diff --git a/marked/Rel-18/29_series/29013/raw.md b/marked/Rel-18/29_series/29013/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..70c9f0b7dd86dd9044752d4e81325bfa7322599e --- /dev/null +++ b/marked/Rel-18/29_series/29013/raw.md @@ -0,0 +1,770 @@ + + +# 3GPP TS 29.013 V18.0.0 (2024-03) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Signalling interworking between ISDN supplementary services; Application Service Element (ASE) and Mobile Application Part (MAP) protocols (Release 18)** + +![GSMA logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +**GLOBAL SYSTEM FOR +MOBILE COMMUNICATIONS** + +GSMA logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +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. + +© 2024, 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..... | 4 | +| 2 References..... | 4 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 5 | +| 4 General..... | 6 | +| 4.1 GSM CCBS Architecture Overview ..... | 6 | +| 4.2 GSM CCBS - ISDN CCBS ASE Interworking Overview ..... | 7 | +| 4.3 Overview on the use of CCBS procedures and parameters values ..... | 8 | +| 4.4 Mapping between MAP and SSAP application layer messages ..... | 8 | +| 4.4.1 MAP D-interface to SSAP interface mapping in HLR A..... | 8 | +| 4.4.2 SSAP interface to MAP D-interface interface mapping in HLR A..... | 8 | +| 5 Mapping between MAP message parameters and SSAP message parameters..... | 9 | +| 5.1 CCBS Request Invocation..... | 9 | +| 5.1.1 Encoding of called party subaddress information ..... | 11 | +| 5.2 CCBS Request Result..... | 11 | +| 5.3 CCBS Request Error ..... | 12 | +| 6 Dialogue handling on the SSAP interface..... | 13 | +| 6.1 Dialogue Beginning..... | 13 | +| 6.1.1 CCBS Request Invocation..... | 13 | +| 6.2 Dialogue Continuation ..... | 13 | +| 6.2.1 CCBS Request Result..... | 13 | +| 6.2.2 CCBS Remote User Free Invocation..... | 14 | +| 6.2.3 CCBS Suspend Invocation ..... | 14 | +| 6.2.4 CCBS Resume Invocation..... | 15 | +| 6.3 Dialogue End..... | 15 | +| 6.3.1 Normal dialogue end ..... | 15 | +| 6.3.2 CCBS Cancel Invocation (from A-side)..... | 16 | +| 6.3.3 CCBS Cancel Invocation (from B-side)..... | 16 | +| 6.3.4 CCBS Request Error..... | 17 | +| 7 Addressing of SCCP layer messages on the SSAP interface..... | 17 | +| 7.1 Use of SCCP..... | 17 | +| 7.2 Addressing of messages at the originating PLMN..... | 17 | +| 7.2.1 TC-BEGIN message from the originating network HLR..... | 17 | +| 7.2.2 TC-CONTINUE, TC-END messages from the originating network HLR ..... | 18 | +| 7.3 Addressing of messages at the destination PLMN..... | 18 | +| 7.3.1 TC-CONTINUE, TC-END messages from the destination network HLR ..... | 18 | +| 7.4 Number formats of the SCCP address parameters..... | 19 | +| 7.4.1 Originating PLMN..... | 19 | +| 7.4.2 Destination PLMN..... | 19 | +| Annex A (informative): Change history..... | 20 | + +# --- Foreword + +This Technical Specification has been produced by the 3GPP. + +This TS provides a detailed specification for interworking between the ISDN Supplementary Services ASE protocol and the Mobile Application Part (MAP) D interface protocol for handling of supplementary services 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 this TS, it will be re-released by the TSG with an identifying change of release date and an increase in version number as follows: + +Version 3.y.z + +where: + +- x the first digit: + - 1 presented to TSG for information; + - 2 presented to TSG for approval; + - 3 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 specification; + +# --- 1 Scope + +The scope of the present document is to provide a specification for interworking between the ISDN Application Service Element (ASE) protocol for supplementary services and the Mobile Application Part (MAP) protocol on MAP D-interface protocol for handling of supplementary services within the digital cellular telecommunications system (Phase 2+). This version of the specification includes the interworking for the Call Completion to Busy Subscriber (CCBS) service between the ISDN CCBS-ASE and MAP. + +The MAP protocol for CCBS service is specified in GSM 09.02. The ISDN CCBS-ASE protocol is specified in ETS 300 356-18. The ISDN CCBS-ASE protocol is also commonly referred to as the SSAP protocol in GSM 03.93. This specification clarifies the interworking within the HLR between these protocols for the Call Completion to Busy Subscriber (CCBS) service. + +Clause 4 describes the mapping between MAP application layer messages and SSAP application layer messages. + +Clause 5 describes the mapping between MAP message parameters and SSAP message parameters. + +Clause 6 describes the dialogue handling on the SSAP interface. + +Clause 7 describes the SCCP layer addressing for messages on the SSAP interface. + +# --- 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. +- [1] GSM 01.04: "Digital cellular telecommunications system (Phase 2+); Abbreviations and acronyms". +- [2] GSM 02.93: "Digital cellular telecommunications system (Phase 2+); Completion of calls to busy subscriber (CCBS) supplementary services - Stage 1". +- [3] GSM 03.93: "Digital cellular telecommunications system (Phase 2+); Technical Realisation of Completion of Calls to Busy Subscriber (CCBS); Stage 2". +- [4] GSM 04.80: "Digital cellular telecommunications system (Phase 2+); Mobile radio interface layer 3 supplementary services specification Formats and coding". +- [5] GSM 04.93: "Digital cellular telecommunications system (Phase 2+); Technical Realisation of Completion of Calls to Busy Subscriber (CCBS); Stage 3". +- [6] GSM 09.02 "Digital cellular telecommunications system (Phase 2+); Mobile Application Part (MAP) specification". +- [7] GSM 09.07 : "Digital cellular telecommunications system (Phase 2+); General requirements on interworking between the Public Land Mobile Network (PLMN) and the Integrated Services Digital Network (ISDN) or Public Switched Telephone Network (PSTN)". +- [8] ETS 300 102-1 (1990): "Integrated Services Digital Network (ISDN); User-network interface layer 3 specifications for basic call control". +- [9] ETS 300 356-18: "ISDN User Part (ISUP) version 2 for the international interface: Part 18: Completion of Calls to Busy Subscriber (CCBS) supplementary service". +- [10] ETS 300 358: "Integrated Services Digital Network (ISDN); Completion of Calls to Busy Subscriber (CCBS) supplementary service; Functional capabilities and information flows". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of this specification, the following definitions apply: + +**SSAP:** Supplementary Service Application Part. SSAP is the protocol used for CCBS procedures on the interface between the originating and destination network. Communication across this interface is performed using SCCP Connectionless Signalling (Refer to ETS 300 358). The terms CCBS-ASE defined in ETS 300 356-18 for the ISDN CCBS service and SSAP defined in GSM 03.93 are the same and are used interchangeably in this specification. The SSAP interface is between the originating network entities (HLR A, OLE) and the destination network entities (HLR B, DLE). + +## 3.2 Abbreviations + +Abbreviations used in this specification are listed in GSM 01.04. + +For the purposes of this specification, the following abbreviations apply: + +| | | +|------|----------------------------------------| +| ASE | Application Service Element | +| CCBS | Call Completion to Busy Subscriber | +| DLE | Destination Local Exchange | +| ISDN | Integrated Services Digital Network | +| MAP | Mobile Application Part | +| OLE | Originating Local Exchange | +| SCCP | Signalling Connection Control Part | +| SSAP | Supplementary Service Application Part | +| TC | Transaction Capabilities | + +# 4 General + +## 4.1 GSM CCBS Architecture Overview + +The stage 1 of the CCBS service is defined in GSM 02.93. + +The network architecture to support the CCBS service in GSM networks is defined in GSM 03.93. For convenience, the architecture is shown again in this specification. Figure 4.1.1 is an architectural overview of the CCBS service when interworking between the originating and the destination networks involved. The originating network may be a mobile network or a fixed network and the destination network may also be a mobile network or a fixed network. + +The call related signalling (see ETS 300 356-18) for CCBS is performed on ISUP links on the following interfaces: + +VMSC A - GMSC B; + +VMSC A - DLE; + +OLE - GMSC B; + +whereas the specific CCBS procedures (see ETS 300 356-18) are performed via the SSAP protocol, which is signalled on the following interfaces: + +HLR A - HLR B; + +HLR A - DLE; + +OLE - HLR B. + +This specification only describes the MAP - SSAP protocol interworking. + +![Figure 4.1: Architectural overview showing common point of interworking. The diagram shows an Originating Network on the left and a Destination Network on the right, both connected to a central TRANSIT NETWORK(S). In the Originating Network, a Fixed Network (OLE) and a Mobile Network (VMSC A) are connected to the transit network via ISUP and SSAP links. The Mobile Network also includes HLR A and VLR A. In the Destination Network, a Fixed Network (DLE) and a Mobile Network (VMSC B) are connected to the transit network via ISUP and SSAP links. The Mobile Network also includes HLR B, VLR B, and GMSC B. SSAP links connect OLE to DLE, HLR A to HLR B, and HLR A to DLE. MAP links connect HLR A to HLR B and HLR A to GMSC B. ISUP links connect VMSC A to GMSC B and VMSC A to DLE.](28d250125d6a79bb23a8a3d459f54cb6_img.jpg) + +``` +graph LR + subgraph Originating_Network [Originating Network] + subgraph Fixed_Network_A [Fixed Network] + OLE[OLE] + end + subgraph Mobile_Network_A [Mobile Network] + HLR_A[HLR A] + VLR_A[VLR A] + VMSC_A[VMSC A] + end + end + subgraph Destination_Network [Destination Network] + subgraph Fixed_Network_B [Fixed Network] + DLE[DLE] + end + subgraph Mobile_Network_B [Mobile Network] + HLR_B[HLR B] + VLR_B[VLR B] + VMSC_B[VMSC B] + GMSC_B[GMSC B] + end + end + TRANSIT((TRANSIT NETWORK(S))) + OLE -- ISUP --> TRANSIT + OLE -- SSAP --> TRANSIT + VMSC_A -- ISUP --> TRANSIT + HLR_A -- SSAP --> TRANSIT + HLR_A -- SSAP --> DLE + HLR_A -- MAP --> HLR_B + HLR_A -- MAP --> GMSC_B + TRANSIT -- ISUP --> DLE + TRANSIT -- SSAP --> DLE + TRANSIT -- ISUP --> GMSC_B + TRANSIT -- SSAP --> HLR_B + GMSC_B -- ISUP --> VMSC_B +``` + +Figure 4.1: Architectural overview showing common point of interworking. The diagram shows an Originating Network on the left and a Destination Network on the right, both connected to a central TRANSIT NETWORK(S). In the Originating Network, a Fixed Network (OLE) and a Mobile Network (VMSC A) are connected to the transit network via ISUP and SSAP links. The Mobile Network also includes HLR A and VLR A. In the Destination Network, a Fixed Network (DLE) and a Mobile Network (VMSC B) are connected to the transit network via ISUP and SSAP links. The Mobile Network also includes HLR B, VLR B, and GMSC B. SSAP links connect OLE to DLE, HLR A to HLR B, and HLR A to DLE. MAP links connect HLR A to HLR B and HLR A to GMSC B. ISUP links connect VMSC A to GMSC B and VMSC A to DLE. + +Figure 4.1: Architectural overview showing common point of interworking + +## 4.2 GSM CCBS - ISDN CCBS ASE Interworking Overview + +The non-call related signalling procedures for CCBS between the originating network and the destination network are defined in ETS 300 356-18 as the ISDN CCBS-ASE. The GSM network also uses these signalling procedures for CCBS without any changes. The ISDN CCBS ASE protocol is supported in GSM networks in the HLR A (originating network) and HLR B (destination network). Therefore no protocol interworking for ISDN CCBS-ASE is needed for the CCBS service between GSM networks and ISDN networks. + +In GSM networks, the CCBS functionality is distributed across several network entities (see GSM 03.93) including the HLR, VLR, MSC and the MS. The HLR shall provide any necessary signalling interworking between the MAP protocol for call completion services on the MAP D-interface (between the VLR and the HLR) and ISDN CCBS-ASE protocol between the originating and destination networks. + +The MAP protocol for CCBS service is specified in GSM 09.02. The ISDN CCBS-ASE protocol is specified in ETS 300 356-18. This specification clarifies the interworking within the HLR between these protocols. + +## 4.3 Overview on the use of CCBS procedures and parameters values + +A GSM subscriber can roam while there is an active CCBS request. The called party address (MSISDN) information is used to initiate a dialogue with the destination network on the SSAP interface. The dialogue on the SSAP interface is opened and maintained while there is an active CCBS request (see ETS 300 356-18). However, the dialogues on the MAP D interface can be closed and reopened as necessary (see GSM 09.02 and GSM 03.93) and use the IMSI information for addressing. + +## 4.4 Mapping between MAP and SSAP application layer messages + +The mapping of MAP messages on the D interface and SSAP messages between the originating and destination networks is described. The precise coding of these messages is given in GSM 09.02 and ETS 300 356-18. + +### 4.4.1 MAP D-interface to SSAP interface mapping in HLR A + +**Table 4.1: Mapping of GSM 09.02 (MAP) operations to ETS 300 356-18 (SSAP) operations** + +| MAP OPERATIONS | SSAP OPERATIONS | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| RegisterCCEntry | CcbsRequest | +| EraseCCEntry/ A GSM 03.93 Event (note 1) | CcbsCancel | +| RemoteUserFree Result/
RemoteUserFree Error/
A GSM 03.93 Event (note 2) | CcbsSuspend | +| StatusReport/
A GSM 03.93 Event (note 3) | CcbsResume | +| NOTE 1 This event may be local to HLR A. See GSM 03.93 for a dynamic description of possible events in HLR A leading to a CCBS request being cancelled. The SSAP CcbsCancel operation can include a cause code parameter; this shall be set to the appropriate value corresponding to the actual dynamic event by HLR A (e.g. cCBS-T3-Timeout, cCBS-T4-Timeout). | | +| NOTE 2 This event may be local to HLR A. See GSM 03.93 for a dynamic description of possible events in HLR A leading to a CCBS request being suspended. | | +| NOTE 3 This event may be local to HLR A. See GSM 03.93 for a dynamic description of possible events in HLR A leading to a CCBS request being resumed. | | + +### 4.4.2 SSAP interface to MAP D-interface interface mapping in HLR A + +| SSAP OPERATIONS | MAP OPERATIONS | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------| +| CcbsRequest Result | RegisterCCEntry Result | +| CcbsRequest Error | RegisterCCEntry Error | +| RemoteUserFree | RemoteUserFree | +| CcbsCancel | SetReportingState/A GSM 03.93 Event (note 1) | +| NOTE 1 This event may be local to HLR A. See GSM 03.93 for a dynamic description of possible events in HLR A resulting from a CCBS request being cancelled. The SSAP CcbsCancel operation can include a cause code parameter(e.g. cCBS-T7-Timeout, cCBS-T9-Timeout). | | + +# 5 Mapping between MAP message parameters and SSAP message parameters + +The mapping between MAP message parameters and SSAP message parameters is described. The precise coding of these messages is given in GSM 09.02 and ETS 300 356-18. + +The following messages on the SSAP interface do not contain any parameters: + +- RemoteUserFree; +- Suspend; +- Resume. + +## 5.1 CCBS Request Invocation + +![Signalling flow for CCBS Request Invocation diagram](a234352dfaccdc24745c88eef7724cc6_img.jpg) + +``` +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note left of VLRA: +--+\n | |\n +--+\n VLRA->>HLRA: RegisterCCEntry\n Note right of VLRA: TC-BEGIN\n Note left of HLRA: +--+\n | |\n +--+\n HLRA->>DN: CcbsRequest\n Note right of HLRA: TC-BEGIN\n Note left of DN: +--+\n | |\n +--+\n +``` + +The diagram illustrates the signalling flow for CCBS Request Invocation. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence of messages is as follows: VLRA sends a RegisterCCEntry message to HLRA, accompanied by a TC-BEGIN message. HLRA then sends a CcbsRequest message to DESTINATION NETWORK B, also accompanied by a TC-BEGIN message. Each entity is represented by a vertical dashed line with a '+' at the top and bottom, indicating the start and end of the interaction period. + +Signalling flow for CCBS Request Invocation diagram + +Figure 5.1: Signalling flow for CCBS Request Invocation + +Table 5.1: Mapping of CCBS Request Invocation parameters + +| RegisterCCEntry PARAMETERS | CcbsRequest PARAMETERS | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| +| ss-Code | not present | +| ccbs-Feature
- b-subscriberSubaddress (note 1) | accessTransportParameter (note 2) | +| translatedB-Number | calledPartyNumber (note 3) | +| serviceIndicator | not present | +| callInfo | not present | +| networkSignallInfo
- ISDN BC Tag, Length, Content (note 4) | userServiceInf | +| networkSignallInfo
- HLC Tag, Length, Content (note 5) | accessTransportParameter (note 2) | +| networkSignallInfo
- LLC Tag, Length, Content (note 6) | accessTransportParameter (note 2) | +| not present | retainSupported (note 7) | +| not present | callingPartyNumber (note 8) | +| not present | userServiceInfPrime (note 9) | +| NOTE 1 CCBS-Feature contains the b-subscriberSubaddress parameter which is the called party subaddress. The GSM HLR A shall map the called party subaddress into the accessTransportParameter if received from the VLR. The entire called party subaddress information (i.e. called party subaddress IEI, LENGTH and CONTENT) is mapped into the accessTransportParameter. See subclause 5.1.1. for details of the required encoding. | | +| NOTE 2 The CcbsRequest contains only one accessTransportParameter. This parameter contains information on the ISDN HLC, LLC and Subaddress. | | +| NOTE 3 The calledParty Number shall be in the international E.164 format. | | +| NOTE 4 The networkSignallInfo contains three information elements ISDN BC, HLC, LLC. The structure of this is defined in GSM 09.02 and the content in GSM 09.07. The ISDN BC information element CONTENT (i.e. without ISDN BC TAG, LENGTH) is mapped into the userServiceInf parameter. | | +| NOTE 5 The networkSignallInfo contains three information elements ISDN BC, HLC, LLC. The structure of this is defined in GSM 09.02 and the content in GSM 09.07. The entire ISDN HLC information element (i.e. ISDN HLC TAG, LENGTH and CONTENT) is mapped into the accessTransportParameter. | | +| NOTE 6 The networkSignallInfo contains three information elements ISDN BC, HLC, LLC. The structure of this is defined in GSM 09.02 and the content in GSM 09.07. The entire ISDN LLC information element (i.e. ISDN LLC TAG, LENGTH and CONTENT) is mapped into the accessTransportParameter. | | +| NOTE 7 This information is local to the HLR A. This information element shall be coded by HLR A to reflect whether it supports CCBS Retention capability. | | +| NOTE 8 This information is local to HLR A. The HLR A provides callingPartyNumber if CLIR was not invoked (See the serviceIndicator parameter in GSM 09.02 and GSM 03.93). If sent, the A subscriber's identity shall be the Basic MSISDN (i.e. the main MSISDN) and shall be in the international E.164 format. | | +| NOTE 9 The GSM HLR A shall not send the userServiceInfPrime | | + +### 5.1.1 Encoding of called party subaddress information + +The CCBS-Feature parameter is received from the VLR and it may include the b-subscriberSubaddress parameter as defined in GSM 09.02. The Called Party Subaddress information requires additional processing in HLR to ensure correct encoding of this information on the SSAP interface. The HLR shall add two octets to the ISDN-SubaddressString received from the VLR as indicated in figure 5.2. + +![](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +| | +|--------------------------------------------------------------------------| +| Called Party Subaddress IEI
(See ETS 300 102-1)
0111 0001 (note 1) | +| Length of the called party address
contents (note 2) | +| ISDN-SubaddressString
(See GSM 09.02)

(note 3) | + +NOTE 1 Called Party Subaddress Information Element Identifier (IEI) is defined by ETS 300 102-1. Its value is "01110001". This information is not sent from the VLR and has to be derived locally in the HLR for interworking purposes. + +NOTE 2 This information has to be derived locally in the HLR for interworking purposes. + +NOTE 3 This information is sent by the VLR. The ISDN-SubaddressString contents is defined in GSM 09.02. + +**Figure 5.2: Encoding of Called Party Subaddress information** + +## 5.2 CCBS Request Result + +![Signalling flow diagram for CCBS Request Result showing interactions between VLRA, HLRA, and DESTINATION NETWORK B.](b3c108e7145f2017957569d06ea359cb_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note right of DN: CcbsRequest-Result +TC-CONTINUE + DN-->HLRA: + Note right of HLRA: RegisterCCEntry-Result +TC-END + HLRA-->VLRA: + +``` + +The diagram illustrates the signalling flow for the CCBS Request Result. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The flow starts with a message from DESTINATION NETWORK B to HLRA labeled 'CcbsRequest-Result' and 'TC-CONTINUE'. HLRA then sends a response back to DESTINATION NETWORK B. Next, HLRA sends a message to VLRA labeled 'RegisterCCEntry-Result' and 'TC-END'. + +Signalling flow diagram for CCBS Request Result showing interactions between VLRA, HLRA, and DESTINATION NETWORK B. + +**Figure 5.3: Signalling flow for CCBS Request Result** + +Table 5.2: Mapping of CCBS Request Result parameters + +| CcbsRequest_ Result PARAMETERS | RegisterCCEntry_ Result PARAMETERS | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| +| retainSupported (note 1) | not present | +| not present | ccbs-Feature (note 2) | +| NOTE 1 This information is associated with each CCBS Request and indicates whether CCBS Retention is supported by the destination B network (see GSM 03.93). | | +| NOTE 2 This information is local to the HLR A. Some of information contained in ccbs-Feature (e.g. ccbs-index) is allocated by the HLR A. The ccbs-Feature information is sent to the MS (see GSM 03.93, GSM 04.93). | | + +## 5.3 CCBS Request Error + +![Signalling flow for CCBS Request Error diagram showing three vertical lifelines: VLRA, HLRA, and DESTINATION NETWORK B. The flow starts with a message from DESTINATION NETWORK B to HLRA labeled 'CcbsRequest-Error' and 'TC-END'. HLRA then sends a message back to VLRA labeled 'RegisterCCEntry-Error' and 'TC-END'.](08441fa90c5fd11994626f662ac13f19_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DESTINATION_NETWORK_B as DESTINATION NETWORK B + Note right of DESTINATION_NETWORK_B: +--+\n | | |\n Note left of HLRA: +--+\n | | |\n Note left of VLRA: +--+\n | | |\n DESTINATION_NETWORK_B->>HLRA: CcbsRequest-Error\n Note right of HLRA: TC-END\n HLRA-->>VLRA: RegisterCCEntry-Error\n Note left of VLRA: TC-END + +``` + +Signalling flow for CCBS Request Error diagram showing three vertical lifelines: VLRA, HLRA, and DESTINATION NETWORK B. The flow starts with a message from DESTINATION NETWORK B to HLRA labeled 'CcbsRequest-Error' and 'TC-END'. HLRA then sends a message back to VLRA labeled 'RegisterCCEntry-Error' and 'TC-END'. + +Figure 5.4: Signalling flow for CCBS Request Error + +Table 5.3: Mapping of CCBS Request Error parameters + +| CcbsRequest_ Error PARAMETERS | RegisterCCEntry_ Error PARAMETERS | +|----------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| shortTermDenial/ longTermDenial (note 1) | shortTermDenial/ longTermDenial (note 2) | +| NOTE 1 For coding of these User Errors see ETS 300 356-18. | | +| NOTE 2 For coding of these User Errors see GSM 09.02. This information is sent to the MS (see GSM 04.93, GSM 04.80). | | + +# 6 Dialogue handling on the SSAP interface + +The dialogue handling on the SSAP interface and the mapping between the corresponding TC transaction sublayer messages on the MAP D and SSAP interfaces is described. The diagrams show the general principle of dialogue handling. Specific message flows depend on the dynamics of the application in the network elements, see GSM 03.93 and GSM 09.02. + +## 6.1 Dialogue Beginning + +### 6.1.1 CCBS Request Invocation + +![Signalling flow for CCBS REQUEST INVOCATION](3ad00ce93ad9dea9ee0f47535e5355e6_img.jpg) + +``` +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note left of VLRA: +--+\n VLRA->>HLRA: RegisterCCEntry\n Note right of HLRA: TC-BEGIN\n HLRA->>DN: CcbsRequest\n Note right of HLRA: TC-BEGIN SCCP +``` + +The diagram illustrates the signalling flow for CCBS REQUEST INVOCATION. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence of messages is as follows: VLRA sends a RegisterCCEntry message to HLRA, which is mapped to TC-BEGIN. HLRA then sends a CcbsRequest message to DESTINATION NETWORK B, which is mapped to TC-BEGIN SCCP. + +Signalling flow for CCBS REQUEST INVOCATION + +Figure 6.1: Signalling flow for CCBS REQUEST INVOCATION + +The CCBS Request invocation is carried by TC-BEGIN. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.1. + +## 6.2 Dialogue Continuation + +### 6.2.1 CCBS Request Result + +![Signalling flow for CCBS Request Result](5dfc130b129ace4df375839020a5700d_img.jpg) + +``` +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note left of VLRA: +--+\n DN->>HLRA: CcbsRequest-Result\n Note right of HLRA: TC-CONTINUE SCCP\n HLRA->>VLRA: RegisterCCEntry-Result\n Note right of VLRA: TC-END +``` + +The diagram illustrates the signalling flow for CCBS Request Result. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence of messages is as follows: DESTINATION NETWORK B sends a CcbsRequest-Result message to HLRA, which is mapped to TC-CONTINUE SCCP. HLRA then sends a RegisterCCEntry-Result message to VLRA, which is mapped to TC-END. + +Signalling flow for CCBS Request Result + +Figure 6.2: Signalling flow for CCBS Request Result + +The CCBS Request Result is carried by TC-CONTINUE. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3. + +### 6.2.2 CCBS Remote User Free Invocation + +![Sequence diagram for CCBS Remote User Free Invocation showing signaling flow between VLRA, HLRA, and DESTINATION NETWORK B.](bd671b21db63e6fdb2196e9b18502aac_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DNB as DESTINATION NETWORK B + Note right of HLRA: RemoteUserFree + HLRA->>DNB: TC-CONTINUE SCCP + Note left of HLRA: RemoteUserFree + HLRA->>VLRA: TC-BEGIN + +``` + +The diagram illustrates the signaling flow for CCBS Remote User Free Invocation. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with a message 'RemoteUserFree' being processed at the HLRA. A 'TC-CONTINUE SCCP' message is sent from the HLRA to the DESTINATION NETWORK B. Simultaneously, another 'RemoteUserFree' message is processed at the HLRA, and a 'TC-BEGIN' message is sent from the HLRA to the VLRA. + +Sequence diagram for CCBS Remote User Free Invocation showing signaling flow between VLRA, HLRA, and DESTINATION NETWORK B. + +**Figure 6.3: Signalling flow for Remote User Free Invocation** + +The CCBS Remote User Free Invocation is carried by TC-CONTINUE. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3. + +### 6.2.3 CCBS Suspend Invocation + +![Sequence diagram for CCBS Suspend Invocation (RemoteUserFree_Result) showing signaling flow between VLRA, HLRA, and DESTINATION NETWORK B.](f6e8acf9f931452d01688d311b5c0364_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DNB as DESTINATION NETWORK B + Note left of HLRA: RemoteUserFree-Result + VLRA->>HLRA: TC-END + Note right of HLRA: CcbsSuspend (note 1) + HLRA->>DNB: TC-CONTINUE SCCP + +``` + +The diagram illustrates the signaling flow for CCBS Suspend Invocation (RemoteUserFree\_Result). It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with a message 'RemoteUserFree-Result' being processed at the VLRA. A 'TC-END' message is sent from the VLRA to the HLRA. Simultaneously, a 'CcbsSuspend (note 1)' message is processed at the HLRA, and a 'TC-CONTINUE SCCP' message is sent from the HLRA to the DESTINATION NETWORK B. + +Sequence diagram for CCBS Suspend Invocation (RemoteUserFree\_Result) showing signaling flow between VLRA, HLRA, and DESTINATION NETWORK B. + +NOTE 1 For conditions leading to a request being suspended, see GSM 03.93 + +**Figure 6.4: Signalling flow for CCBS Suspend Invocation (RemoteUserFree\_Result)** + +![Sequence diagram for CCBS Suspend Invocation (RemoteUserFree_Error) showing signaling flow between VLRA, HLRA, and DESTINATION NETWORK B.](704082cc3e11776bda29595c76411362_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DNB as DESTINATION NETWORK B + Note left of HLRA: RemoteUserFree-Error + VLRA->>HLRA: TC-END + Note right of HLRA: CcbsSuspend (note 1) + HLRA->>DNB: TC-CONTINUE SCCP + +``` + +The diagram illustrates the signaling flow for CCBS Suspend Invocation (RemoteUserFree\_Error). It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with a message 'RemoteUserFree-Error' being processed at the VLRA. A 'TC-END' message is sent from the VLRA to the HLRA. Simultaneously, a 'CcbsSuspend (note 1)' message is processed at the HLRA, and a 'TC-CONTINUE SCCP' message is sent from the HLRA to the DESTINATION NETWORK B. + +Sequence diagram for CCBS Suspend Invocation (RemoteUserFree\_Error) showing signaling flow between VLRA, HLRA, and DESTINATION NETWORK B. + +NOTE 1 For conditions leading to a request being suspended, see GSM 03.93 + +**Figure 6.5: Signalling flow for CCBS Suspend Invocation (RemoteUserFree\_Error)** + +The CCBS Suspend Invocation is carried by TC-CONTINUE. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.2 + +### 6.2.4 CCBS Resume Invocation + +![Signalling flow for CCBS Resume Invocation diagram](9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note left of VLRA: StatusReport + VLRA->>HLRA: TC-BEGIN + HLRA->>DN: CcbsResume (note 1) +TC-CONTINUE +SCCP + +``` + +The diagram illustrates the signalling flow for CCBS Resume Invocation. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with a 'StatusReport' message from VLRA to HLRA. VLRA then sends a 'TC-BEGIN' message to HLRA. HLRA sends a 'CcbsResume (note 1)' message to DESTINATION NETWORK B, which includes 'TC-CONTINUE' and 'SCCP' components. + +Signalling flow for CCBS Resume Invocation diagram + +NOTE 1 For conditions leading to a request being resumed, see GSM 03.93 + +**Figure 6.6: Signalling flow for CCBS Resume Invocation** + +The CCBS Resume Invocation is carried by TC-CONTINUE. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.2. + +## 6.3 Dialogue End + +### 6.3.1 Normal dialogue end + +![Signalling flow for normal dialogue end diagram](3f1987804d7d78bc3b3bc560e974280a_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note right of DN: No component primitive + DN->>HLRA: TC-END +SCCP + HLRA->>VLRA: SetReportingState (note 1) +TC-BEGIN + +``` + +The diagram illustrates the signalling flow for normal dialogue end. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with a 'No component primitive' message from DESTINATION NETWORK B to HLRA. DESTINATION NETWORK B then sends a 'TC-END' message to HLRA, which includes 'SCCP' components. HLRA sends a 'SetReportingState (note 1)' message to VLRA, which includes 'TC-BEGIN' components. + +Signalling flow for normal dialogue end diagram + +NOTE 1 If the monitoring function is active in VLR A and all outstanding CCBS Requests have been deactivated, the HLR A sends SetReportingState to deactivate the monitoring function (see GSM 03.93). + +**Figure 6.7: Signalling flow for normal dialogue end** + +The normal ending of CCBS dialogue from the B-side is carried by TC-END. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3. + +### 6.3.2 CCBS Cancel Invocation (from A-side) + +![Signalling flow for CCBS Cancel Invocation (from A-side)](16152cf1d84aea10848758f51a91ff6a_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note left of VLRA: (note 1) + VLRA->>HLRA: EraseCCEntry + Note right of HLRA: TC-BEGIN + HLRA->>DN: CcbsCancel + Note right of DN: TC-END (note 1) +SCCP + +``` + +The diagram illustrates the signalling flow for CCBS Cancel Invocation from the A-side. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with VLRA sending an 'EraseCCEntry' message to HLRA, with a note indicating this is note 1. HLRA responds with 'TC-BEGIN'. HLRA then sends a 'CcbsCancel' message to DESTINATION NETWORK B, with a note indicating this is TC-END (note 1) and SCCP. + +Signalling flow for CCBS Cancel Invocation (from A-side) + +NOTE 1 Where all outstanding CCBS Requests have been deactivated, CCBS Cancel is sent to each corresponding Destination Network B with the appropriate Destination Network B E.164 Called Party Address (see GSM 03.93, GSM 04.93). + +**Figure 6.8: Signalling flow for CCBS Cancel Invocation (from A-side)** + +The CCBS Cancel Invocation from the A-side is carried by TC-END. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.2. + +### 6.3.3 CCBS Cancel Invocation (from B-side) + +![Signalling flow for CCBS Cancel Invocation (from B-side)](6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg) + +``` + +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note left of DN: (note 1) + DN->>HLRA: CcbsCancel + Note right of HLRA: TC-END +SCCP + HLRA->>VLRA: SetReportingState + Note left of VLRA: TC-BEGIN + +``` + +The diagram illustrates the signalling flow for CCBS Cancel Invocation from the B-side. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence starts with DESTINATION NETWORK B sending a 'CcbsCancel' message to HLRA, with a note indicating this is note 1. HLRA responds with 'TC-END' and 'SCCP'. HLRA then sends a 'SetReportingState' message to VLRA, with a note indicating this is TC-BEGIN. + +Signalling flow for CCBS Cancel Invocation (from B-side) + +NOTE 1: If the monitoring function is active in VLR A and all outstanding CCBS Requests have been deactivated, the HLR A sends SetReportingState to deactivate the monitoring function (see GSM 03.93). + +**Figure 6.9: Signalling flow for CCBS Cancel Invocation (from B-side)** + +The CCBS Cancel Invocation from the B-side is carried by TC-END. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3. + +### 6.3.4 CCBS Request Error + +![Sequence diagram showing the signalling flow for CCBS Request Error between VLRA, HLRA, and DESTINATION NETWORK B.](df82d77a0d2637cbf2da9ea920a554fa_img.jpg) + +``` +sequenceDiagram + participant VLRA + participant HLRA + participant DN as DESTINATION NETWORK B + Note right of DN: CcbsRequest-Error + DN-->HLRA: TC-END SCCP + Note right of HLRA: RegisterCCEntry-Error + HLRA-->VLRA: TC-END +``` + +The diagram illustrates the signalling flow for a CCBS Request Error. It involves three entities: VLRA, HLRA, and DESTINATION NETWORK B. The sequence of messages is as follows: 1. A message labeled 'CcbsRequest-Error' is sent from DESTINATION NETWORK B to HLRA. 2. Below this, a message labeled 'TC-END SCCP' is sent from DESTINATION NETWORK B to HLRA. 3. Next, a message labeled 'RegisterCCEntry-Error' is sent from HLRA to VLRA. 4. Finally, a message labeled 'TC-END' is sent from HLRA to VLRA. + +Sequence diagram showing the signalling flow for CCBS Request Error between VLRA, HLRA, and DESTINATION NETWORK B. + +**Figure 6.10: Signalling flow for CCBS Request Error** + +The CCBS Request Error is carried by TC-END. The SCCP addressing parameters on the SSAP interface shall be as shown in table 7.3. + +# 7 Addressing of SCCP layer messages on the SSAP interface + +The SCCP layer addressing for messages on the SSAP interface is described. + +## 7.1 Use of SCCP + +Clarifications and restrictions on the use and coding of the main SCCP parameters impacted by CCBS on the SSAP interface are indicated. See ETS 300 356-18 and the associated references for the full specification on the use of SCCP on the SSAP interface. The SCCP routeing on the SSAP interface shall be based on the Global Title (GT) translation mechanism as for routeing on the international interface. GT addressing shall be used for inter and intra PLMN signalling. This allows any impact of other network features e.g. Mobile Number Portability to be minimised. + +## 7.2 Addressing of messages at the originating PLMN + +### 7.2.1 TC-BEGIN message from the originating network HLR + +The relevant SCCP parameters in the first message from the HLR A transporting TC-BEGIN are shown in table 7.1. All other SCCP parameters shall be as indicated in ETS 300 356-18. + +**Table 7.1: SCCP parameters used by HLR A for TC-BEGIN** + +| SCCP PARAMETERS for the message transporting TC-BEGIN | PARAMETER VALUE | +|--------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CdPA-Called Party Address | E.164 number of the Called Party. This may be in either international or national E.164 format, see subclause 7.4.1. It is derived from the translatedB-Number parameter which is available from the CCBS application in HLRA, see RegisterCCEntry in GSM 09.02. | +| CgPA-Calling Party Address | E.164 number of HLR A. This may be in either international or national E.164 format, see subclause 7.4.1. | +| SSN- Subsystem Number | 0000 1011
(See ETS 300 356-18) | +| TT- Translation Type | 0001 0001
(See ETS 300 356-18) | +| Other SCCP Parameters | See ETS 300 356-18 | + +### 7.2.2 TC-CONTINUE, TC-END messages from the originating network HLR + +The relevant SCCP parameters in the subsequent messages from the HLR A transporting TC-CONTINUE and TC-END are shown in table 7.2. All other SCCP parameters shall be as indicated in ETS 300 356-18. + +**Table 7.2: SCCP parameters used by HLR A for TC-CONTINUE, TC-END** + +| SCCP PARAMETERS for the message transporting TC-CONTINUE, TC-END | PARAMETER VALUE | +|-------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CdPA-Called Party Address | The Called Party Address is the E.164 address of the calling entity in the destination network that was received in the first response message from the destination network (note 1). | +| CgPA-Calling Party Address | E.164 number of HLR A. This may be in either international or national E.164 format as used in the message transporting TC-BEGIN, see subclause 7.4.1. | +| SSN- Subsystem Number | 0000 1011
(See ETS 300 356-18) | +| TT- Translation Type | 0001 0001
(See ETS 300 356-18) | +| Other SCCP Parameters | See ETS 300 356-18 | +| NOTE 1 | If the destination network is a GSM PLMN, this is E.164 number of HLR B. | + +## 7.3 Addressing of messages at the destination PLMN + +### 7.3.1 TC-CONTINUE, TC-END messages from the destination network HLR + +The relevant SCCP parameters in the first and subsequent messages from the HLR B transporting TC-CONTINUE and TC-END are shown in table 7.3. All other SCCP parameters shall be as indicated in ETS 300 356-18. + +**Table 7.3: SCCP parameters for TC-CONTINUE, TC-END used by HLR B** + +| SCCP PARAMETERS for the message transporting TC-CONTINUE, TC-END | PARAMETER VALUE | +|------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CdPA-Called Party Address | The Called Party Address is the E.164 address of the calling entity in the originating network that was received in the first message transporting TC-BEGIN from the originating network (note 1). | +| CgPA-Calling Party Address | E.164 number of HLR B. This may be in either international or national E.164 format, see subclause 7.4.2 (note 2) | +| SSN- Subsystem Number | 0000 1011
(See ETS 300 356-18) | +| TT- Translation Type | 0001 0001
(See ETS 300 356-18) | +| Other SCCP Parameters | See ETS 300 356-18 | +| NOTE 1 | If the originating network is a GSM PLMN, this is E.164 number of HLR A. | +| NOTE 2 | The E.164 number of HLRB is used as this allows any impact of other network features to be minimised. | + +## 7.4 Number formats of the SCCP address parameters + +The Called and Calling Party Address information in SCCP should be in international E.164 format. Optionally national format E.164 addresses may be used in SCCP for routing of national traffic. For this, the HLR has to modify the addresses which are in international E.164 format to a national E.164 format. If a national format E.164 option is used, all involved network nodes in a given country (i.e. the originating network, any transit networks and the destination network) need support that option. As negotiation is not possible, the option selected by the originating network shall determine the addressing used for all messages which are a part of a single dialogue. + +### 7.4.1 Originating PLMN + +The Called and Calling Party Address information in SCCP should be in international E.164 format. + +The originating network HLR A may use the SCCP Called Party Address in national E.164 format if the called destination (as indicated by the translatedB-number) is in the same country as HLR A. + +The originating network HLR A may use the SCCP Calling Party Address in national E.164 format if the called destination (as indicated by the translatedB-number) is in the same country as HLR A. + +The originating network HLR A shall ensure that the SCCP Called and Calling Party Addresses are either both in international format or national format. + +### 7.4.2 Destination PLMN + +The Called and Calling Party Address information in SCCP should be in international E.164 format. + +The destination network HLR B may use the SCCP Called Party Address in national E.164 format if the originating network is in the same country as HLR B. + +The destination network HLR B may use the SCCP Calling Party Address in national E.164 format if the originating network is in the same country as HLR B. + +The destination network HLR B shall ensure that the SCCP Called and Calling Party Addresses are either both in international format or national format. \ No newline at end of file diff --git a/marked/Rel-18/29_series/29116/raw.md b/marked/Rel-18/29_series/29116/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..854b21ebf0cdd06aa78e5ac4d8a501ed52237074 --- /dev/null +++ b/marked/Rel-18/29_series/29116/raw.md @@ -0,0 +1,3375 @@ + + +# 3GPP TS 29.116 V18.0.0 (2022-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Representational state transfer over xMB reference point between Content Provider and BM-SC; (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** + + + +## **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. + +© 2022, 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 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 8 | +| 4 xMB reference point ..... | 8 | +| 4.1 Overview ..... | 8 | +| 4.2 Reference model..... | 8 | +| 4.3 Functional elements..... | 9 | +| 4.3.1 BM-SC..... | 9 | +| 4.3.2 Content Provider / Multicast Broadcast Source ..... | 9 | +| 4.4 Procedures over xMB reference point..... | 9 | +| 4.4.1 Introduction ..... | 9 | +| 4.4.2 Authentication Procedures..... | 9 | +| 4.4.3 Authorization Procedures ..... | 10 | +| 4.4.4 Service Management Procedures ..... | 10 | +| 4.4.4.1 Create Service ..... | 10 | +| 4.4.4.2 Get Service Properties ..... | 10 | +| 4.4.4.3 Update Service Properties..... | 10 | +| 4.4.4.4 Delete Service ..... | 10 | +| 4.4.4.5 Service Notifications..... | 10 | +| 4.4.5 Session Management Procedures ..... | 10 | +| 4.4.5.1 Create Session..... | 10 | +| 4.4.5.2 Get Session Properties ..... | 10 | +| 4.4.5.3 Update Session Properties ..... | 10 | +| 4.4.5.4 Delete Session..... | 11 | +| 5 xMB API..... | 11 | +| 5.1 Overview ..... | 11 | +| 5.1.0 General ..... | 11 | +| 5.1.1 Supported Methods..... | 11 | +| 5.1.2 Error Handling..... | 12 | +| 5.1.3 xMB Entry Point Discovery ..... | 12 | +| 5.1.4 Content type..... | 12 | +| 5.2 Resources ..... | 13 | +| 5.2.1 Services..... | 13 | +| 5.2.1.0 General..... | 13 | +| 5.2.1.1 Properties ..... | 13 | +| 5.2.1.2 API Operations ..... | 15 | +| 5.2.1.2.1 Introduction ..... | 15 | +| 5.2.1.2.2 Service Creation ..... | 15 | +| 5.2.1.2.3 Service Modification ..... | 15 | +| 5.2.1.2.4 Service Deletion ..... | 17 | +| 5.2.1.2.5 Service Retrieval ..... | 18 | +| 5.2.2 Sessions ..... | 20 | +| 5.2.2.0 General..... | 20 | +| 5.2.2.1 Properties ..... | 20 | +| 5.2.2.2 API Operations ..... | 32 | +| 5.2.2.2.1 Introduction ..... | 32 | +| 5.2.2.2.2 Session Creation..... | 32 | +| 5.2.2.2.3 Session Modification..... | 33 | +| 5.2.2.2.4 Session Deletion..... | 35 | +| 5.2.2.2.5 Session Retrieval..... | 36 | +| 5.2.3 Reports..... | 38 | + +| | | | +|----------------------------------------------------|--------------------------------------------------------------------------------|-----------| +| 5.2.3.0 | General ..... | 38 | +| 5.2.3.1 | Properties ..... | 38 | +| 5.2.3.2 | API Operations ..... | 39 | +| 5.2.3.2.1 | Introduction ..... | 39 | +| 5.2.3.2.2 | Report Retrieval ..... | 39 | +| 5.2.4 | Notifications ..... | 43 | +| 5.2.4.0 | General ..... | 43 | +| 5.2.4.1 | Properties ..... | 43 | +| 5.2.4.1.0. | General ..... | 43 | +| 5.2.4.2.1 | Introduction ..... | 45 | +| 5.2.4.2.2 | Notification Retrieval ..... | 45 | +| 6 | User Plane Procedures ..... | 46 | +| 6.1 | Introduction ..... | 46 | +| 6.2 | File Session ..... | 46 | +| 6.2.1 | General ..... | 46 | +| 6.2.2 | Push Mode ..... | 46 | +| 6.2.3 | Pull Mode ..... | 46 | +| 6.3 | Application Session ..... | 47 | +| 6.3.1 | General ..... | 47 | +| 6.3.2 | Push Mode ..... | 47 | +| 6.3.3 | Pull Mode ..... | 47 | +| 6.4 | RTP Streaming ..... | 48 | +| 6.5 | Transport ..... | 48 | +| 7 | Security ..... | 48 | +| 7.1 | Overview ..... | 48 | +| 7.2 | Authentication & Authorization ..... | 48 | +| 7.3 | Void ..... | 49 | +| 8 | Notification Push to the Content Provider ..... | 49 | +| 8.1 | Introduction ..... | 49 | +| 8.2 | Notification Post ..... | 49 | +| 9 | Feature negotiation ..... | 50 | +| 9.1 | General ..... | 50 | +| 9.2 | HTTP custom headers ..... | 51 | +| 9.2.0 | General ..... | 51 | +| 9.2.1 | 3gpp-Optional-Features ..... | 51 | +| 9.2.2 | 3gpp-Required-Features ..... | 51 | +| 9.2.3 | 3gpp-Accepted-Features ..... | 52 | +| 10 | Using Common API Framework ..... | 52 | +| 10.1 | General ..... | 52 | +| 10.2 | Security ..... | 52 | +| Annex A (informative): Call Flows ..... | | 54 | +| A.1 | Introduction ..... | 54 | +| A.2 | xMB Procedure example for Live DASH services (MBMS Broadcast only) ..... | 54 | +| A.3 | xMB Procedure example for Live DASH services (with Service Continuity) ..... | 57 | +| A.4 | xMB Procedure example for File Delivery Services (without File Schedule) ..... | 57 | +| Annex B (normative): JSON Schema ..... | | 61 | +| Annex C (informative): Change history ..... | | 80 | + +# --- 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 describes the REST-based protocol for the xMB reference point between the Content Provider and the BM-SC. The xMB reference point and related stage 2 protocol procedures are defined in 3GPP TS 23.246 [2] and in 3GPP TS 26.346 [3]. + +# --- 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.246: "Multimedia Broadcast/Multicast Service (MBMS) Architecture and Functional Description". +- [3] 3GPP TS 26.346: "Multimedia Broadcast/Multicast Service (MBMS); Protocols and Codecs". +- [4] Void. +- [5] Void. +- [6] IETF RFC 7231: "Hypertext transfer protocol (HTTP/1.1): Semantics and Content". +- [7] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [8] IETF RFC 7235: "Hypertext Transfer Protocol (HTTP/1.1): Authentication". +- [9] IETF RFC 4918: "HTTP Extensions for Web Distributed Authoring and Versioning (WebDAV)". +- [10] 3GPP TS 26.234: "Transparent end-to-end Packet-switched Streaming Service (PSS); Protocols and codecs". +- [11] IETF RFC 3711: "The Secure Real-time Transport Protocol (SRTP)". +- [12] Void. +- [13] Void. +- [14] Void. +- [15] Void. +- [16] Void. +- [17] Void. +- [18] 3GPP TS 26.247: "Transparent end-to-end Packet-switched Streaming Service (PSS); Progressive Download and Dynamic Adaptive Streaming over HTTP (3GP-DASH)". +- [19] IETF RFC 3926: "FLUTE - File Delivery over Unidirectional Transport". +- [20] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". + +- [21] 3GPP TS 26.347: "MBMS URLs and APIs". +- [22] Open API Initiative, "OpenAPI 2.0 Specification", . +- [23] 3GPP TS 23.285: "Architecture Enhancements for V2X services". +- [24] 3GPP TS 33.246: "3G Security; Security of Multimedia Broadcast/Multicast Service (MBMS)". +- [25] 3GPP TS 24.116: "Stage 3 aspects of system architecture enhancements for TV services". +- [26] IETF RFC 2617: "HTTP Authentication: Basic and Digest Access Authentication". +- [27] IETF RFC 5795: "The Robust Header Compression (ROHC) Framework". +- [28] IETF RFC 3095: "Robust Header Compression (ROHC): Framework and four profiles: RTP, UDP, ESP, and uncompressed". +- [29] IETF RFC 6363: "Forward Error Correction (FEC) Framework". +- [30] Void. +- [31] IETF RFC 1166: "Internet Numbers". +- [32] IETF RFC 5952: "A recommendation for IPv6 address text representation". +- [33] 3GPP TS 26.348: "Northbound Application Programming Interface (API) for Multimedia Broadcast/Multicast Service (MBMS) at the xMB reference point". +- [34] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [35] IETF RFC 7396: "JSON Merge Patch". +- [36] 3GPP TS 23.280: "Common functional architecture to support mission critical services; Stage 2". +- [37] 3GPP TS 24.008: "Mobile radio interface layer 3 specification; Core Network protocols; Stage 3". +- [38] IETF RFC 7232: "Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests". +- [39] 3GPP TS 23.222: "Common API Framework for 3GPP Northbound APIs; Stage 2". +- [40] 3GPP TS 29.222: "Common API Framework for 3GPP Northbound APIs; Stage 3". +- [41] 3GPP TS 33.122: "Security Aspects of Common API Framework for 3GPP Northbound APIs". +- [42] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [43] IETF RFC 7616: "HTTP Digest Access Authentication". + +# --- 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]. + +**Content Provider:** Entity/Entities which supplies/supply content in the form of streaming media or non-real-time (NRT) files to be delivered to UEs over the 3GPP network, via MBMS Bearer and/or unicast bearer services. Also referred to in this document as the Multicast Broadcast Source. The Content Provider may reside either inside or outside the operator's network. + +**Service:** One of the resource types exposed by the RESTful xMB API and operated on by a Content Provider using HTTP methods. It corresponds to a Content Provider's service offering for delivery over the MBMS network to UEs. + +Each service instance created over the xMB API maps to an MBMS User Service as specified by 3GPP TS 26.346 [3]. The delivery of the contents of a created service is performed during one or more sessions associated with that service. + +**Session:** One of the resource types exposed by the RESTful xMB API and operated on by a Content Provider using HTTP methods. It represents one or more time intervals during which the MBMS Bearer is active for the transmission of service contents from the BM-SC to the UE. Each session instance, besides the activity times, may contain various properties pertaining to transport, media and application level information (session type, session state, data rate, permitted delay, user plane ingestion mode, targeted delivery area, reporting parameters, identification of content components delivered during the session, etc.). + +## 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]. + +| | | +|--------|---------------------------------------------| +| 5GMS | 5G Media Streaming | +| ARP | Allocation and Retention Priority | +| API | Application Programming Interface | +| BM-SC | Broadcast Multicast Service Center | +| CAPIF | Common API Framework | +| CDN | Content Delivery Network | +| CP | Content Provider | +| DASH | Dynamic Adaptive Streaming over HTTP | +| FEC | Forward Error Correction | +| FLUTE | File Delivery over Unidirectional Transport | +| GBR | Guaranteed Bitrate | +| HTTP | HyperText Transfer Protocol | +| IS | Initialization Segment | +| JSON | JavaScript Object Notation | +| MPD | Media Presentation Description | +| MSA | MBMS Service Area | +| PKI | Public Key Infrastructure | +| PSK | Pre-Shared Key | +| REST | Representational State Transfer | +| ROHC | Robust Header Compression | +| QCI | QoS Class Identifier | +| QoS | Quality of Service | +| SACH | Service Announcement Channel | +| SAF | Service Announcement Function | +| SLA | Service Level Agreement | +| TLS | Transport Layer Security | +| TMGI | Temporarily Mobile Group Identity | +| TSI | Transport Session Identifier | +| URI | Universal Resource Identifier | +| WebDAV | Web Distributed Authoring and Versioning | +| V2X | Vehicle-to-Everything | + +# --- 4 xMB reference point + +## 4.1 Overview + +## 4.2 Reference model + +The xMB reference point resides between the BM-SC and the Content Provider as depicted in Figure 4.2.1. Control- and user-plane procedures are operated over the xMB-C and xMB-U reference points, respectively. The overall xMB reference model is depicted in clause 4.1 of 3GPP TS 26.348 [33]. + +![Diagram of the xMB reference point showing the BM-SC and Content Provider/Multicast Broadcast Source connected by two arrows labeled xMB-C and xMB-U.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +``` +graph LR; BM-SC[BM-SC] -- xMB-C --> CP[Content Provider/Multicast Broadcast Source]; CP -- xMB-U --> BM-SC; +``` + +Diagram of the xMB reference point showing the BM-SC and Content Provider/Multicast Broadcast Source connected by two arrows labeled xMB-C and xMB-U. + +**Figure 4.2.1 xMB reference point** + +For the V2X Localized User Plane supported feature, the reference model in Annex B.3 of 3GPP TS 23.285 [23] applies. + +## 4.3 Functional elements + +### 4.3.1 BM-SC + +The complete functionality of the BM-SC is defined in 3GPP TS 26.346 [3]. In the context of the xMB reference point, the BM-SC represents the peer endpoint to the Content Provider in supporting all procedures on the xMB interface. + +In addition to the functions defined in 3GPP TS 26.346 [3], the BM-SC may support, for V2X services, the V2X Localized User Plane procedures as defined in 3GPP TS 23.285 [23] clause 5.4.2.2 for receiving Local MBMS information from the Content Provider acting as a V2X Application Server. + +### 4.3.2 Content Provider / Multicast Broadcast Source + +The functional role of the Content Provider is defined in clause 4.4.1a of 3GPP TS 26.346 [3]. Using the xMB reference point, a Content Provider/Multicast Broadcast Source may provide media, as well as service descriptions and control data, to the BM-SC to set up and manage MBMS User Service(s) from the BM-SC to MBMS clients (the latter is not depicted in Figure 4.2.1). + +In addition, the Content Provider which acts as a V2X Application Server may support V2X Localized User Plane procedures as defined in 3GPP TS 23.285 [23] clause 5.4.2.2 for requesting the BM-SC to activate an MBMS bearer for Local MBMS based MBMS data delivery. + +The content provider may also be a mission critical service provider (3GPP TS 23.280 [36]) which is arranging MC Services to Mission Critical Organizations and may require additional control of the resource allocation (QoS, coverage area). + +The Content Provider may be a 5GMS Application Provider as defined in clause 4.1 of TS 26.348 [33], providing 5G Media Streaming services to a 5GMS System. + +## 4.4 Procedures over xMB reference point + +### 4.4.1 Introduction + +All procedures that operate across the xMB reference point, as specified in clause 5 of 3GPP TS 26.348 [33], are summarized in the following clauses. + +### 4.4.2 Authentication Procedures + +Authentication procedures shall be performed via (D)TLS as specified by 3GPP TS 33.246 [24]. The Content Provider shall act as the (D)TLS client and the BM-SC as the (D)TLS server when the Content Provider wants to provision new services or manage existing services. Similarly, the BM-SC shall act as the client when the BM-SC wishes to send reports and notifications to the Content Provider. All of the following procedures require the authentication procedure to be completed successfully. + +### 4.4.3 Authorization Procedures + +The authorization procedure of the Content Provider towards the BM-SC may be based on the (D)TLS connection established as part of the authentication procedure (see clause 4.4.2). In that case, the BM-SC shall check if the Content Provider who sent a request over an authenticated (D)TLS connection is authorized to send that specific request. See clause 7.2 for further details. + +The authorization procedure of the BM-SC towards the Content Provider to allow pushing notifications to the Content Provider may be based on the (D)TLS connection established as part of the authentication procedure (see clause 4.4.2). In that case, the Content Provider shall check if the BM-SC who sent the notification over an authenticated (See clause 7.2 for further details)(D)TLS connection is authorized to send that specific notification. + +### 4.4.4 Service Management Procedures + +#### 4.4.4.1 Create Service + +This procedure is used by the Content Provider to create a service at the BM-SC and negotiate the supported features for the created service. The Content Provider shall use HTTP POST for this purpose. A successfully created service is associated with a resource identifier which is used by the Content Provider to discover, update and delete the service. + +#### 4.4.4.2 Get Service Properties + +This procedure is used by the Content Provider to obtain the service properties from the BM-SC. The Content Provider shall use HTTP GET for this purpose. + +#### 4.4.4.3 Update Service Properties + +This procedure is used by the Content Provider for updating the service properties at the BM-SC. The Content Provider shall use HTTP PUT or HTTP PATCH, corresponding to complete or partial update of service properties, respectively, for this purpose. + +#### 4.4.4.4 Delete Service + +This procedure is used by the Content Provider to terminate the service at the BM-SC. The Content Provider shall use HTTP DELETE for this purpose. + +#### 4.4.4.5 Service Notifications + +This procedure is used by the BM-SC to send service related notifications to the Content Provider. + +### 4.4.5 Session Management Procedures + +#### 4.4.5.1 Create Session + +This procedure is used by the Content Provider to create a session for a previously created service at the BM-SC. The Content Provider shall use HTTP POST for this purpose. A successfully created session is associated with a resource identifier which is used by the Content Provider to discover, update and delete the session. + +#### 4.4.5.2 Get Session Properties + +This procedure is used by the Content Provider to obtain the session properties of a service from the BM-SC. The Content Provider shall use HTTP GET for this purpose. + +#### 4.4.5.3 Update Session Properties + +This procedure is used by the Content Provider for updating the session properties of a session at the BM-SC. The Content Provider shall use HTTP PUT or HTTP PATCH, corresponding to complete or partial update of session properties, respectively, for this purpose. + +If the V2X Localized User Plane feature is supported, the Content Provider may wish to update the session properties for Local MBMS based MBMS data delivery. If so, and the BM-SC decides to use the Local MBMS information, the BM-SC shall use the received BM-SC IP address and port for user plane data delivery. + +NOTE: The Local MBMS information is pre-configured in the Content Provider. At reception of such information, the BM-SC will further send the M1 interface information (e.g. MBMS eNB multicast address and GW source specific multicast address) to the MBMS-GW as specified in 3GPP TS 29.061 [20]. + +If the MCExtension feature is supported, the content provider acting as a mission critical service provider may include: + +- additional properties for resource allocation control (*mc-extension* in table 5.2.2.1-1); and +- specific semantic and syntax for the geographical area (clause 5.4.7 of 3GPP TS 26.348 [33]). + +#### 4.4.5.4 Delete Session + +This procedure is used by the Content Provider to terminate a session of a service at the BM-SC. The Content Provider shall use HTTP DELETE for this purpose. + +# --- 5 xMB API + +## 5.1 Overview + +### 5.1.0 General + +The xMB API is a RESTful API that allows Content Providers to provision broadcast services over 3GPP networks and subsequent ingestion of service content for distribution using eMBMS. The xMB API defines a set of resources and the related procedures for the creation and management of broadcast services and sessions are described in clause 5.2. The corresponding JSON schema for the representation of the resources and operations defined by the xMB API is provided in its complete form in Annex B. The syntax follows the rules defined by the OpenAPI specification [22]. + +### 5.1.1 Supported Methods + +The xMB API follows the RESTful design principles. All operations SHALL be performed using HTTP 1.1 (IETF RFC 7231 [6]) over TLS (3GPP TS 33.246[24]). + +Table 5.1.1-1 gives a summary of the supported HTTP methods and their applicability on a per resource basis. + +Table 5.1.1-1: Summary of supported HTTP methods of xMB API + +| HTTP Method | CRUD | Resource | PATH | +|-------------|---------|--------------|--------------------------------------------------------------------------------------| +| POST | Create | Service | /xmb/v1.0/services | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions | +| GET | Read | Service | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | +| | | Report | /xmb/v1.0/reports?query
or
/xmb/v1.0/reports/{report-res-id} | +| | | Notification | /xmb/v1.0/notifications?query
or
/xmb/v1.0/notifications/{notification-res-id} | +| PUT | Replace | Service | /xmb/v1.0/services/{service-res-id} | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | +| PATCH | Modify | Service | /xmb/v1.0/services/{service-res-id} | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | +| DELETE | Delete | Service | /xmb/v1.0/services/{service-res-id} | +| | | Session | /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} | + +### 5.1.2 Error Handling + +The xMB API shall use the HTTP status codes to indicate any errors that might occur in the processing of operations on xMB resources. Unless defined otherwise, the HTTP status codes shall be interpreted as specified in IETF RFC 7231 [6]. API operations that are not successfully handled shall not leave the resource at an undefined state. The response should provide sufficient information for a human operator to understand and locate the error. + +API operations that do not follow the security procedures defined in clause 7 shall be rejected without any impact on the resources. + +Errors may also happen during the content ingestion and shall be notified to the Content Provider in a timely manner depending on the severity of the error. + +### 5.1.3 xMB Entry Point Discovery + +The Content Provider shall be able to discover the entry point to the xMB interface by one of the following methods: + +- It is provided with the URL that serves as the entry point for the xMB-C interface; +- It acquires that entry point URL from DNS resolution of the following Fully Qualified Domain Name (FQDN): + +.mcc.pub.3gppnetwork.org>, + +in which case the Content Provider shall build the following URL for the entry point of the xMB interface: + +.mcc.pub.3gppnetwork.org/xmb/v1.0/>. + +### 5.1.4 Content type + +The bodies of HTTP request and successful HTTP responses shall be encoded in JSON format (see IETF RFC 8259 [34]). + +The MIME media type that shall be used within the related Content-Type header field is "application/json", as defined in IETF RFC 8259 [34]. + +JSON object used in the HTTP PATCH request shall be encoded according to "JSON Merge Patch" (IETF RFC 7396 [35]) but within the related Content-Type header field the MIME media type shall be signalled as "application/json". + +NOTE: In this Release of the specification only MIME media type "application/json" is supported. + +## 5.2 Resources + +### 5.2.1 Services + +#### 5.2.1.0 General + +The Content Provider shall configure services at the BM-SC using the REST API methods over two resources managed at the BM-SC. + +Table 5.2.1-1 summarizes different resources for provisioning and managing services at the BM-SC. + +**Table 5.2.1-1: Resources for managing services at BM-SC** + +| Resource Name | Resource Type | Description | +|---------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| service | Instance resource | Represents a single service resource. The Content Provider can provision or modify a single service at the BM-SC by invoking REST API requests to this service resource at the BM-SC. | +| services | Collection Resource | Represents a collection of service resources. | + +#### 5.2.1.1 Properties + +Each service resource described in Table 5.2.1-1 has the set of properties described in Table 5.2.1.1-1. The Content Provider shall modify one or more of the properties of the service resource using the API operations described in clause 5.2.1.2. + +Table 5.2.1.1-1 summarizes different service properties of a service resource. + +Table 5.2.1.1-1: Properties of service resource + +| Property Token | JSON Value Type | Defaults | | | Property Description | Applicability (NOTE) | +|-------------------------------------|-----------------|-----------------|-------|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| | | Child Parameter | Units | Values | | | +| service-id | string | | None | N/A | Identifies the MBMS User Service as defined in clause 11.2.1.1 of 3GPP TS 26.346 [3] | | +| service-class | string | | None | (operator defined default) | The service class that service belongs to. (see serviceClass element in clause 11.2.1.2 of 3GPP TS 26.346 [3]). | | +| service-languages | array | | None | Empty list | List of language of the service content. (see serviceLanguage element in clause 11.2.1.1 of 3GPP TS 26.346 [3]). | | +| service-names | array | | None | Empty list | List of Service Names. (see name element in clause 11.2.1.1 of 3GPP TS 26.346 [3]) | | +| receive-only-mode | boolean | | None | False | When set to 'true', the Content Provider indicates that the service is a Receive Only Mode service. | | +| service-announcement-mode | string | | None | SACH | Enumeration of Service Announcement Mode.
Additional service announcement modes may be added in the future.
- "SACH": BM-SC performs the service announcement for the current service using the SACH channel (cf. Annex L.2, L3 of 3GPP TS 26.346 [3]).
- "Content Provider": BM-SC provides the necessary service access information used by the Content Provider to create the service announcement information. | | +| consumption-reporting-configuration | object | | | | The Content Provider wishes to collect consumption reports for the service.
Reporting start and end time: The reporting period with start and end time.
Reporting interval: The interval for which the BM-SC is aggregate the statistics in seconds. (Data type: number; default value: 3600)
Sample percentage: Percentage of users to collect reports from (Data type: number; default value: 10)
The presence of this object indicates the enabling of consumption reporting; if not present, it indicates the disabling of the consumption reporting. | | +| push-notification-url | string | | None | "" | The Content Provider provides Notification URL over which it will receive notifications "pushed" by the BM-SC. The Notification procedure is described in clause 5.3.6. of 3GPP TS 26.348 [33] | | +| push-notification-configuration | string | | None | All | If the Content Provider enables push delivery of notifications, then the Content Provider may provide notification filters
This parameter contains a comma separated list of Classes it wishes to receive among the following options:
Critical, Warning, Information, Service, Session, or All to get all types of notification.
The notification message shall be sent immediately to the Content Provider upon | | + +| | | | | | | | +|-------|-------------------------------------------------------------------------------------|--|--|--|-------------------|--| +| | | | | | its availability. | | +| NOTE: | Properties marked with a supported feature are applicable as described in clause 9. | | | | | | + +The service instance resource with the properties defined above can be found in Annex B. + +#### 5.2.1.2 API Operations + +##### 5.2.1.2.1 Introduction + +Services can be created, updated, or deleted at the BM-SC by the Content Provider, or the properties of a previously created service at the BM-SC may be obtained by the Content Provider, by invoking HTTP methods on the "service" instance resource or the "services" collection resource. + +##### 5.2.1.2.2 Service Creation + +POST /xmb/v1.0/services + +To create a service, the Content Provider shall use the HTTP POST method on the "services" collection resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services". +- the Host field is set to the address of the BM-SC + +The Content Provider shall follow the procedures defined in clause 9 to advertise support of any feature. + +The content body of the POST request shall be empty. Upon receipt of the HTTP POST request from the Content Provider to create a service, the BM-SC will check whether the Content Provider is authenticated and authorized to create services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.1.2.2-1. If the authorization is successful, the BM-SC shall create a service with default service property values as described in clause 5.2.1.1. Upon successful creation of a service, the BM-SC shall respond to the Content Provider with a 201 message indicating that the service is successfully created along with the service resource identifier of the service resource. The service resource identifier is the identifier that uniquely identifies the service. When the Content Provider receives the service resource identifier, it shall use this identifier in subsequent requests to the BM-SC to refer to this service. Alternatively, if the creation of service failed, the BM-SC shall send a 403 message to the Content Provider. + +Both the Content Provider and BM-SC shall remember the negotiated features for the lifetime of the service. + +The possible response messages from the BM-SC, depending on whether the POST request is successful or unsuccessful, are shown in Table 5.2.1.2.2-1. + +**Table 5.2.1.2.2-1: Response status code, message, and contents for service creation** + +| Status Code | Message | Contents | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 201 Created | Service created successfully | The BM-SC shall send the service resource identifier of the created service. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 412 Precondition Failed | Request cannot be fulfilled | The precondition given in one or more of the request-header fields evaluated to false when it was tested on the recipient. | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +##### 5.2.1.2.3 Service Modification + +###### 5.2.1.2.3.1 Partial Modification of Service Properties + +PATCH /xmb/v1.0/services/{service-res-id} + +Assuming that a service has been created using the service creation method described in clause 5.2.1.2.2, partial updating of its properties can be performed by the Content Provider using the HTTP PATCH method on the "service" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}" +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The content body of the service modification request shall contain updated partial representation of the service resource. The representation of the service is based on the JSON schema of the service resource as described in clause 5.2.1.1. Further, one or more properties of the service listed in Table 5.2.1.1-1, with the exception that the value of the properties "id", "service-id", "pull-notification-url" and "receive-only-mode" cannot be modified. + +Upon receipt of the HTTP PATCH request from the Content Provider to update a service, the BM-SC will check whether the Content Provider is authenticated and authorized to update services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message. If the authorization is successful, the BM-SC shall update the requested service. Upon successful updating of the requested service, the BM-SC shall respond to the Content Provider with a 200 OK message indicating that the service is successfully updated along with the updated service resource. If the service was not found, the BM-SC shall send a 404 Not Found message. If the service cannot be updated, the BM-SC shall send a 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the PATCH request is successful or unsuccessful, are shown in Table 5.2.1.2.3.1-1. + +**Table 5.2.1.2.3.1-1: Response status code, message, and contents for service modification using HTTP PATCH** + +| Status Code | Message | Contents | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource that is modified | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +###### 5.2.1.2.3.2 Full Modification of Service Properties + +PUT /xmb/v1.0/services/{service-res-id} + +Assuming that a service has been created using the service creation method described in clause 5.2.1.2.2, full modification of its properties can be performed by the Content Provider using the HTTP PUT method on the "service" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}" +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" + +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The content body of the service update request shall contain the updated representation of the service resource. The representation of the service is based on the JSON schema of the service resource as described in clause 5.2.1.1. Furthermore, when HTTP PUT method is used for updating the service, the Content Provider shall specify the updated values of all the service properties with the exception that the value of the properties "id", "service-id", "pull-notification-url" and "receive-only-mode" cannot be modified. + +Upon receipt of the HTTP PUT request from the Content Provider to update a service, the BM-SC will check whether the Content Provider is authenticated and authorized to update services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.1.2.3.2-1. If the authorization is successful, the BM-SC update the requested service. While updating the service representation, the BM-SC shall overwrite the values of all properties of the service being updated with the values provided in the update request. Upon successful update of the requested service, the BM-SC shall respond to the Content Provider with a 200 OK success message indicating that the service is successfully updated along with the updated service resource. If the service was not found, the BM-SC shall send a 404 Not Found message. If the service cannot be updated, the BM-SC shall send a 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the PUT request is successful or unsuccessful, are shown in Table 5.2.1.2.3.2-1. + +**Table 5.2.1.2.3.2-1: Response status code, message, and contents for service modification using HTTP PUT** + +| Status Code | Message | Contents | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|----------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource that is modified | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +##### 5.2.1.2.4 Service Deletion + +DELETE /xmb/v1.0/services/{service-res-id} + +To delete a service, the Content Provider shall use the HTTP DELETE method on the "service" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}" +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +Upon receipt of the HTTP DELETE request from the Content Provider to delete a service, the BM-SC will check whether the Content Provider is authenticated and authorized to delete services as described in clause 7. If the + +authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.1.2.4-1. If the authorization is successful, the BM-SC shall delete the requested service. Upon successful deletion of requested service, the BM-SC shall respond to the Content Provider with a 200 OK success message indicating that the service is successfully deleted along with the service resource identifier of the service that is deleted. If the service was not found, the BM-SC shall send a 404 Not Found message. If the service cannot be deleted, the BM-SC shall send 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the DELETE request is successful or unsuccessful, are shown in Table 5.2.1.2.4-1. + +**Table 5.2.1.2.4-1: Response status code, message, and contents for service deletion** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|----------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier of the service that is deleted | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +##### 5.2.1.2.5 Service Retrieval + +Services can be read when the Content Provider wishes to know the latest representation of the service resource at the BM-SC. + +###### Retrieval of a specific Service + +GET /xmb/v1.0/services/{service-res-id} + +The retrieval of a service shall be performed by the Content Provider using the HTTP GET method on the "service" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}" +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +Upon receipt of the HTTP GET request from the Content Provider, the BM-SC will check whether the Content Provider is authenticated and authorized to read services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.1.2.5-1. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 OK message along with the service information. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The content body of this response message shall be the representation of the requested service based on the JSON schema of service resource as described in clause 5.2.1.1. The properties "service-id", "service-class", and "service-announcement-mode" shall be included in the response to the Content Provider. All other properties of the service instance are optional to be returned to the Content Provider. + +Alternatively, if the service was not found, the BM-SC shall send a 404 Not Found message. If the request cannot be fulfilled, the BM-SC shall send a 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.1.2.5-1. + +**Table 5.2.1.2.5-1: Response status code, message, and contents for service modification using HTTP GET** + +| Status Code | Message | Contents | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|-------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service representation of the service resource to the Content Provider | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +###### Retrieval of all Services + +GET /xmb/v1.0/services + +The retrieval of all services shall be performed by the Content Provider using the HTTP GET method on the "services" instance resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services" +- the Host field is set to the address of the BM-SC + +Upon receipt of the HTTP GET request from the Content Provider, the BM-SC will check whether the Content Provider is authenticated and authorized to read services as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.1.2.5-2. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 OK message along with information of all services configured at the BM-SC. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the representation of the list of all services configured at the BM-SC where each service representation is based on the JSON schema of service resource as described in clause 5.2.1.1. The properties "service-id", "service-class", and "service-announcement-mode" shall be included for each service representation in the response to the Content Provider. All other properties of the service instance are optional to be returned to the Content Provider. + +Alternatively, if there are no services configured at the BM-SC, the BM-SC shall send message content in the 200 OK message indicating to the Content Provider that there are no services configured at the BM-SC. If the request cannot be fulfilled, the BM-SC shall send a 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.1.2.5-2. + +**Table 5.2.1.2.5-2: Response status code, message, and contents for service modification using HTTP GET** + +| Status Code | Message | Contents | +|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | If there are services configured at the BM-SC, the BM-SC shall send the representations of all the configured services to the Content Provider. If there are no services configured at the BM-SC, the BM-SC shall | + +| | | | +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------| +| | | send message content in this message that there are no services configured at the BM-SC | +| 401
Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403
Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +### 5.2.2 Sessions + +#### 5.2.2.0 General + +The Content Provider shall configure sessions at the BM-SC using the RESTful API methods over two resources managed at the BM-SC. + +Table 5.2.2-1 summarizes different resources for provisioning and managing sessions at the BM-SC. + +**Table 5.2.2-1: Resources for managing sessions at BM-SC** + +| Resource Name | Resource Type | Description | +|---------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Session | Instance resource | Represents a single session resource. The Content Provider can provision or modify a single session at the BM-SC by invoking REST API requests to this session resource at the BM-SC. | +| Sessions | Collection Resource | Represents a collection of session resources. | + +Since sessions are configured for each service, the session instance resource or the sessions collection resource are referenced through a particular service. + +#### 5.2.2.1 Properties + +Each session resource described in Table 5.2.2-1 has the set of properties described in Table 5.2.2.1-1. The Content Provider shall modify one or more of the properties of the session resource using the API operations described in clause 5.2.2.2 + +Table 5.2.2.1-1 summarizes the different properties of a session resource. + +**Table 5.2.2.1-1: Properties of session resource** + +| Property Token | JSON Value Type | Defaults | | Parameter Description | Applicability (NOTE) | +|--------------------|-----------------|--------------------------------------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| session-start | number | UTC Date timestamp (with second precision) | Session creation date + 1h | Time at which the MBMS Bearer become active. | | +| session-stop | number | UTC Date timestamp (with second precision) | Session start date + 1h | Time at which the MBMS bearer becomes inactive. | | +| max-ingest-bitrate | number | kbps | 0 | This requested bitrate by the Content Provider for content ingestion at the BM-SC, which excludes FEC overhead and transport overhead. The BM-SC calculates the MBMS Bearer bitrate from | | + +| | | | | | | +|--------------------------------|---------------|--------------------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | its value, considering overhead like FEC and other transport overheads. The session bitrate is always larger than or equal to the payload bitrate | | +| max-delay | number | ms | -1 | Specifies the maximum delay the MBMS System should add, i.e. from the time a packet is received by the BM-SC to the time when the packet should be received by the MBMS client. | | +| session-state | string | None | Idle | The BM-SC may automatically change the state of the session.

Possible states: "Session Idle", "Session Announced", "Session Active". | | +| service-announcement-starttime | number | UTC Date timestamp (with second precision) | None | When present, the wall-clock time at which the BM-SC shall start service announcement. If absent, the BM-SC may automatically start service announcement when it has all the data needed to perform such service announcement. | | +| geographical-area | string | None | Empty list | Geographical area to which the service is to be provided, via either unicast or MBMS bearers. The BM-SC derives the MBMS service area and the SAI list corresponding to the geographical area as provided by the Content Provider.

The Geographical Area contains list of string.

If the mc-extension property is present and the MCExtension feature is supported, the content of each string follows the format specified by clause 5.4.7 of 3GPP TS 26.348 [33].

Else, the content of each string item is left to the business agreement between the Content Provider and the Operator. | | +| qoe-reporting-configuration | object | | | The Content Provider wishes to collect QoE reports for the session. The Content Provider can supply a list of QoE metric configurations where each metric configuration shall contain:

Metric name: Name of QoE metric

Metric type: Type of metric

Reporting interval: The interval at which the BM-SC should periodically aggregate and report the statistics to the Content Provider.

Sample percentage: Percentage of users to collect reports from

Start time: Start time of report collection

End time: End time of report collection

If this configuration is included, the QoE | | + +| | | | | | | +|--------------|---------|------|-------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| | | | | reporting configuration shall be applied only for this session., and the Content Provider is requesting override of service level configuration for this session by this configuration. | | +| session-type | string | None | Files |

The Session Type represents the method used by the Content Provider in providing content to the BM-SC (via xMB-U). The BM-SC shall select the appropriate delivery method from the Session Type.

Valid values: "Streaming", "Files", "Application", "Transport-Mode"

When the Session Type is set to "Streaming", the BM-SC expects a Streaming type input (RTP), and the format shall compliant to MBMS streaming (as defined in 3GPP TS 26.346 [3]).

When the Session Type is set to "Files", the BM-SC expects generic files as input. The files can be provided either by on-request pull interactions or continuous push ingest.

When the Session Type is set to "Application", then the ingest method depends on the application service description.

When the Application Service Description corresponds to DASH, the BM-SC expects an MPD and optionally one or more Initialization Segments. The content is assumed to be 3GP-DASH compliant (as defined by 3GPP TS 26.247 [18]). The BM-SC may either pull the Media Segments from the Content Provider or the Content Provider will continuously push Media Segments to the BM-SC.

When the Session Type is set to "Transport-Mode", the BM-SC provides transport of data/TV content in a transparent manner. The Content Provider may provide some properties for the MBMS distribution.

The Session Type shall be extensible to include other session types.

| | +| max-cid | integer | none | none |

integer indicating the MAX CID parameter for the compressor (see IETF RFC 5795 [27]). The value for the LARGE_CID parameter (usage of short CID representation or large CID representation) shall be deducted from MAX_CID as follows:

If MAX_CID > 15 then LARGE_CIDS = TRUE else LARGE_CIDS = FALSE.

When header compression applies, the "max-cid" property shall be provided together with "header-compression" property.

| ROHC | + +| | | | | | | +|--------------------|----------------|------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| header-compression | object | none | none |

Requests the BM-SC to enable ROHC (see IETF RFC 5795 [27] and IETF RFC 3095 [28]) on the input flow. The object consists of:

  • - "ipv4addr": String identifying an IPv4 address formatted in the "dotted decimal" notation as defined in IETF RFC 1166 [31].
  • - "ipv6addr": String identifying an IPv6 address formatted according to clause 4 of IETF RFC 5952 [32]. The mixed IPv4 IPv6 notation according to clause 5 of IETF RFC 5952 shall not be used.
  • - "port": integer between 0 and 65535 identifying a UDP or TCP port
  • - "periodicity": a number denoting the target periodicity for ROHC full header packets in units of seconds
  • - "profile": integer denoting the applicable ROHC profile (see IETF RFC 5795 [27]). The value is restricted to the 0x0001 RTP/UDP/IP profile or the 0x0002 UDP/IP profile, 0x0001 profile applies if omitted.

Either "ipv4addr" or "ipv6addr" shall be included and "port" and "periodicity" may be included.

The BM-SC shall:

  1. 1. apply the procedures in IETF RFC 5795 [27] and in IETF RFC 3095 [28] to provide header compression to downlink IP packets and possibly higher protocol layers within the user plane data;
  2. 2. use the ROHC profile requested in the "profile" property for downlink packet which belongs to any of the flows listed in this property;
  3. 3. use the 0x0000 uncompressed profile for any downlink packet which does not belong to any of the flows listed in this property; and
  4. 4. use the ROHC unidirectional mode (see IETF RFC 3095 [28]) without ROHC segmentation (see IETF RFC 5795 [27]).
| ROHC | +| fec | string | none | none | Requests the BM-SC to perform FEC (see IETF RFC 6363 [29]) protection of the input flow when transmitting over the MBMS channel. The string shall include an SDP description of FEC framework configuration information (see clause 5.5 of IETF RFC 6363 [29]) formatted according to clause 8A.5 of 3GPP TS 26.346 [3]. | FEC | +| resource- | boolean | none | false | The resource sharing indication. | ResourceSharing | + +| | | | | | | +|------------------------------------------|--------|----------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| sharing-ind | | | | When present and set to "true", it implies the current transmission resources can be shared with other sessions.

Note that other sessions will use the same Max Bitrate, Geographical Area and (in case of MC Services) QoS-Information. | | +| resource-sharing-url | string | none | none | The resource sharing id.

When present in the session modification request, the value of the field identifies an existing xMB session resource URL (as specified in table 5.1.1-1) to share the transmission, where Max Bitrate, Geographical Area and (in case of MC Services) QoS-Information are re-used.

Note that the Max Bitrate, Geographical Area and (in case of MC Services) QoS-Information cannot be changed since the values from the original session will be used. | ResourceSharing | +| session-announcement-mode | string | – None – | Other | Represents the session announcement mode. The session announcement mode is either "Content Provider" or "SACH", with the following behavior:

"Content Provider": The BMSC generates the session parameters and provides those to the Content Provider.

"SACH": In this case, the session announcement is done by the MBMS system through the SACH. (see Annex L.2, L.3 of 3GPP TS 26.346 [3]).

Additional modes may be added in future releases.

Only applicable if the Session Type is set to "Transport-Mode" | Transport | +| userplane-session-description-parameters | object | | | This property provides information to the BM-SC on where and how to access the user plane content from the content provider, and comprises one or more of the following components:

Type : the type of the content associated with the target resource, for example the Internet Media Type of the resource as identified by an HTTP/S URL. An "embedded" type is defined, which indicates that the xMB-U user plane parameters are embedded in the User Plane Parameters object described below.

Access URL : A URL that enables the access to and possibly control of the ingest session. The URL may, for example, be an RTSP URL, a reference to an SDP that describes a multicast stream, or an | Transport | + +| | | | | | | +|---------------------------------------|--------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| | | | |

HTTP/S URL to retrieve an already-packaged MPEG2-TS stream.

User Plane Parameters: When the Type is set to "embedded", the Content Provider shall provide an object to the BM-SC which contains the session description.

If this property is set to Forward-only, the object may contain a ready-made Session Description and the indication of a single xMB-U reception UDP port. When a Session Description is present, the BM-SC shall use it for Service Announcement.

If this property is set to Proxy, the object shall contain a Session Description template and a list of the transmitted UDP flows to be forwarded on the established MBMS bearer for the session. For each list entry, the content provider shall indicate whether a) this UDP flow is directly associated with a media description entry in the Session Description Template – i.e., an "m=" line is present in the template and which contains a port field, or b) this UDP flow is related to a media description entry – e.g., it corresponds to an RTCP flow affiliated with the RTP flow as described by the RTP/AVP profile). If the flow is directly associated with a media description entry, then the BM-SC shall modify the port field of the media description entry in the Session Description Template. If the flow is related to a media description entry, then the BM-SC shall simply forward the flow onto a port whose value is equal to the port of the related media session plus an offset.

Note the BM-SC may get input on session properties from the content provider, e.g. bitrate, depending on the ingest session.

| | +| userplane-delivery-mode-configuration | string | – None – | Forward-only |

This property defines how the session needs to be delivered to the application, i.e. it basically establishes the delivery mode.

Mode Enumeration: Specifies the delivery mode.

Forward-only: The BM-SC receives complete IP Multicast packets for to be forwarded.

| Transport | + +| | | | | | | +|-----------------------------------------|--------|-----------|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------| +| | | | |

The Content Provider will create the IP multicast packets.

Proxy: The BM-SC proxies the incoming UDP payloads to the outgoing UDP payloads. The BM-SC will create the IP multicast packets.

Only applicable if the Session Type is set to "Transport-Mode".

| | +| delivery-session-description-parameters | string | | |

The contents of this property depend on the setting of the Session Announcement Mode property. If Session Announcement Mode is set to "Content Provider", then at minimum the following session parameters shall be provided by the BM-SC:

TMGI of the MBMS Bearer

For Receive Only Mode service, the TMGI shall be allocated from the range specified in 3GPP TS 24.116 [25]. Note that additional session parameters may be provided, based on the configuration options of the delivery method set to "Transport-Mode".

Only applicable if the Session Type is set to "Transport-Mode".

| Transport | +| sdp-url | string | – None – | "" |

A URL to the SDP that describes the streaming session between the Content Provider and the BM-SC, which will be used for BM-SC ingestion of the streaming session via xMB-U. The SDP shall include the RTSP links for every media session as part of the "a=control" attribute to enable RTSP control of the session. The SDP shall also contain the required bitrate for each of the media sessions.

The content shall conform to the constraints of this specification.

Only applicable if the Session Type is set to "Streaming".

| RTPStreaming | +| time-shifting | number | second | 0 |

Indicates if and for how long time shifting access to the content (using unicast) may be provided for this session.

If not set (so defaulted to 0), there shall be no time shifting access.

Only applicable if the Session Type is set to "Streaming".

| RTPStreaming | +| application-service | string | MIME type | application/dash+xml |

Internet Media Type of the Application Service

Only applicable if the Session Type is set to "Application".

To refer to 5GMS DASH content, the MIME content type may include a profile parameter including the profile of 5G

| ApplicationPush, ApplicationPull | + +| | | | | | | +|----------------------------|--------|------|----------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| | | | | Media Streaming as "urn:3GPP:5GMS:iop:DASH", as defined in DASH in clause 7.3.11 of 3GPP TS 26.247 [18]. | | +| ingest-mode | string | None | "Push" when Session Type is set to "Application"

"Pull" when Session Type is set to "Files" |

The ingest mode enumerates how resources are ingested into the BM-SC via xMB-U.

When the Session Type is set to "Application":

Pull: The BM-SC pulls the resources as described by the application entry point document.

Push: The Content Provider pushes resources. The BM-SC needs to provide a push URL.

In case of DASH, resources are Media Segments:

Pull: The BM-SC pulls the Media Segments as described by the Segment availability start time from a DASH MPD.

Push: The Content Provider pushes Media Segments, so that the Media Segment is available on the BM-SC according to Segment availability start time. The BM-SC needs to provide a push URL.

When the Session Type is set to "Files":

Push: The Content Provider shall push the file to the BM-SC that will immediately process and deliver as soon as it is ready. The BM-SC may be configured to ignore all files that are pushed before session active time, or store them. In case of Push mode, the BM-SC shall provide back to the Content Provider the URL the Content Provider shall use to push the files.

Pull: In this case, the Content Provider provides the resource location from which the BM-SC will fetch the file. The Content Provider may tell the BM-SC when to start fetching the file.

| ApplicationPush, ApplicationPull, FilePush, FilePull | +| application-entrypoint-url | string | None | "" |

The application entry point refers to an MPD when Application Service Description pertains to DASH.

When the Ingest Mode is set to Push, the MPD URL refers to a DASH MPD which should be fetched, optionally conditioned, and then inserted into Service Announcement.

When the Ingest Mode is set to Pull, then the BM-SC will fetch the Segments using unicast.

| ApplicationPush, ApplicationPull, | + +| | | | | | | +|------------------|---------|------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------| +| | | | | Note that if not set to a valid URL, the session will not be started. | | +| push-url | string | None | "" |

When the Session Type is set to "Application":

A resource locator for ingesting Media Segments using HTTP via xMB-U. The Content Provider may create additional sub-resources using WebDAV procedures.

This is a read-only property managed by the BM-SC and only present when Ingest Mode is set to Push

This property is mandatory if the Session type is set to "Application" and Ingest Mode is set to Push.

When the Session Type is set to Files:

A resource locator for ingesting content using HTTP via xMB-U.

This is a read-only property managed by the BM-SC and only present when Ingest Mode is set to Push.

| ApplicationPush, FilePush | +| unicast-delivery | boolean | None | False |

Indicator whether the content is also available for unicast retrieval.

Only applicable if the Session Type is set to "Application".

If set "true", the application client may access the content referenced in the application entry point from a unicast content server or a 5GMS AS.

| ApplicationPush, ApplicationPull, | +| Components | array | None | Empty list |

List of components of the application, which are recommended to be made available on MBMS Bearers.

In case of DASH, each component is identified by a representation identifier.

Only applicable if the Session Type is set to "Application".

| ApplicationPush, ApplicationPull, | +| file-list | array | | |

List of files to be sent.

In the Push mode, the file list is not used since the BM-SC will monitor its push folder and send the files it receives on a first-come first-served basis.

In Pull mode, the file list contains the following information per file entry:

file URL: the URL to the file the BM-SC will use to fetch the content

| FilePull, FileRepair (NOTE 2) | + +| | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

file display URL: The URL to the file as seen by the UE

byte-range (optional): If present and set to "true", indicates that the HTTP(S) URL given in the file display URL parameter can be used for Byte-Range-Based file repair (clause 9.3 of 3GPP TS 26.346 [3]) otherwise file display URL parameter should not be used for Byte-Range-Based file repair

e-tag (optional): represents the value of the ETag as defined in IETF RFC 7232 [38] which may also serve as the version identifier for the file in the Byte-Range-Based file repair requests. The ETag should only be supplied by the 3rd party content provider if it is expected that it is different from the one provided over xMB-U when fetching the file.

file earliest fetch time: The BM-SC shall fetch the file no sooner than this UTC timestamp. If absent, then the file shall be present on the Content Provider server and the BM-SC may fetch it at a time of its choosing.

file latest fetch time: The BM-SC shall fetch the file no later than this UTC timestamp. If absent, then the file shall be present on the Content Provider server and the BM-SC may fetch it at a time of its choosing.

file size (optional): The Content Provider may provide the precise or a file size estimate as input. The BM-SC may update the file size once it has started to fetch the file.

file status: Enumeration stating the state of the file. Possible values are pending, fetched, prepared, transmitting, sent.

Target reception completion time (on the MBMS Client): hint on the deadline by which target time the file should be completely received by the UE. The BM-SC should schedule and order the transmission accordingly.

Keep Updated Interval: The BM-SC checks the file resources with the given interval for changes.

Unicast availability: Indication that the file is also available for unicast retrieval by the application at a Content Provider server whose location is given by the HTTP(S)

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

URL corresponding to the value of "file display URL".

File repetition: The number of times the file shall be sent on the session (a value of 1 means the file shall be sent only once). This counter shall be decreased by one each time the file has been transmitted. When the counter reaches zero the file will cease to be delivered. The BM-SC may send FEC instead of source information.

Note that the expected behavior is that the BM-SC will first send all files in the order of the File List, then decrement the file repetition counter for each file, and subsequently retransmit the list again (only files with counter > 0 are transmitted). This is repeated until all repetitions are completed, or the session stop time has elapsed, whichever event occurring first.

Periodic update interval: When present, it is an indication that this file of the list of files is expected to be periodically updated, and the value of this parameter represents the nominally expected time interval between successive updates of this file. This parameter is a signal to the BM-SC to deliver the file and its updates as a Datacasting service. From its value, the BM-SC will choose the delivery mode ('scheduled-and-periodic' or 'back-to-back'), and set the associated interval and @mode values in controlling the transmission of the Datacasting service.

| | +| file-delivery-manifest-url | string | None | "" |

Alternative to the file list for describing file properties and delivery requirements. The resource may additionally describe scheduling information for the file.

Only applicable if the Session Type is set to Files.

| FilePush, FilePull | +| display-base-url | string | None | "" | When ingest mode is set to Push, the Base URL as seen by the UE. | FilePush | +| sa-file-url | string | None | "" | When the service announcement mode is set to "Content provider", the BM-SC returns the URL of the SA file announcing the session. The BM-SC shall follow the profile 1c (Annex L.3 of 3GPP TS 26.346 [3]) | SaProfile | +| local-mbms-delivery-information | object | | | The Content Provider may request the BM-SC to activate an MBMS bearer for local MBMS based MBMS data delivery. If | LocalMBMS | + +| | | | | | | +|--------------|--------|------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| | | | |

so, the Content Provider shall provide:

MBMS eNB IPv4 multicast address:
Contains the M1 (transport) plane IPv4 destination multicast address used by MBMS-GW for IP multicast encapsulation of application IP multicast datagrams.

MBMS eNB IPv6 multicast address:
Contains the M1 (transport) plane IPv6 prefix of destination multicast address used by MBMS-GW for IP multicast encapsulation of application IP multicast datagrams.

MBMS GW IPv4 SSM address:
Contains the value of MBMS-GW's IPv4 address for Source Specific Multicasting.

MBMS GW IPv6 SSM address:
Contains the value of MBMS-GW's IPv6 address for Source Specific Multicasting.

Common Tunnel Endpoint Identifier:
Indicates the common tunnel endpoint identifier of MBMS GW for user plane.

BM-SC IPv4 address: Indicates the destination IPv4 address of the BM-SC for the reception of user plane data via the xMB-U interface.

BM-SC IPv6 address: Indicates the destination IPv6 address of the BM-SC for the reception of user plane data via the xMB-U interface.

BM-SC port: Indicates the destination UDP port of the BM-SC for the reception of user plane data via the xMB-U interface.

| | +| group-ids | array | None | Empty list |

This parameter contains a list of group identifiers, applicable if the service-announcement-mode is set to "SACH".

It is used by the BM-SC in the service announcement for identifying UE belonging to a group.

| GroupContentDelivery | +| mc-extension | object | | |

If the MCExtension feature is supported, the Content Provider may request the BM-SC to activate an MBMS bearer with a specific QoS. If so, the Content Provider shall provide the following QoS properties in the session modification operation, to be used by the BM-SC within the QoS-Information AVP during the MBMS Session start procedure (3GPP TS 29.061 [20]):

gbr: Guaranteed bitrate for the MBMS session in unit kbps. The BM-SC shall use this value for the

| MCExtension | + +| | | | | | | +|---------------------------------------------------------------------------------------------|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

Guaranteed-Bitrate-DL AVP. The difference between the max-ingest-bitrate and gbr can be used by the BM-SC as a budget for FEC.

qci: QoS Class identifier. The BM-SC shall use this value for the QoS-Class-Identifier AVP.

arp-priority-level: the BM-SC shall use this value for the Priority-Level AVP within the Allocation-Retention-Priority AVP.

arp-pre-emption-capability: the BM-SC shall use this value for the Pre-emption-Capability AVP within the Allocation-Retention-Priority AVP.

arp-pre-emption- vulnerability: the BM-SC shall use this value for the Pre-emption- Vulnerability AVP within the Allocation-Retention-Priority AVP.

If the Content Provider includes the mc-extension property during the session modification operation, the BM-SC shall return the following property in the session retrieval operation:

tmgi: the TMGI of the MBMS session, as returned by the MBMS Session start procedure in 3GPP TS 29.061 [20], the encoding of TMGI is specified in 3GPP TS 24.008 [37], from octet 3 to 8.

| | +| NOTE 1: Properties marked with a supported feature are applicable as described in clause 9. | | | | | | +| NOTE 2: FileRepair feature is only applicable for byte-range and e-tag properties. | | | | | | + +The session instance resource with the properties defined above for each session can be found in Annex B. + +#### 5.2.2.2 API Operations + +##### 5.2.2.2.1 Introduction + +Sessions can be created, updated, or deleted at the BM-SC by the Content Provider, or the properties of a previously created session at the BM-SC, may be obtained by the Content Provider by invoking HTTP methods on the “session” instance resource or the “sessions” collection resource. + +##### 5.2.2.2.2 Session Creation + +POST /xmb/v1.0/services/{service-res-id}/sessions + +To create a session, the Content Provider shall use the HTTP POST method on the "sessions" collection resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions. +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service for which the session creation is sought. + +The content body of the session creation request shall be empty. + +Upon receipt of the HTTP POST request from the Content Provider to create a session, the BM-SC will check whether Content Provider is authenticated and authorized to create sessions as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message. If authorization is successful, the BM-SC shall verify that the service already exists with the given service resource identifier. If the service with given service resource identifier exists at the BM-SC, the BM-SC shall create the requested session for that service with default session property values described in clause 5.2.2.1. Upon successful creation of requested session, the BM-SC shall respond to the Content Provider with a 201 success message indicating that the session is successfully created along with the session resource identifier of the created session. The session resource identifier is the identifier that uniquely identifies the session within that service. When the Content Provider receives the session resource identifier, it shall use this identifier in subsequent requests to the BM-SC to refer to this session. If the creation of session failed, the BM-SC shall send a 403 message. If the service was not found for which the session creation is sought, the BM-SC shall send a 404 message. + +The possible response messages from the BM-SC, depending on whether the POST request is successful or unsuccessful, are shown in Table 5.2.2.2-1. + +**Table 5.2.2.2-1: Response status code, message, and contents for session creation** + +| Status Code | Message | Contents | +|------------------|------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------| +| 201 Created | Session created successfully | The BM-SC shall send the session resource identifier of the created session. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable | | + +##### 5.2.2.2.3 Session Modification + +###### 5.2.2.2.3.0 General + +Sessions created using the session creation methods described in clause 5.2.2.2.2 can be updated when the Content Provider wishes to modify the session properties. + +###### 5.2.2.2.3.1 Partial Modification of Session Properties + +PATCH /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} + +Assuming that a session has been created using the session creation method described in clause 5.2.2.2.2, partial updating of its properties can be performed by the Content Provider by using the HTTP PATCH method on the "session" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service whose session is being modified. + +The {session-res-id} in the request URI is the session resource identifier of the session that is being modified. + +The content body of the session update request shall contain updated partial representation of the session resource. The representation of the session is based on the JSON schema of session resource as described in clause 5.2.2.1. Furthermore, one or more properties of the session listed in table 5.2.2.1-1 with the exception that the session properties "id", "session-state", "qoe-report-url", "delivery-session-description-parameters" and "push-url" cannot be modified. + +Upon receipt of the HTTP PATCH request from the Content Provider to update a session, the BM-SC will check whether the Content Provider is authenticated and authorized to update sessions as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.2.2.3.1-1. If the authorization is successful, the BM-SC shall verify that the service already exists with the given service resource identifier, and a session already exists with the given session resource identifier. If both of them exist, BM-SC shall update the session as requested for that service. Upon successful update of the requested session, the BM-SC shall respond to the Content Provider with a 200 success message indicating that the session is successfully updated along with the updated session resource. As alternative to the 200 OK message, BM-SC may send a 204 No Content success message without any message content to the Content Provider. If the session cannot be updated, the BM-SC shall send a 403 message. If the session is not found or if the service was not found for which the session creation is sought, the BM-SC shall send a 404 message. + +The possible response messages from the BM-SC, depending on whether the PATCH request is successful or unsuccessful, are shown in Table 5.2.2.2.3.1-1. + +**Table 5.2.2.2.3.1-1: Response status code, message, and contents for session modification using HTTP PATCH** + +| Status Code | Message | Contents | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|----------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the session resource that is modified | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +###### 5.2.2.2.3.2 Full Modification of Session Properties + +PUT /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} + +Assuming that a session has been created using the session creation method described in clause 5.2.2.2.2, full update of its properties can be performed by the Content Provider using the HTTP PUT method on the "session" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} +- the Host field is set to the address of the BM-SC +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {service-res-id} in the request URI is the service resource identifier of the service whose session is being modified. + +The {session-res-id} in the request URI is the session resource identifier of the session that is being modified. + +The content body of the session update request shall contain updated representation of the session resource. The representation of the session is based on the JSON schema of session resource as described in clause 5.2.2.1. Furthermore, when the HTTP PUT method is used for updating the service, the Content Provider shall specify the updated values of all the session properties with the exception that the session properties "id", "session-state", "qoe-report-url", "delivery-session-description-parameters" and "push-url" cannot be modified. + +Upon receipt of the HTTP PUT request from the Content Provider to update a session, the BM-SC will check whether the Content Provider is authenticated and authorized to update sessions as described in clause 7. If the authorization is unsuccessful, the BM-SC shall send a 401 message as described in table 5.2.2.2.3.2-1. If the authorization is successful, + +the BM-SC shall verify that the service already exists with the given service resource identifier, and a session already exists with the given session resource identifier. If both of them exist, BM-SC shall update the session as requested for that service. While updating session representation, the BM-SC shall overwrite the values of all properties of the session being updated with the values from provided in the update request. Upon successful update of the requested session, the BM-SC shall respond to the Content Provider with a 200 success message indicating that the session is successfully updated along with the updated session resource. As an alternative to 200 OK success message, BM-SC may send a 204 No Content success message without any message content to the Content Provider. If the session cannot be updated, the BM-SC shall send a 403 message. If the session is not found or if the service was not found for which the session creation is sought, the BM-SC shall send a 404 message. + +The possible response messages from the BM-SC, depending on whether the PUT request is successful or unsuccessful, are shown in Table 5.2.2.2.3.2-1. + +**Table 5.2.2.2.3.2-1: Response status code, message, and contents for session modification using HTTP PUT** + +| Status Code | Message | Contents | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the session resource that is modified | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +##### 5.2.2.2.4 Session Deletion + +DELETE /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} + +To delete a session, the Content Provider shall use the HTTP DELETE method on the "session" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service whose session is being deleted. + +The {session-res-id} in the request URI is the session resource identifier of the session that is being deleted. + +Upon receipt of the HTTP DELETE request from the Content Provider to delete a session, the BM-SC will check whether the Content Provider is authenticated and authorized to delete services as described in clause 7. If the authorization is unsuccessful, the BM-SC shall send a 401 message as described in table 5.2.2.2.4-1. If the authorization is successful, the BM-SC shall verify that the service already exists with the given service resource identifier and a session exists with the given session resource identifier. If both of them exist, BM-SC shall delete the requested session for the given service. Upon successful deletion of requested session, the BM-SC shall respond to the Content Provider with a 200 success message indicating that the session is successfully deleted along with the service resource identifier and the session resource identifier. As an alternative to the 200 OK success message, BM-SC may send a 204 No Content success message without any message content to the Content Provider. If the session cannot be deleted, the BM-SC shall send a 403 message. If the session is not found or if the service was not found for which the session creation is sought, the BM-SC shall send a 404 message. + +The possible response messages from the BM-SC, depending on whether the DELETE request is successful or unsuccessful, are shown in Table 5.2.2.2.4-1. + +**Table 5.2.2.2.4-1: Response status code, message, and contents for session deletion** + +| Status Code | Message | Contents | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|----------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the session resource identifier of the session that is deleted | +| 204 No Content | The request has succeeded | None | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +##### 5.2.2.2.5 Session Retrieval + +Sessions can be read when the Content Provider wishes to know the latest representation of the session resources at the BM-SC. + +Retrieval of a specific Session of a specific Service + +GET /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} + +The retrieval of a session shall be performed by the Content Provider using the HTTP GET method on the "session" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id} +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The {session-res-id} in the request URI is the session resource identifier of the session that is being retrieved. + +Upon receipt of the HTTP GET request from the Content Provider, the BM-SC will check whether the Content Provider is authenticated and authorized to read services and sessions as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.2.2.5-1. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 OK message and shall include the session resource representation of the session corresponding to the given service to the Content Provider. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the representation of the session configured at the BM-SC for the given service where the session representation is based on the JSON schema of session resource as described in clause 5.2.2.1. The properties "session-start", "session-stop", "max-ingest-bitrate", "session-state", "geographical-area", "session-type", "session-announcement-mode", "session-type", "userplane-delivery-mode-configuration", "sdp-url", "application-service-description", "ingest-mode", "application-entrypoint-url", and "unicast-delivery" shall be included in the response to the Content Provider. All other properties of the session instance are optional to be returned to the Content Provider. + +Alternatively, if the service was not found or if the session was not found, the BM-SC shall send a 404 Not Found message. If the request cannot be fulfilled, the BM-SC shall send 403 Forbidden message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.2.2.5-1. + +**Table 5.2.2.2.5-1: Response status code, message, and contents for service modification using HTTP GET** + +| Status Code | Message | Contents | +|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|-------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the session representation of the session resource to the Content Provider | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +###### Retrieval of all Sessions of a Service + +GET /xmb/v1.0/services/{service-res-id}/sessions + +The retrieval of all sessions of a service shall be performed by the Content Provider using the HTTP GET method on the "sessions" instance resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/services/{service-res-id}/sessions +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +Upon receipt of the HTTP GET request from the Content Provider, the BM-SC will check whether the Content Provider is authenticated and authorized to read services and sessions as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.2.2.5-2. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 OK message. If there are sessions configured at the BM-SC for the corresponding service, the BM-SC shall send the representation of the list of all session resources configured at the BM-SC for that service along with the 200 OK message. If there are no sessions configured at the BM-SC for that service, the BM-SC shall send message content in the 200 OK message indicating to the Content Provider that there are no sessions configured at the BM-SC for that service. + +The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the representation of list of sessions configured at the BM-SC for the given service where each session representation is based on the JSON schema of session resource as described in clause 5.2.2.1. The properties "session-start", "session-stop", "max-ingest-bitrate", "session-state", "geographical-area", "session-type", "session-announcement-mode", "session-type", "userplane-delivery-mode-configuration", "sdp-url", "application-service-description", "ingest-mode", "application-entrypoint-url", and "unicast-delivery" shall be included for each session representation in the response to the Content Provider. All other properties of the session instance are optional to be returned to the Content Provider. + +Alternatively, if the request cannot be fulfilled, the BM-SC shall send 403 Forbidden message to the Content Provider. If the service was not found, the BM-SC shall send a 404 Not Found message + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.2.2.5-2. + +**Table 5.2.2.2.5-2: Response status code, message, and contents for service modification using HTTP GET** + +| Status Code | Message | Contents | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | If there are sessions configured at the BM-SC for that service, the BM-SC shall send the representations of all the configured sessions for that service to the Content Provider. If there are no sessions configured at the BM-SC for that service, the BM-SC shall send message content in this message indicating to the Content Provider that there are no sessions configured at the BM-SC for this service | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +### 5.2.3 Reports + +#### 5.2.3.0 General + +The BM-SC shall send reports to the Content Provider upon request by the Content Provider. Table 5.2.3-1 summarizes different report resources that the BM-SC manages for sending reports to the Content Provider. + +**Table 5.2.3-1: Resources for managing reports at BM-SC** + +| Resource Name | Resource Type | Description | +|---------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| Report | Instance resource | Represents a single report resource. The BM-SC can send an individual report to the Content Provider using the report instance resource | +| Reports | Collection Resource | Represents a collection of report resources. | + +Reports can be generated separately for each service or for a session belonging to a particular service. Therefore, a report can be referenced with a given service resource identifier or for a combination of service resource identifier and session resource identifier. + +#### 5.2.3.1 Properties + +Each report resource described in Table 5.2.3-1 has the set of properties described in Table 5.2.3.1-1. The BM-SC shall deliver the reports as indicated by this structure using the API operations described in clause 5.2.3.2 + +Table 5.2.3.1-1 summarizes different service properties of a service resource. + +**Table 5.2.3.1-1: Resources for managing services at BM-SC** + +| Property Token | JSON Value Type | Parameter Description | +|------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| report-res-id | string | Report resource identifier | +| report-starttime | string | Report collection start time | +| report-endtime | string | Report collection end time | +| report-type | string | Type of report. Three types of reports can be generated by the BM-SC to send to the Content Provider:
Consumption report: Report that provides service consumption information
QoE report: Report that provides detailed QoE information of the content received
File reception report: Report that provides detailed reception information for each file | +| report-url | string | Location of the report from where the Content Provider can retrieve the detailed report. | +| Report | string | Detailed report. This may not be included if report-url is included | + +The report instance resource with the properties defined above for each report can be found in Annex B. + +#### 5.2.3.2 API Operations + +##### 5.2.3.2.1 Introduction + +The Content Provider can request reports from the BM-SC for a given service or a session belonging to a given service. + +##### 5.2.3.2.2 Report Retrieval + +Reports can be retrieved by the Content Provider for a service or for a session of a given service using HTTP GET method. + +###### Report Retrieval for a Service + +GET /xmb/v1.0/services/{service-res-id}/reports + +The retrieval of reports of a service shall be performed by the Content Provider using the HTTP GET method on the "reports" collection resource as follows: + +- the request URI with the "path" part set to: "/xmb/v1.0/services/{service-res-id}/reports" +- the Host field is set to the address of the BM-SC + +QoE reports however are only available on session level. The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +Upon receipt of a HTTP GET request from the Content Provider to retrieve all the reports of a service, the BM-SC will check whether the Content Provider is authenticated and authorized to request reports for services and sessions configured at the BM-SC as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.3.2.2-1. If the authorization is successful, the BM-SC shall verify that the service with the given service resource identifier exists at the BM-SC. If the service exists at the BM-SC, the BM-SC shall respond to the Content Provider with a 200 success message along with the service resource identifier and the list of all reports for that service. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the list of report for that service. Each report in this list shall be based on the JSON schema of report resource as described in clause 5.2.3.1. + +Alternatively, if the report retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. If the service for which the report is sought could not be found, the BM-SC shall send a 404 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.3.2.2-1. + +**Table 5.2.3.2.2-1: Response status code, message, and contents for retrieval of all service reports** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier and all the reports for the service | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +GET /xmb/v1.0/services/{service-res-id}/reports/{report-res-id} + +The Content Provider can request individual reports of a service if it is aware of the report resource identifiers of that service. A specific report for a service can be retrieved by the Content Provider using the HTTP GET method on the "report" instance resource as follows. + +- the request URI with the "path" part set to: "/xmb/v1.0/services/{service-res-id}/reports/{report-res-id}" +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service whose reports are being sought. + +The {report-res-id} in the request URI is the report resource identifier of that service. + +It should be noted that QoE reports are only available on session level. Upon receipt of a HTTP GET request from the Content Provider to retrieve a specific report of a service with report resource identifier, the BM-SC will check whether the Content Provider is authenticated and authorized to request reports for services and sessions configured at the BM-SC as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.3.2.2-2. If the authorization is successful, the BM-SC shall verify that the service with the given service resource identifier and a report with given report resource identifier exists for that service at the BM-SC. If such report exists at the BM-SC, the BM-SC shall respond to the Content Provider with a 200 success message along with the service resource identifier and the report to the Content Provider. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the requested report resource for that service whose representation is based on the JSON schema of report resource as described in clause 5.2.3.1. + +Alternatively, if the report retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. If the service for which the report is sought could not be found, the BM-SC shall send a 404 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.3.2.2-2. + +**Table 5.2.3.2.2-2: Response status code, message, and contents for retrieval of a specific report of a service** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|----------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier and the requested report of the service | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. + +###### Report Retrieval for a Session of a given Service + +GET /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id}/reports + +The retrieval of all the reports of a session for a given service shall be performed by the Content Provider using the HTTP GET method on the "reports" collection resource as follows: + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}/sessions/{session-res-id}/reports." +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The {session-res-id} in the request URI is the session resource identifier of the session whose reports are being sought. + +Upon receipt of a HTTP GET request from the Content Provider to retrieve all the reports of a session of given service, the BM-SC will check whether the Content Provider is authenticated and authorized to request reports for services and sessions configured at the BM-SC as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.3.2.2-3. If the authorization is successful, BM-SC shall verify that the service with the given service resource identifier and a corresponding session with the given session identifier exists at the BM-SC. If such a session exists at the BM-SC, the BM-SC shall respond to the Content Provider with a 200 success message along with the list of all reports for that session. If there are no reports for that session at the BM-SC, the BM-SC shall send a 200 OK message with message content indicating that there are no reports for the session at the BM-SC. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the list of all reports for that session. Each report in this list of reports sent shall be based on the JSON schema of report resource as described in clause 5.2.3.1. + +Alternatively, if the report retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. If the session for which the report is sought could not be found, or if the service corresponding to that sessions could not be found, the BM-SC shall send a 404 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.3.2.2-3. + +**Table 5.2.3.2.2-3: Response status code, message, and contents for retrieval of all reports for a session** + +| Status Code | Message | Contents | +|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier, session resource identifier, and all the reports of that session. If there are no reports for that session at the | + +| | | | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| | | BM-SC, the BM-SC shall include message content indicating that there are no reports for the requested session at the BM-SC. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +GET /xmb/v1.0/services/{service-res-id}/sessions/{session-res-id}/reports/{report-res-id} + +The Content Provider can request individual reports of a given session of a service if it is aware of the report resource identifiers of that session for that service. A specific report for a session can be retrieved by the Content Provider using the HTTP GET method on the "report" instance resource as follows. + +- the request URI with the "path" part is set to: "/xmb/v1.0/services/{service-res-id}/sessions/{session-res-id}/reports/{report-res-id}" +- the Host field is set to the address of the BM-SC + +The {service-res-id} in the request URI is the service resource identifier of the service as allocated by the BM-SC during service creation. + +The {session-res-id} in the request URI is the session resource identifier of the session whose report is being sought. + +The {report-res-id} in the request URI is the report resource identifier that is being sought. + +Upon receipt of a HTTP GET request from the Content Provider to retrieve a specific report for a session of a service, the BM-SC will check whether the Content Provider is authenticated and authorized to request reports for services and sessions configured at the BM-SC as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in Table 5.2.3.2.2-4. If the authorization is successful, the BM-SC shall verify that a report with report resource identifier exists for a session with given session resource identifier whose service identifier is the given service resource identifier at the BM-SC. If such a report exists at the BM-SC, the BM-SC shall respond to the Content Provider with a 200 success message along with the requested report to the Content Provider. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the requested report resource for that session for the given service and whose representation is based on the JSON schema of report resource as described in clause 5.2.3.1. + +Alternatively, if the report retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. If the session for which the report is sought could not be found, or if the service corresponding to that session could not be found, or if the report is not found, the BM-SC shall send a 404 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.3.2.2-4. + +**Table 5.2.3.2.2-4: Response status code, message, and contents for retrieval of a specific report of a session** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send the service resource identifier, session resource identifier, and the requested report for the service | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|----------------------------------------------------------------------------------------| +| 403
Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not be fulfilled | +| 404 Not
Found | Requested resource not found | None | +| Note: In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +### 5.2.4 Notifications + +#### 5.2.4.0 General + +Notifications can be exchanged via two alternative methods. In the first method, the Content Provider can "pull" the notifications from the BM-SC using HTTP GET method if and when the Content Provider wishes to acquire notification information as described in this clause. The second method is that the notifications can be "pushed" from the BM-SC to the Content Provider via the push-notification-url as documented in clause 8. + +Table 5.2.4-1 summarizes different notification resources that the BM-SC manages for sending notifications to the Content Provider. + +**Table 5.2.4-1: Resources for managing services at BM-SC** + +| Resource Name | Resource Type | Description | +|---------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| Notification | Instance resource | Represents a single notification resource. The BM-SC can send an individual notification to the Content Provider using the notification instance resource | +| Notifications | Collection Resource | Represents a collection of notification resources. | + +#### 5.2.4.1 Properties + +##### 5.2.4.1.0. General + +Each notification resource described in Table 5.2.4-1 has the set of properties described in Table 5.2.4.1-1. The BM-SC shall deliver the notifications as indicated by this structure using the API operations described in clause 5.2.4.2. + +Table 5.2.4.1-1 summarizes different properties of a notification resource. + +**Table 5.2.4.1-1: Resources for managing services at BM-SC** + +| Property Token | JSON Value Type | Parameter Description | +|---------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notification-res-id | string | Notification resource identifier | +| message-class | string |

Enumeration with the following values (may be expanded in the future): Critical, Warning, Information, Service, Session. The message classes bear the following meaning:

Critical: When some event drastically prevent the proper delivery of content

Warning: When the service can be partially delivered but quality is reduced

Information: When the service is properly delivered but some interesting event occurred

Session/Service: Information about Service/Session related parameters

Table 5.2.4.1-2 shows the information that can be notified for each of the message classes.

| + +| | | | +|---------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| message-name | string |

Unique identifier of the message. Provides information about the message pertaining to the message-class of the notification

Table 5.2.4.1-2 shows the information that can be notified for each of the message classes and message names.

| +| Message-information | object |

A dictionary of key values containing informations linked to the notification.

Every message-information dictionary shall include the following two keys:

date: The value of this key contains the UTC timestamp (in ms) of the date of the event

source: The value of this key is hierarchical colon separated format of services and sessions with the format "service-resource-identifier session-resource-identifier". If the notification is for a service, only the service-resource-identifier shall be included in this value. An empty value for this key shall represent a system wide notification.

Table 5.2.4.1-x shows the additional key value pairs that can be included in the message-information for each of the message-class and message-name.

| + +Table 5.2.4.1-2 shows the notification details that can be sent for each of the message classes. + +**Table 5.2.4.1-2: Notification Details for different message classes** + +| Message Class | Possible Message Name | Additional Key Value Pairs in message-information dictionary | +|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Critical | network-is-down | None | +| | service-badly-configured | bad-or-missing-parameters: [ , .. ] | +| | session-badly-configured | bad-or-missing-parameters: [ , .. ] | +| Warning | incoming-bitrate-exceed-session-capacity | incoming-bit-rate: | +| | no-incoming-data | None | +| Information | qoe-report-available | None | +| | consumption-reports-available | None | +| | reception-reports-available | None | +| Service | service-announcement-change | None | +| Session | session-state-change | from-state:
to-state:
where the from state and to state have one of the values in the enumeration:
Session Idle
Session Announced
Session Active
Session Terminated | +| | file-ready-for-transmission | file-url:
file-size:
transmission-size: | +| | file-download-started | file-url: | +| | file-successfully-sent | file-url: | +| | file-fetch-error | file-url:
http-error-code: | +| Note 1: | For the message-class "Service", the message-name service-announcement-change applies only when the session-state is in Session Announced or Session Active states. | | +| Note 2: | For the message-class "Session", the message-name file-ready-for-transmission applies only when the session-type is "Files". | | +| Note 3: | For the message-class "Session", the message-name file-download-started applies only when the session-type is "Files". | | +| Note 4: | For the message-class "Session", the message-name file-successfully-sent applies only when the session-type is "Files". | | + +The notification instance resource with the properties defined in Table 5.2.4.1-1 can be found in Annex B.5.2.4.2 API Operations + +##### 5.2.4.2.1 Introduction + +The Content Provider can request individual service and session level notifications and system-wide notifications from the BM-SC. The notifications are configured by the Content Provider when it creates services and sessions at the BM-SC. Notifications can be retrieved by the Content Provider from the BM-SC at times of its choice and shall use techniques such as long polling to poll the BM-SC for available notifications. Notifications can be retrieved from the BM-SC using HTTP methods on the notifications collection resource. + +##### 5.2.4.2.2 Notification Retrieval + +###### Retrieval of All Notifications + +###### GET /xmb/v1.0/notifications + +The retrieval of all the notifications shall be performed by the Content Provider using the HTTP GET method on the "notifications" collection resource as follows: + +- the request URI with the "path" part is set to: /xmb/v1.0/notifications +- the Host field is set to the address of the BM-SC + +Upon receipt of a HTTP GET request from the Content Provider to retrieve all the notifications, the BM-SC will check whether the Content Provider is authenticated and authorized to request notifications as described in clause 7. If the authorization fails, the BM-SC shall send a 401 message as described in table 5.2.4.2.2-1. If the authorization is successful, the BM-SC shall respond to the Content Provider with a 200 success message along with the list of all notifications. If there are no available notifications at the BM-SC, the BM-SC shall send a 200 OK message with message content indicating that there are no available notifications. The response from the BM-SC to the Content Provider shall contain the following: + +- the Content-Type header field set to "application/json" +- the body of the message encoded in JSON format + +The content body of this response message shall be the list of notifications available at the BM-SC. Each notification in this list shall be based on the JSON schema of notification resource as described in clause 5.2.4.1. + +Alternatively, if the notification retrieval request cannot be fulfilled, the BM-SC shall send a 403 message to the Content Provider. + +The possible response messages from the BM-SC, depending on whether the GET request is successful or unsuccessful, are shown in Table 5.2.4.2.2-1. + +**Table 5.2.4.2.2-1: Response status code, message, and contents for retrieval of all notifications of service** + +| Status Code | Message | Contents | +|------------------|-------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The BM-SC shall send all the notifications. If there are no notifications available at the BM-SC, the BM-SC shall include message content indicating that there are no notifications at the BM-SC. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7235 [8] and IETF RFC 7231 [6]. | +| 403 Forbidden | Request cannot be fulfilled | The BM-SC may include optional text to indicate why the request could not fulfilled. | +| Note: | In addition to the above response codes, the BM-SC can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | + +Individual notifications can be accessed using HTTP GET method by referencing the "notification-res-id". + +# 6 User Plane Procedures + +## 6.1 Introduction + +The xMB-U user plane procedures cover the transmission of service data between the Content Provider to the BM-SC. Only authorized and authenticated Content Provider sources shall be able to provide user plane data over xMB-U to the BM-SC. The following data transfer modes are supported: + +- File Push: the Content Provider uploads or transmits files to the BM-SC either as soon as they become available, or in advance. +- File Pull: the Content Provider makes files available prior to the session start and at least during the lifetime of a session. The BM-SC will retrieve the files when it needs to deliver them. +- RTP Streaming: the BM-SC establishes an RTSP session to the Content Provider and starts the streaming session to relay media streams. +- Transport: the BM-SC listens on one IP address and one port number to receive UDP packets. + +The details of these procedures are provided in the following clauses. + +## 6.2 File Session + +### 6.2.1 General + +Provisioning files for file distribution shall use one of the two options in the following clauses. + +### 6.2.2 Push Mode + +WebDAV as described in IETF RFC 4918 [9] or HTTP v1.1 shall be used over TLS. The Content Provider shall use the PUT method and place the file in the message body of the request associated with the push-url. The Content Provider shall ensure that each file is available at the BM-SC latest at its provided "file-earliest-fetch-time", or if that parameter is not provided, prior to the session start. Potential response codes and their interpretation is provided in Table 6.2.2-1. + +**Table 6.2.2-1: Response status code, message, and contents of File Push mode** + +| Status Code | Message | Contents | +|------------------|-------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 201 Created | File pushed successfully | None | +| 401 Unauthorized | Request requires user authorization | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not be fulfilled, e.g. incorrect URL used | + +### 6.2.3 Pull Mode + +HTTP v1.1 shall be used over TLS in Pull mode. The BM-SC shall use GET method to request each file as defined by the file-list or alternatively by the manifest received from the file-delivery-manifest-url. The BM-SC shall pull each file earliest at its provided "file-earliest-fetch-time", or if that parameter is not provided, prior to the session start. Upon a successful GET, the Content Provider shall provide the requested file in the response body. Potential response codes and their interpretation is provided in Table 6.2.3-1. + +**Table 6.2.3-1: Response status code, message, and contents of File Pull mode** + +| Status Code | Message | Contents | +|-------------|--------------------------------------|--------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The Content Provider shall send the requested file in the response body. | +| 401 | Request requires user authentication | In accordance to conditions as described in | + +| | | | +|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| +| Unauthorized | | IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | +| Note: | If "file-delivery-manifest-url" is used, and if there is any error code in response to the request to get the manifest from the provided URL, the session is not started. | | + +## 6.3 Application Session + +### 6.3.1 General + +Application mode, including DASH service delivery shall use one of the two options in the following clauses. + +### 6.3.2 Push Mode + +WebDAV as described in IETF RFC 4918 [9] or HTTP v1.1 shall be used over TLS. The Content Provider shall use PUT method with the resource (Application Session) or the Media Segment (DASH) in the message body, to place it at the push-url. The Content Provider shall ensure that each Segment is available at the BM-SC prior to its prescribed Segment availability start time in the MPD, or if that parameter is not provided, prior to the session start. Potential response codes and their interpretation is provided in Table 6.2.2-1. + +**Table 6.3.2-1: Response status code, message, and contents of Application (including DASH) Push mode** + +| Status Code | Message | Contents | +|------------------|-------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| 201 Created | File pushed successfully | None | +| 401 Unauthorized | Request requires user authorization | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not be fulfilled, e.g. incorrect URL was used | + +### 6.3.3 Pull Mode + +HTTP v1.1 shall be used over TLS in Pull mode. For DASH service, the BM-SC shall use the application-entry-point-url to retrieve the MPD. The BM-SC shall use GET method to request the resource, or for DASH, each Media Segment as defined by the MPD. Upon a successful GET, the Content Provider shall provide the requested resource or DASH Segment, respectively, in the response body. Potential response codes and their interpretation is provided in Table 6.2.3-1. + +**Table 6.3.3-1: Response status code, message, and contents of Application (including DASH) Pull mode** + +| Status Code | Message | Contents | +|------------------|--------------------------------------|---------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | The Content Provider shall send the requested resource or DASH Segment in the response body. | +| 401 Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403 Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not be fulfilled | +| 404 Not Found | Requested resource not found | None | + +The BM-SC shall ensure that each DASH Media Segment is fully received prior to its prescribed availability start time, or if not provided, prior to the session start. + +Note: If "application-entry-point-url" is used, and if there is any error code in response to the request to get the MPD from the provided URL, the session shall not be started. + +## 6.4 RTP Streaming + +The Content Provider shall support PSS server functionality according to PSS as described in clause 5.3 of 3GPP TS 26.234 [5]. The streaming session shall be accessible prior to the start of the session. A URL to the SDP file that describes the streaming session between the Content Provider and the BM-SC is provided via the sdp-url, which shall be used for ingesting the streaming session. The SDP shall include the RTSP links for every media session as part of the "a=control" attribute to enable RTSP control of the session. The SDP shall also contain the required bitrate for each of the media sessions. + +When the user plane data is provided via UDP, then SRTP over DTLS as described in 3GPP TS 33.246 [24] shall be used for user plane protection. Establishment of TCP based user plane sessions with PSS is not supported. + +If there is any error retrieving the SDP, the session shall not be started. + +## 6.5 Transport + +For Transport sessions, the BM-SC shall activate the receivers on the indicated IP address and port numbers and shall ensure that firewall and NAT traversal is enabled on these IP addresses and port numbers as defined in the SDP retrieved from the sdp-url. If there is any error retrieving the SDP, the session shall not be started. All traffic shall use DTLS as specified in 3GPP TS 33.246 [24] where both client and server certificates are verified. + +# --- 7 Security + +## 7.1 Overview + +All xMB-C and xMB-U traffic shall only be sent over secured transport channels that are established after successful authentication and authorization as described in clauses 4.4.2, 4.4.3 and 7.2. + +## 7.2 Authentication & Authorization + +(D)TLS as defined in 3GPP TS 33.246 [24] shall be used to authenticate both ends of the connection. + +The BM-SC shall support at least one of the two following modes for authorization of the Content Provider: *domain-based* or *user-based*, as defined in 3GPP TS 26.348 [33]. Authorization shall be performed after the successful completion of (D)TLS authentication. Domain-based authorization, as defined in Annex O.2 of 3GPP TS 33.246 [24], corresponds to the granting of access rights for service and/or session resource management at a coarse-grained level of the Content Provider, as identified by its administrative domain name in the subject field of the Content Provider certificate. User-based authorization, as defined in Annex O.2 of 3GPP TS 33.246 [24], corresponds to the granting of access rights for service/session resource management at a finer-grain level of an individual representative of the Content Provider. User-based authorization, if performed, shall occur after successful domain based authorization, and is based on HTTP Digest authentication of username and password as specified in IETF RFC 7616 [43]. Detailed specification of the authorization procedure and affiliated mechanisms (for example, pre-establishment of agreement between the Content Provider and mobile operator on domain- and user-based access rights, management of username and password credentials, etc.) are outside the scope of this specification, in order to allow flexibility of implementations which conform to the mechanism described herein. + +Authorization of the BM-SC by the Content Provider shall be based on the same mechanisms as described above for BM-SC authorization of the Content Provider. + +## 7.3 Void + +# 8 Notification Push to the Content Provider + +## 8.1 Introduction + +The Content Provider configures the BM-SC with a push-notification-url and push-notification-configuration property as documented in clause 5.2.1.1, where the BM-SC can post the notifications to the Content Provider. + +## 8.2 Notification Post + +To send a notification to the Content Provider, the BM-SC shall use HTTP POST as follows: + +- the request URI with the "path" part is set to: {push-notification-url} HTTP/1.1 +- the Host field is set to the address of the Content Provider +- the Content-Type header field is set to "application/json" +- the body of the message is encoded in JSON format + +The {push-notification-url} in the URI above is the push notification URL configured by the Content Provider when the Content Provider configures the service using procedures described in clause 5.2.1.2. The URL shall be an HTTPS URL. + +The content body of the above POST request shall contain the notification that the BM-SC intends to send to the Content Provider. The representation of the notification is based on the JSON schema of notification resource as described in clause 5.2.4.1. + +Upon receipt of HTTP POST from the BM-SC to notify the Content Provider about a notification, the Content Provider shall check whether the BM-SC is authenticated and authorized to send notifications to the Content Provider. If the authorization fails, the Content Provider shall send a 401 message to the BM-SC. If the authorization is successful, the Content Provider shall accept the notification request and respond to the BM-SC with a 200 OK message indicating that it has received the notification from the BM-SC. If the request cannot be fulfilled, the Content Provider shall send a 403 Forbidden message to the BM-SC. + +The possible response messages from the Content Provider, depending on whether the notification request is accepted or not, are shown in Table 8.2-1. + +**Table 8.2-1: Response status code, message, and contents for notification request using HTTP POST** + +| Status Code | Message | Contents | +|------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|------------------------------------------------------------------------------------------------| +| 200 OK | The request has succeeded | None | +| 401
Unauthorized | Request requires user authentication | In accordance to conditions as described in IETF RFC 7231 [6] and IETF RFC 7235 [8] | +| 403
Forbidden | Request cannot be fulfilled | The Content Provider may include optional text to indicate why the request could not fulfilled | +| Note: In addition to the above response codes, the Content Provider can also send appropriate response codes described in IETF RFC 7231 [6] as applicable. | | | + +# 9 Feature negotiation + +## 9.1 General + +The xMB API needs to provide a mechanism to advertise required and optional features supported by both the Content Provider and BM-SC for interoperability reasons as the functionality of the xMB interface is augmented. + +Feature negotiation shall take place during service creation procedure and applies for a given instance of service and its related session(s), and any optionally associated reports and/or notifications associated with that service until the service is terminated. The Content Provider shall include in the HTTP POST the set of supported features as follows: + +- if a feature is required for the proper operation of the service, its associated session management, and reporting and/or notification functionality, if applicable, it shall be included within the 3gpp-Required-Features header; +- if a feature is optional for the proper operation of the service, its associated session management, and reporting and/or notification functionality, if applicable, it shall be included within the 3gpp-Optional-Features header. + +The BM-SC shall include, within the 3gpp-Accepted-Features header in the response to the HTTP POST, the set of features it supports in common with the Content Provider. + +If the BM-SC does not support any of the required features advertised by the Content-Provider within the 3gpp-Required-Features header, the BM-SC shall reject the HTTP POST with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the Content Provider within the 3gpp-Accepted-Features. + +If the BM-SC requires certain features to be supported that are not advertised by the Content Provider, the BM-SC shall reject the HTTP POST with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the Content Provider within the 3gpp-Accepted-Features and the required features in the 3gpp-required-features. + +If the BM-SC and Content Provider successfully negotiate supported features, the list of commonly supported features shall be applicable for the created service, related session(s) and any optionally associated reports and/or notifications, until it is deleted. Features that are not advertised as supported shall not be used for that service. + +The sender may send information that is related to the supported features. Any unrecognized/supported information shall be ignored by the receiver. + +The table below defines the features applicable to the xMB interface. + +**Table 9.1-1: Features used in xMB Interface** + +| Feature | M/O | Description | +|----------------------|--------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| LocalMBMS | O | The feature indicates the support of Local MBMS data delivery. | +| FilePush | O | The feature indicates the support of File Session Push Mode user plane procedures as specified in clause 6.2.2 | +| FilePull | O | The feature indicates the support of File Session Pull Mode user plane procedures as specified in clause 6.2.3 | +| ApplicationPush | O | The feature indicates the support of Application Push Mode user plane procedures as specified in clause 6.3.2 | +| ApplicationPull | O | The feature indicates the support of Application Pull Mode user plane procedures as specified in clause 6.3.3 | +| RTPStreaming | O | The feature indicates the support of RTPStreaming user plane procedures as specified in clause 6.4 | +| Transport | O | The feature indicates the support of Transport user plane procedures as specified in clause 6.5 | +| FEC | O | This feature indicates the support of applying FEC (see IETF RFC 6363 [29]) to downlink packet streams at the BM-SC. | +| ROHC | O | This feature indicates the support of applying ROHC (see IETF RFC 5795 [27] and IETF RFC 3095 [28]) to downlink packet streams at the BM-SC. | +| GroupContentDelivery | O | This feature indicates the support of delivering contents to a group of UEs. | +| MCExtension | O | This feature indicates the support of the xMB mission critical extension as specified in clause 4.3.2 and clause 5.2.2.1. | +| ResourceSharing | O | This feature indicates the support of sharing transmission resource for different MBMS services. | +| SaProfile | O | This feature indicates the support of BM-SC supplied Service Announcement profile. | +| FileRepair | O | This feature indicates the support of content provider supplied file repair function. | +| Feature: | A short name for the feature to which the M/O and description pertain. | | +| M/O: | Indication on whether the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release. | | +| Description: | Textual description of the feature. | | + +NOTE: The base functionality for the xMB interface is defined in the Release-14 version of this specification and a feature is an extension of that functionality. The negotiation of supported features allows interworking between the endpoints of the xMB interface whereby each entity may support all, some, or none of the features that the xMB application can support defined in this specification. Features are defined so that they are independent of each other. Any introduced feature is explicitly defined in this specification. + +## 9.2 HTTP custom headers + +### 9.2.0 General + +This clause defines any new HTTP custom headers introduced by this specification. + +### 9.2.1 3gpp-Optional-Features + +This header is used by the Content Provider to advertise the optional features that are supported by the Content Provider. + +The encoding of the header follows the ABNF as defined in IETF RFC 7231 [6]. + +3gpp-Optional-Features = "3gpp-Optional-Features" ":" 1#token + +n example is: 3gpp-Optional-Features: feature1, feature2 + +### 9.2.2 3gpp-Required-Features + +This header is used by the Content Provider to announce the mandatory features that must be supported in BM-SC. + +This header is also used by the BM-SC to indicate the missing features that must be supported in Content Provider. + +The encoding of the header follows the ABNF as defined in IETF RFC 7231 [6]. + +3gpp-Required-Features = "3gpp-Required-Features" ":" 1#token + +An example is: 3gpp-Required-Features: feature1, feature2 + +### 9.2.3 3gpp-Accepted-Features + +The header is used by the BM-SC to confirm the commonly supported set of features with the Content Provider. + +The encoding of the header follows the ABNF as defined in IETF RFC 7231 [6]. + +3gpp-Accepted-Features = "3gpp-Accepted-Features" ":" 1#token + +An example is: 3gpp-Accepted-Features: feature1, feature2 + +# --- 10 Using Common API Framework + +## 10.1 General + +When CAPIF is used with BM-SC, BM-SC shall support the following as defined in 3GPP TS 29.222 [40]: + +- 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 [39], 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. + +## 10.2 Security + +When CAPIF is used for external exposure, before invoking the API exposed by the BM-SC, the Content Provider as API invoker shall negotiate the security method (PKI, TLS-PSK or OAuth 2.0) with CAPIF core function and ensure the BM-SC has enough credential to authenticate the Content Provider (see 3GPP TS 29.222 [40], 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 Content Provider and the BM-SC, upon API invocation, the BM-SC shall retrieve the authorization information from the CAPIF core function as described in 3GPP TS 29.222 [40], clause 5.6.2.4. + +As indicated in 3GPP TS 33.122 [41], the access to the xMB API may be authorized by means of the OAuth 2.0 protocol (see IETF RFC 6749 [42]), using the "Client Credentials" authorization grant, where the CAPIF core function (see 3GPP TS 29.222 [40]) plays the role of the authorization server. + +NOTE 1: In this release, only "Client Credentials" authorization grant is supported. + +If OAuth 2.0 is used as the selected security method between the Content Provider and the BM-SC, the Content Provider, prior to consuming services offered by the xMB API, shall obtain a "access token" from the authorization server, by invoking the Obtain\_Authorization service, as described in 3GPP TS 29.222 [40], clause 5.6.2.3.2. + +The xMB API do not define any scopes for OAuth 2.0 authorization. It is the BM-SC responsibility to check whether the Content Provider is authorized to use an API based on the "token". Once the BM-SC verifies the "token", it shall check whether the BM-SC 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 Content Provider has full authority to access any resource or operation for the invoked API. + +NOTE 2: For aforementioned security methods, the BM-SC needs to apply admission control according to access control policies after performing the authorization checks. + +# --- Annex A (informative): Call Flows + +## A.1 Introduction + +The xMB-C procedures are used to create and control MBMS User Services from external sources. An MBMS User Service spans from the BM-SC to the UE and can contain one or more MBMS delivery methods. The provisioning procedure offer functions to create one or more delivery sessions (such as a MBMS Download Delivery session) and allows association of the delivery sessions to MBMS Bearer Services. As part of the xMB-C procedures for MBMS User Services, content ingestion for the user-plane data (i.e. xMB-U) are negotiated. As a result of the xMB-C procedures, the BM-SC can start service announcement and activates MBMS bearer services. + +The Content Provider can query its entitlements, for instance the list of broadcast areas it is authorized to use. + +The Content Provider can query the status of delivery sessions. + +The Content Provider can request reception statistics. + +## --- A.2 xMB Procedure example for Live DASH services (MBMS Broadcast only) + +This procedure example describes the xMB procedures for the delivery of a DASH Live service (see clause 11 of 3GPP TS 26.247 [18] for the specification of DASH Live services), to a single broadcast area. A push interface like WebDAV is used here as the ingestion method for the user-plane data (xMB-U). The push interface is identified by a unique URI. The source of the user plane data (CP Source) are the DASH Media Segments as produced by a Live Encoder / Segmenter and the source pushes each new Segment when it becomes available. The Media Presentation Description (MPD) URL and Initialization Segment (IS) for the Live DASH session is provided to BM-SC during Session creation or in a subsequent update request to the BM-SC. + +![Sequence diagram showing the interaction between UE, MBMS-GW, BM-SC, CP Control, and CP Source for provisioning a live DASH session.](9e8ebf03cae78f4f81b697548c2d7250_img.jpg) + +``` + +sequenceDiagram + participant UE + participant MBMS-GW + participant BM-SC + participant CP Control + participant CP Source + + Note over all: 1: Operator and Content Provider agree Service Level Agreement + Note over BM-SC: 2: BM-SC admin applies agreed ranges to BM-SC + Note over all: Provisioning a Live DASH Session + BM-SC->>CP Control: 3: Authentication and Authorization + Note over BM-SC, CP Control: Creating a Service + BM-SC->>CP Control: 4: HTTP POST + CP Control-->>BM-SC: 5: HTTP 201 CREATED + BM-SC->>CP Control: 6: HTTP GET + CP Control-->>BM-SC: HTTP 200 OK + BM-SC->>CP Control: 7: HTTP PUT/PATCH + CP Control-->>BM-SC: HTTP 200 OK + Note over BM-SC, CP Control: Creating a Session + BM-SC->>CP Control: 8: HTTP POST + CP Control-->>BM-SC: 9: HTTP 201 CREATED + BM-SC->>CP Control: 10: HTTP GET + CP Control-->>BM-SC: HTTP 200 OK + BM-SC->>CP Control: 11: HTTP PUT/PATCH + CP Control-->>BM-SC: HTTP 200 OK + BM-SC->>UE: 12: Do service announcement + Note right of MBMS-GW: (when all data present) + Note over all: MBMS Bearer is activated + BM-SC->>MBMS-GW: 13: MBMS Session Start + MBMS-GW-->>BM-SC: Ok + BM-SC->>CP Control: 14: Notification + BM-SC->>UE: 15: User Plane Data (DASH Segments) + Note over all: MBMS Bearer is deactivated + BM-SC->>MBMS-GW: 16: MBMS Session Stop + MBMS-GW-->>BM-SC: Ok + BM-SC->>CP Control: 17: Notification + +``` + +The sequence diagram illustrates the interaction for provisioning a live DASH session. It begins with an agreement between the Operator and Content Provider (Step 1), followed by the BM-SC admin applying agreed ranges (Step 2). The main process involves authentication, service creation (Steps 4-7), and session creation (Steps 8-11) between the BM-SC and CP Control. A service announcement is sent to the UE (Step 12). Upon MBMS bearer activation, an MBMS Session Start is sent to the MBMS-GW (Step 13), which responds with 'Ok'. A notification is sent to the CP Control (Step 14), and user plane data (DASH segments) are sent to the UE (Step 15). Upon MBMS bearer deactivation, an MBMS Session Stop is sent to the MBMS-GW (Step 16), which responds with 'Ok'. Finally, a notification is sent to the CP Control (Step 17). + +Sequence diagram showing the interaction between UE, MBMS-GW, BM-SC, CP Control, and CP Source for provisioning a live DASH session. + + v5.4 + +###### **Figure A.2-1: xMB-C and xMB-U Procedures for a Live DASH Service** + +- 1: The operator and the Content Provider agree on a Service Level Agreement (SLA), which entitles the Content Provider to use the MBMS system (in accordance to some rules) for content delivery. For instance, the SLA can include day/time ranges, during which the Content Provider can distribute its content. The SLA can also include geographical areas in which the Content Provider is allowed to distribute its content. The SLA also includes target bitrates and likely definitions of tolerable losses per service. +- 2: The BM-SC administrators (operator) apply the agreed ranges. This can imply the provisioning of additional Service Areas, and other system related configurations. + +The following steps describe Content Provider provisioning of a single Live DASH session in a single broadcast area. + +- 3: The Content Provider authenticates itself as authorized user. The Content Provider can only see those configurations, sessions and services which belong to the Content Provider. +- 4: The Content Provider creates a new Service. Optionally, the Content Provider may provide properties for the service like service class, service languages, service names, notification configuration as well as consumption reporting configuration. The Content Provider can select whether the Content Provider or the operator distributes service announcement by providing a list of Service Announcement Channel (SACH, as defined in Annex L.2 / L.3 of 3GPP TS 26.346 [3]) services used for operator-driven service announcement. + +NOTE 1: BM-SC derives the required UE capabilities from the provided service and session properties. + +- 5: Upon successful service creation by the BM-SC, the BM-SC will provide a unique id for the service resource which is expected to be used by the Content Provider for subsequent requests. +- 6: The Content Provider retrieves the current service properties. The unique resource id of the service are provided by the Content Provider as input to the BM-SC. The BM-SC responds with the service properties. +- 7: The Content Provider updates service properties. The unique resource id of the service and some or all service properties are provided by the Content Provider as input to the BM-SC +- 8: The Content Provider creates a session for the previously created service. The unique resource id of the service are provided by the Content Provider as input to the BM-SC. Optionally, the Content Provider may provide common session properties such as maximum ingestion bitrate (excluding any FEC redundancy and transport overhead), scheduling information (start time, stop time), QoE Reporting configuration and session type (set to Application) as input. DASH specific session properties provided as input by the Content Provider include MIME-type of MPD fragment (here, set to application/dash+xml), Application Entry Point URL (here, the MPD URL), xMB-U ingest mode (push/pull), Unicast Delivery Indicator, etc. + +NOTE 2: BM-SC allocates the following parameters for the session description of the MBMS User Service: TMGI, FLUTE IP Multicast Address, UDP Port and TSI (see IETF RFC 3926 [19]). + +NOTE 3: BM-SC derives the SAI list for the MBMS Service Area from Geographical Area provided in Content Provider request and from PLMN id negotiated in step 1. FEC information (codec and ratio) and MBMS Bearer QoS (ARP, QCI) are also negotiated in step 1. + +NOTE 4: The Service Announcement start time can be provided in the request. If not, BM-SC is expected to start announcing the service as soon as all required service and session properties are provided by the Content Provider. + +NOTE 5: In the case of regionalized services, i.e. ones whose contents are region-specific, a session can be cloned so that all sessions of the user service share the same FLUTE parameters. + +- 9: A unique resource id of the session, which identifies the created session, is returned by the BM-SC to the Content Provider. Additionally, the push URL (whereby the required xMB-U ingest mode is set to push) and QoE Report URL are added to the response. +- 10: The Content Provider queries the session configuration by providing the resource ids of the session and service. The Content Provider needs the Push URL to configure the DASH segmenter. The BM-SC provides the information in the response, which includes all readable session properties. +- 11: The Content Provider updates the session by providing the DASH MPD URL (Application Entry Point URL). The BM-SC sends a response with update status. + +- 12: Once all information for service announcement is available, and if service announcement start time has elapsed, the BM-SC starts announcing the service automatically. Service announcement is automatically updated following subsequent session updates. + +The following steps pertain to the BM-SC activating automatically the MBMS Bearer at session start time. See 3GPP TS 26.346 [3] and 3GPP TS 29.061 [20] for further details. + +- 13: The BM-SC activates the MBMS bearer by providing the TMGI, the Flow ID, the MBMS Service Area (MSA), the GBR and other parameters to the MBMS-GW. +- 14: When the Content Provider has configured a Notification URL for the service, the BM-SC delivers service/session related notification messages to the Content Provider. +- 15: When the MBMS bearer is activated, the BM-SC will start forwarding the xMB-U user plane data (push interface here). Any xMB-U user plane data received before activation of the MBMS bearer can be discarded. +- 16: At session stop time, the MBMS bearer is terminated. +- 17: The BM-SC can notify the Content Provider about the termination of the MBMS Bearer. + +NOTE 6: The Content Provider terminates the service, when the service is not needed anymore. All sessions, which have been created or are active will be deleted automatically by BM-SC with the termination of the service. + +## --- A.3 xMB Procedure example for Live DASH services (with Service Continuity) + +This procedure example describes the xMB-C procedures for a Live DASH service with service continuity. See 3GPP TS 26.247 [18] for the specification of DASH services. Service continuity allows UEs to enter or leave the MBMS service areas while receiving a Live DASH service. UEs can switch to unicast as defined in clause 7.6 of 3GPP TS 26.346 [3] when leaving the MBMS service area. + +In case of service continuity support, the system offers representations via unicast and via MBMS Bearers. A unified MPD (cf. clause 7.6 of 3GPP TS 26.346 [3]) contains the corresponding retrieval information. When service continuity is supported, the Content Provider provides MPD and Initialization Segments for both unicast and MBMS bearer access and also the associated Media Segments. The Content Handler functions forwards the content to a DASH (unicast) Server. The DASH (unicast) server can use a Content Delivery Network (CDN) for unicast delivery. + +A push interface is used here as ingestion method for the xMB-U user-plane data. The source of the user plane data (Content Provider Source) are the DASH Media Segments as produced by a Live Encoder / Segmenter, which produces the content for unicast and MBMS bearer delivery. The Media Presentation Description and Initialization Segment for the Live DASH session are provided separately to the BM-SC. + +The Service Announcement Function (SAF) of the BM-SC creates the needed metadata fragments for the MBMS User Service. To support service continuity, the SAF adds base pattern elements to the *userServiceDescription* element. The MBMS Client in the UE matches the base pattern against a portion of the entire request URL. The SAF creates unified MPD by adding information specific elements to it. The SAF makes the service announcement information available via unicast and via MBMS. + +A content handler function of the BM-SC handles the separation of unicast and MBMS bearer content. The content handler function makes the content available in operators CDN for unicast access. + +## --- A.4 xMB Procedure example for File Delivery Services (without File Schedule) + +This procedure example describes the provisioning procedure for the delivery of a File Delivery service, to a single broadcast area, without the presence of the *fileSchedule* element in the Schedule Description fragment of MBMS User Service Announcement information. The *fileSchedule* element contains transmission timing information for each file by its file URL. Consequently, the file URLs must be present when creating service announcement information. + +This example assumes that the BM-SC automatically fetches the file using a pull method (xMB-U mode) and prepares the transmission. File URLs can be provided in the session creation request or any subsequent session update request. When file preparation ends after the session start time, the file is automatically added to user plane flow. It is up to Content Provider to ensure that session scheduling is large enough to allow files preparation and transmission according to bitrate between BM-SC and file location, and bitrate of user plane. + +![Sequence diagram showing the interaction between UE, MBMS-GW, BM-SC, CP Control, and CP Source for a file delivery session. The diagram is divided into four main phases: 1. Operator and Content Provider agree Service Level Agreement; 2. BM-SC admin applies agreed ranges to BM-SC; 3. Provisioning a File Delivery Session (including Authentication, Service creation, and Session creation); 4. MBMS Bearer is activated (Session Start, User Plane Data, Notification); 5. MBMS Bearer is deactivated (Session Stop, Notification).](9b1ec0090070bdf52ea28763b8d52477_img.jpg) + +``` + +sequenceDiagram + participant UE + participant MBMS-GW + participant BM-SC + participant CP Control + participant CP Source + + Note over all: 1: Operator and Content Provider agree Service Level Agreement + Note over BM-SC: 2: BM-SC admin applies agreed ranges to BM-SC + + Note over all: Provisioning a File Delivery Session + Note over BM-SC, CP Control: Creating a Service + BM-SC->>CP Control: 3: Authentication and Authorization + Note over all: ----- + BM-SC->>CP Control: 4: HTTP POST + CP Control-->>BM-SC: 5: HTTP 201 CREATED + BM-SC->>CP Control: 6: HTTP GET + CP Control-->>BM-SC: HTTP 200 OK + BM-SC->>CP Control: 7: HTTP PUT/PATCH + CP Control-->>BM-SC: HTTP 200 OK + Note over all: ----- + Note over BM-SC, CP Control: Creating a Session + BM-SC->>CP Control: 8: HTTP POST + CP Control-->>BM-SC: 9: HTTP 201 CREATED + Note over all: ----- + BM-SC->>MBMS-GW: 10: Do service announcement (when all data present) + BM-SC->>CP Control: 11: HTTP GET + CP Control-->>BM-SC: 12: HTTP 200 OK + BM-SC->>CP Control: 13: HTTP PUT/PATCH + CP Control-->>BM-SC: 14: HTTP 200 OK + Note over all: ----- + + Note over all: MBMS Bearer is activated + BM-SC->>MBMS-GW: 15: MBMS Session Start + MBMS-GW-->>BM-SC: Ok + BM-SC->>CP Control: Notification (Session Id start) + BM-SC->>UE: 16: User Plane Data + BM-SC->>CP Control: Notification (File URL delivery) + Note over all: ----- + + Note over all: MBMS Bearer is deactivated + BM-SC->>MBMS-GW: 17: MBMS Session Stop + MBMS-GW-->>BM-SC: Ok + BM-SC->>CP Control: Notification (Session Id stop) + +``` + +Sequence diagram showing the interaction between UE, MBMS-GW, BM-SC, CP Control, and CP Source for a file delivery session. The diagram is divided into four main phases: 1. Operator and Content Provider agree Service Level Agreement; 2. BM-SC admin applies agreed ranges to BM-SC; 3. Provisioning a File Delivery Session (including Authentication, Service creation, and Session creation); 4. MBMS Bearer is activated (Session Start, User Plane Data, Notification); 5. MBMS Bearer is deactivated (Session Stop, Notification). + +###### **Figure A.4-1: xMB-C and xMB-U Procedures for a File Delivery Service** + +- 1: The operator and the Content Provider agree on a Service Level Agreement (SLA), which entitles the Content Provider to use the MBMS system (in accordance to some rules) for content delivery. For instance, the SLA can include day time ranges, during which the Content Provider can distribute its content. The SLA can also include geographical areas, in which the Content Provider is allowed to distribute content. The SLA also includes target bitrates and likely definitions of tolerable losses per service. +- 2: The BM-SC administrators (operator) apply the agreed ranges. This can imply to add additional Service Areas, the provisioning of and other system related configurations. + +The Content Provider provisioning a file delivery session in a single broadcast area. + +- 3: The Content Provider authenticates itself as authorized user. The Content Provider can only see those configurations, sessions and services, which belong to the Content Provider. +- 4: The Content Provider creates a new service. Optionally, the Content Provider may provide properties for the service like service class, service languages, service names, notification configuration as well as consumption reporting configuration. The Content Provider can select whether the Content Provider or the operator distributes service announcement by providing a list of Service Announcement Channel (SACH, as defined in Annex L.2 / L.3 of 3GPP TS 26.346 [3]) services used for operator-driven service announcement. + +NOTE 1: BM-SC derives the required UE capabilities from the provided service and session properties. + +- 5: Upon successful service creation by the BM-SC, the BM-SC shall provide a unique resource id of the service, that the Content Provider can use for subsequent requests. +- 6: The Content Provider retrieves the current service properties. The unique resource id of the service is provided by the Content Provider as input to the BM-SC. The BM-SC responds with the service properties. +- 7: The Content Provider updates service properties. The unique resource id of the service and some or all service properties are provided by the Content Provider as input to the BM-SC +- 8: The Content Provider creates a session for previously created service. The unique resource id of the service is provided by the Content Provider as input to the BM-SC. Optionally, the Content Provider may provide common session properties like max ingest bitrate (excluding any FEC redundancy and transport overhead), scheduling information (start time, stop time), Geographical Area and QoE Reporting configuration and session type (set to Files) as input. File specific session properties provided as input by Content Provider: xMB-U ingest mode (pull/push), file list if xMB-U pull mode. + +NOTE 2: BM-SC allocates following parameters for SDP of the MBMS User Service: TMGI, FLUTE IP Multicast Address, UDP Port and TSI (see 3GPP TS 26.346 [3]). + +NOTE 3: BM-SC derives the SAI list for the MBMS Service Area from Geographical Area provided in Content Provider request and from PLMN id negotiated in step 1. FEC information (codec and ratio) and MBMS Bearer QoS (ARP, QCI) are also negotiated in step 1. + +NOTE 4: In xMB-U pull ingest mode, file URLs can be provided now (i.e. at session resource creation) or at a later stage (e.g. while the session is active) through the Session Update xMB-C procedure. + +NOTE 5: Service Announcement start time can be provided in request. If not, BM-SC starts announcing service as soon as all required service and session properties are provided by Content Provider. + +NOTE 6: In the case of regional services, i.e. that deliver region specific content, a session can be cloned so that all Sessions of user service use same FLUTE parameters. + +- 9: A unique resource id of the session, which identifies the created Session, is responded. If xMB-U push ingest mode is used, BM-SC provides also the push URL the Content Provider shall use. + +NOTE 7: For file URLs provided in session creation request, the BM-SC starts automatically to fetch the file resource(s) from the content location when file earliest fetch time elapses and generates the FLUTE and FEC symbols (if any). The BM-SC can notify the Content Provider when the process is finalized. + +10: Once all information for service announcement is available, and if service announcement start time is elapsed, the BM-SC starts announcing the service automatically. Service announcement is automatically updated following subsequent Session updates. File schedule element can be present in Schedule fragment for files URLs provided in Session creation request. + +11: The Content Provider queries the Session configuration, providing the resource ids of the session and service. + +12: The BM-SC provides the information in response. + +13: The Content Provider updates session by providing additional File URLs. + +14: The BM-SC sends response with update status. + +NOTE 8: The BM-SC starts automatically to fetch the new file resource(s) from the content location when file earliest fetch time elapses and generates the FLUTE and FEC symbols (if any). The BM-SC can notify the Content Provider when the process is finalized. + +NOTE 9: Steps 9-12 can be executed at any time after Session is created and prior to the Session stop time. Any file URL added after Session start time will be automatically fetched, processed and sent on user plane. + +The BM-SC activates automatically the MBMS Bearer at session start time. + +15: The BM-SC activates the MBMS bearer by providing the TMGI, the Flow ID, the MBMS Service Area (MSA), the GBR and other parameters to the MBMS-GW. The BM-SC can notify the Content Provider about the activation of the MBMS Bearer. + +16: When the MBMS Broadcast bearer is activated, then the BM-SC starts sending the user plane data, according to target reception completion time. The BM-SC can notify Content Provider of file delivery start/end. + +17: At session stop time, the MBMS bearer is terminated. The BM-SC can notify the Content Provider about the termination of the MBMS Bearer. + +NOTE 10: The Content Provider terminates the service. All sessions, which are still created or active will be deleted automatically by BM-SC with the termination of the service. + +# Annex B (normative): JSON Schema + +``` +{ + "swagger": "2.0", + "info": { + "title": "BM-SC API", + "description": "BM-SC Content Provider ingestion API", + "version": "1.0.2" + }, + "host": "", + "schemes": [ + "https" + ], + "basePath": "/xmb/v1.0", + "produces": [ + "application/json" + ], + "paths": { + "/services": { + "get": { + "description": "Return all supported services", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "A list of services.", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Service" + } + } + } + } + } + } + } +} +``` + +``` + } + } +}, +"default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } +} +} +}, +"post":{ + "description":"Creates a service", + "produces":[ + "application/json" + ], + "responses":{ + "201":{ + "description":"Service successfully created..", + "schema":{ + "$ref":"#/definitions/services-response" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + } + } +} +}, +"/services/{service-id}":{ + "get":{ + "description":"Returns resource for a given service-id", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"OK.", + "schema":{ + "$ref":"#/definitions/Service" + } + } + } + } +}, +"patch":{ + "description":"Update a service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"body", + "in":"body", + "required":true, + "description":"Service that needs to be created", + "schema":{ + "$ref":"#/definitions/Service" + } + }, + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + } + ] +} +``` + +``` + "format":"int32" + } +}, +"responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/Service" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } +} +}, +"put":{ + "description":"Updates a service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"body", + "in":"body", + "required":true, + "description":"Service that needs to be created", + "schema":{ + "$ref":"#/definitions/Service" + } + }, + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/Service" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + } +}, +"delete":{ + "description":"Delete a service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", +``` + +``` + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } +], +"responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/services-response" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } +} +} +}, +"/services/{service-id}/sessions":{ + "get":{ + "description":"Return all sessions of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"A list of sessions.", + "schema":{ + "type":"array", + "items":{ + "$ref":"#/definitions/Session" + } + } + }, + "default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } + } + } + }, + "post":{ + "description":"Create a session for a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ +``` + +``` + "201":{ + "description":"Session successfully created..", + "schema":{ + "$ref":"#/definitions/session-response" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + } + } +} +}, +"/services/{service-id}/sessions/{session-id}":{ + "get":{ + "description":"Return a session of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"OK.", + "schema":{ + "$ref":"#/definitions/Session" + } + } + } + }, + "patch":{ + "description":"Updates a session of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"body", + "in":"body", + "required":true, + "description":"Session that needs to be created", + "schema":{ + "$ref":"#/definitions/Session" + } + }, + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + } + ] + } +} +``` + +``` + } +], +"responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/Session" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } +} +}, +"put":{ + "description":"Update a session of a given service", + "produces":{ + "application/json" + }, + "parameters":{ + { + "name":"body", + "in":"body", + "required":true, + "description":"Session that needs to be created", + "schema":{ + "$ref":"#/definitions/Session" + } + }, + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + } + }, + "responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/Session" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + } +}, +"delete":{ + "description":"Delete a session of a given service", +} +``` + +``` +"produces":[ + "application/json" +], +"parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + } +], +"responses":{ + "200":{ + "description":"The request has succeeded", + "schema":{ + "$ref":"#/definitions/session-response" + } + }, + "204":{ + "description":"The request has succeeded" + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } +} +}, +"/services/{service-id}/reports":{ + "get":{ + "description":"Returns all reports of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"A list of reports.", + "schema":{ + "type":"array", + "items":{ + "$ref":"#/definitions/Report" + } + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + }, + }, +} +``` + +``` + "default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } + } + } + } + }, + "/services/{service-id}/reports/{report-id}":{ + "get":{ + "description":"Returns all reports of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"report-id", + "in":"path", + "description":"Report Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"A report with given report-id", + "schema":{ + "$ref":"#/definitions/Report" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + }, + "default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } + } + } + } + }, + "/services/{service-id}/sessions/{session-id}/reports":{ + "get":{ + "description":"Return all reports of a given session of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, +``` + +``` + "type":"integer", + "format":"int32" + } +], +"responses":{ + "200":{ + "description":"OK.", + "schema":{ + "$ref":"#/definitions/Report" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } +} +}, +"/services/{service-id}/sessions/{session-id}/reports/{report-id}":{ + "get":{ + "description":"Return all reports of a given session of a given service", + "produces":[ + "application/json" + ], + "parameters":[ + { + "name":"service-id", + "in":"path", + "description":"Service Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"session-id", + "in":"path", + "description":"Session Id", + "required":true, + "type":"integer", + "format":"int32" + }, + { + "name":"report-id", + "in":"path", + "description":"Report Id", + "required":true, + "type":"integer", + "format":"int32" + } + ], + "responses":{ + "200":{ + "description":"OK.", + "schema":{ + "$ref":"#/definitions/Report" + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "404":{ + "description":"Request not found" + } + } + } +}, +"/notifications":{ + "get":{ + "description":"Returns all notifications.", + "produces":[ +``` + +``` + + "application/json" + ], + "responses":{ + "200":{ + "description":"A list of notifications.", + "schema":{ + "type":"array", + "items":{ + "$ref":"#/definitions/Notification" + } + } + }, + "401":{ + "description":"Request requires user authentication" + }, + "403":{ + "description":"Request cannot be fulfilled" + }, + "default":{ + "description":"Unexpected error", + "schema":{ + "$ref":"#/definitions/Error" + } + } + } +} +}, +"definitions":{ + "Service":{ + "type":"object", + "description":"Service Description", + "properties":{ + "id":{ + "type":"number", + "description":"Service Resource Identifier" + }, + "service-id":{ + "type":"string", + "description":"Identifies the MBMS User Service as defined in Clause 11.2.1.1 of TS +26.346." + }, + "service-class":{ + "description":"Service Class", + "type":"string" + }, + "service-languages":{ + "type":"array", + "description":"List of service languages", + "items":{ + "type":"string" + } + }, + "service-names":{ + "type":"array", + "description":"List of service names", + "items":{ + "type":"string" + } + }, + "receive-only-mode":{ + "description":" When set to true, the Content Provider indicates that the service is a Receive Only +Mode service.", + "type":"boolean" + }, + "service-announcement-mode":{ + "description":"Enumeration that the BM-SC creates according service announcement +fragments for the sessions and / or do service announcement on SACH. Additional service announcement +modes may be added in future", + "type":"string" + }, + "consumption-reporting-configuration":{ + "type":"object", + "description":"The Content Provider wishes to collect consumption reports (enabling +precision, i.e. combination of sample percentage and reporting interval)", + "properties":{ + "reporting-interval":{ + "type":"number", + } + } + } + } + } +} + +``` + +``` + "description":"The interval for which the BM-SC has to aggregate the statistics +for" + }, + "sample-percentage":{ + "type":"number", + "description":"Percentage of users to collect reports from" + }, + "start-time":{ + "type":"string", + "description":"Start time of consumption report collection" + }, + "end-time":{ + "type":"string", + "description":"End time of consumption report collection" + } + } +}, +"push-notification-url":{ + "type":"string", + "description":"The Content Provider provides Notification URL over which it will +receive notifications "pushed" by the BM-SC. The Notification procedure is described in Clause 5.3.6 +of 3GPP TS 26.348 [33]." +}, +"push-notification-configuration":{ + "type":"string", + "description":"If the Content Provider enables push delivery of notifications, then the +Content Provider may provide notification filters. This parameter contains a comma separated list of +Classes it wishes to receive among the following options: Critical, Warning, Information, Service, +Session, or All to get all types of notification. The notification message shall be sent immediately +to the Content Provider upon becoming available." +} +} +}, +"services-response": { + "required": [ + "service-res-id" + ], + "properties": { + "service-res-id": { + "type": "integer", + "format": "int32", + "description": "The resource identifier of the service." + } + } +}, +"Session":{ + "type":"object", + "description":"Session Description", + "properties":{ + "id":{ + "type":"string", + "description":"Session Resource Identifier" + }, + "session-start":{ + "description":"Start time when the MBMS Bearer is active", + "type":"number" + }, + "session-stop":{ + "description":"Stop time until the MBMS bearer is active", + "type":"number" + }, + "max-ingest-bitrate":{ + "description":"The requested bitrate excludes FEC overhead and transport overhead. The +BM-SC calculates the MBMS Bearer bitrate from it, considering overhead like FEC and other transport +overheads. The session bitrate is always larger or equal to the payload bitrate", + "type":"number", + "format":"float" + }, + "max-delay":{ + "description":"Specifies the maximum delay the MBMS System should add, i.e. from the +time the data is received to the time by when the data is released from the MBMS system", + "type":"number", + "format":"float" + }, + "session-state":{ + "description":"The BM-SC may automatically change the state of the session. Possible +states: Session Idle, Session Announced, Session Active", + "type":"string" + } + } +} +``` + +``` + + }, + "service-announcement-start-time":{ + "description":"When present, this time at which the BM-SC shall start service +announcement", + "type":"number" + }, + "geographical-area":{ + "description":"Geographics Area, where the service is provided, either through unicast +or through MBMS Bearers. The BM-SC derives the MBMS Service Area and the SAI list for the +availability information from Geographical Area as provided by the Content Provider. The content of +each string item is left to the business agreement between the Content Provider and the Operator.", + "type":"array", + "items":{ + "type":"string" + } + }, + "qoe-reporting-configuration":{ + "type":"array", + "description":"The Content Provider wishes to collect QoE reports for this session. If +this configuration is included, the QoE reporting configuration shall be applied only for this +session. If this configuration is present, the Content Provider requests overriding of service level +configuration for this session with this configuration. The possible QoE metrics that the Content +Provider may request can be either found in or derived from subclauses 8.4.2 and 10 of 3GPP TS +26.347 [21], as well as the reception reporting information that is available in subclause 9.4.6 of +3GPP TS 26.346 [3]. The detailed or aggregated reports shall not contain information such as +clientId, which might pose privacy concerns, or networkResourceCellId, which would expose mobile +network information.", + "items":{ + "type":"object", + "description":"QoE metric configuration", + "properties":{ + "metric-name":{ + "type":"string", + "description":"Name of QoE metric" + }, + "metric-type":{ + "type":"string", + "description":"Type of metric" + }, + "reporting-interval":{ + "type":"number", + "description":"The interval for which the BM-SC has to aggregate the statistics +for" + }, + "sample-percentage":{ + "type":"number", + "description":"Percentage of users to collect reports from" + }, + "start-time":{ + "type":"string", + "description":"Start time of consumption report collection" + }, + "end-time":{ + "type":"string", + "description":"End time of consumption report collection" + } + } + } + }, + "session-type":{ + "description":"The session type is how the Content Provider is providing the content to +the BM-SC. The BM-SC is selecting the appropriate delivery methods from the session type. The +session type shall be extensible for further session types", + "type":"string", + "enum":{ + "Streaming: When the session type is set to Streaming, the BM-SC expects a Streaming +type input (RTP). When the method is set to streaming, then the format is compliant to MBMS +streaming (as defined in 3GPP TS 26.346 [3]).", + "Files: When the session type is set to Files, the BM-SC expects generic files as +input. The files can be provided either by on-request pull interactions or continuous push ingest", + "Application: When the session type is set to Application, then the ingest depends on +the application service description. When the Application Service Description is set to DASH, the +BM-SC expects an MPD and optionally one or more IS's. The content is assumed to be 3GP-DASH +compliant (as defined by 3GPP TS 26.247). The BM-SC may either pull the Media Segments from the +Content Provider or the Content Provider continuously pushes Segments into the BM-SC", + "Transport-Mode: When the session type is set to Transport-Mode, the BM-SC provides +transport of data/TV content in a transparent manner. The content provide may provide some +configuration parameters for the distributions" + } + } + } +} + +``` + +``` + + ] + }, + "max-cid": { + "type": "integer", + "minimum": 0, + "maximum": 16383, + "description": "indicating the MAX CID parameter for the compressor (see IETF RFC 5795)." + }, + "header-compression":{ + "description":"Requests the BM-SC to enable ROHC on the input flows.", + "type":"array", + "items":{ + "type":"object", + "description":"Describes a single input flow where ROHC is to be applied. Either ipv4addr +or ipv6addr shall be included and port and periodicity may be included.", + "properties":{ + "ipv4addr":{ + "type":"string", + "description":"An IPv4 address formatted in the 'dotted decimal' notation as defined +in IETF RFC 1166 [31]" + }, + "ipv6addr":{ + "type":"string", + "description":" An IPv6 address formatted according to clause 4 of IETF RFC 5952 +[32]. The mixed IPv4 IPv6 notation according to clause 5 of IETF RFC 5952 [32] shall not be used." + }, + "port":{ + "type":"integer", + "description":"A UDP or TCP port between 0 and 65535 " + }, + "periodicity":{ + "type":"number", + "description":"the target periodicity for ROHC full header packets in units of seconds" + }, + "profile":{ + "type":"integer", + "description":"the applicable ROHC profile (see IETF RFC 5795 [27])" + } + } + } + }, + "fec":{ + "description":"Requests the BM-SC to perform FEC protection of the input flow when transmitting +over the MBMS channel. The string shall include an SDP description of FEC framework configuration +information (see subclause 5.5 of IETF RFC 6363 [29]) formatted according to subclause 8A.5 of +3GPP TS 26.346 [3].", + "type":"string" + }, + "resource-sharing-ind":{ + "type":"boolean", + "description": "The resource sharing indication." + }, + "resource-sharing-id":{ + "type":"string", + "description": "The resource sharing id. When present in the session modification +operation, the value of the field identifies an existing xMB session resource URL (as specified in +table 5.1.1-1) to share the transmission, where Max Bitrate, Geographical Area and (in case of MC +Services) QoS Information are re-used." + }, + "transport-mode-session":{ + "description":"Describes a transport mode session", + "type":"object", + "properties":{ + "session-announcement-mode":{ + "description":"The session announcement mode is either Content Provider or MBMS", + "type":"string", + "enum":[ + " Content Provider: the BMSC generates the session parameters and provides those +to the Content Provider.", + "SACH: the session announcement is done by the MBMS system through the SACH." + ] + }, + "userplane-session-description-parameters":{ + "description":"The session description parameters for the user plane provide the +information on where and how the to access the session at the Content Provider. The parameters Type +and Access URL. Note the BM-SC may get input on session properties from the Content Provider, e.g. +bitrate, dependening on the ingest session.", + "type":"object", + } + } + } +} + +``` + +``` + + "properties":{ + "session-description-type":{ + "type":"string", + "description":"The type of the session that describes the session, typically +for proper interpretation of the target resource of the request, for example the Internet Media Type +of the document, of the URL in an HTTP URL. An "Embedded" type is defined which indicates that the +xMB-U user plane parameters are embedded in the User Plane Parameters object." + }, + "session-description-access-url":{ + "type":"string", + "description":"A URL that enables to access and possibly control the ingest +session. The URL may for example be an RTSP URL or a URL to an SDP that describes a multicast stream +or an HTTP URL to retrieve a ready packaged MPEG2-TS stream, etc." + }, + "user-plane-parameters": { + "type": "string", + "description": "When the Type is set to 'Embedded', the Content Provider adds an +object containing the session description. In case of Forward Only Mode, the object may contain a +ready-made Session Description and the indication of a single xMB-U reception UDP port. When a +Session Description is present, then the BM-SC uses it for Session Announcement. In case of Proxy +Mode, the object shall contain a Session Description template and a list of the UDP flows to be +forwarded on the established MBMS bearer for the session. For each list entry, the content provider +indicates whether this flow is directly associated with a media description entry in the Session +Description Template or whether it is related to a media description entry (e.g. RTCP flows, which +have a relation to a media description entry, but are not described in the Session Description). If +the flow is directly associated with a media description entry, the BM-SC shall modify the port +field of the media description entry in the Session Description Template. If the flow is related to +a media description entry, then the BM-SC just forwards the flow on a port that is equal to the port +of the related media session plus an offset; such a flow is only implicitly described in the session +description - for example corresponding to the RTCP flows per the RTP/AVP profile." + } + } + }, + "userplane-delivery-mode-configuration":{ + "description":"This mode configures how the session needs to be delivered to the +application, i.e. it basically establishes the delivery mode", + "type":"string", + "enum":[ + "Forward-only: The BM-SC receives complete IP Multicast packets for to be +forwarded", + "Proxy: Proxy the incoming UDP payloads to the outgoing UDP payloads" + ] + }, + "delivery-session-description-parameters":{ + "description":"If the Service Announcement Mode is set to Content Provider, then +at least the following information is provided by the BM-SC: TMGI of the MBMS Bearer. Note that +additional parameters may be provided, based on the configuration options of the delivery method for +transport only.", + "type":"string" + } +} +}, +"streaming-session":{ + "description":"Describes a streaming session", + "type":"object", + "properties":{ + "sdp-url":{ + "description":"A URL to the SDP that describes the streaming session between the +Content Provider and the BM-SC, that will be used for ingesting the streaming session. The SDP shall +include the RTSP links for every media session as part of the "a=control" attribute to enable RTSP +control of the session. The SDP shall also contain the required bitrate for each of the media +sessions. The content shall conform to the constraints of this specification.", + "type":"string" + }, + "time-shifting":{ + "description":"Indicates if and for how long time shifting access to the content +(using unicast) may be provided for this session.", + "type":"number" + } + } +}, +"application-session":{ + "description":"Describes an application session", + "type":"object", + "properties":{ + "application-service":{ + "description":"Mimetype of the Application Service", + "type":"string" + } + } +} + +``` + +``` + + }, + "ingest-mode":{ + "description":"The ingest mode enumerates how resources are ingested into the BM- +SC", + "type":"string", + "enum":[ + "Pull: The BM-SC pulls the resources as described by the application entry point +document. If DASH resources are Media Segments, the BM-SC pulls the Media Segments as described by +the Segment availability start time from a DASH MPD.", + "Push: The Content Provider pushes resources. The BM-SC needs to provide a push +URL. If DASH resources are Media Segments, Content Provider pushes Media Segments, so that the Media +Segment is available on the BM-SC according to Segment availability start time. The BM-SC needs to +provide a push URL." + ] + }, + "application-entry-point-url":{ + "description":"The application entry point refers to an MPD when Application +Service Description is set to DASH. When the Ingest Mode is set to Push, then the MPD Url refers to +a DASH MPD which should be fetched, optionally conditioned and inserted into Service Announcement. +When the Ingest Mode is set to Pull, then the BM-SC starts fetching the Segments using unicast.", + "type":"string" + }, + "push-url":{ + "description":"If the Session Type is set to Application: A resource locator for +ingesting Media Segments using HTTP. The Content Provider may create additional sub-resources using +WebDAV procedures. This is a read-only parameter managed by the BM-SC and only present when Ingest +Mode is set to Push. If the Session Type is set to Files: This parameter contains the Push URL the +Content Provider shall use when using the Push ingestion mode. This is a read-only parameter managed +by the BM-SC and only present when Ingest Mode is set to Push. ", + "type":"string" + }, + "unicast-delivery":{ + "description":"Indicator whether the content is also available for unicast +retrieval", + "type":"boolean" + }, + "components":{ + "description":"List of Components of the application, which are recommended to be +made available on MBMS Bearers. In case of DASH, each component is identified by a representation +identifier. ", + "type":"array", + "items":{ + "type":"string" + } + } + }, + "files-session":{ + "description":"Describes a file session", + "type":"object", + "properties":{ + "ingest-mode":{ + "description":"The ingest mode enumerates how resources are ingested into the BM- +SC", + "type":"string", + "enum":[ + "Pull: The Content Provider adds files URLs that the BM-SC will fetch. The +Content Provider may tell the BM-SC when to start fetching the file", + "Push: The Content Provider shall push the file to the BM-SC that will +immediately process and deliver as soon as it is ready. The BM-SC may be configured to ignore all +files that are pushed before session active time, or stage them. The BM-SC shall provide back to the +Content Provider the URL the Content Provider shall use to push the files." + ] + }, + "push-url":{ + "description":"If the Session Type is set to Application: A resource locator for +ingesting Media Segments using HTTP. The Content Provider may create additional sub-resources using +WebDAV procedures. This is a read-only parameter managed by the BM-SC and only present when Ingest +Mode is set to Push. If the Session Type is set to Files: This parameter contains the Push URL the +Content Provider shall use when using the Push ingestion mode. This is a read-only parameter managed +by the BM-SC and only present when Ingest Mode is set to Push. ", + "type":"string" + }, + "file-list":{ + "type":"array", + "description":"List of files to be sent. In the Push mode, the file list is not +used since the BM-SC will monitor its push folder and send the files it receives on a first-come +first-served basis. In Pull mode, the file list contains the following information per file entry:", + +``` + +``` + + "items":{ + "type":"object", + "properties":{ + "file-url":{ + "type":"string", + "description":"the URL where the BM-SC will fetch the file content" + }, + "file-display-url":{ + "type":"string", + "description":"the file URL as seen by the UE" + }, + "file-earliest-fetch-time":{ + "type":"string", + "description":"The BM-SC shall fetch the file no sooner than this UTC +timestamp. If absent, then the file shall be present on the Content Provider server and the BM-SC +may fetch it when it wants", + "format":"date-time" + }, + "file-latest-fetch-time":{ + "type":"string", + "description":"The BM-SC shall fetch the file no later than this UTC +timestamp. If absent, then the file shall be present on the Content Provider server and the BM-SC +may fetch it at a time of its choosing.", + "format":"date-time" + }, + "file-size":{ + "type":"integer", + "format":"int32", + "description":"The Content Provider may provide the precise or an file size +estimate as input. The BM-SC may update the file size once it has started to fetch the file" + }, + "file-status":{ + "type":"string", + "description":"Enumeration stating the state of the file. Possible values +are pending, fetched, prepared, transmitting, sent", + "enum":[ + "pending", + "fetched", + "prepared", + "transmitting", + "sent" + ] + }, + "target-reception-completion-time":{ + "type":"string", + "description":"(On the MBMS Client) hint on the due date, when the file +should be completely received by the UE. The BM-SC should schedule and order the transmission etc +accordingly", + "format":"date-time" + }, + "keep-update-interval":{ + "type":"number", + "description":"The BM-SC checks the file resources with the given interval +for changes" + }, + "unicast-availability":{ + "description":"Indication that the file is also available for unicast +retrieval by the application at a Content Provider server whose location is given by the HTTP(S) URL +corresponding to the value of file display URL", + "type":"boolean" + }, + "byte-range":{ + "type":"boolean", + "description": "indicates that the HTTP(S) URL given in the file display +URL parameter can be used for Byte-Range-Based file repair" + }, + "e-tag":{ + "type":"boolean", + "description": "value of the ETag used as version identifier for the file +in the Byte-Range-Based file repair requests" + }, + "file-repetition-duration":{ + "type":"integer", + "format":"int32", + "description":"The number of times the file shall be sent on the session (a +value of 1 means the file shall be sent only once). This counter shall be decreased each time the +file has been transmitted. When equals to zero, no more file repeat is scheduled. The BM-SC may send +FEC instead of source information" + } + } + } + } +} + +``` + +``` + + }, + "periodic-update-interval": { + "type": "number", + "description": "When present, it is an indication that this file of the list +of files is expected to be periodically updated, and the value of this parameter represents the +nominally expected time interval between successive updates of this file. This parameter is a signal +to the BM-SC to deliver the file and its updates as a Datacasting service. From its value, the BM-SC +will choose the delivery mode, and set the associated interval and mode values in controlling the +transmission of the Datacasting service." + } + } +}, +"file-delivery-manifest-url":{ + "description":"Alternative to the file list. The resource may describe scheduling +information for the file", + "type":"string" +}, +"display-base-url": { + "type": "string", + "description": "When ingest mode is set to Push, the Base URL is seen by the UE." +}, +"sa-file-url":{ + "type":"string", + "description": "URL of the SA file announcing the download delivery session, +provided by the BM-SC when service-announcement-mode is set to 'Content Provider'." +} +} +}, +"local-mbms-delivery-information": { + "type": "object", + "description": "Local MBMS Delivery Information", + "properties": { + "mbms-enb-ipv4-multicast-address": { + "type": "string", + "format": "ipv4", + "description": "Contains the M1 (transport) plane IPv4 destination multicast +address used by MBMS-GW for IP multicast encapsulation of application IP multicast datagrams." + }, + "mbms-enb-ipv6-multicast-address ": { + "type": "string", + "format": "ipv6", + "description": "Contains the M1 (transport) plane IPv6 prefix of destination +multicast address used by MBMS-GW for IP multicast encapsulation of application IP multicast +datagrams." + }, + "mbms-gw-ipv4-ssm-address": { + "type": "string", + "format": "ipv4", + "description": "Contains the value of MBMS-GW's IPv4 address for Source +Specific Multicasting." + }, + "mbms-gw-ipv6-ssm-address": { + "type": "string", + "format": "ipv6", + "description": " Contains the value of MBMS-GW's IPv6 address for Source +Specific Multicasting." + }, + "common-tunnel-endpoint-identifier": { + "type": "string", + "description": "Indicates the common tunnel endpoint identifier of MBMS GW +for user plane." + }, + "bm-sc-ipv4-address": { + "type": "string", + "format": "ipv4", + "description": "Indicates the destination IPv4 address of the BM SC for the +reception of user plane data via the xMB U interface." + }, + "bm-sc-ipv6-address": { + "type": "string", + "format": "ipv6", + "description": "Indicates the destination IPv6 address of the BM SC for the +reception of user plane data via the xMB U interface." + }, + "bm-sc-port": { + "type": "integer", + "minimum": 0, + } + } +} + +``` + +``` + "maximum": 65535, + "description": "Indicates the destination UDP port of the BM SC for the +reception of user plane data via the xMB U interface." + } + } + }, + "group-ids": { + "type": "array", + "description": "List of group identifiers", + "items" : { + "type" : "string" + } + }, + "mc-extension": { + "type": "object", + "description": "Mission critical extension, allowing QoS control by the content +provider", + "properties": { + "gbr": { + "type": "number", + "format": "float", + "description": "Guaranteed bitrate for the MBMS bearer in unit kbps" + }, + "qci": { + "type": "integer", + "minimum": 0, + "maximum": 255, + "description": "QoS class identifier for the MBMS bearer" + }, + "arp-priority-level": { + "type": "integer", + "minimum": 1, + "maximum": 15, + "description": "ARP priority level", + }, + "arp-pre-emption-capability": { + "type": "boolean", + "description": "ARP preemption capability" + }, + "arp-pre-emption-vulnerability": { + "type": "boolean", + "description": "ARP preemption vulnerability" + }, + "tmgi": { + "type": "string", + "description": "TMGI of the MBMS bearer" + } + } + } +} +}, +"session-response": { + "required": [ + "session-res-id" + ], + "properties": { + "session-res-id": { + "type": "integer", + "format": "int32", + "description": "The resource identifier of the session." + } + } +}, +"Report":{ + "type": "object", + "description": "Report Description", + "properties": { + "id": { + "type": "string", + "description": "Report Resource Identifier" + }, + "report-type": { + "description": "Type of report", + "type": "string" + }, + "report-url": { + "type": "string", + } + } +} +``` + +``` + + "description":"Location of the report from where the Content Provider can retrieve the +detailed report" + }, + "report":{ + "type":"string", + "description":"Detailed report" + }, + "report-starttime":{ + "type":"string", + "description":"Report collection start time" + }, + "report-endtime":{ + "description":"Report collection end time", + "type":"string" + } + } +}, +"Notification": { + "type": "object", + "description": "Notification Description", + "properties": { + "id": { + "type": "string", + "description": "Notification Resource Identifier" + }, + "message-class": { + "type": "string", + "description": "Indicates the message class of the notification", +"enum" : ["Critical: When some event drastically prevent the proper delivery of content", "Warning: +When the service can be partially delivered but quality is reduced", "Information: When the service +is properly delivered but some interesting event occurred", "transmitting", "Session/Service: +Information about Service/Session related parameters"] + }, + "message-name": { + "description": "Unique identifier of the message. Provides information about the message pertaining +to the message-class of the notification", + "type": "string", +"enum" : ["network-is-down", "service-badly-configured", "session-badly-configured", "incoming- +bitrate-exceed-session-capacity", "no-incoming-data", "goe-report-available", "consumption-reports- +available", "reception-reports-available", "service-announcement-change", "session-state-change", +"file-ready-for-transmission", "file-download-started ", "file-successfully-sent", "file-fetch- +error"] + }, + "message-information": { + "type": "object", + "description": "A dictionary of key values containing informations linked to the +notification", + "additionalProperties": { + "type": "string" + } + } + } +}, +"Error":{ + "type":"object", + "properties":{ + "code":{ + "type":"integer", + "format":"int32" + }, + "message":{ + "type":"string" + } + } +} + +``` + +# Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|------------------------------------------------------------------------------------------------------------|--------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New | +| 2017-01 | | | | | | TS initial skeleton | 0.0.0 | +| 2017-01 | | | | | | C3A170064, C3A170066, C3A170069 agreed in Adhoc | 0.1.0 | +| 2017-02 | | | | | | Specification of the xMB user- and control-plane procedures, accompanied by the corresponding JSON schema. | 0.2.0 | +| 2017-03 | CT#75 | CP-170102 | | | | TS sent for approval to Plenary | 1.0.0 | +| 2017-03 | CT#75 | CP-170102 | | | | TS under change control | 14.0.0 | +| 2017-06 | CT#76 | CP-171115 | 0001 | 2 | F | Editorial Updates to TS 29.116 v14.0.0 | 14.1.0 | +| 2017-06 | CT#76 | CP-171115 | 0002 | 2 | F | Technical Corrections to TS 29.116 v14.0.0 | 14.1.0 | +| 2017-06 | CT#76 | CP-171115 | 0003 | 3 | F | Technical Corrections to TS 29.116 v14.0.0 | 14.1.0 | +| 2017-06 | CT#76 | CP-171115 | 0004 | 2 | F | Supported feature negotiation | 14.1.0 | +| 2017-06 | CT#76 | CP-171137 | 0005 | 2 | B | Local MBMS related MBMS data delivery for xMB interface | 14.1.0 | +| 2017-06 | CT#76 | CP-171115 | 0010 | 2 | F | xMB Stage-2 related updates | 14.1.0 | +| 2017-06 | CT#76 | CP-171140 | 0011 | 2 | F | Security in xMB | 14.1.0 | +| 2017-09 | CT#77 | CP-172037 | 0013 | - | F | Reference correction | 14.2.0 | +| 2017-09 | CT#77 | CP-172037 | 0014 | 1 | F | Fixes and editorial updates to TS 29.116 | 14.2.0 | +| 2017-09 | CT#77 | CP-172053 | 0016 | 1 | F | Alignment to TS 26.346 | 14.2.0 | +| 2017-09 | CT#77 | CP-172055 | 0017 | 1 | F | Modification of Text on xMB Security | 14.2.0 | +| 2017-12 | CT#78 | CP-173087 | 0018 | 1 | F | Correction of Reference | 14.3.0 | +| 2018-06 | CT#80 | CP-181024 | 0021 | 1 | B | FEC and ROHC for mission critical services over MBMS | 15.0.0 | +| 2019-03 | CT#83 | CP-190129 | 0024 | 2 | F | Moving xMB stage 2 to TS 26.348 | 16.0.0 | +| 2019-06 | CT#84 | CP-191086 | 0027 | - | A | Correct feature applicability | 16.1.0 | +| 2019-06 | CT#84 | CP-191108 | 0029 | 1 | A | UE group content delivery | 16.1.0 | +| 2019-06 | CT#84 | CP-191099 | 0031 | 1 | A | Correct ROHC usage in xMB | 16.1.0 | +| 2019-09 | CT#85 | CP-192158 | 0032 | | F | Removal of a duplicated openAPI definition | 16.2.0 | +| 2019-12 | CT#86 | CP-193199 | 0033 | | F | Add file display URI support | 16.3.0 | +| 2019-12 | CT#86 | CP-193199 | 0034 | | F | Clarify consumption report configuration | 16.3.0 | +| 2019-12 | CT#86 | CP-193199 | 0035 | 1 | F | Clarify PATCH usage | 16.3.0 | +| 2019-12 | CT#86 | CP-193204 | 0036 | 1 | B | Mission critical extension | 16.3.0 | +| 2019-12 | CT#86 | CP-193204 | 0037 | | B | MBMS resource sharing | 16.3.0 | +| 2019-12 | CT#86 | CP-193204 | 0038 | | B | SA file returned for the download delivery session | 16.3.0 | +| 2019-12 | CT#86 | CP-193204 | 0039 | | B | File Repair hosted by the content provider | 16.3.0 | +| 2019-12 | CT#86 | CP-193204 | 0040 | 1 | B | xMB adaptation for CAPIF | 16.3.0 | +| 2019-12 | CT#86 | CP-193129 | 0041 | | A | Format for FEC framework configuration information in xMB | 16.3.0 | +| 2020-03 | CT#87e | CP-200217 | 0042 | | F | Correct xMB adaptation for CAPIF | 16.4.0 | +| 2020-03 | CT#87e | CP-200213 | 0043 | 1 | F | Correct opeAPI error in Mission critical extension section | 16.4.0 | +| 2020-06 | CT#88e | CP-201246 | 0044 | | F | Corrected reference to xMB stage-2 spec | 16.5.0 | +| 2020-06 | CT#88e | CP-201246 | 0045 | 1 | D | Remove redundant annex content | 16.5.0 | +| 2020-06 | CT#88e | CP-201239 | 0046 | | F | Correct qci for Mission critical extension | 16.5.0 | +| 2020-06 | CT#88e | CP-201249 | 0047 | | F | Fix the missing push url in file session | 16.5.0 | +| 2020-09 | CT#89e | CP-202061 | 0050 | | A | Correct xMB update procedure | 16.6.0 | +| 2021-06 | CT#92e | CP-211248 | 0052 | | B | eCAPIF support | 17.0.0 | +| 2021-12 | CT#94e | CP-213220 | 0053 | | B | Update of HTTP Digest Access Authentication | 17.1.0 | +| 2022-09 | CT#97e | CP-222094 | 0054 | | B | Supporting xMB interface extensions for 5GMS via eMBMS | 17.2.0 | +| 2022-12 | CT#98e | CP-223199 | 0055 | | F | Miscellaneous corrections | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29118/raw.md b/marked/Rel-18/29_series/29118/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..c2bd98dea24cf2a1ec6c9f32ce16ad24711e1a33 --- /dev/null +++ b/marked/Rel-18/29_series/29118/raw.md @@ -0,0 +1,3164 @@ + + +# 3GPP TS 29.118 V18.0.0 (2023-03) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Mobility Management Entity (MME) Visitor Location Register (VLR) SGs interface specification (Release 18)** + +![5G logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 5G logo, consisting of the text "5G" in a bold, black, sans-serif font. Above the "5" and "G" is a green graphic element consisting of three curved lines, resembling a signal strength indicator or a stylized wave. + +5G logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters "3GPP" in a stylized, bold, black font. The "3" and "G" are connected by a horizontal line, and the "P" and "P" are connected by a horizontal line. Below the "P"s is a small red graphic element consisting of three curved lines, resembling a signal strength indicator or a stylized wave. + +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. + +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..... | 9 | +| 2 References..... | 9 | +| 3 Definitions and abbreviations ..... | 10 | +| 3.1 Definitions..... | 10 | +| 3.2 Abbreviations ..... | 11 | +| 4 Description of the SGs association between a VLR and an MME ..... | 11 | +| 4.1 General ..... | 11 | +| 4.2 SGs association at the VLR..... | 11 | +| 4.2.1 General ..... | 11 | +| 4.2.2 States at the VLR..... | 12 | +| 4.3 SGs association at the MME ..... | 12 | +| 4.3.1 General ..... | 12 | +| 4.3.2 MM context variables at the MME ..... | 13 | +| 4.3.3 States at the MME ..... | 13 | +| 4.3.4 State transitions in the MME without SGsAP signalling ..... | 14 | +| 4.3.5 State transitions in the VLR without SGsAP signalling..... | 14 | +| 5 Procedures for SGs..... | 15 | +| 5.1 Paging for non-EPS services procedure ..... | 15 | +| 5.1.1 General description..... | 15 | +| 5.1.2 Procedures in the VLR ..... | 15 | +| 5.1.2.1 General..... | 15 | +| 5.1.2.2 Paging Initiation..... | 15 | +| 5.1.2.3 Paging Response ..... | 16 | +| 5.1.2.4 Paging Failure ..... | 16 | +| 5.1.2.5 UE unreachable..... | 17 | +| 5.1.3 Procedures in the MME..... | 17 | +| 5.1.3.1 General..... | 17 | +| 5.1.3.2 Procedure when no NAS signalling connection exists ..... | 20 | +| 5.1.3.3 Procedure when a NAS signalling connection exists ..... | 21 | +| 5.2 Location update for non-EPS services procedure ..... | 21 | +| 5.2.1 General description..... | 21 | +| 5.2.2 Procedures in the MME..... | 22 | +| 5.2.2.1 General..... | 22 | +| 5.2.2.2 Location update initiation ..... | 22 | +| 5.2.2.2.1 General ..... | 22 | +| 5.2.2.2.2 VLR fails without restart..... | 24 | +| 5.2.2.3 Location update response..... | 25 | +| 5.2.2.4 Location update failure ..... | 25 | +| 5.2.2.5 Abnormal cases..... | 26 | +| 5.2.2.6 Additional MME procedure for UE supporting NB-S1 mode only..... | 26 | +| 5.2.3 Procedures in the VLR ..... | 27 | +| 5.2.3.1 General..... | 27 | +| 5.2.3.2 Location update response..... | 27 | +| 5.2.3.3 Location update failure ..... | 28 | +| 5.2.3.4 TMSI reallocation procedure ..... | 28 | +| 5.2.3.5 Abnormal cases..... | 28 | +| 5.3 Non-EPS alert procedure..... | 29 | +| 5.3.1 General description..... | 29 | +| 5.3.2 Procedures in the VLR ..... | 29 | +| 5.3.2.1 Alert Initiation..... | 29 | +| 5.3.2.2 Alert Response..... | 29 | +| 5.3.2.3 Alert Failure ..... | 30 | +| 5.3.2.4 Alert Indication ..... | 30 | + +| | | | +|------------|--------------------------------------------------|----| +| 5.3.2.5 | Abnormal cases..... | 30 | +| 5.3.3 | Procedures in the MME..... | 30 | +| 5.3.3.1 | Alert response ..... | 30 | +| 5.3.3.2 | Alert failure..... | 30 | +| 5.3.3.3 | Alert indication ..... | 30 | +| 5.4 | Explicit IMSI detach from EPS services..... | 31 | +| 5.4.1 | General description..... | 31 | +| 5.4.2 | Procedures in the MME..... | 31 | +| 5.4.2.1 | Explicit EPS detach initiation ..... | 31 | +| 5.4.2.2 | Explicit EPS detach response ..... | 32 | +| 5.4.2.3 | Abnormal cases..... | 32 | +| 5.4.3 | Procedures in the VLR ..... | 32 | +| 5.5 | Explicit IMSI detach from non-EPS services ..... | 32 | +| 5.5.1 | General description..... | 32 | +| 5.5.2 | Procedures in the MME..... | 32 | +| 5.5.2.1 | Explicit IMSI detach initiation ..... | 32 | +| 5.5.2.2 | Explicit IMSI detach response..... | 33 | +| 5.5.2.3 | Abnormal cases..... | 33 | +| 5.5.3 | Procedures in the VLR ..... | 33 | +| 5.6 | Implicit IMSI detach from non-EPS services ..... | 33 | +| 5.6.1 | General description..... | 33 | +| 5.6.2 | Procedures in the MME..... | 34 | +| 5.6.3 | Procedures in the VLR ..... | 34 | +| 5.7 | VLR failure procedure ..... | 34 | +| 5.7.1 | General description..... | 34 | +| 5.7.2 | Procedures in the VLR ..... | 34 | +| 5.7.2.1 | VLR Reset Initiation..... | 34 | +| 5.7.2.2 | VLR Reset Response ..... | 34 | +| 5.7.2.3 | Abnormal cases..... | 35 | +| 5.7.3 | Procedures in the MME..... | 35 | +| 5.7.3.1 | VLR reset indication..... | 35 | +| 5.7.3.2 | Void ..... | 35 | +| 5.8 | MME failure procedure..... | 35 | +| 5.8.1 | General description..... | 35 | +| 5.8.2 | Procedures in the MME..... | 35 | +| 5.8.2.1 | MME Reset Initiation ..... | 35 | +| 5.8.2.2 | MME Reset Response..... | 36 | +| 5.8.2.3 | Abnormal cases..... | 36 | +| 5.8.3 | Procedures in the VLR ..... | 36 | +| 5.9 | HSS failure ..... | 36 | +| 5.9.1 | General description..... | 36 | +| 5.9.2 | Procedures in the MME..... | 36 | +| 5.10 | MM information procedure ..... | 37 | +| 5.10.1 | General description..... | 37 | +| 5.10.2 | Procedures in the VLR ..... | 37 | +| 5.10.3 | Procedures in the MME..... | 37 | +| 5.11 | Procedure for tunnelling of NAS messages ..... | 38 | +| 5.11.1 | General description..... | 38 | +| 5.11.2 | Uplink unitdata procedure ..... | 38 | +| 5.11.2.1 | Procedures in the MME..... | 38 | +| 5.11.2.2 | Procedures in the VLR..... | 38 | +| 5.11.2.2.1 | General description ..... | 38 | +| 5.11.2.2.2 | Abnormal cases ..... | 38 | +| 5.11.2.3 | Void ..... | 39 | +| 5.11.3 | Downlink unitdata procedure ..... | 39 | +| 5.11.3.1 | Procedures in the VLR..... | 39 | +| 5.11.3.2 | Procedures in the MME..... | 39 | +| 5.11.3.2.1 | General description ..... | 39 | +| 5.11.3.2.2 | Abnormal cases ..... | 39 | +| 5.11.3.3 | Void ..... | 39 | +| 5.11.4 | Release procedure..... | 39 | +| 5.12 | Service request procedure ..... | 40 | + +| | | | +|--------|-----------------------------------------------------------------|----| +| 5.12.1 | General description..... | 40 | +| 5.12.2 | Procedures in the MME..... | 40 | +| 5.12.3 | Procedures in the VLR ..... | 40 | +| 5.13 | Service abort procedure..... | 41 | +| 5.13.1 | General description..... | 41 | +| 5.13.2 | Procedures in the VLR ..... | 41 | +| 5.13.3 | Procedures in the MME..... | 41 | +| 5.14 | Implicit IMSI detach from EPS services..... | 41 | +| 5.14.1 | General description..... | 41 | +| 5.14.2 | Procedures in the MME..... | 42 | +| 5.14.3 | Procedures in the VLR ..... | 42 | +| 5.15 | UE fallback supervision procedure ..... | 42 | +| 5.15.0 | General description..... | 42 | +| 5.15.1 | Procedures in the VLR ..... | 42 | +| 5.16 | Procedure for MO CSFB indication..... | 43 | +| 5.16.1 | General description..... | 43 | +| 5.16.2 | Procedures in the MME..... | 43 | +| 5.16.3 | Procedures in the VLR ..... | 43 | +| 6 | SGs transport..... | 43 | +| 6.1 | General ..... | 43 | +| 6.2 | IP layer ..... | 43 | +| 6.3 | Transport layer ..... | 43 | +| 7 | Error handling ..... | 44 | +| 7.1 | General ..... | 44 | +| 7.2 | Message too short..... | 44 | +| 7.3 | Unknown or unforeseen message type..... | 44 | +| 7.4 | Missing mandatory information element ..... | 45 | +| 7.5 | Information elements unknown or unforeseen in the message ..... | 45 | +| 7.6 | Out of sequence information elements..... | 45 | +| 7.7 | Repeated information elements..... | 45 | +| 7.8 | Syntactically incorrect mandatory information element. .... | 45 | +| 7.9 | Syntactically incorrect optional information elements..... | 45 | +| 7.10 | Conditional information element errors ..... | 45 | +| 7.11 | Information elements with semantically incorrect contents..... | 46 | +| 8 | Message functional definitions and contents ..... | 46 | +| 8.1 | SGsAP-ALERT-ACK message..... | 46 | +| 8.2 | SGsAP-ALERT-REJECT message..... | 46 | +| 8.3 | SGsAP-ALERT-REQUEST message..... | 46 | +| 8.4 | SGsAP-DOWNLINK-UNITDATA message ..... | 47 | +| 8.5 | SGsAP-EPS-DETACH-ACK message..... | 47 | +| 8.6 | SGsAP-EPS-DETACH-INDICATION message..... | 47 | +| 8.7 | SGsAP-IMSI-DETACH-ACK message ..... | 48 | +| 8.8 | SGsAP-IMSI-DETACH-INDICATION message ..... | 48 | +| 8.9 | SGsAP-LOCATION-UPDATE-ACCEPT message..... | 48 | +| 8.9.1 | Message definition..... | 48 | +| 8.9.2 | New TMSI, or IMSI ..... | 48 | +| 8.10 | SGsAP-LOCATION-UPDATE-REJECT message..... | 49 | +| 8.10.1 | Message definition..... | 49 | +| 8.10.2 | Location area identifier..... | 49 | +| 8.11 | SGsAP-LOCATION-UPDATE-REQUEST message ..... | 50 | +| 8.11.1 | Message definition..... | 50 | +| 8.11.2 | Old location area identifier ..... | 50 | +| 8.11.3 | TMSI status ..... | 50 | +| 8.11.4 | IMEISV ..... | 50 | +| 8.11.5 | TAI ..... | 50 | +| 8.11.6 | E-CGI ..... | 50 | +| 8.11.7 | TMSI based NRI container..... | 51 | +| 8.11.8 | Selected CS domain operator ..... | 51 | +| 8.12 | SGsAP-MM-INFORMATION-REQUEST ..... | 51 | +| 8.13 | SGsAP-PAGING-REJECT message..... | 51 | + +| | | | +|---------|-----------------------------------------------|----| +| 8.14 | SGsAP-PAGING-REQUEST message..... | 51 | +| 8.14.1 | Message definition..... | 51 | +| 8.14.2 | TMSI..... | 52 | +| 8.14.3 | CLI..... | 52 | +| 8.14.4 | Location area identifier..... | 52 | +| 8.14.5 | Global CN-Id..... | 52 | +| 8.14.6 | SS code..... | 52 | +| 8.14.7 | LCS indicator..... | 53 | +| 8.14.8 | LCS client identity..... | 53 | +| 8.14.9 | Channel needed..... | 53 | +| 8.14.10 | eMLPP priority..... | 53 | +| 8.14.11 | Additional paging indicators..... | 53 | +| 8.14.12 | SM Delivery Timer..... | 53 | +| 8.14.13 | SM Delivery Start Time..... | 53 | +| 8.14.4 | Maximum Retransmission Time..... | 53 | +| 8.15 | SGsAP-RESET-ACK message..... | 53 | +| 8.15.1 | Message definition..... | 53 | +| 8.15.2 | MME name..... | 54 | +| 8.15.3 | VLR name..... | 54 | +| 8.16 | SGsAP-RESET-INDICATION message..... | 54 | +| 8.16.1 | Message definition..... | 54 | +| 8.16.2 | MME name..... | 54 | +| 8.16.3 | VLR name..... | 54 | +| 8.17 | SGsAP-SERVICE-REQUEST message..... | 55 | +| 8.17.1 | Message definition..... | 55 | +| 8.17.2 | IMEISV..... | 55 | +| 8.17.3 | UE Time Zone..... | 55 | +| 8.17.4 | Mobile Station Classmark 2..... | 55 | +| 8.17.5 | TAI..... | 55 | +| 8.17.6 | E-CGI..... | 55 | +| 8.17.7 | UE EMM Mode..... | 55 | +| 8.18 | SGsAP-STATUS message..... | 56 | +| 8.18.1 | Message definition..... | 56 | +| 8.18.2 | IMSI..... | 56 | +| 8.19 | SGsAP-TMSI-REALLOCATION-COMPLETE message..... | 56 | +| 8.20 | SGsAP-UE-ACTIVITY-INDICATION message..... | 56 | +| 8.20.1 | Maximum UE Availability Time..... | 56 | +| 8.21 | SGsAP-UE-UNREACHABLE message..... | 57 | +| 8.21.1 | Requested Retransmission Time..... | 57 | +| 8.21.2 | Additional UE Unreachable indicators..... | 57 | +| 8.22 | SGsAP-UPLINK-UNITDATA message..... | 57 | +| 8.22.1 | Message definition..... | 57 | +| 8.22.2 | IMEISV..... | 58 | +| 8.22.3 | UE Time Zone..... | 58 | +| 8.22.4 | Mobile Station Classmark 2..... | 58 | +| 8.22.5 | TAI..... | 58 | +| 8.22.6 | E-CGI..... | 58 | +| 8.23 | SGsAP-RELEASE-REQUEST message..... | 58 | +| 8.23.1 | Message definition..... | 58 | +| 8.23.2 | SGs Cause..... | 58 | +| 8.24 | SGsAP-SERVICE-ABORT-REQUEST message..... | 58 | +| 8.24.1 | Message definition..... | 58 | +| 8.25 | SGsAP-MO-CSFB-INDICATION message..... | 59 | +| 8.25.1 | Message definition..... | 59 | +| 8.25.2 | TAI..... | 59 | +| 8.25.3 | E-CGI..... | 59 | +| 9 | Information element coding..... | 59 | +| 9.1 | Overview..... | 59 | +| 9.2 | Message type..... | 60 | +| 9.3 | Information element identifiers..... | 61 | +| 9.3a | Length indicator..... | 61 | + +| | | | +|---------------------------------------------------|--------------------------------------------|-----------| +| 9.4 | Information elements..... | 61 | +| 9.4.1 | CLI..... | 61 | +| 9.4.2 | EPS location update type..... | 62 | +| 9.4.3 | Erroneous message..... | 62 | +| 9.4.3a | E-UTRAN Cell Global Identity..... | 62 | +| 9.4.4 | Global CN-Id..... | 63 | +| 9.4.5 | IMEISV..... | 63 | +| 9.4.6 | IMSI..... | 63 | +| 9.4.7 | IMSI detach from EPS service type..... | 63 | +| 9.4.8 | IMSI detach from non-EPS service type..... | 63 | +| 9.4.9 | LCS client identity..... | 64 | +| 9.4.10 | LCS indicator..... | 64 | +| 9.4.11 | Location area identifier..... | 64 | +| 9.4.12 | MM information..... | 65 | +| 9.4.13 | MME name..... | 65 | +| 9.4.14 | Mobile identity..... | 65 | +| 9.4.14a | Mobile Station Classmark 2..... | 65 | +| 9.4.15 | NAS message container..... | 65 | +| 9.4.16 | Reject cause..... | 66 | +| 9.4.17 | Service indicator..... | 66 | +| 9.4.18 | SGs cause..... | 66 | +| 9.4.19 | SS code..... | 67 | +| 9.4.20 | TMSI..... | 67 | +| 9.4.21 | TMSI status..... | 67 | +| 9.4.21a | Tracking Area Identity..... | 67 | +| 9.4.21b | UE Time Zone..... | 68 | +| 9.4.21c | UE EMM mode..... | 68 | +| 9.4.22 | VLR name..... | 68 | +| 9.4.23 | Channel needed..... | 69 | +| 9.4.24 | eMLPP priority..... | 69 | +| 9.4.25 | Additional paging indicators..... | 69 | +| 9.4.26 | TMSI based NRI container..... | 69 | +| 9.4.27 | Selected CS domain operator..... | 69 | +| 9.4.28 | Maximum UE Availability Time..... | 70 | +| 9.4.29 | SM Delivery Timer..... | 70 | +| 9.4.30 | SM Delivery Start Time..... | 70 | +| 9.4.31 | Additional UE Unreachable indicators..... | 71 | +| 9.4.32 | Maximum Retransmission Time..... | 71 | +| 9.4.33 | Requested Retransmission Time..... | 72 | +| 10 | List of system variables..... | 72 | +| 10.1 | Timers..... | 72 | +| 10.2 | Retry counters..... | 73 | +| Annex A (informative): Change history..... | | 74 | + +# --- 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 + +CS Fallback in the Evolved Packet System (EPS) enables the provisioning of CS-domain services (e.g. voice call, Location Services (LCS) or supplementary services) by reuse of CS infrastructure when the UE is served by E-UTRAN. Additionally, SMS delivery via the CS core network is realized without CS fallback. + +The present document specifies the procedures and the SGs Application Part (SGsAP) messages used on the SGs interface between the Mobility Management Entity (MME) in the EPS and the Visitor Location Register (VLR), to allow location management coordination and to relay certain messages related to GSM circuit switched services over the EPS system. + +The present document also specifies the use of Stream Control Transmission Protocol (SCTP) for the transport of SGsAP messages. + +The present document is applicable to the MME in the EPS and to the VLR. The functional split between the MME and the VLR is defined in 3GPP TS 23.272 [7]. + +# 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 22.101: "Service aspects; Service principles". +- [3] 3GPP TS 23.003: "Numbering, addressing and identification". +- [4] 3GPP TS 23.007: "Restoration procedures". +- [5] 3GPP TS 23.018: "Basic call handling; Technical realization". +- [5AA] 3GPP TS 23.078: "Customised Applications for Mobile network Enhanced Logic (CAMEL) Phase 4; Stage 2". +- [5A] 3GPP TS 23.081: "Line identification supplementary services". +- [5B] 3GPP TS 23.082: "Call Forwarding (CF) supplementary services". +- [6] Void. +- [6A] 3GPP TS 23.236: "Intra-domain connection of Radio Access Network (RAN) nodes to multiple Core Network (CN) nodes". +- [7] 3GPP TS 23.272: "Circuit Switched Fallback in Evolved Packet System; Stage 2". +- [7A] 3GPP TS 23.251: "Network Sharing; Architecture and Functional Description". +- [7B] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access". +- [8] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [9] 3GPP TS 24.010: "Supplementary services specification; General aspects". + +- [10] 3GPP TS 24.011: "Point-to-Point (PP) Short Message Service (SMS) support on mobile radio interface". +- [11] 3GPP TS 24.030: "Location Services (LCS); Supplementary service operations; Stage 3". +- [12] 3GPP TS 24.081: "Line Identification Supplementary Services - Stage 3". +- [13] 3GPP TS 24.082: "Call Forwarding (CF) supplementary services; Stage 3". +- [14] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [15] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [15A] 3GPP TS 29.011: "Signalling interworking for supplementary services". +- [16] 3GPP TS 29.018: "Serving GPRS Support Node (SGSN) - Visitors Location Register (VLR) Gs interface layer 3 specification". +- [16A] 3GPP TS 29.060: General Packet Radio Service (GPRS);GPRS Tunnelling Protocol (GTP) across the Gn and Gp interface. +- [17] 3GPP TS 29.272: "MME and SGSN Related Interfaces Based on Diameter Protocol". +- [17A] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [17B] 3GPP TS 32.250: "Telecommunication management; Charging management; Circuit Switched (CS) domain charging". +- [18] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management (CM)". +- [19] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC) protocol specification". +- [20] IETF RFC 791 (September 1981): "Internet Protocol". +- [21] Void. +- [22] IETF RFC 2460 (December 1998): "Internet Protocol, Version 6 (IPv6) Specification". +- [23] IETF RFC 4960 (September 2007): "Stream Control Transmission Protocol". +- [24] 3GPP TS 22.067: "enhanced Multi Level Precedence and Pre-emption service (eMLPP); Stage 1". +- [25] 3GPP TS 23.067: "enhanced Multi-Level Precedence and Pre-emption service (eMLPP); Stage 2". +- [26] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC); Stage 2". +- [27] Void. + +# --- 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] apply. Additionally the following definitions of 3GPP TS 24.301 [14] apply: + +###### **Non-EPS services** **SMS only** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.272 [7] apply: + +**CS fallback** +**SMS over SGs** +**SMS in MME** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.251 [7A] apply: + +**Common PLMN** +**Gateway core network (GWCN)** + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.301 [14] apply: + +**In NB-S1 mode** + +## 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]. + +| | | +|-------|--------------------------------------| +| LCS | Location Services | +| MME | Mobility Management Entity | +| NEAF | Non-EPS Alert Flag | +| SCTP | Stream Control Transmission Protocol | +| SGsAP | SGs Application Part | +| SMS | Short Message Service | +| PSI | Provide Subscriber Information | + +# --- 4 Description of the SGs association between a VLR and an MME + +## 4.1 General + +CS fallback function and SMS delivery via the CS core network is realized by reusing Gs interface mechanisms as defined in 3GPP TS 29.018 [16] on the interface between the MME in the EPS and the VLR. This interface is called SGs interface. + +NOTE: Within this specification, the term VLR refers to MSC/VLR or MSC Server/VLR. + +The SGs interface connects the databases in the VLR and the MME. The procedures described in the present document are used to co-ordinate the location information of UEs that are IMSI attached to both EPS and non-EPS services. The SGs interface is also used to convey some circuit switched related procedures via the MME. + +The basis for the interworking between a VLR and an MME is the existence of a SGs association between those entities per UE. The SGs association is applicable to UEs which are configured to use CS fallback and SMS over SGs, or SMS over SGs only. The SGs association is not applicable if the subscriber data indicates that the subscription is for packet only. The SGs association is also not applicable if the MME is registered for SMS for the UE as specified in 3GPP TS 23.272 [7]. + +In NB-S1 mode, the SGs association is also applicable to UEs supports NB-S1 mode only to use SMS over SGs only. + +The behaviour of the VLR and the MME entities related to the SGs interface are defined by the state of the SGs association for a UE. Individual SGs association states are maintained at both the VLR and the MME for each UE. + +## 4.2 SGs association at the VLR + +### 4.2.1 General + +The states associated to the SGs interface in the VLR are specified in subclause 4.2.2 and the state diagram at the VLR is shown in figure 4.2.2.1. The state diagram does not include the message error handling specified in clause 7. + +### 4.2.2 States at the VLR + +#### SGs-NULL + +There is no SGs association with an MME for the UE and therefore the VLR considers that the UE is IMSI detached for EPS services. In this state no SGsAP-MM-INFORMATION-REQUEST messages are sent to the MME. The VLR may initiate paging on the SGs interface if the "Confirmed by Radio Contact" restoration indicator in the VLR is set to "false" (see 3GPP TS 23.007 [4]). Any message from the MME is ignored except SGsAP-LOCATION-UPDATE-REQUEST, SGsAP-IMSI-DETACH-INDICATION and SGsAP-EPS-DETACH-INDICATION. + +#### LA-UPDATE-PRESENT + +The VLR has received an SGsAP-LOCATION-UPDATE-REQUEST message from the MME. In this state, the VLR may be waiting for the outcome of the Update Location procedure from the HSS, if the IMSI is not known in the VLR. For UEs which are configured to use CS fallback and SMS over SGs, or SMS over SGs only, the VLR sends SGsAP-PAGING-REQUEST messages via the SGs interface. + +#### SGs-ASSOCIATED + +The VLR considers that the UE is attached to both EPS and non-EPS services. For UEs which are configured to use CS fallback and SMS over SGs, or SMS over SGs only, the VLR sends SGsAP-PAGING-REQUEST messages via the SGs interface. The VLR can perform the MM information procedure. + +![State diagram at the VLR showing three states: SGs-NULL, LA-UPDATE-PRESENT, and SGs-ASSOCIATED. Transitions are triggered by various messages from the MME, UE, or SGSN, and actions include sending paging, location updates, or reset messages.](af6be343f0c0a8f155f965dcf337b8af_img.jpg) + +``` + +stateDiagram-v2 + [*] --> SGs-NULL : From one of the three states (at the VLR) + SGs-NULL --> SGs-NULL : Reset received from the MME + SGs-NULL --> SGs-NULL : VLR failure + SGs-NULL --> SGs-NULL : Detach indication received from the MME or the UE + SGs-NULL --> SGs-NULL : Location Update Request received from the UE via the A interface or via the lu interface, or from the SGSN via the Gs interface + SGs-NULL --> LA-UPDATE-PRESENT : Location Update Request received from the MME + LA-UPDATE-PRESENT --> SGs-NULL : Send Location Update Reject + LA-UPDATE-PRESENT --> SGs-ASSOCIATED : Send Location Update Accept + LA-UPDATE-PRESENT --> SGs-NULL : Paging failure received + LA-UPDATE-PRESENT --> SGs-NULL : Paging Failure or Alert Failure received + LA-UPDATE-PRESENT --> LA-UPDATE-PRESENT : Send paging + SGs-ASSOCIATED --> SGs-NULL : SGsAP-UE-UNREACHABLE message received + SGs-ASSOCIATED --> SGs-NULL : TMSI Reallocation received + SGs-ASSOCIATED --> SGs-NULL : Send paging + SGs-ASSOCIATED --> LA-UPDATE-PRESENT : Location Update Request received from the MME + +``` + +State diagram at the VLR showing three states: SGs-NULL, LA-UPDATE-PRESENT, and SGs-ASSOCIATED. Transitions are triggered by various messages from the MME, UE, or SGSN, and actions include sending paging, location updates, or reset messages. + +NOTE: Receipt of an SGsAP-RESET-INDICATION message from the MME may change or not the state of the SGs interface of all the associations associated to the restarted MME, see subclause 5.8.3. + +Figure 4.2.2.1: State diagram at the VLR + +## 4.3 SGs association at the MME + +### 4.3.1 General + +The MM context variables associated to the SGs interface in the MME are specified in subclause 4.3.2 and states associated to the SGs interface in the MME are specified in subclause 4.3.3. The state diagram at the MME is shown in figure 4.3.3.1. The state diagram does not include the message error handling specified in clause 7. + +### 4.3.2 MM context variables at the MME + +#### VLR-Reliable: + +Boolean set to "false" when the MME has received a reset indication from the VLR. The MME may: + +- upon reception of a combined tracking area update request from a UE that is still attached for non-EPS services, perform immediately the location update for non-EPS services procedure; or +- upon reception of a periodic tracking area update request from a UE that is still attached for non-EPS services, dependent on network configuration and operator policy, + - perform a network initiated detach with detach type "IMSI detach" immediately after the completion of the periodic tracking area update procedure; or + - perform immediately the location update for non-EPS services procedure. + +#### MME-Reset: + +Boolean set to "true" when the MME restarts after a failure. The "MME-Reset" restoration indicator is unique within an MME and it applies to all the MM contexts stored in the MME. + +### 4.3.3 States at the MME + +#### SGs-NULL + +There is no SGs association with a VLR for the UE and therefore the MME considers that the UE is IMSI detached for non-EPS services. In this state the MME accepts SGsAP-PAGING-REQUEST messages to UEs only if: + +- the "MME-Reset" restoration indicator in the MME is set to "true"; or +- the MME supports the CS restoration indicator set in the Additional paging indicators information element in the SGs-PAGING-REQUEST message. + +#### LA-UPDATE-REQUESTED + +The MME has sent an SGsAP-LOCATION-UPDATE-REQUEST message to the VLR. In this state the MME waits for the outcome of the Update Location for non-EPS services procedure at the VLR before sending the response to the UE. In this state the MME accepts SGsAP-PAGING-REQUEST messages. + +#### SGs-ASSOCIATED + +The MME stores an SGs association for the UE. In this state the MME performs the location update for non-EPS services procedure towards the VLR, e.g. when the location area is changed. All conditions describing when to trigger the location update for non-EPS services procedure are listed in subclause 5.2.2.2. + +![Figure 4.3.3.1: State diagram at the MME. Shows states SGs-NULL, LA-UPDATE-REQUESTED, and SGs-ASSOCIATED with various transition triggers like MME failure, Paging received, and Location Update messages.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +stateDiagram-v2 + direction TB + state "From one of\nthe three states\n(at the MME)" as Start + state "SGs-\nNULL" as NULL + state "LA-UPDATE-\nREQUESTED" as LA_REQ + state "SGs-\nASSOCIATED" as ASSOC + + Start --> NULL : MME failure + Start --> NULL : Send any detach indication\nto the VLR + NULL --> NULL : Paging\nreceived + NULL --> LA_REQ : Send Location\nUpdate Request to\nthe VLR + LA_REQ --> NULL : Location\nUpdate Reject\nreceived + LA_REQ --> LA_REQ : Paging\nreceived + LA_REQ --> ASSOC : Location\nUpdate Accept\nreceived + NULL --> ASSOC : Normal tracking area\nupdate request\nreceived from the UE + NULL --> ASSOC : Periodic tracking area\nupdate request\nreceived from the UE\nwith conditions listed\nin subclause 5.2.2.2. + NULL --> ASSOC : [Any other case]\nCombined tracking area\nupdate request or periodic\ntracking area update request\nreceived from the UE + ASSOC --> NULL : Combined tracking\narea update request\nreceived from the UE\nwith conditions listed\nin subclause 5.2.2.2. + ASSOC --> ASSOC : Paging\nreceived + ASSOC --> ASSOC : Send SGsAP-UE-\nUNREACHABLE message + ASSOC --> ASSOC : Send TMSI\nReallocation + +``` + +Figure 4.3.3.1: State diagram at the MME. Shows states SGs-NULL, LA-UPDATE-REQUESTED, and SGs-ASSOCIATED with various transition triggers like MME failure, Paging received, and Location Update messages. + +**Figure 4.3.3.1: State diagram at the MME** + +### 4.3.4 State transitions in the MME without SGsAP signalling + +During the tracking area update procedure or routing area update procedure (see 3GPP TS 23.401 [7B]) and if the SGs association is not SGs-NULL, the MME may change the state of the SGs association to SGs-NULL upon receipt of a SGSN Context Acknowledge (see 3GPP TS 29.060 [16A]) or Context Acknowledge message without ISR activation (see 3GPP TS 29.274 [17A]) from the target network. + +During the inter-system handover from S1 mode to A/Gb mode or Iu mode, or handover from S1 mode to S1 mode (see 3GPP TS 23.401 [7B]) and if the SGs association is not SGs-NULL, the MME may change the state of the SGs association to SGs-NULL upon receipt of a Forward Relocation Complete (see 3GPP TS 29.060 [16A]) or Forward Relocation Complete Notification message without ISR activation (see 3GPP TS 29.274 [17A]) from the target network. + +If the MME receives a normal attach request, attach request for emergency bearer services or a normal tracking area update request from the UE in state SGs-ASSOCIATED, the MME shall change the state of the SGs association to SGs-NULL. + +If it is required by network configuration or operator policy, the MME shall change the state of the SGs association to SGs-NULL if the following conditions are fulfilled: + +- the MME receives an EXTENDED SERVICE REQUEST message with service type set to "mobile originating CS fallback emergency call or 1xCS fallback emergency call"; +- the state of the SGs association is not SGs-NULL; and +- the MME determines that the UE is not available for PS services at the target RAT as described in 3GPP TS 23.272 [7]. + +### 4.3.5 State transitions in the VLR without SGsAP signalling + +Based on configuration, during PS to CS SRVCC from E-UTRAN (see 3GPP TS 23.216 [26]) and if the SGs association is not SGs-NULL, the VLR may change the state of the SGs association to SGs-NULL upon receipt of a Relocation Complete/Handover Complete message from target RNS/BSS. + +# 5 Procedures for SGs + +## 5.1 Paging for non-EPS services procedure + +### 5.1.1 General description + +This procedure is used by the VLR to send an SGsAP-PAGING-REQUEST message to a UE. This procedure applies to UEs that are simultaneously attached for EPS services and non-EPS services, or for EPS services and SMS only. + +### 5.1.2 Procedures in the VLR + +#### 5.1.2.1 General + +The VLR shall handle the timers, queuing and retransmission for sending the SGsAP-PAGING-REQUEST message on the SGs interface in the same way that it handles the sending of a PAGING message on the A or Iu interface. + +#### 5.1.2.2 Paging Initiation + +When a VLR has to page a UE, the VLR shall check whether the VLR has a SGs association for that UE. The VLR sends SGsAP-PAGING-REQUEST messages to the MME if the MME is in service and the state of the SGs association for the UE is in any of the following states: + +- SGs-ASSOCIATED; +- LA-UPDATE-PRESENT or +- SGs-NULL and the "Confirmed by Radio Contact" restoration indicator is set to "false". + +If the VLR detects that the MME serving the UE is no longer in service and the VLR supports MT CS services delivery via an alternative MME in the MME pool as defined in 3GPP TS 23.007 [4], the VLR shall send the SGs-PAGING-REQUEST message to one alternative MME in the same MME pool. The VLR shall set the CS restoration indicator in the Additional paging indicators information element. + +NOTE 1: The VLR can detect that an MME is no longer in service if there are no SCTP associations in service with that MME. + +The sending of the SGsAP-PAGING-REQUEST message does not change the state of the SGs association with the MME. + +If the "Confirmed by Radio Contact" restoration indicator is set to "true", the VLR shall include the Location area identifier information element into the SGsAP-PAGING-REQUEST message, otherwise (i.e. after a VLR failure), the VLR shall not include the Location area identifier information element. When sending the SGsAP-PAGING-REQUEST message, the VLR shall start timer Ts5. + +If the state of the SGs association is SGs-NULL and the "Confirmed by Radio Contact" restoration indicator is set to "false", the VLR shall also perform a search procedure as specified in 3GPP TS 23.018 [5]. + +In this message, the VLR includes the Service indicator information element which will be used to indicate the type of CS service. If the SGs paging request is sent as a result of reception of Provide Subscriber Information Request message, the VLR sets the Service indicator information element to either "SMS indicator" or "CS call indicator" as specified in subclause 7.2.3.5 of 3GPP TS 23.018 [5]. For SMS, SMS indicator is used. For all the other CS services, CS call indicator is used. + +If the network supports CSFB priority call handling (see 3GPP TS 23.272 [7]) and the call was received with an eMLPP priority level indication (see 3GPP TS 24.008 [8], 3GPP TS 22.067 [24] and 3GPP TS 23.067 [25]), the VLR shall include the value of the received priority level indication in the eMLPP priority information element in the SGsAP-PAGING-REQUEST message. + +The eMLPP priority information element may be used to derive the appropriate priority of a SCTP association for the SGsAP-PAGING-REQUEST message. + +If the Calling Line Identification of the service (see 3GPP TS 24.081 [12]) is available in the VLR, the VLR may include the CLI information element in the SGsAP-PAGING-REQUEST message. The conditions specified in 3GPP TS 23.081 [5A] and 3GPP TS 29.011 [15A] apply also here. + +If the paging is due to a NW-initiated Call Independent SS procedure as defined in 3GPP TS 24.010 [9], the VLR may include the SS code in the SGsAP-PAGING-REQUEST message as defined in 3GPP TS 29.002 [15]. + +NOTE 2: The SS code used by the VLR does not link to a specific supplementary service. The VLR can use any SS code defined in 3GPP TS 29.002 [15], in the SGsAP-PAGING-REQUEST message. + +If the paging is due to a Mobile Terminated Location Request as defined in 3GPP TS 24.030 [11], the VLR shall include LCS indicator in the SGsAP-PAGING-REQUEST message. Additionally, the VLR may include LCS client identity as defined in 3GPP TS 29.002 [15] in the SGsAP-PAGING-REQUEST message. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the paging was due to SMS and the SM Delivery Timer and SM Delivery Start Time IEs were received from the SMS-GMSC as defined in 3GPP TS 29.002 [15], the VLR may include these IEs in the SGsAP-PAGING-REQUEST message. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the paging was due to SMS and the Maximum Retransmission Time IE was received from the SMS-GMSC as defined in 3GPP TS 29.002 [15], the VLR may include the received Maximum Retransmission Time IE in the SGsAP-PAGING-REQUEST message. + +While domain specific access control of the PS domain is ongoing, the VLR shall be configured to send paging messages on both the SGs and the A/Iu interface. + +The VLR may apply implementation specific rules for sending the paging on the A/Iu interface. Dependent on network configuration or operator policy, if the UE does not respond to a first paging on SGs interface or the VLR considers UE fallback was failed as described in subclause 5.15.1, and A/Iu paging has not been initiated already, the VLR shall page on the A/Iu interface. + +#### 5.1.2.3 Paging Response + +The VLR stops the paging procedure towards the MME on expiry of timer Ts5 or on receipt of a SGsAP-SERVICE-REQUEST message from the MME. + +On receipt of an SCCP connection establishment containing the Initial L3 message from the UE via the A or Iu interface, the VLR shall stop the paging procedure. + +Upon receiving the SGsAP-SERVICE-REQUEST message with the UE EMM mode information element indicating "EMM-CONNECTED", if the Service indicator information element in the SGsAP-SERVICE-REQUEST message indicates "CS call indicator" and Call Forwarding on No Reply (CFNRy) is activated for the subscriber, the VLR shall start the CFNRy timer as specified in 3GPP TS 23.082 [5B]. + +If the paging response is received via the A or Iu interface from a location area which differs from the one stored in the VLR, the VLR shall move the SGs association to the SGs-NULL state after the UE has been authenticated successfully. + +NOTE 2: UE sends this paging response as a result of receiving paging request with IMSI and with CN domain indicator set to "CS" (see 3GPP TS 24.301 [14]). + +#### 5.1.2.4 Paging Failure + +On receipt of an SGsAP-PAGING-REJECT message before the timer Ts5 expires, the VLR stops timer Ts5. If the SGs cause information element in the SGsAP-PAGING-REJECT message does not indicate "Mobile terminating CS fallback call rejected by the user", the SGs association is moved to the SGs-NULL state and within this state the SGs association is marked with the contents of the SGs cause information element. If the SGs cause information element in the SGsAP-PAGING-REJECT message indicates "IMSI detached for EPS services" the VLR shall send the paging message on the A/Iu interface. If the SGs cause information element indicates "Mobile terminating CS fallback call rejected by the user", the SGs association state shall not be changed. + +When the VLR receives the SGsAP-PAGING-REJECT message with the SGs cause information element indicating "Mobile terminating CS fallback call rejected by the user", the VLR shall trigger User Determined User Busy (UDUB) as specified in 3GPP TS 24.082 [13]. + +#### 5.1.2.5 UE unreachable + +On receipt of an SGsAP-UE-UNREACHABLE message before the timer Ts5 expires, the VLR stops timer Ts5, and the paging procedure for that paging request towards the MME is stopped. The state of the SGs association at the VLR is unchanged. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the paging was due to SMS and the VLR included the SM-Delivery-Timer and SM-Delivery-Start-Time IEs in the SGsAP-PAGING-REQUEST, and if the SM Buffer Request Indicator bit is set in the Additional UE Unreachable indicators IE in the SGsAP\_UE\_UNREACHABLE message, the VLR may buffer the Short Message until the time indicated in the SGsAP-PAGING-REQUEST or until receipt of any earlier SGsAP message for the UE. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the Retransmission Time IE was included in the SGsAP-UE-UNREACHABLE message, the VLR may forward the received Requested Retransmission Time IE to the SMS-GMSC as defined in 3GPP TS 29.002 [15]. In this case, the VLR shall not set the MNRF flag. + +NOTE 1: A/Iu paging can be ongoing. + +NOTE 2: If the VLR considers the paging procedure completed, and no response from the UE has been received, and CFNRc has been configured and activated for the terminating UE, the VLR applies the equivalent handling as for Call Forwarding on Not Reachable, as specified in 3GPP TS 23.082 [5B] and 3GPP TS 29.011 [15A]. + +### 5.1.3 Procedures in the MME + +#### 5.1.3.1 General + +The MME accepts SGsAP-PAGING-REQUEST messages in any state of the SGs association. In the SGs-NULL state, the MME accepts SGsAP-PAGING-REQUEST messages only if: + +- the "MME-Reset" restoration indicator is set to "true"; or +- the MME supports MT CS services delivery via an alternative MME in the MME pool as defined in 3GPP TS 23.007 [4] and the CS restoration indicator is set in the Additional paging indicators information element in the SGs-PAGING-REQUEST message. + +When a MME receives a SGsAP-PAGING-REQUEST message from a VLR, the MME shall first check if the UE is known by the MME. The handling of the paging request depends on the state of the SGs association, the EMM context variables at the MME, and the Service indicator information element in the SGsAP-PAGING-REQUEST message. The MME shall process the paging request and subsequent SGs procedures related to this request preferentially compared to other normal procedures if the SGsAP-PAGING-REQUEST message includes the eMLPP priority information element and if the MME determines the CS call has high priority based on the received value in the eMLPP priority information element (see 3GPP TS 23.272 [7]). + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "CS call indicator", the MME shall handle the paging request as follows: + +- If the UE is known: + - if the UE is considered to be IMSI attached for EPS services and "SMS only", the MME shall return an SGsAP-PAGING-REJECT message to the VLR indicating in the SGs cause information element "Mobile terminating CS fallback call rejected by the user"; + - if the UE is considered to be IMSI attached for EPS and non-EPS services (i.e. the SGs association is not in the state SGs-NULL), the MME shall page the UE based on the location information stored in the MME, i.e. in all tracking areas of the stored list. If the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element, the MME may set the "VLR-Reliable" MM context variable to "false". If ISR is activated, and in addition the SGsAP-PAGING-REQUEST message does not include the Location area identifier or the "VLR-Reliable" MM context variable in the MME is set to "false", then the MME shall send Detach Notification (Local Detach) message to the associated SGSN; + - if the MME detects that the UE currently has an ongoing IMS emergency session as specified in subclause 4.6a, 3GPP TS 23.272 [7], the MME shall return an SGsAP-PAGING-REJECT message to the + +VLR indicating in the SGs cause information element "Mobile terminating CS fallback call rejected by the user"; + +- if the MME detects that the UE currently has an EPS bearer context with QCI=1 and the MME determines that SRVCC (as specified in 3GPP TS 23.216 [26]) is not supported in the network or it determines that the UE does not support SRVCC, MME shall return SGsAP-PAGING-REJECT message to that VLR with SGs cause information element "Mobile terminating CS fallback call rejected by the user"; +- if the UE is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services (i.e. the state of the SGs association is SGs-NULL): + - if the UE is in the EMM-DEREGISTERED state (see 3GPP TS 24.301 [14]) and if the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is set in the SGsAP-PAGING-REQUEST message, the MME shall send the paging request with the location information provided by the VLR, regardless of the value of the "MME-Reset" indicator. If no such location information is provided, the MME may either page the UE in all the tracking areas served by that MME or in the tracking areas served by the MME and by the VLR, or reject the paging request per operator policy; + - otherwise, the MME shall return an SGsAP-PAGING-REJECT message to that VLR indicating in the SGs cause information element the detach circumstance ("IMSI detached for EPS services", "IMSI detached for non-EPS services" or "IMSI implicitly detached for non-EPS services"); +- if the UE is marked as unreachable, indicated by Paging Proceed Flag set to "false", and the ISR is not activated, the MME shall return an SGsAP-UE-UNREACHABLE message to that VLR indicating in the SGs cause information element "UE unreachable". The state of the SGs association does not change at the MME; or +- if the UE is marked as unreachable, indicated by Paging Proceed Flag set to "false", and the ISR is activated, the MME shall not return an SGsAP-UE-UNREACHABLE message to that VLR. If the SGsAP-PAGING-REQUEST message does not include the Location area identifier or the "VLR-Reliable" MM context variable in the MME is set to "false", then the MME shall send Detach Notification (Local Detach) message to the associated SGSN; Otherwise the MME shall forward the paging request to the associated SGSN, as described in 3GPP TS 29.274 [17A]. + +b) If the UE is not known and the "MME-Reset" restoration indicator at the MME is set to "false" and if: + +- the MME does not support MT CS services delivery via an alternative MME in the MME pool; or +- the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is not set in the SGsAP-PAGING-REQUEST message; + +the MME shall handle the paging request as follows: + +- the MME shall return an SGsAP-PAGING-REJECT message to that VLR indicating in the SGs cause information element "IMSI unknown". + +c) If the UE is not known and if: + +- the "MME-Reset" restoration indicator at the MME is set to "true"; or +- the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is set in the SGsAP-PAGING-REQUEST message; + +the MME shall handle the paging request as follows: + +- if the MME only supports "SMS only", the MME shall return an SGsAP-PAGING-REJECT message to the VLR indicating in the SGs cause information element "Mobile terminating CS fallback call rejected by the user"; +- if the SGsAP-PAGING-REQUEST message includes the Location area identifier information element, the MME shall page the UE in all the tracking areas served by the MME that can be mapped to the location area indicated in the Location area identifier information element; or + +- if the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element, the MME may page in all the tracking areas served by the MME, or the tracking areas served by the MME and by the VLR or reject the paging request per operator policy. + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator", the MME shall handle the paging request as follows: + +a) If the UE is known: + +- if the UE is considered to be IMSI attached for EPS and non-EPS services or IMSI attached for EPS services and "SMS only", the MME shall page the UE based on the location information stored in the MME. If the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element, the MME may set the "VLR-Reliable" MM context variable to "false". If the UE is using eDRX, the MME may, subject to local operator policy, return an SGsAP-UE-UNREACHABLE message to the VLR indicating in the SGs cause information element "UE temporarily unreachable" while continuing to page the UE. If ISR is activated, and in addition the SGsAP-PAGING-REQUEST message does not include the Location area identifier or the "VLR-Reliable" MM context variable in the MME is set to "false", then the MME shall send Detach Notification (Local Detach) message to the associated SGSN; or + +NOTE 2: If location area identifier information element is included in the SGsAP-PAGING-REQUEST, it is not used in paging the UE. + +- for Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE is using eDRX, the SGsAP-PAGING-REQUEST message includes the SM Delivery Timer and SM Delivery Start Time IEs, and the UE is expected to be reachable before the time indicated by the SM-Delivery-Timer and SM-Delivery-Start-Time IEs, the MME may return an SGsAP-UE-UNREACHABLE message to the VLR indicating in the SGs cause information element "UE temporarily unreachable" and setting the SM Buffer Request Indicator bit in the Additional UE Unreachable indicators information element. The state of the SGs association does not change at the MME. The MME should then page the UE when the UE is expected to be reachable. +- for Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE is using eDRX and the SGsAP-PAGING-REQUEST message includes the Maximum Retransmission Time IEs, the MME may return an SGsAP-UE-UNREACHABLE message to that VLR indicating in the SGs cause information element "UE temporarily unreachable" and including the Requested Retransmission Time IE. In this case, the MME shall set the NEAF. The state of the SGs association does not change at the MME. + +NOTE 3: This mechanism does not cause additional signalling at the HLR to retransmit the Short Message. + +- if the UE is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, or as unreachable, the MME shall proceed as specified for the case when the service indicator indicates "CS call indicator". + +b) If the UE is not known and the "MME-Reset" restoration indicator at the MME is set to "false" and if: + +- the MME does not support MT CS services delivery via an alternative MME in the MME pool; or +- the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is not set in the SGsAP-PAGING-REQUEST message; + +the MME shall handle the paging request as follows: + +- the MME shall return an SGsAP-PAGING-REJECT message to that VLR indicating in the SGs cause information element "IMSI unknown". + +c) If the UE is not known and if: + +- the "MME-Reset" restoration indicator at the MME is set to "true"; or +- the MME supports MT CS services delivery via an alternative MME in the MME pool and the CS restoration indicator is set in the SGsAP-PAGING-REQUEST message; + +the MME shall handle the paging request as follows: + +- if the SGsAP-PAGING-REQUEST message includes the Location area identifier information element, the MME shall page the UE in all the tracking areas served by the MME that can be mapped to the location area indicated in the Location area identifier information element; or + +- if the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element, the MME may page in all the tracking areas served by the MME, or the tracking areas served by the MME and by the VLR or reject the paging request per operator policy. + +#### 5.1.3.2 Procedure when no NAS signalling connection exists + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "CS call indicator" and the MME accepts the paging request, the MME shall proceed as follows: + +- If the SGsAP-PAGING-REQUEST message includes the Location area identifier and the "VLR-Reliable" MM context variable in the MME is set to "true": +- if the UE is considered to be IMSI attached for EPS and non-EPS services, the MME pages the UE with CN domain indicator set to "CS". + +if + +- the SGsAP-PAGING-REQUEST message includes the IMSI without TMSI and the location area stored in the MME is the same as the one received in the SGsAP-PAGING-REQUEST message and S-TMSI can be retrieved, and the operator's policy allows the use of S-TMSI as paging address; or + +NOTE: The operator's policy is related to MSC pool in target RAT. + +- the SGsAP-PAGING-REQUEST message includes the TMSI and the location area stored in the MME is the same as the one received in the SGsAP-PAGING-REQUEST message; + +then the MME uses the S-TMSI as paging address at the radio interface; else the MME uses the IMSI; and + +- if the UE is not known, or is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, the MME pages the UE with IMSI and CN domain indicator set to "PS". +- If the SGsAP-PAGING-REQUEST message does not include the Location area identifier, or the "VLR-Reliable" MM context variable in the MME is set to "false": +- if the UE is considered to be IMSI attached for EPS and non-EPS services, the MME uses IMSI as a paging address at the radio interface and CN domain indicator set to "CS". When the MME receives the paging response from the UE, the MME requests the UE to re-attach for non-EPS services as described in 3GPP TS 24.301 [14]; and +- if the UE is not known, or is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, the MME pages the UE with IMSI with CN domain indicator set to "PS" to force the UE to re-attach to EPS and non-EPS services as described in 3GPP TS 24.301 [14]. + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator" and the MME accepts the paging request, the MME shall proceed as follows: + +- If the SGsAP-PAGING-REQUEST message includes the Location area identifier and the "VLR-Reliable" MM context variable in the MME is set to "true": +- if the UE is considered to be IMSI attached for EPS and non-EPS services or IMSI attached for EPS services and "SMS only", the MME shall use the S-TMSI as paging address at the radio interface with CN domain indicator set to "PS". The MME takes action as described in 3GPP TS 24.301 [14], subclause 5.6.2.4; and +- if the UE is not known, or is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, the MME pages the UE with IMSI as paging address at the radio interface with CN domain indicator set to "PS". The MME takes action as described in 3GPP TS 24.301 [14], subclause 5.6.2.4. +- If the SGsAP-PAGING-REQUEST message does not include the Location area identifier information element or the "VLR-Reliable" MM context variable is set to "false": +- if the UE is considered to be IMSI attached for EPS and non-EPS services or IMSI attached for EPS services and for "SMS only", the MME uses S-TMSI as paging address at the radio interface with CN domain indicator set to "PS". When the MME receives the paging response from the UE, the MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14]; and + +- if the UE is not known, or is marked as IMSI detached for EPS services or IMSI (implicitly or explicitly) detached for non-EPS services, the MME pages the UE with IMSI with CN domain indicator set to "PS" to force the UE to re-attach to EPS and non-EPS services as described in 3GPP TS 24.301 [14]. + +Independent of the Service indicator information element, if the MME has activated Idle mode Signalling Reduction for the UE, the MME shall forward the paging request to the associated SGSN, as described in 3GPP TS 29.274 [17A]. + +Independent of the Service indicator information element, the MME shall not retransmit the paging message to the UE. Additionally, if the MME has activated Idle mode Signalling Reduction for the UE, the MME shall not retransmit the paging request to the associated SGSN. + +#### 5.1.3.3 Procedure when a NAS signalling connection exists + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "CS call indicator" and the MME accepts the paging request, the MME shall proceed as follows: + +- The MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14] if the SGsAP-PAGING-REQUEST message does not include the Location area identifier, or the "VLR-Reliable" MM context variable in the MME is set to "false"; and +- otherwise, the MME sends the CS SERVICE NOTIFICATION message to the UE through the NAS signalling connection, including the CS service related parameters (CLI, SS code, LCS indicator and LCS client identity), received from the VLR. + +If the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator" and the MME accepts the paging request, the MME shall proceed as follows: + +- If the Location area identifier information element is not included in the SGsAP-PAGING-REQUEST message or the "VLR-Reliable" MM context variable is set to "false", the MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14]; and +- otherwise, the MME need not take any action towards the UE. + +## 5.2 Location update for non-EPS services procedure + +### 5.2.1 General description + +The location update for non-EPS services procedure is a general procedure used by UEs which are configured to use CS fallback and SMS over SGs, or SMS over SGs only. This procedure is not performed if: + +- the subscriber data indicates that the subscription is for packet only; or +- the MME is registered for SMS for the UE (see 3GPP TS 23.272 [7]). + +NOTE: For the cases specified above, the registration with a VLR is not required and the MME does not initiate the location update for non-EPS services procedure. + +This procedure allows UEs and the network to perform: + +- combined IMSI attach for EPS and non-EPS services or for SMS only; +- IMSI attach for non-EPS services or for SMS only if the UE is already IMSI attached for EPS services; +- normal location update procedure to the VLR if the UE is IMSI attached for both EPS and non-EPS services, or for SMS only; or +- allocation of new TMSI to an UE. + +The location update for non-EPS services procedure in the SGs interface is always started as a consequence of a direct action from the UE. The combined attach and tracking area update procedures are further specified in 3GPP TS 23.272 [7] and 3GPP TS 24.301 [14]. + +When a UE is IMSI attached for EPS and non-EPS services, the VLR shall stop any implicit detach timer. Instead the MME uses the "Paging Proceed Flag" to determine the likely availability of the UE to the network. Upon reception of the periodic Tracking Area Update message, the MME does not report to the VLR, and the MME shall not change the state of the SGs association. When the UE performs a detach only for EPS services or the MME performs an implicit detach for EPS services, and the VLR's implicit detach timer is not already running, the EPS detach indication to the VLR shall cause the VLR's implicit detach timer to be restarted from its initial value. + +If the MME performs an implicit detach for both EPS and non-EPS services, then the MME shall send to the VLR an SGsAP-IMSI-DETACH-INDICATION message with cause "Implicit network initiated IMSI detach from EPS and non-EPS services", as further described in subclause 5.6 (the implicit IMSI detach message indicates that the UE is unavailable for both EPS and non-EPS services). + +### 5.2.2 Procedures in the MME + +#### 5.2.2.1 General + +The location update for non-EPS services procedure is initiated with a combined attach or a combined tracking area update procedure. On receipt of an ATTACH REQUEST message or a TRACKING AREA UPDATE REQUEST message from the UE, the MME handles the EPS related request as specified in 3GPP TS 24.301 [14]. + +When the MME receives the Update Location Answer message containing subscription data from the HSS, the MME determines whether it needs to perform location update for non-EPS services procedure. For the cases identified below, if the MME is configured with ability not to perform registrations with a VLR for the UE, the MME sends response message to the UE without starting the location update for non-EPS services procedure: + +- if the Network Access Mode (NAM) subscription data indicates that the subscription is for packet only (see 3GPP TS 29.272 [17]); or +- if the Network Access Mode (NAM) subscription data indicates that the subscription is for packet and circuit (see 3GPP TS 29.272 [17]) and the MME is registered for SMS as specified in annex C of 3GPP TS 23.272 [7] for this UE. + +NOTE 1: When the MME supports both SMS in MME feature and SMS over SGs, depending on UE capability and/or network configuration and/or "PS and SMS only" subscription, it can be preferred to provide SMS services via SMS in MME to avoid the VLR registration. + +Otherwise, the MME shall start the location update for non-EPS services procedure and shall wait for the outcome of both location update procedures towards the VLR and the HSS before sending the response message to the UE. + +NOTE 2: When the combined attach or tracking area update procedure is for both EPS services and non-EPS services and the MME is not registered for SMS for the UE (see 3GPP TS 23.272 [7]) and the UE has "PS and SMS only" subscription, the MME starts the location update for non-EPS services procedure for SMS over SGs only. + +#### 5.2.2.2 Location update initiation + +##### 5.2.2.2.1 General + +If timer Ts6-1 is not running, the MME shall start the location update for non-EPS services procedure when it receives from the UE: + +- an attach request indicating combined EPS/IMSI attach; +- a combined tracking area update request indicating Combined TA/LA updating with IMSI attach; +- a combined tracking area update request and the MME detects that the LAI has changed; +- a combined tracking area update request and the state of the SGs association is SGs-NULL; or +- a combined tracking area update request and the MME serving the UE has changed. + +If timer Ts6-1 is not running, the MME may start the location update for non-EPS services procedure when it receives from the UE: + +- a combined tracking area update request or a periodic tracking area update , if the MM context variable "VLR-Reliable" for the UE is set to "false" (see subclause 5.7.3). + +If multiple PLMNs are available for the CS domain, the MME shall select a PLMN for CS domain as specified in 3GPP TS 23.272 [7]. If the MME cannot select any PLMN for CS domain for the UE, the MME informs the UE that the CS domain is not available. + +The MME shall determine the new location area identification as follows: + +- if the MME received a combined attach request or combined tracking area update request from the UE with an indication for "SMS only", or the network only supports "SMS only" or the network only has a few VLRs that support SGs interface, the MME may allocate a default location area identification specifically configured for that case; +- else the MME derives the location area identification from the current tracking area identity where the UE is located. For this the MME may take any access restrictions provided by the HSS into account, if the network is using separate location areas for GERAN and UTRAN cells. + +The MME shall derive the VLR name from the location area identification which was determined. For networks supporting the feature 'Intra Domain Connection of RAN Nodes to Multiple CN Nodes', the VLR name is derived as described in 3GPP TS 23.236 [6A]. The MME shall include the location area identification in the new location area identifier information element in the SGsAP-LOCATION-UPDATE-REQUEST message. + +NOTE 1: The selection of the VLR in the MME follows the same rule as the selection of the VLR in the SGSN, as defined in 3GPP TS 23.236 [6A]. + +In networks supporting the feature 'Intra Domain Connection of RAN Nodes to Multiple CN Nodes' (3GPP TS 23.236 [6A]), if the TMSI based NRI container is not received from the UE, and the MME determines that the serving VLR of the UE is changed, the MME shall include in the Old location area identifier a specific LAI value which is not broadcasted in the network and not associated with any VLR. + +NOTE 2: The MME determines that the serving VLR of the UE is changed when the SGs association changes from one serving VLR to a different one, or based on implementation dependent criteria. + +NOTE 3: When the VLR receives the SGsAP-LOCATION-UPDATE-REQUEST message with the specific LAI value, the VLR retrieves the MM context of the UE from the HLR. + +In networks supporting the feature "Intra Domain Connection of RAN Nodes to Multiple CN Nodes" as defined in 3GPP TS 23.236 [6A], the MME shall support load re-distribution of UEs to another VLR than the current one. When the MME receives a periodic tracking area update request or a combined tracking area update request, the MME shall check whether for this UE there is a SGs association to a VLR for which load re-distribution has been initiated in the MME by O&M. If this is the case and + +- if a combined tracking area update request is received, the MME shall derive the new VLR name as described in 3GPP TS 23.236 [6A] and then send the SGsAP-LOCATION-UPDATE-REQUEST message to the new selected VLR; or +- if a periodic tracking area update request is received, dependent on network configuration and operator policy, the MME shall take one of the following actions: + - perform a network initiated detach with detach type "IMSI detach" immediately after the completion of the periodic tracking area update procedure; or + - derive the new VLR name as described in 3GPP TS 23.236 [6A] and then send the SGsAP-LOCATION-UPDATE-REQUEST message to the new selected VLR. + +If the VLR is configured for gateway core network (GWCN), the MME shall select a CS domain operator as specified in 3GPP TS 23.272 [7] and proceed as follows: + +- If the preferred RAT of the selected CS domain operator is GERAN and the UE does not support GERAN network sharing (see 3GPP TS 24.008 [8], subclause 10.5.5.12), the MME shall include the selected CS domain operator in the selected CS domain operator information element, and the common PLMN in the new location area identifier information element in the SGsAP-LOCATION-UPDATE-REQUEST message; or + +- If only common PLMN ID and no multiple PLMN IDs are provided in CS domain for selection by the UE (see 3GPP TS 23.251 [7A], subclause 4.2.3.1), the MME shall include the selected CS domain operator in the selected CS domain operator information element, and the common PLMN in the new location area identifier information element in the SGsAP-LOCATION-UPDATE-REQUEST message. + +If multiple PLMN IDs are provided in CS domain for selection by the UE and the UE supports GERAN network sharing (see 3GPP TS 24.008 [8], subclause 10.5.5.12), the MME shall include the selected PLMN for CS domain in the new location area identifier information element as specified in 3GPP TS 23.251 [7A]. + +The SGsAP-LOCATION-UPDATE-REQUEST message includes the type of location update performed by the UE in the EPS location update type information element. If the UE has performed a combined attach or a combined tracking area update indicating "combined TA/LA updating with IMSI attach", the MME indicates "IMSI attach", otherwise the MME indicates "Normal location update". + +The MME shall include the TMSI status in the SGsAP-LOCATION-UPDATE-REQUEST message if the UE indicates in the ATTACH REQUEST or the TRACKING AREA UPDATE REQUEST message that it has no valid TMSI available. The MME shall also include the old location area identifier in the SGsAP-LOCATION-UPDATE-REQUEST message if the UE included the old location area identification in the ATTACH REQUEST or TRACKING AREA UPDATE REQUEST message. + +The MME shall include the TMSI based NRI container in the SGsAP-LOCATION-UPDATE-REQUEST message if received from the UE. + +If the MME supports the "Automatic Device Detection" (see 3GPP TS 22.101 [2]) or the "Trace for Management Based Activation/Deactivation" (see 3GPP TS 32.422 [18]), the MME shall include the IMEISV in the SGsAP-LOCATION-UPDATE-REQUEST message. + +The MME shall add the UE's current TAI and E-CGI to the SGsAP-LOCATION-UPDATE-REQUEST message. + +When the MME sends the SGsAP-LOCATION-UPDATE-REQUEST, the MME shall start timer Ts6-1. + +If timer Ts6-1 is running and the MME receives from the UE: + +- an attach request indicating combined EPS/IMSI attach; or +- a combined tracking area update with or without IMSI attach. + +Then: + +- if the LAI determined by the MME is the same as in the outstanding request, the MME shall not process this new request and shall wait for the VLR response to the ongoing procedure; +- if the LAI determined by the MME is different but the VLR name is the same as for previous LAI, any response from the VLR to the outstanding request is ignored, the MME shall stop and reset timer Ts6-1 and the MME shall start the location update for non-EPS services procedure; or +- if the LAI determined by the MME is different and the VLR name is different as for previous LAI, any response from the previously addressed VLR to the outstanding request is ignored, the MME shall stop and reset timer Ts6-1, and the MME shall start the location update for non-EPS services procedure. + +When the MME receives from the UE a tracking area update request and the MME serving the UE has changed, the MME shall stop and reset timer Ts6-1. + +##### 5.2.2.2.2 VLR fails without restart + +If the MME supports restoration for CS services via an alternative VLR as defined in 3GPP TS 23.007 [4] and, upon reception of a combined tracking area update request or a periodic tracking area update request from the UE, the MME determines that the VLR serving the UE is no longer in service, the MME may: + +- if a combined tracking area update request is received, select an alternative VLR that is in service for the UE and immediately perform the location update for non-EPS services procedure towards the selected VLR as described in subclause 5.2; or +- if a periodic tracking area update request is received, dependent on network configuration and operator policy, + +- perform a network initiated detach with detach type "IMSI detach" immediately after the completion of the periodic tracking area update procedure and then select an alternative VLR that is in service for the UE during the subsequent combined tracking area update procedure, before performing the location update for non-EPS services procedure towards the selected VLR as described in subclause 5.2; or +- select an alternative VLR that is in service for the UE and immediately perform the location update for non-EPS services procedure towards the selected VLR as described in subclause 5.2. + +If the MME supports restoration for CS services via an alternative VLR as defined in 3GPP TS 23.007 [4] and, upon reception of an UPLINK NAS TRANSPORT message (see 3GPP TS 24.301 [14]) from the UE, the MME determines that the VLR serving the UE is no longer in service, the MME may: + +- request the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14] and then select an alternative VLR that is in service for the UE during the subsequent combined tracking area update procedure, before performing the location update for non-EPS services procedure towards the selected VLR as described in subclause 5.2. + +NOTE 1: How an MME detects a VLR is no longer in service and triggers selection of alternative VLR is implementation dependent. + +NOTE 2: To avoid large amounts of UEs initiating re-attach for non-EPS services simultaneously, the MME can ignore some MO-SMS. Selection of MO-SMS to ignore is implementation dependent. + +#### 5.2.2.3 Location update response + +If the MME receives an SGsAP-LOCATION-UPDATE-ACCEPT message from the VLR, the MME shall stop timer Ts6-1 and: + +- move the state of the SGs association to SGs-ASSOCIATED; +- set the MM context variable "VLR-Reliable" to "true"; and +- indicate to the UE the acceptance of the VLR to the location update procedure. The message sent to the UE includes the Location Area Identity (see 3GPP TS 24.301 [14]). + +The MME shall wait for the outcome of the location update for non-EPS services procedure towards the VLR before sending a response to location update procedure to the UE. When the MME receives an SGsAP-LOCATION-UPDATE-REJECT message from the VLR, it will map the reject cause received to the appropriate reject cause as specified in 3GPP TS 24.301 [14], and report this reject cause to the UE. + +If the VLR included the Mobile identity information element in the SGsAP-LOCATION-UPDATE-ACCEPT message, the MME shall relay the information received to the UE. If the Mobile identity information element contains a new TMSI, this will cause the UE to perform a TMSI reallocation procedure. In this case, the MME shall send to the VLR the SGsAP-TMSI-REALLOCATION-COMPLETE message when the MME receives the ATTACH COMPLETE or the TRACKING AREA UPDATE COMPLETE message from the UE. If the Mobile identity information element contains an IMSI, this will cause the UE to deallocate its TMSI. + +#### 5.2.2.4 Location update failure + +If the MME receives an SGsAP-LOCATION-UPDATE-REJECT message from the VLR, the MME + +- shall stop timer Ts6-1; +- shall move the state of the SGs association to SGs-NULL; and +- indicates to the UE the rejection of the Location Update procedure by the VLR as specified in 3GPP TS 24.301 [14]. The Reject cause value sent by the VLR shall be mapped to the appropriate reject cause as specified in 3GPP TS 24.301 [14], and the latter is forwarded to the UE. + +NOTE: Upon receiving an SGsAP-LOCATION-UPDATE-REJECT message with MM cause #11 or MM cause #13, if the MME is configured to know that the VPLMN has a suitable roaming agreement for E-UTRAN with the HPLMN of the UE, the MME can map the MM cause to EMM cause #18 as specified in 3GPP TS 24.301 [14]. + +#### 5.2.2.5 Abnormal cases + +If timer Ts6-1 expires, the MME shall abort the Location Update for non-EPS service procedure and indicate this to the UE with the Reject cause value 'MSC temporarily not reachable'. The state of the SGs association to the VLR shall be SGs-NULL. + +If the MME receives an SGsAP-LOCATION-UPDATE-ACCEPT message and timer Ts6-1 is not running then: + +- if timer Ts8 is running (see subclause 5.4), the message shall be ignored; +- if timer Ts9 is running (see subclause 5.5), the message shall be ignored; or +- if timers Ts8 and Ts9 are not running: + - if the state of the SGs association to the VLR is SGs-ASSOCIATED, the message shall be ignored; or + - if the state of the SGs association to the VLR is different than SGs-ASSOCIATED, the message shall be treated as a message incompatible with the protocol state of the MME (see subclause 7.3). + +#### 5.2.2.6 Additional MME procedure for UE supporting NB-S1 mode only + +This subclause applies when the UE supporting NB-S1 mode only requests SMS services via a normal attach request or tracking area update request. + +If the UE supporting NB-S1 mode only requests SMS services using normal attach request or tracking area update request, the location update for non-EPS services procedure can be initiated by the MME when SMS over SGs is used. + +If timer Ts6-1 is not running, the MME shall start the location update for non-EPS services procedure when it receives from the UE: + +- an attach request indicating EPS attach and "SMS only" in NB-S1 mode, SMS services via SMS in MME are not available and SMS over SGs is used for the UE; +- a tracking area update request indicating TA updating and "SMS only" in NB-S1 mode, SMS services via SMS in MME are not available, SMS over SGs is used for the UE and the MME detects that the LAI has changed; +- a tracking area update request indicating TA updating and "SMS only" in NB-S1 mode, SMS services via SMS in MME are not available, SMS over SGs is used for the UE and the state of the SGs association is SGs-NULL; or +- a tracking area update request indicating TA updating and "SMS only" in NB-S1 mode, SMS services via SMS in MME are not available, SMS over SGs is used for the UE and the MME detects that the MME serving the UE has changed. + +NOTE 1: When the MME supports both SMS in MME feature and SMS over SGs, depending on UE capability and/or network configuration and/or "PS and SMS only" subscription, it can be preferred to provide SMS services via SMS in MME to avoid the VLR registration. + +NOTE 2: The UE does not include the MS Classmark 2 IE in a normal attach request or normal tracking area update request, and the MME does not store this information or include it in subsequent messages to the VLR. Services that use information part of MS Classmark 2, e.g. CAMEL, can therefore fail when SMS over SGs is provided via normal procedures. + +If the MME has a stored TMSI for the UE, the MME may include this TMSI in the TMSI based NRI container IE in the SGsAP-LOCATION-UPDATE-REQUEST message. Otherwise the MME shall indicate "no valid TMSI available" in the TMSI status IE in the SGsAP-LOCATION-UPDATE-REQUEST message. + +If the MME received a normal attach request or normal tracking area update request from the UE with an indication for "SMS only", the MME may allocate a default location area identification specifically configured for that case. + +If the MME receives an SGsAP-LOCATION-UPDATE-ACCEPT message from the VLR, the MME shall: + +- stop timer Ts6-1 and move the state of the SGs association to SGs-ASSOCIATED; +- set the MM context variable "VLR-Reliable" to "true"; and + +- indicate to the UE the acceptance of SMS services as specified in 3GPP TS 24.301 [14]. + +NOTE 3: The message sent to the UE does not include the Location Area Identity or the Mobile identity information element if received from the VLR. + +If the VLR included the Location area identifier or the Mobile identity information element in the SGsAP-LOCATION-UPDATE-ACCEPT message, the MME may store the received Location area identifier or the Mobile identity information element for the subsequent location update for non-EPS services procedure for the UE. If the Mobile identity information element contains a new TMSI, the MME may send to the VLR the SGsAP-TMSI-REALLOCATION-COMPLETE message when the MME indicates to the UE the acceptance of SMS services. If the Mobile identity information element contains an IMSI, the MME may delete any stored TMSI for the UE. + +If the MME receives an SGsAP-LOCATION-UPDATE-REJECT message from the VLR, the MME shall: + +- stop timer Ts6-1 and move the state of the SGs association to SGs-NULL; and +- indicate to the UE the rejection of SMS services as specified in 3GPP TS 24.301 [14]. The MME maps the location update reject cause received from the VLR to an appropriate value as specified in 3GPP TS 24.301 [14] and forwards to the UE. + +If timer Ts6-1 expires, the MME shall abort the Location Update for non-EPS service procedure. The MME indicates to the UE the rejection of SMS services by setting an appropriate value and shall as specified in 3GPP TS 24.301 [14] and forwards to the UE. The state of the SGs association to the VLR shall be SGs-NULL. + +### 5.2.3 Procedures in the VLR + +#### 5.2.3.1 General + +When a VLR receives an SGsAP-LOCATION-UPDATE-REQUEST message, the VLR checks whether the IMSI is known. If the IMSI is not known, the VLR retrieves the MM context of the UE from the HSS. + +In networks supporting the feature 'Intra Domain Connection of RAN Nodes to Multiple CN Nodes' (3GPP TS 23.236 [6A]), if the TMSI based NRI container is received in the SGsAP-LOCATION-UPDATE-REQUEST message, the VLR derives the NRI value. If the NRI value is not allocated by the VLR, the VLR retrieves the MM context of the UE from the HSS. + +When the VLR is configured for gateway core network (GWCN), the VLR shall select the serving CS domain operator as follows: + +- If the selected CS domain operator information element is received in the SGsAP-LOCATION-UPDATE-REQUEST message, the VLR shall select the serving CS domain operator as specified in the selected CS domain operator information element; +- If the selected CS domain operator information element is not received in the SGsAP-LOCATION-UPDATE-REQUEST message and the PLMN ID included in the new location area identifier information element identifies a CS domain operator, the VLR shall select the serving CS domain operator as specified in the new location area identifier information element; +- Otherwise, the VLR selects the serving CS domain operator based on local policies. + +#### 5.2.3.2 Location update response + +If the location update is accepted by the VLR and, if necessary, by the HSS, the VLR shall: + +- move the SGs association to the SGs-ASSOCIATED state; +- set the "Confirmed by Radio Contact" restoration indicator to "true"; +- update the SGs association by storing the MME address included in SGsAP-LOCATION-UPDATE-REQUEST message; and +- send an SGsAP-LOCATION-UPDATE-ACCEPT message to the sending MME. This message includes the location area identifier received in the New location area identifier information element in the previous SGsAP-LOCATION-UPDATE-REQUEST message. + +After the VLR has updated the SGs association, if Ts5 is still running for a MT service for this UE, the VLR shall repeat SGs Paging Request towards the updated SGs association. + +#### 5.2.3.3 Location update failure + +If the location update is rejected by the VLR, the VLR shall: + +- send an SGsAP-LOCATION-UPDATE-REJECT message to the MME with the appropriate reject cause as indicated in 3GPP TS 24.008 [8] and shall indicate to the MME the Location area identifier received in the corresponding SGsAP-LOCATION-UPDATE-REQUEST message; and +- move the SGs association to SGs-NULL. + +#### 5.2.3.4 TMSI reallocation procedure + +If the VLR decides to allocate a new TMSI to the UE, the VLR shall include the new TMSI in the SGsAP-LOCATION-UPDATE-ACCEPT message. After sending the SGsAP-LOCATION-UPDATE-ACCEPT message with a new TMSI the VLR shall start timer Ts6-2. If the VLR decides to deallocate the TMSI of the UE, the VLR shall include the IMSI of the UE in the SGsAP-LOCATION-UPDATE-ACCEPT message. + +Upon receipt of the SGsAP-TMSI-REALLOCATION-COMPLETE message, the VLR shall stop the timer Ts6-2 and consider the new TMSI as valid. + +If the IMSI was sent to the UE, the VLR considers the old TMSI if available, as deleted. + +If no SGsAP-TMSI-REALLOCATION-COMPLETE message is received by the VLR before the timer Ts6-2 expires, the VLR shall abort the TMSI reallocation procedure. The VLR shall consider the old TMSI if available, occupied until the new TMSI is used in a subsequent A/Iu message, or for an implementation dependent time. The outcome of the TMSI reallocation procedure does not change the state of the SGs association. The VLR uses the IMSI or a TMSI, either the new TMSI or the old TMSI if available, for paging. + +NOTE: Whether the new TMSI or old TMSI is used in the SGs paging request does not impact the paging procedure or UE response. + +#### 5.2.3.5 Abnormal cases + +The following abnormal cases can be identified: + +##### i) MM signalling via A or Iu interface + +If the VLR receives a Location Update request or an IMSI detach indication from the UE by the A or Iu interface when the state of the SGs association in the VLR is not SGs-NULL, the VLR shall move the state of the SGs association to SGs-NULL. + +##### ii) Additional Location Update Request + +If the state of the SGs association in the VLR is LA-UPDATE PRESENT and an SGsAP-LOCATION-UPDATE-REQUEST message is received, then: + +- if the message is from the same MME and indicates the same New location area identifier information element as the outstanding location update request, then the VLR shall ignore this additional SGsAP-LOCATION-UPDATE-REQUEST message; +- if the message is from the same MME but indicates a different New location area identifier information element to the outstanding location update request, then the VLR shall treat this additional SGsAP-LOCATION-UPDATE-REQUEST message and the VLR shall not send any response to the previous SGsAP-LOCATION-UPDATE-REQUEST message; or +- if the message is from a different MME (indicating either the same or different New location area identifier information element) to the outstanding location update request, then the VLR shall treat this additional SGsAP-LOCATION-UPDATE-REQUEST message and the VLR shall not send any response to the previous SGsAP-LOCATION-UPDATE-REQUEST message. + +##### iii) Detach signalling from the MME + +If the state of the SGs association in the VLR is LA-UPDATE PRESENT and either an SGsAP-EPS-DETACH-INDICATION or an SGsAP-IMSI-DETACH-INDICATION message is received, then the VLR shall abandon the Location Update for non-EPS services procedure (neither an SGsAP-LOCATION-UPDATE-ACCEPT nor an SGsAP-LOCATION-UPDATE-REJECT messages is sent) and the further actions described in subclauses 5.4 or 5.5 or 5.6 are followed. + +##### iv) Signalling via Gs interface + +If the VLR receives for a UE a BSSAP+-LOCATION-UPDATE-REQUEST message (as defined in 3GPP TS 29.018 [16]) from an SGSN when the state of the SGs association for this UE in the VLR is not SGs-NONE, the VLR shall move the state of the SGs association to SGs-NONE. + +##### v) New Location Update Request during TMSI reallocation procedure + +If the VLR receives an SGsAP-LOCATION-UPDATE-REQUEST message while Ts6-2 is running, the VLR shall stop timer Ts6-2, abort the TMSI reallocation procedure and proceed with the new location update for non-EPS services procedure. If the VLR needs to page the MS during the new location update for non-EPS services procedure, the VLR uses the IMSI or a TMSI, either the new TMSI from the aborted TMSI reallocation procedure or the old TMSI if available, for paging. + +NOTE: Whether the new TMSI or old TMSI is used in the SGs paging request does not impact the paging procedure or UE response. + +##### vi) Reset signalling from the MME + +If the state of the SGs association in the VLR is LA-UPDATE PRESENT and an SGsAP-RESET-INDICATION message is received from the MME, then the VLR shall abandon the Location Update for non-EPS services procedure (neither an SGsAP-LOCATION-UPDATE-ACCEPT nor an SGsAP-LOCATION-UPDATE-REJECT messages is sent) and the further actions described in subclause 5.8 are followed. + +##### vii) Collision between A or Iu paging and Location Update Request + +If the VLR receives Location Update Request when A or Iu paging is ongoing, then the VLR may abort paging procedure over A or Iu interface and may initiate paging procedure over SGs interface after location updating procedure has successfully completed. + +## 5.3 Non-EPS alert procedure + +### 5.3.1 General description + +This procedure is used by the VLR to request from an MME an indication when any signalling activity from the UE is detected. This procedure can be invoked at any time by the VLR. The MME shall acknowledge the SGsAP-ALERT-REQUEST message. + +### 5.3.2 Procedures in the VLR + +#### 5.3.2.1 Alert Initiation + +The VLR may start the Non-EPS alert procedure at any time. When the VLR wants to request from an MME that further activity from a UE is reported by the MME, the VLR shall send an SGsAP-ALERT-REQUEST message to that MME. The VLR starts timer Ts7 when the SGsAP-ALERT-REQUEST message is sent. + +#### 5.3.2.2 Alert Response + +When an SGsAP-ALERT-ACK message is received, the VLR shall stop the timer Ts7. The state of the SGs association is not changed. + +#### 5.3.2.3 Alert Failure + +If an SGsAP-ALERT-REJECT message is received, the VLR shall stop the timer Ts7, move the state of the SGs association to SGs-NULL and within this state the SGs association is marked with the contents of the SGs cause information element. + +#### 5.3.2.4 Alert Indication + +The VLR shall not change the state of the SGs association upon reception of an SGsAP-UE-ACTIVITY-INDICATION message. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the SGsAP-UE-ACTIVITY-INDICATION message includes the Maximum UE Availability Time IE and the MNRF flag is set in the VLR, the VLR may forward the Maximum UE Availability Time IE to the HLR as defined in 3GPP TS 29.002 [15]. + +#### 5.3.2.5 Abnormal cases + +If no SGsAP-ALERT-ACK message is received before the timer Ts7 expires, the VLR shall retransmit the SGsAP-ALERT-REQUEST message a maximum of Ns7 times. + +NOTE: If no SGsAP-ALERT-ACK message is received after that, a report is made to the O&M system. The state of the SGs association is not changed. + +### 5.3.3 Procedures in the MME + +#### 5.3.3.1 Alert response + +The MME may receive an SGsAP-ALERT-REQUEST message in any state of the SGs association. Upon receipt of an SGsAP-ALERT-REQUEST message from the VLR and if the IMSI is known in the MME, the MME shall reply with an SGsAP-ALERT-ACK message and set the NEAF. If the MME has activated Idle mode Signaling Reduction for the UE, the MME shall send an Alert MME Notification message to the associated SGSN, as described in 3GPP TS 29.274 [17A], except for the conditions specified in subclause 8.2.5c of 3GPP TS 23.272 [7]. + +#### 5.3.3.2 Alert failure + +If an SGsAP-ALERT-REQUEST message is received for an IMSI that is unknown at the MME, the MME shall return an SGsAP-ALERT-REJECT message to the VLR indicating the SGs cause information element value "IMSI unknown". + +#### 5.3.3.3 Alert indication + +The MME shall report to the VLR upon detection of any activity in E-UTRAN (either signalling or, indirectly detected via S-GW, data transfer) from the UE if the NEAF is set. If the MME detects EPS signalling that leads to a procedure towards the VLR, the MME shall follow this procedure and reset the NEAF. If the MME detects activity that does not lead to any procedure towards the VLR, the MME shall send an SGsAP-UE-ACTIVITY-INDICATION message towards the VLR and reset the NEAF. Upon receipt of a UE Activity Notification message from the SGSN, the MME shall reply with a UE Activity Acknowledge message, send an SGsAP-UE-ACTIVITY-INDICATION message to the VLR and reset the NEAF flag. + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE is using eDRX, the MME may include the Maximum UE Availability Time IE in the SGsAP-UE-ACTIVITY-INDICATION message. + +NOTE: This information can be used by the SMS Service Center to prioritize the retransmission of pending Mobile Terminated Short Messages to UEs using eDRX. + +## 5.4 Explicit IMSI detach from EPS services + +### 5.4.1 General description + +This procedure is used by the MME to indicate to the VLR that the UE has been detached from EPS services and therefore the SGs association between the MME and the VLR has to be deactivated. This procedure only applies to UEs which are not in the SGs-NULL state at the MME. The procedures specified in this subclause apply to EPS detach indication initiated by the UE or by the network as specified in 3GPP TS 24.301 [14]. + +The procedure is also used by the MME to indicate to the VLR when a combined tracking area update procedure has been rejected by the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14], or the MME receives the Detach Notification from the SGSN, as described in 3GPP TS 29.274 [17A], when Idle mode Signalling Reduction is activated. + +The procedure is also used by the MME to indicate to the VLR when a periodic tracking area update procedure has been rejected by the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14], for a UE for which an SGs association exists. + +The Explicit IMSI detach from EPS services procedure aborts any other ongoing procedure related to this UE on the SGs interface in the MME and in the VLR. + +### 5.4.2 Procedures in the MME + +#### 5.4.2.1 Explicit EPS detach initiation + +The MME shall send an SGsAP-EPS-DETACH-INDICATION message to a VLR if: + +- the MME receives a detach for EPS from the UE; +- the MME performs network initiated EPS detach procedure; +- the combined tracking area update procedure is rejected by the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14]; +- the periodic tracking area update procedure is rejected by the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14], for a UE for which an SGs association exists; or +- the MME receives a Detach Notification from the SGSN with the Detach type indicating "PS Detach". + +If the MME receives a Detach Request from a UE or Detach Notification from an SGSN and the state of the SGs association to a VLR for that UE is not SGs-NULL, the MME shall check the detach type indicated in the Detach Request message or the detach type indicated in the Detach Notification message. If the UE has indicated EPS detach the MME shall send an SGsAP-EPS-DETACH-INDICATION message to the VLR indicating "UE initiated IMSI detach from EPS services". + +If the MME performs a network initiated detach procedure and the state of the SGs association to a VLR for that UE is not SGs-NULL, the MME shall send an SGsAP-EPS-DETACH-INDICATION message to the VLR indicating "Network initiated IMSI detach from EPS services". + +If the combined or periodic tracking area update procedure is rejected at the MME, except when the MME performs the NAS level mobility management congestion control as specified in 3GPP TS 24.301 [14], for a UE with an SGs association state different from SGs-NULL, the MME shall send an SGsAP-EPS-DETACH-INDICATION to the VLR indicating "EPS services not allowed". + +After sending of the SGsAP-EPS-DETACH-INDICATION message, the MME shall move the state of the SGs association to SGs-NULL. The MME shall start timer Ts8 upon transmission of the SGsAP-EPS-DETACH-INDICATION message and the MME shall stop and reset timer Ts6-1 if running. + +#### 5.4.2.2 Explicit EPS detach response + +If the MME receives an SGsAP-EPS-DETACH-ACK message from the VLR, the MME shall stop timer Ts8. If a confirmation of the detach needs to be sent to the UE, the MME shall not wait for the reception of the SGsAP-EPS-DETACH-ACK message to send such confirmation. + +#### 5.4.2.3 Abnormal cases + +If no SGsAP-EPS-DETACH-ACK message is received by the MME in response to a previous SGsAP-EPS-DETACH-INDICATION message before timer Ts8 expires, the MME shall repeat the SGsAP-EPS-DETACH-INDICATION message a maximum of Ns8 times. + +NOTE: If no SGsAP-EPS-DETACH-ACK message is received after that, a report is made to the O&M system. The state of the SGs association during the acknowledgement procedure remains SGs-NULL. + +### 5.4.3 Procedures in the VLR + +When a VLR receives an SGsAP-EPS-DETACH-INDICATION message, the VLR shall send an SGsAP-EPS-DETACH-ACK message to the sending MME. The VLR shall check the MME name indicated in the SGsAP-EPS-DETACH-INDICATION message. If the received MME name is not changed comparing to the MME name stored in the VLR, the VLR shall move the state of the SGs association for the UE from any state to SGs-NULL and marks the SGs association as "detached for EPS services". Otherwise, the VLR shall not change the state of the SGs association. + +If the VLR's implicit detach timer is not running then the VLR shall set and restart the implicit detach timer upon reception of an SGsAP-EPS-DETACH-INDICATION message. If the VLR's implicit detach timer is running (the state of the SGs association was already SGs-NULL) then the reception of an SGsAP-EPS-DETACH-INDICATION message shall not affect VLR's implicit detach timer. + +## 5.5 Explicit IMSI detach from non-EPS services + +### 5.5.1 General description + +This procedure is used by the MME to indicate to the VLR that the UE has performed IMSI detach from non-EPS services and therefore the SGs association between the MME and the VLR has to be deactivated. This procedure applies only to UEs for which there is a SGs association at the MME. The procedures specified in this subclause apply only to IMSI detach request, combined IMSI and EPS detach requests from the UE or Detach Notification message from an SGSN. + +The explicit IMSI detach from non-EPS services procedure aborts any other ongoing procedure related to this UE on the SGs interface in the MME and in the VLR. + +In order to ensure that the VLR and the UE are synchronized as to which paging channel to use for any of the subsequent paging events, the MME shall attempt to inform the VLR about the detach event by using a retry scheme if the initial delivery of the SGsAP-IMSI-DETACH-INDICATION message fails. + +### 5.5.2 Procedures in the MME + +#### 5.5.2.1 Explicit IMSI detach initiation + +When an MME receives a Detach Request from a UE for which an SGs association exists, the MME shall check the detach type indicated. If the UE is indicating IMSI detach or combined EPS/IMSI detach, the MME shall send an SGsAP-IMSI-DETACH-INDICATION message to the VLR indicating "Explicit UE initiated IMSI detach from non-EPS services" or "Combined UE initiated IMSI detach from EPS and non-EPS services". + +When an MME receives a Detach Notification message for a UE from an SGSN and an SGs association for the UE exists, the MME shall check the cause and detach type indicated. If the cause is indicating "IMSI Detach only", the MME shall send an SGsAP-IMSI-DETACH-INDICATION message to the VLR indicating "Explicit UE initiated IMSI detach from non-EPS services". If the cause is indicating "Complete Detach" and detach type is indicating "Combined + +PS/CS Detach" as specified in 3GPP TS 29.274 [17A], the MME shall send an SGsAP-IMSI-DETACH-INDICATION message to the VLR indicating "Combined UE initiated IMSI detach from EPS and non-EPS services". + +After the sending of the SGsAP-IMSI-DETACH-INDICATION message to the VLR, the MME shall move the state of the SGs association to SGs-NULL. The MME shall start timer Ts9 upon transmission of the SGsAP-IMSI-DETACH-INDICATION message and the MME shall stop and reset timer Ts6-1, if running. + +#### 5.5.2.2 Explicit IMSI detach response + +If the MME receives an SGsAP-IMSI-DETACH-ACK message from the VLR, the MME shall stop timer Ts9. If the detach type received from the UE indicated IMSI only detach or combined EPS/IMSI detach not due to switch off, the MME shall wait for the reception of the SGsAP-IMSI-DETACH-ACK message before sending the confirmation of the detach to the UE. + +#### 5.5.2.3 Abnormal cases + +The following abnormal cases can be identified: + +- i) no SGsAP-IMSI-DETACH-ACK received for a detach with switch off + +If the MME sent an SGsAP-IMSI-DETACH-INDICATION message for a combined IMSI and EPS detach due to switch off and timer Ts9 expires, the MME shall repeat the SGsAP-IMSI-DETACH-INDICATION message a maximum of Ns9 times. + +- ii) no SGsAP-IMSI-DETACH-ACK received for a detach with no switch off + +If the MME sent an SGsAP-IMSI-DETACH-INDICATION message for an IMSI only detach or a combined IMSI and EPS detach not due to switch off and timer Ts9 expires, the MME shall repeat the SGsAP-IMSI-DETACH-INDICATION message a maximum of Ns9 times. If no SGsAP-IMSI-DETACH-ACK is received after that the MME shall send the confirmation of the detach to the UE. + +### 5.5.3 Procedures in the VLR + +When a VLR receives an SGsAP-IMSI-DETACH-INDICATION message, the VLR shall send an SGsAP-IMSI-DETACH-ACK message to the sending MME. + +The VLR shall check the MME name indicated in the SGsAP-IMSI-DETACH-INDICATION message. If the received MME name is not changed comparing to the MME name stored in the VLR, the VLR shall move the state of the SGs association for the UE from any state to SGs-NULL. If the SGsAP-IMSI-DETACH-INDICATION message indicated "Explicit UE initiated IMSI detach from non-EPS services", the VLR marks the SGs association as "IMSI detached for non-EPS services". If the SGsAP-IMSI-DETACH-INDICATION message indicated "Combined UE initiated IMSI detach from EPS and non-EPS services", the VLR marks the SGs association as "IMSI detached for EPS and non-EPS services". The VLR shall mark the UE as detached. + +If the received MME name is different from the MME name stored in the VLR, the VLR shall not change the state of the SGs association. + +## 5.6 Implicit IMSI detach from non-EPS services + +### 5.6.1 General description + +This procedure is used by the MME to indicate when, based on the criteria for implicit detach as specified in 3GPP TS 23.401 [7B], the MME has decided to delete the EMM context of an UE or mark its EMM context as detached. This procedure only applies to UEs for which there is an SGs association at the MME. + +The implicit IMSI detach from non-EPS services procedure aborts any other ongoing procedure related to this UE on the SGs interface in the MME and in the VLR. + +In order to ensure that the VLR and the UE are synchronized as to which paging channel to use for any of the subsequent paging events the MME shall attempt to inform the VLR about the detach event by using a retry scheme if the initial delivery of the SGsAP-IMSI-DETACH-INDICATION message fails. + +### 5.6.2 Procedures in the MME + +When the implicit IMSI detach from non-EPS services procedure is started for a UE, the MME shall send an SGsAP-IMSI-DETACH-INDICATION message to the VLR indicating "Implicit network initiated IMSI detach from EPS and non-EPS services". + +After the sending of the SGsAP-IMSI-DETACH-INDICATION message, the MME shall move the state of the SGs association to SGs-NULL. The MME shall start timer Ts10 upon transmission of the SGsAP-IMSI-DETACH-INDICATION message. + +If the MME receives an SGsAP-IMSI-DETACH-ACK message from the VLR, the MME shall stop timer Ts10. + +If no SGsAP-IMSI-DETACH-ACK message is received by the MME to a previous SGsAP-IMSI-DETACH-INDICATION message before timer Ts10 expires, the MME shall repeat the SGsAP-IMSI-DETACH-INDICATION message a maximum of Ns10 times. The state of the SGs association during the acknowledgement procedure remains SGs-NULL. + +### 5.6.3 Procedures in the VLR + +When a VLR receives the SGsAP-IMSI-DETACH-INDICATION message, the VLR shall send an SGsAP-IMSI-DETACH-ACK message to the sending MME. + +The VLR shall check the MME name indicated in the SGsAP-IMSI-DETACH-INDICATION message. If the received MME name is not changed comparing to the MME name stored in the VLR and the state of the SGs association is not SGs-NULL, the VLR proceeds as follows: + +- The VLR shall move the state of the SGs association for the UE to SGs-NULL. If the VLR does not have a signalling connection for the UE, the VLR shall mark the UE as detached. Additionally, the VLR marks the SGs association as "IMSI implicitly detached for EPS and non-EPS services". + +If the received MME name is different from the MME name stored in the VLR, the VLR shall not change the state of the SGs association. + +## 5.7 VLR failure procedure + +### 5.7.1 General description + +This procedure is used by the VLR to inform the MMEs with an SGs association about the recovery from an internal failure that has affected the SGs association with the MMEs when the VLR fails with restart. + +NOTE: The VLR recovery procedure is handled in such a way that the signalling load on the VLR and MMEs does not create any overload problem. + +### 5.7.2 Procedures in the VLR + +#### 5.7.2.1 VLR Reset Initiation + +In the event of a failure at the VLR which has resulted in the loss of the SGs association information for some UEs, the VLR shall move from any state to the SGs-NULL state for these UEs. The VLR shall also set the "Confirmed by Radio Contact" restoration indicator to "false" (see 3GPP TS 23.007 [4]) for affected UEs. The VLR shall not send any SGsAP-MM-INFORMATION-REQUEST messages to UEs with the SGs association in the SGs-NULL state. + +When the VLR restarts, the VLR shall send an SGsAP-RESET-INDICATION message to all the MMEs connected to the VLR by the SGs interface. This message indicates to the MME that for the UEs with an SGs association to that VLR, the SGs association is no longer reliable. The VLR shall also start a separate timer Ts11 for each MME. + +#### 5.7.2.2 VLR Reset Response + +Upon receipt of an SGsAP-RESET-ACK message from an MME, the VLR shall stop the timer Ts11 for that MME. + +#### 5.7.2.3 Abnormal cases + +If the VLR does not receive an SGsAP-RESET-ACK message from that MME before the timer Ts11 expires, the VLR shall retransmit the SGsAP-RESET-INDICATION message. The retransmission is repeated a maximum of Ns11 times. + +NOTE: If no SGsAP-RESET-ACK is received after that a report is made to the O&M system. + +### 5.7.3 Procedures in the MME + +#### 5.7.3.1 VLR reset indication + +Upon receipt of an SGsAP-RESET-INDICATION message from the VLR, the MME is informed that all the SGs associations with that VLR for all the UEs registered in the MME are no longer reliable because the VLR has lost information about the state of the UEs and during the failure the VLR might have missed signalling messages. The MME shall set the "VLR-Reliable" MM context variable to "false". The detach procedures for deleting the SGs association are still applicable (see subclauses 5.4, 5.5 and 5.6). + +The MME sends an SGsAP-RESET-ACK message to the VLR. + +If the "VLR-Reliable" MM context variable is set to "false", upon reception of a combined tracking area update request or a periodic tracking area update request from the UE that is attached for non-EPS service, the MME may: + +- if a combined tracking area update request is received, immediately perform the location update for non-EPS services procedure towards the VLR as described in subclause 5.2; or +- if a periodic tracking area update request is received, dependent on network configuration and operator policy, + - perform a network initiated detach with detach type "IMSI detach" immediately after the completion of the periodic tracking area update procedure; or + - perform immediately the location update for non-EPS services procedure towards the VLR as described in subclause 5.2. + +#### 5.7.3.2 Void + +## 5.8 MME failure procedure + +### 5.8.1 General description + +This procedure is used by the MME to inform the associated VLRs about the recovery from an internal failure that has affected the SGs association with the VLRs. + +NOTE: The MME recovery procedure is handled in such a way that the signalling load on the MME and VLRs does not create any overload problem. + +### 5.8.2 Procedures in the MME + +#### 5.8.2.1 MME Reset Initiation + +In the event of a failure at the MME which has resulted in the loss of the SGs association information on some UEs, the MME shall move from any state to the SGs-NULL state for these affected UEs. The MME shall also set the "MME-Reset" MM context variable to "true" and start the timer Ts12-1. When the timer Ts12-1 expires the "MME-Reset" MM context variable is set to "false". + +The MME may send an SGsAP-RESET-INDICATION message to all the VLRs connected to the MME by SGs interfaces. The SGsAP-RESET-INDICATION message indicates to the VLR that all the SGs associations with that particular MME for all the UEs registered in the VLR are no longer reliable. The normal procedures for updating the SGs association are still applicable (see subclauses 5.2, 5.4, 5.5 and 5.6). The MME shall also start a separate timer Ts12-2 for each VLR. + +If the MME does not send an SGsAP-RESET-INDICATION message, the MME shall move from any state to the SGs-NULL state only for the associations of the UEs affected by the loss of VLR association information. + +NOTE: The option to not send any SGsAP-RESET-INDICATION message to all the VLRs connected to the MME by SGs interfaces reduces subsequent paging signalling initiated by VLRs by avoiding a complete search of the UE on the entire VLR area. + +#### 5.8.2.2 MME Reset Response + +Upon receipt of an SGsAP-RESET-ACK message, the MME shall stop the timer Ts12-2 for that VLR. + +#### 5.8.2.3 Abnormal cases + +If the MME does not receive an SGsAP-RESET-ACK message from that VLR before the timer Ts12-2 expires, the MME shall retransmit the SGsAP-RESET-INDICATION message. The retransmission is repeated a maximum of Ns12 times. + +NOTE: If no SGsAP-RESET-ACK is received after that a report is made to the O&M system. + +### 5.8.3 Procedures in the VLR + +Upon receipt of an SGsAP-RESET-INDICATION message from the MME, the VLR is informed that all the SGs associations with that MME for all the UEs registered in the MME are no longer reliable because the MME has lost information about the state of the UEs for that VLR and during the failure the MME might have missed signalling messages. The VLR shall either: + +- set the "Confirmed by Radio Contact" restoration indicator to "false" in all the SGs associations containing the restarted MME and set the state of all the SGs associations containing the restarted MME to the SGs-NULL state; or +- keep the 'Confirmed by Radio Contact' restoration indication and the state of all the SGs associations containing the restarted MME unchanged. + +NOTE: The option to not set the 'Confirmed by Radio Contact' restoration indicator to 'false' in all the associations containing the restarted MME reduces subsequent paging signalling the VLR can initiate by avoiding a complete search of the UE on the entire VLR area. + +The VLR shall then send an SGsAP-RESET-ACK message to the MME. + +If the "Confirmed by Radio Contact" restoration indicator is "false" the VLR may send paging messages on both the SGs and the A/Iu interface. + +## 5.9 HSS failure + +### 5.9.1 General description + +This subclause describes the MME behaviour towards the VLR as a consequence of an HSS reset. + +In the case of an HSS failure, the HSS informs the associated MMEs about the recovery from an internal failure that has affected the SGs association with the MMEs according to the HSS reset procedure specified in 3GPP TS 29.272 [17]. + +This information is used in the MME to trigger the VLR to perform a location update towards the HSS in order to restore the HSS subscriber data. + +### 5.9.2 Procedures in the MME + +Upon receipt of a HSS reset indication from the HSS, the MME shall set the NEAF for all registered UEs in the MME for which a valid SGs association with a VLR exists. + +Upon detection of any signalling activity from the UE, the MME shall report to the VLR if the NEAF, as defined in subclause 5.3.3, is set for this UE. If the MME detects signalling that leads to a procedure towards the VLR, the MME + +shall follow this procedure and reset the NEAF. If the MME detects activity that does not lead to any procedure towards the VLR, the MME shall send an SGsAP-UE-ACTIVITY-INDICATION message towards the VLR and reset the NEAF. The MME may delay sending the activity indication for a maximum operator-configuration depending time period to avoid high signalling load. + +## 5.10 MM information procedure + +### 5.10.1 General description + +The MM information procedure is performed between the VLR and the MME via the SGs interface if the target UE for the MM information procedure is IMSI attached to both EPS and non-EPS services (i.e. the state of the SGs association is SGs-ASSOCIATED). The outcome of the MM Information procedure does not change the state of the SGs association at the VLR or MME. + +### 5.10.2 Procedures in the VLR + +If for the target UE for the MM information procedure the state of the SGs association in the VLR is SGs-ASSOCIATED, the VLR may initiate the MM information procedure by transferring an SGsAP-MM-INFORMATION-REQUEST message to the MME. + +### 5.10.3 Procedures in the MME + +If an SGsAP-MM-INFORMATION-REQUEST message is received for a UE for which there exists an SGs association at the MME, dependent on operator preference the MME shall either: + +- 1) check and update the contents of the received MM information information element. The MME then sends the resultant contents of the MM information information element to the UE indicated in the SGsAP-MM-INFORMATION-REQUEST message, using an EMM INFORMATION message as defined in 3GPP TS 24.301 [14]; or +- 2) discard the SGsAP-MM-INFORMATION-REQUEST message. In this case the MME can send an EMM INFORMATION message as defined in 3GPP TS 24.301 [14] to the UE, with contents generated locally by the MME. + +The MME should avoid sending both EMM INFORMATION messages according to option 1 and EMM INFORMATION messages according to option 2 to the same UE. + +NOTE 1: Sending messages according to option 1 and option 2 to the same UE can result in short-time changes of the network name or the local time displayed by the UE. + +For option 1) the MME checks and updates the contents of the MM information information element as follows: + +- a) If LSA Identity has been included in the MM information, the MME shall discard the LSA Identity; +- b) If the network spans more than one time zone, the MME shall handle the time-related parameters as follows: + - if Network Daylight Saving Time has been included in the MM information, then the MME shall discard the Network Daylight Saving Time; + - if Local Time Zone has been included in the MM information, then the MME shall replace the Local Time Zone with the Local Time Zone applicable for this UE. In addition, if the local time zone in the MME has been adjusted for daylight saving time, the MME shall indicate this by including the value used for adjustment in Network Daylight Saving Time IE in the MM information; + - if Universal time and local time zone has been included in the MM information, then the MME shall replace it with the Universal time and local time zone applicable for this UE. In addition, if the local time zone in the MME has been adjusted for daylight saving time, the MME shall indicate this by including the value used for adjustment in Network Daylight Saving Time IE in the MM information; + +NOTE 2: For the determination of the number of time zones, both CS and PS domain are taken into account. + +- c) If the network name, i.e. Full name for network or Short name for network or both, has been included by the VLR in the MM information information element, then dependent on operator preference and other information, e.g. the IMSI of the subscriber, the MME may + - replace the network name received from the VLR with a different network name; + - remove the network name from the MM information information element; or + - keep the network name received from the VLR unchanged. + +NOTE 3: The network name received from the VLR can be different from the network name provided by the MME, e.g. if multiple PLMNs are available for the CS domain. + +## 5.11 Procedure for tunnelling of NAS messages + +### 5.11.1 General description + +The tunnelling of NAS messages procedure is used to encapsulate the NAS messages exchanged between the UE and the VLR. This procedure can be used by either the VLR or the MME depending on the direction of the NAS message. The two procedures are identified as uplink unitdata, in the direction from the MME to the VLR, and downlink unitdata in the direction from the VLR to the MME. + +### 5.11.2 Uplink unitdata procedure + +#### 5.11.2.1 Procedures in the MME + +When the MME receives an Uplink NAS Transport message (see 3GPP TS 24.301 [14]) from a UE, the MME shall copy the value part of the NAS message container information element to the value part of the NAS message container information element of the SGsAP-UPLINK-UNITDATA message and send the SGsAP-UPLINK-UNITDATA message to the VLR if the "VLR-Reliable" MM context variable is not set to "false". If the "VLR-Reliable" MM context variable is set to "false", the MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14]. + +In order to permit the VLR to create an accurate charging record, the MME shall add the IMEISV, the UE Time Zone, the Mobile Station Classmark 2, and the UE's current TAI and E-CGI to the SGsAP-UPLINK-UNITDATA message. + +#### 5.11.2.2 Procedures in the VLR + +##### 5.11.2.2.1 General description + +Upon reception of an SGsAP-UPLINK-UNITDATA, the VLR shall extract the NAS message container information element and treat the value part of this information element according to the procedures defined in 3GPP TS 24.011 [10]. + +Other parameters in the message may be used as specified in 3GPP TS 32.250 [17B] and 3GPP TS 23.078 [5AA]. + +##### 5.11.2.2.2 Abnormal cases + +The following abnormal cases can be identified: + +- i) subscriber data does not exist or is not confirmed by HLR + +If the VLR receives an SGsAP-UPLINK-UNITDATA message from the MME for a UE for which subscriber data does not exist or is not confirmed by HLR, then the VLR shall ignore the received message, and return an SGsAP-RELEASE-REQUEST message to the MME with an SGs cause information element indicating "IMSI unknown". + +- ii) subscriber data exists, but there is no SGs association for the UE at the VLR + +If the VLR receives an SGsAP-UPLINK-UNITDATA message from the MME for a UE for which no SGs association exists, then the VLR shall ignore the received message, and return an SGsAP-RELEASE-REQUEST message to the MME with an SGs cause information element indicating "IMSI detached for non-EPS services". + +#### 5.11.2.3 Void + +### 5.11.3 Downlink unitdata procedure + +#### 5.11.3.1 Procedures in the VLR + +When the VLR needs to send a NAS message to the UE, the VLR shall first verify whether or not it has an SGs association for the UE. If the state of the SGs association for the UE is SGs-ASSOCIATED and LA-UPDATE-PRESENT, then the VLR continues with the procedure. The VLR shall build and encapsulate the NAS message into the value part of the NAS message container information element of an SGsAP-DOWNLINK-UNITDATA message and send the SGsAP-DOWNLINK-UNITDATA message to the MME. + +#### 5.11.3.2 Procedures in the MME + +##### 5.11.3.2.1 General description + +Upon reception of an SGsAP-DOWNLINK-UNITDATA message, the MME shall proceed as follows: + +- If the UE was in EMM-CONNECTED mode, the MME shall copy the value part of the NAS message container information element to the value part of the NAS message container information element of a Downlink NAS Transport message (see 3GPP TS 24.301 [14]) and shall send the Downlink NAS Transport message to the UE; or +- In Deployment Option 3 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE was in EMM-IDLE mode and temporarily unreachable for paging due to using eDRX (as specified in 3GPP TS 24.301 [14]), the MME behaves as specified in subclause 8.2.4a.3 of 3GPP TS 23.272 [7]. + +##### 5.11.3.2.2 Abnormal cases + +The following abnormal cases can be identified: + +- i) subscriber data does not exist or is not confirmed by HSS + +If the MME receives an SGsAP-DOWNLINK-UNITDATA message from the VLR for a UE for which subscriber data does not exist or is not confirmed by HSS, then the MME shall ignore the received message. + +- ii) subscriber data exists, but there is no SGs association for the UE at the MME + +If the MME receives an SGsAP-DOWNLINK-UNITDATA message from the VLR for a UE for which there is no SGs association, then the MME shall ignore the received message. + +#### 5.11.3.3 Void + +### 5.11.4 Release procedure + +When the VLR determines that there are no more NAS messages to be exchanged between the VLR and the UE, or when a further exchange of NAS messages for the specified UE is not possible due to an error, the VLR shall send the SGsAP-RELEASE-REQUEST message to the MME, including the IMSI of the UE for which there are no more NAS messages to be tunnelled. + +- NOTE: For the SMS transport, the VLR can send the SGsAP-RELEASE-REQUEST message when the SMS transaction is complete (reception of a CP-ACK message for the MO case, sending of a CP-ACK message for the MT case), upon reception of a CP-ERROR message, abort of SMS transaction by upper layers, or upon some error cases such as TC1 expiry, no SGs association for the UE or IMSI unknown. + +Upon receipt of an SGsAP-RELEASE-REQUEST message with an SGs cause information element indicating "IMSI unknown" or "IMSI detached for non-EPS services", the MME shall set the "VLR-Reliable" MM context variable to "false". In addition, the MME requests the UE to re-attach for non-EPS services as specified in 3GPP TS 24.301 [14]. + +## 5.12 Service request procedure + +### 5.12.1 General description + +After the reception of an SGsAP-PAGING-REQUEST message from the VLR, the MME will use this procedure to indicate to the VLR that a NAS signalling connection exists between the UE and the MME. + +The procedure can be invoked, by the MME as follows: + +- Upon reception of a Service Request message or Extended Service Request message from the UE; +- Directly after receiving the SGsAP-PAGING-REQUEST message from the VLR, based on the UE's EMM mode; or +- In Deployment Option 3 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), detecting the UE is temporarily unreachable for paging due to using eDRX (as specified in 3GPP TS 24.301 [14]) and the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator". + +### 5.12.2 Procedures in the MME + +When receiving the SGsAP-PAGING-REQUEST message, the MME shall first take action as described in subclause 5.1.3 and check whether the UE, for which the paging is sent, is in EMM-IDLE or EMM-CONNECTED mode. + +If the MME accepts the paging request, the MME shall proceed as follows: + +- If the UE was in EMM-CONNECTED mode, the MME creates and sends an SGsAP-SERVICE-REQUEST message to the VLR based on the conditions specified in 3GPP TS 23.272 [7]. If the UE subsequently rejects the CS fallback call, the MME shall send the SGsAP-PAGING-REJECT message to the VLR with the SGs cause information element indicating "Mobile terminating CS fallback call rejected by the user"; +- If the UE was in EMM-IDLE mode and the SGsAP-PAGING-REQUEST message was received with LAI, the MME shall send the SGsAP-SERVICE-REQUEST message to the VLR when the UE enters EMM-CONNECTED mode; +- If the UE was in EMM-IDLE mode and the SGsAP-PAGING-REQUEST message was received without LAI, the MME behaves as specified in subclause 4.8.1 of 3GPP TS 23.272 [7]; or +- In Deployment Option 3 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), if the UE was in EMM-IDLE mode and temporarily unreachable for paging due to using eDRX (as specified in 3GPP TS 24.301 [14]), and the Service indicator information element in the SGsAP-PAGING-REQUEST message indicates "SMS indicator", the MME behaves as specified in subclause 8.2.4a.3 of 3GPP TS 23.272 [7]. + +The MME shall set the service indicator in the SGsAP-SERVICE-REQUEST message equal to what was received in the SGsAP-PAGING-REQUEST message. Additionally, in order to permit the VLR to create an accurate charging record, the MME shall add the IMEISV, the UE Time Zone, the Mobile Station Classmark 2, and the UE's current TAI and E-CGI to the SGsAP-SERVICE-REQUEST message. + +### 5.12.3 Procedures in the VLR + +Upon reception of the SGsAP-SERVICE-REQUEST message, the VLR shall stop Timer Ts5 and consider the paging procedure as successful. If the paging procedure is for SMS, the VLR shall then start the delivery of the SMS message(s) according to the subclause 5.11.3.1. If the paging procedure with the Service indicator information element indicating "SMS Indicator" was triggered upon reception of a Provide Subscriber Information Request message, the VLR can return an SGs AP-RELEASE-REQUEST message to the MME as specified in subclause 7.2.3.5 of 3GPP TS 23.018 [5]. + +Other parameters in the message may be used as specified in 3GPP TS 32.250 [17B] and 3GPP TS 23.078 [5AA]. + +## 5.13 Service abort procedure + +### 5.13.1 General description + +This procedure can be invoked by the VLR to abort a mobile terminating CS fallback call during call establishment. The procedure applies to UEs that are simultaneously attached for EPS services and non-EPS services, but not to UEs attached for EPS services and SMS only. + +### 5.13.2 Procedures in the VLR + +If the VLR decides to abort a mobile terminating CS fallback call for which it has sent an SGsAP-PAGING-REQUEST message to the MME, and the VLR has not received an SCCP connection establishment containing the Initial L3 message from the UE via the A or Iu interface, the VLR shall send the SGsAP-SERVICE-ABORT-REQUEST message to the MME. The state of the SGs association is not changed. + +### 5.13.3 Procedures in the MME + +When the MME receives the SGsAP-SERVICE-ABORT-REQUEST message from the VLR, the MME shall set the Call Cancelled Flag to "true". + +If the MME receives an EXTENDED SERVICE REQUEST message from the UE with Service type set to "mobile terminating CS fallback or 1xCS fallback" and CSFB response set to "CS fallback accepted by the UE" and the Call Cancelled Flag is set to "true", the MME shall set the Call Cancelled Flag to "false" and will reject the CS fallback call as specified in 3GPP TS 24.301 [14]. + +If the Call Cancelled Flag is set to "true", the MME shall set the Call Cancelled Flag to "false": + +- upon reception of the EXTENDED SERVICE REQUEST message from the UE with Service type set to a value other than "mobile terminating CS fallback or 1xCS fallback" or CSFB response set to a value other than "CS fallback accepted by the UE"; or +- upon reception of a new SGsAP-PAGING-REQUEST message from the VLR. + +When the MME receives the SGsAP-SERVICE-ABORT-REQUEST message after the UE has accepted the CS fallback call, the MME shall discard the SGsAP-SERVICE-ABORT-REQUEST message. The state of the SGs association is not changed. + +## 5.14 Implicit IMSI detach from EPS services + +### 5.14.1 General description + +This procedure is used by the MME to indicate when, based on the criteria for implicit detach as specified in 3GPP TS 23.401 [7B], the MME has decided to delete the EMM context of an UE or mark its EMM context as detached. This procedure only applies to UEs for which there is an SGs association at the MME and the network operating in NMO I and supporting ISR. + +The implicit IMSI detach from EPS services procedure aborts any other ongoing procedure related to this UE on the SGs interface in the MME and in the VLR. + +In order to ensure that the VLR and the UE are synchronized as to which paging channel to use for any of the subsequent paging events the MME shall attempt to inform the VLR about the detach event by using a retry scheme if the initial delivery of the SGsAP-EPS-DETACH-INDICATION message fails. + +### 5.14.2 Procedures in the MME + +When the implicit IMSI detach from EPS services procedure is started for a UE, the MME shall send an SGsAP-EPS-DETACH-INDICATION message to the VLR indicating "Network initiated IMSI detach from EPS services". + +After the sending of the SGsAP-EPS-DETACH-INDICATION message, the MME shall move the state of the SGs association to SGs-NULL. The MME shall start timer Ts13 upon transmission of the SGsAP-EPS-DETACH-INDICATION message. + +If the MME receives an SGsAP-EPS-DETACH-ACK message from the VLR, the MME shall stop timer Ts13. + +If no SGsAP-EPS-DETACH-ACK message is received by the MME to a previous SGsAP-EPS-DETACH-INDICATION message before timer Ts13 expires, the MME shall repeat the SGsAP-EPS-DETACH-INDICATION message a maximum of Ns10 times. The state of the SGs association during the acknowledgement procedure remains SGs-NULL. + +### 5.14.3 Procedures in the VLR + +When a VLR receives an SGsAP-EPS-DETACH-INDICATION message, the VLR shall perform the procedures described in subclause 5.4.3. + +## 5.15 UE fallback supervision procedure + +### 5.15.0 General description + +This procedure is used by the VLR to monitor the status of the UE fallback procedure, after the VLR has sent an SGsAP-PAGING-REQUEST message to the MME. + +### 5.15.1 Procedures in the VLR + +Upon receipt of an SGsAP-SERVICE-REQUEST message from the MME, if the Service indicator information element in the SGsAP-SERVICE-REQUEST message indicates "CS call indicator", the VLR shall start timer Ts14 to supervise the success of UE fallback. + +The VLR shall stop timer Ts14 in the following cases: + +- upon receipt of an SCCP connection establishment containing the Initial L3 message from the UE via the A or Iu interface; +- upon receipt of an SGsAP-PAGING-REJECT message; or +- upon expiry of the CFNRy timer and if Call Forwarding on No Reply (CFNRy) has been configured and activated for the terminating UE. + +NOTE 1: Upon expiry of the CFNRy timer, the VLR triggers Call Forwarding on No Reply (CFNRy) as specified in 3GPP TS 23.082 [5B] and 3GPP TS 29.011 [15A]. + +If Call Forwarding on No Reply (CFNRy) is not activated for the terminating UE, upon expiry of timer Ts14, the VLR shall release the call as specified in 3GPP TS 24.008[8]. + +NOTE 2: Before releasing the call, the VLR needs to consider whether A/Iu paging is ongoing. In addition, if the VLR considers the paging procedure completed, and no response has been received from the UE via the A or Iu interface, and if CFNRc has been configured and activated for the terminating UE, the VLR applies the equivalent handling as for Call Forwarding on Not Reachable, as specified in 3GPP TS 23.082 [5B] and 3GPP TS 29.011 [15A]. + +## 5.16 Procedure for MO CSFB indication + +### 5.16.1 General description + +If the network is configured to support the return to the last used E-UTRAN PLMN after CS fallback as specified in 3GPP TS 23.272 [7], this procedure is used to indicate to the VLR that the UE initiated a service request for MO CS fallback. + +### 5.16.2 Procedures in the MME + +If the MME is configured to support the return to the last used E-UTRAN PLMN after CS fallback, upon reception of an EXTENDED SERVICE REQUEST message (see 3GPP TS 24.301 [14]) from the UE with Service type set to "mobile originating CS fallback or 1xCS fallback" or "mobile originating CS fallback emergency call or 1xCS fallback emergency call" from the UE, the MME shall send the SGsAP-MO-CSFB-INDICATION message to the VLR. + +### 5.16.3 Procedures in the VLR + +If the VLR is configured to support the return to the last used E-UTRAN PLMN after CS fallback, upon reception of an SGsAP-MO-CSFB-INDICATION, the VLR shall start timer Ts15 to supervise the success of the UE fallback. + +If an SCCP connection establishment containing the Initial L3 message is received from the UE via the A or Iu interface, the VLR shall stop timer Ts15 and apply specific handling related to the return to the last used E-UTRAN PLMN after CS fallback. + +Upon expiry of Ts15, the VLR considers the MO CSFB to have failed and does not apply specific handling related to support of the return to the last used E-UTRAN PLMN after CS fallback. + +# --- 6 SGs transport + +## 6.1 General + +This subclause specifies the standards for signalling transport to be used across SGs interface. SGs interface is a logical interface between the MME and the VLR. All the SGsAP messages described in the present document require an SCTP association between the MME and the VLR. + +## 6.2 IP layer + +The MME and the VLR shall support IPv6 (see IETF RFC 2460 [22]) and/or IPv4 (see IETF RFC 791 [20]). + +The IP layer of SGs only supports point-to-point transmission for delivering SGsAP messages. + +## 6.3 Transport layer + +SCTP (see IETF RFC 4960 [23]) shall be supported as the transport layer of SGsAP messages. + +Semi-permanent SCTP associations shall be established between the MME and VLR, i.e. the SCTP associations shall remain up under normal circumstances. The MME shall establish the SCTP association. + +Transport network redundancy can be achieved by SCTP multi-homing between two end-points, of which one or both is assigned with multiple IP addresses. SCTP end-points shall support a multi-homed remote SCTP end-point. + +NOTE 1: If the association initialization to an IP destination address of the VLR is unsuccessful and alternative destination IP address(es) are known, the MME reattempts initialization to an alternative IP address. + +For SCTP endpoint redundancy, an SCTP endpoint (in the MME or VLR) may send an INIT, at any time for an already established SCTP association, which the other SCTP endpoint shall handle as defined in IETF RFC 4960 [23]. + +MME and VLR shall support a configuration with a single SCTP association per MME/VLR pair. Configurations with multiple SCTP endpoints per MME/VLR pair may be supported. + +NOTE 2: If multiple SCTP endpoints are configured and several SCTP associations are established between the MME/VLR pair, whether the VLR and the MME send and receive SGsAP messages via same or different SCTP associations for a given UE is up to implementation. + +Within the SCTP association established between one MME and one VLR, both MME and VLR shall reserve several stream identifiers, based on the INIT message exchange for the sole use of SGsAP procedures. + +The registered port number for SGsAP is 29118. + +The payload protocol identifier to be used for SGsAP is 0. + +# --- 7 Error handling + +## 7.1 General + +This subclause specifies procedures for the handling of unknown, unforeseen, and erroneous protocol data by the receiving entity (i.e. the MME or the VLR). These procedures are called "error handling procedures", but in addition to providing recovery mechanisms for error situations, they define a compatibility mechanism for future extensions of the protocol. + +In this subclause, the following terminology is used: + +- an information element is defined to be syntactically incorrect in a message if it contains at least one value defined as "reserved", or if its value part violates coding rules. However, it is not a syntactical error that an information element indicates in its Length Indicator a greater length than defined in the relevant subclause; and +- a message is defined to have semantically incorrect contents if it contains information which, possibly dependant on the state of the receiver, is in contradiction to the resources of the receiver and/or to the procedural part of current specification. + +When a receiving entity detects the need to send an SGsAP-STATUS message (see errors detailed below), the entity shall copy the IMSI information element value (if included) of the incorrect message to the IMSI information element of the SGsAP-STATUS message. The message in error is also included in the SGsAP-STATUS message. Both the receiving and the sending entity shall abandon the procedure related to the incorrect message and return to the state from where the procedure related to the incorrect message was started. + +An SGsAP-STATUS message shall not be sent in response to a received SGsAP-STATUS message. + +Both the receiving and the sending entity shall inform the O&M entity upon sending or receiving an SGsAP-STATUS message. + +The next subclauses shall be applied in order of precedence. + +## 7.2 Message too short + +When the receiving entity receives a message that is too short to contain a complete message type information element, the receiving entity shall ignore that message. + +## 7.3 Unknown or unforeseen message type + +The entity receiving a message with a message type not defined or not implemented shall ignore the message. The receiving entity shall return an SGsAP-STATUS message with the SGs cause information element set to "message unknown" and the Erroneous message information element containing the received message. + +The entity receiving a message that is not compatible with the protocol state shall return an SGsAP-STATUS message with the SGs cause information element set to "message not compatible with the protocol state" and the erroneous message. + +The entity receiving a message that is not defined to be received by that entity (i.e. the message is sent in the wrong direction) shall treat the message as unknown message and shall ignore the message. The entity shall return an SGsAP-STATUS message with the SGs cause information element set to "message unknown" and the Erroneous message information element containing the received message. + +## 7.4 Missing mandatory information element + +When the receiving entity diagnoses a "missing mandatory information element" error, the receiving entity shall ignore the message and return an SGsAP-STATUS message with the SGs cause information element set to "missing mandatory information element" and shall return the Erroneous message information element containing the received message. + +## 7.5 Information elements unknown or unforeseen in the message + +The receiving entity shall ignore all information elements unknown or unforeseen in a message. + +## 7.6 Out of sequence information elements + +The receiving entity shall ignore all information elements that are out of sequence. + +## 7.7 Repeated information elements + +If an information element with format T, TV, or TLV is repeated in a message in which repetition of the information element is not specified, the receiving entity shall only handle the contents of the information element appearing first and shall ignore all subsequent repetitions of the information element. When repetition of information elements is specified, the receiving entity shall only handle the contents of specified repeated information elements. If the limit on repetition of information elements is exceeded, the receiving entity shall handle the contents of information elements appearing first up to the limit of repetitions and shall ignore all subsequent repetitions of the information element. + +## 7.8 Syntactically incorrect mandatory information element. + +On receipt of a message which contains a syntactically incorrect mandatory information element, the receiver shall ignore the message and return an SGsAP-STATUS message with the SGs cause information element set to "invalid mandatory information" and shall return the Erroneous message information element containing the received message. + +## 7.9 Syntactically incorrect optional information elements + +The receiving entity shall treat all optional information elements that are syntactically incorrect in a message as not present in the message. + +## 7.10 Conditional information element errors + +When the entity receiving a message diagnoses a "missing conditional information element" error or an "unexpected conditional information element" error or when it receives a message containing at least one syntactically incorrect conditional information element which is required to be present in the message, the receiving entity shall ignore the message and return an SGsAP-STATUS message with the SGs cause information element set to "conditional information element error" and shall return the Erroneous message information element containing the received message. + +When the entity receives a message containing a syntactically incorrect conditional information element which is not required to be present in the message, nor required to be absent in the message, then the receiving entity shall ignore that information element. + +## 7.11 Information elements with semantically incorrect contents + +When an information element with semantically incorrect contents is received, the foreseen reactions of the procedural part of the present specification are performed. + +If however no such reactions are specified, the receiving entity shall ignore that information element and treat the rest of the message. If, because this information element was ignored, the rest of the message can no longer be handled then the receiving entity shall return an SGsAP-STATUS message with the SGs cause information element set to "semantically incorrect message" and shall return the Erroneous message information element containing the received message. + +# 8 Message functional definitions and contents + +## 8.1 SGsAP-ALERT-ACK message + +This message is sent by the MME to the VLR to acknowledge a previous SGsAP-ALERT-REQUEST message. Table 8.1.1 shows the content of the SGsAP-ALERT-ACK message. + +**Table 8.1.1: SGsAP-ALERT-ACK message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.2 SGsAP-ALERT-REJECT message + +This message is sent from the MME to the VLR to indicate that the MME could not identify the IMSI indicated in the SGsAP-ALERT-REQUEST message. Table 8.2.1 shows the content of the SGsAP-ALERT-REJECT message. + +**Table 8.2.1: SGsAP-ALERT-REJECT message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| SGs Cause | SGs cause
9.4.18 | M | TLV | 3 | + +## 8.3 SGsAP-ALERT-REQUEST message + +This message is sent by the VLR to the MME to request an indication when the next activity of a UE is detected. Table 8.3.1 shows the content of the SGsAP-ALERT-REQUEST message. + +**Table 8.3.1: SGsAP-ALERT-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.4 SGsAP-DOWNLINK-UNITDATA message + +This message is sent from the VLR to the MME to transparently relay a NAS message, from the VLR, to the UE. Table 8.4.1 shows the content of the SGsAP-DOWNLINK-UNITDATA message. + +**Table 8.4.1: SGsAP-DOWNLINK-UNITDATA message content** + +| Information element | Type/Reference | Presence | Format | Length | +|-----------------------|---------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| NAS message container | NAS message container
9.4.15 | M | TLV | 4-253 | + +## 8.5 SGsAP-EPS-DETACH-ACK message + +This message is sent by the VLR to the MME to acknowledge a previous SGsAP-EPS-DETACH-INDICATION message. Table 8.5.1 shows the content of the SGsAP-EPS-DETACH-ACK message. + +**Table 8.5.1: SGsAP-EPS-DETACH-ACK message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.6 SGsAP-EPS-DETACH-INDICATION message + +This message is sent by the MME to the VLR to indicate an EPS detach performed from the UE or the MME. The type of detach is indicated in the IMSI detach from EPS service type information element. Table 8.6.1 shows the content of the SGsAP-EPS-DETACH-INDICATION message. + +**Table 8.6.1: SGsAP-EPS-DETACH-INDICATION message content** + +| Information element | Type/Reference | Presence | Format | Length | +|-----------------------------------|--------------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| MME name | MME name
9.4.13 | M | TLV | 57 | +| IMSI detach from EPS service type | IMSI detach from EPS service type
9.4.7 | M | TLV | 3 | + +## 8.7 SGsAP-IMSI-DETACH-ACK message + +This message is sent by the VLR to the MME to acknowledge a previous SGsAP-IMSI-DETACH-INDICATION message. Table 8.7.1 shows the content of the SGsAP-IMSI-DETACH-ACK message. + +**Table 8.7.1: SGsAP-IMSI-DETACH-ACK message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.8 SGsAP-IMSI-DETACH-INDICATION message + +This message is sent by the MME to the VLR to indicate an IMSI detach performed from the UE or the MME. The type of detach is indicated in the IMSI detach from non-EPS service type information element. Table 8.8.1 shows the content of the SGsAP-IMSI-DETACH-INDICATION message. + +**Table 8.8.1: SGsAP-IMSI-DETACH-INDICATION message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------------------------|------------------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| MME name | MME name
9.4.13 | M | TLV | 57 | +| IMSI Detach from non-EPS service type | IMSI detach from non-EPS service type
9.4.8 | M | TLV | 3 | + +## 8.9 SGsAP-LOCATION-UPDATE-ACCEPT message + +### 8.9.1 Message definition + +This message is sent by the VLR to the MME to indicate that update or IMSI attach in the VLR has been completed. Table 8.9.1.1 shows the content of the SGsAP-LOCATION-UPDATE-ACCEPT message. + +**Table 8.9.1.1: SGsAP-LOCATION-UPDATE-ACCEPT message content** + +| Information element | Type/Reference | Presence | Format | Length | +|--------------------------|------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| Location area identifier | Location area identifier
9.4.11 | M | TLV | 7 | +| New TMSI, or IMSI | Mobile identity
9.4.14 | O | TLV | 6-10 | + +### 8.9.2 New TMSI, or IMSI + +This information element represents the identity to be used for (and then by) the UE. + +If this information element is an IMSI, then the UE is not allocated any TMSI (and deletes any TMSI accordingly). If this information element is a TMSI, then the UE will use this TMSI as the new temporary identity (the UE deletes its + +old TMSI if available, and stores the new TMSI). If neither a TMSI nor an IMSI are included in this information element, the old TMSI, if any available, will be kept. + +## 8.10 SGsAP-LOCATION-UPDATE-REJECT message + +### 8.10.1 Message definition + +This message is sent by the VLR to the MME to indicate that location update or IMSI attach has failed. Table 8.10.1 shows the content of the SGsAP-LOCATION-UPDATE-REJECT message. + +**Table 8.10.1: SGsAP-LOCATION-UPDATE-REJECT message content** + +| Information element | Type/Reference | Presence | Format | Length | +|--------------------------|------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| Reject cause | Reject cause
9.4.16 | M | TLV | 3 | +| Location area identifier | Location area identifier
9.4.11 | O | TLV | 7 | + +### 8.10.2 Location area identifier + +The VLR shall include this information element. + +## 8.11 SGsAP-LOCATION-UPDATE-REQUEST message + +### 8.11.1 Message definition + +This message is sent by the MME to the VLR either to request update of its location file (normal update) or to request IMSI attach. Table 8.11.1.1 shows the content of the SGsAP-LOCATION-UPDATE-REQUEST message. + +**Table 8.11.1.1: SGsAP-LOCATION-UPDATE-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|------------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| MME name | MME name
9.4.13 | M | TLV | 57 | +| EPS location update type | EPS location update type
9.4.2 | M | TLV | 3 | +| New location area identifier | Location area identifier
9.4.11 | M | TLV | 7 | +| Old location area identifier | Location area identifier
9.4.11 | O | TLV | 7 | +| TMSI status | TMSI status
9.4.21 | O | TLV | 3 | +| IMEISV | IMEISV
9.4.5 | O | TLV | 10 | +| TAI | Tracking Area Identity
9.4.21a | O | TLV | 7 | +| E-CGI | E-UTRAN Cell Global Identity
9.4.3a | O | TLV | 9 | +| TMSI based NRI container | TMSI based NRI container
9.4.26 | O | TLV | 4 | +| Selected CS domain operator | Selected CS domain operator
9.4.27 | O | TLV | 5 | + +### 8.11.2 Old location area identifier + +The MME shall include this information element if the UE included the old location area information in the ATTACH REQUEST or TRACKING AREA UPDATE REQUEST message. + +### 8.11.3 TMSI status + +The MME shall include this information element if the TMSI status received in the ATTACH REQUEST or TRACKING AREA UPDATING REQUEST message from the UE indicates that no valid TMSI is available in the UE. + +### 8.11.4 IMEISV + +The MME shall include this information element if the IMEISV is available in the MME. + +### 8.11.5 TAI + +If the TAI is available in the MME, the MME shall include this information element. + +### 8.11.6 E-CGI + +If the E-CGI is available in the MME, the MME shall include this information element. + +### 8.11.7 TMSI based NRI container + +This information element shall be included if the TMSI based NRI container has been received in the ATTACH REQUEST or TRACKING AREA UPDATING REQUEST message from the UE. + +### 8.11.8 Selected CS domain operator + +This information element shall be included if the network is configured to support gateway core network (GWCN) for CS domain, the preferred RAT of the selected PLMN for CS fallback is GERAN, and the UE does not support GERAN network sharing. + +## 8.12 SGsAP-MM-INFORMATION-REQUEST + +This message is sent by the VLR to the MME to provide the UE with subscriber specific information. Table 8.12.1 shows the content of the SGsAP-MM-INFORMATION-REQUEST message. + +**Table 8.12.1: SGsAP-MM-INFORMATION-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|--------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| MM information | MM information
9.4.12 | M | TLV | 3-n | + +## 8.13 SGsAP-PAGING-REJECT message + +This message is sent from the MME to the VLR to indicate that the delivery of a previous SGsAP-PAGING-REQUEST message has failed. Table 8.13.1 shows the content of the SGsAP-PAGING-REJECT message. + +**Table 8.13.1: SGsAP-PAGING-REJECT message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| SGs Cause | SGs Cause
9.4.18 | M | TLV | 3 | + +## 8.14 SGsAP-PAGING-REQUEST message + +### 8.14.1 Message definition + +This message is sent from the VLR to the MME and contains sufficient information to allow the paging message to be transmitted by the correct cells at the correct time. Table 8.14.1.1 shows the content of the SGsAP-PAGING-REQUEST message. + +Table 8.14.1.1: SGsAP-PAGING-REQUEST message content + +| Information element | Type/Reference | Presence | Format | Length | +|------------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| VLR name | VLR name
9.4.22 | M | TLV | 3-n | +| Service indicator | Service indicator
9.4.17 | M | TLV | 3 | +| TMSI | TMSI
9.4.20 | O | TLV | 6 | +| CLI | CLI
9.4.1 | O | TLV | 3-14 | +| Location area identifier | Location area identifier
9.4.11 | O | TLV | 7 | +| Global CN-Id | Global CN-Id
9.4.4 | O | TLV | 7 | +| SS code | SS code
9.4.19 | O | TLV | 3 | +| LCS indicator | LCS indicator
9.4.10 | O | TLV | 3 | +| LCS client identity | LCS client identity
9.4.9 | O | TLV | 3-n | +| Channel needed | Channel needed
9.4.23 | O | TLV | 3 | +| eMLPP Priority | eMLPP Priority
9.4.24 | O | TLV | 3 | +| Additional paging indicators | Additional paging indicators
9.4.25 | O | TLV | 3 | +| SM Delivery Timer | SM Delivery Timer
9.4.29 | O | TLV | 4 | +| SM Delivery Start Time | SM Delivery Start Time
9.4.30 | O | TLV | 6 | +| Maximum Retransmission Time | Maximum Retransmission Time
9.4.32 | O | TLV | 6 | + +## 8.14.2 TMSI + +This element is omitted in the exceptional case where paging with IMSI is performed. + +## 8.14.3 CLI + +If the Calling Line Identification is available in the VLR, the VLR shall include this information element. + +## 8.14.4 Location area identifier + +The VLR shall include this information element if the "Confirmed by Radio Contact" restoration indicator is set to "true". + +## 8.14.5 Global CN-Id + +If the network supports the Intra Domain Connection of RAN Nodes to multiple CN Nodes functionality, the VLR shall include this information element when the VLR initiates paging by IMSI, via the SGs interface. + +## 8.14.6 SS code + +The VLR may include this information element if paging is due to a NW-initiated Call Independent SS procedure (see 3GPP TS 24.010 [9]). + +### 8.14.7 LCS indicator + +The VLR shall include this information element if the paging is due to a Mobile Terminated Location Request (see 3GPP TS 24.030 [11]). + +### 8.14.8 LCS client identity + +The VLR may include this information element if the paging is due to a Mobile Terminated Location Request (see 3GPP TS 24.030 [11]). If the paging is due to emergency positioning, then VLR should include this information element. + +### 8.14.9 Channel needed + +This information element shall be included if the VLR intends to indicate which channel the UE should use. + +### 8.14.10 eMLPP priority + +This information element shall be included if the VLR supports CSFB priority call handling and the call was received with eMLPP priority level indication. + +The eMLPP priority IE may be used to determine the required priority of a SCTP association for the associated SGsAP message. + +### 8.14.11 Additional paging indicators + +This information element shall be included if additional paging information e.g. CS restoration indicator needs to be passed to the MME. + +### 8.14.12 SM Delivery Timer + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the Service Indicator IE indicates "SMS indicator" and the SM Delivery Timer and SM Delivery Start Time IEs were received from the SMS-GMSC as defined in 3GPP TS 24.010 [9]. + +### 8.14.13 SM Delivery Start Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the Service Indicator IE indicates "SMS indicator" and the SM Delivery Timer and SM Delivery Start Time IEs were received from the SMS-GMSC as defined in 3GPP TS 24.010 [9]. + +### 8.14.4 Maximum Retransmission Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the Service Indicator IE indicates "SMS indicator" and if the Maximum Retransmission Time IE was received from the SMS-GMSC as defined in 3GPP TS 29.002 [15]. + +## 8.15 SGsAP-RESET-ACK message + +### 8.15.1 Message definition + +This message is sent from the MME or the VLR to acknowledge a previous SGsAP-RESET-INDICATION message. This message indicates that all the SGs associations to the VLR or the MME have been marked as invalid. + +The sending entity (either the MME or the VLR) includes its identity in the form of a name in the SGsAP-RESET-ACK message. Table 8.15.1.1 shows the content of the SGsAP-RESET-ACK message. + +**Table 8.15.1.1: SGsAP-RESET-ACK message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| MME name | MME name
9.4.13 | C | TLV | 57 | +| VLR name | VLR name
9.4.22 | C | TLV | 3-n | + +## 8.15.2 MME name + +If the MME is the sending entity, then the MME shall indicate its identity by including its MME name information element. Otherwise (i.e. if the VLR is the sending entity), then the VLR shall not include the MME name information element. + +## 8.15.3 VLR name + +If the VLR is the sending entity, then the VLR shall indicate its identity by including its VLR name information element. Otherwise (i.e. if the MME is the sending entity), then MME shall not include the VLR name information element. + +# 8.16 SGsAP-RESET-INDICATION message + +## 8.16.1 Message definition + +This message is sent from the VLR to the MME to indicate that a failure in the VLR has occurred and all the SGs associations to the VLR are to be marked as invalid. + +This message is also sent from the MME to the VLR to indicate that a failure in the MME has occurred and all the SGs associations to the MME are to be marked as invalid. + +The sending entity (either the MME or the VLR) includes its identity in the SGsAP-RESET-INDICATION message. Table 8.16.1.1 shows the content of the SGsAP-RESET-INDICATION message. + +**Table 8.16.1.1: SGsAP-RESET-INDICATION message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| MME name | MME name
9.4.13 | C | TLV | 57 | +| VLR name | VLR name
9.4.22 | C | TLV | 3-n | + +## 8.16.2 MME name + +If the MME is the sending entity, then the MME shall indicate its identity by including its MME name information element. Otherwise (i.e. if the VLR is the sending entity), then the VLR shall not include the MME name information element. + +## 8.16.3 VLR name + +If the VLR is the sending entity, then the VLR shall indicate its identity by including its VLR name information element. Otherwise (i.e. if the MME is the sending entity), then the MME shall not include the VLR name information element. + +## 8.17 SGsAP-SERVICE-REQUEST message + +### 8.17.1 Message definition + +This message is sent from the MME to the VLR as a response to a previously received SGsAP-PAGING-REQUEST message to indicate the existence of a NAS signalling connection between the UE and the MME or to indicate to the VLR that the NAS signalling connection has been established after the paging procedure. Table 8.17.1 shows the content of the SGsAP-SERVICE-REQUEST message. + +**Table 8.17.1: SGsAP-SERVICE-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|----------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| Service indicator | Service indicator
9.4.17 | M | TLV | 3 | +| IMEISV | IMEISV
9.4.5 | O | TLV | 10 | +| UE Time Zone | UE Time Zone
9.4.21b | O | TLV | 3 | +| Mobile Station Classmark 2 | Mobile Station Classmark 2
9.4.14a | O | TLV | 5 | +| TAI | Tracking Area Identity
9.4.21a | O | TLV | 7 | +| E-CGI | E-UTRAN Cell Global Identity
9.4.3a | O | TLV | 9 | +| UE EMM Mode | UE EMM mode
9.4.21c | O | TLV | 3 | + +### 8.17.2 IMEISV + +If the IMEISV is available in the MME, the MME shall include this information element. + +### 8.17.3 UE Time Zone + +If the UE Time Zone is available in the MME, the MME shall include this information element. + +### 8.17.4 Mobile Station Classmark 2 + +If the Mobile Station Classmark 2 is available in the MME, the MME shall include this information element. + +### 8.17.5 TAI + +If the TAI is available in the MME, the MME shall include this information element. + +### 8.17.6 E-CGI + +If the E-CGI is available in the MME, the MME shall include this information element. + +### 8.17.7 UE EMM Mode + +The MME shall include this information element. This information element indicates the EMM mode of the UE when the SGsAP-PAGING-REQUEST message was received by the MME. + +## 8.18 SGsAP-STATUS message + +### 8.18.1 Message definition + +This message is sent by both the VLR and the MME to indicate an error. The contents of SGsAP-STATUS message are shown in table 8.18.1.1. + +**Table 8.18.1.1: SGsAP-STATUS message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|----------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | O | TLV | 6-10 | +| SGs cause | SGs cause
9.4.18 | M | TLV | 3 | +| Erroneous message | Erroneous message
9.4.3 | M | TLV | 3-n | + +### 8.18.2 IMSI + +The MME shall include this information element if the IMSI is present in the erroneous message. + +## 8.19 SGsAP-TMSI-REALLOCATION-COMPLETE message + +This message is sent by the MME to the VLR to indicate that TMSI reallocation on the UE has been successfully completed. Table 8.19.1 shows the content of the SGsAP-TMSI-REALLOCATION-COMPLETE message. + +**Table 8.19.1: SGsAP-TMSI-REALLOCATION-COMPLETE message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.20 SGsAP-UE-ACTIVITY-INDICATION message + +This message is sent by the MME to the VLR to indicate that activity from a UE has been detected. Table 8.20.1 shows the content of the SGsAP-UE-ACTIVITY-INDICATION message. + +**Table 8.20.1: SGsAP-UE-ACTIVITY-INDICATION message content** + +| Information element | Type/Reference | Presence | Format | Length | +|------------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| Maximum UE Availability Time | Maximum UE Availability Time
9.4.28 | O | TLV | 6 | + +### 8.20.1 Maximum UE Availability Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the MME may include this information element to indicate the time until the UE is available. + +## 8.21 SGsAP-UE-UNREACHABLE message + +This message is sent from the MME to the VLR to indicate that, for example, paging could not be performed because the UE is marked as unreachable at the MME. Table 8.21.1 shows the content of the SGsAP-UE-UNREACHABLE message. + +**Table 8.21.1: SGsAP-UE-UNREACHABLE message content** + +| Information element | Type/Reference | Presence | Format | Length | +|--------------------------------------|------------------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| SGs cause | SGs cause
9.4.18 | M | TLV | 3 | +| Requested Retransmission Time | Requested Retransmission Time
9.4.33 | O | TLV | 6 | +| Additional UE Unreachable indicators | Additional UE Unreachable indicators
9.4.31 | O | TLV | 3 | + +### 8.21.1 Requested Retransmission Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the SGsAP-PAGING-REQUEST message included the Maximum Retransmission Time IE. + +### 8.21.2 Additional UE Unreachable indicators + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this information element may be included if the SGsAP-PAGING-REQUEST message includes the SM Delivery Timer and SM Delivery Start Time IEs and the UE is expected to be reachable before the time indicated by the SM Delivery Timer and SM Delivery Start Time IEs received in the SGsAP-PAGING-REQUEST message. + +## 8.22 SGsAP-UPLINK-UNITDATA message + +### 8.22.1 Message definition + +This message is sent from the MME to the VLR to transparently convey a NAS message, from the UE, to the VLR. Table 8.22.1 shows the content of the SGsAP-UPLINK-UNITDATA message. + +**Table 8.22.1: SGsAP-UPLINK-UNITDATA message content** + +| Information element | Type/Reference | Presence | Format | Length | +|----------------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| NAS message container | NAS message container
9.4.15 | M | TLV | 4-253 | +| IMEISV | IMEISV
9.4.5 | O | TLV | 10 | +| UE Time Zone | UE Time Zone
9.4.21b | O | TLV | 3 | +| Mobile Station Classmark 2 | Mobile Station Classmark 2
9.4.14a | O | TLV | 5 | +| TAI | Tracking Area Identity
9.4.21a | O | TLV | 7 | +| E-CGI | E-UTRAN Cell Global Identity
9.4.3a | O | TLV | 9 | + +## 8.22.2 IMEISV + +If the IMEISV is available in the MME, the MME shall include this information element. + +## 8.22.3 UE Time Zone + +If the UE Time Zone is available in the MME, the MME shall include this information element. + +## 8.22.4 Mobile Station Classmark 2 + +If the Mobile Station Classmark 2 is available in the MME, the MME shall include this information element. + +## 8.22.5 TAI + +If the TAI is available in the MME, the MME shall include this information element. + +## 8.22.6 E-CGI + +If the E-CGI is available in the MME, the MME shall include this information element. + +# 8.23 SGsAP-RELEASE-REQUEST message + +## 8.23.1 Message definition + +This message is sent by the VLR to the MME when the VLR determines that there are no more NAS messages to be exchanged between the VLR and the UE, or when a further exchange of NAS messages for the specified UE is not possible due to an error. Table 8.23.1 shows the content of the SGsAP-RELEASE-REQUEST message. + +**Table 8.23.1: SGsAP-RELEASE-REQUEST message content** + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| SGs cause | SGs cause
9.4.18 | O | TLV | 3 | + +## 8.23.2 SGs Cause + +The VLR shall include the SGs Cause to indicate an error. + +# 8.24 SGsAP-SERVICE-ABORT-REQUEST message + +## 8.24.1 Message definition + +This message is sent from the VLR to the MME to abort a mobile terminating CS fallback call during call establishment. Table 8.24.1.1 shows the content of the SGsAP-SERVICE-ABORT-REQUEST message. + +Table 8.24.1.1: SGsAP-SERVICE-ABORT-REQUEST message content + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|---------------------|----------|--------|--------| +| Message type | Message type
9.2 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | + +## 8.25 SGsAP-MO-CSFB-INDICATION message + +### 8.25.1 Message definition + +If the network is configured to support the return to the last used E-UTRAN PLMN after CS fallback, this message is sent from the MME to the VLR to indicate to the VLR that the UE initiated a service request for MO CS fallback. Table 8.25.1 shows the content of the SGsAP-MO-CSFB-INDICATION message. + +Table 8.25.1: SGsAP-MO-CSFB-INDICATION message content + +| Information element | Type/Reference | Presence | Format | Length | +|---------------------|----------------------------------------|----------|--------|--------| +| Message type | Message type
9.1 | M | V | 1 | +| IMSI | IMSI
9.4.6 | M | TLV | 6-10 | +| TAI | Tracking Area Identity
9.4.21a | O | TLV | 7 | +| E-CGI | E-UTRAN Cell Global Identity
9.4.3a | O | TLV | 9 | + +### 8.25.2 TAI + +If the TAI is available in the MME, the MME shall include this information element. + +### 8.25.3 E-CGI + +If the E-CGI is available in the MME, the MME shall include this information element. + +## 9 Information element coding + +### 9.1 Overview + +This clause specifies the coding of the information elements used in by the SGsAP protocol. + +The spare bits in the coding of an information element shall be set to zero by the sender and shall be ignored by the receiver. + +All unassigned codes (whether omitted or explicitly *Unassigned* in the text) shall be treated as unknown (see clause 7). + +## 9.2 Message type + +Message type uniquely identifies the message being sent. It is a single octet information element, mandatory in all messages. Table 9.2.1 defines the value part of the Message type information element. + +**Table 9.2.1: Message type information element** + +| 8 7 6 5 4 3 2 1 | Message type | Reference | +|------------------------------------------|------------------------------------------------|-----------| +| 0 0 0 0 0 0 0 0 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 0 0 0 0 1 | SGsAP-PAGING-REQUEST | 8.14 | +| 0 0 0 0 0 0 1 0 | SGsAP-PAGING-REJECT | 8.13 | +| 0 0 0 0 0 0 1 1
to
0 0 0 0 0 1 0 1 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 0 0 1 1 0 | SGsAP-SERVICE-REQUEST | 8.17 | +| 0 0 0 0 0 1 1 1 | SGsAP-DOWNLINK-UNITDATA | 8.4 | +| 0 0 0 0 1 0 0 0 | SGsAP-UPLINK-UNITDATA | 8.22 | +| 0 0 0 0 1 0 0 1 | SGsAP-LOCATION-UPDATE-REQUEST | 8.11 | +| 0 0 0 0 1 0 1 0 | SGsAP-LOCATION-UPDATE-ACCEPT | 8.9 | +| 0 0 0 0 1 0 1 1 | SGsAP-LOCATION-UPDATE-REJECT | 8.10 | +| 0 0 0 0 1 1 0 0 | SGsAP-TMSI-REALLOCATION-COMPLETE | 8.19 | +| 0 0 0 0 1 1 0 1 | SGsAP-ALERT-REQUEST | 8.3 | +| 0 0 0 0 1 1 1 0 | SGsAP-ALERT-ACK | 8.1 | +| 0 0 0 0 1 1 1 1 | SGsAP-ALERT-REJECT | 8.2 | +| 0 0 0 1 0 0 0 0 | SGsAP-UE-ACTIVITY-INDICATION | 8.20 | +| 0 0 0 1 0 0 0 1 | SGsAP-EPS-DETACH-INDICATION | 8.6 | +| 0 0 0 1 0 0 1 0 | SGsAP-EPS-DETACH-ACK | 8.5 | +| 0 0 0 1 0 0 1 1 | SGsAP-IMSI-DETACH-INDICATION | 8.8 | +| 0 0 0 1 0 1 0 0 | SGsAP-IMSI-DETACH-ACK | 8.7 | +| 0 0 0 1 0 1 0 1 | SGsAP-RESET-INDICATION | 8.16 | +| 0 0 0 1 0 1 1 0 | SGsAP-RESET-ACK | 8.15 | +| 0 0 0 1 0 1 1 1 | SGsAP-SERVICE-ABORT-REQUEST | 8.24 | +| 0 0 0 1 1 0 0 0 | SGsAP-MO-CSFB-INDICATION | 8.25 | +| 0 0 0 1 1 0 0 1
to
0 0 0 1 1 0 0 1 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 1 1 0 1 0 | SGsAP-MM-INFORMATION-REQUEST | 8.12 | +| 0 0 0 1 1 0 1 1 | SGsAP-RELEASE-REQUEST | 8.23 | +| 0 0 0 1 1 1 0 0 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 1 1 1 0 1 | SGsAP-STATUS | 8.18 | +| 0 0 0 1 1 1 1 0 | Unassigned: treated as an unknown Message type | 7 | +| 0 0 0 1 1 1 1 1 | SGsAP-UE-UNREACHABLE | 8.21 | + +## 9.3 Information element identifiers + +The next list shows the coding of the information element identifiers used in the present document. Table 9.3.1 shows the values assigned for the information element identifiers. + +**Table 9.3.1: Information element identifier coding** + +| 8 7 6 5 4 3 2 1 | Information element | Reference | +|-----------------|---------------------------------------|-----------| +| 0 0 0 0 0 0 0 1 | IMSI | 9.4.6 | +| 0 0 0 0 0 0 1 0 | VLR name | 9.4.22 | +| 0 0 0 0 0 0 1 1 | TMSI | 9.4.20 | +| 0 0 0 0 0 1 0 0 | Location area identifier | 9.4.11 | +| 0 0 0 0 0 1 0 1 | Channel Needed | 9.4.23 | +| 0 0 0 0 0 1 1 0 | eMLPP Priority | 9.4.24 | +| 0 0 0 0 0 1 1 1 | TMSI status | 9.4.21 | +| 0 0 0 0 1 0 0 0 | SGs cause | 9.4.18 | +| 0 0 0 0 1 0 0 1 | MME name | 9.4.13 | +| 0 0 0 0 1 0 1 0 | EPS location update type | 9.4.2 | +| 0 0 0 0 1 0 1 1 | Global CN-Id | 9.4.4 | +| 0 0 0 0 1 1 1 0 | Mobile identity | 9.4.14 | +| 0 0 0 0 1 1 1 1 | Reject cause | 9.4.16 | +| 0 0 0 1 0 0 0 0 | IMSI detach from EPS service type | 9.4.7 | +| 0 0 0 1 0 0 0 1 | IMSI detach from non-EPS service type | 9.4.8 | +| 0 0 0 1 0 1 0 1 | IMEISV | 9.4.5 | +| 0 0 0 1 0 1 1 0 | NAS message container | 9.4.15 | +| 0 0 0 1 0 1 1 1 | MM information | 9.4.12 | +| 0 0 0 1 1 0 1 1 | Erroneous message | 9.4.3 | +| 0 0 0 1 1 1 0 0 | CLI | 9.4.1 | +| 0 0 0 1 1 1 0 1 | LCS client identity | 9.4.9 | +| 0 0 0 1 1 1 1 0 | LCS indicator | 9.4.10 | +| 0 0 0 1 1 1 1 1 | SS code | 9.4.19 | +| 0 0 1 0 0 0 0 0 | Service indicator | 9.4.17 | +| 0 0 1 0 0 0 0 1 | UE Time Zone | 9.4.21b | +| 0 0 1 0 0 0 1 0 | Mobile Station Classmark 2 | 9.4.14a | +| 0 0 1 0 0 0 1 1 | Tracking Area Identity | 9.4.21a | +| 0 0 1 0 0 1 0 0 | E-UTRAN Cell Global Identity | 9.4.3a | +| 0 0 1 0 0 1 0 1 | UE EMM mode | 9.4.21c | +| 0 0 1 0 0 1 1 0 | Additional paging indicators | 9.4.25 | +| 0 0 1 0 0 1 1 1 | TMSI based NRI container | 9.4.26 | +| 0 0 1 0 1 0 0 0 | Selected CS domain operator | 9.4.27 | +| 0 0 1 0 1 0 0 1 | Maximum UE Availability Time | 9.4.28 | +| 0 0 1 0 1 0 1 0 | SM Delivery Timer | 9.4.29 | +| 0 0 1 0 1 0 1 1 | SM Delivery Start Time | 9.4.30 | +| 0 0 1 0 1 1 0 0 | Additional UE Unreachable indicators | 9.4.31 | +| 0 0 1 0 1 1 0 1 | Maximum Retransmission Time | 9.4.32 | +| 0 0 1 0 1 1 1 0 | Requested Retransmission Time | 9.4.33 | + +### 9.3a Length indicator + +The length indicator of the information elements consists of one octet and contains the binary encoding of the number of octets of the value part in the information elements. + +## 9.4 Information elements + +### 9.4.1 CLI + +This information element is used to represent calling line identification for the terminating call received in the CS domain. The CLI information element is coded as shown in figure 9.4.1.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
To
Octet 14 | Octets 3 to 14 contain the value part of the Calling party BCD number information element defined in subclause 10.5.4.9 of 3GPP TS 24.008 [8] (octets 3 to 14, i.e. not including 3GPP TS 24.008 IEI and 3GPP TS 24.008 length indicator) | | | | | | | | + +Figure 9.4.1.1: Calling Line Identification information element + +## 9.4.2 EPS location update type + +The purpose of the EPS location update type information element is to indicate to the VLR whether an IMSI attach or a normal location update has been performed by the UE. The EPS location update type information element is coded as shown in figure 9.4.2.1 and table 9.4.2.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|--------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | EPS location update type value | | | | | | | | + +Figure 9.4.2.1: EPS location update type information element + +Table 9.4.2.1: EPS location update type information element value part + +| EPS location update type value (octet 3) | | +|------------------------------------------|------------------------------------------------------------------------------------------------| +| Bits | | +| 8 | 7 6 5 4 3 2 1 | +| 0 0 0 0 0 0 0 0 | Shall not be sent in this version of the protocol. If received, shall be treated as '00000010' | +| 0 0 0 0 0 0 0 1 | IMSI attach | +| 0 0 0 0 0 0 1 0 | Normal location update | +| 0 0 0 0 0 0 1 1 | to | +| 1 1 1 1 1 1 1 1 | Shall not be sent in this version of the protocol. If received, shall be treated as '00000010' | + +## 9.4.3 Erroneous message + +See subclause 18.4.5 in 3GPP TS 29.018 [16]. + +### 9.4.3a E-UTRAN Cell Global Identity + +The E-UTRAN Cell Global Identity information element indicates the UE's current E-UTRAN Cell Global Identity. The E-UTRAN Cell Global Identity information element is coded as shown in figure 9.4.3a.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|--------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
- | The coding of the E-UTRAN Cell Global Identity value is according to ECGI field information element as specified in subclause 8.21.5 of 3GPP TS 29.274 [17A] | | | | | | | | +| Octet 9 | | | | | | | | | + +Figure 9.4.3a.1: E-UTRAN Cell Global Identity information element + +### 9.4.4 Global CN-Id + +See subclause 18.4.27 in 3GPP TS 29.018 [16]. + +### 9.4.5 IMEISV + +See subclause 18.4.9 in 3GPP TS 29.018 [16]. + +### 9.4.6 IMSI + +See subclause 18.4.10 in 3GPP TS 29.018 [16]. + +### 9.4.7 IMSI detach from EPS service type + +The IMSI detach from EPS service type information element indicates from MME to VLR the particular type of IMSI detach from EPS. The IMSI detach from EPS service type information element is coded as shown in figure 9.4.7.1 and table 9.4.7.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|-----------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | IMSI detach from EPS service type value | | | | | | | | + +Figure 9.4.7.1: IMSI detach from EPS service type information element + +Table 9.4.7.1: IMSI detach from EPS service type information element value + +| | | +|---------------------------------------------------|---------------------------------------------------------| +| IMSI detach from EPS service type value (octet 3) | | +| Bits | | +| 8 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 0 | Interpreted as reserved in this version of the protocol | +| 0 0 0 0 0 0 0 1 | Network initiated IMSI detach from EPS services | +| 0 0 0 0 0 0 1 0 | UE initiated IMSI detach from EPS services | +| 0 0 0 0 0 0 1 1 | EPS services not allowed | +| 0 0 0 0 0 1 0 0 | Interpreted as reserved in this version of the protocol | +| to | | +| 1 1 1 1 1 1 1 1 | | + +### 9.4.8 IMSI detach from non-EPS service type + +The IMSI detach from non-EPS service type information element indicates from MME to VLR the particular type of IMSI detach from non-EPS. The IMSI detach from non-EPS service type information element is coded as shown in figure 9.4.8.1 and table 9.4.8.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|---------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | IMSI detach from non-EPS service type value | | | | | | | | + +Figure 9.4.8.1: IMSI detach from non-EPS service type information element + +**Table 9.4.8.1: IMSI detach from non-EPS service type information element value** + +| | | +|-------------------------------------------------------|----------------------------------------------------------------------| +| IMSI detach from non-EPS service type value (octet 3) | | +| Bits | | +| 8 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 0 | Interpreted as reserved in this version of the protocol | +| 0 0 0 0 0 0 0 1 | Explicit UE initiated IMSI detach from non-EPS services | +| 0 0 0 0 0 1 0 | Combined UE initiated IMSI detach from EPS and non-EPS services | +| 0 0 0 0 0 1 1 | Implicit network initiated IMSI detach from EPS and non-EPS services | +| 0 0 0 0 1 0 0 | Interpreted as reserved in this version of the protocol | +| to | | +| 1 1 1 1 1 1 1 | | + +## 9.4.9 LCS client identity + +The LCS client identity information element is a compound parameter and comprises information related to the client of a LCS request. The LCS client identity information element is coded as shown in figure 9.4.9.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet n | The coding of the LCS client identity value is according to LCS-ClientID as specified in subclause 17.7.13 of 3GPP TS 29.002 [15] | | | | | | | | + +**Figure 9.4.9.1: LCS client identity information element** + +## 9.4.10 LCS indicator + +The LCS indicator information element indicates that the origin of the message is due to a LCS request and the type of this request. The LCS indicator information element is coded as shown in figure 9.4.10.1 and table 9.4.10.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|---------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | LCS indicator value | | | | | | | | + +**Figure 9.4.10.1: LCS indicator information element****Table 9.4.10.1: LCS indicator value** + +| | | +|-----------------|------------------------------------------------------| +| LCS indicator | | +| Bits | | +| 8 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 0 | Normal, unspecified in this version of the protocol. | +| 0 0 0 0 0 0 0 1 | MT-LR | +| 0 0 0 0 0 1 0 | Normal, unspecified in this version of the protocol | +| to | | +| 1 1 1 1 1 1 1 | | + +## 9.4.11 Location area identifier + +This element uniquely identifies one Location Area. The Location area identifier information element is coded as shown in figure 9.4.11.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length Indicator | | | | | | | | +| Octet 3
-
Octet 7 | Octets 3 to 7 contain the value part of the Location area identification information element defined in 3GPP TS 24.008 [8] (starting with octet 2, i.e. not including 3GPP TS 24.008 IEI) | | | | | | | | + +Figure 9.4.11.1: Location area identifier information element + +## 9.4.12 MM information + +The MM information information element is a TLV information element that encapsulates the user information that the MME forwards to the UE. For the coding see subclause 18.4.16 in 3GPP TS 29.018 [16]. + +## 9.4.13 MME name + +The MME name information element specifies the MME name and is coded as shown in figure 9.4.13.1. Octets 3 through 57 contain MME node FQDN as specified in subclause 19.4.2.4 of 3GPP TS 23.003 [3]. The contents of octets 3 through 57 shall be coded as a fully qualified domain name (FQDN) as specified in subclause 19.4.2.1 of 3GPP TS 23.003 [3]. The value part of the MME name information element (not including IEI and length indicator) shall have a length of 55 octets. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|-----------|-------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length Indicator | | | | | | | | +| Octet 3 | Length field of the 1st label of the MME Name | | | | | | | | +| Octet 4 | Leftmost character of the 1st label of the MME name | | | | | | | | +| Octet 5 | - | | | | | | | | +| Octet m | Length field of the i-th label of the MME Name | | | | | | | | +| Octet m+1 | Leftmost character of the i-th label of the MME name | | | | | | | | +| Octet m+2 | - | | | | | | | | +| - | - | | | | | | | | +| Octet 57 | Rightmost character of the last label of the MME Name | | | | | | | | + +Figure 9.4.13.1: MME name information element + +## 9.4.14 Mobile identity + +See subclause 18.4.17 in 3GPP TS 29.018 [16]. + +### 9.4.14a Mobile Station Classmark 2 + +With the exception of the IEI, the contents are specified in subclause 10.5.1.6 in 3GPP TS 24.008 [8]. + +## 9.4.15 NAS message container + +This information element is used to encapsulate the SMS messages transferred between the VLR and the MME. The NAS message container information element is coded as shown in figure 9.4.15.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------------------|-------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | E | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 253 | Octets 3 to 253 contain the SMS message (i.e. CP-DATA, CP-ACK or CP-ERROR) as defined in subclause 7.2 of 3GPP TS 24.011 [10] | | | | | | | | + +Figure 9.4.15.1: NAS message container information element + +## 9.4.16 Reject cause + +See subclause 18.4.21 in 3GPP TS 29.018 [16]. + +## 9.4.17 Service indicator + +This information element indicates the type of the CS service (e.g. voice call, Short Message Service). The Service indicator information element is coded as shown in figure 9.4.17.1 and table 9.4.17.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|-------------------------|---|---|---|---|---|---|---| +| Octet 1 | E | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | Service indicator value | | | | | | | | + +Figure 9.4.17.1: Service indicator information element + +Table 9.4.17.1: Service indicator value + +| | | +|-------------------|------------------------------------------------------------------------------------------------| +| Service indicator | | +| Bits | | +| 8 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 0 | Shall not be sent in this version of the protocol. If received, shall be treated as '00000001' | +| 0 0 0 0 0 0 0 1 | CS call indicator | +| 0 0 0 0 0 0 1 0 | SMS indicator | +| 0 0 0 0 0 0 1 1 | | +| to | Shall not be sent in this version of the protocol. If received, shall be treated as '00000001' | +| 1 1 1 1 1 1 1 1 | | + +## 9.4.18 SGs cause + +The purpose of the SGs cause information element is to indicate an error to the receiving entity. This could be a protocol data error, to indicate to the VLR the reason why a paging procedure could not be performed or to indicate to the VLR that the mobile terminating CS fallback call has been rejected by the user. The SGs cause information element is coded as shown in figure 9.4.18.1 and table 9.4.18.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|------------------|---|---|---|---|---|---|---| +| Octet 1 | E | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | SGs cause value | | | | | | | | + +Figure 9.4.18.1: SGs cause information element + +Table 9.4.18.1: SGs cause information element value part + +| SGs cause value (octet 3) | | +|---------------------------|----------------------------------------------------------| +| Bits | | +| 8 | 7 6 5 4 3 2 1 | +| 0 0 0 0 0 0 0 0 | Normal, unspecified in this version of the protocol. | +| 0 0 0 0 0 0 0 1 | IMSI detached for EPS services | +| 0 0 0 0 0 0 1 0 | IMSI detached for EPS and non-EPS services | +| 0 0 0 0 0 0 1 1 | IMSI unknown | +| 0 0 0 0 0 1 0 0 | IMSI detached for non-EPS services | +| 0 0 0 0 0 1 0 1 | IMSI implicitly detached for non-EPS services | +| 0 0 0 0 0 1 1 0 | UE unreachable | +| 0 0 0 0 0 1 1 1 | Message not compatible with the protocol state | +| 0 0 0 0 1 0 0 0 | Missing mandatory information element | +| 0 0 0 0 1 0 0 1 | Invalid mandatory information | +| 0 0 0 0 1 0 1 0 | Conditional information element error | +| 0 0 0 0 1 0 1 1 | Semantically incorrect message | +| 0 0 0 0 1 1 0 0 | Message unknown | +| 0 0 0 0 1 1 0 1 | Mobile terminating CS fallback call rejected by the user | +| 0 0 0 0 1 1 1 0 | UE temporarily unreachable | +| 0 0 0 0 1 1 1 1 | to Normal, unspecified in this version of the protocol | +| 1 1 1 1 1 1 1 1 | | + +NOTE: "Normal, unspecified" has the same meaning than in 3GPP TS 24.008 [8], informative Annex H (UMTS specific cause values for call control). It is used to report a normal event, and should not be interpreted as syntactically incorrect nor unknown if received. + +## 9.4.19 SS code + +The SS code information element is used to represent the code identifying a single supplementary service, a group of supplementary services, or all supplementary services. The SS code information element is coded as shown in figure 9.4.19.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|-----------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | The coding of the SS code value is according to SS-Code as specified in subclause 17.7.5 of 3GPP TS 29.002 [15] | | | | | | | | + +Figure 9.4.19.1: SS code information element + +## 9.4.20 TMSI + +See subclause 18.4.23 in 3GPP TS 29.018 [16]. + +## 9.4.21 TMSI status + +See subclause 18.4.24 in 3GPP TS 29.018 [16]. + +## 9.4.21a Tracking Area Identity + +This element uniquely identifies one Tracking Area. The Tracking Area Identity information element is coded as shown in figure 9.4.21a.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
-
Octet 7 | Octets 3 to 7 contain the value part of the Tracking Area Identity information element defined in 3GPP TS 24.301 [14] (starting with octet 2, i.e. not including 3GPP TS 24.301 IEI) | | | | | | | | + +Figure 9.4.21a.1: Tracking Area Identity information element + +## 9.4.21b UE Time Zone + +This element identifies the offset between universal time and local time in steps of 15 minutes. The UE Time Zone information element is coded as shown in figure 9.4.21b.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | The coding of the UE Time Zone value is according to value part of the Time Zone information element as specified in subclause 10.5.3.8 of 3GPP TS 24.008 [8] (i.e. not including 3GPP TS 24.008 IEI) | | | | | | | | + +Figure 9.4.21b.1: UE Time Zone information element + +## 9.4.21c UE EMM mode + +The UE EMM mode information element is used by MME to indicate to the VLR the EMM mode of the UE upon reception of the SGsAP-PAGING-REQUEST message. The UE EMM mode information element is coded as shown in figure 9.4.21c.1 and table 9.4.21c.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|-------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | UE EMM mode value | | | | | | | | + +Figure 9.4.21c.1: UE EMM mode information element + +Table 9.4.21c.1: UE EMM mode value + +| | +|------------------------------------------------------------| +| UE EMM mode value (octet 3) | +| Bits | +| 8 7 6 5 4 3 2 1 | +| 0 0 0 0 0 0 0 0 EMM-IDLE | +| 0 0 0 0 0 0 0 1 EMM-CONNECTED | +| 0 0 0 0 0 0 1 0 | +| to Interpreted as reserved in this version of the protocol | +| 1 1 1 1 1 1 1 1 | + +## 9.4.22 VLR name + +The VLR name information element specifies the VLR name and is coded as shown in figure 9.4.22.1. The contents of octets 3 through n shall be coded as a fully qualified domain name (FQDN) as specified in 3GPP TS 23.003 [3]. + +NOTE: In earlier releases of this specification, the coding of VLR Name was not clear. Implementations based on earlier releases that encode VLR Name as a string with labels separated by dot can exist. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|-----------|-------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length Indicator | | | | | | | | +| Octet 3 | Length field of the 1st label of the VLR Name | | | | | | | | +| Octet 4 | Leftmost character of the 1st label of the VLR name | | | | | | | | +| Octet 5 | - | | | | | | | | +| Octet m | Length field of the i-th label of the VLR Name | | | | | | | | +| Octet m+1 | Leftmost character of the i-th label of the VLR name | | | | | | | | +| Octet m+2 | - | | | | | | | | +| - | | | | | | | | | +| Octet n | Rightmost character of the last label of the VLR Name | | | | | | | | + +Figure 9.4.22.1: VLR name information element + +## 9.4.23 Channel needed + +See subclause 18.4.2 in 3GPP TS 29.018 [16]. + +## 9.4.24 eMLPP priority + +See subclause 18.4.4 in 3GPP TS 29.018 [16]. + +## 9.4.25 Additional paging indicators + +The Additional paging indicators information element provides additional information during the paging procedure. The Additional paging indicators information element is coded as shown in figure 9.4.25.1 and table 9.4.25.1. + +The Additional paging indicators is a type 4 information element with a length of 3 octets. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|------------------|---|---|---|---|---|---|---------------| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | CSRI
Spare | + +Figure 9.4.25.1: Additional paging indicators information element + +Table 9.4.25.1: Additional paging indicators value + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Additional paging indicators value (octet 3, bit 1)
Bits
1
0 CS restoration indicator (CSRI) is not set
1 CS restoration indicator (CSRI) is set | +| Bits 8 to 2 of octet 3 are spare and shall be all coded as zero. | + +## 9.4.26 TMSI based NRI container + +See subclause 18.4.28 in 3GPP TS 29.018 [16]. + +## 9.4.27 Selected CS domain operator + +The selected CS domain operator information element indicates the CS domain operator selected by the MME when CS domain is configured for gateway core network (GWCN), the preferred RAT of the selected PLMN for CS fallback is + +GERAN, and the UE does not support GERAN network sharing. The selected CS domain operator information element is coded as shown in figure 9.4.27.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | Coded as octets 2 to 4 of the Location Area Identification IE, defined in 3GPP TS 24.008 [8] (not including 3GPP TS 24.008 IEI and LAC). | | | | | | | | +| - | | | | | | | | | +| Octet 5 | | | | | | | | | + +Figure 9.4.27.1: Selected CS domain operator information element + +## 9.4.28 Maximum UE Availability Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the Maximum UE Availability Time IE indicates the (UTC) time until which a UE using eDRX is expected to be reachable. The Maximum UE Availability Time IE is coded as shown in figure 9.4.28.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|--------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | Maximum UE Availability Time value, encoded as the Maximum UE Availability Time IE in subclause 12.4.2 of 3GPP TS 29.002 [15]. | | | | | | | | +| to | | | | | | | | | +| Octet 6 | | | | | | | | | +| | | | | | | | | | + +Figure 9.4.28.1: Maximum UE Availability Time information element + +## 9.4.29 SM Delivery Timer + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this IE identifies, together with the SM Delivery Start Time, the time until which the VLR buffers the Short Message. The SM Delivery Timer IE is coded as shown in figure 9.4.29.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|----------------|----------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | SM Delivery Timer value, encoded as the SM Delivery Timer IE in subclause 12.9.2 of 3GPP TS 29.002 [15]. | | | | | | | | +| to | | | | | | | | | +| Octet 4 | | | | | | | | | + +Figure 9.4.29.1: SM Delivery Timer information element + +## 9.4.30 SM Delivery Start Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), this IE identifies, together with the SM Delivery Timer, the time until which the VLR buffers the Short Message. The SM Delivery Timer IE is coded as shown in figure 9.4.30.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|--------------------------|--------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 6 | SM Delivery Start Time value, encoded as the SM Delivery Start Time IE in subclause 12.9.2 of 3GPP TS 29.002 [15]. | | | | | | | | + +Figure 9.4.30.1: SM Delivery Start Time information element + +## 9.4.31 Additional UE Unreachable indicators + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the Additional UE Unreachable indicators information element provides additional information during the paging for non-EPS services procedure. The Additional UE Unreachable indicators information element is coded as shown in figure 9.4.31.1 and table 9.4.31.1. + +The Additional UE Unreachable indicators is a type 4 information element with a length of 3 octets. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|---------|------------------|---|---|---|---|---|---|-------| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | SMBRI | +| | Spare | | | | | | | | + +Figure 9.4.31.1: Additional UE Unreachable indicators information element + +Table 9.4.31.1: Additional UE Unreachable indicators value + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Additional paging indicators value (octet 3, bit 1)
Bits
1
0 SM Buffer Request Indicator (SMBRI) is not set
1 SM Buffer Request Indicator (SMBRI) is set | +| Bits 8 to 2 of octet 3 are spare and shall be all coded as zero. | + +## 9.4.32 Maximum Retransmission Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the Maximum Retransmission Time IE indicates the time until which the SMS-GMSC is capable to retransmit the Short Message. The Maximum Retransmission Time IE is coded as shown in figure 9.4.32.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|--------------------------|------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 6 | Maximum Retransmission Time value, encoded as the Maximum Retransmission Time IE in subclause 12.9.2 of 3GPP TS 29.002 [15]. | | | | | | | | + +Figure 9.4.32.1: Maximum Retransmission Time information element + +## 9.4.33 Requested Retransmission Time + +For Deployment Option 2 (see subclause 8.2.4a.1 of 3GPP TS 23.272 [7]), the Requested Retransmission Time IE indicates the time at which the MME requests the SMS-GMSC to retransmit the Short Message. The Requested Retransmission Time IE is coded as shown in figure 9.4.33.1. + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +|--------------------------|---------------------------------------------------------------------------------------------------------------------------------|---|---|---|---|---|---|---| +| Octet 1 | IEI | | | | | | | | +| Octet 2 | Length indicator | | | | | | | | +| Octet 3
to
Octet 6 | Requested Retransmission Time value, encoded as the Requested Retransmission Time IE in subclause 12.9.2 of 3GPPTS 29.002 [15]. | | | | | | | | + +Figure 9.4.33.1: Requested Retransmission Time information element + +# 10 List of system variables + +## 10.1 Timers + +This subclause lists the management timers specified for the operation of the SGsAP protocol. All the implementation shall support the range of values specified in table 10.1.1 or table 10.1.2 as appropriate. The specific value of the timers is under the control of the operator. + +Table 10.1.1: Management timers – MME side + +| Timer name | Default value | Timer range | Granularity | Notes | Relation to other timers | +|------------|---------------|----------------|-------------|------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Ts6-1 | - | 10 s to 90 s | 1 s | Guards the Location Update procedure. | It is expected to take a value greater than 2 times the maximum transmission time in the SGs interface, plus the supervision timer of the Update Location procedure (as defined in 3GPP TS 29.002 [15]) | +| Ts8 | 4 s | 1s to 30 s | 1 s | Guards the Explicit IMSI detach from EPS services procedure. | None. | +| Ts9 | 4 s | 1-30 s | 1 s | Guards the Explicit IMSI detach from non-EPS services procedure. | None. | +| Ts10 | 4 s | 1-30 s | 1 s | Guards the Implicit IMSI detach from non-EPS services procedure. | None. | +| Ts12-1 | - | 8 - 60x384+8 s | 1 min | Controls the resetting of the 'MME-Reset' variable. | It is expected to take a value greater than the longest periodic tracking area update timer running on the MME, plus the transmission delay on the radio interface. | +| Ts12-2 | 4 s | 1-120 s | 1 s | Guards the MME reset procedure. There is one Ts12-2 timer per VLR for which the MME has a SGs association. | None. | +| Ts13 | 4 s | 1-30 s | 1 s | Guards the Implicit IMSI detach from EPS services procedure. | None. | + +NOTE: The Default value is the recommended value. + +Table 10.1.2: Management timers – VLR side + +| Timer name | Default value | Timer range | Granularity | Notes | Relation to other timers | +|------------|---------------|----------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Ts5 | - | 2 s to 20 s | 100 ms | Guards the Paging procedure at the VLR. | Value is correlated to paging cycle. The default is set according to maximum paging cycle supported by the MME (operator choice) as defined in 3GPP TS 36.331 [19]. | +| Ts6-2 | 40 s | 5 s to 60 s | 1 s | Guards the TMSI reallocation procedure. | It is expected to take a value greater than 2 times the maximum transmission time in the SGs interface, plus 4 times T3450 (as defined in 3GPP TS 24.301 [14]). The T3450 value to use in the calculation is the value for cases without coverage enhancement. | +| Ts7 | 4 s | 1 s to 30 s | 1 s | Guards the Non-EPS alert procedure. | None. | +| Ts11 | 4 s | 1-120 s | 1 s | Guards the VLR reset procedure. There is one Ts11 timer per MME for which the VLR has a SGs association. | None. | +| Ts14 | - | 5 s to 20 s (NOTE 2) | 1 s | Guards the MT UE fallback procedure to UTRAN/GERAN | It is expected to take a value greater than T3417ext-mt. Otherwise, the UE can attempt to select GERAN/UTRAN although the call is already released. | +| Ts15 | - | 1 s to 20 s (NOTE 2) | 1 s | Guards the MO UE fallback procedure to UTRAN/GERAN when the network is configured to support the return to the last used E-UTRAN PLMN after CS fallback | None. | + +NOTE 1: The Default value is the recommended value. +NOTE 2: If a too small value is configured, the timer can expire before a successful fallback to UTRAN/GERAN occurs. + +## 10.2 Retry counters + +This subclause lists the management retry counters specified for the operation of the SGsAP protocol. The values in table 10.2.1 and table 10.2.2 are recommended values. + +Table 10.2.1: Management retry counters – VLR side + +| Retry counter name | Retry value | +|--------------------|-------------| +| Ns7 | 2 | +| Ns11 | 2 | + +Table 10.2.2: Management retry counters – MME side + +| Retry counter name | Retry value | +|--------------------|-------------| +| Ns8 | 2 | +| Ns9 | 2 | +| Ns10 | 2 | +| Ns12 | 2 | + +## Annex A (informative): Change history + +| Change history | | | | | | | | +|----------------|---------------|-----------|------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|-------| +| Date | TSG # | TSG Doc. | CR | R
e
v | Subject/Comment | Old | New | +| 2008-06 | | | | | Draft skeleton provided by rapporteur. | - | 0.0.0 | +| 2008-06 | CT1#54 | | | | Includes the following contributions agreed by CT1:
C1-082435, C1-082710 | 0.0.0 | 0.1.0 | +| 2008-08 | CT1#55 | | | | Includes the following contributions agreed by CT1:
C1-083518, C1-083519, C1-083520, C1-083521, C1-083523, C1-083586 | 0.1.0 | 0.2.0 | +| 2008-09 | e-mail review | | | | Added newly assigned TS number and updated title and scope for correct definition of VLR acronym. | 0.2.0 | 0.2.1 | +| 2008-10 | CT1#55 bis | | | | Includes the following contributions agreed by CT1:
C1-083821, C1-083822, C1-083824, C1-084195, C1-084199, C1-084300, C1-084301, C1-084302, C1-084303, C1-084304, C1-084305, C1-084306, C1-084307, C1-084312, C1-084314, C1-084483, C1-084485, C1-084486, C1-084487, C1-084488 | 0.2.1 | 0.3.0 | +| 2008-11 | CT1#56 | | | | Includes the following contributions agreed by CT1:
C1-084709, C1-084719, C1-084722, C1-085182, C1-085194, C1-085195, C1-085196, C1-085197, C1-085301, C1-085302, C1-085303, C1-085311, C1-085522
Changes by the rapporteur:
- correction of title for 3GPP TS 22.101 and 3GPP TS 32.422 in references subclause
- information element identifiers for LCS client identity, LCS indicator, MM information and SS code added to table 9.3.1
- details for coding of LCS client identity moved to figure 9.4.9.1 and details for coding of SS code moved to figure 9.4.19.1
- editorial corrections to align with drafting rules | 0.3.0 | 0.4.0 | +| 2008-11 | | | | | Version 1.0.0 created for presentation to CT#42 for information and approval | 0.4.0 | 1.0.0 | +| 2008-12 | CT#42 | | | | Version 8.0.0 created after approval in CT#42 | 1.0.0 | 8.0.0 | +| 2009-03 | CT#43 | CP-090154 | 0001 | 2 | Handle of CSFB paging procedure when UE is in connected mode | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0002 | | SGs paging with access control in E-UTRAN | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0003 | 2 | Clarifications of paging procedure in MME | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0004 | 1 | Consistent usage of HSS | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0005 | | Location update for non-EPS services procedure: failure and abnormal cases | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0006 | 1 | Clarifications for MM information procedure | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0007 | 1 | VLR number derivation | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0008 | 3 | Abnormal conditions for UL and DL Unitdata procedures | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0009 | 1 | MME behaviour when receiving paging for SMS | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0010 | 1 | Adding IE details | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0011 | 2 | Corrections in state models for VLR/MME | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0012 | 2 | SS handling details in VLR | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0013 | 2 | IE of paging request | 8.0.0 | 8.1.0 | +| 2009-03 | CT#43 | CP-090154 | 0014 | 1 | Corrections and additions for procedures for SMS delivery over SGs | 8.0.0 | 8.1.0 | +| 2009-06 | CT#44 | CP-090421 | 0017 | | Removing Editor's note on EPS location update type | 8.1.0 | 8.2.0 | +| 2009-06 | CT#44 | CP-090421 | 0019 | 1 | Correction of the location update initiation | 8.1.0 | 8.2.0 | +| 2009-06 | CT#44 | CP-090421 | 0021 | 1 | Paging Procedure when MME restarts | 8.1.0 | 8.2.0 | +| 2009-06 | CT#44 | CP-090421 | 0022 | | Forward of CS paging to the SGSN when ISR is activated | 8.1.0 | 8.2.0 | +| 2009-09 | CT#45 | CP-090674 | 0023 | | Correction to the Location update for non-EPS services procedure in the MME | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0024 | 1 | Support multiple SCTP associations | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0025 | | Port number and payload protocol identifier for SGsAP | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0026 | | The usage of timer Ns12 | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0027 | | Corrections for the length of IE | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0028 | 2 | Clarification of Location Update | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090675 | 0029 | 2 | Update for 'SMS-only' behaviour | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090674 | 0031 | 2 | Clarify the condition for starting the location update for non-EPS services procedure | 8.2.0 | 8.3.0 | +| 2009-09 | CT#45 | CP-090675 | 0033 | 1 | SMS over SGs charging and authority enquiry parameters | 8.2.0 | 8.3.0 | +| 2009-09 | CT#46 | CP-090916 | 0036 | 1 | Paging procedure in MME for supporting SMS only | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090916 | 0037 | 1 | Location update initiation for SMS over SGs only | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0038 | 6 | Corrections for SGs Service Request | 8.3.0 | 8.4.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--------------------------------------------------------------------------------------------------------------|--------|--------| +| 2009-09 | CT#46 | CP-090916 | 0039 | 2 | Correction for Online and offline charging parameters | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0040 | 1 | Correction of definition of MME name | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0041 | 1 | Implicit detach procedure in VLR correction | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090916 | 0042 | | Remove use case of UE not supporting combined attach for 'SMS only' | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0043 | 1 | Handling of EPS detach indication | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0044 | | Correction of reference to TS 23.195 | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0046 | | MME executing the HSS location updating procedure and location update procedure for non-EPS services | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090915 | 0047 | 1 | Correction of values of IMSI detach from EPS service type IE and IMSI detach from non-EPS service type IE | 8.3.0 | 8.4.0 | +| 2009-09 | CT#46 | CP-090922 | 0034 | 1 | Paging signalling optimization after MME failure | 8.4.0 | 9.0.0 | +| 2009-09 | CT#46 | CP-090922 | 0035 | 2 | Paging clarifications | 8.4.0 | 9.0.0 | +| 2009-09 | CT#46 | CP-090922 | 0048 | 1 | Add UE EMM Mode IE in SGsAP-SERVICE-REQUEST message | 8.4.0 | 9.0.0 | +| 2010-03 | CT#47 | CP-100126 | 0049 | 2 | MME Name octet length correction | 9.0.0 | 9.1.0 | +| 2010-03 | CT#47 | CP-100126 | 0052 | | Alignment term "CSFB and SMS over SGs" with TS23.401 (Part III) | 9.0.0 | 9.1.0 | +| 2010-03 | CT#47 | CP-100134 | 0053 | 2 | Modification of the paging procedure | 9.0.0 | 9.1.0 | +| 2010-03 | CT#47 | CP-100126 | 0056 | | Clarification of paging procedure for SMS | 9.0.0 | 9.1.0 | +| 2010-03 | CT#47 | CP-100126 | 0058 | 1 | Paging for SMS on S3 and no paging retransmission in the MME | 9.0.0 | 9.1.0 | +| 2010-06 | CT#48 | CP-100348 | 0065 | 2 | Alert MME Notification / UE Activity Notification procedure on S3 interface | 9.1.0 | 9.2.0 | +| 2010-06 | CT#48 | CP-100348 | 0069 | 3 | Paging Procedures in the MME for SMS Service Type | 9.1.0 | 9.2.0 | +| 2010-06 | CT#48 | CP-100348 | 0072 | | Removal of reference to TS 23.195 | 9.1.0 | 9.2.0 | +| 2010-06 | CT#48 | CP-100354 | 0074 | 1 | New LAI derivation at MME | 9.1.0 | 9.2.0 | +| 2010-06 | CT#48 | CP-100370 | 0066 | 2 | Message Name and Miscellaneous Editorial changes | 9.2.0 | 10.0.0 | +| 2010-06 | CT#48 | CP-100370 | 0073 | | Update to service request procedure | 9.2.0 | 10.0.0 | +| 2010-09 | CT#49 | CP-100518 | 0076 | 1 | Location Update Retry on LAIs of other RATs | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100520 | 0081 | 4 | Add Timezone IE in Location Update Request | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0083 | 1 | MME Name | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100501 | 0086 | 2 | Correction to LAI derivation for default SGs scenario | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0088 | 3 | Call cancellation for CSFB MT | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100495 | 0091 | 1 | IMSI detach from EPS and Non-EPS services | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0098 | 2 | MME State Diagram Correction | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0102 | 2 | VLR Abnormal Case Handling for SMS-MO Call | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0103 | 2 | Data Restoration and SGs Association Recovery | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0105 | | Where to page for the UE for a mobile terminated CS call when no NAS signalling connection exists | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0106 | | SGsAP-SERVICE-REQUEST message is not sent when UE is in EMM-IDLE mode | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0111 | | Behavior of the recipient upon receipt of an erroneous SGsAP-Status message | 10.0.0 | 10.1.0 | +| 2010-09 | CT#49 | CP-100518 | 0112 | | Corrections related to use of location area identifier IE at MME upon receiving SGsAP-PAGING-REQUEST message | 10.0.0 | 10.1.0 | +| 2010-12 | CT#50 | CP-100763 | 0099 | 2 | VLR Failure Handling | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0100 | 2 | MME Failure Handling | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0107 | 2 | VLR name is not configured locally in the MME for SGsAP-Paging-Request | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0112 | 1 | Correction of use of release procedure | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0114 | 3 | CS PLMN determination for CSFB | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0117 | 1 | CS domain access rights check in CSFB | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100740 | 0122 | 1 | Paging failure on SGs | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0123 | | Length indicator in SGsAP information elements | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0124 | 2 | Adding location area identity to SGs location update reject message | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0127 | 3 | DST, Universal time and local time zone handling at the MME | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0128 | 1 | Call Forwarding on No Reply Triggering in EMM-CONNECTED Mode | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100740 | 0136 | | Removal of VLR number derivation by the MME | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0137 | 1 | Additional MME Abnormal Cases | 10.1.0 | 10.2.0 | +| 2010-12 | CT#50 | CP-100763 | 0142 | 1 | Removing unused stored parameters in the VLR | 10.1.0 | 10.2.0 | +| 2011-03 | CT#51 | CP-110197 | 0143 | | Requirement for inclusion of LCS client identity IE in SGsAP-PAGING-REQUEST message | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0144 | | Correction of handling of call forwarding | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0145 | 3 | Implicit detach handling for EPS and non-EPS services | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0148 | 1 | Explicit IMSI detach from EPS services triggered by PTAU reject | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0149 | 2 | Discarding LSA identity in MM INFORMATION REQUEST message | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110189 | 0150 | 2 | Clarification about usage of eMLPP priority IE in SGsAP-PAGING-REQUEST | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0151 | 1 | Implicit detach procedure in VLR when MME goes detached | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0153 | | Timer handling in detach response | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0154 | 1 | Location update trigger correction in SGs-ASSOCIATED state | 10.2.0 | 10.3.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|----------------------------------------------------------------------------------------------------------------------|--------|--------| +| 2011-03 | CT#51 | CP-110197 | 0155 | 1 | Paging accept in SGs NULL state at MME | 10.2.0 | 10.3.0 | +| 2011-03 | CT#51 | CP-110197 | 0156 | 2 | VLR behavior in SGs NULL state | 10.2.0 | 10.3.0 | +| 2011-06 | CT#52 | CP-110464 | 0158 | 2 | Correction on SGs UE unreachable handling | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0159 | 1 | UE Paging Initiation after SGs association has been established | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0160 | 1 | Detach handling for Implicit IMSI detach from non-EPS services | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110457 | 0162 | 1 | Removal of CS PLMN reselection requirement for CSFB | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0163 | 1 | New Location Update Request during TMSI reallocation procedure | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0165 | 1 | Updating IMSI detach flag during explicit IMSI detach for non-EPS services | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0167 | 1 | SMS paging at MME failure | 10.3.0 | 10.4.0 | +| 2011-06 | CT#52 | CP-110464 | 0171 | | MME state diagram corrections | 10.3.0 | 10.4.0 | +| 2011-09 | CT#53 | CP-110682 | 0174 | 2 | MO SMS over SGs handling at VLR failure | 10.4.0 | 10.5.0 | +| 2011-09 | CT#53 | CP-110684 | 0175 | 2 | MT SMS over SGs handling at VLR failure | 10.4.0 | 10.5.0 | +| 2011-09 | CT#53 | CP-110682 | 0176 | 1 | Correction on detach in SGs-NULL state for non-EPS service | 10.4.0 | 10.5.0 | +| 2011-09 | CT#53 | CP-110694 | 0169 | 3 | Abnormal case for SGs location update procedure | 10.5.0 | 11.0.0 | +| 2011-09 | CT#53 | CP-110691 | 0179 | 1 | Inclusion of SS Code in SGs Paging for Network initiated CISS Procedure | 10.5.0 | 11.0.0 | +| 2011-09 | CT#53 | CP-110691 | 0182 | 2 | Overlapping with TS 24.301 scope | 10.5.0 | 11.0.0 | +| 2011-12 | CT#54 | CP-110886 | 0177 | 6 | Restoration of CS Services during long MME failure | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110882 | 0180 | 4 | Asynchronous display of network name in CSFB deployment | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110882 | 0181 | 1 | Correction to references | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110888 | 0184 | 1 | Editorial corrections | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110858 | 0193 | 1 | Inclusion of E-UTRAN location in SGs Location Update message | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110874 | 0194 | 1 | Correction on trigger of EPS detach indication at the MME | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110888 | 0198 | 2 | Correct the behaviors of the VLR during the implicit IMSI detach procedure | 11.0.0 | 11.1.0 | +| 2011-12 | CT#54 | CP-110942 | 0183 | 6 | Provide Subscriber Information handling for UE under LTE | 11.0.0 | 11.1.0 | +| 2012-03 | CT#55 | CP-120113 | 0186 | 6 | SGs paging handling in the VLR and the MME failure cases | 11.1.0 | 11.2.0 | +| 2012-06 | CT#56 | CP-120318 | 0203 | 3 | MME paging handling for "SMS Indicator" case | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120293 | 0207 | 2 | Change to the detach message for implicit detach at MME | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120293 | 0211 | 2 | Clarification of MME behaviour in receiving CS Paging when MRT has expired but IDT is running while ISR is activated | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120309 | 0213 | 2 | SGs Support for MSC in Pool to avoid dual VLR registration | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120318 | 0219 | 3 | Support of MAP signalling in the MME (via IWF) | 11.2.0 | 11.3.0 | +| 2012-06 | CT#56 | CP-120315 | 0201 | 6 | Support of SMS in MME for PS-only subscription | 11.2.0 | 11.3.0 | +| 2012-09 | CT#57 | CP-120572 | 0221 | 2 | Partial VLR failure or VLR restart with CSFB while ISR is activated | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120594 | 0225 | 1 | Clarification of MME Name and VLR Name format | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120594 | 0227 | 1 | Transitioning to SGs-NULL upon Attach | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120584 | 0228 | 1 | Avoiding dual VLR registration for legacy UEs | 11.3.0 | 11.4.0 | +| 2012-09 | CT#57 | CP-120589 | 0222 | 2 | Additional condition for skipping VLR SGs registration | 11.3.0 | 11.4.0 | +| 2012-12 | CT#58 | CP-120807 | 0232 | 3 | Handling of VLR failure without restart | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120803 | 0233 | 5 | SMS in MME registration indication from the HSS | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120807 | 0234 | 2 | Configurations with multiple SCTP endpoints per MME/VLR pair | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120807 | 0239 | 5 | FQDN coding in VLR name and MME name | 11.4.0 | 11.5.0 | +| 2012-12 | CT#58 | CP-120898 | 0230 | 7 | Selected PLMN in network sharing for CSFB | 11.4.0 | 11.5.0 | +| 2013-03 | CT#59 | CP-130108 | 0242 | | SGs Interface applicability in case of SMS in MME | 11.5.0 | 11.6.0 | +| 2013-03 | CT#59 | CP-130123 | 0246 | 2 | CS domain operator selection in GWCN | 11.5.0 | 11.6.0 | +| 2013-03 | CT#59 | CP-130134 | 0241 | 6 | MME handling of VLR Failure without restart | 11.6.0 | 12.0.0 | +| 2013-03 | CT#59 | CP-130125 | 0243 | 2 | Editorial change on reset indication | 11.6.0 | 12.0.0 | +| 2013-06 | CT#60 | CP-130255 | 0249 | 1 | Correction to Selected CS Domain Operator IE definition | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0256 | 1 | Clarification on the SGs-implicit IMSI detach | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130239 | 0259 | 2 | Explicit IMSI detach trigger by the rejection of TAU procedure | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130264 | 0264 | 3 | State transition in the MME without SGs signaling | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0265 | 3 | Paging response from GERAN/UTRAN during CSFB | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130386 | 0266 | 3 | Implicit detach timer and implicit IMSI detach | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0267 | | Stop the timer Ts13 | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0268 | | Change VLR number to VLR name | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130264 | 0269 | 4 | Cause Value Mapping Method for Contact without 2G/3G Roaming Agreement | 12.0.0 | 12.1.0 | +| 2013-06 | CT#60 | CP-130258 | 0270 | 3 | VLR handling when CSFB UE failing to access to UTRAN/GERAN | 12.0.0 | 12.1.0 | +| 2013-09 | CT#61 | CP-130505 | 0276 | | General description for UE fallback supervision procedure | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130505 | 0277 | 2 | Re-paging for MT CSFB call at VLR | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130505 | 0278 | 1 | MME handling when receiving paging at the SGs-NULL | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130505 | 0279 | 2 | Handling the collision of call services | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130505 | 0283 | 2 | CSFB supervision via timer Ts5/Ts14 and CFNRy/CRNRc handling | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130510 | 0284 | 2 | Implicit IMSI detach triggering criteria | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130498 | 0292 | 1 | Clarification on SS code used in the Paging message | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130525 | 0296 | 2 | State of SGs association in the MME for emergency CSFB | 12.1.0 | 12.2.0 | +| 2013-09 | CT#61 | CP-130573 | 0290 | 4 | Handling of VLR failure without restart during MO-SMS procedure | 12.1.0 | 12.2.0 | +| 2013-12 | CT#62 | CP-130762 | 0301 | | Correction on reference of message type IE | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130742 | 0303 | 5 | Addition of MO CSFB indication for return to last LTE PLMN | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130754 | 0304 | 1 | Cleanup of SGs paging without LAI case | 12.2.0 | 12.3.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|--------------------------------------------------------------------------------------------|--------|--------| +| 2013-12 | CT#62 | CP-130745 | 0306 | 6 | UE paging after TMSI reallocation procedure abort | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130739 | 0313 | 1 | Modification for paging with IMSI in MME for CSFB | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130754 | 0315 | 2 | Paging identity usage after new Location Update Request during TMSI reallocation procedure | 12.2.0 | 12.3.0 | +| 2013-12 | CT#62 | CP-130754 | 0316 | | Trigger of the SGs service request procedure | 12.2.0 | 12.3.0 | +| 2014-03 | CT#63 | CP-140144 | 0314 | 3 | Collision of tracking area update and the MME initiated IMSI detach procedures | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140141 | 0320 | | Clarification on Ts14 minimum value | 12.3.0 | 12.4.0 | +| 2014-03 | CT#63 | CP-140130 | 0326 | 1 | Response to SGs paging | 12.3.0 | 12.4.0 | +| 2014-06 | CT#64 | CP-140301 | 0329 | 1 | CSFB priority call handling in a network supporting Multimedia Priority Service | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140309 | 0331 | | Return to last LTE PLMN indication for emergency calls | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140331 | 0332 | 1 | Available old TMSI | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140328 | 0336 | 2 | Release of SGs association in case of SRVCC | 12.4.0 | 12.5.0 | +| 2014-06 | CT#64 | CP-140304 | 0338 | 3 | Handling paging request for USSD when VoLTE call is ongoing | 12.4.0 | 12.5.0 | +| 2014-09 | CT#65 | CP-140661 | 0341 | 1 | Clarification on SCTP multi-homing support for SGsAP transport | 12.5.0 | 12.6.0 | +| 2014-12 | CT#66 | CP-140832 | 0343 | 3 | Service request in idle mode. | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140832 | 0346 | 2 | SGs paging when NAS signalling connection is present | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140832 | 0347 | | Removal of duplicated references TS 23.216 | 12.6.0 | 12.7.0 | +| 2014-12 | CT#66 | CP-140862 | 0342 | | Correction of faulty interface reference | 12.7.0 | 13.0.0 | +| 2014-12 | CT#66 | CP-140862 | 0344 | 1 | Correct MME's behaviour in VLR fails without restart | 12.7.0 | 13.0.0 | +| 2014-12 | CT#66 | CP-140858 | 0345 | 1 | Collision during paging procedure in A/lu mode | 12.7.0 | 13.0.0 | +| 2015-06 | CT#68 | CP-150329 | 0354 | | Correction on background color of text | 13.0.0 | 13.1.0 | +| 2015-09 | CT#69 | CP-150529 | 0355 | 3 | SGs state change without SGsAP signalling at the MME during PS HO | 13.1.0 | 13.2.0 | +| 2015-09 | CT#69 | CP-150529 | 0356 | | IMSI format correction | 13.1.0 | 13.2.0 | +| 2016-03 | CT#71 | CP-160072 | 0357 | 8 | UE temporarily unreachable due to eDRX | 13.2.0 | 13.3.0 | +| 2016-03 | CT#71 | CP-160082 | 0358 | | Alignment of paging for MT-SMS in case of ISR activated and VLR failure | 13.2.0 | 13.3.0 | + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2016-09 | CT#73 | CP-160492 | 0359 | 6 | B | Prioritized SM retransmission by the SMS SC when the UE becomes reachable | 13.4.0 | +| 2016-09 | CT#73 | CP-160492 | 0360 | 5 | B | MT SM transmission to a UE in eDRX within the SM-Delivery-Start-Time/Timer | 13.4.0 | +| 2016-09 | CT#73 | CP-160492 | 0361 | 5 | B | MT SM retransmission by the SMS GMSC to a UE in eDRX at the time requested in the Delivery Report | 13.4.0 | +| 2016-09 | CT#73 | CP-160492 | 0362 | 1 | F | Improve the MT SMS over SGs procedure in eDRX | 13.4.0 | +| 2016-12 | CT#74 | CP-160722 | 0363 | 3 | F | Enabling SMS over SGs for NB-IoT only UEs | 13.5.0 | +| 2017-03 | CT#75 | CP-170110 | 0365 | 3 | F | Failure case handling of SMS over SGs for NB-IoT only UEs | 13.6.0 | +| 2017-03 | CT#75 | CP-170111 | 0367 | | F | Correction on CR implementation for eDRX | 13.6.0 | +| 2017-03 | SA#75 | | | | | Upgrade to Rel-14 | 14.0.0 | +| 2017-06 | CT#76 | CP-171073 | 0369 | | F | MS Classmark 2 IE not provided at normal procedures | 14.1.0 | +| 2017-06 | CT#76 | CP-171073 | 0370 | 1 | F | Specification of TMSI handling in the MME at SMS via SGs using normal procedures | 14.1.0 | +| 2017-06 | CT#76 | CP-171073 | 0371 | | F | Extended NAS timer impact on TMSI reallocation supervision timer | 14.1.0 | +| 2017-09 | CT#77 | CP-172120 | 0372 | | C | Handling of timer expiry during extended service request procedure for MT CSFB | 15.0.0 | +| 2017-12 | CT#78 | CP-173054 | 0376 | | A | Missing IE Identifier coding assignments for eDRX | 15.1.0 | +| 2017-12 | CT#78 | CP-173079 | 0377 | 1 | B | Setting of priority transport value for priority services on the SGs Interface | 15.1.0 | +| 2018-03 | CT#79 | CP-180088 | 0378 | | F | IMEISV inclusion criteria correction for ICS | 15.2.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | +| 2022-04 | SA-95e | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 | +| 2023-03 | CT#99 | CP-230246 | 0379 | | F | Correction on SS code inclusion in SGs paging | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29119/raw.md b/marked/Rel-18/29_series/29119/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..b4f10ff7a7cc807ecd60a6bd8550e1c0070f58b7 --- /dev/null +++ b/marked/Rel-18/29_series/29119/raw.md @@ -0,0 +1,296 @@ + + +# 3GPP TS 29.119 V18.0.0 (2024-03) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; GPRS Tunnelling Protocol (GTP) specification for Gateway Location Register (GLR) (Release 18)** + +![LTE Advanced Pro logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for LTE Advanced Pro, featuring the letters 'lte' in a bold, lowercase font. Above the 't' is a green signal icon with three bars. To the right of the 't' are the words 'Advanced' and 'Pro' in a smaller font, with 'Pro' in red. + +LTE Advanced Pro logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters '3GPP' in a stylized, bold font. Below the 'P' is a red signal icon with three bars. 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. + +© 2024, 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 | +| 1.1 References..... | 5 | +| 2 Definitions and abbreviations ..... | 5 | +| 2.1 Definitions..... | 5 | +| 2.2 Abbreviations ..... | 6 | +| 3 General..... | 6 | +| 4 Transmission order and bit definitions..... | 7 | +| 5 GTP header ..... | 7 | +| 6 GTP Message and Message Formats ..... | 7 | +| 6.1 Signalling Message Formats ..... | 7 | +| 6.2 Path Management messages..... | 8 | +| 6.3 Tunnel Management messages..... | 8 | +| 6.4 Location Management message ..... | 9 | +| 6.5 Mobility Management messages..... | 9 | +| 6.6 Reliable delivery of signalling messages ..... | 9 | +| 6.7 Information element ..... | 10 | +| 7 Signalling Plane (GTP-C) ..... | 10 | +| 8 GTP-U ..... | 10 | +| 9 Path Protocol..... | 10 | +| 10 Error handling ..... | 10 | +| 11 Inter-PLMN GTP communication over the Gp Interface ..... | 10 | +| 12 IP, the networking technology used by GTP ..... | 10 | +| 13 GTP parameters..... | 10 | +| Annex A (informative): Change history..... | 11 | + +# --- Foreword + +The present document 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 describes the signalling requirements and procedures used at network elements related to the GLR for GTP within the 3GPP system at the application level. + +The present document gives the description of the systems needed only in the network utilising GLR as the delta document against 3GPP TS 29.060. + +## 1.1 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 23.060: "General Packet Radio Service (GPRS); Service description Stage2". +- [2] 3GPP TS 23.119: "Gateway Location Register (GLR) – stage2". +- [3] 3GPP TS 24.008: "Mobile radio interface layer 3 specification, Core Network Protocols – Stage 3". +- [4] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [5] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp Interface". + +# 2 Definitions and abbreviations + +## 2.1 Definitions + +For the purposes of the present document, the following terms and definitions apply. + +**Gateway Location Register:** this entity handles location management of roaming subscriber in visited network without involving HLR + +**Intermediate GSN:** this entity is used as serving GSN towards home network and relay some PDU notification messages between serving GSN and Gateway GSN + +**MM context:** information sets held in MS and GSNs for a GPRS subscriber related to mobility management (MM) + +**MM Context ID:** IMSI or equivalent for use in conjunction with Anonymous Access (please refer to section GTP Header) + +**Path:** UDP/IP path and TCP/IP path are examples of paths that may be used to multiplex GTP tunnels + +**Path Protocol:** path Protocol is the protocol(s) used as a bearer of GTP between GSNs + +**PDP:** packet Data Protocol (PDP) is a network protocol used by an external packet data network interfacing to GPRS + +- PDP Context:** information sets held in MS and GSNs for a PDP address +- Signalling message:** GTP signalling messages are exchanged between GSN pairs in a path. The signalling messages are used to transfer GSN capability information between GSN pairs and to create, update and delete GTP tunnels +- T-PDU:** original packet, for example an IP datagram, from an MS or a network node in an external packet data network. A T-PDU is the payload that is tunnelled in the GTP tunnel +- Tunnel Endpoint Identifier (TEID):** this field unambiguously identifies a tunnel endpoint in the receiving GTP-U or GTP-C protocol entity. The receiving end side of a GTP tunnel locally assigns the TEID value the transmitting side has to use. The TEID values are exchanged between tunnel endpoints using GTP-C messages + +## 2.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------|------------------------------| +| GGSN | Gateway GPRS support node | +| GLR | Gateway Location Register | +| GPRS | General Packet Radio Service | +| GTP | GPRS Tunnelling Protocol | +| IM_GSN | Intermediate GSN | +| IP | Internet Protocol | +| GLR | Gateway Location Register | +| SGSN | Serving GPRS support node | +| TEID | Tunnel Endpoint Identifier | +| UDP | User Datagram Protocol | + +# --- 3 General + +The present document defines the GPRS Tunnelling Protocol (GTP) specific to the network with the GLR, i.e. the protocol between IM\_GSN and other nodes (i.e. GGSN, SGSN and GTP-MAP protocol converting GSN). It includes only the GTP signalling but not data transfer procedures. + +The interface between IM\_GSM and GGSN is either intra-PLMN interface or inter-PLMN interface. + +![Figure 1: Logical Architecture for PS domain in the network with GLR. The diagram shows a hierarchy of network elements. At the top are GLR and HLR connected by a dotted line (Signalling Interface). Below GLR is a GTP-MAP Protocol Converting GSN, which is connected to GLR by a dotted line and to an IM_GSN by a dotted line. Below HLR is another GTP-MAP Protocol Converting GSN, which is connected to HLR by a dotted line and to a GGSN by a dotted line. The IM_GSN is connected to the GTP-MAP Protocol Converting GSN under GLR by a dotted line, to an SGSN by a solid line (Signalling and Data Transfer Interface), and to the GGSN by a dotted line. The SGSN is connected to the GGSN by a solid line. A legend at the bottom indicates that dotted lines represent Signalling Interfaces and solid lines represent Signalling and Data Transfer Interfaces.](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +Figure 1: Logical Architecture for PS domain in the network with GLR. The diagram shows a hierarchy of network elements. At the top are GLR and HLR connected by a dotted line (Signalling Interface). Below GLR is a GTP-MAP Protocol Converting GSN, which is connected to GLR by a dotted line and to an IM\_GSN by a dotted line. Below HLR is another GTP-MAP Protocol Converting GSN, which is connected to HLR by a dotted line and to a GGSN by a dotted line. The IM\_GSN is connected to the GTP-MAP Protocol Converting GSN under GLR by a dotted line, to an SGSN by a solid line (Signalling and Data Transfer Interface), and to the GGSN by a dotted line. The SGSN is connected to the GGSN by a solid line. A legend at the bottom indicates that dotted lines represent Signalling Interfaces and solid lines represent Signalling and Data Transfer Interfaces. + +**Figure 1: Logical Architecture for PS domain in the network with GLR** + +The GTP protocol is implemented only by IM\_GSNs, SGSNs and GGSNs. No other systems need to be aware of GTP. GPRS MSs are connected to a SGSN without being aware of GTP. + +It is assumed that there will be a many-to-many relationship between IM\_GSNs, SGSNs and GGSNs. An IM\_GSN may provide service to many GGSNs. A SGSN may provide service to many IM\_GSNs and GGSNs. + +# 4 Transmission order and bit definitions + +Transmission order and bit definitions on the interface between the IM\_GSN and other nodes in the network with GLR are the same as that used in the network without the GLR, see 3GPP TS 29.060. + +# 5 GTP header + +The GTP header used on interface between the IM\_GSN and other nodes in the network with GLR is the same as that used in the network without the GLR, see 3GPP TS 29.060. + +# 6 GTP Message and Message Formats + +The only signalling plane exists between the IM\_GSN and other nodes (i.e. GGSN, SGSN and GTP-MAP protocol converting GSN). + +## 6.1 Signalling Message Formats + +GTP defines a set of signalling messages between two associated GSNs. The signalling messages to be used between the IM\_GSN and other nodes are defined in the table below. For the GTP signalling messages to be used on other interfaces see 3GPP TS 29.060. + +Table 1: Signalling messages + +| Message Type value (Decimal) | Signalling message | Reference | +|------------------------------|---------------------------------------------|--------------------------| +| 3 | Version Not Supported | 7.4.3 in 3GPP TS 29.060 | +| 27 | PDU Notification Request | 7.5.12 in 3GPP TS 29.060 | +| 28 | PDU Notification Response | 7.5.13 in 3GPP TS 29.060 | +| 29 | PDU Notification Reject Request | 7.5.14 in 3GPP TS 29.060 | +| 30 | PDU Notification Reject Response | 7.5.15 in 3GPP TS 29.060 | +| 32 | Send Routeing Information for GPRS Request | 7.6.1 in 3GPP TS 29.060 | +| 33 | Send Routeing Information for GPRS Response | 7.6.2 in 3GPP TS 29.060 | +| 34 | Failure Report Request | 7.6.3 in 3GPP TS 29.060 | +| 35 | Failure Report Response | 7.6.4 in 3GPP TS 29.060 | + +## 6.2 Path Management messages + +The messages, which are listed in following table, are used on the interface between the IM\_GSN and other nodes. For the definitions of these messages and other messages used on the other interfaces refer to the corresponding sections in 3GPP TS 29.060. + +| Messages | Sending node | Receiving node | +|-----------------------|--------------|----------------| +| Version Not Supported | IM_GSN | GGSN, SGSN | +| | GGSN, SGSN | IM_GSN | + +## 6.3 Tunnel Management messages + +In following table, only the messages used between the IM\_GSN and GGSN and between the IM\_GSN and SGSN are listed. For the definitions of these messages and other messages used on the other interfaces refer to the corresponding sections in 3GPP TS 29.060. + +| Messages | Sending node | Receiving node | +|----------------------------------|--------------|----------------| +| PDU Notification Request | GGSN | IM_GSN | +| | IM_GSN | SGSN | +| PDU Notification Response | SGSN | IM_GSN | +| | IM_GSN | GGSN | +| PDU Notification Reject Request | SGSN | IM_GSN | +| | IM_GSN | GGSN | +| PDU Notification Reject Response | GGSN | IM_GSN | +| | IM_GSN | SGSN | + +## 6.4 Location Management message + +In the network with the GLR, The optional Location Management messages are defined to support the case when Network-Requested PDP Context Activation procedures are used and an IM\_GSN does not have a SS7 MAP interface. GTP is then used to transfer signalling messages between the IM\_GSN and a GTP-MAP protocol-converting GSN in the GPRS backbone network. The GTP-MAP protocol-converting GSN converts the signalling messages described in this section between GTP and MAP. The MAP messages are sent to and received from the GLR. The GTP-MAP protocol-converting function is described in 3GPP TS 23.060. The MAP protocol describing the corresponding procedures and messages is described in 3GPP TS 29.002. This alternative method is illustrated in Figure 2. + +![Diagram illustrating the GTP-MAP Interworking between IM_GSN, GSN, and GLR. The diagram shows three protocol stacks. The IM_GSN stack has layers GTP, UDP, IP, L2, and L1. The GSN stack has layers GTP, UDP, IP, L2, and L1, with a 'GTP-MAP Interworking' block above the GTP layer. This block contains two sub-stacks: one with GTP, MAP, TCAP, SCCP, MTP3, MTP2, and L1; the other with MAP, TCAP, SCCP, MTP3, MTP2, and L1. The GLR stack has layers MAP, TCAP, SCCP, MTP3, MTP2, and L1. Vertical dashed lines separate the three stacks, and horizontal lines connect corresponding layers across them.](367926125450c2bc3f4bdca9d59a62ba_img.jpg) + +Diagram illustrating the GTP-MAP Interworking between IM\_GSN, GSN, and GLR. The diagram shows three protocol stacks. The IM\_GSN stack has layers GTP, UDP, IP, L2, and L1. The GSN stack has layers GTP, UDP, IP, L2, and L1, with a 'GTP-MAP Interworking' block above the GTP layer. This block contains two sub-stacks: one with GTP, MAP, TCAP, SCCP, MTP3, MTP2, and L1; the other with MAP, TCAP, SCCP, MTP3, MTP2, and L1. The GLR stack has layers MAP, TCAP, SCCP, MTP3, MTP2, and L1. Vertical dashed lines separate the three stacks, and horizontal lines connect corresponding layers across them. + +Figure 2: IM\_GSN - GLR Signalling via a GTP-MAP protocol-converter in a GSN + +In following table, only the messages used between the IM\_GSN and The GTP-MAP protocol-converting GSN are listed. For the definitions of these messages and other messages used on the other interfaces refer to the corresponding sections in 3GPP TS 29.060. + +| Messages | Sending node | Receiving node | +|---------------------------------------------|-----------------------------|-----------------------------| +| Send Routeing Information for GPRS Request | IM_GSN | GTP-MAP protocol-converting | +| Send Routeing Information for GPRS Response | GTP-MAP protocol-converting | IM_GSN | +| Failure Report Request | IM_GSN | GTP-MAP protocol-converting | +| Failure Report Response | GTP-MAP protocol-converting | IM_GSN | + +## 6.5 Mobility Management messages + +The messages belonging to the mobility management messages are not used on the interface between the IM\_GSN and other nodes in the network with the GLR. + +## 6.6 Reliable delivery of signalling messages + +For the Reliability mechanism in the IM\_GSN, see section 7.8 in 3GPP TS 29.060. + +## 6.7 Information element + +The format of information elements in the message used on the interface between the IM\_GSN and other nodes in the network with GLR is the same as that in the network without the GLR. See 3GPP TS 29.060. + +# --- 7 Signalling Plane (GTP-C) + +The definition of signalling plane used in the network with the GLR is the same as that used in the network without the GLR, see in 3GPP TS 29.060. + +# --- 8 GTP-U + +GTP-U is not used on the interface between the IM\_GSN and other nodes. For the definition of GTP-U on the other interfaces, see in 3GPP TS 29.060. + +# --- 9 Path Protocol + +The Path Protocol on the interface between the IM\_GSN and other nodes in the network with the GLR is the same as that used in the network without the GLR. See 3GPP TS 29.060. + +# --- 10 Error handling + +The error handling on the interface between the IM\_GSN and other nodes is the same as that in the network without the GLR. See 3GPP TS 29.060. One exception is that the IM\_GSN doesn't have a Restart Counter because the IM\_GSM stores no PDP and MM context and therefore the synchronisation of the status of these with other GSNs is not needed. + +# --- 11 Inter-PLMN GTP communication over the Gp Interface + +Refer to the corresponding section in 3GPP TS 29.060. + +# --- 12 IP, the networking technology used by GTP + +Refer to the corresponding section in 3GPP TS 29.060. + +# --- 13 GTP parameters + +The definitions and directions for use of the parameters in GTP (inc. timer values or counter values and so on) on the interface between the IM\_GSN and other nodes is the same as that used in the network without the GLR. See 3GPP TS 29.060. \ No newline at end of file diff --git a/marked/Rel-18/29_series/29128/raw.md b/marked/Rel-18/29_series/29128/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..54adc6908c1753fc2d3156b3bd3878356f9f6c52 --- /dev/null +++ b/marked/Rel-18/29_series/29128/raw.md @@ -0,0 +1,2106 @@ + + +# 3GPP TS 29.128 V18.0.0 (2023-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) interfaces for interworking with packet data networks and applications (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 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 General Description ..... | 9 | +| 4.1 Introduction ..... | 9 | +| 5 Procedures Description ..... | 11 | +| 5.1 Introduction ..... | 11 | +| 5.2 Report Procedures ..... | 11 | +| 5.2.1 General ..... | 11 | +| 5.2.2 Detailed Behaviour of the MME/SGSN ..... | 12 | +| 5.2.2.0 General..... | 12 | +| 5.2.2.1 UE Loss of Connectivity..... | 12 | +| 5.2.2.2 UE Reachability..... | 13 | +| 5.2.2.3 Location Reporting ..... | 13 | +| 5.2.2.4 Communication Failure ..... | 13 | +| 5.2.2.5 Availability after DDN failure..... | 13 | +| 5.2.2.6 Idle Status Indication ..... | 13 | +| 5.2.2.7 PDN Connectivity Status ..... | 14 | +| 5.2.3 Detailed Behaviour of the SCEF ..... | 14 | +| 5.2.4 Detailed Behaviour of the IWK-SCEF ..... | 14 | +| 5.3 Event Configuration Procedure ..... | 14 | +| 5.3.1 General ..... | 14 | +| 5.3.2 Detailed Behaviour of the MME/SGSN ..... | 15 | +| 5.3.3 Detailed Behaviour of the IWK-SCEF ..... | 16 | +| 5.4 Event Configuration Procedure for Roaming..... | 16 | +| 5.4.1 General ..... | 16 | +| 5.4.2 Detailed Behaviour of the IWK-SCEF ..... | 17 | +| 5.4.3 Detailed Behaviour of the MME/SGSN ..... | 17 | +| 5.5 MO-Data Procedure ..... | 18 | +| 5.5.1 General ..... | 18 | +| 5.5.2 Detailed Behaviour of the MME/SGSN ..... | 19 | +| 5.5.3 Detailed Behaviour of the SCEF ..... | 19 | +| 5.5.4 Detailed Behaviour of the IWK-SCEF ..... | 20 | +| 5.6 MT Data Procedure ..... | 20 | +| 5.6.1 General ..... | 20 | +| 5.6.2 Detailed Behaviour of the SCEF ..... | 21 | +| 5.6.3 Detailed Behaviour of the MME/SGSN ..... | 21 | +| 5.6.4 Detailed Behaviour of the IWK-SCEF ..... | 22 | +| 5.7 Connection Management by MME/SGSN Procedure. .... | 22 | +| 5.7.1 General ..... | 22 | +| 5.7.2 Detailed Behaviour of the MME/SGSN ..... | 24 | +| 5.7.3 Detailed Behaviour of the SCEF ..... | 25 | +| 5.7.4 Detailed Behaviour of the IWK-SCEF ..... | 26 | +| 5.8 Connection Management by SCEF Procedure..... | 26 | +| 5.8.1 General ..... | 26 | +| 5.8.2 Detailed Behaviour of the SCEF ..... | 27 | +| 5.8.3 Detailed Behaviour of the MME/SGSN ..... | 27 | +| 5.8.4 Detailed Behaviour of the IWK-SCEF ..... | 28 | +| 6 Protocol Specification and Implementation..... | 28 | +| 6.1 Introduction ..... | 28 | + +| | | | +|----------|---------------------------------------------------------------------------|----| +| 6.1.1 | Use of Diameter Base Protocol ..... | 28 | +| 6.1.2 | Securing Diameter Messages ..... | 28 | +| 6.1.3 | Accounting Functionality ..... | 28 | +| 6.1.4 | Use of Sessions ..... | 28 | +| 6.1.5 | Transport Protocol ..... | 29 | +| 6.1.6 | Routing Considerations ..... | 29 | +| 6.1.6.1 | Routing Considerations for Monitoring Event related Requests ..... | 29 | +| 6.1.6.2 | Routing Considerations for Non-IP Data Related Requests ..... | 29 | +| 6.1.6.3 | Handling of the Vendor-Specific-Application-Id AVP ..... | 30 | +| 6.1.7 | Advertising Application Support ..... | 30 | +| 6.1.8 | Diameter Application Identifier ..... | 30 | +| 6.1.9 | Use of the Supported-Features AVP ..... | 30 | +| 6.2 | Commands ..... | 31 | +| 6.2.1 | Introduction ..... | 31 | +| 6.2.2 | Command-Code values ..... | 31 | +| 6.2.3 | Configuration Information Request (CIR) Command ..... | 31 | +| 6.2.4 | Configuration-Information-Answer (CIA) Command ..... | 32 | +| 6.2.5 | Reporting-Information-Request (RIR) Command ..... | 32 | +| 6.2.6 | Reporting-Information-Answer (RIA) Command ..... | 33 | +| 6.2.7 | Connection-Management-Request (CMR) Command ..... | 34 | +| 6.2.8 | Connection-Management-Answer (CMA) Command ..... | 34 | +| 6.2.9 | MO-Data-Request (ODR) Command ..... | 35 | +| 6.2.10 | MO-Data-Answer (ODA) Command ..... | 35 | +| 6.2.11 | MT-Data-Request (TDR) Command ..... | 36 | +| 6.2.12 | MT-Data-Answer (TDA) Command ..... | 36 | +| 6.3 | Result-Code AVP and Experimental-Result AVP Values ..... | 37 | +| 6.3.1 | General ..... | 37 | +| 6.3.2 | Success ..... | 37 | +| 6.3.3 | Permanent Failures ..... | 37 | +| 6.3.3.1 | DIAMETER_ERROR_UNAUTHORIZED_REQUESTING_ENTITY (5510) ..... | 37 | +| 6.3.3.2 | DIAMETER_ERROR_UNAUTHORIZED_SERVICE (5511) ..... | 37 | +| 6.3.3.3 | DIAMETER_ERROR_CONFIGURATION_EVENT_STORAGE_NOT_SUCCESSFUL
(5513) ..... | 37 | +| 6.3.3.4 | DIAMETER_ERROR_CONFIGURATION_EVENT_NON_EXISTANT (5514) ..... | 38 | +| 6.3.3.5 | DIAMETER_ERROR_REQUESTED_LOCATION_NOT_SERVED (5650) ..... | 38 | +| 6.3.3.6 | DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 38 | +| 6.3.3.7 | DIAMETER_ERROR_OPERATION_NOT_ALLOWED (5101) ..... | 38 | +| 6.3.3.8 | DIAMETER_ERROR_INVALID_EPS_BEARER (5651) ..... | 38 | +| 6.3.3.9 | DIAMETER_ERROR_NIDD_CONFIGURATION_NOT_AVAILABLE (5652) ..... | 38 | +| 6.3.3.10 | DIAMETER_ERROR_SCEF_REFERENCE_ID_UNKNOWN (5515) ..... | 38 | +| 6.3.3.11 | DIAMETER_ERROR_USER_TEMPORARILY_UNREACHABLE (5653) ..... | 38 | +| 6.3.3.12 | DIAMETER_ERROR_UNREACHABLE_USER (4221) ..... | 38 | +| 6.4 | AVPs ..... | 38 | +| 6.4.1 | General ..... | 38 | +| 6.4.2 | Monitoring-Event-Configuration ..... | 42 | +| 6.4.3 | Monitoring-Event-Report ..... | 42 | +| 6.4.4 | Communication-Failure-Information ..... | 43 | +| 6.4.5 | Cause-Type ..... | 43 | +| 6.4.6 | SIAP-Cause ..... | 44 | +| 6.4.7 | RANAP-Cause ..... | 44 | +| 6.4.8 | BSSGP-Cause ..... | 44 | +| 6.4.9 | GMM-Cause ..... | 44 | +| 6.4.10 | SM-Cause ..... | 44 | +| 6.4.11 | Number-Of-UE-Per-Location-Configuration ..... | 44 | +| 6.4.12 | Number-Of-UE-Per-Location-Report ..... | 44 | +| 6.4.13 | UE-Count ..... | 45 | +| 6.4.14 | Feature-List AVP ..... | 45 | +| 6.4.14.1 | Feature-List AVP for the T6a/T6b application ..... | 45 | +| 6.4.15 | DRMP ..... | 45 | +| 6.4.16 | User-Identifier ..... | 46 | +| 6.4.17 | Bearer-Identifier ..... | 46 | +| 6.4.18 | Connection-Action ..... | 46 | + +| | | | +|-----------------------------------------------------------------------|----------------------------------------------|-----------| +| 6.4.19 | Non-IP-Data ..... | 46 | +| 6.4.20 | Service-Selection ..... | 46 | +| 6.4.21 | Serving-PLMN-Rate-Control ..... | 46 | +| 6.4.22 | Downlink-Rate-Limit ..... | 47 | +| 6.4.23 | Uplink-Rate-Limit ..... | 47 | +| 6.4.24 | SCEF-Wait-Time ..... | 47 | +| 6.4.25 | CMR-Flags ..... | 47 | +| 6.4.26 | Extended-PCO ..... | 47 | +| 6.4.27 | RRC-Cause-Counter ..... | 47 | +| 6.4.28 | Counter-Value ..... | 47 | +| 6.4.29 | RRC-Counter-Timestamp ..... | 48 | +| 6.4.30 | Terminal-Information ..... | 48 | +| 6.4.31 | TDA-Flags ..... | 48 | +| 6.4.32 | Idle-Status-Indication ..... | 48 | +| 6.4.33 | Idle-Status-Timestamp ..... | 49 | +| 6.4.34 | Active-Time ..... | 49 | +| 6.4.35 | Reachability-Cause ..... | 49 | +| 6.4.36 | APN-Rate-Control-Status ..... | 50 | +| 6.4.37 | Uplink-Number-Of-Packets-Allowed ..... | 50 | +| 6.4.38 | Number-Of-Additional-Exception-Reports ..... | 50 | +| 6.4.39 | Downlink-Number-Of-Packets-Allowed ..... | 50 | +| 6.4.40 | APN-Rate-Control-Status-Validity-Time ..... | 50 | +| A.1 | T6a/b and T7 interfaces ..... | 50 | +| A.1.1 | General ..... | 50 | +| A.1.2 | SCEF behaviour ..... | 50 | +| A.1.3 | MME/SGSN behaviour ..... | 51 | +| A.1.4 | IWK-SCEF behaviour ..... | 51 | +| Annex B (normative): Diameter message priority mechanism ..... | | 51 | +| B.1 | General ..... | 51 | +| B.2 | T6a, T6ai, T6b, T6bi, T7 interfaces ..... | 51 | +| Annex C (normative): Diameter load control mechanism ..... | | 52 | +| C.1 | General ..... | 52 | +| C.2 | SCEF behaviour ..... | 52 | +| C.3 | MME/SGSN behaviour ..... | 53 | +| C.4 | IWK-SCEF behaviour ..... | 53 | +| Annex D (informative): Change history ..... | | 54 | + +# 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 describes the Diameter-based interfaces between the SCEF/IWK-SCEF and other network entities such as MME/SGSN for the Architecture enhancements to facilitate communications with packet data networks and applications. + +In particular, this document specifies the T6a interface between the MME and the SCEF, the T6ai interface between the MME and the IWK-SCEF, the T6b interface between the SGSN and the SCEF, the T6bi interface between the SGSN and the SCEF and the T7 interface between the SCEF and the IWK-SCEF. The procedures over those interfaces 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] Void. +- [4] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol; protocol details ". +- [5] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [6] 3GPP TS 29.228: "IP multimedia (IM) Subsystem Cx Interface; Signalling flows and Message Elements". +- [7] IETF RFC 4960: "Stream Control Transport Protocol". +- [8] IETF RFC 5234: "Augmented BNF for Syntax Specifications: ABNF". +- [9] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [10] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [11] 3GPP TS 25.413: "UTRAN Iu interface Radio Access Network Application Part (RANAP) signalling". + +- [12] 3GPP TS 24.008: "Mobile Radio Interface Layer 3 specification; Core Network Protocols; Stage 3". +- [13] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [14] 3GPP TS 48.018: "General Packet Radio Service (GPRS); Base Station System (BSS) - Serving GPRS Support Node (SGSN); BSS GPRS protocol (BSSGP)". +- [15] IETF RFC 7944: "Diameter Routing Message Priority". +- [16] 3GPP TS 29.272: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [17] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol; Protocol details". +- [18] Void. +- [19] 3GPP TS 23.007: "Restoration procedures". +- [20] 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging applications". +- [21] IETF RFC 5778: "Diameter Mobile IPv6: Support for Home Agent to Diameter Server Interaction". +- [22] 3GPP TS 32.299: "Telecommunication management; Charging management; Diameter charging applications". +- [23] 3GPP TS 32.253: "Telecommunication management; Charging management; Control Plane (CP) data transfer domain charging". +- [24] 3GPP TS 23.003: "Numbering, addressing and identification". +- [25] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access". +- [26] 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". +- [27] 3GPP TS 29.338: "Diameter based protocols to support SMS capable MMEs". +- [28] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [29] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [30] 3GPP TS 32.298: "Telecommunication Management; Charging Management; Charging Data Record (CDR) parameter description". +- [31] IETF RFC 8583: "Diameter Load Information Conveyance". +- [32] IETF RFC 6733: "Diameter Base Protocol". +- [33] 3GPP TS 29.274: " Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C)". + +# --- 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. + +## 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]. + +| | | +|----------|--------------------------------------| +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| SCEF | Service Capability Exposure Function | +| IWK-SCEF | Interworking - SCEF | + +# --- 4 General Description + +## 4.1 Introduction + +The T6a/b reference point between the MME/SGSN and the SCEF, the T6ai/bi reference point between the MME/SGSN in the VPLMN and the IWK-SCEF and the T7 reference point between the IWK-SCEF and the SCEF are defined in the 3GPP TS 23.682 [2]. + +This document describes the Diameter-based T6a/b, T6ai/bi and T7 related procedures, message parameters and protocol specification. + +An excerpt of the 3GPP Architecture for the enhancements to facilitate communications with packet data networks and applications, as defined in 3GPP TS 23.682 [2] is shown in Figure 4.1-1, where the relevant interfaces towards the SCEF/IWK-SCEF are highlighted. + +![Figure 4.1-1: 3GPP Architecture for the enhancements to facilitate communications with packet data networks and applications. The diagram shows a Home PLMN (HPLMN) and a Visited PLMN (VPLMN) separated by a dashed orange line. In the HPLMN, an HSS is connected to an MME/SGSN via S6a/d and S6t interfaces. The MME/SGSN is connected to an SCEF via T6a/b interfaces. In the VPLMN, an MME/SGSN is connected to an IWK-SCEF via T6ai/T6bi interfaces. The IWK-SCEF is connected to the SCEF in the HPLMN via a T7 interface.](cfda9df1319e04207eb28bcefd1dab7b_img.jpg) + +Figure 4.1-1: 3GPP Architecture for the enhancements to facilitate communications with packet data networks and applications. The diagram shows a Home PLMN (HPLMN) and a Visited PLMN (VPLMN) separated by a dashed orange line. In the HPLMN, an HSS is connected to an MME/SGSN via S6a/d and S6t interfaces. The MME/SGSN is connected to an SCEF via T6a/b interfaces. In the VPLMN, an MME/SGSN is connected to an IWK-SCEF via T6ai/T6bi interfaces. The IWK-SCEF is connected to the SCEF in the HPLMN via a T7 interface. + +**Figure 4.1-1: 3GPP Architecture for the enhancements to facilitate communications with packet data networks and applications** + +In this architecture, the T6a/b reference point connects the MME/SGSN with the SCEF. + +The T6a/b interface shall allow the SCEF: + +- to receive reports of the monitoring events from the MME/SGSN configured via an HSS; +- to configure the monitoring events at an MME/SGSN which are not UE related in the non roaming cases; +- to manage a connection between the MME and the SCEF on T6a; +- to send MT data on T6a; +- to receive MO data on T6a. + +The T6ai/bi reference point connects the MME/SGSN with the IWK-SCEF in the visited network, if the IWK-SCEF is deployed. + +The T6ai/bi interface shall allow the IWK-SCEF to: + +- to receive configuration of the monitoring events from the MME or the SGSN and perform a filtering of the services which are allowed for this subscriber in this visited network based on roaming policies; +- to receive reports of the monitoring events from the MME/SGSN that are configured via an HSS, perform a filtering and forward them to the SCEF (in the home network which has configured the event) via the T7 reference point; +- to receive MO data on T6ai/bi and forward them to the SCEF; +- to receive MT data and forward them to the MME on T6ai/bi; +- to manage a connection between MME/SGSN and IWK-SCEF on T6ai/bi and forward connection management commands to the SCEF. + +The T7 reference point connects the IWK-SCEF in the visited network with the SCEF in the home network. + +The T7 interface shall allow the IWK-SCEF to: + +- to forward reports received on T6ai/bi to the SCEF indicated in the event report received on T6ai/T6bi; +- to receive MO data on T6ai/bi and forward them to the SCEF on T7; +- to receive MT data on T7 and forward them to the MME/SGSN; +- to manage connection between the SCEF and the IWK-SCEF on T7 and forward connection management commands to the MME/SGSN. + +# --- 5 Procedures Description + +## 5.1 Introduction + +This clause describes the Diameter-based T6a, T6b, T6ai, T6bi and T7 interface related procedures and the Information elements exchanged between the functional entities. + +In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the "Cat." column. For the correct handling of the Information Element according to the category type, see the description detailed in clause 6 of the 3GPP TS 29.228 [6]. + +## 5.2 Report Procedures + +### 5.2.1 General + +This procedure is used between the MME/SGSN and the SCEF, between the MME/SGSN and the IWK-SCEF and between the IWK-SCEF and the SCEF. + +When the procedure is invoked by the MME or the SGSN, it is used for reporting: + +- UE Loss of Connectivity; +- UE Reachability; +- Location of the UE and change in location of the UE; +- Communication Failure; +- Availability after DNN failure; +- Idle Status Indication; +- PDN Connectivity Status. + +When the procedure is invoked by the IWK-SCEF, it is used for conveying the monitoring event reported by the MME or the SGSN to the SCEF, after applying the roaming policies configured at the IWK-SCEF. + +This procedure is mapped to the commands Reporting-Information-Request/Answer in the Diameter application specified in clause 6. The tables 5.2.1-1 and 5.2.1-2 detail the involved information elements. + +**Table 5.2.1-1: Reporting Information Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------------------|-------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | C | If present, this information element shall contain the identity of the UE. This is a grouped AVP containing the MSISDN or the External-Identifier. | +| Monitoring Event Report
(see 3GPP TS 29.336 [5] clause 8.4.3) | Monitoring-Event-Report | C | If the Reporting-Information-Request is sent for reporting the monitoring events, the MME/SGSN and the IWK-SCEF shall include the monitoring event(s) reported towards the SCEF. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 5.2.1-2: Reporting Information Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code / Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Monitoring Event Report Status | Monitoring-Event-Report-Status | O | If present, this information element shall contain the status of each individual monitoring event report received by the SCEF from the MME/SGSN. | + +### 5.2.2 Detailed Behaviour of the MME/SGSN + +#### 5.2.2.0 General + +The MME/SGSN shall fill the Monitoring-Event-Report AVP according to the event reported as specified below. For all monitoring events, the SCEF-ID, the SCEF-Reference-ID/SCEF-Reference-ID-Ext and the Monitoring-Type AVPs shall be included. In addition, the event specific AVPs as listed below shall be included based on the type of event reported. + +The MME/SGSN shall include the External-Identifier or the MSISDN if present in the subscription data received from the HSS. + +If the MME/SGSN receives an Experimental-Result-Code set to DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN within an RIA command, it shall delete the event stored for the indicated SCEF-ID and SCEF-Reference-ID/SCEF-Reference-ID-Ext (see 3GPP TS 23.007 [19]). + +#### 5.2.2.1 UE Loss of Connectivity + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the UE Loss of Connectivity event is reported: + +- Monitoring-Type set to LOSS\_OF\_CONNECTIVITY (0) + +The following AVPs may be present within the Monitoring-Event-Report AVP when the UE Loss of Connectivity event is reported: + +- Loss-Of-Connectivity-Reason set to one of the values defined in 3GPP TS 29.336 [5] + +#### 5.2.2.2 UE Reachability + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the UE Reachability event is reported: + +- Monitoring-Type set to either UE\_REACHABILITY (1) or UE\_REACHABILITY\_AND\_IDLE\_STATUS\_INDICATION (8), as received in the configuration request. +- Reachability-Information set to REACHABLE\_FOR\_DATA(1) + +The following AVPs may be present within the Monitoring-Event-Report AVP when the UE Reachability event is reported: + +- Maximum-UE-Availability-Time +- Reachability-Cause + +NOTE: When the Monitoring-Type is UE\_REACHABILITY\_AND\_IDLE\_STATUS\_INDICATION (8), absence of the Idle-Status-Indication AVP from the Monitoring-Event-Report AVP indicates that UE reachability is reported. + +#### 5.2.2.3 Location Reporting + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the location event is reported: + +- Monitoring-Type set to LOCATION\_REPORTING (2) +- EPS-Location-Information + +#### 5.2.2.4 Communication Failure + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the Communication Failure event is reported + +- Monitoring-Type set to COMMUNICATION\_FAILURE (5) +- Communication-Failure-Information (see clause 6.4.3) + +#### 5.2.2.5 Availability after DDN failure + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the Availability after DDN failure event is reported: + +- Monitoring-Type set to either AVAILABILITY\_AFTER\_DDN\_FAILURE (6) or AVAILABILITY\_AFTER\_DNN\_FAILURE\_AND\_IDLE\_STATUS\_INDICATION (9), as received in the configuration request. + +NOTE: When the Monitoring-Type is AVAILABILITY\_AFTER\_DNN\_FAILURE\_AND\_IDLE\_STATUS\_INDICATION (9), absence of the Idle-Status-Indication AVP from the Monitoring-Event-Report AVP indicates that Availability after DNN failure is reported. + +#### 5.2.2.6 Idle Status Indication + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the Idle Status Indication event is reported: + +- Monitoring-Type set to UE\_REACHABILITY\_AND\_IDLE\_STATUS\_INDICATION (8) or to AVAILABILITY\_AFTER\_DDN\_FAILURE\_AND\_IDLE\_STATUS\_INDICATION (9), depending on the Monitoring-Type of the corresponding event configuration. + +- Idle-Status-Indication + +#### 5.2.2.7 PDN Connectivity Status + +The following AVPs shall be present within the Monitoring-Event-Report AVP when the PDN Connectivity Status event is reported: + +- Monitoring-Type set to PDN\_CONNECTIVITY\_STATUS (8) +- PDN-Connectivity-Status-Report + +### 5.2.3 Detailed Behaviour of the SCEF + +When the SCEF receives a Reporting Information Request from the MME/SGSN or the IWK-SCEF and at least one of the Monitoring Event Report AVPs has a SCEF-Reference-ID/SCEF-Reference-ID-Ext not known by the SCEF, it shall reply with Experimental-Result-Code set to DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN (see 3GPP TS 23.007 [19]). In that case, if the HSS had included multiple Monitoring Event Reports in the RIR command, the SCEF shall include in the Reporting Information Answer command a list of Monitoring-Event-Report-Status AVPs where the status of multiple monitoring event reports is detailed. In that AVP list, the AVPs corresponding to event reports with a successful status may be omitted by the SCEF, for efficiency. + +Otherwise when the SCEF receives a Reporting-Information-Request command from the MME/SGSN or the IWK-SCEF, the SCEF shall set Result-Code to DIAMETER\_SUCCESS in the Reporting-Information-Answer and shall handle it according to the procedures defined in 3GPP TS 23.682 [2]. + +### 5.2.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a Reporting-Information-Request command from the MME/SGSN it shall deliver the request to the SCEF after applying the roaming policies configured at the IWK-SCEF, as specified in 3GPP TS 23.682 [2]. + +## 5.3 Event Configuration Procedure + +### 5.3.1 General + +This procedure is used between the SCEF and the MME and between the SCEF and the SGSN to configure the monitoring events directly at the MME/SGSN through the T6a/b interface. + +When the procedure is invoked by the SCEF, it is used for configuring the event(s): + +- the number of UEs at a given geographic location. + +This procedure is mapped to the commands Configuration-Information-Request/Answer in the Diameter application specified in clause 6. The tables 5.3.1-1 and 5.3.1-2 detail the involved information elements. + +**Table 5.3.1-1: Configuration Information Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------|--------------------------------|------|-------------------------------------------------------------------------------------------------------| +| Monitoring Event Configuration (see clause 6.4.2) | Monitoring-Event-Configuration | C | If present, this Information Element shall contain the details of the Monitoring event(s) configured. | +| Supported Features (See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this Information Element shall contain the list of features supported by the origin host. | + +**Table 5.3.1-2: Configuration Information Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat | Description | +|----------------------------------------------------------------------------------------|------------------------------------------|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-
Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/T6b errors.
This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-
Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Monitoring Event Report
(see 3GPP TS 29.336 [5]
clause 8.4.3) | Monitoring-Event-
Report | C | If an immediate report is available this information element shall contain the requested data available in the MME/SGSN. | +| Monitoring Event-
Configuration Status
(see 3GPP TS 29.336 [5]
clause 8.4.24) | Monitoring-Event-
Config-Status | O | If present it shall contain the status of each monitoring event configuration identified by an SCEF-Reference-ID/SCEF-Reference-ID-Ext. | + +### 5.3.2 Detailed Behaviour of the MME/SGSN + +Monitoring Events configuration and deletion directly at the MME/SGSN for roaming scenarios is not supported. For the non roaming cases, when the Configuration-Information-Request is received from the SCEF, the MME/SGSN shall, in the following order: + +1. Check whether the requesting SCEF is authorized to request the specified service (e.g: number of UEs at a given geographic location). If not, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) in the Configuration-Information-Answer. +2. If the TA / RA / ECGI location requested by the SCEF is not served by the MME/SGSN, then the MME/SGSN shall set the Experimental-Result AVP to DIAMETER\_ERROR\_REQUESTED\_LOCATION\_NOT\_SERVED (5650) in the Configuration-Information-Answer. + +If there is an error in any of the above steps then the MME/SGSN shall stop processing and shall return the error code specified in the respective step. + +If the MME/SGSN cannot fulfil the received request for reasons not stated above, it shall stop processing the request and set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +If CIR message includes multiple SCEF Reference IDs (either in SCEF-Reference-ID or in SCEF-Reference-ID-Ext AVPs) and for a SCEF Reference ID the monitoring events cannot be handled, the MME/SGSN shall report the failed SCEF Reference ID to the SCEF with an appropriate status in the Monitoring-Event-Config-Status AVP. + +For the number of UEs in a geographic location monitoring event, for each SCEF-Reference-ID that the MME/SGSN is able to successfully process, the MME/SGSN shall + +- if filtering is not requested (i.e. IMSI-Group-Id was not present in the request) or not supported: +include in the Configuration-Information-Answer, the exact count of the number of UEs that are known to be at the requested location. +- if filtering is requested and (i.e. IMSI-Group-Id was present in the request) and supported: +include in the Configuration-Information-Answer, the exact count of the number of UEs belonging to the provided IMSI Group that are known to be at the requested location. + +If the requested location type is current location, then the MME/SGSN may activate the paging and RAN location reporting procedures (if required) before providing the response in the Configuration-Information-Answer. + +If the monitoring event configuration is for a continuous monitoring (i.e. Monitoring-Duration and/or Maximum-Number-Of-Reports are set) and the deletion criteria are met (i.e. Monitoring-Duration time expired and/or Maximum-Number-Of-Reports are sent) the MME/SGSN shall locally delete the Monitoring event. + +### 5.3.3 Detailed Behaviour of the IWK-SCEF + +Monitoring Events configuration and deletion directly at the MME/SGSN for roaming scenarios is not supported. Consequently the IWK-SCEF is not impacted for Monitoring Events configuration and deletion directly at the MME/SGSN from the SCEF.5.3.4 Detailed Behaviour of the SCEF + +When the SCEF receives Monitoring Event Report AVP from the MME/SGSN or the IWK-SCEF in the CIA command, it shall handle it according to the procedures defined in 3GPP TS 23.682 [2]. + +When the SCEF receives a Monitoring Event Report AVP from the MME/SGSN with a SCEF-Reference-ID/SCEF-Reference-ID-Ext not known by the SCEF, it should discard the Monitoring Event Report received in CIA command. + +## 5.4 Event Configuration Procedure for Roaming + +### 5.4.1 General + +The MME/SGSN shall send the monitoring event configuration information to the IWK-SCEF in roaming scenarios, when the MME/SGSN receives the monitoring event configuration from the HSS. The monitoring event configuration information as received in the Monitoring-Event-Configuration AVP shall be locally consumed at the IWK-SCEF and the IWK-SCEF shall not route such information beyond it. + +This procedure is mapped to the commands Configuration-Information-Request/Answer in the Diameter application specified in clause 6. The tables 5.4.1-1 and 5.4.1-2 detail the involved information elements. + +**Table 5.4.1-1: Configuration-Information-Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|--------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Monitoring Event Configuration (see 6.4.2) | Monitoring-Event-Configuration | C | If present, this Information Element shall contain the details of Monitoring event(s). | +| Monitoring Event Report (see 6.4.3) | Monitoring-Event-Report | C | If an immediate report is available this information element shall contain the event reported by the MME/SGSN. The IWK-SCEF shall normalize the event report and send the normalized monitoring event report towards the SCEF as a separate Reporting-Information-Request message. | +| Supported Features (See 3GPP TS 29.229 [7]) | Supported-Features | O | If present, this Information Element shall contain the list of features supported by the origin host. | +| User Identity (See 6.4.16) | User-Identifier | O | If present in the subscription data received from the HSS, this information element shall contain the External-Identifier or the MSISDN. | + +**Table 5.4.1-2: Configuration-Information-Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat | Description | +|-------------------------------------------------------------------------------------|------------------------------------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-
Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [7]) | Supported-
Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Monitoring Event-
Configuration Status
(see 3GPP TS 29.336 [5] clause 8.4.24) | Monitoring-Event-
Config-Status | O | If present it shall contain the status of each monitoring event configuration identified by an SCEF-Reference-ID/SCEF-Reference-ID-Ext. | + +### 5.4.2 Detailed Behaviour of the IWK-SCEF + +When the Configuration-Information-Request is received from the MME/SGSN, the IWK-SCEF shall, in the following order: + +1. Check whether the requesting SCEF, identified by the SCEF-ID is authorized to request the specified service at the VPLMN. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) in the Configuration-Information-Answer. +2. Check whether the chargeable party for the monitoring event is authorized to be charged at the VPLMN. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) in the Configuration-Information-Answer. + +If the Configuration-Information-Request also carries the monitoring event report, the IWK-SCEF checks if the immediate events reported by the MME/SGSN needs to be normalized. If yes, the IWK-SCEF shall normalize the event report as per local policies. The IWK-SCEF shall then send the normalized monitoring event report towards the SCEF as a separate Reporting-Information-Request message. + +If the monitoring event configuration is for a continuous monitoring (i.e. Monitoring-Duration and/or Maximum-Number-Of-Reports are set), then the IWK-SCEF shall temporarily store the monitoring event configuration until the deletion criteria for the monitoring event configuration is met. If the deletion criteria are met, the IWK-SCEF shall delete the Monitoring event locally. The stored monitoring event configuration information shall be used during subsequent monitoring event report procedure, to generate the charging records towards the right chargeable party. + +If the received SCEF Reference ID for Deletion (either in SCEF-Reference-ID-for-Deletion or in SCEF-Reference-ID-for-Deletion-Ext AVPs) does not exist, the IWK-SCEF shall set the Experimental-Result-Code to DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_NON\_EXISTANT (5514). + +If the SCEF Reference ID (either in SCEF-Reference-ID or in SCEF-Reference-ID-Ext) exists and the old configuration data could not be replaced by new Configuration event data, the HSS shall set the Experimental-Result-Code to DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_STORAGE\_NOT\_SUCCESSFUL (5513). + +If the IWK-SCEF cannot fulfil the received request for reasons not stated in the above, it shall stop processing the request and set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +The details how to handle expiring of Monitoring events is described in 3GPP TS 23.682 [2] + +### 5.4.3 Detailed Behaviour of the MME/SGSN + +When the MME/SGSN receives the Configuration-Information-Answer from the IWK-SCEF, it shall handle it as follows: For the monitoring event configurations for which the configuration status have changed since last informed to + +the HSS, the MME/SGSN shall report the status to the HSS through a Notify-Request command as specified in clause 5.2.5 of 3GPP TS 29.272 [16]. + +## 5.5 MO-Data Procedure + +### 5.5.1 General + +This procedure shall be used between the MME/SGSN and the SCEF, between the MME/SGSN and the IWK-SCEF and between the IWK-SCEF and the SCEF. + +When the procedure is invoked by the MME or SGSN, it is used to forward mobile originated Non-IP data of a mobile user from the MME or SGSN to the SCEF. The procedure is also invoked by the MME on reception of RRC cause "MO Exception data". + +This procedure is used according to 3GPP TS 23.682 [2] clause 5.13.4. + +The IWK-SCEF may be in the path between the MME/SGSN and the SCEF for roaming cases when the IWK-SCEF is deployed by the operator of the visited PLMN. + +When the procedure is invoked by the IWK-SCEF, it is used to forward mobile originated Non-IP data received from the MME or SGSN to the SCEF. + +This procedure is mapped to the commands MO-Data-Request/Answer (ODR/ODA) in the Diameter application specified in clause 6. + +The tables 5.5.1-1 and 5.5.1-2 detail the involved information elements. + +**Table 5.5.1-1: MO Data Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | M | This Information Element shall be present and shall contain the identity of the UE. This is a grouped AVP which shall contain the IMSI. | +| EPS Bearer Identity
(See 6.4.17) | Bearer-Identifier | M | This information element shall be present and shall contain either the identity of the EPS bearer identifying the T6a connection, or the NSAPI of the PDP context identifying the T6b connection, for the Non-IP data delivery. | +| Non IP data
(See 6.4.19) | Non-IP-Data | C | This information element shall contain the Non-IP data to be delivered to the SCEF.
This Information Element shall be present when the request conveys Non-IP data. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| MO Exception Data Counter
(see 6.4.27) | RR-Cause-Counter | C | The MME shall include this Information Element when MME needs to send a non-zero counter value for the MO Exception Data Counter. The timestamp in the counter shall be set with the time at which the counter value increased from 0 to 1. | + +Table 5.5.1-2: MO Data Answer + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|--------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +### 5.5.2 Detailed Behaviour of the MME/SGSN + +The MME shall make use of this procedure over a T6a connection identified by its EPS bearer identity and previously established with the SCEF to forward the Non-IP data received from the UE to the SCEF or to an IWK-SCEF when deployed for a roaming case. + +The SGSN shall make use of this procedure over a T6b connection identified by the NSAPI of the PDP context, and previously established with the SCEF, to forward the Non-IP data received from the UE to the SCEF or to an IWK-SCEF when deployed for a roaming case. + +The MME shall increment the "MO Exception data counter" by one each time the MME has received the RRC cause "MO Exception data". The MME may defer sending a MO Data command message to report a non-zero value for the MO Exception Data Counter based on local configuration. + +If the MME has sent the RRC-Cause-Counter for RRC Cause "MO Exception data" in the MO Data Request command the MME shall reset the RRC-Cause-Counter when receiving MO Data Answer command. + +When receiving a Permanent Failure Result-Code/Experimental-Result, the MME or SGSN shall initiate a PDN disconnection procedure or Detach procedure towards the UE and if the permanent failure is different from DIAMETER\_ERROR\_INVALID\_EPS\_BEARER and different from DIAMETER\_ERROR\_USER\_UNKNOWN, the MME or SGSN shall make use of the "Connection Management by MME/SGSN" Procedure (see clause 5.7) to release the T6a/b connection between the MME/SGSN and the SCEF. + +### 5.5.3 Detailed Behaviour of the SCEF + +When the SCEF receives a MO Data Request from the MME/SGSN or the IWK-SCEF, the SCEF shall, in the following order: + +- Check that the User Identity exists in the SCEF. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the MO Data Answer; +- Check if, for this user, a bearer context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the MO Data Answer; +- Process the delivery of the data (if available) to the SCS/AS and/or process the RRC Cause Counter (if available). If the processing of either of them is not successful, return an appropriate Diameter error code, otherwise return a Result code set to DIAMETER\_SUCCESS to the MME/SGSN or IWK-SCEF. If the data delivery to the SCS/AS has failed due to there being no NIDD configuration context with an SCS/AS, set the Experimental-Result to DIAMETER\_ERROR\_NIDD\_CONFIGURATION\_NOT\_AVAILABLE in the MO Data Answer. + +NOTE: The Diameter Result-Code / Experimental-Result returned by the SCEF can depend on the error returned by the SCS/AS to the SCEF. The interface between the SCEF and the SCS/AS is out of scope of 3GPP. + +### 5.5.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a MO Data Request from the MME or SGSN, it shall forward the request to the SCEF. + +When the IWK-SCEF receives a MO Data Answer from the SCEF, it shall forward the answer to the MME or SGSN. + +## 5.6 MT Data Procedure + +### 5.6.1 General + +This procedure shall be used between the SCEF and the MME or SGSN, between the SCEF and the IWK-SCEF and between the IWK-SCEF and the MME or SGSN. + +When the procedure is invoked by the SCEF, it is used to forward mobile terminated Non-IP data of a mobile user from the SCEF to the MME or SGSN. + +This procedure is used according to 3GPP TS 23.682 [2] clause 5.13.3. + +The IWK-SCEF may be in the path between the SCEF and the MME/SGSN for roaming cases when the IWK-SCEF is deployed by the operator of the visited PLMN. + +When the procedure is invoked by the IWK-SCEF, it is used to forward mobile terminated Non-IP data received from the SCEF to the MME or SGSN. + +This procedure is mapped to the commands MT-Data-Request/Answer (TDR/TDA) in the Diameter application specified in clause 6. + +The tables 5.6.1-1 and 5.6.1-2 detail the involved information elements. + +NOTE: The corresponding message name in 3GPP TS 23.682 [2] is "NIDD Submit Request". + +**Table 5.6.1-1: MT Data Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------------------------|-----------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | M | This Information Element shall be present and shall contain the identity of the UE. This is a grouped AVP which shall contain the IMSI. | +| EPS Bearer Identity
(See 6.4.17) | Bearer-Identifier | M | This information element shall be present and shall contain either the identity of the EPS bearer identifying the T6a connection, or the NSAPI of the PDP context identifying the T6b connection, for the Non-IP data delivery. | +| Non-IP Data
(See 6.4.19) | Non-IP-Data | C | This information element shall contain the Non-IP data to be delivered to the MME or SGSN.
This Information Element shall be present when the request conveys Non-IP data. | +| SCEF Wait Time
(See 6.4.24) | SCEF-Wait-Time | O | This information element, when present, shall indicate the timestamp (in UTC) until which the SCEF expects a response. | +| Maximum Retransmission Time
(See 3GPP TS 29.338 [27]) | Maximum-Retransmission-Time | O | This information element, when present, shall indicate the maximum retransmission time (in UTC) until which the SCEF is capable to retransmit the MT Non-IP Data. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +Table 5.6.1-2: MT Data Answer + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------------|--------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-Result | M | This information element shall contain the Result of the request. The Result-Code AVP shall be used to indicate success or errors as defined in the Diameter Base Protocol. The Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Requested Retransmission Time
(See 3GPP TS 29.338 [27]) | Requested-Retransmission-Time | O | This information element may be present if the Experimental-Result-Code is set to DIAMETER_ERROR_USER_TEMPORARILY_UNREACHABLE and the Maximum Retransmission Time information element is present in the MT Data Request. It may be included if the UE is using a power saving mechanism (such as extended idle mode DRX) and the UE is currently not reachable.

When present, this shall indicate the retransmission time (in UTC) at which the SCEF is requested to retransmit the MT Non-IP Data. The Requested Retransmission Time shall not exceed the Maximum Retransmission Time received from the SCEF. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| TDA Flags
(See 6.4.31) | TDA-Flags | O | This Information Element contains a bit mask. See clause 6.4.31 for the meaning of the bits and the condition for each bit to be set or not. | + +### 5.6.2 Detailed Behaviour of the SCEF + +The SCEF shall make use of this procedure over a T6a connection identified by its EPS Bearer Identity, and previously established with the MME, to forward the Non-IP data received from the SCS/AS to the MME or to an IWK-SCEF when deployed for a roaming case. + +The SCEF shall make use of this procedure over a T6b connection identified by the NSAPI of the PDP context, and previously established with the SGSN, to forward the Non-IP data received from the SCS/AS to the SGSN or to an IWK-SCEF when deployed for a roaming case. + +The SCEF shall check if a bearer context exists for the user before sending the request. + +The SCEF may include the Maximum-Retransmission-Time AVP in the MT Data Request to indicate the maximum retransmission time for when it is capable to retransmit the Non-IP Data. + +If the MT Data Answer includes the Requested-Retransmission-Time AVP, the SCEF shall retransmit the MT Non-IP Data at the requested retransmission time. + +### 5.6.3 Detailed Behaviour of the MME/SGSN + +When the MME or SGSN receives a MT Data Request from the SCEF or the IWK-SCEF, the MME or SGSN shall, in the following order: + +- Check that the User Identity exists in the MME or SGSN. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the MT Data Answer; +- Check whether, for this user, a bearer context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the MT Data Answer. +- Process the data delivery to the UE and: + +- if it is successful, return a Result code set to DIAMETER\_SUCCESS to the SCEF or IWK-SCEF; in addition, if the successful delivery was acknowledged by the eNodeB, the MME/SGSN shall set the "Success Acknowledged Delivery" bit within the TDA-Flags AVP. +- return an Experimental-Result set to DIAMETER\_ERROR\_USER\_TEMPORARILY\_UNREACHABLE, if the UE is using a power saving function (e.g. extended idle mode DRX or UE Power Saving Mode as defined in 3GPP TS 23.682 [27]) and the UE is expected to not be reachable shortly or, based on MME or SGSN implementation, within the time indicated by the SCEF-Wait-Time; + +The MME or SGSN shall set the Not Reachable for NIDD flag and store the SCEF Host and Realm for which this flag is set; + +If the MT Data Request includes the Maximum-Retransmission-Time AVP, the MME or SGSN may additionally include the Requested-Retransmission-Time AVP requesting the SCEF to retransmit the Non-IP Data at a later time prior to the Maximum Retransmission Time; + +The MME or SGSN shall then update the SCEF, as specified in clause 5.7, when it detects that the UE is reachable or about to become reachable and the Not Reachable for NIDD flag is set. If the MME or SGSN included the Requested-Retransmission-Time AVP in the MT Data Answer, the MME or SGSN shall do so only if the UE becomes reachable before the Requested Retransmission Time, i.e. the MME or SGSN shall reset the Not Reachable for NIDD flag when the Requested-Retransmission-Time expires if the UE has not become reachable beforehand; + +- return an Experimental-Result set to DIAMETER\_ERROR\_UNREACHABLE\_USER, if the UE is not reachable; +- otherwise return an appropriate Diameter error code. + +### 5.6.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a MT Data Request from the SCEF, it shall forward the request to the MME or SGSN. + +When the IWK-SCEF receives a MT Data Answer from the MME or SGSN, it shall forward the answer to the SCEF. + +## 5.7 Connection Management by MME/SGSN Procedure. + +### 5.7.1 General + +This procedure shall be used between the MME/SGSN and the SCEF, between the MME/SGSN and the IWK-SCEF and between the IWK-SCEF and the SCEF. + +When the procedure is invoked by the MME or SGSN, it is used: + +- to establish a T6a/b connection between the MME/SGSN and the SCEF; +- to update the parameters (e.g. RAT-Type) for a T6a/b connection between the MME/SGSN and the SCEF; +- to update the status of a T6a/b connection between the MME/SGSN and the SCEF, e.g. to indicate to the SCEF that the UE has become or is about to become reachable when MT non-IP data is pending at the SCEF for a UE using a power saving function; + +This procedure is used according to 3GPP TS 23.682 [2] clause 5.13.1 and 5.13.5 and 5.13.6. The IWK-SCEF may be in the path between the MME/SGSN and the SCEF for roaming cases when the IWK-SCEF is deployed by the operator of the visited PLMN. + +When the procedure is invoked by the IWK-SCEF, it is used to forward the Connection Management Request received from the MME or SGSN to the SCEF. + +This procedure is mapped to the commands Connection-Management-Request/Answer (CMR/CMA) in the Diameter application specified in clause 6. + +The tables 5.7.1-1 and 5.7.1-2 detail the involved information elements. + +**Table 5.7.1-1: Connection Management Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------------|-------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | M | This Information Element shall be present and shall contain the identity of the UE. This is a grouped AVP which shall contain the IMSI. | +| EPS Bearer Identity
(See 6.4.17) | Bearer-Identifier | M | This Information Element shall be present and shall contain either the identity of the EPS bearer identifying the T6a connection, or the NSAPI of the PDP context of the T6b connection, to which the request applies. | +| T6a/b Connection Action
(See 6.4.18) | Connection-Action | M | This Information element shall be present and shall contain a T6a/b connection management action indicating a T6a/b connection establishment or a T6a/b connection release or a T6a/b connection update. | +| APN
(See 6.4.20) | Service-Selection | C | This Information element shall contain the APN the user wants to connect to.
It shall be present if the request is for a T6a/b connection establishment. | +| Serving PLMN Rate Control
(See 6.4.21) | Serving-PLMN-Rate-Control | O | If present, this information element shall contain the Serving PLMN rate control set by the MME. | +| CMR Flags
(See 6.4.25) | CMR-Flags | O | This Information Element contains a bit mask. See clause 6.4.25 for the meaning of the bits and the condition for each bit to be set or not. | +| Maximum UE Availability Time
(See 3GPP TS 29.338 [27]) | Maximum-UE-Availability-Time | O | This information element may be included, if available, if the Connection-Action AVP indicates a T6a/b connection update and the UE-Reachable-Indicator is set in the CMR-Flags AVP.

When present, it shall indicate the timestamp (in UTC) until which a UE using a power saving mechanism (such as extended idle mode DRX) is expected to be reachable for MT Non-IP Data Delivery.
This information may be used by the SCEF to prioritize the retransmission of MT Non-IP Data to UEs using a power saving mechanism. | +| Extended PCO | Extended-PCO | C | This Information Element shall be present, if the MME or SGSN receives Extended PCO information from the UE. | +| 3GPP Charging Characteristics
(See 3GPP TS 32.298 [30]) | 3GPP-Charging-Characteristics | C | This Information element shall contain the PDN Connection Charging Characteristics data for an APN Configuration with SCEF-based NIDD mechanism.
It shall be present if the request is for a T6a/b connection establishment and may be present if the request is for a T6a/b connection update. | +| RAT-Type
(See 3GPP TS 29.212 [10]) | RAT-Type | C | This Information Element shall contain the used RAT Type.
It shall be present if the request is for a T6a/b connection establishment or for a T6a/b connection update. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Terminal Information
(See 3GPP TS 29.272 [16]) | Terminal-Information | C | This Information Element shall contain the identity of the UE.
It shall be present if available. | +| Visited PLMN ID
(See 3GPP TS 29.272 [16]) | Visited-PLMN-Id | C | This Information Element shall contain the identity (MCC and MNC) of serving PLMN.
It shall be present if the request is for a T6a/b connection establishment or for a T6a/b connection update. | +| APN Rate Control Status (see 6.4.36) | APN-Rate-Control-Status | O | May be present if the request is for a T6a/b connection establishment. | + +**Table 5.7.1-2: Connection Management Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------------|--------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code /
Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| NIDD Charging Identifier
(See 3GPP TS 32.299 [22]) | PDN-Connection-Charging-Id | C | This Information element is defined in 3GPP TS 32.253 [23] and shall be present if the answer is for a T6a/b connection establishment. | +| Extended PCO | Extended-PCO | C | This Information Element shall be present, if the SCEF needs to send Extended PCO information to the UE. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| APN Rate Control Status (see 6.4.36) | APN-Rate-Control-Status | O | May be present if the response is for a T6a/b connection release. | + +### 5.7.2 Detailed Behaviour of the MME/SGSN + +The MME or SGSN shall make use of this procedure to request one of the following T6a/b connection management actions: + +- for a T6a/b connection establishment, the MME shall: + - include the user's IMSI. + - fill the EPS Bearer Identity information element with either the identity of the EPS bearer that MME allocated to the Non-IP PDN connection, or the NSAPI of the PDP context used by the SGSN for the Non-IP connection, as described in 3GPP TS 23.682 [2]; + - if Serving PLMN Rate Control is configured, the MME shall include the Serving PLMN Rate Control information as described in 3GPP TS 23.401 [25]; +- for a T6a/b connection release, the MME or SGSN shall: + - fill the EPS Bearer Identity information element with the identity of the EPS bearer of the T6a connection, or the NSAPI of the PDP context of the T6b connection, which is released as described in 3GPP TS 23.682 [2]; + - upon getting the Connection Management Answer from the SCEF, delete the T6a/b connection context; +- for a T6a/b connection update, the MME or SGSN shall: + - fill the EPS Bearer Identity information element with the identity of the EPS bearer of the T6a connection, or the NSAPI of the PDP context of the T6b connection, that needs to be updated; + - set the UE-Reachable-Indicator in the CMR-Flags AVP if the UE has become or is about to become reachable. The MME or SGSN may additionally include the Maximum UE Availability Time AVP, if available, to indicate the timestamp (in UTC) until which a UE using a power saving mechanism (such as extended idle mode DRX) is expected to be reachable for MT Non-IP Data Delivery; + - upon getting the Connection Management Answer from the SCEF, reset the Not Reachable for NIDD flag if this flag was set and if the UE-Reachable-Indicator was set in the CMR-Flags AVP in the Connection Management Request; + - if Serving PLMN Rate Control needs to be added or updated, the MME shall include Serving PLMN Rate Control information as described in 3GPP TS 23.401 [25]. + +NOTE: If the UE has several T6a/b connections to the same SCEF, for which Non-IP data is pending, the MME or SGSN initiates a T6a/b connection update for only one of the T6a/b connections towards this SCEF; the UE can have either T6a or T6b connections, but not both simultaneously. + +If the MME or SGSN receives the Extended-PCO AVP in the Connection Management Answer from the SCEF, the MME or SGSN shall forward the Extended-PCO to the UE transparently, as specified in 3GPP TS 24.301 [28]. + +### 5.7.3 Detailed Behaviour of the SCEF + +When the SCEF receives a Connection Management Request from the MME or SGSN the SCEF shall, in the following order: + +- check that the User Identity exists in the SCEF. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the Connection Management Answer; +- check that the T6a/b connection action indicates a T6a/b connection establishment, a T6a/b connection release or a T6a/b connection update. If not, the Experimental-Result shall be set to DIAMETER\_ERROR\_OPERATION\_NOT\_ALLOWED in the Connection Management Answer; +- if the T6a/b connection action indicates a T6a/b connection establishment: + - check whether a valid NIDD configuration exists for the UE at the SCEF; + - If not, the SCEF shall: + - reject the Connection Management Request, with Experimental-Result set to DIAMETER\_ERROR\_NIDD\_CONFIGURATION\_NOT\_AVAILABLE in the Connection Management Answer, or + - accept the Connection Management Request, and initiate a NIDD Configuration procedure with a default SCS/AS configured in the SCEF and the MSISDN or an external ID obtained from the HSS, as specified in 3GPP TS 29.336 [5] clause 7.2.3.2. If such NIDD Configuration procedure fails, the SCEF shall reject the Connection Management Request, with Experimental-Result set to DIAMETER\_ERROR\_NIDD\_CONFIGURATION\_NOT\_AVAILABLE in the Connection Management Answer; + - create an EPS bearer context; + - store the MME or SGSN Identity identified by the Origin-Host AVP of the T6a/b Connection Management Request, and the MME or SGSN realm identified by the Origin-Realm AVP of the T6a/b Connection Management Request in the EPS bearer context; + - include the Extended-PCO AVP in the Connection Management Answer, if the Extended PCO information (e.g. APN Rate Control information) needs to be provided to the UE; + - if Serving PLMN Rate Control is provided by the MME, restrict the number of messages for the downlink to not exceed the values provided in Serving PLMN Rate Control. If it is not provided and Serving PLMN Rate Control is active, then continue using the previously provided values; + - If successful, Result shall be set to DIAMETER\_SUCCESS in the Connection Management Answer; +- if the T6a/b connection action indicates a T6a/b connection release: + - check whether, for this user and the received EPS bearer ID, a T6a connection context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the Connection Management Answer; + - include the Extended-PCO AVP in the Connection Management Answer, if the Extended PCO information needs to be provided to the UE; + - delete the T6a/b connection context at the SCEF. If successful, Result code shall be set to DIAMETER\_SUCCESS in the Connection Management Answer; +- if the T6a/b connection action indicates a T6a connection update: + +- check whether, for this user and the received EPS Bearer Identity, a T6a/b connection context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the Connection Management Answer; +- if successful: + - if Serving PLMN Rate Control is provided by the MME, restrict the number of messages for the downlink to not exceed the values provided in Serving PLMN Rate Control. If it is not provided and Serving PLMN Rate Control is active, then continue using the previously provided values; + - include the Extended-PCO AVP in the Connection Management Answer, if the Extended PCO information (e.g. APN Rate Control information) needs to be provided to the UE; + - store the MME or SGSN Identity identified by the Origin-Host AVP of the T6a/b Connection Management Request and the MME or SGSN realm identified by the Origin-Realm AVP of the T6a/b Connection Management Request, if the MME or SGSN identity has changed, in the bearer context, and the Result shall be set to DIAMETER\_SUCCESS in the Connection Management Answer; + - if the UE-Reachable-Indicator was set in the CMR-Flags AVP, forward any MT Non-IP data pending for any T6a/b connection for this UE, to the MME or SGSN. + +If the Serving-PLMN-Rate-Control AVP is included in the Connection Management Request message from the MME, the SCEF shall enforce the Serving PLMN Rate Control as specified in 3GPP TS 23.401 [12] clause 4.7.7.2. + +### 5.7.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a Connection Management Request from the MME or SGSN, it shall forward the request to the SCEF. + +When the IWK-SCEF receives a Connection Management Answer from the SCEF, it shall forward the answer to the MME or SGSN. + +## 5.8 Connection Management by SCEF Procedure + +### 5.8.1 General + +This procedure shall be used between the SCEF and the MME/SGSN, and between the SCEF and the MME/SGSN via the IWK-SCEF acting as a Diameter proxy agent for roaming cases. + +When the procedure is invoked by the SCEF, it is used + +- to update the parameters (e.g. Extended PCO information) associated to a T6a/b connection between the MME/SGSN and the SCEF; +- to release a T6a/b connection between MME/SGSN and SCEF. + +This procedure is used according to 3GPP TS 23.682 [2]. The IWK-SCEF may be in the path between the MME/SGSN and the SCEF for roaming cases when the IWK-SCEF is deployed by the operator of the visited PLMN. + +This procedure is mapped to the commands Connection-Management-Request/Answer (CMR/CMA) in the Diameter application specified in clause 6. + +The tables 5.8.1-1 and 5.8.1-2 detail the involved information elements. + +**Table 5.8.1-1: Connection Management SCEF Request** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity
(See 6.4.16) | User-Identifier | M | This Information Element shall be present and shall contain the identity of the UE. This is a grouped AVP containing the IMSI. | +| EPS Bearer Identity
(See 6.4.17) | Bearer-Identifier | M | This Information Element shall be present and shall contain either the identity of the EPS bearer identifying the T6a connection, or the NSAPI of the PDP context identifying the T6b connection, to which the request applies. | +| T6a/b Connection Action
(See 6.4.18) | Connection-Action | M | This Information element shall be present and shall contain a T6a/b connection management action indicating a T6a/b connection update. | +| Extended PCO
(see 6.4.26) | Extended-PCO | C | This Information Element shall be present if the SCEF needs to send updated Extended PCO information (e.g. APN Rate Control information) to the UE. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 5.8.1-2: Connection Management SCEF Answer** + +| Information Element Name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 6.3) | Result-Code / Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter Base Protocol.
Experimental-Result AVP shall be used for T6a/b errors. This is a grouped AVP, which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Supported Features
(See 3GPP TS 29.229 [4]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +### 5.8.2 Detailed Behaviour of the SCEF + +The SCEF shall make use of this procedure to send the updated Extended PCO information (e.g. APN Rate Control information) to the UE during T6a/b connection update, if needed. If APN Rate Control information is included in the Extended-PCO AVP within the Connection Management SCEF Request message from the SCEF, the SCEF shall enforce the APN Rate Control as specified in 3GPP TS 23.401 [12] clause 4.7.7.3. + +The SCEF shall make use of this procedure to request the release of the T6a/b connection. + +### 5.8.3 Detailed Behaviour of the MME/SGSN + +When the MME or SGSN receives a Connection Management SCEF Request from the SCEF or the IWK-SCEF, the MME or SGSN shall, in the following order: + +- check that the User Identity exists in the MME or SGSN. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the Connection Management SCEF Answer; +- check that the T6a/b connection action indicates a T6a/b connection update or T6a/b connection release. If not, the Experimental-Result shall be set to DIAMETER\_ERROR\_OPERATION\_NOT\_ALLOWED in the Connection Management SCEF Answer; + +- check whether, for this user and the received EPS Bearer Identity, a T6a/b connection context exists. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_INVALID\_EPS\_BEARER in the Connection Management SCEF Answer; +- if the T6a/b connection action indicates a T6a/b connection update: + - if the Extended-PCO AVP is received, forward the Extended-PCO to the UE, as specified in 3GPP TS 24.301[28]. If successful, the Result code shall be set to DIAMETER\_SUCCESS in the Connection Management SCEF Answer. +- if the T6a/b connection action indicates T6a/b connection release, delete the T6a/b connection context at the MME/SGSN. If successful, the Result code shall be set to DIAMETER\_SUCCESS in the Connection Management SCEF Answer. + +### 5.8.4 Detailed Behaviour of the IWK-SCEF + +When the IWK-SCEF receives a Connection Management SCEF Request from the SCEF, it shall forward the request to the MME or SGSN. + +When the IWK-SCEF receives a Connection Management SCEF Answer from the MME or SGSN, it shall forward the answer to the SCEF. + +# --- 6 Protocol Specification and Implementation + +## 6.1 Introduction + +### 6.1.1 Use of Diameter Base Protocol + +The Diameter base protocol as specified in IETF RFC 6733 [32] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +### 6.1.2 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [4]. + +### 6.1.3 Accounting Functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the T6a/T6b interface, T6ai/T6bi interface and the T7 interface. + +### 6.1.4 Use of Sessions + +Diameter sessions shall be implicitly terminated between: + +- the MME/SGSN and the SCEF, for the T6a/T6b interface; +- the MME/SGSN and the IWK-SCEF, for the T6ai/T6bi interface and +- the IWK-SCEF and the SCEF for the T7 interface. + +An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [32]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +### 6.1.5 Transport Protocol + +Diameter messages over the T6a/T6b, T6ai/T6bi and T7 interface shall make use of SCTP IETF RFC 4960 [7] as transport protocol. + +### 6.1.6 Routing Considerations + +#### 6.1.6.1 Routing Considerations for Monitoring Event related Requests + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host for Monitoring Event related requests. + +The MME/SGSN shall use the SCEF-ID and the SCEF realm previously received over S6a/b for a monitoring event configuration as the Destination-Host AVP and the Destination-Realm AVP in the Reporting-Information-Request for the monitoring event reports sent over the T6a/T6b or T6ai/bi interface. + +The MME/SGSN shall use the pre-configured IWK-SCEF identify and the pre-configured IWK-SCEF realm as the Destination-Host AVP and the Destination Realm AVP in the Configuration-Information-Request for the monitoring event configuration sent over the T6ai/bi interface. + +The IWK-SCEF behaves as a Diameter Proxy agent according to IETF RFC 6733 [32] for the Reporting-Information-Request received from the MME/SGSN over the T6ai/bi interface and shall forward these requests to the SCEF over the T7 interface by keeping unchanged the Destination Realm and Destination Host AVPs. + +For monitoring events directly configured at the MME/SGSN by the SCEF, if the SCEF knows the address/name of the MME/SGSN, both the Destination-Realm AVP and the Destination-Host AVP shall be present in the request. Otherwise, only the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node. Consequently, the Destination-Host AVP is declared as optional in the ABNF for all Monitoring Event related requests initiated by the SCEF. + +The Destination-Realm AVP is declared as mandatory in the ABNF for all Monitoring Event related requests. The Destination-Host AVP is declared as optional in the ABNF description of the Reporting-Information-Request and of the Configuration Information-Request. + +#### 6.1.6.2 Routing Considerations for Non-IP Data Related Requests + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host for Non-IP Data related requests. + +The MME or SGSN shall use the SCEF-ID and the SCEF realm that it received in the subscribed APN associated to the T6a/b connection at its establishment as the Destination-Host AVP and the Destination realm AVP in the Non-IP data related request commands sent over the T6a/b and T6ai/bi interfaces. + +The Destination-Host AVP is declared as optional and the Destination realm AVP as mandatory in the ABNF description of the Non-IP data related requests initiated by the MME or SGSN. + +NOTE 1: For roaming cases, the routing of MME or SGSN initiated request commands to the IWK-SCEF relies on the Destination Realm AVP as according to the Diameter base protocol. + +NOTE 2: The Diameter implicitly terminated sessions and their Session ID for the Non-IP data related traffic are end to end between the MME/SGSN and the SCEF. + +The IWK-SCEF behaves as a Diameter Proxy agent according to IETF RFC 6733 [32] for the Non-IP related requests received from the MME or SGSN over the T6ai/bi interfaces and shall forward these requests to the SCEF over the T7 interface by keeping unchanged the Destination Realm and Destination Host AVPs. + +The SCEF obtains the Destination-Host AVP and the Destination-Realm AVP to use in the Non-IP data related requests towards an MME or SGSN from the Origin-Host AVP and the Origin-Realm AVP received in previous Non-IP Data related requests from the MME or SGSN. The Origin-Realm AVP in the requests received by the SCEF in roaming cases should contain the domain name of the network to which the MME or SGSN belongs, encoded as specified in clause 19.2 of 3GPP TS 23.003 [24]. + +The Destination-Host AVP is declared as optional and the Destination realm AVP as mandatory in the ABNF for the Non-IP Data related requests initiated by the SCEF. + +The IWK-SCEF behaves as a Diameter Proxy agent according to IETF RFC 3588 [3] for the Non-IP related requests received from the SCEF over the T7 interface and shall forward these requests to the MME or SGSN over the T6ai/bi interfaces by keeping unchanged the Destination Realm and Destination Host AVPs. + +#### 6.1.6.3 Handling of the Vendor-Specific-Application-Id AVP + +If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +### 6.1.7 Advertising Application Support + +The SCEF, MME, SGSN and the IWK-SCEF shall advertise support of the Diameter T6a/T6b Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +NOTE: Even though the reference point between the MME/SGSN and the IWK-SCEF is called T6ai/T6bi respectively and the reference point between the IWK-SCEF and the SCEF is called T7, all these reference points use the same Diameter Application ID. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [32]. + +### 6.1.8 Diameter Application Identifier + +The T6a/T6b interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the T6a/T6b interface application is 16777346. + +The T6ai/T6bi and the T7 interface protocol shall use the same Diameter application identifier as the T6a/T6b interface. + +### 6.1.9 Use of the Supported-Features AVP + +When new functionality is introduced on the T6a/T6b application, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. The usage of the Supported-Features AVP on the T6a/T6b application is consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [4]. + +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 [4], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, 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 reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +## 6.2 Commands + +### 6.2.1 Introduction + +This clause defines the Command code values and related ABNF for each command described in this specification. The ABNF for the commands on T6a/T6b, T6ai/T6bi and T7 are the same if not specified explicitly different. + +### 6.2.2 Command-Code values + +This clause defines Command-Code values for the T6a/T6b interface application as allocated by IANA. + +Every command is defined by means of the ABNF syntax IETF RFC 5234 [8], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [32]. When the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [32] shall apply. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with IETF RFC 6733 [32]. + +The following Command Codes are defined in this specification for T6a/T6b: + +**Table 6.2.2-1: Command-Code values for T6a/T6b** + +| Command-Name | Abbreviation | Code | Clause | +|-----------------------------------|--------------|---------|--------------------------------------------------------| +| Configuration-Information-Request | CIR | 8388718 | 3GPP TS 29.336 [5] clause 8.2.3 and clause 6.2.3 below | +| Configuration-Information-Answer | CIA | 8388718 | 3GPP TS 29.336 [5] clause 8.2.4 and clause 6.2.4 below | +| Reporting-Information-Request | RIR | 8388719 | 3GPP TS 29.336 [5] clause 8.2.5 and clause 6.2.5 below | +| Reporting-Information-Answer | RIA | 8388719 | 3GPP TS 29.336 [5] clause 8.2.6 and clause 6.2.6 below | +| Connection-Management-Request | CMR | 8388732 | 6.2.7 | +| Connection-Management-Answer | CMA | 8388732 | 6.2.8 | +| MO-Data-Request | ODR | 8388733 | 6.2.9 | +| MO-Data-Answer | ODA | 8388733 | 6.2.10 | +| MT-Data-Request | TDR | 8388734 | 6.2.11 | +| MT-Data-Answer | TDA | 8388734 | 6.2.12 | + +For these commands, the Application-ID field shall be set to 16777346 (application identifier of the T6a/T6b interface application, allocated by IANA). + +### 6.2.3 Configuration Information Request (CIR) Command + +The Configuration Information Request (CIR) command, indicated by the Command-Code field set to 8388718 and the "R" bit set in the Command Flags field, is sent from: + +- the SCEF to the MME/SGSN; +- the SCEF to the IWK-SCEF and +- the MME/SGSN to the IWK-SCEF + +This command is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Configuration-Information-Request command format is specified as following: + +Message Format: + +``` +< Configuration-Information-Request > ::= < Diameter Header: 8388718, REQ, PXY, 16777346 > + < Session-Id > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + *[ Supported-Features ] + *[ Monitoring-Event-Configuration ] + *[ Monitoring-Event-Report ] + [ User-Identifier ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] +``` + +### 6.2.4 Configuration-Information-Answer (CIA) Command + +The Configuration-Information-Answer (CIA) command, indicated by the Command-Code field set to 8388718 and the "R" bit cleared in the Command Flags field, is sent from: + +- the MME/SGSN to the SCEF; +- the IWK-SCEF to the SCEF and +- the IWK-SCEF to the MME/SGSN + +This command is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Configuration-Information-Answer command format is specified as following: + +Message Format: + +``` +< Configuration-Information-Answer > ::= < Diameter Header: 8388718, PXY, 16777346 > + < Session-Id > + [ DRMP ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ Supported-Features ] + *[ Monitoring-Event-Report ] + *[ Monitoring-Event-Config-Status ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] +``` + +### 6.2.5 Reporting-Information-Request (RIR) Command + +The Reporting-Information-Request (RIR) command, indicated by the Command-Code field set to 8388719 and the "R" bit set in the Command Flags field, is sent from: + +- the MME/SGSN to the SCEF; + +- the MME/SGSN to the IWK-SCEF and +- the IWK-SCEF to the SCEF. + +This command is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Reporting-Information-Request command format is specified as following: + +Message Format: + +``` +< Reporting-Information-Request > ::= < Diameter Header: 8388719, REQ, PXY, 16777346 > +< Session-Id > +[ DRMP ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Destination-Host ] +{ Destination-Realm } +[ OC-Supported-Features ] +*[ Supported-Features ] +[ User-Identifier ] +*[ Monitoring-Event-Report ] +**[ Proxy-Info ] +*[ Route-Record ] +*[AVP] +``` + +### 6.2.6 Reporting-Information-Answer (RIA) Command + +The Reporting-Information-Answer (RIA) command, indicated by the Command-Code field set to 8388719 and the "R" bit cleared in the Command Flags field, is sent from: + +- the SCEF to the MME/SGSN; +- the SCEF to the IWK-SCEF and +- the IWK-SCEF to the MME/SGSN. + +This command is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Reporting-Information-Answer command format is specified as following: + +Message Format: + +``` +< Reporting-Information-Answer > ::= < Diameter Header: 8388719, PXY, 16777346 > +< Session-Id > +[ DRMP ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +*[ Supported-Features ] +*[ Monitoring-Event-Report-Status ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +*[AVP] +``` + +### 6.2.7 Connection-Management-Request (CMR) Command + +The Connection-Management-Request (CMR) command, indicated by the Command-Code field set to 8388732 and the "R" bit set in the Command Flags field, is sent from: + +- the MME or SGSN to the SCEF; +- the MME or SGSN to the SCEF via the IWK-SCEF for roaming cases; +- the SCEF to the MME or SGSN; +- the SCEF to the MME or SGSN via the IWK-SCEF for roaming cases. + +For the T6a/b, T6ai/bi, T7 interfaces, the Connection-Management-Request command format is specified as following: + +Message Format: + +``` +< Connection-Management-Request > ::= < Diameter Header: 8388732, REQ, PXY, 16777346 > + < Session-Id > + < User-Identifier > + < Bearer-Identifier > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + [ OC-Supported-Features ] + [ CMR-Flags ] + [ Maximum-UE-Availability-Time ] + *[ Supported-Features ] + [ Connection-Action ] + [ Service-Selection ] + [ Serving-PLMN-Rate-Control ] + [ Extended-PCO ] + [ 3GPP-Charging-Characteristics ] + [ RAT-Type ] + [ Terminal-Information ] + [ Visited-PLMN-Id ] + [ APN-Rate-Control-Status ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] +``` + +### 6.2.8 Connection-Management-Answer (CMA) Command + +The Connection-Management-Answer (CMA) command, indicated by the Command-Code field set to 8388732 and the "R" bit cleared in the Command Flags field, is sent from: + +- the SCEF to the MME or SGSN; +- the SCEF to the MME or SGSN via the IWK-SCEF for roaming cases; +- the MME or SGSN to the SCEF; +- the MME or SGSN to the SCEF via the IWK-SCEF for roaming cases. + +For the T6a/b, T6ai/bi and T7 interfaces, the Connection-Management-Answer command format is specified as following: + +Message Format: + +``` +< Connection-Management-Answer > ::= < Diameter Header: 8388732, PXY, 16777346 > + < Session-Id > +``` + +``` + +[ DRMP ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Load ] +*[ Supported-Features ] +[ PDN-Connection-Charging-Id ] +[ Extended-PCO ] +[ APN-Rate-Control-Status ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +*[AVP] + +``` + +### 6.2.9 MO-Data-Request (ODR) Command + +The MO-Data-Request (ODR) command, indicated by the Command-Code field set to 8388733 and the "R" bit set in the Command Flags field, is sent from: + +- the MME or SGSN to the SCEF; +- the MME or SGSN to the IWK-SCEF and +- the IWK-SCEF to the SCEF. + +For the T6a/b, T6ai/bi, T7 interfaces, the MO-Data-Request command format is specified as following: + +Message Format: + +``` + +< MO-Data-Request > ::= < Diameter Header: 8388733, REQ, PXY, 16777346 > + < Session-Id > + < User-Identifier > + < Bearer-Identifier > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + [ OC-Supported-Features ] + *[ Supported-Features ] + [ Non-IP-Data ] + *[ Proxy-Info ] + *[ Route-Record ] + [ RRC-Cause-Counter ] + *[AVP] + +``` + +### 6.2.10 MO-Data-Answer (ODA) Command + +The MO-Data-Answer (ODA) command, indicated by the Command-Code field set to 8388733 and the "R" bit cleared in the Command Flags field, is sent from: + +- the SCEF to the MME or SGSN; +- the SCEF to the IWK-SCEF and +- the IWK-SCEF to the MME or SGSN. + +For the T6a/b, T6ai/bi and T7 interfaces, the MO-Data-Answer command format is specified as following: + +Message Format: + +``` + +< MO-Data-Answer > ::= < Diameter Header: 8388733, PXY, 16777346 > + < Session-Id > + [ DRMP ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] + +``` + +### 6.2.11 MT-Data-Request (TDR) Command + +The MT-Data-Request (TDR) command, indicated by the Command-Code field set to 8388734 and the "R" bit set in the Command Flags field, is sent from: + +- the SCEF to the MME or SGSN; +- the SCEF to the IWK-SCEF and +- the IWK-SCEF to the MME or SGSN. + +For the T6a/b, T6ai/bi, T7 interfaces, the MT-Data-Request command format is specified as following: + +Message Format: + +``` + +< MT-Data-Request > ::= < Diameter Header: 8388734, REQ, PXY, 16777346 > + < Session-Id > + < User-Identifier > + < Bearer-Identifier > + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + [ OC-Supported-Features ] + *[ Supported-Features ] + [ Non-IP-Data ] + [ SCEF-Wait-Time ] + [ Maximum-Retransmission-Time ] + *[ Proxy-Info ] + *[ Route-Record ] + *[AVP] + +``` + +### 6.2.12 MT-Data-Answer (TDA) Command + +The MT-Data-Answer (TDA) command, indicated by the Command-Code field set to 8388734 and the "R" bit cleared in the Command Flags field, is sent from: + +- the MME or SGSN to the SCEF; +- the MME or SGSN to the IWK-SCEF and +- the IWK-SCEF to the SCEF. + +For the T6a/b, T6ai/bi and T7 interfaces, the MT-Data-Answer command format is specified as following: + +Message Format: + +``` + +< MT-Data-Answer > ::= < Diameter Header: 8388734, PXY, 16777346 > + < Session-Id > + [ DRMP ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + [ Requested-Retransmission-Time ] + *[ Supported-Features ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + [ TDA-Flags ] + *[AVP] + +``` + +## 6.3 Result-Code AVP and Experimental-Result AVP Values + +### 6.3.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 6.3.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [32] shall be applied. + +### 6.3.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in the Diameter base protocol specified IETF RFC 6733 [32] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 6.3.3.1 DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) + +This result code shall be sent by the MME/SGSN or the IWK-SCEF to indicate that the SCEF is not allowed to request Monitoring services. This error code is defined in 3GPP TS 29.336 [5]. + +#### 6.3.3.2 DIAMETER\_ERROR\_UNAUTHORIZED\_SERVICE (5511) + +This result code shall be sent by the MME/SGSN or the IWK-SCEF to indicate that the specific service requested by the SCEF is not allowed as per local policies. This error code is defined in 3GPP TS 29.336 [5]. + +#### 6.3.3.3 DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_STORAGE\_NOT\_SUCCESSFUL (5513) + +This result code shall be sent by the MME/SGSN to indicate that the specific service requested by the SCEF could not be stored. This error code is defined in 3GPP TS 29.336 [5]. + +#### 6.3.3.4 DIAMETER\_ERROR\_CONFIGURATION\_EVENT\_NON\_EXISTANT (5514) + +This result code shall be sent by the IWK-SCEF to indicate that the requested deletion by the MME/SGSN could not be performed because the event does not exist. This error code is defined in 3GPP TS 29.336 [5]. + +#### 6.3.3.5 DIAMETER\_ERROR\_REQUESTED\_LOCATION\_NOT\_SERVED (5650) + +This result code shall be sent by the MME/SGSN to indicate that the location for which a related monitoring event is configured (e.g. Number of UEs at a given geographical location) by the SCEF, is not served by the MME/SGSN. + +#### 6.3.3.6 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the SCEF or the MME/SGSN to indicate that the user identified by the IMSI is unknown. This error code is defined in 3GPP TS 29.229 [4]. + +#### 6.3.3.7 DIAMETER\_ERROR\_OPERATION\_NOT\_ALLOWED (5101) + +This result code shall be sent by the SCEF to indicate that the operation is not allowed when an EPS bearer context exists for the user. This error code is defined in 3GPP TS 29.329 [17]. + +This result code shall be sent by the SCEF or the MME/SGSN to indicate that the requested T6a/b connection action is not allowed. + +#### 6.3.3.8 DIAMETER\_ERROR\_INVALID\_EPS\_BEARER (5651) + +This result code shall be sent by the SCEF or the MME/SGSN to indicate that there is no bearer context for the user. + +#### 6.3.3.9 DIAMETER\_ERROR\_NIDD\_CONFIGURATION\_NOT\_AVAILABLE (5652) + +This result code shall be sent by the SCEF to indicate that there is no valid NIDD configuration available. + +#### 6.3.3.10 DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN (5515) + +This result code shall be sent by the SCEF to indicate that the SCEF reference ID is not known by the SCEF. + +#### 6.3.3.11 DIAMETER\_ERROR\_USER\_TEMPORARILY\_UNREACHABLE (5653) + +This result code shall be sent by the MME or SGSN to indicate that the UE is temporarily not reachable due to a power saving function, and that the MME or SGSN will update the SCEF when it detects that the UE is reachable or about to become reachable as specified in clause 5.6.3. + +#### 6.3.3.12 DIAMETER\_ERROR\_UNREACHABLE\_USER (4221) + +This result code shall be sent by the MME to indicate that the UE is not reachable. This error code is defined in 3GPP TS 29.172 [26]. + +## 6.4 AVPs + +### 6.4.1 General + +The following table specifies the Diameter AVPs defined for the T6a/T6b interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415). + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +Table 6.4.1-1: T6a/T6b specific Diameter AVPs + +| | | | | AVP Flag rules | | | | | +|-----------------------------------------|----------|----------------|-------------|----------------|-----|------------|----------|-----------| +| Attribute Name | AVP Code | Clause defined | Value Type | Must | May | Should not | Must not | May Encr. | +| Communication-Failure-Information | 4300 | 6.4.4 | Grouped | M,V | | | | No | +| Cause-Type | 4301 | 6.4.5 | Unsigned32 | M,V | | | | No | +| S1AP-Cause | 4302 | 6.4.6 | Unsigned32 | M,V | | | | No | +| RANAP-Cause | 4303 | 6.4.7 | Unsigned32 | M,V | | | | No | +| BSSGP-Cause | 4309 | 6.4.8 | Unsigned32 | M,V | | | | No | +| GMM-Cause | 4304 | 6.4.9 | Unsigned32 | M,V | | | | No | +| SM-Cause | 4305 | 6.4.10 | Unsigned32 | M,V | | | | No | +| Number-Of-UE-Per-Location-Configuration | 4306 | 6.4.11 | Grouped | M,V | | | | No | +| Number-Of-UE-Per-Location-Report | 4307 | 6.4.12 | Grouped | M,V | | | | No | +| UE-Count | 4308 | 6.4.13 | Unsigned32 | M,V | | | | No | +| Connection-Action | 4314 | 6.4.18 | Unsigned32 | M,V | | | | No | +| Non-IP-Data | 4315 | 6.4.19 | OctetString | M,V | | | | No | +| Serving-PLMN-Rate-Control | 4310 | 6.4.21 | Grouped | M,V | | | | No | +| Uplink-Rate-Limit | 4311 | 6.4.23 | Unsigned32 | M,V | | | | No | +| Downlink-Rate-Limit | 4312 | 6.4.22 | Unsigned32 | M,V | | | | No | +| Extended-PCO | 4313 | 6.4.26 | OctetString | M,V | | | | No | +| SCEF-Wait-Time | 4316 | 6.4.24 | Time | M,V | | | | No | +| CMR-Flags | 4317 | 6.4.25 | Unsigned32 | M,V | | | | No | +| RR-Cause-Counter | 4318 | 6.4.27 | Grouped | M,V | | | | No | +| Counter-Value | 4319 | 6.4.28 | Unsigned32 | M,V | | | | No | +| RR-Counter-Timestamp | 4320 | 6.4.29 | Time | M,V | | | | No | +| TDA-Flags | 4321 | 6.4.31 | Unsigned32 | V | | | M | No | +| Idle-Status-Indication | 4322 | 6.4.32 | Grouped | V | | | M | No | +| Idle-Status-Timestamp | 4323 | 6.4.33 | Time | V | | | M | No | +| Active-Time | 4324 | 6.4.34 | Unsigned32 | V | | | M | No | +| Reachability-Cause | 4325 | 6.4.35 | Unsigned32 | V | | | M | No | +| APN-Rate-Control-Status | 4326 | 6.4.36 | Grouped | V | | | M | No | +| Uplink-Number-Of-Packets-Allowed | 4327 | 6.4.37 | Unsigned32 | V | | | M | No | +| Number-Of-Additional-Exception-Reports | 4328 | 6.4.38 | Unsigned32 | V | | | M | No | +| Downlink-Number-Of-Packets-Allowed | 4329 | 6.4.39 | Unsigned32 | V | | | M | No | +| APN-Rate-Control-Status-Validity-Time | 4330 | 6.4.40 | Unsigned64 | V | | | M | No | + +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 [32]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table specifies the Diameter AVPs re-used by the T6a/T6b interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within T6a/T6b. + +Any 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 6.4.1-2, but they may be re-used for the T6a/T6b protocol. + +**Table 6.4.1-2: T6a/T6b re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | +|-------------------------------------|---------------------|-----------------------------------------------------------------------------------------------------------------------------| +| Monitoring-Event-Configuration | 3GPP TS 29.336 [5] | This AVP shall contain the monitoring event to be configured at the MME/SGSN or the IWK-SCEF. See 6.4.2. | +| Monitoring-Event-Report | 3GPP TS 29.336 [5] | This AVP shall contain the monitoring event reported by the MME/SGSN or the IWK-SCEF. See 6.4.3. | +| SCEF-Reference-ID | 3GPP TS 29.336 [5] | | +| SCEF-ID | 3GPP TS 29.336 [5] | | +| SCEF-Reference-ID-for-Deletion | 3GPP TS 29.336 [5] | | +| Supported-Features | 3GPP TS 29.229 [4] | | +| Feature-List-ID | 3GPP TS 29.229 [4] | | +| Feature-List | 3GPP TS 29.229 [4] | See 6.4.14 | +| OC-Supported-Features | IETF RFC 7683 [9] | | +| OC-OLR | IETF RFC 7683 [9] | | +| Monitoring-Event-Config-Status | 3GPP TS 29.336 [5] | This AVP shall contain the status of configuration of each monitoring event identified by an SCEF-ID and SCEF-Reference-ID. | +| DRMP | IETF RFC 7944 [15] | see 6.4.15 | +| User-Identifier | 3GPP TS 29.336 [5] | See 6.4.16 | +| Bearer-Identity | 3GPP TS 29.212 [10] | See 6.4.17 | +| Monitoring-Type | 3GPP TS 29.336 [5] | | +| Loss-Of-Connectivity-Reason | 3GPP TS 29.336 [5] | | +| Maximum-Number-of-Reports | 3GPP TS 29.336 [5] | | +| Monitoring-Duration | 3GPP TS 29.336 [5] | | +| Charged-Party | 3GPP TS 32.299 [20] | | +| UE-Reachability-Configuration | 3GPP TS 29.336 [5] | | +| Location-Information-Configuration | 3GPP TS 29.336 [5] | | +| Reachability-Information | 3GPP TS 29.336 [5] | | +| EPS-Location-Information | 3GPP TS 29.272 [16] | | +| Service-Selection | IETF RFC 5778 [21] | See 6.4.20 | +| PDN-Connection-Charging-Id | 3GPP TS 32.299 [22] | | +| Maximum-Retransmission-Time | 3GPP TS 29.338 [27] | | +| Requested-Retransmission-Time | 3GPP TS 29.338 [27] | | +| Maximum-UE-Availability-Time | 3GPP TS 29.338 [27] | | +| 3GPP-Charging-Characteristics | 3GPP TS 29.061 [29] | | +| RAT-Type | 3GPP TS 29.212 [10] | | +| Terminal-Information | 3GPP TS 29.272 [16] | See 6.4.30 | +| Visited-PLMN-Id | 3GPP TS 29.272 [16] | | +| Load | IETF RFC 8583 [31] | | +| Subscribed-Periodic-RAU-TAU-Timer | 3GPP TS 29.272 [16] | | +| Monitoring-Event-Report-Status | 3GPP TS 29.336 [5] | | +| IMSI-Group-Id | 3GPP TS 29.272 [16] | | +| Reporting-Time-Stamp | 3GPP TS 29.336 [5] | | +| eDRX-Cycle-Length | 3GPP TS 29.272 [16] | | +| DL-Buffering-Suggested-Packet-Count | 3GPP TS 29.272 [16] | | +| PDN-Connectivity-Status-Report | 3GPP TS 29.336 [5] | | +| SCEF-Reference-ID-Ext | 3GPP TS 29.336 [5] | | +| SCEF-Reference-ID-for-Deletion-Ext | 3GPP TS 29.336 [5] | | + +### 6.4.2 Monitoring-Event-Configuration + +The Monitoring-Event-Configuration AVP is of type Grouped. It shall contain the Monitoring event configuration related data. It is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Monitoring-Event-Configuration AVP format is specified as following: + +AVP format: + +``` +Monitoring-Event-Configuration ::= + [ SCEF-Reference-ID ] + [ SCEF-Reference-ID-Ext ] + { SCEF-ID } + { Monitoring-Type } + *[ SCEF-Reference-ID-for-Deletion ] + *[ SCEF-Reference-ID-for-Deletion-Ext ] + [ Maximum-Number-of-Reports ] + [ Monitoring-Duration ] + [ Charged-Party ] + [ UE-Reachability-Configuration ] + [ Location-Information-Configuration ] + *[ Number-Of-UE-Per-Location-Configuration ] + *[AVP] +``` + +When the "Extended Reference IDs" feature is supported by the SCEF and MME/SGSN, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used instead of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. + +### 6.4.3 Monitoring-Event-Report + +The Monitoring-Event-Report AVP is of type Grouped. It shall contain the Monitoring event report data. It is originally defined in 3GPP TS 29.336 [5]. + +For the T6a/T6b interface, the Monitoring-Event-Report AVP format is specified as following: + +AVP format: + +``` +Monitoring-Event-Report ::= + { SCEF-Reference-ID } + [ SCEF-Reference-ID-Ext ] + [ SCEF-ID ] + [ Monitoring-Type ] + [ Reachability-Information ] + [ EPS-Location-Information ] + [ Communication-Failure-Information ] +``` + +\*[ Number-Of-UE-Per-Location-Report ] +[ Loss-Of-Connectivity-Reason ] +[ Visited-PLMN-Id ] +[ Idle-Status-Indication ] +[ Reporting-Time-Stamp ] +[ Maximum-UE-Availability-Time ] +\*[ PDN-Connectivity-Status-Report ] +[ Reachability-Cause ] +\*[AVP] + +The AVPs applicable for each Monitoring-Type reported by the MME/SGSN are specified under clause 5.2.2. + +When the "Extended Reference IDs" feature is supported by the SCEF and MME/SGSN, the SCEF-Reference-ID-Ext AVP shall be used insted of SCEF-Reference-ID; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. + +### 6.4.4 Communication-Failure-Information + +The Communication-Failure-Information AVP is of type Grouped. It shall contain the reason for communication failure. + +AVP format: + +Communication-Failure-Information ::= +[ Cause-Type ] +[ SIAP-Cause ] +[ RANAP-Cause ] +[ BSSGP-Cause ] +[ GMM-Cause ] +[ SM-Cause ] +\*[AVP] + +### 6.4.5 Cause-Type + +The Cause-Type AVP is of type Unsigned32 and it shall identify the type of the SIAP-Cause. The following values are defined: + +RADIO\_NETWORK\_LAYER (0) +TRANSPORT\_LAYER (1) +NAS (2) +PROTOCOL (3) +MISCELLANEOUS (4) + +### 6.4.6 S1AP-Cause + +The S1AP-Cause AVP is of type Unsigned32. It shall contain a non-transparent copy of the S1AP cause code as specified clause 9.2.1.3 of 3GPP TS 36.413 [13]. The RAN cause sub-category of the S1AP-Cause as specified in 3GPP TS 36.413 [13] shall be encoded in the Cause-Type AVP as specified in clause 6.4.5 above. + +### 6.4.7 RANAP-Cause + +The RANAP-Cause AVP is of type Unsigned32. It shall contain the non-transparent copy of the cause value of the RANAP cause code as specified in clause 9.2.1.4 of 3GPP TS 25.413 [11]. + +### 6.4.8 BSSGP-Cause + +The BSSGP-Cause AVP is of type Unsigned32. It shall contain the non-transparent copy of the cause value of the BSSGP "Cause" as specified in clause 11.3.8 in 3GPP TS 48.018 [14]. + +### 6.4.9 GMM-Cause + +The GMM-Cause AVP is of type Unsigned32. It shall contain the GMM cause code as specified in clause 10.5.5.14 of 3GPP TS 24.008 [12]. + +### 6.4.10 SM-Cause + +The SM-Cause AVP is of type Unsigned32. It shall contain the SM cause code as specified in clause 10.5.6.6 and 10.5.6.6A of 3GPP TS 24.008 [12]. + +### 6.4.11 Number-Of-UE-Per-Location-Configuration + +The Number-Of-UE-Per-Location-Configuration AVP is of type Grouped. It shall contain the location information for which the number of UEs needs to be reported by the MME/SGSN. + +AVP format: + +``` +Number-of-UE-Per-Location-Configuration ::= + { EPS-Location-Information } + [ IMSI-Group-Id ] + *[AVP] +``` + +### 6.4.12 Number-Of-UE-Per-Location-Report + +The Number-Of-UE-Per-Location-Report AVP is of type Grouped. It shall contain the location information along with the number of UEs found at that location by the MME/SGSN. + +AVP format: + +``` +Number-of-UE-Per-Location-Report ::= + { EPS-Location-Information } + { UE-Count } + [ IMSI-Group-Id ] + *[AVP] +``` + +### 6.4.13 UE-Count + +The UE-Count AVP is of type Unsigned32. It shall contain the number of UEs counted against a given criteria (say location information). + +### 6.4.14 Feature-List AVP + +#### 6.4.14.1 Feature-List AVP for the T6a/T6b application + +The syntax of this AVP is defined in 3GPP TS 29.229 [4]. + +For the T6a/b application, the meaning of the bits shall be as defined in table 6.4.14.1-1 for the Feature-List-ID. + +**Table 6.4.14.1-1: Features of Feature-List-ID used in T6a/b** + +| Feature bit | Feature | M/O | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | MONTE | O |

Configuration and reporting of monitoring events

This feature is applicable to from an SCEF with CIR/CIA command pair and the reporting of events to the SCEF with RIR/RIA command pair.

If the MME/SGSN does not support this feature, the SCEF shall not send monitoring event configurations to the HSS within CIR.

| +| 1 | NIDD | O |

Support of Non-IP Data service over T6a/b

This feature is applicable to CMR/CMA, ODR/ODA and TDR/TDA command pairs.

If the SCEF does not indicate support of this feature in an CMA, the MME or SGSN may store this information and not send any further CMR commands to that SCEF.

| +| 2 | Filtering | O |

Filtering Number of UEs present at given location by IMSI-Group

This feature is applicable to the CIR/CIA command pair.

If the MME/SGSN does not support this feature, the SCEF shall interpret the reported number of UEs per location as not being filtered by the provided IMSI-Group-Id.

| +| 3 | Extended Reference IDs | O |

Extended Reference IDs

This feature is applicable for the CIR/CIA and RIR/RIA command pairs.

If the SCEF detects that the MME/SGSN does not support this feature, it shall refrain from sending CIR commands containing 64-bit long SCEF Reference IDs.

If the MME/SGSN detects that the SCEF does not support this feature, it shall refrain from sending RIR commands containing 64-bit long SCEF Reference IDs.

| +|

Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "MONTE".
M/O: Defines if the implementation of the feature is mandatory ("M") or optional ("O").
Description: A clear textual description of the feature.

| | | | + +### 6.4.15 DRMP + +The DRMP AVP is of type Enumerated and it is defined in IETF RFC 7944 [15]. This AVP allows the MME, the SGSN, the SCEF and the IWK-SCEF to indicate the relative priority of Diameter messages. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +### 6.4.16 User-Identifier + +The User-Identifier AVP is of type Grouped and it contains the different identifiers used by the UE. + +It is defined in 3GPP TS 29.336 [5] + +### 6.4.17 Bearer-Identifier + +The Bearer-Identifier AVP contains either the identity of the EPS bearer used to identify the T6a connection between the MME and the SCEF or the NSAPI of the PDP context identifying the T6b connection between the SGSN and the SCEF. It is defined in 3GPP TS 29.212 [10]. + +### 6.4.18 Connection-Action + +The Connection-Action AVP is of type Unsigned32 and it shall identify the action to be performed on the T6a/b connection. The following values are defined: + +#### CONNECTION\_ESTABLISHMENT (0) + +This value shall be used if the T6a/b Connection-Management-Request applies to a T6a/b connection establishment. + +#### CONNECTION\_RELEASE (1) + +This value shall be used if the T6a/b Connection-Management-Request applies to a T6a/b connection release. + +#### CONNECTION\_UPDATE (2) + +This value shall be used if the T6a/b Connection-Management-Request applies to updating the properties of a T6a/b connection. + +### 6.4.19 Non-IP-Data + +The Non-IP-Data AVP is of type OctetString and it contains the Non-IP data conveyed between the MME or SGSN and the SCEF. + +### 6.4.20 Service-Selection + +The Service-Selection AVP is of type of UTF8String. This AVP shall contain the APN Network Identifier as specified in 3GPP TS 23.003 [24] clause 9.1. + +The contents of the Service-Selection AVP shall be formatted as a character string composed of one or more labels separated by dots ("."). + +This AVP is originally defined in IETF RFC 5778[21]. + +### 6.4.21 Serving-PLMN-Rate-Control + +The Serving-PLMN-Rate-Control AVP is of type Grouped and shall contain. + +The AVP format shall conform to: + +Serving-PLMN-Rate-Control::= + +[ Uplink-Rate-Limit ] + +[ Downlink-Rate-Limit ] + +\*[AVP] + +A Downlink-Rate-Limit set to 0 shall be interpreted that the Serving PLMN Rate Control for downlink messages is deactivated in the MME. If the Serving PLMN Rate Control is activated, the value of Downlink-Rate-Limit shall not be less than 10, see 3GPP TS 23.401 [25]. + +An Uplink-Rate-Limit set at 0 shall be interpreted that the Serving PLMN Rate Control for uplink messages is deactivated in the MME. If Serving PLMN Rate Control is activated, the value of Uplink-Rate-Limit shall not be less than 10, see 3GPP TS 23.401 [25]. + +### 6.4.22 Downlink-Rate-Limit + +The Downlink-Rate-Limit AVP is of type type Unsigned32 and shall contain the maximum number of NAS Data PDUs per deci hour for this UE for downlink. + +### 6.4.23 Uplink-Rate-Limit + +The Uplink-Rate-Limit AVP is of type Unsigned32 and shall contain the maximum number of NAS Data PDUs per deci hour for this UE for uplink. + +### 6.4.24 SCEF-Wait-Time + +The SCEF-Wait-Time is of type Time and it shall contain the timestamp (in UTC) until which the SCEF expects a response. + +### 6.4.25 CMR-Flags + +The CMR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 6.4.25/1: + +**Table 6.4.25/1: CMR-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------------|------------------------|-----------------------------------------------------------------------------------| +| 0 | UE-Reachable-Indicator | This bit if set indicates that the UE has become or is about to become reachable. | +| NOTE 1: Bits not defined in this table shall be cleared by the sending entity and discarded by the receiving entity. | | | + +### 6.4.26 Extended-PCO + +The Extended-PCO AVP is of type OctetString. The Extended-PCO AVP shall contain the value part of the ePCO IE, starting from octet 4, as specified in clause 9.9.4.26 of 3GPP TS 24.301[28]. + +### 6.4.27 RRC-Cause-Counter + +The RRC-Cause-Counter AVP is of type Grouped and shall contain the number of receptions of "MO Exception data" and the time when the cause " MO Exception Data" is received for the first time. + +The AVP format shall conform to: + +``` + +RRC-Cause-Counter ::= + [ Counter-Value ] + [ RRC-Counter-Timestamp ] + *[AVP] + +``` + +### 6.4.28 Counter-Value + +The Counter-Value AVP is of type type Unsigned32 and shall contain the number of occurrences of reception of RRC cause "MO Exception data". + +### 6.4.29 RRC-Counter-Timestamp + +The RRC-Counter-Timestamp AVP is of type Time and shall contain a timestamp. + +### 6.4.30 Terminal-Information + +The Terminal-Information AVP is of type Grouped. This AVP shall contain the information about the user's terminal. It is originally defined in 3GPP TS 29.272 [16]. + +AVP format + +``` +Terminal-Information ::= + [ IMEI ] + [ Software-Version ] + *[ AVP ] +``` + +### 6.4.31 TDA-Flags + +The TDA-Flags AVP is of type Unsigned32 and it shall contain a bit map. The meaning of the bits shall be as defined in table 6.4.31-1: + +**Table 6.4.31-1: TDA-Flags** + +| Bit | Name | Description | +|------|--------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------| +| 0 | Acknowledged Delivery | This bit when set indicates that eNodeB has acknowledged the successful downlink NIDD delivery. | +| NOTE | Bits not defined in this table shall be cleared by the sending entity and discarded by the receiving entity. | | + +### 6.4.32 Idle-Status-Indication + +The Idle-Status-Indication AVP is of type Grouped, and it shall contain the details when the UE transitions into idle mode. + +AVP format: + +``` +Idle-Status-Indication ::= + [ Idle-Status-Timestamp ] + [ Active-Time ] + [ Subscribed-Periodic-RAU-TAU-Timer ] + [ eDRX-Cycle-Length ] + [ DL-Buffering-Suggested-Packet-Count ] + *[AVP] +``` + +The Subscribed-Periodic-RAU-TAU-Timer AVP shall contain the periodic TAU/RAU time granted to the UE by the MME/SGSN. + +The eDRX-Cycle-Length AVP shall contain the eDRX cycle length granted to the UE by the MME/SGSN. + +The DL-Buffering-Suggested-Packet-Count AVP shall contain the suggested number of downlink packets sent to the S-GW by the MME/SGSN. + +### 6.4.33 Idle-Status-Timestamp + +The Idle-Status-Timestamp AVP is of type Time and shall contain a timestamp (the time at which the UE transitioned into idle mode). + +### 6.4.34 Active-Time + +Active-Time AVP is of type Unsigned32 and shall provide the active time granted to the UE in seconds. + +### 6.4.35 Reachability-Cause + +The Reachability-Cause AVP is of type Unsigned32. The following values are defined: + +CHANGE\_TO\_CONNECTED\_MODE (0) + +REACHABLE\_FOR\_PAGING (1) + +Annex A (normative): +Diameter overload control mechanism + +### 6.4.36 APN-Rate-Control-Status + +The APN-Rate-Control-Status AVP is of type Grouped. It shall contain APN Rate Control Status Information as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +### 6.4.37 Uplink-Number-Of-Packets-Allowed + +The Uplink-Number-Of-Packets-Allowed AVP is of type Unsigned32. It shall contain information of octets k+1 to k+4 as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +### 6.4.38 Number-Of-Additional-Exception-Reports + +The Number-Of-Additional-Exception-Reports AVP is of type Unsigned32. It shall contain information of octets k+5 to k+8 as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +### 6.4.39 Downlink-Number-Of-Packets-Allowed + +The Downlink-Number-Of-Packets-Allowed AVP is of type Unsigned32. It shall contain information of octets k+9 to k+12 as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +### 6.4.40 APN-Rate-Control-Status-Validity-Time + +The APN-Rate-Control-Status-Validity-Time AVP is of type Unsigned64. It shall contain information of octets k+13 to k+20 as specified in figure 8.38-10 of 3GPP TS 29.274 [33]. + +## --- A.1 T6a/b and T7 interfaces + +### A.1.1 General + +The Diameter overload control mechanism is an optional feature over the T6a/b and T7 interface, which may be applied to the traffic of requests commands sent to the SCEF and/or to the traffic of request commands sent to the MME or SGSN. + +It is recommended to make use of the IETF RFC 7683 [9] on the T6a/b and T7 interface where: + +- when applied to the traffic of request commands sent to the SCEF, the SCEF shall behave as a reporting node while the MME/SGSN, and as an alternative the IWK-SCEF shall behave as a reacting node; +- when applied to the traffic of request commands sent to the MME or SGSN, the MME or SGSN shall behave as a reporting node while the SCEF, and as an alternative the IWK-SCEF, shall behave as a reacting node. + +### A.1.2 SCEF behaviour + +The SCEF requests traffic reduction from the MME/SGSN and the IWK-SCEF when it is in an overload situation, by including OC-OLR AVP in answer commands as described in IETF RFC 7683 [9]. + +The SCEF identifies that it is in an overload situation by implementation specific means. For example, the SCEF may take into account the traffic over the T6a/b interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources etc. + +The SCEF determines the specific contents of the OC-OLR AVP in overload reports and the SCEF decides when to send OC-OLR AVPs by implementation specific means. + +The SCEF may decide to deactivate Monitoring events to reduce the number of Reporting-Information-Requests sent for reporting monitoring events. + +The SCEF shall apply required traffic reduction according to the OC-OLR AVPs received in answer commands from the MME to subsequent applicable requests, as per IETF RFC 7683 [9]. + +Requested traffic reduction is achieved by the SCEF by implementation specific means. It may in particular implement throttling of MT non-IP data messages. + +### A.1.3 MME/SGSN behaviour + +The MME or SGSN requests traffic reduction from the SCEF when it is in an overload situation, by including OC-OLR AVP in answer commands as described in IETF RFC 7683 [9]. + +The MME or SGSN identifies that it is in an overload situation by implementation specific means. + +The MME or SGSN shall apply required traffic reduction according to the OC-OLR AVPs received in answer commands from the SCEF to subsequent applicable requests, as per IETF RFC 7683 [9]. + +Requested traffic reduction is achieved by the MME or SGSN by implementation-specific means. It may in particular implement: + +- throttling of monitoring event reports or stop reporting with prioritization (e.g. prioritisation on the type of events, or that one-time reporting takes priority over continuous reporting, ...); +- throttling of new T6a/b connection establishment messages; +- throttling of MO non-IP data messages. + +### A.1.4 IWK-SCEF behaviour + +The IWK-SCEF, when acting as a reacting node towards the SCEF shall apply required traffic reduction received in answer commands from the SCEF to subsequent applicable requests received from the MME or SGSN, as per IETF RFC 7683 [9]. In this case the IWK-SCEF does not forward OC-OLR AVPs to the MME or SGSN. + +The IWK-SCEF, when acting as a reacting node towards the MME or SGSN, shall apply required traffic reduction received in answer commands from the MME or SGSN to subsequent applicable requests received from the SCEF, as per IETF RFC 7683 [9]. In this case the IWK-SCEF does not forward OC-OLR AVPs to the SCEF. + +Requested traffic reduction is achieved by the IWK-SCEF by implementation specific means. For example, it may implement throttling of monitoring event report with prioritization, throttling of MO data or MT data messages. + +# --- Annex B (normative): Diameter message priority mechanism + +## B.1 General + +IETF RFC 7944 [15] specifies a Diameter routing message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes may 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. + +## --- B.2 T6a, T6ai, T6b, T6bi, T7 interfaces + +The Diameter message priority mechanism is an optional feature which may apply on one or several of the T6a, T6ai, T6b, T6bi, T7 interfaces. + +It is recommended to make use of IETF RFC 7944 [15] over the T6a, T6ai, T6b, T6bi, T7 interfaces of an operator network when the overload control defined in Annex A is applied on these interfaces. + +A 3GPP functional entity supporting the Diameter message priority mechanism over one or several of the T6a, T6ai, T6b, T6bi, T7 interfaces shall comply with IETF RFC 7944 [15]. + +A 3GPP functional entity sending a request shall determine the required priority according to its policies. When priority is required, it 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 3GPP 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 3GPP functional entity 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 3GPP functional entity 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 3GPP functional entity shall set the DSCP marking for transport of the request or response according to the required priority level. + +The decisions of the 3GPP functional entity for a required priority and for the priority level value are implementation specific. + +Diameter requests related to high priority traffic shall contain a DRMP AVP with a high priority of which the level value is operator dependent. + +# Annex C (normative): Diameter load control mechanism + +## C.1 General + +The Diameter load control mechanism is an optional feature over the T6a/b and T7 interface, which may be applied to the traffic of request commands sent to the SCEF and/or to the traffic of request commands sent to the MME/SGSN. + +It is recommended to make use of the IETF RFC 8583 [31] on the T6a/b and T7 interface where: + +- when applied to the traffic of request commands sent to the SCEF, the MME/SGSN, and as an alternative the IWK-SCEF shall behave as a reacting node; +- when applied to the traffic of request commands sent to the MME/SGSN, the SCEF, and as an alternative the IWK-SCEF, shall behave as a reacting node. + +## C.2 SCEF behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the SCEF may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [31]. + +## --- C.3 MME/SGSN behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the MME/SGSN may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [31]. + +## --- C.4 IWK-SCEF behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the IWK-SCEF may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [31]. + +# --- Annex D (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------|--------| +| 2015-05 | | | | | | Skeleton of the TS after CT4#69 | 0.0.0 | +| 2015-11 | | | | | | TS after CT4#71 | 0.1.0 | +| 2015-12 | CT#70 | CP-150625 | | | | Presented for information | 1.0.0 | +| 2016-02 | | | | | | TS after CT4#72 | 1.1.0 | +| 2016-03 | CT#71 | CP-160119 | | | | Presented for approval | 2.0.0 | +| 2016-03 | CT#71 | | | | | Cersion 13.0.0. created after CT#71 | 13.0.0 | +| 2016-06 | CT#72 | CP-160225 | 0001 | 1 | | Correction on Table 6.4.1-2 | 13.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0002 | 2 | | Correction on error handling for SCEF reference ID unknown | 13.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0004 | 1 | | Removing the direct configuration of MONTE events at MME via IWK-SCEF by the SCEF for roaming case | 13.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0008 | 3 | | Overload control update for C IoT | 13.1.0 | +| 2016-06 | CT#72 | CP-160225 | 0011 | 1 | | Corrections on styles | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0003 | - | | Assignment of command codes for C IoT | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0005 | 4 | | Signaling the change of MME to the SCEF for a T6a connection used for SCEF PDN | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0006 | 4 | | Procedures updates and new AVPs over T6a for C IoT | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0007 | 5 | | Connection Action check for CMR | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0009 | 4 | | Routing considerations for C IoT | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0012 | 2 | | Serving PLMN Rate Control | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0013 | 2 | | C IoT support in introduction clause | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0014 | 2 | | MT Non-IP Data Delivery for UEs using a power saving function | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0015 | 2 | | Accept T6 Connection Establishment | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0016 | 4 | | Support for APN Rate Control | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0017 | 1 | | Charging Characteristics | 13.1.0 | +| 2016-06 | CT#72 | CP-160228 | 0018 | 2 | | Corrections in clause 5.6.3 of "Detailed Behaviour of the MME" | 13.1.0 | +| 2016-09 | CT#73 | CP-160427 | 0020 | - | | Adding missing result code | 13.2.0 | +| 2016-09 | CT#73 | CP-160423 | 0021 | 1 | | Correction of Reference for ePCO | 13.2.0 | +| 2016-09 | CT#73 | CP-160423 | 0023 | - | | MT-Data-Request command | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0022 | 3 | | Handling of Exception Reports in the Core Network | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0024 | 1 | | Sending of ePCO during the T6a connection release procedure | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0025 | 1 | | Missing AVP codes and Experimental-Result codes for T6a | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0027 | 1 | | SCEF Behaviour of Rate Control Handling | 13.2.0 | +| 2016-09 | CT#73 | CP-160573 | 0028 | 2 | | Not Able to Deliver MO Non-IP Data | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0029 | 1 | | T6a Connection Release after MO Data Answer with permanent error | 13.2.0 | +| 2016-09 | CT#73 | CP-160424 | 0030 | 2 | | Addition of Serving PLMN ID and IMEISV to CMR | 13.2.0 | +| 2016-09 | CT#73 | CP-160435 | 0031 | 1 | | T6b reference point for NonIP-GPRS | 14.0.0 | +| 2016-12 | CT#74 | CP-160660 | 0033 | 1 | | AVAILABILITY AFTER DDN FAILURE reporting | 14.1.0 | +| 2016-12 | CT#74 | CP-160657 | 0035 | 1 | | Reference Correction | 14.1.0 | +| 2016-12 | CT#74 | CP-160657 | 0038 | 1 | | Missing RRC-Cause-Counter AVP in the MO-Data-Request Command | 14.1.0 | +| 2016-12 | CT#74 | CP-160681 | 0039 | 1 | | Load Control | 14.1.0 | +| 2016-12 | CT#74 | CP-160680 | 0036 | 1 | | Updates to T6b for Non-IP GPRS | 14.1.0 | +| 2016-12 | CT#74 | CP-160664 | 0041 | - | | Correction to change IETF drmp draft version to official RFC 7944 | 14.1.0 | +| 2017-03 | CT#75 | CP-170036 | 0042 | 1 | | Loss Of Connectivity Reason | 14.2.0 | +| 2017-03 | CT#75 | CP-170036 | 0045 | - | | Failed-AVP AVP in Request Commands | 14.2.0 | +| 2017-03 | CT#75 | CP-170036 | 0046 | 1 | | Bit ordering in Diameter AVPs used as bit-masks | 14.2.0 | +| 2017-03 | CT#75 | CP-170039 | 0043 | 1 | | RAT-Type Change | 14.2.0 | +| 2017-03 | CT#75 | CP-170039 | 0044 | 1 | | SCEF Initiated T6 Release | 14.2.0 | +| 2017-03 | CT#75 | CP-170029 | 0048 | 1 | | Maximum UE Availability Time | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0049 | 1 | | Update of reference for the Diameter base protocol | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0050 | - | | Handling of the Vendor-Specific-Application-Id AVP | 14.2.0 | +| 2017-03 | CT#75 | CP-170048 | 0051 | - | | Cardinality of the Failed-AVP AVP in answer | 14.2.0 | +| 2017-03 | CT#75 | CP-170047 | 0052 | - | | Removal of Editor's Note on ePCO | 14.2.0 | +| 2017-06 | CT#76 | CP-171029 | 0053 | 2 | | User Identify in RIR | 14.3.0 | +| 2017-06 | CT#76 | CP-171018 | 0055 | 1 | | Support for signaling transport level packet marking | 14.3.0 | +| 2017-09 | CT#77 | CP-172018 | 0056 | 1 | | Reliable Data Service Success cause | 14.4.0 | +| 2017-09 | CT#77 | CP-172013 | 0060 | - | | Correction of DRMP Procedures | 14.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------|--------| +| 2017-09 | CT#77 | CP-172026 | 0057 | 2 | | Enhancements for NAPS on Idle Status Indication | 15.0.0 | +| 2017-09 | CT#77 | CP-172026 | 0061 | - | | Enhancements for NAPS on Accuracy | 15.0.0 | +| 2017-12 | CT#78 | CP-173017 | 0065 | 1 | | Fixing the R Bit in T6a Requests | 15.1.0 | +| 2017-12 | CT#78 | CP-173028 | 0062 | 2 | | Monitoring Event Report Status | 15.1.0 | +| 2018-03 | CT#79 | CP-180025 | 0066 | 1 | | Filtering the Report for Number of UEs in a Geographic Area | 15.2.0 | +| 2018-06 | CT#80 | CP-181130 | 0067 | 1 | | Local deletion of Monitoring events | 15.3.0 | +| 2018-12 | CT#82 | CP-183095 | 0068 | 3 | | Monitoring event report | 15.4.0 | +| 2018-12 | CT#82 | CP-183098 | 0069 | - | | Missing parameters in IdleStatusIndication | 15.4.0 | +| 2019-03 | CT#83 | CP-190038 | 0070 | - | | Missing Maximum-UE-Availability-Time AVP | 15.5.0 | +| 2019-09 | CT#85 | CP-192094 | 0074 | 2 | | draft-ietf-dime-load published as RFC 8583 | 15.6.0 | +| 2019-09 | CT#85 | CP-192122 | 0072 | 1 | | Event type PDN Connectivity Status | 16.0.0 | +| 2020-03 | CT#87e | CP-200050 | 0075 | - | | Reachability Cause | 16.1.0 | +| 2020-12 | CT#90e | CP-203032 | 0076 | - | | Extended Reference ID | 16.2.0 | +| 2021-06 | CT#92e | CP-211072 | 0077 | 1 | | Idle Status Indication | 16.3.0 | +| 2021-09 | CT#93e | CP-212073 | 0078 | 1 | F | APN Rate Control Status | 16.4.0 | +| 2021-09 | CT#93e | CP-212077 | 0079 | - | F | Correction on NIDD Feature | 16.4.0 | +| 2021-12 | | | | | | History table fixed | 16.4.1 | +| 2022-03 | CT#95e | CP-220077 | 0080 | - | F | Correction to wrong CR implementation | 16.5.0 | +| 2022-04 | - | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 | +| 2022-12 | CT#98e | CP-223071 | 0082 | - | A | Idle Status Indication | 17.1.0 | +| 2023-03 | CT#99 | CP-230054 | 0083 | - | F | Monitoring Event Configuration for roaming | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29173/raw.md b/marked/Rel-18/29_series/29173/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..21dd8541192bb451eef8bfea73b237e7b70e6a69 --- /dev/null +++ b/marked/Rel-18/29_series/29173/raw.md @@ -0,0 +1,643 @@ + + +# 3GPP TS 29.173 V18.0.0 (2024-03) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Location Services (LCS); Diameter-based SLh interface for Control Plane LCS (Release 18)** + +![LTE logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The LTE logo, featuring the letters 'lte' in a bold, lowercase font. Above the 'l' is a red signal strength icon consisting of four curved lines. A small 'TM' trademark symbol is located to the right of the 'e'. + +LTE logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, featuring the letters '3GPP' in a stylized, bold, black font. The '3' is larger and positioned to the left of the 'G', 'P', and 'P'. A small red signal strength icon is located below the 'P'. A small 'TM' trademark symbol is located to the top right of the 'P'. + +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. + +© 2024, 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, symbols and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 General Description ..... | 7 | +| 4.1 Introduction ..... | 7 | +| 4.2 Architecture Overview ..... | 7 | +| 4.3 Functional Requirements of SLh Interface ..... | 8 | +| 5 Diameter-based SLh Interface ..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Procedure Descriptions ..... | 8 | +| 5.2.1 Send Routing Information for LCS ..... | 8 | +| 5.2.1.1 General..... | 8 | +| 5.2.1.2 Detailed Behaviour of the HSS..... | 10 | +| 5.2.1.3 Detailed Behaviour of the GLMC ..... | 10 | +| 6 Protocol Specification and Implementations ..... | 11 | +| 6.1 Introduction ..... | 11 | +| 6.1.1 Use of Diameter Base Protocol ..... | 11 | +| 6.1.2 Securing Diameter Messages ..... | 11 | +| 6.1.3 Accounting Functionality ..... | 11 | +| 6.1.4 Use of Sessions..... | 11 | +| 6.1.5 Transport Protocol ..... | 11 | +| 6.1.6 Routing Considerations ..... | 11 | +| 6.1.7 Advertising Application Support..... | 11 | +| 6.1.8 Diameter Application Identifier..... | 12 | +| 6.1.9 User Identity to HSS resolution..... | 12 | +| 6.2 Commands..... | 12 | +| 6.2.1 Introduction ..... | 12 | +| 6.2.2 Command-Code values ..... | 12 | +| 6.2.3 LCS-Routing-Info-Request (RIR) Command ..... | 13 | +| 6.2.4 LCS-Routing-Info-Answer (RIA) Command..... | 13 | +| 6.3 Result-Code AVP and Experimental-Result AVP Values ..... | 14 | +| 6.3.1 General ..... | 14 | +| 6.3.2 Success ..... | 14 | +| 6.3.3 Permanent Failures ..... | 14 | +| 6.3.3.1 DIAMETER_ERROR_USER_UNKNOWN (5001) ..... | 14 | +| 6.3.3.2 DIAMETER_ERROR_UNAUTHORIZED_REQUESTING_NETWORK (5490) ..... | 15 | +| 6.3.4 Transient Failures ..... | 15 | +| 6.3.4.1 DIAMETER_ERROR_ABSENT_USER (4201) ..... | 15 | +| 6.4 AVPs ..... | 15 | +| 6.4.1 General ..... | 15 | +| 6.4.2 LMSI..... | 16 | +| 6.4.3 Serving-Node..... | 16 | +| 6.4.4 MME-Name..... | 16 | +| 6.4.5 MSC-Number ..... | 16 | +| 6.4.6 LCS-Capabilities-Sets ..... | 17 | +| 6.4.7 GMLC-Address ..... | 17 | +| 6.4.8 Additional-Serving-Node ..... | 17 | +| 6.4.9 PPR-Address..... | 17 | +| 6.4.10 Feature-List-ID AVP ..... | 17 | +| 6.4.11 Feature-List AVP..... | 17 | + +6.4.12 MME-Realm..... 18 +6.4.13 SGSN-Name ..... 18 +6.4.14 SGSN-Realm ..... 18 +**Annex A (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. + +# 1 Scope + +The present document describes the Diameter-based SLh interface between the GMLC and the HSS defined for the Control Plane LCS in EPC. + +LCS procedures over the SLh interface are defined in the 3GPP TS 23.271 [2]. + +This specification defines the Diameter application for the GMLC-HSS, SLh reference point. The interactions between the HSS and the GMLC are specified, including the signalling flows. As LCS procedures over the Diameter-based SLh interface are identical to the MAP-based Lh interface, the descriptions of the Lh MAP operations defined in the 3GPP TS 29.002 [3] are mapped into the descriptions of the SLh Diameter commands. + +# 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.271: "Functional stage 2 description of Location Services (LCS)". +- [3] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [4] 3GPP TS 29.228: "IP multimedia (IM) Subsystem Cx Interface; Signalling flows and Message Elements". +- [5] Void. +- [6] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [7] IETF RFC 4960: "Stream Control Transport Protocol". +- [8] 3GPP TS 29.229: "Cx and Dx Interfaces based on the Diameter protocol; protocol details". +- [9] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol; protocol details". +- [10] 3GPP TS 23.003: "Numbering, addressing and identification ". +- [11] 3GPP TS 23.012: "Location Management Procedures". +- [12] 3GPP TS 29.272: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol". +- [13] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [14] Void +- [15] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [16] 3GPP TS 29.273: "Evolved Packet System (EPS); 3GPP EPS AAA interfaces". +- [17] IETF RFC 6733: "Diameter Base Protocol". + +# --- 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], 3GPP TS 23.271 [2] 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]. + +## 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]. + +| | | +|--------|-------------------------------------------| +| ABNF | Augmented Backus-Naur form | +| AVP | Attribute Value Pair | +| H-GMLC | Home-Gateway Mobile Location Centre | +| IANA | Internet Assigned Numbers Authority | +| PMD | Pseudonym mediation device functionality | +| PPR | Privacy Profile Register | +| R-GMLC | Requesting-Gateway Mobile Location Centre | +| RFC | Request For Comments | +| V-GMLC | Visited-Gateway Mobile Location Centre | + +# --- 4 General Description + +## 4.1 Introduction + +The SLh reference point between the GMLC and the HSS is defined in the 3GPP TS 23.271 [2]. + +This document describes the Diameter-based SLh interface related procedures, message parameters and protocol specifications. + +## 4.2 Architecture Overview + +The architecture for support of Location Services in GSM, UMTS and EPS has been defined in 3GPP TS 23.271 [2] and the relevant network elements and interfaces are shown in the figure 4.2-1. + +![Figure 4.2-1: Overview of the LCS Functional Architecture. The diagram shows a central GMLC connected to an HSS via the SLh interface. The GMLC is also connected to seven other entities via various interfaces: Le (External LCS Client), SLg (MME), Lg (SGSN), Lg (MSC/ MSC Server), Lpp (PPR), Lid (PMD), and La (AAA Server).](d0abac95583b52a3b35f74a215567334_img.jpg) + +``` + +graph TD + HSS[HSS] -- SLh --> GMLC[GMLC] + GMLC -- Le --> ELCS[External LCS Client] + GMLC -- SLg --> MME[MME] + GMLC -- Lg --> SGSN[SGSN] + GMLC -- Lg --> MSC[MSC/ MSC Server] + GMLC -- Lpp --> PPR[PPR] + GMLC -- Lid --> PMD[PMD] + GMLC -- La --> AAA[AAA Server] + +``` + +Figure 4.2-1: Overview of the LCS Functional Architecture. The diagram shows a central GMLC connected to an HSS via the SLh interface. The GMLC is also connected to seven other entities via various interfaces: Le (External LCS Client), SLg (MME), Lg (SGSN), Lg (MSC/ MSC Server), Lpp (PPR), Lid (PMD), and La (AAA Server). + +**Figure 4.2-1: Overview of the LCS Functional Architecture** + +In this architecture, the SLh interface is defined between the Gateway Mobile Location Center (GMLC) and the Home Subscriber Server (HSS) to allow the GMLC to request routing information from the HLR or HSS. + +## 4.3 Functional Requirements of SLh Interface + +The requirements for SLh interface are defined in 3GPP TS 23.271 [2]. + +The SLh interface is used by the GMLC to request routing information from the HSS i.e. the address of the H-GMLC, and/or the address of the visited MSC/MSC server, SGSN, 3GPP AAA server or MME for a particular target UE whose location has been requested. + +# 5 Diameter-based SLh Interface + +## 5.1 Introduction + +This section describes the Diameter-based SLh interface related procedures and Information elements exchanged between functional entities. + +In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the "Cat." column. For the correct handling of the Information Element according to the category type, see the description detailed in section 6 of the 3GPP TS 29.228 [4]. + +## 5.2 Procedure Descriptions + +### 5.2.1 Send Routing Information for LCS + +#### 5.2.1.1 General + +This procedure is used between the GMLC and the HSS. The procedure is invoked by the GMLC and is used: + +- To retrieve routing information for LCS for a specified user from the HSS. + +This procedure is mapped to the commands LCS-Routing-Info-Request/Answer in the Diameter application specified in chapter 6. Tables 5.2.1.1/1 and 5.2.1.1/2 detail the involved information elements. + +**Table 5.2.1.1/1: Send Routing Information for LCS (SLh-LCS-SRI)** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name | C | This information element shall contain the IMSI of the targeted user. This IE shall be present if the MSISDN is absent. | +| MSISDN | MSISDN | C | This information element shall contain the MSISDN of the targeted user. This IE shall be present if the IMSI is absent. | +| GMLC Number | GMLC-Number | O | This information element shall contain the ISDN (E.164) number of the requesting GMLC. | +| Supported Features (See 3GPP TS 29.229 [8]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 5.2.1.1/2: Send Routing Information for LCS (SLh-LCS-SRI) Resp** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result (See 5.3.5) | Result-Code / Experimental-Result | M | Result of the request.
Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [17]).
Experimental-Result AVP shall be used for SLh errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| IMSI | User-Name | C | This information element shall contain the IMSI of the targeted user. This IE shall be present if Result-Code is DIAMETER_SUCCESS and the MSISDN is absent. | +| MSISDN | MSISDN | C | This information element shall contain the MSISDN of the targeted user. This IE shall be present if Result-Code is DIAMETER_SUCCESS and the IMSI is absent. | +| LMSI | LMSI | C | This information element shall contain the LMSI allocated by the VLR. This IE should be present if Result-Code is DIAMETER_SUCCESS and LMSI is available in the HSS and MSC-Number is included in the Serving-Node AVP or in an Additional-Serving-Node AVP. | +| Serving Node | Serving-Node | C | This information element shall contain the information about the network node serving the targeted user i.e. the name/number of the serving node (MME, SGSN, 3GPP AAA server or MSC/MSC server), the LCS capabilities sets supported by the serving node and the IP address of the visited GMLC associated with the serving node. This IE shall be present if the Result-Code is DIAMETER_SUCCESS; otherwise it shall be absent. | +| Additional Serving Node | Additional-Serving-Node | C | This information element shall contain the information about another network node serving the targeted user. This IE may be present if Result-Code is DIAMETER_SUCCESS; otherwise it shall be absent. There may be multiple instances of this IE in the response provided by the HSS. | +| Home GMLC Address | GMLC-Address | C | This information element shall contain the IP address of the H-GMLC. This IE should be present if the Result-Code is DIAMETER_SUCCESS; otherwise it shall be absent. | +| PPR Address | PPR-Address | C | This information element shall contain the IP address of the Privacy Profile Register (PPR). This IE should be present if available in the HSS and the Result-Code is DIAMETER_SUCCESS; otherwise it shall be absent. | +| RIA Flags | RIA-Flags | O | This Information Element contains a bit mask. See 6.4.15 for the meaning of the bits. | +| Supported Features (See 3GPP TS 29.229 [8]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 5.2.1.2 Detailed Behaviour of the HSS + +Upon reception of the Send Routing Info for LCS request, the HSS shall, in the following order: + +1. Check whether the requesting GMLC belongs to a network authorized to request UE location information. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_NETWORK in the Send Routing Information for LCS Response. +2. Check that the User Identity for whom data is asked exists in HSS. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN in the Send Routing Information for LCS Response. +- 2a. If both IMSI and MSISDN are present in the request, check whether they identify the same User. If not, the HSS Result-Code shall be set to DIAMETER\_CONTRADICTING\_AVPS in the Send Routing Information for LCS Response. +3. Check that there is at least one serving node associated with the targeted user. If not, Experimental-Result shall be set to DIAMETER\_ERROR\_ABSENT\_USER in the Send Routing Information for LCS Response. + +If there is an error in any of the above steps then the HSS shall stop processing and shall return the error code specified in the respective step (see 3GPP TS 29.329 [9] and 3GPP TS 29.229 [8] for an explanation of the error codes). + +If the HSS cannot fulfil the received request for reasons not stated in the above steps, e.g. due to a database error or empty mandatory data elements, it shall stop processing the request and set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +Otherwise, the requested operation shall take place and the HSS shall return the Result-Code AVP set to DIAMETER\_SUCCESS. The HSS returns one or several of the network addresses of the current MME, SGSN, 3GPP AAA server and/or VMSC/MSC server, the LCS capabilities of the serving nodes if available, the V-GMLC address associated with the serving nodes, if available, and whichever of the IMSI and MSISDN that was not provided in the Send Routing Info for LCS request. If MSISDN was not provided in the Send Routing Info for LCS request and the subscription is MSISDN-less, the HSS shall return the dummy MSISDN value (see 3GPP TS 23.003 [10]). If both MSISDN and IMSI were provided in the Send Routing Info for LCS request, the HSS returns either MSISDN or IMSI or both. The HSS returns the address of the H-GMLC. The HSS also provides the address of the PPR, if available. + +The HSS shall include the Diameter Identity of the SGSN (i.e. SGSN-Name and SGSN-Realm), within the Serving-Node AVP or within an Additional-Serving-Node AVP, if and only if the HSS has received an indication that the Lgd interface is supported by the SGSN (see 3GPP TS 29.272 [12]). + +The HSS shall include the SGSN Number, within the Serving-Node AVP or Additional Serving-Node AVP, except if the HSS has received an indication that the Lg interface is not supported by the SGSN (see 3GPP TS 29.272 [12]). + +If the UE is served by the MME and SGSN parts of the same combined MME/SGSN (see 3GPP TS 29.272 [12] subclause 5.2.2.1.1 for how the HSS determines if the UE is served by the combined MME/SGSN) and if this combined MME/SGSN has indicated the support for optimized LCS procedure (via the Supported-Feature AVP as defined in 3GPP TS 29.272 [12] subclause 7.3.10) and if HSS supports this optimized LCS procedure, then the HSS shall set the "Combined-MME/SGSN-Supporting-Optimized-LCS-Proc" bit of the RIA-Flags. + +Regarding the LCS capabilities of the serving nodes, if the HSS registered an SGSN via the S6d reference point (i.e., the registered serving node is an S4-SGSN), the HSS shall set the LCS-Capabilities-Set value to indicate support of Capability Set 5 (i.e., LCS release 7 or later version). If the HSS registered an MME, the HSS shall not indicate any LCS capability value to the GMLC (i.e., the LCS-Capabilities-Set AVP shall be absent over SLh when the serving node is an MME); in this case, the GMLC shall assume that the MME supports LCS Capability Set 5. + +#### 5.2.1.3 Detailed Behaviour of the GLMC + +If there are a serving node as well as additional serving nodes in a successful Send Routing Info for LCS response, the receiving shall use the serving node in preference to the additional serving nodes. + +# 6 Protocol Specification and Implementations + +## 6.1 Introduction + +### 6.1.1 Use of Diameter Base Protocol + +The Diameter base protocol as specified in IETF RFC 6733 [17] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +### 6.1.2 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [6]. + +### 6.1.3 Accounting Functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the SLh interface. + +### 6.1.4 Use of Sessions + +Between the GMLC and the HSS, Diameter sessions shall be implicitly terminated. An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol as specified in IETF RFC 6733 [17] includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [17]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +### 6.1.5 Transport Protocol + +Diameter messages over the SLh interface shall make use of SCTP IETF RFC 4960 [7] as transport protocol. + +### 6.1.6 Routing Considerations + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host. + +If GMLC knows the address/name of the HSS for a certain user, both the Destination-Realm AVP and the Destination-Host AVP shall be present in the request. Otherwise, only the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node. Consequently, the Destination-Host AVP is declared as optional in the ABNF for all requests initiated by a GMLC. + +Destination-Realm AVP is declared as mandatory in the ABNF for all requests. + +If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +### 6.1.7 Advertising Application Support + +The HSS and GMLC shall advertise support of the Diameter SLh Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [17]. + +### 6.1.8 Diameter Application Identifier + +The SLh interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the SLh interface application is 16777291 (allocated by IANA). + +### 6.1.9 User Identity to HSS resolution + +The User identity to HSS resolution mechanism enables the GMLC (for non-roaming case) or Diameter Relay/proxy agents in the home network (for roaming case) to find the identity of the HSS that holds the LCS subscription data and routing information for the target user when multiple and separately addressable HSSs have been deployed in the home network. The resolution mechanism is not required in networks that utilise a single HSS. + +This User identity to HSS resolution mechanism may rely on routing capabilities provided by Diameter and be implemented in the home operator network within dedicated Diameter Agents (Redirect Agents or Proxy Agents) responsible for determining the HSS identity based on the provided user identity. If this Diameter based implementation is selected by the Home network operator, the principles described in the 3GPP TS 29.272 [12] shall apply. + +NOTE: Alternatives to the user identity to HSS resolution Diameter based implementation are outside the scope of this specification. + +## 6.2 Commands + +### 6.2.1 Introduction + +This section defines the Command code values and related ABNF for each command described in this specification. + +### 6.2.2 Command-Code values + +This section defines Command-Code values for the SLh interface application as allocated by IANA. + +Every command is defined by means of the ABNF syntax IETF RFC 2234 [13], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [17]. In the case, the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [17] shall apply. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id AVP is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with IETF RFC 6733 [17]. + +The following Command Codes are defined in this specification: + +**Table 6.2.2/1: Command-Code values for SLh** + +| Command-Name | Abbreviation | Code | Section | +|--------------------------|---------------------|-------------|----------------| +| LCS-Routing-Info-Request | RIR | 8388622 | 6.2.3 | +| LCS-Routing-Info-Answer | RIA | 8388622 | 6.2.4 | + +For these commands, the Application-ID field shall be set to 16777291 (application identifier of the SLh interface application, allocated by IANA). + +### 6.2.3 LCS-Routing-Info-Request (RIR) Command + +The LCS-Routing-Info-Request (RIR) command, indicated by the Command-Code field set to 8388622 and the "R" bit set in the Command Flags field, is sent from GMLC to HSS. + +Message Format + +``` +< LCS-Routing-Info-Request > ::= < Diameter Header: 8388622, REQ, PXY, 16777291 > + +< Session-Id > + +[ Vendor-Specific-Application-Id ] + +{ Auth-Session-State } + +{ Origin-Host } + +{ Origin-Realm } + +[ Destination-Host ] + +{ Destination-Realm } + +[ User-Name ] + +[ MSISDN ] + +[ GMLC-Number ] + +*[ Supported-Features ] + +*[ Proxy-Info ] + +*[ Route-Record ] + +*[ AVP ] +``` + +### 6.2.4 LCS-Routing-Info-Answer (RIA) Command + +The LCS-Routing-Info-Answer (RIA) command, indicated by the Command-Code field set to 8388622 and the 'R' bit cleared in the Command Flags field, is sent from HSS to GMLC. + +Message Format + +``` +< LCS-Routing-Info-Answer > ::= < Diameter Header: 8388622, PXY, 16777291 > + +< Session-Id > + +[ Vendor-Specific-Application-Id ] + +[ Result-Code ] +``` + +``` + +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +*[ Supported-Features ] +[ User-Name ] +[ MSISDN ] +[ LMSI ] +[ Serving-Node ] +*[ Additional-Serving-Node ] +[ GMLC-Address ] +[ PPR-Address ] +[ RIA-Flags ] +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 6.3 Result-Code AVP and Experimental-Result AVP Values + +### 6.3.1 General + +This section defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 6.3.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [17] shall be applied. + +### 6.3.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in the Diameter base protocol specified in IETF RFC 6733 [17] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 6.3.3.1 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the HSS to indicate that the user identified by the IMSI or the MSISDN is unknown. This error code is defined in 3GPP TS 29.229 [8] + +#### 6.3.3.2 DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_NETWORK (5490) + +This result code shall be sent by the HSS to indicate that the requesting GMLC's network is not authorized to request UE location information. + +### 6.3.4 Transient Failures + +Errors that fall within the transient failures category are those used to inform a peer that the request could not be satisfied at the time that it was received. The request may be able to be satisfied in the future. + +#### 6.3.4.1 DIAMETER\_ERROR\_ABSENT\_USER (4201) + +This result code shall be sent by the HSS to indicate that the location of the targeted user is not known at this time to satisfy the requested operation. + +## 6.4 AVPs + +### 6.4.1 General + +The following table specifies the Diameter AVPs defined for the SLh interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415). + +For all AVPs which contain bit masks and are of the type Unsigned32, bit 0 shall be the least significant bit. For example, to get the value of bit 0, a bit mask of 0x00000001 should be used. + +**Table 6.4.1/1: SLh specific Diameter AVPs** + +| Attribute Name | AVP Code | Section defined | Value Type | AVP Flag rules | | | | | May Encr. | +|-------------------------|----------|-----------------|------------------|----------------|-----|------------|----------|--|-----------| +| | | | | Must | May | Should not | Must not | | | +| LMSI | 2400 | 6.4.2 | OctetString | M, V | | | | | No | +| Serving-Node | 2401 | 6.4.3 | Grouped | M, V | | | | | No | +| MME-Name | 2402 | 6.4.4 | DiameterIdentity | M, V | | | | | No | +| MSC-Number | 2403 | 6.4.5 | OctetString | M, V | | | | | No | +| LCS-Capabilities-Sets | 2404 | 6.4.6 | Unsigned32 | M, V | | | | | No | +| GMLC-Address | 2405 | 6.4.7 | Address | M, V | | | | | No | +| Additional-Serving-Node | 2406 | 6.4.8 | Grouped | M, V | | | | | No | +| PPR-Address | 2407 | 6.4.9 | Address | M, V | | | | | No | +| MME-Realm | 2408 | 6.4.12 | DiameterIdentity | V | | | M | | No | +| SGSN-Name | 2409 | 6.4.13 | DiameterIdentity | V | | | M | | No | +| SGSN-Realm | 2410 | 6.4.14 | DiameterIdentity | V | | | M | | No | +| RIA-Flags | 2411 | 6.4.15 | Unsigned32 | V | | | M | | No | + +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 [17]. + +The following table specifies the Diameter AVPs re-used by the SLh interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within SLh. + +Any other AVPs from existing Diameter Applications, except for the AVPs from the Diameter base protocol as specified in IETF RFC 6733 [17], do not need to be supported. The AVPs from the Diameter base protocol as specified in IETF RFC 6733 [17] are not included in table 6.4.1/2, but they may be re-used for the SLh protocol. + +Table 6.4.1/2: SLh re-used Diameter AVPs + +| Attribute Name | Reference | Comments | +|----------------------|---------------------|--------------------| +| MSISDN | 3GPP TS 29.329 [9] | | +| SGSN-Number | 3GPP TS 29.272 [12] | | +| Supported-Features | 3GPP TS 29.229 [8] | | +| Feature-List-ID | 3GPP TS 29.229 [8] | See section 6.4.10 | +| Feature-List | 3GPP TS 29.229 [8] | See section 6.4.11 | +| GMLC-Number | 3GPP TS 29.272 [12] | | +| 3GPP-AAA-Server-Name | 3GPP TS 29.273 [16] | | + +### 6.4.2 LMSI + +The LMSI AVP is of type OctetString and it shall contain the Local Mobile Station Identity (LMSI) allocated by the VLR, as defined in 3GPP TS 23.003 [10]. For further details on the encoding of this AVP, see 3GPP TS 23.003[10]. + +### 6.4.3 Serving-Node + +The Serving-Node AVP is of type Grouped. This AVP shall contain the information about the network node serving the targeted user. + +AVP format + +``` +Serving-Node ::= + [ SGSN-Number ] + [ SGSN-Name ] + [ SGSN-Realm ] + [ MME-Name ] + [ MME-Realm ] + [ MSC-Number ] + [ 3GPP-AAA-Server-Name ] + [ LCS-Capabilities-Sets ] + [ GMLC-Address ] + *[AVP] +``` + +The GMLC-Address AVP included in the Serving-Node grouped AVP shall contain, if present, the IPv4 or IPv6 address of the GMLC associated with the serving node (i.e., either the home GMLC or the visited GMLC, depending on the location of the serving node). + +### 6.4.4 MME-Name + +The MME-Name AVP is of type DiameterIdentity and it shall contain the Diameter identity of the serving MME. For further details on the encoding of this AVP, see IETF RFC 6733 [17]. + +### 6.4.5 MSC-Number + +The MSC-Number AVP is of type OctetString and it shall contain the ISDN number of the serving MSC or MSC server in international number format as described in ITU-T Rec E.164 [15] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [3] for encoding of TBCD-strings. + +### 6.4.6 LCS-Capabilities-Sets + +The LCS-Capabilities-Sets AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in 3GPP 29.002 [3]. + +### 6.4.7 GMLC-Address + +The GMLC-Address AVP is of type Address and shall contain the IPv4 or IPv6 address of H-GMLC or the V-GMLC associated with the serving node. + +### 6.4.8 Additional-Serving-Node + +The Additional-Serving-Node AVP is of type Grouped. This AVP shall contain the information about the network node serving the targeted user. + +AVP format + +``` +Additional-Serving-Node ::= + [ SGSN-Number ] + [ MME-Name ] + [ SGSN-Name ] + [ SGSN-Realm ] + [ MME-Realm ] + [ MSC-Number ] + [ 3GPP-AAA-Server-Name ] + [ LCS-Capabilities-Sets ] + [ GMLC-Address ] + *[AVP] +``` + +The GMLC-Address AVP included in the Additional-Serving-Node grouped AVP shall contain, if present, the IPv4 or IPv6 address of the GMLC associated with the serving node (i.e., either the home GMLC or the visited GMLC, depending on the location of the serving node). + +### 6.4.9 PPR-Address + +The PPR-Address AVP is of type Address and contains the IPv4 or IPv6 address of the Privacy Profile Register for the targeted user. + +### 6.4.10 Feature-List-ID AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [8]. For this release, the Feature-List-ID AVP value shall be set to 1. + +### 6.4.11 Feature-List AVP + +The syntax of this AVP is defined in 3GPP TS 29.229 [8]. A null value indicates that there is no feature used by the application. + +NOTE: There is no feature defined for this release. + +### 6.4.12 MME-Realm + +The MME-Realm AVP is of type DiameterIdentity and it shall contain the Diameter Realm Identity of the serving MME. For further details on the encoding of this AVP, see IETF RFC 6733 [17]. + +### 6.4.13 SGSN-Name + +The SGSN-Name AVP is of type DiameterIdentity and it shall contain the Diameter identity of the serving SGSN. For further details on the encoding of this AVP, see IETF RFC 6733 [17]. + +### 6.4.14 SGSN-Realm + +The SGSN-Realm AVP is of type DiameterIdentity and it shall contain the Diameter Realm Identity of the serving SGSN. For further details on the encoding of this AVP, see IETF RFC 6733 [17]. + +### 6.4.15 RIA-Flags + +The RIA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 6.4.15/1: + +**Table 6.4.15/1: RIA-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Combined-MME/SGSN-Supporting-Optimized-LCS-Proc | This bit, when set, indicates that the UE is served by the MME and the SGSN parts of the same combined MME/SGSN and this combined MME/SGSN supports the optimized LCS procedure. | +| NOTE1: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving GMLC. | | | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29202/raw.md b/marked/Rel-18/29_series/29202/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..302ed48920a83866734c4bf2c54005de08b66ef8 --- /dev/null +++ b/marked/Rel-18/29_series/29202/raw.md @@ -0,0 +1,576 @@ + + +# 3GPP TS 29.202 V18.0.0 (2024-03) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Signalling System No. 7 (SS7) signalling transport in core network; Stage 3 (Release 18)** + +![3GPP logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 3GPP logo, featuring the letters '3GPP' in a stylized, bold, black font. The '3' is on the left, 'G' is in the middle, 'P' is on the right, and 'P' is slightly behind the 'P'. There is a small red signal icon below the 'G'. + +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. + +© 2024, 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..... | 4 | +| 2 References..... | 4 | +| 2.1 Normative references ..... | 4 | +| 2.2 Informative references..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 5 | +| 4 Introduction..... | 6 | +| 5 Protocol architectures..... | 6 | +| 5.1 Protocol architecture in the case of MTP-based SS7 signalling transport network..... | 6 | +| 5.2 Protocol architecture in the case of IP-based SS7 signalling transport network..... | 6 | +| 5.2.1 M3UA 6 | | +| 5.2.2 MTP3-M2PA..... | 7 | +| 5.3 Protocol architecture in the case of ATM-based SS7 signalling transport network ..... | 7 | +| Annex A (Normative): The use of M3UA in 3GPP networks..... | 8 | +| A.1 Scope..... | 8 | +| A.2 Introduction..... | 8 | +| A.3 Protocol conformance to RFC 4666..... | 9 | +| Annex B (Informative): The use of M2PA in 3GPP networks ..... | 17 | +| B.1 Scope..... | 17 | +| B.2 Introduction..... | 17 | +| B.3 Protocol conformance to RFC 4165..... | 17 | +| 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. + +# --- 1 Scope + +The present document defines the possible protocol architectures for transport of SS7 signalling protocols in Core Network. + +# --- 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*. + +## 2.1 Normative references + +- [1] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [2] ITU-T Recommendation Q.701: "Functional description of the message transfer part (MTP) of signalling system No. 7". +- [3] ITU-T Recommendation Q.702: "Signalling data link". +- [4] ITU-T Recommendation Q.703: "Signalling link". +- [5] ITU-T Recommendation Q.704: "Signalling network functions and messages". +- [6] ITU-T Recommendation Q.705: "Signalling network structure". + +- [7] ITU-T Recommendation Q.706: "Message transfer part signalling performance". +- [8] RFC 2960: "Stream Control Transmission Protocol". +- [9] ITU-T Recommendation G.804: "ATM cell mapping into Plesiochronous Digital Hierarchy (PDH)". +- [10] ITU-T Recommendation I.112: "Vocabulary of terms for ISDNs". +- [11] ITU-T Recommendation I.361: "B-ISDN ATM layer specification". +- [12] ITU-T Recommendation I.363.5: "B-ISDN ATM Adaptation Layer specification: Type 5 AAL". +- [13] ITU-T Recommendation Q.2110: "B-ISDN ATM adaptation layer - Service specific connection oriented protocol (SSCOP)". +- [14] ITU-T Recommendation Q.2140: "B-ISDN ATM adaptation layer - Service specific coordination function for signalling at the network node interface (SSCF at NNI)". +- [15] ITU-T Recommendation Q.2210: "Message transfer part level 3 functions and messages using the services of ITU-T Recommendation Q.2140". +- [17] RFC 3309: "SCTP Checksum Change". +- [18] RFC 4666: Signaling System 7 (SS7) Message Transfer Part 3 (MTP3) - User Adaptation Layer (M3UA)". +- [19] RFC 4165: Signaling System 7 (SS7) Message Transfer Part 2 (MTP2) -User Peer-to-Peer Adaptation Layer (M2PA)". + +## 2.2 Informative references + +- [16] RFC 2719: "Framework Architecture for Signalling Transport". + +# --- 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 TR 21.905 [1]. + +(no further terms defined) + +## 3.2 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]. + +| | | +|------|-------------------------------------------------------------| +| AAL5 | ATM Adaptation Layer type 5 | +| ATM | Asynchronous Transfer Mode | +| IP | Internet Protocol | +| MTP | Message Transfer Part | +| MTP1 | Message Transfer Part layer 1 | +| MTP2 | Message Transfer Part layer 2 | +| MTP3 | Message Transfer Part layer 3 | +| M2PA | Message Transfer Part 2 -User Peer-to-Peer Adaptation Layer | +| M3UA | MTP3-User Adaptation | +| PDH | Plesiochronous Digital Hierarchy | +| SSCF | Service Specific Coordination Function | + +| | | +|-------|-----------------------------------------------| +| SSCOP | Service Specific Connection Oriented Protocol | +| SCCP | Signalling Connection Control Part | +| SCTP | Stream Control Transmission Protocol | +| SDH | Synchronous Digital Hierarchy | +| TCAP | Transaction Capabilities Application Part | + +# --- 4 Introduction + +The Core Network enables the transport of SS7 signalling protocols between two entities by means of different underlying networks (e.g. MTP-based, IP-based or ATM-based). + +The transport of SS7 signalling protocol messages of any protocol layer that is identified by the MTP level 3 layer, in SS7 terms, as a user part (MTP3-user) shall be accomplished in accordance with the protocol architecture defined in the following sub-clauses. The list of these protocol layers includes, but is not limited to, Signalling Connection Control Part (SCCP). + +The transport of protocols which can be identified as SCCP-users, like for example TCAP, and in turn the transport of TCAP-users like MAP and CAP, shall also be accomplished in accordance with the defined protocol architectures, since their protocol messages are transferred as SCCP payload. + +# --- 5 Protocol architectures + +## 5.1 Protocol architecture in the case of MTP-based SS7 signalling transport network + +The transport of an MTP3-user signalling messages shall be accomplished in accordance with the relevant ITU-T Recommendations [2], [3], [4], [5], [6], [7]. + +The protocol architecture applicable in the case of MTP-based SS7 signalling transport network is shown in Figure 5.1/1 + +![Diagram showing the protocol architecture for MTP-based SS7 signalling transport network. It consists of four stacked layers: MTP3-User, MTP3, MTP2, and MTP1.](68ca7669d38a3c31f5a2c3a06fa802e3_img.jpg) + +| | +|-----------| +| MTP3-User | +| MTP3 | +| MTP2 | +| MTP1 | + +Diagram showing the protocol architecture for MTP-based SS7 signalling transport network. It consists of four stacked layers: MTP3-User, MTP3, MTP2, and MTP1. + +Figure 5.1/1: Protocol architecture in the case of MTP-based SS7 signalling transport network + +## 5.2 Protocol architecture in the case of IP-based SS7 signalling transport network + +### 5.2.1 M3UA + +The transport of an MTP3-user signalling messages shall be accomplished in accordance with the architecture defined by the "Framework Architecture for Signalling Transport" [16], by "Stream Control Transmission Protocol"[8] and by the IETF document available in Annex A. An implementation of SCTP to this document shall use the checksum method specified in RFC 3309 [17] instead of the method specified in RFC 2960 [8]. + +The M3UA protocol architecture applicable in the case of IP-based SS7 signalling transport network is shown in Figure 5.2/1 + +![Diagram showing the MTP3-User layer.](1d7c39fcec994ceb71107ec910b176b6_img.jpg) + +| | +|-----------| +| MTP3-User | +|-----------| + +Diagram showing the MTP3-User layer. + +![](997233d405f0d4b89ddeb7683e047f66_img.jpg) + +| | +|------| +| M3UA | +| SCTP | +| IP | + +**Figure 5.2/1: M3UA architecture in the case of IP-based SS7 signalling transport network** + +The definition of the use of M3UA in 3GPP core network is provided in Annex A to this specification. + +### 5.2.2 MTP3-M2PA + +An MTP3 signalling message can also be transported by M2PA, which shall be accomplished in accordance with IETF RFC 4165[19]. + +The M2PA protocol architecture applicable in the case of IP-based SS7 signalling transport network is shown in Figure 5.2/2 + +![](ca4d4ff86cf319ed7cc36a1ecda29101_img.jpg) + +| | +|------| +| MTP3 | +| M2PA | +| SCTP | +| IP | + +**Figure 5.2/2: M2PA architecture in the case of IP-based SS7 signalling transport network** + +The definition of the use of M2PA in 3GPP core network is provided in Annex B to this specification. + +## 5.3 Protocol architecture in the case of ATM-based SS7 signalling transport network + +The transport of an MTP3-user signalling messages shall be accomplished in accordance with the relevant ITU-T Recommendations [9], [10], [11], [12], [13], [14], [15] + +The protocol architectures applicable in the case of ATM-based SS7 signalling transport network are shown in Figure 5.3/1. + +### ATM over SDH + +![](ba9d6e1a75eb6672d04e61a86e1b8a61_img.jpg) + +| | +|-----------| +| MTP3-User | +| MTP3 B | +| SSCF | +| SSCOP | +| AAL5 | +| ATM | + +### ATM over PDH + +![](fb139b01fa81528410fe1d28fbb60486_img.jpg) + +| | +|-----------| +| MTP3-User | +| MTP3 B | +| SSCF | +| SSCOP | +| AAL5 | +| G.804 | + +**Figure 5.3/1: Protocol architectures in the case of ATM-based SS7 signalling transport network** + +# --- Annex A (Normative): The use of M3UA in 3GPP networks + +## A.1 Scope + +This annex defines the application of M3UA in 3GPP core networks. The purpose of the Annex is to ensure the interoperability of different implementations of M3UAs used by different operators and vendors. This is achieved by: + +- Clarifying certain concepts which are used in RFC 4666; +- Defining those features in RFC 4666 for which support is mandatory; +- Defining those features in the RFC 4666 for which support is optional; +- Defining those features in RFC 4666 which shall not be used; + +The specification is intended for interfaces between network domains, however, it can also be used inside one network domain, and constitutes a minimum set of M3UA requirements to be supported between IP nodes and between IP nodes and SGW nodes in a 3GPP network. + +## --- A.2 Introduction + +M3UA may be used on a number of interfaces in a 3GPP core network. The annex is intended for the interface called A and C in figure 1. A is the Interface between two IP nodes that are equipped with SCTP, M3UA and a M3UA user. Examples of M3UA user are BICC, H.248, SCCP and ISUP. The interface can be used inside one network domain but also to interconnect network domains. Interface B can be used between network domains and inside network domains. Interface B is not in the scope for this annex, however, use of Q.701-Q.705 or Q.2210 on interface B is already standardised; in addition, M2PA is also endorsed for interface B in accordance with Annex B. Interface C is the interface between a node including SCTP, M3UA and a M3UA user and a node including SCTP, M3UA and M3UA signalling gateway functions.. This interface is inside one network domain. + +Interfaces A and C are similar. The main difference is that interface C shall also allow for interworking with the SS 7 network and therefore provides functions for the interworking. + +The signalling gateways in this picture are pure MTP3/3B-M3UA signaling gateways. They do not include any M3UA users. Still there could be a node including an M3UA user (e.g. SCCP functions) and a M3UA signalling gateway functions. In that case, the node will support all the interfaces A, B and C. + +![Figure 1: Use of M3UA in 3GPP core network. The diagram shows three network domains (Network domain 1, Network domain 2, and Network domain 3) connected via Signaling Gateways (SG). Network domain 1 contains three IP nodes, each including an M3UA user, connected to an SG. Network domain 2 contains two IP nodes, one including an M3UA user, connected to an SG. Network domain 3 contains two IP nodes, each including an M3UA user, connected to an SG. The SGs are interconnected, with labels A, B, and C indicating different connection points or interfaces.](b3baf3a29b67c7425d2562ddbc52f0cc_img.jpg) + +Figure 1: Use of M3UA in 3GPP core network. The diagram shows three network domains (Network domain 1, Network domain 2, and Network domain 3) connected via Signaling Gateways (SG). Network domain 1 contains three IP nodes, each including an M3UA user, connected to an SG. Network domain 2 contains two IP nodes, one including an M3UA user, connected to an SG. Network domain 3 contains two IP nodes, each including an M3UA user, connected to an SG. The SGs are interconnected, with labels A, B, and C indicating different connection points or interfaces. + +Figure 1: Use of M3UA in 3GPP core network + +## A.3 Protocol conformance to RFC 4666 + +A minimum implementation shall support sections marked mandatory in the table below. It shall be possible to configure all implementations to interoperate (no error messages returned) with the minimum set. + +The table below makes comment to the sections in RFC 4666. In the comment column the following terms are used: + +- Mandatory: When support of text in a section is marked mandatory: + - On an information element, message or message class, it means that a receiver shall understand the information element, message or message class and carry out the requested action. + - For a procedure, it means that the procedure is mandatory to be carried out by the involved network elements. +- Optional: When support of the text in a section is marked optional the feature involved is only guaranteed to work between peer entities which are subject to a bilateral agreement between operators of those entities. If one end uses an optional message or information element and the other does not support it, then either a silent discard takes place of an information element as a part of the message or the message is discarded and an error message is returned. This is described as part of the handling of the optionality in the table. +- Excluded: This means that the feature shall not be used in a 3GPP environment + +Descriptive text means that the section does not include any requirements for this specification. + +Note: The word "heading" means that the section consists only of subordinate sections. + +The comments column also defines the behaviour of a minimum implementation if it does not support a message or an information element in a mandatory message. + +| Section number in M3UA RFC | Comments | +|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Abstract | Descriptive text | +| 1. Introduction | Descriptive text | +| 1.1 Scope | Descriptive text | +| 1.2 Terminology | Descriptive text. | +| 1.3 M3UA overview | Descriptive text. | +| 1.4 Functional area | Descriptive text. | +| 1.5 Sample Configurations | Descriptive text | +| 1.6 Definition of M3UA Boundaries | Descriptive text | +| 2 Conventions | Descriptive text | +| 3. M3UA Protocol Elements | Mandatory | +| 3.1 Common message header | Mandatory | +| 3.1.1 M3UA Protocol Version: | The version number field shall be set to 1 | +| 3.1.2 Message classes and types | The values are classified as follow
0-4 Mandatory
5-8 Excluded
9 Optional (Routing Key Management (RKM) Messages)
10 to 255 Excluded | +| 3.1.2 (Management (MGMT) message) | The values are classified as follow
0 Mandatory
1 Optional (Notify). When received and not supported the message maybe silently discarded.
2-255 Excluded | +| 3.1.2 (Transfer messages) | The values are classified as follow
0 Excluded
1 Mandatory
2 to 255 Excluded | +| 3.1.2 (Signalling network management (SSNM) messages) | The values are classified as follow
0 Excluded
1-6 Mandatory
7- 255 Excluded. | +| 3.1.2 (ASP State Maintenance (ASPSM) Messages) | The values are classified as follow
0 Excluded
1-6 Mandatory
7-255 Excluded | +| 3.1.2 (ASP Traffic Maintenance (ASPTM) Messages) | The values are classified as follow
0 Excluded
1-4 Mandatory
5 to 255 Excluded | +| 3.1.2 (Routing key management (RKM)) messages | Optional
If any of these messages is received and not supported an error message with the error code 0x04 (Unsupported message type) shall be sent | +| 3.1.3 Reserved | Mandatory | +| 3.1.4 Message length | Mandatory | + +| Section number in M3UA RFC | Comments | +|---------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3.2 Variable Length Parameter Format Common Parameters: |

The values are classified as follows

0x0000-- 0x0003, 0x0005, 0x0008, 0x000a, 0x000e, 0x000f, 0x0010 0x0014—0x01ff Excluded

0x0007, 0x0009, 0x000c and 0x0012 Mandatory

0x0004 optional (INFO String) if received and not supported the message is processed but the optional information element is silently discarded,

0x0006 optional (Routing Context if received and not supported the message is processed but the optional information element is silently discarded,

0x000b optional (Traffic Mode Type) if received and not supported the message is processed but the optional information element is silently discarded,

0x0011 (ASP Identifier) if received and not supported the message is processed but the optional information element is silently discarded,

0x0012 Affected point code is mandatory. The support of value 0 in the mask field is mandatory. All other values is outside the scope of this annex.

0x0013 (Correlation ID) if received and not supported the message is processed but the optional information element is silently discarded,

| +| 3.2 Variable Length Parameter Format M3UA Specific Parameters |

The values are classified as follows

0x0201, 0x0202, 0x0203, 0x0211, 0x020d and 0x0214 to 0xffff Excluded

0x0204--0x0205, 0x0210 Mandatory

0x0200 optional (Network Appearance) if received and not supported the message is processed but the optional information element is silently discarded,

0x0206 Optinal (Concerned Destination). If received and not supported the message is processed but the optional information element is silently discarded.

0x0207 (Routing Key), 0x0208 (Registration Result), 0x0209 (Deregistration Result) 0x020a (Local Routing Key Identifier), 0x020b (Destination Point Code), 0x020c (Service Indicators) 0x020d (Subsystem Numbers), 0x020e (Originating Point Code List), 0x020f (Circuit Range), 0x0212 (Registration Status), 0x0213 (Deregistration Status) are parameters in optional message, and therefore no action is specified.

| +| 3.3 Transfer messages | These messages are mandatory at the interfaces A and C. | +| 3.3.1 Payload Data Message (DATA) |

The parameters Network Appearance, Routing Context, Correlation ID are optional

The parameter Protocol data is mandatory.

| +| 3.4 SS7 signalling network management messages | Heading | +| 3.4.1 Destination Unavailable (DUNA) |

The message is mandatory at the interface C.

The parameters Network Appearance, Routing Context, and INFO String are optional

The parameter Affected Point Code is mandatory

| +| 3.4.2 Destination Available (DAVA) |

The message is mandatory at the interface C

The parameters Network Appearance, Routing Context, and INFO String are optional.

The parameter Affected Point Code is mandatory

| +| 3.4.3 Destination State Audit (DAUD) |

The message is mandatory at the interface C

The parameters Network Appearance, Routing Context, and INFO String are optional.

The parameter Affected Point Code is mandatory

| + +| Section number in M3UA RFC | Comments | +|---------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3.4.4 Signalling Congestion (SCON) | The message is mandatory at the interface C
The parameters Network Appearance, Routing Context, Congestion Indications and INFO String are optional
The parameter Affected point code is mandatory. | +| 3.4.5 Destination User Part Unavailable (DUPU) | The message is mandatory at the interfaces A and C.
The parameters Network Appearance, Routing Context, and INFO String are optional.

The parameters Affected point code and User/Cause are mandatory | +| 3.4.6 Destination Restricted (DRST) message | This message is mandatory. | +| 3.5 ASP State Maintenance (ASPSM) Messages | These messages are mandatory at the interfaces A and C. | +| 3.5.1 ASP Up message | The ASP Identifier and Info String parameters are optional | +| 3.5.2 ASP Up Acknowledgement Message | The Info String parameter is optional. | +| 3.5.3 ASP Down message | The Info String parameter is optional. | +| 3.5.4 ASP Down Acknowledgement message | The Info String parameter is optional. | +| 3.5.5 Heartbeat message | The message is mandatory. | +| 3.5.6 Heartbeat Acknowledgement message | The message is mandatory | +| 3.6 Routing Key Management messages | These messages are optional at the interfaces A and C. | +| 3.7 ASP Traffic Maintenance (ASPTM) Messages | These messages are mandatory at the interfaces A and C. | +| 3.7.1 ASP Active message | The parameters Traffic Mode Type, Routing Context and INFO String are optional. | +| 3.7.2 ASP Active Acknowledgement message | The Traffic Mode Type, Routing Context and INFO String are optional. | +| 3.7.3 ASP inactive message | The parameters Routing Context and INFO String are optional. | +| 3.7.4 ASP Inactive Acknowledgement | The parameters Routing Context INFO String are optional. | +| 3.8 Management (MGMT) Messages | Heading | +| 3.8.1 Error message | The message is mandatory at the interfaces A and C | +| 3.8.2 Notify message | The message is optional at the interfaces A and C | +| 4 Procedure | The application of a particular procedure at a certain interface is detailed in the following sections | +| 4.1 Procedures to Support the M3UA-User | Heading | +| 4.1.1 Receipt of Primitives from the M3UA-User | The procedure is mandatory at the interfaces A and C. | +| 4.1.2 Receipt of Primitives from the Layer Management | This section is outside the scope of this annex. | +| 4.2 Procedures to Support the Management of SCTP Associations | The procedures are mandatory at the interfaces A and C | +| 4.2.1 Receipt of M3UA Peer Management Messages | The two first paragraphs are outside the scope of this annex.
Last paragraph is mandatory. | +| 4.3 AS and ASP State Maintenance | The procedure is mandatory at the interfaces A and C. | +| 4.3.1 ASP States | Mandatory | +| 4.3.2 AS States | Mandatory | + +| Section number in M3UA RFC | Comments | +|-------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 4.3.3 M3UA Management Procedures for Primitives | This section is outside the scope of this annex. | +| 4.3.4 ASPM Procedures for Peer-to-Peer Messages | Heading | +| 4.3.4.1 ASP Up Procedure |

This procedure is mandatory at the interface C and is a subset of the procedure used at interface A. See also 4.3.4.1.2.

Note: The registration procedure is optional.

A received ASP Up must be acknowledged by an ASP Up Ack message, if no restriction applies e.g. maintenance.

| +| 4.3.4.1.1 M3UA Version Control | This procedure is mandatory at the interfaces A and C. | +| 4.3.4.1.2 IPSP Considerations (Asp Up) |

This procedure is mandatory at the interface A.

All comments applicable for section 4.3.4.1 and 4.3.4.2 are also applicable for this section.

| +| 4.3.4.2 ASP-Down Procedure |

This procedure is mandatory at the interface C and is a subset of the procedure used at interface A. See also 4.3.4.1.2.

A received ASP Down message must be acknowledged by an ASP Down Ack message, if no restriction applies eg maintenance reason.

| +| 4.3.4.3 ASP Active Procedure |

This procedure is mandatory at interface C and is a subset of the procedure used at interface A. See also 4.3.4.3.1.

Configuration data define which AS an ASP is a member of. The ASP Active message does not contain a Routing Context parameter. Consequently, the ASP Active Ack message does not include any Routing Context(s) parameter.

The traffic state an ASP has, is configured within the associated Application Server. If more than one physical entity (ASPs, SGPs or IPSPs) implements a logical entity (SG, AS) then loadshare with 1+k is the mandatory traffic mode.

A received ASP Active must be acknowledged by an ASP Active Ack message, if no restriction applies e.g. maintenance reason.

If a Routing Context parameter is included in the ASP Active message it is not needed to include the Routing Context parameter in the ASP Active Ack message. Note: This is a deviation to RFC 4666.

| +| 4.3.4.3.1 IPSP Considerations (ASP Active) |

This procedure is mandatory at the interface A.

All comments applicable for section 4.3.4.3 are also applicable for this section.

| +| 4.3.4.4 ASP Inactive Procedures |

This procedure is mandatory at the interface C and is a subset of the procedure used at interface A. See also 4.3.4.4.1.

Configuration data defines which AS an ASP is a member of.

It is optional to send several ASP Active Ack messages in response to a single ASP Active message.

A received ASP Inactive must be acknowledged by an ASP Inactive Ack message, if no restriction applies e.g. maintenance.

The sending of Notify message is mandatory if the As state is changed.

| +| 4.3.4.4.1 IPSP Considerations (ASP Inactive) |

This procedure is mandatory at the interface A.

All comments applicable for section 4.3.4.4 are also applicable for this section.

| + +| Section number in M3UA RFC | Comments | +|----------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 4.3.4.5 Notify Procedures | The procedure is mandatory at the interfaces A and C to reflect an AS state change. | +| 4.3.4.6 Heartbeat Procedures | The procedure is optional. | +| 4.4 Routing Key management procedure | The procedure is optional. | +| 4.5 Procedures to Support the Availability or Congestion Status of SS7 Destination | Heading | +| 4.5.1 At an SGP |

Note: The use of Transfer restricted message is a national option and is about the scope of this specification.

If the SG knows that the ASP supports DRST, then SG shall Send a DRST message, if the SG does not know whether the ASP supports the DRST message the SGW shall send a DAVA message if the destination earlier was unavailable. If the destination was available then no action is required.

| +| 4.5.2 At an ASP | Heading | +| 4.5.2.1 Single SG Configurations | It is mandatory for an ASP to interoperate with one Signaling Gateway. | +| 4.5.2.2 Multiple SG Configurations | It shall be possible to configure an ASP to handle at least a configuration consisting of two Signalling Gateways. | +| 4.5.3 ASP Auditing | Only the part related to international use in Q.704 is inside the scope of this annex. | +| 4.6 MTP 3 restart | The procedure is mandatory. | +| 5. Examples of M3UA Procedures | Descriptive text | +| 5.1. Establishment of Association and Traffic between SGPs and ASPs | Note The procedures defined in the sub-sections to 5.1 are a subset of the procedures defined in section 5.5. | +| 5.1.1 Single ASP in an Application Server ("1+0" sparing) | Descriptive text | +| 5.1.1.1 Single ASP in an Application Server ("1+0" sparing), No Registration | The use of RCn is optional. | +| 5.1.1.2 Single ASP in Application Server ("1+0" sparing), Dynamic Registration | The use of dynamic registration is optional. | +| 5.1.1.3 Single ASP in Multiple Application Servers (each with "1+0" sparing), Dynamic Registration (Case 1 - Multiple Registration Requests) | The use of dynamic registration is optional. | +| 5.1.1.4 Single ASP in Multiple Application Servers (each with "1+0" sparing), Dynamic Registration (Case 2 - Single Registration Request) | The use of dynamic registration is optional. | +| 5.1.2 Two ASPs in Application Server ("1+1" sparing) | This procedure is optional. | +| 5.1.3 Two ASPs in an Application Server ("1+1" sparing, loadsharing case). | The traffic mode parameter is optional in ASP-Active message | +| 5.1.4 Three ASPs in an Application Server ("n+k" sparing, loadsharing case) | The procedure is optional. | +| 5.2 ASP Traffic Failover Examples | Heading | + +| Section number in M3UA RFC | Comments | +|---------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5.2.1 (1+1 Sparing, Withdrawal of ASP, Backup Override) | The use of the procedure "backup override" is optional. | +| 5.2.2 (1+1 Sparing, Backup Override) | The use of the procedure "backup override" is optional. | +| 5.2.3 (n+k Sparing, Loadsharing case, Withdrawal of ASP) | The procedure is optional | +| 5.3 Normal Withdrawal of an ASP from an Application Server and Teardown of an Association | The registration procedure is optional. Routing Contexts (RC) is optional. | +| 5.3.X Normal Withdrawal of the ASP from an Application Server (1+1 sparing) loadsharing and Teardown of Association |
Sequence diagram showing the withdrawal of ASP 2 and ASP 1 from an SGP. The sequence is: SGP sends ASP Inactive to ASP 2; ASP 2 responds with ASP Inactive Ack; SGP sends ASP Inactive to ASP 1; ASP 1 responds with ASP Inactive Ack; SGP sends Notify to ASP 2; ASP 2 responds with ASP Down; SGP sends ASP Down Ack to ASP 2; SGP sends ASP Down to ASP 1; ASP 1 responds with ASP Down Ack.

The figure is added for clarification.

| +| 5.4. Auditing Examples | Heading | +| 5.4.1. SG State: Uncongested/Available | Descriptive text. | +| 5.4.2. SG State: Congested (Congestion Level=2) /Available | Descriptive text. | +| 5.4.3. SG State: Unknown/Available | Descriptive text. | +| 5.4.4. SG State: Unavailable | Descriptive text. | +| 5.5 M3UA/MTP3-User Boundary Examples | Heading | +| 5.5.1 At an ASP | Heading | +| 5.5.1.1 Support for MTP-TRANSFER Primitives at the ASP | Heading | +| 5.5.1.1.1 Support for MTP-TRANSFER Request Primitive | The procedure is mandatory at the interface A and C. This description is also applicable for an IPSP, so replace the abbreviation ASP with ASP/IPSP and SGP with SGP/IPSP | +| 5.5.1.1.2 Support for the MTP-TRANSFER Indication Primitive | The support is mandatory at the interface A and C. This description is also applicable for an IPSP, so replace the abbreviation ASP with ASP/IPSP and SGP with SGP/IPSP. | +| 5.5.1.1.3 Support for ASP Querying of SS7 Destination States | This procedure is mandatory at the interface C. The querying of congestion states is an optional national procedure and outside the scope of this annex. | +| 5.5.2 At an SGP | Heading | +| 5.5.2.1 Support for MTP-TRANSFER Request Primitive at the SGP | The procedure is mandatory at the interface C. Network Appearance is optional. | + +| Section number in M3UA RFC | Comments | +|-----------------------------------------------------------------------------|--------------------------------------------------------------------------------| +| 5.5.2.2 Support for MTP-TRANSFER Indication Primitive at the SGP | The procedure is mandatory at the interface C | +| 5.5.2.3 Support for MTP-PAUSE, MTP-RESUME, MTP-STATUS Indication Primitives | Heading | +| 5.5.2.3.1 Destination Unavailable | The procedure is mandatory at the interface C | +| 5.5.2.3.2 Destination Available | The procedure is mandatory at the interface C | +| 5.5.2.3.3 SS7 Network Congestion | The procedure is mandatory at the interface C | +| 5.5.2.3.4 Destination User Part Unavailable | The procedure is mandatory at the interface C and optional at the interface A. | +| 5.6 Examples for IPSP communication. | Descriptive text. | + +# Annex B (Informative): The use of M2PA in 3GPP networks + +## B.1 Scope + +This annex defines the application of M2PA in 3GPP core networks as an option on interface B. The purpose of the Annex is to ensure the interoperability of different implementations of M2PA as used by different operators and vendors. This is achieved by: + +- Clarifying certain concepts which are used in RFC 4165; +- Defining those features in RFC 4165 for which support is mandatory; +- Defining those features in the RFC 4165 for which support is optional; +- Defining those features in RFC 4165 which shall not be used; + +This specification is intended for interfaces between network domains. However, it can also be used inside one network domain, and constitutes, in that case, a minimum set of M2PA requirements to be supported between IP nodes and between SRP nodes in a 3GPP network. + +## B.2 Introduction + +M2PA may be used between SRPs, i.e. interface B (refer to Figure 1 of Annex A). + +Figure 2 recommends how M2PA is used in a 3GPP IP based signalling network. + +![Diagram illustrating the use of M2PA in 3GPP core networks. It shows two network domains connected via a central SG node. The left domain contains two SG nodes and two SP nodes. The right domain is an SS7 signalling network based on MTP3/MTP2. The connections are labeled M2PA, MTP3/M2PA, and MTP3/MTP2.](b0d4609bc46c2d88a8318706bb5321f7_img.jpg) + +The diagram shows two main network domains represented by clouds. The left cloud contains four nodes: two square nodes labeled 'SG' and two oval nodes labeled 'SP'. The nodes are interconnected: the first 'SG' node is connected to the first 'SP' node and the second 'SG' node; the second 'SG' node is connected to the first 'SG' node, the second 'SP' node, and the third 'SG' node; the first 'SP' node is connected to the second 'SP' node. The third 'SG' node is connected to the second 'SG' node and the right cloud. The right cloud is labeled 'SS7 signalling network based on MTP3/MTP2' and contains several small circles. The connection between the second 'SG' node and the third 'SG' node is labeled 'MTP3/M2PA'. The connection between the third 'SG' node and the right cloud is labeled 'MTP3/MTP2'. The connection between the first 'SG' node and the second 'SG' node is labeled 'M2PA'. + +Diagram illustrating the use of M2PA in 3GPP core networks. It shows two network domains connected via a central SG node. The left domain contains two SG nodes and two SP nodes. The right domain is an SS7 signalling network based on MTP3/MTP2. The connections are labeled M2PA, MTP3/M2PA, and MTP3/MTP2. + +Figure B2.1: Use of M2PA in 3GPP core networks + +## B.3 Protocol conformance to RFC 4165 + +A minimum implementation shall support sections marked mandatory in the table below. It shall be possible to configure all implementations to interoperate (no error messages returned) with the minimum set. + +The table below makes comment to the sections in RFC 4165. In the comment column the following terms are used: + +- Mandatory: When support of text in a section is marked mandatory: + +- On an information element, message or message class, it means that a receiver shall understand the information element, message or message class and carry out the requested action. +- For a procedure, it means that the procedure is mandatory to be carried out by the involved network elements. +- Optional: When support of the text in a section is marked optional the feature involved is only guaranteed to work between peer entities which are subject to a bilateral agreement between operators of those entities. If one end uses an optional information element and the other does not support it, then a silent discard takes place of an information element as a part of the message. This is described as part of the handling of the optionality in the table. +- Excluded: This means that the feature shall not be used in a 3GPP environment + +Descriptive text means that the section does not include any requirements for this specification. + +Note: The word "heading" means that the section consists only of subordinate sections. + +The comments column also defines the behaviour of a minimum implementation if it does not support a message or an information element in a mandatory message. + +| Section number in M2PA RFC | Comments | +|--------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Abstract | Descriptive text | +| 1. Introduction | Descriptive text | +| 1.1 Scope | Descriptive text | +| 1.2 Terminology | Descriptive text. | +| 1.3 Abbreviations | Descriptive text. | +| 1.4 Conventions | Descriptive text. | +| 1.5. Signaling Transport Architecture | Descriptive text | +| 1.5.1 Point Code Representation | Mandatory | +| 1.6 Services Provided by M2PA | Descriptive text | +| 1.6.1 Support for MTP Level 2 / MTP Level 3 Interface Boundary | Mandatory | +| 1.6.2 Support for Peer-to-Peer Communication | Mandatory | +| 1.7. Functions Provided by M2PA | Heading | +| 1.7.1 MTP2 Functionality | Descriptive text | +| 1.7.2 Mapping of SS7 and IP Entities | Mandatory | +| 1.7.3 SCTP Association Management | Mandatory | +| 1.7.4 Retention of MTP3 in the SS7 Network | Descriptive text | +| 1.8. Definition of the M2PA Boundaries | Heading | +| 1.8.1 Definition of the M2PA/MTP Level3 Boundaries | Descriptive text | +| 1.8.2 Definition of the Lower Layer Boundary between M2PA and SCTP | Descriptive text | +| 1.9. Differences Between M2PA and M2UA | Descriptive text | +| 2. Protocol Elements | Mandatory | +| 2.1 Common message header | Mandatory | +| 2.1.1 Version: | Mandatory | +| 2.1.2 Spare | Mandatory | +| 2.1.3 Message class | Mandatory | +| 2.1.4 Message Type | Mandatory | +| 2.1.5 Message Length | Mandatory | +| 2.2 M2PA Header | Mandatory | +| 2.2.1 Backward Sequence Number (BSN) | Mandatory | +| 2.2.2 Forward Sequence Number (FSN) | Mandatory | +| 2.3 M2PA Messages | Mandatory | +| 2.3.1 User Data | Mandatory | +| 2.3.2 Link Status | Mandatory | +| 2.3.2.1 Link Status Proving | Mandatory | +| 3 State Control | Heading | +| 3.1 SCTP Association State Control | Descriptive text | +| 3.2 M2PA Link State Control | Descriptive text | +| 4 Procedures | Mandatory | +| 4.1 Procedures to Support MTP2 Feature | Heading | +| 4.1.1 Signal Unit Format, Delimitation, Acceptance | Descriptive text | +| 4.1.2 MTP and SCTP Entities | The content about how M2PA relates MTP and SCTP entities is Descriptive text.

The relationship between the streams of SCTP and M2PA Messages is mandatory. | +| 4.1.3 Link Alignment | The procedure is Mandatory. | +| 4.1.4 Processor Outage | Mandatory | +| 4.1.5 Level 2 Flow Control | Mandatory | +| 4.1.6 Link Out of Service | Mandatory | +| 4.1.7 SCTP Association Problems | Mandatory | +| 4.1.8 Transmission and Reception Priorities | Mandatory | +| 4.1.9 M2PA Version Control | Mandatory | +| 4.2. Procedures to Support the MTP3/MTP2 Interface | Heading | +| 4.2.1 Sending and Receiving Messages | Mandatory | +| 4.2.2 MTP3 Signaling Link Congestion | Mandatory | +| 4.2.3 Changeover | Mandatory | +| 4.2.3.1 Multiple User Data Streams and Changeover | Descriptive text | +| 4.3 SCTP Considerations | Descriptive text | +| 4.3.1 SCTP Slow Start | Descriptive text

Avoiding the negative effects of slow start is Mandatory. | +| 5 Examples of M2PA Procedures | Descriptive text | + +| Section number in M2PA RFC | Comments | +|--------------------------------------------|------------------| +| 5.1 Link Initialization (Alignment) | Descriptive text | +| 5.2 Message Transmission and Reception | Descriptive text | +| 5.3 Link Status Indication | Descriptive text | +| 5.4 Link Status Message (Processor Outage) | Descriptive text | +| 5.5 Level 2 Flow Control | Descriptive text | +| 5.6 MTP3 Signaling Link Congestion | Descriptive text | +| 5.7 Link Deactivation | Descriptive text | +| 5.8 Link Changeover | Descriptive text | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29204/raw.md b/marked/Rel-18/29_series/29204/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..b1fa3f4b0c7ef6f8d7b2fa5a1c0ce4b0e94cbc74 --- /dev/null +++ b/marked/Rel-18/29_series/29204/raw.md @@ -0,0 +1,1090 @@ + + +# 3GPP TS 29.204 V18.0.0 (2024-03) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Signalling System No. 7 (SS7) security gateway; Architecture, functional description and protocol details (Release 18)** + +![GSMA logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +**GLOBAL SYSTEM FOR +MOBILE COMMUNICATIONS** + +GSMA logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +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. + +© 2024, 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 ..... | 4 | +| Introduction ..... | 4 | +| 1 Scope..... | 5 | +| 2 References..... | 5 | +| 3 Definitions and abbreviations ..... | 5 | +| 3.1 Definitions..... | 5 | +| 3.2 Abbreviations ..... | 6 | +| 4 Network architecture..... | 6 | +| 4.1 Scenarios ..... | 6 | +| 4.1.1 Outbound traffic (not yet protected) from own to foreign NE ..... | 7 | +| 4.1.2 Inbound traffic from foreign to own NE ..... | 7 | +| 4.1.3 Inbound transit traffic ..... | 8 | +| 4.1.4 Outbound transit traffic (not relayed)..... | 9 | +| 4.1.5 Outbound traffic from own to own NE ..... | 9 | +| 4.1.6 Inbound traffic from own to own NE ..... | 10 | +| 4.1.7 Outbound traffic from foreign to own NE..... | 11 | +| 4.1.8 Inbound traffic from own to foreign NE ..... | 11 | +| 4.1.9 Outbound traffic (already protected) from own to foreign NE ..... | 12 | +| 4.1.10 Outbound transit traffic (relayed by SRF)..... | 13 | +| 5 Detailed Behaviour of the SS7 Security Gateway ..... | 13 | +| 5.1 TCAP user traffic ..... | 13 | +| 5.1.1 General ..... | 13 | +| 5.1.2 Interactions with Mobile Number Portability..... | 28 | +| 5.1.3 Interactions with SCCP segmentation..... | 28 | +| 5.1.4 Protocol details ..... | 29 | +| 5.1.4.1 Transformation of unprotected message to protected message ..... | 29 | +| 5.1.4.2 Transformation of protected message to unprotected message ..... | 33 | +| 5.1.4.3 Handling of received XUDTS messages and UDTS messages ..... | 36 | +| Annex A (informative): Change history..... | 39 | + +# --- 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. + +# --- Introduction + +The absence of security in Signalling System No. 7 (SS7) networks is an identified security weakness in 2G systems. This was formerly perceived not to be a problem, since the SS7 networks were the provinces of a small number of large institutions. This is no longer the case, and so there is now a need for security precautions. + +For 3G systems it is a clear goal to be able to protect inter-network SS7 signalling protocols. The protection is done by security gateways which are located at the network border. As a consequence intra network SS7 signalling is not protected and network elements other than Security Gateways are not impacted. + +# --- 1 Scope + +The present document provides functional description of the SS7 Security Gateway. The document covers also network architecture, routeing considerations, and protocol details. + +# --- 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.002: "Mobile Application Part (MAP) specification". +- [2] 3GPP TS 29.078: "Customized Applications for Mobile network Enhanced Logic (CAMEL) Phase 4; CAMEL Application Part (CAP) specification". +- [3] ETSI ETS 300 358: "ISDN Completion of Calls to Busy Subscriber (CCBS) supplementary service; Functional capabilities and information flows". +- [4] 3GPP TS 23.066: "Support of GSM Mobile Number Portability (MNP) stage 2". +- [5] ITU-T Recommendation Q.773: "Specifications of Signalling System No.7; Transaction capabilities formats and encoding". +- [6] 3GPP TS 33.200: "3G Security; Network Domain Security (NDS); Mobile Application Part (MAP) application layer security". +- [7] ITU-T Recommendation E.164: " The international public telecommunication numbering plan". +- [8] 3GPP TS 33.204: "3G Security; Network Domain Security (NDS); Transaction Capabilities Application Part (TCAP) user security". +- [9] ITU-T Recommendations Q.711 to Q.716 (07/96), White Book Signalling Connection Control Part (SCCP). +- [10] 3GPP TS 21.905: "Vocabulary for 3GPP Specifications". + +# --- 3 Definitions and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the terms and definitions given in TR 21.905 [10] 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 [10]. + +TCAP user:                    Application Part identified by one of the following SCCP Subsystem Numbers: + +| | | +|-----------|-------------------------------------------------------------| +| 0000 0110 | HLR (MAP) | +| 0000 0111 | VLR (MAP) | +| 0000 1000 | MSC (MAP) | +| 0000 1001 | EIR (MAP) | +| 0000 1010 | is allocated for evolution (possible Authentication Centre) | + +| | | +|-----------|--------------------------------------------------------| +| 1001 0001 | GMLC (MAP) | +| 1001 0010 | CAP | +| 1001 0011 | gsmSCF (MAP) or IM-SSF (MAP) or Presence Network Agent | +| 1001 0101 | SGSN (MAP) | +| 1001 0110 | GGSN (MAP) | +| 0000 1011 | SSAP | + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------|-----------------------------------------------------| +| CC | Country Code | +| GSMA | Global System for Mobile communications Association | +| IV | Initialisation Vector | +| MAC | Message Authentication Code | +| MNP | Mobile Number Portability | +| MSISDN | Mobile Station International ISDN Number | +| NDC | National Destination Code | +| NE | Network Entit | +| PLMN | Public Land Mobile Network y | +| RN | Routeing Number | +| SAD | Security Association Database | +| SEG | Security Gateway | +| SPD | Security Policy Database | +| SPI | Security Parameter Index | +| SRF | Signalling Relay Functio | +| TCAP | Transcation Capabilities Application Part | +| UDT | SCCP Unidata message | +| XUDT | SCCP Extended Unidata message n | + +# 4 Network architecture + +In a PLMN that employs SS7 Security Gateways all TCAP user signalling messages entering or leaving the PLMN have to transit an SS7 Security Gateway which belongs to the PLMN and which performs the protection of leaving (i.e. outbound) messages and the protection checking and de-protection or blocking of entering (i.e. inbound) messages. + +One or several SS7 Security Gateways may be employed within a PLMN. + +An SS7 Security Gateway may be co-located with any TCAP user NE or it may stand alone. However, for the purpose of this document and without imposing any restrictions, it is assumed that the SS7 Security Gateways is a stand alone entity. + +It is further assumed that the SS7 Security Gateways are located at the boarder of the PLMN i.e. inbound messages transit an SS7 Security Gateway before they reach any other node within the PLMN, and outbound messages transit an SS7 Security Gateway immediately before reaching a node outside the PLMN. + +SS7 routeing is not impacted by the SS7 Security Gateway Architecture. As a consequence SS7 Security Gateways are stateless at TCAP level: No TCAP dialogue states are maintained in the SS7 Security Gateway since the outbound dialogue request message may transit a different SS7 Security Gateway than the corresponding inbound dialogue response message; similarly the inbound dialogue request message may transit a different SS7 Security Gateway than the corresponding outbound dialogue response message. + +## 4.1 Scenarios + +SS7 Security Gateways perform protection, de-protection, blocking and unmodified passing of TCAP user messages depending on the scenario as described below: + +Note that scenarios 4.1.5, 4.1.6, 4.1.7, 4.1.8, and 4.1.9 are not applicable if all PLMN's TCAP user NEs are interconnected by PLMN internal signalling links and routing tables are set up not to allow these scenarios. + +### 4.1.1 Outbound traffic (not yet protected) from own to foreign NE + +This scenario is shown in figure 4.1.1. The message is originated at a NE inside the PLMN. It may transit several transit nodes inside the PLMN before it reaches the SS7 Security Gateway. This SS7 Security Gateway protects the message according to the relevant Security Policy with the relevant Security Association. The message may then transit several nodes outside the PLMN (including an SS7 Security Gateway) before it reaches its destination. + +![Diagram of outbound traffic from own to foreign NE](d793cf7c174b89eb024d132f00679787_img.jpg) + +The diagram illustrates the flow of an unprotected TCAP user message within a PLMN (represented by an orange cloud). The message originates at a yellow 'TCAP user NE' box, passes through a cyan 'Transit Node' box, and then reaches a red 'SS7 Security Gateway' box. A red arrow points from the gateway to the text 'to destination'. Labels 'unprotected TCAP user message' and 'protected TCAP user message' are present, with lines pointing to the message path before and after the security gateway, respectively. + +Diagram of outbound traffic from own to foreign NE + +Figure 4.1.1: Outbound traffic (not yet protected) from own to foreign NE + +### 4.1.2 Inbound traffic from foreign to own NE + +This scenario is shown in figure 4.1.2. The message is originated at a NE outside the PLMN. It may transit several transit nodes (including an SS7 Security Gateway) outside the PLMN before it reaches the PLMN's SS7 Security Gateway. This SS7 Security Gateway checks whether the message is correctly protected according to the relevant security association. If it is not, the message is blocked (discarded), otherwise it is de-protected. To determine the relevant security association the fact that the message may have been relayed by an MNP-SRF in a transit network (see Clause 4.1.10 and 5.1.2) needs to be taken into account. After successful de-protection the message may then transit several nodes inside the PLMN before it reaches the TCAP user NE. + +![Figure 4.1.2: Inbound traffic from foreign to own NE. A diagram showing a PLMN cloud containing a TCAP user NE, a Transit Node, and an SS7 Security Gateway. An unprotected TCAP user message is shown entering the PLMN from the left. A protected TCAP user message is shown entering the PLMN from the right (from origin) and being processed by the SS7 Security Gateway. Arrows indicate the flow of messages from the SS7 Security Gateway to the Transit Node and then to the TCAP user NE.](d0abac95583b52a3b35f74a215567334_img.jpg) + +Figure 4.1.2: Inbound traffic from foreign to own NE. A diagram showing a PLMN cloud containing a TCAP user NE, a Transit Node, and an SS7 Security Gateway. An unprotected TCAP user message is shown entering the PLMN from the left. A protected TCAP user message is shown entering the PLMN from the right (from origin) and being processed by the SS7 Security Gateway. Arrows indicate the flow of messages from the SS7 Security Gateway to the Transit Node and then to the TCAP user NE. + +Figure 4.1.2: Inbound traffic from foreign to own NE + +### 4.1.3 Inbound transit traffic + +This scenario is shown in figure 4.1.3. The message is originated at a NE outside the transit PLMN. It may transit several transit nodes outside the transit PLMN before it reaches the SS7 Security Gateway in inbound direction. This SS7 Security Gateway passes the message unmodified. The message may then transit several transit nodes inside the transit PLMN, another SS7 Security Gateway of the transit PLMN in outbound direction (see Clause 4.1.4), and several transit nodes outside the transit and destination PLMN (potentially including an SS7 Security Gateway) before it reaches the destination PLMN. + +Note: A PLMN operator may decide not to act as transit network for specific or all combinations of origin and destination. In this case the SS7 Security Gateway may block the inbound message. + +![Figure 4.1.3: Inbound transit traffic. A diagram showing a PLMN cloud containing an SS7 Security Gateway, a Transit Node, and an SS7 SEG. A protected or unprotected TCAP user message is shown entering the PLMN from the left (from origin) and being processed by the SS7 Security Gateway. Arrows indicate the flow of the message from the SS7 Security Gateway to the Transit Node and then to the SS7 SEG, which then exits the PLMN to the destination. The message exiting the PLMN is labeled as 'protected or unprotected TCAP user message'.](e1a0d046fbe7f28f5e93a47091851747_img.jpg) + +Figure 4.1.3: Inbound transit traffic. A diagram showing a PLMN cloud containing an SS7 Security Gateway, a Transit Node, and an SS7 SEG. A protected or unprotected TCAP user message is shown entering the PLMN from the left (from origin) and being processed by the SS7 Security Gateway. Arrows indicate the flow of the message from the SS7 Security Gateway to the Transit Node and then to the SS7 SEG, which then exits the PLMN to the destination. The message exiting the PLMN is labeled as 'protected or unprotected TCAP user message'. + +Figure 4.1.3: Inbound transit traffic + +### 4.1.4 Outbound transit traffic (not relayed) + +This scenario is shown in figure 4.1.4. The message is originated at a NE outside the transit PLMN. It may transit several transit nodes outside the transit PLMN (including an SS7 Security Gateway), an SS7 Security Gateway of the transit PLMN in inbound direction (see Clause 4.1.3), and several transit nodes inside the transit PLMN before it reaches the SS7 Security Gateway in outbound direction. This SS7 Security Gateway passes the message unmodified. The message may then transit several transit nodes outside the transit and destination PLMN (potentially including an SS7 Security Gateway) before it reaches the destination PLMN. + +![Diagram of outbound transit traffic (not relayed)](367926125450c2bc3f4bdca9d59a62ba_img.jpg) + +The diagram illustrates the path of a message through a PLMN cloud. An arrow labeled 'from origin' points to a blue box labeled 'SS7 SEG' located outside the PLMN cloud. From the 'SS7 SEG', an arrow points into the PLMN cloud to a cyan box labeled 'Transit Node'. From the 'Transit Node', an arrow points to a red box labeled 'SS7 Security Gateway' located inside the PLMN cloud. From the 'SS7 Security Gateway', an arrow points out of the PLMN cloud to the text 'to destination'. A label 'protected or unprotected TCAP user message' has three lines pointing to the message path: one line points to the arrow between 'from origin' and 'SS7 SEG', another points to the arrow between 'SS7 SEG' and 'Transit Node', and the third points to the arrow between 'Transit Node' and 'SS7 Security Gateway'. + +Diagram of outbound transit traffic (not relayed) + +Figure 4.1.4: Outbound transit traffic (not relayed) + +### 4.1.5 Outbound traffic from own to own NE + +This scenario is shown in figure 4.1.5. The message is originated at a NE inside the PLMN. It may transit several transit nodes inside the PLMN before it reaches the SS7 Security Gateway in outbound direction. This SS7 Security Gateway protects the message according to the relevant Security Association. The message may then transit several transit nodes outside the PLMN, another SS7 Security Gateway of the PLMN in inbound direction (see Clause 4.1.6) and several transit nodes within the PLMN before it reaches the destination NE inside the PLMN. + +![Diagram of outbound traffic from own to own NE](e6df2733626a85205c1db682e6259c46_img.jpg) + +The diagram shows a PLMN cloud containing two 'TCAP user NE' boxes and two 'Transit Node' boxes. Arrows labeled 'unprotected TCAP user message' point from the TCAP user NEs to the Transit Nodes. From the Transit Nodes, traffic flows to an 'SS7 Security Gateway' (red box). A red arrow exits the PLMN to an external 'Transit Node'. From there, a red arrow leads back into the PLMN to an 'SS7 SEG' box. Arrows labeled 'protected TCAP user message' point from this path back towards the internal TCAP user NEs. + +Diagram of outbound traffic from own to own NE + +**Figure 4.1.5: Outbound traffic from own to own NE** + +### 4.1.6 Inbound traffic from own to own NE + +This scenario is shown in figure 4.1.6. The message is originated at a NE inside the PLMN. It may transit several transit nodes inside the PLMN, an SS7 Security Gateway of the PLMN in outbound direction (see Clause 4.1.5), and several transit nodes outside the PLMN before it reaches the SS7 Security Gateway in inbound direction. This SS7 Security Gateway checks whether the message is correctly protected according to the relevant Security Association. If it is not, the message is blocked (discarded), otherwise it is de-protected. The message may then transit several transit nodes inside the PLMN before it reaches the destination NE inside the PLMN. + +![Diagram of inbound traffic from own to own NE](c2fc2621e8206d24427b56bcb2398fc0_img.jpg) + +The diagram shows a PLMN cloud containing two 'TCAP user NE' boxes and two 'Transit Node' boxes. Arrows labeled 'unprotected TCAP user message' point from the TCAP user NEs to the Transit Nodes. From the Transit Nodes, traffic flows to an 'SS7 SEG' box. A red arrow exits the PLMN to an external 'Transit Node'. From there, a red arrow leads back into the PLMN to an 'SS7 Security Gateway' (red box). Arrows labeled 'protected TCAP user message' point from this path back towards the internal TCAP user NEs. + +Diagram of inbound traffic from own to own NE + +**Figure 4.1.6: Inbound traffic from own to own NE** + +### 4.1.7 Outbound traffic from foreign to own NE + +This scenario is shown in figure 4.1.7. The message is originated at a NE outside the PLMN. It may transit several transit nodes outside the PLMN, an SS7 Security Gateway of the PLMN in inbound direction (see Clause 4.1.2), and several transit nodes inside the PLMN before it reaches the SS7 Security Gateway in outbound direction. This SS7 Security Gateway protects the message according to the reverse relevant Security Association. The message may then transit several transit nodes outside the PLMN, another SS7 Security Gateway of the PLMN in inbound direction (see Clause 4.1.2) and several transit nodes within the PLMN before it reaches the destination NE inside the PLMN. + +![Diagram illustrating outbound traffic from a foreign network element (NE) to an own NE within a PLMN. The traffic originates from an external source, passes through an external SS7 Security Gateway (SEG) and Transit Node, enters the PLMN through an inbound SS7 Security Gateway, transits through internal nodes, and exits the PLMN through an outbound SS7 Security Gateway. The message is unprotected (TCAP user message) while inside the PLMN and becomes protected (protected TCAP user message) after the outbound gateway.](7e670a2b556b53ea9002dfff3a420e08_img.jpg) + +The diagram shows the path of a message from an external origin to a destination NE within a PLMN. The message starts as an 'unprotected TCAP user message' and becomes a 'protected TCAP user message' after passing through the outbound SS7 Security Gateway. + +``` +graph LR; Origin[from origin] --> SEG1[SS7 SEG]; SEG1 --> TN1[Transit Node]; TN1 --> SGW1[SS7 Security Gateway]; subgraph PLMN; SGW1 --> TN2[Transit Node]; TN2 --> NE[TCAP user NE]; NE --> TN3[Transit Node]; TN3 --> SEG2[SS7 SEG]; end; SEG2 --> TN4[Transit Node]; TN4 --> SGW2[SS7 Security Gateway]; +``` + +Diagram illustrating outbound traffic from a foreign network element (NE) to an own NE within a PLMN. The traffic originates from an external source, passes through an external SS7 Security Gateway (SEG) and Transit Node, enters the PLMN through an inbound SS7 Security Gateway, transits through internal nodes, and exits the PLMN through an outbound SS7 Security Gateway. The message is unprotected (TCAP user message) while inside the PLMN and becomes protected (protected TCAP user message) after the outbound gateway. + +Figure 4.1.7: Outbound traffic from foreign to own NE + +### 4.1.8 Inbound traffic from own to foreign NE + +This scenario is shown in figure 4.1.8. The message is originated at a NE inside the PLMN. It may transit several transit nodes inside the PLMN, an SS7 Security Gateway of the PLMN in outbound direction (see Clause 4.1.1), and several transit nodes outside the PLMN before it reaches the SS7 Security Gateway in inbound direction. This SS7 Security Gateway checks whether the message is correctly protected according to the relevant security association. If it is not, the message is blocked (discarded); otherwise it is passed unmodified. The message may then transit several transit nodes inside the PLMN, another SS7 Security Gateway of the PLMN in outbound direction (see Clause 4.1.9) and several transit nodes outside the PLMN (including an SS7 Security Gateway) before it reaches the destination NE outside the PLMN. + +![Diagram of inbound traffic from own to foreign NE](27b06ec9f42b5d727a2630f61a5f1861_img.jpg) + +This diagram illustrates the path of an inbound TCAP user message from a TCAP user NE inside a PLMN to a destination outside. The message starts as an 'unprotected TCAP user message' from the TCAP user NE. It is first processed by an internal 'Transit Node', then an 'SS7 SEG'. It then passes through another 'Transit Node' and an 'SS7 Security Gateway' within the PLMN. After exiting the PLMN, it passes through an external 'Transit Node' and another 'SS7 Security Gateway' before reaching the 'to destination' point. The message is shown as a 'protected TCAP user message' after it leaves the PLMN. + +Diagram of inbound traffic from own to foreign NE + +Figure 4.1.8: Inbound traffic from own to foreign NE + +### 4.1.9 Outbound traffic (already protected) from own to foreign NE + +This scenario is shown in figure 4.1.9. The message is originated at a NE inside the PLMN. It may transit several transit nodes inside the PLMN, an SS7 Security Gateway of the PLMN in outbound direction (see Clause 4.1.1), several transit nodes outside the PLMN, an SS7 Security Gateway of the PLMN in inbound direction (see Clause 4.1.8), and several transit nodes inside the PLMN before it reaches the SS7 Security Gateway. This SS7 Security Gateway passes the message unmodified. The message may then transit several transit nodes outside the PLMN (including an SS7 Security Gateway) before it reaches the destination NE outside the PLMN. + +![Diagram of outbound traffic (already protected) from own to foreign NE](853f59c89931a666c07903b31d098277_img.jpg) + +This diagram illustrates the path of an outbound TCAP user message from a TCAP user NE inside a PLMN to a destination outside. The message starts as an 'unprotected TCAP user message' from the TCAP user NE. It is first processed by an internal 'Transit Node', then an 'SS7 SEG'. It then passes through another 'Transit Node' and an 'SS7 Security Gateway' within the PLMN. After exiting the PLMN, it passes through an external 'Transit Node' and another 'SS7 Security Gateway' before reaching the 'to destination' point. The message is shown as a 'protected TCAP user message' after it leaves the PLMN. + +Diagram of outbound traffic (already protected) from own to foreign NE + +Figure 4.1.9: Outbound traffic (already protected) from own to foreign NE + +### 4.1.10 Outbound transit traffic (relayed by SRF) + +This scenario is shown in figure 4.1.10. The message (originally destined for the PLMN) is originated at a NE outside the transit PLMN. It may transit several transit nodes outside the transit PLMN (including an SS7 Security Gateway), an SS7 Security Gateway of the transit PLMN in inbound direction (see Clause 4.1.2), several transit nodes inside the transit PLMN, and an MNP-SRF which replaces the SCCP called party address of the message before it reaches the SS7 Security Gateway in outbound direction. This SS7 Security Gateway recognizes that the message was relayed by an SRF by analyzing the SCCP called party address and protects the message with the relevant Security Association. The message may then transit several transit nodes outside the transit and destination PLMN (potentially including an SS7 Security Gateway) before it reaches the destination PLMN. + +![Diagram illustrating outbound transit traffic relayed by an SRF within a PLMN.](410562339ce067fdc6fa41940c118658_img.jpg) + +The diagram shows a large orange cloud representing a PLMN. Inside the cloud, there are three main components: an 'SS7 SEG' (blue box), an 'MNP SRF' (pink box), and an 'SS7 Security Gateway' (red box). A red arrow labeled 'from origin' points into the cloud towards the SS7 SEG. A black arrow points from the SS7 SEG to the MNP SRF. Another black arrow points from the MNP SRF to the SS7 Security Gateway. A red arrow labeled 'to destination' points out of the cloud from the SS7 Security Gateway. A grey line labeled 'protected TCAP user message' originates from the SS7 Security Gateway and points towards the destination. Another grey line labeled 'unprotected TCAP user message' originates from the MNP SRF and points towards the destination. + +Diagram illustrating outbound transit traffic relayed by an SRF within a PLMN. + +Figure 4.1.10: Outbound transit traffic (relayed by SRF) + +# 5 Detailed Behaviour of the SS7 Security Gateway + +## 5.1 TCAP user traffic + +### 5.1.1 General + +With regard to TCAP user traffic the SS7 Security Gateway performs message protection, protection checking and de-protection, transparent passing, and blocking of messages depending on the message's origin (SCCP calling party address), the message's destination (SCCP called party address), and the message's direction (inbound or outbound) as shown in figure 5.1.1. + +![Flowchart for SS7 Security Gateway procedure. It starts with 'Idle', followed by 'TCAP user message', then 'Check direction'. It branches into INBOUND (IN), OUTBOUND (OUT), and 'not crossing PLMN boundary' (pass). The IN branch leads to 'check origin and destination', which further branches into 'own to own', 'own to foreign', 'foreign to own', and 'foreign to foreign'. The first three lead to 'Inbound' processing blocks, which then lead to a 'result = block' decision. 'own to own' and 'foreign to own' lead to 'block' if 'yes', and 'pass' if 'no'. 'own to foreign' leads to 'pass'. 'foreign to foreign' leads directly to 'pass'.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +procedure SS7\_Security\_Gateway 1(2) + +Procedure in +the SS7 Security +Gateway + +``` +graph TD; Idle([Idle]) --> TCAP[TCAP user message]; TCAP --> CheckDir[Check direction]; CheckDir --> INBOUND[INBOUND]; CheckDir --> OUTBOUND[OUTBOUND]; CheckDir --> NotCrossing[not crossing PLMN boundary]; INBOUND --> IN((IN)); OUTBOUND --> OUT((OUT)); NotCrossing --> pass1((pass)); IN --> CheckOrigin[check origin and destination]; CheckOrigin --> OwnToOwn[own to own]; CheckOrigin --> OwnToForeign[own to foreign]; CheckOrigin --> ForeignToOwn[foreign to own]; CheckOrigin --> ForeignToForeign[foreign to foreign]; OwnToOwn --> InboundOwnToOwn[Inbound_own_to_own]; OwnToForeign --> InboundOwnToForeign[Inbound_own_to_foreign]; ForeignToOwn --> InboundForeignToOwn[Inbound_foreign_to_own]; InboundOwnToOwn --> Result{result = block}; InboundOwnToForeign --> Result; InboundForeignToOwn --> Result; ForeignToForeign --> pass2((pass)); Result -- yes --> block((block)); Result -- no --> pass3((pass)); +``` + +Flowchart for SS7 Security Gateway procedure. It starts with 'Idle', followed by 'TCAP user message', then 'Check direction'. It branches into INBOUND (IN), OUTBOUND (OUT), and 'not crossing PLMN boundary' (pass). The IN branch leads to 'check origin and destination', which further branches into 'own to own', 'own to foreign', 'foreign to own', and 'foreign to foreign'. The first three lead to 'Inbound' processing blocks, which then lead to a 'result = block' decision. 'own to own' and 'foreign to own' lead to 'block' if 'yes', and 'pass' if 'no'. 'own to foreign' leads to 'pass'. 'foreign to foreign' leads directly to 'pass'. + +Figure 5.1.1 Process SS7 Security Gateway (sheet 1 of 2) + +![Flowchart for SS7 Security Gateway procedure. It starts with 'OUT', followed by 'check origin and destination'. A decision point branches into four cases: 'own to own' (Outbound_own_to_own), 'own to foreign' (Outbound_own_to_foreign), 'foreign to own' (Outbound_foreign_to_own), and 'foreign to foreign' (Outbound_foreign_to_foreign). All four cases lead to a 'pass' node. Below this, there is a 'block' node and a 'pass' node leading to a 'TCAP user message'. Both 'block' and 'TCAP user message' lead to an 'Idle' node.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +procedure SS7\_Security\_Gateway + +2(2) + +Procedure in the SS7 Security Gateway + +``` +graph TD; OUT((OUT)) --> check[check origin and destination]; check --> own_to_own[own to own]; check --> own_to_foreign[own to foreign]; check --> foreign_to_own[foreign to own]; check --> foreign_to_foreign[foreign to foreign]; own_to_own --> Outbound_own_to_own[Outbound_own_to_own]; own_to_foreign --> Outbound_own_to_foreign[Outbound_own_to_foreign]; foreign_to_own --> Outbound_foreign_to_own[Outbound_foreign_to_own]; foreign_to_foreign --> Outbound_foreign_to_foreign[Outbound_foreign_to_foreign]; Outbound_own_to_own --> pass1((pass)); Outbound_own_to_foreign --> pass1; Outbound_foreign_to_own --> pass1; Outbound_foreign_to_foreign --> pass1; pass1 --> block((block)); pass1 --> pass2((pass)); pass2 --> TCAP[TCAP user message]; block --> Idle([Idle]); TCAP --> Idle; +``` + +Flowchart for SS7 Security Gateway procedure. It starts with 'OUT', followed by 'check origin and destination'. A decision point branches into four cases: 'own to own' (Outbound\_own\_to\_own), 'own to foreign' (Outbound\_own\_to\_foreign), 'foreign to own' (Outbound\_foreign\_to\_own), and 'foreign to foreign' (Outbound\_foreign\_to\_foreign). All four cases lead to a 'pass' node. Below this, there is a 'block' node and a 'pass' node leading to a 'TCAP user message'. Both 'block' and 'TCAP user message' lead to an 'Idle' node. + +Figure 5.1.1 Process SS7 Security Gateway (sheet 2 of 2) + +![Flowchart for macrodefinition Check_Direction. It starts with a connector, followed by a decision 'previous node belongs to own PLMN'. If 'yes', it goes to another decision 'next node belongs to own PLMN'. If 'yes', it ends at 'not crossing PLMN boundary'. If 'no', it ends at 'OUTBOUND'. If 'no' from the first decision, it goes to another decision 'next node belongs to own PLMN'. If 'yes', it ends at 'INBOUND'. If 'no', it ends at 'not crossing PLMN boundary'.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +macrodefinition Check\_Direction 1(1) + +``` +graph TD; Start([ ]) --> D1{previous node belongs to own PLMN}; D1 -- yes --> D2{next node belongs to own PLMN}; D1 -- no --> D3{next node belongs to own PLMN}; D2 -- yes --> E1(( )); D2 -- no --> E2(( )); D3 -- yes --> E3(( )); D3 -- no --> E4(( )); E1 --- E1_L[not crossing PLMN boundary]; E2 --- E2_L[OUTBOUND]; E3 --- E3_L[INBOUND]; E4 --- E4_L[not crossing PLMN boundary]; +``` + +Flowchart for macrodefinition Check\_Direction. It starts with a connector, followed by a decision 'previous node belongs to own PLMN'. If 'yes', it goes to another decision 'next node belongs to own PLMN'. If 'yes', it ends at 'not crossing PLMN boundary'. If 'no', it ends at 'OUTBOUND'. If 'no' from the first decision, it goes to another decision 'next node belongs to own PLMN'. If 'yes', it ends at 'INBOUND'. If 'no', it ends at 'not crossing PLMN boundary'. + +Figure 5.1.2 Macro Check\_Direction (sheet 1 of 1) + +![Flowchart for macrodefinition Inbound_own_to_own](8307f6b04df072c9332f9987e034272c_img.jpg) + +macrodefinition Inbound\_own\_to\_own + +1(1) + +``` +graph TD; Start([ ]) --> D1{message contains protectable parameter}; D1 -- no --> Pass1((pass)); D1 -- yes --> D2{message is not protected}; D2 -- no --> D3{message should be protected according to SPD}; D2 -- yes --> D4{Fall Back allowed according to SPD}; D4 -- yes --> Pass2((pass)); D4 -- no --> Block((block)); D3 -- no --> D5{calling party address consistent with SPI}; D3 -- yes --> D6{protection mode acceptable according to SPD}; D5 -- no --> D6; D5 -- yes --> D7{success}; D6 -- no --> D7; D6 -- yes --> Deprotect[De-protect message]; Deprotect --> D7; D7 -- no --> Block; D7 -- yes --> Pass3((pass)); Block --> Pass2; +``` + +The flowchart illustrates the logic for the macrodefinition Inbound\_own\_to\_own. It begins with a start node leading to a decision box 'message contains protectable parameter'. If 'no', it passes. If 'yes', it proceeds to 'message is not protected'. If 'no', it goes to 'message should be protected according to SPD'. If 'yes', it checks 'Fall Back allowed according to SPD'. If 'yes', it passes; if 'no', it blocks. From 'message should be protected according to SPD', if 'no', it checks 'calling party address consistent with SPI'. If 'yes', it checks 'protection mode acceptable according to SPD'. If 'no', it checks 'success'. If 'yes', it de-protects the message and checks 'success'. If 'success' is 'no', it blocks; if 'yes', it passes. If 'calling party address consistent with SPI' is 'no', it proceeds to 'protection mode acceptable according to SPD'. All 'pass' nodes lead to a common exit point. + +Flowchart for macrodefinition Inbound\_own\_to\_own + +Figure 5.1.3 Macro Inbound\_own\_to\_own (sheet 1 of 1) + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or a parameter is present in an Invoke or ReturnError Component, or a result is present in a ReturnResult Component. + +The decision box "message is not protected" takes the "no"-exit if user-information within the Dialogue Portion is identified by the object identifier ss7-ProtectedDialogueAS or + +operationCode within an Invoke or ReturnResult Component takes the global value ss7-ProtectedDialogueAS or errorCode within an ReturnError Component takes the global value ss7-ProtectedDialogueAS. + +The decision box "message should be protected according to SPD" takes the "yes"-exit if the message's SCCP calling party address identifies a PLMN for which an SPD entry for incoming messages exists. + +The decision box "fall back allowed according to SPD" takes the "yes"-exit if the SPD entry for incoming messages is marked "fall back allowed". + +The decision box "calling party address consistent with SPI" takes the "yes"-exit if the SPI within the message's Security Header points to an SA that was negotiated with the PLMN derived from the message's SCCP calling party address. + +The decision box "protection mode acceptable according to SPD" takes the "yes"-exit if the protection mode within the message's Security Header is found in the SPD-entry for incoming messages. + +![Flowchart for macrodefinition Inbound_own_to_foreign. The process starts with an oval connector. The first decision is 'message contains protectable parameter'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to the next decision 'message is not protected'. If 'no', it goes to a 'block' connector. If 'yes', it goes to the next decision 'message should be protected according to SPD'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to the next decision 'Fall Back allowed according to SPD'. If 'no', it goes to a 'block' connector. If 'yes', it goes to a 'pass' connector. From the 'block' connector, it goes to a decision 'called party address consistent with SPI'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to the next decision 'protection mode correct'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to a 'pass' connector.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +macrodefinition Inbound\_own\_to\_foreign 1(1) + +``` +graph TD; Start([ ]) --> D1{message contains protectable parameter}; D1 -- no --> P1((pass)); D1 -- yes --> D2{message is not protected}; D2 -- no --> B1((block)); D2 -- yes --> D3{message should be protected according to SPD}; D3 -- no --> P2((pass)); D3 -- yes --> D4{Fall Back allowed according to SPD}; D4 -- no --> B2((block)); D4 -- yes --> P3((pass)); B2 --> D5{called party address consistent with SPI}; D5 -- no --> P4((pass)); D5 -- yes --> D6{protection mode correct}; D6 -- no --> P5((pass)); D6 -- yes --> P6((pass)); +``` + +Flowchart for macrodefinition Inbound\_own\_to\_foreign. The process starts with an oval connector. The first decision is 'message contains protectable parameter'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to the next decision 'message is not protected'. If 'no', it goes to a 'block' connector. If 'yes', it goes to the next decision 'message should be protected according to SPD'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to the next decision 'Fall Back allowed according to SPD'. If 'no', it goes to a 'block' connector. If 'yes', it goes to a 'pass' connector. From the 'block' connector, it goes to a decision 'called party address consistent with SPI'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to the next decision 'protection mode correct'. If 'no', it goes to a 'pass' connector. If 'yes', it goes to a 'pass' connector. + +**Figure 5.1.4 Macro Inbound\_own\_to\_foreign (sheet 1 of 1)** + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or a parameter is present in an Invoke or ReturnError Component, or a result is present in a ReturnResult Component. + +The decision box "message is not protected" takes the "no"-exit if user-information within the Dialogue Portion is identified by the object identifier ss7-ProtectedDialogueAS or + +operationCode within an Invoke or ReturnResult Component takes the global value ss7-ProtectedDialogueAS or errorCode within an ReturnError Component takes the global value ss7-ProtectedDialogueAS. + +The decision box "message should be protected according to SPD" takes the "yes"-exit if the message's SCCP called party address identifies a PLMN for which an SPD entry for outgoing messages exists. + +The decision box "fall back allowed according to SPD" takes the "yes"-exit if the SPD entry for outgoing messages is marked "fall back allowed". + +The decision box "called party address consistent with SPI" takes the "yes"-exit if the SPI within the message's Security Header points to an SA that was negotiated with the PLMN derived from the message's SCCP called party address. + +The decision box "protection mode correct" takes the "yes"-exit if the presence/absence of octets 10 and 11 within the message's Security Header is consistent with the protection mode in the SPD-entry for outgoing messages. Note that octets 10 and 11 of the Security Header are only used to construct the IV which is not needed (and shall therefore be absent) if the protection mode is "authenticity and integrity". + +![Flowchart for macrodefinition Inbound_foreign_to_own. It starts with a connector, followed by a decision 'message contains protectable parameter'. If 'no', it goes to 'pass'. If 'yes', it goes to 'message is not protected'. If 'no', it goes to connector 'A'. If 'yes', it goes to 'relayed by SRF'. If 'no', it goes to a merge point. If 'yes', it goes to 'message should be protected according to SPD (relay network)'. If 'no', it goes to 'pass'. If 'yes', it goes to 'Fall Back allowed according to SPD (relay network)'. If 'no', it goes to a merge point. If 'yes', it goes to 'pass'. The merge point leads to 'message should be protected according to SPD (orig. network)'. If 'no', it goes to 'block'. If 'yes', it goes to 'Fall Back allowed according to SPD (orig. network)'. If 'no', it goes to a merge point. If 'yes', it goes to 'pass'.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +macrodefinition Inbound\_foreign\_to\_own + +1(2) + +``` +graph TD; Start([ ]) --> D1{message contains protectable parameter}; D1 -- no --> P1((pass)); D1 -- yes --> D2{message is not protected}; D2 -- no --> A((A)); D2 -- yes --> D3{relayed by SRF}; D3 -- no --> M1(( )); D3 -- yes --> D4{message should be protected according to SPD (relay network)}; D4 -- no --> P2((pass)); D4 -- yes --> D5{Fall Back allowed according to SPD (relay network)}; D5 -- no --> M2(( )); D5 -- yes --> P3((pass)); M1 --> D6{message should be protected according to SPD (orig. network)}; D6 -- no --> B((block)); D6 -- yes --> D7{Fall Back allowed according to SPD (orig. network)}; D7 -- no --> M3(( )); D7 -- yes --> P4((pass)); M2 --> M3; +``` + +Flowchart for macrodefinition Inbound\_foreign\_to\_own. It starts with a connector, followed by a decision 'message contains protectable parameter'. If 'no', it goes to 'pass'. If 'yes', it goes to 'message is not protected'. If 'no', it goes to connector 'A'. If 'yes', it goes to 'relayed by SRF'. If 'no', it goes to a merge point. If 'yes', it goes to 'message should be protected according to SPD (relay network)'. If 'no', it goes to 'pass'. If 'yes', it goes to 'Fall Back allowed according to SPD (relay network)'. If 'no', it goes to a merge point. If 'yes', it goes to 'pass'. The merge point leads to 'message should be protected according to SPD (orig. network)'. If 'no', it goes to 'block'. If 'yes', it goes to 'Fall Back allowed according to SPD (orig. network)'. If 'no', it goes to a merge point. If 'yes', it goes to 'pass'. + +Figure 5.1.5 Macro Inbound\_foreign\_to\_own (sheet 1 of 2) + +![Flowchart for macrodefinition Inbound_foreign_to_own. The process starts at node A. It enters a loop of decision diamonds. The first decision is 'calling party address consistent with SPI'. If 'yes', it proceeds to 'De-protect message'. If 'no', it goes to 'relayed by SRF'. If 'no', it proceeds to 'De-protect message'. If 'yes', it goes to 'protection mode acceptable according to SPD (relay network)'. If 'no', it leads to a 'block' node. If 'yes', it proceeds to 'De-protect message'. From 'De-protect message', it goes to 'success'. If 'no', it leads to a 'block' node. If 'yes', it leads to a 'pass' node. There is also a decision diamond 'protection mode acceptable according to SPD (orig. network)' which receives a 'no' from the relay network decision and leads to 'De-protect message' if 'yes'.](e180f2b5fcbe8001554a7c0677cd3f82_img.jpg) + +macrodefinition Inbound\_foreign\_to\_own + +2(2) + +``` +graph TD; A((A)) --> D1{calling party address consistent with SPI}; D1 -- yes --> DM[De-protect message]; D1 -- no --> D2{relayed by SRF}; D2 -- no --> DM; D2 -- yes --> D3{protection mode acceptable according to SPD (relay network)}; D3 -- no --> B1((block)); D3 -- yes --> DM; DM --> D4{success}; D4 -- no --> B2((block)); D4 -- yes --> P((pass)); D3 -- no --> D5{protection mode acceptable according to SPD (orig. network)}; D5 -- yes --> DM; +``` + +Flowchart for macrodefinition Inbound\_foreign\_to\_own. The process starts at node A. It enters a loop of decision diamonds. The first decision is 'calling party address consistent with SPI'. If 'yes', it proceeds to 'De-protect message'. If 'no', it goes to 'relayed by SRF'. If 'no', it proceeds to 'De-protect message'. If 'yes', it goes to 'protection mode acceptable according to SPD (relay network)'. If 'no', it leads to a 'block' node. If 'yes', it proceeds to 'De-protect message'. From 'De-protect message', it goes to 'success'. If 'no', it leads to a 'block' node. If 'yes', it leads to a 'pass' node. There is also a decision diamond 'protection mode acceptable according to SPD (orig. network)' which receives a 'no' from the relay network decision and leads to 'De-protect message' if 'yes'. + +Figure 5.1.5 Macro Inbound\_foreign\_to\_own (sheet 2 of 2) + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or a parameter is present in an Invoke or ReturnError Component, or a result is present in a ReturnResult Component. + +The decision box "message is not protected" takes the "no"-exit if user-information within the Dialogue Portion is identified by the object identifier ss7-ProtectedDialogueAS or + +operationCode within an Invoke or ReturnResult Component takes the global value ss7-ProtectedDialogueAS or errorCode within an ReturnError Component takes the global value ss7-ProtectedDialogueAS. + +The decision box "relayed by SRF" takes the "yes"-exit if the SCCP called party address consists of a Routing Number (RN) pointing to the own network and an MSISDN pointing to a relay network within the portability cluster. + +The decision box "message should be protected according to SPD (relay network)" takes the "yes"-exit if an SPD entry for incoming messages exists for the relay network. + +The decision box "Fall Back allowed according to SPD (relay network)" takes the "yes"-exit if the SPD entry for incoming messages (from the relay network) is marked "fall back allowed". + +The decision box "message should be protected according to SPD (orig. network)" takes the "yes"-exit if the message's SCCP calling party address identifies a PLMN for which an SPD entry for incoming messages exists. + +The decision box "Fall Back allowed according to SPD (relay network)" takes the "yes"-exit if the SPD entry for incoming messages (from the network identified by the SCCP calling party address) is marked "fall back allowed". + +The decision box "calling party address consistent with SPI" takes the "yes"-exit if the SPI within the message's Security Header points to an SA that was negotiated with the PLMN derived from the message's SCCP calling party address. + +The decision box "protection mode acceptable according to SPD (relay network)" takes the "yes"-exit if the presence/absence of octets 10 and 11 within the message's Security Header is consistent with a protection mode found in the SPD-entry (for incoming messages from the network identified by the SPI). Note that octets 10 and 11 of the Security Header are only used to construct the IV which is not needed (and shall therefore be absent) if the protection mode is "authenticity and integrity". + +The decision box "protection mode acceptable according to SPD (orig. network)" takes the "yes"-exit if the presence/absence of octets 10 and 11 within the message's Security Header is consistent with a protection mode found in the SPD-entry (for incoming messages from the network identified by the SCCP calling party address). Note that octets 10 and 11 of the Security Header are only used to construct the IV which is not needed (and shall therefore be absent) if the protection mode is "authenticity and integrity". + +![Flowchart for macro Outbound_own_to_own](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +macrodefinition Outbound\_own\_to\_own 1(1) + +``` +graph TD; Start([ ]) --> D1{message contains protectable parameter}; D1 -- no --> Pass((pass)); D1 -- yes --> D2{message needs to be protected according to SPD}; D2 -- no --> Pass; D2 -- yes --> P[protect message]; P --> Pass; +``` + +The flowchart illustrates the macro definition Outbound\_own\_to\_own. It begins with a start symbol (a circle with a vertical line on the left) leading to a decision diamond labeled "message contains protectable parameter". If the answer is "no", the flow proceeds directly to a pass symbol (a circle with the word "pass"). If the answer is "yes", the flow proceeds to another decision diamond labeled "message needs to be protected according to SPD". If the answer is "no", the flow proceeds directly to the pass symbol. If the answer is "yes", the flow proceeds to a process box labeled "protect message", which then leads to the pass symbol. A note icon is present in the top left corner of the diagram area. + +Flowchart for macro Outbound\_own\_to\_own + +**Figure 5.1.6 Macro Outbound\_own\_to\_own (sheet 1 of 1)** + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or a parameter is present in an Invoke or ReturnError Component, or a result is present in a ReturnResult Component. + +The decision box "message needs to be protected according to SPD" takes the "yes"-exit if an SPD entry for outgoing messages exists (for messages sent to the own network). + +![Flowchart for macrodefinition Outbound_own_to_foreign. It starts with an oval connector, followed by a decision diamond 'message contains protectable parameter'. If 'no', it goes to a merge point. If 'yes', it goes to another decision diamond 'message is protected'. If 'yes', it goes to the merge point. If 'no', it goes to a third decision diamond 'message needs to be protected according to SPD'. If 'no', it goes to the merge point. If 'yes', it goes to a process box 'protect message', which then leads to a circle connector 'pass'. The merge point is a vertical line with three horizontal arrows pointing to it from the 'no' paths of the decision diamonds.](26d664119ad25250780f554633444e54_img.jpg) + +macrodefinition Outbound\_own\_to\_foreign 1(1) + +``` +graph TD; Start([ ]) --> D1{message contains protectable parameter}; D1 -- no --> Merge(( )); D1 -- yes --> D2{message is protected}; D2 -- yes --> Merge; D2 -- no --> D3{message needs to be protected according to SPD}; D3 -- no --> Merge; D3 -- yes --> P[protect message]; P --> Pass((pass)); Merge --> Pass; +``` + +Flowchart for macrodefinition Outbound\_own\_to\_foreign. It starts with an oval connector, followed by a decision diamond 'message contains protectable parameter'. If 'no', it goes to a merge point. If 'yes', it goes to another decision diamond 'message is protected'. If 'yes', it goes to the merge point. If 'no', it goes to a third decision diamond 'message needs to be protected according to SPD'. If 'no', it goes to the merge point. If 'yes', it goes to a process box 'protect message', which then leads to a circle connector 'pass'. The merge point is a vertical line with three horizontal arrows pointing to it from the 'no' paths of the decision diamonds. + +**Figure 5.1.7 Macro Outbound\_own\_to\_foreign (sheet 1 of 1)** + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or a parameter is present in an Invoke or ReturnError Component, or a result is present in a ReturnResult Component. + +The decision box "message is protected" takes the "yes"-exit if user-information within the Dialogue Portion is identified by the object identifier ss7-ProtectedDialogueAS or + +operationCode within an Invoke or ReturnResult Component takes the global value ss7-ProtectedDialogueAS or errorCode within an ReturnError Component takes the global value ss7-ProtectedDialogueAS. + +The decision box "message needs to be protected according to SPD" takes the "yes"-exit if an SPD entry for outgoing messages exists (for messages sent to the network identified by the SCCP called party address). + +![Flowchart for macro Outbound_foreign_to_own. It starts with an oval connector, followed by a decision diamond 'message contains protectable parameter'. If 'no', it goes to a 'pass' oval. If 'yes', it goes to another decision diamond 'message needs to be protected according to SPD'. If 'no', it goes to a 'pass' oval. If 'yes', it goes to a process box 'protect message with reverse SA', which then leads to a 'pass' oval.](e821c3d8a87ee2a9ff6b8644ffe6bdae_img.jpg) + +macrodefinition Outbound\_foreign\_to\_own 1(1) + +``` +graph TD; Start([ ]) --> D1{message contains protectable parameter}; D1 -- no --> Pass([pass]); D1 -- yes --> D2{message needs to be protected according to SPD}; D2 -- no --> Pass; D2 -- yes --> Process[protect message with reverse SA]; Process --> Pass; +``` + +Flowchart for macro Outbound\_foreign\_to\_own. It starts with an oval connector, followed by a decision diamond 'message contains protectable parameter'. If 'no', it goes to a 'pass' oval. If 'yes', it goes to another decision diamond 'message needs to be protected according to SPD'. If 'no', it goes to a 'pass' oval. If 'yes', it goes to a process box 'protect message with reverse SA', which then leads to a 'pass' oval. + +**Figure 5.1.8 Macro Outbound\_foreign\_to\_own (sheet 1 of 1)** + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or + +a parameter is present in an Invoke or ReturnError Component, or +a result is present in a ReturnResult Component. + +The decision box "message needs to be protected according to SPD" takes the "yes"-exit if an SPD entry for incoming messages exists (for messages received from the network identified by the SCCP calling party address). If more than one acceptable protection modes are present, one may be chosen. + +The task box "protect message with reverse SA" performs protection of the message with the SA that is to be used for de-protection when receiving messages from the network in question. + +![Flowchart for macro Outbound_foreign_to_foreign. It starts with an oval connector, followed by four decision diamonds: 'message contains protectable parameter', 'message is protected', 'relayed by SRF', and 'message needs to be protected according to SPD'. The 'yes' path of the last decision leads to a 'protect message' task box, which is associated with 'with SA own to foreign'. All 'no' paths from the decision diamonds and the 'protect message' task box lead to a 'pass' connector at the bottom.](088921fa3f5a44c8551815122517eefd_img.jpg) + +macrodefinition Outbound\_foreign\_to\_foreign 1(1) + +``` +graph TD; Start([ ]) --> D1{message contains protectable parameter}; D1 -- no --> Pass([pass]); D1 -- yes --> D2{message is protected}; D2 -- yes --> Pass; D2 -- no --> D3{relayed by SRF}; D3 -- no --> Pass; D3 -- yes --> D4{message needs to be protected according to SPD}; D4 -- no --> Pass; D4 -- yes --> T1[protect message]; T1 --- T2[with SA own to foreign]; T1 --> Pass; +``` + +Flowchart for macro Outbound\_foreign\_to\_foreign. It starts with an oval connector, followed by four decision diamonds: 'message contains protectable parameter', 'message is protected', 'relayed by SRF', and 'message needs to be protected according to SPD'. The 'yes' path of the last decision leads to a 'protect message' task box, which is associated with 'with SA own to foreign'. All 'no' paths from the decision diamonds and the 'protect message' task box lead to a 'pass' connector at the bottom. + +Figure 5.1.9 Macro Outbound\_foreign\_to\_foreign (sheet 1 of 1) + +The decision box "message contains protectable parameter" takes the "yes"-exit if user-information is present in the Dialogue Portion, or a parameter is present in an Invoke or ReturnError Component, or a result is present in a ReturnResult Component. + +The decision box "message is protected" takes the "yes"-exit if user-information within the Dialogue Portion is identified by the object identifier ss7-ProtectedDialogueAS or operationCode within an Invoke or ReturnResult Component takes the global value ss7-ProtectedDialogueAS or errorCode within an ReturnError Component takes the global value ss7-ProtectedDialogueAS. + +The decision box "relayed by SRF" takes the "yes"-exit if the SCCP called party address consists of a Routing Number (RN) pointing to the own network and an MSISDN pointing to a relay network within the portability cluster. + +The decision box "message needs to be protected according to SPD" takes the "yes"-exit if an SPD entry for outgoing messages exists (for messages sent to the network identified by the SCCP called party address). + +### 5.1.2 Interactions with Mobile Number Portability + +In Mobile Number Portability scenarios (see 3GPP TS 23.066 [4]) a Signalling Relay Function (SRF) may relay SCCP traffic by modifying the SCCP called party address as shown in figure 4.1.10. + +A relayed message's SCCP called party address consists of a Routing Number (RN) and an MSISDN (see 3GPP TS 23.066 [4]). + +An SS7 Security Gateway needs to recognize (by analyzing the SCCP called party address) whether or not a message was relayed in order to + +- distinguish outbound transit traffic relayed by an SRF in the own network (which needs to be protected) from other outbound transit traffic (which needs to be passed transparently), and to +- distinguish inbound terminating traffic relayed by an SRF within the portability cluster (where the check needs to be based on the policy identified by the MSISDN within the SCCP called party address) from other inbound terminating traffic (where the check needs to be based on the policy identified by the SCCP calling party address). + +**NOTE :** In MNP-SRF scenarios, when the relaying PLMN does not make use of TCAP-User Security, messages sent from a source PLMN to a destination PLMN via the relaying PLMN are unprotected although protection may be desired for messages sent from the source PLMN to the destination PLMN. Network operators may therefore want to negotiate use of TCAP-User Security with all PLMNs of a portability cluster. + +### 5.1.3 Interactions with SCCP segmentation + +When the incoming SCCP message makes use of SCCP segmenting (i.e. several XUDT messages are received rather than one UDT or a single XUDT message) the SS7 Security Gateway has to perform reassembling before processing the message, and it may have to perform segmenting before sending the processed message. + +It may happen that the received SCCP message (containing an unprotected TCAP user payload) is not segmented (UDT or single XUDT), but after security processing the message's length is increased, so that the processed message needs to be segmented before it is sent. This situation may be undesired (since transfer of XUDT messages is not guaranteed by all transit networks) but cannot be avoided by the SS7 Security Gateway (see note). + +**Note:** The support of message segmentation at the SCCP layer in all transit networks could be enforced by mandating the usage of the White Book SCCP [9]. GSMA would work with International Carriers to ensure that fully operationally-verified support of XUDT is available before TCAPsec gateways are deployed. + +It may also happen that the received (protected) message is segmented (several XUDTs), but after security processing the message's length is decreased, so that the processed message does not need to be segmented before it is sent. In this case the de-protecting SS7 Security Gateway needs to know some SCCP-details of the original unprotected message as sent from the originating NE to the protecting SS7 Security Gateway. These original SCCP information needs to be transported within the TCAP-user parameter of the protected message. Depending on this information the de-protecting SS7-Security Gateway can decide whether to send a UDT or a single XUDT message towards the destination. . + +In cases where the received unprotected message is not segmented but the (to be) sent protected message needs to be segmented, the SS7 Security Gateway has to replace the message's SCCP calling party address with its own address. This is to guarantee uniqueness of the combination of the SCCP calling party address and the Segmentation local reference in the (to be) sent message. The original SCCP calling party address needs to be transported within the TCAP-user parameter of the (first segment of the) protected message. + +If the received protected message contains an original SCCP calling party address within the TCAP-user parameter, the de-protecting SS7 Security Gateway has to replace the SCCP calling party address with the original SCCP calling party address before forwarding the de-protected message to the destination. + +An SS7 Security Gateway that has sent a segmented, protected message with a replaced SCCP calling party address may receive an SCCP XUDTS message with its own address as called party address. In this case the SS7 Security Gateway shall retrieve the original SCCP calling party address, the original TCAP Message type and TCAP transaction id from the data parameter of the received XUDTS message and construct a UDTS message with unmodified Return cause, called party address replaced with the retrieved original calling party address, unmodified calling party address, and Data parameter containing the retrieved TCAP message type and TCAP transaction id, and forward it to the destination. + +### 5.1.4 Protocol details + +#### 5.1.4.1 Transformation of unprotected message to protected message + +The unprotected TCAP-user message is either transported within an SCCP UDT message or it is transported within a single SCCP XUDT message or it is segmented over several SCCP XUDT messages. Other SCCP message types are not subject to protection. + +The transformation process is done in 3 steps: + +##### Step 1: SCCP re-assembly of the unprotected message + +In a first step the unprotected message is transformed into an intermediate unprotected representation which is made up of the following parameters: + +| | | +|-------------------------------------------------|--------------------------------------| +| SCCP Message type | | +| SCCP Protocol class | | +| SCCP Hop counter (optional) | | +| SCCP Called party address | | +| SCCP Calling party address | | +| SCCP Segmentation local reference (optional) | | +| SCCP Importance (optional) | | +| SCCP Data (made up of the following parameters: | TCAP Message type | +| | TCAP orig. Transaction Id (optional) | +| | TCAP dest. Transaction Id (optional) | +| | TCAP Dialogue Portion (optional) | +| | TCAP Component Portion (optional)) | + +If the unprotected message was transported within an SCCP UDT message, the intermediate unprotected representation of the message takes the following values: + +| | | +|-----------------------------------|-------------------------------------| +| SCCP Message type | UDT | +| SCCP Protocol class | same as in the received UDT message | +| SCCP Hop counter | absent | +| SCCP Called party address | same as in the received UDT message | +| SCCP Calling party address | same as in the received UDT message | +| SCCP Segmentation local reference | absent | +| SCCP Importance | absent | +| SCCP Data | same as in the received UDT message | + +If the unprotected message was transported within a single SCCP XUDT message, the intermediate unprotected representation of the message takes the following values: + +| | | +|-----------------------------------|--------------------------------------| +| SCCP Message type | XUDT | +| SCCP Protocol class | same as in the received XUDT message | +| SCCP Hop counter | same as in the received XUDT message | +| SCCP Called party address | same as in the received XUDT message | +| SCCP Calling party address | same as in the received XUDT message | +| SCCP Segmentation local reference | absent | +| SCCP Importance | same as in the received XUDT message | +| SCCP Data | same as in the received XUDT message | + +If the unprotected message was segmented over several SCCP XUDT messages, the intermediate unprotected representation of the message takes the following values: + +| | | +|-----------------------------------|-------------------------------------------------------------------------------------------------------| +| SCCP Message type | XUDT | +| SCCP Protocol class | same as in the first received XUDT message | +| SCCP Hop counter | same as in the first received XUDT message | +| SCCP Called party address | same as in the first received XUDT message | +| SCCP Calling party address | same as in the first received XUDT message | +| SCCP Segmentation local reference | same as in the first received XUDT message | +| SCCP Importance | same as in the first received XUDT message | +| SCCP Data | concatenation of the received segments (for details of the re-assembly procedure see ITU-T Q.714 [9]) | + +##### Step 2: Protection + +In a second step the intermediate unprotected representation is transformed into an intermediate protected representation which is made up of the following parameters: + +| | | +|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------| +| SCCP Hop counter (optional) | | +| SCCP Called party address | | +| SCCP Calling party address | | +| SCCP Segmentation local reference (optional) | | +| SCCP Importance (optional) | | +| Original SCCP info (made up of the following parameters: | Original SCCP Calling party address (optional)
Original SCCP Message type
Original SCCP Protocol class) | +| Original TCAP info (made up of the following parameters: | Original TCAP Message type
otid (optional)
dtid (optional)) | +| TCAPsec Security header | | +| TCAPsec Cipher- or Cleartext | | +| TCAPsecMAC | | + +The intermediate unprotected representation of the message takes the following values: + +| | | +|---------------------------------------------------------|----------------------------------------------------------------------------| +| SCCP Hop counter | same as SCCP Hop counter in the intermediate unprotected representation | +| SCCP Called party address | same as in the intermediate unprotected representation | +| SCCP Calling party address | same as in the intermediate unprotected representation | +| SCCP Segmentation local reference | same as in the intermediate unprotected representation | +| SCCP Importance | same as SCCP Importance in the intermediate unprotected representation | +| Original SCCP info made up of the following parameters: | | +| Original SCCP Message type | same as SCCP Message type in the intermediate unprotected representation | +| Original SCCP Protocol class | same as SCCP Protocol class in the intermediate unprotected representation | +| Original TCAP info made up of the following parameters: | | +| Original TCAP Message type | same as TCAP Message type in the intermediate unprotected representation | + +| | | +|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| TCAP otid | same as TCAP orig. Transaction Id in the intermediate unprotected representation | +| TCAP dtid | same as TCAP dest. Transaction Id in the intermediate unprotected representation | +| TCAPsec Security header | See 3GPP TS 33.204 [8] | +| TCAPsec Cipher- or Cleartext | result of applying the encryption function to the concatenation of Dialogue Portion and Component Portion of the intermediate unprotected representation (ciphertext), or concatenation of Dialogue Portion and Component Portion of the intermediate unprotected representation(cleartext) | +| TCAPsec MAC | result of applying the integrity function to the concatenation of Security header and Cipher- or Cleartext of the intermediate protected representation. | + +##### Step 3: SCCP segmentation of the protected message + +In a third step the intermediate protected representation is transformed into a single SCCP UDT message, a single SCCP XUDT message, or several SCCP XUDT messages depending on the Original SCCP Message type of the intermediate protected representation and the need for segmentation as follows: + +If the Original SCCP Message type in the intermediate protected representation takes the value "UDT" and the message need not be segmented, it is transformed into a single SCCP UDT message with following parameter values: + +| | | +|-----------------------|-----------------------------------------------------------------------------------| +| Message Type | UDT | +| Protocol class | same as Original SCCP Protocol class in the intermediate protected representation | +| Called party address | same as SCCP Called party address in the intermediate protected representation | +| Calling party address | same as SCCP Calling party address in the intermediate protected representation | +| Data | (see below) | + +If the Original SCCP Message type in the intermediate protected representation takes the value "XUDT" and the message need not be segmented, it is transformed into a single SCCP XUDT message with following parameter values: + +| | | +|-----------------------|-----------------------------------------------------------------------------------| +| Message Type | XUDT | +| Protocol class | same as Original SCCP Protocol class in the intermediate protected representation | +| Hop counter | same as Original SCCP Hop counter in the intermediate protected representation | +| Called party address | same as SCCP Called party address in the intermediate protected representation | +| Calling party address | same as SCCP Calling party address in the intermediate protected representation | +| Data | (see below) | +| Segmentation | absent | +| Importance | same as Original SCCP Importance in the intermediate protected representation | + +If the Original SCCP Message type in the intermediate protected representation takes the value "UDT" and the message needs to be segmented, it is transformed into several SCCP XUDT message with following parameter values: + +| | | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Message Type | XUDT | +| Protocol class | first segment: class 1 (in sequence delivery), return option: same as in Original SCCP Protocol class in the intermediate protected representation
subsequent segment: class 1 (in sequence delivery), return option: no special options | +| Hop counter | absent | +| Called party address | same as SCCP Called party address in the intermediate protected representation | +| Calling party address | the SS7 Security Gateway's own address | +| Data | (segment of see below) | +| Segmentation | see [9] | +| Importance | absent | + +If the Original SCCP Message type in the intermediate protected representation takes the value "XUDT" and the message needs to be segmented, it is transformed into several SCCP XUDT message with following parameter values: + +| | | +|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Message Type | XUDT | +| Protocol class | first segment: class 1 (in sequence delivery), return option: same as in Original SCCP Protocol class in the intermediate protected representation
subsequent segment: class 1 (in sequence delivery), return option: no special options | +| Hop counter | same as Original SCCP Hop counter in the intermediate protected representation | + +| | | +|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Called party address | same as SCCP Called party address in the intermediate protected representation | +| Calling party address | if SCCP Segmentation Local reference is present in the intermediate protected representation: same as SCCP Calling party address in the intermediate protected representation;
otherwise: the SS7 Security Gateway's own address | +| Data | (segment of see below) | +| Segmentation | see [9]; if SCCP Segmentation Local reference is present in the intermediate protected representation, the same value shall be used. | +| Importance | same as Original SCCP Importance in the intermediate protected representation. | + +The SCCP Data parameter (re-assembled) shall take the following value: + +| | | +|-----------------------|----------------------------------| +| TCAP Message type | unidirectional | +| TCAP DialoguePortion | absent | +| TCAP ComponentPortion | one invoke component with: | +| invokeId | (any legal value) | +| linkId | absent | +| operationCode | local value 90 (secureTransport) | +| parameter | ANY DEFINED BY operationCode | + +``` +SS7-Secure-Transport-Operation-and-DataTypes { + itu-t identified-organization (4) etsi (0) mobileDomain (0) + gsm-Network (1) modules (3) ss7-Secure-Transport-Operation-and-DataTypes (27) version1 (1)} +``` + +``` +DEFINITIONS +IMPLICIT TAGS +::= +BEGIN +``` + +``` +EXPORTS + secureTransport +; +``` + +``` +IMPORTS + OPERATION +FROM Remote-Operations-Information-Objects { + joint-iso-itu-t remote-operations(4) + informationObjects(5) version1(0)} + +; +``` + +| | +|--------------------------------------------------------------------------------------------------------| +| 
secureTransport OPERATION ::= {     ARGUMENT         SecureTransportArg     CODE local:90 }
| +|--------------------------------------------------------------------------------------------------------| + +| | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
SecureTransportArg ::= SEQUENCE {     originalSCCP-Info           [0] OriginalSCCP-Info      OPTIONAL,     originalTCAP-Info           [1] OriginalTCAP-Info,     protectedPayload            [2] ProtectedPayload }
| +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 
OriginalSCCP-Info ::= SEQUENCE {     originalSCCP-MessageType      [0] OriginalSCCP-MessageType      OPTIONAL,     -- original SCCP-MessageType shall be present if it is different from the actual     -- SCCP-Message type; otherwise it may be absent     originalSCCP-ProtocolClass    [1] OriginalSCCP-ProtocolClass      OPTIONAL     -- originalSCCP-ProtocolClass shall be present if it is different from the actual     -- SCCP-Protocol class (first segment); otherwise it may be absent.     originalSCCP-CallingPartyAddress [2] OriginalSCCP-CallingPartyAddress OPTIONAL,     -- originalSCCP-CallingPartyAddress shall be present if and only if the actual     -- SCCP Calling party address is the SS7 Security Gateway's own address }
| +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +``` + +OriginalSCCP-MessageType ::= ENUMERATED { + udt (9), + xudt (17) } + -- this parameter shall take the value of the Original SCCP Message type from the + -- intermediate protected representation + +OriginalSCCP-ProtocolClass ::= OCTET STRING(SIZE(1)) + -- coded according to ITU-T Q.713 + +OriginalSCCP-CallingPartyAddress ::= OCTET STRING(SIZE(3..18)) + -- coded according to ITU-T Q.713 + -- Octet 1: Address indicator + -- Octets 2 - n: Address + +OriginalTCAP-Info ::= SEQUENCE { + originalTCAP-MessageType OriginalTCAP-MessageType, + otid OTID OPTIONAL, + dtid DTID OPTIONAL +} + +OriginalTCAP-MessageType ::= ENUMERATED { + unidirectional (97), + begin (98), + end (100), + continue (101), + abort (103) } + -- this parameter shall take the value of the Original TCAP Message type from the + -- intermediate protected representation + +OTID ::= OCTET STRING(SIZE(1..4)) + -- OTID shall take the value of the TCAP otid from the intermediate protected + -- representation + +DTID ::= OCTET STRING(SIZE(1..4)) + -- DTID shall take the value of the TCAP dtid from the intermediate protected + -- representation + +ProtectedPayload ::= OCTET STRING(SIZE(13..3438)) + -- The protected payload is the concatenation of + -- 9 or 11 octets SecurityHeader, + -- n octets ciphertext or cleartext, and + -- 4 octets MAC + + -- The SecurityHeader is coded as follows (see 3GPP TS 33.204 [8]): + -- Octets 1-4: SPI + -- Octets 5-8: TVP. The TVP is a 32 bit time stamp. Its value is binary coded + -- + -- and indicates the number of intervals of 100 milliseconds + -- elapsed since 1st January 2002, 0:00:00 UTC + -- Octet 9: Indicator Byte with bits 7-1 spare and bit 0 if set indicates presence of + -- Octets 10-11 + -- Octet 10: SS7 SEG-Id + -- Octet 11: Prop + +``` + +END + +#### 5.1.4.2 Transformation of protected message to unprotected message + +The protected TCAP-user message is either transported within an SCCP UDT message or it is transported within a single SCCP XUDT message or it is segmented over several SCCP XUDT messages. Other SCCP message types are not subject to protection. + +The transformation process is done in 3 steps: + +##### Step 1: SCCP re-assembly of the protected message + +In a first step the protected message is transformed into the intermediate protected representation (see chapter 5.1.4.1): + +If the protected message was transported within an SCCP UDT message, the intermediate protected representation of the message takes the following values: + +| | | +|-------------------------------------|---------------------------------------------------------------------------------------------------| +| SCCP Hop counter | absent | +| SCCP Called party address | same as in the received UDT message | +| SCCP Calling party address | same as in the received UDT message | +| SCCP Segmentation local reference | absent | +| SCCP Importance | absent | +| Original SCCP info | | +| Original SCCP Calling party address | absent | +| Original SCCP Message type | UDT | +| Original SCCP Protocol class | same as SCCP Protocol class in the received UDT message | +| Original TCAP info | | +| Original TCAP Message type | same as Original TCAP Message type in the TCAP-invoke component parameter of the received message | +| otid | same as otid in the TCAP-invoke component parameter of the received message | +| dtid | same as dtid in the TCAP-invoke component parameter of the received message | +| TCAPsec Security header | same as received in the TCAP-invoke component parameter of the received message | +| TCAPsec Cipher- or Cleartext | same as received in the TCAP-invoke component parameter of the received message | +| TCAPsec MAC | same as received in the TCAP-invoke component parameter of the received message | + +If the protected message was transported within a single SCCP XUDT message, the intermediate protected representation of the message takes the following values: + +| | | +|-------------------------------------|---------------------------------------------------------------------------------------------------| +| SCCP Hop counter | same as in the received XUDT message | +| SCCP Called party address | same as in the received XUDT message | +| SCCP Calling party address | same as in the received XUDT message | +| SCCP Segmentation local reference | absent | +| SCCP Importance | same as in the received XUDT message | +| Original SCCP info | | +| Original SCCP Calling party address | absent | +| Original SCCP Message type | same as OriginalSCCP-Messagetype in the TCAP-invoke component parameter of the received message | +| Original SCCP Protocol class | same as OriginalSCCP-ProtocolClass in the TCAP-invoke component parameter of the received message | +| Original TCAP info | | +| Original TCAP Message type | same as Original TCAP Message type in the TCAP-invoke component parameter of the received message | +| otid | same as otid in the TCAP-invoke component parameter of the received message | +| dtid | same as dtid in the TCAP-invoke component parameter of the received message | +| TCAPsec Security header | same as received in the TCAP-invoke component parameter of the received message | +| TCAPsec Cipher- or Cleartext | same as received in the TCAP-invoke component parameter of the received message | +| TCAPsec MAC | same as received in the TCAP-invoke component parameter of the received message | + +If the protected message was transported within several SCCP XUDT message, the intermediate protected representation of the message takes the following values: + +| | | +|---------------------------|--------------------------------------------| +| SCCP Hop counter | same as in the first received XUDT message | +| SCCP Called party address | same as in the first received XUDT message | + +| | | +|-------------------------------------|---------------------------------------------------------------------------------------------------------------------| +| SCCP Calling party address | same as in the first received XUDT message | +| SCCP Segmentation local reference | same as in the first received XUDT message | +| SCCP Importance | same as in the first received XUDT message | +| Original SCCP info | | +| Original SCCP Calling party address | same as OriginalSCCP-CallingPartyAddress in the TCAP-invoke component parameter of the received reassembled message | +| Original SCCP Message type | same as OriginalSCCP-MessageType in the TCAP-invoke component parameter of the received reassembled message | +| Original SCCP Protocol class | same as OriginalSCCP-ProtocolClass in the TCAP-invoke component parameter of the received reassembled message | +| Original TCAP info | | +| Original TCAP Message type | same as OriginalTCAP-MessageType in the TCAP-invoke component parameter of the received reassembled message | +| otid | same as otid in the TCAP-invoke component parameter of the received reassembled message | +| dtid | same as dtid in the TCAP-invoke component parameter of the received reassembled message | +| TCAPsec Security header | same as received in the TCAP-invoke component parameter of the received reassembled message | +| TCAPsec Cipher- or Cleartext | same as received in the TCAP-invoke component parameter of the received reassembled message | +| TCAPsec MAC | same as received in the TCAP-invoke component parameter of the received reassembled message | + +##### Step 2: De-Protection + +In a second step the intermediate protected representation is transformed into an intermediate unprotected representation (see chapter 5.1.4.1): + +The intermediate unprotected representation of the message takes the following values: + +| | | +|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SCCP Message type | same as OriginalSCCP-MessageType from the TCAP-invoke component's parameter of the intermediate protected representation | +| SCCP Protocol class | same as OriginalSCCP-ProtocolClass from the TCAP-invoke component's parameter of the intermediate protected representation | +| SCCP Hop counter | same as SCCP Hop counter in the intermediate protected representation | +| SCCP Called party address | same as SCCP Called party address in the intermediate protected representation | +| SCCP Calling party address | if OriginalSCCP-CallingPartyAddress is present in the intermediate protected representation, its value is taken; otherwise same as SCCP Calling party address of the intermediate protected representation | +| SCCP Segmentation local reference | if SCCP Message type in the intermediate unprotected representation is XUDT, then same as in the intermediate protected representation; otherwise absent. | +| SCCP Importance | same as in the intermediate unprotected representation | +| SCCP Data : | | +| TCAP Message type | same as OriginalTCAP-MessageType in the intermediate protected representation | +| TCAP orig. Transaction Id | same as otid in the intermediate protected representation | +| TCAP dest. Transaction Id | same as dtid in the intermediate protected representation | +| TCAP Dialogue Portion (optional) | First part of the cleartext (as indicated by TAG and LENGTH according to BER). If encryption was applied then ciphertext needs to be converted first to cleartext | +| TCAP Component Portion (optional) | second part of the cleartext (as indicated by TAG and LENGTH according to BER). If encryption was applied then ciphertext needs to be converted first to cleartext | + +##### Step 3: SCCP segmentation of the unprotected message + +In a third step the intermediate unprotected representation is transformed into a single SCCP UDT message, a single SCCP XUDT message, or several SCCP XUDT messages depending on the SCCP Message type of the intermediate unprotected representation and the need for segmentation as follows: + +If the SCCP Message type in the intermediate unprotected representation is "UDT", it is transformed into a single SCCP UDT message with following parameter values: + +| | | +|-----------------------|-----------------------------------------------------------------------------------| +| Message Type | UDT | +| Protocol class | same as SCCP Protocol class in the intermediate unprotected representation | +| Called party address | same as SCCP Called party address in the intermediate unprotected representation | +| Calling party address | same as SCCP Calling party address in the intermediate unprotected representation | +| Data | same as SCCP Data in the intermediate unprotected representation | + +If the SCCP Message type in the intermediate unprotected representation is "XUDT" and the message does not need to be segmented, it is transformed into a single SCCP XUDT message with following parameter values: + +| | | +|-----------------------|-----------------------------------------------------------------------------------| +| Message type | XUDT | +| Protocol class | same as SCCP Protocol class in the intermediate unprotected representation | +| Hop counter | same as SCCP Hop counter in the intermediate unprotected representation | +| Called party address | same as SCCP Called party address in the intermediate unprotected representation | +| Calling party address | same as SCCP Calling party address in the intermediate unprotected representation | +| Data | same as SCCP Data in the intermediate unprotected representation | +| Segmentation | absent | +| Importance | same as SCCP Importance in the intermediate unprotected representation | + +If the SCCP Message type in the intermediate unprotected representation is "XUDT" and the message needs to be segmented, it is transformed into several SCCP XUDT message with following parameter values: + +| | | +|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------| +| Message type (all segments) | XUDT | +| Protocol class (first segment) | class 1 (in sequence delivery), return option: same as in SCCP Protocol class of the intermediate unprotected representation | +| (subsequent segments) | class 1 (in sequence delivery), return option: no special options | +| Hop counter (all segments) | same as SCCP Hop counter in the intermediate unprotected representation | +| Called party address (all segments) | same as SCCP Called party address in the intermediate unprotected representation | +| Calling party address (all segments) | same as SCCP Calling party address in the intermediate unprotected representation | +| Data | segment of SCCP Data from the intermediate unprotected representation (see ITU-T Q.714 [9]) | +| Segmentation | see [9]. Local reference shall be taken from the intermediate unprotected representation | +| Importance (all segments) | same as SCCP Importance in the intermediate unprotected representation | + +#### 5.1.4.3 Handling of received XUDTS messages and UDTS messages + +An SS7 Security Gateway shall not try to re-assemble XUDTS messages, since the SCCP option "return on error" is not set for subsequent XUDT segments. As a consequence the SS7 Security Gateway shall not try to protect or de-protect XUDTS messages (fragments) or UDTS messages. However, special handling of XUDTS messages and UDTS messages is required as follows: + +##### Outbound direction + +Instead of re-assembling and protecting the XUDTS messages or protecting UDTS messages, the SS7 Security Gateway shall remove the TCAP Dialogue Portion and the TCAP Component Portion from the SCCP Data parameter before sending the XUDTS message or UDTS message. This is in order not to pass the cleartext (or fragment of the cleartext) in outbound direction. SCCP message type and addresses shall not be changed. + +An example is shown in figure 5.1.4.3-1: A transit node in PLMN 2 cannot deliver the UDT message and therefore returns an UDTS message. SS7 Security Gateway 2 in PLMN 2 removes the cleartext (TCAP dialogue portion and TCAP component portion) from the SCCP data parameter. SS7 Security Gateway 1 in PLMN 1 recognizes that the + +received UDTS message does not contain a TCAP unidirectional message with a secure transport invoke component and therefore it does not modify the SCCP message. + +![Sequence diagram showing message exchanges between NE 1, SS7 Sec Gateway 1, SS7 Sec Gateway 2, Transit Node, and NE 2 across PLMN 1 and PLMN 2.](08c7a76a7786bd08b99dd4cb41583ef4_img.jpg) + +``` + +sequenceDiagram + participant NE 1 + participant SGW1 as SS7 Sec Gateway 1 + participant SGW2 as SS7 Sec Gateway 2 + participant TN as Transit Node + participant NE 2 + + Note left of NE 1: PLMN 1 + Note right of NE 2: PLMN 2 + + NE 1->>SGW1: UDT + SGW1->>SGW2: XUDT + SGW1->>SGW2: XUDT + SGW2->>TN: UDT + TN->>SGW2: UDTS + SGW2->>SGW1: UDTS + SGW1->>NE 1: UDTS + +``` + +Sequence diagram showing message exchanges between NE 1, SS7 Sec Gateway 1, SS7 Sec Gateway 2, Transit Node, and NE 2 across PLMN 1 and PLMN 2. + +**Figure 5.1.4.3-1: XUDTS messages and UDTS messages (Outbound direction)** + +##### Inbound direction + +Instead of re-assembling and de-protecting the XUDTS messages or de-protecting UDTS messages, the SS7 Security Gateway shall analyze the SCCP Called party address. If it matches with the SS7 Security Gateway's own address, it shall recover the OriginalSCCP-CallingPartyAddress from the (fragment in the) data parameter and replace the SCCP Called party address with the recovered value. In any case the SS7 Security Gateway shall recover and analyze the TCAP Message type from the (fragment in the) data parameter. If the recovered value is "unidirectional" and a invoke component with operation code "secure transport" is included, the SS7 Security Gateway shall recover the originalTCAP-Messagetype, otid, and dtid from the OriginalTCAP-Info, replace the TCAP Message type with the original TCAP-Messagetype, insert otid and dtid and remove the remaining material from the SCCP data parameter. If the received message is an XUDTS message and the original SCCP Message type was UDT then the SS7 Security shall modify the SCCP Message type to UDTS. + +An example is shown in figure 5.1.4.3-2: A transit node in a transit network cannot deliver the XUDT messages and therefore returns an XUDTS message (note that the second XUDT does not have the SCCP return option set). SS7 Security Gateway 1 in PLMN 1 recognizes that the received XUDTS message does contain a TCAP unidirectional message with a secure transport invoke component and therefore, since the original SCCP-Messagetype is UDT, modifies the SCCP Message type from XUDTS to UDTS. Furthermore, the TCAP Message type is modified from unidirectional to the original TCAP-Messagetype, the Transaction Ids are inserted, and the remaining material (fragment of the ciphertext) is removed. + +In addition the SS7 Security Gateway 1 in PLMN 1 recognizes that the received XUDTS message does contain SS7 Security Gateway 1's own address as SCCP Called party address and therefore replaces it with the original SCCPCalling party address. + +![Sequence diagram showing message exchanges between NE 1, SS7 Sec Gateway 1, Transit Node, SS7 Sec Gateway 2, and NE 2 across PLMN 1 and PLMN 2.](6629e8a87e7552e2454b7c3e9f6d73a0_img.jpg) + +The diagram illustrates a sequence of messages between network elements (NEs) and gateways across two PLMNs. PLMN 1 contains NE 1, SS7 Sec Gateway 1, and a Transit Node. PLMN 2 contains SS7 Sec Gateway 2 and NE 2. The message flow is as follows: + +- NE 1 sends a UDT message to SS7 Sec Gateway 1. +- SS7 Sec Gateway 1 sends two XUDT messages to the Transit Node. +- The Transit Node sends an XUDTS message back to SS7 Sec Gateway 1. +- SS7 Sec Gateway 1 sends a UDTS message to NE 1. + +``` +sequenceDiagram + participant NE1 as NE 1 + participant SS7G1 as SS7 Sec Gateway 1 + participant TN as Transit Node + participant SS7G2 as SS7 Sec Gateway 2 + participant NE2 as NE 2 + + Note left of NE1: PLMN 1 + Note right of NE2: PLMN 2 + + NE1->>SS7G1: UDT + SS7G1->>TN: XUDT + SS7G1->>TN: XUDT + TN->>SS7G1: XUDTS + SS7G1->>NE1: UDTS +``` + +Sequence diagram showing message exchanges between NE 1, SS7 Sec Gateway 1, Transit Node, SS7 Sec Gateway 2, and NE 2 across PLMN 1 and PLMN 2. + +Figure 5.1.4.3-2: XUDTS messages and UDTS messages (inbound direction) \ No newline at end of file diff --git a/marked/Rel-18/29_series/29205/raw.md b/marked/Rel-18/29_series/29205/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ae71ef0d8993b8433db7b0d6aede33f30b9dd7ab --- /dev/null +++ b/marked/Rel-18/29_series/29205/raw.md @@ -0,0 +1,953 @@ + + +# 3GPP TS 29.205 V18.0.0 (2024-03) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Application of Q.1900 series to bearer independent Circuit Switched (CS) core network architecture; Stage 3 (Release 18)** + +![3GPP logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The 3GPP logo, featuring the letters '3GPP' in a stylized font. The '3' is large and bold, with a red signal icon below it. The 'G' and 'P' are also bold, with the 'P' having a small 'TM' symbol above it. + +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. + +© 2024, 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, symbols and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Protocols..... | 8 | +| 4.1 Call control protocol (Nc interface) ..... | 8 | +| 4.2 Interworking with other protocols..... | 8 | +| 4.3 Resource control protocol (G)MSC and MGW (Mc Interface) ..... | 8 | +| 4.4 Bearer control protocol between MGWs (Nb interface)..... | 9 | +| 4.5 Signalling Transport..... | 9 | +| 4.5.1 Call Control protocols ..... | 9 | +| 4.5.2 Resource control protocol (G)MSC and MGW (Mc Interface) ..... | 9 | +| 4.5.3 Bearer control protocol between MGWs (Nb interface) ..... | 9 | +| Annex A: Void..... | 9 | +| Annex B (normative): Transparent Support of Mobile Services ..... | 9 | +| B.1 Introduction..... | 9 | +| B.2 Mobile Service Transport (MST) – Format and Codes ..... | 10 | +| B.2.1 Encapsulated Application Information..... | 10 | +| B.2.1.1 General Layout ..... | 10 | +| B.2.1.2 List of Identifiers ..... | 12 | +| B.2.1.3 Mobile Equipment Identifier ..... | 12 | +| B.2.1.4 LCLS Negotiation Request..... | 13 | +| B.2.1.5 LCLS Negotiation Response ..... | 13 | +| B.2.1.6 LCLS Status..... | 14 | +| B.2.1.7 LCLS Status Change ..... | 14 | +| B.2.1.8 LCLS Status Result ..... | 14 | +| B.2.1.9 LCLS Global Call Reference..... | 15 | +| B.2.1.10 LCLS Configuration Preference..... | 16 | +| B.2.1.11 LCLS Configuration Change Request..... | 17 | +| B.2.1.12 LCLS Configuration Change Result ..... | 17 | +| B.2.2 Application Transport Instruction Indicators ..... | 18 | +| Annex C (normative): LCLS Service Application ..... | 18 | +| C.1 Use of MST ASE ..... | 18 | +| C.2 Procedures..... | 18 | +| C.2.1 Indication of LCLS Capability ..... | 18 | +| C.2.1.1 LCLS Service Capability Indication ..... | 18 | +| C.2.1.2 Actions at Originating Serving Node ..... | 19 | +| C.2.1.3 Actions at Intermediate Serving Node ..... | 19 | +| C.2.1.4 Actions at Destination Serving Node ..... | 19 | +| C.2.2 Backward LCLS Negotiation during Call Setup..... | 20 | +| C.2.2.1 Introduction ..... | 20 | +| C.2.2.2 Actions at Destination Serving Node ..... | 20 | +| C.2.2.3 Actions at Intermediate Serving Node ..... | 20 | +| C.2.2.4 Actions at Originating Serving Node ..... | 20 | +| C.2.3 Answer message..... | 21 | +| C.2.3.1 Introduction ..... | 21 | + +- C.2.3.2 Actions at Destination Serving Node ..... 21 +- C.2.3.3 Actions at Intermediate Serving Node ..... 21 +- C.2.3.4 Actions at Originating Serving Node ..... 21 +- C.2.4 LCLS Configuration Change Request..... 21 + - C.2.4.1 Introduction ..... 21 + - C.2.4.2 Actions at Initiating Serving Node ..... 22 + - C.2.4.3 Actions at Intermediate Serving Node ..... 22 + - C.2.4.4 Actions at Terminating Serving Node..... 22 +- C.2.5 LCLS Status Update..... 22 + - C.2.5.1 Introduction ..... 22 + - C.2.5.2 Actions at Initiating Serving Node ..... 23 + - C.2.5.3 Actions at Intermediate Serving Node ..... 23 + - C.2.5.4 Actions at Terminating Serving Node..... 23 +- C.2.6 LCLS Status Change Request ..... 23 + - C.2.6.1 Introduction ..... 23 + - C.2.6.2 Actions at Initiating Serving Node ..... 23 + - C.2.6.3 Actions at Intermediate Serving Node ..... 24 + - C.2.6.4 Actions at Terminating Serving Node..... 24 + +**Annex D (informative): Change history ..... 25** + +# --- 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 describes the protocols to be used when ITU-T Q.1902 "Bearer Independent Call Control" is used as call control protocol in a 3GPP Bearer Independent CS core network 3GPP TS 23.205 [1]. The Q.1902 operates between (G)MSC servers. The BICC architecture as described in ITU-T Q.1902 [6]-[10] consists of a number of protocols. The following types of protocols are described: call control protocol, bearer control protocols and a resource control protocol for this architecture. The architecture complies with the requirements imposed by 3GPP TS 23.205 [1] and TS 23.153 [2]. + +The present document is valid for a 3rd generation PLMN (UMTS) complying with Release 4 and later. + +Note: Q.1902 can be used in other network architectures than the one defined in 3GPP TS 23.205 [1] + +# 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 23.205: "Bearer Independent CS Core Network – Stage 2". +- [2] 3GPP TS 23.153: "Out of Band Transcoder Control - Stage 2". +- [3] 3GPP TS 29.232: "Media Gateway Controller (MGC) – Media Gateway (MGW) Interface; Stage 3". +- [4] 3GPP TS 29.414: "Core Network Nb Data Transport and Signalling Transport". +- [5] ITU-T Recommendation Q.765.5 (06/2000): "Application Transport Mechanism". +- [6] ITU-T Recommendation Q.1902.1 (07/2001): "Bearer Independent Call Control CS2 Functional Description". Inclusive Amendment 3: "Support for the Customized Alerting Tone (CAT) service". +- [7] ITU-T Recommendation Q.1902.2 (07/2001): "Bearer Independent Call Control CS2 General functions of messages and parameters". Inclusive Amendment 5: "Support for the Customized Alerting Tone (CAT) service". +- [8] ITU-T Q.1902.3 (07/2001): "Bearer Independent Call Control CS2 Formats and Codes". Inclusive Amendment 5: "Support for the Customized Alerting Tone (CAT) service". +- [9] ITU-T Recommendation Q.1902.4 (07/2001): "Bearer Independent Call Control CS2 Basic Call Procedures". +- [10] ITU-T Recommendation Q.1902.5 (07/2001): "Exceptions to the Application Transport Mechanism in the Context of Bearer Independent Call Control". +- [11] ITU-T Recommendation Q.1902.6 (07/2001): "Generic Signalling Procedures for the support of the ISDN User Part Supplementary Services and for bearer redirection". +- [12] ITU-T Recommendation Q.1950 (07/2001): "Call Bearer Control Protocol". +- [13] ITU-T Recommendations Q.2630.1 (12/1999), Q.2630.2 (12/2000): "AAL type 2 signalling protocol". + +- [14] ITU-T Recommendation Q.1990 (07/2001): "BICC Bearer Control tunnelling protocol". +- [15] ITU-T Recommendation Q.1970 (07/2001): "BICC IP Bearer Control protocol". +- [16] ITU-T Recommendation Q.1912.1 (07/2001): "Interworking between Signalling System No. 7 ISDN user part and the Bearer Independent Call Control protocol". +- [17] ITU-T Recommendation Q.1912.2 (07/2001): "Interworking between selected Signalling System (PSTN Access DSS1, C5, R1, R2, TUP) and the Bearer Independent Call Control Protocol". +- [18] ITU-T Recommendation Q.2150.0 (05/2001): "Generic Signalling Transport Service". +- [19] ITU-T Recommendation Q.2150.1 (05/2001): "Signalling Transport Converter on MTP3 and MTP3b". +- [20] ITU-T Recommendation Q.2150.3 (12/2002): "Signalling Transport Converter on SCTP". +- [21] ITU-T Recommendation H.248.4 (11/2000): "Gateway Control Protocol: Transport over SCTP". +- [22] 3GPP TS 29.202: "SS7 signalling transport in core network". +- [23] ITU-T Recommendation H.248.5 (11/2000): "Gateway control protocol: Transport over ATM". +- [24] ITU-T Q.765 (06/2000): "Signalling system No. 7 – Application transport mechanism". +- [25] 3GPP TS 23.003: "Numbering, addressing and identification". +- [26] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC); Stage 2". +- [27] 3GPP TS 23.237: "IP Multimedia subsystem (IMS) Service Continuity; Stage 2". +- [28] 3GPP TR 21.905: "Vocabulary for 3GPP Specifications". +- [29] 3GPP TS 23.284: "Local Call Local Switch; Stage 2". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +| | | +|----|-----------------------------------------------------| +| Nc | Interface between the (G)MSC servers. | +| Mc | Interface between the server and the media gateway. | +| Nb | Interface between media gateways (MGW). | + +## 3.3 Abbreviations + +For the purposes of the present document, the abbreviations as defined in 3GPP TR 21.905 [28] 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 [28]. + +| | | +|------|----------------------------------| +| APM | Application Transport Mechanism | +| | Application Transport Message | +| APP | Application Transport Parameter | +| BAT | Bearer Association Transport | +| BICC | Bearer Independent Call Control | +| C5 | CCITT signalling system number 5 | +| GCR | Global Call Reference | + +| | | +|------|--------------------------------------| +| LCLS | Local Call Local Switch | +| M3UA | MTP3 – User Adaptation Layer | +| MGC | Media Gateway Controller | +| MST | Mobile Service Transport | +| R1 | Regional Signalling System 1 | +| R2 | Regional Signalling System 2 | +| SCTP | Stream Control Transmission Protocol | +| SN | Serving Node | +| TUP | Telephony User Part | + +# 4 Protocols + +Implementations providing any of the interfaces or protocols identified in the subclauses below shall implement the requirements of the specifications identified in those subclauses. + +## 4.1 Call control protocol (Nc interface) + +| | | +|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Q.1902.1 | BICC PROTOCOL (CS2) FUNCTIONAL DESCRIPTION [6] | +| Q.1902.2 | BICC PROTOCOL (CS2) AND SIGNALLING SYSTEM NO 7 ISUP
GENERAL FUNCTIONS OF MESSAGES AND PARAMETERS [7] | +| Q.1902.3 | BICC PROTOCOL (CS2) AND SIGNALLING SYSTEM NO 7 ISUP
FORMATS AND CODES [8] (NOTE) | +| Q.1902.4 | BICC (CS2) BASIC CALL PROCEDURES [9] | +| Q.1902.5 | EXCEPTIONS TO THE APM IN THE CONTEXT OF BICC [10]
AMENDMENT TO ITU-T RECOMMENDATION Q.765.5 FOR BICC CS2 [5] | +| Q.1902.6 | GENERIC SIGNALLING PROCEDURES AND SUPPORT OF THE ISDN USER PART SUPPLEMENTARY
SERVICES WITH THE BEARER INDEPENDENT CALL CONTROL PROTOCOL [11] | +| NOTE: | The "Backward CAT indicators" parameter shall be encoded as an optional 3-octet parameter in the ACM, CPG and SEG messages rather than as a 1-octet parameter as incorrectly defined in Amendment 5 of ITU-T Recommendation Q.1902.3 [8]. | + +## 4.2 Interworking with other protocols + +| | | +|----------|-------------------------------------------------------------------------------------------------------------------------------------------| +| Q.1912.1 | ISUP-BICC INTERWORKING [16] | +| Q.1912.2 | INTERWORKING BETWEEN SELECTED SIGNALLING SYSTEMS (PSTN ACCESS DSS1 C5 R1 R2 TUP)
AND THE BEARER INDEPENDENT CALL CONTROL PROTOCOL [17] | + +## 4.3 Resource control protocol (G)MSC and MGW (Mc Interface) + +| | | +|----------------|------------------------------------------------------------------------------| +| 3GPP TS 29.232 | "Media Gateway Controller (MGC) – Media Gateway (MGW) Interface;Stage 3" [3] | +|----------------|------------------------------------------------------------------------------| + +## 4.4 Bearer control protocol between MGWs (Nb interface) + +| | | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3GPP TS 29.414 | "Core Network Nb Data Transport and Signalling Transport" [4] including ITU-T Recommendation Q.1970 "IP bearer control protocol" [15] , ITU-T Recommendation Q.1990 "BICC tunneling control protocol" [14] , ITU-T Recommendation Q.2630.1-2 "AAL type 2 signalling protocol" [13]. | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +## 4.5 Signalling Transport + +### 4.5.1 Call Control protocols + +| | | +|----------------|--------------------------------------------------------------------------------------------| +| Q.2150.0 | "Generic Signalling Transport Service" [18] | +| Q.2150.1 | "Signalling Transport Converter on MTP3 and MTP3b" [19] | +| Q.2150.3 | "Signalling Transport Converter on SCTP" [20] | +| 3GPP TS 29.202 | "SS7 signalling transport in core network" [22] Annex A: The use of M3UA in 3GPP networks. | + +### 4.5.2 Resource control protocol (G)MSC and MGW (Mc Interface) + +| | | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3GPP TS 29.232 | "Media Gateway Controller (MGC) – Media Gateway (MGW) Interface; Stage 3" [3] including ITU-T Recommendation H.248.4 "Transport over SCTP" [21], ITU-T Recommendation H.248.5 "Transport over ATM" [23], and 3GPP TS 29.202 "SS7 signalling transport in core network" [22] Annex A: The use of M3UA in 3GPP networks. | +|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +### 4.5.3 Bearer control protocol between MGWs (Nb interface) + +| | | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3GPP TS 29.414 | "Core Network Nb Data Transport and signalling transport" [4] including ITU-T Recommendation Q.2630.1-2: "AAL type 2 signalling protocol" [13] and the tunnel-up and tunnel-down procedure in 3GPP TS 29.232 [31] | +|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +# --- Annex A: Void + +# Annex B (normative): Transparent Support of Mobile Services + +## B.1 Introduction + +This Annex specifies a new mobile APM usage "Transparent support of mobile services". + +In ITU-T Recommendation Q.1902.3 [8], for the Application Transport Parameter (APP), the following codepoint is defined to refer to this application context identifier (ACI): + +0 0 0 0 1 1 1 MST + +The text in ITU-T Recommendation Q.1902.5 [10] shall be followed when implementing this application with the following clarification: + +- where the text refers to BAT ASE this shall be interpreted to mean Mobile Service Transport (MST) service. + +The MST service shall use implicit addressing; see ITU-T Recommendation Q.765 [24]. + +## B.2 Mobile Service Transport (MST) – Format and Codes + +### B.2.1 Encapsulated Application Information + +#### B.2.1.1 General Layout + +The general layout of the Encapsulated Application Information field of the Application Transport parameter as defined in ITU-T Recommendation Q.1902.3 [8] is shown in Table B.2.1.1.1. + +**Table B.2.1.1.1: Encapsulated application information field** + +| MSB | | | | | | | | LSB | | Octet | +|-----------------------------|---|---|---|---|---|---|---|-----|--|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | | +| Identifier 1 | | | | | | | | | | 1 | +| Length indicator 1 | | | | | | | | | | 2 | +| Compatibility information 1 | | | | | | | | | | 3 | +| Contents 1 | | | | | | | | | | 4 | +| | | | | | | | | | | | +| Identifier n | | | | | | | | | | m | +| Length indicator n | | | | | | | | | | | +| Compatibility information n | | | | | | | | | | | +| Contents n | | | | | | | | | | p | + +Each information element within the Encapsulated Application Information field has the same structure. An information element consists of four fields which always appear in the following order: Identifier (one octet), Length indicator, Compatibility information, Contents. + +The Identifier distinguishes one type from another one and governs the interpretation of the contents. There are two types of Identifiers: type "constructor" and type "simple", for which the contents are defined as follows: + +- For a "constructor" type, the Contents field shall again consist of one or more information elements, each of which is structured as described above, i.e., Identifier, Length indicator, Compatibility information, Contents. +- For a "simple" type, the Contents field contains one value only. + +When passing on an information element of type "constructor", the order of the information elements within this "constructor" shall be maintained. + +The Length indicator specifies the length (i.e., integral number of octets in pure binary representation) of the Compatibility information and Contents. The length does not include the Identifier nor the Length indicator. + +The format of the Length indicator is shown in Table B.2.1.1.2. Bit 8 is defined as Extension indicator and indicates whether or not the information on the length continues through the next octet. Value "0" of the Extension indicator means "*information continues through the next octet*", while value "1" means "*last octet*". The Length indicator itself has a maximum length of 2 octets, i.e., if octet 1a is needed, the Extension indicator of octet 1a is always set to value "1". + +**Table B.2.1.1.2: Length indicator** + +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | Octet | +|--------|---|---|---|-----|---|---|---|-----|-------| +| ext. | | | | | | | | LSB | 1 | +| ext. 1 | 0 | 0 | 0 | MSB | | | | | 1a | + +The Compatibility information contains corresponding instructions for the case that the received information element is unrecognised. The format of this field is shown in Table B.2.1.1.3. + +**Table B.2.1.1.3: Compatibility information** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | Octet | +|------|-----------------------------|-----------------------|----------------|-----------------------------|-----------------------|---|---|-------| +| ext. | pass-on not possible | | general action | | | | | 1 | +| | send notification indicator | instruction indicator | reserved | send notification indicator | instruction indicator | | | | + +The following codes are used in the subfields of the Compatibility information field. + +Bits 2 1 *Instruction indicator for general action* + +0 0 Pass on information element + +0 1 Discard information element + +1 0 Discard MST data + +1 1 Release call + +Bit 3 *Send notification indicator for general action* + +0 Do not send notification + +1 Send notification + +Bit 4 reserved + +Bits 6 5 *Instruction indicator for pass-on not possible* + +0 0 Release call + +0 1 Discard information element + +1 0 Discard MST data + +1 1 reserved (interpreted as 00) + +Bit 7 *Send notification indicator for pass-on not possible* + +0 Do not send notification + +1 Send notification + +Bit 8 *Extension indicator* + +- 0 Information continues through the next octet +- 1 Last octet + +The Contents field is the substance of the element and contains the information the element is intended to convey. + +#### B.2.1.2 List of Identifiers + +Table B.2.1.2.1 contains the list of Identifiers. + +**Table B.2.1.2.1: List of identifiers** + +| Value | Information element name | Type | Reference | +|------------------------------|-----------------------------------|--------|-----------| +| 0000 0000 | spare | - | | +| 0000 0001 | Mobile Equipment Identifier | simple | B.2.1.3 | +| 0000 0010 | LCLS Negotiation Request | simple | B.2.1.4 | +| 0000 0011 | LCLS Negotiation Response | simple | B.2.1.5 | +| 0000 0100 | LCLS Status | simple | B.2.1.6 | +| 0000 0101 | LCLS Status Change | simple | B.2.1.7 | +| 0000 0110 | LCLS Status Result | simple | B.2.1.8 | +| 0000 0111 | LCLS Global Call Reference | simple | B.2.1.9 | +| 0000 1000 | LCLS Configuration Preference | simple | B.2.1.10 | +| 0000 1001 | LCLS Configuration Change Request | simple | B.2.1.11 | +| 0000 1010 | LCLS Configuration Change Result | simple | B.2.1.12 | +| 0000 1011
to
1101 1111 | reserved for 3GPP use | - | | +| 1110 0000
to
1111 1111 | reserved for national use | - | | + +#### B.2.1.3 Mobile Equipment Identifier + +The format of the Mobile Equipment Identifier is shown in Table B.2.1.3.1. + +**Table B.2.1.3.1: Mobile Equipment Identifier** + +| MSB | | | | | | | | LSB | | | | | | | | Octet | +|-----------------------------|---|---|---|---|---|---|---|-----|---|---|---|---|---|---|---|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Mobile Equipment Identifier | | | | | | | | | | | | | | | | 1 | +| | | | | | | | | | | | | | | | | ... | +| | | | | | | | | | | | | | | | | x | + +The MEI contains either the International Mobile station Equipment Identity (IMEI) or the International Mobile station Equipment Identity and Software Version Number (IMEISV) as defined in subclause 6.2 of 3GPP TS 23.003 [25]. + +Both IMEI and IMEISV are TBCD encoded where IMEI is 15 digits and IMEISV is 16 digits. Bits 5 to 8 of octet n+1 (where n represents the octet of the IMEI(SV) being encoded) encodes digit 2n, bits 1 to 4 of octet n+1 encodes digit 2n-1 (i.e. the order of digits is swapped in each octet compared to the digit order defined in 3GPP TS 23.003 [25]). For IMEI, bits 5 to 8 of the last octet shall be filled with an end mark coded as '1111'. + +For the use of the Mobile Equipment Identifier (MEI) see 3GPP TS 23.216 [26] and 3GPP TS 23.237 [27]. + +#### B.2.1.4 LCLS Negotiation Request + +The format of the LCLS Negotiation Request is shown in Table B.2.1.4.1. + +**Table B.2.1.4.1: LCLS Negotiation Request** + +| MSB | | | | | | | LSB | | | +|---------------------|-------|---|---|---|---|----------------------|-----|--|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| Extension Indicator | Spare | | | | | Permission Indicator | | | Octet 1 | + +The LCLS Negotiation Request is sent in the forward direction to indicate LCLS usage permission. + +##### Bit 1 2        **Permission Indicator** + +| | | +|---------|-------------------------| +| 00 | LCLS is allowed | +| 01 | LCLS is not allowed | +| 10 – 11 | Reserved for future use | + +Bit 3 - 7        Spare + +##### Bit 8            **Extension Indicator** + +| | | +|---|-------------------------------------| +| 0 | information continues in next octet | +| 1 | last octet | + +For the use of the LCLS Negotiation Request IE see Annex C.2.1 and 3GPP TS 23.284 [29]. + +#### B.2.1.5 LCLS Negotiation Response + +The format of the LCLS Negotiation Response is shown in Table B.2.1.5.1. + +**Table B.2.1.5.1: LCLS Negotiation Response** + +| MSB | | | | | | | LSB | | | +|-------|---|---|---|---|----------------------|---|-----|--|---------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| Spare | | | | | Permission Indicator | | | | Octet 1 | + +The LCLS Negotiation Response contains information sent in the backwards direction to indicate result of the LCLS Negotiation Request. The LCLS Negotiation Response is coded as follows: + +##### Bits 1 2        **Permission Indicator** + +| | | +|----|--------------------------------------------| +| 00 | LCLS is allowed | +| 01 | LCLS is not allowed | +| 10 | LCLS is not supported by a subsequent node | +| 11 | spare | + +Bits 3 - 8 Spare + +For the use of the LCLS Negotiation Response IE see Annex C.2.2 and 3GPP TS 23.284 [29]. + +#### B.2.1.6 LCLS Status + +The format of the LCLS Status is shown in Table B.2.1.6.1. + +**Table B.2.1.6.1: LCLS Status** + +| • MSB | | | | | | | | • LSB | Octet | +|-------------|---|---|---|---|---|---|---|-------|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| LCLS Status | | | | | | | | | 1 | + +The LCLS Status contains information sent in forward and backward directions to indicate LCLS connection status. The LCLS Status is coded as follows: + +| Value | Meaning | +|-----------|----------------------------------------| +| 0000 0000 | no indication | +| 0000 0001 | LCLS is feasible but not yet connected | +| 0000 0010 | LCLS not connected | +| 0000 0011 | LCLS connected | + +All other values are reserved. + +For the use of the LCLS Status IE see Annex C.2.3, C.2.5 and 3GPP TS 23.284 [29]. + +#### B.2.1.7 LCLS Status Change + +The format of the LCLS Status Change is shown in Table B.2.1.7.1. + +**Table B.2.1.7.1: LCLS Status Change** + +| MSB | | | | | | | | LSB | Octet | +|--------------------|---|---|---|---|---|---|---|-----|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| LCLS Status Change | | | | | | | | | 1 | + +The LCLS Status Change Identifier contains information sent in forward and backward directions to indicate requested change of LCLS connection status. The LCLS Status Change Identifier is coded as follows: + +| Value | Meaning | +|-----------|---------------------------------------------| +| 0000 0000 | LCLS connection preparation | +| 0000 0001 | LCLS disconnection preparation | +| 0000 0010 | LCLS disconnection preparation for Handover | + +All other values are reserved. + +For the use of the LCLS Status Change IE see Annex C.2.6 and 3GPP TS 23.284 [29]. + +#### B.2.1.8 LCLS Status Result + +The format of the LCLS Status Result is shown in Table B.2.1.8.1. + +**Table B.2.1.8.1: LCLS Status Result** + +| MSB | | | LSB | | | | | Octet | +|-------|---|---|---------------------|---|---|----------------------|---|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Spare | | | Rejection Indicator | | | Acceptance Indicator | | 1 | + +The LCLS Status Result contains information sent in forward and backward directions to indicate result of the LCLS Status Change Request. The LCLS Status Result is coded as follows: + +##### **Bit 1 Acceptance Indicator** + +| | | +|---|-------------------------------------| +| 0 | LCLS Status Change request accepted | +| 1 | LCLS Status Change request rejected | + +##### **Bits 2 3 4 5 Rejection Indicator** + +| | | +|-------------|-------------------------------| +| 0000 | No indication | +| 0001 | Ongoing supplementary service | +| 0010 – 1111 | Reserved for future use | + +Bits 6 - 8 Spare + +For the use of the LCLS Status Result IE see Annex C.2.6 and 3GPP TS 23.284 [29]. + +#### B.2.1.9 LCLS Global Call Reference + +The format of the LCLS Global Call Reference (GCR) is shown in Table B.2.1.9.1. + +**Table B.2.1.9.1: LCLS Global Call Reference** + +| MSB | | | LSB | | | | | Octet | +|------------------------------------|---|---|-----|---|---|---|---|---------------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Network ID length indicator | | | | | | | | 1 | +| Network ID | | | | | | | | 2 | +| (variable length 3 – 5 octets) | | | | | | | | 4+m (m=0,1,2) | +| Node ID length indicator | | | | | | | | 5+m | +| Node ID | | | | | | | | 6+m | +| (fixed length: 2 octets) | | | | | | | | 7+m | +| Call Reference ID length indicator | | | | | | | | 8+m | +| | | | | | | | | 9+m | +| Call Reference ID | | | | | | | | | +| (fixed length: 5 octets) | | | | | | | | 13+m | + +The LCLS GCR is information sent in forward direction to uniquely identify a call and correlate activities associated with that call. The LCLS GCR is coded as follows: + +- Network ID length indicator +Binary coded information indicating the number of octets in the Network ID field. +- Network ID +Information identifying a network. The Network ID field is specified in ITU-T Recommendation Q.1902.3 [8]. +- Node ID length Indicator +Binary coded information indicating the number of octets in the Node ID field. + +- Node ID +A binary number that uniquely identifies within the network the node which generates the call reference. +- Call Reference ID length indicator +Binary coded information indicating the number of octets in the Call Reference ID field. +- Call Reference ID +A binary number used for the call reference of the call. It is generated by the originating serving node for each call. + +NOTE: If the originating serving radio access is GERAN the format of the Call Reference ID subfield is shown in Table B.2.1.9.2. The originating BSS ID is an integer that uniquely identifies the Base Station Subsystem (BSS) Node within an operator's network. + +**Table B.2.1.9.2: Call Reference ID** + +| MSB | | | | | | | | LSB | | | | | | | | Octet | +|------------------------------------------------|---|---|---|---|---|---|---|-----|---|---|---|---|---|---|---|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Call Identifier
(fixed length: 3 octets) | | | | | | | | | | | | | | | | 1 | +| | | | | | | | | | | | | | | | | 2 | +| | | | | | | | | | | | | | | | | 3 | +| Originating BSS ID
(fixed length: 2 octets) | | | | | | | | | | | | | | | | 4 | +| | | | | | | | | | | | | | | | | 5 | + +For the use of the LCLS GCR IE see Annex C.2.1 and 3GPP TS 23.284 [29]. + +#### B.2.1.10 LCLS Configuration Preference + +The format of the LCLS Configuration Preference is shown in Table B.2.1.10.1. + +**Table B.2.1.10.1: LCLS Configuration Preference** + +| MSB | | | | LSB | | | | Octet | +|---------------------|-------|---|---|-----------------------------------|----------------------------------|---------------------------------|--------------------------------|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Extension Indicator | Spare | | | Backward Data Reception Indicator | Forward Data Reception Indicator | Backward Data Sending Indicator | Forward Data Sending Indicator | 1 | + +The LCLS Configuration Preference contains information sent in forward and backward directions to indicate negotiated LCLS configuration preference. + +##### Bit 1 Forward Data Sending Indicator + +0 not required +1 required + +##### Bit 2 Backward Data Sending Indicator + +0 not required +1 required + +##### Bit 3 Forward Data Reception Indicator + +0 not required +1 required + +##### Bit 4 Backward Data Reception Indicator + +0 not required +1 required + +Bits 5 - 7 Spare + +**Bit 8 Extension Indicator** +0 information continues in next octet +1 last octet + +For the use of the LCLS Configuration Preference IE see Annex C.2.1, C.2.2, C.2.4 and 3GPP TS 23.284 [29]. + +#### B.2.1.11 LCLS Configuration Change Request + +The format of the LCLS Configuration Change Request is shown in Table B.2.1.11.1. + +**Table B.2.1.11.1: LCLS Configuration Change Request** + +| MSB | LSB | | | | | | | Octet | +|---------------------|-------|---|---|---|---|---|------|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Extension Indicator | Spare | | | | | | Type | 1 | + +The LCLS Configuration Change Request contains information sent in the forward and backward directions to indicate type of LCLS Configuration Change Request. + +**Bit 1 2 Type** +00 LCLS Configuration Preference Modification Request +01 - 11 Spare + +Bit 3 - 7 Spare + +**Bit 8 Extension Indicator** +0 information continues in next octet +1 last octet + +For the use of the LCLS Configuration Change Request IE see Annex C.2.4 and 3GPP TS 23.284 [29]. + +#### B.2.1.12 LCLS Configuration Change Result + +The format of the LCLS Configuration Change Result is shown in Table B.2.1.12.1. + +**Table B.2.1.12.1: LCLS Configuration Change Result** + +| MSB | | | | | | | LSB | Octet | +|-------|---|---------------------|---|---|---|---|----------------------|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| Spare | | Rejection Indicator | | | | | Acceptance Indicator | 1 | + +The LCLS Configuration Change Result contains information sent in the backward direction to indicate result of the LCLS Configuration Change Request. The LCLS Configuration Change Result is coded as follows: + +**Bit 1 Acceptance Indicator** +0 LCLS Configuration Change request accepted +1 LCLS Configuration Change request rejected (if set then Rejection Indicator provides further details) + +**Bits 2 3 4 5 Rejection Indicator** + +| | | +|-------------|--------------------------------------------| +| 0000 | No indication | +| 0001 | Requested LCLS configuration not supported | +| 0010 | Ongoing supplementary service | +| 0011 – 1111 | Reserved for future use | +| Bits 6 - 8 | Spare | + +For the use of the LCLS Configuration Change Result IE see Annex C.2.4 and 3GPP TS 23.284 [29]. + +### B.2.2 Application Transport Instruction Indicators + +For the MST service the Application Transport Instruction Indicators (ATII) shall be set as follows: + +| | | | +|------|---|------------------------------------------| +| Bits | 1 | Release call indicator (RCI) | +| | 0 | do not release call | +| Bit | 2 | Send notification indicator (SNI) | +| | 0 | do not send notification | + +# --- Annex C (normative): LCLS Service Application + +LCLS Service is defined in 3GPP TS 23.284 [29] and is dependent on the following identifiers being included in BICC/ISUP messaging. The following sections describe the detailed protocol behaviour when these identifiers are included. + +## --- C.1 Use of MST ASE + +LCLS service makes use of the services of the MST ASE described in Annex B. The services of the MST ASE are accessed by means of primitives (such as "MST\_data") which are the same as BAT ASE primitives defined in ITU-T Recommendation Q.765.5 [5]. + +## --- C.2 Procedures + +### C.2.1 Indication of LCLS Capability + +#### C.2.1.1 LCLS Service Capability Indication + +LCLS service shall be used for a call if MST\_data primitive associated with an IAM includes LCLS Information Elements: a LCLS GCR, a LCLS Negotiation Request and a LCLS Configuration Preference. The absence of the LCLS Negotiation, the LCLS Configuration Preference and the LCLS GCR Information Elements in the IAM specifies that the LCLS service shall not be used. + +The compatibility information of the LCLS Negotiation Request, the LCLS Configuration Preference and the LCLS GCR Information Elements shall be set so as to cause the Information Element to be discarded by nodes that do not support LCLS service. + +The procedures for call establishment using the LCLS service are described in 3GPP TS 23.284 [29]. + +#### C.2.1.2 Actions at Originating Serving Node + +An originating Serving Node (SN) that supports the LCLS service shall indicate this within the IAM message of the mobile originating call by including the LCLS Negotiation Request, the LCLS Configuration Preference and the LCLS GCR Information Elements within the MST Application Transport Parameter (APP) within the IAM. + +When the LCLS service is allowed to be used the IAM is sent to the succeeding node with the Permission Indicator of the LCLS Negotiation Request Information Element set to "LCLS is allowed". + +Depending on network requirements the originating SN may additionally indicate required configurations for user plane connectivity towards originating or terminating UE within the LCLS Configuration Preference Information Element. If the originating MSC server needs to: + +- send data towards the terminating UE it shall set Forward Data Sending Indicator to "required"; +- send data towards the originating UE it shall set Backward Data Sending Indicator to "required"; +- receive data from the originating UE it shall set Forward Data Reception Indicator to "required"; +- receive data from the terminating UE it shall set Backward Data Reception Indicator to "required". + +The originating SN shall perform the setting of LCLS Configuration Preference Information Element according to rules specified in sub-clause 4.2 of 3GPP TS 23.284 [29] or it may determine that LCLS is not allowed and indicate this by setting the value of Permission Indicator of the LCLS Negotiation Request Information Element to "LCLS is not allowed". + +#### C.2.1.3 Actions at Intermediate Serving Node + +For the intermediate Serving Node (SN), LCLS service indication (i.e. LCLS GCR, LCLS Negotiation Request and LCLS Configuration Preference Information Elements) shall be included only if received from the preceding node and if the node itself supports the LCLS service. + +The intermediate SN shall not change the LCLS GCR Information Element. If the intermediate SN receives Permission Indicator of the LCLS Negotiation Request Information Element set to "LCLS is not allowed" it shall not change it. + +Depending on network requirements the intermediate SN may additionally indicate required configurations for user plane connectivity towards originating or terminating UE by changing the received LCLS Configuration Preference Information Element. If the intermediate SN needs to: + +- send data towards the terminating UE it shall set Forward Data Sending Indicator to "required"; +- send data towards the originating UE it shall set Backward Data Sending Indicator to "required"; +- receive data from the originating UE it shall set Forward Data Reception Indicator to "required"; +- receive data from the terminating UE it shall set Backward Data Reception Indicator to "required". + +If the intermediate SN receives any of these indicators set to "required" it shall not change them. + +#### C.2.1.4 Actions at Destination Serving Node + +For the destination Serving Node (SN), LCLS service shall be supported only if the IAM with the LCLS Negotiation Request, LCLS Configuration Preference and LCLS GCR Information Elements within the MST Application Transport Parameter (APP) is received from the preceding node and if the node itself supports the LCLS service. + +Depending on network requirements the destination SN may additionally modify received configurations for user plane connectivity towards originating or terminating UE, by changing the settings of the LCLS Configuration Preference Information Element. If the destination SN needs to: + +- send data towards the terminating UE it shall set Forward Data Sending Indicator to "required"; +- send data towards the originating UE it shall set Backward Data Sending Indicator to "required"; +- receive data from the originating UE it shall set Forward Data Reception Indicator to "required"; + +- receive data from the terminating UE it shall set Backward Data Reception Indicator to "required". + +If the destination SN receives any of these indicators set to "required" it shall not change them. + +The destination SN shall perform modification of LCLS Configuration Preference Information Element according to rules specified in sub-clause 4.2 of 3GPP TS 23.284 [29] or it may determine that LCLS is not allowed and shall indicate this by setting the value of Permission Indicator of the LCLS Negotiation Response Information Element to "LCLS is not allowed". + +### C.2.2 Backward LCLS Negotiation during Call Setup + +#### C.2.2.1 Introduction + +LCLS service shall be used for a call if MST\_data primitive associated with first backward (APM or ACM) message includes a LCLS Negotiation Response and a LCLS Configuration Preference Information Elements. The absence of the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements in the first backward message specifies that the LCLS service shall not be used. + +The compatibility information of the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements shall be set so as to cause the Information Element to be discarded by nodes that do not support LCLS service. + +#### C.2.2.2 Actions at Destination Serving Node + +If LCLS service is supported according to conditions specified in sub-clause C.2.1.4 a destination SN shall include in the first backward message (APM or ACM) the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements in the MST\_Data request primitive. + +#### C.2.2.3 Actions at Intermediate Serving Node + +If LCLS service is supported according to conditions specified in sub-clause C.2.1.3 but a succeeding node does not return LCLS Negotiation Response Information Element in the first backward message, an Intermediate SN shall include the LCLS Negotiation Response Information Element. The Permission Indicator of the LCLS Negotiation Response Information Element shall be set to "LCLS is not supported by a subsequent node". + +On receipt of a backward message (APM, ACM or CPG) with the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements the Intermediate SN shall store the LCLS configuration settings from the LCLS Configuration Preference Information Element and shall forward the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements unchanged. + +#### C.2.2.4 Actions at Originating Serving Node + +If the first backward message does not contain the LCLS Negotiation Response and the LCLS Configuration Preference Information Elements the originating SN shall assume that LCLS is not supported by succeeding node and LCLS shall not be performed for that call; no further LCLS signalling shall take place for that call. + +If the first backward message contains the LCLS Negotiation Response Information Element but the Permission Indicator is set to "LCLS Not Allowed" or "LCLS is not supported by a subsequent node" then the originating SN shall not request establishment of the LCLS connection at this time. + +NOTE: A subsequent LCLS Negotiation Response Information Element can be received from succeeding nodes, e.g. in the event of a call forwarding on no reply. + +### C.2.3 Answer message + +#### C.2.3.1 Introduction + +LCLS connection may be established for a call if MST\_data primitive associated with an ANM includes a LCLS Status Identifier Information Element. The absence of the LCLS Status Identifier Information Element in the ANM specifies that the LCLS connection shall not be requested. + +The compatibility information of the LCLS Status Identifier shall be set so as to cause the Information Element to be discarded by nodes that do not support LCLS service. + +#### C.2.3.2 Actions at Destination Serving Node + +If a destination SN determines that LCLS service is feasible according to the conditions specified in sub-clause 6.2.1.3.4 of 3GPP TS 23.284 [29] it shall include the LCLS Status Identifier Information Element set to "LCLS feasible but not yet connected" within the MST Application Transport Parameter (APP) within the ANM. + +#### C.2.3.3 Actions at Intermediate Serving Node + +An Intermediate SN shall pass the LCLS Status Identifier within the ANM unchanged. + +#### C.2.3.4 Actions at Originating Serving Node + +When an originating SN receives an ANM with the LCLS Status Identifier indicating the LCLS service is feasible it shall request LCLS connection. + +### C.2.4 LCLS Configuration Change Request + +#### C.2.4.1 Introduction + +Modification of a LCLS configuration can only occur after the LCLS negotiation has been performed during the call set-up phase according to the procedures described in sub-clauses C.2.1 and C.2.2. A SN involved in a LCLS Configuration Change procedure must not initiate a new LCLS Configuration Change Request until the existing LCLS Configuration Change procedure has been completed. + +A LCLS Configuration Change Request message may be sent in either direction and at any time during the active phase of a call, after the LCLS negotiation has been performed during the call establishment. A LCLS Configuration Change Request and a LCLS Configuration Preference Information Elements indicating the requested change of the LCLS configuration shall be included in a MST\_data primitive, corresponding to an APM message. + +A MST\_Data primitive, corresponding to the APM message shall be issued in response, including the LCLS Configuration Preference and the LCLS Configuration Change Result Information Elements indicating if the requested change of LCLS configuration has been accepted and if it has not been accepted the reason for rejection. + +The compatibility information of the LCLS Configuration Preference, the LCLS Configuration Change Request and LCLS Configuration Change Result Information Elements shall be set so as to cause the Information Element to be discarded and send notification by nodes that do not support LCLS service. + +NOTE: The term "initiating" SN in the following clauses refers to a SN which initiates the LCLS Configuration Change Request. The term "terminating" SN in the following clauses refers to a SN which terminates the LCLS Configuration Change Request. + +#### C.2.4.2 Actions at Initiating Serving Node + +If a SN determines that LCLS configuration needs to be changed it may send an APM message which includes a LCLS Configuration Change Request and the LCLS Configuration Preference Information Elements to its succeeding and/or preceding node. The initiating SN shall set the desired configurations as described in sub-clause C.2.1.2. + +The LCLS Configuration Change Request may only be initiated if LCLS Negotiation was performed during call establishment. + +NOTE: this does not require that LCLS was permitted during the call establishment. + +On receipt of an APM message containing the LCLS Configuration Preference and the LCLS Configuration Change Result Information Elements, if the result indicates "accepted" the modification of the LCLS Configuration settings has been successful. If the LCLS Configuration Change Result Information Element indicates "rejected" the initiating SN shall resume the LCLS connection with the LCLS configuration unchanged. + +#### C.2.4.3 Actions at Intermediate Serving Node + +When an intermediate SN receives an APM message with the LCLS Configuration Change Request and the LCLS Configuration Preference Information Elements requesting a certain LCLS Configuration Change the intermediate SN shall check if it can support the requested LCLS configuration. If the intermediate SN can support the proposed LCLS configuration it shall forward the LCLS Configuration Preference and the LCLS Configuration Change Request Information Elements to its succeeding or preceding node. If the intermediate SN cannot support/permit the proposed LCLS configuration it shall respond with a LCLS Configuration Change Result Information Element set to "LCLS Configuration Change request rejected" along with the Rejection Indicator detailing the reason for rejection. + +On receipt of an APM message with the LCLS Configuration Change Result and LCLS Configuration Preference Information Elements from its succeeding/preceding node if the LCLS Configuration Change Result Information Element indicates "accepted" the intermediate SN shall store the LCLS configuration settings from the LCLS Configuration Preference Information Element and shall forward the APM message to its preceding/succeeding node. + +If the LCLS Configuration Change Result Information Element indicates "rejected" the intermediate SN shall resume the LCLS connection with the LCLS configuration unchanged and the intermediate SN shall forward the APM message to its preceding/succeeding node. + +#### C.2.4.4 Actions at Terminating Serving Node + +When an SN which is a terminating SN with respect to a LCLS Configuration Change Request receives an APM message with the LCLS Configuration Change Request and LCLS Configuration Preference Information Elements requesting a certain LCLS Configuration Change the terminating SN shall check if it can support the requested LCLS configuration. + +If the terminating SN can support the proposed LCLS configuration change it shall return the LCLS Configuration Preference Information Element and the LCLS Configuration Change Result Information Element indicating acceptance of the LCLS Configuration Change to its succeeding or preceding node. If the terminating SN cannot support/permit the proposed LCLS configuration it shall respond with a LCLS Configuration Change Result Information Element set to "LCLS Configuration Change request rejected" along with the Rejection Indicator detailing the reason for rejection. + +### C.2.5 LCLS Status Update + +#### C.2.5.1 Introduction + +A LCLS Status Update message may be sent in either direction to indicate that a LCLS connection status has been changed. A LCLS Status Identifier Information Element indicating the new LCLS connection status value shall be included in a MST\_data primitive, corresponding to an APM message. + +The compatibility information of the LCLS Status Identifier shall be set so as to cause the Information Element to be discarded and send notification by nodes that do not support LCLS service. + +NOTE: The term "initiating" SN in the following clauses refers to an originating SN or a destination SN that may initiate the LCLS Status Update message. The term "terminating" SN in the following clauses refers to an originating SN or a destination SN that may receive the LCLS Status Update message. + +#### C.2.5.2 Actions at Initiating Serving Node + +If a SN determines that the LCLS connection status has been changed it shall send the new LCLS connection status value to an adjacent SN. An initiating SN shall send the LCLS Status Identifier Information Element within the MST Application Transport Parameter (APP) within the APM message. + +#### C.2.5.3 Actions at Intermediate Serving Node + +When an intermediate SN receives the APM message with the LCLS Status Identifier Information Element from the preceding/succeeding SN and if the same LCLS connection status value has not been already received from the succeeding/preceding SN, the intermediate SN shall store the new LCLS Connection status value and shall pass the LCLS Status Identifier Information Element within the APM message unchanged to its succeeding/preceding SN. + +#### C.2.5.4 Actions at Terminating Serving Node + +When a terminating SN receives the APM message with the LCLS Status Identifier Information Element from the adjacent SN, it shall update its LCLS connection status value. + +### C.2.6 LCLS Status Change Request + +#### C.2.6.1 Introduction + +A LCLS Status Change Request message may be sent in either direction and at any time during the active phase of a call, after the LCLS has been initially established. A LCLS Status Change Identifier Information Element indicating the requested change of the LCLS connection status shall be included in a MST\_data primitive, corresponding to an APM message. + +An MST\_Data primitive, corresponding to the APM message shall be issued in response, including the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element indicating if the requested change of LCLS connection status has been accepted and if it has not been accepted the reason for rejection. + +The compatibility information of the LCLS Status Change Identifier and the LCLS Status Result Identifier shall be set so as to cause the Information Element to be discarded and send notification by nodes that do not support LCLS service. + +NOTE: The term "initiating" SN in the following clauses refers to a SN which initiates the LCLS Status Change. The term "terminating" SN in the following clauses refers to a SN which terminates the LCLS Status Change. + +#### C.2.6.2 Actions at Initiating Serving Node + +When a SN determines that the LCLS connection status needs to be changed, it shall request the change of the LCLS connection status from its preceding and/or succeeding SN. An initiating SN shall send the LCLS Status Change Identifier Information Element within the MST Application Transport Parameter (APP) within an APM message. + +An APM message containing the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element will be received in response from the succeeding and/or preceding SN. + +If initiating SN is an SN serving a Radio Network (originating SN or destination SN), upon reception of the LCLS Status Result Identifier Information Element indicating the acceptance of the requested LCLS connection status change, the initiating SN shall change the LCLS connection status. + +NOTE: This change of LCLS connection status can be deferred until signalling interaction with the served Radio Network Controller, which is outside of the scope of this specification. + +#### C.2.6.3 Actions at Intermediate Serving Node + +When an intermediate SN receives from a preceding/succeeding SN an APM message that includes a LCLS Status Change Identifier Information Element within the MST Application Transport Parameter (APP) it shall check if it can support the required change of the LCLS connection status. + +If the intermediate SN cannot support the requested change of the LCLS connection status it shall respond to the preceding/succeeding SN with the APM message containing the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element with an Acceptance indicator set to "LCLS Status Change request rejected" along with a Rejection Indicator detailing the reason for rejection. + +If the intermediate SN can support the required change of the LCLS connection status it shall pass the LCLS Status Change Identifier Information Element within the APM message unchanged to its succeeding/preceding SN. An APM message will be received in response, including the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element from its succeeding/preceding SN. The intermediate SN shall pass the LCLS Status Change Identifier Information Element and the LCLS Status Result Identifier Information Element within the APM message unchanged to its succeeding/preceding SN. + +#### C.2.6.4 Actions at Terminating Serving Node + +Upon reception of an APM message that includes a LCLS Status Change Identifier Information Element, from the adjacent SN, a terminating SN shall check if it can support the required change of the LCLS connection status. + +If the terminating SN can support the required change, it shall change the LCLS connection status. If the result of the LCLS connection status change is successful the terminating SN shall send to the adjacent SN the APM message with the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element indicating the acceptance of the requested LCLS connection status change. + +NOTE: If the terminating SN is an SN serving a Radio Network (originating SN or destination SN), there can be additional signalling with the served Radio Network Controller, prior to responding to the LCLS Status Change Request; this is, however, outside of the scope of this specification. + +If the result of the LCLS connection status change is unsuccessful or if the terminating SN cannot support the required change it shall respond to the adjacent SN with the APM message containing the LCLS Status Change Identifier Information Element and a LCLS Status Result Identifier Information Element with an Acceptance indicator set to "LCLS Status Change request rejected" along with a Rejection Indicator detailing the reason for rejection. \ No newline at end of file diff --git a/marked/Rel-18/29_series/29217/raw.md b/marked/Rel-18/29_series/29217/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..158a1a7dbdb8b345652e48611bb7ff3c4044233c --- /dev/null +++ b/marked/Rel-18/29_series/29217/raw.md @@ -0,0 +1,938 @@ + + +# 3GPP TS 29.217 V18.0.0 (2024-03) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Policy and Charging Control (PCC); Congestion reporting over Np 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 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** + +LTE, 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. + +© 2024, 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 and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Np reference point..... | 7 | +| 4.1 Overview ..... | 7 | +| 4.2 Np reference model ..... | 8 | +| 4.3 Functional elements..... | 8 | +| 4.3.1 RCAF..... | 8 | +| 4.3.2 PCRF ..... | 9 | +| 4.3.3 H-PCRF ..... | 9 | +| 4.3.4 V-PCRF ..... | 9 | +| 4.4 Procedures over Np reference point..... | 9 | +| 4.4.1 RUCI Report..... | 9 | +| 4.4.1.1 General..... | 9 | +| 4.4.1.2 Non-aggregated RUCI report..... | 10 | +| 4.4.1.3 Aggregated RUCI report..... | 10 | +| 4.4.2 Reporting Restriction Provisioning ..... | 10 | +| 4.4.3 UE mobility between RCAFs..... | 11 | +| 4.4.4 Removal of UE context ..... | 11 | +| 4.4.5 Race condition handling ..... | 12 | +| 5 Np protocol ..... | 12 | +| 5.1 Protocol support ..... | 12 | +| 5.2 Initialization, maintenance and termination of connection and session..... | 12 | +| 5.3 Np specific AVPs..... | 13 | +| 5.3.1 General ..... | 13 | +| 5.3.2 Aggregated-Congestion-Info AVP ..... | 13 | +| 5.3.3 Aggregated-RUCI-Report AVP ..... | 13 | +| 5.3.4 Congestion-Level-Definition AVP..... | 14 | +| 5.3.5 Congestion-Level-Range AVP..... | 14 | +| 5.3.6 Congestion-Level-Set-Id AVP ..... | 14 | +| 5.3.7 Congestion-Level-Value AVP..... | 14 | +| 5.3.8 Congestion-Location-Id AVP..... | 15 | +| 5.3.9 Conditional-Restriction AVP ..... | 15 | +| 5.3.10 eNodeB-Id AVP ..... | 15 | +| 5.3.11 IMSI-List AVP ..... | 15 | +| 5.3.12 RCAF-Id AVP ..... | 16 | +| 5.3.13 Reporting-Restriction AVP ..... | 16 | +| 5.3.14 RUCI-Action AVP ..... | 16 | +| 5.3.15 Extended-eNodeB-Id AVP ..... | 17 | +| 5.4 Np re-used AVPs..... | 17 | +| 5.4.1 General ..... | 17 | +| 5.4.2 Use of the Supported-Features AVP on the Np reference point..... | 18 | +| 5.5 Np specific Experimental-Result-Code AVP values ..... | 19 | +| 5.5.1 General ..... | 19 | +| 5.5.2 Success ..... | 19 | +| 5.5.3 Permanent Failures ..... | 19 | +| 5.5.4 Transient Failures ..... | 19 | +| 5.6 Np messages..... | 19 | +| 5.6.0 Command-Code Values..... | 19 | +| 5.6.1 Non-Aggregated-RUCI-Report-Request (NRR) command ..... | 20 | +| 5.6.2 Non-Aggregated-RUCI-Report-Answer (NRA) command..... | 20 | + +5.6.3 Aggregated-RUCI-Report-Request (ARR) command ..... 21 +5.6.4 Aggregated-RUCI-Report-Answer (ARA) command..... 21 +5.6.5 Modify-Uecontext-Request (MUR) command..... 21 +5.6.6 Modify-Uecontext-Answer (MUA) command..... 22 +**Annex A (informative): Change history..... 23** + +# --- 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 Np reference point. The functional requirements and the stage 2 specifications of the Np reference point are contained in 3GPP TS 23.203 [2]. The Np reference point lies between the RAN Congestion Awareness Function (RCAF) and the Policy and Charging Rules Function (PCRF) for the non-roaming case, between the RCAF and the H-PCRF for the home-routed scenario and between the RCAF and the V-PCRF for the visited access scenario. + +NOTE: If not specified explicitly, the PCRF also means H-PCRF for the home-routed scenario or V-PCRF in the visited access scenario in the specification. + +# 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.203: "Policy and charging control architecture". +- [3] 3GPP TS 29.213: "Policy and Charging Control signalling flows and QoS parameter mapping". +- [4] IETF RFC 4005: "Diameter Network Access Server Application". +- [5] IETF RFC 4006: "Diameter Credit Control Application". +- [6] 3GPP TS 29.229: "Cx and Dx interfaces based on Diameter protocol; Protocol details". +- [7] IETF RFC 3588: "Diameter Base Protocol". +- [8] 3GPP TS 23.401: "GPRS enhancements for E-UTRAN access". +- [9] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [10] 3GPP TS 29.215: "Policy and Charging Control (PCC) over S9 reference point; Stage 3". +- [11] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [12] 3GPP TS 29.274: "3GPP Evolved Packet System. Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [13] ITU-T Recommendation E.212: "The international identification plan for mobile terminals and mobile users". +- [14] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [15] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [16] IETF RFC 7944: "Diameter Routing Message Priority". +- [17] IETF RFC 8583: "Diameter Load Information Conveyance". +- [18] IETF RFC 6733: "Diameter Base Protocol". + +- [19] IETF RFC 5719: "Updated IANA Considerations for Diameter Command Code Allocations". +- [20] IETF RFC 2234: "Augmented BNF for syntax specifications". + +# --- 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]. + +**Home Routed Access:** Roaming scenario where the PCEF is located in the HPLMN. In a Home Routed roaming scenario, the UE obtains access to the packet data network from the HPLMN. + +**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. + +**Visited Access (also known as local breakout):** Roaming scenario where the PCEF is located in the VPLMN. In a Visited Access Roaming scenario, the UE obtains access to the packet data network from the VPLMN. + +## 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 | +| ARR | Aggregated RUCI Report Request | +| ARA | Aggregated RUCI Report Answer | +| DRMP | Diameter Routing Message Priority | +| H-PCRF | Home PCRF | +| MUR | Modify Uecontext Request | +| MUA | Modify Uecontext Answer | +| NRR | Non-Aggregated RUCI Report Request | +| NRA | Non-Aggregated RUCI Report Answer | +| PCC | Policy and Charging Control | +| PCRF | Policy and Charging Rule Function | +| RCAF | RAN Congestion Awareness Function | +| RUCI | RAN User Plane Congestion Information | +| V-PCRF | Visited PCRF | + +# --- 4 Np reference point + +## 4.1 Overview + +The Np reference point is located between the RCAF and the PCRF for the non-roaming scenario, between the RCAF and the H-PCRF for the home-routed scenario and between the RCAF and the V-PCRF for the visited access scenario. The Np reference point is used for: + +- Reporting the RUCI from the RCAF to the PCRF; +- Provisioning the Reporting Restriction from the PCRF to the RCAF; + +- The User Equipment (UE) mobility between RCAF; +- The removal of the UE context in the RCAF. + +The stage 2 level requirements for the Np reference point are defined in 3GPP TS 23.203 [2]. + +Signalling flows related to Np interface are specified in 3GPP TS 29.213 [3]. + +Refer to Annex G of 3GPP TS 29.213 [3] for Diameter overload control procedures over the Np interface. + +Refer to Annex J of 3GPP TS 29.213 [3] for Diameter message priority mechanism procedures over the Np interface. + +Refer to Annex K of 3GPP TS 29.213 [3] for Diameter load control procedures over the Np interface. + +## 4.2 Np reference model + +The relationships between the involved functional entities are depicted in figure 4.2.1. The overall PCC architecture is depicted in clause 3a of 3GPP TS 29.213 [3] . + +![Diagram of the Np reference model showing RCAF and PCRF connected via the Np interface.](1c94fd3cebf58af136144f14160d128e_img.jpg) + +The diagram shows two green rectangular boxes, labeled 'RCAF' on the left and 'PCRF' on the right, connected by a horizontal line. Above the line, the label 'Np' is centered. There is a small vertical tick mark on the line between the two boxes. + +Diagram of the Np reference model showing RCAF and PCRF connected via the Np interface. + +**Figure 4.2.1: Np reference model** + +NOTE: For the home-routed access scenario, the RCAF interacts with the H-PCRF. For the visited access scenario, the RCAF interacts with the V-PCRF. + +**Figure 4.2.2: Void** + +**Figure 4.2.3: Void** + +## 4.3 Functional elements + +### 4.3.1 RCAF + +The RCAF is a functional element which reports RAN User Plane Congestion Information (RUCI) via the Np interface to the PCRF to enable the PCRF to take the RAN user plane congestion status into account for policy decisions. RUCI includes the following information: + +- The user id (e.g. IMSI) identifying the UE impacted by congestion; +- PDN ID for which congestion information is reported; +- Congestion level information (either congestion level value or congestion level set id) of the UE impacted by congestion; +- eNodeB identifier, ECGI or SAI identifying the eNodeB, E-UTRAN cell or Service Area respectively, serving the UE if a conditional restriction to restrict location reporting is not enabled. + +NOTE 1: In case of E-UTRAN, whether the eNodeB identifier or the ECGI are included in the RUCI is up to operator configuration in the RCAF. + +The RCAF sends the RUCI to the PCRFs serving the UEs' PDN connections as follows: + +- For a PDN connection in a non-roaming scenario the RCAF reports the RUCI to the PCRF; +- For a PDN connection in a local breakout scenario, based on operator configuration, the RCAF reports the RUCI to the V-PCRF; + +- For a PDN connection in a home routed scenario, based on the roaming agreement with the HPLMN and operator configuration, the RCAF reports the RUCI to the H-PCRF + +NOTE 2: Reporting of congestion information to the HPLMN may be used e.g. in case of a group of PLMNs which belong to a single business entity. + +The RCAF determines whether a given PDN connection is served in a local breakout or a home routed roaming scenario based on the APN operator identifier received as part of the APN information from the MME or the SGSN as documented in 3GPP TS 23.401 [8] and 3GPP TS 23.060 [9], respectively. + +NOTE 3: Operator configuration can be used to limit RUCI reporting on the Np interface to certain APNs only. + +The RCAF maintains a context per user id and APN. The context is identified by the IMSI and the APN. It contains the following information: + +- The previously reported congestion level over the Np reference point; +- The reporting restrictions received from the PCRF. The reporting restrictions are stored by the RCAF until the PCRF explicitly signals to remove the reporting restrictions. +- The logical PCRF id received from the PCRF to identify the PCRF that is the Np destination for the RCAF when sending aggregate messages. + +### 4.3.2 PCRF + +The PCRF is a functional element that encompasses policy control decision and flow based charging control functionalities. + +The PCRF may receive RUCI from the RCAF as input for policy decisions of congestion mitigation. The PCRF may provide, update or remove the reporting restrictions of RUCI, or stop or enable RUCI reporting for a given user id and PDN ID. The PCRF may enable or disable the reporting of congestion location identifier as part of RUCI. The PCRF may also remove the context at the RCAF for a given user id and PDN ID. + +NOTE: Depending on the RUCI reporting interval configured in the RCAF, a UE can move outside the area indicated without the RCAF immediately notifying the PCRF. In case the PCRF receives information about the cell currently serving a UE via Np and Gx when the location change reporting is enabled, then the information received via Gx is expected to take precedence. + +### 4.3.3 H-PCRF + +Functionality defined in clause 4.3.2 shall apply if UE is roaming with home-routed access scenario. + +NOTE: Reporting of congestion information to the HPLMN can be used e.g. in case of a group of PLMNs which belong to a single business entity. + +### 4.3.4 V-PCRF + +Functionality defined in clause 4.3.2 shall apply if UE is roaming with visited access scenario. + +## 4.4 Procedures over Np reference point + +### 4.4.1 RUCI Report + +#### 4.4.1.1 General + +The RCAF shall perform the RUCI reporting to the PCRF when at least one of the following conditions applies: + +- the RCAF detects a UE in the congestion area for the first time; +- a reporting restriction is enabled and the congestion level set id is changed; + +- a reporting restriction is not enabled and the congestion level value is changed; +- a conditional restriction to restrict location reporting is not enabled and the UE is in a congested area and the location is changed; or +- the RCAF detects that the UE is no longer experiencing congestion (i.e. the UE is no longer detected in any of the congested cells that the RCAF is monitoring). + +The RCAF shall report the RUCI to the PCRF unless the RUCI reporting is disabled for the PDN ID or for the user id and the PDN ID. + +Two types of RUCI reports may be used on Np for transfer of congestion information from RCAF to PCRF: Non-aggregated RUCI report and Aggregated RUCI report. If the RCAF does not know the destination PCRF for the user id and PDN ID, the Non-aggregated RUCI report shall be used; otherwise the RCAF may use either the Non-aggregate RUCI report or Aggregated RUCI report for the user id and PDN ID. + +#### 4.4.1.2 Non-aggregated RUCI report + +For a Non-aggregated RUCI report, the RCAF shall send an NRR command to the PCRF by including the user id within the Subscription-Id AVP, PDN ID within the Called-Station-Id AVP and a congestion level set id within the Congestion-Level-Set-Id AVP if the reporting restriction was provided earlier or a congestion level value within the Congestion-Level-Value AVP if the reporting restriction was not provided earlier at the command level. The RCAF may also provide congestion location identifier of the UE within the Congestion-Location-Id AVP in the NRR command. The RCAF shall also include the RCAF Identity within the RCAF-Id AVP in every NRR command for a specific user id and PDN ID. + +Once the PCRF receives the NRR command, the PCRF shall store the related info and respond with an NRA command including the PCRF id within the PCRF-Address AVP. The PCRF may use the RUCI received from the RCAF as input for policy decisions. When the RCAF receives the NRA command, the RCAF may store the PCRF id in the UE context for this specific user id together with PDN ID for further aggregated RUCI report. + +If the ReportRestriction feature is supported by both the RCAF and the PCRF, the PCRF may provide reporting restrictions in the NRA command according to clause 4.4.2. + +#### 4.4.1.3 Aggregated RUCI report + +For an Aggregated RUCI report, the RCAF shall aggregate the RUCIs of different user ids and PDN IDs that have the same destination PCRF. The RCAF shall send an ARR command to the destination PCRF by including the PCRF id within the Destination-Host AVP, one or more Aggregated-RUCI-Report AVP with a congestion level set id within the Congestion-Level-Set-Id AVP if the reporting restriction was provided earlier or a congestion level value within the Congestion-Level-Value AVP if the reporting restriction was not provided earlier, the PDN ID within the Called-Station-ID AVP and a list of aggregated congestion information within the Aggregated-Congestion-Info AVP. + +NOTE 1: Each instance of Aggregated-RUCI-Report AVP aggregates the user id list of the subscribers that share the same level of congestion or share the same congestion level set id. + +NOTE 2: When the RCAF assembles a Diameter ARR command, if the message length of ARR command has exceeded the maximum length of Diameter message which can be configurable, the RCAF can divide the original ARR command into multiple aggregated RUCI messages for the delivery over Np reference point. + +Once the PCRF receives the ARR command, the PCRF shall store the related info and respond with an ARA command. The PCRF may use the RUCI received from the RCAF as input for policy decisions. + +### 4.4.2 Reporting Restriction Provisioning + +If the ReportRestriction feature is supported by both the RCAF and the PCRF, the PCRF may provide the reporting restrictions for a specific user id and PDN ID in the initial NRA command. The PCRF may also provide, modify or disable restrictions for RUCI reporting or stop or enable RUCI reporting for the specific user id and PDN ID at any later time. The PCRF may also use this procedure to enable or disable the reporting of congestion location identifier as part of RUCI. + +In order to initially provide the reporting restrictions, the PCRF shall send a Modify-Uecontext-Request (MUR) command including the targeted Subscription-Id AVP indicating the user id, the Called-Station-Id AVP indicating the targeted PDN ID and one or more Congestion-Level-Definition AVP(s) including the defined congestion level set within the Congestion-Level-Set-Id AVP and corresponding congestion level(s) within the Congestion-Level-Range AVP or reply with an NRA command including one or more Congestion-Level-Definition AVP(s) including the defined congestion level set within the Congestion-Level-Set-Id AVP and corresponding congestion level(s) within the Congestion-Level-Range AVP . The PCRF may also include the Reporting-Restriction AVP and Conditional-Restriction AVP to indicate when conditional reporting restrictions apply. + +The PCRF may modify already provided reporting restrictions. To do so the PCRF shall provide the complete list of congestion level sets and corresponding congestion levels to be used in the same manner as when initially providing reporting restrictions. This complete list shall replace any previously provided list. The absence of Reporting-Restriction AVP and Conditional-Restriction AVP indicates that previous state of reporting restrictions remains valid. + +If reporting restrictions has been provided for a specific user id and PDN ID, the PCRF may remove the reporting restrictions by, in the MUR command, including the Reporting-Restriction AVP set to 0 (No reporting restriction), together with Subscription-Id AVP indicating the user id and the Called-Station-Id AVP indicating the targeted PDN ID or reply with an NRA command including the Reporting-Restriction AVP set to 0 (No reporting restriction). + +The PCRF may disable RUCI reporting by, in the MUR command, including the RUCI-Action AVP set to 0 (Disable RUCI Reporting), together with Subscription-Id AVP indicating the user id and the Called-Station-Id AVP indicating the targeted PDN ID or reply with an NRA command including the RUCI-Action AVP set to 0 (Disable RUCI Reporting). + +To enable RUCI Reporting if previously disabled, the PCRF in the MUR command shall include the RUCI-Action AVP set to 1 (Enable RUCI Reporting), together with Subscription-Id AVP indicating the user id and the Called-Station-Id AVP indicating the targeted PDN ID or reply with an NRA command including the RUCI-Action AVP set to 1 (Enable RUCI Reporting). + +If reporting restrictions also applies, the PCRF shall include one or more Congestion-Level-Definition AVP(s) including the defined congestion level set with the Congestion-Level-Set-Id AVP and corresponding congestion level(s) within the Congestion-Level-Range AVP, within the same command. + +To provision the reporting restriction which disables the reporting of congestion location identifier of the UE as part of RUCI, the PCRF shall include Reporting-Restriction AVP set to 1 (Conditional reporting restriction) and Conditional-Restriction AVP with the bit 0 be set. To enable a previously disabled reporting of the congestion location identifier of the UE as part of RUCI, the PCRF shall include Reporting-Restriction AVP set to 2 (Unconditional reporting restriction). + +The PCRF shall include the value of the RCAF-Id AVP received in the NRR command for the specific user id and PDN ID in the Destination-Host AVP of the MUR command. + +The RCAF acknowledges the received MUR command by sending a Modify-Uecontext-Answer (MUA) command in all cases above. + +### 4.4.3 UE mobility between RCAFs + +If RUCI reporting is used for a specific user id and PDN ID and the PCRF receives a new non-aggregated RUCI report for the same user id and PDN ID but with a different RCAF id included in the RCAF-Id AVP, the PCRF shall update the related information and respond with an NRA command according to clause 4.4.1.1. + +The PCRF shall also initiate a removal of the UE context to the old RCAF according to clause 4.4.4. + +### 4.4.4 Removal of UE context + +This procedure is initiated when the PCRF needs to remove a UE context from the RCAF, e.g. at UE mobility between RCAFs. + +If the PCRF due to an event determines that a UE context needs to be removed from the RCAF, the PCRF shall send an MUR command to the targeted RCAF to explicitly release the context related to the user id and PDN ID by including the Subscription-Id AVP indicating the user id, the Called-Station-Id AVP indicating the PDN ID, the Destination-Host AVP indicating the targeted RCAF id and the RUCI-Action AVP set to 2 (Release Context). + +The RCAF when receiving the MUR command from the PCRF shall release the context related to the user id and PDN ID. If this is the last PDN ID stored for this user id the RCAF shall release the complete context. + +The RCAF shall acknowledge the received MUR command by sending an MUA command. + +### 4.4.5 Race condition handling + +If the RCAF receives an MUR command to remove a context for a specific user id and PDN ID, the request shall be handled immediately, regardless of whether there are any ongoing RUCI report transactions for that user id and PDN ID. + +If the PCRF receives an NRR command for a specific user id and PDN ID, and if there is an ongoing MUR command to remove the context for that user id and PDN ID, the PCRF shall reject the incoming request with a Diameter experimental result code of DIAMETER\_PENDING\_TRANSACTION. + +If the PCRF receives an ARR command for specific user id and PDN ID combinations for which there is at least one ongoing MUR command to remove the context, the PCRF shall accept the request and only update the context(s) that are not in the process of being removed. + +# --- 5 Np protocol + +## 5.1 Protocol support + +The Np application is defined as a vendor specific Diameter application, where the vendor is 3GPP and the Application-ID for the Np Application in the present release is 16777342. 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 Np application within the Auth-Application-Id AVP in order to create suitable routeing tables. + +With regard to the Diameter protocol defined over the Np interface, the PCRF acts as a Diameter server, in the sense that it is the network element that handles the RUCI reporting for a particular realm. The RCAF acts as the Diameter client, in the sense that it is the network element reporting the RUCI. + +## 5.2 Initialization, maintenance and termination of connection and session + +The initialization and maintenance of the connection between the RCAF and PCRF are defined by the underlying protocol. Establishment and maintenance of connections between Diameter nodes are described in IETF RFC 6733 [18]. + +After establishing the transport connection, the RCAF and the PCRF shall advertise the support of the Np 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 [18]). + +The Np Diameter session shall be terminated after each request and answer pair interaction. + +In order to indicate that the session state is not to be maintained, the Diameter client and server shall include the Auth-Session-State AVP with the value set to NO\_STATE\_MAINTAINED (1), in the request and in the answer messages (see IETF RFC 6733 [18]). + +## 5.3 Np specific AVPs + +### 5.3.1 General + +Table 5.3.1.1 describes the Diameter AVPs defined for the Np reference point, their AVP Code values, types, possible flag values, whether or not the AVP may be encrypted and which supported features the AVP is applicable to. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415). + +**Table 5.3.1.1: Np specific Diameter AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type (NOTE 2) | AVP Flag rules (NOTE 1) | | | | May Encr. | Applicability (NOTE 3) | +|-----------------------------|----------|----------------|---------------------|-------------------------|-----|------------|----------|-----------|------------------------| +| | | | | Mus t | May | Should not | Must not | | | +| Aggregated-Congestion-Info | 4000 | 5.3.2 | Grouped | V, M | P | | | Y | | +| Aggregated-RUCI-Report | 4001 | 5.3.3 | Grouped | V, M | P | | | Y | | +| Congestion-Level-Definition | 4002 | 5.3.4 | Grouped | V | P | | M | Y | ReportRestriction | +| Congestion-Level-Range | 4003 | 5.3.5 | Unsigned32 | V | P | | M | Y | ReportRestriction | +| Congestion-Level-Set-Id | 4004 | 5.3.6 | Unsigned32 | V | P | | M | Y | ReportRestriction | +| Congestion-Level-Value | 4005 | 5.3.7 | Unsigned32 | V, M | P | | | Y | | +| Congestion-Location-Id | 4006 | 5.3.8 | Grouped | V | P | | M | Y | ReportRestriction | +| Conditional-Restriction | 4007 | 5.3.9 | Unsigned32 | V | P | | M | Y | ReportRestriction | +| eNodeB-Id | 4008 | 5.3.10 | OctetString | V, M | P | | | Y | | +| IMSI-List | 4009 | 5.3.11 | OctetString | V, M | P | | | Y | | +| RCAF-Id | 4010 | 5.3.12 | DiameterIdentity | V, M | P | | | Y | | +| Reporting-Restriction | 4011 | 5.3.13 | Unsigned32 | V | P | | M | Y | ReportRestriction | +| RUCI-Action | 4012 | 5.3.14 | Unsigned32 | V | P | | M | Y | ReportRestriction | +| Extended-eNodeB-Id | 4013 | 5.3.15 | OctetString | V, M | P | | M | Y | | + +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 [18]. + +NOTE 2: The value types are defined in IETF RFC 6733 [18]. + +NOTE 3: AVPs marked with a supported feature (e.g. "ReportRestriction") are applicable as described in clause 5.4.2. + +### 5.3.2 Aggregated-Congestion-Info AVP + +The Aggregated-Congestion-Info AVP (AVP code 4000) is of type Grouped. It contains a list of user ids identified by IMSI and optionally the congestion location id in which the list of user ids are located. + +``` +Aggregated-Congestion-Info ::= < AVP Header: 4000 > + [ Congestion-Location-Id ] + [ IMSI-List ] + *[ AVP ] +``` + +### 5.3.3 Aggregated-RUCI-Report AVP + +The Aggregated-RUCI-Report AVP (AVP code 4001) is of type Grouped, and it is used to contain the congestion level value or congestion level set id for a set of users which have the same PCRF for the same PDN ID. + +The congestion-Level-Value AVP contains the congestion level value if the PCRF did not provide the reporting restriction earlier for the user id and PDN ID. + +The Congestion-Level-Set-Id AVP contains the congestion level set identifier between the PCRF and the RCAF if the PCRF provided the reporting restriction earlier for the user id and PDN ID. + +The Called-Station-Id AVP contains the PDN ID. + +The Aggregated-Congestion-Info AVP shall indicate the list of users included in the IMSI-List AVP and the congested location included in the Congestion-Location-Id AVP (if applicable), where a congestion level included in the Congestion-Level-Value AVP or congestion level set included in the Congestion-Level-Set-Id AVP shall apply. + +``` +Aggregated-RUCI-Report ::= < AVP Header: 4001 > + 1*{ Aggregated-Congestion-Info } + [ Called-Station-Id ] + [ Congestion-Level-Value ] + [ Congestion-Level-Set-Id ] + *[ AVP ] +``` + +### 5.3.4 Congestion-Level-Definition AVP + +The Congestion-Level-Definition AVP (AVP code 4002) is of type Grouped, and it is used to define a congestion level set and corresponding congestion level(s) to be used by the RCAF for a specific user id and PDN ID at congestion reporting. When this AVP is present in the MUR command reporting restrictions apply, when this AVP is absent there are no reporting restriction for the specific user id and PDN ID. + +``` +Congestion-Level-Definition ::= < AVP Header: 4002 > + { Congestion-Level-Set-Id } + { Congestion-Level-Range } + *[ AVP ] +``` + +### 5.3.5 Congestion-Level-Range AVP + +The Congestion-Level-Range AVP (AVP code 4003) is of type Unsigned32, and it is used to indicate the list of congestion level(s) bound to a certain congestion level set, between the PCRF and the RCAF. The Congestion-Level-Range AVP 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.5.1: Congestion Level Range** + +| Bit | Name | Description | +|-----|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | No congestion | This bit, when set, indicates that the RCAF shall report the corresponding congestion level set id to the PCRF when there is no congestion for a certain user id and PDN ID. | +| 1 | Congestion level 1 | This bit, when set, indicates that the RCAF shall report the corresponding congestion level set id to the PCRF when congestion level 1 is reached for a certain user id and PDN ID. | +| 1+n | Congestion level 1+n | This bit, when set, indicates that the RCAF shall report the corresponding congestion level set id to the PCRF when congestion level 1+n is reached for a certain user id and PDN ID. | + +### 5.3.6 Congestion-Level-Set-Id AVP + +The Congestion-Level-Set-Id AVP (AVP code 4004) is of type Unsigned32, and it is used to indicate the congestion level set identifier between the PCRF and the RCAF. + +### 5.3.7 Congestion-Level-Value AVP + +The Congestion-Level-Value AVP (AVP code 4005) is of type Unsigned32, and it is used to indicate the congestion level associated with the user id and PDN ID. + +The following values are defined: + +0 (No congestion): + +This value indicates that there is no congestion. + +N (Congestion level n): + +These values indicate that there is congestion. The value n is an integer between 1 and 31 and indicates a congestion level. The value 1 is the lowest congestion level and value 31 is the highest congestion level. + +### 5.3.8 Congestion-Location-Id AVP + +The Congestion-Location -Id AVP (AVP code 4006) is of type Grouped, and it indicates the identifier of a congested location in which the UE is currently located. The congested location is one of the following: the eNodeB, E-UTRAN cell or Service Area serving the UE. If ECGI is included in the 3GPP-User-Location-Info AVP within Congestion-Location-Id AVP, then the eNodeB identifier within eNodeB-Id AVP or Extended-eNodeB-Id AVP shall not be included in this AVP. This AVP is provided in the RUCI per user id and APN. If the eNodeB identifier has a length of 18 or 21 bits it shall be provided in the Extended-eNodeB-Id AVP and otherwise in the eNodeB-Id AVP. + +AVP Format: + +``` +Congestion-Location-Id ::= < AVP Header: 4006 > + [ 3GPP-User-Location-Info ] + [ eNodeB-Id ] + [ Extended-eNodeB-Id ] + *[ AVP ] +``` + +### 5.3.9 Conditional-Restriction AVP + +The Conditional-Restriction AVP (AVP code 4007) is of type Unsigned32 and it shall contain a bit mask, and indicates what conditional reporting restrictions apply. Conditional reporting restrictions shall apply when this AVP is provided. 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.9.1: Conditional-Restriction over Np** + +| Bit | Name | Description | +|-----|---------------------------------------|--------------------------------------------------------------------------------------------------------------------| +| 0 | UE location info not included in RUCI | This bit, when set, indicates that the location information of the UE shall not be included in RUCI for reporting. | + +### 5.3.10 eNodeB-Id AVP + +The eNodeB-Id AVP (AVP code 4008) is of type OctetString, and indicates the eNodeB in which the UE is currently located. The AVP shall be coded as in clause 8.51 of 3GPP TS 29.274 [12]. + +### 5.3.11 IMSI-List AVP + +The IMSI-List AVP (AVP code 4009) is of type OctetString, and it contains a list of user ids identified by IMSI. Each IMSI shall be encoded as TBCD digits as defined in ITU-T Recommendation E.212 [13], i.e. digits from 0 through 9 are encoded "0000" to "1001". Each IMSI shall be encoded as 8 octets. If the length of the IMSI is 14, then the last octet shall be encoded as "1111 1111". If the length of the IMSI is 15, bits 5 to 8 of the last octet shall be encoded with the filler "1111". The maximum number of digits is 15. An example of the encoding of the IMSI List as the data part of the OctetString AVP is given below in Figure 5.3.11-1. Octet 1 given below is the first octet of the data part of the IMSI-List AVP. + +| Octets | Bits | | | | | | | | +|-----------|---------------------------|---|---|---|---------------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Number digit 2 of IMSI-1 | | | | Number digit 1 of IMSI-1 | | | | +| 2 | Number digit 4 of IMSI-1 | | | | Number digit 3 of IMSI-1 | | | | +| ... | ... | | | | ... | | | | +| 8 | 1111 | | | | Number digit 15 of IMSI-1 | | | | +| 9 | Number digit 2 of IMSI-2 | | | | Number digit 1 of IMSI-2 | | | | +| 10 | Number digit 4 of IMSI-2 | | | | Number digit 3 of IMSI-2 | | | | +| ... | ... | | | | ... | | | | +| 15 | Number digit 14 of IMSI-2 | | | | Number digit 13 of IMSI-2 | | | | +| 16 | 1111 | | | | 1111 | | | | +| 17 | Number digit 2 of IMSI-3 | | | | Number digit 1 of IMSI-3 | | | | +| 18 | Number digit 4 of IMSI-3 | | | | Number digit 3 of IMSI-3 | | | | +| ... | ... | | | | ... | | | | +| 23 | Number digit 14 of IMSI-3 | | | | Number digit 13 of IMSI-3 | | | | +| 24 | 1111 | | | | 1111 | | | | +| ... | ... | | | | ... | | | | +| (n-1)*8+1 | Number digit 2 of IMSI-n | | | | Number digit 1 of IMSI-n | | | | +| (n-1)*8+2 | Number digit 4 of IMSI-n | | | | Number digit 3 of IMSI-n | | | | +| ... | ... | | | | ... | | | | +| (n-1)*8+8 | 1111 | | | | Number digit 15 of IMSI-n | | | | + +NOTE: In the above figure showing an example of encoding, it is assumed that n IMSIs are included in the IMSI-List AVP. The digit length of IMSI-1, IMSI-2, IMSI-3 and IMSI-n are 15, 14, 14, 15 respectively. + +**Figure 5.3.11-1: Encoding of IMSI-List AVP** + +### 5.3.12 RCAF-Id AVP + +The RCAF-Id AVP (AVP code 4010) is of type DiameterIdentity, and it is used to contain the RCAF identity. + +### 5.3.13 Reporting-Restriction AVP + +The Reporting-Restriction AVP (AVP code 4011) is of type Unsigned32, and it is used to indicate the applicable reporting restrictions between the PCRF and RCAF. If this AVP is not provided during the initial reporting restriction provisioning, it shall be understood as unconditional reporting restrictions apply. + +The following values are defined: + +0 (No reporting restriction): + +This value shall be used by the PCRF to indicate to the RCAF that there are no restrictions on congestion reporting for a specific user id and PDN ID. This value shall not be used if congestion level definitions are included in the same command. + +1 (Conditional reporting restriction): + +This value shall be used by the PCRF to indicate to the RCAF that there are conditional restrictions on congestion reporting for a specific user id and PDN ID. + +2 (Unconditional reporting restriction): + +This value shall be used by the PCRF to indicate to the RCAF that there are unconditional restrictions on congestion reporting for a specific user id and PDN ID. + +### 5.3.14 RUCI-Action AVP + +The RUCI-Action AVP (AVP code 4012) is of type Unsigned32, and it is used to disable or enable RUCI reporting between the PCRF and RCAF or to release the context for a specific user id and PDN ID. + +The following values are defined: + +0 (Disable RUCI reporting): + +This value shall be used by the PCRF to indicate to the RCAF that RUCI reporting shall not be performed for a specific user id and PDN ID. + +1 (Enable RUCI reporting): + +This value shall be used by the PCRF to indicate to the RCAF that RUCI reporting shall be performed for a specific user id and PDN ID. + +2 (Release Context): + +This value shall be used by the PCRF to indicate to the RCAF that the context shall be released for a specific user id and PDN ID. + +### 5.3.15 Extended-eNodeB-Id AVP + +The Extended-eNodeB-Id AVP (AVP code 4013) is of type OctetString, and indicates the eNodeB in which the UE is currently located. The AVP shall be coded as in clause 8.51 of 3GPP TS 29.274 [12] for Type Extended Macro eNodeB. + +## 5.4 Np re-used AVPs + +### 5.4.1 General + +Table 5.4.1.1 lists the Diameter AVPs re-used by the Np reference point from other existing Diameter Applications, reference to their respective specifications, short description of their usage within the Np reference point and which supported features the AVP is applicable to. 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.1.1, but they are re-used for the Np reference point. Unless otherwise stated, re-used AVPs shall maintain their 'M', 'P' and 'V' flag settings. Where RADIUS VSAs are re-used, unless otherwise stated, they shall be translated to Diameter AVPs as described in RFC 4005 [4] with the exception that the 'M' flag shall be set and the 'P' flag may be set. + +Table 5.4.1.1: Np re-used Diameter AVPs + +| Attribute Name | Reference | Description | Applicability (NOTE) | +|-----------------------------------------------------------------------------------------|----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| Called-Station-Id | IETF RFC 4005 [4] | The address the user is connected to (i.e. the PDN identifier). | | +| DRMP | IETF RFC 7944 [16] | Allows Diameter endpoints to indicate the relative priority of Diameter transactions. | | +| Load | IETF RFC 8583 [17] | 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. | | +| OC-OLR | IETF RFC 7683 [15] | Contains the necessary information to convey an overload report. | | +| OC-Supported-Features | IETF RFC 7683 [15] | Defines the support for the Diameter overload indication conveyance by the sending node. | | +| PCRF-Address | TS 29.215 [10] | The identity, which indicates the destination PCRF. | | +| Subscription-Id | IETF RFC 4006 [5] | The identification of the subscription (i.e. IMSI) | | +| Supported-Features | TS 29.229 [6] | If present, this AVP informs the destination host about the features that the origin host requires to successfully complete this command exchange | | +| 3GPP-User-Location-Info | TS 29.061 [11], clause 16.4.7.2. | Indicates details of where the UE is currently located. Only SAI (Geographic Location Type set to 1) or ECGI (Geographic Location Type set to 129) is included in this information. | | +| NOTE: AVPs marked with a supported feature are applicable as described in clause 5.4.2. | | | | + +### 5.4.2 Use of the Supported-Features AVP on the Np reference point + +When new functionality is introduced on the Np reference point, it should be defined as optional. If backwards incompatible changes cannot be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. Unless otherwise stated, the use of the Supported-Features AVP on the Np reference point shall be compliant to the usage of the Supported-Features AVP on the Cx reference point and consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [6]. + +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 [6], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, 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 reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Supported-Features AVP shall be included in every NRR and NRA command if supported by the RCAF and PCRF respectively. + +The table below defines the features applicable to the Np interface for the feature list with a Feature-List-ID of 1. + +Table 5.4.2.1: Features of Feature-List-ID 1 used in Np + +| Feature bit | Feature | M/O | Description | +|-------------------------------------------------------------------------------------------------------------------------------------|-------------------|-----|-------------------------------------------------------------| +| 0 | ReportRestriction | O | This feature indicates the support of reporting restriction | +| 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. | | | | + +## 5.5 Np specific Experimental-Result-Code AVP values + +### 5.5.1 General + +This clause defines result code values that shall be supported by Diameter implementations that conform to this specification. + +### 5.5.2 Success + +Result Codes that fall into 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 [18] are applied. + +### 5.5.3 Permanent Failures + +Errors that fall into the Permanent Failures category shall be used to inform the peer that the request has failed. The Result-Code AVP values defined in Diameter Base Protocol IETF RFC 6733 [18] are applied. As an addition the following Result-Code AVP value defined in IETF RFC 4006 [5] is applicable: + +DIAMETER\_USER\_UNKNOWN (5030): + +This error shall be used by the PCRF to indicate to the RCAF that the end user specified in the request is unknown to the PCRF, or it shall be used by the RCAF to indicate to the PCRF that the end user specified in the request is unknown to the RCAF. This result code does not apply for aggregated RUCI report. + +### 5.5.4 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 [18] are applicable. As an addition the following Experimental-Result-Code value defined in 3GPP TS 29.212 [14] is applicable: + +DIAMETER\_PENDING\_TRANSACTION (4144): + +This error shall be used when a node receives an incoming request for a specific user id and PDN ID while it has an ongoing transaction for the same user id and PDN ID and cannot handle the request as described in clause 4.4.5. + +## 5.6 Np messages + +### 5.6.0 Command-Code Values + +This clause defines the Command-Code values for the Np interface application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [x]. Every command is defined by means of the ABNF syntax in IETF RFC 2234 [y], and according to the rules in IETF RFC 6733 [18]. + +NOTE: As the commands in the present specification have originally been defined based on the former specification of the Diameter Base Protocol (IETF RFC 3588 [7]), the Vendor-Specific-Application-Id AVP is still assumed as a required AVP (an AVP indicated as {AVP}) in the command code format to avoid backward compatibility issues, even if the use of this AVP has been deprecated in the new specification of the Diameter Base Protocol (IETF RFC 6733 [18]). + +The Np application identifier shall be included in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP contained in the commands defined in this specification. + +The following Command Codes are defined in this specification: + +Table 5.6.0.1: Command-Code values for Np + +| Command-Name | Abbreviation | Code | Section | +|------------------------------------|--------------|---------|---------| +| Non-Aggregated-RUCI-Report-Request | NRR | 8388720 | 5.6.1 | +| Non-Aggregated-RUCI-Report-Answer | NRA | 8388720 | 5.6.2 | +| Aggregated-RUCI-Report-Request | ARR | 8388721 | 5.6.3 | +| Aggregated-RUCI-Report-Answer | ARA | 8388721 | 5.6.4 | +| Modify-Uecontext-Request | MUR | 8388722 | 5.6.5 | +| Modify-Uecontext-Answer | MUA | 8388722 | 5.6.6 | + +#### 5.6.1 Non-Aggregated-RUCI-Report-Request (NRR) command + +The NRR command, indicated by the Command-Code field set to 8388720 and the 'R' bit set in the Command Flags field, is sent by the RCAF to the PCRF as part of the Non-aggregated RUCI report procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + [ Origin-State-Id ] + [ Subscription-Id ] + [ Called-Station-Id ] + [ Congestion-Level-Value ] + [ Congestion-Level-Set-Id ] + [ Congestion-Location-Id ] + [ OC-Supported-Features ] + [ RCAF-Id ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Supported-Features ] + *[ AVP ] +``` + +#### 5.6.2 Non-Aggregated-RUCI-Report-Answer (NRA) command + +The NRA command, indicated by the Command-Code field set to 8388720 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the RCAF as part of the Non-aggregated RUCI report procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388720, PXY > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ OC-Supported-Features ] + [ OC-OLR ] + [ Reporting-Restriction ] + [ Conditional-Restriction ] + [ RUCI-Action ] + *[ Congestion-Level-Definition ] + [ PCRF-Address ] + [ Origin-State-Id ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + *[ Proxy-Info ] + *[ Supported-Features ] +``` + +``` + +*[ Load ] +*[ AVP ] + +``` + +### 5.6.3 Aggregated-RUCI-Report-Request (ARR) command + +The ARR command, indicated by the Command-Code field set to 8388721 and the 'R' bit set in the Command Flags field, is sent by the RCAF to the PCRF as part of the Aggregated RUCI report procedure. + +Message Format: + +``` + + ::= + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + [ Origin-State-Id ] + *[ Aggregated-RUCI-Report ] + [ OC-Supported-Features ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ Supported-Features ] + *[ AVP ] + +``` + +### 5.6.4 Aggregated-RUCI-Report-Answer (ARA) command + +The ARA command, indicated by the Command-Code field set to 8388721 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the RCAF as part of the Aggregated RUCI report procedure. + +Message Format: + +``` + + ::= < Diameter Header: 8388721, PXY > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Origin-State-Id ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + *[ Proxy-Info ] + *[ Supported-Features ] + *[ Load ] + *[ AVP ] + +``` + +### 5.6.5 Modify-Uecontext-Request (MUR) command + +The MUR command, indicated by the Command-Code field set to 8388722 and the 'R' bit set in the Command Flags field, is sent by the PCRF to the RCAF in order to request congestion reporting restrictions or remove the context for a specific user id and PDN ID. + +Message Format: + +``` + +< Modify-Uecontext-Request > ::= < Diameter Header: 8388722, REQ, PXY > + < Session-Id > + [ DRMP ] + { Vendor-Specific-Application-Id } + { Auth-Session-State } + { Origin-Host } + +``` + +``` +{ Origin-Realm } +{ Destination-Realm } +{ Destination-Host } +[ Origin-State-Id ] +[ Subscription-Id ] +[ Called-Station-Id ] +[ OC-Supported-Features ] +[ Reporting-Restriction ] +[ Conditional-Restriction ] +[ RUCI-Action ] +*[ Congestion-Level-Definition ] +*[ Proxy-Info ] +*[ Route-Record ] +*[ AVP ] +``` + +### 5.6.6 Modify-Uecontext-Answer (MUA) command + +The MUA command, indicated by the Command-Code field set to 8388722 and the 'R' bit set in the Command Flags field, is sent by the RCAF to the PCRF as a response to the request for congestion reporting restrictions to or remove the context a specific user id and PDN ID. + +Message Format: + +``` +< Modify-Uecontext-Answer > ::= < Diameter Header: 8388722, PXY > +< Session-Id > +[ DRMP ] +{ Vendor-Specific-Application-Id } +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ Result-Code ] +[ Experimental-Result ] +[ Failed-AVP ] +[ Origin-State-Id ] +[ OC-Supported-Features ] +[ OC-OLR ] +*[ Redirect-Host ] +[ Redirect-Host-Usage ] +[ Redirect-Max-Cache-Time ] +*[ Proxy-Info ] +*[ AVP ] +``` + +# Annex A (informative): Change history + +| Change history | | | | | | | | +|-----------------------|--------------|-----------------|-----------|------------|--------------------------------------------------------------------------------|------------------------------------------------------------------------------|------------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2015-06 | CT#68 | CP-150367 | | | Cleaned-up by MCC, based on the version sent by e-mail on June 5th and agreed. | 2.1.0 | 2.2.0 | +| 2015-06 | - | - | - | - | MCC Editorial update after approval by TSG CT#68 | 2.2.0 | 13.0.0 | +| 2015-09 | CP-69 | CP-150477 | 0003 | 2 | Alignment of RUCI reporting restrictions' basis for UPCON | 13.0.0 | 13.1.0 | +| 2015-09 | CP-69 | CP-150477 | 0005 | 2 | Correction to the PCRF functionality | 13.0.0 | 13.1.0 | +| 2015-09 | CP-69 | CP-150477 | 0006 | 1 | Correction to the RCAF functionality | 13.0.0 | 13.1.0 | +| 2015-09 | CP-69 | CP-150477 | 0008 | 1 | Corrections to the wrong implementation of C3-150441 | 13.0.0 | 13.1.0 | +| 2015-09 | CP-69 | CP-150477 | 0009 | 1 | Fixing Ambiguous Flag Rules for AVPs reused from TS 29.061 | 13.0.0 | 13.1.0 | +| 2015-12 | CP-70 | CP-150672 | 0010 | 1 | Some corrections to 29.217 | 13.1.0 | 13.2.0 | +| 2015-12 | CP-70 | CP-150797 | 0011 | 1 | Update the PCC architecture figures in 29.217 | 13.1.0 | 13.2.0 | +| 2015-12 | CP-70 | CP-150630 | 0012 | 1 | Update draft-ietf-dime-ovli reference to RFC 7683 | 13.1.0 | 13.2.0 | +| 2015-12 | CP-70 | CP-150672 | 0013 | 1 | Vendor Specific Application ID over Np interface | 13.1.0 | 13.2.0 | +| 2015-12 | CP-70 | CP-150672 | 0016 | 2 | Race condition handling for aggregated RUCI report | 13.1.0 | 13.2.0 | +| 2015-12 | CP-70 | CP-150730 | 0018 | 1 | Diameter Message Priority over Np | 13.1.0 | 13.2.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2016-03 | CT#71 | CP-160094 | 0022 | 1 | F | Congestion Level for the specific user id | 13.3.0 | +| 2016-03 | CT#71 | CP-160094 | 0023 | 1 | F | Add command codes and AVP numbers for Np protocol | 13.3.0 | +| 2016-03 | CT#71 | CP-160093 | 0024 | - | F | Reference of the Diameter message priority mechanism procedure | 13.3.0 | +| 2016-03 | CT#71 | CP-160094 | 0025 | 1 | F | Add missing abbreviations | 13.3.0 | +| 2016-06 | CT#72 | CP-160276 | 0026 | 2 | F | Correct Modify-Uecontext-Answer command definition and some editorial errors | 13.4.0 | +| 2016-09 | CT#73 | CP-160442 | 0027 | - | F | Correction of IETF drmp draft version | 13.5.0 | +| 2016-09 | CT#73 | CP-160453 | 0028 | 1 | F | Correction to the Np reused Diameter AVPs table | 13.5.0 | +| 2016-12 | CT#74 | CP-160614 | 0029 | - | F | Correction to change IETF drmp draft version to official RFC 7944 | 13.6.0 | +| 2016-12 | CT#74 | CP-160615 | 0030 | 2 | B | Diameter Load Control Mechanism | 14.0.0 | +| 2016-12 | CT#74 | CP-160616 | 0031 | 1 | F | Diameter base protocol specification update | 14.0.0 | +| 2017-03 | CT#75 | CP-170086 | 0033 | 2 | F | Support of long and short Macro eNodeB IDs | 14.1.0 | +| 2017-03 | CT#75 | CP-170076 | 0034 | - | F | Update instance number for the Failed-AVP in answer commands | 14.1.0 | +| 2017-06 | CT#76 | CP-171119 | 0035 | 1 | F | Reference update for draft-ietf-dime-load | 14.2.0 | +| 2017-06 | CT#76 | CP-171133 | 0040 | 1 | F | Vendor-Specific-Application-Id AVP handling | 14.2.0 | +| 2018-06 | CT#80 | | | | | Automatic upgrade from previous Release | 15.0.0 | +| 2019-09 | CT#85 | CP-192154 | 0042 | 1 | A | draft-ietf-dime-load published as RFC 8583 | 15.1.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | +| 2022-03 | SA#95e | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 | +| 2024-03 | SA#103 | - | - | - | | Update to Rel-18 version (MCC) | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29219/raw.md b/marked/Rel-18/29_series/29219/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..0080cfbcfa724c88bde23504925c0a5c14a83276 --- /dev/null +++ b/marked/Rel-18/29_series/29219/raw.md @@ -0,0 +1,862 @@ + + +# 3GPP TS 29.219 V18.0.0 (2024-03) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Policy and Charging Control: Spending Limit Reporting over Sy 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 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. + +© 2024, 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 and abbreviations ..... | 7 | +| 3.1 Definitions..... | 7 | +| 3.2 Abbreviations ..... | 7 | +| 4 Sy reference point ..... | 8 | +| 4.1 Overview ..... | 8 | +| 4.2 Sy Reference model ..... | 8 | +| 4.3 Subscriber Spending Limits ..... | 8 | +| 4.4 Functional elements..... | 9 | +| 4.4.1 PCRF ..... | 9 | +| 4.4.2 OCS ..... | 9 | +| 4.5 Spending Limits procedures over Sy reference point ..... | 9 | +| 4.5.1 Initial/Intermediate Spending Limit Report Request..... | 9 | +| 4.5.1.1 General..... | 9 | +| 4.5.1.2 Detailed behaviour of the PCRF ..... | 10 | +| 4.5.1.3 The behaviour of the OCS ..... | 10 | +| 4.5.2 Spending Limit Report ..... | 11 | +| 4.5.2.1 General..... | 11 | +| 4.5.2.2 The behaviour of the OCS ..... | 12 | +| 4.5.2.3 Detailed behaviour of the PCRF..... | 12 | +| 4.5.3 Final Spending Limit Report Request ..... | 12 | +| 4.5.3.1 General..... | 12 | +| 4.5.3.2 Detailed behaviour of the PCRF ..... | 13 | +| 4.5.3.3 The behaviour of the OCS ..... | 13 | +| 4.5.4 Sy Session Termination by the OCS ..... | 13 | +| 5 Sy protocol..... | 13 | +| 5.1 Protocol support ..... | 13 | +| 5.1.1 Use of Diameter base protocol ..... | 13 | +| 5.1.2 Void ..... | 14 | +| 5.1.3 Accounting functionality ..... | 14 | +| 5.1.4 Transport protocol ..... | 14 | +| 5.1.5 Advertising Application Support..... | 14 | +| 5.1.6 Use of the Supported-Features AVP ..... | 14 | +| 5.2 Initialization and maintenance of connection and session ..... | 15 | +| 5.3 Sy specific AVPs..... | 15 | +| 5.3.0 General ..... | 15 | +| 5.3.1 Policy-Counter-Identifier AVP ..... | 16 | +| 5.3.2 Policy-Counter-Status AVP..... | 16 | +| 5.3.3 Policy-Counter-Status-Report AVP ..... | 16 | +| 5.3.4 SL-Request-Type AVP..... | 16 | +| 5.3.5 Pending-Policy-Counter-Information AVP ..... | 16 | +| 5.3.6 Pending-Policy-Counter-Change-Time AVP ..... | 17 | +| 5.3.7 SN-Request-Type AVP ..... | 17 | +| 5.4 Sy re-used AVPs ..... | 17 | +| 5.5 Sy specific Experimental-Result-Code AVP values ..... | 18 | +| 5.5.1 General ..... | 18 | +| 5.5.2 Permanent Failures ..... | 18 | +| 5.5.3 Transient Failures ..... | 19 | +| 5.6 Sy Messages ..... | 19 | +| 5.6.1 Command-Code Values..... | 19 | +| 5.6.2 Spending-Limit-Request (SLR) command..... | 19 | +| 5.6.3 Spending-Limit-Answer (SLA) command ..... | 20 | + +5.6.4 Spending-Status-Notification-Request (SNR) command..... 20 +5.6.5 Spending-Status-Notification-Answer (SNA) command ..... 20 +5.6.6 Session-Termination-Request (STR) command..... 21 +5.6.7 Session-Termination-Answer (STA) command ..... 21 +**Annex A (normative): User Identity for Fixed Broadband Access network convergence..... 22** +**Annex B (informative): Change history..... 23** + +# --- 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 Sy reference point for the present release. The functional requirements and the stage 2 specifications of the Sy reference point are contained in TS 23.203 [2]. The Sy reference point lies between the Policy and Charging Rule Function (PCRF) and the Online Charging System (OCS). The internal OCS functionality for policy counter provision management pertaining to Sy is specified in TS 32.296 [16]. + +# --- 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.203: "Policy Control and Charging architecture". +- [3] Void. +- [4] IETF RFC 4005: "Diameter Network Access Server Application" +- [5] IETF RFC 4006: "Diameter Credit Control Application". +- [6] IETF RFC 5719: "Updated IANA Considerations for Diameter Command Code Allocations" +- [7] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [8] 3GPP TS 29.213: "Policy and charging control signalling flows and Quality of Service (QoS) parameter mapping". +- [9] Void. +- [10] Void. +- [11] Void. +- [12] Void. +- [13] IETF RFC 791: "Transmission Control Protocol". +- [14] IETF RFC 4960: "Stream Control Transmission Protocol". +- [15] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol". +- [16] 3GPP TS 32.296: "Telecommunication management; charging management; Online Charging System (OCS) applications and interfaces". +- [17] ETSI TS 283 034 v2.2.0: "Telecommunications and Internet converged Services and Protocols for Advanced Networking (TISPAN); Network Attachment Sub-System (NASS); e4 interface based on the DIAMETER protocol". +- [18] IETF RFC 3046: "DHCP Relay Agent Information Option". +- [19] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". + +- [20] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [21] IETF RFC 7944: "Diameter Routing Message Priority". +- [22] IETF RFC 8583: "Diameter Load Information Conveyance". +- [23] IETF RFC 6733: "Diameter Base Protocol". + +# --- 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 TR 21.905 [1]. + +**policy counter:** A mechanism within the OCS to track spending applicable for a subscriber. + +**policy counter identifier:** A reference to a policy counter in the OCS 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. + +**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. + +## 3.2 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]. + +| | | +|------|----------------------------------------------------| +| DRMP | Diameter Routing Message Priority | +| OCS | Online charging system | +| OFCS | Offline charging system | +| PCEF | Policy and Charging Enforcement Function | +| PCRF | Policy and Charging Rule Function | +| RCAF | RAN Congestion Awareness Function | +| SLA | Spending-Limit-Answer (SL-Answer) | +| SLR | Spending-Limit-Request (SL- Request) | +| SNA | Spending-Status-Notification-Answer (SN-Answer) | +| SNR | Spending-Status-Notification-Request (SN- Request) | +| STA | Session-Termination-Answer (ST-Answer) | +| STR | Session-Termination-Request (ST- Request) | + +# --- 4 Sy reference point + +## 4.1 Overview + +The Sy reference point is located between the Policy and Charging Rules Function (PCRF) and the Online Charging System (OCS). The Sy reference point enables transfer of policy counter status information relating to subscriber spending from OCS to PCRF and supports the following functions: + +- Request of policy counter status reporting from PCRF to OCS and subscribe to or unsubscribe from spending limit reports (i.e. notifications of policy counter status changes). +- Notification of spending limit reports from OCS to PCRF. +- Cancellation of spending limit reporting from PCRF to OCS. + +Since the Sy reference point resides between the PCRF and OCS in the HPLMN, roaming with home routed or visited access as well as non-roaming scenarios are supported in the same manner. + +The stage 2 level requirements for the Sy reference point are defined in 3GPP TS 23.203 [2]. + +Signalling flows related to the Sy interface are specified in 3GPP TS 29.213 [8]. + +Refer to Annex G of 3GPP TS 29.213 [8] for Diameter overload control procedures over the Sy interface. + +Refer to Annex J of 3GPP TS 29.213 [8] for Diameter message priority mechanism procedures over the Sy interface. + +Refer to Annex K of 3GPP TS 29.213 [8] for Diameter load control procedures over the Sy interface. + +## 4.2 Sy Reference model + +The Sy reference point is defined between the PCRF and the OCS. The relationships between the involved functional entities are depicted in figure 4.2.1. The overall PCC architecture is depicted in clause 3a of 3GPP TS 29.213 [8] + +![Diagram of the Sy reference model showing PCRF and OCS connected by the Sy interface.](3b621c21b0af3a504a28d2547e87138f_img.jpg) + +The diagram shows two rectangular boxes, one on the left labeled 'PCRF' and one on the right labeled 'OCS'. A horizontal line connects the two boxes. Above the line, centered between the boxes, is the label 'Sy'. There is a small vertical tick mark on the line directly below the 'Sy' label. + +Diagram of the Sy reference model showing PCRF and OCS connected by the Sy interface. + +Figure 4.2.1: Sy reference model + +.Figure 4.2.2: Void + +## 4.3 Subscriber Spending Limits + +Policy decisions based on spending limits is a function that allows the PCRF to make policy decisions based on the status of policy counters that are maintained in the OCS. The PCRF uses the policy counter statuses received from the OCS as input to its policy decisions, e.g. downgrade the QoS (e.g. APN-AMBR) or modify the PCC/QoS/ADC Rules. + +When the status of policy counters is first required to make a policy decision for a subscriber, the PCRF uses the Initial Spending Limit Report Request procedure. The PCRF may request specific or all policy counter statuses to be reported by the OCS for the user. The OCS provides the status to the PCRF of the requested policy counters, and will notify the PCRF of any changes in the status of those policy counters. Optionally, the OCS can provide one or more pending statuses for a requested policy counter with the times that have to be applied. The pending status of a policy counter shall autonomously become the current status of a policy counter at the PCRF when the indicated corresponding time is reached. Subsequently, the provided information for pending statuses of a policy counter shall overwrite the previously received information. + +NOTE 1: The mechanism for provisioning the policy counters in the OCS is out of scope of this document. + +NOTE 2: A policy counter in the OCS can represent the spending for one or more services, one or more devices, one or more subscribers, etc. The representation is operator dependent. There is no explicit relationship between Charging-Key and policy counter. + +The PCRF may request reporting for specific policy counter(s) that it is not currently subscribed and/or cancel reporting for specific policy counter status(es) using the Intermediate Spending Limit Report Request. The PCRF may cancel spending limit reporting for all policy counter(s) using the Final Spending Limit Report Request. + +The updated subscriber profile may also trigger the PCRF sending the Initial/Intermediate/Final Spending Limit Report Request to the OCS to subscribe and/or cancel reporting for policy counter status(es). If spending limit reporting for a policy counter is enabled, the OCS shall notify the PCRF of changes in the status of this policy counter (e.g. daily spending limit of \$2 reached) and optionally pending statuses of this policy counter with the activation time (e.g. due to a billing period that will expire at midnight). + +## 4.4 Functional elements + +### 4.4.1 PCRF + +The Policy Control and Charging Rules Function (PCRF) is a functional element that encompasses policy control decision and flow based charging control functionalities. + +The PCRF may take information on the subscriber's spending status into account in its policy decisions. The PCRF may request spending limit reporting for policy counters from the OCS using the Initial or Intermediate Spending Limit Report Request procedure as specified in clause 4.5.1. The PCRF may cancel spending limit reporting for specific policy counter(s) using the Intermediate Spending Limit Report Request procedure, or for all policy counter(s) using the Final Spending Limit Report Request procedure as specified in clause 4.5.3. + +The PCRF shall have at least one active IP-CAN session to be able to initiate an Sy session to be used when required for spending limit reporting for that subscriber. The PCRF shall terminate the Sy session when the last IP-CAN session for that subscriber is terminated or no IP-CAN session for the same user depends on the spending status information provided over Sy reference point. + +The PCRF may use the status of each relevant policy counter as input to its policy decision as required by the decision logic. + +### 4.4.2 OCS + +The Online Charging System (OCS), for the purpose of policy decisions based on the subscriber's spending, shall: + +- maintain the policy counter statuses applicable for a subscriber. +- report the policy counter status values for the subscriber when requested to the PCRF. +- when a policy counter status changes, report the change to the PCRF. + +## 4.5 Spending Limits procedures over Sy reference point + +### 4.5.1 Initial/Intermediate Spending Limit Report Request + +#### 4.5.1.1 General + +This procedure shall be used by the PCRF to request the status of policy counters available at the OCS, and to subscribe or unsubscribe to updates of policy counters by the OCS. + +This procedure is mapped to the Spending-Limit-Request/Answer commands specified in clause 5.6. + +**Table 4.5.1.1/1: Initial/Intermediate Spending Limit Report Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------|---------------------------------------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity | Subscription-Id, Logical-Access-ID AVP, Physical-Access-ID (NOTE 1) | C | This IE shall contain the identity of the user. It shall be present in the initial request when the SL-Request-Type=INITIAL_REQUEST. | +| Request Type | SL-Request-Type | M | This IE shall indicate whether this is the initial or a subsequent request for the user. | +| Subscribed Policy Counter Identifier List | Policy-Counter-Identifier | O | This IE shall indicate the list of policy counter identifiers to be subscribed to. In the intermediate spending limit report request procedure, this list overrides a previously provisioned list. If omitted in either the Initial or Intermediate Spending Limit Report Request procedures the PCRF requests subscription to all available policy counters. | + +NOTE 1: The Logical-Access-ID AVP and Physical-Access-ID AVP are only applicable to Fixed Broadband Access network convergence as defined in annex A. + +**Table 4.5.1.1/2: Initial/Intermediate Spending Limit Report Response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------|------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Policy Counter Status Report | Policy-Counter-Status-Report | O | If present, this information element shall contain a policy counter identifier, the current status value and if applicable pending policy counter statuses with the activation times. | +| Result | Result-Code or Experimental-Result | M | This IE shall contain the result of the operation. | + +#### 4.5.1.2 Detailed behaviour of the PCRF + +The PCRF shall make use of this procedure when it determines for a subscriber that + +- The status of policy counter(s) to which the PCRF does not have an existing subscription for status change notifications is/are required. +- The status of one or more, but not all, policy counter(s) to which the PCRF has an existing subscription for status change notifications are no longer required. + +NOTE: The Final Spending Limit Request procedure in clause 4.5.3 is used to remove all subscriptions. + +In the initial request, i.e. when the request is sent for the first time for the Subscriber, the PCRF shall set the SL-Request-Type AVP to the value INITIAL\_REQUEST (0). For subsequent requests for the same Subscriber, the PCRF shall set the SL-Request-Type AVP to INTERMEDIATE\_REQUEST (1). + +For each policy counter that the PCRF requires the current status and notifications of future status changes, the PCRF shall indicate the concerned policy counter identifiers in the request. Alternatively, the policy counter identifiers may be omitted if the PCRF requires the current status and notifications of future status changes of all available policy counters. + +#### 4.5.1.3 The behaviour of the OCS + +Upon reception of the request from the PCRF, the OCS shall check if there is an ongoing Sy session associated with the received Session-Id AVP. If there is no Sy session and the SL-Request-Type AVP is set to INITIAL\_REQUEST (0), an Sy session is created on the OCS. If there is an Sy session and the SL-Request-Type AVP is not set to INTERMEDIATE\_REQUEST (1), the OCS shall return a response with the Result-Code set to DIAMETER\_INVALID\_AVP\_VALUE and with the Failed-AVP AVP containing the SL-Request-Type AVP. If there is no Sy session and the SL-Request-Type AVP is not set to INITIAL\_REQUEST (0), the OCS shall return a response with the Result-Code AVP set to DIAMETER\_UNKNOWN\_SESSION\_ID. + +Upon reception of the request from the PCRF provided with explicit Policy Counter Identifier(s): + +If all the policy counter identifiers are known to the OCS, the OCS shall be able to subsequently notify the PCRF of any policy counter state changes and/or additions, removal or changes of pending policy counter statuses along with their activation time. + +If a policy counter identifier is known by the OCS, but is not applicable to the subscriber (e.g. not provisioned), the OCS may use an operator configured policy counter status to indicate this to the PCRF. + +If the OCS is configured to accept the request provided with unknown policy counter identifier(s), and if the OCS determines that one or more policy counter identifiers are unknown, an operator configured policy counter status may be used to indicate the policy counter identifier(s) determined as unknown by OCS. The status of known policy counter identifier(s) shall be returned to the PCRF in the same procedure in this case. + +Alternatively, if the OCS is configured to reject the request provided with unknown policy counter identifier(s), and if the OCS determines that one or more policy counter identifiers are unknown, the OCS shall return a response with the Experimental-Result-Code AVP set to DIAMETER\_ERROR\_UNKNOWN\_POLICY\_COUNTERS and with the Failed-AVP AVP indicating the unknown policy counter identifiers. When this failure occurs, if the SL-Request-Type AVP is set to: + +- INITIAL\_REQUEST (0), then the Sy session is not created. +- INTERMEDIATE\_REQUEST (1), then none of the changes in the request take effect but the Sy session is maintained. + +NOTE 1: In order to avoid misbehaviors due to the policy counters maintained in the Sy session, the PCRF can terminate the Sy session invoking the Final Spending Limit Request procedure in clause 4.5.3. + +When the PCRF provides a new subscribed policy counter identifier list, the OCS shall remove any policy counter identifiers no longer in the list from association with the Sy session such that the OCS will no longer notify the PCRF of those policy counter state changes. + +If an initial or intermediate request contains no policy counter identifiers, the OCS shall subsequently notify the PCRF of all available policy counter state changes and optionally the pending policy counter statuses with the activation times. If the OCS has no available policy counters for that subscriber during the Initial Spending Limit Report Request procedure, it sets the Experimental-Result-Code to DIAMETER\_ERROR\_NO\_AVAILABLE\_POLICY\_COUNTERS. When this failure occurs, if the SL-Request-Type AVP is set to: + +- INITIAL\_REQUEST (0), then the Sy session is not created. +- INTERMEDIATE\_REQUEST (1), then none of the changes in the request take effect but the Sy session is maintained. + +NOTE 2: The PCRF can terminate the Sy session invoking the Final Spending Limit Request procedure in clause 4.5.3, or maintain the Sy session assuming that further available policy counters will be notified. + +If the user identified in an initial request is not known to the OCS, the OCS shall reject the Spending Limit Report Request by including the result code of DIAMETER\_USER\_UNKNOWN in the Spending Limit Report Answer. In this case, the Sy session is not created. + +Upon successful creation of an Sy session, the OCS shall include the current status of all subscribed policy counters (if any) in the response and set the Result-Code to DIAMETER\_SUCCESS. + +### 4.5.2 Spending Limit Report + +#### 4.5.2.1 General + +This procedure shall be used by the OCS to notify the PCRF of changes in the status of subscribed policy counter(s). + +This procedure is mapped to the Spending-Status-Notification-Request /Answer commands specified commands specified in clause 5.6. + +**Table 4.5.2.1/1: Spending Limit Report Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------|------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Policy Counter Status Report | Policy-Counter-Status-Report | M | If present, this information element shall contain a policy counter identifier, the current status value and if applicable pending policy counter statuses with the activation times. | + +**Table 4.5.2.1/2: Spending Limit Report Response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|------------------------------------|------|----------------------------------------------------| +| Result | Result-Code or Experimental-Result | M | This IE shall contain the result of the operation. | + +#### 4.5.2.2 The behaviour of the OCS + +When the status of a specific policy counter changes or when pending statuses associated with the policy counter are added, removed or changed, 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 a Spending-Status-Notification-Request command including the current policy counter status, and if applicable pending policy counter statuses with the activation times to the PCRF associated with each affected Sy session. The OCS shall not send the policy counter status for the same policy counter until it received the response of the previous status report of the policy counter. + +If several policy counters change status at the same time, the OCS may group the status change notifications into a single Spending-Status-Notification-Request command to the PCRF by sending multiple Policy-Counter-Status-Report AVPs in the request. + +#### 4.5.2.3 Detailed behaviour of the PCRF + +The PCRF shall acknowledge the request by sending a response 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. + +NOTE: The values related to the status of a policy counter (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the values are out of scope of 3GPP. + +The PCRF shall ignore an unknown policy counter status report for all unknown policy counter identifiers in an SLA or in an SNR from the OCS. + +If the PCRF receives an SNR command while it has an ongoing SLR transaction with the OCS, the PCRF shall update the policy counter information based on the SNR command. When the corresponding SLA command for the ongoing SLR transaction is eventually received, the PCRF shall only update policy counter information for counters that were not provided in the previously received SNR command. + +If the PCRF receives a Policy-Counter-Status-Report with one or more Pending-Policy-Counter-Information AVPs, then at the time defined by the Pending-Policy-Counter-Change-Time AVP, the pending Policy-Counter-Status shall autonomously become the current status of a policy counter. Subsequently provided information for pending statuses of a policy counter shall overwrite the previously received information. If the pending policy counter statuses are applicable to a policy counter identifier but the Pending-Policy-Counter-Information AVPs are omitted in the new policy counter status report, the PCRF shall remove all the pending policy counter statuses. + +### 4.5.3 Final Spending Limit Report Request + +#### 4.5.3.1 General + +This procedure shall be used by the PCRF to unsubscribe to any future updates of policy counters for a given subscriber by the OCS. + +This procedure is mapped to the Session-Termination-Request/Answer commands specified in IETF RFC 6733 [23]. + +**Table 4.5.3.1/1: Final Spending Limit Report Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|--------------------------------------------------------------------------------------------------------| +| Termination Cause | Termination-Cause | M | This IE shall contain the reason why the session was terminated. It shall be set to "DIAMETER_LOGOUT". | + +**Table 4.5.3.1/2: Final Spending Limit Report Response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-------------------------|------|----------------------------------------------------| +| Result | Result-Code | M | This IE shall contain the result of the operation. | + +#### 4.5.3.2 Detailed behaviour of the PCRF + +When 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 notifications, the PCRF shall send the Final Spending Limit Report Request to the OCS. + +#### 4.5.3.3 The behaviour of the OCS + +Upon reception of the request from the PCRF, the OCS shall check that there is an ongoing Sy session associated with the received Session-Id AVP. If there is no Sy session, the OCS shall return a response with the Result-Code AVP set to DIAMETER\_UNKNOWN\_SESSION\_ID. + +The OCS shall remove all policy counter subscriptions associated with the Sy session such that the OCS will no longer notify the PCRF of policy counter state changes and close the session by returning a response with the Result-Code AVP set to DIAMETER\_SUCCESS. + +### 4.5.4 Sy Session Termination by the OCS + +If the ASR feature is supported, and the OCS decides that the Sy session for a subscriber needs to be terminated (e.g. because subscriber is removed from an OCS system), the OCS shall send the Spending-Status-Notification-Request (SNR) containing the SN-Request-Type AVP with bit 1 (Abort Session Request) set to the PCRF. + +Upon receipt of the SNR containing the SN-Request-Type AVP with bit 1 set, the PCRF shall acknowledge the receipt of the SNR by sending the Spending-Status-Notification-Answer (SNA) and shall then send a Final Spending Limit Report Request as specified in clause 4.5.3. + +NOTE: The termination of the Sy session causes the H-PCRF to make the applicable policy decision and act accordingly, i.e. sessions on other interfaces such as the Rx or Gx interface will remain established, unless the policy decision causes their termination. + +# 5 Sy protocol + +## 5.1 Protocol support + +### 5.1.1 Use of Diameter base protocol + +The Diameter Base Protocol as specified in IETF RFC 6733 [23] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +With regard to the Diameter protocol defined over the Sy interface, the OCS acts as a Diameter server, in the sense that it is the network element that handles policy counter status requests for a particular realm. The PCRF acts as the Diameter client, in the sense that it is the network element requesting policy counter status to the OCS. + +A Diameter routing table entry can have a different destination based on the application identifier of the command. The application identifier stored in the command header must match the value of any application identifier AVPs in the command body. Diameter agents (relay, proxy, redirection, translation agents) should use the application identifier in the command header to route to a suitable destination. + +### 5.1.2 Void + +### 5.1.3 Accounting functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the Sy interface. + +### 5.1.4 Transport protocol + +Diameter messages over the Sy interface shall make use of TCP IETF RFC 791 [13] or SCTP IETF RFC 4960 [14]. + +### 5.1.5 Advertising Application Support + +The Diameter application identifier assigned to the Sy interface application is 16777302. + +The PCRF and OCS shall advertise support of the Diameter Sy Application by including the value of the Sy application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [23]. + +### 5.1.6 Use of the Supported-Features AVP + +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 Sy 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 TS 29.229 [15]. + +The base functionality for the Sy 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 Sy commands. As defined in clause 7.1.1 of TS 29.229 [15], 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 TS 29.229 [15], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the Sy 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 Sy 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 TS 29.229 [15]. The following exceptions apply to the initial SLR/SLA command pair: + +- If the PCRF supports any supported features defined for Sy, the SLR shall include the features supported by the PCRF within Supported-Features AVP(s) with the 'M' bit cleared. + +NOTE 2: One instance of Supported-Features AVP is needed per Feature-List-ID. + +- If the SLR command does not contain any Supported-Features AVP(s) and the OCS supports no supported features defined for Sy functionality, the OCS shall not include the Supported-Features AVP in the SLA command. In this case, both PCRF and OCS shall not use any supported features defined for Sy. + +Once the PCRF and OCS 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 Sy interface for the feature list with a Feature-List-ID of 1. + +**Table 5.1.6-1: Features of Feature-List-ID 1 used on the Sy interface** + +| Feature bit | Feature | M/O | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|-----|----------------------------------------------------------------| +| 0 | ASR | O | Sy Session Termination by the OCS as specified in clause 4.5.4 | +| 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.2 Initialization and maintenance of connection and session + +The Diameter protocol between the PCRF and the OCS, shall always keep the session state, and use the same Session-Id parameter for the lifetime of each Diameter session. + +Each Diameter session shall identify a Sy session for a given user. In order to indicate that the session state is to be maintained, the Diameter client and server shall not include the Auth-Session-State AVP, either in the request or in the response messages (see IETF RFC 6733 [23]). + +The PCRF shall link the Gx session(s) or S9 session with the Sy session at Sy session initialization and maintain that until the IP-CAN session(s) for that subscriber are terminated or no IP-CAN session for the same user depends on the spending status information provided over Sy reference point. + +## 5.3 Sy specific AVPs + +### 5.3.0 General + +Table 5.3.0.1 describes the Diameter AVPs defined for the Sy reference point, their AVP Code values, types and possible flag values. The Vendor-Id header of all AVPs defined in the present document shall be set to 3GPP (10415). + +**Table 5.3.0.1: Sy specific Diameter AVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules (Note 1) | | | | Applicability (Note 2) | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|----------------|------------|-------------------------|-----|------------|----------|------------------------| +| | | | | Must | May | Should not | Must not | | +| Pending-Policy-Counter-Information | 2905 | 5.3.5 | Grouped | M,V | P | | | | +| Pending-Policy-Counter-Change-Time | 2906 | 5.3.6 | Time | M,V | P | | | | +| Policy-Counter-Identifier | 2901 | 5.3.1 | UTF8String | M,V | P | | | | +| Policy-Counter-Status | 2902 | 5.3.2 | UTF8String | M,V | P | | | | +| Policy-Counter-Status-Report | 2903 | 5.3.3 | Grouped | M,V | P | | | | +| SL-Request-Type | 2904 | 5.3.4 | Enumerated | M,V | P | | | | +| SN-Request-Type | 2907 | 5.3.7 | Unsigned32 | V | P | | M | ASR | +| 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 [23]. | | | | | | | | | +| NOTE 2: AVPs marked with a supported feature are applicable as described in clause 5.1.6. | | | | | | | | | + +### 5.3.1 Policy-Counter-Identifier AVP + +The Policy-Counter-Identifier AVP (AVP code 2901) is of type UTF8String, and it uniquely identifies a policy counter that is maintained per subscriber within the OCS. + +### 5.3.2 Policy-Counter-Status AVP + +The Policy-Counter-Status AVP (AVP code 2902) is of type UTF8String, and identifies the policy counter status applicable for a specific policy counter and subscriber. + +NOTE: The valid values for the Policy-Counter-Status AVP are specific for each Policy-Counter-Identifier value. + +The values (e.g. valid, invalid or any other status) are not specified. The interpretation and actions related to the defined values are out of scope of 3GPP. + +### 5.3.3 Policy-Counter-Status-Report AVP + +The Policy-Counter-Status-Report AVP (AVP code 2903) is of type Grouped. It is used by the OCS to report the status of a specific policy counter. + +Associated pending policy counter statuses shall always be provided within Pending-Policy-Counter-Information AVPs if the pending policy counter statuses are applicable to the policy counter identifier. If there are no Pending-Policy-Counter-Information AVPs provided within the Policy-Counter-Status-Report AVP, previously provided pending counter statuses are removed. In addition, newly provided pending policy counter statuses overwrite previously provided ones. + +AVP Format: + +``` +Policy-Counter-Status-Report ::= < AVP Header: 2903 > + { Policy-Counter-Identifier } + { Policy-Counter-Status } + *[ Pending-Policy-Counter-Information ] + *[ AVP ] +``` + +### 5.3.4 SL-Request-Type AVP + +The SL-Request-Type AVP (AVP code 2904) is of type Enumerated, and informs the OCS whether the SLR command is being sent as part of the initial or intermediate spending limit report request procedure. + +The following values are defined: + +INITIAL\_REQUEST (0) + +This value indicates that this is the first request in the Diameter session. + +INTERMEDIATE\_REQUEST (1) + +This value indicates that this is the second or subsequent request in the Diameter session. + +### 5.3.5 Pending-Policy-Counter-Information AVP + +The Pending-Policy-Counter-Information AVP (AVP code 2905) is of type Grouped, which contains the pending policy counter status and the active time. If multiple pending policy counter AVPs are included, they shall be sorted in order of change time. + +AVP Format: + +``` +Pending-Policy-Counter-Information ::= < AVP Header: 2905 > + { Policy-Counter-Status } + { Pending-Policy-Counter-Change-Time } + *[ AVP ] +``` + +NOTE: The valid values for the Pending-Policy-Counter-Information AVP are specific for each Policy-Counter-Identifier value. + +### 5.3.6 Pending-Policy-Counter-Change-Time AVP + +The Pending-Policy-Counter-Change-Time AVP (AVP code 2906) is of type Time. This value indicates the NTP time at which the pending policy counter status becomes the current status of a policy counter. + +### 5.3.7 SN-Request-Type AVP + +The SN-Request-Type AVP (AVP code 2907) shall be of type Unsigned32 and shall contain a bit mask, and informs the PCRF about the type of the Spending-Status-Notification-Request (SNR). 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 following values are defined, and multiple bits may be set in combination: + +**Table 5.3.7-1: SN-Request-Type AVP** + +| Bit | Name | Description | +|-----|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Normal Request | This bit, when set, indicates that the SNR is used only to convey a spending limit report as detailed in clause 4.5.2. This shall be the default value that applies when the SN-Request-Type AVP is not included in an SNR. | +| 1 | Abort Session Request | This bit, when set, indicates that the SNR is used to request the termination of the Sy session as detailed in clause 4.5.4 | + +## 5.4 Sy re-used AVPs + +Table 5.4 lists the Diameter AVPs re-used by the Sy reference point from existing Diameter Applications, reference to their respective specifications and a short description of their usage within the Sy 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, but they are re-used for the Sy reference point. 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 [4] with the exception that the 'M' flag shall be set and the 'P' flag may be set. + +**Table 5.4: Sy re-used Diameter AVPs** + +| Attribute Name | Reference | Description | +|-----------------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DRMP | IETF RFC 7944 [21] | Allows Diameter endpoints to indicate the relative priority of Diameter transactions. | +| Subscription-Id | IETF RFC 4006 [5] | The identification of the subscription (IMSI, MSISDN, etc) | +| Load | IETF RFC 8583 [22] | 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. | +| Logical-Access-ID | ETSI TS 283 034 [17] | Contains a Circuit-ID (as defined in IETF RFC 3046 [18]). The Logical Access ID may explicitly contain the identity of the Virtual Path and Virtual Channel carrying the traffic. Applicable only for Fixed Broadband Access network convergence as defined in annex A.
This AVP shall have the 'M' bit cleared. | +| OC-OLR | IETF 7683 [20] | Contains the necessary information to convey an overload report. | +| OC-Supported-Features | IETF 7683 [20] | Defines the support for the Diameter overload indication conveyance by the sending node. | +| Physical-Access-ID | ETSI TS 283 034 [17] | Identifies the physical access to which the user equipment is connected. Includes a port identifier and the identity of the access node where the port resides. Applicable only for Fixed Broadband Access network convergence as defined in annex A.
This AVP shall have the 'M' bit cleared. | +| Supported-Features | 3GPP TS 29.229 [15] | If present in a request, this AVP informs the destination host about the features that the origin host supports. If present in an answer, this AVP informs the destination host about common features with the origin host. | + +## 5.5 Sy specific Experimental-Result-Code AVP values + +### 5.5.1 General + +IETF RFC 6733 [23] 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). + +### 5.5.2 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request failed, and the request should not be attempted again. + +The Result-Code AVP values defined in Diameter base protocol IETF RFC 6733 [23] are applicable. Also, the following Result-Code AVP value defined in IETF RFC 4006 [5] is applicable: + +DIAMETER\_USER\_UNKNOWN (5030) + +This error shall be used by the OCS to indicate to the PCRF that the end user specified in the request is unknown to the OCS and that the Sy session cannot be created. + +The following specific Sy Experimental-Result-Code value is defined for permanent failures: + +DIAMETER\_ERROR\_UNKNOWN\_POLICY\_COUNTERS (5570) + +This error shall be used by the OCS to indicate to the PCRF that the OCS does not recognize one or more Policy Counters specified in the request, when the OCS is configured to reject the request provided with unknown policy counter identifier(s). + +### 5.5.3 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 protocol IETF RFC 6733 [23] are applicable. Also the following specific Sy Experimental-Result-Code value is defined for transient failures: + +DIAMETER\_ERROR\_NO\_AVAILABLE\_POLICY\_COUNTERS (4241) + +This error shall be used by the OCS to indicate to the PCRF that the OCS has no available policy counters for the subscriber. + +The PCRF may retry the request based on local configuration or operator policy on receipt of a transient failure. + +## 5.6 Sy Messages + +### 5.6.1 Command-Code Values + +This clause defines the Command-Code values for the Sy interface application as allocated by IANA from the vendor-specific namespace defined in IETF RFC 5719 [6]. Every command is defined by means of the ABNF syntax IETF RFC 2234 [7], according to the rules in IETF RFC 6733 [23]. + +The following Command Codes are defined in this specification: + +**Table 5.6.1: Command-Code values for Sy** + +| Command-Name | Abbreviation | Code | Section | +|--------------------------------------|--------------|---------|---------| +| Spending-Limit-Request | SLR | 8388635 | 5.6.2 | +| Spending-Limit-Answer | SLA | 8388635 | 5.6.3 | +| Spending-Status-Notification-Request | SNR | 8388636 | 5.6.4 | +| Spending-Status-Notification-Answer | SNA | 8388636 | 5.6.5 | + +In addition, the Session-Termination-Request and Session-Termination-Answer commands are reused from IETF RFC 6733 [23]. + +For the commands defined in this specification and reused commands, the Application-ID field shall be set to 16777302. + +### 5.6.2 Spending-Limit-Request (SLR) command + +The SLR command, indicated by the Command-Code field set to 8388635 and the 'R' bit set in the Command Flags field, is sent by the PCRF to the OCS as part of the Initial or Intermediate Spending Limit Report Request procedure. + +Message Format: + +``` + ::= + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + [ Destination-Host ] + [ Origin-State-Id ] + [ OC-Supported-Features ] + * [ Supported-Features ] + { SL-Request-Type } + * [ Subscription-Id ] + * [ Policy-Counter-Identifier ] + [ Logical-Access-ID ] + [ Physical-Access-ID ] + * [ Proxy-Info ] + * [ Route-Record ] + * [ AVP ] +``` + +NOTE: Multiple instances of the Subscription-Id AVP in the SLR command correspond to multiple types of identifier for the same subscriber, for example IMSI and MSISDN. + +### 5.6.3 Spending-Limit-Answer (SLA) command + +The SLA command, indicated by the Command-Code field set to 8388635 and the 'R' bit cleared in the Command Flags field, is sent by the OCS to the PCRF as part of the Initial or Intermediate Spending Limit Report Request procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388635, PXY > + < Session-Id > + [ DRMP ] + { Auth-Application-Id } + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] + [ OC-Supported-Features ] + [ OC-OLR ] + * [ Supported-Features ] + * [ Policy-Counter-Status-Report ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Origin-State-Id ] + * [ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + * [ Proxy-Info ] + * [ Load ] + * [ AVP ] +``` + +### 5.6.4 Spending-Status-Notification-Request (SNR) command + +The SNR command, indicated by the Command-Code field set to 8388636 and the 'R' bit set in the Command Flags field, is sent by the OCS to the PCRF as part of the Spending Limit Report procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388636, REQ, PXY > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + { Destination-Realm } + { Destination-Host } + { Auth-Application-Id } + [ Origin-State-Id ] + [ OC-Supported-Features ] + * [ Policy-Counter-Status-Report ] + [ SN-Request-Type ] + * [ Proxy-Info ] + * [ Route-Record ] + * [ AVP ] +``` + +### 5.6.5 Spending-Status-Notification-Answer (SNA) command + +The SNA command, indicated by the Command-Code field set to 8388636 and the 'R' bit cleared in the Command Flags field, is sent by the PCRF to the OCS as part of the Spending Limit Report procedure. + +Message Format: + +``` + ::= < Diameter Header: 8388636, PXY > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Experimental-Result ] +``` + +``` +[ Origin-State-Id ] +[ OC-Supported-Features ] +[ OC-OLR ] +[ Error-Message ] +[ Error-Reporting-Host ] +*[ Redirect-Host ] +[ Redirect-Host-Usage ] +[ Redirect-Max-Cache-Time ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ AVP ] +``` + +### 5.6.6 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 PCRF to the OCS as part of the Final Spending Limit Report Request procedure. + +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 ] + [ Origin-State-Id ] + *[ Proxy-Info ] + *[ Route-Record ] + *[ AVP ] +``` + +### 5.6.7 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 OCS to the PCRF as part of the Final Spending Limit Report Request procedure. + +Message Format: + +``` + ::= < Diameter Header: 275, PXY > + < Session-Id > + [ DRMP ] + { Origin-Host } + { Origin-Realm } + [ Result-Code ] + [ Error-Message ] + [ Error-Reporting-Host ] + [ Failed-AVP ] + [ Origin-State-Id ] + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Redirect-Host ] + [ Redirect-Host-Usage ] + [ Redirect-Max-Cache-Time ] + *[ Proxy-Info ] + *[ Load ] + *[ AVP ] +``` + +# --- Annex A (normative): User Identity for Fixed Broadband Access network convergence + +In the Fixed Broadband Access network convergence scenario, the User Identity refers to the Subscriber Identifier as defined in TS 29.212 [19] Annex G.5.1.6. + +If the User Identity is the Access Line Identifier, the Logical-Access-ID AVP and Physical-Access-ID AVP are included in the SLR command instead of the Subscription-Id AVP. + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------|-----------|------|-----|-----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|--------| +| Date | TSG # | TSG Doc. | CR | Rev | Subject/Comment | Old | New | +| 2014-12 | TSG#66 | CP-140922 | 020 | 2 | Update PCC architecture diagrams to include Np reference point | 12.2.0 | 13.0.0 | +| 2015-06 | TSG#68 | CP-150342 | 0023 | 1 | Notify a pending policy counter status change | 13.0.0 | 13.1.0 | +| 2015-06 | TSG#68 | CP-150342 | 0026 | 1 | Correction to pending policy counters status report | 13.0.0 | 13.1.0 | +| 2015-06 | TSG#68 | CP-150342 | 0029 | 5 | Including the Supported-Features AVP | 13.0.0 | 13.1.0 | +| 2015-06 | TSG#68 | CP-150348 | 0031 | 1 | Usage of AVPs related to user identity for convergence scenario | 13.0.0 | 13.1.0 | +| 2015-06 | TSG#68 | CP-150360 | 0032 | 1 | Diameter overload control over Sy | 13.0.0 | 13.1.0 | +| 2015-06 | TSG#68 | CP-150363 | 0034 | 1 | Correcting Hanging Paragraphs | 13.0.0 | 13.1.0 | +| 2015-12 | TSG#70 | CP-150797 | 0040 | 1 | Update the PCC architecture figures in 29.219 | 13.1.0 | 13.2.0 | +| 2015-12 | TSG#70 | CP-150630 | 0041 | 1 | Update draft-ietf-dime-ovli reference to RFC 7683 | 13.1.0 | 13.2.0 | +| 2015-12 | TSG#70 | CP-150788 | 0042 | 3 | Sy interface impacts for Race condition handling | 13.1.0 | 13.2.0 | +| 2015-12 | TSG#70 | CP-150788 | 0046 | 2 | Correction text for the use of the Spending-Status-Notification-Request (SNR) command on the Sy reference point | 13.1.0 | 13.2.0 | +| Change history | | | | | | | | +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2016-03 | TSG#71 | CP-160093 | 0047 | 2 | B | Diameter Message Priority over Sy interface | 13.3.0 | +| 2016-12 | TSG#74 | CP-160614 | 0052 | - | F | Change IETF drmp draft version to official RFC 7944 | 13.4.0 | +| 2016-12 | TSG#74 | CP-160615 | 0051 | 2 | B | Diameter Load Control Mechanism | 14.0.0 | +| 2016-12 | TSG#74 | CP-160616 | 0053 | 1 | F | Diameter base protocol specification update | 14.0.0 | +| 2017-03 | TSG#75 | CP-170076 | 0055 | 1 | F | Update instance number for the Failed-AVP in answer commands | 14.1.0 | +| 2017-06 | TSG#76 | CP-171119 | 0057 | 1 | F | Reference update for draft-ietf-dime-load | 14.2.0 | +| 2017-09 | TSG#77 | CP-172054 | 0062 | 2 | B | Enhancement on Sy reference point | 15.0.0 | +| 2018-03 | TSG#79 | CP-180049 | 0063 | 2 | F | Supported-Features AVP missing in SLR/SLA's ABNF | 15.1.0 | +| 2019-06 | TSG#84 | CP-191093 | 0073 | 1 | A | Correction of OCS behaviour for unknown and unavailable Policy Counters | 15.2.0 | +| 2019-09 | TSG#85 | CP-192154 | 0075 | 1 | A | draft-ietf-dime-load published as RFC 8583 | 15.3.0 | +| 2020-07 | SA#88e | - | - | - | | Update to Rel-16 version (MCC) | 16.0.0 | +| 2022-03 | SA#95e | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 | +| 2024-03 | SA#103 | - | - | - | | Update to Rel-18 version (MCC) | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29228/raw.md b/marked/Rel-18/29_series/29228/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ebe627d08a25217c6e8130190cd7195126108ce9 --- /dev/null +++ b/marked/Rel-18/29_series/29228/raw.md @@ -0,0 +1,2614 @@ + + +# 3GPP TS 29.228 V18.0.0 (2024-03) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; IP Multimedia (IM) Subsystem Cx and Dx interfaces; Signalling flows and message contents (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. + +© 2022, 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 ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 10 | +| 4 Main Concept..... | 11 | +| 5 General Architecture ..... | 11 | +| 5.1 Functional requirements of network entities ..... | 11 | +| 5.1.1 Functional requirements of P-CSCF ..... | 11 | +| 5.1.2 Functional requirements of I-CSCF ..... | 11 | +| 5.1.3 Functional requirements of S-CSCF ..... | 11 | +| 5.1.4 Functional requirements of HSS ..... | 11 | +| 5.1.5 Functional classification of Cx interface procedures ..... | 11 | +| 5.1.6 Functional Requirements of the Presentity Presence Proxy..... | 12 | +| 6 Procedure Descriptions ..... | 12 | +| 6.1 Location management procedures..... | 13 | +| 6.1.1 User registration status query ..... | 13 | +| 6.1.1.1 Detailed behaviour..... | 14 | +| 6.1.2 S-CSCF registration/deregistration notification ..... | 16 | +| 6.1.2.1 Detailed behaviour..... | 20 | +| 6.1.3 Network initiated de-registration by the HSS, administrative..... | 25 | +| 6.1.3.1 Detailed behaviour..... | 26 | +| 6.1.4 User location query..... | 28 | +| 6.1.4.1 Detailed behaviour..... | 29 | +| 6.2 User data handling procedures..... | 30 | +| 6.2.1 User Profile download..... | 30 | +| 6.2.2 HSS initiated update of User Information ..... | 30 | +| 6.2.2.1 Detailed behaviour..... | 32 | +| 6.3 Authentication procedures..... | 33 | +| 6.3.1 Detailed behaviour..... | 36 | +| 6.4 User identity to HSS resolution..... | 37 | +| 6.5 Implicit registration ..... | 38 | +| 6.5.1 S-CSCF initiated procedures ..... | 38 | +| 6.5.1.1 Registration..... | 38 | +| 6.5.1.2 De-registration ..... | 38 | +| 6.5.1.3 Authentication..... | 38 | +| 6.5.1.4 Downloading the user profile ..... | 38 | +| 6.5.1.5 Initiation of a session to a non-registered user ..... | 39 | +| 6.5.2 HSS initiated procedures ..... | 39 | +| 6.5.2.1 Update of User Profile ..... | 39 | +| 6.5.2.2 De-registration ..... | 39 | +| 6.5.2.3 Update of the Charging information..... | 39 | +| 6.5.2.4 Update of the SIP Digest Authentication Data ..... | 39 | +| 6.5.2.5 Update of the Allowed WAF and/or WWSF Identities ..... | 40 | +| 6.6 Download of the Relevant User Profile and Charging Information and Allowed WAF and/or WWSF Identities..... | 40 | +| 6.6.1 HSS initiated update of User Profile ..... | 40 | +| 6.6.2 S-CSCF operation..... | 40 | +| 6.7 S-CSCF Assignment ..... | 40 | +| 7 Information element contents..... | 43 | +| 7.1 Visited Network Identifier ..... | 43 | +| 7.2 Public User Identity..... | 43 | + +| | | | +|---------|------------------------------------------------|----| +| 7.2a | Public Service Identity ..... | 43 | +| 7.2b | Wildcarded Public Identity..... | 43 | +| 7.2c | Void..... | 43 | +| 7.3 | Private User Identity..... | 43 | +| 7.3a | Private Service Identity ..... | 43 | +| 7.4 | S-CSCF Name..... | 43 | +| 7.4a | AS Name ..... | 43 | +| 7.5 | S-CSCF Capabilities ..... | 44 | +| 7.6 | Result..... | 44 | +| 7.7 | User Profile ..... | 44 | +| 7.8 | Server Assignment Type..... | 44 | +| 7.9 | Authentication Data..... | 44 | +| 7.9.1 | Item Number..... | 44 | +| 7.9.2 | Authentication Scheme..... | 44 | +| 7.9.3 | Authentication Information ..... | 44 | +| 7.9.4 | Authorization Information..... | 44 | +| 7.9.5 | Confidentiality Key ..... | 44 | +| 7.9.6 | Integrity Key..... | 45 | +| 7.9.7 | Authentication Context..... | 45 | +| 7.9.8 | Digest Authenticate ..... | 45 | +| 7.9.8.1 | Digest Realm..... | 45 | +| 7.9.8.2 | Void ..... | 45 | +| 7.9.8.3 | Digest Algorithm ..... | 45 | +| 7.9.8.4 | Digest QoP..... | 45 | +| 7.9.8.5 | Digest HA1 ..... | 45 | +| 7.9.8.6 | Alternate Digest Algorithm ..... | 45 | +| 7.9.8.7 | Alternate Digest HA1 ..... | 45 | +| 7.9.9 | Line Identifier ..... | 45 | +| 7.9.10 | Framed IP Address ..... | 46 | +| 7.9.11 | Framed IPv6 Prefix..... | 46 | +| 7.9.12 | Framed Interface Id ..... | 46 | +| 7.10 | Number Authentication Items ..... | 46 | +| 7.11 | Reason for de-registration ..... | 46 | +| 7.12 | Charging information ..... | 46 | +| 7.13 | Routing information ..... | 46 | +| 7.14 | Type of authorization ..... | 46 | +| 7.15 | Void..... | 46 | +| 7.16 | User Data Already Available ..... | 46 | +| 7.17 | Associated Private Identities ..... | 46 | +| 7.18 | Originating-Request ..... | 46 | +| 7.19 | User Authorization Request Flags..... | 47 | +| 7.20 | Loose-Route Indication..... | 47 | +| 7.21 | S-CSCF Restoration Information..... | 47 | +| 7.22 | Associated Registered Private Identities ..... | 47 | +| 7.23 | Multiple Registration Indication ..... | 47 | +| 7.24 | Session-Priority ..... | 47 | +| 7.25 | Identities with Emergency Registration ..... | 47 | +| 7.26 | Privileged-Sender Indication..... | 47 | +| 7.27 | LIA Flags..... | 47 | +| 7.28 | Server Assignment Request Flags..... | 47 | +| 7.29 | Allowed WAF and/or WWSF Identities ..... | 48 | +| 7.30 | RTR Flags ..... | 48 | +| 7.31 | Failed-PCSCF..... | 48 | +| 8 | Error handling procedures..... | 48 | +| 8.1 | Registration error cases ..... | 48 | +| 8.1.1 | Cancellation of the old S-CSCF ..... | 48 | +| 8.1.2 | Error in S-CSCF name..... | 49 | +| 8.1.3 | Error in S-CSCF assignment type ..... | 49 | + +| | | | +|-----------------------------------------------------------------------------------------------|----------------------------------------------------------------|----| +| 9 | Protocol version identification..... | 49 | +| 10 | Operational Aspects..... | 49 | +| Annex A (normative): Mapping of Cx operations and terminology to Diameter ..... | 50 | | +| A.1 | Introduction..... | 50 | +| A.2 | Cx message to Diameter command mapping..... | 50 | +| A.3 | Cx message parameters to Diameter AVP mapping..... | 50 | +| A.4 | Message flows..... | 51 | +| A.4.1 | Registration– user not registered..... | 52 | +| A.4.2 | Registration – user currently registered ..... | 53 | +| A.4.3 | UE initiated de-registration ..... | 53 | +| A.4.4 | Network initiated de-registration ..... | 54 | +| A.4.4.1 | Registration timeout ..... | 54 | +| A.4.4.2 | Administrative de-registration..... | 54 | +| A.4.4.3 | De-registration initiated by service platform..... | 55 | +| A.4.5 | UE Terminating SIP session set-up..... | 55 | +| A.4.6 | Initiation of a session to a non-registered user..... | 56 | +| A.4.6a | AS originating session on behalf of a non-registered user..... | 56 | +| A.4.7 | User Profile update..... | 57 | +| Annex B (informative): User profile UML model ..... | 58 | | +| B.1 | General description ..... | 58 | +| B.2 | Service profile ..... | 58 | +| B.2.1 | Public Identification ..... | 59 | +| B.2.1A | Core Network Service Authorization..... | 61 | +| B.2.2 | Initial Filter Criteria ..... | 62 | +| B.2.3 | Service Point Trigger ..... | 63 | +| Annex C (informative): Conjunctive and Disjunctive Normal Form..... | 65 | | +| Annex D (informative): High-level format for the User Profile..... | 68 | | +| Annex E (normative): XML schema for the Cx interface user profile..... | 69 | | +| Annex F (normative): Definition of parameters for service point trigger matching ..... | 74 | | +| Annex G (normative): Emergency registrations ..... | 74 | | +| Annex H (normative): Diameter overload control mechanism..... | 75 | | +| H.1 | General ..... | 75 | +| H.2 | HSS behaviour..... | 75 | +| H.3 | I/S-CSCF behaviour ..... | 75 | +| Annex I (Informative): Diameter overload node behaviour ..... | 76 | | +| I.1 | Message prioritization ..... | 76 | +| Annex J (normative): Diameter message priority mechanism..... | 76 | | +| J.1 | General ..... | 76 | +| J.2 | Cx/Dx interfaces..... | 76 | +| J.2.1 | General ..... | 76 | +| J.2.2 | S-CSCF/I-CSCF behaviour ..... | 76 | +| J.2.3 | HSS/SLF behaviour ..... | 77 | +| J.2.4 | Interactions ..... | 77 | +| Annex K (normative): Diameter load control mechanism ..... | 78 | | +| K.1 | General ..... | 78 | +| K.2 | HSS behaviour..... | 78 | +| K.3 | I-CSCF/S-CSCF behaviour ..... | 78 | + +Annex L (informative): Change history ..... 79 + +# --- 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 + +This 3GPP Technical Specification (TS) specifies: + +1. The interactions between the HSS (Home Subscriber Server) and the CSCF (Call Session Control Functions), referred to as the Cx interface. +2. The interactions between the CSCF and the SLF (Server Locator Function), referred to as the Dx interface. +3. The interactions between the SIP Core and the SIP database, referred to as the Cx interface, for the Mission Critical Services, where this interface is named as AAA-1, as described in 3GPP TS 23.280 [30]. + +NOTE: In the 3GPP TS 23.280 [30] the term SIP database is used for the HSS and the term SIP Core is used for the P-CSCF, the I-CSCF and the S-CSCF when compared to this specification. + +The IP Multimedia (IM) Subsystem stage 2 is specified in 3GPP TS 23.228 [1] and the signalling flows for the IP multimedia call control based on SIP and SDP are specified in 3GPP TS 24.228 [2]. + +This document addresses the signalling flows for Cx and Dx interfaces. + +This document also addresses how the functionality of Px interface is accomplished. + +The Presence Service Stage 2 description (architecture and functional solution) is specified in 3GPP TS 23.141 [10]. + +# --- 2 References + +- [1] 3GPP TS 23.228: "IP Multimedia (IM) Subsystem – Stage 2". +- [2] 3GPP TS 24.228: "Signalling flows for the IP multimedia call control based on SIP and SDP". +- [3] 3GPP TS 33.203: "Access security for IP-based services". +- [4] 3GPP TS 23.002: "Network architecture". +- [5] 3GPP TS 29.229: "Cx Interface based on Diameter – Protocol details". +- [6] 3GPP TS 23.218: "IP Multimedia (IM) Session Handling; IP Multimedia (IM) call model". +- [7] IETF RFC 2045 "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies". +- [8] 3GPP TS 24.229: "IP Multimedia Call Control Protocol based on SIP and SDP" – stage 3. +- [9] Void. +- [10] 3GPP TS 23.141: "Presence Service; Architecture and Functional Description". +- [11] IETF RFC 3261 "SIP: Session Initiation Protocol". +- [12] IETF RFC 4566 "SDP: Session Description Protocol". +- [13] IEEE 1003.1-2004, Part 1: Base Definitions. + +- [14] IETF RFC 2486: "The Network Access Identifier". +- [15] IETF RFC 3966: "The tel URI for Telephone Numbers". +- [16] Void. +- [17] 3GPP TS 23.003: "Numbering, addressing and identification". +- [18] 3GPP TS 23.008: "Organization of subscriber data". +- [19] 3GPP TS 23.380: "IMS Restoration Procedures". +- [20] Void +- [21] IETF RFC 4005: "Diameter Network Access Server Application". +- [22] IETF RFC 4412: "Communications Resource Priority for the Session Initiation Protocol (SIP)". +- [23] 3GPP TS 23.167: "IP Multimedia Subsystem (IMS) emergency sessions". +- [24] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [25] 3GPP TS 22.153: "Multimedia Priority Service". +- [26] ANSI X3.4: "Coded Character Set - 7-bit American Standard Code for Information Interchange". +- [27] IETF RFC 7944: "Diameter Routing Message Priority". +- [28] Void +- [29] IETF IETF RFC 8583: "Diameter Load Information Conveyance". +- [30] 3GPP TS 23.280: "Common functional architecture to support mission critical services". +- [31] IETF RFC 6733: "Diameter Base Protocol". +- [32] 3GPP TS 24.323: "3GPP IP Multimedia Subsystem (IMS) service level tracing management object (MO)". +- [33] IETF RFC 7616: "HTTP Digest Access Authentication". + +# --- 3 Definitions, symbols and abbreviations + +## 3.1 Definitions + +For the purposes of the present document, the following terms and definitions given in TS 23.003 [17] apply: + +**Distinct Public Service Identity** + +**Distinct Public User Identity** + +**Public Service Identity** + +**Public User Identity** + +**Wildcarded Public Service Identity** + +**Wildcarded Public User Identity** + +For the purposes of the present document, the following terms and definitions apply. + +**Common Part** (of a user profile): Contains Initial Filter Criteria instances that should be evaluated both for registered and unregistered Public User Identities, or for unregistered Public Service Identities in the S-CSCF. + +**Complete user profile:** Contains the Initial Filter Criteria instances of all three different user profile parts; registered part, unregistered part and common part. + +**IP Multimedia session:** IP Multimedia session and IP Multimedia call are treated as equivalent in this specification. + +**Authentication pending flag:** A flag that indicates that the authentication of a Public User Identity - Private User Identity pair is pending and waiting for confirmation. + +**Charging information:** Data that is sent in the Charging-Information AVP. + +**Allowed WAF and/or WWSF identities:** A list of network addresses identifying WebRTC Authentication Functions (WAFs) and/or WebRTC Web Server Functions (WWSFs) allowed for a subscription. + +**Implicitly registered Public User Identity set:** A set of Public User Identities, which are registered and de-registered simultaneously when any of the Public User Identities belonging to that set is registered or de-registered. + +**Not Registered State:** Public Identity is not Registered and has no S-CSCF assigned. + +**Private Identity:** Either a Private User Identity or a Private Service Identity. + +**Public Identity:** Either a Public User Identity or a Public Service Identity. + +**Registered Part (of a user profile):** Contains Initial Filter Criteria instances that should be evaluated only for registered Public User Identities in the S-CSCF. iFCs from the registered part need not be evaluated when the Public Identity is unregistered. + +**Registered State:** Public User Identity is Registered at the request of the user and has an S-CSCF assigned. + +**S-CSCF reassignment pending flag:** A flag that is handled only when IMS Restoration Procedures are supported and that indicates that the subscription may be reassigned to a new S-CSCF (i.e. the current S-CSCF is not responding) + +**Unregistered part (of a user profile):** Contains Initial Filter Criteria instances that should be evaluated only for unregistered Public Identities in the S-CSCF. iFCs from the unregistered part need not be evaluated when the Public User Identity is registered. + +**Unregistered State:** Public Identity is not Registered but has a serving S-CSCF assigned to execute Unregistered state services as a consequence of a terminating request, or an originating request from an AS on behalf of a user, or there is an S-CSCF keeping the user profile stored. + +**User information:** The user related data that the S-CSCF requests from the HSS or HSS pushes to the S-CSCF, e.g. user profile, charging information, allowed WAF and/or WWSF identities and authentication information. + +**User profile:** Data that is sent in the User-Data AVP. + +## 3.2 Abbreviations + +For the purposes of the present document, the following abbreviations apply: + +| | | +|--------|------------------------------------| +| AVP | Attribute Value Pair | +| C | Conditional | +| CSCF | Call Session Control Function | +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| GIBA | GPRS-IMS-Bundled-Authentication | +| HSS | Home Subscriber Server | +| IE | Information Element | +| IP | Internet Protocol | +| I-CSCF | Interrogating CSCF | +| IM | IP Multimedia | +| IMS | IP Multimedia Subsystem | +| M | Mandatory | +| MPS | Multimedia Priority Service | +| NASS | Network Attachment SubSystem | +| O | Optional | + +| | | +|--------|--------------------------------| +| P-CSCF | Proxy CSCF | +| SIP | Session Initiation Protocol | +| SLF | Server Locator Function | +| S-CSCF | Serving CSCF | +| WAF | WebRTC Authentication Function | +| WWSF | WebRTC Web Server Function | + +# --- 4 Main Concept + +This document presents the Cx interface related functional requirements of the communicating entities. + +It gives a functional classification of the procedures and describes the procedures and message parameters. + +Error handling flows, protocol version identification, etc. procedures are also included. + +# --- 5 General Architecture + +This clause further specifies the architectural assumptions associated with the Cx reference point, building on TS 23.228 [1] and also the Px reference point building upon TS 23.141 [10]. + +## 5.1 Functional requirements of network entities + +### 5.1.1 Functional requirements of P-CSCF + +There is no requirement for the interaction between the P-CSCF and the HSS. + +### 5.1.2 Functional requirements of I-CSCF + +The I-CSCF communicates with the HSS over the Cx interface. + +For functionality of the I-CSCF refer to TS 23.002 [4]. + +### 5.1.3 Functional requirements of S-CSCF + +The S-CSCF communicates with the HSS over the Cx interface. + +For functionality of the S-CSCF refer to TS 23.002 [4]. + +### 5.1.4 Functional requirements of HSS + +The HSS communicates with the I-CSCF and the S-CSCF over the Cx interface. + +For functionality of the HSS refer to TS 23.002 [4]. + +### 5.1.5 Functional classification of Cx interface procedures + +Operations on the Cx interface are classified in functional groups: + +1. Location management procedures + - The operations regarding registration and de-registration. + - Location retrieval operation. +2. User data handling procedures + - The download of user information during registration and to support recovery mechanisms. + +- Operations to support the updating of user data and recovery mechanisms. +- 3. User authentication procedures +- 4. IMS Restoration Procedures (see TS 23.380 [19]) to support S-CSCF service interruption + +### 5.1.6 Functional Requirements of the Presentity Presence Proxy + +The interaction between the Presentity Presence Proxy and the HSS, referred to as the Px interface, is handled using the mechanisms defined for the Cx interface. + +# --- 6 Procedure Descriptions + +In the tables that describe the Information Elements transported by each command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the Category "Cat." column. The application level specification overrides the ABNF defining the presence of the AVPs to be included in the Diameter commands. The category defined by the Information Element table shall always be the same, i.e. Optional; or more restrictive, i.e. Mandatory or Conditional, than the presence requirements defined by the ABNF syntax, e.g. a required AVP in the ABNF shall not be overridden by an Optional IE but an Optional AVP in the ABNF may be overridden by the Mandatory or Conditional IE Category. + +- A mandatory Information Element shall always be present in the command. If this Information Element is absent, an application error occurs at the receiver and an answer message shall be sent back to the originator of the request with the Result-Code set to DIAMETER\_MISSING\_AV. This message shall also include a Failed-AVP AVP containing the missing Information Element i.e. the corresponding Diameter AVP defined by the AVP Code and the other fields set as expected for this Information Element. +- A conditional Information Element (marked as (C) in the table) shall be present in the command if certain conditions are fulfilled. + - If the receiver detects that those conditions are fulfilled and the Information Element is absent, an application error occurs and an answer message shall be sent back to the originator of the request with the Result-Code set to DIAMETER\_MISSING\_AV. This message shall also include a Failed-AVP AVP containing the missing Information Element i.e. the corresponding Diameter AVP defined by the AVP Code and the other fields set as expected for this Information Element. + - If those conditions are not fulfilled, the Information Element shall be absent. If however this Information Element appears in the message, it shall not cause an application error and it may be ignored by the receiver if this is not explicitly defined as an error case. Otherwise, an application error occurs at the receiver and an answer message with the Result-Code set to DIAMETER\_AVP\_NOT\_ALLOWED shall be sent back to the originator of the request. A Failed-AVP AVP containing a copy of the corresponding Diameter AVP shall be included in this message. +- An optional Information Element (marked as (O) in the table) may be present or absent in the command, at the discretion of the application at the sending entity. Absence or presence of this Information Element shall not cause an application error and may be ignored by the receiver. + +When a procedure is required to determine whether two S-CSCF names are equal, the rules for SIP URI comparison specified in RFC 3261 clause 19.1.4 shall apply. + +When a procedure is required to determine the Public Identity used for an identity lookup in HSS and SLF, the HSS and SLF shall use the Public Identity from the SIP URI or Tel URI as contained in the Public-Identity AVP that is in canonical form as described by TS 23.003 [17]. + +Unknown permanent failure error codes shall be treated in the same way as DIAMETER\_UNABLE\_TO\_COMPLY. For unknown transient failure error codes the request may be repeated, or handled in the same way as DIAMETER\_UNABLE\_TO\_COMPLY. + +## 6.1 Location management procedures + +### 6.1.1 User registration status query + +This procedure is used between the I-CSCF and the HSS during SIP registrations. The procedure is invoked by the I-CSCF, corresponds to the combination of the functional level operations Cx-Query and Cx-Select-Pull (see TS 23.228 [1]) and is used: + +- To authorize the registration of the distinct Public User Identity, checking multimedia subsystem access permissions and roaming agreements. +- To perform a first security check, determining whether the distinct Public User Identity in the message is associated with the Private User Identity sent in the message. +- To obtain either the S-CSCF where the distinct Public User Identity is registered or unregistered (i.e. registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored), or the list of capabilities that the S-CSCF has to support. + +This procedure is mapped to the commands User-Authorization-Request/Answer in the Diameter application specified in TS 29.229 [5]. Tables 6.1.1.1 and 6.1.1.2 detail the involved information elements. + +**Table 6.1.1.1: User registration status query** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------------------|-------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Public User Identity (See 7.2) | Public-Identity | M | Public User Identity to be registered | +| Visited Network Identifier (See 7.1) | Visited-Network-Identifier | M | Identifier that allows the home network to identify the visited network | +| Type of Authorization (See 7.14) | User-Authorization-Type | C |

Type of authorization requested by the I-CSCF.

If the request corresponds to a de-registration, i.e. Expires field or expires parameter in Contact field in the REGISTER method is equal to zero, this AVP shall be present in the command and the value shall be set to DE-REGISTRATION.

If the request corresponds to an initial registration or a re-registration, i.e. Expires field or expires parameter in Contact field in the REGISTER method is not equal to zero then this AVP may be absent from the command. If present its value shall be set to REGISTRATION.

If the request corresponds to an initial registration or a re-registration or a de-registration and the I-CSCF explicitly queries the S-CSCF capabilities, then this AVP shall be present in the command and the value shall be set to REGISTRATION_AND_CAPABILITIES. The I-CSCF shall use this value when the S-CSCF currently assigned to the Public User Identity in the HSS, cannot be contacted and a new S-CSCF needs to be selected. The I-CSCF shall also use this value for RLOS related registrations when the S-CSCF currently assigned to the Public User Identity in the HSS does not support RLOS (see 3GPP TS 23.228 [1] annex Z) and a new S-CSCF (supporting RLOS) needs to be selected.

RLOS support of the different S-CSCFs shall be locally configured in the I-CSCF, and this capability is independent on the subscribed capabilities received from HSS.

| +| Private User Identity (See 7.3) | User-Name | M | Private User Identity | +| Routing Information (See 7.13) | Destination-Host, Destination-Realm | C | If the I-CSCF knows HSS name Destination-Host AVP shall be present in the command. Otherwise, only Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node, e.g. SLF, based on the Diameter routing table in the I-CSCF. | +| UAR Flags (See 7.19) | UAR-Flags | O | This Information Element contains a set of indications. See 7.19 for the content of the information element. | + +**Table 6.1.1.2: User registration status response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------|--------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 7.6) | Result-Code /
Experimental-Result | M | Result of the operation.
Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [31]).
Experimental-Result AVP shall be used for Cx/Dx errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| S-CSCF capabilities
(See 7.5) | Server-Capabilities | O | Required capabilities of the S-CSCF to be assigned to the IMS Subscription. | +| S-CSCF Name
(See 7.4) | Server-Name | C | Name of the assigned S-CSCF. | + +#### 6.1.1.1 Detailed behaviour + +The HSS shall, in the following order (if there is an error in any of the following steps the HSS shall stop processing and return the corresponding error code, see TS 29.229 [5]): + +0. If the HSS supports WebRTC as described in TS 23.228 [1] clause U.2.1.4, it shall check if the Private User Identity and the Public User Identity are managed by a third party, if so the HSS continues in step 4. + +NOTE : How the HSS identifies that the Private User Identity and the Public User Identity are managed by a third party for WebRTC and how the HSS identifies the corresponding user profile are implementation specific. + +1. Check that the Private User Identity and the Public User Identity exists in the HSS. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +2. Check that the Public User Identity matches a distinct Public User Identity in the HSS. If it doesn't, the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +3. Check that the Public User Identity received in the request is associated with the Private User Identity received in the request. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IDENTITIES\_DONT\_MATCH. +4. Check whether the Public User Identity received in the request is barred from the establishment of multimedia sessions. + - If it is an IMS Emergency Registration (by checking the UAR Flags) or the Public User Identity received in the request is not barred, continue to step 5. + - Otherwise, the HSS shall check whether there are other non-barred Public User Identities to be implicitly registered with that one. + - If so, continue to step 5. + - If not, Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED. +5. Check the User-Authorization-Type received in the request: + - If it is REGISTRATION or if User-Authorization-Type is absent from the request, the HSS shall check whether the UAR Flags indicate that this is an IMS Emergency Registration: + - If it is not, and the Public User Identity is allowed to roam in the visited network (if not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED) and authorized to register (if not Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED) then continue to step 6. + - If it is an IMS Emergency Registration, authorization shall be granted and the HSS shall not perform any check regarding roaming. Continue to step 6. + - If it is DE\_REGISTRATION, the HSS may not perform any check regarding roaming. Continue to step 6. + +- If it is REGISTRATION\_AND\_CAPABILITIES, the HSS shall check whether the UAR Flags indicate that this is an IMS Emergency Registration: +- If it is not, and the Public User Identity is allowed to roam in the visited network (if not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED) and authorized to register (if not Result-Code shall be set to DIAMETER\_AUTHORIZATION\_REJECTED). The HSS may return the Server-Capabilities AVP, which enables the I-CSCF to select an S-CSCF. The returned capabilities, if any, shall satisfy all the requirements of all the service profiles associated with the IMS Subscription. If Server-Capabilities AVP is absent, it indicates to the I-CSCF that it can select any available S-CSCF. If an S-CSCF is already assigned in the HSS and IMS Restoration Procedures are supported in the HSS, the HSS shall set the S-CSCF reassignment pending flag and shall allow overwriting of the S-CSCF name in the next SAR request. Result-Code shall be set to DIAMETER\_SUCCESS. The HSS shall not return any S-CSCF name. Stop processing. +- If it is an IMS Emergency Registration, authorization shall be granted and the HSS shall not perform any check regarding roaming. The HSS may return the Server-Capabilities AVP, which enables the I-CSCF to select an S-CSCF. The returned capabilities, if any, shall satisfy all the requirements of all the service profiles associated with the IMS Subscription. The Server-Capabilities AVP may be absent, to indicate to the I-CSCF that it can select any available S-CSCF. Result-Code shall be set to DIAMETER\_SUCCESS. The HSS shall not return any S-CSCF name. Stop processing. + +##### 6. Check the state of the Public User Identity received in the request: + +- If it is registered, the HSS shall return the stored S-CSCF name. No S-CSCF capabilities shall be present in the response. If User-Authorization-Type is equal to REGISTRATION or is absent, Experimental-Result-Code shall be set to DIAMETER\_SUBSEQUENT\_REGISTRATION. If User-Authorization-Type is equal to DE-REGISTRATION, Result-Code shall be set to DIAMETER\_SUCCESS. +- If it is unregistered (i.e. registered as a consequence of an originating or terminating request or there is an S-CSCF keeping the user profile stored) and User-Authorization-Type is equal to DE-REGISTRATION, the HSS shall return the stored S-CSCF name and the Result-Code shall be set to DIAMETER\_SUCCESS. If the User-Authorization-Type is equal to REGISTRATION or is absent, then the HSS shall return the stored S-CSCF name and the Experimental-Result-Code set to DIAMETER\_SUBSEQUENT\_REGISTRATION. The HSS shall not return any S-CSCF capabilities. +- If it is not registered yet, the HSS shall check the value of User-Authorization-Type received in the request: + - If the value of User-Authorization-Type is DE\_REGISTRATION and the Authentication pending flag is set, the HSS shall return the stored S-CSCF name and Experimental-Result-Code set to DIAMETER\_SUCCESS. The HSS shall not return any S-CSCF capabilities. Otherwise, if Authentication pending flag is not set, the HSS shall not return any S-CSCF name or S-CSCF capabilities. The HSS shall set the Experimental-Result-Code to DIAMETER\_ERROR\_IDENTITY\_NOT\_REGISTERED in the response. + - If the value of User-Authorization-Type is REGISTRATION or is absent, then the HSS shall check if there is at least one Public User Identity within the IMS Subscription with an S-CSCF name assigned. + - If there is at least one Public User Identity within the IMS Subscription that is registered, the HSS shall return the S-CSCF name assigned for that Public User Identity and Experimental-Result-Code set to DIAMETER\_SUBSEQUENT\_REGISTRATION. The HSS shall not return any S-CSCF capabilities. + - If there is at least one Public User Identity within the IMS Subscription that is unregistered (i.e. registered as a consequence of an originating or terminating request or there is an S-CSCF keeping the user profile stored), then the HSS shall return the stored S-CSCF name and the Experimental-Result-Code set to DIAMETER\_SUBSEQUENT\_REGISTRATION. The HSS shall not return any S-CSCF capabilities. + - If there is no identity of the user within the same IMS Subscription that is registered or unregistered, the HSS shall check if there is an S-CSCF name stored for the user (e.g. the user is being authenticated by the S-CSCF as indicated by the Authentication pending flag). If it is, the HSS shall return the stored S-CSCF name and Experimental-Result-Code set to DIAMETER\_SUBSEQUENT\_REGISTRATION. The HSS shall not return any S-CSCF capabilities. + +- If there is not any Public User Identity within the IMS Subscription with an S-CSCF name assigned, then the HSS may return the Server-Capabilities AVP, which enables the I-CSCF to select an S-CSCF. The returned capabilities, if any, shall satisfy all the requirements of all the service profiles associated with the IMS Subscription. The Server-Capabilities AVP may be absent, to indicate to the I-CSCF that it may select any available S-CSCF. Experimental-Result-Code shall be set to DIAMETER\_FIRST\_REGISTRATION. The HSS shall not return any S-CSCF name. + +If the HSS cannot fulfil received request, e.g. due to database error, it shall set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. No S-CSCF name or S-CSCF capabilities shall be present in the response. + +### 6.1.2 S-CSCF registration/deregistration notification + +This procedure is used between the S-CSCF and the HSS. The procedure is invoked by the S-CSCF, corresponds to the combination of the operations Cx-Put and Cx-Pull (see TS 23.228 [1]) and is used: + +- To assign an S-CSCF to a Public Identity, or to clear the name of the S-CSCF assigned to one or more Public Identities. +- To download from HSS the relevant user information for the S-CSCF. +- To backup and retrieve the S-CSCF Restoration Information (see TS 23.380 [19]) in the HSS. +- To provide a P-CSCF Restoration Indication, and optionally, the address of the failed P-CSCF, to the HSS and trigger P-CSCF Restoration mechanism. + +This procedure is mapped to the commands Server-Assignment-Request/Answer in the Diameter application specified in TS 29.229 [5]. Tables 6.1.2.1 and 6.1.2.2 describe the involved information elements. + +Table 6.1.2.1: S-CSCF registration/deregistration notification request + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------------------------|-----------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Public User Identity / Public Service Identity (See 7.2 and 7.2a) | Public-Identity | C | Public Identity or list of Public Identities.
One and only one Public Identity shall be present if the Server-Assignment-Type is any value other than TIMEOUT_DEREGISTRATION, USER_DEREGISTRATION, DEREGISTRATION_TOO_MUCH_DATA, TIMEOUT_DEREGISTRATION_STORE_SERVER_NAME, USER_DEREGISTRATION_STORE_SERVER_NAME or ADMINISTRATIVE_DEREGISTRATION.
If Server-Assignment-Type indicates deregistration of some type and Private Identity is not present in the request, at least one Public Identity shall be present. | +| S-CSCF Name (See 7.4) | Server-Name | M | Name of the S-CSCF. | +| Private User Identity / Private Service Identity (See 7.3 and 7.3a) | User-Name | C | Private Identity.
It shall be present if it is available when the S-CSCF issues the request. It may be absent during the initiation of a session to an unregistered Public Identity (Server-Assignment-Type shall contain the value UNREGISTERED_USER) or after S-CSCF recovery upon originating request different than REGISTER (Server-Assignment-Type shall contain the value NO_ASSIGNMENT).
In case of de-registration, Server-Assignment-Type equal to TIMEOUT_DEREGISTRATION, ADMINISTRATIVE_DEREGISTRATION, DEREGISTRATION_TOO_MUCH_DATA or TIMEOUT_DEREGISTRATION_STORE_SERVER_NAME if no Public-Identity AVPs are present then User-Name AVP shall be present. | +| Server Assignment Type (See 7.8) | Server-Assignment-Type | M | Type of update, request or notification that the S-CSCF requests in the HSS (e.g. de-registration). See 3GPP TS 29.229 [5] for all the possible values. | +| User Data Already Available (See 7.16) | User-Data-Already-Available | M | This indicates if the user profile and charging information and, if supported and present in the subscription, allowed WAF and/or WWSF identities are already available in the S-CSCF.
In the case where Server-Assignment-Type is not equal to NO_ASSIGNMENT, REGISTRATION, RE_REGISTRATION or UNREGISTERED_USER, the HSS shall not use User Data Already Available when processing the request. | +| Routing Information (See 7.13) | Destination-Host | C | If the S-CSCF knows the HSS name, the Destination-Host AVP shall be present in the command.
This information is available if the request belongs to an already existing registration, e.g. in case of the re-registration, where the HSS name is stored in the S-CSCF. The HSS name is obtained from the Origin-Host AVP, which is received from the HSS, e.g. included in the MAA command. This information may not be available if the command is sent as a consequence of a session termination for an unregistered Public Identity. In this case the Destination-Host AVP is not present and the command is routed to the next Diameter node, e.g. SLF, based on the Diameter routing table in the S-CSCF. | +| Wildcarded Public Identity (See 7.2b) | Wildcarded-Public-Identity | O | If the request refers to a Wildcarded PSI or Wildcarded Public User Identity, and the Server-Assignment-Type is set to UNREGISTERED_USER, NO_ASSIGNMENT, TIMEOUT_DEREGISTRATION_STORE_SERVER_NAME, ADMINISTRATIVE_DEREGISTRATION, DEREGISTRATION_TOO_MUCH_DATA or TIMEOUT_DEREGISTRATION, the S-CSCF may include the corresponding Wildcarded PSI or Wildcarded Public User Identity in this information element.
If this element is present, it shall be used by the HSS to identify the identity affected by the request. The terms Public Identity or Public Service Identity in the detailed behaviour refer then to the Wildcarded Public Identity. | +| S-CSCF Restoration Information (See 7.21) | SCSCF-Restoration-Info | C | When the S-CSCF supports IMS Restoration Procedures, if Server-Assignment-Type is REGISTRATION or RE_REGISTRATION, and any of the related restoration information changed compared to the previous one, the S-CSCF shall send this information element to the HSS. This information allows a later retrieval in case of an S-CSCF service interruption. | + +| | | | | +|---------------------------------------------|----------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Multiple-Registration-Indication (See 7.23) | Multiple-Registration-Indication | C | When the S-CSCF supports IMS Restoration Procedures, if Server-Assignment-Type is REGISTRATION and the registration is a multiple registration and the Public User Identity is not stored as registered with the Private User Identity as in the request in the S-CSCF, the S-CSCF shall send this information element to the HSS. | +| Session-Priority (See 7.24) | Session-Priority | O | This information element, if present, shall indicate the session's priority to the HSS. | +| SAR Flags (See 7.28) | SAR-Flags | O | This Information Element contains a set of indications. See 7.28 for the content of the information element. | +| Failed P-CSCF | Failed-PCSCF | O | If present, this Information Element shall contain the address (FQDN and/or IP addresses) of a failed P-CSCF; it shall only be included if the SAR Flags IE contains the "P-CSCF Restoration Indication" (see clause 7.28). | + +Table 6.1.2.2: S-CSCF registration/deregistration notification response + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Private User Identity / Private Service Identity (See 7.3 and 7.3a) | User-Name | C | Private Identity.
It shall be present if it is available when the HSS sends the response.
It may be absent in the following error case: when the Server-Assignment-Type of the request is UNREGISTERED_USER and the received Public Identity is not known by the HSS. | +| Registration result (See 7.6) | Result-Code / Experimental-Result | M | Result of registration.
Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [31]).
Experimental-Result AVP shall be used for Cx/Dx errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| User Profile (See 7.7) | User-Data | C | Relevant user profile.
It shall be present when Server-Assignment-Type in the request is equal to NO_ASSIGNMENT, REGISTRATION, RE_REGISTRATION or UNREGISTERED_USER according to the rules defined in clause 6.6.
If the S-CSCF receives more data than it is prepared to accept, it shall perform the de-registration of the Private Identity with Server-Assignment-Type set to DEREGISTRATION_TOO_MUCH_DATA and send back a SIP 3xx or 480 (Temporarily Unavailable) response, which shall trigger the selection of a new S-CSCF by the I-CSCF, as specified in 3GPP TS 24.229 [8]. | +| Charging Information (See 7.12) | Charging-Information | C | Addresses of the charging functions.
It shall be present when the User-Data AVP is sent to the S-CSCF according to the rules defined in clause 6.6.
When this parameter is included, either the Primary-Charging-Collection-Function-Name AVP or the Primary-Event-Charging-Function-Name AVP shall be included. All other elements shall be included if they are available. | +| Associated Private Identities | Associated-Identities | O | This AVP contains all Private Identities, which belong to the same IMS subscription as the Private Identity or Public Identity received in the SAR command.
If the IMS subscription contains only single Private Identity this AVP shall not be present. | +| Loose-Route Indication | Loose-Route-Indication | C | This AVP indicates to the S-CSCF that loose-route mechanism shall be applied to the public identities contained in the user profile received from the HSS.
If the loose-route mechanism is required, this AVP shall be present and set to LOOSE_ROUTE_REQUIRED.
If the Loose-Route mechanism is not required, this AVP may be either absent or present. If present, it shall be set to LOOSE_ROUTE_NOT_REQUIRED. | +| S-CSCF Restoration Information (See 7.21) | SCSCF-Restoration-Info | C | This information shall be present if it was stored by the S-CSCF in the HSS and Server-Assignment-Type is either UNREGISTERED_USER or NO_ASSIGNMENT.
This information shall also be present if it was stored by the S-CSCF in the HSS and the SAR indicates it is related to a multiple registration and Server-Assignment-Type is REGISTRATION.
This information may be present if it was stored by the S-CSCF in the HSS and Server-Assignment-Type is either REGISTRATION or RE_REGISTRATION and there are other Private Identities different from the Private Identity received in the SAR command being registered with the Public Identity received in the SAR command. | +| Associated Registered Private Identities (See 7.22) | Associated-Registered-Identities | C | This AVP contains all Private Identities that were registered with the Public Identity received in the SAR command.
The HSS shall send this information element if the IMS Restoration Procedures are supported and the value of Server-Assignment-Type in the request is REGISTRATION or RE_REGISTRATION and there are other Private Identities different from the Private Identity received in the SAR command being registered with the Public Identity received in the SAR command.
Otherwise, this AVP shall not be present. | + +| | | | | +|--------------------------------------------------------|--------------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| S-CSCF Name
(See 7.4) | Server-Name | C | Name of the assigned S-CSCF.
This AVP shall be present, if the requesting S-CSCF name is different from the previously assigned S-CSCF name stored in the HSS. | +| Wildcarded Public Identity
(See 7.2b) | Wildcarded-Public-Identity | C | This AVP shall be present if:
- the value of Server-Assignment-Type in the request was UNREGISTERED_USER or NO_ASSIGNMENT and
- the Wildcarded-Public-Identity AVP in the request was not present and
- the Public Identity in the request fell within the range of a Wildcarded Public User Identity in the HSS whose state is registered/unregistered.

If this element is present, it shall be used by the S-CSCF to identify the identity affected by the request. | +| Privileged-
Sender
Indication
(See 7.26) | Privileged-
Sender-
Indication | O | This AVP indicates if the Private User Identity shall be considered as a privileged sender.
If not present, it means that the Private User Identity is not considered a privileged sender. | +| Allowed WAF
and/or WWSF
Identities (See
7.29) | Allowed-WAF-
WWSF-
Identities | C | Addresses of the WAFs and/or WWSFs the subscription is allowing to use.
This AVP shall be present if both
a) it is applicable for the subscription and
b) the User-Data AVP is present. | + +#### 6.1.2.1 Detailed behaviour + +On registering/deregistering a Public Identity the S-CSCF shall inform the HSS. The same procedure is used by the S-CSCF: + +- to get the user information which contains the user profile, the charging information and the allowed WAF and/or WWSF Identities. The relevant user profile downloaded is described in more detailed in clauses 6.5.1 and 6.6. +- to provide a P-CSCF Restoration Indication to the HSS when the S-CSCF, supporting the HSS based P-CSCF restoration mechanism described in TS 23.380 [19], has identified a P-CSCF failure for a given UE and then triggers the P-CSCF Restoration mechanism execution for this UE. + +The Public-Identity AVP and User-Data AVPs in this command pair shall contain only one type of identities i.e. either only Public User Identities, or only Public Service Identities. User initiated registration/deregistration procedures (i.e. server-assignment-type is set to RE\_REGISTRATION, USER\_DEREGISTRATION, etc.) shall only be allowed for distinct Public User Identities. + +The HSS holds information about the state of registration of all the identities related to an IMS Subscription. The S-CSCF uses this procedure to update such states. For Shared Public User Identities, the S-CSCF shall initiate this procedure towards the HSS for each Private User Identity undergoing a Registration or Deregistration related to the Shared Public User Identity. For implicitly registered identities, the rules defined in Clause 6.5.1 shall apply. + +When the request message was received because of a terminating session request, the HSS may prioritise the received request message according to priority level received within the Session-Priority AVP. + +NOTE 1: Refer to Annex J for HSS procedures associated with the handling of both the Session-Priority AVP and DRMP AVP received in the request message. + +The HSS shall, in the following order (in case of an error in any of the steps the HSS shall stop processing and return the corresponding error code, see TS 29.229 [5]): + +1. Check that the Public Identity and Private Identity exist in the HSS. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +2. The HSS may check whether the Private and Public Identities received in the request are associated in the HSS. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IDENTITIES\_DONT\_MATCH. +3. If more than one Public-Identity AVP is present and the Server-Assignment-Type is one of the values defined in Table 6.1.2.1 as applying for only one identity, then the Result Code shall be set to DIAMETER\_AVP\_OCCURS\_TOO\_MANY\_TIMES and no user information shall be returned. +4. The HSS shall check the Public Identity type received in the request. + +- If the identity in the request is a distinct Public User Identity, continue in step 5, otherwise the HSS shall check the server-assignment-type: + +If it indicates REGISTRATION, RE\_REGISTRATION, USER\_DEREGISTRATION, USER\_DEREGISTRATION\_STORE\_SERVER\_NAME, AUTHENTICATION\_FAILURE or AUTHENTICATION\_TIMEOUT, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IN\_ASSIGNMENT\_TYPE. + +- If the identity in the request is a Public Service Identity, then check if the PSI Activation State for that identity is active. If not, then the response shall contain Experimental-Result-Code set to DIAMETER\_ERROR\_USER\_UNKNOWN. + +##### 5. Check the Server Assignment Type value received in the request: + +- If it indicates REGISTRATION or RE\_REGISTRATION, the HSS shall check whether the Public Identity is assigned for the S-CSCF requesting the data. + +If there is already an S-CSCF assigned to the user and the requesting S-CSCF is not the same as the previously assigned S-CSCF, and IMS restoration procedures are not supported or the S-CSCF reassignment pending flag is not set, the HSS shall include the name of the previously assigned S-CSCF in the response message and the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IDENTITY\_ALREADY\_REGISTERED. + +If there is already an S-CSCF assigned to the user and the requesting S-CSCF is not the same as the previously assigned S-CSCF and IMS restoration procedures are supported, and the S-CSCF reassignment pending flag is set, the HSS shall overwrite the S-CSCF name and shall reset the S-CSCF reassignment pending flag. + +If there is no S-CSCF assigned to the user or the requesting S-CSCF is the same as the previously assigned S-CSCF stored in the HSS, the HSS shall download the relevant user information taking into consideration the value set in the User-Data-Already-Available AVP (see clause 6.6). The Result-Code shall be set to DIAMETER\_SUCCESS and the HSS shall set the registration state of the Public User Identity as registered (if not already registered). If the S-CSCF Restoration Information is included in the request and the HSS implements IMS Restoration procedures, and if it is RE\_REGISTRATION, the HSS shall store this information. If the Public User Identity's authentication pending flag which is specific for the Private User Identity is set, the HSS shall clear it. If there are multiple Private User Identities, which belong to the served IMS subscription the Associated-Identities AVP should be added to the answer message and it shall contain all Private User Identities associated to the IMS subscription. If the loose-route mechanism is required for the registered Public User Identities, the Loose-Route-Indication AVP shall be added to the answer message. If there are multiple Private User Identities being registered with the Public Identity received in the request message, and the IMS Restoration Procedures are supported in the HSS, the Associated-Registered-Identities AVP shall be added to the answer message and it shall contain all Private User Identities being registered with the Public Identity, and subject to the operator policy, the HSS may include all stored S-CSCF Restoration Information groups associated to the Private User Identities in the response. + +NOTE 2: If the HSS returns all the S-CSCF Restoration Information groups in the response, the S-CSCF can ignore the Associated-Registered-Identities AVP and skip additional Server-Assignment-Request since the information is already made available. + +If it is REGISTRATION and the HSS implements IMS Restoration procedures, if multiple registration indication is included in the request and the Public User Identity is stored as registered in the HSS, and there is restoration information related to the Private User Identity, the HSS shall not overwrite the stored S-CSCF Restoration Information, instead, it shall send the stored S-CSCF restoration information together with the user profile in the SAA. Subject to the operator policy, if there is S-CSCF Restoration Information associated with several Private User Identities, the HSS may include all the S-CSCF Restoration Information groups in the response. The Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IN\_ASSIGNMENT\_TYPE. Otherwise, the HSS shall store the received S-CSCF restoration information. The Result-Code shall be set to DIAMETER\_SUCCESS. + +- If it indicates UNREGISTERED\_USER, the following applies. + +If the P-CSCF-Restoration-Indication is included in SAR-Flags AVP, the HSS supporting the P-CSCF-Restoration-mechanism feature shall check whether at least one of the serving node(s) for corresponding user support this feature. If none of the serving nodes support the feature, the HSS shall stop processing this + +request and the Result-Code shall be set to DIAMETER\_ERROR\_SERVING\_NODE\_FEATURE\_UNSUPPORTED. + +The HSS shall check whether the Public Identity is assigned for the S-CSCF requesting the data: + +- If there is already an S-CSCF assigned to the user and the requesting S-CSCF is not the same as the previously assigned S-CSCF, and IMS restoration procedures are not supported or the S-CSCF reassignment pending flag is not set and a P-CSCF-Restoration-Indication is not included in SAR-Flags AVP, the HSS shall include the name of the previously assigned S-CSCF in the response message and the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IDENTITY\_ALREADY\_REGISTERED. +- If there is already an S-CSCF assigned to the user and the requesting S-CSCF is not the same as the previously assigned S-CSCF and IMS restoration procedures are supported, and the S-CSCF reassignment pending flag is set, the HSS shall overwrite the S-CSCF name and shall reset the S-CSCF reassignment pending flag. +- If there is no S-CSCF assigned to the user or the requesting S-CSCF is the same as the previously assigned S-CSCF stored in the HSS, the HSS shall store the S-CSCF name. + +The HSS shall check the Public Identity registration state: + +- If the registration state of the Public Identity is not registered or unregistered, the HSS shall set or keep the registration state of the Public Identity as unregistered, i.e. registered as a consequence of an originating or terminating request and if a P-CSCF-Restoration-Indication is not included in SAR-Flags AVP download the relevant user information. The Result-Code shall be set to DIAMETER\_SUCCESS. If there are multiple Private User Identities associated to the Public User Identity in the HSS, the HSS shall arbitrarily select one of the Private User Identities and put it into the response message. +- If the registration state of the Public Identity is registered and IMS restoration procedures are not supported, the HSS shall set the registration state of the Public identity as unregistered, clear any S-CSCF Restoration Information associated with the Public User Identity (if any) and if a P-CSCF-Restoration-Indication is not included in SAR-Flags AVP download the relevant user information. The Result-Code shall be set to DIAMETER\_SUCCESS. If there are multiple Private User Identities associated to the Public User Identity in the HSS, the HSS shall arbitrarily select one of the Private User Identities and put it into the response message. + +NOTE 3: The case where S-CSCF Restoration Information is stored in the HSS even though IMS Restoration Procedures are not supported corresponds to the situation where the HSS supports IMS Restoration Procedures but a new assigned S-CSCF does not, while the former S-CSCF supported this feature. + +- If the registration state of the Public Identity is registered and IMS restoration procedures are supported and a P-CSCF-Restoration-Indication is not included in SAR-Flags AVP, the HSS shall include in the response all S-CSCF Restoration Information related with the Public User Identity. If there is S-CSCF Restoration Information associated with several Private User Identities, the HSS shall include all the S-CSCF Restoration Information groups in the response. The Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IN\_ASSIGNMENT\_TYPE. +- If the registration state of the Public Identity is Registered and IMS Restoration Procedures are supported and a P-CSCF-Restoration-Indication is included in SAR-Flags AVP, the HSS shall set the registration state of the Public identity as Unregistered and clear any S-CSCF Restoration Information associated with the Public User Identity (if any). The Result-Code shall be set to DIAMETER\_SUCCESS. + +If there are multiple Private User Identities, which belong to the served IMS subscription the Associated-Identities AVP should be added to the answer message and it shall contain all Private User Identities associated to the IMS subscription. + +If the S-CSCF receives a wildcarded public identity from the I-CSCF, the S-CSCF shall use this wildcarded public identity to fetch the user profile (i.e. by sending a Cx-SAR including Wildcarded-Public-Identity AVP if the profile is not available) and registration information locally stored. + +If the S-CSCF does not receive a wildcarded public identity, the S-CSCF shall not perform wildcarded public identity matching and shall use the public identity received instead to fetch the user profile (i.e. by sending a + +Cx-SAR without including Wildcarded-Public-Identity AVP if the profile is not available) and registration information. + +NOTE 4: There may be SIP requests in which the S-CSCF does not receive information of a wildcarded public identity, e.g. originating call from an AS on behalf of a user. + +NOTE 5: Since a distinct public identity falling into the range of a wildcarded public identity can have a different service profile, the S-CSCF does not perform the wildcarded public identity matching against the public identity received to avoid using the wrong service profile. + +If the Wildcarded-Public-Identity AVP is not received and if the Public Identity falls within the range of a wildcarded public identity whose registration state is registered and a P-CSCF-Restoration-Indication is not included in SAR-Flags AVP, the HSS shall not overwrite the registration state. The Result-Code shall be set to DIAMETER\_ERROR\_IN\_ASSIGNMENT\_TYPE and the HSS shall include the Wildcarded-Public-Identity AVP in the response. Upon reception of this error, the S-CSCF should behave as if it has received a wildcarded public identity in the first place. + +If SAR-Flags AVP includes a P-CSCF-Restoration-Indication, the HSS supporting the P-CSCF-Restoration-mechanism feature shall send a P-CSCF restoration indication to the serving nodes where the IMSI associated to the received Private Identity is registered, i.e. SGSN and/or MME, using S6a/S6d IDR/IDA or Gr ISD request/answer as described in TS 23.380 [19] clause 5.4. The Result-Code shall be set to DIAMETER\_SUCCESS. + +- If it indicates TIMEOUT\_DEREGISTRATION, USER\_DEREGISTRATION, DEREGISTRATION\_TOO\_MUCH\_DATA or ADMINISTRATIVE\_DEREGISTRATION, the following applies. + +If it indicates ADMINISTRATIVE\_DEREGISTRATION and if the P-CSCF-Restoration-Indication is included in SAR-Flags AVP, the HSS supporting the P-CSCF-Restoration-mechanism feature shall check whether at least one of the serving node(s) for corresponding user support this feature. If none of the serving nodes support the feature, the HSS shall stop processing this request and the Result-Code shall be set to DIAMETER\_ERROR\_SERVING\_NODE\_FEATURE\_UNSUPPORTED. + +The HSS shall check the registration state for all the Public Identities in the request. + +- If a Private User Identity is present in the request, if the request did not contain Public Identities the HSS shall check the registration state of the Public Identities associated with the Private Identity identified in the request. For each Public Identity: + - If the registration state of the Public User Identity is Registered, the HSS shall check if the Public User Identity is currently registered with one or more Private User Identities. + - If the Public User Identity is currently registered with only one Private User Identity, the HSS shall set the registration state of the Public User Identity to Not Registered and clear the S-CSCF name and any S-CSCF Restoration Information associated with the Public User Identity. + - If the Public User Identity is currently registered with more than one Private User Identity, the HSS shall keep the registration state of the Public User Identity as Registered and retain the S-CSCF name associated with the Public User Identity. The HSS shall remove any S-CSCF Restoration Information associated to the registration of this Public User Identity with this Private User Identity. + - If a Private User Identity is absent in the request, if the Public User Identity is currently registered with more than one Private User Identity, the HSS shall stop processing this request and shall set the Result-Code to DIAMETER\_MISSING\_AVP. + - if the registration state of the Public Identity is Unregistered, the HSS shall set the registration state of the Public Identity to Not Registered and clear the S-CSCF name associated with the Public Identity. + +In case of ADMINISTRATIVE\_DEREGISTRATION, if SAR-Flags AVP includes a P-CSCF-Restoration-Indication, the HSS or combined HSS-UDM supporting the P-CSCF-Restoration-mechanism feature shall send a P-CSCF restoration indication to the serving nodes where the IMSI associated to the received Private Identity is registered, i.e. SGSN and/or MME, using S6a/S6d IDR/IDA or Gr ISD request/answer as described in TS 23.380 [19] clause 5.4, and SMF and/or AMF, using the Nudm\_UECM\_P-CSCF-RestorationNotification service operation as described in TS 23.380 [19] clause 5.8.4. + +The Result-Code shall be set to DIAMETER\_SUCCESS + +- If it indicates TIMEOUT\_DEREGISTRATION\_STORE\_SERVER\_NAME or USER\_DEREGISTRATION\_STORE\_SERVER\_NAME the HSS decides whether to keep the S-CSCF name associated to the Private User Identity stored or not for all the Public User Identities that the S-CSCF indicated in the request. If no Public User Identity is present in the request, the Private User Identity shall be present. +- If the HSS decides to keep the S-CSCF name stored the HSS shall keep the S-CSCF name stored for all the Public User Identities associated to the Private User Identity. The Result-Code shall be set to DIAMETER\_SUCCESS. + +The HSS shall check if each Public User Identity in the request is currently registered with one or more Private User Identities. If the request did not contain Public User Identities the HSS shall check if each Public User Identity associated with the Private User Identity in the request is currently registered with one or more Private User Identities. For each Public User Identity;- + +- If only one Private User Identity associated with the Public User Identity is currently registered with the Public User Identity, the HSS shall set the registration state of the Public User Identity to Unregistered and clear any S-CSCF Restoration Information associated with the Public User Identity +- If more than one Private User Identity that shares that Public User Identity is currently registered with the Public User Identity the HSS shall keep the registration state of the Public User Identity as Registered. The HSS shall remove any S-CSCF Restoration Information associated to the registration of this Public User Identity with the Private User Identity in the request. +- If the HSS decides not to keep the S-CSCF name the Experimental-Result shall be set to DIAMETER\_SUCCESS\_SERVER\_NAME\_NOT\_STORED. + +The HSS shall check if each Public User Identity in the request is currently registered with one or more Private User Identities. If the request did not contain Public User Identities the HSS shall check if each Public User Identity associated with the Private User Identity in the request is currently registered with one or more Private User Identities. For each Public User Identity;- + +- If only one Private User Identity associated with the Public User Identity is currently registered with the Public User Identity, the HSS shall set the registration state of the Public User Identity to Not Registered and clear the S-CSCF name associated with Public User Identity. +- If more than one Private User Identity that shares that Public User Identity is currently registered with the Public User Identity the HSS shall keep the registration state of the Public User Identity as Registered. +- If it indicates NO\_ASSIGNMENT, the HSS checks whether the Public Identity is assigned for the S-CSCF requesting the data. If the requesting S-CSCF is not the same as the assigned S-CSCF and the S-CSCF reassignment pending flag is not set, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY, otherwise the HSS shall download the relevant user information and the Result-Code shall be set to DIAMETER\_SUCCESS. If relevant S-CSCF Restoration Information is stored in the HSS and IMS Restoration Procedures are supported, it shall be added to the answer message. If there is S-CSCF Restoration Information associated with several Private User Identities, the HSS shall include all the S-CSCF Restoration Information groups in the response. If there are multiple Private User Identities, which belong to the served IMS subscription the Associated-Identities AVP should be added to the answer message and it shall contain all Private User Identities associated to the IMS subscription. + +NOTE 6: the check of the S-CSCF reassignment pending flag is needed since an S-CSCF supporting restoration procedures can receive a user initiated de-registration for a Public Identity for which it does not have any registration data (see TS 23.380 [19]). In such case, the S-CSCF indicates NO\_ASSIGNMENT in Server-Assignment-Type to retrieve any possible restoration information from the HSS. + +- If it indicates AUTHENTICATION\_FAILURE (e.g. there is a mismatch in IP-address secure binding information) or AUTHENTICATION\_TIMEOUT (e.g. no response to Digest challenge), the HSS shall keep the registration state of the Public User Identity. The HSS shall check the registration state for the Public User Identity in the request and only if the registration state of the Public User Identity is Not Registered, the HSS shall clear the S-CSCF name associated with the Public User Identity. + +If the Public User Identity's authentication pending flag which is specific for the Private User Identity is set, the HSS shall clear it. The Result-Code shall be set to DIAMETER\_SUCCESS. + +If the HSS cannot fulfil the received request, e.g. due to database error, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. The HSS shall not modify any registration state nor download any Public Identity information to the S-CSCF. + +See clause 8.1.2 and 8.1.3 for the description of the handling of the error situations: reception of an S-CSCF name different from the one stored in the HSS and reception of a Server-Assignment-Type value not compatible with the registration state of the Public Identity. + +### 6.1.3 Network initiated de-registration by the HSS, administrative + +In case of network initiated de-registration of by the HSS, the HSS change the state of the Public Identities to Not Registered and send a notification to the S-CSCF indicating the identities that shall be de-registered. The procedure is invoked by the HSS, corresponds to the functional level operation Cx-Deregister (see TS 23.228 [1]). + +This procedure is mapped to the commands Registration-Termination-Request/Answer in the Diameter application specified in TS 29.229 [5]. Tables 6.1.3.1 and 6.1.3.2 describe the involved information elements. + +**Table 6.1.3.1: Network Initiated Deregistration by HSS request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Public User Identity / Public Service Identity (See 7.2 and 7.2a) | Public-Identity | C | It contains the list of Public Identities that are de-registered, in the form of SIP URL or TEL URL.
Public-Identity AVP shall be present if the de-registration reason code is NEW_SERVER_ASSIGNED. It may be present with the other reason codes. | +| Private User Identity / Private Service Identity (See 7.3 and 7.3a) | User-Name | M | It contains the Private Identity in the form of a NAI. The HSS shall always send a Private Identity that is known to the S-CSCF based on an earlier SAR/SAA procedure. | +| Reason for de-registration (See 7.11) | Deregistration-Reason | M | The HSS shall send to the S-CSCF a reason for the de-registration. The de-registration reason is composed of two parts: one textual message (if available) that is intended to be forwarded to the user that is de-registered, and one reason code (see 3GPP TS 29.229 [5]) that determines the behaviour of the S-CSCF | +| Routing Information (See 7.13) | Destination-Host | M | It contains the name of the S-CSCF which originated the last update of the name of the multimedia server stored in the HSS for a given IMS Subscription. The address of the S-CSCF is the same as the Origin-Host AVP in the message sent from the S-CSCF. | +| Associated Private Identities | Associated-Identities | O | This AVP contains Private Identities, which belong to the same IMS subscription as the Private Identity in the User-Name AVP and should be de-registered together with that one.
If the IMS subscription contains only a single Private Identity, this AVP shall not be present. | +| RTR Flags (See 7.30) | RTR-Flags | O | This information element contains a bit mask.
See 7.30 for the meaning of the bits. | + +**Table 6.1.3.2: Network Initiated Deregistration by HSS response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------|--------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 7.6) | Result-Code /
Experimental-Result | M | This information element indicates the result of de-registration. Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [31]). Experimental-Result AVP shall be used for Cx/Dx errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| Associated Private Identities | Associated-Identities | C | This AVP shall be present if the S-CSCF de-registered more than one Private Identity with the request. It contains all Private Identities that have been deregistered together with the one in the User-Name AVP of the request. | +| Identities with Emergency Registration
(See 7.25) | Identity-with-Emergency-Registration | C | This information element indicates a list of pairs of private and public user identities which have not been de-registered due to emergency registration. | + +#### 6.1.3.1 Detailed behaviour + +The HSS shall de-register the affected identities and invoke this procedure to inform the S-CSCF. The S-CSCF shall remove all the information stored in the S-CSCF for the affected identities. + +The HSS may de-register: + +- One Public Identity or a list of Public Identities. HSS may include all Public User Identities associated with the User-Name AVP to the request. This option is applicable with all reason codes. +- One or more Private Identities of the IMS Subscription with all associated Public Identities. No Public-Identity AVPs shall be present in this case. This option is applicable with reason codes PERMANENT\_TERMINATION, SERVER\_CHANGE, and REMOVE\_S-CSCF. +- All Public Service Identities that match a Wildcarded Public Service Identity. In this case the HSS may send one of the Public Service Identities that was received in the Server Assignment Request for that Wildcarded Public Service Identity and the associated Private Service Identity. +- A Wildcarded Public User Identity. In this case the HSS shall send a distinct Public User Identity that belongs to the same implicit registration set as the Wildcarded Public User Identity and the associated Private User Identity. + +The HSS shall send in the Deregistration-Reason AVP the reason for the de-registration, composed by a textual message (if available) aimed for the user and a reason code that determines the action the S-CSCF has to perform. The possible reason codes are: + +- PERMANENT\_TERMINATION: The HSS indicates to the S-CSCF that the S-CSCF will no longer be assigned to the Public Identity and associated implicitly registered/unregistered Public Identities (if any) for the Private Identity(ies) indicated in the request (e.g. due to an IMS subscription cancellation, or modification, or a removal of IP-address secure binding information when GIBA is used). This reason also indicates that no other S-CSCF can be assigned. + +The HSS shall check the registration state of the Public Identities. If no Public Identities are involved, the HSS shall check the registration state of the Public Identities associated with the Private User Identity identified. For each Public Identity: + +- If the registration state of the Public Identity is Registered, the HSS shall check if the Public User Identity is currently registered with one or more Private User Identities. + - If the Public User Identity is currently registered with only one Private User Identity, the HSS shall check whether the Public User Identity is included in the information element Identities with Emergency Registrations returned by S-CSCF in the response. + - If included, the HSS shall keep the S-CSCF name associated with the Public User Identity and set the registration state of the Public User Identity to Unregistered. + +- If not included, the HSS shall clear the S-CSCF name associated with the Public User Identity, and set the registration state of the Public User Identity to Not Registered. The S-CSCF initiates the de-registration of the Public User Identity unless it is emergency registered. +- If the Public User Identity is currently registered with more than one Private User Identity, the HSS shall keep the registration state of the Public User Identity as Registered and retain the S-CSCF name associated with the Public User Identity. The S-CSCF initiates the de-registration of the Public User Identity unless it is emergency registered. +- If the registration state of the Public Identity is Unregistered, the HSS shall check whether this Public User Identity is included in the information element Identities with Emergency Registrations returned by S-CSCF in the response. + - If included, the HSS shall keep the S-CSCF name associated with the Public User Identity. + - If not included, the HSS shall set the registration state of the Public Identity to Not Registered and clear the S-CSCF name associated with the Public Identity. +- NEW\_SERVER\_ASSIGNED: The HSS indicates to the S-CSCF that a new S-CSCF has been allocated to the IMS Subscription e.g. because the previous assigned S-CSCF was unavailable during a registration procedure. The S-CSCF shall remove all information for all of the Public Identities indicated in the request. +- SERVER\_CHANGE: The HSS indicates to the S-CSCF that the de-registration is requested to force the selection of new S-CSCF to assign to the IMS Subscription (e.g. when the S-CSCF capabilities are changed in the HSS or when the S-CSCF indicates that it has not enough memory for the updated User Profile). The HSS shall set the registration state to "Not Registered" and clear the S-CSCF name for all of the Public Identities affected by the request. If the S-CSCF does not indicate in the response all the Private Identities that were in the request, the HSS shall repeat this request for each of the remaining Private Identities in the IMS Subscription that are known to the S-CSCF. The S-CSCF should start the network initiated de-registration towards the user, i.e. all registrations within the IMS Subscription are de-registered and the user is asked to re-register to all existing registrations. +- REMOVE\_S-CSCF: The HSS indicates to the S-CSCF that the S-CSCF will no longer be assigned to an unregistered Public Identity(ies) (i.e. registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored) for a given IMS Subscription. + +The HSS shall check if an emergency registration exists in the S-CSCF, checking for each Public Identity contained in the request whether it is present in the information element Identities with Emergency Registrations returned by S-CSCF. + +- If an emergency registration does not exist in S-CSCF, for each Public Identity contained within the request, the HSS shall set the registration state of the Public Identity to Not Registered and clear the S-CSCF name associated with the Public Identity. The S-CSCF shall remove all information related to the Public User Identity contained within the request. +- If an emergency registration exists in S-CSCF for one or more Public User Identities contained in the request, the S-CSCF should include the corresponding Private Identity / Public User Identity pairs in the information element Identities with Emergency Registrations in the answer. The HSS, when receiving such an answer, shall not change the registration state of the Public User Identities present in the information element Identities with Emergency Registrations and shall keep unchanged the S-CSCF name associated with these Public User Identities. + +Public Identities which are emergency registered in the S-CSCF shall not be de-registered when a Cx-Deregistration request with a -reason code of PERMANENT\_TERMINATION or REMOVE\_S-CSCF is received from the HSS. In this case + +- if all to be de-registered identities are emergency registered, a Result-Code set to DIAMETER\_UNABLE\_TO\_COMPLY and a list of Private / Public Identity pairs which are emergency registered shall be returned to the HSS +- if a proper subset of the to be de-registered identities are emergency registered, a Result-Code of DIAMETER\_LIMITED\_SUCCESS and a list of Private Identity / Public Identity pairs which are emergency registered shall be returned to the HSS. + +NOTE 1: If the Public Identity that is emergency registered has normal registration as well, then for the normal registration the S-CSCF will perform the detailed de-registration procedures towards the UE for each reason code as described in TS 24.229 [8]. + +NOTE 2: It is assumed that Public Identities which are implicitly registered along with an emergency registration are also emergency registered. + +The detailed de-registration procedures performed by the S-CSCF are described in TS 24.229 [8]. + +### 6.1.4 User location query + +This procedure is used between the I-CSCF and the HSS to obtain the name of the S-CSCF assigned to a Public Identity, or the name of the AS hosting a PSI for direct routing. The procedure is invoked by the I-CSCF, is performed per Public Identity, and corresponds to the functional level operation Cx-Location-Query (see TS 23.228 [1]). + +This procedure is mapped to the commands Location Info Request/Answer in the Diameter application specified in TS 29.229 [5]. Tables 6.1.4.1 and 6.1.4.2 detail the involved information elements. + +**Table 6.1.4.1: User Location query** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------------------------------|-------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Public User Identity / Public Service Identity (See 7.2 and 7.2a) | Public-Identity | M | Public Identity | +| Routing information (See 7.13) | Destination-Host, Destination-Realm | C | If the I-CSCF knows HSS name Destination-Host AVP shall be present in the command. Otherwise, only Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node, e.g. SLF, based on the Diameter routing table in the I-CSCF. | +| Originating Request (See 7.18) | Originating-Request | O | It indicates that the request is related to an originating SIP message. | +| Type of Authorization (See 7.14) | User-Authorization-Type | C | This information element shall be present and set to REGISTRATION_AND_CAPABILITIES by the I-CSCF if IMS Restoration Procedures are supported and the S-CSCF currently assigned to the Public User Identity in the HSS cannot be contacted. | +| Session Priority (See 7.24) | Session-Priority | O | This information element, if present, shall indicate the session's priority to the HSS. | + +**Table 6.1.4.2: User Location response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|--------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 7.6) | Result-Code /
Experimental-Result | M | Result of the operation.
Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [31]).
Experimental-Result AVP shall be used for Cx/Dx errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | +| S-CSCF Name / AS name
(See 7.4 and 7.4a) | Server-Name | C | Name of the assigned S-CSCF for basic IMS routing or the name of the AS for direct routing. | +| S-CSCF capabilities
(See 7.5) | Server-Capabilities | O | It contains the information to help the I-CSCF in the selection of the S-CSCF. | +| Wildcarded Public Identity
(See 7.2b) | Wildcarded-Public-Identity | O | If the requests refers to a Wildcarded PSI or Wildcarded Public User Identity (the Public Identity in the request matches a Wildcarded PSI or Wildcarded Public User Identity in the HSS), the HSS shall include the corresponding Wildcarded Public Identity in this information element.

The matching of distinct Public Identities takes precedence over the matching of wildcarded public identities. | +| LIA Flags
(See 7.27) | LIA-Flags | O | This information element contains a bit mask.
See 7.27 for the meaning of the bits. | + +#### 6.1.4.1 Detailed behaviour + +The HSS may prioritise the received request message according to priority level received within the Session-Priority AVP. + +NOTE 1: Refer to Annex J for HSS procedures associated with the handling of both the Session-Priority AVP and DRMP AVP received in the request message. + +The HSS shall, in the following order (if an error occurs in any of the ste + +The HSS shall, in the following order (if an error occurs in any of the steps the HSS shall stop processing and return the corresponding error code, see TS 29.229 [5]): + +1. Check that the Public Identity is known. If not the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +2. Check the type of the Public Identity contained in the request: + - If this is a Public User Identity, continue to step 2a. + - If this is a Public Service Identity: + - Check if the PSI Activation State for that identity is active. If not, then the response shall contain Experimental-Result-Code set to DIAMETER\_ERROR\_USER\_UNKNOWN. + - Check if the name of the AS hosting the Public Service Identity is stored in the HSS and that the request does not contain the Originating-Request AVP. + - If this is the case, if IMS Restoration Procedures are supported, the HSS shall check if User-Authorization-Type was received in the request, and if the value is REGISTRATION\_AND\_CAPABILITIES: + - If it is, the HSS shall reject the request with Result-Code set to DIAMETER\_UNABLE\_TO\_COMPLY. + - Otherwise, the HSS shall return the AS name and the Result-Code AVP shall be set to DIAMETER\_SUCCESS. HSS may set PSI Direct Routing Indication bit in LIA-Flags AVP, then I-CSCF shall not perform IMS Restoration Procedures (see clause 4.3.3 in TS 23.380 [19]). + +- Otherwise, continue to step 2a. +- 2a. If IMS Restoration procedures are supported, the HSS shall check if User-Authorization-Type was received in the request, and if the value is REGISTRATION\_AND\_CAPABILITIES: +- If it is, then the HSS may return the Server-Capabilities AVP. The returned capabilities, if any, shall satisfy all the requirements of all the service profiles associated with the IMS Subscription. If Server-Capabilities AVP is absent, it indicates to the I-CSCF that it can select any available S-CSCF. Also the HSS shall set the S-CSCF reassignment pending flag and allow overwriting of the S-CSCF name in the next SAR request, which enables the I-CSCF to select an S-CSCF. The Result-Code shall be set to DIAMETER\_SUCCESS. The HSS shall not return any S-CSCF name. Stop processing. + - Otherwise, continue to step 3. +3. Check the state of the Public Identity received in the request, and where necessary, check if the Public Identity has terminating services related to the unregistered state. +- If it is registered, the HSS shall return the stored S-CSCF name. The Server-Name AVP shall contain the SIP URI of the server. The Server-Capabilities AVP shall not be present. The Result-Code AVP shall be set to DIAMETER\_SUCCESS. + - If it is unregistered (i.e. registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored) the HSS shall return the S-CSCF name assigned for that Public Identity. The Server-Name AVP shall contain the SIP URI of the server. The Server-Capabilities AVP shall not be present. The Result-Code shall be set to DIAMETER\_SUCCESS. + - If it is not registered, but either it has terminating services related to unregistered state or the request contains the Originating-Request AVP, the HSS shall check if there is at least one Public Identity within the IMS Subscription with an S-CSCF name assigned: + - If this is the case the HSS shall return the S-CSCF name assigned for that Public Identity. The Server-Name AVP shall contain the SIP URI of the server. The Server-Capabilities AVP shall not be present. The Result-Code shall be set to DIAMETER\_SUCCESS. + - If there is not any S-CSCF name assigned to a Public Identity within the IMS Subscription, the HSS may return information about the required S-CSCF capabilities, which enables the I-CSCF to select an S-CSCF. The Server-Capabilities AVP may be present. The HSS shall send the same server capability set that is sent in the user registration status response during the registration. If Server-Capabilities AVP is not present, the I-CSCF shall understand that any S-CSCF is suitable for the IMS Subscription. The Server-Name AVP shall not be present. The Experimental-Result-Code shall be set to DIAMETER\_UNREGISTERED\_SERVICE. + - If it is not registered or unregistered, and the Public Identity has no terminating services related to the unregistered state and the request does not contain the Originating-Request AVP, the response shall contain Experimental-Result-Code set to DIAMETER\_ERROR\_IDENTITY\_NOT\_REGISTERED. + +If the HSS cannot fulfil the received request, e.g. due to database error, it shall set Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. No S-CSCF name or S-CSCF capabilities shall be present in the response. + +## 6.2 User data handling procedures + +### 6.2.1 User Profile download + +As part of the registration procedure ( TS 23.228 [1]) S-CSCF obtains user data and service related information by means of the Cx-Put Resp operation (see 6.1.2). + +### 6.2.2 HSS initiated update of User Information + +This procedure is initiated by the HSS to update at least one of the following user information in S-CSCF: + +- User profile information and/or + +- Charging information and/or +- Allowed WAF and/or WWSF Identities and/or +- SIP Digest authentication information in the S-CSCF. + +This procedure shall not be used by the HSS to add, delete, or update the value of the IMSI. + +This procedure corresponds to the functional level operation Cx-Update\_Subscr\_Data (see TS 23.228 [1]). + +This procedure is mapped to the commands Push-Profile-Request/Answer in the Diameter application specified in TS 29.229 [5]. Tables 6.2.2.1 and 6.2.2.2 describe the involved information elements. + +**Table 6.2.2.1: User Profile Update request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------------------------|-----------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Private User Identity / Private Service Identity (See 7.3 and 7.3a) | User-Name | M | Private Identity.
The HSS shall always send a Private Identity that is known to the S-CSCF based on an earlier SAR/SAA procedure. | +| User profile (See 7.7) | User-Data | C | Updated user profile (see clauses 6.5.2.1 and 6.6.1), with the format defined in clause 7.7.
It shall be present if the user profile is changed in the HSS. If the User-Data AVP is not present, the SIP-Auth-Data-Item or Charging-Information AVP or Allowed-WAF-WWSF-Identities AVP shall be present. | +| Authentication Data (See 7.9) | SIP-Auth-Data-Item | C | SIP Digest authentication information.
It shall be present if the used authentication scheme is SIP Digest and when password change has occurred in the HSS.
If the SIP-Auth-Data-Item AVP is not present, the Charging-Information or User-Data AVP or Allowed-WAF-WWSF-Identities AVP shall be present.
See Table 6.3.6 for the contents of this information element. | +| Charging Information (See 7.12) | Charging-Information | C | Addresses of the charging functions.
It shall be present if the charging addresses are changed in the HSS. If the Charging-Information AVP is not present, the SIP-Auth-Data-Item or User-Data AVP or Allowed-WAF-WWSF-Identities AVP shall be present.
When this parameter is included, either the Primary-Charging-Collection-Function-Name AVP or the Primary-Event-Charging-Function-Name AVP shall be included. All other charging information shall be included if it is available. | +| Routing Information (See 7.13) | Destination-Host | M | It contains the name of the S-CSCF which originated the last update of the name of the multimedia server stored in the HSS for a given IMS Subscription. The address of the S-CSCF is the same as the Origin-Host AVP in the message sent from the S-CSCF. | +| Allowed WAF and/or WWSF Identities (See 7.29) | Allowed-WAF-WWSF-Identities | C | Addresses of the WAFs and/or WWSFs the subscription is allowing to use.
It shall be present if the allowed WAF and/or WWSF identities are changed in the HSS. | + +**Table 6.2.2.2: User Profile Update response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|--------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result (See 7.6) | Result-Code / Experimental-Result | M | This information element indicates the result of the update of User Profile in the S-CSCF.
Result-Code AVP shall be used for errors defined in the Diameter base protocol (see IETF RFC 6733 [31]).
Experimental-Result AVP shall be used for Cx/Dx errors. This is a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | + +#### 6.2.2.1 Detailed behaviour + +The HSS shall make use of this procedure to update the relevant user information to the S-CSCF. See clauses 6.5.2.1 and 6.6.1 for the rules of user profile updating. See clause 6.5.2.3 for the rules of Charging Information update. See clause 6.5.2.4 for the rules of SIP Digest Authentication Data update. See clause 6.5.2.5 for the rules of Allowed WAF and/or WWSF Identities update. + +If there are multiple registered Private User Identities associated to the Public User Identity in the HSS, the HSS shall send only single request and select arbitrarily one of the Private User Identities and put it into the request. For updates of the profile of a Wildcarded Public Identity, the HSS shall send only one single request. That request shall contain the Wildcarded Public Identity. + +The SIP-Auth-Data-Item AVP and/or Charging-Information AVP and/or the User-Data AVP shall be present in the request. + +If the User-Data AVP is present in the request, the S-CSCF shall overwrite, for the Public Identities indicated in the User profile included in the request, current information with the information received from the HSS, except in the error situations detailed in table 6.2.2.1.1. + +If the Charging-Information AVP is present in the request, the S-CSCF shall replace the existing charging information with the information received from the HSS. + +The SIP-Auth-Data-Item AVP shall be present if the command is sent in order to update SIP Digest authentication information due to a password change. + +If the S-CSCF receives data that it can not recognise, unsupported user data in a part of the request where it may not be ignored or more data than it can accept, it shall return the corresponding error code to the HSS as indicated in table 6.2.2.1.1. The S-CSCF shall not overwrite the data that it already has to give service to the IMS Subscription. The HSS shall initiate a network-initiated de-registration procedure towards the S-CSCF with Deregistration-Reason set to SERVER\_CHANGE, which will trigger the assignment of a new S-CSCF. + +If the HSS receives DIAMETER\_ERROR\_USER\_UNKNOWN from the S-CSCF in the Push-Profile-Answer, then the HSS shall re-send the request using another arbitrarily selected registered Private Identity (if any). If restoration procedures are not supported, the HSS shall set the unknown Private User Identity's registration status to "not registered"; this will allow the synchronization of the registration status in HSS and S-CSCF. + +NOTE: If restoration procedures are supported, restoration procedures will ensure synchronization of the registration status in HSS and S-CSCF, i.e. the S-CSCF can either immediately retrieve the S-CSCF restoration information for the registered Public User Identity (sending SAR with Server Assignment Type set to NO\_ASSIGNMENT), or wait for reception of a SIP request. + +Table 6.2.2.1.1 details the valid result codes that the S-CSCF can return in the response. + +**Table 6.2.2.1.1: User information update response valid result codes** + +| Result-Code AVP value | Condition | +|----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DIAMETER_SUCCESS | The request succeeded. | +| DIAMETER_ERROR_NOT_SUPPORTED_USER_DATA | The request failed. The S-CSCF informs the HSS that the received user information contained information, which was not recognised or supported by the S-CSCF due to unsupported S-CSCF capabilities. | +| DIAMETER_ERROR_USER_UNKNOWN | The request failed because the Private Identity is not found in S-CSCF. | +| DIAMETER_ERROR_TOO_MUCH_DATA | The request failed. The S-CSCF informs to the HSS that it tried to push too much data into the S-CSCF. | +| DIAMETER_UNABLE_TO_COMPLY | The request failed. | + +## 6.3 Authentication procedures + +This procedure is used between the S-CSCF and the HSS to exchange information to support the authentication between the end user and the home IMS network. The procedure is invoked by the S-CSCF, corresponds to the combination of the operations Cx-AV-Req and Cx-AV-Req-Resp (see TS 33.203 [3]) and is used: + +- To retrieve authentication vectors from the HSS. +- To resolve synchronization failures between the sequence numbers in the UE and the HSS for authentication schemes that support this capability (e.g. IMS-AKA). +- To promote the result of the NASS-level authentication to the IMS level. +- To retrieve the IP-address secure binding information for GPRS-IMS-Bundled Authentication (GIBA) from the HSS. + +This procedure is mapped to the commands Multimedia-Auth-Request/Answer in the Diameter application specified in TS 29.229 [5]. Tables 6.3.1 through 6.3.7 detail the involved information elements. + +**Table 6.3.1: Authentication Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------|-------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Public User Identity (See 7.2) | Public-Identity | M | This information element contains the Distinct Public User Identity of the user | +| Private User Identity (See 7.3) | User-Name | M | This information element contains the Private User Identity | +| Number Authentication Items (See 7.10) | SIP-Number-Auth-Items | M | This information element indicates the number of authentication vectors requested. Certain authentication schemes do not support more than one set of authentication vectors (e.g. SIP Digest, GIBA). | +| Authentication Data (See 7.9) | SIP-Auth-Data-Item | M | See Table 6.3.2 for the contents of this information element. | +| S-CSCF Name (See 7.4) | Server-Name | M | This information element contains the name (SIP URL) of the S-CSCF. | +| Routing Information (See 7.13) | Destination-Host | C | If the S-CSCF knows the HSS name this AVP shall be present. This information is available if the MAR belongs to an already existing registration, e.g. in case of the re-registration, where the HSS name is stored in the S-CSCF. The HSS name is obtained from the Origin-Host AVP, which is received from the HSS, e.g. included in the MAA command. This information may not be available if the command is sent in case of the initial registration. In this case the Destination-Host AVP is not present and the command is routed to the next Diameter node, e.g. SLF, based on the Diameter routing table in the client. | + +**Table 6.3.2: Authentication Data content in Authentication Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------|----------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Authentication Scheme (See 7.9.2) | SIP-Authentication-Scheme | M | This information element indicates the authentication scheme. See 3GPP TS 29.229 [5] for a list of values | +| Authentication Context (See 7.9.7) | SIP-Authentication-Context | C | This information element shall contain authentication-related information relevant for performing the authentication. It shall be absent for IMS-AKA authentication schemes. | +| Authorization Information (See 7.9.4) | SIP-Authorization | C | This information element shall only be present for a request due to an IMS-AKA synchronization failure. If present, only IMS-AKA authentication schemes are allowed. | + +Table 6.3.3: Void + +Table 6.3.4: Authentication Request Response + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Identity (See 7.2) | Public-Identity | C | Public User Identity. It shall be present when the result is DIAMETER_SUCCESS. | +| Private User Identity (See 7.3) | User-Name | C | Private User Identity. It shall be present when the result is DIAMETER_SUCCESS. | +| Number Authentication Items (See 7.10) | SIP-Number-Auth-Items | C | This information element indicates the number of authentication vectors delivered in the Authentication Data information element. It shall be present when the result is DIAMETER_SUCCESS. For SIP Digest, NASS Bundled authentication and GIBA this AVP shall be set to a value of 1. | +| Authentication Data (See 7.9) | SIP-Auth-Data-Item | C | If the SIP-Number-Auth-Items AVP is equal to zero or it is not present, then this information element shall not be present. See Table 6.3.5 for the contents of this information element. | +| Result (See 7.6) | Result-Code / Experimental-Result | M | This information element indicates the result of the operation. It shall be mapped to Result-Code AVP for errors defined in the Diameter base protocol (see IETF RFC 6733 [31]). It shall be mapped to Experimental-Result AVP for Cx/Dx errors. This information element is mapped to a grouped AVP which contains the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. | + +**Table 6.3.5: Authentication Data information element content in Authentication Request Response** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------------------|---------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Item Number
(See 7.9.1) | SIP-Item-Number | C | This information element shall only be present for IMS-AKA authentication schemes.
This information element shall be present when there are multiple occurrences of the Authentication Data information element in the Authentication Request Response, and the order in which they should be processed is significant.
In this scenario, Authentication Data information elements with a low Item Number information element value should be processed before Authentication Data information elements with a high Item Number information element value. | +| Authentication Scheme
(See 7.9.2) | SIP-Authentication-Scheme | M | This information element indicates the authentication scheme. | +| Authentication Information
(See 7.9.3) | SIP-Authenticate | C | This information element shall only be present for IMS-AKA authentication schemes. | +| Authorization Information
(See 7.9.4) | SIP-Authorization | C | This information element shall only be present for IMS-AKA authentication schemes. | +| Confidentiality Key
(See 7.9.5) | Confidentiality-Key | C | This information element shall be present for IMS AKA authentication schemes.
It shall contain the confidentiality key. | +| Integrity Key
(See 7.9.6) | Integrity-Key | C | This information element shall only be present for IMS-AKA authentication schemes.
This information element shall contain the integrity key. | +| Digest Authenticate
(See 7.9.8) | SIP-Digest-Authenticate | C | This information element shall only be present for SIP Digest authentication scheme.
See Table 6.3.7 for contents of this grouped AVP. | +| Line Identifier
(See 7.9.9) | Line-Identifier | C | This information element shall only be present for NASS Bundled authentication scheme.
This information element contains fixed broadband access line identifier associated to the user. This information element can be repeated. | +| Framed IP Address
(See 7.9.10) | Framed-IP-Address | C | This information element shall only be present for GPRS-IMS-Bundled authentication scheme.
If the IP Address of the User is an IPv4 address, this AVP shall be included. | +| Framed IPv6 Prefix
(See 7.9.11) | Framed-IPv6-Prefix | C | This information element shall only be present for GPRS-IMS-Bundled authentication scheme.
If the IP Address of the User is an IPv6 address, this AVP shall be included. | +| Framed Interface Id
(See 7.9.12) | Framed-Interface-Id | C | This information element shall only be present for GPRS-IMS-Bundled authentication scheme.
If and only if the IP Address of the User is an IPv6 address and the Framed-IPv6-Prefix AVP alone is not unique for the user this AVP shall be included. | + +**Table 6.3.6: Void** + +**Table 6.3.7: Digest Authenticate information element content – Response for SIP Digest** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|----------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Digest Realm
(See 7.9.8.1) | Digest-Realm | M | This information element corresponds to the Realm parameter as defined in IETF RFC 7616 [33]. | +| Digest Algorithm
(See 7.9.8.3) | Digest-Algorithm | O | This information element contains the algorithm as defined in IETF RFC 7616 [33].
If this information element is present, it shall contain "MD5".
If neither the Digest Algorithm information element nor the Alternate Digest Algorithm information element are present, then the value "MD5" is assumed.
(NOTE 1) | +| Digest QoP
(See 7.9.8.4) | Digest-QoP | M | This information element contains the QoP as defined in IETF RFC 7616 [33]. This information element shall be set to a value of "auth" by the HSS. | +| Digest HA1
(See 7.9.8.5) | Digest-HA1 | M | This information element contains the H(A1) for algorithm "MD5" as defined in IETF RFC 7616 [33].
(NOTE 1) | +| Alternate Digest Algorithm
(See 7.9.8.6) | Alternate-Digest-Algorithm | O | This information element contains the algorithm as defined in IETF RFC 7616 [33].
(NOTE 2) | +| Alternate Digest HA1
(See 7.9.8.6) | Alternate-Digest-HA1 | O | This information element contains the H(A1), as defined in IETF RFC 7616 [33].
(NOTE 2) | + +NOTE 1: The MD5 algorithm is only supported for backward compatibility and may only be provided within the Digest Algorithm information element. +NOTE 2: If the Alternate Digest HA1 information element is present, the Digest HA1 information element shall also be present and the Digest HA1 information element shall contain the MD5 hash. The algorithm of the Alternate Digest HA1 information element shall be determined by the Alternate Digest Algorithm information element. + +**Table 6.3.8: Void****Table 6.3.9: Void** + +### 6.3.1 Detailed behaviour + +The HSS shall, in the following order (in case of an error in any of the steps the HSS shall stop processing and return the corresponding error code, see TS 29.229 [5]): + +1. Check that the Private User Identity and the Public User Identity exist in the HSS. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +2. Check that the Public User Identity matches a distinct Public User Identity in the HSS. If it doesn't, the Experimental-Result-Code shall be set to DIAMETER\_ERROR\_USER\_UNKNOWN. +3. Check whether the Private and Public User Identities in the request are associated in the HSS. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_IDENTITIES\_DONT\_MATCH. +4. Check the authentication scheme indicated in the request, and + - if it is "Unknown", check the authentication scheme stored in HSS. If it is neither NASS-Bundled authentication nor SIP Digest authentication, Experimental-Result-Code shall be set to DIAMETER\_ERROR\_AUTH\_SCHEME\_NOT\_SUPPORTED. + - if not, check that the authentication scheme indicated in the request is supported. If not Experimental-Result-Code shall be set to DIAMETER\_ERROR\_AUTH\_SCHEME\_NOT\_SUPPORTED. + +This step is only applicable for IMS-AKA authentication. If the request indicates there is a synchronization failure, the HSS shall compare the S-CSCF name received in the request to the S-CSCF name stored in the HSS: + +- If they are identical the HSS shall process AUTS as described in TS 33.203 [3] and return the requested authentication information. The Result-Code shall be set to DIAMETER\_SUCCESS. + +5. Check the registration status of the Public User Identity received in the request: + - If it is registered, the HSS shall compare the S-CSCF name received in the request to the S-CSCF name stored in the HSS: + - If they are different, the HSS shall overwrite the S-CSCF name. If IMS restoration procedures are supported and the S-CSCF reassignment pending flag is set, the HSS shall reset the flag and keep the S-CSCF restoration information associated with the Public User Identity. The HSS shall download SIP-Auth-Data-Item stored up to a maximum specified in SIP-Number-Auth-Items received in the command Multimedia-Auth-Request. If authentication scheme is neither NASS-Bundled nor GIBA, the HSS shall set the Public User Identity's authentication pending flag which is specific to the Private User Identity received in the request. The Result-Code shall be set to DIAMETER\_SUCCESS. + - If they are identical, the HSS shall download SIP-Auth-Data-Item stored up to a maximum specified in SIP-Number-Auth-Items received in the command Multimedia-Auth-Request. The Result-Code shall be set to DIAMETER\_SUCCESS. + - If it is unregistered (i.e. registered as a consequence of an originating or terminating request or there is an S-CSCF keeping the user profile stored) or not registered, the HSS shall compare the S-CSCF name received in the request to the S-CSCF name stored in the HSS: + - If they are different or if there is no S-CSCF name stored in the HSS for any Public User Identity of the IMS subscription, the HSS shall store the S-CSCF name. The HSS shall download SIP-Auth-Data-Item stored up to a maximum specified in SIP-Number-Auth-Items received in the command Multimedia-Auth-Request. If authentication scheme is neither NASS-Bundled nor GIBA, the HSS shall set the Public User Identity's authentication pending flag which is specific to the Private User Identity which was received in the request. The Result-Code shall be set to DIAMETER\_SUCCESS. + - If they are identical, the HSS shall download SIP-Auth-Data-Item stored up to a maximum specified in SIP-Number-Auth-Items received in the command Multimedia-Auth-Request. If authentication scheme is neither NASS-Bundled nor GIBA, the HSS shall set the Public User Identity's authentication pending flag which is specific to the Private User Identity that was received in the request. The Result-Code shall be set to DIAMETER\_SUCCESS. + +Exceptions to the cases specified here shall be treated by HSS as error situations, the Result-Code shall be set to DIAMETER\_UNABLE\_TO\_COMPLY. No authentication information shall be returned. + +## 6.4 User identity to HSS resolution + +The User identity to HSS resolution mechanism enables the I-CSCF and the S-CSCF to find the identity of the HSS, that holds the subscriber data for a given Public Identity when multiple and separately addressable HSSs have been deployed by the network operator. The resolution mechanism is not required in networks that utilise a single HSS. An example for a single HSS solution is server farm architecture. + +The resolution mechanism described in TS 23.228 [1] shall use a Subscription Locator Function (SLF) or a Diameter Proxy Agent. + +The I-CSCF and the S-CSCF accesses the SLF via the Dx interface. The Dx interface shall always be used in conjunction with the Cx interface. The Dx interface shall be based on the Diameter base protocol as specified in IETF RFC 6733 [31]. The SLF functionality shall use the routing mechanism provided by an enhanced Diameter redirect agent. + +The SLF or the Diameter Proxy Agent shall be able to determine the HSS identity. + +To get the HSS identity the I-CSCF and the S-CSCF shall send the Cx request normally destined to the HSS to a pre-configured Diameter address/name. + +- If this Cx Request is received by an SLF (acting as a Diameter redirect agent), the SLF shall determine the HSS identity and sends to the I-CSCF or S-CSCF a notification of redirection towards the HSS identity, in response to the Cx request. Multiple HSS identities may be included in the response, as specified in IETF RFC 6733 [31]. In such a case, the I-CSCF or the S-CSCF shall send the Cx Request to the first HSS identity in the ordered list received in the Cx Response from the SLF. If the I-CSCF or S-CSCF does not receive a successful response to + +the Cx Request, the I-CSCF or S-CSCF shall send a Cx Request to the next HSS identity in the ordered list. This procedure shall be repeated until a successful response from an HSS is received. + +- If this Cx Request is received by the Diameter Proxy Agent, the Diameter Proxy Agent shall determine the HSS identity based on the provided user identity and - if the Diameter load control mechanism is supported (see IETF IETF RFC 8583 [29]) - optionally also based on previously received load values from Load AVPs of type HOST. The Diameter Proxy Agent shall then forward the Cx request directly to the determined HSS. The I-CSCF and S-CSCF shall determine the HSS identity from the response to the Cx request received from the HSS. + +While the I-CSCF is stateless, the S-CSCF shall store the HSS identity/name/Realm, as specified in TS 23.228 [1] and shall use it in further Cx requests associated to the same IMS Public Identity. + +In networks where the use of the user identity to HSS resolution mechanism is required, each I-CSCF and S-CSCF shall be configured with the address/name of the SLF or the Diameter Proxy Agent to enable use of these resolution mechanisms. + +## 6.5 Implicit registration + +Implicit registration is the mechanism by which a user is allowed to register simultaneously more than one of his/her Public User Identities. The HSS knows the identities that are to be implicitly registered when it receives the indication of the registration of an individual identity. + +What follows is an extension of the affected basic procedures. + +### 6.5.1 S-CSCF initiated procedures + +The result of the S-CSCF initiated procedures affects all the Public User Identities that are configured in the HSS to be in the same implicitly registered Public User Identity set with the targeted individual Public User Identity. Where the S-CSCF initiated procedure affects the Registration state of the targeted Public User Identity, the Registration states of the Public User Identities in the associated implicitly registered Public User Identity set are affected in the same way. + +#### 6.5.1.1 Registration + +The notification of a registration of a Public User Identity implies the registration of the corresponding implicitly registered Public User Identity set. The user information downloaded in the response contains the Public User Identities of the implicitly registered Public User Identity set with the associated service profiles. This allows the S-CSCF to know which Public User Identities belong to the implicitly registered Public User Identity set. The S-CSCF shall take from the set of implicitly registered Public User Identities the first identity which is not barred, and use this as the default Public User Identity. The default Public User Identity shall be a distinct Public User Identity. + +#### 6.5.1.2 De-registration + +The de-registration of a Public User Identity implies the de-registration of the corresponding implicitly registered Public User Identity set, both in the HSS and in the S-CSCF. The S-CSCF shall include in the request a single Public User Identity to deregister all the Public User Identities that belong to the corresponding implicitly registered Public User Identity set. + +The de-registration of a Private User Identity implies the de-registration of all the corresponding Public User Identities, both in the HSS and in the S-CSCF. + +#### 6.5.1.3 Authentication + +Setting the authentication pending flag for a Public User Identity implies setting the authentication pending flag for each corresponding implicitly registered Public User Identity in the HSS. + +#### 6.5.1.4 Downloading the user profile + +If the S-CSCF requests to download a user profile from HSS, the user profile in the response shall contain the Public User Identities of the corresponding implicitly registered Public User Identity set with the associated service profiles. + +#### 6.5.1.5 Initiation of a session to a non-registered user + +The change of a Public User Identity to the Unregistered state due to the initiation of a session from/to a Public Identity that was in Not Registered state and the opposite change from Unregistered state to Not Registered state implies the same change for all the Public User Identities in the same Implicit Registration Set. + +### 6.5.2 HSS initiated procedures + +#### 6.5.2.1 Update of User Profile + +A request sent by the HSS to update the user profile shall include only the Public User Identities of the implicitly registered Public User Identity set, with the associated service profiles (even if not updated). If other Public User Identities not associated with the implicitly registered Public User Identity set are affected, they shall be downloaded in separate commands. + +This procedure shall be used by the HSS to add a newly provisioned or Not Registered Public User Identity or Identities to an existing implicitly registered Public User Identity set that is in the state Registered or Unregistered. The added Public User Identity gets the registration state of the set it is added to. + +The HSS shall use this procedure if a Public User Identity or Identities are removed from the implicitly registered Public User Identity set that is in a state Registered or Unregistered. In practise, this is done by sending a PPR for the set without the removed identities. The S-CSCF shall remove all information stored in the S-CSCF for the removed identities. + +The HSS shall not use this procedure if there is no Public User Identities left in the implicitly registered Public User Identity set after the removal. In that case HSS shall use the RTR command instead. + +The HSS shall not use this procedure to change the default Public User Identity of the implicitly registered Public User Identity set that is in a state Registered. In that case the HSS shall use the RTR command to de-register the Public User Identity set. + +When a change of the Reference Location Information occurs (e.g.. a change of authorization), the HSS may use a network initiated de-registration instead of this procedure, and may indicate to the S-CSCF that the de-registration is sent due to change of Reference Location Information. + +Moving of a Public User Identity or Identities from one implicitly registered Public User Identity set to another set shall be done in two steps: First the identity or identities are removed from the "old" set as described above, then the identity or identities are added to the "new" set as described above. + +#### 6.5.2.2 De-registration + +A request sent by the HSS to de-register any of the identities included in an implicitly registered Public User Identity set shall affect all the Public User Identities of the deregistered set. + +The de-registration of a Private User Identity implies the de-registration of all the corresponding Public User Identities, both in the HSS and in the S-CSCF. + +#### 6.5.2.3 Update of the Charging information + +A request sent by the HSS to update the charging information shall include the Private User Identity for whom the charging information changed. + +If corresponding Public Identity is registered or unregistered (i.e. registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored) and charging information is changed, the HSS should immediately push this information to the S-CSCF. + +#### 6.5.2.4 Update of the SIP Digest Authentication Data + +A request sent by the HSS to update the authentication data shall include the Private User Identity for whom the authentication data changed. + +If corresponding Public Identity is registered and authentication data is changed, the HSS should immediately push this information to the S-CSCF. + +If corresponding Public Identity is either not registered or unregistered (i.e. registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored), authentication pending flag is set and authentication data is changed, the HSS should immediately push this information to the S-CSCF. + +#### 6.5.2.5 Update of the Allowed WAF and/or WWSF Identities + +A request sent by the HSS to update the WAF and/or WWSF identities allowed for the subscription shall include the Private User Identity for whom this information changed. + +If corresponding Public Identity is registered and allowed WAF and/or WWSF identities are changed, the HSS should immediately push this information to the S-CSCF. + +## 6.6 Download of the Relevant User Profile and Charging Information and Allowed WAF and/or WWSF Identities + +The download of the relevant user profile, charging information and, if supported and part of subscription, allowed WAF and/or WWSF identities from the HSS to the S-CSCF depends on whether the user profile, charging information and, if supported and part of subscription, allowed WAF and/or WWSF identities are already stored in the S-CSCF. If the SiFC feature is supported by the HSS and S-CSCF, the HSS shall download the identifiers of the shared iFC sets. If either the HSS or the S-CSCF does not support the SiFC feature, the HSS shall download the complete iFCs, and SiFC identifiers shall not be downloaded by the HSS. The SiFC feature is defined in TS 29.229 [5]. + +If User-Data-Already-Available is set to USER\_DATA\_NOT\_AVAILABLE the HSS shall download the requested user profile, charging information and, if supported and part of subscription, allowed WAF and/or WWSF identities. If the Public User Identity in the request is included in an implicitly registered Public User Identity set, the HSS shall include in the response the service profiles associated with all Public User Identities within the implicitly registered Public User Identity set to which the received Public User Identity belongs. + +If User-Data-Already-Available is set to USER\_DATA\_ALREADY\_AVAILABLE, the HSS should not return any user profile or charging information data or allowed WAF and/or WWSF identities. The HSS may override User-Data-Already-Available set to USER\_DATA\_ALREADY\_AVAILABLE and download the user profile, charging information and, if supported and part of subscription, allowed WAF and/or WWSF identities. + +### 6.6.1 HSS initiated update of User Profile + +The request to update the user profile in the S-CSCF includes only the Public User Identities of the implicitly registered Public User Identity set with the associated service profiles. See 6.5.2.1. + +If the Public Identity is registered or unregistered (i.e. registered as a consequence of an originating or terminating request or there is a S-CSCF keeping the user profile stored) and there are changes in the user profile, the HSS should immediately push the complete user profile to the S-CSCF. + +### 6.6.2 S-CSCF operation + +At deregistration of a Public User Identity, the S-CSCF shall store the user information if it sends Server-Assignment-Request command including Server-Assignment-Type AVP set to value USER\_DEREGISTRATION\_STORE\_SERVER\_NAME or TIMEOUT\_DEREGISTRATION\_STORE\_SERVER\_NAME and the HSS responds with DIAMETER\_SUCCESS. Otherwise the S-CSCF shall not keep user information. + +## 6.7 S-CSCF Assignment + +The list of mandatory and optional capabilities received by an I-CSCF from the HSS allows operators to distribute users between S-CSCFs, depending on the different capabilities (e.g. features, role, geographical location) that each S-CSCF may have. Alternatively, an operator has the possibility to steer users to certain S-CSCFs. + +The operator shall define (possibly based on the functionality offered by each S-CSCF installed in the network) the exact meaning of the S-CSCF mandatory and optional capabilities available in his network. It is an operator task to allocate a unique value to represent a single capability (e.g. support of "wildcarded PSI") or a set of capabilities (e.g. support of "alias" and "Shared IFC sets" and "wildcarded PSI") and to use these values to identify capabilities that are mandatory and/or optional to support for a given subscription. It is a configuration task for the operator to ensure that the I-CSCF has a correct record of the capability values received from the HSS for each S-CSCF available in his network. The I-CSCF and the HSS do not need to know the semantic of these values. This semantic is exclusively an operator issue. + +As a first choice, the I-CSCF shall select an S-CSCF that has all the mandatory and optional capabilities for the user. Only if that is not possible shall the I-CSCF apply a 'best-fit' algorithm. If more than one S-CSCF is identified that supports all mandatory capabilities the I-CSCF may then consider optional capabilities in selecting a specific S-CSCF. The 'best-fit' algorithm is implementation dependent and out of the scope of this specification. + +It is the responsibility of the operator to ensure that there are S-CSCFs which have mandatory capabilities indicated by the HSS for any given user. However, configuration errors may occur. If such errors occur and they prevent the I-CSCF from selecting an S-CSCF which meets the mandatory capabilities indicated by the HSS, the I-CSCF shall inform the operator via the O&M subsystem. + +As an alternative to selecting an S-CSCF based on the list of capabilities received from the HSS, it is possible to steer users to certain S-CSCFs. To do this, the operator may include one or more S-CSCF names as part of the capabilities of the user profile. The reason for the selection (e.g. all the users belonging to the same company/group could be in the same S-CSCF to implement a VPN service) and the method of selection are operator issues and out of the scope of this specification. If this alternative is chosen, the HSS shall include Server-Name AVPs in the Server-Capabilities AVP and should not include Mandatory-Capability AVPs or Optional-Capability AVPs in the Server-Capabilities AVP, and the I-CSCF when receiving Server-Name AVPs within the Server-Capabilities AVP shall discard any Mandatory-Capability AVP and any Optional-Capability AVP received within the Server-Capabilities AVP. + +The following table is a guideline for operators that records S-CSCF capabilities that need to be supported by an S-CSCF in order to serve a user or a service (identified by a Public User Identity or Public Service Identity), that cannot be served by an S-CSCF which is only compliant to a previous 3GPP release. + +Table 6.7: Guidelines for S-CSCF Capabilities + +| Capability | Mandatory or Optional (NOTE 1) | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Support of "Wildcarded PSI" | M | This capability indicates that the assigned S-CSCF shall support the handling of Wildcarded PSIs. | +| Support of "OrigUnreg SPT" | M | This capability indicates that the assigned S-CSCF shall be able to process iFCs with a Session Case "Originating_Unregistered" received from the HSS in the user profile. | +| Support of "OrigCDIV SPT" | M | This capability indicates that the assigned S-CSCF shall be able to process iFCs with a Session Case "Originating_CDIV" received from the HSS in the user profile. | +| Support of "Shared iFC sets" | O | This capability indicates that the assigned S-CSCF may support the "SiFC" feature defined in 3GPP TS 29.229 [5]. | +| Support of "Display Name" | O | This capability indicates that the assigned S-CSCF may support the handling of "Display Name". The behaviour of the S-CSCF related to this missing data is the same as if the HSS did not send the Display Name. | +| Support of "Alias" | O | This capability indicates that the assigned S-CSCF may support the "AliasInd" feature defined in 3GPP TS 29.229 [5]. | +| Support of "SIP Digest Authentication" | M | This capability indicates that the assigned S-CSCF shall support the handling of SIP Digest Authentication. | +| Support of "NASS Bundled Authentication" | M | This capability indicates that the assigned S-CSCF shall support the handling of NASS Bundled Authentication. | +| Support of "Wildcarded IMPUs" | M | This capability indicates that the assigned S-CSCF shall support the handling of Wildcarded Public User Identities. | +| Support of "Loose-Route " | M | This capability indicates that the assigned S-CSCF shall support the loose-route mechanism. | +| Support of "Service Level Trace" | M | This capability indicates that the assigned S-CSCF shall support the Service Level Trace mechanism. | +| Support of "Priority Service" | M | This capability indicates that the S-CSCF shall support a network default pre-configured namespace (e.g. "wps") and the associated Service Priority Level. See IETF RFC 4412 [22] and 3GPP TS 24.229 [8]. | +| Support of "Extended Priority " (NOTE 2) | M | This capability indicates that the S-CSCF shall support the Priority Namespaces and their associated Priority Levels. See IETF RFC 4412 [22] and 3GPP TS 24.229 [8]. | +| Support of "Early IMS Security" | M | This capability indicates that the assigned S-CSCF shall support GIBA. | +| Support of "Reference Location" | M | This capability indicates that the assigned S-CSCF shall support the handling of reference location as defined in 3GPP TS 23.167 [23]. | +| Support of "Privileged-Sender" | M | This capability indicates that the S-CSCF shall support privileged sender. See 3GPP TS 24.229 [8]. | +| Support of "IMSI" | M | This capability indicates that the assigned S-CSCF shall support the handling of the IMSI. | +| Support of "Maximum Number of allowed simultaneous registrations" | M | This capability indicates that the assigned S-CSCF shall support the handling of maximum number of allowed simultaneous registrations per user as received from the HSS. | +| NOTE 1: Mandatory (M) corresponds to a Mandatory Capability that shall be supported by the assigned S-CSCF for a given user. The I-CSCF shall not select an S-CSCF that does not meet a mandatory capability. The selection of a S-CSCF not supporting this capability would lead to an unspecified network behaviour.

Optional (O) corresponds to an Optional Capability that may be supported by the assigned S-CSCF for a given user. The selection of a S-CSCF that would not support this capability will not significantly affect the network behaviour. | | | +| NOTE 2: Support of "Extended Priority " is backward compatible with continued support of the "Priority Service". | | | + +# --- 7 Information element contents + +## 7.1 Visited Network Identifier + +This information element contains the domain name of the visited network. + +## 7.2 Public User Identity + +This information element contains the Public User Identity. For definition of a Public User Identity, see TS 23.003 [17]. + +When GPRS-IMS-Bundled Authentication (GIBA) is used, a Temporary Public User Identity is derived from the IMSI used for bearer network access according to the rules in TS 23.003 [17]. + +### 7.2a Public Service Identity + +This information element contains a Public Service Identity (PSI) that is hosted by an application server. For definition of a PSI, see TS 23.003 [17]. + +### 7.2b Wildcarded Public Identity + +This information element contains a Wildcarded PSI that is hosted by an application server or a Wildcarded Public User Identity. For definition of a Wildcarded PSI and a Wildcarded Public User Identity, see TS 23.003 [17]. + +### 7.2c Void + +## 7.3 Private User Identity + +This information element contains the Private User Identity. For definition of a Private User Identity, see TS 23.003 [17]. + +When GPRS-IMS-Bundled Authentication (GIBA) is used, the Private User Identity is derived from the IMSI as specified in TS 33.203 [3]. + +### 7.3a Private Service Identity + +This information element contains the Private Service Identity. For definition of a Private Service Identity, see TS 23.003 [17]. + +## 7.4 S-CSCF Name + +This information element contains the S-CSCF Name of the S-CSCF assigned to an IMS Subscription. For definition of a S-CSCF Name, see TS 23.008 [18]. + +### 7.4a AS Name + +This information element contains the AS Name of the AS hosting a Public Service Identity. For definition of AS Name, see TS 23.008 [18]. + +## 7.5 S-CSCF Capabilities + +This information element carries information to assist the I-CSCF during the process of selecting an S-CSCF for a certain IMS Subscription. + +## 7.6 Result + +This information element contains result of an operation. See TS 29.229 [5] for the possible values. + +## 7.7 User Profile + +This information element contains the user profile in XML format. The user profile XML shall be valid against the user profile XML schema defined in Annex E. + +Annex B specifies the UML logical model of the user profile downloaded via the Cx interface. + +Annex D contains and informative, high level representation, of the wire representation of user profile data. + +## 7.8 Server Assignment Type + +Indicates the type of server assignment. See TS 29.229 [5] for the list of existing values. + +## 7.9 Authentication Data + +This information element is composed of the following sub-elements. + +### 7.9.1 Item Number + +This information element indicates the order in which the authentication vectors are to be consumed. See TS 29.229 [5] for coding details. + +### 7.9.2 Authentication Scheme + +This information element contains the authentication scheme, which is used to encode the authentication parameters. See TS 29.229 [5] for a list of values. + +### 7.9.3 Authentication Information + +This information element is used to convey the challenge and authentication token used during the authentication procedure, see TS 33.203 [3] for more information. See TS 29.229 [5] for coding details. + +### 7.9.4 Authorization Information + +This information element is used, in an authentication request, to indicate a failure of synchronization. In a response, it is used to convey the expected response to the challenge used to authenticate the user, see TS 33.203 [3] for more information. See TS 29.229 [5] for coding details. + +### 7.9.5 Confidentiality Key + +This information element contains the confidentiality key, see TS 33.203 [3] for more information. See TS 29.229 [5] for coding details. + +### 7.9.6 Integrity Key + +This information element contains the integrity key, see TS 33.203 [3] for more information. See TS 29.229 [5] for coding details. + +### 7.9.7 Authentication Context + +This information element contains authentication-related information relevant for performing the authentication but that is not part of the SIP authentication headers. Some mechanisms (e.g. PGP, digest with quality of protection set to "auth-int" defined in IETF RFC 7616 [33], digest with predictive nonces or sip access digest) request that part or the whole SIP request (e.g. the SIP method) is passed to the entity performing the authentication. In such cases the SIPAuthentication-Context AVP shall be carrying such information. + +See TS 29.229 [5] for coding details. + +### 7.9.8 Digest Authenticate + +This information element is composed of the following sub-elements. + +#### 7.9.8.1 Digest Realm + +This information element is part of the Digest authentication challenge, and corresponds to the Realm parameter as defined in IETF RFC 3261 [11]. This information element is used to convey the Realm to the S-CSCF during the SIP Digest authentication procedure. See TS 29.229 [5] for coding details. + +#### 7.9.8.2 Void + +#### 7.9.8.3 Digest Algorithm + +This information element is part of the Digest authentication challenge, defined in IETF RFC 7616 [33]. See TS 29.229 [5] for coding details. + +#### 7.9.8.4 Digest QoP + +This information element is part of the Digest authentication challenge, defined in IETF RFC 7616 [33]. It provides the Quality of Protection indication and has an effect on the digest computation. See TS 29.229 [5] for coding details. + +#### 7.9.8.5 Digest HA1 + +This information element is part of the Digest authentication challenge, defined in IETF RFC 7616 [33]. See TS 29.229 [5] for coding details. + +#### 7.9.8.6 Alternate Digest Algorithm + +This information element is part of the Digest authentication challenge, defined in IETF RFC 7616 [33]. See TS 29.229 [5] for coding details. + +#### 7.9.8.7 Alternate Digest HA1 + +This information element is part of the Digest authentication challenge, defined in IETF RFC 7616 [33]. See TS 29.229 [5] for coding details. + +### 7.9.9 Line Identifier + +This information element contains the line identifier of the user's network termination. See TS 29.229 [5] for coding details. + +### 7.9.10 Framed IP Address + +See TS 29.229 [5] for more information. + +### 7.9.11 Framed IPv6 Prefix + +See TS 29.229 [5] for more information. + +### 7.9.12 Framed Interface Id + +See TS 29.229 [5] for more information. + +## 7.10 Number Authentication Items + +This information element contains the number of authentication vectors requested or delivered. + +## 7.11 Reason for de-registration + +This information element contains the reason for a de-registration procedure. + +## 7.12 Charging information + +Addresses of the charging functions. See TS 29.229 [5]. + +## 7.13 Routing information + +Information to route requests. + +## 7.14 Type of authorization + +Type of authorization requested by the I-CSCF. See TS 29.229 [5] for a list of values. + +## 7.15 Void + +Void + +## 7.16 User Data Already Available + +This information element indicates to the HSS if the user profile is already available in the S-CSCF. See TS 29.229 [5] for a list of values. + +## 7.17 Associated Private Identities + +This information element indicates to the S-CSCF the Private Identities, which belong to the same IMS Subscription as the Private Identity received in the request command. See TS 29.229 [5]. + +## 7.18 Originating-Request + +This information element indicates to the HSS that the request is related to an originating SIP message. See 3GPP 29.229 [5]. + +## 7.19 User Authorization Request Flags + +This information element carries the following indication (see 3GPP 29.229 [5] for coding details): + +- IMS Emergency Registration. + +## 7.20 Loose-Route Indication + +This information element indicates to the S-CSCF that the loose-route mechanism shall be applied to the public identities contained in the user profile received from the HSS. See TS 29.229 [5]. This information is static data for the duration of the subscription or the validity of the IMS identity. Modification of this data result in Network Initiated Deregistration (SERVER\_CHANGE); see clause 6.1.3.1. + +## 7.21 S-CSCF Restoration Information + +This information element contains information for the S-CSCF to handle traffic for a registered user. It is associated with the Private User Identity and the Implicit Registration Set that is affected by the SAR request. See TS 29.229 [5] for the contents of this information element. + +## 7.22 Associated Registered Private Identities + +This information element indicates to the S-CSCF the Registered Private Identities, which were registered with the Public Identity received in the request command. See TS 29.229 [5]. + +## 7.23 Multiple Registration Indication + +This information element indicates to the HSS that this is related to a multiple registration. See TS 29.229 [5]. + +## 7.24 Session-Priority + +This information element indicates the session's priority level to the HSS. See TS 29.229 [5]. + +## 7.25 Identities with Emergency Registration + +This information element indicates to the HSS a list of pairs of Private / Public Identities that are emergency registered. See TS 29.229 [5]. + +## 7.26 Privileged-Sender Indication + +This information element indicates to the S-CSCF that the Private User Identity shall be considered as a privileged sender, as described in TS 24.229 [8]. + +## 7.27 LIA Flags + +This information element carries the following indications. See TS 29.229 [5] for coding details. + +- PSI Direct Routing Indication + +## 7.28 Server Assignment Request Flags + +This information element carries the following indication (see 3GPP 29.229 [5] for coding details): + +- P-CSCF Restoration Indication + +## 7.29 Allowed WAF and/or WWSF Identities + +Addresses of the WebRTC Authentication Functions and/or WebRTC Web Server Functions allowed for a subscription. See TS 33.203 [3]. + +## 7.30 RTR Flags + +This information element carries the following indications. See TS 29.229 [5] for coding details. + +- Reference Location Information change + +## 7.31 Failed-PSCF + +This information element indicates to the HSS the address of a failed P-CSCF, as detected by the S-CSCF. + +# --- 8 Error handling procedures + +## 8.1 Registration error cases + +This clause describes the handling of error cases, which can occur during the registration process. If the new and previously assigned S-CSCF names sent in the Multimedia-Auth-Request command are different and the Multimedia-Auth-Request is not indicating synchronisation failure (i.e. the request does not contain *auts* parameter), then the HSS shall overwrite the S-CSCF name. + +If the new and previously assigned S-CSCF names sent in a command other than the Multimedia-Auth-Request command are different and the S-CSCF reassignment pending flag is not set, then the HSS shall not overwrite the S-CSCF name; instead it shall send a response to the S-CSCF indicating an error. + +### 8.1.1 Cancellation of the old S-CSCF + +It is possible that in certain situations the HSS receives a Multimedia-Auth-Request (MAR) command including a S-CSCF name, which is not the same as the previously assigned S-CSCF for the user. This can happen e.g. in case the new S-CSCF is selected due to a failure in the re-registration if the previously assigned S-CSCF does not respond to REGISTER message sent from the I-CSCF after a timeout. + +In this case, the new S-CSCF is assigned for the user and if registrations in the previously assigned S-CSCF exist for the user, these registrations in the old S-CSCF are handled locally in the old S-CSCF, e.g. re-registration timers in the old S-CSCF shall cancel the registrations. + +Additionally, the HSS should de-register the registrations in the old S-CSCF by using the Registration-Termination-Request command. In this case, the HSS shall first check whether the deregistration is really required by comparing the Diameter client address of the newly assigned S-CSCF received in the MAR command to the Diameter client address stored in the HSS. If the Diameter client addresses match, the deregistration shall not be initiated. Otherwise the deregistration should be initiated for all the registered Public User Identities for the corresponding IMS Subscription. HSS shall check whether IMS Restoration Procedures are supported to perform deregistration: + +- If supported, Registration-Termination-Request shall be sent for all Public User Identities (with their associated Private User Identities), with Deregistration-Reason AVP value set to NEW\_SERVER\_ASSIGNED. +- Otherwise, Registration-Termination-Request shall be sent with different Deregistration-Reason AVP values, in the following order: + 1. Deregistration-Reason AVP value set to NEW\_SERVER\_ASSIGNED, for the Public User Identity (with its associated Private User Identity), which is registered in the new S-CSCF. + 2. Deregistration-Reason AVP value set to SERVER\_CHANGE, for the user Public User Identities (with their associated Private User Identities), which are not yet registered in the new S-CSCF. + +### 8.1.2 Error in S-CSCF name + +If the S-CSCF name sent in the Server-Assignment-Request command and the previously assigned S-CSCF name stored in the HSS are different and the S-CSCF reassignment pending flag is not set, then the HSS shall not overwrite the S-CSCF name. If the Server Assignment Type indicates NO\_ASSIGNMENT, the HSS shall send a response to the S-CSCF with Result-Code value set to DIAMETER\_UNABLE\_TO\_COMPLY. For all other Server Assignment Types, the HSS shall send a response to the S-CSCF with Experimental-Result-Code value set to DIAMETER\_ERROR\_IDENTITY\_ALREADY\_REGISTERED. + +If the S-CSCF name sent in the Server-Assignment-Request command and the previously assigned S-CSCF name stored in the HSS are different and IMS Restoration Procedures are supported and the S-CSCF reassignment pending flag is set, then the HSS shall allow overwriting of the S-CSCF name and proceed with the processing of the SAR command as defined in clause 6.1.2. + +### 8.1.3 Error in S-CSCF assignment type + +If the Server-Assignment-Type in the Server-Assignment-Request command sent by the S-CSCF to the HSS is not allowed (i.e if the Server-Assignment-Type is not applicable based on the user state or it is not applicable based on the user identity type), the HSS shall send a response to the S-CSCF with the Experimental-Result-Code value set to DIAMETER\_ERROR\_IN\_ASSIGNMENT\_TYPE. + +# --- 9 Protocol version identification + +See TS 29.229 [5]. + +# --- 10 Operational Aspects + +See TS 29.229 [5]. + +# Annex A (normative): Mapping of Cx operations and terminology to Diameter + +## A.1 Introduction + +This appendix gives mappings from Cx to Diameter protocol elements. Diameter protocol elements are defined in TS 29.229 [5]. + +## A.2 Cx message to Diameter command mapping + +The following table defines the mapping between stage 2 operations and Diameter commands: + +**Table A.2.1: Cx message to Diameter command mapping** + +| Cx message | Source | Destination | Command-Name | Abbreviation | +|-------------------------------------|--------|-------------|-----------------------------------|--------------| +| Cx-Query + Cx-Select-Pull | I-CSCF | HSS | User-Authorization-Request | UAR | +| Cx-Query Resp + Cx-Select-Pull Resp | HSS | I-CSCF | User-Authorization-Answer | UAA | +| Cx-Put + Cx-Pull | S-CSCF | HSS | Server-Assignment-Request | SAR | +| Cx-Put Resp + Cx-Pull Resp | HSS | S-CSCF | Server-Assignment-Answer | SAA | +| Cx-Location-Query | I-CSCF | HSS | Location-Info-Request | LIR | +| Cx-Location-Query Resp | HSS | I-CSCF | Location-Info-Answer | LIA | +| Cx-AuthDataReq | S-CSCF | HSS | Multimedia-Authentication-Request | MAR | +| Cx-AuthDataResp | HSS | S-CSCF | Multimedia-Authentication-Answer | MAA | +| Cx-Deregister | HSS | S-CSCF | Registration-Termination-Request | RTR | +| Cx-Deregister Resp | S-CSCF | HSS | Registration-Termination-Answer | RTA | +| Cx-Update Subscr Data | HSS | S-CSCF | Push-Profile-Request | PPR | +| Cx-Update Subscr Data Resp | S-CSCF | HSS | Push-Profile-Answer | PPA | + +## A.3 Cx message parameters to Diameter AVP mapping + +The following table gives an overview about the mapping: + +**Table A.3.1: Cx message parameters to Diameter AVP mapping** + +| Cx parameter | AVP Name | +|----------------------------|----------------------------| +| Visited Network Identifier | Visited-Network-Identifier | +| Public Identity | Public-Identity | +| Private Identity | User-Name | +| S-CSCF Name | Server-Name | +| AS Name | | +| S-CSCF capabilities | Server-Capabilities | +| Result | Result-Code | +| | Experimental-Result-Code | + +| Cx parameter | AVP Name | +|------------------------------------|----------------------------------| +| User profile | User-Data | +| Server Assignment Type | Server-Assignment-Type | +| Authentication data | SIP-Auth-Data-Item | +| Item Number | SIP-Item-Number | +| Authentication Scheme | SIP-Authentication-Scheme | +| Authentication Information | SIP-Authenticate | +| Authorization Information | SIP-Authorization | +| Confidentiality Key | Confidentiality-Key | +| Integrity Key | Integrity-Key | +| Number Authentication Items | SIP-Number-Auth-Items | +| Reason for de-registration | Deregistration-Reason | +| Charging Information | Charging-Information | +| Routing Information | Destination-Host | +| Type of Authorization | Authorization-Type | +| Associated Private Identities | Associated-Identities | +| Digest Authenticate | SIP-Digest-Authenticate | +| Digest Realm | Digest-Realm | +| Digest Algorithm | Digest-Algorithm | +| Digest QoP | Digest-QoP | +| Digest HA1 | Digest-HA1 | +| Alternate Digest Algorithm | Alternate-Digest-Algorithm | +| Alternate Digest HA1 | Alternate-Digest-HA1 | +| Line Identifier | Line-Identifier | +| Wildcarded Public Identity | Wildcarded-Public Identity | +| Loose-Route Indication | Loose-Route-Indication | +| S-CSCF Restoration Information | SCSCF-Restoration-Info | +| Multiple Registration Indication | Multiple-Registration-Indication | +| Privileged-Sender Indication | Privileged-Sender-Indication | +| LIA Flags | LIA-Flags | +| Allowed WAF and/or WWSF Identities | Allowed-WAF-WWSF-Identities | + +## A.4 Message flows + +The following message flows give examples regarding which Diameter messages shall be sent in scenarios described in TS 23.228 [1]. + +### A.4.1 Registration– user not registered + +![Sequence diagram for Registration - user not registered. Lifelines: UA, P-CSCF, I-CSCF, HSS, S-CSCF. The process involves a failed initial registration, followed by an authentication challenge and a subsequent successful registration.](40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg) + +``` + +sequenceDiagram + participant UA + participant P-CSCF + participant I-CSCF + participant HSS + participant S-CSCF + + Note left of P-CSCF: Visited Network + Note right of I-CSCF: Home Network + + UA->>P-CSCF: 1. Register + P-CSCF->>I-CSCF: 2. Register + I-CSCF->>HSS: 3. UAR + HSS-->>I-CSCF: 4. UAA + Note right of I-CSCF: S-CSCF selection + I-CSCF->>S-CSCF: 5. Register + S-CSCF->>HSS: 6. MAR + Note right of HSS: Authentication vector selection + HSS-->>S-CSCF: 7. MAA + S-CSCF-->>I-CSCF: 8. 401 Unauthorised + Note right of S-CSCF: Authentication Information + I-CSCF-->>P-CSCF: 9. 401 Unauthorised + Note right of I-CSCF: Authentication Information + P-CSCF-->>UA: 10. 401 Unauthorised + Note right of P-CSCF: Authentication Information + UA->>P-CSCF: 11. Register response + P-CSCF->>I-CSCF: 12. Register response + I-CSCF->>HSS: 13. UAR + HSS-->>I-CSCF: 14. UAA + I-CSCF->>S-CSCF: 15. Register response + Note right of S-CSCF: Authentication + S-CSCF->>HSS: 18. SAR + HSS-->>S-CSCF: 19. SAA + S-CSCF-->>I-CSCF: 20. OK + I-CSCF-->>P-CSCF: 21. OK + P-CSCF-->>UA: 22. OK + +``` + +Sequence diagram for Registration - user not registered. Lifelines: UA, P-CSCF, I-CSCF, HSS, S-CSCF. The process involves a failed initial registration, followed by an authentication challenge and a subsequent successful registration. + +Figure A.4.1.1: Registration – user not registered + +### A.4.2 Registration – user currently registered + +![Sequence diagram for Re-registration (A.4.2.1)](a0e8fe7862a6d7341faf5dac275277cc_img.jpg) + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant I-CSCF + participant HSS + participant S-CSCF + Note left of UE: Visited Network + Note right of S-CSCF: Home Network + UE->>P-CSCF: 1. Register + P-CSCF->>I-CSCF: 2. Register + I-CSCF->>HSS: 3. UAR + HSS-->>I-CSCF: 4. UAA + I-CSCF->>S-CSCF: 5. Register + S-CSCF->>HSS: 6. SAR + HSS-->>S-CSCF: 7. SAA + S-CSCF->>I-CSCF: 8. 200 OK + I-CSCF->>P-CSCF: 9. 200 OK + P-CSCF->>UE: 10. 200 OK +``` + +Sequence diagram illustrating the Re-registration process (A.4.2.1). The diagram shows the interaction between the UE (User Equipment) in the Visited Network and the Home Network components (P-CSCF, I-CSCF, HSS, S-CSCF). The process starts with the UE sending a '1. Register' message to the P-CSCF. The P-CSCF forwards it as '2. Register' to the I-CSCF. The I-CSCF sends a '3. UAR' to the HSS, which responds with '4. UAA'. The I-CSCF then sends a '5. Register' to the S-CSCF. The S-CSCF sends a '6. SAR' to the HSS, which responds with '7. SAA'. The S-CSCF then sends a '8. 200 OK' response back to the I-CSCF, which in turn sends a '9. 200 OK' to the P-CSCF, which finally sends a '10. 200 OK' to the UE. + +Sequence diagram for Re-registration (A.4.2.1) + +Figure A.4.2.1: Re-registration + +### A.4.3 UE initiated de-registration + +![Sequence diagram for UE initiated de-registration (A.4.3.1)](c0c7f65c51c83fbe595b47326f6b089a_img.jpg) + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant I-CSCF + participant HSS + participant S-CSCF + Note left of UE: Visited Network + Note right of S-CSCF: Home Network + UE->>P-CSCF: 1. REGISTER + P-CSCF->>I-CSCF: 2. REGISTER + I-CSCF->>HSS: 3. UAR + HSS-->>I-CSCF: 4. UAA + I-CSCF->>S-CSCF: 5. REGISTER + S-CSCF->>HSS: 6. SAR + HSS-->>S-CSCF: 7. SAA + S-CSCF->>I-CSCF: 8. 200 OK + I-CSCF->>P-CSCF: 9. 200 OK + P-CSCF->>UE: 10. 200 OK +``` + +Sequence diagram illustrating the UE initiated de-registration process (A.4.3.1). The diagram shows the interaction between the UE (User Equipment) in the Visited Network and the Home Network components (P-CSCF, I-CSCF, HSS, S-CSCF). The process starts with the UE sending a '1. REGISTER' message to the P-CSCF. The P-CSCF forwards it as '2. REGISTER' to the I-CSCF. The I-CSCF sends a '3. UAR' to the HSS, which responds with '4. UAA'. The I-CSCF then sends a '5. REGISTER' to the S-CSCF. The S-CSCF sends a '6. SAR' to the HSS, which responds with '7. SAA'. The S-CSCF then sends a '8. 200 OK' response back to the I-CSCF, which in turn sends a '9. 200 OK' to the P-CSCF, which finally sends a '10. 200 OK' to the UE. + +Sequence diagram for UE initiated de-registration (A.4.3.1) + +Figure A.4.3.1: UE initiated de-registration + +### A.4.4 Network initiated de-registration + +#### A.4.4.1 Registration timeout + +![Sequence diagram for registration timeout de-registration](195611c20b2dc7ed0fa3033392e22908_img.jpg) + +This sequence diagram illustrates the network-initiated de-registration process due to a registration timeout. It involves four entities: UE, P-CSCF, S-CSCF, and HSS. The process begins with internal timer expirations at both the P-CSCF and S-CSCF. The S-CSCF then sends a SAR (Service Authorization Request) to the HSS, which responds with an SAA (Service Authorization Answer). + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant S-CSCF + participant HSS + Note right of P-CSCF: 1. Timer Expires + Note right of S-CSCF: 1. Timer Expires + S-CSCF->>HSS: 2. SAR + HSS-->>S-CSCF: 3. SAA +``` + +Sequence diagram for registration timeout de-registration + +Figure A.4.4.1.1: Network initiated de-registration – registration timeout + +#### A.4.4.2 Administrative de-registration + +![Sequence diagram for administrative de-registration](db5deafdae53dbc7d5972957f708c691_img.jpg) + +This sequence diagram illustrates the network-initiated administrative de-registration process. It involves four entities: UE, P-CSCF, S-CSCF, and HSS. The process starts with the HSS sending an RTR (Re-Registration) message to the S-CSCF. The S-CSCF then sends a Deregister message to the P-CSCF, which in turn sends a UE Inform message to the UE. The UE responds with an OK 200 message to the P-CSCF, which then forwards an OK 200 message to the S-CSCF. Finally, the S-CSCF sends an RTA (Re-Registration Timer Activation) message to the HSS. + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant S-CSCF + participant HSS + HSS->>S-CSCF: 1. RTR + S-CSCF->>P-CSCF: 2. Deregister + P-CSCF->>UE: 3. UE Inform + UE-->>P-CSCF: 4. OK 200 + P-CSCF-->>S-CSCF: 5a. OK 200 + S-CSCF->>HSS: 5. RTA +``` + +Sequence diagram for administrative de-registration + +Figure A.4.4.2.1: Network initiated de-registration – administrative de-registration + +#### A.4.4.3 De-registration initiated by service platform + +![Sequence diagram for network initiated de-registration initiated by service platform. Lifelines: UE, P-CSCF, S-CSCF, HSS. Steps: 1. Service Control (S-CSCF internal), 2. Deregister (S-CSCF to P-CSCF), 3. UE Inform (P-CSCF to UE), 4. OK 200 (P-CSCF to S-CSCF), 5. OK 200 (UE to P-CSCF), 6. SAR (S-CSCF to HSS), 7. SAA (HSS to S-CSCF).](9e8ebf03cae78f4f81b697548c2d7250_img.jpg) + +``` +sequenceDiagram + participant UE + participant P-CSCF + participant S-CSCF + participant HSS + Note right of S-CSCF: 1. Service Control + S-CSCF->>P-CSCF: 2. Deregister + P-CSCF->>UE: 3. UE Inform + P-CSCF->>S-CSCF: 4. OK 200 + UE-->>P-CSCF: 5. OK 200 + S-CSCF->>HSS: 6. SAR + HSS->>S-CSCF: 7. SAA +``` + +Sequence diagram for network initiated de-registration initiated by service platform. Lifelines: UE, P-CSCF, S-CSCF, HSS. Steps: 1. Service Control (S-CSCF internal), 2. Deregister (S-CSCF to P-CSCF), 3. UE Inform (P-CSCF to UE), 4. OK 200 (P-CSCF to S-CSCF), 5. OK 200 (UE to P-CSCF), 6. SAR (S-CSCF to HSS), 7. SAA (HSS to S-CSCF). + +Figure A.4.4.3.1: Network initiated de-registration – initiated by service platform + +### A.4.5 UE Terminating SIP session set-up + +![Sequence diagram for UE Terminating SIP session set-up. Lifelines: I-CSCF, HSS, S-CSCF (under Home Network). Steps: 1. INVITE (External to I-CSCF), 2. LIR (I-CSCF to HSS), 3. LIA (HSS to I-CSCF), 5. INVITE (I-CSCF to S-CSCF).](21327313f7b18a481da0c87a6472a80d_img.jpg) + +``` +sequenceDiagram + participant I-CSCF + participant HSS + participant S-CSCF + Note over I-CSCF, HSS, S-CSCF: Home Network + External->>I-CSCF: 1. INVITE + I-CSCF->>HSS: 2. LIR + HSS->>I-CSCF: 3. LIA + I-CSCF->>S-CSCF: 5. INVITE +``` + +Sequence diagram for UE Terminating SIP session set-up. Lifelines: I-CSCF, HSS, S-CSCF (under Home Network). Steps: 1. INVITE (External to I-CSCF), 2. LIR (I-CSCF to HSS), 3. LIA (HSS to I-CSCF), 5. INVITE (I-CSCF to S-CSCF). + +Figure A.4.5.1: UE Terminating SIP session set-up + +### A.4.6 Initiation of a session to a non-registered user + +![Sequence diagram for Initiation of a session to a non-registered user](2cf3896394a2342a2b46c504ab9a8830_img.jpg) + +``` + +sequenceDiagram + participant External + participant I-CSCF + participant HSS + participant S-CSCF + + External->>I-CSCF: 1. INVITE + I-CSCF->>HSS: 2. LIR + HSS-->>I-CSCF: 3. LIA + Note left of I-CSCF: 4. S-CSCF Selection + I-CSCF->>S-CSCF: 5. INVITE + S-CSCF->>HSS: 6. SAR + HSS-->>S-CSCF: 7. SAA + Note right of S-CSCF: 8. Service Control + Note right of S-CSCF: 9. S-CSCF performs further actions + +``` + +The sequence diagram illustrates the interaction for initiating a session to a non-registered user. It involves four lifelines: External, I-CSCF, HSS, and S-CSCF. The process starts with an INVITE from the External entity to the I-CSCF. The I-CSCF sends a LIR to the HSS, which responds with a LIA. The I-CSCF then performs S-CSCF Selection and sends an INVITE to the S-CSCF. The S-CSCF sends a SAR to the HSS, which responds with a SAA. Finally, the S-CSCF performs Service Control and further actions. + +Sequence diagram for Initiation of a session to a non-registered user + +Figure A.4.6.1: Initiation of a session to a non-registered user + +#### A.4.6a AS originating session on behalf of a non-registered user + +![Sequence diagram for AS originating session on behalf of a non-registered user](408c4798ea60469e0728a7cbbd598668_img.jpg) + +``` + +sequenceDiagram + participant AS + participant I-CSCF + participant HSS + participant S-CSCF + + Note left of AS: 1a. INVITE + AS->>I-CSCF: 1b1. INVITE + I-CSCF->>HSS: 1b2. LIR + HSS-->>I-CSCF: 1b3. LIA + Note left of I-CSCF: 1b4. S-CSCF Selection + I-CSCF->>S-CSCF: 1b5. INVITE + Note right of S-CSCF: 2. SAR + S-CSCF->>HSS: 2. SAR + HSS-->>S-CSCF: 3. SAA + Note right of S-CSCF: 4. Service Control + Note right of S-CSCF: 5. S-CSCF performs further actions + +``` + +The sequence diagram illustrates the interaction for an AS originating session on behalf of a non-registered user. It involves four lifelines: AS, I-CSCF, HSS, and S-CSCF. The process starts with an INVITE from the AS to the I-CSCF (labeled 1b1). The I-CSCF sends a LIR to the HSS, which responds with a LIA. The I-CSCF then performs S-CSCF Selection and sends an INVITE to the S-CSCF. The S-CSCF sends a SAR to the HSS, which responds with a SAA. Finally, the S-CSCF performs Service Control and further actions. A dashed box encloses the first five steps, indicating a logical grouping of the initial session setup. + +Sequence diagram for AS originating session on behalf of a non-registered user + +Figure A.4.6a.1: AS originating session on behalf of a non-registered user + +### A.4.7 User Profile update + +![Sequence diagram showing User Profile update between S-CSCF and HSS.](7ed5d5770331f31ade15439a21c31425_img.jpg) + +``` +sequenceDiagram + participant S-CSCF + participant HSS + Note right of HSS: PPR + HSS->>S-CSCF: PPR + Note left of S-CSCF: PPA + S-CSCF->>HSS: PPA +``` + +The diagram illustrates a sequence of messages between an S-CSCF (Serving CSCF) and an HSS (Home Subscriber Server). The interaction consists of two steps: 1. The HSS sends a PPR (Profile Request) message to the S-CSCF. 2. The S-CSCF sends a PPA (Profile Answer) message to the HSS. + +Sequence diagram showing User Profile update between S-CSCF and HSS. + +Figure A.4.7.1: User profile update + +# Annex B (informative): User profile UML model + +The purpose of this UML model is to define in an abstract level the structure of the user profile downloaded over the Cx interface and describe the purpose of the different information classes included in the user profile. + +## B.1 General description + +The following picture gives an outline of the UML model of the user profile, which is downloaded from HSS to S-CSCF: + +![UML Class Diagram of User Profile](237b76118be454462fc9b4e96adaa6c7_img.jpg) + +``` +classDiagram + IMSSubscription "1" *-- "1..n" ServiceProfile + IMSSubscription "1" *-- "0..1" ReferenceLocationInformation + class IMSSubscription { + Private User Identity + IMSI + } + class ServiceProfile + class ReferenceLocationInformation { + AccessType: string + AccessInfo: string + AccessValue: string + } +``` + +The diagram shows a UML class model for the User Profile. At the top is the **IMS Subscription** class, which contains two attributes: **Private User Identity** and **IMSI**. Below it are two classes: **ServiceProfile** and **ReferenceLocationInformation**. The **IMS Subscription** class has a composition relationship with both. The multiplicity of **ServiceProfile** is **1..n**, and the multiplicity of **ReferenceLocationInformation** is **0..1**. The **ReferenceLocationInformation** class contains three attributes: **AccessType: string**, **AccessInfo: string**, and **AccessValue: string**. + +UML Class Diagram of User Profile + +**Figure B.1.1: User Profile** + +IMS Subscription class contains as a parameter the private user identity of the user in NAI format and the IMSI of the user, if available, as defined in TS 23.003 [17]. + +Each instance of the IMS Subscription class contains zero or one instance of the class Reference Location Information. + +The class Reference Location Information contains zero or one attribute AccessType, zero or one attribute AccessInfo, and zero or one attribute AccessValue. + +The attribute AccessType indicates the type of access for which the reference location of the user is defined (e.g. ADSL). The attribute AccessInfo indicates the type of the access information defined for the reference location of the user (e.g. dsl-location). The attribute AccessValue contains the location information (e.g. line identifier in fixed access networks) as configured by the operator. + +Each instance of the IMS Subscription class contains one or several instances of the class Service Profile. + +## B.2 Service profile + +The following picture gives an outline of the UML model of the Service Profile class: + +![UML Class Diagram for Service Profile](01832e59ebad7ada5e790de6f90cc9b6_img.jpg) + +``` +classDiagram + class ServiceProfile { + SharedIFCSetID: integer + } + class PublicIdentity + class CoreNetworkServicesAuthorization + class InitialFilterCriteria + + ServiceProfile "1" *-- "1..n" PublicIdentity + ServiceProfile "1" *-- "0..1" CoreNetworkServicesAuthorization + ServiceProfile "1" *-- "0..n" InitialFilterCriteria +``` + +The diagram shows a UML class structure. At the top is the **ServiceProfile** class, which contains an attribute **SharedIFCSetID: integer**. Below it are three classes: **PublicIdentity**, **CoreNetworkServicesAuthorization**, and **InitialFilterCriteria**. The **ServiceProfile** class has a composition relationship with each of these three classes, indicated by a solid diamond. The multiplicities are: **ServiceProfile** (1) to **PublicIdentity** (1..n), **ServiceProfile** (1) to **CoreNetworkServicesAuthorization** (0..1), and **ServiceProfile** (1) to **InitialFilterCriteria** (0..n). + +UML Class Diagram for Service Profile + +**Figure B.2.1: Service Profile** + +Each instance of the Service Profile class consists of the following classes: + +- One or several instances of the Public-Identity class. PublicIdentity class contains the Public Identities associated with that service profile. The information in the CoreNetworkServicesAuthorization and InitialFilterCriteria classes apply to all PublicIdentification class instances, which are included in one ServiceProfile class. +- An optional instance of the CoreNetworkServicesAuthorization class. If no instance of the CoreNetworkServicesAuthorization class is present, no filtering related to subscribed media or restriction on IMS Communication Service Identifiers applies in the S-CSCF. +- Zero or several instances of the InitialFilterCriteria class. + +Each instance of the Service Profile class contains the following attributes: + +- Zero or more instances of the attribute SharedIFCSetID. A SharedIFCSetID attribute points to a set of Initial Filter Criteria locally administered and stored at the S-CSCF. Shared iFC Sets may be shared by several Service Profiles. + +### B.2.1 Public Identification + +The following picture gives an outline of the UML model of Public Identification class: + +![UML Class Diagram showing Public Identification and ExtendedPriority classes.](cac61a60141d0335b4ae7a081f6b18d4_img.jpg) + +``` + +classDiagram + class PublicIdentification["Public Identification"] { + BarringIndication: Boolean + Identity: anyURI + IdentityType: enumerated + WildcardedPSI: anyURI + DisplayName: string + AliasIdentityGroupId: string + WildcardedIMPU: anyURI + ServiceLevelTraceInfo: string + ServicePriorityLevel: enumerated + MaxNumOfAllowedSimultRegs: Integer + } + class ExtendedPriority { + PriorityNamespace: string + PriorityLevel: string + } + PublicIdentification "1" *-- "0..n" ExtendedPriority + +``` + +The diagram shows a class named "Public Identification" with the following attributes: BarringIndication (Boolean), Identity (anyURI), IdentityType (enumerated), WildcardedPSI (anyURI), DisplayName (string), AliasIdentityGroupId (string), WildcardedIMPU (anyURI), ServiceLevelTraceInfo (string), ServicePriorityLevel (enumerated), and MaxNumOfAllowedSimultRegs (Integer). Below this class is a diamond-shaped aggregation symbol connected to a class named "ExtendedPriority" with a multiplicity of 0..n. The "ExtendedPriority" class has two attributes: PriorityNamespace (string) and PriorityLevel (string). + +UML Class Diagram showing Public Identification and ExtendedPriority classes. + +**Figure B.2.1.1: Public Identification** + +The attribute BarringIndication is of type Boolean. If it is absent, or if it is present and set to FALSE, the S-CSCF shall not restrict the use of that public user identity in any IMS communications. If it is present and set to TRUE, the S-CSCF shall prevent that public identity from being used in any IMS communication except registrations and re-registrations, as specified in TS 24.229 [8]. + +Public Identification class can contain an Identity attribute. The attribute IdentityType indicates the type of identity contained in each case. It could be either: + +- A distinct Public User Identity +- A distinct Public Service Identity +- A Wildcarded Public Service Identity +- A non distinct Public User Identity, i.e. not explicitly provisioned in HSS. +- A Wildcarded Public User Identity + +If the identity type is not present, it is assumed to be a distinct Public User Identity. + +The attribute WildcardedPSI may be present (when IdentityType is WildcardedPSI) and contains the Wildcarded Public Service Identity that matched the Public Service Identity. This Wildcarded Public Service identity shall be sent as stored in the HSS, that is, including the delimiter described in TS 23.003 [17]. + +The attribute DisplayName allows a name to be associated with a Public Identity. + +The attribute AliasIdentityGroupID indicates the Alias Public User Identity Set to which the Public User Identity belongs. If the "AliasInd" feature is supported, all Public User Identities shall have an AliasIdentityGroupID allocated. Within an IMS subscription Public User Identities that have the same AliasIdentityGroupID allocated shall be in the same implicit registration sets, and shall share their service profile and the same service data for each and every service, and shall be regarded as aliases of each other, as defined in the TS 23.008 [18]. If the "AliasInd" feature is not supported, all Public User Identities within an IMS subscription that are within the same implicit registration set and share their service profile shall be regarded aliases of each other. + +The attribute WildcardedIMPU shall be present when IdentityType is a non distinct IMPU or it may be optionally present when IdentityType is a Wildcarded IMPU. It contains the Wildcarded Public User Identity that matched the + +Public User Identity. This Wildcarded Public User identity shall be sent as stored in the HSS, that is, including the delimiter described in TS 23.003 [17]. + +The attribute ServiceLevelTraceInfo provides the Service Level Tracing Information that is related to the Public User Identity. If the ServiceLevelTraceInfo is present, service level tracing shall be enabled in the S-CSCF for the related Public User Identity according to the configuration data received. If the ServiceLevelTraceInfo is not present, service level tracing is disabled in the S-CSCF for the related Public User Identity. + +The attribute ServicePriorityLevel provides the Priority Level allowed for the Public User Identity, which can be used by the S-CSCF and other network elements for Priority Service. + +The attribute PriorityNamespace provides the Namespace as specified in IETF RFC 4412 [22] and to which the Extended Priority refers. + +The attribute PriorityLevel provides the Priority Level allowed for the Public User Identity, for the Extended Priority. Its value depends on the PriorityNamespace. + +The attribute MaxNumOfAllowedSimultRegs provides the maximum number of allowed simultaneous registrations for the Public User Identity. + +### B.2.1A Core Network Service Authorization + +The following picture gives an outline of the UML model of Core Network Service Authorization class: + +![UML Class Diagram for Core Network Service Authorization](6b9ee906d502aece4a2becf5895db07a_img.jpg) + +``` +classDiagram + class CoreNetworkServiceAuthorization["Core Network Service Authorization"] + class SubscribedMediaProfileId["Subscribed Media Profile Id"] { + SubscribedMediaProfileId: Integer + } + class ListOfServiceIds["List of Service Ids"] + class ServiceId["Service Id"] { + ServiceId: string + } + + CoreNetworkServiceAuthorization "1" *-- "0..1" SubscribedMediaProfileId + CoreNetworkServiceAuthorization "1" *-- "0..1" ListOfServiceIds + ListOfServiceIds "1" *-- "0..n" ServiceId +``` + +The diagram illustrates the UML model for the Core Network Service Authorization class. At the top is the 'Core Network Service Authorization' class. It has a composition relationship with two classes below it: 'Subscribed Media Profile Id' and 'List of Service Ids'. The 'Subscribed Media Profile Id' class has an attribute 'SubscribedMediaProfileId' of type 'Integer'. The 'List of Service Ids' class has a composition relationship with the 'Service Id' class. The 'Service Id' class has an attribute 'ServiceId' of type 'string'. The multiplicities are: 'Core Network Service Authorization' (1) to 'Subscribed Media Profile Id' (0..1), 'Core Network Service Authorization' (1) to 'List of Service Ids' (0..1), and 'List of Service Ids' (1) to 'Service Id' (0..n). + +UML Class Diagram for Core Network Service Authorization + +**Figure B.2.1A.1: Core Network Service Authorization** + +Each instance of the Core Network Service Authorization class contains zero or one instance of the class Subscribed Media Profile Id. If no instance of the class Subscribed Media Profile Id is present, no filtering related to subscribed media applies in S-CSCF. The Subscribed Media Profile Id is of type Integer and identifies a media profile in the S-CSCF for the authorization of media parameters. + +Each instance of the Core Network Service Authorization class contains zero or one instance of the class List of Service Ids. If no instance of the class List of Service Ids is present, no restriction on IMS Communication Service Identifiers related applies in S-CSCF. Each instance of the class List of Service Ids contains zero or more instances of the class Service Id. The Service Id is of type String and identifies an IMS Communication Service Identifier that the subscriber is authorized to use. + +### B.2.2 Initial Filter Criteria + +The following picture gives an outline of the UML model of Initial Filter Criteria class: + +![UML Class Diagram of Initial Filter Criteria](212c50c4e3d043c989037a01e13c1a98_img.jpg) + +``` + +classDiagram + class InitialFilterCriteria { + Priority: integer + ProfilePartIndicator: enumerated + } + class TriggerPoint { + ConditionTypeCNF: boolean + } + class ApplicationServer { + ServerName: SIP URL + DefaultHandling: enumerated + ServiceInfo: string + } + class SPT (ServicePointTrigger) { + ConditionNegated: boolean + Group: list of integers + } + class IncludeRegisterRequest + class IncludeRegisterResponse + + InitialFilterCriteria "1" *-- "0..1" TriggerPoint + InitialFilterCriteria "1" *-- "1" ApplicationServer + TriggerPoint "1" *-- "1..n" SPT + ApplicationServer "1" *-- "0..1" IncludeRegisterRequest + ApplicationServer "1" *-- "0..1" IncludeRegisterResponse + +``` + +The diagram illustrates the UML model for the Initial Filter Criteria class. At the top is the **InitialFilterCriteria** class, which has attributes **Priority: integer** and **ProfilePartIndicator: enumerated**. It has a composition relationship with the **TriggerPoint** class (multiplicity 0..1) and the **ApplicationServer** class (multiplicity 1). The **TriggerPoint** class has the attribute **ConditionTypeCNF: boolean** and has a composition relationship with the **SPT (ServicePointTrigger)** class (multiplicity 1..n). The **SPT** class has attributes **ConditionNegated: boolean** and **Group: list of integers**. The **ApplicationServer** class has attributes **ServerName: SIP URL**, **DefaultHandling: enumerated**, and **ServiceInfo: string**. It has a composition relationship with the **IncludeRegisterRequest** class (multiplicity 0..1) and the **IncludeRegisterResponse** class (multiplicity 0..1). + +UML Class Diagram of Initial Filter Criteria + +**Figure B.2.2.1.1: Initial Filter Criteria** + +Each instance of the InitialFilterCriteria class includes the following attributes: + +- One instance of Priority attribute that indicates the priority of the Filter Criteria. The higher the Priority Number the lower the priority of the Filter Criteria is; i.e., a Filter Criteria with a higher value of Priority Number shall be assessed after the Filter Criteria with a smaller Priority Number have been assessed. The same priority shall not be assigned to more than one initial Filter Criterion. +- An optional instance of ProfilePartIndicator attribute that is an enumerated type, with possible values "REGISTERED and UNREGISTERED, indicating if the iFC is a part of the registered or unregistered user profile. If ProfilePartIndicator is missing from the iFC, the iFC is considered to be relevant to both the registered and unregistered parts of the user profile, i.e. belongs to the common part of the user profile. + +Each instance of the InitialFilterCriteria class consists of the following classes: + +- An optional instance of TriggerPoint class that describes the trigger points that should be checked in order to find out if the indicated Application Server should be contacted or not. Each TriggerPoint is a boolean expression in Conjunctive or Disjunctive Normal form (CNF or DNF). The absence of Trigger Point instance will indicate an unconditional triggering to Application Server. + +The attribute ConditionTypeCNF attribute defines how the set of SPTs are expressed, i.e. either an Ored set of ANDed sets of SPT statements or an ANDed set of Ored sets of statements. Individual SPT statements can also be negated. These combinations are termed, respectively, Disjunctive Normal Form (DNF) and Conjunctive Normal Form (CNF) for the SPT (see Annex C). Both DNF and CNF forms can be used. ConditionTypeCNF is + +a boolean that is TRUE when the Trigger Point associated with the FilterCriteria is a boolean expression in Conjunctive Normal Form (CNF) and FALSE if the Trigger Point is expressed in Disjunctive Normal Form (DNF) (see Annex C). + +Each TriggerPoint class is composed by 1 to n instances of the SPT (ServicePointTrigger) class. + +- One instance of ApplicationServer class that defines the application server, which is contacted, if the trigger points are met. + +Each instance of the ApplicationServer class includes following attributes: + +- One instance of ServerName attribute that is the SIP URL of the application server to contact. +- An optional instance of DefaultHandling attribute that determines whether the dialog should be released if the Application Server could not be reached or not; it is of type enumerated and can take the values: SESSION\_ CONTINUED or SESSION\_ TERMINATED. +- One optional instance of the ServiceInfo attribute. The ServiceInfo attribute allows to download to S-CSCF information that is to be transferred transparently to an Application Server when the trigger points of a filter criterion are satisfied. ServiceInfo is a string conveying that information. See TS 23.218 [6] for a description of the use of this information element. + +Each instance of the ApplicationServer class includes following classes: + +- One optional instance of the IncludeRegisterRequest class that indicates to the S-CSCF that the incoming SIP REGISTER request is to be transferred to an Application Server when the trigger points of a filter criterion are satisfied. See TS 23.218 [6] for a description of the use of this information element. +- One optional instance of the IncludeRegisterResponse class that indicates to the S-CSCF that the final SIP response to the incoming SIP REGISTER request is to be transferred to an Application Server when the trigger points of a filter criterion are satisfied. See TS 23.218 [6] for a description of the use of this information element. + +### B.2.3 Service Point Trigger + +The following picture gives an outline of the UML model of Service Point Trigger class: + +![UML Class Diagram for Service Point Trigger](a4b868a176f7e0448ee72483727e9f6f_img.jpg) + +``` + +classDiagram + class ServicePointTrigger { + ConditionNegated: boolean + Group: list of integer + RegistrationType: list of enumerated + } + class RequestURI { + RequestURI: string + } + class SIPMethod { + Method: string + } + class SIPHeader { + Header: string + Content: string + } + class SessionCase { + SessionCase: enumerated + } + class SessionDescription { + Line: string + Content: string + } + ServicePointTrigger <|-- RequestURI + ServicePointTrigger <|-- SIPMethod + ServicePointTrigger <|-- SIPHeader + ServicePointTrigger <|-- SessionCase + ServicePointTrigger <|-- SessionDescription + +``` + +The diagram shows a UML class hierarchy. At the top is the **Service Point Trigger** class, which has three attributes: **ConditionNegated** (boolean), **Group** (list of integer), and **RegistrationType** (list of enumerated). Below it, five classes inherit from **Service Point Trigger**: **Request-URI**, **SIP Method**, **SIP Header**, **Session Case**, and **Session Description**. Each of these five classes has its own specific attribute(s): **RequestURI** (string) for Request-URI, **Method** (string) for SIP Method, **Header** (string) and **Content** (string) for SIP Header, **SessionCase** (enumerated) for Session Case, and **Line** (string) and **Content** (string) for Session Description. + +UML Class Diagram for Service Point Trigger + +**Figure B.2.3.1: Service Point Trigger** + +The attribute **Group** of the class **Service Point Trigger** allows the grouping of SPTs that will configure the sub-expressions inside a CNF or DNF expression. For instance, in the following CNF expression $(A+B).(C+D)$ , $A+B$ and $C+D$ would correspond to different groups. + +In CNF, the attribute Group identifies the ORed sets of SPT instances. If the SPT belongs to different ORed sets, SPT can have more than one Group values assigned. At least one Group must be assigned for each SPT. + +In DNF, the attribute Group identifies the ANDed sets of SPT instances. If the SPT belongs to different ANDed sets, SPT can have more than one Group values assigned. At least one Group must be assigned for each SPT. + +The attribute ConditionNegated of the class Service Point Trigger defines whether the individual SPT instance is negated (i.e. NOT logical expression). + +**NOTE:** The operator should be aware that a negated Session Case implies that all other available session cases are set. The list of session cases depends on the release and can even be increased in the future, then a negated Session Case may end up triggering ASs unexpectedly (e.g. NOT ORIGINATED\_REGISTERED may trigger only TERMINATING\_UNREGISTERED and TERMINATING\_REGISTERED, or as well ORIGINATING\_UNREGISTERED and ORIGINATING\_CDIV). + +The attribute RegistrationType of the class Service Point Trigger is relevant only to the SIP Method SPT with a value of "REGISTER" and its' support is optional in the HSS and in the S-CSCF. The RegistrationType may contain a list of values that define whether the SPT matches to REGISTER messages that are related to initial registrations, re-registrations, and/or de-registrations. If RegistrationTypes are given, the SIP Method SPT with a value of "REGISTER" shall match if any of the RegistrationTypes match and the S-CSCF supports the RegistrationType attribute. If the SIP Method SPT contains value "REGISTER", and no RegistrationType is given, or if the S-CSCF does not support the RegistrationType attribute, the SIP Method SPT matches to all REGISTER messages. The attribute RegistrationType may be discarded if it is present in an SPT other than SIP Method with value "REGISTER". + +Request-URI class defines SPT for the Request-URI. Request-URI contains attribute RequestURI. + +SIP Method class defines SPT for the SIP method. SIP Method contains attribute Method which holds the name of any SIP method. + +SIP Header class defines SPT for the presence or absence of any SIP header or for the content of any SIP header. SIP Header contains attribute Header which identifies the SIP Header, which is the SPT, and the Content attribute defines the value of the SIP Header if required. + +The absence of the Content attribute and ConditionNegated = TRUE indicates that the SPT is the absence of a determined SIP header. + +Session Case class represents an enumerated type, with possible values "Originating", "Terminating\_Registered", "Terminating\_Unregistered", "Originating\_Unregistered", "Originating\_CDIV" indicating whether the filter should be used by the S-CSCF handling the Originating, Terminating for a registered end user, Terminating for an unregistered end user, Originating for an unregistered end user, or Originating after Call Diversion services. + +Session Description Information class defines SPT for the content of any SDP field within the body of a SIP Method. The Line attribute identifies the line inside the session description. Content is a string defining the content of the line identified by Line. + +# Annex C (informative): Conjunctive and Disjunctive Normal Form + +A Trigger Point expression is constructed out of atomic expressions (i.e. Service Point Trigger) linked by Boolean operators AND, OR and NOT. Any logical expression constructed in that way can be transformed to forms called Conjunctive Normal Form (CNF) and Disjunctive Normal Form (DNF). + +A Boolean expression is said to be in Conjunctive Normal Form if it is expressed as a conjunction of disjunctions of literals (positive or negative atoms), i.e. as an AND of clauses, each of which is the OR of one or more atomic expressions. + +Taking as an example the following trigger: + +Method = "INVITE" OR Method = "MESSAGE" OR (Method="SUBSCRIBE" AND NOT Header = "from" Content = "joe") + +The trigger can be split into the following atomic expressions: + +Method="INVITE" + +Method="MESSAGE" + +Method="SUBSCRIBE" + +NOT header="from" Content ="joe" + +Grouping the atomic expressions, the CNF expression equivalent to the previous example looks like: + +(Method="INVITE" OR Method = "MESSAGE" OR Method="SUBSCRIBE") AND (Method="INVITE" OR Method = "MESSAGE" OR (NOT Header = "from" Content = "joe")) + +This result in two "OR" groups linked by "AND" (CNF): + +(Method="INVITE" OR Method = "MESSAGE" OR Method="SUBSCRIBE") + +(Method="INVITE" OR Method = "MESSAGE" OR (NOT Header = "from" Content = "joe")) + +The XML representation of the trigger is: + +``` + + + IMPI1@homedomain.com + + + 1 + sip:IMPU1@homedomain.com + + + sip:IMPU2@homedomain.com + + + 0 + + 1 + + 0 + 0 + INVITE + + + + + +``` + +``` + + + + 0 + 0 + MESSAGE + + + 0 + 0 + SUBSCRIBE + + + 0 + 1 + INVITE + + + 0 + 1 + MESSAGE + + + + 1 + 1 + +
From
+ "joe" + + + + + sip:AS1@homedomain.com + 0 + + + + + +``` + +A Boolean expression is said to be in Disjunctive Normal Form if it is expressed as a disjunction of conjunctions of literals (positive or negative atoms), i.e. as an OR of clauses, each of which is the AND of one or more atomic expressions. + +The previous example is already in DNF, composed by the following groups: + +Method="INVITE" + +Method="MESSAGE" + +Method="SUBSCRIBE" AND (NOT header="from" Content ="joe") + +The XML representation of the trigger is: + +``` + + + + IMPI1@homedomain.com + + + 1 + sip:IMPU1@homedomain.com + + +``` + +``` + + sip:IMPU2@homedomain.com + + + 0 + + 0 + + 0 + 0 + INVITE + + + 0 + 1 + MESSAGE + + + 0 + 2 + SUBSCRIBE + + + 1 + 2 + +
From
+ "joe" + + + + + sip:AS1@homedomain.com + 0 + + + + +``` + +# Annex D (informative): High-level format for the User Profile + +The way the information shall be transferred through the Cx interface can be seen from a high-level point of view in the following picture: + +![](343e05a9fd8a8c8743428fa4ae6e2736_img.jpg) + +| | | | | | +|-----------------------------|--------------------|-----------------|--------------------------|--------------------| +| IMS
Subscription
Data | Service
Profile | Public id. data | Core Network Serv. Auth. | App.&Serv. Filters | +| | | | | | + +**Figure D.1: Example of in-line format of user profile** + +If more than one service profile is created, for example to assign a different set of filters to public identifiers 1 and 2 and public identity 3, the information shall be packaged in the following way: + +![](ada2aa7cce9cff9cf116d9ae2b8b7c27_img.jpg) + +| | | | | | | | | | | +|-----------------------------|----------------------|--------------|--------------|----------------|-------------|----------------------|--------------|----------------|-------------| +| IMS
Subscription
Data | Service
Profile 1 | Public id. 1 | Public id. 2 | CN Serv. Auth. | A&S Filters | Service
Profile 2 | Public id. 3 | CN Serv. Auth. | A&S Filters | +| | | | | | | | | | | + +**Figure D.2: Example of in-line format of user profile** + +# --- Annex E (normative): XML schema for the Cx interface user profile + +The file CxDataType\_Rel11.xsd, attached to this specification, contains the XML schema for the user profile that is sent over the Cx interface. The user profile XML schema defines that are used in the user profile XML. The data that is allowed to be sent in the user profile may vary depending on the features supported by the Diameter end points, see TS 29.229 [5]. The user profile XML schema file is intended to be used by an XML parser. The version of the Cx application sending the user profile XML shall be the same as the version of the sent user profile XML and thus it implies the version of the user profile XML schema to be used to validate it. + +Table E.1 describes the data types and the dependencies among them that configure the user profile XML schema. + +Table E.1: XML schema for the Cx interface user profile: simple data types + +| Data type | Tag | Base type | Comments | +|---------------------------|--------------------------------------------------------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| tPriority | Priority | integer | >= 0 | +| tProfilePartIndicator | ProfilePartIndicator | enumerated | Possible values:
0 (REGISTERED)
1 (UNREGISTERED) | +| tSharedIFCSetID | SharedIFCSetID | integer | >= 0 | +| tGroupID | Group | integer | >= 0 | +| tRegistrationType | RegistrationType | enumerated | Possible values:
0 (INITIAL_REGISTRATION)
1 (RE-REGISTRATION)
2 (DE-REGISTRATION) | +| tDefaultHandling | DefaultHandling | enumerated | Possible values:
0 (SESSION_CONTINUED)
1 (SESSION_TERMINATED) | +| tDirectionOfRequest | SessionCase | enumerated | Possible values:
0 (ORIGINATING_REGISTERED)
1 TERMINATING_REGISTERED
2 (TERMINATING_UNREGISTERED)
3 (ORIGINATING_UNREGISTERED)
4 (ORIGINATING_CDIV) | +| tPrivateID | PrivateID | anyURI | Syntax described in IETF RFC 2486 [14] | +| tSIP_URL | Identity | anyURI | Syntax described in IETF RFC 3261 [11] or 3GPP TS 23003 (See Note 1) | +| tTEL_URL | Identity | anyURI | Syntax described in IETF RFC 3966 [15] or 3GPP TS 23003 (See Note 1) | +| tIdentity | Identity | (union) | Union of tSIP_URL, and tTEL_URL | +| tIdentityType | IdentityType | enumerated | Possible values:
0 (DISTINCT PUBLIC_USER_IDENTITY)
1 (DISTINCT_PSI)
2 (WILDCARDED_PSI) (See Note 2)
3 (NON_DISTINCT_IMPU) (See Note 3)
4 (WILDCARDED_IMPU) (See Note 4) | +| tServiceInfo | ServiceInfo | string | | +| tString | RequestURI, Method, Header, Content, Line, AccessType, AccessInfo, AccessValue | string | | +| tBool | ConditionTypeCNF, ConditionNegated, BarringIndication | boolean | Possible values:
0 (false)
1 (true) | +| tSubscribedMediaProfileId | SubscribedMediaProfileId | integer | >=0 | +| tDisplayName | DisplayName | string | | +| tAliasIdentityGroupID | AliasIdentityGroupID | string | | +| tServiceLevelTraceInfo | ServiceLevelTraceInfo | string | Syntax described in 3GPP TS 24.323 [32] | +| tServicePriorityLevel | ServicePriorityLevel | enumerated | Possible values:
0 (Highest priority)
1
2
3
4 (Lowest priority) | +| tPriorityNamespace | PriorityNamespace | string | Possible values are those of the namespaces that are defined in IETF RFC 4412 [22] or defined according to the IANA registration procedure described in IETF RFC 4412 [22] for Resource-Priority Namespaces. | +| tPriorityLevel | PriorityLevel | string | Possible values depend on the PriorityNamespace and are specified with the associated namespace that is defined in IETF RFC 4412 [22] or defined according to the IANA registration procedure described in IETF RFC 4412 [22] for Resource-Priority Namespaces | +| tIMSI | IMSI | string | Syntax described in 3GPP TS 23.003 [17]. ASCII encoded according to ANSI X3.4 [26]. | +| tMaxNumOfAllowedSi | MaxNumOfAllowedSi | integer | >= 1 | + +| | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|--|--| +| multRegistrations | multRegistrations | | | +| NOTE 1: Only when the "Identity" tag is a Wildcarded Identity the syntax is described in 1 23.003 [17]. It applies to both WILDCARDED_IMPU and WILDCARDED_PSI. | | | | +| NOTE 2: Wildcarded PSI could optionally be included as well in tPublicIdentityExtension. | | | | +| NOTE 3: The IMPU is not explicitly provisioned in HSS. In this case, corresponding Wildcarded IMPU is included in tPublicIdentityExtension3. | | | | +| NOTE 4: WILDCARDED_IMPU indicates that the content of the identity in the "Identity" tag is a Wildcarded Public User Identity. In this case, Wildcarded IMPU could optionally be included as well in tPublicIdentityExtension3. | | | | + +**Table E.2: XML schema for the Cx interface user profile: complex data types** + +| Data type | Tag | Compound of | | | +|-----------|-----|-------------|------|-------------| +| | | Tag | Type | Cardinality | + +| | | | | | +|-----------------------------------|----------------------------------|----------------------------------|-----------------------------------|----------------------| +| tIMSSubscription | IMSSubscription | PrivateID | tPrivateID | 1 | +| | | ServiceProfile | tServiceProfile | (1 to n) | +| | | Extension | tIMSSubscriptionExtension | (0 to 1) | +| tIMSSubscriptionExtension | Extension | IMSI | tIMSI | (0 to 1) | +| | | Extension | tIMSSubscriptionExtension2 | (0 to 1) | +| tIMSSubscriptionExtension2 | Extension | ReferenceLocationInformation | tReferenceLocationInformation | (0 to n)
(NOTE 5) | +| tReferenceLocationInformation | ReferenceLocationInformation | AccessType | tString (NOTE 4) | (0 to 1) | +| | | AccessInfo | tString (NOTE 4) | (0 to 1) | +| | | AccessValue | tString (NOTE 4) | (0 to 1) | +| tServiceProfile | ServiceProfile | PublicIdentity | tPublicIdentity | (1 to n) | +| | | CoreNetworkServicesAuthorization | CoreNetworkServicesAuthorization | (0 to 1) | +| | | InitialFilterCriteria | tInitialFilterCriteria | (0 to n) | +| | | Extension | tServiceProfileExtension | (0 to 1) | +| tServiceProfileExtension | Extension | SharedIFCSetID | tSharedIFCSetID | (0 to n) | +| tCoreNetworkServicesAuthorization | CoreNetworkServicesAuthorization | SubscribedMediaProfileId | tSubscribedMediaProfileId | (0 to 1) | +| | | Extension | tCNServicesAuthorizationExtension | (0 to 1) | +| tPublicIdentity | PublicIdentity | BarringIndication | tBool | (0 to 1) | +| | | Identity | tIdentity | 1 | +| | | Extension | tPublicIdentityExtension | (0 to 1) | +| tInitialFilterCriteria | InitialFilterCriteria | Priority | tPriority | 1 | +| | | TriggerPoint | tTrigger | (0 to 1) | +| | | ApplicationServer | tApplicationServer | 1 | +| | | ProfilePartIndicator | tProfilePartIndicator | (0 to 1) | +| tTrigger | TriggerPoint | ConditionTypeCNF | tBool | 1 | +| | | SPT | tSePoTri | (1 to n) | +| tSePoTri | SPT | ConditionNegated | tBool | (0 to 1) | +| | | Group | tGroupID | (1 to n) | +| | | Choice of | RequestURI | 1 | +| | | | Method | 1 | +| | | | SIPHeader | 1 | +| | | | SessionCase | 1 | +| | | | SessionDescription | 1 | +| | | Extension | tSePoTriExtension | (0 to 1) | +| tSePoTriExtension | Extension | RegistrationType | tRegistrationType | (0 to 2) | +| tHeader | SIPHeader | Header | tString | 1 | +| | | Content | tString | (0 to 1) | +| tSessionDescription | SessionDescription | Line | tString | 1 | +| | | Content | tString | (0 to 1) | +| tApplicationServer | ApplicationServer | ServerName | tSIP_URL | 1 | +| | | DefaultHandling | tDefaultHandling | (0 to 1) | +| | | ServiceInfo | tServiceInfo | (0 to 1) | +| | | Extension | tApplicationServerExtension | (0 to 1) | +| tApplicationServerExtension | Extension | IncludeRegisterRequest | tIncludeRegisterRequest | (0 to 1) | +| | | IncludeRegisterResponse | tIncludeRegisterResponse | (0 to 1) | +| tIncludeRegisterRequest | IncludeRegisterRequest | (NOTE 2) | (NOTE 2) | (0 to 1) | +| tIncludeRegisterResponse | tIncludeRegisterResponse | (NOTE 2) | (NOTE 2) | (0 to 1) | +| tPublicIdentityExtension | Extension | IdentityType | tIdentityType | (0 to 1) | +| | | WildcardedPSI | anyURI (NOTE 3) | (0 to 1) | +| | | Extension | tPublicIdentityExtension2 | (0 to 1) | +| tPublicIdentityExtension2 | Extension | DisplayName | tDisplayName | (0 to 1) | +| | | AliasIdentityGroupID | tAliasIdentityGroupID | (0 to 1) | +| | | Extension | tPublicIdentityExtension3 | (0 to 1) | +| tPublicIdentityExtension3 | Extension | WildcardedIMPU | anyURI (NOTE 3) | (0 to 1) | +| | | ServiceLevelTraceInfo | tServiceLevelTraceInfo | (0 to 1) | +| | | ServicePriorityLevel | ServicePriorityLevel | (0 to 1) | +| | | Extension | tPublicIdentityExtension4 | (0 to 1) | +| tPublicIdentityExtension4 | Extension | ExtendedPriority | tExtendedPriority | (0 to n) | +| | | Extension | tPublicIdentityExtension5 | (0 to 1) | + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------------------------------|-------------------------------------|----------| +| tPublicIdentityExtension5 | Extension | MaxNumOfAllowedSimult Registrations | tMaxNumOfAllowedSimultRegistrations | (0 to 1) | +| tExtendedPriority | ExtendedPriority | PriorityNamespace | tPriorityNamespace | 1 | +| | | PriorityLevel | tPriorityLevel | 1 | +| tCNServicesAuthorizationExtension | Extension | ListOfServiceIds | tListOfServiceIds | (0 to 1) | +| tListOfServiceIds | ListOfServiceIds | ServiceId | tString | (0 to n) | +| NOTE 1: "n" shall be interpreted as non-bounded. | | | | | +| NOTE 2: empty cells shall be interpreted as complex XML elements without defined content. | | | | | +| NOTE 3: the syntax of Wildcarded Public User Identity and Wildcarded Service Identity shall be as described in 3GPP TS 23.003 [17]. | | | | | +| NOTE 4: the syntax of AccessType, AccessInfo and AccessValue is as described in 3GPP TS 24.229 [8] for P-Access-Network-Info header fields: AccessType corresponds to the "access-type" field whereas AccessInfo and AccessValue correspond to the type and associated value defined for the "access-info" field. | | | | | +| NOTE 5: the HSS shall not send more than one instance of ReferenceLocationInformation and if the S-CSCF receives more than one instance of ReferenceLocationInformation it may arbitrarily pick one for further processing. | | | | | + +# Annex F (normative): Definition of parameters for service point trigger matching + +Table F.1 defines the parameters that are transported in the user profile XML. + +**Table F.1: Definition of parameters in the user profile XML** + +| Tag | Description | +|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RequestURI | RequestURI tag shall include a regular expression in a form of Extended Regular Expressions (ERE) as defined in clause 9 in IEEE 1003.1-2004 Part 1 [13]. For SIP URI, the regular expression shall be matched against the hostport of the SIP-URI. For definition of SIP-URI and hostport, see IETF RFC 3261 [11]. For Tel URI, the regular expression shall be matched against the telephone-subscriber of the telephone-uri. For definition of telephone-subscriber and telephone-uri, see IETF RFC 3966 [15]. | +| SIPHeader | A SIP Header SPT shall be evaluated separately against each header instance within the SIP message. The SIP Header SPT matches if at least one header occurrence matches the SPT. | +| Header (of SIPHeader) | Header tag shall include a regular expression in a form of Extended Regular Expressions (ERE) as defined in clause 9 in IEEE 1003.1-2004 Part 1 [13]. The regular expression shall be matched against the header-name of the SIP header. For definition of header and header-name, see IETF RFC 3261 [11]. Before matching the header-name to the pattern, all SWSs shall be removed from the header-name and all LWSs in the header-name shall be reduced to a single white space character (SP). For definition of SWS and LWS, see IETF RFC 3261 [11]. | +| Content (of SIPHeader) | Content tag shall include a regular expression in a form of Extended Regular Expressions (ERE) as defined in clause 9 in IEEE 1003.1-2004 Part 1 [13]. The regular expression shall be matched against the header-value of the SIP header. For definition of header and header-value, see IETF RFC 3261 [11]. If the SIP header contains several header-values in a comma-separated list, each of the header-value shall be matched against the pattern for the Content separately. Before matching the header-value to the pattern, all SWSs shall be removed from the header-value and all LWSs in the header-value shall be reduced to a single white space character (SP). For definition of SWS and LWS, see IETF RFC 3261 [11]. | +| SessionDescription | A Session Description SPT shall be evaluated separately against each SDP field instance within the SIP message. The Session Description SPT matches if at least one field occurrence matches the SPT. | +| Line (of SessionDescription) | Line tag shall include a regular expression in a form of Extended Regular Expressions (ERE) as defined in clause 9 in IEEE 1003.1-2004 Part 1 [13]. The regular expression shall be matched against the type of the field inside the session description. For definition of type, see clause 6 in IETF RFC 4566 [12]. | +| Content (of SessionDescription) | Content tag shall include a regular expression in a form of Extended Regular Expressions (ERE) as defined in clause 9 in IEEE 1003.1-2004 Part 1 [13]. The regular expression shall be matched against the value of the field inside the session description. For definition of value, see clause 6 in IETF RFC 4566 [12]. | + +# Annex G (normative): Emergency registrations + +S-CSCF and HSS shall handle emergency registrations as normal registrations with the following considerations: + +- Upon emergency registration, following cases apply: + - If a normal registration for the same user does not exist, the S-CSCF shall download corresponding user profile from HSS, ensure that the HSS allocates S-CSCF name to this subscriber and the registration status is set to UNREGISTERED. + - Otherwise, the S-CSCF shall ensure that the registration status of the user is not changed in the HSS. +- Upon deregistration or expiration of the last normal session, if an emergency registration is still active for this subscriber, the S-CSCF shall ensure that the HSS keeps S-CSCF name allocated to this subscriber and the registration status is set to UNREGISTERED. + +- Upon expiration of an emergency registration, the S-CSCF shall ensure the registration status of the user is not changed in the HSS if there are other normal registrations of the user. Otherwise, the S-CSCF may send SAR to the HSS to remove its name and set the registration status of the user to NOT REGISTERED. +- IMS Restoration procedures do not apply for IMS emergency sessions. + +# --- Annex H (normative): Diameter overload control mechanism + +## H.1 General + +Diameter overload control mechanism is an optional feature. + +IETF RFC 7683 [24] specifies a Diameter overload control mechanism which includes the definition and the transfer of related AVPs between Diameter nodes. + +It is recommended to make use of IETF RFC 7683 [24] on the Cx interface where, when applied, the I/S-CSCF shall behave as reacting nodes and the HSS as a reporting node. + +Depending on regional/national requirements and network operator policy, priority traffic (e.g. MPS as described in TS 22.153 [25]) 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. + +## H.2 HSS behaviour + +The HSS requests traffic reduction from the I/S-CSCF when the HSS is in an overload situation, including OC-OLR AVP in answer commands as described in IETF RFC 7683 [24]. + +The HSS identifies that it is in an overload situation by implementation specific means. For example, the HSS may take into account the traffic over the Cx interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources, etc. + +The HSS determines the specific contents of OC-OLR AVP in overload reports and the HSS decides when to send OC-OLR AVPs by implementation specific means. + +## H.3 I/S-CSCF behaviour + +The I/S-CSCF applies required traffic reduction received in answer commands to subsequent applicable requests, as per IETF RFC 7683 [24]. + +The I/S-CSCF achieves requested traffic reduction by implementation specific means. For example, the I/S-CSCF may implement message throttling with prioritization or a message retaining mechanism for operations that can be postponed. + +Diameter requests related to priority traffic (e.g. MPS) and emergency, detected via the presence of priority information (e.g., Resource-Priority header field for MPS) in SIP messages as described in TS 24.229 [8], have the highest priority. Depending on regional/national regulatory and operator policies, these Diameter requests shall be the last to be throttled, when the I/S-CSCF has to apply traffic reduction. Relative priority amongst various priority traffic (e.g. MPS) and emergency traffic is subject to regional/national regulatory and operator policies. + +# --- Annex I (Informative): Diameter overload node behaviour + +## I.1 Message prioritization + +This clause describes possible behaviours of the I/S-CSCF regarding message prioritisation in an informative purpose. + +The I/S-CSCF may take the following into account when making throttling decisions: + +- Identification of the procedures that can be deferred (e.g. Deregistration Request), so to avoid to drop non deferrable procedures; +- Prioritisation of certain types of request (e.g. between MAR and SAR for S-CSCF, and between LIR and UAR for I-CSCF) according to the context of their use, in particular: + - Higher prioritisation of SAR commands for S-CSCF that are related to a registered user for a service, so to avoid the interruption of the registered service for the user; + - Higher prioritisation of LIR commands for I-CSCF that are related to a requested service different from registration or deregistration, so to get more originating or terminating services provided to the user; +- Skipping of optional authentication. +- Priority level of a priority user (e.g., MPS user). + +# --- Annex J (normative): Diameter message priority mechanism + +## J.1 General + +IETF RFC 7944 [27] specifies a Diameter message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes may 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. + +## J.2 Cx/Dx interfaces + +### J.2.1 General + +The Diameter message priority mechanism is an optional feature. + +It is recommended to make use of IETF RFC 7944 [27] over the Cx/Dx interfaces of an operator network when the overload control defined in Annex H is applied on these Cx/Dx interfaces. + +### J.2.2 S-CSCF/I-CSCF behaviour + +When the S-CSCF/I-CSCF supports the Diameter message priority mechanism, the S-CSCF/I-CSCF shall comply with IETF RFC 7944 [27]. + +The S-CSCF/I-CSCF sending a request shall determine the required priority according to its policies. When priority is required, the S-CSCF/I-CSCF 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 S-CSCF/I-CSCF 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 the S-CSCF/I-CSCF 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: + +- the S-CSCF/I-CSCF 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 S-CSCF/I-CSCF shall set the DSCP marking for transport of the request or response according to the required priority level. + +Diameter requests related to priority traffic (e.g. MPS as identified by the S-CSCF/I-CSCF through SIP procedures, emergency) shall contain a DRMP AVP with a high priority of which the level value is operator dependent. + +When not-explicitly requested, the inclusion and priority value of the DRMP AVP in Diameter messages are implementation specific. + +### J.2.3 HSS/SLF behaviour + +When the HSS/SLF supports the Diameter message priority mechanism, the HSS/SLF shall comply with IETF RFC 7944 [27]. + +The HSS/SLF sending a request shall determine the required priority according to its policies. When priority is required, the HSS/SLF 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 HSS/SLF 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 the HSS/SLF 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: + +- the HSS/SLF 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 HSS/SLF shall set the DSCP marking for transport of the request or response according to the required priority level. + +When not-explicitly requested, the inclusion and priority value of the DRMP AVP in Diameter messages are implementation specific. + +### J.2.4 Interactions + +If the HSS supporting the Diameter message priority mechanism receives the request message containing both the Session-Priority AVP and DRMP AVP, the HSS shall prioritize the request according to priority level received within the DRMP AVP. + +# --- Annex K (normative): Diameter load control mechanism + +## K.1 General + +The Diameter load control mechanism is an optional feature. + +It is recommended to make use of IETF IETF RFC 8583 [29] on the Cx interface where, when applied, the I-CSCF and the S-CSCF shall behave as reacting nodes and the HSS as a reporting node. + +## K.2 HSS behaviour + +The HSS may report its current load by including a Load AVP of type HOST in answer commands as described in IETF IETF RFC 8583 [29]. + +The HSS calculates its current load by implementation specific means. For example, the HSS may take into account the traffic over the Cx interface or other interfaces, the level of usage of internal resources (e.g. CPU, memory), the access to external resources, etc. + +The HSS determines when to send Load AVPs of type HOST by implementation specific means. + +## K.3 I-CSCF/S-CSCF behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the I-CSCF/S-CSCF may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF IETF RFC 8583 [29]. \ No newline at end of file diff --git a/marked/Rel-18/29_series/29250/raw.md b/marked/Rel-18/29_series/29250/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..58943db25916ebbeb5ee923cdf0254e42e107b0b --- /dev/null +++ b/marked/Rel-18/29_series/29250/raw.md @@ -0,0 +1,1157 @@ + + +# 3GPP TS 29.250 V18.0.0 (2024-03) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Nu reference point between SCEF and PFDF for sponsored data connectivity (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' in smaller letters below the logo. + +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. + +© 2024, 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 Nu reference point..... | 7 | +| 4.1 Overview ..... | 7 | +| 4.2 Nu reference model ..... | 7 | +| 4.3 Functional elements..... | 8 | +| 4.3.1 PFDF..... | 8 | +| 4.3.2 SCEF..... | 8 | +| 4.4 Procedures over Nu reference point..... | 8 | +| 4.4.1 Management of PFD..... | 8 | +| 4.4.2 PFD management notification ..... | 9 | +| 5 Nu protocol ..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Transport layer ..... | 10 | +| 5.3 Application delivery layer..... | 10 | +| 5.3.1 General ..... | 10 | +| 5.3.2 HTTP status codes..... | 10 | +| 5.3.3 Methods ..... | 10 | +| 5.3.4 Resources and URI design..... | 11 | +| 5.3.5 HTTP request/response formats ..... | 11 | +| 5.3.5.1 General..... | 11 | +| 5.3.5.2 POST /nuapplication/provisioning ..... | 12 | +| 5.3.5.3 POST /nuapplication/notification ..... | 14 | +| 5.3.6 Feature negotiation ..... | 15 | +| 5.3.6.1 General..... | 15 | +| 5.3.6.2 HTTP custom headers..... | 16 | +| 5.3.6.2.1 3gpp-Optional-Features..... | 16 | +| 5.3.6.2.2 3gpp-Required-Features ..... | 16 | +| 5.3.6.2.3 3gpp-Accepted-Features..... | 16 | +| 5.4 Specific application communication ..... | 17 | +| 5.4.1 General ..... | 17 | +| 5.4.2 Content type..... | 17 | +| 5.4.3 JSON provisioning fields ..... | 17 | +| 5.4.3.1 General..... | 17 | +| 5.4.3.2 scef-notification-uri ..... | 17 | +| 5.4.4 Void..... | 18 | +| 5.4.5 JSON errors and informational response fields..... | 18 | +| 5.4.5.1 General..... | 18 | +| 5.4.6 JSON report fields ..... | 18 | +| 5.4.6.1 General..... | 18 | +| 5.4.6.2 pfd-reports..... | 18 | +| 5.4.6.3 application-ids..... | 19 | +| 5.4.7 JSON notification fields ..... | 19 | +| 5.4.7.1 General..... | 19 | +| 5.4.7.2 notification-pfd-reports..... | 19 | +| 5.4.7.3 user-plane-location-area..... | 20 | +| 5.4.7.4 cell-ids..... | 20 | +| 5.4.7.5 enodeb-ids..... | 20 | +| 5.4.7.6 extended-enodeb-ids ..... | 20 | +| 5.4.7.7 routing-area-ids ..... | 20 | + +| | | | +|-------------------------------|-----------------------------------------------|-----------| +| 5.4.7.8 | tracking-area-ids ..... | 21 | +| 5.5 | PFDF discovery ..... | 21 | +| 5.6 | SCEF discovery ..... | 21 | +| 6 | Secure communication ..... | 21 | +| Annex A (informative): | JSON Schema ..... | 21 | +| A.1 | Provisioning schema ..... | 21 | +| A.2 | Error and Informational response schema ..... | 23 | +| A.3 | PFD management notification schema ..... | 25 | +| Annex B (informative): | Call Flows ..... | 28 | +| B.1 | General ..... | 28 | +| B.2 | Provisioning of PFDs ..... | 28 | +| Annex C (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. + +# 1 Scope + +The present document provides the stage 3 specification of the Nu reference point. The functional requirements and the stage 2 specifications of the Nu reference point are specified in 3GPP TS 23.682 [2]. The Nu reference point lies between the Packet Flow Description Function (PFDF) and the Service Capability Exposure Function (SCEF). + +# 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.203: "Policy and charging control architecture". +- [4] 3GPP TS 29.213: "Policy and Charging Control signalling flows and QoS parameter mapping". +- [5] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [6] IETF RFC 2818: "HTTP Over TLS". +- [7] IETF RFC 793: "Transmission Control Protocol". +- [8] Void. +- [9] 3GPP TS 29.251: "Gw and Gwn reference points for sponsored data connectivity". +- [10] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [11] IETF RFC 7159: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [12] IETF draft-newton-json-content-rules-09: "A Language for Rules Describing JSON Content". + +NOTE: This individual draft will not further progress in IETF. It is available from the following link: +. + +- [13] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing". +- [14] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [15] IETF RFC 7232: "Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests". +- [16] IETF RFC 7233: "Hypertext Transfer Protocol (HTTP/1.1): Range Requests". +- [17] IETF RFC 7234: "Hypertext Transfer Protocol (HTTP/1.1): Caching". +- [18] IETF RFC 7235: "Hypertext Transfer Protocol (HTTP/1.1): Authentication". +- [19] 3GPP TS 29.274: "Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". + +# 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]. + +**Packet Flow Description (PFD):** A set of information enabling the detection of application traffic provided by a 3rd party service provider (from 3GPP TS 23.203 [3]). + +## 3.2 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 3GPP TR 21.905 [1]. + +| | | +|------|------------------------------------------| +| JSON | JavaScript Object Notation | +| PCEF | Policy and Charging Enforcement Function | +| PFD | Packet Flow Description | +| PFDF | Packet Flow Description Function | +| SCEF | Service Capability Exposure Function | +| TDF | Traffic Detection Function | + +# 4 Nu reference point + +## 4.1 Overview + +The Nu reference point is located between the Packet Flow Description Function (PFDF) and the Service Capability Exposure Function (SCEF). The Nu reference point is used for provisioning of PFDs from the SCEF to the PFDF and reporting the result of the PFD Management from the PFDF to the SCEF. + +The stage 2 level requirements for the Nu reference point are defined in 3GPP TS 23.682 [2]. + +## 4.2 Nu reference model + +The Nu reference point is defined between the SCEF and the PFDF. 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 [4]. + +![Diagram of the Nu reference model showing the PFDF and SCEF connected via the Nu reference point.](ba9d6e1a75eb6672d04e61a86e1b8a61_img.jpg) + +The diagram illustrates the Nu reference model. It consists of two light green rectangular boxes, labeled 'PFDF' on the left and 'SCEF' on the right. A horizontal line connects the two boxes. Above this line, centered between the boxes, is the label 'Nu'. A small vertical tick mark is positioned on the horizontal line directly below the 'Nu' label. + +Diagram of the Nu reference model showing the PFDF and SCEF connected via the Nu reference point. + +Figure 4.2.1: Nu reference model + +## 4.3 Functional elements + +### 4.3.1 PFDF + +The PFDF (Packet Flow Description Function) is a functional element which receives and manages the PFDs associated to application identifier (s) from the SCEF via the Nu reference point. + +The PFDF provisions PFDs for the corresponding application identifier (s) to the PCEF/TDF as defined in 3GPP TS 23.203 [3] and 3GPP TS 29.251 [9]. + +### 4.3.2 SCEF + +The SCEF (Service Capability Exposure Function) is a functional element which provides means to securely expose the services and capabilities provided by the 3GPP network interfaces. + +The SCEF shall support the management of PFDs provided by the 3rd party SCS/AS. The SCEF may provision the PFDs to the PFDF via the Nu reference point. + +## 4.4 Procedures over Nu reference point + +### 4.4.1 Management of PFD + +The PFDs associated with application identifier (s) may be created, updated or removed in the PFDF by the third party SCS/AS via the SCEF as defined in 3GPP TS 23.682 [2]. + +If the SCEF receives one or more sets of PFDs for external application identifier (s) provisioned by the third party SCS/AS, which is authorized to perform the management of PFDs based on operator policies, the SCEF shall: + +- If the external application identifier(s) is different from the application identifier(s) known at the PFDF, translate the external application identifier(s) to the application identifier(s) known at the PFDF; and +- may check if the allowed delay satisfies the required SLA against the minimum allowed delay as defined in 3GPP TS 23.682 [2]; and +- send an HTTP POST message to the PFDF including the provisioned PFD changes for the the application identifier (s) within the body of the HTTP POST as described in clause 5.3.5.2. + +NOTE 1: It is up to operator configuration whether to use different external application identifiers that require a mapping to application identifiers known at the PFDF. The external application identifier can be the same as the application identifier known at the PFDF. + +Upon receipt of the HTTP request for the provisioning operation from the SCEF, the PFDF shall perform the following steps: + +- If an allowed delay is received for an application identifier, for Pull mode as defined in 3GPP TS 29.251 [9], the PFDF shall compare the allowed delay with the configured caching time which is: + - a caching time value configured for that application identifier; or + - the default caching time value if no caching time value is configured for that application identifier. +- Then if the PFDF cannot ensure the PCEF/TDF will pull the PFDs in time (i.e. allowed delay is shorter than the caching time), the PFDF shall within the HTTP response send a failure reason and that caching time value used in the comparison and may still store (create/update/remove) the PFDs for this application identifier. + +NOTE 2: In the Combination mode as defined in 3GPP TS 29.251 [9], the PFDF can check the received allowed delay against the caching time but will always store (create/update/remove) the PFDs. + +- In the Pull mode as defined in 3GPP TS 29.251 [9], for the application identifier(s) without the need to send failure reason; or in the Push or Combination mode as defined in 3GPP TS 29.251 [9], for received application identifier(s), the PFDF shall: + +- delete all the PFD(s) for the application identifier(s) where the removal-flag is also provided and set to true; +- update the existing PFD(s) if a new PFD(s) with the same PFD identifier(s) is received , add new PFD(s) if the new PFD(s) with a new PFD identifier(s) is received, and/or delete an existing PFD(s) if the same PFD identifier(s) without any content is received, where the partial-flag is also provided and set to true; +- remove existing PFD(s) (if available) and install the new PFD(s) for the corresponding PFD identifier(s) where no flag is provided; +- acknowledge the HTTP POST message by sending a corresponding HTTP response with the appropriate status code as defined in clause 5.3.2. If the POST operation was successful for at least one application identifier, the PFDF shall respond with an HTTP 200 OK status code. + +### 4.4.2 PFD management notification + +In the Push mode or Combination mode as defined in 3GPP TS 29.251 [9], if the PFDs are provisioned to at least one of the known PCEFs/TDFs (but not all) within the allowed delay (i.e. the provisioned PFDs can not be enforced successfully in some PCEF/TDFs known on the PFDF), the PFDF may notify the SCEF about the failed PFD provisioning with the HTTP POST message using the failure reason "PARTIAL\_FAILURE" as defined in Table 5.4.7.1-1. In this case, the PFDF may include location area(s) of the PCEF/TDF(s) which can not enforce the provisioned PFD(s) within the field "user-plane-location-area" of the corresponding instance of the PFD report(s). If the PFDs are provisioned to none of the known PCEFs/TDFs within the allowed delay, the PFDF shall notify the SCEF about the failed PFD provisioning with the HTTP POST message using appropriate failure reason as defined in clause 6.4.6.3 of 3GPP TS 29.251 [9]. + +When receiving the HTTP POST message, the SCEF shall respond with an HTTP response message. + +# --- 5 Nu protocol + +## 5.1 Introduction + +The following layers of the protocol stack for the Nu reference point between the SCEF and the PFDF are described in clauses: + +- IETF RFC 793 [7] provides the communication service at the transport layer. +- An optional communication security layer can be added between the transport and the application delivery layer (see clause 6). +- The application delivery layer provides the transport of the specific application communication data using IETF RFC 7230 [13], IETF RFC 7231 [14], IETF RFC 7232 [15], IETF RFC 7233 [16], IETF RFC 7234 [17] and IETF RFC 7235 [18]. +- The specific application communication layer constitutes the transport of the JSON content type. + +Figure 5.1.1 illustrates the protocol stack of the RESTful Nu reference point. + +![Figure 5.1.1: Protocol stack of the RESTful Nu reference point. The diagram shows two protocol stacks, SCEF and PFDF, connected by a REST-Nu interface. The SCEF stack has layers: JSON (Specific application communication), HTTP (Application delivery), TCP (Transport layer), IP (Network layer), L2 (Data link layer), and L1 (Physical layer). The PFDF stack has the same layers: JSON, HTTP, TCP, IP, L2, and L1. The REST-Nu interface is shown as a vertical line between the two stacks.](e6df2733626a85205c1db682e6259c46_img.jpg) + +| | | | | +|------------------------------------|------|---------|------| +| Specific application communication | JSON | | JSON | +| Application delivery | HTTP | | HTTP | +| Transport layer | TCP | | TCP | +| Network layer | IP | | IP | +| Data link layer | L2 | | L2 | +| Physical layer | L1 | | L1 | +| | SCEF | REST-Nu | PFDF | + +Figure 5.1.1: Protocol stack of the RESTful Nu reference point. The diagram shows two protocol stacks, SCEF and PFDF, connected by a REST-Nu interface. The SCEF stack has layers: JSON (Specific application communication), HTTP (Application delivery), TCP (Transport layer), IP (Network layer), L2 (Data link layer), and L1 (Physical layer). The PFDF stack has the same layers: JSON, HTTP, TCP, IP, L2, and L1. The REST-Nu interface is shown as a vertical line between the two stacks. + +**Figure 5.1.1: Protocol stack of the RESTful Nu reference point** + +## 5.2 Transport layer + +HTTP is layered over TCP, which provides a reliable transport. + +For provisioning of PFDs from the SCEF to the PFDF, the SCEF acts as an HTTP client and the PFDF acts as an HTTP server. As a result, the SCEF shall initiate a TCP connection with the PFDF. + +## 5.3 Application delivery layer + +### 5.3.1 General + +The application delivery layer shall use RESTful HTTP. + +The application delivery layer provides provisioning of the PFDs by the SCEF. + +If the SCEF needs to provision PFDs for a set of application identifier(s) (creation/update/deletion) to the PFDF, the SCEF shall send an HTTP POST message. + +### 5.3.2 HTTP status codes + +The HTTP status codes for the REST-based Nu interface are specified in the IETF RFC 7231 [14]. + +### 5.3.3 Methods + +Methods indicate to the server what action has to be performed. Every HTTP request message has a method. + +The HTTP POST method is used by the SCEF to provision PFDs for a set of application identifiers. The request URI defines the address responsible for the management of the PFDs provisioning as a controller resource. + +The HTTP POST method is also used by the PFDF to inform the SCEF for PFD management notification. + +Every HTTP request results in a response message that comes back with a status code and further information in its body, if required. The HTTP request initiator waits for this response before initiating a further request. + +### 5.3.4 Resources and URI design + +The URI design shall be based on the structure defined in IETF RFC 3986 [10]: + +``` +scheme ":" hier-part [ "?" query ] [ "#" fragment ] +hier-part = "//" authority path-abempty +/ path-absolute +/ path-rootless +/ path-empty +``` + +The scheme may be HTTP or HTTPS for the Nu interface. Within a scheme the definition of names shall follow the rules of HTTP URIs. Host and port are the main parts of the authority. The path element identifies the resources. + +For the Nu interface, the following required parts of the URI shall be used as follows: + +scheme: The application delivery layer protocol "http" or "https". + +authority: It includes the server address and optionally a port as follows: host [":" port] + +path-absolute: The path-absolute should have the following ABNF: "/" mainapp "/" mainresource. In this release: + +"mainapp" is "nuapplication". + +"mainresource" is "provisioning". + +The PFDs management (associating/disassociating PFDs with application identifiers) in PFDF is a controller resource that is responsible for processing requests that provisioning a set of changes for more than one set of PFDs for corresponding application identifiers atomically. + +An example of the URI to identify the controller resource is . + +NOTE: A different path can be used when the Resource URI is preconfigured in the SCEF. + +### 5.3.5 HTTP request/response formats + +#### 5.3.5.1 General + +The PFDs provisioning procedure is performed through HTTP transactions consisting of a request initiated by the SCEF and answered by the PFDF. + +Table 5.3.5.1-1 summarizes the content of the requests and responses. More detailed information is specified in the corresponding clauses as indicated in the table. + +**Table 5.3.5.1-1: Nu requests/response summary table** + +| Method | Resource URI's path | Clause Defined | Request body | Initiator | Response body | +|--------|-----------------------------------------------------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------|-----------|------------------------------------------------------------------------------------------------------| +| POST | /nuapplication/provisioning (NOTE 1) | 5.3.5.2 | Content-Type: application/json
The SCEF shall include PFDs content associated with application identifier(s) using the schema defined in Annex A. | SCEF | Successful response: The PFDF may include informational data in the body of the response in Annex A. | +| POST | {sceF-notification-uri}
or
/nuapplication/notification (NOTE 2) | 5.3.5.3 | Content-Type: application/json
The PFDF shall include notification result and application identifier(s) using the schema defined in Annex A. | PFDF | | + +NOTE 1: A different path from /nuapplication/provisioning may be used when it is configured in the SCEF. In that case the "path" part set in the different methods should use the configured one. + +NOTE 2: A different path from /nuapplication/notification may be used when it is configured in the PFDF and no sceF-notification-uri is received in the provisioning POST. In that case the "path" part set in the different methods should use the configured one. + +#### 5.3.5.2 POST /nuapplication/provisioning + +The provisioning of the PFDs shall be performed by the SCEF by using the POST method as follows: + +- The request URI formatted as defined in clause 5.3.4 with the "path" part set to: /nuapplication/provisioning. +- The Content-Type header field set to "application/json" +- The body of the message encoded in JSON format as defined in Annex A. The body shall include + - for the PFD(s) creation for a new application identifier, a new application identifier and its full list of PFD(s) to be created; + - for the PFD(s) full update for an existing application identifier, the existing application identifier and its new full list of PFD(s) + - for the PFD(s) partial update for an existing application identifier, the existing application identifier, partial update indication and + - new PFD(s) with new PFD identifier(s) to add new PFD(s), + - new PFD(s) with existing PFD identifier(s) to update existing PFD(s), and/or + - the existing PFD identifier(s) without any content to remove the existing PFD(s); + - for the PFD(s) removal for an existing application identifier, the existing application identifier and the removal indication. + +Upon receipt of the HTTP POST request, the PFDF shall respond to the SCEF indicating whether the provisioning was successful or not using one of the HTTP status codes as defined in clause 5.3.2. If the provisioning was accepted, the PFDF shall respond with an HTTP 200 OK status code if no resource is created, or an HTTP 201 Created status code if one or more resources are created. If the allowed delay is too short according to the criteria in clause 4.4.1, the PFDF shall respond with an HTTP 200 OK status code and additional information in the body of the response indicating failure reason "too short allowed delay" and the value of caching time as defined in Annex A. If the provisioning was rejected, the PFDF shall indicate the reason using an appropriate HTTP status code as defined in clause 5.3.2 and optionally additional information in the body of the response as defined in Annex A. + +Below is an example of an HTTP POST and a corresponding successful response: + +POST /nuapplication/provisioning HTTP/1.1 +Host: pfdserver.example.com +Content-Type: application/json +Content-Length: ... + +``` +[ + { + "application-identifier":"test-application-1", + "removal-flag":true + }, + { + "application-identifier":"test-application-2", + "allowed-delay":600, + "pfds":[ + { + "pfd-identifier":"pfd1", + "flow-descriptions":[ + "permit in ip from 10.68.28.39 80 to any" + ] + }, + { + "pfd-identifier":"pfd2", + "urls":[ + "^http://test.example.com(/\\S*)?$" + ] + } + ] + }, + { + "application-identifier":"test-application-3", + "partial-flag":true, + "pfds":[ + { + "pfd-identifier":"pfd3", + "urls":[ + "^http://test.example2.net(/\\S*)?$" + ] + } + ] + } +] +``` + +``` + ] + }, + { + "pfd-identifier":"pfd4" + } +] +} +] +``` + +Here is an example of a successful response: + +HTTP/1.1 200 OK + +Date: Mon, 7 May 2012 16:00:00 GMT + +Server: pfdserver.example.com + +Content-Type: application/json + +``` +{ + "success-message": "Notification was processed successfully.", +} +``` + +#### 5.3.5.3 POST /nuapplication/notification + +The notification of the PFD management shall be performed by the PFDF by using the POST method as follows: + +- The request URI formatted as defined in clause 5.3.4 with the "path" part set to: /nuapplication/notification. +- The Content-Type header field set to "application/json". +- The body of the message encoded in JSON format as defined in Annex A. The body shall include the pfd-report. + +Upon receipt of the HTTP POST request, the SCEF shall respond to the PFDF with HTTP 200 OK status code. + +Below is an example of an HTTP POST and a corresponding response: + +POST /nuapplication/notification HTTP/1.1 + +Host: scefservers.example.com + +Content-Type: application/json + +Content-Length: ... + +``` +{ + "notification-pfd-reports": [ + { + "application-ids": ["test-application-1", "test-application-2", "test-application-3"], + "pfd-failure-code": "PARTIAL_FAILURE", + "user-plane-location-area": { + "cell-ids" : ["46000045BD6007", "46000045BD6008"], + } + } + ] +} +``` + +``` + "tracking-area-ids" : ["46000063F8", "46000063F9"] + } +} +] +} +``` + +Here is an example of a response: + +HTTP/1.1 200 OK + +Date: Mon, 7 May 2018 16:00:00 GMT + +Server: scefservers.example.com + +Content-Type: application/json + +### 5.3.6 Feature negotiation + +#### 5.3.6.1 General + +The REST based Nu interface needs to provide a mechanism to advertise required and optional features supported by both the SCEF and PFDF for interoperability reasons as the functionality of the REST Nu based interface is augmented. + +Feature negotiation shall take place during the first interaction (i.e. HTTP POST in provisioning) between the PFDF and the SCEF. The client shall include in the HTTP request the set of supported features as follows: + +- if a feature is required for the proper operation of the application, it shall be included within the 3gpp-Required-Features header; +- if a feature is optional for the proper operation of the application, it shall be included within the 3gpp-Optional-Features header. + +The server shall include, within the 3gpp-Accepted-Features header in the HTTP response, the set of features it supports in common with the client. + +If the server does not support any of the required features advertised by the client within the 3gpp-Required-Features header, the server shall reject the HTTP request with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the client within the 3gpp-Accepted-Features. + +If the server requires certain features to be supported that are not advertised by the client, the server shall reject the HTTP request with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the client within the 3gpp-Accepted-Features and the required features in the 3gpp-required-features. + +If the SCEF and the PFDF successfully negotiate supported features, the list of commonly supported features shall be applicable for the lifetime of the application. Features that are not advertised as supported shall not be used. + +The sender may send information that is related to the supported features. Any unrecognized information shall be ignored by the receiver. + +The table below defines the features applicable to the Nu interface. + +**Table 5.3.6.1-1: Features used in Nu Interface** + +| Feature | M/O | Description | +|-------------------------------------------------------------------------------------------------------------------------|-----|---------------------------------------------------------------------------------------------------| +| DomainNameProtocol | O | This feature supports the additional protocol matching condition for the domain name in PFD data. | +| PfdMgmtNotification | O | This feature supports the PFD management notification. | +| Feature: A short name for the feature to which the M/O and description pertain. | | | +| M/O: Indication on whether the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release. | | | +| Description: Textual description of the feature. | | | + +NOTE: The base functionality for the Nu interface is defined in the Release-14 version of this specification and a feature is an extension of that functionality. The negotiation of supported features allows interworking between the endpoints of the Nu interface whereby each entity may support all, some, or none of the features that the Nu application can support defined in this specification. Features are defined so that they are independent of each other. Any introduced feature is explicitly defined in this specification. + +Since a post Release-16 version of SCEF does not send any supported feature information, the interworking PFDF supporting Release-16 version does not need to send any information related to supported feature and both sides shall behave as specified in the Release-14 version of this specification. + +A post Release-16 version of PFDF may receive supported feature information from a Release-16 version of SCEF, those information will be ignored by the PFDF and both sides shall behave as specified in the Release-14 version of this specification. + +#### 5.3.6.2 HTTP custom headers + +This clause defines any new HTTP custom headers introduced by this specification. + +##### 5.3.6.2.1 3gpp-Optional-Features + +This header is used by the client to advertise the optional features that are supported by the client. + +The encoding of the header follows the ABNF as defined in IETF RFC 7230 [13]. + +`3gpp-Optional-Features = "3gpp-Optional-Features" ":" 1#token` + +An example is: `3gpp-Optional-Features: feature1, feature2` + +##### 5.3.6.2.2 3gpp-Required-Features + +This header is used by the client to announce the mandatory features that must be supported in the server. + +This header is also used by the server to indicate the missing features that must be supported in the client. + +The encoding of the header follows the ABNF as defined in IETF RFC 7230 [13]. + +`3gpp-Required-Features = "3gpp-Required-Features" ":" 1#token` + +An example is: `3gpp-Required-Features: feature1, feature2` + +##### 5.3.6.2.3 3gpp-Accepted-Features + +The header is used by the server to confirm the commonly supported set of features with the client. + +The encoding of the header follows the ABNF as defined in IETF RFC 7230 [13]. + +`3gpp-Accepted-Features = "3gpp-Accepted-Features" ":" 1#token` + +An example is: `3gpp-Accepted-Features: feature1, feature2` + +## 5.4 Specific application communication + +### 5.4.1 General + +Specific application communication represents the presentation of application data structures by transforming data into the form that the application accepts. It establishes the context between application-layer entities. + +NOTE: This release only supports the content type JSON. + +### 5.4.2 Content type + +The body of HTTP messages shall be in JSON format. The content of the JSON text is defined in clause 5.4.3 and Annex A. + +The MIME media type that shall be used within the Content-Type header field is "application/json" as defined in IETF RFC 7159 [11]. + +### 5.4.3 JSON provisioning fields + +#### 5.4.3.1 General + +Table 5.4.3.1-1 describes the JSON provisioning fields used within the body of the HTTP messages representing the PFDs information associated with an application identifier. The table includes the information about the name of the field and the type of the fields. + +**Table 5.4.3.1-1: Nu Provisioning JSON fields** + +| Field Name | Clause defined | JSON Value Type
(NOTE 1) | JCR Type
(NOTE 2) | Applicability
(NOTE 4) | +|------------------------|--------------------|-----------------------------|----------------------|---------------------------| +| application-identifier | 3GPP TS 29.251 [9] | string | string | | +| allowed-delay | 3GPP TS 29.251 [9] | number | uint64 | | +| pfdids | 3GPP TS 29.251 [9] | array | array | | +| pfd-identifier | 3GPP TS 29.251 [9] | string | string | | +| flow-descriptions | 3GPP TS 29.251 [9] | array | array | | +| urls | 3GPP TS 29.251 [9] | array | array | | +| domain-names | 3GPP TS 29.251 [9] | array | array | | +| removal-flag (NOTE 3) | 3GPP TS 29.251 [9] | boolean | boolean | | +| partial-flag (NOTE 3) | 3GPP TS 29.251 [9] | boolean | boolean | | +| dn-protocol | 3GPP TS 29.251 [9] | string | string | DomainNameProtocol | +| scef-notification-uri | 5.4.3.2 | string | string | PfdMgmtNotification | + +NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. +NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. +NOTE 3: Only one of the removal-flag and the partial-flag for the application identifier shall be set to true. +NOTE 4: Fields marked with a supported feature are applicable as described in clause 5.3.6. + +#### 5.4.3.2 scef-notification-uri + +The scef-notification-uri is of type string indicating the SCEF sent URI for receiving notifications. + +### 5.4.4 Void + +### 5.4.5 JSON errors and informational response fields + +#### 5.4.5.1 General + +Table 5.4.4.1-1 describes the JSON fields defined for the errors and informational responses including their types and the field names. + +**Table 5.4.5.1-1: JSON fields for errors and informational response** + +| Field Name | Clause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | Applicability (NOTE 5) | +|---------------------------------------------------------------------------------------------|-----------------------------|--------------------------|-----------------------------------------------------------------|------------------------| +| errors | 3GPP TS 29.251 [9] (NOTE 4) | array | array | | +| error-type | 3GPP TS 29.251 [9] (NOTE 4) | string | "application"
"interface"
"server"
"other"
(NOTE 3) | | +| error-message | 3GPP TS 29.251 [9] | string | string | | +| error-tag | 3GPP TS 29.251 [9] | string | string | | +| error-path | 3GPP TS 29.251 [9] | string | string | | +| error-info | 3GPP TS 29.251 [9] | object | object | | +| success-message | 3GPP TS 29.251 [9] | string | string | | +| success-path | 3GPP TS 29.251 [9] | string | string | | +| success-info | 3GPP TS 29.251 [9] | object | object | | +| NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. | | | | | +| NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. | | | | | +| NOTE 3: The quoted strings for a string type. | | | | | +| NOTE 4: The error is sent from the PFDF to the SCEF. | | | | | +| NOTE 5: Fields marked with a supported feature are applicable as described in clause 5.3.6. | | | | | + +### 5.4.6 JSON report fields + +#### 5.4.6.1 General + +Table 5.4.6.1-1 describes the JSON fields defined for the report information objects which are included in the error-info field. + +**Table 5.4.6.1-1: JSON fields for Report from the PFDF** + +| Field Name | Clause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | Applicability (NOTE 4) | +|---------------------------------------------------------------------------------------------|-----------------------------|--------------------------|-------------------|------------------------| +| pfd-reports | 5.4.6.2 | array | array | | +| application-ids | 5.4.6.3 | array | array | | +| pfd-failure-code | 3GPP TS 29.251 [9] (NOTE 3) | string | string | | +| caching-time | 3GPP TS 29.251 [9] | number | uint64 | | +| NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. | | | | | +| NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. | | | | | +| NOTE 3: The additional failure reasons for Nu are "TOO_SHORT_ALLOWED_DELAY". | | | | | +| NOTE 4: Fields marked with a supported feature are applicable as described in clause 5.3.6. | | | | | + +#### 5.4.6.2 pfd-reports + +The pfd-reports field is of type array and it contains a list of pfd reports. + +The pfd-reports field can be used in an HTTP response to report failures in the installation/modification of PFDs. In this case, it shall be provided as a sub field of the error-info field. + +Multiple pfd report instances shall be provided within the pfd-reports field if different pfd-failure-code values are applicable within the same HTTP response. + +caching-time field is included if the pfd-failure-code is set to the value "TOO\_SHORT\_ALLOWED\_DELAY". + +A report instance shall contain application-ids and pfd-failure-code fields. + +The JCR format for the pfd-reports is: + +``` +$pfd-reports = "pfd-reports" : [ + { $application-ids, + $pfd-failure-code, + $caching-time, + } + +] +``` + +#### 5.4.6.3 application-ids + +The application-ids field is of type array of string, and contains one or more application identifiers to which the PFDs belong. + +### 5.4.7 JSON notification fields + +#### 5.4.7.1 General + +Table 5.4.7.1-1 describes the JSON notification fields used within the body of the HTTP messages. The table includes the information about the name of the field and the type of the fields. + +**Table 5.4.7.1-1: Nu Notification JSON fields** + +| Field Name | Clause defined | JSON Value Type
(NOTE 1) | JCR Type
(NOTE 2) | Applicability
(NOTE 3) | +|--------------------------|---------------------------------|-----------------------------|----------------------|---------------------------| +| notification-pfd-reports | 5.4.7.2 | array | array | PfdMgmtNotification | +| application-ids | 5.4.6.3 | array | array | PfdMgmtNotification | +| pfd-failure-code | 3GPP TS 29.251 [9] (
NOTE 4) | string | string | PfdMgmtNotification | +| user-plane-location-area | 5.4.7.3 | object | object | PfdMgmtNotification | +| cell-ids | 5.4.7.4 | array | array | PfdMgmtNotification | +| enodeb-ids | 5.4.7.5 | array | array | PfdMgmtNotification | +| extended-enodeb-ids | 5.4.7.6 | array | array | PfdMgmtNotification | +| routing-area-ids | 5.4.7.7 | array | array | PfdMgmtNotification | +| tracking-area-ids | 5.4.7.8 | array | array | PfdMgmtNotification | + +NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. +NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. +NOTE 3: Fields marked with a supported feature are applicable as described in clause 5.3.6. +NOTE 4: The additional failure reasons for Nu are "PARTIAL\_FAILURE". + +#### 5.4.7.2 notification-pfd-reports + +The notification-pfd-reports field is of type array and it contains a list of pfd reports. + +The notification-pfd-reports field can be used in an HTTP POST to notify the failures in the installation/modification of PFDs. In this case, it shall be included in the body of the message. + +Multiple pfd report instances shall be provided within the notification-pfd-reports field if different pfd-failure-code values are applicable within the same HTTP response. + +user-plane-location-area field is included if the pfd-failure-code is set to the value "PARTIAL\_FAILURE". + +A report instance shall contain application-ids and pfd-failure-code fields. + +The JCR format for the notification-pfd-reports is: + +``` +$notification-pfd-reports = "notification-pfd-reports" : [ + { $application-ids, + $pfd-failure-code, + $user-plane-location-area ? + } + +] +``` + +#### 5.4.7.3 user-plane-location-area + +The user-plane-location-areas field is of type object and it contains location areas of the user plane(s) which can not enforce the PFD(s) successfully. + +The JCR format for the user-plane-location-area is: + +``` +$user-plane-location-area = // : { + $cell-ids ?, + $enodeb-ids ?, + $extended-enodeb-ids ?, + $routing-area-ids ?, + $tracking-area-id ? +} +``` + +#### 5.4.7.4 cell-ids + +The cell-ids is of type string array and it contains a list of Cell Global Identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in clause 8.21.1 of 3GPP TS 29.274 [19]. + +#### 5.4.7.5 enodeb-ids + +The enodeb-ids is of type string array and it contains a list of eNodeB identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in clause 8.21.7 of 3GPP TS 29.274 [19]. + +#### 5.4.7.6 extended-enodeb-ids + +The enodeb-ids is of type string array and it contains a list of eNodeB identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in clause 8.21.8 of 3GPP TS 29.274 [19]. + +#### 5.4.7.7 routing-area-ids + +The routing-area-ids is of type string array and it contains a list of Routing Area Identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in clause 8.21.3 of 3GPP TS 29.274 [19]. + +#### 5.4.7.8 tracking-area-ids + +The tracking-area-ids is of type string array and it contains a list of Tracking Area Identities served by the user plane(s) which can not enforce the PFD(s) successfully. The content of the string has the same encoding as defined in clause 8.21.4 of 3GPP TS 29.274 [19]. + +## 5.5 PFDF discovery + +The PFDF URI may be pre-configured on the SCEF. + +The SCEF may select the PFDF by this configuration. + +## 5.6 SCEF discovery + +The SCEF notification URI may be pre-configured on the PFDF. + +The SCEF notification URI may also be sent to the PFDF in the PFD provisioning. + +The PFDF may select the SCEF by the pre-configuration or use the notification URI received in the PFD provisioning. + +# --- 6 Secure communication + +Either the NDS/IP network layer security defined in 3GPP TS 33.210 [5] or HTTP over TLS as defined in IETF RFC 2818 [6] should be used to secure communication over the REST based Nu interface. + +# --- Annex A (informative): JSON Schema + +## A.1 Provisioning schema + +This clause defines the JSON schema for the body of HTTP request providing the provisioned PFDs. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +``` +# jcr-version 0.7 +``` + +``` +# ruleset-id 3gpp.nuapplication.provisioning +``` + +``` +# import 3gpp.gwapplication.pfds as pfds +``` + +``` +; JCR representing the PFDs provisioning data +``` + +``` +$provisioning-root = @{root} { +``` + +``` + $application-identifier, +``` + +``` + $removal-flag ?, +``` + +``` + $partial-flag ?, +``` + +``` + $allowed-delay ?, +``` + +``` + $pfds ?, +``` + +``` + $scefn-notification-uri ? +``` + +``` +} + +; An array list of the PFDs for multiple application identifiers +$pfd-array-root = @{root} [ $provisioning-root * ] + +; The detected application traffic identifier for the PFDs +$application-identifier = "application-identifier" : string + +; The allowed delay time for the PFDs deployment +$allowed-delay = "allowed-delay" : uint64 + +; The PFDs associated with the same application identifier +$pfd = "pfd" : [ $pfd * ] +; The PFD content +$pfd = { + $pfd-identifier, + ( $flow-descriptions | $urls | $domain-names | // : any ) ?, + $pfd.dn-protocol ? +} + +; The PFD identifier +$pfd-identifier = "pfd-identifier" : string + +; The flow descriptions +$flow-descriptions = "flow-descriptions" : [ string + ] + +; The url matching expressions +$urls = "urls" : [ string + ] + +; The domain name match criteria +$domain-names = "domain-names" : [ string + ] + +; A flag indicates whether this is a removal or not +$removal-flag = "removal-flag" : boolean +``` + +; A flag indicates whether this is a partial update or not +\$partial-flag = "partial-flag" : boolean + +; The URI in the SCEF for receiving notifications from the PFDF +\$sceff-notification-uri = "sceff-notification-uri" : string + +## --- A.2 Error and Informational response schema + +This clause defines the JSON schema for the body of HTTP responses in case of errors or success. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +# jcr-version 0.7 + +# ruleset-id 3gpp.nuapplication.info + +; A JCR for the error/successful response body + +; Errors information + +\$errors-root = @{root} { \$errors } + +; Success information + +``` +$success-root = @{root} { + $success-message, + $success-path ?, + $success-info ? +} +``` + +; Resource fields definitions + +; The list of errors returned in responses sent by the PCEF/TDF + +``` +$errors = "errors" : [ +{ + $error-type, + $error-message, + $error-tag ?, + $error-path ?, + $error-info ? +} + +] +``` + +; The error type for an error. It can be one of 'application', 'interface', 'server' and 'other'. + +\$error-type = "error-type" : ( "application" | "interface" | "server" | "other" ) + +; The error text message + +\$error-message = "error-message" : string + +; The error tag for a specific error + +\$error-tag = "error-tag" : string + +; A JSON pointer path to the error resource + +\$error-path = "error-path" : string + +; Any additional information for the error + +\$error-info = "error-info" : { + +\$pfd-reports ?, + +// : any \* + +} + +; Report fields definitions + +; The list of pfd reports sent to the SCEF + +\$pfd-reports = "pfd-reports" : [ + +{ + +\$application-ids, + +\$pfd-failure-code, + +\$caching-time + +} + + +] + +; The application identifiers for the PFDs + +\$application-ids = "application-ids" : [string+] + +; The string format for the pfd failure code + +\$pfd-failure-code =: ( + +"MALFUNCTION" | + +"RESOURCES\_LIMITATION" | + +"TOO\_SHORT\_ALLOWED\_DELAY" | + +``` +"PARTIAL_FAILURE" | +"OTHER_REASON" +) + +; The caching time for the PFDs +$caching-time = "caching-time" : uint64 + +; The successful text message +$success-message = "success-message" : string + +; A JSON pointer path to the success resource +$success-path = "success-path" : string + +; Any additional information for the success. +$success-info = "success-info" : { // : any * } +``` + +## --- A.3 PFD management notification schema + +This clause defines the JSON schema for the body of HTTP request providing the notification of PFD management. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +``` +# jcr-version 0.7 + +# ruleset-id 3gpp.nuapplication.notification + +; A JCR for the notification body +$notification-root = @{root} { + $notification-pfd-reports +} + +; Report fields definitions + +; The list of pfd reports sent to the SCEF +$notification-pfd-reports = "notification- pfd-reports" : [ +{ + $application-ids, + $pfd-failure-code, + $user-plane-location-area ? +} + +] +``` + +; The application identifiers for the PFDs + +\$application-ids = "application-ids" : [string+] + +; The string format for the pfd failure code + +\$pfd-failure-code =: ( +"MALFUNCTION" | +"RESOURCES\_LIMITATION" | +"PARTIAL\_FAILURE" | +"OTHER\_REASON" +) + +; The location area of user planes which can not enforce the PFDs successfully + +\$user-plane-location-area = { +\$cell-ids ?, +\$enodeb-ids ?, +\$extended-enodeb-ids ?, +\$routing-area-ids ?, +\$tracking-area-ids ? +} + +; The cell IDs served by the user planes which can not enforce the PFDs successfully + +\$cell-ids = "cell-ids" : [ string + ] + +; The eNodeB IDs served by the user planes which can not enforce the PFDs successfully + +\$enodeb-ids = "enodeb-ids" : [ string + ] + +; The extended eNodeB IDs served by the user planes which can not enforce the PFDs successfully + +\$extended-enodeb-ids = "extended-enodeb-ids" : [ string + ] + +; The Routing Area IDs served by the user planes which can not enforce the PFDs successfully + +\$routing-area-ids = "routing-area-ids" : [ string + ] + +; The Tracking Area IDs served by the user planes which can not enforce the PFDs successfully + +\$tracking-area-ids = "tracking-area-ids" : [ string + ] + + + +# --- Annex B (informative): Call Flows + +## B.1 General + +This annex describes the procedures for the interactions between the PFDF and the SCEF. + +## --- B.2 Provisioning of PFDs + +This clause describes the signalling flow for the Provisioning of PFDs. + +![Sequence diagram showing the provisioning of PFDs between SCEF and PFDF.](4af57aad638888edf2062306f8a54a6c_img.jpg) + +``` +sequenceDiagram + participant SCEF + participant PFDF + Note right of SCEF: 1. HTTP POST + SCEF->>PFDF: 1. HTTP POST + Note left of PFDF: 2. HTTP 200 OK + PFDF-->>SCEF: 2. HTTP 200 OK +``` + +The diagram is a sequence diagram illustrating the interaction between the SCEF (Service Capability Exposure Function) and the PFDF (PDN Gateway Selection Function) for provisioning PFDs. It consists of two vertical lifelines. The first message is an arrow from the SCEF lifeline to the PFDF lifeline, labeled '1. HTTP POST'. The second message is an arrow from the PFDF lifeline back to the SCEF lifeline, labeled '2. HTTP 200 OK'. + +Sequence diagram showing the provisioning of PFDs between SCEF and PFDF. + +**Figure B.2.1: Provisioning of PFDs** + +1. The SCEF sends the HTTP POST to the PFDF to indicate the creation, modification or deletion of PFDs for one or more application identifier(s) including the parameters defined in clause 5.3.5.2. +2. The PFDF sends the HTTP 200 OK response to the SCEF including the parameters defined in clause 5.3.5.2. + +# Annex C (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|--------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------|--------| +| 2016-10 | | | | | | TS skeleton of Nu reference point stage 3. | 0.0.0 | +| 2016-10 | | | | | | Inclusion of C3-163247, C3-163248, C3-163322 and editorial change from Rapporteur. | 0.1.0 | +| 2016-12 | | | | | | Inclusion of C3-164069, C3-164227 and editorial change from Rapporteur. | 0.2.0 | +| 2017-01 | | | | | | Inclusion of C3-170053, C3-17 0054, C3-170056 and editorial change from Rapporteur. | 0.3.0 | +| 2017-02 | | | | | | Inclusion of C3-171187, C3-171324, and editorial change from Rapporteur. | 0.4.0 | +| 2017-04 | | | | | | Inclusion of C3-172121, C3-172193, C3-172278, and editorial change from Rapporteur. | 0.5.0 | +| 2017-05 | | | | | | Inclusion of C3-173200, C3-173202, C3-173332, C3-173333 and editorial change from Rapporteur. | 0.6.0 | +| 2017-06 | CT#76 | CP-171145 | | | | TS sent to plenary for information and approval | 1.0.0 | +| 2017-06 | CT#76 | CP-171145 | | | | TS approved at plenary | 14.0.0 | +| 2017-09 | CT#77 | CP-172047 | 0001 | 2 | F | Caching time over the Nu interface | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0002 | 2 | F | Clarification of partial update | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0003 | 1 | F | Correct the example of the PFD provisioning | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0004 | 1 | F | Update the reference of HTTP 1.1 | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0007 | - | F | PFD handling for Push or Combination mode in PFDF | 14.1.0 | +| 2017-12 | CT#78 | CP-173100 | 0008 | - | F | JSON example correction | 14.2.0 | +| 2018-06 | CT#80 | | | | | Automatic upgrade from previous Release | 15.0.0 | +| 2019-03 | CT#83 | CP-190131 | 0010 | 2 | B | Supported feature negotiation | 16.0.0 | +| 2019-03 | CT#83 | CP-190133 | 0012 | 2 | B | PFD extension | 16.0.0 | +| 2019-06 | CT#84 | CP-191097 | 0015 | - | A | Reference update: draft-newton-json-content-rules | 16.1.0 | +| 2019-06 | CT#84 | CP-191100 | 0016 | - | F | Encoding of custom header fields | 16.1.0 | +| 2019-06 | CT#84 | CP-191102 | 0018 | 1 | B | PFD management notification | 16.1.0 | +| 2019-12 | CT#86 | CP-193220 | 0019 | 3 | B | PFD partial failure notification | 16.2.0 | +| 2022-03 | SA#95e | - | - | - | | Update to Rel-17 version (MCC) | 17.0.0 | +| 2024-03 | SA#103 | - | - | - | | Update to Rel-18 version (MCC) | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29251/raw.md b/marked/Rel-18/29_series/29251/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..f8b5ca31064e391b25050612df5c60688b6ed792 --- /dev/null +++ b/marked/Rel-18/29_series/29251/raw.md @@ -0,0 +1,1741 @@ + + +# 3GPP TS 29.251 V18.0.0 (2024-03) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Gw and Gwn reference point for sponsored data connectivity (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** + +## --- 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. + +© 2024, 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 Gw reference point..... | 7 | +| 4.1 Overview ..... | 7 | +| 4.2 Gw reference model ..... | 7 | +| 4.3 Functional elements..... | 8 | +| 4.3.1 PFDF..... | 8 | +| 4.3.2 PCEF..... | 8 | +| 4.4 Procedures over Gw reference point ..... | 8 | +| 4.4.1 Request for PFDs ("Pull mode" and "Combination mode")..... | 8 | +| 4.4.1.0 General..... | 8 | +| 4.4.1.1 Request for PFDs by the full pull ..... | 9 | +| 4.4.1.2 Request for PFDs by the partial pull..... | 9 | +| 4.4.2 Provisioning of PFDs ("Push mode" and "Combination mode") ..... | 10 | +| 5 Gwn reference point ..... | 11 | +| 5.1 Overview ..... | 11 | +| 5.2 Gwn reference model ..... | 11 | +| 5.3 Functional elements..... | 11 | +| 5.3.1 PFDF..... | 11 | +| 5.3.2 TDF..... | 11 | +| 5.4 Procedures over Gwn reference point ..... | 11 | +| 6 Gw/Gwn protocol..... | 12 | +| 6.1 Introduction ..... | 12 | +| 6.2 Transport layer ..... | 12 | +| 6.3 Application delivery layer..... | 13 | +| 6.3.2 Resources and URI design..... | 13 | +| 6.3.2.1 General..... | 13 | +| 6.3.2.2 URI design for Pull mode ..... | 14 | +| 6.3.2.3 URI design for Push mode..... | 14 | +| 6.3.3 HTTP request/response formats ..... | 14 | +| 6.3.3.1 General..... | 14 | +| 6.3.3.2 GET /gwapplication/pfdfs/{application-identifier} ..... | 15 | +| 6.3.3.3 GET /gwapplication/pfdfs?{query-parameters } ..... | 17 | +| 6.3.3.4 GET /gwapplication/pfdfs..... | 18 | +| 6.3.3.5 POST /gwapplication/provisioning..... | 19 | +| 6.3.4 HTTP status codes ..... | 23 | +| 6.3.5 Feature negotiation ..... | 23 | +| 6.3.5.1 General..... | 23 | +| 6.3.5.2 HTTP custom headers..... | 24 | +| 6.3.5.2.1 3gpp-Optional-Features..... | 24 | +| 6.3.5.2.2 3gpp-Required-Features..... | 25 | +| 6.3.5.2.3 3gpp-Accepted-Features..... | 25 | +| 6.3.5.3 Precedence for HTTP custom headers..... | 25 | +| 6.4 Specific application communication ..... | 25 | +| 6.4.1 General ..... | 25 | +| 6.4.2 Content type..... | 25 | +| 6.4.3 JSON PFDs fields..... | 25 | +| 6.4.3.1 General..... | 25 | +| 6.4.3.2 application-identifier..... | 26 | +| 6.4.3.3 void ..... | 26 | + +| | | | +|-------------------------------|-------------------------------------------------------|-----------| +| 6.4.3.4 | caching-time..... | 26 | +| 6.4.3.5 | pfds..... | 26 | +| 6.4.3.6 | pfd-identifier ..... | 27 | +| 6.4.3.7 | flow-descriptions ..... | 27 | +| 6.4.3.8 | urls ..... | 27 | +| 6.4.3.9 | domain-names..... | 27 | +| 6.4.3.10 | dn-protocol..... | 27 | +| 6.4.4 | JSON provisioning fields ..... | 27 | +| 6.4.4.1 | General..... | 27 | +| 6.4.4.2 | notification-flag ..... | 28 | +| 6.4.4.3 | removal-flag..... | 28 | +| 6.4.4.4 | allowed-delay..... | 28 | +| 6.4.4.5 | partial-flag..... | 28 | +| 6.4.5 | JSON errors and informational response fields..... | 28 | +| 6.4.5.1 | General..... | 28 | +| 6.4.5.2 | error-tag ..... | 29 | +| 6.4.6 | JSON report fields ..... | 29 | +| 6.4.6.1 | General..... | 29 | +| 6.4.6.2 | pfd-reports..... | 29 | +| 6.4.6.3 | pfd-failure-code ..... | 30 | +| 6.4.7 | JSON partial pull response fields ..... | 30 | +| 6.4.7.1 | General..... | 30 | +| 6.4.7.2 | partial-flag..... | 30 | +| 6.4.8 | JSON partial pull request fields..... | 30 | +| 6.4.8.1 | General..... | 30 | +| 6.4.8.2 | timestamp..... | 31 | +| 6.5 | The discovery of PCEF/TDF and PFDF ..... | 31 | +| 6.5.1 | PCEF/TDF discovery ..... | 31 | +| 6.5.2 | PFDF discovery ..... | 31 | +| 7 | Secure communication..... | 31 | +| Annex A (normative): | JSON Schema ..... | 32 | +| A.1 | PFDs schema..... | 32 | +| A.2 | Provisioning schema ..... | 33 | +| A.3 | Error and Informational response schema ..... | 34 | +| A.4 | Partial pull request schema ..... | 36 | +| A.5 | Partial pull response schema..... | 37 | +| Annex B (informative): | Call Flows..... | 38 | +| B.1 | General..... | 38 | +| B.2 | Request for PFDs by Full Pull (“Pull mode”)..... | 38 | +| B.3 | Provisioning of PFDs (“Push mode”)..... | 38 | +| B.4 | Provisioning of PFDs by Push with Notifications ..... | 39 | +| B.5 | Request for PFDs by Partial Pull (“Pull mode”)..... | 40 | +| Annex C (informative): | Change history..... | 41 | + +# --- 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 Gw and Gwn reference points. The functional requirements and the stage 2 specifications of the Gw and Gwn reference points are specified in 3GPP TS 23.203 [2]. The Gw reference point lies between the Packet Flow Description Function (PFDF) and the Policy and Charging Enforcement Function (PCEF). The Gwn reference point lies between the Packet Flow Description Function (PFDF) and the Traffic Detection Function (TDF). + +# 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.203: "Policy and charging control architecture". +- [3] 3GPP TS 29.213: "Policy and Charging Control signalling flows and QoS parameter mapping" +- [4] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications". +- [5] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [6] IETF RFC 793: "Transmission Control Protocol". +- [7] Void. +- [8] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [9] IETF RFC 2818: "HTTP Over TLS". +- [10] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax" +- [11] IETF RFC 7159: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [12] IETF draft-newton-json-content-rules-09: "A Language for Rules Describing JSON Content". + +NOTE: This individual draft will not further progress in IETF. It is available from the following link: +. + +- [13] IETF RFC 6733: "Diameter Base Protocol". +- [14] 3GPP TS 29.250: "Nu reference point between SCEF and PFDF for sponsored data connectivity". +- [15] 3GPP TS 29.155: "Traffic steering control; Representational state transfer (REST) over St reference point". +- [16] IETF RFC 7230: "Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing". +- [17] IETF RFC 7231: "Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content". +- [18] IETF RFC 7232: "Hypertext Transfer Protocol (HTTP/1.1): Conditional Requests". + +- [19] IETF RFC 7233: "Hypertext Transfer Protocol (HTTP/1.1): Range Requests". +- [20] IETF RFC 7234: "Hypertext Transfer Protocol (HTTP/1.1): Caching". +- [21] IETF RFC 7235: "Hypertext Transfer Protocol (HTTP/1.1): Authentication". +- [22] IETF RFC 3339: "Date and Time on the Internet: Timestamps". + +# --- 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 TR 21.905 [1]. + +**Packet Flow Description (PFD):** A set of information enabling the detection of application traffic provided by a 3rd party service provider (from 3GPP TS 23.203 [2]). + +**Pull mode:** A mode used between the PCEF/TDF and the PFDF where the PFDs are sent by the PFDF at reception of an HTTP request from the PCEF/TDF. + +**Push mode:** A mode used between the PCEF/TDF and the PFDF where the PFDs and/or notification of PFD deletion are sent by the PFDF in an HTTP request to the PCEF/TDF. + +**Combination mode:** A mode used between the PCEF/TDF and the PFDF where both pull and push exist. This mode allows the PFDF to send the PFDs at reception of an HTTP request from the PCEF/TDF and provision PFD changes (creation/update/deletion) and/or notification of PFD creation/update/deletion in the HTTP request to the PCEF/TDF. + +## 3.2 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 3GPP TR 21.905 [1]. + +| | | +|------|------------------------------------------| +| JSON | JavaScript Object Notation | +| PCEF | Policy and Charging Enforcement Function | +| PFD | Packet Flow Description | +| PFDF | Packet Flow Description Function | +| SCEF | Service Capability Exposure Function | +| TDF | Traffic Detection Function | + +# --- 4 Gw reference point + +## 4.1 Overview + +The Gw reference point is located between the Packet Flow Description Function (PFDF) and the Policy and Charging Enforcement Function (PCEF). The Gw reference point is used for retrieval, provisioning and removal of PFDs from the PFDF to the PCEF and reporting the handling result of PFDs from the PCEF to the PFDF. + +The stage 2 level requirements for the Gw reference point are defined in 3GPP TS 23.203 [2]. + +## 4.2 Gw reference model + +The Gw reference point is defined between the PFDF and the PCEF. The relationships between the different functional entities involved are depicted in figure 4.2.1. The overall PCC architecture is depicted in subclause 3a of 3GPP TS 29.213 [3]. + +![Figure 4.2.1: Gw reference model diagram showing PCEF and PFDF connected via a Gw interface.](d0abac95583b52a3b35f74a215567334_img.jpg) + +The diagram illustrates the Gw reference model. It consists of two rectangular boxes, one on the left labeled 'PCEF' and one on the right labeled 'PFDF'. A horizontal line connects the two boxes, with a small vertical tick mark in the middle. Above this tick mark is the label 'Gw', indicating the reference point between the two functional elements. + +Figure 4.2.1: Gw reference model diagram showing PCEF and PFDF connected via a Gw interface. + +Figure 4.2.1: Gw reference model + +## 4.3 Functional elements + +### 4.3.1 PFDF + +The PFDF (Packet Flow Description Function) is a functional element which stores PFDs associated with application identifier(s) and transfers them to the PCEF via Gw interface to enable the PCEF to perform accurate application detection when the PFDs are managed by a 3rd party service provider. + +The PFDF receives PFDs for the corresponding application identifier(s) from the SCEF as defined in 3GPP TS 23.682 [4] and 3GPP TS 29.250 [14]. + +### 4.3.2 PCEF + +The PCEF (Policy and Charging Enforcement Function) functionality defined in subclause 4.4.2 of 3GPP TS 29.212 [5] shall be applied. In addition, the PCEF shall support the management of PFDs provisioned by the PFDF. The application detection filter may be extended with the PFDs provided by the PFDF. + +## 4.4 Procedures over Gw reference point + +When the PFDF is deployed and the management of PFDs is supported by the PCEF, the mode of PFDs management shall be consistently configured in one PLMN, it may be: + +- Pull mode only, or +- Push mode only, or +- Combination mode. + +### 4.4.1 Request for PFDs ("Pull mode" and "Combination mode") + +#### 4.4.1.0 General + +If the PartialPull feature is not supported, at the time a PCC Rule with an application identifier for which PFDs provisioned by the PFDF are not available is activated or provisioned, or when the caching timer for an application identifier elapses and a PCC Rule for the application identifier is still active, the PCEF shall request all PFDs for the application identifier from the PFDF as defined in subclause 4.4.1.1. + +If the PartialPull feature is supported, when the caching timer for an application identifier elapses and a PCC rule for this application identifier is still active. The PCEF may request the PFDs for the application identifier from the PFDF as defined in subclause 4.4.1.2. + +When the PCEF receives the response from the PFDF, the PCEF shall install, update or remove the received PFD(s) for the application identifier(s) accordingly. + +The PCEF shall also for each application identifier start a caching timer with a value + +- according to the received caching time value for that application identifier, if such a value is received for that application identifier; or +- otherwise with a default caching time value configured in the PCEF. + +NOTE 1: The PCEF(s) and the PFDF(s) within an operator network are configured with the same default caching time value to be applied for all application identifiers. + +NOTE 2: In the combination mode, the HTTP POST message from the PFDF does not impact the running caching timer of an application identifier. + +When the PCEF removes the last PCC rule that refers to the corresponding application identifier, or when the caching timer expires and no PCC rule refers to the application identifier, the PCEF may remove the PFD(s) related with the application identifier. + +The PFDs retrieved from PFDF take precedence over any PFDs pre-configured in the PCEF. If all PFDs retrieved from the PFDF are removed for an application identifier, the pre-configured PFDs shall be applied again for the application identifier. + +#### 4.4.1.1 Request for PFDs by the full pull + +The PCEF shall send an HTTP GET message to the PFDF to retrieve the PFDs for one or more application identifier(s) as defined in subclauses 6.3.3.2, 6.3.3.3 and 6.3.3.4 if the PartialPull feature is not supported in the PFDF and PCEF. + +Upon receipt of the HTTP request for the pull operation, the PFDF shall respond to the PCEF indicating whether the pull operation was successful or not by using one of the HTTP status codes; if the pull operation is successful, the PFDF: + +- shall provide all the PFDs of the specified application identifier(s) from the request within the body of the HTTP response; and +- if there are caching time value(s) configured for any of the specified application identifier(s), shall set the caching-time to the caching time value(s) for those application identifier(s) in the body of the HTTP response. + +The PCEF shall install, update or remove the received PFD(s) for the application identifier(s) as defined subclauses 6.3.3.2, 6.3.3.3 and 6.3.3.4 respectively. + +#### 4.4.1.2 Request for PFDs by the partial pull + +The PCEF shall send an HTTP POST message to the PFDF for partial retrieval of the PFDs for one or more application identifier(s) as defined in subclause 6.3.3.6 if the PartialPull feature is supported in the PFDF and PCEF. The PCEF shall include the application identifier(s) and the corresponding timestamp of the PFD(s) received in the last provisioning for the application identifier in the request. The PCEF may also request full set of PFD(s) of an application identifier without including the timestamp if it is not available. + +Upon receipt of the HTTP request for the pull operation, the PFDF shall respond to the PCEF indicating whether the pull operation was successful or not by using one of the HTTP status codes; if the pull operation is successful, the PFDF: + +- shall include the full list of the PFD(s) for the application identifier(s) if the corresponding timestamp is not provided in the request; +- if there are no PFDs changed since the last request based on the timestamp, shall not provide the specified application identifier(s) in the body of the HTTP response; and +- if all the PFDs of the specified application identifier(s) is removed since the last request based on the timestamp, shall not provide any PFDs for the specified removed application identifier(s). +- if there are partial PFDs of the specified application identifier(s) changed since the last request based on the timestamp, shall provide the partial-flag and set to true and updated PFDs. +- if all PFDs are changed of the specified application identifier(s) since the last request based on the timestamp, shall provide all the new PFD(s) without the partial-flag. +- if there are caching time value(s) configured for any of the specified application identifier(s), shall set the caching-time to the caching time value(s) for those application identifier(s) in the body of the HTTP response. + +When the PCEF receives the response message, the PCEF shall + +- for an application identifier(s) within the request message but is not provided in the response message, reserve all the existing PFD(s); + +- for an application identifier(s) within the response message where the PFD(s) is provided but partial-flag is not provided, remove all the existing PFD(s) (if available) and install all the newly provided PDF(s); +- for an application identifier(s) within the response message where no PFD(s) is provided, delete the existing PFD(s) and remove the application identifier(s); +- for an application identifier(s) within the response message where the PFD(s) is provided and partial-flag is also provided and set to true + - install a new PFD(s) if the new PFD(s) with a new PFD identifier(s) is received, + - update an existing PFD(s) if a new PFD(s) with the same PFD identifier(s) is received, + - delete an existing PFD(s) if the same PFD identifier(s) without any content is received, and/or + - reserve an existing PFD(s) if the PFD identifier(s) is not received. + +### 4.4.2 Provisioning of PFDs ("Push mode" and "Combination mode") + +The PFDF may create, update or remove one or multiple PFDs associated with application identifier(s) to the PCEF. When the request for creation, update, or removal for an application identifier(s) is received from the SCEF, for the Push mode, the PFDF shall for each PCEF it serves: + +- immediately send to the PCEF an HTTP POST message including the provisioned changes of one or more application identifiers as specified in subclause 6.3.3.5, or +- wait for a period shorter than the allowed delay ( e.g. to aggregate all the PFDs for several application) , then send to the PCEF an HTTP POST message including the provisioned changes. + +For the Combination mode, the PFDF may for each PCEF it serves wait for a period shorter than the allowed delay (e.g. to aggregate all the PFDs for several application) and, if no HTTP GET request for that application identifier is received during the waiting time, then send an HTTP POST message including the provisioned changes and/or notification of PFD creation/update for that application identifier as specified in subclause 6.3.3.5. + +NOTE 1: In the combination mode, the PFDF can check the received allowed delay against the caching time as specified in subclause 4.4.1 of 3GPP TS 29.250 [14], in order to utilize the pull procedure. + +When the PCEF receives the HTTP POST message, the PCEF shall + +- for an application identifier(s) where no flag is provided, remove the all existing all PFD(s) (if available) and install all the new provided PDF(s). +- for an application identifier(s) where the removal-flag is also provided and set to true, delete the existing PFD(s); +- for an application identifier(s) where partial-flag is also provided and set to true + - install a new PFD(s) if the new PFD(s) with a new PFD identifier(s) is received, + - update an existing PFD(s) if a new PFD(s) with the same PFD identifier(s) is received, and/or + - delete an existing PFD(s) if the same PFD identifier(s) without any content is received; +- acknowledge the HTTP POST message by sending a corresponding HTTP response with the appropriate status code (200 OK for success) as described in subclause 6.3.4; and +- retrieve the PFDs for the corresponding application identifier(s) as defined in subclause 4.4.1 either immediately if the allowed-delay is not provided, or within the provided allowed-delay for the application identifier(s) where the notification-flag is included and set to true. + +NOTE 2: It depends on the implementation whether the PCEF initiates separate pull requests to retrieve the PFDs for different application identifier(s) within the allowed-delay. The decision to send PFD, and/or notification of PFD creation/update/deletion for certain application identifier on the PFDF is based on the operator policy. + +NOTE 3: In the push mode, the PFDF can be configured with the list of PCEFs per application identifier(s). + +NOTE 4: The caching timer is not applicable for the PCEF/TDF in Push mode. + +# 5 Gwn reference point + +## 5.1 Overview + +The Gwn reference point is located between the Packet Flow Description Function (PFDF) and the Traffic Detection Function (TDF). The Gwn reference point enables transport of PFDs from the PFDF to the TDF for a particular Application Identifier or for a set of Application Identifiers. + +The Gwn reference point supports the following functions: + +- Creation, updating and removal of individual or the whole set of PFDs from the PFDF to the TDF. +- Confirmation of creation, updating and removal of PFDs from the TDF to the PFDF. + +NOTE: The interaction between the PFDF and the TDF is not related to any IP-CAN session. + +The stage 2 level requirements for the Gwn reference point are defined in 3GPP TS 23.203 [2]. + +## 5.2 Gwn reference model + +The Gwn reference point is defined between the PFDF and the TDF. The relationships between the different functional entities involved are depicted in figure 5.2.1. The overall PCC architecture is depicted in subclause 3a of 3GPP TS 29.213 [3]. + +![Diagram of the Gwn reference model showing the TDF and PFDF connected by the Gwn reference point.](f14e75bd1c6e2f234db4775dbf0dbf1a_img.jpg) + +The diagram shows two light green rectangular boxes, labeled 'TDF' on the left and 'PFDF' on the right. A horizontal line connects the two boxes. Above the line, centered between the boxes, is the label 'Gwn'. A small vertical tick mark is present on the line, slightly to the left of the 'Gwn' label. + +Diagram of the Gwn reference model showing the TDF and PFDF connected by the Gwn reference point. + +Figure 5.2.1: Gwn reference model + +## 5.3 Functional elements + +### 5.3.1 PFDF + +Subclause 4.3.1 is applicable with the clarification that the TDF replaces the PCEF and Gwn interface replaces Gw interface. + +### 5.3.2 TDF + +The TDF (Traffic Detection Function) functionality defined in subclause 4b.4.2 of 3GPP TS 29.212 [5] shall be applied. In addition, the TDF shall support the management of PFDs provisioned by the PFDF. + +## 5.4 Procedures over Gwn reference point + +The procedures in subclause 4.4 are applicable with the clarification that the TDF replaces the PCEF in those procedures. + +# 6 Gw/Gwn protocol + +## 6.1 Introduction + +The following layers of the protocol stack for the Gw/Gwn reference point between PCEF/TDF and PFDF are described in subclauses: + +- TCP as defined in IETF RFC 793 [6] provides the communication service at the transport layer. +- An optional communication security layer can be added between the transport and the application delivery layer (see clause 7). +- The application delivery layer provides the transport of the specific application communication data using HTTP as defined in IETF RFC 7230 [16], IETF RFC 7231 [17], IETF RFC 7232 [18], IETF RFC 7233 [19], IETF RFC 7234 [20] and IETF RFC 7235 [21]. +- The specific application communication layer constitutes the transport of the JSON content type. + +Figure 6.1.1 illustrates the protocol stack of the RESTful Gw/Gwn reference point. + +![Figure 6.1.1: Protocol stack of the Gw/Gwn reference point. The diagram shows two protocol stacks, PCEF/TDF on the left and PFDF on the right, separated by a vertical line representing the Gw/Gwn reference point. Both stacks have six layers. From top to bottom, they are: Specific application communication (JSON), Application delivery (HTTP), Transport layer (TCP), Network layer (IP), Data link layer (L2), and Physical layer (L1). Horizontal lines connect corresponding layers between PCEF/TDF and PFDF across the reference point.](78ffccd66df9bafd96e3e081110d09dd_img.jpg) + +| | | | | +|------------------------------------|----------|--------|------| +| Specific application communication | JSON | | JSON | +| Application delivery | HTTP | | HTTP | +| Transport layer | TCP | | TCP | +| Network layer | IP | | IP | +| Data link layer | L2 | | L2 | +| Physical layer | L1 | | L1 | +| | PCEF/TDF | Gw/Gwn | PFDF | + +Figure 6.1.1: Protocol stack of the Gw/Gwn reference point. The diagram shows two protocol stacks, PCEF/TDF on the left and PFDF on the right, separated by a vertical line representing the Gw/Gwn reference point. Both stacks have six layers. From top to bottom, they are: Specific application communication (JSON), Application delivery (HTTP), Transport layer (TCP), Network layer (IP), Data link layer (L2), and Physical layer (L1). Horizontal lines connect corresponding layers between PCEF/TDF and PFDF across the reference point. + +**Figure 6.1.1: Protocol stack of the Gw/Gwn reference point** + +## 6.2 Transport layer + +HTTP is layered over TCP, which provides a reliable transport. + +If the "Pull mode" is deployed, then the PCEF/TDF shall act as an HTTP client and the PFDF shall act as an HTTP server. In this case, the PCEF/TDF shall initiate a TCP connection with the PFDF. + +If the "Push mode" is deployed, then the PFDF shall act as an HTTP client and the PCEF/TDF shall act as an HTTP server. In this case, the PFDF shall initiate a TCP connection with the PCEF/TDF. + +If the "Combination mode" is deployed, then + +- for pull request, the HTTP roles and TCP session establishment as described above for the "Pull mode" apply. +- for push request (with or without notification), the HTTP roles and TCP session establishment as described above for the "Push mode" apply. + +## 6.3 Application delivery layer + +The application delivery layer shall use RESTful HTTP. + +The application delivery layer provides the following services: + +- Retrieval of the PFDs from the PFDF +- Provisioning of the PFDs by the PFDF +- Notification sent from PFDF to the PCEF/TDF to indicate PFD changes related to application identifiers being created, updated or deleted + +In order to retrieve the PFD for a specific application identifier, the PFDF shall send an HTTP GET message including the application identifier as a path element of the request URI as specified in subclause 6.3.3.2. + +In order to retrieve the PFDs for a set of application identifiers, the PCEF/TDF shall send an HTTP GET message to the PFDF including the application identifier(s) as the query parameters in the URI as specified in subclause 6.3.3.3. + +In order to retrieve all PFDs, the PCEF/TDF may omit the '?' and {query parameters} in the HTTP GET message's URI as specified in subclause 6.3.3.4. + +If the PFDF needs to provision PFDs for a set of application identifier(s) (creation/update/deletion) to the PCEF/TDF, the PFDF shall send an HTTP POST message, which includes the provisioned changes and/or the notifications of impacted application identifiers as described in subclause 6.3.3.5. + +### 6.3.1 Methods + +Methods indicate to the server what action has to be performed. Every HTTP request message has a method. The following HTTP methods can be used: + +- GET: Used by the PCEF/TDF to retrieve the PFDs information for a set of application identifier(s). The server returns the PFDs representation within the body of the response. +- POST: Used by the PFDF to provision or notify PFDs changes for a set of application identifiers(s). The request URI defines the address responsible for the management of the PFDs provisioning as a controller resource. + +Every HTTP request results in a response message that comes back with a status code and further information in its body, if required. The HTTP request initiator waits for this response before initiating a further request. + +### 6.3.2 Resources and URI design + +#### 6.3.2.1 General + +The URI design shall be based on the structure defined in IETF RFC 3986 [10]: + +``` + +scheme ":" hier-part [ "?" query ] [ "#" fragment ] +hier-part = "//" authority path-abempty + / path-absolute + / path-rootless + / path-empty + +``` + +The scheme may be HTTP or HTTPS for the Gw/Gwn interface. Within a scheme the definition of names shall follow the rules of HTTP URIs. Host and port are the main parts of the authority. The path element identifies the resources. + +For the Gw/Gwn interface, the following required parts of the URI shall be used as follows: + +- scheme: The application delivery layer protocol "http" or "https". +- authority: It includes the server address and optionally a port as follows: host [":" port] +- path-absolute: The path-absolute should have the following ABNF: "/" mainapp "/" mainresource ["/" resourcepath]. In this release: + +- "mainapp" is "gwapplication". +- "mainresource" is defined in subclauses 6.3.2.2 and 6.3.2.3. +- "resourcepath" contains the path to identify the PFDs resource for a specific application identifier. + +#### 6.3.2.2 URI design for Pull mode + +In pull mode, the PFDs in PFDF is a readable RESTful resource: + +- "mainresource" is "pfd". +- "resourcepath" varies and is defined in subclauses 6.3.3.2, 6.3.3.3 and 6.3.3.4. + +An example of the URI to identify the RESTful resource is: . + +NOTE: A different resource path can be used when the Resource URI is preconfigured in the PCEF/TDF. + +#### 6.3.2.3 URI design for Push mode + +In push mode, the PFDs management (associating/disassociating PFDs with application identifiers) in PCEF/TDF is a controller resource that is responsible for processing push requests that involve provisioning and/or notifying a set of changes for more than one set of PFDs for corresponding application identifiers atomically. + +- "mainresource" shall be "provisioning". +- "resourcepath" is not applicable in push mode. + +An example of the URI to identify the controller resource is . + +NOTE: A different resource path can be used when the Resource URI is preconfigured in the PFDF. + +### 6.3.3 HTTP request/response formats + +#### 6.3.3.1 General + +The PFDs pull procedure is performed through HTTP transactions consisting of a request initiated by the PCEF/TDF and its corresponding response provided by the PFDF. While the PFDs push procedure is initiated by the PFDF and answered by the PCEF/TDF + +Table 6.3.3.1-1 summarizes the content of the requests and responses. More detailed information is specified in the corresponding subclauses as indicated in the table. + +Table 6.3.3.1-1: Gw/Gwn requests/response summary table + +| Method | Resource URI's path | Clause Defined | Request body | Initiator | Response body | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| GET | /gwapplication/pfds/{application-identifier}
(NOTE 1) | 6.3.3.2 | None | PCEF
/TDF | Successful response: The PPDF shall include the representation of the corresponding PDFs of the specified application identifier in the body of the response as per Annex A.1 | +| GET | /gwapplication/pfds?{query-parameters}
(NOTE 1) | 6.3.3.3 | None | PCEF
/TDF | Successful response: The PPDF shall include the representation of the corresponding PDFs for a set of application identifier(s) in the body of the response as per Annex A.1 | +| GET | /gwapplication/pfds
(NOTE 1) | 6.3.3.4 | None | PCEF
/TDF | Successful response: The PPDF shall include the representation of the corresponding PDFs for all application identifier(s) in the body of the response as per Annex A.1 | +| POST | /gwapplication/provisioning
(NOTE 2) | 6.3.3.5 | Content-Type: application/json
The PPDF may include PFDs content and/or notification associated with application identifier(s) using the schema defined in Annex A.2. | PPDF | Successful response: The PCEF/TDF may include informational data in the body of the response as per Annex A.3 | +| POST | /gwapplication/partialpull
(NOTE 3) | 6.3.3.6 | Content-Type: application/json
The PCEF/TDF may include application identifier(s) using the schema defined in Annex A.4. | PCEF
/TDF | Successful response: The PPDF shall include the representation of the corresponding updated PFD(s) for the requested application identifier(s) in the body of the response as per Annex A.5. | +| NOTE 1: A different path from /gwapplication/pfds/ may be used when it is configured in the PCEF/TDF. In that case the "path" part set in the different methods should use the configured one. | | | | | | +| NOTE 2: A different path from /gwapplication/provisioning may be used when it is configured in the PPDF. In that case the "path" part set in the different methods should use the configured one. | | | | | | +| NOTE 3: A different path from /gwapplication/partialpull may be used when it is configured in the PPDF. In that case the "path" part set in the different methods should use the configured one. | | | | | | + +#### 6.3.3.2 GET /gwapplication/pfds/{application-identifier} + +To retrieve the PFDs for a specific application identifier, the PCEF/TDF shall send an HTTP GET request to the PPDF as follows: + +- the request URI formatted as defined in subclause 6.3.2 with the "path" part set to: /gwapplication/pfds/{application-identifier}, where the application-identifier is the application id with which the PFDs are associated. + +Upon receipt of the HTTP GET, the PPDF shall respond to the PCEF/TDF indicating whether the querying of the resource was successful or not using one of the HTTP status codes as defined in subclause 6.3.4. If the resource exists, the PPDF shall respond with an HTTP 200 OK status code and include the PFDs representation state within the body of the response as defined in Annex A.1. If no resource was found, the PPDF shall respond with an HTTP 404 not found. The PPDF shall also include the Content-Type header field set to "application/json". + +If the PCEF/TDF receives the HTTP 404 not found status code, the PCEF/TDF shall remove all the PFD(s) of the queried application identifier. + +Below is an example of a corresponding HTTP GET: + +GET /gwapplication/pfds/test-application-1 HTTP/1.1 + +Host: pfdserver.example.com + +Here is an example of a successful response : + +HTTP/1.1 200 OK + +Server: pfdserver.example.com + +Content-Type: application/json + +Content-Length: ... + +``` +{ + "application-identifier":"test-application-1", + + "caching-time":200000, + "pfds":[ + { + + "pfd-identifier":"pfd1", + "flow-descriptions":[ + "permit in ip from 10.68.28.39 80 to any", + "permit out ip from any to 10.68.28.39 80" + ] + }, + { + "pfd-identifier":"pfd2", + "urls":[ + "^http://test.example.com(/\\S*)?$" + ] + } + ] +} +``` + +#### 6.3.3.3 GET /gwapplication/pfds?{query-parameters } + +To retrieve the PFDs for a set of application identifier(s), the PCEF/TDF may send an HTTP GET request to the PFDF as follows: + +- The request URI formatted as defined in subclause 6.3.2 with the "path" part set to: /gwapplication/pfds?{query-parameters}, where the query-parameters contains one or multiple application identifier(s) delimited by comma with a parameter name "application-identifiers". As an example: "application-identifiers=id1,id2,id3" +- Any "=" and "," for any application identifier in the query parameters shall be encoded as "%3D" and "%2C" in the URI. + +Upon receipt of the HTTP request, the PFDF shall respond to the PCEF/TDF indicating whether the querying of the resources was successful or not using one of the HTTP status codes as defined in subclause 6.3.4. If at least one resource exists, the PFDF shall respond with an HTTP 200 OK status code and include a list of the PFDs associated with the found application identifier(s) within the body of the response as defined in Annex A.1. If the PFDs associated with a queried application-identifier are not provided in the response, it implicitly means that the corresponding application-identifier does not exist at the PFDF. If no resource was found, the PFDF shall respond with an HTTP 404 not found. The PFDF shall also include the Content-Type header field set to "application/json". + +If the PCEF/TDF receives the 200 OK but one or more queried application identifier(s) is not provided in the response, the PCEF/TDF shall remove the PFD(s) of the queried application identifier(s) which is not included in the response. + +If the PCEF/TDF receives the HTTP 404 not found status code, the PCEF/TDF shall remove all the PFD(s) of the queried application identifier(s). + +Below is an example of this HTTP GET on two sets of PFDs query. But only one is found in the PFDF. + +GET /gwapplication/pfds?application-identifiers=test-application-1,test-application-2 HTTP/1.1 + +Host: pfdserver.example.com + +Here is an example of a successful response : + +HTTP/1.1 200 OK + +Server: pfdserver.example.com + +Content-Type: application/json + +Content-Length: ... + +``` +[ +{ + "application-identifier":"test-application-1", + "caching-time":200000, + "pfd": [ + { + "pfd-identifier":"pfd1", + "flow-descriptions": [ + "permit in ip from 10.68.28.39 80 to any", + "permit out ip from any to 10.68.28.39 80" + ] + }, + { +``` + +``` + "pfd-identifier":"pfd2", + "urls":[ + "^http://test.example.com(/\\S*)?$" + ] + } +] +} +] +``` + +#### 6.3.3.4 GET /gwapplication/pfds + +To retrieve PFDs associated with all application identifiers, the PCEF/TDF may send an HTTP GET request to the PFDF as follows: + +- The request URI formatted as defined in subclause 6.3.2 with the "path" part set to: /gwapplication/pfds. + +Upon receipt of the HTTP request, the PFDF shall respond to the PCEF/TDF indicating whether the querying of the resources was successful or not using one of the HTTP status codes as defined in subclause 6.3.4. If at least one resource exists, the PFDF shall respond with an HTTP 200 OK status code and include a list of the PFDs associated with the found application identifier(s) within the body of the response as defined in Annex A.1. If no resource was found, the PFDF shall respond with an HTTP 404 not found. The PFDF shall also include the Content-Type header field set to "application/json". + +If the PCEF/TDF receives the 200 OK but one or more application identifier(s) which exists at the PCEF/TDF is not provided in the response, the PCEF/TDF shall remove the PFD(s) of the application identifier(s) which is not included in the response. + +If the PCEF/TDF receives the HTTP 404 not found status code, the PCEF/TDF shall remove all the PFD(s) of all the identifier(s) which exist at the PCEF/TDF. + +Below is an example of this HTTP GET. + +GET /gwapplication/pfds HTTP/1.1 + +Host: pfdserver.example.com + +Here is an example of a successful response : + +HTTP/1.1 200 OK + +Server: pfdserver.example.com + +Content-Type: application/json + +Content-Length: ... + +``` +[ + { + "application-identifier":"test-application-1", + "caching-time":200000, + "pfds":[ + { +``` + +``` + + "pfd-identifier":"pfd1", + "flow-descriptions":[ + "permit in ip from 10.68.28.39 80 to any", + "permit out ip from any to 10.68.28.39 80" + ] + }, + { + "pfd-identifier":"pfd2", + "urls":[ + "^http://test.example.com(/\\S*)?$" + ] + } +] +} +] + +``` + +#### 6.3.3.5 POST /gwapplication/provisioning + +The provisioning of the PFDs shall be performed by the PFDF by using the POST method as follows: + +- The request URI formatted as defined in subclause 6.3.2 with the "path" part set to: /gwapplication/provisioning. +- The Content-Type header field set to "application/json" +- The body of the message encoded in JSON format as defined in Annex A.2. The body shall include + - for the PFD(s) creation for a new application identifier, a new application identifier and its full list of PFD(s) to be created; + - for the PFD(s) full update for an existing application identifier, the existing application identifier and its new full list of PFD(s); + - for the PFD(s) partial update for an existing application identifier, the existing application identifier, partial update indication and + - new PFD(s) with new PFD identifier(s) to install the new PFD(s) , + - new PFD(s) with existing PFD identifier(s) to update the existing PFD(s), and/or + - the existing PFD identifier(s) without any content to remove the PFD(s); + - for the PFD(s) removal for an existing application identifier, the existing application identifier and the removal indication; + - for the PFD(s) notification, the notification indication and an optional allowed delay time for the PCEF/TDF to pull the corresponding PFD(s) within the allowed delay time. + +Upon receipt of the HTTP POST, the PCEF/TDF shall respond to the PFDF indicating whether the provisioning was successful or not using one of the HTTP status codes as defined in subclause 6.3.4. If the provisioning was accepted, the + +PCEF/TDF shall respond with an HTTP 200 OK status code if no resource is created, or an HTTP 201 Created status code if one or more resources are created. If the provisioning was rejected, the PCEF/TDF shall indicate the reason using an appropriate HTTP status code for as defined in subclause 6.3.4 and optionally additional information in the body of the response as defined in Annex A.3. If the pfd-reports is included, the PCEF/TDF shall identify the failed PFDs by including the application-identifier and specify the failed reason code by including a pfd-failure-code field. + +Depending on the value of the pfd-failure-code field, the PFDF may provision the PFDs again. + +Below is an example of an HTTP POST and a corresponding successful response: + +POST /gwapplication/provisioning HTTP/1.1 + +Host: pcefserver.example.com + +Content-Type: application/json + +Content-Length: ... + +``` +[ + { + "application-identifier":"test-application-1", + "notification-flag":true, + "allowed-delay":600 + }, + { + "application-identifier":"test-application-2", + "removal-flag":true + }, + { + "application-identifier":"test-application-3", + "pfds":[ + { + "pfd-identifier":"pfd1", + "flow-descriptions":[ + "permit in ip from 10.68.28.39 80 to any" + ] + } + ] + }, + { + "application-identifier":"test-application-4", + "partial-flag":true, + "pfds":[ + { +``` + +``` + "pfd-identifier":"pfd3", + "urls":[ + "^http://test.example2.net(/\\S*)?$" + ] + }, + { + "pfd-identifier":"pfd4" + } +] +} +] +``` + +Here is an example of a successful response: + +HTTP/1.1 200 OK + +Date: Mon, 23 Apr 2012 17:10:00 GMT + +Server: pcefserver.example.com + +Content-Type: application/json + +``` +{ + "success-message": "Notification was processed successfully.", +} +``` + +#### 6.3.3.6 POST /gwapplication/partialpull + +The partialpull of the PFDs shall be performed by the PCEF by using the POST method as follows: + +- The request URI formatted as defined in subclause 6.3.2 with the "path" part set to: /gwapplication/partialpull. +- The Content-Type header field set to "application/json" +- The body of the message encoded in JSON format as defined in Annex A.4. The body shall include + - one or more existing application identifier(s) with corresponding timestamp if available for the PFD(s) partial pull, + +Upon receipt of the HTTP POST, the PFDF shall respond to the PCEF/TDF indicating whether the partialpull was successful or not using one of the HTTP status codes as defined in subclause 6.3.4. If the partialpull was accepted, the PFDF shall respond with an HTTP 200 OK status code and additional information in the body of the response as defined in Annex A.5. If the request was rejected, the PFDF shall indicate the reason using an appropriate HTTP status code for as defined in subclause 6.3.4 and optionally additional information in the body of the response as defined in Annex A.3. + +Depending on the value of the pfd-failure-code field, the PCEF/TDF may partialpull the PFDs again. + +Below is an example of an HTTP POST and a corresponding successful response: + +POST /gwapplication/partialpull HTTP/1.1 + +Host: pfdserver.example.com + +Content-Type: application/json + +Content-Length: ... + +``` +[ + { + "application-identifier":"test-application-1", + "timestamp":"2021-01-01T20:30:40.50z", + }, + { + "application-identifier":"test-application-2", }, + { + "application-identifier":"test-application-3", + "timestamp":"2021-01-01T20:30:40.50z", + }, +] +``` + +Here is an example of a successful response: + +HTTP/1.1 200 OK + +Server: pfdserver.example.com + +Content-Type: application/json + +Content-Length: ... + +``` +[ + { + "application-identifier":"test-application-1", + }, + { + "application-identifier":"test-application-2", + "timestamp":"2021-01-02T10:20:30.40z", + "caching-time":200000, + "pfd": [ + { + "pfd-identifier":"pfd1", + "flow-descriptions": [ + "permit in ip from 10.68.28.39 80 to any" + ] + } + ] + } +] +``` + +``` +}, +{ + "application-identifier":"test-application-3", + "timestamp":"2021-01-02T10:20:30.40z", + "caching-time":200000, + "partial-flag":true, + "pfd": [ + { + "pfd-identifier":"pfd3", + "urls": [ + "^http://test.example2.net(/\\S*)?$" + ] + }, + { + "pfd-identifier":"pfd4" + } + ] +} +] +``` + +### 6.3.4 HTTP status codes + +HTTP status codes are used as defined in IETF RFC 7231 [17] + +### 6.3.5 Feature negotiation + +#### 6.3.5.1 General + +The REST based Gw/Gwn interface needs to provide a mechanism to advertise required and optional features supported by both the PCEF/TDF and PFDF for interoperability reasons as the functionality of the REST Gw/Gwn based interface is augmented. + +Feature negotiation shall take place during the first interaction (either HTTP POST in push or HTTP GET in pull) between the PFDF and the PCEF/TDF. The client shall include in the HTTP request the set of supported features as follows: + +- if a feature is required for the proper operation of the application, it shall be included within the 3gpp-Required-Features header; +- if a feature is optional for the proper operation of the application, it shall be included within the 3gpp-Optional-Features header. + +The server shall include, within the 3gpp-Accepted-Features header in the HTTP response, the set of features it supports in common with the client. + +If the server does not support any of the required features advertised by the client within the 3gpp-Required-Features header, the server shall reject the HTTP request with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the client within the 3gpp-Accepted-Features. + +If the server requires certain features to be supported that are not advertised by the client, the server shall reject the HTTP request with an HTTP 412 Precondition Failed status code and shall include the commonly supported features with the client within the 3gpp-Accepted-Features and the required features in the 3gpp-required-features. + +If the PCEF/TDF and the PFDF successfully negotiate supported features, the list of commonly supported features shall be applicable for the lifetime of the application. Features that are not advertised as supported shall not be used. + +The sender may send information that is related to the supported features. Any unrecognized information shall be ignored by the receiver. + +The table below defines the features applicable to the Gw interface. + +**Table 6.3.5.1-1: Features used in Gw Interface** + +| Feature | M/O | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|---------------------------------------------------------------------------------------------------| +| PartialUpdate | O | The PFDF can use this feature for partial update in PFD push. | +| PartialPull | O | The PCEF can use this feature for partial pull in PFD retrieval. | +| DomainNameProtocol | O | This feature supports the additional protocol matching condition for the domain name in PFD data. | +| Feature: A short name for the feature to which the M/O and description pertain.
M/O: Indication on whether the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release.
Description: Textual description of the feature. | | | + +The table below defines the features applicable to the Gwn interface. + +**Table 6.3.5.1-2: Features used in Gwn Interface** + +| Feature | M/O | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|---------------------------------------------------------------------------------------------------| +| PartialUpdate | O | The PFDF can use this feature for partial update in PFD push. | +| PartialPull | O | The PCEF can use this feature for partial pull in PFD retrieval. | +| DomainNameProtocol | O | This feature supports the additional protocol matching condition for the domain name in PFD data. | +| Feature: A short name for the feature to which the M/O and description pertain.
M/O: Indication on whether the implementation of the feature is mandatory ("M") or optional ("O") in this 3GPP Release.
Description: Textual description of the feature. | | | + +NOTE: The base functionality for the Gw/Gwn interface is defined in the Release-14 version of this specification and a feature is an extension of that functionality. The negotiation of supported features allows interworking between the endpoints of the Gw/Gwn interface whereby each entity may support all, some, or none of the features that the Gw/Gwn application can support defined in this specification. Features are defined so that they are independent of each other. Any introduced feature is explicitly defined in this specification. + +#### 6.3.5.2 HTTP custom headers + +This subclause defines any new HTTP custom headers introduced by this specification. + +##### 6.3.5.2.1 3gpp-Optional-Features + +This header is used by the client to advertise the optional features that are supported by the client. + +The encoding of the header follows the ABNF as defined in IETF RFC 7230 [16]. + +3gpp-Optional-Features = "3gpp-Optional-Features" ":" 1#token + An example is: 3gpp-Optional-Features: feature1, feature2 + +##### 6.3.5.2.2 3gpp-Required-Features + +This header is used by the client to announce the mandatory features that must be supported in the server. + +This header is also used by the server to indicate the missing features that must be supported in the client. + +The encoding of the header follows the ABNF as defined in IETF RFC 7230 [16]. + +3gpp-Required-Features = "3gpp-Required-Features" ":" 1#token + +An example is: 3gpp-Required-Features: feature1, feature2 + +##### 6.3.5.2.3 3gpp-Accepted-Features + +The header is used by the server to confirm the commonly supported set of features with the client. + +The encoding of the header follows the ABNF as defined in IETF RFC 7230 [16]. + +3gpp-Accepted-Features = "3gpp-Accepted-Features" ":" 1#token + +An example is: 3gpp-Accepted-Features: feature1, feature2 + +#### 6.3.5.3 Precedence for HTTP custom headers + +The server shall evaluate the HTTP custom headers first if other conditional headers (e.g. If-None-Match, as defined in IETF RFC 7232 [18]) are also present. + +## 6.4 Specific application communication + +### 6.4.1 General + +Specific application communication represents the presentation of application data structures by transforming data into the form that the application accepts. It establishes the context between application-layer entities. + +NOTE: This release only supports the content type JSON + +### 6.4.2 Content type + +The HTTP POST requests in pull mode shall be an encoded string which is defined in subclause 6.3.3.4. + +The HTTP responses in pull mode as well as the HTTP messages in push mode shall be in JSON format. The content of the JSON text is defined in subclause 6.4.3, 6.4.4 and Annex A. + +The MIME media type that shall be used within the Content-Type header field is “application/json” as defined in IETF RFC 7159 [11]. + +### 6.4.3 JSON PFDs fields + +#### 6.4.3.1 General + +Table 6.4.3.1.1 describes the JSON fields used within the body of the HTTP messages representing the PFDs information associated with an application identifier. The table includes the information about the name of the field and the type of the fields. + +Table 6.4.3.1.1: Gw/Gwn PFD JSON fields + +| Field Name | Clause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | Applicability (NOTE 3) | +|------------------------|----------------|--------------------------|-------------------|------------------------| +| application-identifier | 6.4.3.2 | string | string | | +| caching-time | 6.4.3.4 | number | uint64 | | +| pfds | 6.4.3.5 | array | array | | +| pfd-identifier | 6.4.3.6 | string | string | | +| flow-descriptions | 6.4.3.7 | array | array | | +| urls | 6.4.3.8 | array | array | | +| domain-names | 6.4.3.9 | array | array | | +| dn-protocol | 6.4.3.10 | string | string | DomainNameProtocol | + +NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. +NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. +NOTE 3: Fields marked with a supported feature are applicable as described in subclause 6.3.5. + +#### 6.4.3.2 application-identifier + +The application-identifier field is of type string, and contains the application identifier to which the PFDs belong. + +#### 6.4.3.3 void + +#### 6.4.3.4 caching-time + +The caching-time field is of type uint64. It's a caching time value in seconds. When the caching timer elapses, the PCEF/TDF shall re-fetch the PFDs associated with the corresponding application-identifier from the PFDF. If the caching-time is: + +- omitted, the PCEF/TDF shall use the preconfigured default caching time value to control how long the PFDs valid; or +- set to zero, then the PFDs are valid until explicitly deleted by the PFDF. + +NOTE: The value zero of caching-time is only valid in the Combination mode and can be used as an indication of infinite PFD validity. It can be used to avoid unnecessary PFD refreshment for an application, in such case, the PFDs cannot be deleted at the expiration of the caching timer if it was not stopped at reception of caching-time set to zero value. + +#### 6.4.3.5 pfds + +The pfds field is of type array. It contains the PFDs that belong to a specific application identifier. When multiple PFDs are associated with the application identifier, the application is detected when any of the PFDs associated with the application identifier is matched. + +The following defines the content of the PFD: + +The pfd-identifier field shall be included within the PFD, and shall be unique within the context of an application identifier. + +At least one of the flow-descriptions field, the urls field, the domain-names field or a custom field shall be present for the application traffic detection. If a PFD contains multiple filter types, the PFD is only matched when every filter type contained in the PFD has a matching value. + +The custom field is type of any with an arbitrary field name. Any primitive type, array, or object defined in IETF RFC 7159 [11] can be set to this field. It provides the extensions for the proprietary application traffic detection mechanisms, based on the agreement between the ASP and the mobile operator. + +Below are the JCR for the PFD: + +``` +$pfd = { +``` + +``` +$pfd-identifier, +($flow-descriptions | $urls | $domain-names | // : any) ? +} +``` + +#### 6.4.3.6 pfd-identifier + +The pfd-identifier is of type string. It uniquely identifies a PFD within its associated application identifier. + +#### 6.4.3.7 flow-descriptions + +The flow-descriptions is of type string array. The content of the string has the same encoding as the IPFilterRule AVP value as defined in IETF RFC 6733 [13]. It represents a 3-tuple with protocol, server ip and server port for UL/DL application traffic. + +#### 6.4.3.8 urls + +The urls is type of string array. The content of the string shall be a URL or a regular expression which is used to match the significant parts of the URL. + +#### 6.4.3.9 domain-names + +The domain-names is type of string array. The content of the string shall be an FQDN or a regular expression as a domain name matching criteria. + +#### 6.4.3.10 dn-protocol + +The dn-protocol is type of string. It indicates the additional protocol and protocol field for domain names to be matched, applicable when domain-names field is present. + +The following values are defined: + +##### 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. + +##### TLS\_SCN + +Identifies the Subject Common Name in TLS ServerCertificate message. + +### 6.4.4 JSON provisioning fields + +#### 6.4.4.1 General + +In addition to subclause 6.4.3, Table 6.4.4.1.1 describes the extra JSON fields used within the body of the HTTP messages representing the PFDs provisioning information in push mode. The table includes the information about the name of the field and the type of the fields. + +Table 6.4.4.1.1: Gw/Gwn Provisioning JSON fields + +| Field Name | Clause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | Applicability (NOTE 3) | +|-----------------------------------------------------------------------------------------------------------------------------------|----------------|--------------------------|-------------------|------------------------| +| notification-flag (NOTE 4) | 6.4.4.2 | boolean | boolean | | +| removal-flag (NOTE 4) | 6.4.4.3 | boolean | boolean | | +| allowed-delay (NOTE 4) | 6.4.4.4 | number | uint64 | | +| partial-flag (NOTE 4) | 6.4.4.5 | boolean | boolean | PartialUpdate | +| NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. | | | | | +| NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. | | | | | +| NOTE 3: Fields marked with a supported feature are applicable as described in subclause 6.3.5. | | | | | +| NOTE 4: Only one of the notification-flag, removal-flag and the partial-flag for the application identifier shall be set to true. | | | | | + +#### 6.4.4.2 notification-flag + +The notification-flag is of type boolean. + +If the value of the flag is true, then it indicates a PFDs notification, and the corresponding PFDs information for the application identifier is not provided in the JSON body. Instead, the PCEF/TDF shall reload it with the application identifier via the pull procedure. + +#### 6.4.4.3 removal-flag + +The removal-flag is of type boolean. + +If the value of the flag is true, then it indicates the PFDs and its associated application identifier have been removed in the PFDF. The PCEF/TDF shall unbind all PFDs associated with that application identifier. + +#### 6.4.4.4 allowed-delay + +The allowed-delay field is of type uint64. It contains a time interval in seconds. The PFDs shall be deployed within this time interval. If the allowed-delay is omitted, or if it is set to zero, then the PFDs shall be immediately deployed. + +#### 6.4.4.5 partial-flag + +The partial-flag is of type boolean. + +If the value of the flag is true, then it indicates some PFDs for the application identifier(s) have been created/updated/deleted in the PFDF. The PCEF/TDF shall update existing PFDs or add new PFDs for the PFD identifier(s) with PFDs, or unbind all PFDs associated with the PFD identifier(s) without any PFDs content. + +### 6.4.5 JSON errors and informational response fields + +#### 6.4.5.1 General + +Table 6.4.5.1.1 describes the JSON fields defined for the errors and informational responses including their types and the field names. + +**Table 6.4.5.1.1: JSON fields for errors and informational response** + +| Field Name | Subclause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | +|-----------------|------------------------------|--------------------------|-----------------------------------------------------------------| +| errors | 3GPP TS 29.155 [15] (NOTE 4) | array | array | +| error-type | 3GPP TS 29.155 [15] (NOTE 4) | string | "application"
"interface"
"server"
"other"
(NOTE 3) | +| error-message | 3GPP TS 29.155 [15] | string | string | +| error-tag | 6.4.5.2 | string | string | +| error-path | 3GPP TS 29.155 [15] | string | string | +| error-info | 3GPP TS 29.155 [15] | object | object | +| success-message | 3GPP TS 29.155 [15] | string | string | +| success-path | 3GPP TS 29.155 [15] | string | string | +| success-info | 3GPP TS 29.155 [15] | object | object | + +NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. +NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. +NOTE 3: The quoted strings for a string type. +NOTE 4: The error is sent from the PCEF/TDF to the PFDF. + +#### 6.4.5.2 error-tag + +The error-tag field is of type string. It defines a tag for a particular error. + +##### PFD\_EVENT + +This error-tag shall be used when the PFDs cannot be installed/modified at the PCEF, pfd-reports shall be provided in the error-info as described in subclause 6.4.6. + +### 6.4.6 JSON report fields + +#### 6.4.6.1 General + +Table 6.4.6.1.1 describes the JSON fields defined for the report information objects which are included in the error-info field. + +**Table 6.4.6.1.1: JSON fields for Report from the PCEF** + +| Field Name | Subclause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | +|------------------|---------------------|--------------------------|-------------------| +| pdf-reports | 6.4.6.2 | array | array | +| application-ids | 3GPP TS 29.250 [14] | array | array | +| pfd-failure-code | 6.4.6.3 | string | string | + +NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. +NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. + +#### 6.4.6.2 pfd-reports + +The pfd-reports field is of type array and it contains a list of pfd reports. + +The pdf-reports field can be used in an HTTP response to report failures in the installation/modification of PFDs in the Push mode. In this case, it shall be provided as a sub field of the error-info field. + +Multiple pfd report instances shall be provided within the pfd-reports field if different pfd-failure-code values are applicable within the same HTTP response. + +A report instance shall contain the application-ids and pfd-failure-code fields. + +The JCR format for the pfd-reports is: + +``` +$pfd-reports = "pfd-reports" : [ + { $application-ids, + $pfd-failure-code + } + +] +``` + +#### 6.4.6.3 pfd-failure-code + +The pfd-failure-code is of type string. + +The following values are defined in this release: + +MALFUNCTION + +RESOURCES\_LIMITATION + +OTHER\_REASON + +### 6.4.7 JSON partial pull response fields + +#### 6.4.7.1 General + +In addition to subclause 6.4.3, Table 6.4.7.1.1 describes the extra JSON fields used within the body of the HTTP response messages representing the PFDs information in partial pull mode. The table includes the information about the name of the field and the type of the fields. + +**Table 6.4.7.1.1: Gw/Gwn Partial Pull Response JSON fields** + +| Field Name | Clause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | Applicability (NOTE 3) | +|------------------------------------------------------------------------------------------------|----------------|--------------------------|-------------------|------------------------| +| partial-flag | 6.4.4.5 | boolean | boolean | PartialPull | +| NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. | | | | | +| NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. | | | | | +| NOTE 3: Fields marked with a supported feature are applicable as described in subclause 6.3.5. | | | | | + +#### 6.4.7.2 partial-flag + +The partial-flag is of type boolean. + +If the value of the flag is true, then it indicates the PCEF/TDF supporting update the existing PFDs, or keep the existing PFDs if no changes of PFDs for the application identifier(s) in PFDF. + +### 6.4.8 JSON partial pull request fields + +#### 6.4.8.1 General + +In addition to subclause 6.4.3, Table 6.4.8.1.1 describes the extra JSON fields used within the body of the HTTP request messages in partial pull mode. The table includes the information about the name of the field and the type of the fields. + +Table 6.4.8.1.1: Gw/Gwn PartialPull JSON fields + +| Field Name | Clause defined | JSON Value Type (NOTE 1) | JCR Type (NOTE 2) | Applicability (NOTE 3) | +|------------------------------------------------------------------------------------------------|----------------|--------------------------|-------------------|------------------------| +| timestamp | 6.4.8.2 | string | string | PartialPull | +| NOTE 1: The basic JSON value types are defined in IETF RFC 7159 [11]. | | | | | +| NOTE 2: The JCR types are defined in IETF draft-newton-json-content-rules [12]. | | | | | +| NOTE 3: Fields marked with a supported feature are applicable as described in subclause 6.3.5. | | | | | +| NOTE 4: String with the format as defined in RFC 3339 [22]. | | | | | + +#### 6.4.8.2 timestamp + +The timestamp is of type string formatted as defined in RFC 3339 [22], and contains the UTC time set for the PFD(s) of the application identifier provisioning by the PFDF. + +## 6.5 The discovery of PCEF/TDF and PFDF + +### 6.5.1 PCEF/TDF discovery + +For “Push mode”, the PFDF requires a method to discover the PCEF(s)/TDF(s). + +A list of PCEF/TDF URIs may be pre-configured on the PFDF. + +The PFDF may select the PCEF/TDF by this configuration. + +NOTE: Other methods to discover the PCEF(s)/TDF(s) are implementation specific. + +### 6.5.2 PFDF discovery + +For “Pull mode”, the PCEF/TDF requires a method to discover the PFDF. + +The PFDF URI may be pre-configured on the PCEF/TDF. + +The PCEF/TDF may select the PFDF by this configuration. + +NOTE 1: Other methods to discover the PFDF are implementation specific. + +NOTE 2: If multiple PFDFs are deployed within one PLMN, coordination between the PFDFs is needed to avoid duplicated provisioning, e.g. to avoid that the PCEF/TDFs served by different PFDFs are overlapping + +# --- 7 Secure communication + +Either the NDS/IP network layer security defined in 3GPP TS 33.210 [8] or HTTP over TLS as defined in IETF RFC 2818 [9] should be used to secure communication over the REST based Gw and Gwn interfaces. + +# --- Annex A (normative): JSON Schema + +## A.1 PFDs schema + +This subclause defines the JSON schema for the body of HTTP responses providing the state of one or more PFDs resources in pull mode. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +``` +# jcr-version 0.7 +``` + +``` +# ruleset-id 3gpp.gwapplication.pfds +``` + +``` +; JCR representing the pfds root resource +``` + +``` +$pfds-root = @ {root} { + $application-identifier, + $caching-time ?, + $partial-flag ? $pfds ? +} +``` + +``` +; An array list of the PFDs for multiple application identifiers +``` + +``` +$pfds-array-root = @ {root} [ $pfds-root * ] +``` + +``` +; A flag indicates whether this is a partial update or not +``` + +``` +$partial-flag = "partial-flag" : boolean +``` + +``` +; The caching timer for the PFDs +``` + +``` +$caching-time = "caching-time" : uint64 +``` + +``` +; The PFDs associated with the same application identifier +``` + +``` +$pfds = "pfds" : [ $pfd * ] +``` + +``` +; The PFD content +``` + +``` +$pfd = { + $pfd-identifier, + ( $flow-descriptions | $urls | $domain-names | // : any) ?, + $dn-protocol ? +} +``` + +``` +; The PFD identifier +$pfd-identifier = "pfd-identifier" : string + +; The flow descriptions +$flow-descriptions = "flow-descriptions" : [ string + ] + +; The url matching expressions +$urls = "urls" : [ string + ] + +; The domain name match criteria +$domain-names = "domain-names" : [ string + ] + +; The domain name protocol +$dn-protocol =: ( + "DNS_QNAME" | + "TLS_SNI" | + "TLS_SAN" | + "TLS_SCN" +) +``` + +## --- A.2 Provisioning schema + +This subclause defines the JSON schema for the body of HTTP request providing the provisioned PFDs as well as the PFDs notifications in push mode. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +``` +# jcr-version 0.7 +# ruleset-id 3gpp.gwapplication.provisioning +# import 3gpp.gwapplication.pfds as pfds + +; JCR representing the PFDs provisioning data +$provisioning-root = @ {root} { + $pfds.application-identifier, + $notification-flag ?, + $removal-flag ?, +} +``` + +``` +$partial-flag ?, +$allowed-delay ?, +$pfd.pfd ? +} +``` + +; An array list of the PFDs provisioning/notification for multiple application identifiers + +``` +$provisioning-array-root = @ {root} [ $provisioning-root * ] +``` + +; A flag indicates whether this is a notification or a provisioning + +``` +$notification-flag = "notification-flag" : boolean +``` + +; A flag indicates whether this is a removal or not + +``` +$removal-flag = "removal-flag" : boolean +``` + +; A flag indicates whether this is a partial update or not + +``` +$partial-flag = "partial-flag" : boolean +``` + +; The allowed delay time for the PFDs deployment + +``` +$allowed-delay = "allowed-delay" : uint64 +``` + +## --- A.3 Error and Informational response schema + +This subclause defines the JSON schema for the body of HTTP responses in case of errors or success. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +``` +# jcr-version 0.7 +``` + +``` +# ruleset-id 3gpp.gwapplication.info +``` + +; A JCR for the error/successful response body + +; Errors information + +``` +$errors-root = @ {root} { $errors } +``` + +; Success information + +``` +$success-root = @ {root} { +``` + +``` + $success-message, +``` + +``` + $success-path ?, +``` + +``` + $success-info ? +``` + +``` +} + +; Resource fields definitions +; The list of errors returned in responses sent by the PCEF/TDF +$errors = "errors" : [ +{ + $error-type, + $error-message, + $error-tag ?, + $error-path ?, + $error-info ? +} + +] + +; The error type for an error. It can be one of 'application', 'interface', 'server' and 'other'. +$error-type = "error-type" : ( "application" | "interface" | "server" | "other" ) + +; The error text message +$error-message = "error-message" : string + +; The error tag for a specific error +$error-tag = "error-tag" : string + +; A JSON pointer path to the error resource +$error-path = "error-path" : string + +; Any additional information for the error +$error-info = "error-info" : { + $pfd-reports ?, + // : any * +} + +; Report fields definitions +; The list of pfd reports sent to the PFDF +$pfd-reports = "pfd-reports" : [ +``` + +``` + + { $application-ids, + $pfd-failure-code + } + +] + +; The string format for the pfd failure code +$pfd-failure-code =: ( + "MALFUNCTION" | + "RESOURCES_LIMITATION" | + "OTHER_REASON" +) + +; The successful text message +$success-message = "success-message" : string + +; A JSON pointer path to the success resource +$success-path = "success-path" : string + +; Any additional information for the success. +$success-info = "success-info" : { // : any *} + +; application identifiers +$application-ids = "application-ids" : [ string + ] + +``` + +## --- A.4 Partial pull request schema + +This subclause defines the JSON schema for the body of HTTP request for PFD(s) for one or more application identifier(s) in partial pull mode. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +``` + +# jcr-version 0.7 + +# ruleset-id 3gpp.gwapplication.partialpullrequest + +# import 3gpp.gwapplication.pfds as pfds + +; JCR representing the partial pull request data +$partialpullrequest-root = @{root} { + $pfds.application-identifier, + +``` + +``` + + $timestamp ?, +} + +; An array list of the partial pull request data for multiple application identifiers +$partialpullrequest-array-root = @{root} [ $partialpullrequest-root * ] + +; The UTC time set for the PFD(s) of the application identifier provisioning by the PFDF. +$timestamp = "timestamp" : string + +``` + +## A.5 Partial pull response schema + +This subclause defines the JSON schema for the body of HTTP response providing the provisioned PFDs in partial pull mode. The schema is based on IETF draft-newton-json-content-rules [12] and is defined below: + +``` + +# jcr-version 0.7 + +# ruleset-id 3gpp.gwapplication.partialpullresponse + +# import 3gpp.gwapplication.pfds as pfds + +# import 3gpp.gwapplication.provisioning as provisioning + +# import 3gpp.gwapplication.partialpullrequest as request + + +; JCR representing the partial pull response data +$partialpullresponse-root = @{root} { + $pfds.application-identifier, + $provisioning.partial-flag ?, + $request.timestamp ?, + $pfds.pfds ? +} + +; An array list of the partial pull response data for multiple application identifiers +$partialpullresponse-array-root = @{root} [ $partialpullresponse-root * ] + +``` + +# Annex B (informative): Call Flows + +## B.1 General + +This annex describes the procedures for the interactions between the PFDF and the PCEF/TDF. + +## B.2 Request for PFDs by Full Pull (“Pull mode”) + +This subclause describes the signalling flow for the request for PFDs by full pull. + +![Sequence diagram showing the request for PFDs by full pull. The PCEF/TDF sends an HTTP GET request to the PFDF, and the PFDF responds with an HTTP 200 OK.](d8698aacaeead6dfed9a1e448670a2e4_img.jpg) + +``` +sequenceDiagram + participant PCEF/TDF + participant PFDF + Note right of PCEF/TDF: 1. HTTP GET + PCEF/TDF->>PFDF: 1. HTTP GET + Note left of PFDF: 2. HTTP 200 OK + PFDF-->>PCEF/TDF: 2. HTTP 200 OK +``` + +Sequence diagram showing the request for PFDs by full pull. The PCEF/TDF sends an HTTP GET request to the PFDF, and the PFDF responds with an HTTP 200 OK. + +**Figure B.2.1: Request for PFDs by full pull** + +1. The PCEF/TDF sends the HTTP GET to the PFDF to request the PFDs including the parameters defined in subclause 6.3.3.2, 6.3.3.3 or 6.3.3.4. +2. The PFDF sends the HTTP 200 OK response to the PCEF/TDF including the parameters defined in subclause 6.3.3.2, 6.3.3.3 or 6.3.3.4. + +## B.3 Provisioning of PFDs (“Push mode”) + +This subclause describes the signalling flow for the provisioning of PFDs. + +![Sequence diagram for provisioning of PFDs](9f6dec4d4e9fde40bce018861ef1278e_img.jpg) + +``` +sequenceDiagram + participant PCEF/TDF + participant PFDF + Note left of PCEF/TDF: + PFDF->>PCEF/TDF: 1. HTTP POST + PCEF/TDF-->>PFDF: 2. HTTP 200 OK +``` + +A sequence diagram showing the interaction between PCEF/TDF and PFDF. The PFDF sends an HTTP POST message to the PCEF/TDF, and the PCEF/TDF responds with an HTTP 200 OK message. + +Sequence diagram for provisioning of PFDs + +**Figure B.3.1: Provisioning of the PFDs** + +1. The PFDF sends the HTTP POST to the PCEF/TDF to provision the PFDs of one or more application identifiers including the parameters defined in subclause 6.3.3.5. +2. The PCEF/TDF sends the HTTP 200 OK response to the PFDF including the parameters defined in subclause 6.3.3.5. + +## B.4 Provisioning of PFDs by Push with Notifications + +This subclause describes the signalling flow for the provisioning of PFDs by push with notifications. + +![Sequence diagram for provisioning of PFDs by push with notification](f1091147d93cee4dfa88498610e395a7_img.jpg) + +``` +sequenceDiagram + participant PCEF/TDF + participant PFDF + Note left of PCEF/TDF: + PFDF->>PCEF/TDF: 1. HTTP POST + PCEF/TDF-->>PFDF: 2. HTTP 200 OK + Note right of PCEF/TDF: + PCEF/TDF->>PFDF: 3. Request for the PFDs +``` + +A sequence diagram showing the interaction between PCEF/TDF and PFDF. The PFDF sends an HTTP POST message to the PCEF/TDF, and the PCEF/TDF responds with an HTTP 200 OK message. After a dashed line indicating a delay, the PCEF/TDF sends a 'Request for the PFDs' message to the PFDF. + +Sequence diagram for provisioning of PFDs by push with notification + +**Figure B.4.1: Provisioning of the PFDs by push with notification** + +1. The PFDF sends the HTTP POST to the PCEF/TDF to provision the notification of creation/update for one or more application identifiers including the parameters defined in subclause 6.3.3.5. +2. The PCEF/TDF sends the HTTP 200 OK response to the PFDF including the parameters defined in subclause 6.3.3.5. +3. Within the allowed-delay provided in the step1, the PCEF/TDF initiates the procedure defined in Annex B.2 to request the PFDs for the application identifiers. + +NOTE: The step 3 can be executed multiple times if the PCEF/TDF initiates separate pull requests to retrieve the PFDs for different application identifier(s). + +## B.5 Request for PFDs by Partial Pull (“Pull mode”) + +This subclause describes the signalling flow for the request for PFDs by partial pull. + +![Sequence diagram showing the request for PFDs by partial pull. The PCEF/TDF sends an HTTP POST to the PFDF, and the PFDF responds with an HTTP 200 OK.](107da2e3495b2f24352c9e3b26ec4841_img.jpg) + +``` +sequenceDiagram + participant PCEF/TDF + participant PFDF + Note left of PCEF/TDF: Request for PFDs by partial pull + PCEF/TDF->>PFDF: 1. HTTP POST + PFDF-->>PCEF/TDF: 2. HTTP 200 OK +``` + +Sequence diagram showing the request for PFDs by partial pull. The PCEF/TDF sends an HTTP POST to the PFDF, and the PFDF responds with an HTTP 200 OK. + +**Figure B.5.1: Request for PFDs by partial pull** + +1. The PCEF/TDF sends the HTTP POST to the PFDF to request the PFDs including the parameters defined in subclause 6.3.3.6. +2. The PFDF sends the HTTP 200 OK response to the PCEF/TDF including the parameters defined in subclause 6.3.3.6. + +# Annex C (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|--------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2016-10 | | | | | | TS skeleton of Gw and Gwn reference points stage 3. | 0.0.0 | +| 2016-10 | | | | | | Inclusion of C3-163212, C3-163213, C3-163304, C3-163323, C3-163326, C3-163327 and editorial change from Rapporteur. | 0.1.0 | +| 2016-11 | | | | | | Inclusion of C3-164174, C3-164177, C3-164231 and editorial change from Rapporteur. | 0.2.0 | +| 2017-01 | | | | | | Inclusion of C3-170055, C3-170060, C3-170061, C3-170063, C3-170065 and editorial change from Rapporteur. | 0.3.0 | +| 2017-02 | | | | | | Inclusion of C3-171274, C3-171304, C3-171307, C3-171308, C3-171319, and editorial change from Rapporteur. | 0.4.0 | +| 2017-03 | CT#75 | CP-170101 | | | | TS sent for Information to Plenary | 1.0.0 | +| 2017-04 | | | | | | Inclusion of C3-172137, C3-172195, C3-172197, C3-172237, C3-172238, C3-172246, and editorial change from Rapporteur. | 1.1.0 | +| 2017-05 | | | | | | Inclusion of C3-173120, C3-173154, C3-173196, C3-173198, C3-173201, C3-173288, C3-173289, C3-173290, C3-173295, C3-173297, C3-173320, C3-173322, C3-173331, and editorial change from Rapporteur. | 1.2.0 | +| 2017-06 | CT#76 | CP-171144 | | | | TS sent for approval to plenary. | 2.0.0 | +| 2017-06 | CT#76 | CP-171144 | | | | TS approved at plenary. | 14.0.0 | +| 2017-09 | CT#77 | CP-172047 | 0001 | 2 | F | Clarification of partial update. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0002 | 3 | F | Clarification of combination mode. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0005 | 2 | F | Clarification of PCEF's behaviour in the pull mode. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0006 | 1 | F | Update the reference of HTTP 1.1. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0007 | 1 | F | Caching time correction. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0011 | 1 | F | PFD error report correction. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0012 | 1 | F | Correction for PFD provisioning notification. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0014 | 1 | F | Reference and URI design correction. | 14.1.0 | +| 2017-09 | CT#77 | CP-172047 | 0015 | 1 | F | Correction to PFD removal. | 14.1.0 | +| 2017-12 | CT#78 | CP-173100 | 0016 | - | F | Correction to PFD removal. | 14.2.0 | +| 2017-12 | CT#78 | CP-173100 | 0017 | - | F | Precedence for 3GPP custom headers. | 14.2.0 | +| 2018-06 | SA#80 | - | - | - | - | Update to Rel-15 version (MCC) | 15.0.0 | +| 2018-12 | CT#82 | CP-183120 | 0019 | 1 | A | Correction to PFD retrieval by pull mode | 15.1.0 | +| 2019-03 | CT#83 | CP-190133 | 0020 | 3 | B | PFD extension | 16.0.0 | +| 2019-06 | CT#84 | CP-191097 | 0023 | - | A | Reference update: draft-newton-json-content-rules | 16.1.0 | +| 2019-06 | CT#84 | CP-191097 | 0026 | - | A | Encoding of custom header fields | 16.1.0 | +| 2019-09 | CT#85 | CP-192168 | 0029 | - | A | Correct presence condition in PFD definition | 16.2.0 | +| 2020-12 | CT#90e | CP-203135 | 0030 | 1 | B | Optimized Pull mode | 17.0.0 | +| 2021-03 | CT#91e | CP-210215 | 0031 | 1 | B | Partial pull update | 17.1.0 | +| 2021-03 | CT#91e | CP-210215 | 0032 | - | B | Procedure of partial pull update | 17.1.0 | +| 2021-03 | CT#91e | CP-210215 | 0033 | 2 | F | Corrections on partial pull | 17.1.0 | +| 2021-06 | CT#92e | CP-211231 | 0034 | 1 | F | Response of partial pull | 17.2.0 | +| 2024-03 | SA#103 | - | - | - | - | Update to Rel-18 version (MCC) | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29256/raw.md b/marked/Rel-18/29_series/29256/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..a8a7dc77695f71244219c346a5cb11f9af1f2be2 --- /dev/null +++ b/marked/Rel-18/29_series/29256/raw.md @@ -0,0 +1,1155 @@ + + +# 3GPP TS 29.256 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Uncrewed Aerial Systems Network Function (UAS-NF); Aerial Management 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 small capital 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 small capital letters. + +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 of terms, symbols and abbreviations..... | 8 | +| 3.1 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 4.1 Introduction ..... | 8 | +| 5 Services offered by the NEF (UAS-NF)..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Nnef_Authentication Service ..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 AuthenticateAuthorize Service Operation ..... | 10 | +| 5.2.2.2.1 General ..... | 10 | +| 5.2.2.3 AuthNotify Service Operation ..... | 11 | +| 5.2.2.3.1 General ..... | 11 | +| 6 API Definitions ..... | 12 | +| 6.1 Nnef_Authentication Service API..... | 12 | +| 6.1.1 Introduction ..... | 12 | +| 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..... | 13 | +| 6.1.3.1 Overview..... | 13 | +| 6.1.3.2 Resource: uav-authentications ..... | 14 | +| 6.1.3.2.1 Description ..... | 14 | +| 6.1.3.2.2 Resource Definition..... | 14 | +| 6.1.3.2.3 Resource Standard Methods..... | 14 | +| 6.1.3.2.4 Resource Custom Operations..... | 15 | +| 6.1.5 Notifications ..... | 15 | +| 6.1.5.1 General..... | 15 | +| 6.1.5.2 Authentication Notification ..... | 16 | +| 6.1.5.2.1 Description ..... | 16 | +| 6.1.5.2.2 Target URI..... | 16 | +| 6.1.5.2.3 Standard Methods..... | 16 | +| 6.1.6 Data Model ..... | 17 | +| 6.1.6.1 General..... | 17 | +| 6.1.6.2 Structured data types..... | 17 | +| 6.1.6.2.1 Introduction ..... | 17 | +| 6.1.6.2.2 Type: UAVAuthInfo ..... | 18 | +| 6.1.6.2.3 Type: AuthNotification ..... | 19 | +| 6.1.6.2.4 Type: UAVAuthResponse..... | 20 | +| 6.1.6.2.5 Type: UAVAuthFailure..... | 21 | +| 6.1.6.2.6 Type: AuthContainer..... | 21 | +| 6.1.6.3 Simple data types and enumerations..... | 21 | +| 6.1.6.3.1 Introduction ..... | 21 | +| 6.1.6.3.2 Simple data types ..... | 22 | + +- 6.1.6.3.3 Enumeration: AuthResult..... 22 +- 6.1.6.3.4 Enumeration: NotifType ..... 22 +- 6.1.7 Error Handling..... 22 + - 6.1.7.1 General..... 22 + - 6.1.7.2 Protocol Errors ..... 22 + - 6.1.7.3 Application Errors..... 22 +- 6.1.8 Feature negotiation ..... 23 +- 6.1.9 Security ..... 23 +- 6.1.10 HTTP redirection..... 23 + +A.1 General..... 23 +A.2 Nnef\_Authentication API ..... 24 + +# --- 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-NF functionality of the Nnef Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the NEF (UAS-NF). + +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]. + +The Uncrewed Aerial System Network Function (UAS-NF) provides the UAS-specific NEF services to NF service consumers (e.g. AMF, SMF). The UAS-NF is functionality within the NEF. + +# --- 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.256: "Support of Uncrewed Aerial Systems (UAS) connectivity, identification and tracking; Stage 2". +- [7] 3GPP TR 21.900: "Technical Specification Group working methods". +- [8] IETF RFC 9113: "HTTP/2". +- [9] OpenAPI Initiative, "OpenAPI 3.0.0 Specification", . +- [10] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [11] IETF RFC 9457: "Problem Details for HTTP APIs". +- [12] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [13] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [14] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [16] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". + +# --- 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]. + +For the purposes of the present document, the terms and definitions given in 3GPP TS 23.256 [6] 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 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]. + +| | | +|-------|-------------------------------------------| +| AA | Authorization/Authentication | +| BRID | Broadcast Remote Identification | +| BVLOS | Beyond Visual Line of Sight | +| C2 | Command and Control | +| NRID | Networked Remote Identification | +| PEI | Permanent Equipment Identifier | +| RID | Remote Identification | +| TPAE | Third Party Authorized Entity | +| UAS | Uncrewed Aerial System | +| UAV | Uncrewed Aerial Vehicle | +| USS | UAS Service Supplier | +| UTM | Uncrewed Aerial System Traffic Management | +| UUAA | USS UAV AA | +| UUID | Universal Unique Identifier | + +# --- 4 Overview + +## 4.1 Introduction + +Within the 5GC, the NEF (UAS-NF) offers services to the AMF, SMF, and PCF via the Nnef service based interface, and the NEF (UAS-NF) offers services to the SMF+PGW-C via the Nnef service based interface for UUAA-SM and C2 procedure supported in EPS (see 3GPP TS 23.256 [6]). + +Figure 4.1-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the NEF (UAS-NF) and the scope of the present specification. + +![Figure 4.1-1: Reference model – NEF (UAS-NF). The diagram shows four network functions (AMF, SMF, PCF, and AF) on the left connected to a central NEF (UAS-NF) on the right. The connections are labeled N51 (AMF to NEF), N29 (SMF to NEF), N30 (PCF to NEF), and N33 (AF to NEF). The NEF (UAS-NF) is represented by a large green rectangle containing a smaller green rectangle labeled UAS-NF. The label 'Nnef' is placed between the central connection point and the NEF (UAS-NF) block.](e6df2733626a85205c1db682e6259c46_img.jpg) + +Figure 4.1-1: Reference model – NEF (UAS-NF). The diagram shows four network functions (AMF, SMF, PCF, and AF) on the left connected to a central NEF (UAS-NF) on the right. The connections are labeled N51 (AMF to NEF), N29 (SMF to NEF), N30 (PCF to NEF), and N33 (AF to NEF). The NEF (UAS-NF) is represented by a large green rectangle containing a smaller green rectangle labeled UAS-NF. The label 'Nnef' is placed between the central connection point and the NEF (UAS-NF) block. + +Figure 4.1-1: Reference model – NEF (UAS-NF) + +The functionalities supported by the NEF (UAS-NF) are listed in clause 4.3.2 of 3GPP TS 23.256 [6]. + +# 5 Services offered by the NEF (UAS-NF) + +## 5.1 Introduction + +The table 5.1-1 shows the NEF (UAS-NF) Services and Service Operations: + +Table 5.1-1 List of NEF (UAS-NF) Services + +| Service Name | Service Operations | Operation Semantics | Example Consumer(s) | Mapped Service Operation | +|---------------------|-----------------------|---------------------|---------------------|-------------------------------------------| +| Nnef_Authentication | AuthenticateAuthorize | Request/Response | AMF, SMF, SMF+PGW-C | Nnef_Authentication_AuthenticateAuthorize | +| | Notification | Subscribe/Notify | AMF, SMF, SMF+PGW-C | Nnef_Authentication_Notification | + +## 5.2 Nnef\_Authentication Service + +### 5.2.1 Service Description + +The service allows communication of authentication and authorization messages between AMF/SMF and external AF (USS). An NF as service consumer (e.g. AMF, SMF, SMF+PGW-C) can authenticate or subscribe to receive notifications from NEF (UAS-NF) related to reauthentication, update authorization data or revoke authorization of the UAV. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The Nnef\_Authentication service supports following service operations: + +- AuthenticateAuthorize +- Notification + +#### 5.2.2.2 AuthenticateAuthorize Service Operation + +##### 5.2.2.2.1 General + +The AuthenticateAuthorize service operation is used during the following procedure: + +- UUAA-MM and UUAA-SM procedures (see 3GPP TS 23.256 [6], clause 5.2.2 and clause 5.2.3, respectively) +- C2 authorization (see 3GPP TS 23.256 [6], clause 5.2.5 and clause 5.4) + +The AuthenticateAuthorize service operation is invoked by an NF Service Consumer (e.g. an AMF, SMF, SMF+PGW-C) towards the NEF (UAS-NF), when UUAA-MM is done at 5GS registration, UUAA-SM is done at PDU session establishment, or for Authorization for C2 in 5GS or EPS. + +The NF Service Consumer (e.g. the AMF or the SMF or the SMF+PGW-C) shall send the authentication message to NEF (UAS-NF) by sending the HTTP POST request towards the UAV Authentications resource as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram showing the AuthenticateAuthorize Service Operation. An NF Service Consumer sends a POST request to the NEF (UAS-NF). The NEF responds with either a 200 OK (UAVAuthResponse) or a 4xx/5xx (ProblemDetails) or 3xx status.](7c6d9bfe9c31ce872722d60b73d20df1_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NEF (UAS-NF) + Note left of NF Service Consumer: 1. POST .../uav-authentications (UAVAuthInfo) + NF Service Consumer->>NEF (UAS-NF): Request + Note right of NEF (UAS-NF): 2a. 200 OK (UAVAuthResponse) + NEF (UAS-NF)-->>NF Service Consumer: Response + Note right of NEF (UAS-NF): 2b. 4xx/5xx (ProblemDetails) or 3xx + NEF (UAS-NF)-->>NF Service Consumer: Error/Redirect + +``` + +Sequence diagram showing the AuthenticateAuthorize Service Operation. An NF Service Consumer sends a POST request to the NEF (UAS-NF). The NEF responds with either a 200 OK (UAVAuthResponse) or a 4xx/5xx (ProblemDetails) or 3xx status. + +**Figure 5.2.2.2.1-1: AuthenticateAuthorize Service Operation** + +- The NF Service Consumer shall send a POST request to the resource representing the UAV Authentications resource of the NEF (UAS-NF) with a "UAVAuthInfo" object in the request body, including: + - gsi IE set to GPSI (in the format of External Identifier) of the UAV; + - serviceLevelId IE set to Service Level Device Identity; + - authMsg IE contains the service-level AA message + - . This IE is deprecated; the "authContainer" IE should be used instead. + - "authContainer" IE that contains one or more authentication message(s) in the AA container provided by the UE (see 3GPP TS 23.256 [6]). This IE deprecates the "authMsg" IE. + - authNotificationURI IE provides the notification URI to receive notifications related to authentication; + - authServerAddress IE provides the Authorization Server Address, e.g. Authorization Server FQDN. This IE is not included for intermediate round-trip authentication messages; + - nfType IE carries the NF type of the NF service consumer (e.g. AMF or SMF or SMF+PGW-C); and + - userLocInfo IE provides the user location information (e.g. cell Id). + +If the NF Service Consumer is SMF or SMF+PGW-C, the "UAVAuthInfo" also may include: + +- ipAddr IE carries the IP Address associated with the PDU session; +- pei IE carries the PEI; + +If the NF Service Consumer is SMF or SMF+PGW-C, for UUAA-MM and UUAA-SM procedures the "UAVAuthInfo" also may include: + +- dnn IE carries the DNN which can be used by NEF (UAS-NF) later on to create a subscription at SMF; and +- sNssai IE carries the S-NSSAI which can be used by NEF (UAS-NF) later on to create a subscription at SMF. + +2a. On success, the NEF (UAS-NF) shall store the result and return "200 OK". + +For intermediate round-trip messages, the content (i.e. UAVAuthResponse) shall contain the GPSI of the UAV and Service Level Device Identity. The content optionally includes "authContainer", see 3GPP TS 23.256 [6] for further details. + +For the final NEF (UAS-NF) to NF service consumer message, the content (i.e. UAVAuthResponse) shall contain the GPSI of the UAV, notifyCorrId attribute and "authResult" attribute. If the UAV is authenticated successfully, the NEF (UAS-NF) shall set the "authResult" attribute to "AUTH\_SUCCESS". "authMsg" and "authResult" attributes are deprecated; the attribute "authContainer" should be used instead. The content shall contain the authorized Service Level Device Identity and "authContainer" content delivering the AA result, configuration information to the UAV. The AMF forwards the message transparently to UE over NAS MM. + +2b. On failure or redirection, one of the HTTP status codes listed in Table 6.1.7.3-1 shall be returned. For a 4xx/5xx response, the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.7.3-1. + +If the NEF (UAS-NF) cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the NEF (UAS-NF) shall send the HTTP error response as specified in clause 6.1.7. + +If the UAV authentication is failed, the NEF (UAS-NF) shall reject the request with an HTTP "403 Forbidden" response message including the "cause" attribute of the ProblemDetails data structure set to "AUTHENTICATION\_FAILURE". NEF (UAS-NF) shall also include an indication of uasResourceRelease received from the USS to indicate if the PDU sessions associated with the "DNN(s) subject to aerial services" can be released or not, during re-authentication failure, when the service operation is used during Re-authentication procedure. + +In above steps, while there is no expected response from the USS in the case of time out, the NEF(UAS-NF) shall return HTTP status code "504 Gateway Timeout", with the message body containing a ProblemDetails structure with the "cause" attribute set to "PEER\_NOT\_RESPONDING". + +#### 5.2.2.3 AuthNotify Service Operation + +##### 5.2.2.3.1 General + +The AuthNotify service operation is used during the following procedure: + +- USS Initiated reauthentication (see 3GPP TS 23.256 [6], clause 5.2.4) +- USS Initiated update authorization data or revoke authorization of the UAV + +The AuthNotify service operation is invoked by the NEF (UAS-NF) to inform a NF Service Consumer (e.g. AMF, SMF, SMF+PGW-C), when USS triggers reauthentication, update authorization data or revoke authorization of the UAV. NEF (UAS-NF) shall determine the NF service consumer based on the previously stored UUAA context during the successful UUAA procedure as defined in clause 5.2.2.2. + +The NEF (UAS-NF) shall send the AuthNotify request by sending the HTTP POST method towards the Notification URI as shown in Figure 5.2.2.3.1-1. + +![Sequence diagram for AuthNotify Service Operation. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'NEF(UAS-NF)' on the right. The sequence of messages is: 1. A solid arrow points from NEF(UAS-NF) to NF Service Consumer with the text '1. POST {notificationUri} (AuthNotification)'. 2a. A dashed arrow points from NF Service Consumer to NEF(UAS-NF) with the text '2a. 204 No content'. 2b. A dashed arrow points from NF Service Consumer to NEF(UAS-NF) with the text '2b. 4xx/5xx (ProblemDetails) or 3xx'.](e787e02d9214556476d95941bda1d350_img.jpg) + +``` + +sequenceDiagram + participant NEF as NEF(UAS-NF) + participant Consumer as NF Service Consumer + Note left of Consumer: + Note right of NEF: + NEF->>Consumer: 1. POST {notificationUri} (AuthNotification) + Consumer-->>NEF: 2a. 204 No content + Consumer-->>NEF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for AuthNotify Service Operation. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'NEF(UAS-NF)' on the right. The sequence of messages is: 1. A solid arrow points from NEF(UAS-NF) to NF Service Consumer with the text '1. POST {notificationUri} (AuthNotification)'. 2a. A dashed arrow points from NF Service Consumer to NEF(UAS-NF) with the text '2a. 204 No content'. 2b. A dashed arrow points from NF Service Consumer to NEF(UAS-NF) with the text '2b. 4xx/5xx (ProblemDetails) or 3xx'. + +Figure 5.2.2.3.1-1: AuthNotify Service Operation + +1. The NEF (UAS-NF) shall send a POST request towards the Notification URI received in the Authenticate service operation request (See clause 5.2.2.2.1). If the AMF for UUAA-MM has changed, the NEF (UAS-NF) + +should discover the Notification URI of the new AMF via NRF (in the default notification subscription with the "UUAA\_MM\_AUTH\_NOTIFICATION" notification type). The NEF (UAS-NF) shall be able to determine the NF type of the NF service consumer by nfType IE received in the Authenticate service operation request. The request body shall contain an "AuthNotification" object containing the reauthentication information or update authorization information or revoke authorization indication. + +When the procedure is used for reauthentication or reauthorization/update authorization information, the AuthNotification object includes: + +- the gpsi IE set to the GPSI (in the format of External Identifier) of the given UAV required to be reauthenticated; +- serviceLevelId IE set to the Service Level Device Identity of the UAV; +- authMsg IE contains the service-level AA message. This IE is deprecated; the "authContainer" IE should be used instead. +- "authContainer" IE that contains AA related data provided by the UE (see 3GPP TS 23.256 [6]). This IE deprecates the "authMsg" IE. +- notifyType IE set to REAUTH used for reauthentication and/or notifyType IE set to UPDATEAUTH used for update authorization data; and +- notifyCorrId IE set to the notification correlation ID; + +When the procedure is used for authorization revocation, the AuthNotification object includes: + +- the gpsi IE set to the GPSI (in the format of External Identifier) of the given UAV; +- serviceLevelId IE set to the Service Level Device Identity of the UAV; +- notifyType IE set to REVOKE; and +- notifyCorrId IE set to the notification correlation ID; + +2a. On success, "204 No content" shall be returned without response body. If the NF Service consumer remove the successful UUAA result during UUAA Revocation procedure, the NEF (UAS-NF) shall remove the UUAA context (see clause 5.2.7 of 3GPP TS 23.256 [6]). + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.5.2.3.1-3 shall be returned. For a 4xx/5xx response, the response body should contain a "ProblemDetails" object. + +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 6.1.7. + +# --- 6 API Definitions + +## 6.1 Nnef\_Authentication Service API + +### 6.1.1 Introduction + +The Nnef\_Authentication shall use the Nnef\_Authentication API. + +The API URI of the Nnef\_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 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 "nnef-authentication". +- 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 [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]. + +The OpenAPI [9] specification of HTTP messages and content bodies for the Nnef\_Authentication 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 [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 [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 [11]. + +#### 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 applicable. + +### 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 Nnef\_Authentication API. + +![Diagram showing the resource URI structure for the Nnef_Authentication API. The root path is {apiRoot}/nnef-authentication/. A line branches from this root to a box containing the resource URI part /uav-authentications.](c52116487ab4b76a2415714183c9a14a_img.jpg) + +``` +graph TD; Root["{apiRoot}/nnef-authentication/"] --> Box["/uav-authentications"]; +``` + +Diagram showing the resource URI structure for the Nnef\_Authentication API. The root path is {apiRoot}/nnef-authentication/. A line branches from this root to a box containing the resource URI part /uav-authentications. + +**Figure 6.1.3.1-1: Resource URI structure of the Nnef\_Authentication 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 | +|---------------------|----------------------|---------------------------------|----------------------| +| uav-authentications | /uav-authentications | POST | A UAV authentication | + +#### 6.1.3.2 Resource: uav-authentications + +The resource represents UAV Authentications to be done with the NEF (UAS-NF). + +##### 6.1.3.2.1 Description + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnef-authentication//uav-authentications + +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 performs UAV authentication. + +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 | +|-------------|---|-------------|-------------------------------------------------------| +| UAVAuthInfo | M | 1 | Represents the data to be used for UAV authentication | + +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 | +|------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UAVAuthResponse | M | 1 | 200 OK | Successful request of UAV authentication and authorization. If C2 authorization request is sent during UUAA-SM, the final response indicates that at least UUAA has succeeded. | +| RedirectResponse | O | 0..1 | 307
Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308
Permanent Redirect | Permanent redirection.
(NOTE 2) | +| UAVAuthFailure | O | 0..1 | 403
Forbidden | This represents that the UAV authentication is failed, the "cause" attribute of the ProblemDetails data structure set to one of the following application errors:
- AUTHENTICATION_FAILURE
- SERVICE_NOT_ALLOWED
See table 6.1.7.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:
- PEER_NOT_RESPONDING
See table 6.1.7.3-1 for the description of the error. | + +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 NEF (UAS-NF) or NEF (UAS-NF) (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 NEF (UAS-NF) or UAS-NF/NEF (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 + +None + +### 6.1.5 Notifications + +#### 6.1.5.1 General + +This clause specifies the notifications provided by the Nnef\_Authentication service. + +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]. + +#### 6.1.5.2 Authentication Notification + +##### 6.1.5.2.1 Description + +The NF Service Consumer (e.g. the AMF or SMF or SMF+PGW-C) provides the Notification URI for getting notified about reauthentication requested by the USS. The NEF (UAS-NF) shall notify the NF Service Consumer when reauthentication is requested by the USS. + +##### 6.1.5.2.2 Target URI + +The Notification URI "{notifUri}" 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 | +|-----------------|-----------------------------------------------| +| notificationUri | String formatted as URI with the Callback Uri | + +##### 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-2. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------| +| AuthNotification | M | 1 | Contains the reauthentication information. | + +**Table 6.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 | +| 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 POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply, with response body containing an object of 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.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 | 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 [4]. | +| 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.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 | 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 [4]. | +| 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.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 Nnef\_Authentication service based interface protocol. + +**Table 6.1.6.1-1: Nnef\_Authentication specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------|----------------|----------------------------------------------|---------------| +| UAVAuthInfo | 6.1.6.2.2 | Information within Authenticate Request | | +| AuthNotification | 6.1.6.2.3 | Information within notification | | +| UAVAuthResponse | 6.1.6.2.4 | Information within Authenticate Response | | +| UAVAuthFailure | 6.1.6.2.5 | Information within Authenticate Response | | +| AuthResult | 6.1.6.3.3 | Enumeration indicating authentication result | | +| NotifyType | 6.1.6.3.4 | Enumeration Notification type | | +| AuthContainer | 6.1.6.2.6 | Carries the AA related data | | + +Table 6.1.6.1-2 specifies data types re-used by the Nnef\_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 Nnef\_Authentication service based interface. + +**Table 6.1.6.1-2: Nnef\_Authentication re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|---------------------|--------------------------------------------------|---------------| +| IpAddr | 3GPP TS 29.571 [15] | IP address | | +| Pei | 3GPP TS 29.571 [15] | Permanent Equipment Identifier | | +| Uri | 3GPP TS 29.571 [15] | Uri | | +| Gpsi | 3GPP TS 29.571 [15] | GPSI | | +| ExtSnssai | 3GPP TS 29.571 [15] | Ext Snssai | | +| Dnn | 3GPP TS 29.571 [15] | DNN information | | +| UserLocation | 3GPP TS 29.571 [15] | User location | | +| RedirectResponse | 3GPP TS 29.571 [15] | Contains redirection related information | | +| NFType | 3GPP TS 29.510 [14] | NF Type | | +| ReftoBinaryData | 3GPP TS 29.571 [15] | authMsg data, AA message payload data | | +| Bytes | 3GPP TS 29.571 [15] | Binary data encoded as a base64 character string | | + +#### 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: UAVAuthInfo + +Table 6.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 | This IE may be present if the NF Service Consumer is the SMF or SMF+PGW-C.

When present, this IE indicates the IP address associated with the PDU session. | | +| authMsg | RefToBinaryData | O | 0..1 | Contains the service-level AA message. 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 | This IE may be present if the NF Service Consumer is the SMF or SMF+PGW-C.

When present, PEI associated with the UAV. | | +| authServerAddress | string | O | 0..1 | Provides the Authorization Server Address, e.g. Authorization Server FQDN. | | +| authNotificationURI | Uri | C | 0..1 | This IE shall be present in the initial authentication message.

It carries the notification URI to receive authentication related notifications | | +| dnn | Dnn | C | 0..1 | This IE shall be present if the NF Service Consumer is the SMF or SMF+PGW-C.

When present, this IE indicates DNN associated with the PDU session. | | +| sNssai | ExtSnsai | C | 0..1 | This IE shall be present if the NF Service Consumer is the SMF.

When present, this IE indicates the S-NSSAI associated with the PDU session. | | +| ueLocInfo | UserLocation | O | 0..1 | This IE shall contain the UE location information if it is available. | | +| nfType | NFType | M | 1 | NFType of the NF service consumer.
Possible NFType values supported in this release of the specification are
  • - AMF
  • - SMF
| | + +##### 6.1.6.2.3 Type: AuthNotification + +Table 6.1.6.2.3-1: Definition of type AuthNotification + +| 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 | RefToBinaryData | C | 0..1 | Contains the service-level AA message.
This IE may be present if the notifType is set to "UPDATEAUTH". This attribute is deprecated; the attribute "authContainer" should be used instead. | | +| authContainer | array(AuthContainer) | C | 1..N | Contains the AA related data, including optionally the "authResult" attribute. This IE shall be present if the notifType is set to "UPDATEAUTH". This attribute deprecates "authMsg" attribute. | | +| notifType | NotifType | M | 1 | This IE shall contain the notification type. | | +| notifyCorrId | string | M | 1 | This IE shall contain the Notification Correlation Id. | | + +##### 6.1.6.2.4 Type: UAVAuthResponse + +Table 6.1.6.2.4-1: Definition of type UAVAuthResponse + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | GPSI of the UAV | | +| authResult | AuthResult | C | 0..1 | This IE shall be present for the final NEF (UAS-NF) to NF service consumer message.

Conveys the UAV authentication result. This attribute is deprecated; the attribute "authContainer" should be used instead. | | +| authMsg | RefToBinaryData | O | 0..1 | Contains the service-level AA message. This attribute is deprecated; the attribute "authContainer" should be used instead. | | +| authContainer | array(AuthContainer) | C | 1..N | Contains the AA related data, including the "authResult" attribute in the final AA response. This attribute shall be present for the final AA response message. This attribute deprecates "authMsg" attribute. | | +| serviceLevelId | string | O | 0..1 | This IE contains the authorized Service Level Device Identity | | +| notifyCorrId | string | O | 0..1 | When present, this IE shall contain the Notification Correlation Id. | | + +##### 6.1.6.2.5 Type: UAVAuthFailure + +Table 6.1.6.2.5-1: Definition of type UAVAuthFailure + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| error | ProblemDetails | M | 1 | Represents the application error information. The application level error cause shall be encoded in the "cause" attribute. | | +| uasResourceRelease | boolean | C | 0..1 |

This IE shall be present and used to indicate if the PDU sessions associated with the "DNN(s) subject to aerial services" can be released or not, during re-authentication failure.

It shall be included if the "cause" attribute of the ProblemDetails data structure set to "AUTHENTICATION_FAILURE".

When present, it shall be set as follows:
- true: the PDU sessions associated with the "DNN(s) subject to aerial services" release is requested;
- false (default): the PDU sessions associated with the "DNN(s) subject to aerial services" release is not requested.

| | + +##### 6.1.6.2.6 Type: AuthContainer + +Table 6.1.6.2.6-1: Definition of type AuthContainer + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| authMsgType | Bytes | O | 0..1 | This IE, when present, carries the Service-level-AA payload type specified in clause 9.11.2.15 of 3GPP TS 24.501 [16]. | | +| 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. | | + +#### 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: AuthResult + +The enumeration AuthResult represents the result of authentication and/or authorization. It shall comply with the provisions defined in table 6.1.5.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration AuthResult** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------|---------------| +| "AUTH_SUCCESS" | The UAV authentication or C2 Authorization has succeeded. | | +| "AUTH_FAIL" | The UAV authentication or C2 Authorization has failed. | | + +##### 6.1.6.3.4 Enumeration: NotifType + +The enumeration NotifType represents the type of notification. It shall comply with the provisions defined in table 6.1.6.3.4-1. + +**Table 6.1.6.3.4-1: Enumeration NotifType** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------|---------------| +| "REAUTH" | The UAV needs to be reauthenticated. | | +| "UPDATEAUTH" | Authorization data needs to be updated to UAV. | | +| "REVOKE" | Revoke UAV authentication and authorization | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nnef\_Authentication 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 Nnef\_Authentication API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nnef\_Authentication service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nnef\_Authentication service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|------------------------|---------------------|------------------------------------------------------------------------| +| AUTHENTICATION_FAILURE | 403 Forbidden | The UAV authentication is failed | +| SERVICE_NOT_ALLOWED | 403 Forbidden | UAS services not allowed | +| PEER_NOT_RESPONDING | 504 Gateway Timeout | No response is received from the remote peer (i.e. USS) when time out. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nnef\_Authentication 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 [12] and 3GPP TS 29.500 [4], the access to the Nnef\_Authentication API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [13]), based on local configuration, 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 Nnef\_Authentication 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 Nnef\_Authentication service. + +The Nnef\_Authentication API defines a single scope "nnef-authentication" 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 Nnef\_Authentication service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different NEF (UAS-NF) producer instance will return the NF Instance ID of the new NEF (UAS-NF) 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 NEF (UAS-NF) redirects a service request to a different NEF (UAS-NF) using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new NEF (UAS-NF) 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 3.0.0 specifications in YAML format, following guidelines in 3GPP TS 29.501 [5]. + +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 Nnef\_Authentication API + +``` +openapi: 3.0.0 + +info: + title: Nnef_Authentication + version: '1.0.2' + description: | + NEF Auth Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.256 V17.3.0; 5G System;Uncrewed Aerial Systems Network Function (UAS-NF); + Aerial Management Services; Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.256/ + +servers: + - url: '{apiRoot}/nnef-authentication/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnef-authentication + +paths: + /uav-authentications: + post: + 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: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '403': + description: UAV authentication failure + content: + application/json: + schema: + $ref: '#/components/schemas/UAVAuthFailure' +``` + +``` +'504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + authNotification: + '{request.body#/authNotification }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AuthNotification' + responses: + '204': + description: Successful 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' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnef-authentication: Access to the Nnef_authentication API + +schemas: +# +# STRUCTURED DATA TYPES +# + UAVAuthInfo: + description: UAV auth data + type: object + required: + - gps + - serviceLevelId + - nfType + properties: + gps: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gps' + serviceLevelId: + type: string + authNotificationURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ipAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + authServerAddress: + type: string + authMsg: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + deprecated: true + authContainer: + type: array + items: + $ref: '#/components/schemas/AuthContainer' + minItems: 1 + ueLocInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sNssai: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' +nfType: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + +UAVAuthResponse: + description: UAV auth response data + type: object + required: + - gpsi + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + serviceLevelId: + type: string + authMsg: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + deprecated: true + authContainer: + type: array + items: + $ref: '#/components/schemas/AuthContainer' + minItems: 1 + authResult: + allOf: + - $ref: '#/components/schemas/AuthResult' + deprecated: true + notifyCorrId: + type: string + +AuthNotification: + description: UAV related notification + type: object + required: + - gpsi + - serviceLevelId + - notifyType + - notifyCorrId + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + serviceLevelId: + type: string + notifyCorrId: + type: string + authMsg: + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + deprecated: true + authContainer: + type: array + items: + $ref: '#/components/schemas/AuthContainer' + minItems: 1 + notifyType: + $ref: '#/components/schemas/NotifyType' + +UAVAuthFailure: + description: UAV auth failure + type: object + required: + - error + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + uasResourceRelease: + type: boolean + default: false + +AuthContainer: + description: Authentication/Authorization data + type: object + properties: + authMsgType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + authMsgPayload: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + authResult: +``` + +``` +$ref: '#/components/schemas/AuthResult' +``` + +``` +# +``` + +``` +# SIMPLE DATA TYPES +``` + +``` +# +``` + +``` +# +``` + +``` +# ENUMERATIONS +``` + +``` +# +``` + +``` +AuthResult: + description: Enumeration representing the result of authentication and/or authorization. + anyOf: + - type: string + enum: + - AUTH_SUCCESS + - AUTH_FAIL + - type: string +NotifyType: + description: Enumeration representing the type of notification. + anyOf: + - type: string + enum: + - REAUTH + - UPDATEAUTH + - REVOKE + - type: string +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|--------------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-04 | CT4#103-e | C4-212292 | | | | Initial TS skeleton. | 0.0.0 | +| 2021-04 | CT4#103-e | C4-212598 | | | | Added scope, introduction, references, and abbreviations. | 0.1.0 | +| 2021-05 | CT4#104-e | C4-213529 | | | | Aligned introduction terminology. Added, updated references. | 0.2.0 | +| 2021-08 | CT4#105-e | C4-214758 | | | | Aligned interfaces, added Nnef_Auth service. | 0.3.0 | +| 2021-10 | CT4#106-e | C4-215522 | | | | Several alignments with stage-2, clean-up, added OpenAPI for Nnef_Auth. | 0.4.0 | +| 2021-11 | CT4#107-e | C4-216474 | | | | Several further alignments with stage-2: aligned API and operation names, terminology. Further clean-up done. | 0.5.0 | +| 2021-12 | CT#94 | CP-213160 | | | | V1.0.0 presented for information | 1.0.0 | +| 2022-01 | CT4#107bis-e | C4-220456 | | | | Several consistency issues addressed. Implemented pCRs C4-220121, C4-220122, C4-220285, C4-220291, C4-220292, C4-220293, and C4-220387 | 1.1.0 | +| 2022-02 | CT4#108-e | C4-221594 | | | | Further consistency issues addressed. Implemented pCRs C4-221324, C4-221494, C4-221519, and C4-221340. | 1.2.0 | +| 2022-03 | CT#95e | CP-220109 | | | | TS presented for approval | 2.0.0 | +| 2022-03 | CT#95e | | | | | TS approved | 17.0.0 | +| 2022-06 | CT#96e | CP-221044 | 0001 | 1 | | Add Notification Correlation id | 17.1.0 | +| 2022-06 | CT#96e | CP-221044 | 0002 | 1 | | Indication of UAS service release | 17.1.0 | +| 2022-06 | CT#96e | CP-221044 | 0004 | | | Removal of revoke cause | 17.1.0 | +| 2022-06 | CT#96e | CP-221028 | 0005 | | | Remove the apiVersion placeholder from the resource URI variables table | 17.1.0 | +| 2022-06 | CT#96e | CP-221282 | 0007 | 1 | | 29.256 Rel-17 API version and External doc update | 17.1.0 | +| 2022-09 | CT#97e | CP-222036 | 0009 | | | Fix for formatting of OpenAPI description field | 17.2.0 | +| 2022-09 | CT#97e | CP-222058 | 0010 | | | 29.256 Rel-17 API version and External doc update | 17.2.0 | +| 2022-12 | CT#98e | CP-223056 | 0008 | 2 | | Corrections for Auth message type | 17.3.0 | +| 2022-12 | CT#98e | CP-223066 | 0011 | | | 29.256 Rel-17 API version and External doc update | 17.3.0 | +| 2023-03 | CT#99 | CP-230082 | 0012 | 1 | | Rejecting PDN connection for C2 communication when UAS service is not allowed | 17.4.0 | +| 2023-03 | CT#99 | CP-230068 | 0014 | | | Miscellaneous corrections | 18.0.0 | +| 2023-06 | CT#100 | CP-231027 | 0013 | 5 | F | Location header and missing Redirection clause | 18.1.0 | +| 2023-09 | CT#101 | CP-232047 | 0018 | 1 | A | Authorization Notification Callbackfor UUAA-MM after AMF Change | 18.2.0 | +| 2023-09 | CT#101 | CP-232046 | 0017 | - | B | Clarification on Direct C2 authorization procedure | 18.2.0 | +| 2023-12 | CT#102 | CP-233027 | 0020 | - | F | HTTP RFCs obsoleted by IETF RFC 9113 | 18.3.0 | +| 2023-12 | CT#102 | CP-233030 | 0021 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.3.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29257/raw.md b/marked/Rel-18/29_series/29257/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..373d90211162075940771e4b18212a9f513b9d4f --- /dev/null +++ b/marked/Rel-18/29_series/29257/raw.md @@ -0,0 +1,6150 @@ + + +# 3GPP TS 29.257 V18.2.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Application layer support for Uncrewed Aerial System (UAS); UAS Application Enabler (UAE) 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 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. Below the 'P' is a red signal wave icon, and below the entire logo is the text 'A GLOBAL INITIATIVE'. + +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..... | 11 | +| 2 References..... | 11 | +| 3 Definitions, symbols and abbreviations ..... | 11 | +| 3.1 Definitions..... | 11 | +| 3.2 Symbols..... | 12 | +| 3.3 Abbreviations ..... | 12 | +| 4 Overview..... | 13 | +| 5 Services offered by the UAE Server ..... | 14 | +| 5.1 Introduction ..... | 14 | +| 5.2 UAE_C2OperationModeManagement Service..... | 14 | +| 5.2.1 Service Description ..... | 14 | +| 5.2.2 Service Operations..... | 14 | +| 5.2.2.1 Introduction..... | 14 | +| 5.2.2.2 UAE_C2OperationModeManagement_Initiate ..... | 15 | +| 5.2.2.2.1 General ..... | 15 | +| 5.2.2.2.2 C2 Operation Mode Initiation ..... | 15 | +| 5.2.2.3 UAE_C2OperationModeManagement_Notify ..... | 16 | +| 5.2.2.3.1 General ..... | 16 | +| 5.2.2.3.2 C2 Operation Mode Management Completion Notification..... | 16 | +| 5.2.2.3.3 Selected C2 Communication Mode Notification ..... | 17 | +| 5.2.2.3.4 C2 Communication Mode Switching Notification..... | 18 | +| 5.3 UAE_RealtimeUAVStatus Service..... | 20 | +| 5.3.1 Service Description ..... | 20 | +| 5.3.2 Service Operations..... | 20 | +| 5.3.2.1 Introduction..... | 20 | +| 5.3.2.2 UAE_RealtimeUAVStatus_Subscribe..... | 20 | +| 5.3.2.2.1 General ..... | 20 | +| 5.3.2.2.2 Subscribe to real-time UAV status information reporting ..... | 20 | +| 5.3.2.2.3 Update an existing real-time UAV status information reporting subscription ..... | 21 | +| 5.3.2.3 UAE_RealtimeUAVStatus_Unsubscribe ..... | 22 | +| 5.3.2.3.1 General ..... | 22 | +| 5.3.2.3.2 Unsubscribe from real-time UAV status information reporting ..... | 22 | +| 5.3.2.4 UAE_RealtimeUAVStatus_Notify ..... | 23 | +| 5.3.2.4.1 General ..... | 23 | +| 5.3.2.4.2 Real-time UAV Status Notification ..... | 23 | +| 5.4 UAE_ChangeUSSManagement Service ..... | 24 | +| 5.4.1 Service Description ..... | 24 | +| 5.4.2 Service Operations..... | 24 | +| 5.4.2.1 Introduction..... | 24 | +| 5.4.2.2 UAE_ChangeUSSManagement_ManageUSS..... | 24 | +| 5.4.2.2.1 General ..... | 24 | +| 5.4.2.2.2 USS Change Policy Creation ..... | 24 | +| 5.4.2.2.3 USS Change Policy Update..... | 25 | +| 5.4.2.2.3 USS Change Policy Deletion ..... | 26 | +| 5.4.2.3 UAE_ChangeUSSManagement_RequestUSSChange ..... | 26 | +| 5.4.2.3.1 General ..... | 26 | +| 5.4.2.3.2 USS Change Request ..... | 26 | +| 5.4.2.4 UAE_ChangeUSSManagement_Notify ..... | 27 | +| 5.4.2.4.1 General ..... | 27 | +| 5.4.2.4.2 USS Change Policy Configuration Status Notification..... | 27 | +| 5.4.2.4.3 USS Change Notification..... | 28 | +| 5.4.2.4.4 USS Change Trigger Notification..... | 29 | +| 5.5 UAE_DAASupport Service ..... | 30 | + +| | | | +|-------------|--------------------------------------------------------------|----| +| 5.5.1 | Service Description ..... | 30 | +| 5.5.2 | Service Operations..... | 30 | +| 5.5.2.1 | Introduction..... | 30 | +| 5.5.2.2 | UAE_DAASupport_Manage ..... | 30 | +| 5.5.2.2.1 | General ..... | 30 | +| 5.5.2.2.2 | DAA Policy Creation ..... | 30 | +| 5.5.2.2.3 | DAA Policy Update ..... | 31 | +| 5.5.2.2.3 | DAA Policy Deletion ..... | 32 | +| 5.5.2.3 | UAE_DAASupport_InformDAAEvent ..... | 32 | +| 5.5.2.3.1 | General ..... | 32 | +| 5.5.2.3.2 | DAA Events Information Request ..... | 32 | +| 5.5.2.4 | UAE_DAASupport_Notify ..... | 33 | +| 5.5.2.4.1 | General ..... | 33 | +| 5.5.2.4.2 | DAA Policy Configuration Completion Status Notification..... | 33 | +| 5.5.2.4.3 | DAA Event Notification..... | 34 | +| 6 | API Definitions ..... | 35 | +| 6.1 | UAE_C2OperationModeManagement Service API ..... | 35 | +| 6.1.1 | Introduction ..... | 35 | +| 6.1.2 | Usage of HTTP..... | 35 | +| 6.1.3 | Resources..... | 35 | +| 6.1.4 | Custom Operations without associated resources ..... | 35 | +| 6.1.4.1 | Overview..... | 35 | +| 6.1.4.2 | Operation: Initiate ..... | 36 | +| 6.1.4.2.1 | Description ..... | 36 | +| 6.1.4.2.2 | Operation Definition ..... | 36 | +| 6.1.5 | Notifications ..... | 37 | +| 6.1.5.1 | General..... | 37 | +| 6.1.5.2 | C2 Operation Mode Management Completion Notification ..... | 38 | +| 6.1.5.2.1 | Description ..... | 38 | +| 6.1.5.2.2 | Target URI..... | 38 | +| 6.1.5.2.3 | Standard Methods..... | 38 | +| 6.1.5.2.3.1 | POST ..... | 38 | +| 6.1.5.3 | Selected C2 Communication Mode Notification..... | 39 | +| 6.1.5.3.1 | Description ..... | 39 | +| 6.1.5.3.2 | Target URI..... | 39 | +| 6.1.5.3.3 | Standard Methods..... | 39 | +| 6.1.5.3.3.1 | POST ..... | 39 | +| 6.1.5.4 | C2 Communication Mode Switching Notification ..... | 40 | +| 6.1.5.4.1 | Description ..... | 40 | +| 6.1.5.4.2 | Target URI..... | 40 | +| 6.1.5.4.3 | Standard Methods..... | 41 | +| 6.1.5.4.3.1 | POST ..... | 41 | +| 6.1.6 | Data Model ..... | 42 | +| 6.1.6.1 | General..... | 42 | +| 6.1.6.2 | Structured data types..... | 43 | +| 6.1.6.2.1 | Introduction ..... | 43 | +| 6.1.6.2.2 | Type: ConfigureData..... | 44 | +| 6.1.6.2.3 | Type: SelectedC2CommModeNotif..... | 46 | +| 6.1.6.2.4 | Type: C2CommModeSwitchNotif..... | 46 | +| 6.1.6.2.5 | Type: C2Result..... | 47 | +| 6.1.6.2.6 | Type: UasId..... | 47 | +| 6.1.6.2.7 | Type: UavId..... | 47 | +| 6.1.6.2.8 | Type: C2ServiceArea..... | 48 | +| 6.1.6.2.9 | Type: C2OpModeMngtCompStatus ..... | 48 | +| 6.1.6.2.10 | Type: C2SwitchPolicies..... | 48 | +| 6.1.6.2.11 | Type: C2LinkQualityThrlds..... | 49 | +| 6.1.6.3 | Simple data types and enumerations..... | 49 | +| 6.1.6.3.1 | Introduction ..... | 49 | +| 6.1.6.3.2 | Simple data types ..... | 49 | +| 6.1.6.3.3 | Enumeration: C2CommMode ..... | 49 | +| 6.1.6.3.4 | Enumeration: C2CommModeSwitching ..... | 50 | + +| | | | +|-------------|----------------------------------------------------------------------------------|----| +| 6.1.6.3.5 | Enumeration: C2SwitchingCause ..... | 50 | +| 6.1.6.3.6 | Enumeration: C2OpModeStatus ..... | 51 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 51 | +| 6.1.6.5 | Binary data..... | 51 | +| 6.1.6.5.1 | Binary Data Types..... | 51 | +| 6.1.7 | Error Handling..... | 52 | +| 6.1.7.1 | General..... | 52 | +| 6.1.7.2 | Protocol Errors ..... | 52 | +| 6.1.7.3 | Application Errors..... | 52 | +| 6.1.8 | Feature negotiation ..... | 52 | +| 6.1.9 | Security..... | 52 | +| 6.2 | UAE_RealtimeUAVStatus Service API ..... | 53 | +| 6.2.1 | Introduction ..... | 53 | +| 6.2.2 | Usage of HTTP..... | 53 | +| 6.2.3 | Resources..... | 53 | +| 6.2.3.1 | Overview..... | 53 | +| 6.2.3.2 | Resource: Real-time UAV Status Subscriptions ..... | 54 | +| 6.2.3.2.1 | Description ..... | 54 | +| 6.2.3.2.2 | Resource Definition..... | 54 | +| 6.2.3.2.3 | Resource Standard Methods..... | 54 | +| 6.2.3.2.3.1 | GET ..... | 54 | +| 6.2.3.2.3.2 | POST ..... | 55 | +| 6.2.3.2.4 | Resource Custom Operations..... | 56 | +| 6.2.3.3 | Resource: Individual Real-time UAV Status Subscription..... | 56 | +| 6.2.3.3.1 | Description ..... | 56 | +| 6.2.3.3.2 | Resource Definition..... | 56 | +| 6.2.3.3.3 | Resource Standard Methods..... | 56 | +| 6.2.3.3.3.1 | GET ..... | 56 | +| 6.2.3.3.3.2 | PUT..... | 57 | +| 6.2.3.3.3.3 | DELETE ..... | 58 | +| 6.2.3.3.4 | Resource Custom Operations..... | 59 | +| 6.2.4 | Custom Operations without associated resources ..... | 59 | +| 6.2.5 | Notifications ..... | 59 | +| 6.2.5.1 | General..... | 59 | +| 6.2.5.2 | Real-time UAV Status Notification ..... | 60 | +| 6.2.5.2.1 | Description ..... | 60 | +| 6.2.5.2.2 | Target URI..... | 60 | +| 6.2.5.2.3 | Standard Methods..... | 60 | +| 6.2.5.2.3.1 | POST ..... | 60 | +| 6.2.6 | Data Model ..... | 61 | +| 6.2.6.1 | General..... | 61 | +| 6.2.6.2 | Structured data types..... | 61 | +| 6.2.6.2.1 | Introduction ..... | 61 | +| 6.2.6.2.2 | Type: RTUavStatusSubsc ..... | 62 | +| 6.2.6.2.3 | Type: RTUavStatusNotif..... | 62 | +| 6.2.6.2.4 | Type: RTUavStatus..... | 62 | +| 6.2.6.2.5 | Type: UavNetConnStatus..... | 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.4 | Data types describing alternative data types or combinations of data types ..... | 63 | +| 6.2.6.5 | Binary data..... | 63 | +| 6.2.6.5.1 | Binary Data Types..... | 63 | +| 6.2.7 | Error Handling..... | 63 | +| 6.2.7.1 | General..... | 63 | +| 6.2.7.2 | Protocol Errors ..... | 64 | +| 6.2.7.3 | Application Errors..... | 64 | +| 6.2.8 | Feature negotiation ..... | 64 | +| 6.2.9 | Security..... | 64 | +| 6.3 | UAE_ChangeUSSManagement Service API..... | 65 | +| 6.3.1 | Introduction ..... | 65 | +| 6.3.2 | Usage of HTTP..... | 65 | + +| | | | +|-------------|----------------------------------------------------------------------------------|----| +| 6.3.3 | Resources..... | 65 | +| 6.3.3.1 | Overview..... | 65 | +| 6.3.3.2 | Resource: USS Change Policies ..... | 66 | +| 6.3.3.2.1 | Description ..... | 66 | +| 6.3.3.2.2 | Resource Definition..... | 66 | +| 6.3.3.2.3 | Resource Standard Methods..... | 66 | +| 6.3.3.2.3.1 | GET ..... | 66 | +| 6.3.3.2.3.2 | POST ..... | 67 | +| 6.3.3.2.4 | Resource Custom Operations ..... | 68 | +| 6.3.3.3 | Resource: Individual USS Change Policy ..... | 68 | +| 6.3.3.3.1 | Description ..... | 68 | +| 6.3.3.3.2 | Resource Definition..... | 68 | +| 6.3.3.3.3 | Resource Standard Methods..... | 68 | +| 6.3.3.3.3.1 | GET ..... | 68 | +| 6.3.3.3.3.2 | PUT..... | 69 | +| 6.3.3.3.3.2 | PATCH..... | 70 | +| 6.3.3.3.3.4 | DELETE ..... | 71 | +| 6.3.3.3.4 | Resource Custom Operations ..... | 72 | +| 6.3.4 | Custom Operations without associated resources ..... | 72 | +| 6.3.4.1 | Overview..... | 72 | +| 6.3.4.2 | Operation: RequestUssChange ..... | 73 | +| 6.3.4.2.1 | Description ..... | 73 | +| 6.3.4.2.2 | Operation Definition ..... | 73 | +| 6.3.5 | Notifications ..... | 74 | +| 6.3.5.1 | General..... | 74 | +| 6.3.5.2 | USS Change Policy Configuration Status Notification ..... | 74 | +| 6.3.5.2.1 | Description ..... | 74 | +| 6.3.5.2.2 | Target URI..... | 74 | +| 6.3.5.2.3 | Standard Methods..... | 74 | +| 6.3.5.2.3.1 | POST ..... | 74 | +| 6.3.5.3 | USS Change Notification..... | 75 | +| 6.3.5.3.1 | Description ..... | 75 | +| 6.3.5.3.2 | Target URI..... | 75 | +| 6.3.5.3.3 | Standard Methods..... | 76 | +| 6.3.5.3.3.1 | POST ..... | 76 | +| 6.3.5.4 | USS Change Trigger Notification..... | 76 | +| 6.3.5.4.1 | Description ..... | 76 | +| 6.3.5.4.2 | Target URI..... | 76 | +| 6.3.5.4.3 | Standard Methods..... | 77 | +| 6.3.5.4.3.1 | POST ..... | 77 | +| 6.3.6 | Data Model ..... | 78 | +| 6.3.6.1 | General..... | 78 | +| 6.3.6.2 | Structured data types..... | 78 | +| 6.3.6.2.1 | Introduction ..... | 78 | +| 6.3.6.2.2 | Type: USSChangePolReq..... | 79 | +| 6.3.6.2.3 | Type: USSChangePolResp..... | 79 | +| 6.3.6.2.4 | Type: USSChangePolicy..... | 79 | +| 6.3.6.2.5 | Type: USSChangePolicyPatch..... | 80 | +| 6.3.6.2.6 | Type: MultiUssPol ..... | 80 | +| 6.3.6.2.7 | Type: UasServArea ..... | 80 | +| 6.3.6.2.8 | Type: UasRoute..... | 80 | +| 6.3.6.2.9 | Type: USSChangeReq..... | 81 | +| 6.3.6.2.10 | Type: USSChangePolConfigNotif..... | 81 | +| 6.3.6.2.11 | Type: USSChangeNotif..... | 81 | +| 6.3.6.2.12 | Type: USSChangeTriggerNotif..... | 81 | +| 6.3.6.3 | Simple data types and enumerations..... | 82 | +| 6.3.6.3.1 | Introduction ..... | 82 | +| 6.3.6.3.2 | Simple data types ..... | 82 | +| 6.3.6.4 | Data types describing alternative data types or combinations of data types ..... | 82 | +| 6.3.6.5 | Binary data..... | 82 | +| 6.3.6.5.1 | Binary Data Types..... | 82 | +| 6.3.7 | Error Handling..... | 82 | + +| | | | +|-------------|----------------------------------------------------------------------------------|-----| +| 6.3.7.1 | General ..... | 82 | +| 6.3.7.2 | Protocol Errors ..... | 82 | +| 6.3.7.3 | Application Errors ..... | 82 | +| 6.3.8 | Feature negotiation ..... | 83 | +| 6.3.9 | Security ..... | 83 | +| 6.4 | UAE_DAA Support Service API ..... | 84 | +| 6.4.1 | Introduction ..... | 84 | +| 6.4.2 | Usage of HTTP ..... | 84 | +| 6.4.3 | Resources ..... | 84 | +| 6.4.3.1 | Overview ..... | 84 | +| 6.4.3.2 | Resource: DAA Policies ..... | 85 | +| 6.4.3.2.1 | Description ..... | 85 | +| 6.4.3.2.2 | Resource Definition ..... | 85 | +| 6.4.3.2.3 | Resource Standard Methods ..... | 85 | +| 6.4.3.2.3.1 | GET ..... | 85 | +| 6.4.3.2.3.2 | POST ..... | 86 | +| 6.4.3.2.4 | Resource Custom Operations ..... | 87 | +| 6.4.3.3 | Resource: Individual DAA Policy ..... | 87 | +| 6.4.3.3.1 | Description ..... | 87 | +| 6.4.3.3.2 | Resource Definition ..... | 87 | +| 6.4.3.3.3 | Resource Standard Methods ..... | 87 | +| 6.4.3.3.3.1 | GET ..... | 87 | +| 6.4.3.3.3.2 | PUT ..... | 88 | +| 6.4.3.3.3.2 | PATCH ..... | 89 | +| 6.4.3.3.3.4 | DELETE ..... | 90 | +| 6.4.3.3.4 | Resource Custom Operations ..... | 91 | +| 6.4.4 | Custom Operations without associated resources ..... | 91 | +| 6.4.4.1 | Overview ..... | 91 | +| 6.4.4.2 | Operation: InformDAAEvents ..... | 92 | +| 6.4.4.2.1 | Description ..... | 92 | +| 6.4.4.2.2 | Operation Definition ..... | 92 | +| 6.4.5 | Notifications ..... | 93 | +| 6.4.5.1 | General ..... | 93 | +| 6.4.5.2 | DAA Policy Configuration Completion Status Notification ..... | 93 | +| 6.4.5.2.1 | Description ..... | 93 | +| 6.4.5.2.2 | Target URI ..... | 93 | +| 6.4.5.2.3 | Standard Methods ..... | 93 | +| 6.4.5.2.3.1 | POST ..... | 93 | +| 6.4.5.3 | DAA Event Notification ..... | 94 | +| 6.4.5.3.1 | Description ..... | 94 | +| 6.4.5.3.2 | Target URI ..... | 94 | +| 6.4.5.3.3 | Standard Methods ..... | 94 | +| 6.4.5.3.3.1 | POST ..... | 94 | +| 6.4.6 | Data Model ..... | 95 | +| 6.4.6.1 | General ..... | 95 | +| 6.4.6.2 | Structured data types ..... | 96 | +| 6.4.6.2.1 | Introduction ..... | 96 | +| 6.4.6.2.2 | Type: DAAPolReq ..... | 96 | +| 6.4.6.2.3 | Type: DAAPolResp ..... | 97 | +| 6.4.6.2.4 | Type: DAAPolicy ..... | 97 | +| 6.4.6.2.5 | Type: DAAPolicyPatch ..... | 97 | +| 6.4.6.2.6 | Type: DAAAppPolicy ..... | 97 | +| 6.4.6.2.7 | Type: InformDAAEventsReq ..... | 98 | +| 6.4.6.2.8 | Type: DAAPolConfigNotif ..... | 98 | +| 6.4.6.2.9 | Type: DAAEventsInfo ..... | 98 | +| 6.4.6.2.10 | Type: DAAEvent ..... | 99 | +| 6.4.6.3 | Simple data types and enumerations ..... | 99 | +| 6.4.6.3.1 | Introduction ..... | 99 | +| 6.4.6.3.2 | Simple data types ..... | 99 | +| 6.4.6.3.3 | Enumeration: DAAPolConfigStatus ..... | 99 | +| 6.4.6.4 | Data types describing alternative data types or combinations of data types ..... | 99 | +| 6.4.6.5 | Binary data ..... | 100 | + +| | | | +|-------------------------------|-----------------------------------------|------------| +| 6.4.6.5.1 | Binary Data Types..... | 100 | +| 6.4.7 | Error Handling..... | 100 | +| 6.4.7.1 | General..... | 100 | +| 6.4.7.2 | Protocol Errors ..... | 100 | +| 6.4.7.3 | Application Errors..... | 100 | +| 6.4.8 | Feature negotiation ..... | 100 | +| 6.4.9 | Security..... | 100 | +| 7 | Using Common API Framework ..... | 101 | +| 7.1 | General ..... | 101 | +| 7.2 | Security..... | 101 | +| Annex A (normative): | OpenAPI specification..... | 102 | +| A.1 | General..... | 102 | +| A.2 | UAE_C2OperationModeManagement API ..... | 103 | +| A.3 | UAE_RealtimeUAVStatus API ..... | 110 | +| A.4 | UAE_ChangeUSSManagement API..... | 115 | +| A.5 | UAE_DAASupport API..... | 121 | +| Annex B (informative): | Withdrawn API versions ..... | 129 | +| B.1 | General..... | 129 | +| B.2 | UAE_C2OperationModeManagement API ..... | 129 | +| B.3 | UAE_RealtimeUAVStatus API ..... | 129 | +| B.4 | UAE_ChangeUSSManagement API..... | 129 | +| B.5 | UAE_DAASupport API..... | 129 | +| Annex C (informative): | Change history..... | 130 | + +## 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 Application Enabler (UAE) Server services, for enabling the support of Uncrewed Aerial System (UAS) applications over 3GPP networks. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the UAE Server. + +The stage 2 application layer architecture for Uncrewed Aerial System (UAS), functional requirements, procedures and information flows necessary for enabling Uncrewed Aerial System (UAS) applications over 3GPP networks are specified in 3GPP TS 23.255 [6]. + +The common protocol and interface aspects for API definition are specified in clause 5.2 of 3GPP TS 29.122 [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.122: "T8 reference point for Northbound Application Programming Interfaces (APIs)". +- [3] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [4] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [5] 3GPP TR 21.900: "Technical Specification Group working methods". +- [6] 3GPP TS 23.255: "Application layer support for Uncrewed Aerial System (UAS); Functional architecture and information flows". +- [7] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [8] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". +- [9] 3GPP TS 23.222: "Common API Framework for 3GPP Northbound APIs; Stage 2". +- [10] 3GPP TS 29.222: "Common API Framework for 3GPP Northbound APIs; Stage 3". +- [11] 3GPP TS 33.122: "Security aspects of Common API Framework (CAPIF) for 3GPP northbound APIs". +- [12] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". + +## 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 purpose of the present document, the terms and definitions given in clause 3 of 3GPP TS 23.255 [6] also apply, including the ones referencing other specifications. + +### 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]. + +| | | +|-------|--------------------------------------| +| BVLOS | Beyond Visual Line Of Sight | +| C2 | Command and Control | +| CAA | Civil Aviation Authorities | +| DAA | Detect And Avoid | +| RSRP | Reference Signal Received Power | +| UAE | UAS Application Enabler | +| UAS | Uncrewed Aerial System | +| UASS | UAS Application Specific Server | +| UAV | Uncrewed Aerial Vehicle | +| UAV-C | Uncrewed Aerial Vehicle – Controller | +| USS | UAS Service Supplier | +| UTM | UAS Traffic Management | + +## 4 Overview + +The UAS Application Enabler (UAE) Server forms part of the UAS application enabler layer that aims to ensure the efficient use and deployment of UAS over 3GPP systems. The UAE Server supports for this purpose, among other functionalities defined in 3GPP TS 23.255 [6], the following functionalities: + +- UAS application layer support functions to a UASS (e.g. USS/UTM) over the Us reference point, i.e.: + - C2 operation mode configuration management for a UAS (i.e. pair of UAV and UAV-C); + - C2 communication modes switching control and management for a UAS (i.e. pair of UAV and UAV-C); + - Real-Time UAV Connection Status Monitoring and Location reporting; + - USS change management; and + - DAA management; + +and + +- interaction with other UAE Servers over the UAE-E reference point, in order to support distributed UAE Server deployments. + +Figure 4-1 shows the reference model of the UAS Application Layer, with a focus on the UAE Server: + +![Figure 4-1: UAS Application Layer functional model. This diagram illustrates the functional architecture of the UAS Application Layer. It is divided into three main vertical components: UAS UE (UAV-C or UAV), UAS application server, and 3GPP network system. The UAS UE contains a 'UAS application specific client' and a 'UAE client'. The UAS application server contains a 'UAS application specific server', a 'UAE server' (highlighted in blue), and 'SEAL servers'. The 3GPP network system is shown in the center. Interfaces include U1-APP between the UAS application specific client and server; Uc between the UAE client and server; U1-AE between the UAE client and the UAE server; SEAL-UU between SEAL clients and SEAL servers; and SEAL-S between the UAE server and SEAL servers. The UAE server also connects to the 3GPP network system via Nnef, T8, MB2-U, and xMB-U interfaces. The SEAL servers connect to the 3GPP network system via MB2-C/xMB-C, Nnef, Rx, and T8 interfaces. Horizontal dashed lines define the 'UAS application specific layer', 'UAE layer', and 'SEAL' layer. A 'UAE-E' reference point is indicated between the UAE server and the SEAL servers.](e9d825d87c5f85c8dba0664eace96ef4_img.jpg) + +Figure 4-1: UAS Application Layer functional model. This diagram illustrates the functional architecture of the UAS Application Layer. It is divided into three main vertical components: UAS UE (UAV-C or UAV), UAS application server, and 3GPP network system. The UAS UE contains a 'UAS application specific client' and a 'UAE client'. The UAS application server contains a 'UAS application specific server', a 'UAE server' (highlighted in blue), and 'SEAL servers'. The 3GPP network system is shown in the center. Interfaces include U1-APP between the UAS application specific client and server; Uc between the UAE client and server; U1-AE between the UAE client and the UAE server; SEAL-UU between SEAL clients and SEAL servers; and SEAL-S between the UAE server and SEAL servers. The UAE server also connects to the 3GPP network system via Nnef, T8, MB2-U, and xMB-U interfaces. The SEAL servers connect to the 3GPP network system via MB2-C/xMB-C, Nnef, Rx, and T8 interfaces. Horizontal dashed lines define the 'UAS application specific layer', 'UAE layer', and 'SEAL' layer. A 'UAE-E' reference point is indicated between the UAE server and the SEAL servers. + +Figure 4-1: UAS Application Layer functional model + +## 5 Services offered by the UAE Server + +### 5.1 Introduction + +The UAE Server provides the following services: + +- UAE\_C2OperationModeManagement +- UAE\_RealtimeUAVStatus +- UAE\_ChangeUSSManagement +- UAE\_DAASupport + +Table 5.1-1 summarizes the corresponding APIs defined in this specification. + +**Table 5.1-1: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | API Name | Annex | +|-------------------------------|--------|-------------------------------------------------|--------------------------------------------|--------------------|-------| +| UAE_C2OperationModeManagement | 5.2 | UAE Server C2 Operation Mode Management Service | TS29257_UAE_C2OperationModeManagement.yaml | uae-c2opmode-mngt | A.2 | +| UAE_RealtimeUAVStatus | 5.3 | UAE Server Real-time UAV Status Service | TS29257_UAE_RealtimeUAVStatus.yaml | uae-uav-status | A.3 | +| UAE_ChangeUSSManagement | 5.4 | UAE USS Change Management Service | TS29257_UAE_ChangeUSSManagement.yaml | uae-usschange-mngt | A.4 | +| UAE_DAASupport | 5.5 | UAE DAA Support | TS29257_UAE_DAASupport.yaml | uae-daa | A.5 | + +NOTE: When 3GPP TS 29.122 [2] is referenced for the common protocol and interface aspects for API definition in the clauses under clause 5, the UAE Server takes the role of the SCEF and the UASS takes the role of the SCS/AS. + +### 5.2 UAE\_C2OperationModeManagement Service + +#### 5.2.1 Service Description + +The UAE\_C2OperationModeManagement service exposed by the UAE Server enables a UASS (e.g. USS/UTM) to: + +- communicate C2 operation mode configuration information to the UAE Server for a UAS (i.e. pair of UAV and UAV-C); +- receive notifications from the UAE Server on the C2 operation mode management completion; +- receive notifications from the UAE Server on the C2 communication mode selected by a UAS (i.e. pair of UAV and UAV-C); and +- receive notifications from the UAE Server when C2 communication mode switching is carried out and decide whether to authorize it or not. + +## 5.2.2 Service Operations + +### 5.2.2.1 Introduction + +The service operations defined for the UAE\_C2OperationModeManagement service are shown in table 5.2.2.1-1. + +**Table 5.2.2.1-1: UAE\_C2OperationModeManagement Service Operations** + +| Service Operation Name | Description | Initiated by | +|----------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| UAE_C2OperationModeManagement_Initiate | This service operation enables a UASS to initiate the configuration of C2 operation modes for a UAS (i.e. pair of UAV and UAV-C) by communicating the associated C2 operation mode configuration information to the UAE Server. | e.g. UASS | +| UAE_C2OperationModeManagement_Notify | This service operation enables a UAE Server to notify a previously subscribed UASS either:
  • - on C2 operation mode management completion;
  • - on the C2 communication mode selected by a UAS (i.e. pair of UAV and UAV-C); or
  • - when C2 communication mode switching is carried out. The UASS may then confirm the targeted C2 communication mode switching or not.
| UAE Server | + +### 5.2.2.2 UAE\_C2OperationModeManagement\_Initiate + +#### 5.2.2.2.1 General + +This service operation is used by a UASS to request the provisioning of C2 operation mode configuration information for a UAS (i.e. pair of UAV and UAV-C) to the UAE Server. + +The following procedures are supported by the "UAE\_C2OperationModeManagement\_Initiate" service operation: + +- C2 Operation Mode Initiation procedure. + +#### 5.2.2.2.2 C2 Operation Mode Initiation + +Figure 5.2.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to request the provisioning of C2 operation mode configuration information for a UAS (i.e. pair of UAV and UAV-C) (see also clause 7.4 of 3GPP TS 23.255[6]). + +![Sequence diagram showing the C2 Operation Mode Initiation procedure between a UASS and a UAE Server. The UASS sends a POST request (ConfigureData) to the UAE Server. The UAE Server responds with a 200 OK (C2Result) or a 4xx/5xx error.](220869911a1ecfa1dd4aa6d750319aad_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE Server + Note left of UASS: UASS + Note right of UAE Server: UAE Server + UASS->>UAE Server: 1. POST .../initiate (ConfigureData) + UAE Server-->>UASS: 2a. 200 OK (C2Result) + Note right of UAE Server: 2b. 4xx/5xx + +``` + +Sequence diagram showing the C2 Operation Mode Initiation procedure between a UASS and a UAE Server. The UASS sends a POST request (ConfigureData) to the UAE Server. The UAE Server responds with a 200 OK (C2Result) or a 4xx/5xx error. + +**Figure 5.2.2.2.2-1: C2 Operation Mode Initiation procedure** + +- The UASS shall send for this purpose an HTTP POST request (custom operation: "Initiate") to the UAE Server, with the request URI set to "{apiRoot}/uae-c2opmode-mngt//initiate" and the request body including the ConfigureData data structure that shall contain: + - the identifier of the UASS that is sending the request, within the "uassId" attribute; + +- the identifier of the target UAS (i.e. pair of UAV and UAV-C) to which the C2 Operation Mode configuration information is destined, within the "uasId" attribute; +- the allowed C2 communication modes for the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute, within the "allowedC2CommModes" attribute; +- the C2 Operation Mode switching types to be supported by the UAE Server, within the "c2CommModeSwitchTypes" attribute; +- the notification URI via which the UASS desires to receive notifications from the UAE Server, within the "notificationUri" attribute; +- the primary C2 communication mode (i.e. either Direct C2 Communication mode or Network-Assisted C2 Communication mode) to be used by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute, within the "primaryC2CommMode" attribute; and +- the C2 operation mode switching policies, within the "c2SwitchPolicies" attribute; + +and may also contain: + +- the secondary C2 communication mode (i.e. either Direct C2 Communication mode or Network-Assisted C2 Communication mode) to be used by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute, within the "secondaryC2CommMode" attribute; +- the service area within which the C2 operation mode management request applies (i.e. a geographical area or a topological area), within the "c2ServiceArea" attribute; and +- the list of features supported by the UASS among the ones defined in clause 6.1.8, within the "suppFeat" attribute. + +2a. Upon success, the UAE Server shall respond with an HTTP "200 OK" status code with the response body including the C2Result data structure which shall contain a feedback from the UAE Server on whether the request for C2 Operation Mode configuration information provisioning is confirmed (i.e. can be undertaken by the UAE Server) or not. The C2Result data structure may also contain the list of negotiated supported features. + +2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +## 5.2.2.3 UAE\_C2OperationModeManagement\_Notify + +### 5.2.2.3.1 General + +This service operation is used by a UAE Server to notify a previously subscribed UASS either on C2 operation mode management completion, on the C2 communication mode selected by a UAS (i.e. pair of UAV and UAV-C) or when C2 communication mode switching is carried out. For the latter, the UASS may then confirm the targeted C2 communication mode switching or not. See also clause 7.4 of 3GPP TS 23.255 [6]. + +The following procedures are supported by the "UAE\_C2OperationModeManagement\_Notify" service operation: + +- C2 Operation Mode Management Completion Notification. +- Selected C2 Communication Mode Notification. +- C2 Communication Mode Switching Notification. + +### 5.2.2.3.2 C2 Operation Mode Management Completion Notification + +Figure 5.2.2.3.2-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on the C2 operation mode management completion status for a UAS (i.e. pair of UAV and UAV-C). See also clause 7.4 of 3GPP TS 23.255 [6]. + +![Sequence diagram for C2 Operation Mode Management Completion Notification procedure. The diagram shows a UASS and a UAE Server. The UAE Server sends a POST request to the UASS with the URI {notificationUri}/c2mode-mngt-completion and a body containing C2OpModeMngtCompStatus. The UASS responds with either a 204 No Content (2a) or an error status code (2b, 4xx/5xx).](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note right of UAE_Server: 1. POST {notificationUri}/c2mode-mngt-completion +(C2OpModeMngtCompStatus) + UAE_Server->>UASS: 1. POST {notificationUri}/c2mode-mngt-completion +(C2OpModeMngtCompStatus) + Note right of UASS: 2a. 204 No Content + UASS->>UAE_Server: 2a. 204 No Content + Note right of UASS: 2b. 4xx/5xx + UASS->>UAE_Server: 2b. 4xx/5xx + +``` + +Sequence diagram for C2 Operation Mode Management Completion Notification procedure. The diagram shows a UASS and a UAE Server. The UAE Server sends a POST request to the UASS with the URI {notificationUri}/c2mode-mngt-completion and a body containing C2OpModeMngtCompStatus. The UASS responds with either a 204 No Content (2a) or an error status code (2b, 4xx/5xx). + +**Figure 5.2.2.3.2-1: C2 Operation Mode Management Completion Notification procedure** + +1. The UAE Server shall send for this purpose an HTTP POST request to the UASS with the request URI set to "{notificationUri}/c2mode-mngt-completion", where the "notificationUri" is set to the value received from the UASS during the C2 Operation Mode Initiation procedure defined in clause 5.2.2.2, and the request body including the C2OpModeMngtCompStatus data structure that shall contain: + +- the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the notification is related, within the "uasId" attribute; and +- the C2 operation mode management completion status (i.e. either successful or not successful) for the concerned UAS (i.e. pair of UAV and UAV-C), within the "status" attribute. + +- 2a. Upon success, the UASS shall respond to the UAE Server with an HTTP "204 No Content" status code to acknowledge the reception of the notification. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +### 5.2.2.3.3 Selected C2 Communication Mode Notification + +Figure 5.2.2.3.3-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on the C2 communication mode selected by a UAS (i.e. pair of UAV and UAV-C). See also clause 7.4 of 3GPP TS 23.255[6]. + +![Sequence diagram for Selected C2 Communication Mode Notification procedure. The diagram shows a UASS and a UAE Server. The UAE Server sends a POST request to the UASS with the URI {notificationUri}/inform-selec-c2mode and a body containing SelectedC2CommModeNotif. The UASS responds with either a 204 No Content (2a) or an error status code (2b, 4xx/5xx).](9b62a616c7a1097c5da57f001ab6dd64_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note right of UAE_Server: 1. POST {notificationUri}/inform-selec-c2mode +(SelectedC2CommModeNotif) + UAE_Server->>UASS: 1. POST {notificationUri}/inform-selec-c2mode +(SelectedC2CommModeNotif) + Note right of UASS: 2a. 204 No Content + UASS->>UAE_Server: 2a. 204 No Content + Note right of UASS: 2b. 4xx/5xx + UASS->>UAE_Server: 2b. 4xx/5xx + +``` + +Sequence diagram for Selected C2 Communication Mode Notification procedure. The diagram shows a UASS and a UAE Server. The UAE Server sends a POST request to the UASS with the URI {notificationUri}/inform-selec-c2mode and a body containing SelectedC2CommModeNotif. The UASS responds with either a 204 No Content (2a) or an error status code (2b, 4xx/5xx). + +**Figure 5.2.2.3.3-1: Selected C2 Communication Mode Notification procedure** + +1. The UAE Server shall send for this purpose an HTTP POST request to the UASS with the request URI set to "{notificationUri}/inform-selec-c2mode", where the "notificationUri" is set to the value received from the UASS during the C2 Operation Mode Initiation procedure defined in clause 5.2.2.2, and the request body including the SelectedC2CommModeNotif data structure that shall contain: + +- the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the notification is related, within the "uasId" attribute; and + +- the primary C2 communication mode selected by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute, within the "selPrimaryC2CommMode" attribute; + +and may also contain: + +- the secondary C2 communication mode selected by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute, within the "selSecondaryC2CommMode" attribute. + +- 2a. Upon success, the UASS shall respond to the UAE Server with an HTTP "200 No Content" status code to acknowledge the reception of the notification. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +#### 5.2.2.3.4 C2 Communication Mode Switching Notification + +Figure 5.2.2.3.4-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on the targeted C2 communication mode switching for a UAS (i.e. pair of UAV and UAV-C) and may request confirmation from the UASS. See also clause 7.4 of 3GPP TS 23.255[6]. + +![Sequence diagram showing the C2 Communication Mode Switching Notification procedure between a UAE Server and a UASS. The UAE Server sends a POST request to the UASS. The UASS responds with either a 200 OK (C2Result), a 204 No Content, or a 4xx/5xx error status code.](e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg) + +``` + +sequenceDiagram + participant UAE Server + participant UASS + Note left of UAE Server: 1. POST {notificationUri}/inform-c2mode-switch (C2CommModeSwitchNotif) + UAE Server->>UASS: 1. POST {notificationUri}/inform-c2mode-switch (C2CommModeSwitchNotif) + Note right of UASS: 2a. 200 OK (C2Result) + Note right of UASS: 2b. 204 No Content + Note right of UASS: 2c. 4xx/5xx + UASS-->>UAE Server: 2a. 200 OK (C2Result) + UASS-->>UAE Server: 2b. 204 No Content + UASS-->>UAE Server: 2c. 4xx/5xx + +``` + +Sequence diagram showing the C2 Communication Mode Switching Notification procedure between a UAE Server and a UASS. The UAE Server sends a POST request to the UASS. The UASS responds with either a 200 OK (C2Result), a 204 No Content, or a 4xx/5xx error status code. + +**Figure 5.2.2.3.4-1: C2 Communication Mode Switching Notification procedure** + +1. The UAE Server shall send for this purpose an HTTP POST request to the UASS with the request URI set to "{notificationUri}/inform-c2mode-switch", where the "notificationUri" is set to the value received from the UASS during the C2 Operation Mode Initiation procedure defined in clause 5.2.2.2, and the request body including the C2CommModeSwitchNotif data structure that shall contain: + - the identifier of the UAE Server that is sending the notification and possibly requesting C2 Communication Mode switching confirmation for a UAS (i.e. pair of UAV and UAV-C) from the UASS, within the "uaeServerId" attribute; + - the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the provided C2 Communication Mode switching information is related, within the "uasId" attribute; and + - the targeted C2 Communication Mode switching for the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute, within the "c2CommModeSwitchType" attribute; + +And may contain: + +- the C2 Communication Mode switching cause, within the "switchingCause" attribute. + +- 2a. Upon success, if the UASS has to confirm (i.e. approve) the C2 Communication Mode switching operation to the UAE Server, the UASS shall respond with an HTTP "200 OK" status code with the response body including the + +C2Result data structure which shall contain a feedback from the UASS on whether this C2 Communication Mode switching is confirmed (i.e. approved) or not. + +- 2b. Otherwise, upon success, if the UASS does not have to confirm (i.e. approve) the C2 Communication Mode switching operation to the UAE Server, the UASS shall respond to the UAE Server with an HTTP "204 No Content" status code to acknowledge the reception of the notification. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2c. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +## 5.3 UAE\_RealtimeUAVStatus Service + +### 5.3.1 Service Description + +The UAE\_RealtimeUAVStatus service exposed by the UAE Server enables a UASS (e.g. USS/UTM) to: + +- subscribe to real-time UAV status information reporting; +- update an existing real-time UAV status information reporting subscription; +- receive real-time UAV status notifications; and +- unsubscribe from real-time UAV status information reporting. + +The UAV status information includes the UAV network connection status information and the UAV location information. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operations defined for the UAE\_RealtimeUAVStatus service are shown in table 5.3.2.1-1. + +**Table 5.3.2.1-1: UAE\_RealtimeUAVStatus Service Operations** + +| Service Operation Name | Description | Initiated by | +|-----------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| UAE_RealtimeUAVStatus_Subscribe | This service operation enables a UASS to subscribe to real-time UAV status information reporting or update an existing real-time UAV status information reporting subscription. | e.g. UASS | +| UAE_RealtimeUAVStatus_Unsubscribe | This service operation enables a UASS to unsubscribe from real-time UAV status information reporting. | e.g. UASS | +| UAE_RealtimeUAVStatus_Notify | This service operation enables a UAE Server to notify a previously subscribed UASS on real-time UAV status information. | UAE Server | + +#### 5.3.2.2 UAE\_RealtimeUAVStatus\_Subscribe + +##### 5.3.2.2.1 General + +This service operation is used by a UASS to subscribe to real-time UAV status information reporting or update an existing real-time UAV status information reporting subscription. + +The following procedures are supported by the "UAE\_RealtimeUAVStatus\_Subscribe" service operation: + +- Subscribe to real-time UAV status information reporting. +- Update an existing real-time UAV status information reporting subscription. + +##### 5.3.2.2.2 Subscribe to real-time UAV status information reporting + +Figure 5.3.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to request the creation of a subscription to real-time UAV status information reporting (see also clause 7.5 of 3GPP TS 23.255[6]). + +![Sequence diagram for subscribing to real-time UAV status information reporting](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +A sequence diagram showing the interaction between a UASS and a UAE Server. The UASS sends a POST request to the UAE Server. The UAE Server responds with either a 201 Created status (success) or a 4xx/5xx status (error). + +``` +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. POST .../subscriptions (RTUavStatusSubsc) + UASS->>UAE_Server: Request + Note right of UAE_Server: 2a. 201 Created (RTUavStatusSubsc) + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: Response +``` + +Sequence diagram for subscribing to real-time UAV status information reporting + +**Figure 5.3.2.2.2-1: Procedure for subscribing to real-time UAV status information reporting** + +1. In order to subscribe to real-time UAV status reporting, the UASS shall send an HTTP POST request to the UAE Server, with the request URI set to "{apiRoot}/uae-uav-status//subscriptions" and the request body including the RTUavStatusSubsc data structure that shall contain: + - the identifier of the UASS that is sending the request, within the "uassId" attribute; + - the identifier(s) of the target UAV(s) to which the subscription is related, within the "uavIds" attribute; + - the notification URI via which the UASS desires to receive real-time UAV status notifications from the UAE Server, within the "notificationUri" attribute; and + - the list of features supported by the UASS among the ones defined in clause 6.2.8, within the "suppFeat" attribute. +- 2a. Upon success, the UAE Server shall respond with an HTTP "201 Created" status code with the response body containing a representation of the created Individual Real-time UAV Status Subscription resource within the RTUavStatusSubsc data structure. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +#### 5.3.2.2.3 Update an existing real-time UAV status information reporting subscription + +Figure 5.3.2.2.3-1 depicts a scenario where a UASS sends a request to the UAE Server to request the update of an existing subscription to real-time UAV status information reporting. + +![Sequence diagram for updating a real-time UAV status information reporting subscription](75e4b78ee25f885d73120e3066a5253e_img.jpg) + +A sequence diagram showing the interaction between a UASS and a UAE Server. The UASS sends a PUT request to the UAE Server. The UAE Server responds with either a 200 OK or 204 No Content status (success) or a 4xx/5xx status (error). + +``` +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. PUT .../subscriptions/{subscriptionId} (RTUavStatusSubsc) + UASS->>UAE_Server: Request + Note right of UAE_Server: 2a. 200 OK (RTUavStatusSubsc) / 204 No Content + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: Response +``` + +Sequence diagram for updating a real-time UAV status information reporting subscription + +**Figure 5.3.2.2.3-1: Procedure for updating a real-time UAV status information reporting subscription** + +1. In order to update an existing real-time UAV status reporting subscription, the UASS shall send an HTTP PUT request to the UAE Server, with the request URI set to "{apiRoot}/uae-uav-status//subscriptions/{subscriptionId}", requesting to update the Individual Real-time UAV Status Subscription resource identified by the provided "subscriptionId" path segment. The request body shall include an updated representation of the resource within the RTUavStatusSubsc data structure that shall contain: + - the identifier of the UASS that is sending the request, within the "uassId" attribute; + +NOTE: An alternative UASS than the one that requested the creation of the subscription resource can send this subscription update request. + +- the same or an updated list of identifier(s) of the target UAV(s) to which the subscription is related, within the "uavIds" attribute; and + - the same or an updated notification URI via which the UASS desires to receive real-time UAV status notifications from the UAE Server, within the "notificationUri" attribute. +- 2a. Upon success, the UAE Server shall update the concerned Individual Real-time UAV Status Subscription resource accordingly and respond with either: +- an HTTP "200 OK" status code with the response body containing a representation of the updated Individual Real-time UAV Status Subscription resource within the RTUavStatusSubsc data structure; or + - an HTTP "204 No Content" status code. +- If the UAE Server is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI of the resource located in an alternative UAE Server, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP PUT response body. + +### 5.3.2.3 UAE\_RealtimeUAVStatus\_Unsubscribe + +#### 5.3.2.3.1 General + +This service operation is used by a UASS to unsubscribe from real-time UAV status information reporting. + +The following procedures are supported by the "UAE\_RealtimeUAVStatus\_Unsubscribe" service operation: + +- Unsubscribe from real-time UAV status information reporting. + +#### 5.3.2.3.2 Unsubscribe from real-time UAV status information reporting + +Figure 5.3.2.3.2-1 depicts a scenario where a UASS sends a request to the UAE Server to request the deletion of an existing Individual Real-time UAV Status Subscription resource (see also clause 7.5 of 3GPP TS 23.255 [6]). + +![Sequence diagram showing the procedure for unsubscribing from real-time UAV status information reporting. The UASS sends a DELETE request to the UAE Server. The UAE Server responds with either a 204 No Content (2a) or an error status code (2b).](2834bdd6eb8540277e609decbb924003_img.jpg) + +``` +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. DELETE .../subscriptions/{subscriptionId} () + UASS->>UAE_Server: 1. DELETE .../subscriptions/{subscriptionId} () + Note right of UAE_Server: 2a. 204 No Content + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: 2a. 204 No Content + UAE_Server-->>UASS: 2b. 4xx/5xx +``` + +Sequence diagram showing the procedure for unsubscribing from real-time UAV status information reporting. The UASS sends a DELETE request to the UAE Server. The UAE Server responds with either a 204 No Content (2a) or an error status code (2b). + +**Figure 5.3.2.3.2-1: Procedure for unsubscribing from real-time UAV status information reporting** + +1. In order to unsubscribe from real-time UAV status reporting, the UASS shall send an HTTP DELETE request to the UAE Server, with the request URI set to "{apiRoot}/uae-uav-status/{apiVersion}/subscriptions/{subscriptionId}", requesting to delete the Individual Real-time UAV Status Subscription resource identified by the provided "subscriptionId" path segment. +- 2a. Upon success, the UAE Server shall respond with an HTTP "204 No Content" status code. + +If the UAE Server is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI of the resource located in an alternative UAE Server, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP DELETE response body. + +### 5.3.2.4 UAE\_RealtimeUAVStatus\_Notify + +#### 5.3.2.4.1 General + +This service operation is used by a UAE Server to notify a previously subscribed UASS on real-time UAV status information. See also clause 7.5 of 3GPP TS 23.255 [6]. + +The following procedures are supported by the "UAE\_RealtimeUAVStatus\_Notify" service operation: + +- Real-time UAV Status Notification. + +#### 5.3.2.4.2 Real-time UAV Status Notification + +Figure 5.3.2.4.2-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on real-time UAV status information. See also clause 7.5 of 3GPP TS 23.255 [6]. + +![Sequence diagram showing the Real-time UAV Status Notification procedure between a UASS and a UAE Server. The UAE Server sends a POST request to the UASS. The UASS responds with either a 204 No Content (success) or a 4xx/5xx status code (failure).](86d30a7d5a9cd4ee5456b5962ae3420a_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note right of UAE_Server: 1. POST {notificationUri}/uav-status (RTUavStatusNotif) + UAE_Server->>UASS: 1. POST {notificationUri}/uav-status (RTUavStatusNotif) + Note left of UASS: 2a. 204 No Content +2b. 4xx/5xx + UASS-->>UAE_Server: 2a. 204 No Content +2b. 4xx/5xx + +``` + +Sequence diagram showing the Real-time UAV Status Notification procedure between a UASS and a UAE Server. The UAE Server sends a POST request to the UASS. The UASS responds with either a 204 No Content (success) or a 4xx/5xx status code (failure). + +**Figure 5.3.2.4.2-1: Real-time UAV Status Notification procedure** + +- The UAE Server shall send for this purpose an HTTP POST request to the UASS with the request URI set to "{notificationUri}/uav-status", where the "notificationUri" is set to the value received from the UASS during the real-time UAV status reporting subscription creation/update procedures defined in clause 5.3.2.2, and the request body including the RTUavStatusNotif data structure that shall contain: + - The identifier of the Individual Real-time UAV Status Subscription to which the notification is related, within the "subscriptionId" attribute; and + - The real-time UAV status information for the concerned UAV(s), within the "rTUavStatus" attribute. +- Upon success, the UASS shall respond with an HTTP "204 No Content" status code to acknowledge the reception of the notification to the UAE Server. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body. + +## 5.4 UAE\_ChangeUSSManagement Service + +### 5.4.1 Service Description + +The UAE\_ChangeUSSManagement service exposed by the UAE Server enables a UASS (e.g. USS) to: + +- create/update/delete USS Change Policies; +- request USS change; +- receive notifications on USS Change Policy Configuration status; +- receive notifications on USS Change (i.e. that a USS change was performed); and +- receive notifications when USS change needs to be triggered. + +### 5.4.2 Service Operations + +#### 5.4.2.1 Introduction + +The service operations defined for the UAE\_ChangeUSSManagement service are shown in table 5.4.2.1-1. + +**Table 5.4.2.1-1: UAE\_ChangeUSSManagement Service Operations** + +| Service Operation Name | Description | Initiated by | +|------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| UAE_ChangeUSSManagement_ManageUSS | This service operation enables a UASS to create/update/delete a USS Change Policy. | e.g. UASS | +| UAE_ChangeUSSManagement_RequestUSSChange | This service operation enables a UASS to trigger USS change. | e.g. UASS | +| UAE_ChangeUSSManagement_Notify | This service operation enables a UAE Server to notify a previously subscribed UASS either:
  • - on USS Change Policy Configuration completion status;
  • - on USS change (i.e. that a USS change was performed); or
  • - when USS change needs to be triggered.
| e.g. UASS | + +#### 5.4.2.2 UAE\_ChangeUSSManagement\_ManageUSS + +##### 5.4.2.2.1 General + +This service operation is used by a UASS to request the creation/update/deletion of a USS Change Policy at the UAE Server. + +The following procedures are supported by the "UAE\_ChangeUSSManagement\_ManageUSS" service operation: + +- USS Change Policy Creation. +- USS Change Policy Update. +- USS Change Policy Deletion. + +##### 5.4.2.2.2 USS Change Policy Creation + +Figure 5.4.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to create a USS Change Policy (see also clause 7.6 of 3GPP TS 23.255[6]). + +![Sequence diagram for USS Change Policy Creation. A UASS sends a POST .../policies (USSChangePolReq) to a UAE Server. The UAE Server responds with 2a. 201 Created (USSChangePolResp) or 2b. 4xx/5xx.](26d664119ad25250780f554633444e54_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. Request creation + UASS->>UAE_Server: POST .../policies (USSChangePolReq) + Note right of UAE_Server: 2a. Success / 2b. Error + UAE_Server-->>UASS: 2a. 201 Created (USSChangePolResp) + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: 2b. 4xx/5xx + +``` + +Sequence diagram for USS Change Policy Creation. A UASS sends a POST .../policies (USSChangePolReq) to a UAE Server. The UAE Server responds with 2a. 201 Created (USSChangePolResp) or 2b. 4xx/5xx. + +**Figure 5.4.2.2.2-1: Procedure for USS Change Policy Creation** + +1. In order to request the creation of a USS Change Policy, the UASS shall send an HTTP POST request to the UAE Server targeting the "USS Change Policies" resource, with the request body including the USSChangePolReq data structure. +- 2a. Upon success, the UAE Server shall respond with an HTTP "201 Created" status code with the response body containing a representation of the created "Individual USS Change Policy" resource and potentially additional information within the USSChangePolResp data structure. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.3.7. + +#### 5.4.2.2.3 USS Change Policy Update + +Figure 5.4.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to update an existing USS Change Policy (see also clause 7.6 of 3GPP TS 23.255°[6]). + +![Sequence diagram for USS Change Policy Update. A UASS sends a PUT or PATCH .../policies/{policyId} (USSChangePolicy or USSChangePolicyPatch) to a UAE Server. The UAE Server responds with 2a. 200 OK (USSChangePolicy) / 204 No Content or 2b. 4xx/5xx.](e7c6a6e4c3047dac05a3b92e396e9794_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. Request update + UASS->>UAE_Server: PUT or PATCH .../policies/{policyId} (USSChangePolicy or USSChangePolicyPatch) + Note right of UAE_Server: 2a. Success / 2b. Error + UAE_Server-->>UASS: 2a. 200 OK (USSChangePolicy) / 204 No Content + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: 2b. 4xx/5xx + +``` + +Sequence diagram for USS Change Policy Update. A UASS sends a PUT or PATCH .../policies/{policyId} (USSChangePolicy or USSChangePolicyPatch) to a UAE Server. The UAE Server responds with 2a. 200 OK (USSChangePolicy) / 204 No Content or 2b. 4xx/5xx. + +**Figure 5.4.2.2.3-1: Procedure for USS Change Policy Update** + +1. In order to request the update/modification of an existing USS Change Policy, the UASS shall send an HTTP PUT/PATCH request to the UAE Server targeting the corresponding "Individual USS Change Policy" resource, with the request body including the USSChangePolicy data structure (in case the HTTP PUT method is used) or the USSChangePolicyPatch data structure (in case the HTTP PATCH method is used). + +NOTE: An alternative UASS (i.e. other than the one that requested the creation of the targeted resource) can initiate this request. + +If the UAE Server is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI of the resource located in an alternative UAE Server, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UAE Server shall respond with either: + +- an HTTP "200 OK" status code with the response body containing a representation of the updated/modified "Individual USS Change Policy" resource and potentially additional information within the USSChangePolicy data structure; or +- an HTTP "204 No Content" status code. + +2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP PUT/PATCH response body, as specified in clause 6.3.7. + +#### 5.4.2.2.3 USS Change Policy Deletion + +Figure 5.4.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to delete an existing USS Change Policy (see also clause 7.6 of 3GPP°TS°23.255°[6]). + +![Sequence diagram for USS Change Policy Deletion. A UASS sends a DELETE .../policies/{policyId} () request to a UAE Server. The UAE Server responds with 2a. 204 No Content or 2b. 4xx/5xx.](20136850feb70fd71c7d41cdae203ebb_img.jpg) + +``` +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: + UASS->>UAE_Server: DELETE .../policies/{policyId} () + Note right of UAE_Server: + UAE_Server-->>UASS: 2a. 204 No Content + Note right of UAE_Server: + UAE_Server-->>UASS: 2b. 4xx/5xx +``` + +Sequence diagram for USS Change Policy Deletion. A UASS sends a DELETE .../policies/{policyId} () request to a UAE Server. The UAE Server responds with 2a. 204 No Content or 2b. 4xx/5xx. + +**Figure 5.4.2.2.3-1: Procedure for USS Change Policy Deletion** + +1. In order to request the deletion of an existing USS Change Policy, the UASS shall send an HTTP DELETE request to the UAE Server targeting the corresponding "Individual USS Change Policy" resource. + +NOTE: An alternative UASS (i.e. other than the one that requested the creation of the targeted resource) can initiate this request. + +- 2a. Upon success, the UAE Server shall respond with an HTTP "204 No Content" status code. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP DELETE response body, as specified in clause 6.3.7. + +#### 5.4.2.3 UAE\_ChangeUSSManagement\_RequestUSSChange + +##### 5.4.2.3.1 General + +This service operation is used by a UASS to request USS change. + +The following procedures are supported by the "UAE\_ChangeUSSManagement\_RequestUSSChange" service operation: + +- USS Change Request. + +##### 5.4.2.3.2 USS Change Request + +Figure 5.4.2.3.2-1 depicts a scenario where a UASS sends a request to the UAE Server to request USS change (see also clause 7.6 of 3GPP°TS°23.255°[6]). + +![Sequence diagram showing the procedure for USS Change Request. A UASS sends a POST .../request-usschange (USSChangeReq) to a UAE Server. The UAE Server responds with either 2a. 204 No Content or 2b. 4xx/5xx.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. Request USS change + UASS->>UAE_Server: POST .../request-usschange (USSChangeReq) + Note right of UAE_Server: 2a. 204 No Content / 2b. 4xx/5xx + UAE_Server-->>UASS: Response + +``` + +Sequence diagram showing the procedure for USS Change Request. A UASS sends a POST .../request-usschange (USSChangeReq) to a UAE Server. The UAE Server responds with either 2a. 204 No Content or 2b. 4xx/5xx. + +**Figure 5.4.2.3.2-1: Procedure for USS Change Request** + +1. In order to request USS change, the UASS shall send an HTTP POST request (custom operation: "RequestUssChange") to the UAE Server, with the request URI set to "{apiRoot}/uae-usschange-mngt//request-usschange", and the request body including the USSChangeReq data structure. + +If the UAE Server is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI of the resource located in an alternative UAE Server, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UAE Server shall respond with an HTTP "204 No Content" status code. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.3.7. + +#### 5.4.2.4 UAE\_ChangeUSSManagement\_Notify + +##### 5.4.2.4.1 General + +This service operation is used by a UAE Server to notify a previously subscribed UASS either: + +- on USS Change Policy Configuration completion status; +- on USS change (i.e. that a USS change was performed); or +- when USS change needs to be triggered. + +The following procedures are supported by the "UAE\_ChangeUSSManagement\_Notify" service operation: + +- USS Change Policy Configuration Status Notification. +- USS Change Notification. +- USS Change Trigger Notification. + +##### 5.4.2.4.2 USS Change Policy Configuration Status Notification + +Figure 5.4.2.4.2-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on the status of USS Change Policy Configuration (see also clause 7.6 of 3GPP TS 23.255 [6]). + +![Sequence diagram for USS Change Policy Configuration Status Notification procedure. A UAE Server sends a POST {notifUri}/usschange-policy (USSChangePolConfigNotif) request to a UASS. The UASS responds with either 2a. 204 No Content or 2b. 4xx/5xx.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` +sequenceDiagram + participant UAE Server + participant UASS + Note left of UAE Server: POST {notifUri}/usschange-policy (USSChangePolConfigNotif) + UAE Server->>UASS: Request + Note right of UASS: 2a. 204 No Content + Note right of UASS: 2b. 4xx/5xx + UASS-->>UAE Server: Response +``` + +Sequence diagram for USS Change Policy Configuration Status Notification procedure. A UAE Server sends a POST {notifUri}/usschange-policy (USSChangePolConfigNotif) request to a UASS. The UASS responds with either 2a. 204 No Content or 2b. 4xx/5xx. + +**Figure 5.4.2.4.2-1: USS Change Policy Configuration Status Notification procedure** + +1. In order to notify a UASS on the status of USS Change Policy Configuration, the UAE Server shall send an HTTP POST request to the UASS with the request URI set to "{notifUri}/usschange-policy", where the "notifUri" is set to the value received from the UASS during the USS Change Policy Creation/Update procedure defined in clause 5.4.2.2, and the request body including the USSChangePolConfigNotif data structure. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UASS shall respond to the UAE Server with an HTTP "204 No Content" status code to acknowledge the reception of the notification. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.3.7. + +#### 5.4.2.4.3 USS Change Notification + +Figure 5.4.2.4.3-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS that a USS change was performed (see also clause 7.6 of 3GPP TS 29.255°[6]). + +![Sequence diagram for USS Change Notification procedure. A UAE Server sends a POST {notifUri}/usschange (USSChangeNotif) request to a UASS. The UASS responds with either 2a. 204 No Content or 2b. 4xx/5xx.](7a02de7ed198501f7a4f6ca37c3f28c5_img.jpg) + +``` +sequenceDiagram + participant UAE Server + participant UASS + Note left of UAE Server: POST {notifUri}/usschange (USSChangeNotif) + UAE Server->>UASS: Request + Note right of UASS: 2a. 204 No Content + Note right of UASS: 2b. 4xx/5xx + UASS-->>UAE Server: Response +``` + +Sequence diagram for USS Change Notification procedure. A UAE Server sends a POST {notifUri}/usschange (USSChangeNotif) request to a UASS. The UASS responds with either 2a. 204 No Content or 2b. 4xx/5xx. + +**Figure 5.4.2.4.3-1: USS Change Notification procedure** + +1. In order to notify a UASS that a USS change was performed, the UAE Server shall send an HTTP POST request to the UASS with the request URI set to "{notifUri}/usschange", where the "notifUri" is set to the value received from the UASS during the USS Change Policy Creation/Update procedure defined in clause 5.4.2.2, and the request body including the USSChangeNotif data structure. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UASS shall respond to the UAE Server with an HTTP "204 No Content" status code to acknowledge the reception of the notification. + +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.3.7. + +#### 5.4.2.4.4 USS Change Trigger Notification + +Figure 5.4.2.4.4-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS that a USS change should be triggered (see also clause 7.6 of 3GPP TS 23.255[6]). + +![Sequence diagram showing the USS Change Trigger Notification procedure between a UAE Server and a UASS.](f0a97d0d3818a253c1d2a009966081b1_img.jpg) + +``` +sequenceDiagram + participant UAE Server + participant UASS + Note right of UAE Server: POST {notifUri}/usschange-trigger (USSChangeTriggerNotif) + UAE Server->>UASS: Request + Note left of UASS: 2a. 204 No Content + Note left of UASS: 2b. 4xx/5xx + UASS-->>UAE Server: Response +``` + +The diagram illustrates the interaction between a UAE Server and a UASS. The UAE Server sends a POST request to the UASS with the URI {notifUri}/usschange-trigger and the body USSChangeTriggerNotif. The UASS responds with either a 204 No Content status code (2a) or a 4xx/5xx status code (2b). + +Sequence diagram showing the USS Change Trigger Notification procedure between a UAE Server and a UASS. + +**Figure 5.4.2.4.4-1: USS Change Trigger Notification procedure** + +1. In order to notify a UASS that a USS change should be triggered, the UAE Server shall send an HTTP POST request to the UASS with the request URI set to "{notifUri}/usschange-trigger", where the "notifUri" is set to the value received from the UASS during the USS Change Policy Creation/Update procedure defined in clause 5.4.2.2, and the request body including the USSChangeTriggerNotif data structure. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UASS shall respond to the UAE Server with an HTTP "204 No Content" status code to acknowledge the reception of the notification. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.3.7. + +## 5.5 UAE\_DAASupport Service + +### 5.5.1 Service Description + +The UAE\_DAASupport service exposed by the UAE Server enables a UASS (e.g. USS/UTM) to: + +- create/update/delete DAA Policies; +- receive DAA Policy Configuration Completion Status notifications; +- receive DAA Event notifications; and +- inform about and request the management of the detected DAA related events. + +### 5.5.2 Service Operations + +#### 5.5.2.1 Introduction + +The service operations defined for the UAE\_DAASupport service are shown in table 5.5.2.1-1. + +**Table 5.5.2.1-1: UAE\_DAASupport Service Operations** + +| Service Operation Name | Description | Initiated by | +|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| UAE_DAASupport_Manage | This service operation enables a UASS to create/update/delete a DAA Application Policy. | e.g. UASS | +| UAE_DAASupport_InformDAAEvent | This service operation enables a UASS to send the detected DAA related events. | e.g. UASS | +| UAE_DAASupport_Notify | This service operation enables a UAE Server to notify a previously subscribed UASS either:
  • - on DAA Policy Configuration Completion Status; or
  • - on detected DAA related events.
| e.g. UASS | + +#### 5.5.2.2 UAE\_DAASupport\_Manage + +##### 5.5.2.2.1 General + +This service operation is used by a UASS to request the creation/update/deletion of a DAA Policy at the UAE Server. + +The following procedures are supported by the "UAE\_DAASupport\_Manage" service operation: + +- DAA Policy Creation. +- DAA Policy Update. +- DAA Policy Deletion. + +##### 5.5.2.2.2 DAA Policy Creation + +Figure 5.5.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to create a DAA Policy (see also clause 7.7 of 3GPP TS 23.255 [6]). + +![Sequence diagram for DAA Policy Creation. A UASS sends a POST .../policies (DAAPolReq) to a UAE Server. The UAE Server responds with 2a. 201 Created (DAAPolResp) on success or 2b. 4xx/5xx on failure.](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. Request creation + UASS->>UAE_Server: POST .../policies (DAAPolReq) + Note right of UAE_Server: 2a. Success / 2b. Failure + UAE_Server-->>UASS: 2a. 201 Created (DAAPolResp) + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: 2b. 4xx/5xx + +``` + +Sequence diagram for DAA Policy Creation. A UASS sends a POST .../policies (DAAPolReq) to a UAE Server. The UAE Server responds with 2a. 201 Created (DAAPolResp) on success or 2b. 4xx/5xx on failure. + +**Figure 5.5.2.2.2-1: Procedure for DAA Policy Creation** + +1. In order to request the creation of a DAA Policy, the UASS shall send an HTTP POST request to the UAE Server targeting the "DAA Policies" resource, with the request body including the DAAPolReq data structure. +- 2a. Upon success, the UAE Server shall respond with an HTTP "201 Created" status code with the response body containing a representation of the created "Individual DAA Policy" resource and potentially additional information within the DAAPolResp data structure. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.4.7. + +### 5.5.2.2.3 DAA Policy Update + +Figure 5.5.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to update an existing DAA Policy (see also clause 7.7 of 3GPP TS 23.255 [6]). + +![Sequence diagram for DAA Policy Update. A UASS sends a PUT or PATCH .../policies/{policyId} (DAAPolicy or DAAPolicyPatch) to a UAE Server. The UAE Server responds with 2a. 200 OK (DAAPolicy) / 204 No Content on success or 2b. 4xx/5xx on failure.](dc1f232cfd39be5c20b21374ad4c04c0_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: 1. Request update + UASS->>UAE_Server: PUT or PATCH .../policies/{policyId} (DAAPolicy or DAAPolicyPatch) + Note right of UAE_Server: 2a. Success / 2b. Failure + UAE_Server-->>UASS: 2a. 200 OK (DAAPolicy) / 204 No Content + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: 2b. 4xx/5xx + +``` + +Sequence diagram for DAA Policy Update. A UASS sends a PUT or PATCH .../policies/{policyId} (DAAPolicy or DAAPolicyPatch) to a UAE Server. The UAE Server responds with 2a. 200 OK (DAAPolicy) / 204 No Content on success or 2b. 4xx/5xx on failure. + +**Figure 5.5.2.2.3-1: Procedure for DAA Policy Update** + +1. In order to request the update/modification of an existing DAA Policy, the UASS shall send an HTTP PUT/PATCH request to the UAE Server targeting the corresponding "Individual DAA Policy" resource, with the request body including the DAAPolicy data structure (in case the HTTP PUT method is used) or the DAAPolicyPatch data structure (in case the HTTP PATCH method is used). + +NOTE: An alternative UASS (i.e. other than the one that requested the creation of the targeted resource) can initiate this request. + +If the UAE Server is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI of the resource located in an alternative UAE Server, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UAE Server shall respond with either: + - an HTTP "200 OK" status code with the response body containing a representation of the updated/modified "Individual DAA Policy" resource and potentially additional information within the DAAPolicy data structure; or + +- an HTTP "204 No Content" status code. + +2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP PUT/PATCH response body, as specified in clause 6.4.7. + +### 5.5.2.2.3 DAA Policy Deletion + +Figure 5.5.2.2.2-1 depicts a scenario where a UASS sends a request to the UAE Server to delete an existing DAA Policy (see also clause 7.7 of 3GPP°TS°23.255°[6]). + +![Sequence diagram for DAA Policy Deletion](94fd137860c16c8dfd75512f10161fe8_img.jpg) + +``` +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note left of UASS: - an HTTP "204 No Content" status code. + Note left of UASS: 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP PUT/PATCH response body, as specified in clause 6.4.7. + UASS->>UAE_Server: DELETE .../policies/{policyId} () + Note right of UAE_Server: 2a. 204 No Content + Note right of UAE_Server: 2b. 4xx/5xx + UAE_Server-->>UASS: +``` + +The diagram illustrates the interaction between a UASS and a UAE Server for DAA Policy Deletion. The UASS sends a DELETE request to the UAE Server. The UAE Server responds with either a 204 No Content status code (2a) or an error status code (2b). The UASS also receives an HTTP "204 No Content" status code and error information as specified in clause 6.4.7. + +Sequence diagram for DAA Policy Deletion + +**Figure 5.5.2.2.3-1: Procedure for DAA Policy Deletion** + +1. In order to request the deletion of an existing DAA Policy, the UASS shall send an HTTP DELETE request to the UAE Server targeting the corresponding "Individual DAA Policy" resource. + +NOTE: An alternative UASS (i.e. other than the one that requested the creation of the targeted resource) can initiate this request. + +2a. Upon success, the UAE Server shall respond with an HTTP "204 No Content" status code. + +2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP DELETE response body, as specified in clause 6.4.7. + +### 5.5.2.3 UAE\_DAASupport\_InformDAAEvent + +#### 5.5.2.3.1 General + +This service operation is used by a UASS to inform about and request the management of the detected DAA related event(s). + +The following procedures are supported by the "UAE\_DAASupport\_InformDAAEvent" service operation: + +- DAA Events Information Request. + +#### 5.5.2.3.2 DAA Events Information Request + +Figure 5.5.2.3.2-1 depicts a scenario where a UASS sends a request to the UAE Server to inform about and request the management of the detected DAA related event(s) (see also clause 7.7 of 3GPP°TS°23.255°[6]). + +![Sequence diagram for Figure 5.5.2.3.2-1: Procedure for DAA Events Information Request. The diagram shows a UASS sending a POST request to a UAE Server. The request is POST .../policies (InformDAAEventsReq). The UAE Server responds with either 2a. 204 No Content or 2b. 4xx/5xx.](b5335262987c819d7f71ce40f99cb71b_img.jpg) + +``` + +sequenceDiagram + participant UASS + participant UAE_Server as UAE Server + Note right of UASS: POST .../policies (InformDAAEventsReq) + UASS->>UAE_Server: Request + Note left of UAE_Server: 2a. 204 No Content +2b. 4xx/5xx + UAE_Server-->>UASS: Response + +``` + +Sequence diagram for Figure 5.5.2.3.2-1: Procedure for DAA Events Information Request. The diagram shows a UASS sending a POST request to a UAE Server. The request is POST .../policies (InformDAAEventsReq). The UAE Server responds with either 2a. 204 No Content or 2b. 4xx/5xx. + +**Figure 5.5.2.3.2-1: Procedure for DAA Events Information Request** + +1. In order to send DAA related event(s) information, the UASS shall send an HTTP POST request (custom operation: "InformDAAEvents") to the UAE Server, with the request URI set to "{apiRoot}/uaedaa//inform-events" and the request body including the InformDAAEventsReq data structure. + +If the UAE Server is not able to handle the request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI of the resource located in an alternative UAE Server, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UAE Server shall respond with an HTTP "204 No Content" status code. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.4.7. + +#### 5.5.2.4 UAE\_DAASupport\_Notify + +##### 5.5.2.4.1 General + +This service operation is used by a UAE Server to notify a previously subscribed UASS either: + +- on DAA Policy Configuration Completion Status; or +- on DAA related event(s). + +The following procedures are supported by the "UAE\_DAASupport\_Notify" service operation: + +- DAA Policy Configuration Completion Status Notification. +- DAA Event Notification. + +##### 5.5.2.4.2 DAA Policy Configuration Completion Status Notification + +Figure 5.5.2.4.2-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on the status of DAA Policy Configuration (see also clause 7.7 of 3GPP TS 23.255 [6]). + +![Sequence diagram for Figure 5.5.2.4.2-1: DAA Policy Configuration Completion Status Notification procedure. The diagram shows a UAE Server sending a POST request to a UASS. The request is POST {notifUri}/daa-policy (DAAPolConfigNotif). The UASS responds with either 2a. 204 No Content or 2b. 4xx/5xx.](4b935d396d60146aaa66ac7372c758b7_img.jpg) + +``` + +sequenceDiagram + participant UAE_Server as UAE Server + participant UASS + Note left of UAE_Server: POST {notifUri}/daa-policy (DAAPolConfigNotif) + UAE_Server->>UASS: Request + Note right of UASS: 2a. 204 No Content +2b. 4xx/5xx + UASS-->>UAE_Server: Response + +``` + +Sequence diagram for Figure 5.5.2.4.2-1: DAA Policy Configuration Completion Status Notification procedure. The diagram shows a UAE Server sending a POST request to a UASS. The request is POST {notifUri}/daa-policy (DAAPolConfigNotif). The UASS responds with either 2a. 204 No Content or 2b. 4xx/5xx. + +**Figure 5.5.2.4.2-1: DAA Policy Configuration Completion Status Notification procedure** + +1. In order to notify a UASS on the status of DAA Policy Configuration, the UAE Server shall send an HTTP POST request to the UASS with the request URI set to "{notifUri}/daa-policy", where the "notifUri" is set to the value received from the UASS during the DAA Policy Creation/Update procedure defined in clause 5.5.2.2, and the request body including the DAAPolConfigNotif data structure. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UASS shall respond to the UAE Server with an HTTP "204 No Content" status code to acknowledge the reception of the notification. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.4.7. + +#### 5.5.2.4.3 DAA Event Notification + +Figure 5.5.2.4.3-1 depicts a scenario where the UAE Server sends a request to notify a previously subscribed UASS on DAA related event(s) (see also clause 7.7 of 3GPP TS 23.255[6]). + +![Sequence diagram of DAA Event Notification procedure between UAE Server and UASS.](836b0790cef5469a167fa8931df4e408_img.jpg) + +``` +sequenceDiagram + participant UAE Server + participant UASS + Note left of UAE Server: POST {notifUri}/daa-events (DAAEventsInfo) + UAE Server->>UASS: POST {notifUri}/daa-events (DAAEventsInfo) + Note right of UASS: 2a. 200 OK (DAAEventsInfo) / 204 No Content + Note right of UASS: 2b. 4xx/5xx + UASS-->>UAE Server: 2a. 200 OK (DAAEventsInfo) / 204 No Content + Note right of UASS: 2b. 4xx/5xx + UASS-->>UAE Server: 2b. 4xx/5xx +``` + +The diagram illustrates the interaction between a UAE Server and a UASS. The UAE Server sends a POST request to the UASS with the URI "{notifUri}/daa-events" and a body containing "DAAEventsInfo". The UASS responds with either a "200 OK" status code with a "DAAEventsInfo" body, or a "204 No Content" status code (case 2a), or an error status code in the 4xx or 5xx range (case 2b). The response is sent back to the UAE Server. + +Sequence diagram of DAA Event Notification procedure between UAE Server and UASS. + +Figure 5.5.2.4.3-1: DAA Event Notification procedure + +1. In order to notify a UASS on the detected DAA event(s), the UAE Server shall send an HTTP POST request to the UASS with the request URI set to "{notifUri}/daa-events", where the "notifUri" is set to the value received from the UASS during the DAA Policy Creation/Update procedure defined in clause 5.5.2.2, and the request body including the DAAEventsInfo data structure. + +If the UASS is not able to handle the notification request, it may respond with an HTTP "307 Temporary Redirect" status code or an HTTP "308 Permanent Redirect" status code including an HTTP "Location" header containing an alternative URI representing the end point of an alternative UASS where the notification should be sent, as defined in clause 5.2.10 of 3GPP TS 29.122 [2]. + +- 2a. Upon success, the UASS shall respond to the UAE Server with either: + - an HTTP "200 OK" status code with the response body containing updated/additional DAA event(s) related information within the DAAEventsInfo data structure, if the UASS needs to provide information about additional DAA event(s) or updated DAA event(s) related information; or + - an HTTP "204 No Content" status code, if the UASS does not need to provide any updated/additional DAA event(s) related information. +- 2b. On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the HTTP POST response body, as specified in clause 6.4.7. + +--- + +## 6 API Definitions + +### 6.1 UAE\_C2OperationModeManagement Service API + +#### 6.1.1 Introduction + +The UAE\_C2OperationModeManagement service shall use the UAE\_C2OperationModeManagement API. + +The API URI of the UAE\_C2OperationModeManagement API shall be: + +**{apiRoot}/** + +The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [2], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. +- The shall be "uae-c2opmode-mngt". +- The shall be "v1". +- The shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. + +NOTE: When 3GPP TS 29.122 [2] is referenced for the common protocol and interface aspects for API definition in the clauses under clause 6.1, the UAE Server takes the role of the SCEF and the UASS takes the role of the SCS/AS. + +#### 6.1.2 Usage of HTTP + +The provisions of clause 5.2.2 of 3GPP TS 29.122 [2] shall apply for the UAE\_C2OperationModeManagement API. + +#### 6.1.3 Resources + +There are no resources defined for this API in this release of the specification. + +#### 6.1.4 Custom Operations without associated resources + +##### 6.1.4.1 Overview + +The structure of the custom operation URIs of the UAE\_C2OperationModeManagement API is shown in Figure 6.1.4.1-1. + +![Diagram showing the custom operation URI structure. A rounded rectangle contains the placeholder '{apiRoot}/uae-c2opmode-mngt/'. A line extends from the bottom of this rectangle to a dashed rectangle containing the path '/initiate'.](2837ffdadcdb1e5bababa56b564e56ed_img.jpg) + +``` + +graph TD + A["{apiRoot}/uae-c2opmode-mngt/"] --> B[/initiate] + style B stroke-dasharray: 5 5 + +``` + +Diagram showing the custom operation URI structure. A rounded rectangle contains the placeholder '{apiRoot}/uae-c2opmode-mngt/'. A line extends from the bottom of this rectangle to a dashed rectangle containing the path '/initiate'. + +**Figure 6.1.4.1-1: Custom operation URI structure of the UAE\_C2OperationModeManagement API** + +Table 6.1.4.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the UAE\_C2OperationModeManagement API. + +**Table 6.1.4.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|----------------|----------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| Initiate | /initiate | POST | Enables a UASS to request to provision C2 Operation Mode configuration information for a UAS (i.e. pair of UAV and UAV-C) to the UAE Server. | + +## 6.1.4.2 Operation: Initiate + +### 6.1.4.2.1 Description + +The custom operation enables a UASS to initiate the configuration of C2 operation modes for a UAS (i.e. pair of UAV and UAV-C) by communicating the associated C2 Operation Mode configuration information to the UAE Server. + +### 6.1.4.2.2 Operation Definition + +This operation shall support the request data structures and the response data structures and response codes specified in tables 6.1.4.2.2-1 and 6.1.4.2.2-2. + +**Table 6.1.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------| +| ConfigureData | M | 1 | Contains the parameters to request to provision C2 Operation Mode configuration information for a UAS (i.e. pair of UAV and UAV-C). | + +**Table 6.1.4.2.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| C2Result | M | 1 | 200 OK | The communicated C2 Operation Mode configuration information was successfully received.
The response body shall contain the feedback of the UAE Server on whether this C2 Operation Mode configuration request is confirmed (i.e. can be undertaken by the UAE Server) or not. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +**Table 6.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 target URI located in an alternative UAE Server. | + +**Table 6.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 target URI located in an alternative UAE Server. | + +## 6.1.5 Notifications + +### 6.1.5.1 General + +Notifications shall comply to clause 5.2.5 of 3GPP TS 29.122 [2]. + +Table 6.1.5.1-1: Notifications overview + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------------------------------------------|------------------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| C2 Operation Mode Management Completion Notification | {notificationUri}/c2mode-mngt-completion | c2mode-mngt-completion (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS on the C2 operation mode management completion status for the concerned UAS (i.e. pair of UAV and UAV-C). | +| Selected C2 Communication Mode Notification | {notificationUri}/inform-selec-c2mode | inform-selec-c2mode (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS on the C2 communication mode selected by the concerned UAS (i.e. pair of UAV and UAV-C). | +| C2 Communication Mode Switching Notification | {notificationUri}/inform-c2mode-switch | inform-c2mode-switch (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS when C2 communication mode switching is carried out for the concerned UAS (i.e. pair of UAV and UAV-C) and possibly request confirmation from the UASS. | + +## 6.1.5.2 C2 Operation Mode Management Completion Notification + +### 6.1.5.2.1 Description + +The C2 Operation Mode Management Completion Notification is used by a UAE Server to notify a previously subscribed UASS on the C2 operation mode management completion status for a UAS (i.e. pair of UAV and UAV-C). + +### 6.1.5.2.2 Target URI + +The Callback URI "{notificationUri}/c2mode-mngt-completion" 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 | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------| +| notificationUri | Uri | String formatted as a URI containing the Callback URI. | + +### 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-2. + +Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------| +| C2OpModeMngtCompStatus | M | 1 | Contains the C2 operation mode management completion status for the concerned UAS (i.e. pair of UAV and UAV-C). | + +**Table 6.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 | The C2 operation mode management completion status for the concerned UAS (i.e. pair of UAV and UAV-C) is successfully received and 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 UASS where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UASS where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +**Table 6.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 UASS towards which the notification should be redirected. | + +**Table 6.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 UASS towards which the notification should be redirected. | + +## 6.1.5.3 Selected C2 Communication Mode Notification + +### 6.1.5.3.1 Description + +The Selected C2 Communication Mode Notification is used by a UAE Server to notify a previously subscribed UASS on the C2 communication mode selected by a UAS (i.e. pair of UAV and UAV-C). + +### 6.1.5.3.2 Target URI + +The Callback URI "{notificationUri}/inform-selec-c2mode" shall be used with the callback URI variables defined in table 6.1.5.3.2-1. + +**Table 6.1.5.3.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------| +| notificationUri | Uri | String formatted as a URI containing the Callback URI. | + +### 6.1.5.3.3 Standard Methods + +#### 6.1.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.3.3.1-1 and the response data structures and response codes specified in table 6.1.5.3.3.1-2. + +**Table 6.1.5.3.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------| +| SelectedC2CommModeNotif | M | 1 | Contains information on the C2 Communication Mode selected by the concerned UAS (i.e. pair of UAV and UAV-C). | + +**Table 6.1.5.3.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | The C2 Communication Mode selected by the concerned UAS (i.e. pair of UAV and UAV-C) is successfully received and 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +**Table 6.1.5.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 representing the end point of an alternative UASS towards which the notification should be redirected. | + +**Table 6.1.5.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 representing the end point of an alternative UASS towards which the notification should be redirected. | + +## 6.1.5.4 C2 Communication Mode Switching Notification + +### 6.1.5.4.1 Description + +The C2 Communication Mode Switching Notification is used by a UAE Server to notify a previously subscribed UASS on the targeted C2 Communication Mode switching for a UAS (i.e. pair of UAV and UAV-C). + +### 6.1.5.4.2 Target URI + +The Callback URI "{notificationUri}/inform-c2mode-switch" shall be used with the callback URI variables defined in table 6.1.5.4.2-1. + +**Table 6.1.5.4.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------| +| notificationUri | Uri | String formatted as a URI containing the Callback URI. | + +### 6.1.5.4.3 Standard Methods + +#### 6.1.5.4.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.4.3.1-1 and the response data structures and response codes specified in table 6.1.5.4.3.1-2. + +**Table 6.1.5.4.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| C2CommModeSwitchNotif | M | 1 | Contains information on the targeted C2 Communication Mode switching for the concerned UAS (i.e. pair of UAV and UAV-C). | + +**Table 6.1.5.4.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| C2Result | M | 1 | 200 OK | The targeted C2 Communication Mode switching for the concerned UAS (i.e. pair of UAV and UAV-C) is successfully received.
The response body shall contain the feedback of the UASS on whether this C2 Communication Mode switching is confirmed (i.e. validated) or not. | +| n/a | | | 204 No Content | The targeted C2 Communication Mode switching for the concerned UAS (i.e. pair of UAV and UAV-C) is successfully received and acknowledged, and the UASS does not need to confirm (i.e. validate) it. | +| 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +**Table 6.1.5.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 UASS towards which the notification should be redirected. | + +**Table 6.1.5.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 UASS towards which the notification should be redirected. | + +## 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 UAE\_C2OperationModeManagement API. + +**Table 6.1.6.1-1: UAE\_C2OperationModeManagement API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ConfigureData | 6.1.6.2.2 | Represents the parameters to request to provision C2 Operation Mode configuration information for a UAS (i.e. pair of UAV and UAV-C). | | +| SelectedC2CommModeNotif | 6.1.6.2.3 | Represents information on the C2 Communication Mode selected by a UAS (i.e. pair of UAV and UAV-C). | | +| C2CommModeSwitchNotif | 6.1.6.2.4 | Represents information on the targeted C2 Communication Mode switching for a UAS (i.e. pair of UAV and UAV-C). | | +| C2LinkQualityThrlds | 6.1.6.2.11 | Represents the C2 link quality thresholds. | | +| C2OpModeMngtCompStatus | 6.1.6.2.9 | Represents the C2 operation mode management completion status for a UAS (i.e. pair of UAV and UAV-C). | | +| C2OpModeStatus | 6.1.6.3.6 | Represents the C2 operation mode management completion status. | | +| C2Result | 6.1.6.2.5 | Represents the result of an action related to C2 of a UAS. | | +| C2ServiceArea | 6.1.6.2.8 | Represents a C2 service area. | | +| C2SwitchPolicies | 6.1.6.2.10 | Represents the C2 operation mode switching policies. | | +| UasId | 6.1.6.2.6 | Represents the identifier of a UAS (i.e. pair of UAV and UAV-C). | | +| UavId | 6.1.6.2.7 | Represents the identifier of a UAV (e.g. UAV, UAV-C). | | +| C2CommMode | 6.1.6.3.3 | Represents the C2 Communication Modes. | | +| C2CommModeSwitching | 6.1.6.3.4 | Represents the C2 Communication Mode Switching types. | | +| C2SwitchingCause | 6.1.6.3.5 | Represents the C2 Communication Mode switching cause. | | + +Table 6.1.6.1-2 specifies data types re-used by the UAE\_C2OperationModeManagement API from other specifications, including a reference to their respective specifications, and when needed, a short description of their use within the UAE\_C2OperationModeManagement API. + +**Table 6.1.6.1-2: UAE\_C2OperationModeManagement API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|--------------------|---------------------------------------------------------------|---------------| +| ExternalGroupId | 3GPP TS 29.122 [2] | Represents an external group identifier. | | +| GeographicArea | 3GPP TS 29.572 [8] | Represents a geographical area. | | +| Gpsi | 3GPP TS 29.571 [7] | Represents a GPSI. | | +| Ncgi | 3GPP TS 29.571 [7] | Represents an NCGI. | | +| PacketLossRate | 3GPP TS 29.571 [7] | Represents the packet loss rate. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features. | | +| Tai | 3GPP TS 29.571 [7] | Represents a tracking area identifier. | | +| Uri | 3GPP TS 29.122 [2] | Represents a URI. | | + +## 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: ConfigureData + +**Table 6.1.6.2.2-1: Definition of type ConfigureData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uassId | Uri | M | 1 | Contains the identity of the UASS communicating the C2 Operation Mode configuration information for a UAS (i.e. pair of UAV and UAV-C). It takes the form of a URI. | | +| uasId | UasId | M | 1 | Contains the identity of the UAS (i.e. pair of UAV and UAV-C) to which the provided C2 Operation Mode configuration information is destined.

This shall be either in the form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| allowedC2CommModes | array(C2CommMode) | M | 1..N | Contains the allowed C2 communication modes for the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute. | | +| c2CommModeSwitchTypes | array(C2CommModeSwitching) | M | 1..N | Contains the C2 Communication Mode switching types to be supported by the UAE Server for the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute.
The possible switching types are:
  • - from "Direct C2 Communication" to "Network-Assisted C2 Communication";
  • - from "Network-Assisted C2 Communication" to "Direct C2 Communication";
  • - from "Direct C2 Communication" to "UTM-Navigated C2 Communication"; and/or
  • - from "Network-Assisted C2 Communication" to "UTM-Navigated C2 Communication".
| | +| notificationUri | Uri | M | 1 | Contains the notification URI via which the UASS desires to receive notifications from the UAE Server. | | +| primaryC2CommMode | C2CommMode | M | 1 | Contains the primary C2 communication mode to be used by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute. It shall be set to either "DIRECT_C2_COMMUNICATION" or "NETWORK_ASSISTED_C2_COMMUNICATION". | | +| secondaryC2CommMode | C2CommMode | O | 0..1 | Contains the secondary C2 communication mode to be used by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute. When provided, it shall be set to either "DIRECT_C2_COMMUNICATION" or "NETWORK_ASSISTED_C2_COMMUNICATION". | | +| c2SwitchPolicies | C2SwitchPolicies | M | 1 | Contains the C2 operation mode switching policies. | | +| c2ServiceArea | C2ServiceArea | O | 0..1 | Contains the service area within which the C2 operation mode management request applies. This shall be either a geographical area or a topological area. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.1.8.

This attribute shall be provided if at least one feature is supported by the UASS. | | + +## 6.1.6.2.3 Type: SelectedC2CommModeNotif + +Table 6.1.6.2.3-1: Definition of type SelectedC2CommModeNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identity of the UAS (i.e. pair of UAV and UAV-C) to which the notification is related.

This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| selPrimaryC2CommMode | C2CommMode | M | 1 | Contains the primary C2 communication mode selected by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute. It shall be set to either "DIRECT_C2_COMMUNICATION" or "NETWORK_ASSISTED_C2_COMMUNICATION". | | +| selSecondaryC2CommMode | C2CommMode | O | 0..1 | Contains the secondary C2 communication mode to be used by the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute. When provided, it shall be set to either "DIRECT_C2_COMMUNICATION" or "NETWORK_ASSISTED_C2_COMMUNICATION". | | + +## 6.1.6.2.4 Type: C2CommModeSwitchNotif + +Table 6.1.6.2.4-1: Definition of type C2CommModeSwitchNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|---------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uaeServerId | Uri | M | 1 | Contains the identifier of the UAE Server that is sending the notification and requesting C2 Communication Mode switching confirmation for a UAS (i.e. pair of UAV and UAV-C) from the UASS. | | +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the provided C2 Communication Mode switching information is related.

This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| c2CommModeSwitchType | C2CommModeSwitching | M | 1 | Contains the targeted C2 Communication Mode switching for the UAS (i.e. pair of UAV and UAV-C) identified by the "uasId" attribute. | | +| switchingCause | C2SwitchingCause | O | 0..1 | Contains the cause that triggers the C2 Communication Mode switching. | | + +## 6.1.6.2.5 Type: C2Result + +Table 6.1.6.2.5-1: Definition of type C2Result + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| c2OpConfirmed | Boolean | M | 1 | This attribute indicates whether the requested action (e.g. targeted C2 Communication Mode switching, C2 Operation Mode configuration information provisioning) is confirmed or not.
  • - "true" means that the requested action is confirmed or approved.
  • - "false" means that the requested action is not confirmed or not approved.
| | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.
This attribute shall be provided by the UAE Server in the response to a request in which the UASS provided the list of features that it supports. | | + +## 6.1.6.2.6 Type: UasId + +Table 6.1.6.2.6-1: Definition of type UasId + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| groupId | ExternalGroupId | C | 0..1 | Contains the identity of a UAS (i.e. a pair of UAV and UAV-C) in the form of a group identifier.
(NOTE) | | +| individualUasId | array(UavId) | C | 0..N | Contains the identity of a UAS (i.e. a pair of UAV and UAV-C) in the form of a collection of individual identifiers of the UAV and UAV-C composing the UAS.
(NOTE) | | + +NOTE: The "groupId" attribute and the "individualUasId" attribute are mutually exclusive. + +## 6.1.6.2.7 Type: UavId + +Table 6.1.6.2.7-1: Definition of type UavId + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | C | 0..1 | Contains the identity of a UAV or UAV-C in the form of a GPSI.
(NOTE) | | +| caald | string | C | 0..1 | Contains the identity of a UAV or UAV-C in the form of a CAA level UAV ID.
(NOTE) | | + +NOTE: At least one of the "groupId" attribute or the "caald" attribute shall be provided within the UavId data type. + +## 6.1.6.2.8 Type: C2ServiceArea + +Table 6.1.6.2.8-1: Definition of type C2ServiceArea + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------|---------------| +| ncgiList | array(Ncgi) | C | 0..N | Contains a list of NR cell identifier(s) that constitutes the C2 service area. | | +| tailList | array(Tai) | C | 0..N | Contains a list of tracking area identifier(s) that constitutes the C2 service area. | | +| geographicAreaList | array(GeographicArea) | C | 0..N | Contains a list of geographic area(s) that constitutes the C2 service area. | | +| NOTE: Either the "geographicAreaList" attribute or the "ncgiList" attribute and/or the "tailList" attribute shall be provided. | | | | | | + +## 6.1.6.2.9 Type: C2OpModeMngtCompStatus + +Table 6.1.6.2.9-1: Definition of type C2OpModeMngtCompStatus + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the provided C2 operation mode management completion status information is related. | | +| status | C2OpModeStatus | M | 1 | Contains the C2 operation mode management completion status. | | + +## 6.1.6.2.10 Type: C2SwitchPolicies + +Table 6.1.6.2.10-1: Definition of type C2SwitchPolicies + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------------------------------------------------------------------------|---------------------|---|-------------|---------------------------------------------------------------------------------------------------------|---------------| +| directC2LinkQualityThrlds | C2LinkQualityThrlds | O | 0..1 | Contains the threshold(s) used to evaluate the quality of the direct C2 link. | | +| uuC2LinkQualityThrlds | C2LinkQualityThrlds | O | 0..1 | Contains the threshold(s) used to evaluate the quality of the Network-Assisted (i.e. Uu based) C2 link. | | +| NOTE: Either the "directC2LinkQualityThrlds" attribute, the "uuC2LinkQualityThrlds" attribute or both shall be provided. | | | | | | + +## 6.1.6.2.11 Type: C2LinkQualityThrlds + +Table 6.1.6.2.11-1: Definition of type C2LinkQualityThrlds + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------|---------------| +| nrRsrpThrldLow | integer | O | 0..1 | Represents the lower RSRP value threshold for the direct C2 link.
Value range: 0-127.
(NOTE 1) | | +| nrRsrpThrldHigh | integer | O | 0..1 | Represents the upper RSRP value threshold for the direct C2 link.
Value range: 0-127.
(NOTE 2) | | +| nrRsrqThrldLow | integer | O | 0..1 | Represents the lower RSRQ value threshold for the direct C2 link.
Value range: 0-127.
(NOTE 1) | | +| nrRsrqThrldHigh | integer | O | 0..1 | Represents the upper RSRQ value threshold for the direct C2 link.
Value range: 0-127.
(NOTE 2) | | +| packetLossThrldLow | PacketLossRate | O | 0..1 | Represents the lower packet loss rate value threshold for the direct C2 link.
(NOTE 1) | | +| packetLossThrldHigh | PacketLossRate | O | 0..1 | Represents the upper packet loss rate value threshold for the direct C2 link.
(NOTE 2) | | + +NOTE 1: At least one of the "nrRsrpThrldLow", "nrRsrqThrldLow" or "packetLossThrldLow" attributes shall be provided. +NOTE 2: At least one of the "nrRsrpThrldHigh", "nrRsrqThrldHigh" or "packetLossThrldHigh" attributes shall be provided. + +## 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: C2CommMode + +The enumeration C2CommMode represents C2 Communication Modes. It shall comply with the provisions of table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration C2CommMode** + +| Enumeration value | Description | Applicability | +|-----------------------------------|----------------------------------------------------|---------------| +| DIRECT_C2_COMMUNICATION | Represents Direct C2 Communication mode. | | +| NETWORK_ASSISTED_C2_COMMUNICATION | Represents Network-Assisted C2 Communication mode. | | +| UTM_NAVIGATED_C2_COMMUNICATION | Represents UTM-Navigated C2 communication mode. | | + +#### 6.1.6.3.4 Enumeration: C2CommModeSwitching + +The enumeration C2CommModeSwitching represents C2 Communication Mode Switching types. It shall comply with the provisions of table 6.1.6.3.4-1. + +**Table 6.1.6.3.4-1: Enumeration C2CommModeSwitching** + +| Enumeration value | Description | Applicability | +|--------------------------------------|------------------------------------------------------------------------------------------------------------------------------------|---------------| +| DIRECT_TO_NETWORK_ASSISTED_C2 | Represents the C2 Communication Mode switching from Direct C2 Communication mode to Network-Assisted C2 Communication mode. | | +| NETWORK_ASSISTED_TO_DIRECT_C2 | Represents the C2 Communication Mode switching from Network-Assisted C2 Communication mode to Direct C2 Communication mode. | | +| DIRECT_TO_UTM_NAVIGATED_C2 | Represents the C2 Communication Mode switching from Direct C2 Communication mode to UTM-Navigated C2 communication mode. | | +| NETWORK_ASSISTED_TO_UTM_NAVIGATED_C2 | Represents the C2 Communication Mode switching from Network-Assisted C2 Communication mode to UTM-Navigated C2 communication mode. | | + +#### 6.1.6.3.5 Enumeration: C2SwitchingCause + +The enumeration C2SwitchingCause represents the C2 Communication Mode switching cause. It shall comply with the provisions of table 6.1.6.3.5-1. + +**Table 6.1.6.3.5-1: Enumeration C2SwitchingCause** + +| Enumeration value | Description | Applicability | +|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| DIRECT_LINK_QUALITY_DEGRADATION | Indicates that the C2 Communication Mode switching was triggered due to a degradation in the direct radio link quality. | | +| DIRECT_LINK_AVAILABLE | Indicates that the C2 Communication Mode switching was triggered due to the availability of a direct link, i.e. direct radio link quality enables its usage. | | +| MOVING_BVLOS | Indicates that the C2 Communication Mode switching was triggered due to the UAV moving BVLOS. | | +| LOCATION_CHANGE | Indicates that the C2 Communication Mode switching was triggered due to an actual or expected location/mobility of the UAV (e.g. which impacts the UAV-to-UAV-C location). | | +| TRAFFIC_CONTROL_NEEDED | Indicates that the C2 Communication Mode switching was triggered due to the necessity to have air traffic control. | | +| SECURITY_REASONS | Indicates that the C2 Communication Mode switching was triggered due to security reasons. | | +| OTHER_REASONS | Indicates that the C2 Communication Mode switching was triggered due to other reasons (e.g. unpredictable event, unknown reason, weather conditions, topography, etc.). | | + +#### 6.1.6.3.6 Enumeration: C2OpModeStatus + +The enumeration C2OpModeStatus represents C2 Operation Mode Management Completion status. It shall comply with the provisions of table 6.1.6.3.6-1. + +**Table 6.1.6.3.6-1: Enumeration C2CommMode** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------------------|---------------| +| SUCCESSFUL | Indicates that the C2 operation mode configuration was successful. | | +| NOT_SUCCESSFUL | Indicates that the C2 operation mode configuration was not successful. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +#### 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 | +|------|----------------|--------------| +| | | | + +## 6.1.7 Error Handling + +### 6.1.7.1 General + +For the UAE\_C2OperationModeManagement API, HTTP error responses shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [2]. Protocol errors and application errors specified in clause 5.2.6 of 3GPP TS 29.122 [2] shall be supported for the HTTP status codes specified in table 5.2.6-1 of 3GPP TS 29.122 [2]. + +In addition, the requirements in the following clauses are applicable for the UAE\_C2OperationModeManagement API. + +### 6.1.7.2 Protocol Errors + +No specific protocol errors for the UAE\_C2OperationModeManagement API are specified. + +### 6.1.7.3 Application Errors + +The application errors defined for the UAE\_C2OperationModeManagement API 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 listed in table 6.1.8-1 are defined for the UAE\_C2OperationModeManagement API. They shall be negotiated using the extensibility mechanism defined in clause 5.2.7 of 3GPP TS 29.122 [2]. + +**Table 6.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.1.9 Security + +The provisions of clause 6 of 3GPP TS 29.122 [2] shall apply for the UAE\_C2OperationModeManagement API. + +## 6.2 UAE\_RealtimeUAVStatus Service API + +### 6.2.1 Introduction + +The UAE\_RealtimeUAVStatus service shall use the UAE\_RealtimeUAVStatus API. + +The API URI of the UAE\_RealtimeUAVStatus API shall be: + +**{apiRoot}/** + +The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [2], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. +- The shall be "uae-uav-status". +- The shall be "v1". +- The shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. + +NOTE: When 3GPP TS 29.122 [2] is referenced for the common protocol and interface aspects for API definition in the clauses under clause 6.2, the UAE Server takes the role of the SCEF and the UASS takes the role of the SCS/AS. + +### 6.2.2 Usage of HTTP + +The provisions of clause 5.2.2 of 3GPP TS 29.122 [2] shall apply for the UAE\_RealtimeUAVStatus API. + +### 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 depicts the resource URIs structure for the UAE\_RealtimeUAVStatus API. + +![Diagram showing the hierarchical structure of Resource URIs for the UAE_RealtimeUAVStatus API. The root URI is {apiRoot}/uae-uav-status/. It branches to /subscriptions, which in turn branches to /{subscriptionId}.](147f857b06606c016ce376b7a89934d2_img.jpg) + +``` +graph TD; A["{apiRoot}/uae-uav-status/"] --> B["/subscriptions"]; B --> C["/{subscriptionId}"]; +``` + +Diagram showing the hierarchical structure of Resource URIs for the UAE\_RealtimeUAVStatus API. The root URI is {apiRoot}/uae-uav-status/. It branches to /subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 6.2.3.1-1: Resource URIs structure of the UAE\_RealtimeUAVStatus API** + +Table 6.2.3.1-1 provides an overview of the resources and applicable HTTP methods for the UAE\_RealtimeUAVStatus API. + +**Table 6.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------------------|---------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------| +| Real-time UAV Status Subscriptions | /subscriptions | GET | Retrieve all the active real-time UAV status subscriptions managed by the UAE Server. | +| | | POST | Request the creation of a subscription to real-time UAV status reporting. | +| Individual Real-time UAV Status Subscription | /subscriptions/{subscriptionId} | GET | Retrieve a real-time UAV status subscription resource identified by the provided subscription identifier. | +| | | PUT | Update an existing real-time UAV status subscription resource identified by the provided subscription identifier. | +| | | DELETE | Request the deletion of a real-time UAV status subscription resource identified by the provided subscription identifier. | + +## 6.2.3.2 Resource: Real-time UAV Status Subscriptions + +### 6.2.3.2.1 Description + +This resource represents the collection of real-time UAV status subscriptions managed by the UAE Server. + +### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/uae-uav-status//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 5.2.4 of 3GPP TS 29.122 [2]. | + +### 6.2.3.2.3 Resource Standard Methods + +#### 6.2.3.2.3.1 GET + +The GET method allows a UASS to retrieve all the active real-time UAV status subscriptions managed by the UAE Server. 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 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.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 GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(RTUavStatusSubsc) | M | 1..N | 200 OK | Successful case. All the active real-time UAV status subscriptions managed by the UAE Server shall be 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 UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +Table 6.2.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 in an alternative UAE Server. | + +Table 6.2.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 in an alternative UAE Server. | + +### 6.2.3.2.3.2 POST + +The POST method allows a UASS to request the creation of a subscription to real-time UAV status reporting at the UAE Server. This method shall support the URI query parameters specified in table 6.2.3.2.3.2-1. + +Table 6.2.3.2.3.2-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.2.3.2.3.2-2 and the response data structures and response codes specified in table 6.2.3.2.3.2-3. + +Table 6.2.3.2.3.2-2: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| RTUavStatusSubsc | M | 1 | Represents the parameters to request the creation of a subscription to real-time UAV status reporting. | + +**Table 6.2.3.2.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RTUavStatusSubsc | M | 1 | 201 Created | Successful case. The subscription is successfully created and a representation of the created Individual Real-time UAV Status Subscription resource shall be returned.
An HTTP "Location" header that contains the resource URI of the created Individual Real-time UAV Status Subscription resource shall also be included. | +| NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. | | | | | + +**Table 6.2.3.2.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}/uae-uav-status//subscriptions/{subscriptionId} | + +#### 6.2.3.2.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +### 6.2.3.3 Resource: Individual Real-time UAV Status Subscription + +#### 6.2.3.3.1 Description + +This resource represents an individual real-time UAV status subscription managed by the UAE Server. + +#### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/uae-uav-status//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 5.2.4 of 3GPP TS 29.122 [2]. | +| subscriptionId | string | Represents the subscription identifier. | + +#### 6.2.3.3.3 Resource Standard Methods + +##### 6.2.3.3.3.1 GET + +The GET method allows a UASS to retrieve a real-time UAV status subscription identified by the subscription identifier included in the request URI (i.e. within the "{subscriptionId}" path segment). 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 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.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 GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RTUavStatusSubsc | M | 1 | 200 OK | Successful case. The requested Individual Real-time UAV Status Subscription resource shall be 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 UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] 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 in an alternative UAE Server. | + +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 in an alternative UAE Server. | + +#### 6.2.3.3.3.2 PUT + +The PUT method allows a UASS to request the update of an existing real-time UAV status subscription identified by the subscription identifier included in the request URI (i.e. within the "{subscriptionId}" path segment). 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 | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| 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 | +|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------| +| RTUavStatusSubsc | M | 1 | Represents the parameters to request the update of an existing subscription to real-time UAV status reporting. | + +**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 | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RTUavStatusSubsc | M | 1 | 200 OK | Successful case. The real-time UAV status subscription is successfully updated and a representation of the updated Individual Real-time UAV Status Subscription resource shall be returned. | +| n/a | | | 204 No Content | Successful case. The real-time UAV status subscription is successfully updated. | +| 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 UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| NOTE: The mandatory HTTP error status code for the HTTP PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] 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 in an alternative UAE Server. | + +**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 in an alternative UAE Server. | + +#### 6.2.3.3.3.3 DELETE + +The DELETE method allows a UASS to request the deletion of an existing real-time UAV status subscription identified by the subscription identifier included in the request URI (i.e. within the "{subscriptionId}" path segment). 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 | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| 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 | Successful case. The real-time UAV status subscription 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 UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server. Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] 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 | An alternative URI of the resource located in an alternative UAE Server. | + +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 | An alternative URI of the resource located in an alternative UAE Server. | + +#### 6.2.3.3.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +### 6.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. + +### 6.2.5 Notifications + +#### 6.2.5.1 General + +Notifications shall comply to clause 5.2.5 of 3GPP TS 29.122 [2]. + +Table 6.2.5.1-1: Notifications overview + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------|------------------------------|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| Real-time UAV Status Notification | {notificationUri}/uav-status | uav-status (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS on the real-time UAV status information. | + +## 6.2.5.2 Real-time UAV Status Notification + +### 6.2.5.2.1 Description + +The Real-time UAV Status Notification is used by a UAE Server to notify a previously subscribed UASS on the real-time UAV status information. + +### 6.2.5.2.2 Target URI + +The Callback URI "{notificationUri}/uav-status" shall be used with the callback URI variables defined in table 6.2.5.2.2-1. + +**Table 6.2.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------| +| notificationUri | Uri | String formatted as a URI containing the Callback URI. | + +### 6.2.5.2.3 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** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-------------------------------------------------| +| RTUavStatusNotif | M | 1 | Represents a real-time UAV status notification. | + +**Table 6.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 | Successful case. The real-time UAV status notification is successfully received and 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] also apply. + +**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 | An alternative URI representing the end point of an alternative UASS towards which the notification should be 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 | An alternative URI representing the end point of an alternative UASS towards which the notification should be 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 UAE\_RealtimeUAVStatus API. + +**Table 6.2.6.1-1: UAE\_RealtimeUAVStatus API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------|----------------|--------------------------------------------------------------------------------------------------------|---------------| +| RTUavStatusSubsc | 6.2.6.2.2 | Represents the parameters to request the creation of a subscription to real-time UAV status reporting. | | +| RTUavStatusNotif | 6.2.6.2.3 | Represents a real-time UAV status notification. | | +| RTUavStatus | 6.2.6.2.4 | Represents real-time UAV status information. | | +| UavNetConnStatus | 6.2.6.2.5 | Represents the UAV network connection status information. | | + +Table 6.2.6.1-2 specifies data types re-used by the UAE\_RealtimeUAVStatus API from other specifications, including a reference to their respective specifications, and when needed, a short description of their use within the UAE\_RealtimeUAVStatus API. + +**Table 6.2.6.1-2: UAE\_RealtimeUAVStatus API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|--------------------|---------------------------------------------------------------|---------------| +| DateTime | 3GPP TS 29.122 [2] | Represents a date and a time. | | +| MonitoringType | 3GPP TS 29.122 [2] | Represents a monitoring event type. | | +| LocationInfo | 3GPP TS 29.122 [2] | Represents user location information. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features. | | +| UavId | Clause 6.1.6.2.7 | Represents a UAV identifier. | | +| Uri | 3GPP TS 29.122 [2] | Represents a URI. | | + +### 6.2.6.2 Structured data types + +#### 6.2.6.2.1 Introduction + +This clause defines the data structures to be used in resource representations. + +## 6.2.6.2.2 Type: RTUavStatusSubsc + +Table 6.2.6.2.2-1: Definition of type RTUavStatusSubsc + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uassId | Uri | M | 1 | Contains the identity of the UASS that is sending the request. It takes the form of a URI. | | +| uavIds | array(UavId) | M | 1..N | Contains the identity of the UAV(s) to which the real-time UAV status subscription is related. | | +| notificationUri | Uri | M | 1 | Contains the notification URI via which the UASS desires to receive real-time UAV status notifications from the UAE Server. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.2.8.

This attribute shall be provided in the HTTP POST request for subscription resource creation and in the associated successful response. | | + +## 6.2.6.2.3 Type: RTUavStatusNotif + +Table 6.2.6.2.3-1: Definition of type RTUavStatusNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| subscriptionId | string | M | 1 | Contains the identifier of the Individual Real-time UAV Status Subscription to which the notification is related. | | +| rTUavStatus | array(RTUavStatus) | M | 1..N | Contains the real-time UAV status information for a UAV. | | + +## 6.2.6.2.4 Type: RTUavStatus + +Table 6.2.6.2.4-1: Definition of type RTUavStatus + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|--------------------------------------------------------------------------------------------|---------------| +| uavId | UavId | M | 1 | Contains the identity of the UAV to which the real-time UAV status information is related. | | +| uavNetConnStatus | UavNetConnStatus | C | 0..1 | Contains the network connection status information for the UAV.
(NOTE) | | +| uavLocInfo | LocationInfo | M | 0..1 | Contains the location information for the UAV.
(NOTE) | | + +NOTE: Either only the "uavLocInfo" attribute or both the "uavNetConnStatus" attribute and the "uavLocInfo" attribute shall be present. + +## 6.2.6.2.5 Type: UavNetConnStatus + +Table 6.2.6.2.5-1: Definition of type UavNetConnStatus + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| statusInfo | MonitoringType | M | 1 | Contains the network connection status monitoring event that occurred.

Only the "LOSS_OF_CONNECTIVITY", "UE_REACHABILITY", "COMMUNICATION_FAILURE" and "PDN_CONNECTIVITY_STATUS" values are applicable. | | +| timestamp | DateTime | M | 1 | Contains the timestamp of the provided network connection status information. | | + +## 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.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +## 6.2.6.5 Binary data + +## 6.2.6.5.1 Binary Data Types + +Table 6.2.6.5.1-1: Binary Data Types + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +## 6.2.7 Error Handling + +## 6.2.7.1 General + +For the UAE\_RealtimeUAVStatus API, HTTP error responses shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [2]. Protocol errors and application errors specified in clause 5.2.6 of 3GPP TS 29.122 [2] shall be supported for the HTTP status codes specified in table 5.2.6-1 of 3GPP TS 29.122 [2]. + +In addition, the requirements in the following clauses are applicable for the UAE\_RealtimeUAVStatus API. + +### 6.2.7.2 Protocol Errors + +No specific protocol errors for the UAE\_RealtimeUAVStatus API are specified. + +### 6.2.7.3 Application Errors + +The application errors defined for the UAE\_RealtimeUAVStatus API are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +### 6.2.8 Feature negotiation + +The optional features listed in table 6.2.8-1 are defined for the UAE\_RealtimeUAVStatus API. They shall be negotiated using the extensibility mechanism defined in clause 5.2.7 of 3GPP TS 29.122 [2]. + +**Table 6.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.2.9 Security + +The provisions of clause 6 of 3GPP TS 29.122 [2] shall apply for the UAE\_RealtimeUAVStatus API. + +## 6.3 UAE\_ChangeUSSManagement Service API + +### 6.3.1 Introduction + +The UAE\_ChangeUSSManagement service shall use the UAE\_ChangeUSSManagement API. + +The API URI of the UAE\_ChangeUSSManagement API shall be: + +**{apiRoot}/** + +The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [2], i.e.: + +**{apiRoot}//** + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. +- The shall be "uae-usschange-mngt". +- The shall be "v1". +- The shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. + +NOTE: When 3GPP TS 29.122 [2] is referenced for the common protocol and interface aspects for API definition in the clauses under clause 6.3, the UAE Server takes the role of the SCEF and the UASS takes the role of the SCS/AS. + +### 6.3.2 Usage of HTTP + +The provisions of clause 5.2.2 of 3GPP TS 29.122 [2] shall apply for the UAE\_ChangeUSSManagement API. + +### 6.3.3 Resources + +#### 6.3.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.3.3.1-1 depicts the resource URIs structure for the UAE\_ChangeUSSManagement API. + +![Diagram showing the resource URI structure for the UAE_ChangeUSSManagement API. The root URI is {apiRoot}/uae-usschange-mngt/. A line descends from this root to a box containing /policies. From the /policies box, another line descends to a box containing /.](0a83cda688278bb05ef5134e66bdaf6e_img.jpg) + +``` +graph TD; Root["{apiRoot}/uae-usschange-mngt/"] --- Policies["/policies"]; Policies --- PolicyId["/"]; +``` + +Diagram showing the resource URI structure for the UAE\_ChangeUSSManagement API. The root URI is {apiRoot}/uae-usschange-mngt/. A line descends from this root to a box containing /policies. From the /policies box, another line descends to a box containing /. + +**Figure 6.3.3.1-1: Resource URIs structure of the UAE\_ChangeUSSManagement API** + +Table 6.3.3.1-1 provides an overview of the resources and applicable HTTP methods for the UAE\_ChangeUSSManagement API. + +Table 6.3.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|------------------------------|----------------------|---------------------------------|-------------------------------------------------------------------------| +| USS Change Policies | /policies | GET | Retrieve all the active USS Change Policies managed by the UAE Server. | +| | | POST | Request the creation of a USS Change Policy. | +| Individual USS Change Policy | /policies/{policyId} | GET | Retrieve an existing "Individual USS Change Policy". | +| | | PUT | Request the update of an existing "Individual USS Change Policy". | +| | | PATCH | Request the modification of an existing "Individual USS Change Policy". | +| | | DELETE | Request the deletion of an existing "Individual USS Change Policy". | + +### 6.3.3.2 Resource: USS Change Policies + +#### 6.3.3.2.1 Description + +This resource represents the collection of USS Change Policies managed by the UAE Server. + +#### 6.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/uae-usschange-mngt//policies + +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 5.2.4 of 3GPP TS 29.122 [2]. | + +#### 6.3.3.2.3 Resource Standard Methods + +##### 6.3.3.2.3.1 GET + +The HTTP GET method allows a UASS to retrieve all the active USS Change Policies managed by the UAE Server. + +This method shall support the URI query parameters specified in table 6.3.3.2.3.1-1. + +Table 6.3.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.3.3.2.3.1-2 and the response data structures and response codes specified in table 6.3.3.2.3.1-3. + +Table 6.3.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.3.3.2.3.1-3: Data structures supported by the GET Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(USSChangePolicy) | M | 1..N | 200 OK | Successful case. All the active USS Change Policies managed by the UAE Server shall be 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.3.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 in an alternative UAE Server. | + +Table 6.3.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 in an alternative UAE Server. | + +### 6.3.3.2.3.2 POST + +The HTTP POST method allows a UASS to request the creation of a USS Change Policy at the UAE Server. + +This method shall support the URI query parameters specified in table 6.3.3.2.3.2-1. + +Table 6.3.3.2.3.2-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.3.3.2.3.2-2 and the response data structures and response codes specified in table 6.3.3.2.3.2-3. + +Table 6.3.3.2.3.2-2: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|---------------------------------------------------------------------------| +| USSChangePolReq | M | 1 | Represents the parameters to request the creation of a USS Change Policy. | + +**Table 6.3.3.2.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USSChangePolResp | M | 1 | 201 Created | Successful case. The USS Change Policy is successfully created and a representation of the created "Individual USS Change Policy" resource shall be returned.
An HTTP "Location" header that contains the resource URI of the created resource shall also be included. | +| NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. | | | | | + +**Table 6.3.3.2.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}/uae-usschange-mngt//policies/{policyId} | + +### 6.3.3.2.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +## 6.3.3.3 Resource: Individual USS Change Policy + +### 6.3.3.3.1 Description + +This resource represents a USS Change Policy managed by the UAE Server. + +### 6.3.3.3.2 Resource Definition + +Resource URI: {apiRoot}/uae-usschange-mngt//policies/{policyId} + +This resource shall support the resource URI variables defined in table 6.3.3.3.2-1. + +**Table 6.3.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4 of 3GPP TS 29.122 [2]. | +| policyId | string | Represents the identifier of the "Individual USS Change Policy". | + +### 6.3.3.3.3 Resource Standard Methods + +#### 6.3.3.3.3.1 GET + +The HTTP GET method allows a UASS to retrieve an existing "Individual USS Change Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.3.3.3.3.1-1. + +**Table 6.3.3.3.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.3.3.3.3.1-2 and the response data structures and response codes specified in table 6.3.3.3.3.1-3. + +Table 6.3.3.3.3.1-2: Data structures supported by the GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.3.3.3.3.1-3: Data structures supported by the GET Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USSChangePolicy | M | 1 | 200 OK | Successful case. The requested "Individual USS Change Policy" resource shall be 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.3.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 in an alternative UAE Server. | + +Table 6.3.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 in an alternative UAE Server. | + +### 6.3.3.3.3.2 PUT + +The HTTP PUT method allows a UASS to request the update of an existing "Individual USS Change Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.3.3.3.3.2-1. + +Table 6.3.3.3.3.2-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 6.3.3.3.3.2-2 and the response data structures and response codes specified in table 6.3.3.3.3.2-3. + +Table 6.3.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|---------------------------------------------------------------------------------------| +| USSChangePolicy | M | 1 | Represents the updated representation of the "Individual USS Change Policy" resource. | + +**Table 6.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USSChangePolicy | M | 1 | 200 OK | Successful case. The "Individual USS Change Policy" resource is successfully updated and a representation of the updated resource shall be returned in the response body. | +| n/a | | | 204 No Content | Successful case. The "Individual USS Change Policy" 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.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 in an alternative UAE Server. | + +**Table 6.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 in an alternative UAE Server. | + +### 6.3.3.3.2 PATCH + +The HTTP PATCH method allows a UASS to request the modification of an existing "Individual USS Change Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.3.3.3.2-1. + +**Table 6.3.3.3.2-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.3.3.3.2-2 and the response data structures and response codes specified in table 6.3.3.3.2-3. + +**Table 6.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------| +| USSChangePolicyPatch | M | 1 | Represents the parameters to request the modification of the "Individual USS Change Policy" resource. | + +**Table 6.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| USSChangePolicy | M | 1 | 200 OK | Successful case. The "Individual USS Change Policy" resource is successfully modified and a representation of the updated resource shall be returned in the response body. | +| n/a | | | 204 No Content | Successful case. The "Individual USS Change Policy" 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.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 in an alternative UAE Server. | + +**Table 6.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 in an alternative UAE Server. | + +#### 6.3.3.3.3.4 DELETE + +The HTTP DELETE method allows a UASS to request the deletion of an existing "Individual USS Change Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.3.3.3.3.4-1. + +**Table 6.3.3.3.3.4-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.3.3.3.3.4-2 and the response data structures and response codes specified in table 6.3.3.3.3.4-3. + +**Table 6.3.3.3.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.3.3.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 | Successful case. The "Individual USS Change Policy" 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.3.3.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 UAE Server. | + +Table 6.3.3.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 UAE Server. | + +### 6.3.3.3.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +## 6.3.4 Custom Operations without associated resources + +### 6.3.4.1 Overview + +The structure of the custom operation URIs of the UAE\_ChangeUSSManagement API is shown in Figure 6.3.4.1-1. + +![Diagram showing the URI structure for the custom operation. A line from the base URI '{apiRoot}/uae-usschange-mngt/' points to a dashed box containing the path '/request-usschange'.](1f5279ac241813966be03158ad92142b_img.jpg) + +{apiRoot}/uae-usschange-mngt/ + +``` + +graph TD + A["{apiRoot}/uae-usschange-mngt/"] --> B["/request-usschange"] + +``` + +Diagram showing the URI structure for the custom operation. A line from the base URI '{apiRoot}/uae-usschange-mngt/' points to a dashed box containing the path '/request-usschange'. + +Figure 6.3.4.1-1: Custom operation URI structure of the UAE\_ChangeUSSManagement API + +Table 6.3.4.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the UAE\_ChangeUSSManagement API. + +**Table 6.3.4.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|------------------|----------------------|--------------------|---------------------------------------------------------| +| RequestUssChange | /request-usschange | POST | Enables a UASS to request USS change to the UAE Server. | + +### 6.3.4.2 Operation: RequestUssChange + +#### 6.3.4.2.1 Description + +The custom operation enables a UASS to request USS change to the UAE Server. + +#### 6.3.4.2.2 Operation Definition + +This operation shall support the request data structures and the response data structures and response codes specified in tables 6.3.4.2.2-1 and 6.3.4.2.2-2. + +**Table 6.3.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|------------------------------------------------| +| USSChangeReq | M | 1 | Contains the parameters to request USS change. | + +**Table 6.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 USS change request is successfully received. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.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 target URI located in an alternative UAE Server. | + +**Table 6.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 target URI located in an alternative UAE Server. | + +## 6.3.5 Notifications + +### 6.3.5.1 General + +Notifications shall comply to clause 5.2.5 of 3GPP TS 29.122 [2]. + +**Table 6.3.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------------------------|------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| USS Change Policy Configuration Status Notification | {notifUri}/usschange-policy | usschange-policy (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS on the status of USS Change Policy configuration. | +| USS Change Notification | {notifUri}/usschange | usschange (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS that a USS change was performed. | +| USS Change Trigger Notification | {notifUri}/usschange-trigger | usschange-trigger (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS that a USS change should be triggered. | + +### 6.3.5.2 USS Change Policy Configuration Status Notification + +#### 6.3.5.2.1 Description + +The USS Change Policy Configuration Status Notification is used by a UAE Server to notify a previously subscribed UASS on the status of USS Change Policy configuration status. + +#### 6.3.5.2.2 Target URI + +The Callback URI "{notifUri}/usschange-policy" shall be used with the callback URI variables defined in table 6.3.5.2.2-1. + +**Table 6.3.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | String formatted as a URI containing the Callback URI.
The notification URI is provided as part of the USS Change Policy creation/update/modification request as defined in clause 6.3.3. | + +#### 6.3.5.2.3 Standard Methods + +##### 6.3.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.3.5.2.3.1-1 and the response data structures and response codes specified in table 6.3.5.2.3.1-2. + +**Table 6.3.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------------|---|-------------|-------------------------------------------------------------------| +| USSChangePolConfigNotif | M | 1 | Represents a USS Change Policy Configuration Status notification. | + +Table 6.3.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 case. The USS Change Policy Configuration Status notification is successfully received and 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.3.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 UASS towards which the notification should be redirected. | + +Table 6.3.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 UASS towards which the notification should be redirected. | + +### 6.3.5.3 USS Change Notification + +#### 6.3.5.3.1 Description + +The USS Change Notification is used by a UAE Server to notify a previously subscribed UASS that a USS change was performed. + +#### 6.3.5.3.2 Target URI + +The Callback URI "{notifUri}/usschange" shall be used with the callback URI variables defined in table 6.3.5.3.2-1. + +Table 6.3.5.3.2-1: Callback URI variables + +| Name | Data type | Definition | +|----------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | String formatted as a URI containing the Callback URI.
The notification URI is provided as part of the USS Change Policy creation/update/modification request as defined in clause 6.3.3. | + +### 6.3.5.3.3 Standard Methods + +#### 6.3.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.3.5.3.3.1-1 and the response data structures and response codes specified in table 6.3.5.3.3.1-2. + +**Table 6.3.5.3.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|---------------------------------------| +| USSChangeNotif | M | 1 | Represents a USS Change notification. | + +**Table 6.3.5.3.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The USS Change notification is successfully received and 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.3.5.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 representing the end point of an alternative UASS towards which the notification should be redirected. | + +**Table 6.3.5.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 representing the end point of an alternative UASS towards which the notification should be redirected. | + +### 6.3.5.4 USS Change Trigger Notification + +#### 6.3.5.4.1 Description + +The USS Change Trigger Notification is used by a UAE Server to notify a previously subscribed UASS that a USS change should be triggered. + +#### 6.3.5.4.2 Target URI + +The Callback URI "{notifUri}/usschange-trigger" shall be used with the callback URI variables defined in table 6.3.5.4.2-1. + +**Table 6.3.5.4.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | String formatted as a URI containing the Callback URI.
The notification URI is provided as part of the USS Change Policy creation/update/modification request as defined in clause 6.3.3. | + +### 6.3.5.4.3 Standard Methods + +#### 6.3.5.4.3.1 POST + +This method shall support the request data structures specified in table 6.3.5.4.3.1-1 and the response data structures and response codes specified in table 6.3.5.4.3.1-2. + +**Table 6.3.5.4.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-----------------------------------------------| +| USSChangeTriggerNotif | M | 1 | Represents a USS Change Trigger notification. | + +**Table 6.3.5.4.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case. The USS Change Trigger notification is successfully received and 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.3.5.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 UASS towards which the notification should be redirected. | + +**Table 6.3.5.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 UASS towards which the notification should be redirected. | + +## 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 UAE\_ChangeUSSManagement API. + +**Table 6.3.6.1-1: UAE\_ChangeUSSManagement API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------|----------------|-------------------------------------------------------------------------------|---------------| +| MultiUssPol | 6.3.6.2.6 | Represents a Multi-USS policy. | | +| UasServArea | 6.3.6.2.7 | Represents a service area (e.g. registration service area) for a UAS. | | +| UasRoute | 6.3.6.2.8 | Represents the a UAS route. | | +| USSChangeNotif | 6.3.6.2.11 | Represents a USS Change notification. | | +| USSChangePolConfigNotif | 6.3.6.2.10 | Represents a USS Change Policy Configuration Status notification. | | +| USSChangePolReq | 6.3.6.2.2 | Represents the parameters to request the creation of a USS Change Policy. | | +| USSChangePolResp | 6.3.6.2.3 | Represents the response to a USS Change Policy create request. | | +| USSChangePolicy | 6.3.6.2.4 | Represents a USS Change Policy. | | +| USSChangePolicyPatch | 6.3.6.2.5 | Represents the parameters to request the modification of a USS Change Policy. | | +| USSChangeReq | 6.3.6.2.9 | Represents the parameters to request for USS change. | | +| USSChangeTriggerNotif | 6.3.6.2.12 | Represents a USS Change Trigger notification. | | + +Table 6.3.6.1-2 specifies data types re-used by the UAE\_ChangeUSSManagement API from other specifications, including a reference to their respective specifications, and when needed, a short description of their use within the UAE\_ChangeUSSManagement API. + +**Table 6.3.6.1-2: UAE\_ChangeUSSManagement API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|--------------------|---------------------------------------------------------------|---------------| +| GeographicArea | 3GPP TS 29.572 [8] | Represents a geographical area. | | +| Ncgi | 3GPP TS 29.571 [7] | Represents an NCGI. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features. | | +| Tai | 3GPP TS 29.571 [7] | Represents a tracking area identifier. | | +| UasId | Clause 6.1.6.2.6 | Represents a UAV identifier. | | +| Uri | 3GPP TS 29.122 [2] | Represents a URI. | | + +### 6.3.6.2 Structured data types + +#### 6.3.6.2.1 Introduction + +This clause defines the data structures to be used in resource representations. + +## 6.3.6.2.2 Type: USSChangePolReq + +Table 6.3.6.2.2-1: Definition of type USSChangePolReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uassId | Uri | M | 1 | Contains the identity of the UASS that is sending the request. | | +| ussChangePol | USSChangePolicy | M | 1 | Contains the USS Change Policy that shall be created. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.3.8.
This attribute shall be provided if feature negotiation shall take place. | | + +## 6.3.6.2.3 Type: USSChangePolResp + +Table 6.3.6.2.3-1: Definition of type USSChangePolResp + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ussChangePol | USSChangePolicy | M | 1 | Contains the created USS Change Policy. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.3.8.
This attribute shall be provided if feature negotiation shall take place and this attribute was present in the corresponding request. | | + +## 6.3.6.2.4 Type: USSChangePolicy + +Table 6.3.6.2.4-1: Definition of type USSChangePolicy + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the provided USS Change Policy is related.
This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| notifUri | Uri | M | 1 | Contains the notification URI via which the UASS desires to receive USS Change management related notifications from the UAE Server. | | +| uasRegArea | UasServArea | O | 0..1 | Contains the registration area within which the UAS is allowed to fly. | | +| uasAllowedRoute | UasRoute | O | 0..1 | Contains the allowed route for the UAS within the UAS registration area provided by the "uasRegArea" attribute.
This attribute shall be present only if the "uasRegArea" attribute is present. | | +| multiUssPol | MultiUssPol | O | 0..1 | Contains the multi-USS policy management container consisting of the requirements and policies for multi-USS management. | | + +Editor's Note: The full content of the USSChangePolicy data structure is FFS. + +## 6.3.6.2.5 Type: USSChangePolicyPatch + +Table 6.3.6.2.5-1: Definition of type USSChangePolicyPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifUri | Uri | O | 0..1 | Contains the updated notification URI via which the UASS desires to receive USS Change management related notifications from the UAE Server. | | +| uasRegArea | UasServArea | O | 0..1 | Contains the updated registration area within which the UAS is allowed to fly. | | +| uasAllowedRoute | UasRoute | O | 0..1 | Contains the updated allowed route for the UAS within the UAS registration area provided by the "uasRegArea" attribute.

This attribute shall be present only if the "uasRegArea" attribute is present. | | +| multiUssPol | MultiUssPol | O | 0..1 | Contains the updated multi-USS policy management container. | | + +Editor's Note: The full content of the USSChangePolicyPatch data structure is FFS. + +## 6.3.6.2.6 Type: MultiUssPol + +Table 6.3.6.2.6-1: Definition of type MultiUssPol + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| | | | 1 | | | + +Editor's Note: The definition of the MultiUssPol data structure is FFS. + +## 6.3.6.2.7 Type: UasServArea + +Table 6.3.6.2.7-1: Definition of type UasServArea + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| ncgiList | array(Ncgi) | C | 1..N | Contains a list of NR cell identifier(s) that constitutes the service area. | | +| tailList | array(Tai) | C | 1..N | Contains a list of tracking area identifier(s) that constitutes the service area. | | +| geographicAreaList | array(GeographicArea) | C | 1..N | Contains a list of geographic area(s) that constitutes the service area. | | +| NOTE: Either the "geographicAreaList" attribute, or the "ncgiList" attribute and/or the "tailList" attribute shall be provided. | | | | | | + +Editor's Note: The content of the UasServArea data structure is FFS. + +## 6.3.6.2.8 Type: UasRoute + +Table 6.3.6.2.8-1: Definition of type UasRoute + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| | | | 1 | | | + +Editor's Note: The definition of the UasRoute data structure is FFS. + +## 6.3.6.2.9 Type: USSChangeReq + +Table 6.3.6.2.9-1: Definition of type USSChangeReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uassId | Uri | M | 1 | Contains the identity of the UASS that is sending the request. | | +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the USS change request is related.
This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.3.8.
This attribute shall be provided if feature negotiation shall take place. | | + +Editor's Note: The full content of the USSChangeReq data structure is FFS. + +## 6.3.6.2.10 Type: USSChangePolConfigNotif + +Table 6.3.6.2.10-1: Definition of type USSChangePolConfigNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the USS Change Policy configuration notification is related.
This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| multiUssPol | MultiUssPol | O | 0..1 | Contains the multi-USS policy management container consisting of the requirements and policies for multi-USS management. | | + +Editor's Note: The full content of the USSChangePolConfigNotif data structure is FFS. + +## 6.3.6.2.11 Type: USSChangeNotif + +Table 6.3.6.2.11-1: Definition of type USSChangeNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| | | | | | | + +Editor's Note: The definition of the USSChangeNotif data structure is FFS. + +## 6.3.6.2.12 Type: USSChangeTriggerNotif + +Table 6.3.6.2.12-1: Definition of type USSChangeTriggerNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| | | | | | | + +Editor's Note: The definition of the USSChangeTriggerNotif data structure is FFS. + +### 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 + +The simple data types defined in table 6.3.6.3.2-1 shall be supported. + +**Table 6.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +### 6.3.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +### 6.3.6.5 Binary data + +#### 6.3.6.5.1 Binary Data Types + +**Table 6.3.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +## 6.3.7 Error Handling + +### 6.3.7.1 General + +For the UAE\_ChangeUSSManagement API, HTTP error responses shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [2]. Protocol errors and application errors specified in clause 5.2.6 of 3GPP TS 29.122 [2] shall be supported for the HTTP status codes specified in table 5.2.6-1 of 3GPP TS 29.122 [2]. + +In addition, the requirements in the following clauses are applicable for the UAE\_ChangeUSSManagement API. + +### 6.3.7.2 Protocol Errors + +No specific protocol errors for the UAE\_ChangeUSSManagement API are specified. + +### 6.3.7.3 Application Errors + +The application errors defined for the UAE\_ChangeUSSManagement API are listed in Table 6.3.7.3-1. + +**Table 6.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +### 6.3.8 Feature negotiation + +The optional features listed in table 6.3.8-1 are defined for the UAE\_ChangeUSSManagement API. They shall be negotiated using the extensibility mechanism defined in clause 5.2.7 of 3GPP TS 29.122 [2]. + +**Table 6.3.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +### 6.3.9 Security + +The provisions of clause 6 of 3GPP TS 29.122 [2] shall apply for the UAE\_ChangeUSSManagement API. + +## 6.4 UAE\_DAASupport Service API + +### 6.4.1 Introduction + +The UAE\_DAASupport service shall use the UAE\_DAASupport API. + +The API URI of the UAE\_DAASupport Service API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP requests shall have the Resource URI structure defined in clause 5.2.4 of 3GPP TS 29.122 [2], i.e.: + +**{apiRoot}///** + +with the following components: + +- The {apiRoot} shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. +- The shall be "uae-daa". +- The shall be "v1". +- The shall be set as described in clause 5.2.4 of 3GPP TS 29.122 [2]. + +NOTE: When 3GPP TS 29.122 [2] is referenced for the common protocol and interface aspects for API definition in the clauses under clause 6.4, the UAE Server takes the role of the SCEF and the UASS takes the role of the SCS/AS. + +### 6.4.2 Usage of HTTP + +The provisions of clause 5.2.2 of 3GPP TS 29.122 [2] shall apply for the UAE\_DAASupport API. + +### 6.4.3 Resources + +#### 6.4.3.1 Overview + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.4.3.1-1 depicts the resource URIs structure for the UAE\_DAASupport API. + +![Diagram showing the resource URI structure for the UAE_DAASupport API. The root URI is {apiRoot}/uae-daa/. It branches to /policies, which further branches to /{policyId}.](3d53d3bbe5b70dfc8d612c63b9587837_img.jpg) + +``` +graph TD; Root["{apiRoot}/uae-daa/"] --- Policies["/policies"]; Policies --- PolicyId["/{policyId}"]; +``` + +Diagram showing the resource URI structure for the UAE\_DAASupport API. The root URI is {apiRoot}/uae-daa/. It branches to /policies, which further branches to /{policyId}. + +**Figure 6.4.3.1-1: Resource URIs structure of the UAE\_DAASupport API** + +Table 6.4.3.1-1 provides an overview of the resources and applicable HTTP methods for the UAE\_DAASupport API. + +Table 6.4.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------|----------------------|---------------------------------|------------------------------------------------------------------| +| DAA Policies | /policies | GET | Retrieve all the active DAA Policies managed by the UAE Server. | +| | | POST | Request the creation of a DAA Policy. | +| Individual DAA Policy | /policies/{policyId} | GET | Retrieve an existing "Individual DAA Policy". | +| | | PUT | Request the update of an existing "Individual DAA Policy". | +| | | PATCH | Request the modification of an existing "Individual DAA Policy". | +| | | DELETE | Request the deletion of an existing "Individual DAA Policy". | + +## 6.4.3.2 Resource: DAA Policies + +### 6.4.3.2.1 Description + +This resource represents the collection of DAA Policies managed by the UAE Server. + +### 6.4.3.2.2 Resource Definition + +Resource URI: {apiRoot}/uae-daa//policies + +This resource shall support the resource URI variables defined in table 6.4.3.2.2-1. + +Table 6.4.3.2.2-1: Resource URI variables for this resource + +| Name | Data type | Definition | +|---------|-----------|-----------------------------------------| +| apiRoot | string | See clause 5.2.4 of 3GPP TS 29.122 [2]. | + +### 6.4.3.2.3 Resource Standard Methods + +#### 6.4.3.2.3.1 GET + +The HTTP GET method allows a UASS to retrieve all the active DAA Policies managed by the UAE Server. + +This method shall support the URI query parameters specified in table 6.4.3.2.3.1-1. + +Table 6.4.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.4.3.2.3.1-2 and the response data structures and response codes specified in table 6.4.3.2.3.1-3. + +Table 6.4.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.4.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(DAAPolicy) | M | 1..N | 200 OK | Successful case. All the active DAA Policies managed by the UAE Server shall be 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.4.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 in an alternative UAE Server. | + +**Table 6.4.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 in an alternative UAE Server. | + +#### 6.4.3.2.3.2 POST + +The HTTP POST method allows a UASS to request the creation of a DAA Policy at the UAE Server. + +This method shall support the URI query parameters specified in table 6.4.3.2.3.2-1. + +**Table 6.4.3.2.3.2-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.4.3.2.3.2-2 and the response data structures and response codes specified in table 6.4.3.2.3.2-3. + +**Table 6.4.3.2.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|--------------------------------------------------------------------| +| DAAPolReq | M | 1 | Represents the parameters to request the creation of a DAA Policy. | + +**Table 6.4.3.2.3.2-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DAAPolResp | M | 1 | 201 Created | Successful case. The DAA Policy is successfully created and a representation of the created "Individual DAA Policy" resource shall be returned.
An HTTP "Location" header that contains the resource URI of the created resource shall also be included. | +| NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. | | | | | + +**Table 6.4.3.2.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}/uae-daa//policies/{policyId} | + +#### 6.4.3.2.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +### 6.4.3.3 Resource: Individual DAA Policy + +#### 6.4.3.3.1 Description + +This resource represents a DAA Policy managed by the UAE Server. + +#### 6.4.3.3.2 Resource Definition + +Resource URI: {apiRoot}/uae-daa//policies/{policyId} + +This resource shall support the resource URI variables defined in table 6.4.3.3.2-1. + +**Table 6.4.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------|-----------|--------------------------------------------------------------------| +| apiRoot | string | See clause 5.2.4 of 3GPP TS 29.122 [2]. | +| policyId | string | Represents the identifier of the "Individual DAA Policy" resource. | + +#### 6.4.3.3.3 Resource Standard Methods + +##### 6.4.3.3.3.1 GET + +The HTTP GET method allows a UASS to retrieve an existing "Individual DAA Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.4.3.3.3.1-1. + +**Table 6.4.3.3.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.4.3.3.3.1-2 and the response data structures and response codes specified in table 6.4.3.3.3.1-3. + +Table 6.4.3.3.3.1-2: Data structures supported by the GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.4.3.3.3.1-3: Data structures supported by the GET Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DAAPolicy | M | 1 | 200 OK | Successful case. The requested "Individual DAA Policy" resource shall be 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP GET method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.4.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 in an alternative UAE Server. | + +Table 6.4.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 in an alternative UAE Server. | + +#### 6.4.3.3.3.2 PUT + +The HTTP PUT method allows a UASS to request the update of an existing "Individual DAA Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.4.3.3.3.2-1. + +Table 6.4.3.3.3.2-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 6.4.3.3.3.2-2 and the response data structures and response codes specified in table 6.4.3.3.3.2-3. + +Table 6.4.3.3.3.2-2: Data structures supported by the PUT Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|--------------------------------------------------------------------------------| +| DAAPolicy | M | 1 | Represents the updated representation of the "Individual DAA Policy" resource. | + +**Table 6.4.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DAAPolicy | M | 1 | 200 OK | Successful case. The "Individual DAA Policy" resource is successfully updated and a representation of the updated resource shall be returned in the response body. | +| n/a | | | 204 No Content | Successful case. The "Individual DAA Policy" 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP PUT method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.4.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 in an alternative UAE Server. | + +**Table 6.4.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 in an alternative UAE Server. | + +#### 6.4.3.3.3.2 PATCH + +The HTTP PATCH method allows a UASS to request the modification of an existing "Individual DAA Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.4.3.3.3.2-1. + +**Table 6.4.3.3.3.2-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.4.3.3.3.2-2 and the response data structures and response codes specified in table 6.4.3.3.3.2-3. + +**Table 6.4.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|------------------------------------------------------------------------------------------------| +| DAAPolicyPatch | M | 1 | Represents the parameters to request the modification of the "Individual DAA Policy" resource. | + +**Table 6.4.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DAAPolicy | M | 1 | 200 OK | Successful case. The "Individual DAA Policy" resource is successfully modified and a representation of the updated resource shall be returned in the response body. | +| n/a | | | 204 No Content | Successful case. The "Individual DAA Policy" 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP PATCH method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.4.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 in an alternative UAE Server. | + +**Table 6.4.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 in an alternative UAE Server. | + +#### 6.4.3.3.3.4 DELETE + +The HTTP DELETE method allows a UASS to request the deletion of an existing "Individual DAA Policy" resource at the UAE Server. + +This method shall support the URI query parameters specified in table 6.4.3.3.3.4-1. + +**Table 6.4.3.3.3.4-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.4.3.3.3.4-2 and the response data structures and response codes specified in table 6.4.3.3.3.4-3. + +**Table 6.4.3.3.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +Table 6.4.3.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 | Successful case. The "Individual DAA Policy" 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP DELETE method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.4.3.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 UAE Server. | + +Table 6.4.3.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 UAE Server. | + +#### 6.4.3.3.4 Resource Custom Operations + +There are no resource custom operations defined for this resource in this release of the specification. + +### 6.4.4 Custom Operations without associated resources + +#### 6.4.4.1 Overview + +The structure of the custom operation URIs of the UAE\_DAASupport API is shown in Figure 6.4.4.1-1. + +![Diagram showing the custom operation URI structure of the UAE_DAASupport API. The base URI is {apiRoot}/uae-daa/. A line branches from the end of the base URI to a dashed box containing the custom operation path /inform-events.](96b5a08abda472c0c3838ecf1357f57f_img.jpg) + +``` + + {apiRoot}/uae-daa/ + | + +----- /inform-events + +``` + +Diagram showing the custom operation URI structure of the UAE\_DAASupport API. The base URI is {apiRoot}/uae-daa/. A line branches from the end of the base URI to a dashed box containing the custom operation path /inform-events. + +Figure 6.4.4.1-1: Custom operation URI structure of the UAE\_DAASupport API + +Table 6.4.4.1-1 provides an overview of the custom operations and applicable HTTP methods defined for the UAE\_DAASupport API. + +**Table 6.4.4.1-1: Custom operations without associated resources** + +| Operation name | Custom operation URI | Mapped HTTP method | Description | +|-----------------|----------------------|--------------------|------------------------------------------------------------------------| +| InformDAAEvents | /inform-events | POST | Enables a UASS to inform about and manage possible DAA related events. | + +## 6.4.4.2 Operation: InformDAAEvents + +### 6.4.4.2.1 Description + +The custom operation enables a UASS to inform about and request the management of possible DAA related events to the UAE Server. + +### 6.4.4.2.2 Operation Definition + +This operation shall support the request data structures and the response data structures and response codes specified in tables 6.4.4.2.2-1 and 6.4.4.2.2-2. + +**Table 6.4.4.2.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|----------------------------------------------------------------------------------------------------| +| InformDAAEvents Req | M | 1 | Contains the parameters to inform about and request the management of possible DAA related events. | + +**Table 6.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 | Successful case. The request is successfully received. | +| n/a | | | 307 Temporary Redirect | Temporary redirection. The response shall include a Location header field containing an alternative target URI located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| n/a | | | 308 Permanent Redirect | Permanent redirection. The response shall include a Location header field containing an alternative target URI located in an alternative UAE Server.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status code for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +**Table 6.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 target URI located in an alternative UAE Server. | + +**Table 6.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 target URI located in an alternative UAE Server. | + +## 6.4.5 Notifications + +### 6.4.5.1 General + +Notifications shall comply to clause 5.2.5 of 3GPP TS 29.122 [2]. + +**Table 6.4.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------------------------------|-----------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| DAA Policy Configuration Completion Status Notification | {notifUri}/daa-policy | daa-policy (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS on the status of DAA Policy configuration. | +| DAA Event Notification | {notifUri}/daa-events | daa-events (POST) | This service operation enables a UAE Server to notify a previously subscribed UASS of DAA related event(s). | + +### 6.4.5.2 DAA Policy Configuration Completion Status Notification + +#### 6.4.5.2.1 Description + +The DAA Policy Configuration Completion Status Notification is used by a UAE Server to notify a previously subscribed UASS on the status of DAA Policy configuration. + +#### 6.4.5.2.2 Target URI + +The Callback URI "{notifUri}/daa-policy" shall be used with the callback URI variables defined in table 6.4.5.2.2-1. + +**Table 6.4.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | String formatted as a URI containing the Callback URI.
The notification URI is provided as part of the DAA Policy creation/update/modification request as defined in clause 6.4.3. | + +#### 6.4.5.2.3 Standard Methods + +##### 6.4.5.2.3.1 POST + +This method shall support the request data structures specified in table 6.4.5.2.3.1-1 and the response data structures and response codes specified in table 6.4.5.2.3.1-2. + +**Table 6.4.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|------------------------------------------------------------| +| DAAPolConfigNotif | M | 1 | Represents a DAA Policy Configuration Status notification. | + +Table 6.4.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 case. The DAA Policy Configuration Status notification is successfully received and 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.4.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 UASS towards which the notification should be redirected. | + +Table 6.4.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 UASS towards which the notification should be redirected. | + +## 6.4.5.3 DAA Event Notification + +### 6.4.5.3.1 Description + +The DAA Event Notification is used by a UAE Server to notify a previously subscribed UASS of DAA related event(s). + +### 6.4.5.3.2 Target URI + +The Callback URI "{notifUri}/daa-events" shall be used with the callback URI variables defined in table 6.4.5.3.2-1. + +Table 6.4.5.3.2-1: Callback URI variables + +| Name | Data type | Definition | +|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | String formatted as a URI containing the Callback URI.
The notification URI is provided as part of the DAA Policy creation/update/modification request as defined in clause 6.4.3. | + +### 6.4.5.3.3 Standard Methods + +#### 6.4.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.4.5.3.3.1-1 and the response data structures and response codes specified in table 6.4.5.3.3.1-2. + +Table 6.4.5.3.3.1-1: Data structures supported by the POST Request Body + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|--------------------------------------| +| DAAEventsInfo | M | 1 | Represents a DAA Event notification. | + +Table 6.4.5.3.3.1-2: Data structures supported by the POST Response Body + +| Data type | P | Cardinality | Response codes | Description | +|---------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| DAAEventsInfo | M | 1 | 200 OK | Successful case. The DAA event notification is successfully received and acknowledged, and the UASS returns updated/additional DAA related event information in the response body. | +| n/a | | | 204 No Content | Successful case. The DAA event notification is successfully received and 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | +| 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 UASS where the notification should be sent.
Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [2]. | + +NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [2] shall also apply. + +Table 6.4.5.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 representing the end point of an alternative UASS towards which the notification should be redirected. | + +Table 6.4.5.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 representing the end point of an alternative UASS towards which the notification should be redirected. | + +## 6.4.6 Data Model + +### 6.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.6.1-1 specifies the data types defined for the UAE\_DAASupport API. + +**Table 6.4.6.1-1: UAE\_DAASupport API specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------------|----------------|------------------------------------------------------------------------|---------------| +| DAAAppPolicy | 6.4.6.2.6 | Represents a DAA Application policy. | | +| DAAEvent | 6.4.6.2.10 | Represents a DAA related event. | | +| DAAEventsInfo | 6.4.6.2.9 | Represents a DAA Event notification. | | +| DAAPolConfigNotif | 6.4.6.2.8 | Represents a DAA Policy Configuration Status notification. | | +| DAAPolReq | 6.4.6.2.2 | Represents the parameters to request the creation of a DAA Policy. | | +| DAAPolResp | 6.4.6.2.3 | Represents the response to a DAA Policy create request. | | +| DAAPolicy | 6.4.6.2.4 | Represents the content of a DAA Policy. | | +| DAAPolicyPatch | 6.4.6.2.5 | Represents the parameters to request the modification of a DAA Policy. | | +| InformDAAEventsReq | 6.4.6.2.7 | Represents the parameters to report DAA related event(s). | | + +Table 6.4.6.1-2 specifies data types re-used by the UAE\_DAASupport API from other specifications, including a reference to their respective specifications, and when needed, a short description of their use within the UAE\_DAASupport API. + +**Table 6.4.6.1-2: UAE\_DAASupport API re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------|--------------------|---------------------------------------------------------------|---------------| +| LocationInfo | 3GPP TS 29.122 [2] | Represents user location information. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features. | | +| UasId | Clause 6.1.6.2.6 | Represents a UAV identifier. | | +| Uri | 3GPP TS 29.122 [2] | Represents a URI. | | + +## 6.4.6.2 Structured data types + +### 6.4.6.2.1 Introduction + +This clause defines the data structures to be used in resource representations. + +### 6.4.6.2.2 Type: DAAPolReq + +**Table 6.4.6.2.2-1: Definition of type DAAPolReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uassId | Uri | M | 1 | Contains the identity of the UASS that is sending the request. | | +| daaPol | DAAPolicy | M | 1 | Contains the DAA Policy that shall be created. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.4.8.

This attribute shall be provided if feature negotiation shall take place. | | + +## 6.4.6.2.3 Type: DAAPolResp + +Table 6.4.6.2.3-1: Definition of type DAAPolResp + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| daaPol | DAAPolicy | M | 1 | Contains the created DAA Policy. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.4.8.

This attribute shall be provided if feature negotiation shall take place and this attribute was present in the corresponding request. | | + +## 6.4.6.2.4 Type: DAAPolicy + +Table 6.4.6.2.4-1: Definition of type DAAPolicy + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the provided DAA Policy is related.

This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| notifUri | Uri | M | 1 | Contains the notification URI via which the UASS desires to receive DAA related notifications from the UAE Server. | | +| daaAppPol | DAAppPolicy | C | 0..1 | Contains the DAA Application policy consisting of the requirements and policies for DAA management.

This attribute shall be provided when available. | | + +## 6.4.6.2.5 Type: DAAPolicyPatch + +Table 6.4.6.2.5-1: Definition of type DAAPolicyPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------|---------------| +| notifUri | Uri | O | 0..1 | Contains the updated notification URI via which the UASS desires to receive DAA related notifications from the UAE Server. | | +| daaAppPol | DAAppPolicy | O | 0..1 | Contains the updated DAA Application policy. | | + +## 6.4.6.2.6 Type: DAAppPolicy + +Table 6.4.6.2.6-1: Definition of type DAAppPolicy + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------|---------------| +| | | | 1 | | | + +Editor's Note: The definition of the DAAppPolicy data structure is FFS. + +## 6.4.6.2.7 Type: InformDAAEventsReq + +Table 6.4.6.2.7-1: Definition of type InformDAAEventsReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uassId | Uri | M | 1 | Contains the identity of the UASS that is sending the request. | | +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the DAA event information management request is related.
This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| daaEventsInfo | array(DAAEvent) | M | 1..N | Contains the detected DAA event information. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.4.8.
This attribute shall be provided if feature negotiation shall take place. | | + +## 6.4.6.2.8 Type: DAAPolConfigNotif + +Table 6.4.6.2.8-1: Definition of type DAAPolConfigNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------|---------------| +| status | DAAPolConfigStatus | M | 1 | Contains the DAA Policy configuration completion status. | | + +## 6.4.6.2.9 Type: DAAEventsInfo + +Table 6.4.6.2.9-1: Definition of type DAAEventsInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) to which the DAA event information management request is related.
This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| daaEventsInfo | array(DAAEvent) | M | 1..N | Contains the detected DAA event information. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the list of supported features among the ones defined in clause 6.4.8.
This attribute shall be provided if feature negotiation shall take place. | | + +## 6.4.6.2.10 Type: DAAEvent + +Table 6.4.6.2.10-1: Definition of type DAAEvent + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uasId | UasId | M | 1 | Contains the identifier of the UAS (i.e. pair of UAV and UAV-C) for which a potential flight path conflict is detected.
This shall be either in form of a UAS identifier (e.g. group ID) or a collection of individual identifiers (e.g. CAA level UAV ID, GPSI) of the UAV and UAV-C composing the UAS. | | +| uasLocInfo | LocationInfo | M | 1 | Contains the location information of the UAS with which a potential flight path conflict is detected. | | + +## 6.4.6.3 Simple data types and enumerations + +## 6.4.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.4.6.3.2 Simple data types + +The simple data types defined in table 6.4.6.3.2-1 shall be supported. + +Table 6.4.6.3.2-1: Simple data types + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +## 6.4.6.3.3 Enumeration: DAAPolConfigStatus + +The enumeration DAAPolConfigStatus represents DAA Policy configuration completion status. It shall comply with the provisions of table 6.4.6.3.3-1. + +Table 6.4.6.3.3-1: Enumeration DAAPolConfigStatus + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------|---------------| +| SUCCESSFUL | Indicates that the DAA Policy configuration was successful. | | +| NOT_SUCCESSFUL | Indicates that the DAA Policy configuration was not successful. | | + +## 6.4.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this release of the specification. + +## 6.4.6.5 Binary data + +### 6.4.6.5.1 Binary Data Types + +**Table 6.4.6.5.1-1: Binary Data Types** + +| Name | Clause defined | Content type | +|------|----------------|--------------| +| | | | + +## 6.4.7 Error Handling + +### 6.4.7.1 General + +For the UAE\_DAASupport API, HTTP error responses shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [2]. Protocol errors and application errors specified in clause 5.2.6 of 3GPP TS 29.122 [2] shall be supported for the HTTP status codes specified in table 5.2.6-1 of 3GPP TS 29.122 [2]. + +In addition, the requirements in the following clauses are applicable for the UAE\_DAASupport API. + +### 6.4.7.2 Protocol Errors + +No specific protocol errors for the UAE\_DAASupport API are specified. + +### 6.4.7.3 Application Errors + +The application errors defined for the UAE\_DAASupport API are listed in Table 6.4.7.3-1. + +**Table 6.4.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 6.4.8 Feature negotiation + +The optional features listed in table 6.4.8-1 are defined for the UAE\_DAASupport API. They shall be negotiated using the extensibility mechanism defined in clause 5.2.7 of 3GPP TS 29.122 [2]. + +**Table 6.4.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 6.4.9 Security + +The provisions of clause 6 of 3GPP TS 29.122 [2] shall apply for the UAE\_DAASupport API. + +## 7 Using Common API Framework + +### 7.1 General + +When CAPIF is used with a UAE Server service, the UAE Server shall support the following functionalities as defined in 3GPP TS 29.222 [10]: + +- the API exposing function and the related APIs over CAPIF-2/2e and CAPIF-3/3e reference points; +- the API publishing function and the related APIs over CAPIF-4/4e reference point; +- the API management function and the related APIs over CAPIF-5/5e reference point; and +- at least one of the security methods for authentication and authorization, and the related security mechanisms. + +In a centralized deployment as defined in 3GPP TS 23.222 [9], where the CAPIF core function and the API provider domain functions are co-located, the interactions between the CAPIF core function and the API provider domain functions may be independent of the CAPIF-3/3e, CAPIF-4/4e and CAPIF-5/5e reference points. + +When CAPIF is used with a UAE Server service, the UAE Server shall register all the northbound APIs features in the CAPIF Core Function. + +### 7.2 Security + +When CAPIF is used for external exposure, before invoking an API exposed by the UAE Server, the service API consumer (e.g. UASS) acting as an API invoker shall negotiate the security method (PKI, TLS-PSK or OAuth 2.0) with the CAPIF core function and ensure that the UAE Server has enough credentials to authenticate the service API consumer (e.g. UASS), as defined in clauses 5.6.2.2 and 6.2.2.2 of 3GPP TS 29.222 [10]. + +If PKI or TLS-PSK is selected as the security method to be used between the service API consumer (e.g. UASS) and the UAE Server, upon API invocation, the UAE Server shall retrieve the authorization information from the CAPIF core function as described in clause 5.6.2.4 of 3GPP TS 29.222 [10]. + +As indicated in 3GPP TS 33.122 [11], the access to the UAE Server APIs may be authorized by means of the OAuth 2.0 protocol (see IETF RFC 6749 [12]), using the "Client Credentials" authorization grant, where the CAPIF core function (see 3GPP TS 29.222 [10]) plays the role of the authorization server. + +NOTE 1: In this release, only "Client Credentials" authorization grant is supported. + +If OAuth 2.0 is selected as the security method to be used between the service API consumer (e.g. UASS) and the UAE Server, the service API consumer (e.g. UASS) shall, prior to consuming the services offered by the UAE Server APIs, obtain a "token" from the authorization server, by invoking the Obtain\_Authorization service operation as described in clause 5.6.2.3.2 of 3GPP TS 29.222 [10]. + +The UAE Server APIs do not define any scopes for OAuth 2.0 authorization. It is the UAE Server responsibility to check whether the service API consumer (e.g. UASS) is authorized to use an API based on the provided "token". Once the UAE Server verifies the "token", it shall check whether the UAE 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 service API consumer (e.g. UASS) has full authority to access any resource or operation provided by the invoked API. + +NOTE 2: For the aforementioned security methods, the UAE Server needs to apply admission control according to access control policies after performing the authorization checks. + +--- + +## 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 [3] and clause 5B of 3GPP TR 21.900 [5]). + +## A.2 UAE\_C2OperationModeManagement API + +``` +openapi: 3.0.0 + +info: + title: UAE Server C2 Operation Mode Management Service + version: 1.1.0-alpha.1 + description: | + UAE Server C2 Operation Mode Management Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.257 V18.1.0; Application layer support for Uncrewed Aerial System (UAS); + UAS Application Enabler (UAE) Server Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.257/ + +servers: + - url: '{apiRoot}/uae-c2opmode-mngt/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /initiate: + post: + summary: Request the provisioning of C2 Operation Mode configuration information for a UAS + (i.e. pair of UAV and UAV-C). + operationId: InitiateC2OpModeConfig + tags: + - Initiate C2 Operation Mode configuration + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ConfigureData' + responses: + '200': + description: > + The communicated C2 Operation Mode configuration information was successfully + received. The response body contains the feedback of the UAE Server on whether + this C2 Operation Mode configuration request is confirmed (i.e. can be undertaken + by the UAE Server) or not. + content: + application/json: + schema: + $ref: '#/components/schemas/C2Result' + '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' +callbacks: + C2OpModeMngtCompletionNotification: + '{ $request.body#/notificationUri }/c2mode-mngt-completion': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/C2OpModeMngtCompStatus' + responses: + '204': + description: > + No Content. The notification was successful and the C2 Operation Mode + Management Completion status for the concerned UAS (i.e. pair of UAV + and UAV-C) was successfully received and acknowledged by the UASS. + '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' + SelectedC2CommunicationModeNotification: + '{ $request.body#/notificationUri }/inform-selec-c2mode': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SelectedC2CommModeNotif' + responses: + '204': + description: > + No Content. The notification was successful and the C2 Communication Mode + selected by the concerned UAS (i.e. pair of UAV and UAV-C) was successfully + received and acknowledged by the UASS. + '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' +C2CommunicationModeSwitchingNotification: + '{$request.body#/notificationUri}/inform-c2mode-switch': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/C2CommModeSwitchNotif' + responses: + '200': + description: > + OK. The targeted C2 Communication Mode switching for the concerned UAS + (i.e. pair of UAV and UAV-C) is successfully received. The response body + contains the feedback of the UASS on whether this C2 Communication Mode + switching is confirmed (i.e. validated) or not. + content: + application/json: + schema: + $ref: '#/components/schemas/C2Result' + '204': + description: > + No Content. The targeted C2 Communication Mode switching for the concerned + UAS (i.e. pair of UAV and UAV-C) is successfully received and acknowledged, + and the UASS does not need to confirm (i.e. validate) it. + '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: + ConfigureData: + description: > + Represents the parameters to request to provision C2 Operation Mode configuration + information for a UAS (i.e. pair of UAV and UAV-C). + type: object + properties: + +``` + +``` + uassId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + uasId: + $ref: '#/components/schemas/UasId' + allowedC2CommModes: + type: array + items: + $ref: '#/components/schemas/C2CommMode' + minItems: 1 + c2CommModeSwitchTypes: + type: array + items: + $ref: '#/components/schemas/C2CommModeSwitching' + minItems: 1 + notificationUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + primaryC2CommMode: + $ref: '#/components/schemas/C2CommMode' + secondaryC2CommMode: + $ref: '#/components/schemas/C2CommMode' + c2SwitchPolicies: + $ref: '#/components/schemas/C2SwitchPolicies' + c2ServiceArea: + $ref: '#/components/schemas/C2ServiceArea' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uassId + - uasId + - allowedC2CommModes + - c2CommModeSwitchTypes + - notificationUri + - primaryC2CommMode + - c2SwitchPolicies + +SelectedC2CommModeNotif: + description: > + Represents information on the C2 Communication Mode selected by a UAS (i.e. pair of + UAV and UAV-C). + type: object + properties: + uasId: + $ref: '#/components/schemas/UasId' + selPrimaryC2CommMode: + $ref: '#/components/schemas/C2CommMode' + selSecondaryC2CommMode: + $ref: '#/components/schemas/C2CommMode' + required: + - uasId + - selPrimaryC2CommMode + +C2CommModeSwitchNotif: + description: > + Represents information on the targeted C2 Communication Mode switching for a UAS + (i.e. pair of UAV and UAV-C). + type: object + properties: + uaeServerId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + uasId: + $ref: '#/components/schemas/UasId' + c2CommModeSwitchType: + $ref: '#/components/schemas/C2CommModeSwitching' + switchingCause: + $ref: '#/components/schemas/C2SwitchingCause' + required: + - uaeServerId + - uasId + - c2CommModeSwitchType + +C2Result: + description: Represents the result of an action related to C2 of a UAS. + type: object + properties: + c2OpConfirmed: + type: boolean + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +``` + +``` +required: + - c2OpConfirmed + +UasId: + description: Represents the identifier of a UAS (i.e. pair of UAV and UAV-C). + type: object + properties: + groupId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/ExternalGroupId' + individualUasId: + type: array + items: + $ref: '#/components/schemas/UavId' + minItems: 2 + oneOf: + - required: [groupId] + - required: [individualUasId] + +UavId: + description: Represents the identifier of a UAV (e.g. UAV, UAV-C). + type: object + properties: + gpsI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + caaId: + type: string + anyOf: + - required: [gpsI] + - required: [caaId] + +C2ServiceArea: + description: Represents a C2 service area. + type: object + properties: + ncgiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + geographicAreaList: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea' + oneOf: + - required: [geographicAreaList] + - anyOf: + - required: [ncgiList] + - required: [taiList] + +C2OpModeMngtCompStatus: + description: > + Represents the C2 Operation Mode Management Completion status for a UAV + (e.g. UAV, UAV-C). + type: object + properties: + uasId: + $ref: '#/components/schemas/UasId' + status: + $ref: '#/components/schemas/C2OpModeStatus' + required: + - uasId + - status + +C2SwitchPolicies: + description: Represents the C2 operation mode switching policies. + type: object + properties: + directC2LinkQualityThrlds: + $ref: '#/components/schemas/C2LinkQualityThrlds' + uuC2LinkQualityThrlds: + $ref: '#/components/schemas/C2LinkQualityThrlds' + +C2LinkQualityThrlds: + description: Represents the C2 link quality thresholds. + type: object +``` + +``` +properties: + nrRsrpThrldLow: + type: integer + minimum: 0 + maximum: 127 + nrRsrpThrldHigh: + type: integer + minimum: 0 + maximum: 127 + nrRsrqThrldLow: + type: integer + minimum: 0 + maximum: 127 + nrRsrqThrldHigh: + type: integer + minimum: 0 + maximum: 127 + packetLossThrldLow: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + packetLossThrldHigh: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' +``` + +## # ENUMS: + +``` +C2CommMode: + anyOf: + - type: string + enum: + - DIRECT_C2_COMMUNICATION + - NETWORK_ASSISTED_C2_COMMUNICATION + - UTM_NAVIGATED_C2_COMMUNICATION + - 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 C2 Communication Mode. + Possible values are: + - DIRECT_C2_COMMUNICATION: Indicates Direct C2 Communication mode. + - NETWORK_ASSISTED_C2_COMMUNICATION: Indicates Network-Assisted C2 Communication mode. + - UTM_NAVIGATED_C2_COMMUNICATION: Indicates UTM-Navigated C2 communication mode. +``` + +``` +C2CommModeSwitching: + anyOf: + - type: string + enum: + - DIRECT_TO_NETWORK_ASSISTED_C2 + - NETWORK_ASSISTED_TO_DIRECT_C2 + - DIRECT_TO_UTM_NAVIGATED_C2 + - NETWORK_ASSISTED_TO_UTM_NAVIGATED_C2 + - 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 C2 Communication Mode Switching type. + Possible values are: + - DIRECT_TO_NETWORK_ASSISTED_C2: Indicates the C2 Communication Mode switching from Direct + C2 Communication mode to Network-Assisted C2 Communication mode. + - NETWORK_ASSISTED_TO_DIRECT_C2: Indicates the C2 Communication Mode switching from + Network-Assisted C2 Communication mode to Direct C2 Communication mode. + - DIRECT_TO_UTM_NAVIGATED_C2: Indicates the C2 Communication Mode switching from + Direct C2 Communication mode to UTM-Navigated C2 communication mode. + - NETWORK_ASSISTED_TO_UTM_NAVIGATED_C2: Indicates the C2 Communication Mode switching + from Network-Assisted C2 Communication mode to UTM-Navigated C2 communication mode. +``` + +``` +C2SwitchingCause: + anyOf: + - type: string + enum: + - DIRECT_LINK_QUALITY_DEGRADATION + - DIRECT_LINK_AVAILABLE + - MOVING_BVLOS + - LOCATION_CHANGE + - TRAFFIC_CONTROL_NEEDED + - SECURITY_REASONS + - OTHER_REASONS + - 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 C2 Communication Mode switching cause. + Possible values are: + - DIRECT_LINK_QUALITY_DEGRADATION: Indicates that the C2 Communication Mode switching + was triggered due to a degradation in the direct radio link quality. + - DIRECT_LINK_AVAILABLE: Indicates that the C2 Communication Mode switching was triggered + due to the availability of a direct link, i.e. direct radio link quality enables its + usage. + - MOVING_BVLOS: Indicates that the C2 Communication Mode switching was triggered due to + the UAV moving BVLOS. + - LOCATION_CHANGE: Indicates that the C2 Communication Mode switching was triggered due to + an actual or expected location/mobility of the UAV (e.g. which impacts the UAV-to-UAV-C + location). + - TRAFFIC_CONTROL_NEEDED: Indicates that the C2 Communication Mode switching was triggered + due to the necessity to have air traffic control. + - SECURITY_REASONS: Indicates that the C2 Communication Mode switching was triggered due to + security reasons. + - OTHER_REASONS: Indicates that the C2 Communication Mode switching was triggered due to + other reasons (e.g. unpredictable event, unknown reason, weather conditions, topography, + etc.). + +C2OpModeStatus: + anyOf: + - type: string + enum: + - SUCCESSFUL + - NOT_SUCCESSFUL + - 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 C2 operation mode management completion status. + Possible values are: + - SUCCESSFUL: Indicates that the C2 operation mode configuration was successful. + - NOT_SUCCESSFUL: Indicates that the C2 operation mode configuration was not successful. +``` + +## A.3 UAE\_RealtimeUAVStatus API + +``` +openapi: 3.0.0 +info: + title: UAE Server Real-time UAV Status Service + version: 1.0.0 + description: | + UAE Server Real-time UAV Status Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.257 V17.1.0; Application layer support for Uncrewed Aerial System (UAS); + UAS Application Enabler (UAE) Server Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.257/ + +servers: + - url: '{apiRoot}/uae-uav-status/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /subscriptions: + get: + summary: Retrieve all the active real-time UAV status subscriptions managed by the UAE Server. + operationId: GetRTUavStatusSubscriptions + tags: + - Real-time UAV Status Subscriptions (Collection) + responses: + '200': + description: > + OK. All the active real-time UAV status subscriptions managed by the UAE Server + shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RTUavStatusSubsc' + '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: Request the creation of a subscription to real-time UAV status reporting. + operationId: CreateRTUavStatusSubsc + tags: + - Real-time UAV Status Subscriptions (Collection) + requestBody: +``` + +``` + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RTUavStatusSubsc' + responses: + '200': + description: > + OK. The subscription is successfully created and a representation of the created + Individual Real-time UAV Status Subscription resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RTUavStatusSubsc' + headers: + Location: + description: > + Contains the URI of the created Individual Real-time UAV Status 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: + RTUavStatusNotification: + '{$request.body#/notificationUri}/uav-status': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RTUavStatusNotif' + responses: + '204': + description: > + No Content. The real-time UAV status notification is successfully + received and acknowledged. + '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' +``` + +``` + $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}: + get: + summary: Retrieve a real-time UAV status subscription resource. + operationId: GetRTUavStatusSubscription + tags: + - Individual Real-time UAV Status Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Individual Real-time UAV Status Subscription identifier. + required: true + schema: + type: string + responses: + '200': + description: OK. The requested real-time UAV status subscription resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RTUavStatusSubsc' + '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 real-time UAV status subscription. + operationId: UpdateRTUavStatusSubscription + tags: + - Individual Real-time UAV Status Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Individual Real-time UAV Status Subscription identifier. + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RTUavStatusSubsc' + responses: + '200': + description: > + OK. The real-time UAV status subscription is successfully updated and a + representation of the updated Individual Real-time UAV Status Subscription + resource shall be returned. + content: + application/json: +``` + +``` + schema: + $ref: '#/components/schemas/RTUavStatusSubsc' + '204': + description: No Content. The real-time UAV status subscription is successfully updated. + '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: Request the deletion of an existing real-time UAV status subscription. + operationId: DeleteRTUavStatusSubscription + tags: + - Individual Real-time UAV Status Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Individual Real-time UAV Status Subscription identifier. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual Real-time UAV Status Subscription 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' + '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: +``` + +``` +RTUavStatusSubsc: + description: > + Represents the parameters to request the creation or update of a subscription + to real-time UAV status reporting. + type: object + properties: + uassId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + uavIds: + type: array + items: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UavId' + minItems: 1 + notificationUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uassId + - uavIds + - notificationUri + +RTUavStatusNotif: + description: Represents a real-time UAV status notification. + type: object + properties: + subscriptionId: + type: string + rTUavStatus: + type: array + items: + $ref: '#/components/schemas/RTUavStatus' + minItems: 1 + required: + - subscriptionId + - rTUavStatus + +RTUavStatus: + description: Represents real-time UAV status information. + type: object + properties: + uavId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UavId' + uavNetConnStatus: + $ref: '#/components/schemas/UavNetConnStatus' + uavLocInfo: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + allOf: + - required: [uavId] + - oneOf: + - required: [uavLocInfo] + - allOf: + - required: [uavLocInfo] + - required: [uavNetConnStatus] + +UavNetConnStatus: + description: Represents UAV network connection status information. + type: object + properties: + statusInfo: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/MonitoringType' + timestamp: + $ref: 'TS29122_CommonData.yaml#/components/schemas/DateTime' + required: + - statusInfo + - timestamp +``` + +## A.4 UAE\_ChangeUSSManagement API + +``` +openapi: 3.0.0 + +info: + title: UAE Server USS Change Management Service + version: 1.0.0-alpha.1 + description: | + UAE Server USS Change Management Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.257 V18.1.0; Application layer support for Uncrewed Aerial System (UAS); + UAS Application Enabler (UAE) Server Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.257/ + +servers: + - url: '{apiRoot}/uae-usschange-mngt/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /policies: + get: + summary: Retrieve all the active USS Change Policies managed by the UAE Server. + operationId: GetUSSChangePolicies + tags: + - USS Change Policies (Collection) + responses: + '200': + description: > + OK. All the active USS Change Policies managed by the UAE Server shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/USSChangePolicy' + '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: Request the creation of a USS Change Policy. + operationId: CreateUSSChangePolicy + tags: + - USS Change Policies (Collection) + requestBody: +``` + +``` + + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/USSChangePolReq' + responses: + '200': + description: > + OK. The USS Change Policy is successfully created and a representation of the created + Individual USS Change Policy resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/USSChangePolResp' + headers: + Location: + description: > + Contains the URI of the created Individual USS Change Policy 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' +#Editor's Note: The definition of the notifications is FFS. + +/policies/{policyId}: + parameters: + - name: policyId + in: path + description: Represents the identifier of the Individual USS Change Policy resource. + required: true + schema: + type: string + + get: + summary: Retrieve an existing Individual USS Change Policy resource. + operationId: GetUSSChangePolicy + tags: + - Individual USS Change Policy (Document) + responses: + '200': + description: OK. The requested Individual USS Change Policy resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/USSChangePolicy' + '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 USS Change Policy resource. + operationId: UpdateUSSChangePolicy + tags: + - Individual USS Change Policy (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/USSChangePolicy' + responses: + '200': + description: > + OK. The Individual USS Change Policy resource is successfully updated and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/USSChangePolicy' + '204': + description: > + No Content. The Individual USS Change Policy 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' + '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: Request the modification of an existing Individual USS Change Policy resource. + operationId: ModifyUSSChangePolicy + tags: + - Individual USS Change Policy (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/USSChangePolicyPatch' + responses: + '200': + description: > + OK. The Individual USS Change Policy resource is successfully modified and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: +``` + +``` + $ref: '#/components/schemas/USSChangePolicy' + '204': + description: > + No Content. The Individual USS Change Policy 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' + '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: Request the deletion of an existing Individual USS Change Policy resource. + operationId: DeleteUSSChangePolicy + tags: + - Individual USS Change Policy (Document) + responses: + '204': + description: > + No Content. The Individual USS Change Policy 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' + '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' + +/request-usschange: + post: + summary: Request USS change. + operationId: RequestUSSChange + tags: + - Request USS Change + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/USSChangeReq' + responses: + '204': + description: > + No Content. The USS change request 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' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + USSChangePolReq: + description: > + Represents the parameters to request the creation/Update of a USS Change Policy. + type: object + properties: + uassId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + ussChangePol: + $ref: '#/components/schemas/USSChangePolicy' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uassId + - ussChangePol + + USSChangePolResp: + description: Represents the response to a USS Change Policy create/update request. + type: object + properties: + ussChangePol: + $ref: '#/components/schemas/USSChangePolicy' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ussChangePol + + USSChangePolicy: + description: Represents a USS Change Policy. + type: object + properties: + uasId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UasId' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + required: + - uasId + - notifUri + + USSChangePolicyPatch: + description: > + Represents the parameters to request the modification of a USS Change Policy. + type: object +``` + +``` +properties: + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + +USSChangeReq: + description: Represents the parameters to request for USS change. + type: object + properties: + uassId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + uasId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UasId' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uassId + - uasId +``` + +## A.5 UAE\_DAASupport API + +``` +openapi: 3.0.0 + +info: + title: UAE Server DAA Support Service + version: 1.0.0-alpha.2 + description: | + UAE Server DAA Support Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.257 V18.2.0; Application layer support for Uncrewed Aerial System (UAS); + UAS Application Enabler (UAE) Server Services; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.257/ + +servers: + - url: '{apiRoot}/uae-daa/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /policies: + get: + summary: Retrieve all the active DAA Policies managed by the UAE Server. + operationId: GetDAAPolicies + tags: + - DAA Policies (Collection) + responses: + '200': + description: > + OK. All the active DAA Policies managed by the UAE Server shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DAAPolicy' + '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: Request the creation of a DAA Policy. + operationId: CreateDAAPolicy + tags: + - DAA Policies (Collection) + requestBody: +``` + +``` + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DAAPolReq' + responses: + '200': + description: > + OK. The DAA Policy is successfully created and a representation of the created + Individual DAA Policy resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/DAAPolResp' + headers: + Location: + description: > + Contains the URI of the created Individual DAA Policy 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: + DAAPolCompStatusNotif: + '{$request.body#/daaPol/notifUri}/daa-policy': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DAAPolConfigNotif' + responses: + '204': + description: > + No Content. The DAA Policy Configuration Status notification is successfully + received and acknowledged. + '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' + +DAAEventsNotif: + '{$request.body#/daaPol/notifUri}/daa-events': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DAAEventsInfo' + responses: + '200': + description: > + OK. The DAA event notification is successfully received and acknowledged, and + the UASS returns updated/additional DAA related event information in the + response body. + content: + application/json: + schema: + $ref: '#/components/schemas/DAAEventsInfo' + '204': + description: > + No Content. The DAA event notification is successfully received and + acknowledged. + '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' + +/policies/{policyId}: + parameters: + - name: policyId + in: path + description: Represents the identifier of the Individual DAA Policy resource. + required: true + schema: + type: string + + get: + summary: Retrieve an existing Individual DAA Policy resource. + operationId: GetIndDAAPolicy + tags: + - Individual DAA Policy (Document) + responses: + '200': + description: OK. The requested Individual DAA Policy resource shall be returned. + content: + application/json: + schema: + +``` + +``` + $ref: '#/components/schemas/DAAPolicy' + '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 DAA Policy resource. + operationId: UpdateIndDAAPolicy + tags: + - Individual DAA Policy (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DAAPolicy' + responses: + '200': + description: > + OK. The Individual DAA Policy resource is successfully updated and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/DAAPolicy' + '204': + description: > + No Content. The Individual DAA Policy 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' + '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: Request the modification of an existing Individual DAA Policy resource. + operationId: ModifyIndDAAPolicy + tags: + - Individual DAA Policy (Document) + requestBody: + required: true +``` + +``` +content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/DAAPolicyPatch' +responses: + '200': + description: > + OK. The Individual DAA Policy resource is successfully modified and a + representation of the updated resource shall be returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/DAAPolicy' + '204': + description: > + No Content. The Individual DAA Policy 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' + '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: Request the deletion of an existing Individual DAA Policy resource. + operationId: DeleteIndDAAPolicy + tags: + - Individual DAA Policy (Document) + responses: + '204': + description: > + No Content. The Individual DAA Policy 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' + '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' + +/inform-events: + post: + summary: Inform about and request the management of possible DAA related events. + operationId: InformDAAEvents + tags: + - InformDAAEvents +``` + +``` +requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/InformDAAEventsReq' +responses: + '204': + description: > + No Content. The request 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' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{tokenUrl}' + scopes: {} + +schemas: + DAAPolReq: + description: > + Represents the parameters to request the creation of a DAA Policy. + type: object + properties: + uassId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + daaPol: + $ref: '#/components/schemas/DAAPolicy' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uassId + - daaPol + + DAAPolResp: + description: Represents the response to a DAA Policy creation request. + type: object + properties: + daaPol: + $ref: '#/components/schemas/DAAPolicy' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - daaPol + + DAAPolicy: + description: Represents the content of a DAA Policy. + type: object + properties: +``` + +``` + uasId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UasId' + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + required: + - uasId + - notifUri + +DAAPolicyPatch: + description: > + Represents the parameters to request the modification of a DAA Policy. + type: object + properties: + notifUri: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + +InformDAAEventsReq: + description: Represents the parameters to report DAA related event(s). + type: object + properties: + uassId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Uri' + uasId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UasId' + daaEventsInfo: + type: array + items: + $ref: '#/components/schemas/DAAEvent' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uassId + - uasId + - daaEventsInfo + +DAAPolConfigNotif: + description: Represents the parameters to request for DAA. + type: object + properties: + status: + $ref: '#/components/schemas/DAAPolConfigStatus' + required: + - status + +DAAEventsInfo: + description: Represents the parameters to request for DAA. + type: object + properties: + uasId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UasId' + daaEventsInfo: + type: array + items: + $ref: '#/components/schemas/DAAEvent' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - uasId + - daaEventsInfo + +DAAEvent: + description: Represents the parameters to request for DAA. + type: object + properties: + uasId: + $ref: 'TS29257_UAE_C2OperationModeManagement.yaml#/components/schemas/UasId' + uasLocInfo: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo' + required: + - uasId + - uasLocInfo + +DAAPolConfigStatus: + anyOf: + - type: string + enum: +``` + +- SUCCESSFUL +- NOT\_SUCCESSFUL +- 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 DAA Policy configuration completion status. + +Possible values are: + +- SUCCESSFUL: Indicates that the DAA Policy configuration was successful. +- NOT\_SUCCESSFUL: Indicates that the DAA Policy configuration was not successful. + +--- + +## Annex B (informative): Withdrawn API versions + +### B.1 General + +This Annex lists withdrawn API versions of the APIs defined in the present specification. Clause 4.3.1.6 of 3GPP TS 29.501 [5] describes the withdrawal of API versions. + +--- + +### B.2 UAE\_C2OperationModeManagement API + +The API versions listed in table B.2-1 are withdrawn for the UAE\_C2OperationModeManagement API. + +**Table B.2-1: Withdrawn API versions of the UAE\_C2OperationModeManagement service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +--- + +### B.3 UAE\_RealtimeUAVStatus API + +The API versions listed in table B.3-1 are withdrawn for the UAE\_RealtimeUAVStatus API. + +**Table B.3-1: Withdrawn API versions of the UAE\_RealtimeUAVStatus service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +--- + +### B.4 UAE\_ChangeUSSManagement API + +The API versions listed in table B.3-1 are withdrawn for the UAE\_ChangeUSSManagement API. + +**Table B.3-1: Withdrawn API versions of the UAE\_ChangeUSSManagement service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +--- + +### B.5 UAE\_DAASupport API + +The API versions listed in table B.3-1 are withdrawn for the UAE\_DAASupport API. + +**Table B.3-1: Withdrawn API versions of the UAE\_DAASupport service** + +| API version number | Remarks | +|--------------------|---------| +| | | + +## Annex C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2021-05 | CT3#116-e | | - | - | - | Skeleton for the new UASAPP TS | 0.0.0 | +| 2021-05 | CT3#116-e | C3-213503 | | | | Inclusion of C3-213539 | 0.1.0 | +| 2021-09 | CT3#117-e | C3-214619 | - | - | - | Inclusion of: C3-214294, C3-214295, C3-214296, C3-214297, C3-214487, C3-214299, C3-214300, C3-214488, C3-214489 | 0.2.0 | +| 2021-10 | CT3#118-e | C3-215478 | | | | Inclusion of: C3-215442, C3-215443, C3-215444, C3-215445, C3-215446, C3-215447, C3-215448, C3-215449, C3-215450, C3-215451 | 0.3.0 | +| 2021-11 | CT3#119-e | C3-216551 | - | - | - | Inclusion of: C3-216211, C3-216212, C3-216213, C3-216214, C3-216215, C3-216216, C3-216217, C3-216218, C3-216219 | 0.4.0 | +| 2021-12 | CT#94-e | CP-213206 | - | - | - | Presented for information | 1.0.0 | +| 2022-01 | CT3#119-bis-e | C3-220456 | | | | Inclusion of: C3-220308, C3-220309, C3-220310, C3-220311, C3-220312, C3-220313, C3-220314, C3-220315 | 1.1.0 | +| 2022-02 | CT3#120-e | C3-221557 | | | | Inclusion of: C3-221342, C3-221343, C3-221344, C3-221345, C3-221346, C3-221347, C3-221348, C3-221349, C3-221352, C3-221353, C3-221638, C3-221639, C3-221640 | 1.2.0 | +| 2022-03 | CT#95e | CP-220162 | | | | Presentation to TSG CT for approval | 2.0.0 | +| 2022-03 | CT#95e | CP-220162 | | | | Approved by TSG CT | 17.0.0 | +| 2022-06 | CT#96 | CP-221160 | 0001 | 1 | F | Correcting the definition of a mandatory attribute in the OpenAPI file | 17.1.0 | +| 2022-06 | CT#96 | CP-221160 | 0002 | 1 | F | Updating the description fields for enumerations in the OpenAPI file | 17.1.0 | +| 2022-06 | CT#96 | CP-221160 | 0003 | 1 | F | Adding a missing reference number | 17.1.0 | +| 2022-06 | CT#96 | CP-221151 | 0004 | - | F | Update of info and externalDocs fields | 17.1.0 | +| 2023-03 | CT#99 | CP-230156 | 0006 | - | F | Correction of the description fields in enumerations | 18.0.0 | +| 2023-03 | CT#99 | CP-230161 | 0007 | - | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-06 | CT#100 | C3-232397 | 0008 | 2 | B | Definition of the service description clauses of the UAE_ChangeUSSManagement API | 18.1.0 | +| 2023-06 | CT#100 | C3-232398 | 0010 | 2 | B | Definition of the API resources and notifications of the UAE_ChangeUSSManagement API | 18.1.0 | +| 2023-06 | CT#100 | C3-232399 | 0011 | 1 | B | Definition of the API data model clause of the UAE_ChangeUSSManagement API | 18.1.0 | +| 2023-06 | CT#100 | C3-231252 | 0012 | | B | Definition of the OpenAPI description of the UAE_ChangeUSSManagement API | 18.1.0 | +| 2023-06 | CT#100 | C3-232400 | 0013 | 1 | B | Starting the Definition of the UAE_DAASupport API | 18.1.0 | +| 2023-06 | CT#100 | C3-232401 | 0014 | | B | Definition of the API clauses of the UAE_DAASupport API | 18.1.0 | +| 2023-06 | CT#100 | C3-232402 | 0015 | | B | Definition of the OpenAPI description of the UAE_DAASupport API | 18.1.0 | +| 2023-12 | CT#102 | CP-233288 | 0017 | 1 | F | Correct the attributes defined within DAAPolConfigNotif data type. | 18.2.0 | +| 2023-12 | CT#102 | CP-233237 | 0020 | | F | Update of info and externalDocs fields | 18.2.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29272/raw.md b/marked/Rel-18/29_series/29272/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..98ca408fc0356962b05d9fbd88813cccdeca0720 --- /dev/null +++ b/marked/Rel-18/29_series/29272/raw.md @@ -0,0 +1,6992 @@ + + +# 3GPP TS 29.272 V18.2.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Evolved Packet System (EPS); Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related interfaces based on Diameter protocol (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..... | 10 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions and abbreviations..... | 14 | +| 3.1 Definitions..... | 14 | +| 3.2 Abbreviations..... | 14 | +| 4 General Description..... | 15 | +| 5 MME – HSS (S6a) and SGSN – HSS (S6d)..... | 15 | +| 5.1 Introduction..... | 15 | +| 5.2 Mobility Services..... | 15 | +| 5.2.1 Location Management Procedures..... | 15 | +| 5.2.1.1 Update Location..... | 15 | +| 5.2.1.1.1 General..... | 15 | +| 5.2.1.1.2 Detailed behaviour of the MME and the SGSN..... | 18 | +| 5.2.1.1.3 Detailed behaviour of the HSS..... | 23 | +| 5.2.1.2 Cancel Location..... | 27 | +| 5.2.1.2.1 General..... | 27 | +| 5.2.1.2.2 Detailed behaviour of the MME and the SGSN..... | 27 | +| 5.2.1.2.3 Detailed behaviour of the HSS..... | 28 | +| 5.2.1.3 Purge UE..... | 28 | +| 5.2.1.3.1 General..... | 28 | +| 5.2.1.3.2 Detailed behaviour of the MME and the SGSN..... | 29 | +| 5.2.1.3.3 Detailed behaviour of the HSS..... | 30 | +| 5.2.2 Subscriber Data Handling Procedures..... | 30 | +| 5.2.2.1 Insert Subscriber Data..... | 30 | +| 5.2.2.1.1 General..... | 30 | +| 5.2.2.1.2 Detailed behaviour of the MME and the SGSN..... | 33 | +| 5.2.2.1.3 Detailed behaviour of HSS..... | 36 | +| 5.2.2.2 Delete Subscriber Data..... | 38 | +| 5.2.2.2.1 General..... | 38 | +| 5.2.2.2.2 Detailed behaviour of the MME and the SGSN..... | 41 | +| 5.2.2.2.3 Detailed behaviour of the HSS..... | 42 | +| 5.2.3 Authentication Procedures..... | 42 | +| 5.2.3.1 Authentication Information Retrieval..... | 42 | +| 5.2.3.1.1 General..... | 42 | +| 5.2.3.1.2 Detailed behaviour of the MME and the SGSN..... | 44 | +| 5.2.3.1.3 Detailed behaviour of the HSS..... | 44 | +| 5.2.4 Fault Recovery Procedures..... | 46 | +| 5.2.4.1 Reset..... | 46 | +| 5.2.4.1.1 General..... | 46 | +| 5.2.4.1.2 Detailed behaviour of the MME and the SGSN..... | 47 | +| 5.2.4.1.3 Detailed behaviour of the HSS..... | 48 | +| 5.2.5 Notification Procedures..... | 49 | +| 5.2.5.1 Notification..... | 49 | +| 5.2.5.1.1 General..... | 49 | +| 5.2.5.1.2 Detailed behaviour of the MME and the SGSN..... | 52 | +| 5.2.5.1.3 Detailed behaviour of the HSS..... | 53 | +| 5A MME – CSS (S7a) and SGSN – CSS (S7d)..... | 54 | +| 5A.1 Introduction..... | 54 | +| 5A.2 Mobility Services..... | 54 | +| 5A.2.1 Location Management Procedures..... | 54 | +| 5A.2.1.1 Update VCSG Location..... | 54 | +| 5A.2.1.1.1 General..... | 54 | + +| | | | +|------------|-------------------------------------------------------|----| +| 5A.2.1.1.2 | Detailed behaviour of the MME and the SGSN..... | 55 | +| 5A.2.1.1.3 | Detailed behaviour of the CSS..... | 56 | +| 5A.2.1.2 | Cancel VCSG Location..... | 56 | +| 5A.2.1.2.1 | General..... | 56 | +| 5A.2.1.2.2 | Detailed behaviour of the MME and the SGSN..... | 57 | +| 5A.2.1.2.3 | Detailed behaviour of the CSS..... | 57 | +| 5A.2.2 | Subscriber Data Handling Procedures..... | 57 | +| 5A.2.2.1 | Insert VCSG Subscriber Data..... | 57 | +| 5A.2.2.1.1 | General..... | 57 | +| 5A.2.2.1.2 | Detailed behaviour of the MME and the SGSN..... | 58 | +| 5A.2.2.1.3 | Detailed behaviour of CSS..... | 59 | +| 5A.2.2.2 | Delete VCSG Subscriber Data..... | 59 | +| 5A.2.2.2.1 | General..... | 59 | +| 5A.2.2.2.2 | Detailed behaviour of the MME and the SGSN..... | 60 | +| 5A.2.2.2.3 | Detailed behaviour of the CSS..... | 60 | +| 5A.2.3 | Fault Recovery Procedures..... | 60 | +| 5A.2.3.1 | VCSG Reset..... | 60 | +| 5A.2.3.1.1 | General..... | 60 | +| 5A.2.3.1.2 | Detailed behaviour of the MME and the SGSN..... | 61 | +| 5A.2.3.1.3 | Detailed behaviour of the CSS..... | 61 | +| 6 | MME – EIR (S13) and SGSN – EIR (S13')..... | 62 | +| 6.1 | Introduction..... | 62 | +| 6.2 | ME Identity Check Procedures..... | 62 | +| 6.2.1 | ME Identity Check..... | 62 | +| 6.2.1.1 | General..... | 62 | +| 6.2.1.2 | Detailed behaviour of the MME and the SGSN..... | 63 | +| 6.2.1.3 | Detailed behaviour of the EIR..... | 63 | +| 7 | Protocol Specification and Implementation..... | 64 | +| 7.1 | Introduction..... | 64 | +| 7.1.1 | Use of Diameter base protocol..... | 64 | +| 7.1.2 | Securing Diameter Messages..... | 64 | +| 7.1.3 | Accounting functionality..... | 64 | +| 7.1.4 | Use of sessions..... | 64 | +| 7.1.5 | Transport protocol..... | 64 | +| 7.1.6 | Routing considerations..... | 65 | +| 7.1.7 | Advertising Application Support..... | 65 | +| 7.1.8 | Diameter Application Identifier..... | 65 | +| 7.1.9 | Use of the Supported-Features AVP..... | 66 | +| 7.2 | Commands..... | 67 | +| 7.2.1 | Introduction..... | 67 | +| 7.2.2 | Command-Code values..... | 67 | +| 7.2.3 | Update-Location-Request (ULR) Command..... | 68 | +| 7.2.4 | Update-Location-Answer (ULA) Command..... | 69 | +| 7.2.5 | Authentication-Information-Request (AIR) Command..... | 69 | +| 7.2.6 | Authentication-Information-Answer (AIA) Command..... | 70 | +| 7.2.7 | Cancel-Location-Request (CLR) Command..... | 70 | +| 7.2.8 | Cancel-Location-Answer (CLA) Command..... | 70 | +| 7.2.9 | Insert-Subscriber-Data-Request (IDR) Command..... | 71 | +| 7.2.10 | Insert-Subscriber-Data-Answer (IDA) Command..... | 71 | +| 7.2.11 | Delete-Subscriber-Data-Request (DSR) Command..... | 72 | +| 7.2.12 | Delete-Subscriber-Data-Answer (DSA) Command..... | 73 | +| 7.2.13 | Purge-UE-Request (PUR) Command..... | 74 | +| 7.2.14 | Purge-UE-Answer (PUA) Command..... | 74 | +| 7.2.15 | Reset-Request (RSR) Command..... | 75 | +| 7.2.16 | Reset-Answer (RSA) Command..... | 75 | +| 7.2.17 | Notify-Request (NOR) Command..... | 76 | +| 7.2.18 | Notify-Answer (NOA) Command..... | 76 | +| 7.2.19 | ME-Identity-Check-Request (ECR) Command..... | 77 | +| 7.2.20 | ME-Identity-Check-Answer (ECA) Command..... | 77 | +| 7.2.21 | Update-VCSG-Location-Request (UVR) Command..... | 78 | + +| | | | +|----------|---------------------------------------------------|-----| +| 7.2.22 | Update-VCSG-Location-Answer (UVA) Command..... | 78 | +| 7.2.23 | Cancel-VCSG-Location-Request (CVR) Command..... | 78 | +| 7.2.24 | Cancel-VCSG-Location-Answer (CVA) Command..... | 79 | +| 7.3 | Information Elements..... | 80 | +| 7.3.1 | General..... | 80 | +| 7.3.2 | Subscription-Data..... | 89 | +| 7.3.3 | Terminal-Information..... | 90 | +| 7.3.4 | IMEI..... | 91 | +| 7.3.5 | Software-Version..... | 91 | +| 7.3.6 | 3GPP2-MEID..... | 91 | +| 7.3.7 | ULR-Flags..... | 91 | +| 7.3.8 | ULA-Flags..... | 93 | +| 7.3.9 | Visited-PLMN-Id..... | 93 | +| 7.3.10 | Feature-List AVP..... | 93 | +| 7.3.10.1 | Feature-List AVP for the S6a/S6d application..... | 93 | +| 7.3.10.2 | Feature-List AVP for the S7a/S7d application..... | 106 | +| 7.3.11 | Requested-EUTRAN-Authentication-Info..... | 106 | +| 7.3.12 | Requested-UTRAN- GERAN-Authentication-Info..... | 106 | +| 7.3.13 | RAT-Type..... | 106 | +| 7.3.14 | Number-Of-Requested-Vectors..... | 106 | +| 7.3.15 | Re-Synchronization-Info..... | 107 | +| 7.3.16 | Immediate-Response-Preferred..... | 107 | +| 7.3.17 | Authentication-Info..... | 107 | +| 7.3.18 | E-UTRAN-Vector..... | 107 | +| 7.3.19 | UTRAN-Vector..... | 107 | +| 7.3.20 | GERAN-Vector..... | 108 | +| 7.3.21 | Network-Access-Mode..... | 108 | +| 7.3.22 | HPLMN-ODB..... | 108 | +| 7.3.23 | Item-Number..... | 108 | +| 7.3.24 | Cancellation-Type..... | 108 | +| 7.3.25 | DSR-Flags..... | 109 | +| 7.3.26 | DSA-Flags..... | 111 | +| 7.3.27 | Context-Identifier..... | 111 | +| 7.3.28 | Void..... | 112 | +| 7.3.29 | Subscriber-Status..... | 112 | +| 7.3.30 | Operator-Determined-Barring..... | 112 | +| 7.3.31 | Access-Restriction-Data..... | 112 | +| 7.3.32 | APN-OI-Replacement..... | 113 | +| 7.3.33 | All-APN-Configurations-Included-Indicator..... | 113 | +| 7.3.34 | APN-Configuration-Profile..... | 114 | +| 7.3.35 | APN-Configuration..... | 114 | +| 7.3.36 | Service-Selection..... | 116 | +| 7.3.37 | EPS-Subscribed-QoS-Profile..... | 116 | +| 7.3.38 | VPLMN-Dynamic-Address-Allowed..... | 116 | +| 7.3.39 | STN-SR..... | 116 | +| 7.3.40 | Allocation-Retention-Priority..... | 117 | +| 7.3.41 | AMBR..... | 117 | +| 7.3.42 | MIP-Home-Agent-Address..... | 117 | +| 7.3.43 | MIP-Home-Agent-Host..... | 118 | +| 7.3.44 | PDN-GW-Allocation-Type..... | 118 | +| 7.3.45 | MIP6-Agent-Info..... | 118 | +| 7.3.46 | RAT-Frequency-Selection-Priority-ID..... | 118 | +| 7.3.47 | IDA-Flags..... | 118 | +| 7.3.48 | PUA-Flags..... | 119 | +| 7.3.49 | NOR-Flags..... | 119 | +| 7.3.50 | User-Id..... | 120 | +| 7.3.51 | Equipment-Status..... | 120 | +| 7.3.52 | Regional-Subscription-Zone-Code..... | 121 | +| 7.3.53 | RAND..... | 121 | +| 7.3.54 | XRES..... | 121 | +| 7.3.55 | AUTN..... | 121 | + +| | | | +|---------|--------------------------------------------------------|-----| +| 7.3.56 | KASME..... | 121 | +| 7.3.57 | Confidentiality-Key AVP..... | 121 | +| 7.3.58 | Integrity-Key AVP..... | 121 | +| 7.3.59 | Kc AVP..... | 121 | +| 7.3.60 | SRES..... | 121 | +| 7.3.61 | Void..... | 121 | +| 7.3.62 | PDN-Type..... | 121 | +| 7.3.63 | Trace-Data AVP..... | 122 | +| 7.3.64 | Trace-Reference AVP..... | 122 | +| 7.3.65 | Void..... | 123 | +| 7.3.66 | Void..... | 123 | +| 7.3.67 | Trace-Depth AVP..... | 123 | +| 7.3.68 | Trace-NE-Type-List AVP..... | 123 | +| 7.3.69 | Trace-Interface-List AVP..... | 123 | +| 7.3.70 | Trace-Event-List AVP..... | 123 | +| 7.3.71 | OMC-Id AVP..... | 123 | +| 7.3.72 | GPRS-Subscription-Data..... | 123 | +| 7.3.73 | Complete-Data-List-Included-Indicator..... | 124 | +| 7.3.74 | PDP-Context..... | 124 | +| 7.3.75 | PDP-Type..... | 125 | +| 7.3.75A | Ext-PDP-Type..... | 125 | +| 7.3.76 | Void..... | 125 | +| 7.3.77 | QoS-Subscribed..... | 125 | +| 7.3.78 | CSG-Subscription-Data..... | 125 | +| 7.3.79 | CSG-Id..... | 125 | +| 7.3.80 | Expiration-Date..... | 125 | +| 7.3.81 | Roaming-Restricted-Due-To-Unsupported-Feature..... | 126 | +| 7.3.82 | Specific-APN-Info AVP..... | 126 | +| 7.3.83 | Alert-Reason AVP..... | 126 | +| 7.3.84 | LCS-Info..... | 126 | +| 7.3.85 | GMLC-Number..... | 126 | +| 7.3.86 | LCS-PrivacyException..... | 127 | +| 7.3.87 | SS-Code..... | 127 | +| 7.3.88 | SS-Status..... | 127 | +| 7.3.89 | Notification-To-UE-User..... | 127 | +| 7.3.90 | External-Client..... | 127 | +| 7.3.91 | Client-Identity..... | 128 | +| 7.3.92 | GMLC-Restriction..... | 128 | +| 7.3.93 | PLMN-Client..... | 128 | +| 7.3.94 | Service-Type..... | 128 | +| 7.3.95 | ServiceTypeIdentity..... | 128 | +| 7.3.96 | MO-LR..... | 128 | +| 7.3.97 | Void..... | 129 | +| 7.3.98 | Trace-Collection-Entity AVP..... | 129 | +| 7.3.99 | Teleservice-List..... | 129 | +| 7.3.100 | TS-Code..... | 129 | +| 7.3.101 | Call-Barring-Info..... | 129 | +| 7.3.102 | SGSN-Number..... | 129 | +| 7.3.103 | IDR-Flags..... | 129 | +| 7.3.104 | ICS-Indicator..... | 130 | +| 7.3.105 | Visited-Network-Identifier..... | 130 | +| 7.3.106 | IMS-Voice-Over-PS-Sessions-Supported..... | 131 | +| 7.3.107 | Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions..... | 131 | +| 7.3.108 | Last-UE-Activity-Time..... | 131 | +| 7.3.109 | GMLC-Address..... | 131 | +| 7.3.110 | EPS-User-State..... | 131 | +| 7.3.111 | EPS-Location-Information..... | 132 | +| 7.3.112 | MME-User-State..... | 132 | +| 7.3.113 | SGSN-User-State..... | 132 | +| 7.3.114 | User-State..... | 132 | +| 7.3.115 | MME-Location-Information..... | 133 | + +| | | | +|---------|----------------------------------------|-----| +| 7.3.116 | SGSN-Location-Information..... | 133 | +| 7.3.117 | E-UTRAN-Cell-Global-Identity..... | 134 | +| 7.3.118 | Tracking-Area-Identity..... | 134 | +| 7.3.119 | Cell-Global-Identity..... | 134 | +| 7.3.120 | Routing-Area-Identity..... | 134 | +| 7.3.121 | Location-Area-Identity..... | 134 | +| 7.3.122 | Service-Area-Identity..... | 134 | +| 7.3.123 | Geographical-Information..... | 134 | +| 7.3.124 | Geodetic-Information..... | 134 | +| 7.3.125 | Current-Location-Retrieved..... | 134 | +| 7.3.126 | Age-Of-Location-Information..... | 135 | +| 7.3.127 | Active-APN..... | 135 | +| 7.3.128 | Error-Diagnostic..... | 135 | +| 7.3.129 | Ext-PDP-Address AVP..... | 136 | +| 7.3.130 | UE-SRVCC-Capability..... | 136 | +| 7.3.131 | MPS-Priority..... | 136 | +| 7.3.132 | VPLMN-LIPA-Allowed..... | 136 | +| 7.3.133 | LIPA-Permission..... | 136 | +| 7.3.134 | Subscribed-Periodic-RAU-TAU-Timer..... | 137 | +| 7.3.135 | SIPTO-Permission..... | 137 | +| 7.3.136 | MDT-Configuration..... | 137 | +| 7.3.137 | Job-Type..... | 138 | +| 7.3.138 | Area-Scope..... | 138 | +| 7.3.139 | List-Of-Measurements..... | 138 | +| 7.3.140 | Reporting-Trigger..... | 138 | +| 7.3.141 | Report-Interval..... | 138 | +| 7.3.142 | Report-Amount..... | 138 | +| 7.3.143 | Event-Threshold-RSRP..... | 138 | +| 7.3.144 | Event-Threshold-RSRQ..... | 138 | +| 7.3.145 | Logging-Interval..... | 138 | +| 7.3.146 | Logging-Duration..... | 139 | +| 7.3.147 | Relay-Node-Indicator..... | 139 | +| 7.3.148 | MDT-User-Consent..... | 139 | +| 7.3.149 | PUR-Flags..... | 139 | +| 7.3.150 | Subscribed-VSRVCC..... | 139 | +| 7.3.151 | Equivalent-PLMN-List..... | 140 | +| 7.3.152 | CLR-Flags..... | 140 | +| 7.3.153 | UVR-Flags..... | 140 | +| 7.3.154 | UVA-Flags..... | 140 | +| 7.3.155 | VPLMN-CSG-Subscription-Data..... | 141 | +| 7.3.156 | Local-Time-Zone..... | 141 | +| 7.3.157 | A-MSISDN..... | 141 | +| 7.3.158 | Void..... | 141 | +| 7.3.159 | MME-Number-for-MT-SMS..... | 141 | +| 7.3.160 | Void..... | 142 | +| 7.3.161 | Void..... | 142 | +| 7.3.162 | SMS-Register-Request..... | 142 | +| 7.3.163 | Time-Zone..... | 142 | +| 7.3.164 | Daylight-Saving-Time..... | 142 | +| 7.3.165 | Subscription-Data-Flags..... | 142 | +| 7.3.166 | Measurement-Period-LTE..... | 143 | +| 7.3.167 | Measurement-Period-UMTS..... | 143 | +| 7.3.168 | Collection-Period-RRM-LTE..... | 143 | +| 7.3.169 | Collection-Period-RRM-UMTS..... | 143 | +| 7.3.170 | Positioning-Method..... | 143 | +| 7.3.171 | Measurement-Quantity..... | 143 | +| 7.3.172 | Event-Threshold-Event-I..... | 144 | +| 7.3.173 | Event-Threshold-Event-II..... | 144 | +| 7.3.174 | Restoration-Priority..... | 144 | +| 7.3.175 | SGs-MME-Identity..... | 144 | +| 7.3.176 | SIPTO-Local-Network-Permission..... | 144 | + +| | | | +|---------|-----------------------------------------------|-----| +| 7.3.177 | Coupled-Node-Diameter-ID..... | 144 | +| 7.3.178 | OC-Supported-Features..... | 144 | +| 7.3.179 | OC-OLR..... | 144 | +| 7.3.180 | ProSe-Subscription-Data..... | 144 | +| 7.3.181 | WLAN-offloadability..... | 145 | +| 7.3.182 | WLAN-offloadability-EUTRAN..... | 145 | +| 7.3.183 | WLAN-offloadability-UTRAN..... | 145 | +| 7.3.184 | Reset-ID..... | 145 | +| 7.3.185 | MDT-Allowed-PLMN-Id..... | 146 | +| 7.3.186 | Adjacent-PLMNs..... | 146 | +| 7.3.187 | Adjacent-Access-Restriction-Data..... | 146 | +| 7.3.188 | DL-Buffering-Suggested-Packet-Count..... | 146 | +| 7.3.189 | IMSI-Group-Id..... | 147 | +| 7.3.190 | Group-Service-Id..... | 147 | +| 7.3.191 | Group-PLMN-Id..... | 147 | +| 7.3.192 | Local-Group-Id..... | 148 | +| 7.3.193 | AESE-Communication-Pattern..... | 148 | +| 7.3.194 | Communication-Pattern-Set..... | 148 | +| 7.3.195 | Monitoring-Event-Configuration..... | 149 | +| 7.3.196 | Monitoring-Event-Report..... | 150 | +| 7.3.197 | UE-Reachability-Configuration..... | 150 | +| 7.3.198 | eNodeB-ID..... | 151 | +| 7.3.199 | Supported-Services..... | 151 | +| 7.3.200 | Supported-Monitoring-Events..... | 151 | +| 7.3.201 | AIR-Flags..... | 151 | +| 7.3.202 | UE-Usage-Type..... | 152 | +| 7.3.203 | DRMP..... | 152 | +| 7.3.204 | Non-IP-PDN-Type-Indicator..... | 152 | +| 7.3.205 | Non-IP-Data-Delivery-Mechanism..... | 152 | +| 7.3.206 | Additional-Context-Identifier..... | 153 | +| 7.3.207 | SCEF-Realm..... | 153 | +| 7.3.208 | Subscription-Data-Deletion..... | 153 | +| 7.3.209 | Preferred-Data-Mode..... | 153 | +| 7.3.210 | Emergency-Info..... | 153 | +| 7.3.211 | Load..... | 154 | +| 7.3.212 | V2X-Subscription-Data..... | 154 | +| 7.3.213 | V2X-Permission..... | 154 | +| 7.3.214 | PDN-Connection-Continuity..... | 154 | +| 7.3.215 | eDRX-Cycle-Length..... | 155 | +| 7.3.216 | eDRX-Cycle-Length-Value..... | 155 | +| 7.3.217 | UE-PC5-AMBR..... | 155 | +| 7.3.218 | Extended eNodeB-ID..... | 155 | +| 7.3.219 | MBSFN-Area..... | 155 | +| 7.3.220 | MBSFN-Area-ID..... | 155 | +| 7.3.221 | Carrier-Frequency..... | 156 | +| 7.3.222 | RDS-Indicator..... | 156 | +| 7.3.223 | Service-Gap-Time..... | 156 | +| 7.3.224 | Aerial-UE-Subscription-Information..... | 156 | +| 7.3.225 | Broadcast-Location-Assistance-Data-Types..... | 156 | +| 7.3.226 | Paging-Time-Window..... | 158 | +| 7.3.227 | Operation-Mode..... | 158 | +| 7.3.228 | Paging-Time-Window-Length..... | 158 | +| 7.3.229 | eDRX-Related-RAT..... | 158 | +| 7.3.230 | Core-Network-Restrictions..... | 159 | +| 7.3.231 | Interworking-5GS-Indicator..... | 159 | +| 7.3.232 | Ethernet-PDN-Type-Indicator..... | 159 | +| 7.3.233 | Subscribed-ARPI..... | 159 | +| 7.3.234 | IAB-Operation-Permission..... | 159 | +| 7.3.235 | V2X-Subscription-Data-Nr..... | 160 | +| 7.3.236 | UE-PC5-QoS..... | 160 | +| 7.3.237 | PC5-QoS-Flow..... | 160 | + +| | | | +|-------------------------------|------------------------------------------------------------------|------------| +| 7.3.238 | 5QI..... | 160 | +| 7.3.239 | PC5-Flow-Bitrates..... | 160 | +| 7.3.240 | Guaranteed-Flow-Bitrates..... | 161 | +| 7.3.241 | Maximum-Flow-Bitrates..... | 161 | +| 7.3.242 | PC5-Range..... | 161 | +| 7.3.243 | PC5-Link-AMBR..... | 161 | +| 7.3.244 | Third-Context-Identifier..... | 161 | +| 7.4 | Result-Code and Experimental-Result Values..... | 161 | +| 7.4.1 | General..... | 161 | +| 7.4.2 | Success..... | 161 | +| 7.4.3 | Permanent Failures..... | 161 | +| 7.4.3.1 | DIAMETER_ERROR_USER_UNKNOWN (5001)..... | 161 | +| 7.4.3.2 | DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION (5420)..... | 162 | +| 7.4.3.3 | DIAMETER_ERROR_RAT_NOT_ALLOWED (5421)..... | 162 | +| 7.4.3.4 | DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004)..... | 162 | +| 7.4.3.5 | DIAMETER_ERROR_EQUIPMENT_UNKNOWN (5422)..... | 162 | +| 7.4.3.6 | DIAMETER_ERROR_UNKNOWN_SERVING_NODE (5423)..... | 162 | +| 7.4.4 | Transient Failures..... | 162 | +| 7.4.4.1 | DIAMETER_AUTHENTICATION_DATA_UNAVAILABLE (4181)..... | 162 | +| 7.4.4.2 | DIAMETER_ERROR_CAMEL_SUBSCRIPTION_PRESENT (4182)..... | 162 | +| 8 | User identity to HSS resolution..... | 162 | +| Annex A (normative): | MME mapping table for S6a and NAS Cause Code values..... | 163 | +| Annex B(normative): | SGSN mapping table for S6d and NAS Cause Code values..... | 166 | +| Annex C (normative): | Diameter overload control mechanism..... | 168 | +| C.1 | General..... | 168 | +| C.2 | S6a/S6d interfaces..... | 168 | +| C.2.1 | General..... | 168 | +| C.2.2 | HSS behaviour..... | 168 | +| C.2.3 | MME/SGSN behaviour..... | 168 | +| Annex D (Informative): | Diameter overload control node behaviour..... | 169 | +| D.1 | Message prioritisation over S6a/d..... | 169 | +| Annex E (normative): | Diameter message priority mechanism..... | 169 | +| E.1 | General..... | 169 | +| E.2 | S6a/S6d interfaces..... | 169 | +| E.2.1 | General..... | 169 | +| E.2.2 | HSS, CSS, EIR behaviour..... | 169 | +| E.2.3 | MME/SGSN behaviour..... | 170 | +| Annex F (normative): | Diameter load control mechanism..... | 171 | +| F.1 | General..... | 171 | +| F.2 | S6a/S6d interfaces..... | 171 | +| F.2.1 | General..... | 171 | +| F.2.2 | HSS behaviour..... | 171 | +| F.2.3 | MME/SGSN behaviour..... | 171 | +| Annex G (informative): | Change history..... | 172 | + +## 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 describes the Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) related diameter-based interfaces towards the Home Subscriber Server (HSS) or the CSG Subscriber Server (CSS), and the MME and the SGSN related diameter-based interface towards the Equipment Identity Register (EIR). + +This specification defines the Diameter application for the MME-HSS, S6a reference point, for the MME-CSS, S7a reference point, for the SGSN-HSS, S6d reference point, and for the SGSN-CSS, S7d reference point. The interactions between the HSS/CSS and the MME/SGSN are specified, including the signalling flows. + +This specification defines the Diameter application for the MME-EIR, S13 reference point, and for the SGSN-EIR, S13' reference point. The interactions between the MME/SGSN and the EIR are specified, including the signalling flows. + +In this specification, if there is no specific indication, the following principles apply: + +- "SGSN" refers to an SGSN which at least supports the S4 interface and may support Gn and Gp interfaces. +- "S4-SGSN" refers to an SGSN which supports the S4 interface and does not support Gn and Gp interfaces. +- Gn/Gp-SGSN refers to an SGSN which supports the Gn and Gp interfaces and does not support S4 interface. +- "GPRS subscription data" refers to the parameters in the HLR column in Table 5.2. in 3GPP TS 23.008 [30]. +- "EPS subscription data" refers to the parameters in the HSS column in Table 5.2A-1 in 3GPP TS 23.008 [30]. + +The Evolved Packet System stage 2 description (architecture and functional solutions) is specified in 3GPP TS 23.401 [2] and in 3GPP TS 23.060 [12]. + +SGSN CAMEL Subscription Data are not supported over S6d interface. + +--- + +## 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.401: "GPRS enhancements for E-UTRAN access ". +- [3] 3GPP TS 23.003: "Numbering, addressing and identification". +- [4] Void. + +- [5] 3GPP TS 33.401: "3GPP System Architecture Evolution: Security Architecture". +- [6] Void". +- [7] IETF RFC 2234: "Augmented BNF for syntax specifications". +- [8] 3GPP TS 32.299: "Charging management; Diameter charging applications". +- [9] 3GPP TS 29.229: "Cx and Dx interfaces based on the Diameter protocol". +- [10] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [11] 3GPP TS 29.214: "Policy and Charging Control over Rx reference point". +- [12] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [13] 3GPP TS 22.016: "International Mobile station Equipment Identities (IMEI)". +- [14] IETF RFC 4960: "Stream Control Transmission Protocol". +- [15] Void +- [16] 3GPP TS 33.210: "3G Security; Network Domain Security; IP Network Layer Security".. +- [17] 3GPP TS 29.228: "IP multimedia (IM) Subsystem Cx and Dx Interfaces; Signalling flows and Message Elements". +- [18] 3GPP TS 33.102: "3G Security; Security Architecture". +- [19] 3GPP TS 36.413: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); S1 Application Protocol (S1AP)". +- [20] IETF RFC 5778: "Diameter Mobile IPv6: Support for Home Agent to Diameter Server Interaction". +- [21] 3GPP TS 29.061: "Interworking between the Public Land Mobile Network (PLMN) supporting packet based services and Packet Data Networks (PDN)". +- [22] 3GPP TS 32.298: "Charging Management; CDR parameter description". +- [23] 3GPP TS 32.422: "Telecommunication management; Subscriber and equipment trace; Trace control and configuration management". +- [24] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [25] 3GPP TS 29.329: "Sh Interface based on the Diameter protocol". +- [26] IETF RFC 5447: "Diameter Mobile IPv6: Support for Network Access Server to Diameter Server Interaction". +- [27] IETF RFC 4004: "Diameter Mobile IPv4 Application". +- [28] 3GPP2 A.S0022: "Interoperability Specification (IOS) for Evolved High Rate Packet Data (eHRPD) Radio Access Network Interfaces and Interworking with Enhanced Universal Terrestrial Radio Access Network (E-UTRAN)". +- [29] 3GPP TS 23.011: "Technical realization of Supplementary Services - General Aspects". +- [30] 3GPP TS 23.008: "Organization of subscriber data". +- [31] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols; Stage 3". +- [32] IETF RFC 5516: "Diameter Command Code Registration for Third Generation Partnership Project (3GPP) Evolved Packet System (EPS)". +- [33] 3GPP TS 32.251: "Telecommunication management; Charging management; Packet Switched (PS) domain charging". + +- [34] 3GPP TS 23.292: "IP Multimedia Subsystem (IMS) centralized services ". +- [35] 3GPP TS 23.216: "Single Radio Voice Call Continuity (SRVCC)". +- [36] 3GPP TS 23.015:"Technical realization of Operator Determined Barring (ODB)". +- [37] 3GPP TS 29.173: "Diameter-based SLh interface for Control Plane LCS". +- [38] 3GPP TS 29.303: "Domain Name System Procedures; Stage 3". +- [39] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp Interface". +- [40] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2". +- [41] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [42] 3GPP TS 22.042: "Network Identity and TimeZone (NITZ); Service description; Stage 1". +- [43] 3GPP TS 23.007: "Restoration procedures". +- [44] 3GPP TS 23.272: "Circuit Switched (CS) fallback in Evolved Packet System (EPS); Stage 2". +- [45] 3GPP TS 29.010: "Information element mapping between Mobile Station - Base Station System (MS - BSS) and Base Station System - Mobile-services Switching Centre (BSS - MSC)". +- [46] 3GPP TS 29.118: "Mobility Management Entity (MME) –Visitor Location Register (VLR)SGs interface specification ". +- [47] 3GPP TS 29.172: "Evolved Packet Core (EPC) LCS Protocol (ELP) between the Gateway Mobile Location Centre (GMLC) and the Mobile Management Entity (MME)". +- [48] 3GPP TS 29.338: "Diameter based protocols to support Short Message Service (SMS) capable Mobile Management Entities (MMEs)". +- [49] 3GPP TS 29.344: "Proximity-services (ProSe) Function to Home Subscriber Server (HSS) aspects; Stage 3". +- [50] IETF RFC 7683: "Diameter Overload Indication Conveyance". +- [51] 3GPP TS 23.380: "IMS Restoration Procedures". +- [52] 3GPP TS 22.153: "Multimedia Priority Service". +- [53] 3GPP TS 23.221: "Architectural requirements". +- [54] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [55] 3GPP TS 23.682: "Architecture enhancements to facilitate communications with packet data networks and applications ". +- [56] 3GPP TS 29.217: "Congestion reporting over Np reference point". +- [57] IETF RFC 7944: "Diameter Routing Message Priority". +- [58] 3GPP TS 43.020: "Security related network functions". +- [59] 3GPP TS 29.273: "Evolved Packet System (EPS); 3GPP EPS AAA interfaces". +- [60] IETF RFC 8583: "Diameter Load Information Conveyance". +- [61] IETF RFC 6733: "Diameter Base Protocol". +- [62] 3GPP TS 36.331: "Evolved Universal Terrestrial Radio Access (E-UTRA); Radio Resource Control (RRC); Protocol specification". + +- [63] 3GPP TS 29.128: "Mobility Management Entity (MME) and Serving GPRS Support Node (SGSN) interfaces for interworking with packet data networks and applications". +- [64] 3GPP TS 24.301: "Non-Access-Stratum (NAS) protocol for Evolved Packet System (EPS); Stage 3". +- [65] 3GPP TS 36.423: "Evolved Universal Terrestrial Radio Access Network (E-UTRAN); X2 Application Protocol (X2AP)". +- [66] 3GPP TS 29.503: "Unified Data Management Services". +- [67] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [68] 3GPP TS 23.287: "Architecture enhancements for 5G System (5GS) to support Vehicle-to-Everything (V2X) services". +- [69] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [70] 3GPP TS 29.563: "5G System; Home Subscriber Server (HSS) services for interworking with Unified Data Management (UDM); Stage 3". +- [71] GSMA PRD IR.73: "Steering of Roaming Implementation Guidelines". + +--- + +## 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]. + +**CSG subscription data from CSS:** It identifies the CSG subscription data that a MME or a SGSN has received from a CSS for a subscriber identified by its IMSI. + +**CSG subscription data from HSS:** It identifies the CSG subscription data that a MME or a SGSN has received from a HSS for a subscriber identified by its IMSI. + +### 3.2 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]. + +| | | +|------|----------------------------------------------------| +| AVP | Attribute Value Pair | +| C | Conditional | +| CSS | CSG Subscriber Server | +| DCN | Dedicated Core Network | +| DRMP | Diameter Routing Message Priority | +| DSCP | Differentiated Services Code Point | +| EIR | Equipment Identity Register | +| ESM | EPS Session Management | +| HSS | Home Subscriber Server | +| IAB | Integrated Access and Backhaul | +| IE | Information Element | +| LAA | Licensed Assisted Access | +| LWA | LTE/WLAN Aggregation | +| LWIP | LTE/WLAN Radio Level Integration with IPsec Tunnel | +| M | Mandatory | +| MME | Mobility Management Entity | +| NR | New Radio | + +| | | +|-----------|----------------------------------------------| +| O | Optional | +| ODB | Operator Determined Barring | +| SCEF | Service Capability Exposure Function | +| URRP-MME | User Reachability Request Parameter for MME | +| URPP-SGSN | User Reachability Request Parameter for SGSN | + +--- + +## 4 General Description + +This document describes the S6a/S6d and S13/S13' interfaces related procedures, message parameters and protocol specifications. + +The procedures, message parameters and protocol are similar between S6a and S6d. S6a is used for location changes of the MME, while S6d is for location changes of the SGSN. Refer to clause 5 for the differences, especially clause 5.2.1. + +The procedures, message parameters and protocol are identical as for the S13 and S13'. See clause 6 for details. + +In the tables that describe the Information Elements transported by each Diameter command, each Information Element is marked as (M) Mandatory, (C) Conditional or (O) Optional in the "Cat." column. For the correct handling of the Information Element according to the category type, see the description detailed in clause 6 of the 3GPP TS 29.228 [17]. + +--- + +## 5 MME – HSS (S6a) and SGSN – HSS (S6d) + +### 5.1 Introduction + +The S6a interface enables the transfer of subscriber related data between the MME and the HSS as described in the 3GPP TS 23.401 [2]. + +The S6d interface enables the transfer of subscriber related data between the SGSN and the HSS as described in 3GPP TS 23.060 [12]. + +### 5.2 Mobility Services + +#### 5.2.1 Location Management Procedures + +##### 5.2.1.1 Update Location + +###### 5.2.1.1.1 General + +The Update Location Procedure shall be used between the MME and the HSS and between the SGSN and the HSS to update location information in the HSS. The procedure shall be invoked by the MME or SGSN and is used: + +- to inform the HSS about the identity of the MME or SGSN currently serving the user, and optionally in addition; +- to update MME or SGSN with user subscription data; subscription data that are applicable to MMEs but not to SGSNs should not be sent to the SGSN unless the SGSN is known to be a combined MME/SGSN; similarly subscription data that are applicable to SGSNs but not to MMEs should not be sent to the MME unless the MME is known to be a combined MME/SGSN. +- to provide the HSS with other user data, such as Terminal Information or UE SRVCC Capability. + +This procedure is mapped to the commands Update-Location-Request/Answer (ULR/ULA) in the Diameter application specified in clause 7. + +Table 5.2.1.1.1/1 specifies the involved information elements for the request. + +Table 5.2.1.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.1.1.1/1: Update Location Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------------|---------------------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Terminal Information (See 7.3.3) | Terminal-Information | O | This information element shall contain information about the user's mobile equipment. Within this Information Element, only the IMEI and the Software-Version AVPs shall be used on the S6a/S6d interface. | +| ULR Flags (See 7.3.7) | ULR-Flags | M | This Information Element contains a bit mask. See 7.3.7 for the meaning of the bits. | +| Visited PLMN Id (See 7.3.9) | Visited-PLMN-Id | M | This IE shall contain the MCC and the MNC, see 3GPP TS 23.003 [3]. It may be used to apply roaming based features. | +| Equivalent PLMN List (See 7.3.151) | Equivalent-PLMN-List | O | This Information Element shall contain the equivalent PLMN list of which the MME/SGSN requests the corresponding CSG Subscription data. | +| RAT Type (See 7.3.13) | RAT-Type | M | This Information Element contains the radio access type the UE is using. See clause 7.3.13 for details. | +| SGSN number (See 7.3.102) | SGSN-Number | C | This Information Element contains the ISDN number of the SGSN, see 3GPP TS 23.003 [3]. It shall be present when the message is sent on the S6d interface and the SGSN supports LCS (using MAP based Lg interface) or SMS functionalities or the Gs interface. It may be present when the message is sent on the S6a interface and the requesting node is a combined MME/SGSN. | +| Homogeneous Support of IMS Voice Over PS Sessions | Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions | O | This Information Element, if present, indicates whether or not "IMS Voice over PS Sessions" is supported homogeneously in all TAs or RAs in the serving node (MME or SGSN or combined MME/SGSN).

The value "SUPPORTED" indicates that there is support for "IMS Voice over PS Sessions" in all TAs or RAs.

The value "NOT_SUPPORTED" indicates that there is not support for "IMS Voice over PS Sessions" in any of the TAs or RAs. | +| V-GMLC address | GMLC-Address | C | This Information Element shall contain, if available, the IPv4 or IPv6 address of the V-GMLC associated with the serving node. | +| Active APN | Active-APN | O | This Information Element, if present, contains the list of active APNs stored by the MME or SGSN, including the identity of the PDN GW assigned to each APN. For the case of explicitly subscribed APNs, the following information shall be present:

- Context-Identifier: context id of subscribed APN in use
- Service-Selection: name of subscribed APN in use
- MIP6-Agent-Info: including PDN GW identity in use for subscribed APN
- Visited-Network-Identifier: identifies the PLMN where the PDN GW was allocated

For the case of the Wildcard APN, the following information shall be present:
- Context-Identifier: context id of the Wildcard APN
- Specific-APN-Info: list of APN-in use and related PDN GW identity when the subscribed APN is the wildcard APN

It may be present when MME or SGSN needs to restore PDN GW data in HSS due to a Reset procedure. | +| UE SRVCC Capability | UE-SRVCC-Capability | C | This information element shall indicate if the UE supports or does not support the SRVCC capability and shall be present if the MME or the SGSN supports SRVCC and this information is available to the MME or the SGSN. | +| MME Number for MT SMS | MME-Number-for-MT-SMS | C | This Information Element contains the ISDN number of the MME to route SMS to the UE through the MME, see 3GPP TS 23.003 [3]. It shall be present when the MME supports SMS in MME and wishes to provide SMS in MME. | + +| | | | | +|------------------------------------------|--------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SMS Register Request | SMS-Register-Request | C | This information element is used to inform the HSS if the MME or the SGSN needs to be registered for SMS, prefers not to be registered for SMS or has no preference. It shall be present when the MME supports SMS in MME and requests to be registered for SMS. It shall be present when the SGSN supports "SMS in SGSN" as defined in clause 5.3.18 in 23.060 [12], and requests to be registered for SMS. | +| SGs MME identity | SGs-MME-Identity | O | This information element is used to inform the HSS of the MME identity that the MME will use over the SGs interface. This information element shall be present, if the MME supports this information element and if the MME identity used over SGs is different from the MME Diameter identity used over S6a. | +| Coupled node's Diameter identity | Coupled-Node-Diameter-ID | O | This information element contains the Diameter identity of the coupled node (i.e. MME's Diameter identity for the SGSN and SGSN's Diameter identity for the MME) when the message is sent by the combined MME/SGSN.

This information element may be present when the message is sent on the S6a/S6d interface and the requesting node is a combined MME/SGSN. | +| Adjacent PLMNs | Adjacent-PLMNs | O | This information element, if present, shall contain the list of PLMNs where an UE served by the MME/SGSN is likely to make a handover from the PLMN where the MME/SGSN is located. This list is statically configured by the operator in the MME/SGSN, according to the geographical disposition of the different PLMNs in that area, the roaming agreements, etc... | +| Supported Services (3GPP TS 29.336 [54]) | Supported-Services | O | If present, this Information Element shall contain AVPs indicating details of the services supported by the MME/SGSN. | + +**Table 5.2.1.1/2: Update Location Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result (See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable:
- User Unknown
- Unknown EPS Subscription
- RAT Not Allowed
- Roaming Not Allowed | +| Error-Diagnostic | Error-Diagnostic | O | If the Experimental Result indicates "Unknown EPS Subscription", Error Diagnostic may be present to indicate whether or not GPRS subscription data are subscribed (i.e. whether or not Network Access Mode stored in the HSS indicates that only circuit service is allowed).

If the Experimental Result indicates "Roaming Not Allowed", and the Update Location is rejected due to ODB, Error Diagnostic may be present to indicate the specific type of ODB. | +| ULA-Flags (See 7.3.8) | ULA-Flags | C | This Information Element contains a bit mask. See 7.3.8 for the meaning of the bits. It shall be present only when the Result-Code AVP is DIAMETER_SUCCESS. | +| Subscription Data (See 7.3.2) | Subscription-Data | C | This Information Element shall contain the complete subscription profile of the user. It shall be present if success is reported, unless an explicit "skip subscriber data" indication was present in the request. | +| Reset-IDs (See 7.3.184) | Reset-ID | O | The Reset-ID uniquely identifies a fallible resource in the HSS on which the user (IMSI) depends. In the event of a restart of the fallible resource a Reset message containing the Reset-ID will exactly identify the impacted subscribers. | + +#### 5.2.1.1.2 Detailed behaviour of the MME and the SGSN + +The MME shall make use of this procedure to update the MME identity stored in the HSS (e.g. at initial attach, inter MME tracking area update or radio contact after HSS reset). + +The SGSN shall make use of this procedure to update the SGSN identity stored in the HSS (e.g. at initial attach, inter SGSN routing area update or radio contact after HSS reset). + +The MME shall make use of this procedure to request SMS data and to become registered for SMS. + +The SGSN shall make use of this procedure to request to become registered for SMS. + +A combined MME/SGSN which uses different Diameter Identities for the MME and SGSN parts shall not send a second ULR when in a first ULA the ULA-Flag "Separation Indication" was not set. + +For UEs receiving emergency services, in which the UE was not successfully authenticated, the MME or SGSN shall not make use of the Update Location procedure. + +If the Update Location request is to be sent due to an inter node (SGSN to MME) update and the previous SGSN is a Gn/Gp SGSN, the MME shall set the "Single-Registration-Indication" flag in the ULR-Flags information element in the request. + +If the Update Location request is to be sent due to an initial attach, the MME or SGSN shall set the "Initial-Attach-Indicator" flag in the ULR-Flags information element in the request. + +If the Update Location request is sent due to a Tracking Area Update following intra-PLMN inter-MME or AMF to MME handover, then the MME may set the Intra-PLMN-inter-MME handover flag in the ULR-Flags information element in the request. + +If the Update Location request is sent due to a Tracking Area Update following inter-PLMN inter-MME or AMF to MME handover, then the MME may set the Inter-PLMN-inter-MME handover flag in the ULR-Flags information element in the request. + +In order to avoid handovers failing (including the cases of emergency and non-emergency EPS fallback voice handovers), the Intra-PLMN-inter-MME handover flag and Inter-PLMN-inter-MME handover flags are required if the HPLMN deploys Steering of Roaming functionality that interferes with the Diameter signalling procedures e.g. as described in the section 6.1 of GSMA PRD IR.73 [71]. Otherwise, these flags are left to be configured based on operator policy. + +NOTE 0: It is useful if the HPLMN discloses how they do Steering of Roaming to the VPLMN. The VPLMN can be configured to comply if they support this feature in the MME. + +When receiving and supporting Reset-ID AVPs in the response, the MME or SGSN shall delete all the stored Reset-IDs, if there are any, and then store all the received Reset-IDs. + +A combined MME/SGSN shall set the "Skip Subscriber Data" flag in the ULR-Flags if subscriber data are already available due to a previous identical location update. Otherwise the MME/SGSN shall not set the "Skip Subscriber Data" flag in the ULR-Flags. + +A combined MME/SGSN that has advertised its support for the combined MME/SGSN capability, by either including the SGSN Number within ULR sent over S6a or including the Coupled-Node-Diameter-ID within ULR sent over S6a/S6d or by using same Diameter identity over S6a and S6d interfaces, shall be prepared to receive a single subscription data update message (IDR or DSR) from the HSS when the subscription data is modified. + +If the MME or SGSN knows about the homogeneity of the support of IMS Voice over PS Sessions in all TAs or RAs associated to that serving node (i.e., it is supported in all the TA/RAs or it is not supported in any of the TA/RAs) and for the serving subscriber taking into account roaming relationship for IMS Voice over PS Sessions, it shall include this indication to the HSS in the "Homogeneous Support of IMS Voice over PS Sessions" IE. + +The MME or SGSN may include dynamic APN and PGW ID data in the list of Active-APN AVPs, in order to restore this information in the HSS after a Reset procedure. + +The MME/SGSN may include an equivalent PLMN list to request the CSG Subscription data of the equivalent PLMNs. + +A standalone MME shall not indicate its support for any SGSN specific features, and it shall not request explicitly the download of GPRS data (via the GPRS-Subscription-Data-Indicator flag; see clause 7.3.7). A standalone MME that does not support the "SMS in MME" feature shall not provide its MME Number for MT SMS, "SMS only" indication or SMS Registration Request and therefore not indicate its support for any SMS related features (such as ODB or barring services). + +For an SGSN, if a DIAMETER\_ERROR\_CAMEL\_SUBSCRIPTION\_PRESENT is received, the SGSN shall initiate the update location procedure with MAP over Gr interface and use Gr for the subsequent mobility procedures. + +For a standalone MME or SGSN, if EPS or GPRS subscription data is received, the standalone MME or SGSN shall replace all of the EPS or GPRS subscription data of the user in the MME or SGSN. Any optional EPS or GPRS data not received, but stored in the standalone MME or SGSN, shall be deleted. + +For a combined MME/SGSN, if EPS subscription data of the user is received, it shall replace all of the EPS subscription data of the user. Any optional EPS data not received by the combined MME/SGSN, but stored in the MME/SGSN, shall be deleted. + +For a combined MME/SGSN, if GPRS subscription data of the user is received, it shall replace all of the GPRS subscription data of the user. Any optional GPRS data not received by the combined MME/SGSN, but stored in the MME/SGSN, shall be deleted. + +When receiving an Update Location response from the HSS, the MME or SGSN shall check the result code. If it indicates success the MME or SGSN shall store the received subscription profile (if any), and it shall store the HSS identity as received in the Origin-Host AVP. + +If an Additional MSISDN (A-MSISDN) is available in the subscription data and downloaded in the A-MSISDN AVP to the MME/SGSN in an Update Location and if the MME or SGSN supports the additional MSISDN feature, the MME or SGSN shall use the Additional MSISDN as C-MSISDN. + +For UEs receiving emergency services (i.e. emergency attached UEs or normal attached UEs with a UE Requested PDN Connection for emergency services), and if the MME or SGSN supports emergency services for users in limited service state, the MME or SGSN shall proceed even if the Update Location procedure fails (e.g. authenticated users with roaming restrictions or RAT-Type restrictions in HSS). + +When receiving GPRS-Subscription-Data AVP in the response, the SGSN or combined MME/SGSN shall delete all the stored PDP-Contexts, if there are any, and then store all the received PDP-Contexts. + +When receiving the APN-Configuration-Profile AVP in a ULA, the MME or SGSN shall delete all the stored APN-Configurations, if there are any, and then store all the received APN-Configurations. + +For each of the received APN-Configurations in the APN-Configuration-Profile, if both the MIP6-Agent-Info and the PDN-GW-Allocation-Type AVPs are absent in the APN-Configuration AVP and the MME or SGSN does not have any associated PGW information, the MME or SGSN shall perform the PGW selection (static or dynamic) according to the local configuration. If MIP6-Agent-Info is present, and PDN-GW-Allocation-Type is not present, this means that the PDN GW address included in MIP6-Agent-Info has been statically allocated. If the MIP6-Agent-Info contains an FQDN of the PDN GW, the MME shall retrieve the PGW PLMN ID from the MIP-Home-Agent-Host AVP within the MIP6-Agent-Info AVP. + +When receiving an Update Location response from the HSS in the TAU or RAU procedure, for each of the received APN-Configurations in the APN-Configuration-Profile, if both the MIP6-Agent-Info and the PDN-GW-Allocation-Type AVPs are absent in the APN-Configuration AVP and the MME or SGSN has associated PGW information and the UE-level access restriction "HO-To-Non-3GPP-Access Not Allowed" is not set, the MME or SGSN should send a Notify Request if HO to the WLAN is supported in the network, including the APN and PDN GW identity to the HSS in order to restore this information in the HSS e.g. after a Reset procedure. + +If the MME/SGSN supports interworking with Gn/Gp-SGSNs, it shall ensure that the Context-Identifier sent over GTPv1 for each of the received APN-Configurations is within the range of 1 and 255. + +NOTE 1: If the MME/SGSN receives from HSS a Context-Identifier value higher than 255, how this value is mapped to a value between 1 and 255 is implementation specific. + +If the subscriber is not roaming and the SIPTO-Permission information for an APN is present, the MME or SGSN shall allow SIPTO above RAN for that APN only if the SIPTO-Permission information indicates so. + +If the subscriber is not roaming and the SIPTO-Permission information for an APN is not present, the MME or SGSN may allow SIPTO above RAN for that APN. + +If the subscriber is roaming and the SIPTO-Permission information for an APN is present, the MME or SGSN shall allow SIPTO above RAN for that APN only if the SIPTO-Permission information indicates so and the VPLMN Dynamic Address is allowed and the MME or SGSN selects a PDN GW in the VPLMN. + +If the subscriber is roaming and the SIPTO-Permission information for an APN is not present, the MME or SGSN shall not allow SIPTO above RAN for that APN. + +NOTE 2: Based on local configuration, the MME or SGSN can determine not to allow SIPTO above RAN for an APN, regardless if the SIPTO-Permission information is present. + +If the subscriber is not roaming and the SIPTO-Local-Network-Permission information for an APN is present, the MME or SGSN shall allow SIPTO at the local network for that APN only if the SIPTO-Local-Network-Permission information indicates so. + +If the subscriber is not roaming and the SIPTO-Local-Network-Permission information for an APN is not present, the MME or SGSN may allow SIPTO at the local network for that APN. + +If the subscriber is roaming and the SIPTO-Local-Network-Permission information for an APN is present, the MME or SGSN shall allow SIPTO at the local network for that APN only if the SIPTO-Local-Network-Permission information indicates so and the VPLMN Dynamic Address is allowed and the MME or SGSN selects a L-GW in the VPLMN. + +If the subscriber is roaming and the SIPTO-Local-Network-Permission information for an APN is not present, the MME or SGSN shall not allow SIPTO at the local network for that APN. + +NOTE 3: Based on local configuration, the MME or SGSN can determine not to allow SIPTO at the local network for an APN, regardless if the SIPTO-Local-Network-Permission information is present. + +If MPS-Priority AVP is present and the UE is subscribed to the eMLPP or 1x RTT priority service in the CS domain as indicated by the MPS-CS-Priority bit of the AVP, the MME shall allow the UE to initiate the RRC connection with higher priority than other normal UEs during CS Fallback procedure. If the MPS-Priority AVP is present and the UE is subscribed to MPS in the EPS domain as indicated by the MPS-EPS-Priority bit of the AVP, the MME shall allow the UE to initiate the RRC connection with higher priority than other normal UEs. + +If the subscriber is not roaming, the MME or SGSN may allow or prohibit the UE to use LIPA as indicated by LIPA-Permission for a specific APN. + +If the subscriber is roaming and the VPLMN-LIPA-Allowed AVP indicates that the UE is not allowed to use LIPA in the VPLMN where the UE is attached, the MME or SGSN shall not provide LIPA for the UE and shall not consider the LIPA-Permission AVP. If the VPLMN-LIPA-Allowed AVP indicates that the UE is allowed to use LIPA in the VPLMN, the MME or SGSN may allow or prohibit the UE to use LIPA as indicated by LIPA-Permission for a specific APN. The VPLMN-Dynamic-Address-Allowed AVP shall not be considered if it is received when the MME or SGSN establishes a PDN connection with LIPA. + +If the LIPA-Permission information for an APN indicates LIPA only, the MME or SGSN shall only allow LIPA for that APN via the authorized CSGs according to the CSG Subscription Data. If the LIPA-Permission information for an APN indicates LIPA prohibited, the MME or SGSN shall not allow LIPA for that APN. If the LIPA-Permission information for an APN indicates LIPA conditional, the MME or SGSN shall allow non LIPA, and LIPA for that APN via the authorized CSGs according to the CSG Subscription Data. If the LIPA-Permission AVP is not present for a specific APN, the APN shall not be allowed to use LIPA. + +The LIPA-Permission information for the Wildcard APN shall apply to any APN that is not explicitly present in the subscription data. + +The SIPTO-Permission information for the Wildcard APN shall apply to any APN that is not explicitly present in the subscription data. + +The SIPTO-Local-Network-Permission information for the Wildcard APN shall apply to any APN that is not explicitly present in the subscription data. + +If the subscription data received for a certain APN indicates that the APN was authorized as a consequence of having the Wildcard APN in the user subscription in HSS, then the MME shall not store this APN data beyond the lifetime of the UE session and the MME shall delete them upon disconnection of the UE. + +If the MME supports the Relay Node functionality (see 3GPP TS 36.300 [40]) and the subscription data indicates that the subscriber is not a relay, the MME shall reject the attach request from a device attempting to attach to EPS as a Relay Node. If a device requests to be attached to EPS as an UE, the MME shall proceed with the attach procedure regardless of the content of the Relay Node Indicator. + +If trace data are received in the subscriber data, the MME or SGSN shall start a Trace Session. For details, see 3GPP TS 32.422 [23]. + +If the Ext-PDP-Type AVP is present in the PDP-Context AVP, the SGSN or combined MME/SGSN shall ignore the value of the PDP-Type AVP. + +If the subscriber is not roaming and the Subscribed-Periodic-RAU-TAU-Timer information is present, the MME or SGSN shall allocate the subscribed value to the UE as periodic RAU or TAU timer. If the subscriber is roaming and the Subscribed-Periodic-RAU-TAU-Timer information is present, the MME or SGSN may use the subscribed periodic RAU/TAU timer value as an indication to decide for allocating a locally configured periodic RAU/TAU timer value to the UE. + +For a combined MME/SGSN, the node may include the Coupled-Node-Diameter-ID AVP to allow the HSS to determine if the UE is served by the MME and SGSN parts of the same combined MME/SGSN. When the message is sent over S6a interface and if this AVP is included, the MME shall include the Diameter identity of the coupled SGSN which is used by the SGSN over S6d interface. When the message is sent over S6d interface and if this AVP is included, the SGSN shall include the Diameter identity of the coupled MME which is used by the MME over S6a interface. + +NOTE 4: The Coupled-Node-Diameter-ID AVP allows the HSS to determine if the UE is served by the MME and SGSN parts of the same combined MME/SGSN, when the SGSN number is not available and when Diameter identity of S6a and S6d interfaces of the combined MME/SGSN are not the same. + +If the MME supports the "SMS in MME" feature and the UE has requested a combined EPS/IMSI attach or Combined TA/LA Update (see 3GPP TS 23.272 [44]) and the MME is not currently registered for SMS, the MME requests to be registered for SMS by indicating its MME Number for MT SMS in the request, including the SMS-Register-Request AVP and the SMS-Only-Indication flag set in the ULR-Flags AVP if UE indicates "SMS only". + +If the MME supports the "SMS in MME" feature, when receiving an EPS attach or a TAU from a UE accessing NB-IoT which requests SMS by indicating "SMS transfer without Combined Attach" (see 3GPP TS 23.401 [2]), and if the MME is not currently registered for SMS, the MME requests to be registered for SMS by indicating its MME Number for MT SMS in the request, including the SMS-Register-Request AVP. + +If the HSS provides the MME with SMS data in the ULA and the ULA-Flags is received with "MME Registered for SMS" flag set, the MME shall store this data for providing SMS in MME service and consider itself registered for SMS. + +If the SGSN supports the "SMS in SGSN" feature as specified in 3GPP TS 23.060 [12], clause 5.3.18, and wishes to provide SMS via SGSN it shall set the "SMS in SGSN" flag in the Feature-List AVP, and include SMS-Register-Request AVP. If the SGSN supports the Diameter based Gdd interface for SMS in SGSN, it shall set the "Gdd-in-SGSN" flag in the Feature-List AVP. If the UE has indicated "SMS-Only" this shall be indicated to the HSS setting the SMS-Only-Indication flag in the ULR-Flags AVP. + +NOTE 5: the setting of the "SMS in SGSN" feature bit reflects the "SMS in SGSN Offered" as described in stage 2 above. + +If the SMS-In-SGSN-Allowed-Indication flag is set in the received Subscription-Data-Flags AVP, the SGSN shall store the subscription data for providing SMS in SGSN service. + +If the subscriber is not roaming and the Restoration-Priority information for a certain APN is present, the MME or SGSN shall consider the subscribed value as the relative priority of the user's PDN connection among PDN connections to the same APN when restoring PDN connections affected by an SGW or PGW failure/restart (see 3GPP TS 23.007 [43]). If the subscriber is roaming and the Restoration-Priority information for a certain APN is present, the MME or SGSN may use the subscribed value as an indication of the relative priority of the user's PDN connection among PDN connections to the same APN based on service level agreements. The MME/SGSN may use a locally configured value as default restoration priority if the Restoration-Priority AVP for a certain APN is not present, or if it is not permitted by service level agreements for an in-bound roamer. + +If the subscription data received for a certain APN includes WLAN-offloadability AVP, then the MME or SGSN shall determine the offloadability of the UE's PDN Connection(s) to that APN based on subscription data and locally configured policy (e.g. for roaming users or when the subscription data does not include any offloadability indication). + +NOTE 6: As indicated in clause 7.3.31, if the UE-level access restriction "HO-To-Non-3GPP-Access Not Allowed" is set, the offload of PDN Connections to WLAN is not allowed for any APN. + +If the subscription data received for the user includes the DL-Buffering-Suggested-Packet-Count AVP, then the MME or SGSN should take into account the subscription data, in addition to local policies, to determine whether to invoke extended buffering of downlink packets at the SGW for High Latency Communication. Otherwise, the MME or SGSN shall make this determination based on local policies only. + +When receiving IMSI-Group-Id AVP(s) within the Subscription-Data AVP, the MME or SGSN shall replace stored IMSI-Group Ids (if any) with the received information rather than add the received information to the stored information. + +When receiving one or more Monitoring-Event-Configuration AVP(s) in the ULA, the MME or SGSN shall start the detection of the Monitoring events indicated in those AVP(s), if not already started, and shall stop the detection and delete the previous monitoring events (if any) which are not indicated in those AVP(s). If there is a failure when starting the detection (e.g. maximum resources exceeded), the MME or SGSN shall not store the failed configuration(s) and shall send a notification of those events whose configuration have failed, as described in clause 5.2.5.1.2 (NOR/NOA commands). If the Subscription-Data AVP is received in the ULA but it does not contain any Monitoring-Event-Configuration AVP(s), the MME or SGSN shall stop the detection and delete all stored monitoring event configurations (if any). + +If the MME/SGSN supports Monitoring, the MME/SGSN shall include the Supported-Services AVP with Supported-Monitoring-Events included in the ULR command. + +If the MME and the UE support Attach without PDN connection (i.e. EMM-REGISTERED without PDN connection) and the PDN-Connection-Restricted flag is set in the received Subscription-Data-Flags AVP, the MME shall not establish any non-emergency PDN connection and shall tear down any existing non-emergency PDN connection for this user. + +If the subscription data received for the user includes the Preferred-Data-Mode AVP, for an IP APN configuration or for a non-IP APN configuration with SGi based delivery, then the MME should (if the subscriber is not roaming) or may (if the subscriber is roaming) take into account the subscription data, in addition to local policies and the UE's Preferred Network Behaviour, to determine whether to transmit the traffic associated with this APN over the User Plane and/or over the Control Plane. Otherwise, the MME shall make this determination based on local policies and the UE's Preferred Network Behaviour only. + +If the MME receives from the HSS an Update Location response containing the Emergency-Info AVP in the Subscription-Data, the MME shall use the PDN-GW identity included in Emergency-Info as the PDN-GW used to establish emergency PDN connections with the emergency APN, for non-roaming authenticated UEs requesting the handover of an emergency PDN connection if the MME is configured to use a dynamic PDN-GW for emergency services for such user. + +When receiving V2X-Subscription-Data in the ULA, the MME shall determine whether the UE is authorized to use V2X communication over PC5 according to V2X subscription data and UE provided network capability. If the UE is authorized to use V2X communication over PC5, the MME shall store the "V2X service authorized" indication together with the UE AMBR used for PC5 interface (i.e. UE-PC5-AMBR), and provide such information to the eNodeB when needed. + +If the MME/SGSN receives from the HSS an Update Location response without the bit set for "NR as Secondary RAT" in the Feature-List AVP, the MME/SGSN, based on local policy, may restrict access for NR as secondary RAT when all relevant entities except HSS supports it. + +If the MME receives from the HSS an Update Location response containing in the subscription data the Core-Network-Restrictions AVP with the bit "5GC not allowed" set, the MME shall restrict mobility towards 5GC. + +#### 5.2.1.1.3 Detailed behaviour of the HSS + +When receiving an Update Location request the HSS shall check whether subscription data exists for the IMSI. + +If the HSS determines that there is not any type of subscription for the IMSI (including EPS, GPRS and CS subscription data), a Result Code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If the Update Location Request is received over the S6a interface, and the subscriber has not any APN configuration, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +If the Update Location Request is received over S6a, from an MME that does not support the "Non-IP PDN Type APNs" feature, and the user's subscription profile contains only APN configurations of type "Non-IP", the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +If the Update Location Request is received over the S6d interface, and the subscriber has neither an APN configuration profile nor GPRS subscription data, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +When sending DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION, an Error Diagnostic information may be added to indicate whether or not GPRS subscription data are subscribed (i.e. whether or not Network Access Mode stored in the HSS indicates that only CS service is allowed). + +The HSS shall check whether the RAT type the UE is using is allowed for the subscriber in the serving PLMN. If it is not, a Result Code of DIAMETER\_ERROR\_RAT\_NOT\_ALLOWED shall be returned. + +The HSS shall check whether access to EPC is allowed, based on the active Core Network Restrictions of the subscriber. If access to EPC is restricted, a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION shall be returned. + +The HSS shall check whether roaming is not allowed in the VPLMN due to ODB. If so a Result Code of DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED shall be returned. When this error is sent due to the MME or SGSN not supporting a certain ODB category, an Error Diagnostic information element may be added to indicate the type of ODB; if this error is sent due to the ODB indicating "Barring of Roaming", Error Diagnostic shall not be included. + +If the Update Location Request is received over the S6d interface and the HSS supports the "SGSN CAMEL Capability" feature, and the SGSN indicates support of SGSN CAMEL capability, the HSS shall check if the subscriber has SGSN CAMEL Subscription data. If the subscriber has SGSN CAMEL Subscription data, the HSS shall return a Result Code of DIAMETER\_ERROR\_CAMEL\_SUBSCRIPTION\_PRESENT. + +If the Update Location Request is received over the S6a interface, the HSS shall send a Cancel Location Request with a Cancellation-Type of MME\_UPDATE\_PROCEDURE (CLR; see clause 7.2.7) to the previous MME (if any) and replace the stored MME-Identity with the received value (the MME-Identity is received within the Origin-Host AVP). The HSS shall reset the "UE purged in MME" flag and delete any stored last known MME location information of the (no longer) purged UE. If the "Single-Registration-Indication" flag was set in the received request, the HSS shall send a Cancel Location Request with a Cancellation-Type of SGSN\_UPDATE\_PROCEDURE to the SGSN (MAP Cancel Location), and delete the stored SGSN address and SGSN number. If the "Initial-Attach-Indicator" flag was set in the received request, and the "Single-Registration-Indication" flag was not set, the HSS shall send a Cancel Location Request with a Cancellation-Type of INITIAL\_ATTACH\_PROCEDURE (CLR; see clause 7.2.7, or MAP Cancel Location) to the SGSN if there is an SGSN registration. + +If the Update Location Request is received over the S6d interface, the HSS shall send a Cancel Location Request with a Cancellation-Type of SGSN\_UPDATE\_PROCEDURE (CLR; see clause 7.2.7, or MAP Cancel Location) to the previous SGSN (if any) and replace the stored SGSN-Identity with the received value (the SGSN-Identity is received within the Origin-Host AVP). The HSS shall reset the "UE purged in SGSN" flag and delete any stored last known SGSN location information of the (no longer) purged UE. If the "Initial-Attach-Indicator" flag was set in the received request, the HSS shall send a Cancel Location Request with a Cancellation-Type of INITIAL\_ATTACH\_PROCEDURE (CLR; see clause 7.2.7) to the MME if there is an MME registration. + +When the HSS receives the Update Location Request, if a 15th digit of the IMEI AVP is received, the HSS may discard the digit. + +If the Update Location Request includes either the ULR-flag Inter-PLMN-inter-MME or the ULR-flag intra-PLMN-inter-MME, then the HSS may ignore this information. + +NOTE 1: These flags are intended for use by Steering of Roaming functions that are not standardised by 3GPP and which operate by interfering with the Diameter procedures. + +If the Update Location Request includes the list of active APNs, the HSS shall delete all the stored dynamic PDN GW information, if there are any, and then replace them by the PDN GW information received in the list of Active-APN AVPs. + +If the Update Location Request includes an equivalent PLMN list, the HSS shall return the CSG list (if any) for each equivalent PLMN to the MME with the subscription data, and Visited-PLMN-Id AVP shall be present in the CSG-Subscription-Data AVP to indicate the corresponding PLMN. If there is no equivalent PLMN list received, the HSS may not include Visited-PLMN-Id AVP in the CSG-Subscription-Data AVP, and the CSG-Subscription-Data AVP shall contain the CSG subscription data of the registered PLMN of the MME or the SGSN. + +If the Update Location Request is received over the S6a interface for a user for which the URRP-MME parameter is set in the HSS, the HSS shall clear the URRP-MME parameter and send an indication to the corresponding Service Related Entities. + +If the Update Location Request is received over the S6d interface for a user for which the URRP-SGSN parameter is set in the HSS, the HSS shall clear the URRP-SGSN parameter and send an indication to the corresponding Service Related Entities. + +If no result code has been sent to the MME or SGSN so far, the HSS shall include the subscription data in the ULA command according to the ULR-Flags and the supported/unsupported features of the MME or SGSN, unless an explicit "skip subscriber data" indication has been received in the request, and shall return a Result Code of DIAMETER\_SUCCESS. + +When the APN-Configuration-Profile AVP is present in the Subscription-Data AVP sent within a ULA, the AVP shall contain at least the default APN Configuration and a Context-Identifier AVP that identifies the per subscriber's default APN configuration. The default APN Configuration shall not contain the Wildcard APN (see 3GPP TS 23.003 [3], clause 9.2); the default APN shall always contain an explicit APN. + +The GPRS Subscription data (if available in the HSS) shall only be present in the ULA command if it was indicated by the serving node in the ULR-Flags AVP (see clause 7.3.7), or when the subscription data is returned by a Pre-Rel-8 HSS (via an IWF) or when the Update Location Request is received over the S6d interface and there is no APN configuration profile stored for the subscriber. + +The HSS shall use the indication received in the GPRS-Subscription-Data-Indicator for future use in the subscriber data update procedures. + +The HSS shall store the new terminal information and/or the new UE SRVCC capability, if they are present in the request. If the UE SRVCC capability is not present, the HSS shall store that it has no knowledge of the UE SRVCC capability. + +If the MME/SGSN indicates support of the Additional-MSISDN feature and an additional MSISDN (A-MSISDN) is available in the subscription data, the HSS shall send the provisioned additional MSISDN together with the MSISDN. + +If the MME/SGSN does not support the Additional-MSISDN feature, the HSS shall populate the MSISDN AVP either with the subscribed MSISDN or the subscribed additional MSISDN based on operator policy and availability. + +NOTE 2: When the MME/SGSN does not support the Additional-MSISDN feature, the MME/SGSN will use the MSISDN from the MSISDN AVP as C-MSISDN. + +LCS-Info, Teleservice-List and Call-Barring-Info data shall be included according to the list of supported features indicated by the serving node (see clause 7.3.10). + +If the HSS supports the "SMS in MME" feature and receives the indication that the MME supports the "SMS in MME" feature and requests to be registered for SMS by including the MME Number for MT SMS, SMS-Register-Request AVP and/or setting the SMS-Only-Indication flag in the ULR-Flags AVP if indicated from the UE, the HSS shall determine if SMS can be provided via the MME as described in 3GPP TS 23.272 [44]. If SMS in MME is accepted the HSS shall register the MME for SMS, store the "MME number for MT SMS" as the corresponding MSC number to be used for MT SMS and return an indication of MME registered for SMS in ULA-Flags AVP. + +If the MME is successfully registered for SMS the HSS shall download the available SMS related subscription data that may comprise SMS teleservice, MSISDN, ODB and barring services for SMS according to supported features. Also, if the user is considered as not reachable (i.e., MNRF flag is set in HSS for that user), and the UE is considered to have free available memory (i.e., MCEF flag is not set in HSS for that user), the HSS shall send a MAP-Alert-Service-Centre message or S6c-Alert-Service-Centre-Request to the SMS-IWMSC (see 3GPP TS 29.338 [48]). + +If the HSS supports the "SMS in SGSN" feature as described in 3GPP TS 23.060 [12], clause 5.3.18 and receives the indication from the SGSN that it supports "SMS in SGSN" feature, and SMS-Register-Request AVP and/or the SMS-Only-Indication flag in the ULR-Flags AVP if indicated from the UE, and the PS subscriber data allow for SMS services (e.g. the subscription information indicates "PS and SMS-Only"), the HSS shall determine if SMS can be provided via the SGSN as described in 3GPP TS 23.060 [12]. If "SMS in SGSN" is accepted the HSS shall indicate in the ULA that "SMS in SGSN" is allowed to the SGSN and shall handle MT SMS as described in 3GPP TS 23.060 [12], clause 5.3.18. If the HSS supports the "Gdd-in-SGSN" feature and receives the indication from the SGSN that it supports the "Gdd-in-SGSN" feature, the HSS shall store the information that the SGSN supports the Gdd interface. Also, if the user is considered as not reachable (i.e., MNRG flag is set in HSS for that user), and the UE is considered to have free available memory (i.e., MCEF flag is not set in HSS for that user), the HSS shall send a MAP-Alert-Service-Centre message or S6c-Alert-Service-Centre-Request to the SMS-IWMSC (see 3GPP TS 29.338 [48]). + +The HSS may use the indication received in the Node-Type-Indicator for future use in the subscriber data update procedures. + +Subscriber-Status AVP shall be present in the Subscription-Data AVP when sent within a ULA. If the value "OPERATOR\_DETERMINED\_BARRING" is sent, the Operator-Determined-Barring AVP or HPLMN-ODB AVP shall also be present in the Subscription-Data AVP, or vice versa. + +Access-Restriction-Data AVP shall be present within the Subscription-Data AVP sent within a ULA if at least one of the defined restrictions applies. + +The AMBR AVP shall be present in the Subscription-Data AVP when the APN-Configuration-Profile AVP is sent within a ULA (as part of the Subscription-Data AVP) and may be present in the Subscription-Data AVP when the GPRS-Subscription-Data AVP is present. + +The EPS-Subscribed-QoS-Profile AVP and the AMBR AVP shall be present in the APN-Configuration AVP when the APN-Configuration AVP is sent in the APN-Configuration-Profile AVP and when the APN-Configuration-Profile AVP is sent within a ULA (as part of the Subscription-Data AVP). + +For those APNs that have been authorized as a consequence of having the Wildcard APN in the user subscription, the HSS shall include the specific APN name and associated PDN-GW identity inside the APN context of the Wildcard APN. This indicates to the MME that the particular APN shall not be cached in the MME and it shall be deleted when the UE session is terminated. + +If a Result Code of DIAMETER\_SUCCESS is returned, the HSS shall set the Separation Indication in the response. + +If the HSS receives an indication in the ULR command about the homogeneous support of IMS Voice over PS Sessions in all TA/RAs associated to a serving node, it may use this information in the future in order to skip the T-ADS data retrieval, as described in clause 5.2.2.1 (IDR/IDA commands). + +Subscribed-VSRVCC AVP shall be present within the Subscription-Data AVP sent within a ULA only if the user is subscribed to the SRVCC and vSRVCC. + +If the UE is allowed to use Proximity-based Services in the visited PLMN, the HSS shall include ProSe-Subscription-Data AVP within the Subscription-Data AVP sent within a ULA. + +If the HSS receives the SGs MME identity and if the HSS supports this information element, the HSS shall store it for use with VLR restoration. + +If the HSS receives Update Location Request over both the S6a and S6d interfaces then based on the following conditions the HSS concludes if the UE is served by the MME and SGSN parts of the same combined MME/SGSN: + +- if both the messages contain the same SGSN number; or +- if the Diameter identity received over S6a matches with the Diameter identity received over S6d; or +- if the Coupled-Node-Diameter-ID AVP received over S6a interface matches with the Diameter identity received within Origin-Host AVP over S6d interface OR if the Coupled-Node-Diameter-ID AVP received over S6d interface matches with the Diameter identity received within Origin-Host AVP over S6a interface. + +If the HSS supports the handling of access restrictions for adjacent PLMNs, and it receives a list of adjacent PLMNs from the MME/SGSN, the HSS may send the associated Access Restriction Data, according to local operator policies, in the Adjacent-Access-Restriction-Data AVP, so the MME/SGSN can use this information to allow, or prevent, inter-RAT inter-PLMN handovers towards any of the PLMNs indicated by the HSS. The HSS shall not include in the list of + +Adjacent-Access-Restriction-Data the PLMN-ID, and its access restrictions, of the current PLMN where the MME/SGSN is located, since this information is already conveyed in the Access-Restriction-Data AVP inside the Subscription-Data AVP. + +If the HSS supports Monitoring events and receives a Supported-Services AVP it shall only trigger those services which are supported by the MME/SGSN. + +If the HSS has previously received over SWx (see 3GPP TS 29.273 [59]) the identity of the PDN-GW to be used for the establishment of emergency PDN connections, it shall include it as part of the Subscription-Data AVP (in the Emergency-Info AVP), in the Update Location response to the MME. + +If the UE is allowed to use V2X service in the visited PLMN and the MME supports V2X service, the HSS shall include V2X-Subscription-Data AVP into Subscription-Data AVP within the ULA command. + +If the MME/SGSN supports the "External-Identifier" feature, the HSS shall include the External-Identifier associated with Monitoring Event Configuration in the External-Identifier AVP if populated in the subscription. When multiple External Identifiers are defined for a same subscription, the HSS shall send a default External Identifier in the External-Identifier AVP of the Subscription-Data AVP, and shall include a specific External Identifier (if different from the default External Identifier) associated to each Monitoring Event Configuration in the External-Identifier AVP of each Monitoring-Event-Configuration AVP occurrence inside the Subscription-Data AVP. + +The Aerial-UE-Subscription-Information AVP shall be present within the Subscription-Data AVP sent within a ULA only if the user has Aerial UE subscription information. + +## 5.2.1.2 Cancel Location + +### 5.2.1.2.1 General + +The Cancel Location Procedure shall be used between the HSS and the MME and between the HSS and the SGSN to delete a subscriber record from the MME or SGSN. The procedure shall be invoked by the HSS and is used: + +- to inform the MME or SGSN about a subscription withdrawal, or a change in the subscriber profile that does not allow PS services anymore (e.g., the Network Access Mode does not allow PS services), or a change in the subscriber profile that does not allow access to EPC anymore, or +- to inform the MME or SGSN about an ongoing update procedure i.e. MME or SGSN change or +- to inform the MME or SGSN about an initial attach procedure. + +This procedure is mapped to the commands Cancel-Location-Request/Answer (CLR/CLA) in the Diameter application specified in clause 7. + +Table 5.2.1.2.1/1 specifies the involved information elements for the request. + +Table 5.2.1.2.1/2 specifies the involved information elements for the answer. + +**Table 5.2.1.2.1/1: Cancel Location Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Cancellation Type
(See 7.3.24) | Cancellation-Type | M | Defined values that can be used are:
- MME-Update Procedure,
- SGSN-Update Procedure,
- Subscription Withdrawal,
- Update Procedure_IWF,
- Initial Attach Procedure. | +| CLR Flags
(See 7.3.152) | CLR-Flags | O | This Information Element contains a bit mask. See 7.3.152 for the meaning of the bits and the condition for each bit to be set or not. | + +**Table 5.2.1.2.1/2: Cancel Location Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | The result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]). | + +### 5.2.1.2.2 Detailed behaviour of the MME and the SGSN + +When receiving a Cancel Location request the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_SUCCESS is returned. + +If it is known, the MME or SGSN shall check the Cancellation Type and act accordingly. + +If the Cancellation Type is "Subscription Withdrawal", the MME or SGSN shall delete the subscription data and detach the UE; in addition, if the Reattach-Required flag is set, the MME or SGSN shall indicate to the UE to initiate an immediate re-attach procedure, as described in 3GPP TS 23.401 [2] and 3GPP TS 23.060 [12]. A result code of DIAMETER\_SUCCESS shall be returned. + +If a cancellation type of "Initial Attach Procedure" is received, the MME or SGSN shall not delete the subscription data. For details see 3GPP TS 23.401 [2] and 3GPP TS 23.060 [12]. If the MME receives this cancellation type, and it is registered for SMS, it shall consider itself as unregistered for SMS. Also in this case a result code of DIAMETER\_SUCCESS shall be returned. + +When a UE is served by a single combined MME/SGSN for both E-UTRAN and non-E-UTRAN access, the combined MME/SGSN shall check the Cancellation-Type. If it indicates Subscription Withdrawal or Update Procedure\_IWF, the CLR is processed both in the MME part and in the SGSN part of the combined node. If it indicates Initial Attach Procedure, and if the CLR-Flags AVP is received and supported by the combined MME/SGSN, the CLR is processed only in the affected part of the combined node as indicated by the "S6a/S6d-Indicator" flag in the CLR-Flags AVP. Otherwise, the CLR is processed only in the affected part of the combined node and subscription data are kept for the not affected part. + +### 5.2.1.2.3 Detailed behaviour of the HSS + +The HSS shall make use of this procedure when the subscription is withdrawn by the HSS operator, and when the HSS detects that the UE has moved to a new MME or SGSN area, and when EPC access is not allowed due to Core Network Restrictions. + +The HSS+UDM shall also make use of this procedure when the HSS+UDM detects that the UE has moved to a new AMF area, if the AMF indicates to the HSS+UDM to cancel MME and/or SGSN. The HSS+UDM shall include a cancellation type as specified in clause 5.4.2.2 of 3GPP TS 29.563 [70]. + +The HSS shall include a cancellation type of "Subscription Withdrawal" if the subscription is withdrawn by the operator, or if the subscriber profile does not allow PS services anymore, or if the Core Network Restrictions do not allow access to EPC anymore; the HSS may set the Reattach-Required flag in order to request the MME or the SGSN to trigger an immediate reattachment of the UE. + +The HSS shall include a cancellation type of "MME Update Procedure" if the UE moved to a new MME area. + +The HSS shall include a cancellation type of "SGSN Update Procedure" if the UE moved to a new SGSN area. + +The HSS shall include a cancellation type of "Initial Attach Procedure" if the cancel location is initiated due to an Initial Attach from the UE. + +The HSS shall include the CLR-Flags with the "S6a/S6d-Indicator" flag indicating the affected part of the combined node if the cancel location is to be sent to a combined MME/SGSN during initial attach procedure. + +### 5.2.1.3 Purge UE + +#### 5.2.1.3.1 General + +The Purge UE Procedure shall be used between the MME and the HSS and between the SGSN and the HSS to indicate that the subscriber's profile has been deleted from the MME or SGSN either by an MMI interaction or automatically, e.g. because the UE has been inactive for several days. + +This procedure is mapped to the commands Purge-UE-Request/Answer (PUR/PUA) in the Diameter application specified in clause 7. + +Table 5.2.1.3.1/1 specifies the involved information elements for the request. + +Table 5.2.1.3.1/2 specifies the involved information elements for the answer. + +**Table 5.2.1.3.1/1: Purge UE Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 673 3 [61]) | M | This information element shall contain user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| PUR-Flags (See 7.3.149) | PUR-Flags | O | If present, this Information Element shall contain a bitmask. See clause 7.3.149 for the meaning of the bits. | +| EPS-Location-Information (See 7.3.111) | EPS-Location-Information | C | This Information Element shall contain the last known EPS-Location Information of the purged UE. Shall be present if available. | + +**Table 5.2.1.3.1/2: Purge UE Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable:
- User Unknown | +| PUA-Flags
(See 7.3.48) | PUA-Flags | C | This Information Element shall contain a bit mask. See clause 7.3.48 for the meaning of the bits. It shall be present only when the Result-Code AVP is DIAMETER_SUCCESS. | + +### 5.2.1.3.2 Detailed behaviour of the MME and the SGSN + +The MME shall make use of this procedure to set the "UE Purged in the MME" flag in the HSS when the subscription profile is deleted from the MME database due to MMI interaction or after long UE inactivity. + +The SGSN shall make use of this procedure to set the "UE Purged in SGSN" flag in the HSS when the subscription profile is deleted from the SGSN database due to MMI interaction or after long UE inactivity. + +The combined MME/SGSN when using a single Origin-Host identity shall make use of this procedure to set the "UE Purged in MME" and "UE Purged in SGSN" flags in the HSS when the subscription profile is deleted from the common MME/SGSN database due to MMI interaction or after long UE inactivity on all registered accesses. If the HSS has indicated support for the Partial Purge feature (see clause 7.3.10), the combined MME/SGSN may also indicate to the HSS a Purge of the UE in only one of the serving nodes in the combined node (either in the MME or in the SGSN). + +The combined MME/SGSN when using different Origin-Host identities for MME and SGSN shall send two Purge UE Requests as if it was not combined. + +When receiving a Purge UE response from the HSS the MME shall check the Result Code. If it indicates success, the MME shall check the PUA flag "freeze M-TMSI", and if set freeze the M-TMSI i.e. block it for immediate re-use. + +When receiving a Purge UE response from the HSS the SGSN shall check the Result Code. If it indicates success, the SGSN shall check the PUA flag "freeze P-TMSI", and if set freeze the P-TMSI i.e. block it for immediate re-use. + +When receiving a Purge UE response from the HSS the combined MME/SGSN shall check the Result Code. If it indicates success, the combined MME/SGSN shall check the PUA flag "freeze M-TMSI" and "freeze P-TMSI", and if set freeze the M-TMSI and/or the P-TMSI i.e. block it for immediate re-use. + +### 5.2.1.3.3 Detailed behaviour of HSS + +When receiving a Purge UE request the HSS shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If it is known, the HSS shall set the result code to DIAMETER\_SUCCESS and compare the received identity in the Origin-Host with the stored MME-Identity and with the stored SGSN-Identity. + +If the received identity matches the stored MME-identity and the stored SGSN-Identity (no matter whether the node type indicator bit in ULR-Flags was set or clear), then: + +- if the HSS supports the Partial Purge feature (see clause 7.3.10), and the combined MME/SGSN indicated that the UE was purged in only one of the serving nodes, the HSS shall set the PUA flags according to the serving node where the purge was done (i.e., either "freeze M-TMSI" if the purge was done in the MME, or "freeze P-TMSI" if the purge was done in the SGSN); similarly, the HSS shall either set the "UE purged in MME" flag and + +store the received last known MME Location information of the purged UE, or set the "UE purged in SGSN" flag and store the received last known SGSN-Location Information of the purged UE, accordingly; + +- if the HSS does not support the Partial Purge feature, or the combined MME/SGSN did not indicate that the UE was purged in only one of the serving nodes, the HSS shall set the PUA flags "freeze M-TMSI" and "freeze P-TMSI" in the answer message and set the flag "UE purged in MME" and "UE purged in SGSN" and store the received last known EPS Location Information of the purged UE; + +If the received identity matches the stored MME-identity but not the stored SGSN-identity, the HSS shall set the PUA flag "freeze M-TMSI" and clear the PUA flag "freeze P-TMSI" in the answer message, set the flag "UE purged in MME" and store the received last known MME location information of the purged UE; + +If the received identity matches the stored SGSN-identity but not the stored MME-identity, the HSS shall set the PUA flag "freeze P-TMSI" and clear the PUA flag "freeze M-TMSI" in the answer message and set the flag "UE purged in SGSN" and store the received last known SGSN location information of the purged UE; + +If the received identity does not match the stored MME-identity and does not match the stored SGSN-identity, the HSS shall clear the PUA flags "freeze M-TMSI" and "freeze P-TMSI" in the answer message. + +## 5.2.2 Subscriber Data Handling Procedures + +### 5.2.2.1 Insert Subscriber Data + +#### 5.2.2.1.1 General + +The Insert Subscriber Data Procedure shall be used between the HSS and the MME and between the HSS and the SGSN for updating and/or requesting certain user data in the MME or SGSN in the following situations: + +- due to administrative changes of the user data in the HSS and the user is now located in an MME or SGSN, i.e. if the user was given a subscription and the subscription has changed; subscription data that are applicable to MMEs but not to SGSNs should not be sent to the SGSN unless the SGSN is known to be a combined MME/SGSN; similarly subscription data that are applicable to SGSNs but not to MMEs should not be sent to the MME unless the MME is known to be a combined MME/SGSN. +- the operator has applied, changed or removed Operator Determined Barring for this user; +- activate subscriber tracing in the MME or the SGSN; +- to indicate to the MME or SGSN that the HSS has requested to be notified when the UE has become reachable; +- to request from the MME or SGSN the necessary data to support the T-ADS functionality; +- to retrieve location information and/or state information from the MME or the SGSN; +- to retrieve from the MME or the SGSN the Local Time Zone of the location in the visited network where the UE is attached; +- to update the STN-SR (e.g., as a result of an Sh interaction with an SCC-AS). +- to update the MME/SGSN with the identity of a dynamically allocated PDN GW as a result of the first PDN connection establishment associated with an APN over non 3GPP access or 5GS.. +- to update the MME with the identity of a PDN GW for Emergency Services as a result of the PDN connection establishment for Emergency Services over non 3GPP access. +- to indicate to the MME that the HSS has deregistered the MME for SMS. +- to indicate to the MME/SGSN that the HSS-based P-CSCF restoration procedure, as described in 3GPP TS 23.380 [51] clause 5.4, shall be executed. +- to request the MME or the SGSN to configure and report the detection of Monitoring events, or delete stored Monitoring events configuration. + +- to update the MME with the O&M configured desired Active Time for power saving mode (PSM), or with the value received from the SCEF if Active Time is provided as part of the Suggested-Network-Configuration AVP. +- to update the MME with the O&M configured desired Core Network Restrictions to restrict/allow mobility to 5GC. + +If the HSS knows that the UE has attached to the MME and SGSN parts of the same combined MME/SGSN via both the E-UTRAN and UTRAN/GERAN (refer to clause 5.2.1.1.2, 5.2.1.1.3 for further details), the HSS should invoke this procedure for a single time to update and/or request certain user data in the combined MME/SGSN, i.e. the HSS should not invoke this procedure for each of the MME and the SGSN registered respectively. + +If the Node-Type-Indicator information has been previously received as cleared in the ULR-Flags and if the MME has not been registered for SMS during update location procedure for the MME, the HSS may skip any change of the SMS related subscription data and consequently does not have to make use of the Insert Subscriber Data procedure to update the SMS subscription data in the MME. + +This procedure is mapped to the commands Insert Subscriber Data-Request/Answer (IDR/IDA) in the Diameter application specified in clause 7. + +Table 5.2.2.1.1/1 specifies the involved information elements for the request. + +Table 5.2.2.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.2.1.1/1: Insert Subscriber Data Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Subscription Data
(See 7.3.2) | Subscription-Data | M | This Information Element shall contain the part of the subscription profile that either is to be added to the subscription profile stored in the MME or SGSN or is replacing a part of the subscription profile stored in the MME or SGSN. | +| IDR Flags
(See 7.3.103) | IDR-Flags | C | This Information Element shall contain a bit mask. See 7.3.103 for the meaning of the bits. | +| Reset-IDs
(See 7.3.184) | Reset-ID | O | The Reset-ID uniquely identifies a fallible resource in the HSS on which the user (IMSI) depends. In the event of a restart of the fallible resource a Reset message containing the Reset-ID will exactly identify the impacted subscribers. | + +**Table 5.2.2.1.1/2: Insert Subscriber Data Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host.
A combined MME/SGSN that makes use of separate origin host values in Update Location Request messages sent on S6a and Update Location Request messages sent on S6d can detect whether the IDR from HSS was sent to the MME or to the SGSN.
IDA sent from such combined MME/SGSN corresponds to the MME's or the SGSN's supported features respectively.
A combined MME/SGSN that makes use of a common origin host value in Update Location Request messages sent on S6a and Update Location Request messages sent on S6d cannot detect whether the IDR from HSS was sent to the MME or to the SGSN.
IDA sent from such combined MME/SGSN uses the union of the MME's and the SGSN's supported features. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
Result-Code AVP shall be used to indicate success / errors defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown | +| IMS Voice over PS Sessions Supported
(See 7.3.106) | IMS-Voice-Over-PS-Sessions-Supported | C | If available to the serving node, this information element shall indicate whether or not "IMS Voice over PS Sessions" is supported by the UE's most recently used TA or RA in the serving node (MME or SGSN or combined MME/SGSN). If the UE is in detached state, this information element shall not be included in the response. | +| Last UE Activity Time
(See 7.3.108) | Last-UE-Activity-Time | C | If available to the serving node, this information element shall contain the time of the last radio contact with the UE. If the UE is in detached state, this information element shall not be included in the response. | +| RAT Type
(See 7.3.13) | RAT-Type | C | If available to the serving node, this information element shall indicate the RAT Type of the access where the UE was present at the time of the last radio contact. If the UE is in detached state, this information element shall not be included in the response. | +| IDA-Flags
(See 7.3.47) | IDA-Flags | C | This Information Element shall contain a bit mask. See 7.3.47 for the meaning of the bits. | +| EPS-User-State
(See 7.3.110) | EPS-User-State | C | This Information Element shall contain the EPS-User State. It shall be present if EPS user state was requested within IDR. | +| EPS-Location-Information
(See 7.3.111) | EPS-Location-Information | C | This Information Element shall contain the EPS-Location Information. It shall be present if EPS location information was requested within IDR. | +| Local Time Zone
(See 7.3.156) | Local-Time-Zone | C | This Information Element shall contain information on the Local Time Zone of the location in the visited network where the UE is attached. It shall be present if the Local Time Zone was requested within IDR. | +| Monitoring Event Report | Monitoring-Event-Report | C | This Information Element shall contain the report of Monitoring event. It shall be present if Monitoring event configuration is included within IDR and any of the requested Monitoring events are available to be reported. (see NOTE 1) | +| Monitoring Event Config Status | Monitoring-Event-Config-Status | C | This Information Element shall be present if Monitoring event configuration is included in IDR. It shall contain all the configuration status for each Monitoring event that was requested. | +| Supported Services
(3GPP TS 29.336 [54]) | Supported-Services | O | If present, this Information Element shall contain AVPs indicating details of the services supported by the MME/SGSN. | +| NOTE 1: In IWK-SCEF scenarios, an event is available to be reported by the visited MME only if the event is considered as authorized by the visited MME after checking with the IWK-SCEF. Otherwise, the immediate report shall be not be sent in this command (S6a/IDA), and it shall be sent over T6a using RIR command (see 3GPP TS 29.128 [63]). | | | | + +#### 5.2.2.1.2 Detailed behaviour of the MME and the SGSN + +When receiving an Insert Subscriber Data request the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If it is known, the MME or SGSN shall replace the specific part of the stored subscription data with the received data, or shall add the received data to the stored data. + +When receiving the APN-Configuration-Profile AVP within the Subscription-Data AVP, the MME or SGSN shall check the All-APN-Configurations-Included-Indicator value. If it indicates "All\_APN\_CONFIGURATIONS\_INCLUDED", the MME or SGSN shall delete all stored APN-Configurations and then store all received APN-Configurations. Otherwise, the MME or SGSN shall check the Context-Identifier value of each received APN-Configuration. If the Context-Identifier of a received APN-Configuration matches a Context-Identifier of a stored APN-Configuration, the MME or SGSN shall replace the stored APN-Configuration with the received APN-Configuration. If the Context-Identifier of a received APN-Configuration does not match a Context-Identifier of a stored APN-Configuration, the MME or SGSN shall add the received APN-Configuration to the stored APN-Configurations. If the addition or update of the subscription data succeeds in the MME or SGSN, the Result-Code shall be set to DIAMETER\_SUCCESS. The MME or SGSN shall then acknowledge the Insert Subscriber Data message by returning an Insert Subscriber Data Answer. + +For each of the received APN-Configurations in the APN-Configuration-Profile, if both the MIP6-Agent-Info and the PDN-GW-Allocation-Type AVPs are absent in the APN-Configuration AVP, the MME or SGSN shall perform the PGW selection (static or dynamic) according to the local configuration. If MIP6-Agent-Info is present, and PDN-GW-Allocation-Type is not present, this means that the PDN GW address included in MIP6-Agent-Info has been statically allocated. + +If the MME/SGSN supports interworking with Gn/Gp-SGSNs, it shall ensure that the context identifier sent over GTPv1 for each of the received APN-Configurations is within the range of 1 and 255. + +NOTE 1: If the MME/SGSN receives from HSS a Context-Identifier value higher than 255, how this value is mapped to a value between 1 and 255 is implementation specific. + +If the MME is requested to notify the HSS when the UE becomes reachable, the MME shall set the URRP-MME parameter to indicate the need to inform the HSS about UE reachability, e.g. when the next NAS activity from the UE is detected. If the SGSN is requested to notify the HSS when the UE becomes reachable, the SGSN shall set the URRP-SGSN parameter to indicate the need to inform the HSS about UE reachability, e.g. when the next NAS activity from the UE is detected. + +When receiving GPRS-Subscription-Data AVP within the Subscription-Data AVP, the SGSN or combined MME/SGSN shall check the Complete-Data-List-Included-Indicator value. If it indicates "All\_PDP\_CONTEXTS\_INCLUDED", the SGSN or combined MME/SGSN shall delete all stored PDP-Contexts and then store all received PDP-Contexts. Otherwise, the SGSN or combined MME/SGSN shall check the Context-Identifier value of each received PDP-Context. If the Context-Identifier of a received PDP-Context matches a Context-Identifier of a stored PDP-Context, the SGSN or combined MME/SGSN shall replace the stored PDP-Context with the received PDP-Context. If the Context-Identifier of a received PDP-Context does not match a Context-Identifier of a stored PDP-Context, the SGSN or combined MME/SGSN shall add the received PDP-Context to the stored PDP-Contexts. + +If the MME or SGSN receives an empty Subscription-Data AVP, it shall take no action with regard to the stored subscription data. + +When receiving HPLMN-ODB AVP within the Subscription-Data AVP, the MME or SGSN shall replace stored HPLMN-ODB data (if any) with the received information rather than add the received information to the stored information. Unsupported Barring categories need not be stored. + +When receiving Operator-Determined-Barring AVP within the Subscription-Data AVP, the MME or SGSN shall replace stored ODB subscription information (if any) with the received information rather than add the received information to the stored information. Unsupported Barring categories need not be stored. + +When receiving Access-Restriction-Data or Adjacent-Access-Restriction-Data AVPs within the Subscription-Data AVP, the MME or SGSN shall replace the corresponding stored information (if any) with the new received information, rather than adding received information to stored information. The handling of access restrictions per-PLMN is defined in 3GPP TS 23.221 [53], clause 6.3.5a and in 3GPP TS 23.401 [2] clause 4.3.28. + +When receiving APN-OI-Replacement AVP within the Subscription-Data AVP, the MME or SGSN shall replace the stored information (if any) with the received information. + +When receiving Regional-Subscription-Zone-Code AVP within the Subscription-Data AVP, the MME or SGSN shall replace stored Zone Codes (if any) with the received information rather than add the received information to the stored information. MMEs and SGSNs that do not support regional subscription need not store zone codes. If due to regional subscription restrictions or access restrictions the entire SGSN area is restricted, SGSN shall report it to the HSS by returning the "SGSN Area Restricted" indication within the IDA flags. + +When receiving CSG-Subscription-Data AVPs within the Subscription-Data AVP the MME or SGSN shall replace all stored information from previously received CSG-Subscription-Data AVPs (if any) with the received information rather than add the received information to the stored information. + +When receiving Teleservice-List AVP, Call-Barring-Info, or LCS-Info AVP, the MME or SGSN shall replace stored information (if any) with the received information rather than add the received information to the stored information. + +When receiving ProSe-Subscription-Data AVP, the MME or combined MME/SGSN shall replace stored information (if any) with the received information rather than add the received information to the stored information. + +When receiving and supporting Reset-ID AVPs within the request, the MME or SGSN shall replace stored information (if any) with received information rather than add received information to stored information. + +When receiving the IDR-Flags with the "T-ADS Data Request" bit set, and the UE is in attached state, the MME or SGSN or combined MME/SGSN shall return in the IDA message the time stamp of the UE's most recent radio contact and the associated RAT Type, and an indication of whether or not IMS Voice over PS is supported in the current (and most recently used) TA or RA. If the UE is in detached state, the MME or SGSN or combined MME/SGSN shall answer successfully to the T-ADS request from HSS, but it shall not include any of the T-ADS IEs in the response (IMS Voice over PS Sessions Supported, RAT Type and Last UE Activity Time). + +When receiving the IDR-Flags with the "EPS User State Request" bit and/or "EPS Location Information Request" bits set the MME or SGSN shall return the corresponding user information to the HSS. If the serving node is a combined MME/SGSN, and the UE is attached via both E-UTRAN and UTRAN/GERAN on the same node, the combined MME/SGSN shall provide the corresponding user information relevant for both MME and SGSN. If the Current Location Request bit was also set and the UE is in idle mode and is expected to be reachable even when it uses a power saving feature (e.g. extended idle mode DRX or PSM as defined in 3GPP TS 23.685 [55]), then the MME or SGSN or combined MME/SGSN shall page the UE in order to return the most up-to-date corresponding user information. If the Current Location Request bit was also set and either paging is unsuccessful or the UE is not expected to be reachable, then the last known location of the UE shall be returned to the HSS. If the Current Location Request bit was also set and the UE (attached via E-UTRAN) is in connected mode, then the MME or combined MME/SGSN shall use SIAP Location Reporting Control procedure towards the eNB prior to reporting the E-UTRAN Cell Global Identification in order to return the UE's most up-to-date cell information. When the location is returned to the HSS, the MME or the combined MME/SGSN shall provide the age of location information if stored in the MME or the combined MME/SGSN or received from eNB. + +When receiving the IDR-Flags with only the "Current Location Request" bit set (i.e. the "EPS Location Information Request" bit is not set), the MME or SGSN or combined MME/SGSN shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the "Local Time Zone Request" bit was set the MME or SGSN if supported shall provide the Local Time Zone corresponding to the location (e.g. TAI or RAI) of the UE to the HSS. + +If the MME or SGSN cannot fulfil the received request, e.g. due to a database error or any of the required actions cannot be performed, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. If subscription data are received, the MME or SGSN shall mark the subscription record "Subscriber to be restored in HSS". + +If trace data are received in the subscriber data, the MME or SGSN shall start a Trace Session. For details, see 3GPP TS 32.422 [23]. + +If the Ext-PDP-Type AVP is present in the PDP-Context AVP, the SGSN or combined MME/SGSN shall ignore the value of the PDP-Type AVP. + +When receiving the IDR-Flags with the bit "Remove SMS Registration" set, the MME shall consider itself unregistered for SMS. + +If the subscription data received for a certain APN includes WLAN-offloadability AVP, then the MME or SGSN shall determine the offloadability of the UE's PDN Connection(s) to that APN based on subscription data and locally configured policy (e.g. for roaming users or when the subscription data does not include any offloadability indication). + +NOTE 2: As indicated in clause 7.3.31, if the UE-level access restriction "HO-To-Non-3GPP-Access Not Allowed" is set, the offload of PDN Connections to WLAN is not allowed for any APN. + +When receiving the IDR-Flags with the "P-CSCF Restoration Request" bit set, the MME or SGSN or combined MME/SGSN shall execute the procedures for HSS-based P-CSCF Restoration, as described in 3GPP TS 23.380 [51] clause 5.4. + +If the subscription data received for the user includes the DL-Buffering-Suggested-Packet-Count AVP, then the MME or SGSN should take into account the subscription data, in addition to local policies, to determine whether to invoke extended buffering of downlink packets at the SGW for High Latency Communication. Otherwise, the MME or SGSN shall make this determination based on local policies only. + +When receiving IMSI-Group-Id AVP(s) within the Subscription-Data AVP, the MME or SGSN shall replace stored IMSI-Group Ids (if any) with the received information rather than add the received information to the stored information. + +In the present clause, if the feature "Extended Reference IDs" (see clause 7.3.10) is supported by the HSS and the MME/SGSN, the term "SCEF Reference ID" shall refer to the content of the 64-bit long "SCEF-Reference-ID-Ext" AVP, and the term "SCEF Reference ID for Deletion" shall refer to the content of the 64-bit long "SCEF-Reference-ID-for-Deletion-Ext" AVP. + +When receiving a Monitoring-Event-Configuration in the IDR: + +- if the SCEF Reference ID for Deletion is present in the IDR, the MME or SGSN shall stop the detection of the Monitoring event related to the SCEF Reference ID for Deletion and SCEF-ID pair, and shall delete the corresponding Monitoring event configuration data; +- if the SCEF Reference ID is present in the IDR but not stored in the MME or SGSN, the MME or SGSN shall store the received Monitoring event configuration data related to the SCEF Reference ID and SCEF-ID pair, and shall start the detection for the specified Monitoring event(s). +- if the SCEF Reference ID is present in the IDR and stored in the MME or SGSN, the MME or SGSN shall replace the stored Monitoring event configuration data related to the SCEF Reference ID and SCEF-ID pair with the received information. + +NOTE 3: In roaming scenarios the MME/SGSN can reply immediately to the HSS without waiting for the outcome of the interaction with the IWK-SCEF. + +For the monitoring event configurations for which the configuration status have changed since the last status informed to the HSS, the MME/SGSN shall notify the HSS about the outcome of the interaction with the IWK-SCEF as specified in clause 5.2.5.1.2. + +If the HSS indicates the support of Monitoring event feature to the MME/SGSN and the MME/SGSN supports Monitoring, the MME/SGSN shall include the Supported-Services AVP with Supported-Monitoring-Event included in the IDA command. + +When receiving the Maximum-Response-Time in Monitoring-Event-Configuration in IDR, the MME shall use the Maximum-Response-Time as the Active Time for the usage of PSM in UE. If not, when the MME receives the Active-Time in subscription data, the MME shall use the Active-Time as the Active Time for the usage of PSM in UE. + +When receiving AESE-Communication-Pattern AVP(s) within the Subscription-Data AVP with an SCEF Reference ID for which the MME has already stored data, it shall delete the stored data (CP set(s)) and store the received ones. + +When receiving AESE-Communication-Pattern AVP(s) within the Subscription-Data AVP with one or more SCEF Reference ID for deletion the MME shall delete the data related to the indicated SCEF Reference ID. + +If the MME and the UE support an Attach without PDN connection (i.e. EMM-REGISTERED without PDN connection) and the PDN-Connection-Restricted flag is set in the received Subscription-Data-Flags AVP, the MME shall not establish any non-emergency PDN connection and shall tear down any existing non-emergency PDN connection for this user. + +If the subscription data received for the user includes the Preferred-Data-Mode AVP, for an IP APN configuration or for a non-IP APN configuration with SGi based delivery, then the MME should (if the subscriber is not roaming) or may (if the subscriber is roaming) take into account the subscription data, in addition to local policies and the UE's Preferred Network Behaviour, to determine whether to transmit the traffic associated with this APN over the User Plane and/or over the Control Plane. Otherwise, the MME shall make this determination based on local policies and the UE's Preferred Network Behaviour only. + +If the MME subscription data received for the user includes the Emergency-Info AVP, the MME shall use the PDN-GW identity contained in such AVP as the PDN-GW used to establish emergency PDN connections with the emergency APN, for non-roaming authenticated UEs requesting the handover of an emergency PDN connection if the MME is configured to use a dynamic PDN-GW for emergency services for such user. + +When receiving V2X-Subscription-Data in the IDR, the MME shall determine whether the UE is authorized to use V2X communication over PC5 according to V2X subscription data and UE provided network capability. If the UE is authorized to use V2X communication over PC5, the MME shall store the "V2X service authorized" indication together with the UE AMBR used for PC5 interface (i.e. UE-PC5-AMBR), and provide such information to the eNodeB when needed. + +If the MME/SGSN receives from the HSS an Insert Subscriber Data request without the bit set for "NR as Secondary RAT" in the Feature-List AVP, the MME/SGSN, based on local policy, may restrict access for NR as secondary RAT when all relevant entities except HSS supports it. + +If the MME receives from the HSS Insert Subscriber Data request containing in the subscription data the Core-Network-Restrictions AVP with the bit "5GC not allowed" set, the MME shall restrict mobility towards 5GC. + +When receiving Paging-Time-Window AVPs within the Subscription-Data AVP, the MME or SGSN shall replace stored information (if any) with the received information rather than add the received information to the stored information. + +#### 5.2.2.1.3 Detailed behaviour of HSS + +The HSS shall make use of this procedure to replace a specific part of the user data stored in the MME or SGSN with the data sent, or to add a specific part of user data to the data stored in the MME or SGSN. The HSS shall also make use of this procedure to indicate to the MME that it is no longer registered for SMS. + +NOTE: When a Cancel Location message is required for other reasons, the use of IDR to indicate that the MME is no longer registered for SMS is not needed (see clause 5.2.1.2). + +Subscriber-Status AVP shall be present in the Subscription-Data AVP, sent within IDR, if the current value in the MME or SGSN needs to be changed. To remove all Operator Determined Barring Categories the Subscriber-Status shall be set to "SERVICE\_GRANTED". If Subscriber-Status AVP is present and set to OPERATOR\_DETERMINED\_BARRING, the Operator-Determined-Barring AVP or HPLMN-ODB AVP shall also be present in the Subscription-Data AVP. + +Access-Restriction-Data AVP shall be present within the Subscription-Data AVP sent within an IDR if the information stored in the MME or SGSN needs to be modified. + +APN-OI-Replacement AVP shall be present in the Subscription-Data AVP sent within an IDR, if the UE level APN-OI-Replacement has been added or modified in the HSS. + +The APN-Configuration-Profile AVP shall be present in the Subscription-Data AVP sent within an IDR if the Context-Identifier associated with the default APN configuration is changed or at least one APN-Configuration is added or modified by the HSS. If the default APN is changed in the HSS, the APN-Configuration-Profile AVP shall contain the Context-Identifier associated with the default APN and the APN-Configuration AVP for the default APN. The default APN Configuration shall not contain the Wildcard APN (see 3GPP TS 23.003 [3], clause 9.2); the default APN shall always contain an explicit APN. + +The EPS-Subscribed-QoS-Profile AVP and the AMBR AVP shall be present in the APN-Configuration AVP when the APN-Configuration AVP is sent in the APN-Configuration-Profile AVP and when the APN-Configuration-Profile AVP is sent within an IDR (as part of the Subscription-Data AVP). + +If the GPRS-Subscription-Data-Indicator information has been previously received as set in the ULR-Flags during update location procedure for the SGSN or combined MME/SGSN, the HSS shall make use of this procedure to replace + +the GPRS Subscription Data stored in the SGSN or combined MME/SGSN with the data sent or to add a PDP-Context to the data stored in the SGSN or combined MME/SGSN. + +ProSe-Subscription-Data AVP shall be present in the Subscription-Data AVP sent within an IDR, if the ProSe Subscription data has been added or modified in the HSS. + +If the HSS receives a message (e.g. via MAP ATM or Sh Sh-Subs-Notif) from a Service Related Entity (e.g. IP-SM-GW) indicating that the UE is unreachable, + +- the HSS shall associate the subscription to UE reachability of the service-related entity to the URRP-MME and the URRP-SGSN parameters (if not already done) +- and if the URRP-MME and/or the URRP-SGSN parameters were not already set (i.e. at least one service-related entity already listed as subscribed), the HSS shall + - set the URRP-MME and/or URRP-SGSN parameters and + - send an IDR command to the registered MME and/or to the registered SGSN including the "UE Reachability Request flag" in the IDR Request Flags in order to request the MME and/or SGSN to notify the HSS when the UE becomes reachable again, unless the HSS knows from the previous ULR command that the registered MME and/or the registered SGSN do not support UE reachability notifications. + +If the IDR is sent for the only purpose to request the MME and/or SGSN about the UE reachability status notification, the Subscription-Data AVP shall be included empty. + +If the HSS has received a message from a service related entity requesting EPS User State and/or EPS Location Information without the Serving Node Indication IE, the HSS shall set the "EPS User State Request" bit and/or "EPS Location Information Request" bit respectively in the IDR-Flags. The HSS may optionally also set the "Current Location Request" bit along with the "EPS Location Information Request" bit in the IDR-Flags, if the most up-to-date set of information is needed, unless the HSS knows from the previous ULR command that the registered MME and/or the registered SGSN do not support State/Location Information retrieval. If the IDR is sent only for the purpose of requesting the MME or the SGSN User State or Location Information, the Subscription-Data AVP included shall be empty. + +If the HSS cannot request EPS Location Information from the MME/SGSN e.g. because the UE is purged from the MME/SGSN, the HSS may make use of stored EPS Location information received in a previous IDA or PUR message. + +If the HSS has received a message from an AS requesting the current access network's support status of "IMS Voice over PS Sessions", and there is no indication about homogeneous support of IMS Voice over PS Sessions in all the serving nodes currently registered in HSS for the UE, the HSS shall set the "T-ADS Data Request flag" in the IDR Request Flags, unless the HSS knows from the previous ULR command that the registered MME and/or the registered SGSN do not support T-ADS data retrieval. If the IDR is sent for the only purpose to retrieve the "IMS Voice over PS Sessions Supported" indication from the MME or SGSN, the Subscription-Data AVP included shall be empty. + +If the HSS has received a message from an AS requesting the Local Time Zone, the HSS shall set the " Local Time Zone Request" bit in the IDR-Flags, unless the HSS knows from the previous ULR command that the registered MME and/or the registered SGSN do not support Local Time Zone retrieval. If the IDR is sent only for the purpose of requesting the Local Time Zone, the Subscription-Data AVP included shall be empty. + +If the HSS received an indication in a former ULR command from the MME or SGSN about homogeneous support of IMS Voice over PS Sessions in all TA/RAs associated to that serving node, it may use this information to skip the retrieval of T-ADS data. This can only be done if all the registered serving nodes in HSS for the UE indicated in ULR the same type of homogeneous support (i.e. both serving nodes indicated "SUPPORTED", or both serving nodes indicated "NOT\_SUPPORTED"); otherwise, the retrieval of T-ADS data shall be done, to receive the time of the last radio contact with the UE. + +All APN and PGW-ID pairs stored in the HSS not associated with an explicit APN subscription, (i.e. the access to that APN has been authorized as a consequence of having the Wildcard APN in the user subscription), shall be included by the HSS inside the APN context of the Wildcard APN, as multiple instances of the Specific-APN-Info AVP. + +When receiving an Insert Subscriber Data answer with "SGSN Area Restricted" the HSS shall set the SGSN area restricted flag as "SGSN area restricted". + +Subscribed-VSRVCC AVP may be present within the Subscription-Data AVP sent within an ISR only if the user is subscribed to the SRVCC and vSRVCC. + +If the HSS determines that the MME shall be unregistered for SMS it shall set the "Remove SMS Registration" bit in the IDR-Flags. If the IDR is sent for the only purpose to indicate that the MME is no longer registered for SMS, the Subscription-Data AVP shall be included empty. + +If the HSS needs to request to the MME/SGSN the execution of the HSS-based P-CSCF restoration procedure, as described in 3GPP TS 23.380 [51] clause 5.4, the HSS shall set the "P-CSCF Restoration Request" bit in the IDR-Flags, if supported by the MME/SGSN. If the IDR is sent only for the purpose of requesting the execution of the HSS-based P-CSCF restoration procedures, the Subscription-Data AVP included shall be empty. + +If the HSS receives a SCEF request to configure Monitoring events for the UE to be handled by the MME/SGSN or receives a SCEF request for deleting Monitoring events for the UE in the MME/SGSN, the HSS shall include Monitoring-Event-Configuration AVP(s) in the Subscription-Data AVP sent within the IDR. If the HSS has registered both an MME and an SGSN as serving nodes for a given user, and both nodes are not part of a same combined MME/SGSN node, the HSS shall send the Monitoring-Event-Configuration AVP(s) to each one of the serving nodes that supports the Monitoring event service. If the HSS receives the IDA with Monitoring-Event-Report AVP(s), the HSS shall forward the Monitoring-Event-Report AVP(s) to the SCEF associated to those Monitoring events. + +If the HSS does not receive a SCEF request to configure Monitoring events for the UE to be handled by the MME/SGSN and does not receive an Active Time with the Suggested-Network-Configuration AVP, the HSS may send an O&M configured desired Active Time value within the Active-Time AVP. + +If the HSS receives a Supported-Services AVP it shall only trigger those services which are supported by the MME/SGSN. + +If the HSS has previously received over SWx (see 3GPP TS 29.273 [59]) the identity of the PDN-GW to be used for the establishment of emergency PDN connections, it shall send it to the registered MME (if any) in the IDR command as part of the Subscription-Data AVP (in the Emergency-Info AVP). + +If V2X subscription data has been added or modified in the HSS, the HSS shall include the V2X-Subscription-Data AVP in the Subscription-Data AVP sent within an IDR. + +If the External-Identifier associated with Monitoring Event Configuration for the UE has been added or modified in the HSS and the MME/SGSN supports the "External-Identifier" feature, the HSS shall include the External-Identifier AVP in the Subscription-Data AVP. When multiple External Identifiers are defined for a same subscription, the HSS shall send a default External Identifier in the External-Identifier AVP of the Subscription-Data AVP, and shall include a specific External Identifier (if different from the default External Identifier) associated to each Monitoring Event Configuration in the External-Identifier AVP of each Monitoring-Event-Configuration AVP occurrence inside the Subscription-Data AVP. + +The Aerial-UE-Subscription-Information AVP may be present within the Subscription-Data AVP sent within an IDR only if the user has Aerial UE subscription information. + +If Core Network Restrictions in subscription data (5GC allowed/not allowed) has been added or modified in the HSS, the HSS shall include the Core-Network-Restrictions AVP in the Subscription-Data AVP sent within an IDR. + +## 5.2.2.2 Delete Subscriber Data + +### 5.2.2.2.1 General + +This procedure shall be used between the MME and the HSS and between the SGSN and the HSS, to remove some data of the HSS user profile stored in the MME or SGSN. The procedure shall be invoked by the HSS and it corresponds to the functional level operation Delete Subscriber Data (see 3GPP TS 23.401 [2]). + +It shall be used to remove: + +- a subset (which may or may not be the complete set of APN configurations) of the APN Configuration Profile for the subscriber from the SGSN or combined MME/SGSN; +- a proper subset (i.e. a subset that is not equal to the complete set of APN configurations and does not contain the default APN configuration) of the APN Configuration Profile for the subscriber from the MME; +- the regional subscription; +- the subscribed charging characteristics; + +- Session Transfer Number for SRVCC; +- trace data; +- ProSe subscription data; +- Reset-IDs; +- MSISDN; +- UE Usage Type; +- V2X subscription data. +- External Identifier(s). + +If the HSS knows that the UE has attached to the MME and SGSN parts of the same combined MME/SGSN via both E-UTRAN and UTRAN/GERAN(refer to clause 5.2.1.1.2, 5.2.1.1.3 for further details), the HSS should invoke this procedure for a single time to remove some or all data of the HSS user profile stored in the combined MME/SGSN, i.e. not invoke this procedure for each of the MME and the SGSN registered respectively. + +If the Node-Type-Indicator information has been previously received as cleared in the ULR-Flags and if the MME has not been registered for SMS during update location procedure for the MME, the HSS may skip any removal of the SMS related subscription data and consequently does not have to make use of the Delete Subscriber Data procedure to update the SMS subscription data in the MME. + +This procedure is mapped to the commands Delete-Subscriber-Data-Request/Answer (DSR/DSA) in the Diameter application specified in clause 7. + +Table 5.2.2.2.1/1 specifies the involved information elements for the request. + +Table 5.2.2.2.1/2 specifies the involved information elements for the answer. + +**Table 5.2.2.2.1/1: Delete Subscriber Data Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| DSR Flags
(See 7.3.25) | DSR-Flags | M | This Information Element shall contain a bit mask. See 7.3.25 for the meaning of the bits. | +| Trace Reference
(See 7.3.64) | Trace-Reference | C | This parameter shall contain the same value as used for the activation of the Trace Session.
This element shall be present only if the "Trace Data Withdrawal" bit is set in the DSR-Flags. | +| Context Identifier
(See 7.3.27) | Context-Identifier | C | This parameter shall identify the PDN subscription context or GPRS-PDP context that shall be deleted.
This element shall be present only if the "PDN subscription contexts Withdrawal" bit or the "PDP context withdrawal" bit is set in the DSR-Flags. In the "PDN subscription contexts Withdrawal" case, the Context-Identifier shall not be associated with the default APN configuration. For the compatibility with the MAP protocol as defined in the 3GPP TS 29.002 [24], this parameter shall not have a value of zero. | +| TS Code List
(See 7.3.100) | TS-Code | C | This parameter shall contain the teleservice codes that are to be deleted from the subscription.
This element shall be present only if the "SMS Withdrawal" bit is set in the DSR-Flags and the SMS related teleservice codes are to be deleted. | +| SS Code List
(See 7.3.87) | SS-Code | C | This parameter shall contain the supplementary service codes that are to be deleted from the subscription.
This element shall be present only if the "SMS Withdrawal" bit is set or the "LCS Withdrawal" bit is set in the DSR-Flags. | +| SCEF-Id
(See 3GPP TS 29.336 [54]) | SCEF-ID | C | This parameter shall contain the identity of the SCEF to which monitoring events that are to be deleted are associated.
This element shall be present if the "Delete monitoring events" bit is set in the DSR-Flags. | +| eDRX Related RAT List | eDRX-Related-RAT | C | This parameter shall contain the RAT types for which the eDRX Cycle Lengths is to be deleted from the subscription.
This element shall be present only if the "eDRX-Cycle-Length-Withdrawal" bit is set in the DSR-Flags and the corresponding eDRX Cycle Lengths are to be deleted.
If the "eDRX-Cycle-Length-Withdrawal" bit is set in DSR-Flags, but the eDRX-Related-RAT AVP is absent in this command, the MME/SGSN shall delete the stored eDRX cycle lengths for all RATs. | +| External Identifiers | External-Identifiers | O | If present, this parameter shall contain the External Identifier(s) to be deleted from the subscriber data; the MME/SGSN shall also delete those monitoring events that include an External-Identifier AVP in their event configuration matching any of the External-Identifiers in this IE.

This IE shall be absent if the "External-Identifier-Withdrawal" bit is not set in the DSR-Flags.

If this IE is absent, and "External-Identifier-Withdrawal" bit is set in DSR-Flags, the MME/SGSN shall delete the default External-Identifier in the Subscription-Data AVP and it shall also delete all monitoring events that include an External-Identifier AVP in their event configuration. | + +**Table 5.2.2.2.1/2: Delete Subscriber Data Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown | +| DSA Flags
(See 7.3.26) | DSA-Flags | C | This Information Element shall contain a bit mask. See 7.3.26 for the meaning of the bits. | + +## 5.2.2.2.2 Detailed behaviour of the MME and the SGSN + +When receiving a Delete Subscriber Data request, the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If it is known, but the Context-Identifier is associated with the default APN configuration, the MME shall not delete the PDN subscription context, and return an error with a Result-Code set to DIAMETER\_UNABLE\_TO\_COMPLY. + +Otherwise, the MME or SGSN shall delete the corresponding data according to the indication as sent in the request, and acknowledge the Delete Subscriber Data message by returning a Delete Subscriber Data Answer. + +If an MME receives a Delete Subscriber Data Request with the "Complete APN Configuration Profile Withdrawal" bit set in the DSR-Flags AVP, it shall return an error with a Result-Code set to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the deletion of the subscription data succeeds in the MME or SGSN, the Result-Code shall be set to DIAMETER\_SUCCESS. + +If the Regional Subscription is deleted from the subscription data, the SGSN shall check for its routing areas whether they are allowed or not. If the entire SGSN area is restricted, SGSN shall report it to the HSS by returning the "SGSN Area Restricted" indication within the DSA flags. + +If the EPS Subscription Data is deleted from the subscription data, the MME or SGSN shall check whether all EPS Subscription Data for the subscriber is deleted or if only a subset of the stored EPS Subscription Data for the subscriber is deleted, the MME or SGSN may then deactivate the associated affected active EPS bearers. + +If the Subscribed Charging Characteristics are deleted from the subscription data, the Gn/Gp-SGSN shall maintain the existing Subscribed Charging Characteristics throughout the lifetime of the existing MM and PDP contexts, see 3GPP TS 32.251 [33]. + +If the Subscribed Charging Characteristics are deleted from the subscription data, the MME or S4-SGSN shall maintain the existing Subscribed Charging Characteristics throughout the lifetime of the existing IP CAN bearer, see 3GPP TS 32.251 [33]. + +If the MSISDN is deleted from the subscription data, the MME or SGSN shall maintain the existing MSISDN throughout the lifetime of the existing PDN connections that were established prior to the deletion of the MSISDN (i.e., other network nodes, such as PDN-GW, are not informed of such deletion for the existing PDN connections). The MME/SGSN shall also delete those monitoring events related to the deleted MSISDN. + +If the MME or SGSN cannot fulfil the received request for other reasons, e.g. due to a database error, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. In this case, the MME or SGSN shall mark the subscription record "Subscriber to be restored in HSS". + +If trace data are deleted from the subscription data, the MME or SGSN shall deactivate the Trace Session identified by the trace reference. For details, see 3GPP TS 32.422 [23]. + +If External Identifiers are requested to be deleted from the subscription data, the MME/SGSN shall check whether any of the identifiers to be deleted match the default External-Identifier provided by HSS in the Subscription-Data AVP (unless all External Identifiers are requested to be deleted from the subscription); in such case, the MME/SGSN shall reject the request and return an error with a Result-Code set to DIAMETER\_UNABLE\_TO\_COMPLY (if default External Identifier is wanted to be deleted, no External Identifier must be provided in the request). The MME/SGSN shall also delete those monitoring events related to the deleted External Identifiers, or all monitoring events associated to any External Identifier if default External Identifier is deleted. + +### 5.2.2.2.3 Detailed behaviour of the HSS + +The HSS shall make use of this procedure to remove deleted subscription data from the MME or SGSN. + +The HSS shall make use of this procedure to remove deleted GPRS Subscription Data from the SGSN or combined MME/SGSN if the GPRS-Subscription-Data-Indicator information has been previously received as set in the ULR-Flags during update location procedure for the MME. + +The HSS shall not set the "Complete APN Configuration Profile Withdrawal" bit in the DSR-Flags AVP when sending a Delete Subscriber Data Request to an MME, since the default APN shall always be present in an MME. + +When receiving a Delete Subscriber Data Answer with "SGSN Area Restricted" the HSS shall set the SGSN area restricted flag as "SGSN area restricted". + +## 5.2.3 Authentication Procedures + +### 5.2.3.1 Authentication Information Retrieval + +#### 5.2.3.1.1 General + +The Authentication Information Retrieval Procedure shall be used by the MME and by the SGSN to request Authentication Information from the HSS. + +This procedure is mapped to the commands Authentication-Information-Request/Answer (AIR/AIA) in the Diameter application specified in clause 7. + +Table 5.2.3.1.1/1 specifies the involved information elements for the request. + +Table 5.2.3.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.3.1.1/1: Authentication Information Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-----------------------------------------------------------|-------------------------------------------|------|---------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Requested E-UTRAN Authentication Info
(See 7.3.11) | Requested-EUTRAN-Authentication-Info | C | This information element shall contain the information related to authentication requests for E-UTRAN. | +| Requested UTRAN/GERAN Authentication Info
(See 7.3.12) | Requested-UTRAN-GERAN Authentication-Info | C | This information element shall contain the information related to authentication requests for UTRAN or GERAN. | +| Visited PLMN ID
(See 7.3.9) | Visited-PLMN-ID | M | This IE shall contain the MCC and the MNC of the visited PLMN, see 3GPP TS 23.003 [3]. | +| AIR Flags
(See 7.3.201) | AIR-Flags | O | This IE, if present, contains a bit mask. See clause 7.3.201 for the meaning of the different bits. | + +**Table 5.2.3.1.1/2: Authentication Information Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
This IE shall contain the Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown
- Unknown EPS Subscription
- Authentication Data Unavailable | +| Error-Diagnostic | Error-Diagnostic | O | If the Experimental Result indicated "Unknown EPS Subscription", Error Diagnostic may be present to indicate whether or not GPRS subscription data are subscribed (i.e. whether or not Network Access Mode stored in the HSS indicates that only CS service is allowed). | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Authentication Info
(See 7.3.17) | Authentication-Info | C | This IE shall contain the Authentication Vectors. | +| UE Usage Type
(See 7.3.202) | UE-Usage-Type | C | This IE shall be present if the HSS supports the Dedicated Core Networks feature, and the "Send UE Usage Type" flag was set in the AIR-Flags AVP in the AIR command, and this information is available in the user subscription.
If present, this IE shall contain the UE Usage Type of the subscriber (see clause 7.3.202). | + +### 5.2.3.1.2 Detailed behaviour of the MME and the SGSN + +The MME or SGSN shall make use of this procedure in order to retrieve the Authentication Vectors from the HSS. + +If the MME or SGSN supports Emergency services for users in limited service state, and the user's IMSI is not available from the UE, or the user's IMSI is marked as unauthenticated, the MME or SGSN shall not make use of the Authentication Information Retrieval procedure. + +If the request is triggered by a synchronization failure during E-UTRAN authentication, the MME or combined MME/SGSN shall include the Re-Synchronization Information in the Requested-EUTRAN-Authentication-Info AVP in the request. + +If the request is triggered by a synchronization failure during UTRAN or GERAN authentication, the SGSN or combined MME/SGSN shall include the Re-Synchronization Information in the Requested-UTRAN-GERAN-Authentication-Info AVP in the request. + +Re-Synchronization Information shall not be present in both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP. + +A stand alone MME shall include the Requested-EUTRAN-Authentication-Info AVP and shall not include the Requested-UTRAN-GERAN-Authentication-Info AVP in the request. The Immediate-Response-Preferred AVP should be present if a EUTRAN-Vector is needed for immediate use. + +A stand alone SGSN shall not include the Requested-EUTRAN-Authentication-Info AVP and shall include the Requested-UTRAN-GERAN-Authentication-Info AVP in the request. The Immediate-Response-Preferred AVP should be present if a UTRAN/GERAN-Vector is needed for immediate use. + +A combined MME/SGSN may include both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP in the request. If both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP are present in the request, the Immediate-Response-Preferred AVP shall be present if the requested authentication vectors are needed for immediate use. The content of the Immediate-Response-Preferred AVP shall correspond to the access type which the UE is currently to be authenticated. The Immediate-Response-Preferred AVP shall not be present in both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP. The presence of an Immediate-Response-Preferred AVP shall indicate that a vector is needed for immediate use. + +When EUTRAN-AVs and UTRAN-AVs or GERAN-AVs are requested, presence of Immediate-Response-Preferred AVP within the Requested-EUTRAN-Authentication-Info AVP shall indicate that EUTRAN-AVs are requested for immediate use in the MME/SGSN; presence of Immediate-Response-Preferred AVP within the Requested-UTRAN-GERAN-Authentication-Info AVP shall indicate that UTRAN-AVs or GERAN-AVs are requested for immediate use in the MME/SGSN. It may be used by the HSS to determine the number of vectors to be obtained from the AuC and the number of vectors downloaded to the MME or SGSN. + +If the MME or SGSN supports the Dedicated Core Networks functionality, and the MME or SGSN needs to retrieve the UE Usage Type from the HSS, it shall set the "Send UE Usage Type" flag in the AIR-Flags AVP in the AIR command. + +When receiving an Authentication Information response from the HSS, the MME or SGSN shall check the Result Code. If it indicates success and Authentication Information is present in the result, the MME or SGSN shall use the received vectors. For details see 3GPP TS 33.401 [5]. + +If the MME or SGSN supports Emergency services for users in limited service state, the MME or SGSN shall proceed even if the Authentication Information Retrieval procedure has failed. In this case, the MME or SGSN shall mark the user's IMSI as unauthenticated. + +Vectors with lower Item Number should be used before Vectors with higher Item Number are used in the MME or SGSN. For Vectors received within different requests those received by the earlier request should be used before those received by the later request. + +### 5.2.3.1.3 Detailed behaviour of the HSS + +When receiving an Authentication Information request the HSS shall check whether subscription data exists for the IMSI. + +If the HSS determines that there is not any type of subscription for the IMSI (including EPS, GPRS and CS subscription data), a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If the Authentication Information Request contains a Requested-EUTRAN-Authentication-Info AVP but no Requested-UTRAN-GERAN-Authentication-Info AVP, and the subscriber has not any APN configuration, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +If the Authentication Information Request contains a Requested-UTRAN-GERAN-Authentication-Info AVP but no Requested-EUTRAN-Authentication-Info AVP, and the subscriber has neither an APN configuration profile nor GPRS subscription data, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +If the Authentication Information Request contains both Requested-EUTRAN-Authentication-Info AVP and Requested-UTRAN-GERAN-Authentication-Info AVP, and the Requested-EUTRAN-Authentication-Info AVP does not contain an Immediate-Response-Preferred AVP, and the subscriber has not any APN configuration, the HSS shall not return E-UTRAN vectors. + +If the Authentication Information Request contains both Requested-EUTRAN-Authentication-Info AVP and Requested-UTRAN-GERAN-Authentication-Info AVP, and the Requested-EUTRAN-Authentication-Info AVP contains an Immediate-Response-Preferred AVP, and the subscriber does not have any APN configuration, the HSS shall return a Result Code of DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION. + +When sending DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION, an Error Diagnostic information may be added to indicate whether or not GPRS subscription data are subscribed (i.e. whether or not Network Access Mode stored in the HSS indicates that only circuit service is allowed). + +If EUTRAN-Authentication-Info is requested, the HSS shall check if serving nodes within the realm identified by the received Origin-Realm AVP are allowed to request authentication information for use in the serving network identified by the received Visited-PLMN-Id AVP. + +The HSS shall then request the AuC to generate the corresponding requested Authentication Vectors (AVs). Subject to load considerations and/or other implementation specific considerations which may be based on the presence of an Immediate-Response-Preferred AVP, less AVs than the requested number of AVs may be generated. + +If EUTRAN-Authentication-Info is requested, when receiving AVs from the AuC, the HSS shall generate the KASME before sending the response to the MME or combined MME-SGSN. + +If the AuC is unable to calculate any corresponding AVs due to unallowed attachment for the UE, e.g. the UE is attaching via E-UTRAN with a SIM card equipped, the HSS shall return an error DIAMETER\_AUTHORIZATION\_REJECTED, the HSS shall not return any AV to the requesting node in the response. Otherwise, if no corresponding pre-computed AV is available, and the AuC is unable to calculate any corresponding AVs due to unknown failures, such as the internal database error, the result code shall be set to DIAMETER\_AUTHENTICATION\_DATA\_UNAVAILABLE. The MME or the SGSN may request authentication vectors again. + +For details see 3GPP TS 33.401 [5]. KASME generation is not performed before sending the response to the SGSN. + +If the Requested-EUTRAN-Authentication-Info AVP is present in the request, the HSS shall download E-UTRAN authentication vectors to the MME. If the Requested-UTRAN-GERAN-Authentication-Info AVP is present in the request, the HSS shall download UTRAN or GERAN authentication vectors to the SGSN. + +If the Immediate Response Preferred parameter has been received, the HSS may use it together with the number of requested vectors and the number of vectors stored in the HSS that are pre-computed to determine the number of vectors to be obtained from the AuC. The HSS may return less number of vectors than requested to the MME or SGSN. If both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP are in the request, and one of them includes the Immediate Response Preferred parameter, the HSS may omit the vectors request that are not for immediate use. If both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP are in the request, and both of them includes the Immediate Response Preferred parameter, the HSS may return E-UTRAN authentication vectors and UTRAN or GERAN authentication vectors. KASME is always computed for each E-UTRAN vector due to the PLMN-binding before sending the response to the MME independent of the presence of the Immediate Response Preferred parameter. + +If the Re-Synchronization-Info AVP has been received, the HSS shall check the AUTS parameter before sending new authentication vectors to the MME or the SGSN. For details see 3GPP TS 33.102 [18]. If both the Requested-EUTRAN-Authentication-Info AVP and the Requested-UTRAN-GERAN-Authentication-Info AVP are in the request, + +and both of them include the Re-Synchronization-Info AVP, the HSS shall not check the AUTS parameter and return the result code of DIAMETER\_UNABLE\_TO\_COMPLY. Any authentication vectors shall not be sent by the HSS to the requesting node in the response. + +If more than one EPS or UTRAN or GERAN Vector is to be included within one Authentication-Info AVP, the Item-Number AVP shall be present within each Vector. + +If the HSS supports the Dedicated Core Networks functionality, and the MME or SGSN has set the "Send UE Usage Type" flag in the AIR-Flags AVP in the AIR command: + +- if the UE Usage Type value is available in the subscription data of the user: + - if the Immediate Response Preferred parameter is not present in the Requested-EUTRAN-Authentication-Info nor in the Requested-UTRAN-GERAN-Authentication-Info, the HSS may return no authentication vectors in the response; the HSS shall then return the result code DIAMETER\_SUCCESS and may return the generated AVs (if any) to the MME or SGSN; +- the HSS shall include the UE-Usage-Type AVP in the AIA response command if the result code is DIAMETER\_SUCCESS or DIAMETER\_AUTHENTICATION\_DATA\_UNAVAILABLE. +- if the UE Usage Type value is not available in the subscription data of the user, the HSS shall answer as if the MME/SGSN had not requested the UE Usage Type parameter. + +## 5.2.4 Fault Recovery Procedures + +### 5.2.4.1 Reset + +#### 5.2.4.1.1 General + +The Reset Procedure shall be used by the HSS, after a restart, to indicate to the MME and to the SGSN that a failure has occurred. + +The Reset Procedure may also be used by the HSS as part of operation and maintenance actions e.g. to allow planned HSS outage without service interruption, or to update subscription data shared by multiple subscribers. + +This procedure is mapped to the commands Reset-Request/Answer (RSR/RSA) in the Diameter application specified in clause 7. + +Table 5.2.4.1.1/1 specifies the involved information elements for the request. + +Table 5.2.4.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.4.1.1/1: Reset Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|----------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| User Id List
(See 7.3.50) | User-Id | O | This IE shall contain a list of User-Ids where a User-Id comprises the leading digits of an IMSI (i.e. MCC, MNC, leading digits of MSIN) and it shall identify the set of subscribers whose IMSIs begin with the User-Id. The HSS may include this information element if the occurred failure is limited to subscribers identified by one or more User-Ids. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Reset-IDs
(See 7.3.184) | Reset-ID | O | If present, this information element identifies the set of impacted subscribers. | +| Subscription Data
(See 7.3.2) | Subscription-Data | O | If the Reset Procedure is used to add/ modify subscription data shared by multiple subscribers, this Information Element shall contain the part of the subscription profile that either is to be added to the subscription profile stored in the MME or SGSN or combined MME/SGSN or is replacing a part of the subscription profiles of the impacted subscribers stored in the MME or SGSN.
Shall be absent if Subscription-Data-Deletion AVP is present.
Shall be absent if Reset-ID AVP is absent | +| Subscription Data Deletion
(See 7.3.208) | Subscription-Data-Deletion | O | If the Reset Procedure is used to delete subscription data shared by multiple subscribers, this Information Element shall contain identifications of the part of the subscription profile that is to be deleted from the subscription profiles of the impacted subscribers stored in the MME or SGSN or combined MME/SGSN.
Shall be absent if Subscription-Data AVP is present.
Shall be absent if Reset-ID AVP is absent | + +**Table 5.2.4.1.1/2: Reset Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
There are no Experimental-Result codes applicable for this command. | + +#### 5.2.4.1.2 Detailed behaviour of the MME and the SGSN + +When receiving a Reset message neither containing Subscription-Data nor Subscription-Data-Deletion the MME or SGSN or combined MME/SGSN shall mark all impacted subscriber records "Location Information Confirmed in HSS " as "Not Confirmed". + +When receiving a Reset message containing Subscription-Data or Subscription-Data-Deletion the MME or SGSN or combined MME/SGSN shall update all impacted subscriber records accordingly, i.e. each impacted subscriber record is updated as if an individual IDR or DSR for that subscriber was received; for details see clauses 5.2.2.1.2 and 5.2.2.2.2. The MME or SGSN or combined MME/SGSN shall not mark successfully updated subscriber records "Location Information Confirmed in HSS " as "Not Confirmed". If an impacted subscriber record cannot be updated for any reason (e.g. the updated data is considered not shareable by the MME or SGSN or combined MME/SGSN, or the update requires an individual acknowledgement to be sent to the HSS), the MME or SGSN or combined MME/SGSN shall mark that record "Location Information Confirmed in HSS " as "Not Confirmed". + +NOTE: Which subscription data are considered by the MME or SGSN or combined MME/SGSN not shareable by multiple subscribers is implementation specific. + +If the update of shared subscription data requires only local updates in the MME or SGSN or combined MME/SGSN (i.e., the update of the profile does not imply to initiate any signalling interaction towards other network nodes), the updates should be performed immediately (e.g. deleting an Operator Determined Barring). + +If the update of shared subscription data implies initiating a signalling interaction towards other nodes (e.g. towards the PGW/PCRF for the change of an APN configuration parameter, such as APN-AMBR), depending on the UE's state the following shall apply: + +- If the UE is in CONNECTED state, the updates shall be performed immediately including signalling towards other nodes. +- If the UE is in IDLE state, the signalling towards other nodes should be deferred to the next authenticated radio contact with that UE. + +NOTE: The rational for the recommendation to defer signalling towards other nodes until the next authenticated radio contact is to consider impacts to the network only when the updates are required, and to spread the signalling towards other nodes over some time, based on user's activity. + +In both cases, to avoid high processing/signalling load resulting from shared subscription data update, processing/signalling actions resulting from data updates in the MME or SGSN or combined MME/SGSN may take a maximum operator configuration-depending time. + +If the Reset-IDs IE is supported and received, the MME or SGSN or combined MME/SGSN shall make use of the Reset-IDs (together with the HSS's realm) in order to determine which subscriber records are impacted (i.e. check whether at least one received Reset-ID is associated with the subscriber); otherwise the MME or SGSN or combined MME/SGSN shall make use of the HSS Identity received in the Origin-Host AVP (by comparing it with the value stored after successful ULA) and may make use of the received User-Id-List (if any) in order to determine which subscriber records are impacted. + +At the next authenticated radio contact with the UE concerned, if the subscriber record "Location Information Confirmed in HSS" is marked as "Not Confirmed", the restoration procedure shall be triggered. + +See also 3GPP TS 29.118 [46] clause 5.9.2. + +#### 5.2.4.1.3 Detailed behaviour of the HSS + +The HSS shall make use of this procedure in order to indicate to all relevant MMEs, SGSN, and combined MME/SGSNs that the HSS has restarted and may have lost the current MME-Identity and SGSN-Identity of some of its subscribers who may be currently roaming in the MME area and/or SGSN area, and that the HSS, therefore, cannot send a Cancel Location messages or Insert Subscriber Data messages when needed. + +The HSS may make use of this procedure in order to indicate to all relevant MMEs, SGSN, and combined MME/SGSNs that the HSS has updated subscription data shared by some of its subscribers who may be currently roaming in the MME area and/or SGSN area. + +If the Reset-ID feature is not supported by the MME/SGSN and HSS, the HSS optionally may include a list of Ids identifying a subset of subscribers served by the HSS, if the occurred failure is limited to those subscribers. + +If the Reset-ID feature is supported by the MME or SGSN, the HSS optionally may include one (or several) Reset-ID AVPs identifying e.g. failed hardware components if the occurred failure is limited to those subscribers associated with e.g. the identified failed hardware components. + +The HSS should invoke this procedure towards a combined MME/SGSN only for a single time even if some of the impacted subscribers are attached to the combined MME/SGSN via UTRAN/GERAN and some of the impacted subscribers are attached to the combined MME/SGSN via E-UTRAN. + +## 5.2.5 Notification Procedures + +### 5.2.5.1 Notification + +#### 5.2.5.1.1 General + +The Notification Procedure shall be used between the MME and the HSS and between the SGSN and the HSS when an inter MME or SGSN location update does not occur but the HSS needs to be notified about + +- an update of terminal information; +- an update of the UE SRVCC capability (only if the MME/SGSN supports SRVCC). + +The Notification Procedure shall also be used between the MME and the HSS and between the SGSN and the HSS if the HSS needs to be notified about: + +- an assignment/change of a dynamically allocated PDN GW for an APN, if such a notification is needed taking into account the access restrictions and the type of PDN; + +NOTE: If the PDN is of type "non-IP", the APN is not accessible via non-3GPP access and therefore the PDN-GW ID does not need to be conveyed across accesses. + +- an assignment/change of a dynamically allocated PDN GW for the establishment of emergency PDN connections, if such notification is needed for a non roaming authenticated user, based on operator policy (e.g. on whether the operator uses static PDN GW or not for emergency services) taking into account the access restrictions and feature support; +- the failed monitoring event configurations at the MME or SGSN (if received in ULA) or the status of the monitoring event configurations at the IWK-SCEF; +- the deletion of a monitoring event configuration in SCEF for a UE (i.e. due to an SCEF restart, see 3GPP TS 23.007 [43]). + +The Notification Procedure shall be used between the MME and the HSS when an inter MME location update does not occur but the HSS needs to be notified about + +- the need to send a Cancel Location to the current SGSN. + +The Notification Procedure shall be used between the MME and the HSS when the "SMS in MME" feature is applied and between the SGSN and the HSS when an earlier short message delivery failed and the HSS needs to be notified about: + +- the UE is reachable or the UE has memory capacity available to receive one or more short messages. + +The Notification Procedure shall be used between the MME and the HSS and between the SGSN and the HSS when the HSS has requested to be notified about: + +- the UE is reachable. + +The Notification Procedure shall be used between the MME and the HSS and between the SGSN and the HSS to notify the HSS about: + +- an update of the Homogeneous Support of IMS Voice Over PS Sessions. + +The Notification Procedure shall be used between the MME and the HSS to notify the HSS about: + +- removal of MME registration for SMS. + +This procedure is mapped to the commands Notify-Request/Answer (NOR/NOA) in the Diameter application specified in clause 7. + +Table 5.2.5.1.1/1 specifies the involved information elements for the request. + +Table 5.2.5.1.1/2 specifies the involved information elements for the answer. + +**Table 5.2.5.1.1/1: Notify Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Terminal Information
(See 7.3.3) | Terminal-Information | C | This information element shall contain information about the user's mobile equipment.
When notifying the HSS about any change of Terminal Information, the MME or SGSN shall include the new Terminal Information in the request. Within this Information Element, only the IMEI and the Software-Version AVPs shall be used on the S6a/S6d interface. | +| PDN GW Identity
(See 7.3.45) | MIP6-Agent-Info | C | This IE shall contain the identity of the selected and dynamically allocated PDN GW for an APN. It shall be present if a new PDN-GW has been selected and the subscriber is allowed handover to non 3GPP access or 5GS interworking without N26 interface enabled.
When notifying the HSS about a newly selected PDN GW, the MME or SGSN shall include the PDN-GW-Identity in the request.
For establishment of emergency PDN connections, this IE shall contain the identity of the PDN-GW used to establish those PDN connections. | +| PGW PLMN ID | Visited-Network-Identifier | C | This IE identifies the PLMN in which the PDN GW is located. It shall be present when the PDN GW Identity is present and does not contain an FQDN. | +| Context Identifier
(See 7.3.27) | Context-Identifier | O | This parameter shall identify the APN Configuration with which the selected PDN GW shall be correlated.
It may be present if it is available and the PDN-GW is present and is particular for one specific APN and not common to all the APNs.
For the compatibility with the MAP protocol as defined in the 3GPP TS 29.002 [24], this parameter shall not have a value of zero. | +| APN
(See TS 23.008 [30]) | Service-Selection
(See IETF RFC 5778 [20]) | C | This IE shall contain the APN for the selected and dynamically allocated PDN GW.

For establishment of non-emergency PDN connections, it shall be present if the selected PDN-GW is present and is particular for one specific APN and not common to all the APNs.

For establishment of emergency PDN connections (i.e., the Emergency-Services AVP is present, with the Emergency-Indication flag set), this AVP shall be left absent. | +| Alert Reason
(See 7.3.83) | Alert-Reason | C | This parameter shall indicate if the mobile subscriber is present or the MS has memory available.
It shall be present when notifying the HSS about the presence of the UE or the UE has memory capacity available to receive one or more short messages. | +| UE SRVCC Capability | UE-SRVCC-Capability | C | This information element shall indicate if the UE supports or does not support the SRVCC capability.
If the MME/SGSN supports SRVCC and the UE SRVCC Capability has changed, the MME or SGSN shall include the new UE SRVCC Capability in the request. | +| NOR Flags
(See 7.3.49) | NOR-Flags | C | This Information Element shall contain a bit mask. See 7.3.49 for the meaning of the bits. Absence of this information element shall be interpreted as all bits set to 0.
When notifying the HSS about the need to send cancel location to the current SGSN, the MME shall set the "Single-Registration-Indication" flag in the NOR-Flags.
When notifying the HSS about the "restricted" status of the current SGSN area, the SGSN shall set the "SGSN area restricted" flag in the NOR-Flags.
When notifying the HSS about the reachability of the UE or the UE has memory capacity available to receive one or more short messages, the MME, if the "SMS in MME" feature is applied, or SGSN shall set the "Ready for SM" flag correspondingly in the NOR-Flags. | + +| | | | | +|-----------------------------------------------------------------|----------------------------------------------------|---|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | When notifying the HSS that the UE is reachable, the MME or SGSN shall set the "UE Reachable" flag correspondingly in the NOR-Flags.
When notifying the HSS about update of the Homogeneous Support of IMS Voice Over PS Sessions, the MME or the SGSN shall set the "Homogeneous Support of IMS Voice Over PS Sessions" flag and S6a/S6d-Indicator flag for a combined MME/SGSN correspondingly in the NOR-Flags.
When notifying the HSS about removal of MME registration for SMS, the MME shall set the "Removal of MME Registration for SMS" flag correspondingly in the NOR-Flags. | +| Homogeneous Support of IMS Voice Over PS Sessions (See 7.3.107) | Homogeneous -Support-of-IMS-Voice-Over-PS-Sessions | C | This Information Element shall be present if Homogeneous Support of IMS Voice Over PS Sessions is modified to one of the values "SUPPORTED" or "NOT_SUPPORTED".

The value "SUPPORTED" indicates that there is support for "IMS Voice over PS Sessions" in all TAs or RAs.

The value "NOT_SUPPORTED" indicates that there is not support for "IMS Voice over PS Sessions" in any of the TAs or RAs. | +| Maximum UE Availability Time | Maximum-UE-Availability-Time | O | This information element may be included when notifying the HSS that the UE is reachable. When present, it shall indicate the timestamp (in UTC) until which a UE using a power saving mechanism (such as extended idle mode DRX) is expected to be reachable for SM Delivery.
This information may be used by the SMS Center to prioritize the retransmission of Short Message to UEs using a power saving mechanism. | +| Monitoring Event Config Status | Monitoring-Event-Config-Status | C | This information element shall be present if the MME/SGSN sends the Notify Request after receiving the Configuration-Information-Answer from the IWK-SCEF. This information element shall only contain the monitoring event configuration status of those events whose configuration status has changed since the last status informed to the HSS.

This information element shall also be present if any of the monitoring events configurations received in ULA failed and shall only contain the monitoring event configuration status of those events whose detection could not be started at the MME/SGSN.

This information element shall also be present if the MME or SGSN determines that a Monitoring Event Configuration for a UE is to be deleted in the HSS (i.e. SCEF responds to a Monitoring Event Report with DIAMETER_ERROR_SCEF_REFERENCE_ID_UNKNOWN). | +| Emergency Services (See 3GPP TS 29.273 [59]) | Emergency-Services | C | The MME shall include this information element, and set the Emergency-Indication flag, to notify the HSS that a new PDN-GW has been selected for the establishment of an emergency PDN connection, whose identity is conveyed in the "PDN GW Identity" IE. | + +Table 5.2.5.1.1/2: Notify Answer + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result (See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S6a/S6d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown | +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 5.2.5.1.2 Detailed behaviour of the MME and the SGSN + +If the MME or SGSN supports Emergency services, the MME or SGSN shall not make use of the Notification procedure for emergency attached unauthenticated UEs; for authenticated UEs, the MME shall make use of the Notification procedure to inform the HSS about the PDN-GW selected to establish emergency PDN connections, if the MME is configured to use a dynamic PGW for emergency services for such UEs. + +The MME or SGSN shall not make use of the Notification procedure to inform the HSS about the identity of the dynamically selected PDN-GW, if the access restrictions indicate that the user is not allowed to get service via non-3GPP access, or the PDN type of the APN is of type "non-IP". + +The MME or SGSN shall include conditional AVPs in NOR according to the description given in table 5.2.5.1.1/1. + +If the MME sends a Notify Request to inform the HSS that the UE has become reachable again, the MME shall clear the corresponding URRP-MME for the UE. + +If the SGSN sends a Notify Request to inform the HSS that the UE has become reachable again, the SGSN shall clear the corresponding URRP-SGSN for the UE. + +If the MME sends a Notify Request to inform the HSS about the presence of the UE to receive one or more short messages, the MME shall clear the corresponding MNRF for the UE. + +If the SGSN sends a Notify Request to inform the HSS about the presence of the UE to receive one or more short messages, the SGSN shall clear the corresponding MNRG for the UE. + +If the MME or SGSN determines that it needs to update the Homogeneous Support of IMS Voice Over PS Sessions in the HSS, the MME or SGSN shall send a Notify Request with the "Homogeneous Support of IMS Voice Over PS Sessions" bit set in the NOR-Flags AVP; if there is homogeneous support, or homogeneous non-support, of IMS Voice Over PS Sessions, the MME or SGSN shall report it by including the updated Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions AVP; if the support is not homogeneous, the MME or SGSN shall report it by leaving such AVP absent in the Notify Request to the HSS. MME or SGSN shall ensure the status of Homogeneous Support of IMS Voice Sessions in HSS does not contradict with the value of "IMS voice over PS session indicator" provided to UE over NAS as specified in 3GPP TS 24.008 [31] and 3GPP TS 24.301 [64]; + +if "IMS voice over PS session indicator" sent to UE has changed from "not supported" to "supported" when status Homogenous Support of IMS Voice in HSS is "not supported", MME or SGSN shall immediately send Notify Request indicating as either homogenous support or not homogeneous; + +if "IMS voice over PS session indicator" sent to UE has changed from "supported" to "not supported" when status Homogenous Support of IMS Voice in HSS is "supported", MME or SGSN shall immediately send Notify Request indicating as either homogenous non-support or not homogeneous. + +If the MME needs to indicate to the HSS that it is no longer registered for SMS in the HSS, the MME shall send a Notify Request with "Removal of MME Registration for SMS" flag set in the NOR-Flags AVP. + +When receiving a Notify response from the HSS, if the result code indicates + +DIAMETER\_ERROR\_UNKNOWN\_SERVING\_NODE, the MME or SGSN shall consider the Notification procedure as failed, and it shall mark the subscriber record as "Subscriber to be restored in HSS". + +When receiving a Notify response from the HSS, if the result code indicates + +DIAMETER\_ERROR\_USER\_UNKNOWN, the MME or SGSN shall detach the subscriber and remove the subscriber from its database. + +If the MME/SGSN has received the monitoring event configurations in an ULA command and one, several or all event detections fail to be started (e.g due to maximum resources exceeded), the MME/SGSN shall send the Notify Request command with the Monitoring-Event-Config-Status AVP for the failed monitoring event configurations. + +If the MME or SGSN receives a failure response, e.g. DIAMETER\_UNABLE\_TO\_COMPLY, corresponding to a Notify Request to notify the HSS about the selected PDN-GW, the MME or SGSN shall not trigger a detach for the subscriber based only on this failure. + +NOTE 1: A failure to indicate the selected PDN-GW to the HSS does not impact connectivity provided via 3GPP access. + +When the MME/SGSN has received the Configuration-Information-Answer from the IWK-SCEF during the monitoring event configuration procedure, the MME/SGSN shall send the Notify Request command with the Monitoring-Event-Config-Status AVP as received from the IWK-SCEF in the Configuration-Information-Answer, for the monitoring + +event configurations whose status have changed (due to authorization performed by the IWK-SCEF) since last informed to the HSS. + +NOTE 2: If the Monitoring-Event-Configuration was received at the MME/SGSN in the ULA command, then the HSS is not yet informed of any status of the monitoring event configuration. In this case, the entire Monitoring-Event-Config-Status as received from IWK-SCEF has to be transferred to the HSS through a Notify Request Command. + +If the MME or SGSN determines that a Monitoring Event Configuration for a UE is to be deleted in the HSS (i.e. SCEF responds to a Monitoring Event Report with DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN), the MME or SGSN shall send a Notify Request with the Monitoring-Event-Config-Status AVP. The Monitoring-Event-Config-Status AVP shall include the error as received from SCEF. + +#### 5.2.5.1.3 Detailed behaviour of the HSS + +When receiving a Notify request the HSS shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If the IMSI is known, and the source MME or SGSN originating the Notify message is not currently registered in HSS for that UE, a result code of DIAMETER\_ERROR\_UNKNOWN\_SERVING\_NODE shall be returned. + +If the IMSI is known, and the source MME or SGSN is currently registered in HSS, the HSS shall set the result code to DIAMETER\_SUCCESS, unless otherwise stated, and + +- store the new terminal information if present in the request; +- store the new UE SRVCC capability if present in the request; +- store the new PDN GW and PLMN ID for an APN if present in the request and the APN is present in the subscription and if PDN GW is dynamically allocated; otherwise the HSS shall not store the new PDN GW data and shall set the result code to DIAMETER\_UNABLE\_TO\_COMPLY; +- store the new PDN GW and PLMN ID, and the APN itself, if both are present in the request, and the APN is not present in the subscription but a wild card APN is present in the subscription; +- if the Emergency Services IE is present, with the Emergency-Indication flag set, store the new PDN GW, as the PDN GW used to establish emergency PDN connections; the HSS shall store this information not bound to any specific APN; +- mark the location area as "restricted" if so indicated in the request; +- send Cancel Location to the current SGSN if so indicated in the request; +- if the UE has become reachable again, and NOR is received on S6a from an MME or on S6d from an SGSN, the HSS shall respectively clear the URRP-MME or the URPP-SGSN parameter for the UE and send an indication to the Service Related Entities if there is any; +- when NOR is received on S6d from an SGSN (with the Alert Reason present), the HSS shall reset the MNRG flag and send a MAP-Alert-Service-Centre message or S6c-Alert-Service-Centre-Request (see 3GPP TS 29.338 [48], i.e. the behaviour in the HSS should be the same as when a MAP-Ready for SM is received from an SGSN; +- when NOR is received on S6a from an MME (with the Alert Reason present), the HSS shall reset the MNRF flag and send a MAP-Alert-Service-Centre message or S6c-Alert-Service-Centre-Request (see 3GPP TS 29.338 [48], i.e. the behaviour in the HSS should be the same as when a MAP-Ready for SM is received from a VLR/MSC; +- when NOR is received on S6a from an MME or on S6d from an SGSN to update the Homogeneous Support of IMS Voice Over PS Sessions, the HSS shall store the updated Homogeneous Support of IMS Voice Over PS Sessions and may use this information in the future in order to skip the T-ADS data retrieval, as described in clause 5.2.2.1 (IDR/IDA commands). If the "Homogeneous Support of IMS Voice Over PS Sessions" bit is set in the NOR-Flags AVP received but without Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions AVP present in the NOR message, the HSS shall take the Homogeneous Support of IMS Voice Over PS Sessions as unknown to the serving node. If the "Homogeneous Support of IMS Voice Over PS Sessions" bit is not set in the NOR-Flags AVP, the HSS shall ignore (if present) the Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions AVP; + +- when NOR is received on S6a from an MME for removal of MME registration for SMS, the HSS shall remove the MME registration for SMS and the "MME number for SMS" as the corresponding MSC number to be used for MT SMS. +- when NOR is received on S6a from an MME or on S6d from an SGSN with the Monitoring-Event-Config-Status AVP, the HSS shall either trigger a Monitoring event cancelation procedure for the monitoring events that were not successfully authorized at the MME/SGSN by the IWK-SCEF or a Monitoring event suspension procedure for the monitoring events that were not successfully configured at the MME/SGSN, as specified in clause 7.2.2.2 of 3GPP TS 29.336 [54]. The HSS shall trigger a Monitoring event cancelation or suspension procedure based on the result code as indicated by MME/SGSN (e.g. DIAMETER\_ERROR\_UNAUTHORIZED\_REQUESTING\_ENTITY (5510) returned by IWK-SCEF triggers a Monitoring event cancelation procedure in HSS). +- when NOR is received on S6a from an MME or on S6d from an SGSN with an indication of the deletion of a monitoring event configuration in SCEF (DIAMETER\_ERROR\_SCEF\_REFERENCE\_ID\_UNKNOWN in the Monitoring-Event-Config-Status AVP), the HSS shall locally delete the corresponding Monitoring Event Configuration and shall not trigger a Monitoring event cancelation procedure. + +and then send the response to the MME or SGSN. + +--- + +## 5A MME – CSS (S7a) and SGSN – CSS (S7d) + +### 5A.1 Introduction + +The S7a interface enables the transfer of subscriber related CSG data in the VPLMN between the MME and the CSS as described in 3GPP TS 23.401 [2]. + +The S7d interface enables the transfer of subscriber related CSG data in the VPLMN between the SGSN and the CSS as described in 3GPP TS 23.060 [12]. + +### 5A.2 Mobility Services + +#### 5A.2.1 Location Management Procedures + +##### 5A.2.1.1 Update VCSG Location + +###### 5A.2.1.1.1 General + +The Update VCSG Location Procedure shall be used between the MME and the CSS or between the SGSN and the CSS to update location information in the CSS or retrieve the CSG subscription data of the UE from the CSS. The procedure allows: + +- to inform the CSS about the identity of the MME or SGSN currently serving the user, +- to update MME or SGSN with user CSG subscription data received from the CSS. + +This procedure is mapped to the commands Update-VCSG-Location-Request/Answer (UVR/UVA) in the Diameter application specified in clause 7. + +Table 5A.2.1.1.1/1 specifies the involved information elements for the request. + +Table 5A.2.1.1.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.1.1.1/1: Update VCSG Location Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| MSISDN | MSISDN | C | This information element shall contain the user MSISDN, formatted according to 3GPP TS 29.329 [25]. It shall be present if available. | +| UVR Flags
(See 7.3.153) | UVR-Flags | M | This Information Element contains a bit mask. See 7.3.153 for the meaning of the bits. | +| SGSN number
(See 7.3.102) | SGSN-Number | C | This Information Element contains the ISDN number of the SGSN, see 3GPP TS 23.003 [3].
It shall be present when the message is sent on the S7d interface.
It may be present when the message is sent on the S7a interface and the requesting node is a combined MME/SGSN. | + +**Table 5A.2.1.1.1/2: Update VCSG Location Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S7a/S7d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable:
- User Unknown | +| VPLMN CSG Subscription Data
(See 7.3.155) | VPLMN-CSG-Subscription-Data | C | This Information Element shall contain the list of CSG Ids and the associated expiry dates stored in the CSS. It shall be present if success is reported, unless an explicit "skip subscriber data" indication was present in the request or the Temporary Empty VPLMN CSG Subscription Data flag is set. | +| UVA Flags
(See 7.3.154) | UVA-Flags | C | This Information Element contains a bit mask. See 7.3.154 for the meaning of the bits. | + +#### 5A.2.1.1.2 Detailed behaviour of the MME and the SGSN + +The MME or SGSN shall make use of this procedure to register the UE in the CSS and to retrieve the "CSG subscription data from CSS" when: + +- the VPLMN supports Autonomous CSG Roaming +- and the HPLMN has enabled Autonomous CSG Roaming in the VPLMN +- and the UE has requested an initial attach or a tracking area procedure or a routing area procedure to a CSG cell +- and the MME or SGSN have not yet registered the UE in the CSS. + +If the Autonomous CSG Roaming in the VPLMN is not supported or is not allowed by the HPLMN of the subscriber, the MME or SGSN shall not make use of the Update CSG Location procedure. + +For UEs receiving emergency services, in which the UE was not successfully authenticated, the MME or SGSN shall not make use of the Update VCSG Location procedure. + +A combined MME/SGSN shall set the "Skip Subscriber Data" flag in the UVR-Flags if the "CSG subscription data from CSS" are already available due to a previously VCSG Location updating. + +A combined MME/SGSN that has chosen the option to include the SGSN Number within an Update VCSG Request sent over S7a shall be prepared to receive a single CSG subscription data update message from the CSS when the CSG subscription data is modified in the CSS. + +When receiving an Update VCSG Location Answer from the CSS, the MME or SGSN shall check the result code. If it indicates success the MME or SGSN shall delete all the stored "CSG subscription data from CSS" (if any) and then store the received "CSG subscription data from the CSS" (if any), and it shall store the CSS identity as received in the Origin-Host AVP. + +If the same CSG Id exists in both "CSG subscription data from CSS" and "CSG subscription data from HSS", the "CSG subscription data from HSS" shall take precedence over the "CSG subscription data from CSS" in further use. + +If an error response is received from the CSS, the MME or SGSN shall not reject the UE and shall end the procedure when the UE is attaching to a normal cell. If the UE is attaching to a CSG cell, in this case the MME or SGSN shall check if there is such CSG Id from the HSS. If there is no such CSG Id, the MME or SGSN shall reject the UE. + +#### 5A.2.1.1.3 Detailed behaviour of the CSS + +When receiving an Update VCSG Location request the CSS shall check whether the user is known. + +If the user is not known, and if the Update VCSG Location Request is received over the S7a/S7d interface, the CSS may: + +- store the MME or SGSN identity received within the Origin-Host AVP, and include the UVA-Flags AVP with "Temporary Empty VPLMN CSG Subscription Data" flag set, and return a Result Code of DIAMETER\_SUCCESS, or +- return a Result Code of DIAMETER\_ERROR\_USER\_UNKNOWN. + +NOTE: A mechanism is needed in the CSS to associate the CSG subscription data of the user with the received IMSI. + +If the Update VCSG Location Request is received over the S7a/S7d interface, the CSS shall replace the stored MME or SGSN identity with the received value (the identity is received within the Origin-Host AVP). + +If no result code indicating an error is sent to the MME or SGSN, the CSS shall include the VPLMN CSG subscription data in the Update VCSG Location Answer unless an explicit "skip subscriber data" indication has been received in the request, and shall return a Result Code of DIAMETER\_SUCCESS. + +#### 5A.2.1.2 Cancel VCSG Location + +##### 5A.2.1.2.1 General + +The Cancel VCSG Location Procedure shall be used between the CSS and the MME and between the CSS and the SGSN. The procedure shall be invoked by the CSS and is used: + +- to inform the MME or SGSN about the subscriber's VCSG subscription withdrawal by the CSS operator and the removal of their registration in the CSS. + +This procedure is mapped to the commands Cancel-VCSG-Location-Request/Answer (CVR/CVA) in the Diameter application specified in clause 7. + +Table 5A.2.1.2.1/1 specifies the involved information elements for the request. + +Table 5A.2.1.2.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.1.2.1/1: Cancel VCSG Location Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|--------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Cancellation Type
(See 7.3.24) | Cancellation-Type | M | Defined values that can be used are:
- Subscription Withdrawal, applied to the VPLMN CSG subscription. | + +**Table 5A.2.1.2.1/2: Cancel VCSG Location Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | The result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]). | + +#### 5A.2.1.2.2 Detailed behaviour of the MME and the SGSN + +When receiving a Cancel VCSG Location request the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_SUCCESS is returned. + +If it is known, the MME or SGSN shall check if the Cancellation Type is Subscription Withdrawal. In this case, the MME or SGSN shall remove the information of their registration in the CSS and the stored VPLMN CSG subscription if any. Also in this case a result code of DIAMETER\_SUCCESS is returned. + +When a UE is served by a single combined MME/SGSN for both E-UTRAN and non-E-UTRAN access, the combined MME/SGSN shall check if the Cancellation Type is Subscription Withdrawal. In this case, the Cancel VCSG Location request is processed both in the MME part and in the SGSN part of the combined node. + +#### 5A.2.1.2.3 Detailed behaviour of the CSS + +The CSS shall make use of this procedure when the user's VPLMN CSG subscription is withdrawn by the CSS operator and shall include a cancellation type of "Subscription Withdrawal". + +### 5A.2.2 Subscriber Data Handling Procedures + +#### 5A.2.2.1 Insert VCSG Subscriber Data + +##### 5A.2.2.1.1 General + +The Insert VCSG Subscriber Data Procedure shall be used between the CSS and the MME and between the CSS and the SGSN for updating CSG subscription data in the MME or SGSN in the following situations: + +- due to administrative changes of the user data in the CSS and the user is now located in an MME or SGSN, i.e. if the user was given a CSG subscription and the CSG subscription has changed; + +If the CSS knows that the UE has attached to the same combined MME/SGSN via both the E-UTRAN and UTRAN/GERAN, i.e. the CSS has received the Update VCSG Location Request over both the S7a interface and S7d interface respectively with the same SGSN number, the CSS should invoke this procedure for a single time to update CSG subscription data in the combined MME/SGSN, i.e. the CSS should not invoke this procedure for each of the MME and the SGSN registered respectively. + +This procedure is mapped to the commands Insert-Subscriber Data-Request/Answer (IDR/IDA) in the Diameter application specified in clause 7. + +Table 5A.2.2.1.1/1 specifies the involved information elements for the request. + +Table 5A.2.2.1.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.2.1.1/1: Insert VCSG Subscriber Data Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|------------------------------------|------|---------------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name (See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| VPLMN CSG Subscription Data (See 7.3.2) | VPLMN-CSG-Subscription-Data | M | This Information Element shall contain the list of CSG Ids and the associated expiry dates stored in the VPLMN CSS. | + +**Table 5A.2.2.1.1/2: Insert VCSG Subscriber Data Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|---------------------------------------------|-----------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features (See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result (See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation. Result-Code AVP shall be used to indicate success / errors defined in the Diameter base protocol (see IETF RFC 6733 [61]). The Experimental-Result AVP shall be used for S7a/S7d errors. This is a grouped AVP which shall contain the 3GPP Vendor Id in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP. The following errors are applicable in this case:
- User Unknown. | + +#### 5A.2.2.1.2 Detailed behaviour of the MME and the SGSN + +When receiving an Insert VCSG Subscriber Data request, the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If the request does not contain any CSG-Subscription-Data AVP, Experimental-Result shall be set to DIAMETER\_ERROR\_SUBS\_DATA\_ABSENT. + +If the request contains at least one CSG-Subscription-Data AVPs, the MME or SGSN shall delete all the stored "CSG subscription data from CSS" (if any), and then store the received "CSG subscription data from CSS". + +If the MME or SGSN cannot fulfil the received request, e.g. due to a database error, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +If the same CSG Id exists in both "CSG subscription data from CSS" and "CSG subscription data from HSS", the "CSG subscription data from HSS" shall take precedence over the "CSG subscription data from CSS" in further use. + +#### 5A.2.2.1.3 Detailed behaviour of CSS + +The CSS shall make use of this procedure to delete the "CSG subscription data from CSS" stored in the MME or SGSN and replace them with the CSG subscription data sent. + +If the CSS receives a Insert VCSG Subscriber Data answer with the Result Code DIAMETER\_ERROR\_USER\_UNKNOWN, the CSS shall clear the stored MME or SGSN identity. + +#### 5A.2.2.2 Delete VCSG Subscriber Data + +##### 5A.2.2.2.1 General + +This procedure shall be used between the CSS and the MME or between the CSS and the SGSN, to remove all the "CSG subscription data from CSS" stored in the MME or SGSN. The procedure shall be invoked by the CSS. + +If the CSS knows that the UE has attached to the same combined MME/SGSN via both E-UTRAN and UTRAN/GERAN, i.e. the CSS has received the Update VCSG Location Request over both the S7a interface and S7d interface respectively with the same SGSN number, the CSS should invoke this procedure for a single time to remove all the "CSG subscription data from CSS" stored in the combined MME/SGSN, i.e. not invoke this procedure for each of the MME and the SGSN registered respectively. + +This procedure is mapped to the commands Delete-Subscriber-Data-Request/Answer (DSR/DSA) in the S7a/S7d Diameter application specified in clause 7. + +Table 5A.2.2.2.1/1 specifies the involved information elements for the request. + +Table 5A.2.2.2.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.2.2.1/1: Delete VCSG Subscriber Data Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|---------------------------------------|------|--------------------------------------------------------------------------------------------------------------| +| IMSI | User-Name
(See IETF RFC 6733 [61]) | M | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| DSR Flags
(See 7.3.25) | DSR-Flags | M | This Information Element shall contain a bit mask. See 7.3.25 for the meaning of the bits. | + +**Table 5A.2.2.2.1/2: Delete VCSG Subscriber Data Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S7a/S7d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- User Unknown | + +#### 5A.2.2.2.2 Detailed behaviour of the MME and the SGSN + +When receiving a Delete VCSG Subscriber Data request, the MME or SGSN shall check whether the IMSI is known. + +If it is not known, a result code of DIAMETER\_ERROR\_USER\_UNKNOWN shall be returned. + +If it is known, the MME or SGSN shall delete all the stored "CSG subscription data from CSS". + +If the deletion of the subscription data succeeds in the MME or SGSN, the Result-Code shall be set to DIAMETER\_SUCCESS. + +If the MME or SGSN cannot fulfil the received request for other reasons, e.g. due to a database error, it shall set the Result-Code to DIAMETER\_UNABLE\_TO\_COMPLY. + +#### 5A.2.2.2.3 Detailed behaviour of the CSS + +The CSS shall make use of this procedure to remove all the CSG subscription data associated to CSS from the MME or SGSN. + +NOTE: When a Delete VCSG Subscriber Data procedure occurs, the MME or SGSN remains registered in the CSS + +If the CSS receives a Delete VCSG Subscriber Data answer with the Result Code DIAMETER\_ERROR\_USER\_UNKNOWN from the MME or SGSN, the CSS shall clear the stored MME or SGSN identity. + +### 5A.2.3 Fault Recovery Procedures + +#### 5A.2.3.1 VCSG Reset + +##### 5A.2.3.1.1 General + +The VCSG Reset Procedure shall be used by the CSS, after a restart, to indicate to the MME and to the SGSN that a failure has occurred. + +This procedure is mapped to the commands Reset-Request/Answer (RSR/RSA) in the S7a/S7d Diameter application specified in clause 7. + +Table 5A.2.3.1.1/1 specifies the involved information elements for the request. + +Table 5A.2.3.1.1/2 specifies the involved information elements for the answer. + +**Table 5A.2.3.1.1/1: VCSG Reset Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-------------------------|------|-------------------------------------------------------------------------------------------------------| +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +**Table 5A.2.3.1.1/2: VCSG Reset Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|------------------------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result
(See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S7a/S7d errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
There are no Experimental-Result codes applicable for this command. | +| Supported Features
(See 3GPP TS 29.229 [9]) | Supported-Features | O | If present, this information element shall contain the list of features supported by the origin host. | + +#### 5A.2.3.1.2 Detailed behaviour of the MME and the SGSN + +When receiving a VCSG Reset message, the MME or SGSN or combined MME/SGSN, for all roaming users for which they have a registration in CSS, shall mark "Location Information Confirmed in CSS" record as "Not Confirmed". The MME or SGSN or combined MME/SGSN shall make use of the CSS Identity received in the Origin-Host AVP (by comparing it with the value stored after successful ULA) in order to determine which user records are impacted. + +When, as described in 3GPP TS 23.007 [43], an event requiring the MME or SGSN to check the "CSG subscription data from CSS" occurs, and if the user record "Location Information Confirmed in CSS" is marked as "Not Confirmed", the restoration procedure shall be triggered. + +#### 5A.2.3.1.3 Detailed behaviour of the CSS + +The CSS shall make use of this procedure in order to indicate to all relevant MMEs, SGSNs, and combined MME/SGSNs that the CSS has restarted and may have lost the current MME-Identity and SGSN-Identity of some of its users who may be currently roaming in the MME area and/or SGSN area, and to which the CSS, therefore, cannot send e.g. Insert VCSG Subscriber Data messages when needed. + +The CSS should invoke this procedure towards a combined MME/SGSN only for a single time even if some of the impacted subscribers are attached to the combined MME/SGSN via UTRAN/GERAN and some of the impacted subscribers are attached to the combined MME/SGSN via E-UTRAN. + +## 6 MME – EIR (S13) and SGSN – EIR (S13') + +### 6.1 Introduction + +The S13 interface shall enable the ME Identity check procedure between the MME and the EIR as described in the 3GPP TS 23.401 [2]. + +The S13' interface shall enable the ME Identity check procedure between the SGSN and the EIR as described in the 3GPP TS 23.060 [12]. + +### 6.2 ME Identity Check Procedures + +#### 6.2.1 ME Identity Check + +##### 6.2.1.1 General + +This Mobile Equipment Identity Check Procedure shall be used between the MME and the EIR and between the SGSN and the EIR to check the Mobile Equipment's identity status (e.g. to check that it has not been stolen, or, to verify that it does not have faults). + +This procedure is mapped to the commands ME-Identity-Check-Request/Answer (ECR/ECA) in the Diameter application specified in clause 6. + +Table 6.2.1.1/1 specifies the involved information elements for the request. + +Table 6.2.1.1/2 specifies the involved information elements for the answer. + +**Table 6.2.1.1/1: ME Identity Check Request** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|----------------------------------|------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Terminal Information (See 7.3.3) | Terminal-Information | M | This information element shall contain the information about the used mobile equipment i.e. the IMEI. Within this Information Element, only the IMEI and the Software-Version AVPs shall be used on the S13/S13' interface. | +| IMSI | User-Name (See IETF RFC 6733 [61]) | O | This information element shall contain the user IMSI, formatted according to 3GPP TS 23.003 [3], clause 2.2. | + +**Table 6.2.1.1/2: ME Identity Check Answer** + +| Information element name | Mapping to Diameter AVP | Cat. | Description | +|-------------------------------|-----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Result (See 7.4) | Result-Code / Experimental-Result | M | This IE shall contain the result of the operation.
The Result-Code AVP shall be used to indicate success / errors as defined in the Diameter base protocol (see IETF RFC 6733 [61]).
The Experimental-Result AVP shall be used for S13/S13' errors. This is a grouped AVP which shall contain the 3GPP Vendor ID in the Vendor-Id AVP, and the error code in the Experimental-Result-Code AVP.
The following errors are applicable in this case:
- Unknown equipment | +| Equipment Status (See 7.3.51) | Equipment-Status | C | This information element shall contain the status of the requested mobile equipment as defined in 3GPP TS 22.016 [13].
It shall be present if the result of the ME Identity Check is DIAMETER_SUCCESS. | + +### 6.2.1.2 Detailed behaviour of the MME and the SGSN + +The MME or the SGSN shall make use of this procedure to check the ME identity, if the MME or the SGSN is configured to check the IMEI with the EIR. + +Terminal-Information, when sent by the MME/SGSN to the EIR, shall contain the IMEI AVP, and it may contain also the Software-Version AVP. + +IMSI may be sent together with Terminal Information to the EIR for operator-determined purposes. + +When receiving the ME Identity Check answer from the EIR, the MME or the SGSN shall check the result code and the equipment status. Dependent upon the result, the MME or the SGSN will decide its subsequent actions (e.g. sending an Attach Reject if the EIR indicates that the Mobile Equipment is unknown or prohibited listed). + +### 6.2.1.3 Detailed behaviour of the EIR + +When receiving an ME Identity Check request, the EIR shall check whether the mobile equipment is known. + +The EIR shall identify the mobile equipment based on the first 14 digits of the IMEI AVP; if a 15th digit is received in the IMEI AVP, this digit shall be ignored by the EIR. + +Based on operator policies, the EIR may also use the Software-Version AVP, in addition to the first 14 digits of the IMEI AVP, to check the equipment identity against prohibited and tracking lists (see 3GPP TS 22.016 [13]). + +If the mobile equipment identity is not known, a result code of DIAMETER\_ERROR\_EQUIPMENT\_UNKNOWN is returned. + +If it is known, the EIR shall return DIAMETER\_SUCCESS with the equipment status. + +## 7 Protocol Specification and Implementation + +### 7.1 Introduction + +#### 7.1.1 Use of Diameter base protocol + +The Diameter base protocol as specified in IETF RFC 6733 [61] shall apply except as modified by the defined support of the methods and the defined support of the commands and AVPs, result and error codes as specified in this specification. Unless otherwise specified, the procedures (including error handling and unrecognised information handling) shall be used unmodified. + +#### 7.1.2 Securing Diameter Messages + +For secure transport of Diameter messages, see 3GPP TS 33.210 [16]. + +If there are no intermediate Diameter Agent networks located between the visited PLMN and the home PLMN, the HSS or the first Diameter Agent located in the home PLMN which has direct connection with the serving network is required to check that the realm contained in the Origin-Realm AVP in the request from the serving network corresponds to the right serving network. + +If there are intermediate Diameter Agent networks located between the visited PLMN and home PLMN, the first Diameter Agent which has direct connection with the serving network is required to check that the realm contained in the Origin-Realm AVP in the request from the serving network corresponds to the right serving network. + +NOTE 1: How to do the above check is implementation specific, e.g. it may be done by checking if the IP addresses of the serving network nodes match with the realm received in the Origin-Realm AVP in the request. + +NOTE 2: Network configurations where a (potential) visited PLMN acts as intermediate Diameter Agent network are not allowed. + +NOTE 3: In the case there are intermediate Diameter Agent networks, the home network has to trust these intermediate Diameter agent networks to do the check and other hop by hop security check. This trust is usually substantiated by contracts since there are no remote technical means to verify if the checks were actually performed. + +#### 7.1.3 Accounting functionality + +Accounting functionality (Accounting Session State Machine, related command codes and AVPs) shall not be used on the S6a, S6d, S13 and S13' interfaces. + +#### 7.1.4 Use of sessions + +Between the MME and the HSS and between the SGSN and the HSS and between the MME and the EIR, Diameter sessions shall be implicitly terminated. An implicitly terminated session is one for which the server does not maintain state information. The client shall not send any re-authorization or session termination requests to the server. + +The Diameter base protocol specified in IETF RFC 6733 [61] includes the Auth-Session-State AVP as the mechanism for the implementation of implicitly terminated sessions. + +The client (server) shall include in its requests (responses) the Auth-Session-State AVP set to the value NO\_STATE\_MAINTAINED (1), as described in IETF RFC 6733 [61]. As a consequence, the server shall not maintain any state information about this session and the client shall not send any session termination request. Neither the Authorization-Lifetime AVP nor the Session-Timeout AVP shall be present in requests or responses. + +#### 7.1.5 Transport protocol + +Diameter messages over the S6a, S6d, S13, S13', S7a and S7d interfaces shall make use of SCTP IETF RFC 4960 [14]. + +## 7.1.6 Routing considerations + +This clause specifies the use of the Diameter routing AVPs Destination-Realm and Destination-Host. + +If an MME or SGSN knows the address/name of the HSS for a certain user, and the associated home network domain name, both the Destination-Realm and Destination-Host AVPs shall be present in the request. + +NOTE: When sending a ULR command for a certain user due to HSS restoration procedure (i.e, after the MME/SGSN have received a Reset command from the HSS), the MME or the SGSN might consider the stored address/name of the HSS for the user to be invalid and hence not known. + +If an MME or SGSN knows only the home network domain name for a certain user, the Destination-Realm AVP shall be present and the command shall be routed to the next Diameter node. + +If an MME or SGSN knows only the identity of the user, the home network domain name shall be derived from the user's IMSI (MNC and MCC values) to construct the EPC Home Network Realm/Domain, as indicated in 3GPP TS 23.003 [3], clause 19.2, and use it as Destination-Realm. + +Consequently, the Destination-Host AVP is declared as optional in the ABNF for all requests initiated by an MME or SGSN. + +The address/name of the EIR shall be locally configured in the MME. + +Requests initiated by the HSS towards an MME or SGSN shall include both Destination-Host and Destination-Realm AVPs. + +The HSS obtains the Destination-Host AVP to use in requests towards an MME or SGSN, from the Origin-Host AVP received in previous requests from the MME or SGSN. Consequently, the Destination-Host AVP is declared as mandatory in the ABNF for all requests initiated by the HSS. The Origin-Host AVP received in requests from the MME may contain a Diameter identity of the MME encoded as specified in clause 19.4.2.4 of 3GPP TS 23.003 [3]. The Origin-Host AVP received in requests from the SGSN may contain a Diameter identity of the SGSN encoded as specified in clause 19.4.2.6 of 3GPP TS 23.003 [3]. + +The HSS obtains the Destination-Realm AVP to use in requests towards an MME or SGSN, from the Origin-Realm AVP received in previous requests from the MME or SGSN. The Origin-Realm AVP in the requests received by the HSS in roaming cases, should contain the domain name of the network to which the MME or the SGSN belongs, encoded as specified in clause 19.2 of 3GPP TS 23.003 [3]. + +The Destination-Realm AVP is declared as mandatory in the ABNF for all requests. + +If the Vendor-Specific-Application-ID AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node, and it shall not be used for routing purposes. + +## 7.1.7 Advertising Application Support + +The HSS, MME, SGSN and EIR shall advertise support of the Diameter S6a/S6d and/or S13/S13' Application by including the value of the application identifier in the Auth-Application-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The vendor identifier value of 3GPP (10415) shall be included in the Supported-Vendor-Id AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands, and in the Vendor-Id AVP within the Vendor-Specific-Application-Id grouped AVP of the Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands. + +The Vendor-Id AVP included in Capabilities-Exchange-Request and Capabilities-Exchange-Answer commands that is not included in the Vendor-Specific-Application-Id AVPs as described above shall indicate the manufacturer of the Diameter node as per IETF RFC 6733 [61]. + +## 7.1.8 Diameter Application Identifier + +This clause specifies three Diameter applications: The S6a/S6d interface application, the S13/S13' interface application, and the S7a/S7d interface application. + +The S6a/S6d interface application allows a Diameter server and a Diameter client: + +- to exchange location information; +- to authorize a user to access the EPS; +- to exchange authentication information; +- to download and handle changes in the subscriber data stored in the server. + +The S6a/S6d interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the S6a/S6d interface application is 16777251 (allocated by IANA). + +The S13/S13' interface application allows a Diameter server and a Diameter client: + +- to check the validity of the ME Identity. + +The S13/S13' interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the S13/S13' interface application is 16777252 (allocated by IANA). + +The S7a/S7d interface application allows a Diameter server and a Diameter client: + +- to authorize a user to access CSGs identified in the CSS while roaming; +- to download and handle changes in CSG subscriber data stored in the CSS. + +The S7a/S7d interface protocol shall be defined as an IETF vendor specific Diameter application, where the vendor is 3GPP. The vendor identifier assigned by IANA to 3GPP () is 10415. + +The Diameter application identifier assigned to the S7a/S7d interface application is 16777308 (allocated by IANA). + +### 7.1.9 Use of the Supported-Features AVP + +When new functionality is introduced on the S6a/S6d interfaces, it should be defined as optional. If backwards incompatible changes can not be avoided, the new functionality shall be introduced as a new feature and support advertised with the Supported-Features AVP. The usage of the Supported-Features AVP on the S6a/S6d interfaces is consistent with the procedures for the dynamic discovery of supported features as defined in clause 7.2 of 3GPP TS 29.229 [9]. + +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 [9], the Supported-Features AVP is of type grouped and contains the Vendor-Id, Feature-List-ID and Feature-List AVPs. On the all reference points as specified in this specification, 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 reference point, the Feature-List-ID AVP shall differentiate those lists from one another. + +The Table 7.3.10/1 defines the features applicable to the S6a/S6d interfaces for the feature list with a Feature-List-ID of 1. The Table 7.3.10/2 defines the features applicable to the S6a/S6d interfaces for the feature list with a Feature-List-ID of 2. + +NOTE 1: If the support of a feature by the receiver is required in order for the receiver to be able to correctly process the request command, then the feature is included in the Supported-Features AVP and the M-bit of the Supported-Features AVP has to be set in the request command, according to 3GPP TS 29.229 [9] clause 7.2.1. + +NOTE 2: Currently none of the features that can be included in the Supported-Features AVP of the ULR command requires that the HSS supports them to successfully process the ULR command. For this reason the MME or SGSN does not need to set the M-bit of the Supported-Features AVP in the ULR command. This corresponds to the exception to the general rule requiring the setting of the M-bit of the Supported-Features AVP in a request described in 3GPP TS 29.229 [9] clause 7.2.1. Setting the M-bit of the Supported-Features AVP in the ULR command will mean that, if any of the features is not supported, the HSS will reject the ULR command as according to 3GPP TS 29.229 [9] clause 7.2.1. + +## 7.2 Commands + +### 7.2.1 Introduction + +This clause defines the Command code values and related ABNF for each command described in this specification. + +### 7.2.2 Command-Code values + +This clause defines Command-Code values for the S6a/S6d interface application and S13/S13' interface application as allocated by IANA in the IETF RFC 5516 [32]. + +Every command is defined by means of the ABNF syntax IETF RFC 2234 [7], according to the Command Code Format (CCF) specification defined in IETF RFC 6733 [61]. In the case, the definition and use of an AVP is not specified in this document, the guidelines in IETF RFC 6733 [61] shall apply. + +The Vendor-Specific-Application-Id AVP shall not be included in any command sent by Diameter nodes supporting applications defined in this specification. If the Vendor-Specific-Application-Id AVP is received in any of the commands defined in this specification, it shall be ignored by the receiving node. + +NOTE: The Vendor-Specific-Application-Id is included as an optional AVP in all Command Code Format specifications defined in this specification in order to overcome potential interoperability issues with intermediate Diameter agents non-compliant with the IETF RFC 6733 [61]. + +The following Command Codes are defined in this specification: + +**Table 7.2.2/1: Command-Code values for S6a/S6d** + +| Command-Name | Abbreviation | Code | Clause | +|------------------------------------|--------------|------|--------| +| Update-Location-Request | ULR | 316 | 7.2.3 | +| Update-Location-Answer | ULA | 316 | 7.2.4 | +| Cancel-Location-Request | CLR | 317 | 7.2.7 | +| Cancel-Location-Answer | CLA | 317 | 7.2.8 | +| Authentication-Information-Request | AIR | 318 | 7.2.5 | +| Authentication-Information-Answer | AIA | 318 | 7.2.6 | +| Insert-Subscriber-Data-Request | IDR | 319 | 7.2.9 | +| Insert-Subscriber-Data-Answer | IDA | 319 | 7.2.10 | +| Delete-Subscriber-Data-Request | DSR | 320 | 7.2.11 | +| Delete-Subscriber-Data-Answer | DSA | 320 | 7.2.12 | +| Purge-UE-Request | PUR | 321 | 7.2.13 | +| Purge-UE-Answer | PUA | 321 | 7.2.14 | +| Reset-Request | RSR | 322 | 7.2.15 | +| Reset-Answer | RSA | 322 | 7.2.16 | +| Notify-Request | NOR | 323 | 7.2.17 | +| Notify-Answer | NOA | 323 | 7.2.18 | + +For these commands, the Application-ID field shall be set to 16777251 (application identifier of the S6a/S6d interface application, allocated by IANA). + +**Table 7.2.2/2: Command-Code values for S13/S13'** + +| Command-Name | Abbreviation | Code | Clause | +|---------------------------|--------------|------|--------| +| ME-Identity-Check-Request | ECR | 324 | 7.2.19 | +| ME-Identity-Check-Answer | ECA | 324 | 7.2.20 | + +For these commands, the Application-ID field shall be set to 16777252 (application identifier of the S13/S13' interface application, allocated by IANA). + +**Table 7.2.2/3: Command-Code values for S7a/S7d** + +| Command-Name | Abbreviation | Code | Clause | +|----------------------------------|--------------|---------|--------| +| Update-VCSG-Location-Request | UVR | 8388638 | 7.2.21 | +| Update-VCSG-Location-Answer | UVA | 8388638 | 7.2.22 | +| Insert-Subscription-Data-Request | IDR | 319 | 7.2.9 | +| Insert-Subscription-Data-Answer | IDA | 319 | 7.2.10 | +| Delete-Subscriber-Data-Request | DSR | 320 | 7.2.11 | +| Delete-Subscriber-Data-Answer | DSA | 320 | 7.2.12 | +| Reset-Request | RSR | 322 | 7.2.15 | +| Reset-Answer | RSA | 322 | 7.2.16 | +| Cancel-VCSG-Location-Request | CVR | 8388642 | 7.2.23 | +| Cancel-VCSG-Location-Answer | CVA | 8388642 | 7.2.24 | + +For these commands, the Application-ID field shall be set to 16777308 (application identifier of the S7a/S7d interface application, allocated by IANA). + +## 7.2.3 Update-Location-Request (ULR) Command + +The Update-Location-Request (ULR) command, indicated by the Command-Code field set to 316 and the "R" bit set in the Command Flags field, is sent from MME or SGSN to HSS. + +Message Format + +``` +< Update-Location-Request > ::= < Diameter Header: 316, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ OC-Supported-Features ] + *[ Supported-Features ] + [ Terminal-Information ] + { RAT-Type } + { ULR-Flags } + [ UE-SRVCC-Capability ] + { Visited-PLMN-Id } + [ SGSN-Number ] + [ Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions ] + [ GMLC-Address ] + *[ Active-APN ] + [ Equivalent-PLMN-List ] + [ MME-Number-for-MT-SMS ] + [ SMS-Register-Request ] + [ SGs-MME-Identity ] + [ Coupled-Node-Diameter-ID ] + [ Adjacent-PLMNs ] +``` + +``` + +[ Supported-Services ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 7.2.4 Update-Location-Answer (ULA) Command + +The Update-Location-Answer (ULA) command, indicated by the Command-Code field set to 316 and the 'R' bit cleared in the Command Flags field, is sent from HSS to MME or SGSN. + +Message Format + +``` + +< Update-Location-Answer > ::= < Diameter Header: 316, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + [ Error-Diagnostic ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + [ ULA-Flags ] + [ Subscription-Data ] + *[ Reset-ID ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.5 Authentication-Information-Request (AIR) Command + +The Authentication-Information-Request (AIR) command, indicated by the Command-Code field set to 318 and the 'R' bit set in the Command Flags field, is sent from MME or SGSN to HSS. + +Message Format + +``` + +< Authentication-Information-Request > ::= < Diameter Header: 318, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ OC-Supported-Features ] + *[Supported-Features] + [ Requested-EUTRAN-Authentication-Info ] + [ Requested-UTRAN-GERAN-Authentication-Info ] + { Visited-PLMN-Id } + [ AIR-Flags ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.6 Authentication-Information-Answer (AIA) Command + +The Authentication-Information-Answer (AIA) command, indicated by the Command-Code field set to 318 and the 'R' bit cleared in the Command Flags field, is sent from HSS to MME or SGSN. + +### Message Format + +``` +< Authentication-Information-Answer > ::= < Diameter Header: 318, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + [ Error-Diagnostic ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[Supported-Features] + [ Authentication-Info ] + [ UE-Usage-Type ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.7 Cancel-Location-Request (CLR) Command + +The Cancel-Location-Request (CLR) command, indicated by the Command-Code field set to 317 and the 'R' bit set in the Command Flags field, is sent from HSS to MME or SGSN. + +### Message Format + +``` +< Cancel-Location-Request > ::= < Diameter Header: 317, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + *[Supported-Features ] + { Cancellation-Type } + [ CLR-Flags ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.8 Cancel-Location-Answer (CLA) Command + +The Cancel-Location-Answer (CLA) command, indicated by the Command-Code field set to 317 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to HSS. + +### Message Format + +``` +< Cancel-Location-Answer > ::= < Diameter Header: 317, PXY, 16777251 > + < Session-Id > +``` + +``` + +[ DRMP ] +[ Vendor-Specific-Application-Id ] +*[ Supported-Features ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 7.2.9 Insert-Subscriber-Data-Request (IDR) Command + +The Insert-Subscriber-Data-Request (IDR) command, indicated by the Command-Code field set to 319 and the 'R' bit set in the Command Flags field, is sent from HSS or CSS to MME or SGSN. + +Message Format when used over the S6a or S6d application: + +``` + +< Insert-Subscriber-Data-Request > ::= < Diameter Header: 319, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + *[ Supported-Features ] + { Subscription-Data } + [ IDR- Flags ] + *[ Reset-ID ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +Message Format when used over the S7a or S7d application: + +``` + +< Insert-Subscriber-Data-Request > ::= < Diameter Header: 319, REQ, PXY, 16777308 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + *[ Supported-Features ] + *[ VPLMN-CSG-Subscription-Data ] + *[ Reset-ID ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.10 Insert-Subscriber-Data-Answer (IDA) Command + +The Insert-Subscriber-Data-Answer (IDA) command, indicated by the Command-Code field set to 319 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to HSS or CSS. + +Message Format when used over the S6a or S6d application: + +``` +< Insert-Subscriber-Data-Answer > ::= < Diameter Header: 319, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ IMS-Voice-Over-PS-Sessions-Supported ] + [ Last-UE-Activity-Time ] + [ RAT-Type ] + [ IDA-Flags ] + [ EPS-User-State ] + [ EPS-Location-Information ] + [Local-Time-Zone ] + [ Supported-Services ] + *[ Monitoring-Event-Report ] + *[ Monitoring-Event-Config-Status ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +Message Format when used over the S7a or S7d application: + +``` +< Insert-Subscriber-Data-Answer > ::= < Diameter Header: 319, PXY, 16777308 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.11 Delete-Subscriber-Data-Request (DSR) Command + +The Delete-Subscriber Data-Request (DSR) command, indicated by the Command-Code field set to 320 and the 'R' bit set in the Command Flags field, is sent from HSS or CSS to MME or SGSN. + +Message Format when used over the S6a/S6d application: + +``` +< Delete-Subscriber-Data-Request > ::= < Diameter Header: 320, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + { User-Name } + *[ Supported-Features ] + { DSR-Flags } +``` + +``` + +[ SCEF-ID ] +*[ Context-Identifier ] +[ Trace-Reference ] +*[ TS-Code ] +*[ SS-Code ] +[ eDRX-Related-RAT ] +*[ External-Identifier ] +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +The SCEF-ID shall be present when the flag "Delete monitoring events" in DSR-Flags AVP is set. + +Message Format when used over the S7a/S7d application: + +``` + +< Delete-Subscriber-Data-Request > ::= < Diameter Header: 320, REQ, PXY, 16777308 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +{ Destination-Host } +{ Destination-Realm } +{ User-Name } +*[ Supported-Features ] +{ DSR-Flags } +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 7.2.12 Delete-Subscriber-Data-Answer (DSA) Command + +The Delete-Subscriber Data-Answer (DSA) command, indicated by the Command-Code field set to 320 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to HSS or CSS. + +Message Format when used over the S6a/S6d application: + +``` + +< Delete-Subscriber-Data-Answer > ::= < Diameter Header: 320, PXY, 16777251 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +*[ Supported-Features ] +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +[ DSA-Flags ] +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +Message Format when used over the S7a /S7d application: + +``` + +< Delete-Subscriber-Data-Answer > ::= < Diameter Header: 320, PXY, 16777308 > +< Session-Id > +[ DRMP ] +[ Vendor-Specific-Application-Id ] +*[ Supported-Features ] + +``` + +``` + +[ Result-Code ] +[ Experimental-Result ] +{ Auth-Session-State } +{ Origin-Host } +{ Origin-Realm } +*[ AVP ] +[ Failed-AVP ] +*[ Proxy-Info ] +*[ Route-Record ] + +``` + +## 7.2.13 Purge-UE-Request (PUR) Command + +The Purge-UE-Request (PUR) command, indicated by the Command-Code field set to 321 and the 'R' bit set in the Command Flags field, is sent from MME or SGSN to HSS. + +Message Format + +``` + +< Purge-UE-Request > ::= < Diameter Header: 321, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ OC-Supported-Features ] + [ PUR-Flags ] + *[ Supported-Features ] + [ EPS-Location-Information ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.14 Purge-UE-Answer (PUA) Command + +The Purge-UE-Answer (PUA) command, indicated by the Command-Code field set to 321 and the 'R' bit cleared in the Command Flags field, is sent from HSS to MME or SGSN. + +Message Format + +``` + +< Purge-UE-Answer > ::= < Diameter Header: 321, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + [ PUA-Flags ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.15 Reset-Request (RSR) Command + +The Reset-Request (RSR) command, indicated by the Command-Code field set to 322 and the 'R' bit set in the Command Flags field, is sent from HSS or CSS to MME or SGSN. + +Message Format when used over the S6a/S6d application: + +``` +< Reset-Request > ::= < Diameter Header: 322, REQ, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + *[ Supported-Features ] + *[ User-Id ] + *[ Reset-ID ] + [ Subscription-Data ] + [ Subscription-Data-Deletion ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +Message Format when used over the S7a /S7d application: + +``` +< Reset-Request > ::= < Diameter Header: 322, REQ, PXY, 16777308 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + { Destination-Host } + { Destination-Realm } + *[ Supported-Features ] + *[ Reset-ID ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.16 Reset-Answer (RSA) Command + +The Reset-Answer (RSA) command, indicated by the Command-Code field set to 322 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to HSS or CSS. + +Message Format when used over the S6a/S6d application: + +``` +< Reset-Answer > ::= < Diameter Header: 322, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] +``` + +\*[ Route-Record ] + +Message Format when used over the S7a /S7d application: + +``` +< Reset-Answer > ::= < Diameter Header: 322, PXY, 16777308 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.17 Notify-Request (NOR) Command + +The Notify-Request (NOR) command, indicated by the Command-Code field set to 323 and the 'R' bit set in the Command Flags field, is sent from MME or SGSN to HSS. + +Message Format + +``` +< Notify-Request > ::= < Diameter Header: 323, REQ, PXY, 16777251 > + < Session-Id > + [ Vendor-Specific-Application-Id ] + [ DRMP ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ OC-Supported-Features ] + *[ Supported-Features ] + [ Terminal-Information ] + [ MIP6-Agent-Info ] + [ Visited-Network-Identifier ] + [ Context-Identifier ] + [Service-Selection] + [ Alert-Reason ] + [ UE-SRVCC-Capability ] + [ NOR-Flags ] + [ Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions ] + [ Maximum-UE-Availability-Time ] + *[ Monitoring-Event-Config-Status ] + [ Emergency-Services ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.18 Notify-Answer (NOA) Command + +The Notify-Answer (NOA) command, indicated by the Command-Code field set to 323 and the 'R' bit cleared in the Command Flags field, is sent from HSS to MME or SGSN. + +Message Format + +``` + +< Notify-Answer> ::= < Diameter Header: 323, PXY, 16777251 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ OC-Supported-Features ] + [ OC-OLR ] + *[ Load ] + *[ Supported-Features ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.19 ME-Identity-Check-Request (ECR) Command + +The ME-Identity-Check-Request (ECR) command, indicated by the Command-Code field set to 324 and the 'R' bit set in the Command Flags field, is sent from MME or SGSN to EIR. + +### Message Format + +``` + +< ME-Identity-Check-Request > ::= < Diameter Header: 324, REQ, PXY, 16777252 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { Terminal-Information } + [ User-Name ] + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.20 ME-Identity-Check-Answer (ECA) Command + +The ME-Identity-Check-Answer (ECA) command, indicated by the Command-Code field set to 324 and the 'R' bit cleared in the Command Flags field, is sent from EIR to MME or SGSN. + +### Message Format + +``` + +< ME-Identity-Check-Answer> ::= < Diameter Header: 324, PXY, 16777252 > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Equipment-Status ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] + +``` + +## 7.2.21 Update-VCSG-Location-Request (UVR) Command + +The Update-VCSG-Location-Request (UVR) command, indicated by the Command-Code field set to 8388638 and the "R" bit set in the Command Flags field, is sent from MME or SGSN to CSS. + +### Message Format + +``` +< Update-VCSG-Location-Request > ::= < Diameter Header: 8388638, REQ, PXY, > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + [ Destination-Host ] + { Destination-Realm } + { User-Name } + [ MSISDN ] + [ SGSN-Number ] + *[ Supported-Features ] + { UVR-Flags } + *[ AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.22 Update-VCSG-Location-Answer (UVA) Command + +The Update-VCSG-Location-Answer (UVA) command, indicated by the Command-Code field set to 8388638 and the 'R' bit cleared in the Command Flags field, is sent from CSS to MME or SGSN. + +### Message Format + +``` +< Update-VCSG-Location-Answer > ::= < Diameter Header: 8388638, PXY, > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + [ Result-Code ] + [ Experimental-Result ] + [ Error-Diagnostic ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ Supported-Features ] + *[ VPLMN-CSG-Subscription-Data ] + [ UVA-Flags ] + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.2.23 Cancel-VCSG-Location-Request (CVR) Command + +The Cancel-VCSG-Location-Request (CVR) command, indicated by the Command-Code field set to 8388642 and the 'R' bit set in the Command Flags field, is sent from CSS to MME or SGSN. + +### Message Format + +``` +< Cancel-VCSG-Location-Request > ::= < Diameter Header: 8388642, REQ, PXY, > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + { Auth-Session-State } + { Origin-Host } +``` + +``` +{ Origin-Realm } +{ Destination-Host } +{ Destination-Realm } +{ User-Name } +*[Supported-Features ] +{ Cancellation-Type } +*[ AVP ] +*[ Proxy-Info ] +*[ Route-Record ] +``` + +## 7.2.24 Cancel-VCSG-Location-Answer (CVA) Command + +The Cancel-VCSG-Location-Answer (CVA) command, indicated by the Command-Code field set to 8388642 and the 'R' bit cleared in the Command Flags field, is sent from MME or SGSN to CSS. + +### Message Format + +``` +< Cancel-VCSG-Location-Answer > ::= < Diameter Header: 8388642, PXY, > + < Session-Id > + [ DRMP ] + [ Vendor-Specific-Application-Id ] + *[ Supported-Features ] + [ Result-Code ] + [ Experimental-Result ] + { Auth-Session-State } + { Origin-Host } + { Origin-Realm } + *[ AVP ] + [ Failed-AVP ] + *[ Proxy-Info ] + *[ Route-Record ] +``` + +## 7.3 Information Elements + +### 7.3.1 General + +The following table specifies the Diameter AVPs defined for the S6a/S6d interface protocol, the S7a/S7d interface protocol and the S13/S13' interface protocol, their AVP Code values, types, possible flag values and whether or not the AVP may be encrypted. The Vendor-ID header of all AVPs defined in this specification shall be set to 3GPP (10415). + +For all AVPs which contain bit masks and are of the type Unsigned32, e.g., ULR-Flags, DSR-Flags, PUA-Flags, etc., 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. + +**Table 7.3.1/1: S6a/S6d, S7a/S7d and S13/S13' specific DiameterAVPs** + +| Attribute Name | AVP Code | Clause defined | Value Type | AVP Flag rules | | | | | +|-------------------------------------------|----------|----------------|-------------|----------------|-----|------------|----------|-----------| +| | | | | Must | May | Should not | Must not | May Encr. | +| Subscription-Data | 1400 | 7.3.2 | Grouped | M, V | | | | No | +| Terminal-Information | 1401 | 7.3.3 | Grouped | M, V | | | | No | +| IMEI | 1402 | 7.3.4 | UTF8String | M, V | | | | No | +| Software-Version | 1403 | 7.3.5 | UTF8String | M, V | | | | No | +| QoS-Subscribed | 1404 | 7.3.77 | OctetString | M, V | | | | No | +| ULR-Flags | 1405 | 7.3.7 | Unsigned32 | M, V | | | | No | +| ULA-Flags | 1406 | 7.3.8 | Unsigned32 | M, V | | | | No | +| Visited-PLMN-Id | 1407 | 7.3.9 | OctetString | M, V | | | | No | +| Requested-EUTRAN-Authentication-Info | 1408 | 7.3.11 | Grouped | M, V | | | | No | +| Requested-UTRAN-GERAN-Authentication-Info | 1409 | 7.3.12 | Grouped | M, V | | | | No | +| Number-Of-Requested-Vectors | 1410 | 7.3.14 | Unsigned32 | M, V | | | | No | +| Re-Synchronization-Info | 1411 | 7.3.15 | OctetString | M, V | | | | No | +| Immediate-Response-Preferred | 1412 | 7.3.16 | Unsigned32 | M, V | | | | No | +| Authentication-Info | 1413 | 7.3.17 | Grouped | M, V | | | | No | +| E-UTRAN-Vector | 1414 | 7.3.18 | Grouped | M, V | | | | No | +| UTRAN-Vector | 1415 | 7.3.19 | Grouped | M, V | | | | No | +| GERAN-Vector | 1416 | 7.3.20 | Grouped | M, V | | | | No | +| Network-Access-Mode | 1417 | 7.3.21 | Enumerated | M, V | | | | No | +| HPLMN-ODB | 1418 | 7.3.22 | Unsigned32 | M, V | | | | No | +| Item-Number | 1419 | 7.3.23 | Unsigned32 | M, V | | | | No | +| Cancellation-Type | 1420 | 7.3.24 | Enumerated | M, V | | | | No | +| DSR-Flags | 1421 | 7.3.25 | Unsigned32 | M, V | | | | No | +| DSA-Flags | 1422 | 7.3.26 | Unsigned32 | M, V | | | | No | +| Context-Identifier | 1423 | 7.3.27 | Unsigned32 | M, V | | | | No | +| Subscriber-Status | 1424 | 7.3.29 | Enumerated | M, V | | | | No | +| Operator-Determined-Barring | 1425 | 7.3.30 | Unsigned32 | M, V | | | | No | +| Access-Restriction-Data | 1426 | 7.3.31 | Unsigned32 | M, V | | | | No | +| APN-OI-Replacement | 1427 | 7.3.32 | UTF8String | M, V | | | | No | +| All-APN-Configurations-Included-Indicator | 1428 | 7.3.33 | Enumerated | M, V | | | | No | +| APN-Configuration-Profile | 1429 | 7.3.34 | Grouped | M, V | | | | No | +| APN-Configuration | 1430 | 7.3.35 | Grouped | M, V | | | | No | +| EPS-Subscribed-QoS-Profile | 1431 | 7.3.37 | Grouped | M, V | | | | No | +| VPLMN-Dynamic-Address-Allowed | 1432 | 7.3.38 | Enumerated | M, V | | | | No | +| STN-SR | 1433 | 7.3.39 | OctetString | M, V | | | | No | +| Alert-Reason | 1434 | 7.3.83 | Enumerate | M, V | | | | No | +| AMBR | 1435 | 7.3.41 | Grouped | M, V | | | | No | +| CSG-Subscription-Data | 1436 | 7.3.78 | Grouped | M, V | | | | No | +| CSG-Id | 1437 | 7.3.79 | Unsigned32 | M, V | | | | No | +| PDN-GW-Allocation-Type | 1438 | 7.3.44 | Enumerated | M, V | | | | No | +| Expiration-Date | 1439 | 7.3.80 | Time | M, V | | | | No | +| RAT-Frequency-Selection-Priority-ID | 1440 | 7.3.46 | Unsigned32 | M, V | | | | No | +| IDA-Flags | 1441 | 7.3.47 | Unsigned32 | M, V | | | | No | +| PUA-Flags | 1442 | 7.3.48 | Unsigned32 | M, V | | | | No | +| NOR-Flags | 1443 | 7.3.49 | Unsigned32 | M, V | | | | No | +| User-Id | 1444 | 7.3.50 | UTF8String | V | | | M | No | +| Equipment-Status | 1445 | 7.3.51 | Enumerated | M, V | | | | No | +| Regional-Subscription-Zone-Code | 1446 | 7.3.52 | OctetString | M, V | | | | No | +| RAND | 1447 | 7.3.53 | OctetString | M, V | | | | No | +| XRES | 1448 | 7.3.54 | OctetString | M, V | | | | No | +| AUTN | 1449 | 7.3.55 | OctetString | M, V | | | | No | +| KASME | 1450 | 7.3.56 | OctetString | M, V | | | | No | +| Trace-Collection-Entity | 1452 | 7.3.98 | Address | M, V | | | | No | +| Kc | 1453 | 7.3.59 | OctetString | M, V | | | | No | +| SRES | 1454 | 7.3.60 | OctetString | M, V | | | | No | +| PDN-Type | 1456 | 7.3.62 | Enumerated | M, V | | | | No | + +| | | | | | | | | | +|---------------------------------------------------|------|---------|-------------|------|--|--|---|----| +| Roaming-Restricted-Due-To-Unsupported-Feature | 1457 | 7.3.81 | Enumerated | M, V | | | | No | +| Trace-Data | 1458 | 7.3.63 | Grouped | M, V | | | | No | +| Trace-Reference | 1459 | 7.3.64 | OctetString | M, V | | | | No | +| Trace-Depth | 1462 | 7.3.67 | Enumerated | M, V | | | | No | +| Trace-NE-Type-List | 1463 | 7.3.68 | OctetString | M, V | | | | No | +| Trace-Interface-List | 1464 | 7.3.69 | OctetString | M, V | | | | No | +| Trace-Event-List | 1465 | 7.3.70 | OctetString | M, V | | | | No | +| OMC-Id | 1466 | 7.3.71 | OctetString | M, V | | | | No | +| GPRS-Subscription-Data | 1467 | 7.3.72 | Grouped | M, V | | | | No | +| Complete-Data-List-Included-Indicator | 1468 | 7.3.73 | Enumerated | M, V | | | | No | +| PDP-Context | 1469 | 7.3.74 | Grouped | M, V | | | | No | +| PDP-Type | 1470 | 7.3.75 | OctetString | M, V | | | | No | +| 3GPP2-MEID | 1471 | 7.3.6 | OctetString | M, V | | | | No | +| Specific-APN-Info | 1472 | 7.3.82 | Grouped | M, V | | | | No | +| LCS-Info | 1473 | 7.3.84 | Grouped | M, V | | | | No | +| GMLC-Number | 1474 | 7.3.85 | OctetString | M, V | | | | No | +| LCS-PrivacyException | 1475 | 7.3.86 | Grouped | M, V | | | | No | +| SS-Code | 1476 | 7.3.87 | OctetString | M, V | | | | No | +| SS-Status | 1477 | 7.3.88 | OctetString | M, V | | | | No | +| Notification-To-UE-User | 1478 | 7.3.89 | Enumerated | M, V | | | | No | +| External-Client | 1479 | 7.3.90 | Grouped | M, V | | | | No | +| Client-Identity | 1480 | 7.3.91 | OctetString | M, V | | | | No | +| GMLC-Restriction | 1481 | 7.3.92 | Enumerated | M, V | | | | No | +| PLMN-Client | 1482 | 7.3.93 | Enumerated | M, V | | | | No | +| Service-Type | 1483 | 7.3.94 | Grouped | M, V | | | | No | +| ServiceTypeIdentity | 1484 | 7.3.95 | Unsigned32 | M, V | | | | No | +| MO-LR | 1485 | 7.3.96 | Grouped | M, V | | | | No | +| Teleservice-List | 1486 | 7.3.99 | Grouped | M, V | | | | No | +| TS-Code | 1487 | 7.3.100 | OctetString | M, V | | | | No | +| Call-Barring-Info | 1488 | 7.3.101 | Grouped | M, V | | | | No | +| SGSN-Number | 1489 | 7.3.102 | OctetString | M, V | | | | No | +| IDR-Flags | 1490 | 7.3.103 | Unsigned32 | M, V | | | | No | +| ICS-Indicator | 1491 | 7.3.104 | Enumerated | V | | | M | No | +| IMS-Voice-Over-PS-Sessions-Supported | 1492 | 7.3.106 | Enumerated | V | | | M | No | +| Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions | 1493 | 7.3.107 | Enumerated | V | | | M | No | +| Last-UE-Activity-Time | 1494 | 7.3.108 | Time | V | | | M | No | +| EPS-User-State | 149 | 7.3.110 | Grouped | V | | | M | No | +| EPS-Location-Information | 149 | 7.3.111 | Grouped | V | | | M | No | +| MME-User-State | 149 | 7.3.112 | Grouped | V | | | M | No | +| SGSN-User-State | 149 | 7.3.113 | Grouped | V | | | M | No | +| User-State | 149 | 7.3.114 | Enumerated | V | | | M | No | +| MME-Location Information | 160 | 7.3.115 | Grouped | V | | | M | No | +| SGSN-Location-Information | 160 | 7.3.116 | Grouped | V | | | M | No | + +| | | | | | | | | | +|-----------------------------------|------|---------|-------------|---|--|--|---|----| +| E-UTRAN-Cell-Global-Identity | 160 | 7.3.117 | OctetString | V | | | M | No | +| Tracking-Area-Identity | 160 | 7.3.118 | OctetString | V | | | M | No | +| Cell-Global-Identity | 160 | 7.3.119 | OctetString | V | | | M | No | +| Routing-Area-Identity | 160 | 7.3.120 | OctetString | V | | | M | No | +| Location-Area-Identity | 160 | 7.3.121 | OctetString | V | | | M | No | +| Service-Area-Identity | 160 | 7.3.122 | OctetString | V | | | M | No | +| Geographical-Information | 160 | 7.3.123 | OctetString | V | | | M | No | +| Geodetic-Information | 160 | 7.3.124 | OctetString | V | | | M | No | +| Current-Location-Retrieved | 161 | 7.3.125 | Enumerated | V | | | M | No | +| Age-Of-Location-Information | 161 | 7.3.126 | Unsigned32 | V | | | M | No | +| Active-APN | 161 | 7.3.127 | Grouped | V | | | M | No | +| Error-Diagnostic | 161 | 7.3.128 | Enumerated | V | | | M | No | +| Ext-PDP-Address | 1621 | 7.3.129 | Address | V | | | M | No | +| UE-SRVCC-Capability | 1615 | 7.3.130 | Enumerated | V | | | M | No | +| MPS-Priority | 1616 | 7.3.131 | Unsigned32 | V | | | M | No | +| VPLMN-LIPA-Allowed | 1617 | 7.3.132 | Enumerated | V | | | M | No | +| LIPA-Permission | 1618 | 7.3.133 | Enumerated | V | | | M | No | +| Subscribed-Periodic-RAU-TAU-Timer | 1619 | 7.3.134 | Unsigned32 | V | | | M | No | +| Ext-PDP-Type | 1620 | 7.3.75A | OctetString | V | | | M | No | +| SIPTO-Permission | 1613 | 7.3.135 | Enumerated | V | | | M | No | +| MDT-Configuration | 1622 | 7.3.136 | Grouped | V | | | M | No | +| Job-Type | 1623 | 7.3.137 | Enumerated | V | | | M | No | +| Area-Scope | 1624 | 7.3.138 | Grouped | V | | | M | No | +| List-Of-Measurements | 1625 | 7.3.139 | Unsigned32 | V | | | M | No | +| Reporting-Trigger | 1626 | 7.3.140 | Unsigned32 | V | | | M | No | +| Report-Interval | 1627 | 7.3.141 | Enumerated | V | | | M | No | +| Report-Amount | 1628 | 7.3.142 | Enumerated | V | | | M | No | +| Event-Threshold-RSRP | 1629 | 7.3.143 | Unsigned32 | V | | | M | No | +| Event-Threshold-RSRQ | 1630 | 7.3.144 | Unsigned32 | v | | | M | No | + +| | | | | | | | | | +|-------------------------------------|------|---------|------------------|------|--|--|---|----| +| Logging-Interval | 1631 | 7.3.145 | Enumerated | V | | | M | No | +| Logging-Duration | 1632 | 7.3.146 | Enumerated | V | | | M | No | +| Relay-Node-Indicator | 1633 | 7.3.147 | Enumerated | V | | | M | No | +| MDT-User-Consent | 1634 | 7.3.148 | Enumerated | V | | | M | No | +| PUR-Flags | 1635 | 7.3.149 | Unsigned32 | V | | | M | No | +| Subscribed-VSRVCC | 1636 | 7.3.150 | Enumerated | V | | | M | No | +| Equivalent-PLMN-List | 1637 | 7.3.151 | Grouped | V | | | M | No | +| CLR-Flags | 1638 | 7.3.152 | Unsigned32 | V | | | M | No | +| UVR-Flags | 1639 | 7.3.153 | Unsigned32 | M, V | | | | No | +| UVA-Flags | 1640 | 7.3.154 | Unsigned32 | M, V | | | | No | +| VPLMN-CSG-Subscription-Data | 1641 | 7.3.155 | Grouped | M, V | | | | No | +| Time-Zone | 1642 | 7.3.163 | UTF8String | V | | | M | No | +| A-MSISDN | 1643 | 7.3.157 | OctetString | V | | | M | No | +| MME-Number-for-MT-SMS | 1645 | 7.3.159 | OctetString | V | | | M | No | +| SMS-Register-Request | 1648 | 7.3.162 | Enumerated | V | | | M | No | +| Local-Time-Zone | 1649 | 7.3.156 | Grouped | V | | | M | No | +| Daylight-Saving-Time | 1650 | 7.3.164 | Enumerated | V | | | M | No | +| Subscription-Data-Flags | 1654 | 7.3.165 | Unsigned32 | V | | | M | No | +| Measurement-Period-LTE | 1655 | 7.3.166 | Enumerated | V | | | M | No | +| Measurement-Period-UMTS | 1656 | 7.3.167 | Enumerated | V | | | M | No | +| Collection-Period-RRM-LTE | 1657 | 7.3.168 | Enumerated | V | | | M | No | +| Collection-Period-RRM-UMTS | 1658 | 7.3.169 | Enumerated | V | | | M | No | +| Positioning-Method | 1659 | 7.3.170 | OctetString | V | | | M | No | +| Measurement-Quantity | 1660 | 7.3.171 | OctetString | V | | | M | No | +| Event-Threshold-Event-1F | 1661 | 7.3.172 | Integer32 | V | | | M | No | +| Event-Threshold-Event-1I | 1662 | 7.3.173 | Integer32 | V | | | M | No | +| Restoration-Priority | 1663 | 7.3.174 | Unsigned32 | V | | | M | No | +| SGs-MME-Identity | 1664 | 7.3.175 | UTF8String | V | | | M | No | +| SIPTO-Local-Network-Permission | 1665 | 7.3.176 | Unsigned32 | V | | | M | No | +| Coupled-Node-Diameter-ID | 1666 | 7.3.177 | DiameterIdentity | V | | | M | No | +| WLAN-offloadability | 1667 | 7.3.181 | Grouped | V | | | M | No | +| WLAN-offloadability-EUTRAN | 1668 | 7.3.182 | Unsigned32 | V | | | M | No | +| WLAN-offloadability-UTRAN | 1669 | 7.3.183 | Unsigned32 | V | | | M | No | +| Reset-ID | 1670 | 7.3.184 | OctetString | V | | | M | No | +| MDT-Allowed-PLMN-Id | 1671 | 7.3.185 | OctetString | V | | | M | No | +| Adjacent-PLMNs | 1672 | 7.3.186 | Grouped | V | | | M | No | +| Adjacent-Access-Restriction-Data | 1673 | 7.3.187 | Grouped | V | | | M | No | +| DL-Buffering-Suggested-Packet-Count | 1674 | 7.3.188 | Integer32 | V | | | M | No | +| IMSI-Group-Id | 1675 | 7.3.189 | Grouped | V | | | M | No | +| Group-Service-Id | 1676 | 7.3.190 | Unsigned32 | V | | | M | No | +| Group-PLMN-Id | 1677 | 7.3.191 | OctetString | V | | | M | No | +| Local-Group-Id | 1678 | 7.3.192 | OctetString | V | | | M | No | +| AIR-Flags | 1679 | 7.3.201 | Unsigned32 | V | | | M | No | +| UE-Usage-Type | 1680 | 7.3.202 | Unsigned32 | V | | | M | No | +| Non-IP-PDN-Type-Indicator | 1681 | 7.3.204 | Enumerated | V | | | M | No | +| Non-IP-Data-Delivery-Mechanism | 1682 | 7.3.205 | Unsigned32 | V | | | M | No | +| Additional-Context-ID | 1683 | 7.3.206 | Unsigned32 | V | | | M | No | +| SCEF-Realm | 1684 | 7.3.207 | DiameterIdentity | V | | | M | No | +| Subscription-Data-Deletion | 1685 | 7.3.208 | Grouped | V | | | M | No | +| Preferred-Data-Mode | 1686 | 7.3.209 | Unsigned32 | V | | | M | No | +| Emergency-Info | 1687 | 7.3.210 | Grouped | V | | | M | No | +| V2X-Subscription-Data | 1688 | 7.3.212 | Grouped | V | | | M | No | +| V2X-Permission | 1689 | 7.3.213 | Unsigned32 | V | | | M | No | +| PDN-Connection-Continuity | 1690 | 7.3.214 | Unsigned32 | V | | | M | No | +| eDRX-Cycle-Length | 1691 | 7.3.215 | Grouped | V | | | M | No | +| eDRX-Cycle-Length-Value | 1692 | 7.3.216 | OctetString | V | | | M | No | +| UE-PC5-AMBR | 1693 | 7.3.217 | Unsigned32 | V | | | M | No | +| MBSFN-Area | 1694 | 7.3.219 | Grouped | V | | | M | No | +| MBSFN-Area-ID | 1695 | 7.3.220 | Unsigned32 | V | | | M | No | +| Carrier-Frequency | 1696 | 7.3.221 | Unsigned32 | V | | | M | No | + +| | | | | | | | | | +|------------------------------------------|------|---------|-------------|---|--|--|---|----| +| RDS-Indicator | 1697 | 7.3.222 | Enumerated | V | | | M | No | +| Service-Gap-Time | 1698 | 7.3.223 | Unsigned32 | V | | | M | No | +| Aerial-UE-Subscription-Information | 1699 | 7.3.224 | Unsigned32 | V | | | M | No | +| Broadcast-Location-Assistance-Data-Types | 1700 | 7.3.225 | Unsigned64 | V | | | M | No | +| Paging-Time-Window | 1701 | 7.3.226 | Grouped | V | | | M | No | +| Operation-Mode | 1702 | 7.3.227 | Unsigned32 | V | | | M | No | +| Paging-Time-Window-Length | 1703 | 7.3.228 | OctetString | V | | | M | No | +| Core-Network-Restrictions | 1704 | 7.3.230 | Unsigned32 | V | | | M | No | +| eDRX-Related-RAT | 1705 | 7.3.229 | Grouped | V | | | M | No | +| Interworking-5GS-Indicator | 1706 | 7.3.231 | Enumerated | V | | | M | No | +| Ethernet-PDN-Type-Indicator | 1707 | 7.3.232 | Enumerated | V | | | M | No | +| Subscribed-ARPI | 1708 | 7.3.233 | Unsigned32 | V | | | M | No | +| IAB-Operation-Permission | 1709 | 7.3.234 | Enumerated | V | | | M | No | +| V2X-Subscription-Data-Nr | 1710 | 7.3.235 | Grouped | V | | | M | No | +| UE-PC5-QoS | 1711 | 7.3.236 | Grouped | V | | | M | No | +| PC5-QoS-Flow | 1712 | 7.3.237 | Grouped | V | | | M | No | +| 5QI | 1713 | 7.3.238 | Integer32 | V | | | M | No | +| PC5-Flow-Bitrates | 1714 | 7.3.239 | Grouped | V | | | M | No | +| Guaranteed-Flow-Bitrates | 1715 | 7.3.240 | Integer32 | V | | | M | No | +| Maximum-Flow-Bitrates | 1716 | 7.3.241 | Integer32 | V | | | M | No | +| PC5-Range | 1717 | 7.3.242 | Integer32 | V | | | M | No | +| PC5-Link-AMBR | 1718 | 7.3.243 | Integer32 | V | | | M | No | +| Third-Context-Identifier | 1719 | 7.3.244 | Unsigned32 | V | | | M | No | + +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 [61]. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +The following table specifies the Diameter AVPs re-used by the S6a/S6d interface protocol from existing Diameter Applications, including a reference to their respective specifications and when needed, a short description of their use within S6a and S6d. + +Any other AVPs from existing Diameter Applications, except for the AVPs from Diameter base protocol specified in IETF RFC 6733 [61], do not need to be supported. The AVPs from the Diameter base protocol specified in IETF RFC 6733 [61] are not included in table 7.3.1/2, but they may be re-used for the S6a/S6d protocol, the S7a/S7 protocol and the S13/S13' protocol. + +**Table 7.3.1/2: S6a/S6d, S7a/S7d and S13/S13' re-used Diameter AVPs** + +| Attribute Name | Reference | Comments | M-bit | +|-------------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| +| Service-Selection | IETF RFC 5778 [20] | See clause 7.3.36 | | +| 3GPP-Charging-Characteristics | 3GPP TS 29.061 [21] | See 3GPP TS 32.251 [33] Annex A and 3GPP TS 32.298 [22] clause 5.1.2.2.7
This attribute holds the EPS PDN Connection Charging Characteristics data for an EPS APN Configuration, or the PDP context Charging Characteristics for GPRS PDP context, or the Subscribed Charging Characteristics data for the subscriber level 3GPP Charging Characteristics; refer to 3GPP TS 23.008 [30]. | | +| Supported-Features | 3GPP TS 29.229 [9] | | | +| Feature-List-ID | 3GPP TS 29.229 [9] | | | +| Feature-List | 3GPP TS 29.229 [9] | See clause 7.3.10 | | +| Served-Party-IP-Address | 3GPP TS 32.299 [8] | holds the PDN IP Address of the user | | +| QoS-Class-Identifier | 3GPP TS 29.212 [10] | | | +| Allocation-Retention-Priority | 3GPP TS 29.212 [10] | See clause 7.3.40 | | +| Priority-Level | 3GPP TS 29.212 [10] | | | +| Pre-emption-Capability | 3GPP TS 29.212 [10] | | | +| Pre-emption-Vulnerability | 3GPP TS 29.212 [10] | | | +| Max-Requested-Bandwidth-DL | 3GPP TS 29.214 [11] | | | +| Max-Requested-Bandwidth-UL | 3GPP TS 29.214 [11] | | | +| Extended-Max-Requested-BW-DL | 3GPP TS 29.214 [11] | | | +| Extended-Max-Requested-BW-UL | 3GPP TS 29.214 [11] | | | +| RAT-Type | 3GPP TS 29.212 [10] | See clause 7.3.13 | Must set | +| MSISDN | 3GPP TS 29.329 [25] | | | +| MIP6-Agent-Info | IETF RFC 5447 [26] | | | +| MIP-Home-Agent-Address | IETF RFC 4004 [27] | | | +| MIP-Home-Agent-Host | IETF RFC 4004 [27] | | | +| PDP-Address | 3GPP TS 32.299 [8] | | | +| Confidentiality-Key | 3GPP TS 29.229 [9] | See clause 7.3.57 | | +| Integrity-Key | 3GPP TS 29.229 [9] | See clause 7.3.58 | | +| Visited-Network-Identifier | 3GPP TS 29.229 [9] | See clause 7.3.105 | Must not set | +| GMLC-Address | 3GPP TS 29.173 [37] | See clause 7.3.109 | Must not set | +| User-CSG-Information | 3GPP TS 32.299 [8] | | Must not set | +| ProSe-Subscription-Data | 3GPP TS 29.344 [49] | See clause 7.3.180 | Must not set | +| OC-Supported-Features | IETF RFC 7683 [50] | See clause 7.3.178 | Must not set | +| OC-OLR | IETF RFC 7683 [50] | See clause 7.3.179 | Must not set | +| SCEF-Reference-ID | 3GPP TS 29.336 [54] | | Must not set | + +| Attribute Name | Reference | Comments | M-bit | +|------------------------------------|---------------------|---------------------|--------------| +| SCEF-ID | 3GPP TS 29.336 [54] | | Must not set | +| AESE-Communication-Pattern | 3GPP TS 29.336 [54] | see clause 7.3.193 | Must not set | +| Communication-Pattern-set | 3GPP TS 29.336 [54] | see clause 7.3.194 | Must not set | +| Monitoring-Event-Configuration | 3GPP TS 29.336 [54] | See clause 7.3.195 | Must not set | +| Monitoring-Event-Report | 3GPP TS 29.336 [54] | See clause 7.3.196 | Must not set | +| UE-Reachability-Configuration | 3GPP TS 29.336 [54] | See clause 7.3.197 | Must not set | +| eNodeB-ID | 3GPP TS 29.217 [56] | See clause 7.3.198 | Must not set | +| SCEF-Reference-ID-for-Deletion | 3GPP TS 29.336 [54] | | Must not set | +| Monitoring-Type | 3GPP TS 29.336 [54] | | Must not set | +| Maximum-Number-of-Reports | 3GPP TS 29.336 [54] | | Must not set | +| Monitoring-Duration | 3GPP TS 29.336 [54] | | Must not set | +| Charged-Party | 3GPP TS 29.336 [54] | | Must not set | +| Location-Information-Configuration | 3GPP TS 29.336 [54] | | Must not set | +| Reachability-Type | 3GPP TS 29.336 [54] | | Must not set | +| Maximum-Response-Time | 3GPP TS 29.336 [54] | | Must not set | +| Reachability-Information | 3GPP TS 29.336 [54] | | Must not set | +| Reachability-Cause | 3GPP TS 29.128 [63] | | Must not set | +| Monitoring-Event-Config-Status | 3GPP TS 29.336 [54] | | Must not set | +| Supported-Services | 3GPP TS 29.336 [54] | See clause 7.3.199 | Must not set | +| Supported-Monitoring-Events | 3GPP TS 29.336 [54] | See clause 7.3.200 | Must not set | +| DRMP | IETF RFC 7944 [57] | See clause 7.3.203 | Must not set | +| Reference-ID-Validity-Time | 3GPP TS 29.336 [54] | | Must not set | +| Maximum-UE-Availability-Time | 3GPP TS 29.338 [48] | See clause 5.3.3.22 | Must not set | +| Emergency-Services | 3GPP TS 29.273 [59] | | | +| Load | IETF RFC 8583 [60] | See clause 7.3.211 | Must not set | +| Extended-eNodeB-ID | 3GPP TS 29.217 [56] | See clause 7.3.218 | Must not set | +| External-Identifier | 3GPP TS 29.336 [54] | | Must not set | + +| Attribute Name | Reference | Comments | M-bit | +|---------------------------------------|---------------------|--------------------|-------------------| +| Loss-Of-Connectivity-Reason | 3GPP TS 29.336 [54] | | Must not set | +| Active-Time | 3GPP TS 29.128 [63] | | Must not set | +| Idle-Status-Indication | 3GPP TS 29.128 [63] | | Must not set | +| MTC-Provider-Info | 3GPP TS 29.336 [54] | | Must not set | +| Traffic-Profile | 3GPP TS 29.336 [54] | | Must not set | +| PDN-Connectivity-Status-Configuration | 3GPP TS 29.336 [54] | See clause 7.3.195 | Must not set | +| PDN-Connectivity-Status-Report | 3GPP TS 29.336 [54] | See clause 7.3.196 | Must not set | +| Battery-Indicator | 3GPP TS 29.336 [54] | | Battery-Indicator | +| SCEF-Reference-ID-Ext | 3GPP TS 29.336 [54] | | Must not set | +| SCEF-Reference-ID-for-Deletion-Ext | 3GPP TS 29.336 [54] | | Must not set | + +NOTE 1: The M-bit settings for re-used AVPs override those of the defining specifications that are referenced. Values include: "Must set", "Must not set". If the M-bit setting is blank, then the defining specification applies. + +NOTE 2: If the M-bit is set for an AVP and the receiver does not understand the AVP, it shall return a rejection. If the M-bit is not set for an AVP, the receiver shall not return a rejection, whether or not it understands the AVP. If the receiver understands the AVP but the M-bit value does not match with the definition in this table, the receiver shall ignore the M-bit. + +### 7.3.2 Subscription-Data + +The Subscription-Data AVP is of type Grouped. It shall contain the information related to the user profile relevant for EPS and GERAN/UTRAN. + +AVP format: + +Subscription-Data ::= + +[ Subscriber-Status ] + +[ MSISDN ] + +[ A-MSISDN ] + +[ STN-SR ] + +[ ICS-Indicator ] + +[ Network-Access-Mode ] + +[ Operator-Determined-Barring ] + +[ HPLMN-ODB ] + +\*10[ Regional-Subscription-Zone-Code ] + +[ Access-Restriction-Data ] + +[ APN-OI-Replacement ] + +[ LCS-Info ] + +[ Teleservice-List ] + +\*[ Call-Barring-Info ] + +[ 3GPP-Charging-Characteristics ] + +[ AMBR ] + +[ APN-Configuration-Profile ] + +[ RAT-Frequency-Selection-Priority-ID ] + +[ Trace-Data ] + +[ GPRS-Subscription-Data ] + +\*[ CSG-Subscription-Data ] + +[ Roaming-Restricted-Due-To-Unsupported-Feature ] + +[ Subscribed-Periodic-RAU-TAU-Timer ] + +[ MPS-Priority ] + +[ VPLMN-LIPA-Allowed ] + +[ Relay-Node-Indicator ] + +[ MDT-User-Consent ] + +[ Subscribed-VSRVCC ] + +[ ProSe-Subscription-Data ] + +[ Subscription-Data-Flags ] + +\*[ Adjacent-Access-Restriction-Data ] +[ DL-Buffering-Suggested-Packet-Count ] +\*[ IMSI-Group-Id ] +[ UE-Usage-Type ] +\*[ AESE-Communication-Pattern ] +\*[ Monitoring-Event-Configuration ] +[ Emergency-Info ] +[ V2X-Subscription-Data ] +[ V2X-Subscription-Data-Nr ] +\*[ eDRX-Cycle-Length ] +[ External-Identifier ] +[ Active-Time ] +[ Service-Gap-Time ] +[ Broadcast-Location-Assistance-Data-Types ] +[ Aerial-UE-Subscription-Information ] +[ Core-Network-Restrictions ] +\*[ Paging-Time-Window ] +[ Subscribed-ARPI ] +[ IAB-Operation-Permission ] +\*[ AVP ] + +The AMBR included in this grouped AVP shall include the AMBR associated to the user's subscription (UE-AMBR); Max-Requested-Bandwidth-UL and Max-Requested-Bandwidth-DL within this AVP shall not both be set to "0". + +The APN-OI-Replacement included in this grouped AVP shall include the UE level APN-OI-Replacement associated to the user's subscription. + +When multiple External Identifiers are defined for the same subscription, the External-Identifier in this grouped AVP shall contain a default External Identifier determined by the HSS. + +### 7.3.3 Terminal-Information + +The Terminal-Information AVP is of type Grouped. This AVP shall contain the information about the user's terminal. + +AVP format + +Terminal-Information ::= + +[ IMEI ] +[ 3GPP2-MEID ] +[ Software-Version ] +\*[ AVP ] + +### 7.3.4 IMEI + +The IMEI AVP is of type UTF8String. This AVP shall contain the International Mobile Equipment Identity, as specified in 3GPP TS 23.003 [3]. It should consist of 14 digits, including the 8-digit Type Allocation Code (TAC) and the 6-digit Serial Number (SNR). It may also include a 15th digit. + +### 7.3.5 Software-Version + +The Software-Version AVP is of type UTF8String. This AVP shall contain the 2-digit Software Version Number (SVN) of the International Mobile Equipment Identity, as specified in 3GPP TS 23.003 [3]. + +### 7.3.6 3GPP2-MEID + +This AVP is of type OctetString. This AVP contains the Mobile Equipment Identifier of the user's terminal. For further details on the encoding of the AVP data, refer to the encoding of the Mobile Identity (MEID) octets 3 to 10 in 3GPP2 A.S0022 [28] Annex A. + +### 7.3.7 ULR-Flags + +The ULR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.7/1: + +**Table 7.3.7/1: ULR-Flags** + +| Bit | Name | Description | +|-----------------------------------------------------------------------------------------------------------------------|----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Single-Registration-Indication | This bit, when set, indicates that the HSS shall send Cancel Location to the SGSN. An SGSN shall not set this bit when sending ULR. | +| 1 | S6a/S6d-Indicator | This bit, when set, indicates that the ULR message is sent on the S6a interface, i.e. the source node is an MME (or a combined MME/SGSN to which the UE is attached via E-UTRAN).
This bit, when cleared, indicates that the ULR message is sent on the S6d interface, i.e. the source node is an SGSN (or a combined MME/SGSN to which the UE is attached via UTRAN or GERAN). | +| 2 | Skip Subscriber Data | This bit, when set, indicates that the HSS may skip subscription data in ULA. If the subscription data has changed in the HSS after the last successful update of the MME/SGSN, the HSS shall ignore this bit and send the updated subscription data. If the HSS effectively skips the sending of subscription data, the GPRS-Subscription-Data-Indicator flag can be ignored. | +| 3 | GPRS-Subscription-Data-Indicator | This bit, when set, indicates that the HSS shall include in the ULA command the GPRS subscription data, if available in the HSS; it shall be included in the GPRS-Subscription-Data AVP inside the Subscription-Data AVP (see 7.3.2).
Otherwise, the HSS shall not include the GPRS-Subscription-Data AVP in the response, unless the Update Location Request is received over the S6d interface and there is no APN configuration profile stored for the subscriber, or when the subscription data is returned by a Pre-Rel-8 HSS (via an IWF).
A standalone MME shall not set this bit when sending a ULR. | +| 4 | Node-Type-Indicator | This bit, when set, indicates that the requesting node is a combined MME/SGSN.
This bit, when cleared, indicates that the requesting node is a single MME or SGSN; in this case, if the S6a/S6d-Indicator is set, the HSS may skip the check of those supported features only applicable to the SGSN, and if, in addition the MME does not request to be registered for SMS, the HSS may consequently skip the download of the SMS related subscription data to a standalone MME. NOTE2 | +| 5 | Initial-Attach-Indicator | This bit, when set, indicates that the HSS shall send Cancel Location to the MME or SGSN if there is the MME or SGSN registration. | +| 6 | PS-LCS-Not-Supported-By-UE | This bit, when set, indicates to the HSS that the UE does not support neither UE Based nor UE Assisted positioning methods for Packet Switched Location Services. The MME shall set this bit on the basis of the UE capability information. The SGSN shall set this bit on the basis of the UE capability information and the access technology supported by the SGSN. | +| 7 | SMS-Only-Indication | This bit, when set, indicates that the UE indicated "SMS only" when requesting a combined IMSI attach or combined RA/LU. | +| 8 | Dual-Registration-5G-Indicator | This bit, when set by an MME over S6a interface, indicates that the HSS+UDM shall not send Nudm_UECM_DeregistrationNotification to the registered AMF (if any); when not set by an MME over S6a interface, it indicates that the HSS+UDM shall send Nudm_UECM_DeregistrationNotification to the registered AMF (if any). See 3GPP TS 29.503 [66].

An SGSN shall not set this bit when sending ULR over S6d interface. | +| 9 | Inter-PLMN-inter-MME handover | This bit, when set by an MME over S6a interface, indicates that an inter PLMN inter MME (or AMF to MME) handover is ongoing. | +| 10 | Intra-PLMN-inter-MME handover | This bit, when set by an MME over S6a interface, indicates that an intra PLMN inter MME (or AMF to MME) handover is ongoing. | +| NOTE1: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving HSS. | | | +| NOTE2: If the MME is registered for SMS then the HSS will download the SMS related data also for the standalone MME. | | | + +## 7.3.8 ULA-Flags + +The ULA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.8/1: + +**Table 7.3.8/1: ULA-Flags** + +| Bit | Name | Description | +|-------|----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Separation Indication | This bit, when set, indicates that the HSS stores SGSN number and MME number in separate memory. A Rel-8 HSS shall set the bit. An IWF interworking with a pre Rel-8 HSS/HLR shall clear the bit. | +| 1 | MME Registered for SMS | This bit, when set, indicates that the HSS has registered the MME for SMS. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | + +## 7.3.9 Visited-PLMN-Id + +The Visited-PLMN-Id AVP is of type OctetString. This AVP shall contain the concatenation of MCC and MNC. See 3GPP TS 23.003 [3]. The content of this AVP shall be encoded as an octet string according to table 7.3.9-1. + +See 3GPP TS 24.008 [31], clause 10.5.1.13, PLMN list, for the coding of MCC and MNC. If MNC is 2 digits long, bits 5 to 8 of octet 2 are coded as "1111". + +**Table 7.3.9/1: Encoding format for Visited-PLMN-Id AVP** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---|---|---|---|---|---|---|---|--| +| | | | | | | | | | +| | | | | | | | | | +| | | | | | | | | | + +## 7.3.10 Feature-List AVP + +### 7.3.10.1 Feature-List AVP for the S6a/S6d application + +The syntax of this AVP is defined in 3GPP TS 29.229 [9]. + +For the S6a/S6d application, the meaning of the bits shall be as defined in table 7.3.10/1 for the Feature-List-ID 1 and in table 7.3.10/2 for the Feature-List-ID 2. + +**Table 7.3.10/1: Features of Feature-List-ID 1 used in S6a/S6d** + +| Feature bit | Feature | M/O | Description | +|-------------|--------------------------------------------|-----|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | ODB-all-APN | O | Operator Determined Barring of all Packet Oriented Services

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update by sending DIAMETER_ERROR_ROAMING_NOT_ALLOWED and, optionally, including the type of ODB in the Error-Diagnostic AVP. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 1 | ODB-HPLMN-APN | O | Operator Determined Barring of Packet Oriented Services from access points that are within the HPLMN whilst the subscriber is roaming in a VPLMN

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update by sending DIAMETER_ERROR_ROAMING_NOT_ALLOWED and, optionally, including the type of ODB in the Error-Diagnostic AVP. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 2 | ODB-VPLMN-APN | O | Operator Determined Barring of Packet Oriented Services from access points that are within the roamed to VPLMN

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update by sending DIAMETER_ERROR_ROAMING_NOT_ALLOWED and, optionally, including the type of ODB in the Error-Diagnostic AVP. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 3 | ODB-all-OG | O | Operator Determined Barring of all outgoing calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 4 | ODB-all-InternationalOG | O | Operator Determined Barring of all outgoing international calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 5 | ODB-all-InternationalOGNot ToHPLMN-Country | O | Operator Determined Barring of all outgoing international calls except those directed to the home PLMN country

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update. If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | + +| | | | | +|----|-------------------------------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 6 | ODB-all-Interzonal OG | O | Operator Determined Barring of all outgoing inter-zonal calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update.
If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 7 | ODB-all-Interzonal OGNotTo HPLMN-Country | O | Operator Determined Barring of all outgoing inter-zonal calls except those directed to the home PLMN country

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update.
If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 8 | ODB-all-Interzonal OGAndInternational OGNotTo HPLMN-Country | O | Operator Determined Barring of all outgoing international calls except those directed to the home PLMN country and Barring of all outgoing inter-zonal calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send this ODB barring category to the MME or SGSN within ULA. Instead the HSS may reject location update.
If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent this ODB category within IDR, the HSS may apply barring of roaming and send CLR. | +| 9 | RegSub | O | Regional Subscription

This feature is applicable for the ULR/ULA, IDR/IDA and DSR/DSA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send Regional Subscription Zone Codes to the MME or SGSN within ULA. Instead the HSS may reject location update.
If the MME or SGSN does not indicate support of this feature in IDA and the HSS has sent Regional Subscription Zone Codes within IDR, the HSS may apply barring of roaming and send CLR. | +| 10 | Trace | O | Trace Function

This feature is applicable for the ULR/ULA, IDR/IDA and DSR/DSA command pairs.
If the MME or SGSN does not indicate support of this feature in ULR, the HSS shall not send Trace Data to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent Trace Data within IDR, the HSS may store this indication, and not send any further Trace Data to that MME or SGSN.

If the MME or SGSN does not indicate support of this feature in DSA, and the HSS has sent Trace Data within DSR, the HSS may store this indication, and not send any further Trace Data to that MME or SGSN | +| 11 | LCS-all-PrivExcep (NOTE 1) | O | All LCS Privacy Exception Classes

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN. | + +| | | | | +|----|--------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 12 | LCS-Universal
(NOTE 1) | O |

Allow location by any LCS client

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 13 | LCS-CallSessionRelated
(NOTE 1) | O |

Allow location by any value added LCS client to which a call/session is established from the target UE

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 14 | LCS-CallSessionUnrelated
(NOTE 1) | O |

Allow location by designated external value added LCS clients

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 15 | LCS-PLMNOperator
(NOTE 1) | O |

Allow location by designated PLMN operator LCS clients

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 16 | LCS-ServiceType
(NOTE 1) | O |

Allow location by LCS clients of a designated LCS service type

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports MAP based Lg interface.
If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 17 | LCS-all-MOLR-SS
(NOTE 1) | O |

All Mobile Originating Location Request Classes

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. Over S6d interface, this feature is applicable when the SGSN supports MAP based Lg interface.
If the MME or SGSN does not support this feature, the HSS shall not send the related LCS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that MME or SGSN.

| + +| | | | | +|----|-------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 18 | LCS-BasicSelf Location (NOTE 1) | O |

Allow an MS to request its own location

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. Over S6d interface, this feature is applicable when the SGSN supports MAP based Lg interface. If the MME or SGSN does not support this feature, the HSS shall not send the related LCS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that MME or SGSN.

| +| 19 | LCS-AutonomousSelfLocation (NOTE 1) | O |

Allow an MS to perform self location without interaction with the PLMN

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. Over S6d interface, this feature is applicable when the SGSN supports MAP based Lg interface. If the MME or SGSN does not support this feature, the HSS shall not send the related LCS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that MME or SGSN.

| +| 20 | LCS-TransferToThirdParty | O |

Allow an MS to request transfer of its location to another LCS client

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. Over S6d interface, this feature is applicable when the SGSN supports MAP based Lg interface. If the MME or SGSN does not support this feature, the HSS shall not send the related LCS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that MME or SGSN.

| +| 21 | SM-MO-PP (NOTE 1) | O |

Short Message MO-PP

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| +| 22 | Barring-Outgoing Calls | O |

Barring of Outgoing Calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| +| 23 | BAOC | O |

Barring of all outgoing calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs. If the MME or SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| + +| | | | | +|----|--------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 24 | BOIC | O |

Barring of outgoing international calls

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| +| 25 | BOICExHC | O |

Barring of outgoing international calls except those directed to the home PLMN Country

This feature is applicable for the ULR/ULA and IDR/IDA command pairs.
If the MME or SGSN does not support this feature, the HSS shall not send the related SMS information to the MME or SGSN within ULA.

If the MME or SGSN does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME or SGSN.

| +| 26 | UE-Reachability-Notification | O |

UE Reachability Notification

This feature is applicable for the ULR/ULA and IDR/IDA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support the UE-Reachability-Notifications, the HSS shall not set the "UE-Reachability-Request" bit in IDR-Flags in subsequent IDR commands towards that MME or SGSN.

| +| 27 | T-ADS Data Retrieval | O |

Terminating Access Domain Selection Data Retrieval

This feature is applicable for the ULR/ULA and IDR/IDA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support the retrieval of T-ADS data via IDR/IDA commands, the HSS shall not set the "T-ADS Data Request" bit in IDR-Flags in subsequent IDR commands towards that MME or SGSN.

| +| 28 | State/Location-Information-Retrieval | O |

State/Location Information Retrieval

This feature is applicable for the ULR/ULA and IDR/IDA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support State/Location Information Retrieval, the HSS shall not set the "EPS User State Request", "EPS Location Information Request" or "Current Location Request" bits in IDR-Flags in subsequent IDR commands towards that MME or SGSN.

| +| 29 | Partial Purge | O |

Partial Purge from a Combined MME/SGSN

This feature is applicable for the ULR/ULA and PUR/PUA command pairs, over S6a and S6d.

If the HSS indicates in the ULA command that it does not support Partial Purge, the combined MME/SGSN shall not include in the PUR command the indication of the specific serving node where the Purge has been done.

| +| 30 | Local Time Zone Retrieval | O |

UE Time Zone Retrieval

This feature is applicable for the ULR/ULA and IDR/IDA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support the retrieval of Local Time Zone via IDR/IDA commands, the HSS shall not set the "Local Time Zone Request" bit in IDR-Flags in subsequent IDR commands towards that MME or SGSN.

| + +| | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 31 | Additional MSISDN | O |

Additional MSISDN

This feature is applicable for the ULR/ULA, IDR/IDA and DSR/DSA command pairs, over S6a and S6d.

If the MME or SGSN indicates in the ULR command that it does not support A-MSISDN, the HSS shall populate the MSISDN AVP either with the subscribed MSISDN or the subscribed additional MSISDN based on operator policy and availability and the HSS shall not send IDR with the A-MSISDN AVP or DSR with the "A-MSISDN Withdrawal" bit to the serving nodes when the subscription data is changed.

If the MME or SGSN indicates in the IDA command that it does not support this feature and the HSS has already sent an A-MSISDN value within IDR, the HSS may store this indication and not send any further A-MSISDN updates to that MME or SGSN.

| +| Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1".
Feature: A short name that can be used to refer to the bit and to the feature, e.g. "ODB-HPLMN-APN".
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: If both bits, corresponding to the feature defined for Lg interface and Lgd interface respectively, are not set, and the HSS supports the feature, the HSS shall not send the related LCS information to the SGSN within ULA and IDR. | | | | + +**Table 7.3.10/2: Features of Feature-List-ID 2 used in S6a/S6d** + +| Feature bit | Feature | M/O | Description | +|-------------|---------------------------------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | SMS in MME | O |

SMS in MME

This feature is applicable for the ULR/ULA, IDR/IDA, DSR/DSA, NOR/NOA command pairs, over S6a.

It is used by the MME to notify the HSS it is capable of SMS transfer without the need of establishing an SGs association with an MSC.

If the MME does not support this feature, the HSS shall not send the related SMS information to the MME within ULA.

If the MME does not indicate support of this feature in IDA, and the HSS has sent the related SMS information within IDR, the HSS may store this indication, and not send any further SMS information to that MME.

If the HSS does not support this feature, the HSS shall ignore any request for a registration for SMS; the MME may store this feature indication, and not send any further request for a registration for SMS to the HSS.

| +| 1 | SMS in SGSN | O |

SMS in SGSN

This feature is applicable for the ULR/ULA command pair, over S6d.

If the SGSN indicates in the ULR command that it does not support this feature, the HSS shall not indicate "SMS in SGSN Allowed" to the SGSN.

| +| 2 | Dia-LCS-all-PrivExcep (NOTE 1) | O |

All LCS Privacy Exception Classes

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 3 | Dia-LCS-Universal (NOTE 1) | O |

Allow location by any LCS client

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 4 | Dia-LCS-CallSessionRelated (NOTE 1) | O |

Allow location by any value added LCS client to which a call/session is established from the target UE

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 5 | Dia-LCS-CallSessionUnrelated (NOTE 1) | O |

Allow location by designated external value added LCS clients

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| + +| | | | | +|----|--------------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 6 | Dia-LCS-PLMNOperator
(NOTE 1) | O |

Allow location by designated PLMN operator LCS clients

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 7 | Dia-LCS-ServiceType
(NOTE 1) | O |

Allow location by LCS clients of a designated LCS service type

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 8 | Dia-LCS-all-MOLR-SS
(NOTE 1) | O |

All Mobile Originating Location Request Classes

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 9 | Dia-LCS-BasicSelfLocation
(NOTE 1) | O |

Allow an MS to request its own location

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 10 | Dia-LCS-AutonomousSelfLocation
(NOTE 1) | O |

Allow an MS to perform self location without interaction with the PLMN

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 11 | Dia-LCS-TransferToThirdParty
(NOTE 1) | O |

Allow an MS to request transfer of its location to another LCS client

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over the S6d interface, when the SGSN supports Diameter based Lgd interface. If the SGSN does not support this feature, the HSS shall not send the related LCS information to the SGSN within ULA.

If the SGSN does not indicate support of this feature in IDA, and the HSS has sent the related LCS information within IDR, the HSS may store this indication, and not send any further LCS information to that SGSN.

| +| 12 | Gdd-in-SGSN | O |

Support of Diameter based Gdd interface for SMS in SGSN

This feature is applicable for the ULR/ULA command pair over S6d, when the SGSN supports the Diameter based Gdd interface for SMS in SGSN.

| + +| | | | | +|----|----------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 13 | Optimized-LCS-Proc-Support | O |

Support for the optimized LCS procedure

This feature is applicable for the ULR/ULA command pair over S6a/S6d, when the network supports ISR and when the node is combined MME/SGSN and supports optimized LCS procedure as described in 3GPP TS 29.172 [47] clause 6.2.2.

| +| 14 | SGSN CAMEL Capability | O |

Support of SGSN CAMEL Capability

This feature is applicable for the ULR/ULA command pair over S6d, when the SGSN supports the CAMEL capability.

| +| 15 | ProSe Capability | O |

Support of ProSe Capability

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over S6a (and S6d), when the MME (or combined MME/SGSN) supports the ProSe capability.
If the MME or combined MME/SGSN does not support this feature, the HSS shall not send the related ProSe subscription data to the MME or combined MME/SGSN within ULA.

If the MME or combined MME/SGSN does not indicate support of this feature in IDA, and the HSS has sent the related ProSe subscription data within IDR, the HSS may store this indication, and not send any further ProSe subscription data to that MME.

| +| 16 | P-CSCF Restoration | O |

Support of P-CSCF Restoration

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a or S6d interfaces, when the MME or SGSN supports the execution of the P-CSCF restoration procedures.

If the MME or the SGSN does not indicate support of this feature in ULR, the HSS shall not send subsequent IDR commands requesting the execution of HSS-based P-CSCF restoration procedures, as described in 3GPP TS 23.380 [51] clause 5.4.

| +| 17 | Reset-IDs | O |

Support of Reset-IDs

This feature is applicable to the ULR/ULA and IDR/IDA and DSR/DSA and RSR/RSA command pairs over the S6a and S6d interfaces.

If the MME or SGSN indicates in the ULR command that it does not support Reset-IDs, the HSS shall not include Reset-ID AVPs in RSR commands sent to that MME or SGSN.

If the MME or SGSN indicates that it does not support this feature in IDA, and the HSS has already sent a Reset-ID value within IDR, the HSS may store this indication and not send any further Reset-ID updates to that MME or SGSN.

| +| 18 | Communication-Pattern | O |

Support of AESE communication patterns

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over S6a (and S6d), when the MME (or combined MME/SGSN) supports the AESE communication patterns.

If the MME or combined MME/SGSN does not indicate the support for this feature, the HSS shall not send CP parameter sets to the MME or combined MME/SGSN within IDR/ULA command.

If the MME or combined MME/SGSN indicates that it does not support this feature in IDA, and the HSS has already sent CP parameter sets within IDR, the HSS may store this indication and not send any further updates related to CP parameter sets to that MME or combined MME/SGSN.

| + +| | | | | +|----|-------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 19 | Monitoring-Event | O |

Support of Monitoring Event

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a or S6d interfaces, when the MME or SGSN supports the Monitoring event feature.

If the MME or SGSN does not indicate support of this feature in ULR, the HSS shall not send Monitoring event configuration data to the MME or SGSN within ULA and shall not send subsequent IDR commands requesting the configuration of Monitoring events in the MME or SGSN.

If the MME or SGSN indicates that it does not support this feature in IDA, and the HSS has already sent Monitoring event configuration data within IDR, the HSS may store this indication and not send any further updates related to Monitoring events to that MME or SGSN.

| +| 20 | Dedicated Core Networks | O |

Support of Dedicated Core Networks

This feature is applicable to the ULR/ULA, IDR/IDA and DSR/DSA command pairs over the S6a and S6d interfaces.

If the MME/SGSN does not indicate support of this feature in the ULR command, the HSS shall not send DCN-related subscription data (e.g., UE Usage Type) in ULA, and shall not send subsequent IDR or DSR commands when such subscription data are updated.

If the MME/SGSN does not indicate support of this feature in the IDA command and the HSS has already sent DCN-related subscription data in IDR, the HSS may store this indication and not send further updates related to DCN subscription data.

| +| 21 | Non-IP PDN Type APNs | O |

Support of Non-IP PDN Type APNs

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a and S6d interfaces.

If the MME/SGSN does not indicate support of this feature in the ULR command, the HSS shall not send APN configurations with a Non-IP PDN type in the subscription data sent in ULA or in IDR, and shall not send IDR commands with the only purpose to update such subscription data.

If the MME or SGSN indicates in the IDA command that it does not support this feature, and the HSS has already sent Non-IP PDN Type APNs within IDR, the HSS may store this indication, and not send any further updates related to Non-IP PDN Type APNs to that MME or SGSN.

| +| 22 | Non-IP PDP Type APNs | O |

Support of Non-IP PDP Type APNs

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a/S6d interface.

If the MME/SGSN does not indicate support of this feature in the ULR command, the HSS shall not send PDP contexts (as part of the GPRS-Subscription-Data) with a Non-IP PDP type in the subscription data sent in ULA or in IDR, and shall not send IDR commands with the only purpose to update such subscription data.

If the MME or SGSN indicates in the IDA command that it does not support this feature, and the HSS has already sent Non-IP PDP Type APNs within IDR, the HSS may store this indication, and not send any further updates related to Non-IP PDP Type APNs to that MME or SGSN.

| +| 23 | Removal of MSISDN | O |

Support of Removal of MSISDN

This feature is applicable to the ULR/ULA and DSR/DSA command pairs over the S6a/S6d interface.

If the MME/SGSN does not indicate support of this feature in the ULR command, the HSS shall not send DSR with the "MSISDN Withdrawal" bit set, to remove an existing MSISDN value from the subscription profile stored in the MME/SGSN.

| + +| | | | | +|----|------------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 24 | Emergency Service Continuity | O |

Support of Emergency Services Continuity

This feature is applicable to the ULR/ULA, NOR/NOA and IDR/IDA command pairs over the S6a interface, when the HSS and the MME support the continuity of emergency services upon mobility between 3GPP and WLAN accesses, as specified in 3GPP TS 23.401 [2], or continuity of emergency services upon mobility between EPS and 5GS without N26 interface, as specified in 3GPP TS 23.502 [67].

If the MME does not indicate support of this feature in a former ULR command, the HSS shall not include the Emergency Info in an ULA command and shall not send an IDR command to update the PGW in use for emergency services.

If the HSS does not indicate support of this feature in a former ULA command, the MME shall not send a NOR command to update the PGW in use for emergency services.

If the HSS supports this feature on S6a, it shall also support the Emergency Service Continuity feature on SWx, see 3GPP TS 29.273 [59].

| +| 25 | V2X Capability | O |

Support of V2X Service

This feature is applicable for the ULR/ULA and IDR/IDA command pairs over S6a (and S6d), when the MME (or combined MME/SGSN) supports the V2X service.

If the MME or combined MME/SGSN does not support this feature, the HSS shall not send the related V2X subscription data to the MME or combined MME/SGSN within ULA.

If the MME or combined MME/SGSN does not indicate support of this feature in IDA, and the HSS has sent the related V2X subscription data within IDR, the HSS may store this indication, and not send any further V2X subscription data to that MME or that combined MME/SGSN.

| +| 26 | External-Identifier | O |

Support of External-Identifier

This feature is applicable for the ULR/ULA, DSR/DSA and IDR/IDA command pairs over S6a (and S6d), when the MME (or combined MME/SGSN) supports the External-Identifier.

If the MME or combined MME/SGSN does not support this feature:

  • -The HSS shall not send the External-Identifier subscription data to the MME or combined MME/SGSN within ULA.
  • -The HSS shall not send Monitoring Event configuration for UEs that are part of a group and have no MSISDN as part of its subscription data to the MME/SGSN.
  • -The HSS shall not indicate External-Identifier-Withdrawal in the DSR-Flags AVP of the DSR.
| +| 27 | NR as Secondary RAT | O |

Support of NR as Secondary RAT

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over S6a (and S6d) when the MME (or combined MME/SGSN) supports NR as Secondary RAT, and over S6d when the SGSN supports the indication related to NR as Secondary RAT (such as, e.g., the related Access Restriction Data, or extended QoS parameters).

If the MME, SGSN, or combined MME/SGSN does not support this feature, the HSS shall not send (in ULA) or update (in IDR) subscription data related to NR as Secondary RAT.

If the HSS does not support this feature, the MME shall ignore the bit "NR as Secondary RAT Not Allowed" in Access-Restriction-Data.

| + +| | | | | +|----|--------------------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 28 | Unlicensed Spectrum as Secondary RAT | O |

Support of Unlicensed Spectrum as Secondary RAT

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over S6a (and S6d) when the MME (or combined MME/SGSN) supports the use of unlicensed spectrum in the form of LAA or LWA/LWIP as Secondary RAT.

If the MME (or combined MME/SGSN) does not support this feature, the HSS shall not send (in ULA) or update (in IDR) subscription data related to the use of unlicensed spectrum in the form of LAA, LWA/LWIP or NR in unlicensed bands as Secondary RAT (such as, e.g., the related Access Restriction Data).

If the HSS does not support this feature, the MME shall ignore the bit "Unlicensed Spectrum as Secondary RAT Not Allowed" in Access-Restriction-Data.

| +| 29 | Ethernet PDN Type APNs | O |

Support of Ethernet PDN Type APNs

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a and S6d interfaces.

If the MME (or combined MME/SGSN) does not indicate support of this feature in the ULR command, the HSS shall not send APN configurations with an Ethernet PDN type in the subscription data sent in ULA or in IDR, and shall not send IDR commands with the only purpose to update such subscription data.

If the MME (or combined MME/SGSN) indicates in the IDA command that it does not support this feature, and the HSS has already sent Ethernet PDN Type APNs within IDR, the HSS may store this indication, and not send any further updates related to Ethernet PDN Type APNs to that MME (or combined MME/SGSN).

| +| 30 | Extended Reference IDs | O |

Extended Reference IDs

This feature is applicable to the ULR/ULA and IDR/IDA command pairs over the S6a or S6d interfaces, when the HSS and MME/SGSN support handling 64-bit long Reference IDs.

If the MME or SGSN does not indicate support of this feature in ULR, the HSS shall not send ULA or IDR commands containing 64-bit long SCEF Reference IDs or SCEF Reference IDs for Deletion.

| + +Feature bit: The order number of the bit within the Supported-Features AVP, e.g. "1". +Feature: A short name that can be used to refer to the bit and to the feature, e.g. "SMS in MME". +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: If both bits, corresponding to the same feature defined for Lg interface and Lgd interface, are not set, and the HSS supports the feature, the HSS shall not send the related LCS information to the SGSN within ULA and IDR. + +Features that are not indicated in the Supported-Features AVPs within a given application message shall not be used to construct that message. + +### 7.3.10.2 Feature-List AVP for the S7a/S7d application + +For the S7a/S7d application, the feature list does not contain any feature in this release. + +## 7.3.11 Requested-EUTRAN-Authentication-Info + +The Requested-EUTRAN-Authentication-Info is of type Grouped. It shall contain the information related to the authentication requests for E-UTRAN. + +AVP format + +Requested-EUTRAN-Authentication-Info ::= + +[ Number-Of-Requested-Vectors ] + +[ Immediate-Response-Preferred ] + +[ Re-synchronization-Info ] +\*[AVP] + +### 7.3.12 Requested-UTRAN- GERAN-Authentication-Info + +The Requested-UTRAN-GERAN-Authentication-Info is of type Grouped. It shall contain the information related to the authentication requests for UTRAN or GERAN. + +AVP format + +Requested-UTRAN-GERAN-Authentication-Info ::= +[ Number-Of-Requested-Vectors ] +[ Immediate-Response-Preferred ] +[ Re-synchronization-Info ] +\*[AVP] + +### 7.3.13 RAT-Type + +The RAT-Type AVP is of type Enumerated and is used to identify the radio access technology that is serving the UE. See 3GPP TS 29.212 [10] for the defined values. + +3GPP TS 29.212 [10] defines distinct RAT-Type values for EUTRAN (WB-EUTRAN), EUTRAN-NB-IoT, LTE-M, WB-EUTRAN over satellite access, EUTRAN-NB-IoT over satellite access, LTE-M over satellite access; these values shall be used in the signaling between the serving nodes (MME/SGSN) and the HSS, e.g. to determine the corresponding access restrictions for the UE. + +### 7.3.14 Number-Of-Requested-Vectors + +The Number-Of-Requested-Vectors AVP is of type Unsigned32. This AVP shall contain the number of AVs the MME or SGSN is prepared to receive. + +### 7.3.15 Re-Synchronization-Info + +The Re-Synchronization-Info AVP is of type OctetString. It shall contain the concatenation of RAND and AUTS. + +### 7.3.16 Immediate-Response-Preferred + +The Immediate-Response-Preferred AVP is of type Unsigned32. This optional AVP indicates by its presence that immediate response is preferred, and by its absence that immediate response is not preferred. If present, the value of this AVP is not significant. + +When EUTRAN-AVs and UTRAN-AVs or GERAN-AVs are requested, presence of this AVP within the Requested-EUTRAN-Authentication-Info AVP shall indicate that EUTRAN-AVs are requested for immediate use in the MME/SGSN; presence of this AVP within the Requested-UTRAN-GERAN-Authentication-Info AVP shall indicate that UTRAN-AVs or GERAN-AVs are requested for immediate use in the MME/SGSN. It may be used by the HSS to determine the number of vectors to be obtained from the AuC and the number of vectors downloaded to the MME or SGSN. + +### 7.3.17 Authentication-Info + +The Authentication-Info AVP is of type Grouped. This AVP contains Authentication Vectors. + +AVP format: + +Authentication-Info ::= + +\*[ E-UTRAN-Vector ] +\*[UTRAN-Vector] +\*[GERAN-Vector] +\*[AVP] + +### 7.3.18 E-UTRAN-Vector + +The E-UTRAN-Vector AVP is of type Grouped. This AVP shall contain an E-UTRAN Vector. + +AVP format: + +E-UTRAN-Vector ::= +[ Item-Number ] +{ RAND } +{ XRES } +{ AUTN } +{ KASME } +\*[AVP] + +### 7.3.19 UTRAN-Vector + +The UTRAN-Vector AVP is of type Grouped. This AVP shall contain an UTRAN Vector. + +AVP format: + +UTRAN-Vector ::= +[ Item-Number ] +{ RAND } +{ XRES } +{ AUTN } +{ Confidentiality-Key } +{ Integrity-Key } +\*[AVP] + +### 7.3.20 GERAN-Vector + +The GERAN-Vector AVP is of type Grouped. This AVP shall contain a GERAN Vector. + +AVP format: + +GERAN-Vector ::= +[ Item-Number ] +{ RAND } +{ SRES } +{ Kc } + +\*[AVP] + +### 7.3.21 Network-Access-Mode + +The Network-Access-Mode AVP is of type Enumerated. The following values are defined: + +PACKET\_AND\_CIRCUIT (0) + +Reserved (1) + +ONLY\_PACKET (2) + +### 7.3.22 HPLMN-ODB + +The HPLMN-ODB AVP is of type Unsigned32 and it shall contain a bit mask indicating the HPLMN specific services of a subscriber that are barred by the operator. The meaning of the bits is HPLMN specific: + +**Table 7.3.22/1: HPLMN-ODB** + +| Bit | Description | +|-----|-------------------------------| +| 0 | HPLMN specific barring type 1 | +| 1 | HPLMN specific barring type 2 | +| 2 | HPLMN specific barring type 3 | +| 3 | HPLMN specific barring type 4 | + +HPLMN-ODB may apply to mobile originated short messages; See 3GPP TS 23.015 [36]. + +### 7.3.23 Item-Number + +The Item-Number AVP is of type Unsigned32. The Item Number is used to order Vectors received within one request. + +### 7.3.24 Cancellation-Type + +The Cancellation-Type AVP is of type Enumerated and indicates the type of cancellation. The following values are defined: + +MME\_UPDATE\_PROCEDURE (0) + +This value is used when the Cancel Location is sent to the previous MME due to a received Update Location message from a new MME or due to the HSS+UDM receiving an Nudm\_UEContextManagement service request from the AMF or due to the HSS receiving Nhss\_UECM\_SNDeregistration service operation from UDM (see clause 5.4.2.2 of 3GPP TS 29.563 [70]). + +SGSN\_UPDATE\_PROCEDURE (1) + +This value is used when the Cancel Location is sent to the previous SGSN due to a received Update Location message from a new SGSN or due to the HSS+UDM receiving an Nudm\_UEContextManagement service request from the AMF or due to the HSS receiving Nhss\_UECM\_SNDeregistration service operation from UDM (see clause 5.4.2.2 of 3GPP TS 29.563 [70]). + +SUBSCRIPTION\_WITHDRAWAL (2) + +This value is used: + +- when the Cancel Location is sent by the HSS to the current MME or SGSN due to withdrawal of the user's subscription by the HSS operator; +- when the Cancel VCSG Location is sent by the CSS to the current MME or SGSN due to withdrawal of the user's VPLMN CSG subscription by the CSS operator. + +UPDATE\_PROCEDURE\_IWF (3) + +This value is used by an IWF when interworking with a pre-Rel-8 HSS. + +INITIAL\_ATTACH\_PROCEDURE (4) + +This value is used when the Cancel Location is sent to the MME or SGSN due to a received Update Location message during initial attach procedure from an SGSN or MME respectively. + +## 7.3.25 DSR-Flags + +The DSR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits is defined in table 7.3.25/1: + +**Table 7.3.25/1: DSR-Flags** + +| Bit | Name | Description | +|-----|------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Regional Subscription Withdrawal | This bit, when set, indicates that Regional Subscription shall be deleted from the subscriber data. | +| 1 | Complete APN Configuration Profile Withdrawal | This bit, when set, indicates that all EPS APN configuration data for the subscriber shall be deleted from the subscriber data. This flag only applies to the S6d interface. | +| 2 | Subscribed Charging Characteristics Withdrawal | This bit, when set, indicates that the Subscribed Charging Characteristics have been deleted from the subscription data. | +| 3 | PDN subscription contexts Withdrawal | This bit, when set, indicates that the PDN subscription contexts whose identifier is included in the Context-Identifier AVP shall be deleted.
(Note 1) | +| 4 | STN-SR | This bit, when set, indicates that the Session Transfer Number for SRVCC shall be deleted from the subscriber data. | +| 5 | Complete PDP context list Withdrawal | This bit, when set, indicates that all PDP contexts for the subscriber shall be deleted from the subscriber data. | +| 6 | PDP contexts Withdrawal | This bit, when set, indicates that the PDP contexts whose identifier is included in the Context-Identifier AVP shall be deleted.
(Note 2) | +| 7 | Roaming Restricted due to unsupported feature | This bit, when set, indicates that the roaming restriction shall be deleted from the subscriber data in the MME or SGSN. | +| 8 | Trace Data Withdrawal | This bit, when set, indicates that the Trace Data shall be deleted from the subscriber data. | +| 9 | CSG Deleted | This bit, when set, indicates that
  • the "CSG-Subscription-Data from HSS" shall be deleted in the MME or SGSN when received over the S6a or S6d interface
  • the "CSG-Subscription-Data from CSS" shall be deleted in the MME or SGSN when received over the S7a or S7d interface.
| +| 10 | APN-OI-Replacement | This bit, when set, indicates that the UE level APN-OI-Replacement shall be deleted from the subscriber data. | +| 11 | GMLC List Withdrawal | This bit, when set, indicates that the subscriber's LCS GMLC List shall be deleted from the MME or SGSN. | +| 12 | LCS Withdrawal | This bit, when set, indicates that the LCS service whose code is included in the SS-Code AVP shall be deleted from the MME or SGSN. | +| 13 | SMS Withdrawal | This bit, when set, indicates that the SMS service whose code is included in the SS-Code AVP or TS-Code AVP shall be deleted from the MME or SGSN. | +| 14 | Subscribed periodic RAU-TAU Timer Withdrawal | This bit, when set, indicates that the subscribed periodic RAU TAU Timer value shall be deleted from the subscriber data. | +| 15 | Subscribed VSRVCC Withdrawal | This bit, when set, indicates that the Subscribed VSRVCC shall be deleted from the subscriber data. | +| 16 | A-MSISDN Withdrawal | This bit, when set, indicates that the additional MSISDN, if present, shall be deleted from the subscriber data. | +| 17 | ProSe Withdrawal | This bit, when set, indicates that the ProSe subscription data shall be deleted from the MME or combined MME/SGSN. | +| 18 | Reset-IDs | This bit, when set, indicates that the set of Reset-IDs shall be deleted from the MME or SGSN. | +| 19 | DL-Buffering-Suggested-Packet-Count Withdrawal | This bit, when set, indicates that the DL-Buffering-Suggested-Packet-Count shall be deleted in the MME or SGSN. | +| 20 | Subscribed IMSI-Group-Id Withdrawal | This bit, when set, indicates that all subscribed IMSI-Group-Id(s) shall be deleted in the MME or SGSN. | +| 21 | Delete monitoring events | This bit when set indicates to the MME or SGSN to delete all the Monitoring events for the subscriber which are associated with the provided SCEF-ID. | +| 22 | User Plane Integrity Protection | This bit, when set, indicates to the SGSN that User Plane Integrity Protection may no longer be required when GERAN is | + +| | | | +|---------|-----------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Withdrawal | used. The MME shall ignore it. | +| 23 | MSISDN Withdrawal | This bit, when set, indicates that the MSISDN shall be deleted from the subscriber data.
It is also used by the MME/SGSN to delete those monitoring events created using the MSISDN. | +| 24 | UE Usage Type Withdrawal | This bit, when set, indicates to the MME or SGSN that the UE Usage Type shall be deleted from the subscription data. | +| 25 | V2X Withdrawal | This bit, when set, indicates that the V2X subscription data shall be deleted from the MME or combined MME/SGSN. | +| 26 | External-Identifier-Withdrawal | This bit, when set, indicates that the External-Identifier shall be deleted from the subscriber data.
It is also used by the MME/SGSN to delete those monitoring events created using the removed External Identifier or all monitoring events created for any External Identifier in case of removing the default External Identifier. | +| 27 | Aerial-UE-Subscription Withdrawal | This bit, when set, indicates that the Aerial UE subscription shall be deleted from the subscriber data. | +| 28 | Paging Time Window Subscription Withdrawal | This bit, when set, indicates that the Paging Time Window subscription shall be deleted from the subscriber data. | +| 29 | Active-Time-Withdrawal | This bit, when set, indicates that the Active Time used for PSM shall be deleted from the subscriber data. | +| 30 | eDRX-Cycle-Length -Withdrawal | This bit, when set, indicates that the eDRX-Cycle-Length shall be deleted from the subscriber data. .
If the eDRX-Related-RAT is present in the DSR command, only the eDRX Cycle Length for indicated RAT types shall be deleted. Otherwise, the entire eDRX Cycle Length subscription for all RAT types shall be deleted. | +| 31 | Service-Gap-Time-Withdrawal | This bit, when set, indicates that the Service Gap Time shall be deleted from the subscriber data. | +| Note 1: | If the Complete APN Configuration Profile Withdrawal bit is set, this bit should not be set. | | +| Note 2: | If the Complete PDP context list Withdrawal bit is set, this bit should not be set. | | +| Note 3: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | +| Note 4: | Bits 3 and 6 are excluding alternatives and shall not both be set. | | +| Note 5: | When this AVP is transferred over the S7a/S7d interface, only the bit 9 (CSG Deleted) is meaningful, other bits shall be cleared. | | + +## 7.3.26 DSA-Flags + +The DSA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits is defined in table 7.3.26/1: + +**Table 7.3.26/1: DSA-Flags** + +| Bit | Name | Description | +|---------------------------------------------------------------------------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| 0 | Network Node area restricted | This bit, when set, shall indicate that the complete Network Node area (SGSN area) is restricted due to regional subscription. | +| Note: Bits not defined in this table shall be cleared by the sending SGSN and discarded by the receiving HSS. | | | + +## 7.3.27 Context-Identifier + +The Context-Identifier AVP is of type Unsigned32. + +### 7.3.28 Void + +### 7.3.29 Subscriber-Status + +The 3GPP Subscriber Status AVP is of type Enumerated. It shall indicate if the service is barred or granted. The following values are defined: + +SERVICE\_GRANTED (0) + +OPERATOR\_DETERMINED\_BARRING (1) + +### 7.3.30 Operator-Determined-Barring + +The Operator-Determined-Barring AVP is of type Unsigned32 and it shall contain a bit mask indicating the services of a subscriber that are barred by the operator. The meaning of the bits is the following: + +**Table 7.3.30/1: Operator-Determined-Barring** + +| Bit | Description | +|-----|------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | All Packet Oriented Services Barred | +| 1 | Roamer Access HPLMN-AP Barred | +| 2 | Roamer Access to VPLMN-AP Barred | +| 3 | Barring of all outgoing calls | +| 4 | Barring of all outgoing international calls | +| 5 | Barring of all outgoing international calls except those directed to the home PLMN country | +| 6 | Barring of all outgoing inter-zonal calls | +| 7 | Barring of all outgoing inter-zonal calls except those directed to the home PLMN country | +| 8 | Barring of all outgoing international calls except those directed to the home PLMN country and Barring of all outgoing inter-zonal calls | + +### 7.3.31 Access-Restriction-Data + +The Access-Restriction-Data AVP is of type Unsigned32 and it shall contain a bit mask where each bit when set to 1 indicates a restriction. The meaning of the bits is the following: + +**Table 7.3.31/1: Access-Restriction-Data** + +| Bit | Description | +|-------------------------------------------------------------------------------------------------------------|--------------------------------------------------| +| 0 | UTRAN Not Allowed | +| 1 | GERAN Not Allowed | +| 2 | GAN Not Allowed | +| 3 | I-HSPA-Evolution Not Allowed | +| 4 | WB-E-UTRAN Not Allowed | +| 5 | HO-To-Non-3GPP-Access Not Allowed | +| 6 | NB-IoT Not Allowed | +| 7 | Enhanced Coverage Not Allowed | +| 8 | NR as Secondary RAT in E-UTRAN Not Allowed | +| 9 | Unlicensed Spectrum as Secondary RAT Not Allowed | +| 10 | NR in 5GS Not Allowed | +| 11 | LTE-M Not Allowed | +| 12 | WB-E-UTRAN Except LTE-M Not Allowed | +| 13 | WB-E-UTRAN(LEO) Not Allowed | +| 14 | WB-E-UTRAN(MEO) Not Allowed | +| 15 | WB-E-UTRAN(GEO) Not Allowed | +| 16 | WB-E-UTRAN(OTHERSAT) Not Allowed | +| 17 | NB-IoT(LEO) Not Allowed | +| 18 | NB-IoT(MEO) Not Allowed | +| 19 | NB-IoT(GEO) Not Allowed | +| 20 | NB-IoT(OTHERSAT) Not Allowed | +| 21 | LTE-M(LEO) Not Allowed | +| 22 | LTE-M(MEO) Not Allowed | +| 23 | LTE-M(GEO) Not Allowed | +| 24 | LTE-M(OTHERSAT) Not Allowed | +| 25 | NR (LEO) Not Allowed | +| 26 | NR (MEO) Not Allowed | +| 27 | NR (GEO) Not Allowed | +| 28 | NR (OTHERSAT) Not Allowed | +| NOTE 1: Bits not defined in this table shall be cleared by the HSS and discarded by the receiving MME/SGSN. | | +| NOTE 2: Bits 11 and 12 are only used when bit 4 is not set. | | + +The restriction "HO-To-Non-3GPP-Access Not Allowed" shall take a higher precedence than the APN-level parameter "WLAN-Offloadability" (see clause 7.3.181). + +### 7.3.32 APN-OI-Replacement + +The APN-OI-Replacement AVP is of type UTF8String. This AVP shall indicate the domain name to replace the APN OI for the non-roaming case and the home routed roaming case when constructing the APN, and the APN-FQDN upon which to perform a DNS resolution. See 3GPP TS 23.003 [3] and 3GPP TS 29.303 [38]. + +The contents of the APN-OI-Replacement AVP shall be formatted as a character string composed of one or more labels separated by dots ("."). + +### 7.3.33 All-APN-Configurations-Included-Indicator + +The All-APN-Configurations-Included-Indicator AVP is of type Enumerated. The following values are defined: + +ALL\_APN\_CONFIGURATIONS\_INCLUDED (0) + +MODIFIED\_ADDED\_APN\_CONFIGURATIONS\_INCLUDED (1) + +### 7.3.34 APN-Configuration-Profile + +The APN-Configuration-Profile AVP is of type Grouped. It shall contain the information related to the user's subscribed APN configurations for EPS. + +The AVP format shall conform to: + +``` +APN-Configuration-Profile ::= + { Context-Identifier } + [ Additional-Context-Identifier ] + [ Third-Context-Identifier ] + { All-APN-Configurations-Included-Indicator } + 1*{APN-Configuration} + *[AVP] +``` + +The Subscription-Data AVP associated with an IMSI contains one APN-Configuration-Profile AVP. + +Each APN-Configuration-Profile AVP contains one or more APN-Configuration AVPs. + +Each APN-Configuration AVP describes the configuration for a single APN. + +Therefore, the cardinality of the relationship between IMSI and APN is one-to-many. + +The Context-Identifier AVP shall identify the per subscriber's default APN configuration. + +If present, the Additional-Context-Identifier AVP shall identify another default APN configuration, only for those subscriptions containing more than one types of APNs i.e. among APNs with an IP-based PDN type, APNs with a Non-IP PDN type, and APNs with an Ethernet PDN type; in this case, each of those two default APN configurations shall have a different PDN type category (e.g. one default APN with an IP-based PDN type, and another default APN with a Non-IP PDN type). + +If present, the Third-Context-Identifier AVP shall identify another default APN configuration, only for those subscriptions containing more than two types of APNs i.e. among APNs with an IP-based PDN type, APNs with a Non-IP PDN type, and APNs with an Ethernet PDN type; in this case, each of those three default APN configurations shall have a different PDN type category (i.e. one default APN with an IP-based PDN type, and another default APN with a Non-IP PDN type and one default APN with an Ethernet PDN type). + +### 7.3.35 APN-Configuration + +The APN-Configuration AVP is of type Grouped. It shall contain the information related to the user's subscribed APN configurations. The Context-Identifier in the APN-Configuration AVP shall identify that APN configuration, and it shall not have a value of zero. Furthermore, the Context-Identifier in the APN-Configuration AVP shall uniquely identify the EPS APN configuration per subscription. For a particular EPS user having multiple APN configurations, the Service-Selection AVP values shall be unique across APN-Configuration AVPs. + +The AVP format shall conform to: + +``` +APN-Configuration ::= + { Context-Identifier } + * 2 [ Served-Party-IP-Address ] + { PDN-Type } + { Service-Selection } + [ EPS-Subscribed-QoS-Profile ] + [ VPLMN-Dynamic-Address-Allowed ] +``` + +[MIP6-Agent-Info ] +[ Visited-Network-Identifier ] +[ PDN-GW-Allocation-Type ] +[ 3GPP-Charging-Characteristics ] +[ AMBR ] +\*[ Specific-APN-Info ] +[ APN-OI-Replacement ] +[ SIPTO-Permission ] +[ LIPA-Permission ] +[ Restoration-Priority ] +[ SIPTO-Local-Network-Permission ] +[ WLAN-offloadability ] +[ Non-IP-PDN-Type-Indicator ] +[ Non-IP-Data-Delivery-Mechanism ] +[ SCEF-ID ] +[ SCEF-Realm ] +[ Preferred-Data-Mode ] +[ PDN-Connection-Continuity ] +[ RDS-Indicator ] +[ Interworking-5GS-Indicator ] +[ Ethernet-PDN-Type-Indicator ] +\*[ AVP ] + +The AMBR included in this grouped AVP shall include the AMBR associated to this specific APN configuration (APN-AMBR). + +The Served-Party-IP-Address AVP may be present 0, 1 or 2 times. These AVPs shall be present if static IP address allocation is used for the UE, and they shall contain either of: + +- an IPv4 address, or +- an IPv6 address/prefix, or +- both, an IPv4 address and an IPv6 address/prefix. + +For the IPv6 prefix, the lower 64 bits of the address shall be set to zero. + +The PDN-GW-Allocation-Type AVP applies to the MIP6-Agent-Info AVP. Therefore, it shall not be present if MIP6-Agent-Info is not present. + +The APN-OI-Replacement included in this grouped AVP shall include the APN-OI-Replacement associated with this APN configuration. This APN-OI-Replacement has higher priority than UE level APN-OI-Replacement. + +The Visited-Network-Identifier AVP indicates the PLMN where the PGW was allocated, in case of dynamic PGW assignment. + +NOTE: If interworking with MAP is needed, the Context-Identifier will be in the range of 1 and 50. + +The Non-IP-Data-Delivery-Mechanism shall only be present when Non-IP-PDN-Type-Indicator is set to TRUE (1). + +The SCEF-ID AVP and the SCEF-Realm AVP shall only be present when Non-IP-PDN-Type-Indicator is set to TRUE (1), and Non-IP-Data-Delivery-Mechanism is set to SCEF-BASED-DATA-DELIVERY (1). + +The RDS-Indicator may be present when Non-IP-PDN-Type-Indicator is set to TRUE (1), and Non-IP-Data-Delivery-Mechanism is set to SCEF-BASED-DATA-DELIVERY (1). + +Absence of PDN-Connection-Continuity AVP indicates that the handling is left to local VPLMN policy. + +### 7.3.36 Service-Selection + +The Service-Selection AVP is of type of UTF8String. This AVP shall contain either the APN Network Identifier (i.e. an APN without the Operator Identifier) per 3GPP TS 23.003 [3], clauses 9.1 & 9.1.1, or this AVP shall contain the wild card value per 3GPP TS 23.003 [3], clause 9.2.1, and 3GPP TS 23.008 [30], clause 2.13.6). + +The contents of the Service-Selection AVP shall be formatted as a character string composed of one or more labels separated by dots (".") or as the wild card APN, i.e., consisting of only one ASCII label, "\*". + +This AVP is defined in IETF RFC 5778[20]. + +### 7.3.37 EPS-Subscribed-QoS-Profile + +The EPS-Subscribed-QoS-Profile AVP is of type Grouped. It shall contain the bearer-level QoS parameters (QoS Class Identifier and Allocation Retention Priority) associated to the default bearer for an APN (see 3GPP TS 23.401 [2], clause 4.7.3). + +AVP format + +``` + +EPS-Subscribed-QoS-Profile ::= + + { QoS-Class-Identifier } + + { Allocation-Retention-Priority } + + *[AVP] + +``` + +NOTE: QoS-Class-Identifier is defined in 3GPP TS 29.212 [10] as an Enumerated AVP. The values allowed for this AVP over the S6a/S6d interface are only those associated to non-GBR bearers, as indicated in 3GPP TS 23.008 [30]; e.g., values QCI\_1, QCI\_2, QCI\_3 and QCI\_4, which are associated to GBR bearers, cannot be sent over S6a/S6d. + +### 7.3.38 VPLMN-Dynamic-Address-Allowed + +The VPLMN-Dynamic-Address-Allowed AVP is of type Enumerated. It shall indicate whether for this APN, the UE is allowed to use the PDN GW in the domain of the HPLMN only, or additionally, the PDN GW in the domain of the VPLMN.. If this AVP is not present, this means that the UE is not allowed to use PDN GWs in the domain of the VPLMN. The following values are defined: + +NOTALLOWED (0) + +ALLOWED (1) + +### 7.3.39 STN-SR + +The STN-SR AVP is of type OctetString and shall contain the Session Transfer Number for SRVCC. See 3GPP TS 23.003 [3] for the definition of STN-SR. This AVP contains an STN-SR, in international number format as described in ITU-T Rec E.164 [41], encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.40 Allocation-Retention-Priority + +The Allocation-Retention-Priority AVP is of type Grouped and is defined in 3GPP TS 29.212 [10]. It shall indicate the Priority of Allocation and Retention for the corresponding APN configuration. + +AVP format + +``` +Allocation-Retention-Priority ::= + { Priority-Level } + [ Pre-emption-Capability ] + [ Pre-emption-Vulnerability ] +``` + +If the Pre-emption-Capability AVP is not present in the Allocation-Retention-Priority AVP, the default value shall be PRE-EMPTION\_CAPABILITY\_DISABLED (1). + +If the Pre-emption-Vulnerability AVP is not present in the Allocation-Retention-Priority AVP, the default value shall be PRE-EMPTION\_VULNERABILITY\_ENABLED (0). + +### 7.3.41 AMBR + +The AMBR AVP is of type Grouped. + +It shall contain the maximum requested bandwidth for Uplink and Downlink traffic. The Max-Requested-Bandwidth-(UL/DL) AVPs shall encode the bandwidth value in bits per second, having an upper limit of 4294967295 bits per second. The Extended-Max-Requested-BW-(UL/DL) AVPs shall encode the bandwidth value in kilobits (1000 bits) per second, having an upper limit of 4294967295 kilobits per second. + +When the maximum bandwidth value to be set for UL (or DL, respectively) traffic is lower than 4294967296 bits per second, the Max-Requested-Bandwidth-UL (or -DL, respectively) AVP shall be present, and set to the requested bandwidth value in bits per second, and the Extended-Max-Requested-BW-UL (or -DL, respectively) AVP shall be absent. + +When the maximum bandwidth value to be set for UL (or DL, respectively) traffic is higher than 4294967295 bits per second, the Max-Requested-Bandwidth-UL (or DL, respectively) AVP shall be present, and set to its upper limit 4294967295, and the Extended-Max-Requested-BW-UL (or -DL, respectively) shall be present, and set to the requested bandwidth value in kilobits (1000 bits) per second. + +NOTE: The value applicable for Max-Requested-Bandwidth-UL (or DL, respectively) is between 1 and 4294967295 bits per second, and the value applicable for Extended-Max-Requested-BW-UL (or -DL, respectively) is between 4294968 and 4294967295 kilobits per second. The AMBR AVP cannot indicate the requested bandwidth between 4294967296 and 4294967999 bits per second, and any larger value that cannot be represented in the granularity of kilobits per second. + +AVP format + +``` +AMBR ::= + { Max-Requested-Bandwidth-UL } + { Max-Requested-Bandwidth-DL } + [ Extended-Max-Requested-BW-UL ] + [ Extended-Max-Requested-BW-DL ] + *[AVP] +``` + +### 7.3.42 MIP-Home-Agent-Address + +The MIP-Home-Agent-Address AVP is of type Address and is defined in IETF RFC 4004 [27]. This AVP shall contain either IPv4 or IPv6 address of the PDN-GW and this IP address shall be used as the PDN-GW IP address. + +### 7.3.43 MIP-Home-Agent-Host + +The MIP-Home-Agent-Host is of type Grouped and is defined in IETF RFC 4004 [27]. This AVP shall contain a FQDN of the PDN-GW which shall be used to resolve the PDN-GW IP address using the Domain Name Service function. + +MIP-Home-Agent-Host grouped AVP is composed by Destination-Host and Destination-Realm AVPs. + +Destination-Host shall contain the hostname of the PDN-GW, formatted as described in 3GPP TS 29.303 [38], clause 4.3.2. + +Destination-Realm shall be formatted as: + +epc.mnc.mcc.3gppnetwork.org + +where MNC and MCC values indicate the PLMN where the PDN-GW is located. + +### 7.3.44 PDN-GW-Allocation-Type + +The PDN-GW-Allocation-Type AVP is of type Enumerated. It shall indicate whether the PDN GW address included in MIP6-Agent-Info has been statically allocated (i.e. provisioned in the HSS by the operator), or dynamically selected by other nodes. The following values are defined: + +STATIC (0) + +DYNAMIC (1) + +### 7.3.45 MIP6-Agent-Info + +The MIP6-Agent-Info AVP is of type Grouped and is defined in IETF RFC 5447 [26]. This AVP shall contain the identity of the PDN-GW. This AVP is used to convey the identity of the PDN-GW between the MME/SGSN and the HSS regardless of the specific mobility protocol used (GTP or PMIPv6). The identity of PDN-GW is either an IP address transported in MIP-Home-Agent-Address or an FQDN transported in MIP-Home-Agent-Host. FQDN shall be used if known to the MME/SGSN/HSS. + +AVP format + +``` +MIP6-Agent-Info ::= < AVP Header: 486 > + *2[ MIP-Home-Agent-Address ] + [ MIP-Home-Agent-Host ] + [ MIP6-Home-Link-Prefix ] + *[ AVP ] +``` + +Within the MIP6-Agent-Info AVP, if static address allocation is used, there may be either: + +- an IPv4 address or an IPv6 address of the PGW contained in one MIP-Home-Agent-Address AVP; +- both IPv4 address and IPv6 address of the PGW contained in two MIP-Home-Agent-Address AVPs. + +The AVP MIP6-Home-Link-Prefix is not used in S6a/S6d, but it is included here to reflect the complete IETF definition of the grouped AVP. + +### 7.3.46 RAT-Frequency-Selection-Priority-ID + +The RAT-Frequency-Selection-Priority-ID AVP is of type Unsigned32 and shall contain the subscribed value of Subscriber Profile ID for RAT/Frequency Priority. For details, see 3GPP TS 23.401 [2] and 3GPP TS 23.060 [12]. The coding is defined in 3GPP TS 36.413 [19]. Values shall be in the range of 1 to 256. + +### 7.3.47 IDA-Flags + +The IDA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meanings of the bits are defined in table 7.3.47/1: + +**Table 7.3.47/1: IDA-Flags** + +| Bit | Name | Description | +|---------------------------------------------------------------------------------------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| 0 | Network Node area restricted | This bit, when set, shall indicate that the complete Network Node area (SGSN area) is restricted due to regional subscription. | +| Note: Bits not defined in this table shall be cleared by the sending SGSN and discarded by the receiving HSS. | | | + +### 7.3.48 PUA-Flags + +The PUA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meanings of the bits are defined in table 7.3.48/1: + +**Table 7.3.48/1: PUA-Flags** + +| bit | name | Description | +|----------------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------------------------------------------------------------------------------------| +| 0 | Freeze M-TMSI | This bit, when set, shall indicate to the MME that the M-TMSI needs to be frozen, i.e. shall not be immediately re-used. | +| 1 | Freeze P-TMSI | This bit, when set, shall indicate to the SGSN that the P-TMSI needs to be frozen, i.e. shall not be immediately re-used. | +| Note: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | | + +### 7.3.49 NOR-Flags + +The NOR-Flags AVP is of type Unsigned32 and it contains a bit mask. The meaning of the bits is defined in table 7.3.49/1: + +**Table 7.3.49/1: NOR-Flags** + +| bit | name | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Single-Registration-Indication | This bit, when set, indicates that the HSS shall send Cancel Location to the SGSN. An SGSN shall not set this bit when sending NOR. | +| 1 | SGSN area restricted | This bit, when set, shall indicate that the complete SGSN area is restricted due to regional subscription. | +| 2 | Ready for SM from SGSN | This bit, when set, shall indicate that the UE is present or the UE has memory capacity available to receive one or more short messages via SGSN. | +| 3 | UE Reachable from MME | This bit, when set, shall indicate that the UE has become reachable again from MME. | +| 4 | Reserved | The use of this bit is deprecated. This bit shall be discarded by the receiving HSS. | +| 5 | UE Reachable from SGSN | This bit, when set, shall indicate that the UE has become reachable again from SGSN. | +| 6 | Ready for SM from MME | This bit, when set, shall indicate that the UE is present or the UE has memory capacity available to receive one or more short messages via MME. | +| 7 | Homogeneous Support of IMS Voice Over PS Sessions | This bit, when set, shall indicate that the Homogeneous Support of IMS Voice Over PS Sessions is updated. | +| 8 | S6a/S6d-Indicator | This bit, when set, shall indicate that the NOR message is sent on the S6a interface, i.e. the message is from the MME or the MME part on the combined MME/SGSN.
This bit, when cleared, indicates that the NOR message is sent on the S6d interface, i.e. the message is from the SGSN or the SGSN part on the combined MME/SGSN. | +| 9 | Removal of MME Registration for SMS | This bit, when set, shall indicate that the MME requests to remove its registration for SMS. | +| NOTE 1: The S6a/S6d-Indicator flag shall be used together with Homogeneous Support of IMS Voice Over PS Sessions flag, i.e. if the Homogeneous Support of IMS Voice Over PS Sessions bit is set, the S6a/S6d-Indicator bit shall be set if the message is sent from the MME or the MME part on the combined MME/SGSN, and shall be cleared if the message is sent from the SGSN or the SGSN part on the combined MME/SGSN. This S6a/S6d-Indicator bit shall be discarded by the receiving HSS if the Homogeneous Support of IMS Voice Over PS Sessions bit is not set. | | | +| NOTE 2: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving HSS. | | | +| | | | + +### 7.3.50 User-Id + +The User-Id AVP shall be of type UTF8String. It shall contain the leading digits of an IMSI (i.e. MCC, MNC, leading digits of MSIN, see 3GPP TS 23.003 [3], clause 2.2) formatted as a character string. Within a HSS, a User-Id identifies a set of subscribers, each with identical leading IMSI digits. + +### 7.3.51 Equipment-Status + +The Equipment-Status AVP is of type Enumerated, and shall contain the status of the mobile equipment. The following values are defined: + +PERMITTEDLISTED (0) + +PROHIBITEDLISTED (1) + +## TRACKINGLISTED (2) + +### 7.3.52 Regional-Subscription-Zone-Code + +The Regional-Subscription-Zone-Code AVP is of type OctetString. It shall contain a Zone Code (ZC) as defined in 3GPP TS 23.003 [3], clause 4.4. Up to 10 Zone Codes per VPLMN can be defined as part of the user's subscription data. + +NOTE 1: Each zone code represents a collection of tracking area or routing areas (defined by the operator of the VPLMN) where the user is allowed, or disallowed, to roam. The determination of which areas are actually allowed, and which ones are not allowed, is done by the serving node (MME/SGSN) in an implementation-dependent manner. + +NOTE 2: The description of RSZI in 3GPP TS 23.003 [3] is applicable, in the context of this specification, not only to location areas, but also to routing and tracking areas. + +### 7.3.53 RAND + +The RAND AVP is of type OctetString. This AVP shall contain the RAND. See 3GPP TS 33.401 [5]. + +### 7.3.54 XRES + +The XRES AVP is of type OctetString. This AVP shall contain the XRES. See 3GPP TS 33.401 [5]. + +### 7.3.55 AUTN + +The AUTN AVP is of type OctetString. This AVP shall contain the AUTN. See 3GPP TS 33.401 [5]. + +### 7.3.56 KASME + +The KASME AVP is of type OctetString. This AVP shall contain the K\_ASME. See 3GPP TS 33.401 [5]. + +### 7.3.57 Confidentiality-Key AVP + +The Confidentiality-Key is of type OctetString, and shall contain the Confidentiality Key (CK). + +### 7.3.58 Integrity-Key AVP + +The Integrity-Key is of type OctetString, and shall contain the Integrity Key (IK). + +### 7.3.59 Kc AVP + +The Kc AVP is of type OctetString, and shall contain the Ciphering Key (Kc). + +### 7.3.60 SRES + +The SRES AVP is of type OctetString. This AVP shall contain the SRES. See 3GPP TS 33.102 [18]. + +### 7.3.61 Void + +### 7.3.62 PDN-Type + +The PDN-Type AVP is of type Enumerated and indicates the address type of the PDN, when it is IP-based. + +NOTE: There are certain PDNs that can be accessed without using IP. These are identified by a specific PDN type indicator in their APN configuration settings (e.g. see clauses 7.3.204 and 7.3.232). + +The following values are defined: + +IPv4 (0) + +This value shall be used to indicate that the PDN can be accessed only in IPv4 mode. + +IPv6 (1) + +This value shall be used to indicate that the PDN can be accessed only in IPv6 mode. + +IPv4v6 (2) + +This value shall be used to indicate that the PDN can be accessed both in IPv4 mode, in IPv6 mode, and also from UEs supporting dualstack IPv4v6. + +IPv4\_OR\_IPv6 (3) + +This value shall be used to indicate that the PDN can be accessed either in IPv4 mode, or in IPv6 mode, but not from UEs supporting dualstack IPv4v6. It should be noted that this value will never be used as a requested PDN Type from the UE, since UEs will only use one of their supported PDN Types, i.e., IPv4 only, IPv6 only or IPv4v6 (dualstack). This value is only used as part of the APN subscription context, as an authorization mechanism between HSS and MME. + +### 7.3.63 Trace-Data AVP + +The Trace-Data AVP is of type Grouped. This AVP shall contain the information related to trace function. + +AVP format + +Trace-Data ::= + +{Trace-Reference} +{Trace-Depth} +{Trace-NE-Type-List} +[Trace-Interface-List] +{Trace-Event-List} +[OMC-Id] +{Trace-Collection-Entity} +[MDT-Configuration] +\*[AVP] + +### 7.3.64 Trace-Reference AVP + +The Trace-Reference AVP is of type OctetString. This AVP shall contain the concatenation of MCC, MNC and Trace ID, where the Trace ID is a 3 byte Octet String. See 3GPP TS 32.422 [23]. + +The content of this AVP shall be encoded as octet strings according to table 7.3.64/1. + +See 3GPP TS 24.008 [31], clause 10.5.1.13, PLMN list, for the coding of MCC and MNC. If MNC is 2 digits long, bits 5 to 8 of octet 2 are coded as "1111". + +**Table 7.3.64/1: Encoding format for Trace-Reference AVP** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|----------|---|---|---|---|---|---|---|--| +| | | | | | | | | | +| | | | | | | | | | +| | | | | | | | | | +| Trace ID | | | | | | | | | +| | | | | | | | | | +| | | | | | | | | | + +### 7.3.65 Void + +### 7.3.66 Void + +### 7.3.67 Trace-Depth AVP + +The Trace-Depth AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Trace Depth. + +### 7.3.68 Trace-NE-Type-List AVP + +The Trace-NE-Type-List AVP is of type OctetString. Octets are coded according to 3GPP TS 32.422 [23]. + +### 7.3.69 Trace-Interface-List AVP + +The Trace-Interface-List AVP is of type OctetString. Octets are coded according to 3GPP TS 32.422 [23]. + +### 7.3.70 Trace-Event-List AVP + +The Trace-Event-List AVP is of type OctetString. Octets are coded according to 3GPP TS 32.422 [23]. + +### 7.3.71 OMC-Id AVP + +The OMC-Id AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. + +### 7.3.72 GPRS-Subscription-Data + +The GPRS-Subscription-Data AVP is of type Grouped. It shall contain the information related to the user profile relevant for GPRS. + +AVP format: + +``` +GPRS-Subscription-Data ::= + { Complete-Data-List-Included-Indicator } + 1*50{PDP-Context} + *[AVP] +``` + +NOTE: The max number of PDP-Context AVP aligns with the value of maxNumOfPDP-Contexts as defined in 3GPP TS 29.002 [24]. + +### 7.3.73 Complete-Data-List-Included-Indicator + +The Complete-Data-List-Included-Indicator AVP is of type Enumerated. The following values are defined: + +ALL\_PDP\_CONTEXTS\_INCLUDED (0) + +MODIFIED\_ADDED\_PDP\_CONTEXTS\_INCLUDED (1) + +### 7.3.74 PDP-Context + +The PDP-Context AVP is of type Grouped. For a particular GPRS user having multiple PDP Context configurations, the Service-Selection AVP values may be the same for different PDP-Context AVPs. + +AVP format + +``` +PDP-Context ::= + { Context-Identifier } + { PDP-Type } + [ PDP-Address ] + { QoS-Subscribed } + [ VPLMN-Dynamic-Address-Allowed ] + { Service-Selection } + [3GPP-Charging-Characteristics] + [ Ext-PDP-Type ] + [ Ext-PDP-Address ] + [ AMBR ] + [ APN-OI-Replacement ] + [ SIPTO-Permission ] + [ LIPA-Permission ] + [ Restoration-Priority ] + [ SIPTO-Local-Network-Permission ] + [ Non-IP-Data-Delivery-Mechanism ] + [ SCEF-ID ] + *[AVP] +``` + +The Ext-PDP-Address AVP may be present only if the PDP-Address AVP is present. If the Ext-PDP-Address AVP is present, then it shall not contain the same address type (IPv4 or IPv6) as the PDP-Address AVP. + +When PDP-Type takes the value Non-IP (HEX 02), the Ext-PDP-Type AVP shall be absent. + +The AMBR included in this grouped AVP shall include the AMBR associated to the APN included in the PDP-Context AVP (APN-AMBR). + +The APN-OI-Replacement included in this grouped AVP shall include the APN-OI-Replacement associated to the APN included in the PDP-Context. This APN-OI-Replacement has higher priority than UE level APN-OI-Replacement. + +The Non-IP-Data-Delivery-Mechanism shall only be present when PDP-Type takes the value Non-IP (HEX 02). + +The SCEF-ID shall only be present when Non-IP-Data-Delivery-Mechanism takes the value SCEF-BASED-DATA-DELIVERY (1). + +### 7.3.75 PDP-Type + +The PDP-Type AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. The allowed values are one of IPv4 encoded as HEX (21) or IPv6 encoded as HEX (57) or Non-IP encoded as HEX (02). + +### 7.3.75A Ext-PDP-Type + +The Ext-PDP-Type AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24] and 3GPP TS 29.060 [39] and shall contain the value of IPv4v6. + +### 7.3.76 Void + +### 7.3.77 QoS-Subscribed + +The QoS-Subscribed AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24] (octets of QoS-Subscribed, Ext-QoS-Subscribed, Ext2-QoS-Subscribed, Ext3-QoS-Subscribed and Ext4-QoS-Subscribed values are concatenated). + +### 7.3.78 CSG-Subscription-Data + +The CSG-Subscription-Data AVP is of type Grouped. This AVP shall contain the CSG-Id, and may contain the associated Visited-PLMN-Id, an associated expiration date and the APNs which are allowed to be accessed via Local IP Access from the CSG. + +If the Visited-PLMN-Id is not present, the CSG-Subscription-Data corresponds to the registered PLMN (i.e. the visited PLMN) of the MME or the SGSN. + +AVP format + +``` + +CSG-Subscription-Data ::= + { CSG-Id } + [ Expiration-Date ] + *[ Service-Selection ] + [ Visited-PLMN-Id ] + *[AVP] + +``` + +### 7.3.79 CSG-Id + +The CSG-Id AVP is of type Unsigned32. Values are coded according to 3GPP TS 23.003 [3]. Unused bits (least significant) shall be padded with zeros. + +### 7.3.80 Expiration-Date + +The Expiration-Date AVP is of type Time (see IETF RFC 6733 [61]) and contains the point in time when subscription to the CSG-Id expires. + +### 7.3.81 Roaming-Restricted-Due-To-Unsupported-Feature + +The Roaming-Restricted-Due-To-Unsupported-Feature AVP is of type Enumerated and indicates that roaming is restricted due to unsupported feature. The following value is defined: + +Roaming-Restricted-Due-To-Unsupported-Feature (0) + +### 7.3.82 Specific-APN-Info AVP + +The Specific-APN-Info AVP is of type Grouped. It shall only be present in the APN configuration when the APN is a wild card APN. It shall contain the APN which is not present in the subscription context but the UE is authorized to connect to and the identity of the registered PDN-GW. + +The AVP format shall conform to: + +``` +Specific-APN-Info ::= + { Service-Selection } + { MIP6-Agent-Info } + [ Visited-Network-Identifier ] + *[ AVP ] +``` + +### 7.3.83 Alert-Reason AVP + +The Alert-Reason AVP is of type Enumerated. The following values are defined: + +UE\_PRESENT (0) + +UE\_MEMORY\_AVAILABLE (1) + +### 7.3.84 LCS-Info + +The LCS-Info AVP is of type Grouped. This AVP shall contain the following LCS related information for a subscriber: + +- list of GMLCs in the HPLMN that are permitted to issue a call/session unrelated or call/session related MT-LR location request for this UE; +- privacy exception list that is applicable only over the S6d interface; +- MO-LR list. + +AVP format + +``` +LCS-Info ::= + *[ GMLC-Number ] + *[ LCS-PrivacyException ] + *[ MO-LR ] + *[AVP] +``` + +### 7.3.85 GMLC-Number + +The GMLC-Number AVP is of type OctetString. This AVP shall contain the ISDN number of the GMLC in international number format as described in ITU-T Rec E.164 [41] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.86 LCS-PrivacyException + +The LCS-PrivacyException AVP is of type Grouped. This AVP shall contain the classes of LCS Client that are allowed to locate any target UE. + +AVP format + +``` +LCS-PrivacyException ::= + { SS-Code } + { SS-Status } + [ Notification-To-UE-User ] + *[ External-Client ] + *[ PLMN-Client ] + *[ Service-Type ] + *[AVP] +``` + +### 7.3.87 SS-Code + +The SS-Code AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. + +### 7.3.88 SS-Status + +The SS-Status AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. For details, see 3GPP TS 23.011 [29]. + +### 7.3.89 Notification-To-UE-User + +The Notification- To-UE-User AVP is of type Enumerated. The following values are defined: + +``` +NOTIFY_LOCATION_ALLOWED (0) +NOTIFYANDVERIFY_LOCATION_ALLOWED_IF_NO_RESPONSE (1) +NOTIFYANDVERIFY_LOCATION_NOT_ALLOWED_IF_NO_RESPONSE (2) +LOCATION_NOT_ALLOWED (3) +``` + +### 7.3.90 External-Client + +The External-Client AVP is of type Grouped. This AVP shall contain the identities of the external clients that are allowed to locate a target UE for a MT-LR. + +AVP format + +``` +External-Client ::= + { Client-Identity } + [ GMLC-Restriction ] + [ Notification-To-UE-User ] + *[AVP] +``` + +### 7.3.91 Client-Identity + +The Client-Identity AVP is of type OctetString and it shall contain the ISDN number of the external client in international number format as described in ITU-T Rec E.164 [41] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.92 GMLC-Restriction + +The GMLC-Restriction AVP is of type Enumerated. The following values are defined: + +GMLC\_LIST (0) + +HOME\_COUNTRY (1) + +### 7.3.93 PLMN-Client + +The PLMN-Client AVP is of type Enumerated. The following values are defined: + +BROADCAST\_SERVICE (0) + +O\_AND\_M\_HPLMN (1) + +O\_AND\_M\_VPLMN (2) + +ANONYMOUS\_LOCATION (3) + +TARGET\_UE\_SUBSCRIBED\_SERVICE (4) + +### 7.3.94 Service-Type + +The Service-Type AVP is of type Grouped. This AVP shall contain the identities of the service type of the clients that are allowed to locate a target UE for an MT-LR. + +AVP format + +Service-Type ::= + +{ ServiceTypeIdentity } + +[ GMLC-Restriction ] + +[ Notification-To-UE-User ] + +\*[AVP] + +### 7.3.95 ServiceTypeIdentity + +The ServiceTypeIdentity AVP is of type Unsigned32. For details on the values of this AVP, see 3GPP TS 29.002 [24]. + +### 7.3.96 MO-LR + +The MO-LR AVP is of type Grouped. This AVP shall contain the classes of MO-LR for which a subscription exists for a particular UE. + +AVP format + +MO-LR ::= + +{ SS-Code } + +{ SS-Status } + +\*[AVP] + +### 7.3.97 Void + +### 7.3.98 Trace-Collection-Entity AVP + +The Trace-Collection-Entity AVP is of type Address and contains the IPv4 or IPv6 address of the Trace Collection Entity, as defined in 3GPP TS 32.422 [23], clause 5.9. + +### 7.3.99 Teleservice-List + +The Teleservice-List AVP is of type Grouped. This AVP shall contain the service codes for the short message related teleservice for a subscriber: + +AVP format + +Teleservice-List ::= + +1 \* { TS-Code }\*[ AVP ] + +### 7.3.100 TS-Code + +The TS-Code AVP is of type OctetString. Octets are coded according to 3GPP TS 29.002 [24]. + +### 7.3.101 Call-Barring-Info + +The Call-Barring-Info AVP is of type Grouped. This AVP shall contain the service codes for the short message related call barring services for a subscriber: + +AVP format + +Call-Barring-Info ::= + +{ SS-Code } + +{ SS-Status } + +\*[ AVP ] + +### 7.3.102 SGSN-Number + +The SGSN-Number AVP is of type OctetString and it shall contain the ISDN number of the SGSN. For further details on the definition of this AVP, see 3GPP TS 23.003 [3]. This AVP contains an SGSN-Number in international number format as described in ITU-T Rec E.164 [41] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.103 IDR-Flags + +The IDR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.103/1: + +**Table 7.3.103/1: IDR-Flags** + +| bit | name | Description | +|----------------------------------------------------------------------------------------------------------------------|----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | UE Reachability Request | This bit when set shall indicate to the MME or the SGSN that the HSS is awaiting a Notification of UE Reachability. | +| 1 | T-ADS Data Request | This bit, when set, shall indicate to the MME or SGSN that the HSS requests the support status of "IMS Voice over PS Sessions", and the RAT Type and timestamp of the last radio contact with the UE. | +| 2 | EPS User State Request | This bit, when set, shall indicate to the MME or the SGSN that the HSS requests the MME or the SGSN for the current user state. | +| 3 | EPS Location Information Request | This bit, when set, shall indicate to the MME or the SGSN that the HSS requests the MME or SGSN for location information | +| 4 | Current Location Request | This bit when set shall indicate to the MME or the SGSN that the HSS requests the MME or SGSN to provide the most current location information by paging the UE if the UE is in idle mode. This bit is used only in combination with the "EPS Location Information Request" bit. | +| 5 | Local Time Zone Request | This bit when set shall indicate to the MME or the SGSN that the HSS requests the MME or SGSN to provide information on the time zone of the location in the visited network where the UE is attached. | +| 6 | Remove SMS Registration | This bit when set shall indicate to the MME that it shall consider itself unregistered for SMS. | +| 7 | RAT-Type Requested | This bit when set shall indicate to the MME or the SGSN that the HSS requests the MME or SGSN to provide the RAT Type that corresponds to the requested EPS Location Information. This bit is used only in combination with the "EPS Location Information Request" bit. | +| 8 | P-CSCF Restoration Request | This bit, when set, shall indicate to the MME or SGSN that the HSS requests the execution of the HSS-based P-CSCF restoration procedures, as described in 3GPP TS 23.380 [51] clause 5.4. | +| NOTE: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | | + +### 7.3.104 ICS-Indicator + +The ICS-Indicator AVP is of type Enumerated. The meaning of the values is defined in 3GPP TS 23.292 [34] and 3GPP TS 23.216 [35]. The following values are defined: + +FALSE (0) + +TRUE (1) + +### 7.3.105 Visited-Network-Identifier + +The Visited-Network-Identifier AVP contains the identity of the network where the PDN-GW was allocated, in the case of dynamic PDN-GW assignment. + +The AVP shall be encoded as: + +mnc.mcc.3gppnetwork.org + +### 7.3.106 IMS-Voice-Over-PS-Sessions-Supported + +The IMS-Voice-Over-PS-Sessions-Supported AVP is of type Enumerated. The following values are defined: + +#### NOT\_SUPPORTED (0) + +This value indicates that "IMS Voice over PS Sessions" is not supported by the UE's most recently used TA or RA in the serving node. + +#### SUPPORTED (1) + +This value indicates that "IMS Voice over PS Sessions" is supported by the UE's most recently used TA or RA in the serving node. + +### 7.3.107 Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions + +The Homogeneous-Support-of-IMS-Voice-Over-PS-Sessions AVP is of type Enumerated. The following values are defined: + +#### NOT\_SUPPORTED (0) + +This value indicates that "IMS Voice over PS Sessions" is not supported, homogeneously, in any of the TAs or RAs associated to the serving node for the served subscribers including consideration on roaming relationship for IMS Voice over PS. + +#### SUPPORTED (1) + +This value indicates that "IMS Voice over PS Sessions" is supported, homogeneously, in all of the TAs or RAs associated to the serving node for the served subscriber including consideration on roaming relationship for IMS Voice over PS. + +If this AVP is not present in the command, it indicates that there is no homogeneous support of IMS Voice Over PS Sessions on all the TA/RAs of the serving node, or that the homogeneity of this support is unknown to the serving node. + +NOTE: In order to ensure the T-ADS by HPLMN, MME or SGSN is expected to either set "Homogenous Support of IMS Voice over PS Sessions" AVP to "NOT\_SUPPORTED (0)", or not to set this AVP for inbound roaming subscribers if there is no IMS Voice over PS roaming relationship with the HPLMN. + +### 7.3.108 Last-UE-Activity-Time + +The Last-UE-Activity-Time AVP is of type Time (see IETF RFC 6733 [61]), and contains the point of time of the last radio contact of the serving node (MME or SGSN) with the UE. + +### 7.3.109 GMLC-Address + +The GMLC-Address AVP is of type Address and shall contain the IPv4 or IPv6 address of the V-GMLC associated with the serving node. + +### 7.3.110 EPS-User-State + +The EPS-User-State AVP is of type Grouped. It shall contain the information related to the user state in the MME and/or the SGSN. + +AVP format + +EPS-User-State ::= + +[MME-User-State] + +[SGSN-User-State] + +\*[AVP] + +### 7.3.111 EPS-Location-Information + +The EPS-Location Information AVP is of type Grouped. It shall contain the information related to the user location relevant for EPS. + +AVP format + +``` +EPS-Location-Information ::= + [MME-Location-Information] + [SGSN-Location-Information] + *[AVP] +``` + +### 7.3.112 MME-User-State + +The MME-User-State AVP is of type Grouped. It shall contain the information related to the user state in the MME. + +AVP format + +``` +MME-User-State ::= + [User-State] + *[AVP] +``` + +### 7.3.113 SGSN-User-State + +The SGSN-User-State AVP is of type Grouped. It shall contain the information related to the user state in the SGSN. + +AVP format + +``` +SGSN-User-State ::= + [User-State] + *[AVP] +``` + +### 7.3.114 User-State + +The User-State AVP is of type Enumerated and indicates the user state in EPS. The following values are defined: + +DETACHED (0) + +The UE is in EMM\_DEREGISTERED state. + +ATTACHED\_NOT\_REACHABLE\_FOR\_PAGING (1) + +The SGSN has determined from its internal data that the UE is attached to the network, but there is no EPS bearer active, and the UE is not reachable for paging. This value is only applicable to S4-SGSN. + +ATTACHED\_REACHABLE\_FOR\_PAGING (2) + +The SGSN has determined from its internal data that the UE is attached to the network, but there is no EPS bearer active; the SGSN has not determined from its internal data that the UE is not reachable for paging. This value is only applicable to S4-SGSN. + +CONNECTED\_NOT\_REACHABLE\_FOR\_PAGING (3) + +The SGSN or MME has determined from its internal data that the UE is attached to the network, there is at least one EPS bearer active, and the UE is not reachable for paging. + +CONNECTED\_REACHABLE\_FOR\_PAGING (4) + +The SGSN or MME has determined from its internal data that the UE is attached to the network, there is at least one EPS bearer active, and the SGSN or MME has not determined from its internal data that the UE is not reachable for paging. + +#### RESERVED (5) + +This value should not be used by MME or SGSN over S6a/S6d. If this value is received by the HSS from pre-rel-12 MME/SGSNs, the HSS shall consider that the UE is not reachable and use the "Network determined not reachable" state when reporting the User State to other network entities, e.g. over Sh. + +NOTE: The state associated to a "Network determined not reachable" condition should also be used by HSS when reporting to the requesting entity, e.g. over Sh, that the user was found to be not reachable (for instance, if the HSS receives no answer from the MME/SGSN to the user state query). + +### 7.3.115 MME-Location-Information + +The MME-Location-Information AVP is of type Grouped. It shall contain the information related to the user location relevant for the MME. + +AVP format + +MME-Location-Information ::= + +[E-UTRAN-Cell-Global-Identity] +[Tracking-Area-Identity] +[Geographical-Information] +[Geodetic-Information] +[Current-Location-Retrieved] +[Age-Of-Location-Information] +[User-CSG-Information] +[ eNodeB-ID ] +[ Extended-eNodeB-ID ] +\*[AVP] + +An eNodeB-ID AVP may be present for Monitoring event reporting. + +### 7.3.116 SGSN-Location-Information + +The SGSN-Location-Information AVP is of type Grouped. It shall contain the information related to the user location relevant for the SGSN. + +AVP format + +SGSN-Location-Information ::= + +[Cell-Global-Identity] +[Location-Area-Identity] +[Service-Area-Identity] +[Routing-Area-Identity] +[Geographical-Information] +[Geodetic-Information] + +[Current-Location-Retrieved] +[Age-Of-Location-Information] +[ User-CSG-Information] +\*[AVP] + +### 7.3.117 E-UTRAN-Cell-Global-Identity + +The E-UTRAN-Cell-Global-Identity AVP is of type OctetString and shall contain the E-UTRAN Cell Global Identification of the user which identifies the cell the user equipment is registered, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.118 Tracking-Area-Identity + +The Tracking-Area-Identity AVP is of type OctetString and shall contain the Tracking Area Identity of the user which identifies the tracking area where the user is located, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.119 Cell-Global-Identity + +The Cell-Global-Identity AVP is of type OctetString and shall contain the Cell Global Identification of the user which identifies the cell the user equipment is registered, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.120 Routing-Area-Identity + +The Routing-Area-Identity AVP is of type OctetString and shall contain the Routing Area Identity of the user which identifies the routing area where the user is located, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.121 Location-Area-Identity + +The Location-Area-Identity AVP is of type OctetString and shall contain the Location Area Identification of the user which identifies the Location area where the user is located, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.122 Service-Area-Identity + +The Service-Area-Identity AVP is of type OctetString and shall contain the Service Area Identifier of the user where the user is located, as specified in 3GPP TS 23.003 [3]. Octets are coded as described in 3GPP TS 29.002 [24]. + +### 7.3.123 Geographical-Information + +The Geographical-Information AVP is of type OctetString and shall contain the geographical Information of the user. For details and octet encoding, see 3GPP TS 29.002 [24]. + +### 7.3.124 Geodetic-Information + +The Geodetic-Information AVP is of type OctetString and shall contain the Geodetic Location of the user. For details and octet encoding, see 3GPP TS 29.002 [24]. + +### 7.3.125 Current-Location-Retrieved + +The Current-Location-Retrieved AVP is of type Enumerated. The following values are defined: + +ACTIVE-LOCATION-RETRIEVAL (0) + +This value is used when location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after retrieving the most up-to-date location information from the eNB when the UE is in connected mode. + +### 7.3.126 Age-Of-Location-Information + +The Age-Of-Location-Information AVP is of type Unsigned32 and shall contain the the elapsed time in minutes since the last network contact of the user equipment. For details, see 3GPP TS 29.002 [24]. + +### 7.3.127 Active-APN + +The Active-APNs AVP is of type Grouped. It shall contain information about a dynamically established APN on a serving node, so the HSS can restore it, if it is eventually lost after a node restart. + +The AVP format shall conform to: + +``` +Active-APN ::= + { Context-Identifier } + [ Service-Selection ] + [ MIP6-Agent-Info ] + [ Visited-Network-Identifier ] + *[ Specific-APN-Info ] + *[ AVP ] +``` + +### 7.3.128 Error-Diagnostic + +The Error-Diagnostic AVP is of type Enumerated. The following values are defined: + +- GPRS\_DATA\_SUBSCRIBED (0) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION and there is GPRS Subscription Data for the user. + +- NO\_GPRS\_DATA\_SUBSCRIBED (1) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION and there is not GPRS Subscription Data for the user. + +- ODB\_ALL\_APN (2) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED and the Operator Determined Barring indicates "All Packet Oriented Services Barred" (see clause 7.3.30). + +- ODB\_HPLMN\_APN (3) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED and the Operator Determined Barring indicates "Roamer Access HPLMN-AP Barred" (see clause 7.3.30). + +- ODB\_VPLMN\_APN (4) + +This value shall be used when Experimental-Error is DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED and the Operator Determined Barring indicates "Roamer Access to VPLMN-AP Barred" (see clause 7.3.30). + +### 7.3.129 Ext-PDP-Address AVP + +The Ext-PDP-Address AVP is of type Address and indicates an additional address of the data protocol, and it may be included when the PDP supports dual-stack (IPv4v6). + +### 7.3.130 UE-SRVCC-Capability + +The UE-SRVCC-Capability AVP is of type Enumerated. It shall indicate if the UE supports or does not support the SRVCC capability. The following values are defined: + +UE-SRVCC-NOT-SUPPORTED (0) + +UE-SRVCC-SUPPORTED (1) + +### 7.3.131 MPS-Priority + +The MPS-Priority AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.131/1: + +**Table 7.3.131/1: MPS-Priority** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------| +| 0 | MPS-CS-Priority | This bit, when set, indicates that the UE is subscribed to the eMLPP or 1x RTT priority service in the CS domain. | +| 1 | MPS-EPS-Priority | This bit, when set, indicates that the UE is subscribed to the MPS in the EPS domain. | +| Note: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | | + +NOTE: The HSS derives the information for MPS-CS-Priority from the eMLPP Subscription Data as defined in the 3GPP TS 29.002 [24] or 1x RTT priority service which is out of the scope of 3GPP. + +### 7.3.132 VPLMN-LIPA-Allowed + +The VPLMN-LIPA-Allowed AVP is of type Enumerated. It shall indicate whether the UE is allowed to use LIPA in the VPLMN where the UE is roaming. The following values are defined: + +LIPA\_NOTALLOWED (0) + +This value indicates that the UE is not allowed to use LIPA in the VPLMN where the UE is roaming. + +LIPA\_ALLOWED (1) + +This value indicates that the UE is allowed to use LIPA in the VPLMN where the UE is roaming. + +### 7.3.133 LIPA-Permission + +The LIPA-Permission AVP is of type Enumerated. It shall indicate whether the APN can be accessed via Local IP Access. The following values are defined: + +LIPA\_PROHIBITED (0) + +This value indicates that this APN is prohibited to be accessed via LIPA. + +LIPA\_ONLY (1) + +This value indicates that this APN can be accessed only via LIPA. + +LIPA\_CONDITIONAL (2) + +This value indicates that this APN can be accessed via both non LIPA and LIPA. + +### 7.3.134 Subscribed-Periodic-RAU-TAU-Timer + +The Subscribed-Periodic-RAU-TAU-Timer AVP is of type Unsigned32 and it shall contain the subscribed periodic RAU/TAU timer value in seconds as specified in 3GPP TS 24.008 [31]. + +### 7.3.135 SIPTO-Permission + +The SIPTO-Permission AVP is of type Enumerated. It shall indicate whether the traffic associated with this particular APN is allowed or not for SIPTO above RAN. + +The following values are defined: + +SIPTO\_above\_RAN\_ALLOWED (0) + +SIPTO\_above\_RAN\_NOTALLOWED (1) + +### 7.3.136 MDT-Configuration + +The MDT-Configuration AVP is of type Grouped. It shall contain MDT related information as specified in 3GPP TS 32.422 [23]. + +The AVP format shall conform to: + +MDT-Configuration ::= + +``` + + { Job-Type } + [ Area-Scope ] + [ List-Of-Measurements ] + [ Reporting-Trigger ] + [ Report-Interval ] + [ Report-Amount ] + [ Event-Threshold-RSRP ] + [ Event-Threshold-RSRQ ] + [ Logging-Interval ] + [ Logging-Duration ] + [ Measurement-Period-LTE ] + [ Measurement-Period-UMTS ] + [ Collection-Period- RRM-LTE ] + [ Collection-Period-RRM-UMTS ] + [ Positioning-Method ] + [ Measurement-Quantity ] + [ Event-Threshold-Event-1F ] + [ Event-Threshold-Event-1I ] + *[ MDT-Allowed-PLMN-Id ] + *[ MBSFN-Area ] + *[ AVP ] + +``` + +### 7.3.137 Job-Type + +The Job-Type AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Job-Type. + +### 7.3.138 Area-Scope + +The Area-Scope AVP is of type Grouped. See 3GPP TS 32.422 [23]. + +The AVP format shall conform to: + +``` +Area-Scope ::= + *[ Cell-Global-Identity ] + *[ E-UTRAN-Cell-Global-Identity ] + *[ Routing-Area-Identity ] + *[ Location-Area-Identity ] + *[ Tracking-Area-Identity ] + *[ AVP ] +``` + +### 7.3.139 List-Of-Measurements + +The List-Of-Measurements AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits is defined in 3GPP TS 32.422 [23]. The most significant bit is bit 8 of the first octet. + +### 7.3.140 Reporting-Trigger + +The Reporting-Trigger AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits is defined in 3GPP TS 32.422 [23]. The most significant bit is bit 8 of the first octet. + +### 7.3.141 Report-Interval + +The Report-Interval AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Report Interval + +### 7.3.142 Report-Amount + +The Report-Amount AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Report Amount. + +### 7.3.143 Event-Threshold-RSRP + +The Event-Threshold-RSRP AVP is of type Unsigned32. See 3GPP TS 32.422 [23] for allowed values + +### 7.3.144 Event-Threshold-RSRQ + +The Event-Threshold-RSRQ AVP is of type Unsigned32. See 3GPP TS 32.422 [23] for allowed values + +### 7.3.145 Logging-Interval + +The Logging-Interval AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Logging Interval + +### 7.3.146 Logging-Duration + +The Logging-Duration AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Logging Duration + +### 7.3.147 Relay-Node-Indicator + +The Relay-Node-Indicator AVP is of type Enumerated. It shall indicate whether the subscription data belongs to a Relay Node or not (see 3GPP TS 36.300 [40]). The following values are defined: + +NOT\_RELAY\_NODE (0) + +This value indicates that the subscription data does not belong to a Relay Node. + +RELAY\_NODE (1) + +This value indicates that the subscription data belongs to a Relay Node. + +The default value when this AVP is not present is NOT\_RELAY\_NODE (0). + +### 7.3.148 MDT-User-Consent + +The MDT-User-Consent AVP is of type Enumerated. It shall indicate whether the user has given his consent for MDT activation or not (see 3GPP TS 32.422 [23]). The following values are defined: + +CONSENT\_NOT\_GIVEN (0) + +CONSENT\_GIVEN (1) + +The default value when this AVP is not present in ULA is CONSENT\_NOT\_GIVEN (0). Absence of this AVP in IDR shall be interpreted as the MDT-User-Consent has not been modified. + +The presence of this subscription parameter in ULA or IDR shall be independent of the support of the Trace Function by the MME/SGSN (see clause 7.3.10). + +### 7.3.149 PUR-Flags + +The PUR-Flags AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.149/1: + +**Table 7.3.149/1: PUR-Flags** + +| bit | name | Description | +|-------|----------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | UE Purged in MME | This bit, when set, indicates that the combined MME/SGSN has purged the UE in the MME part of the node. This bit shall not be set by a standalone SGSN. | +| 1 | UE Purged in SGSN | This bit, when set, shall indicate that the combined MME/SGSN has purged the UE in the SGSN part of the node. This bit shall not be set by a standalone MME. | +| NOTE: | Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving HSS. | | + +### 7.3.150 Subscribed-VSRVCC + +The Subscribed-VSRVCC AVP is of type Enumerated. It shall indicate that the user is subscribed to the vSRVCC. The following value is defined: + +VSRVCC\_SUBSCRIBED (0) + +Absence of this AVP in IDR shall be interpreted as the Subscribed-VSRVCC has not been modified. + +Absence of this AVP in ULA shall be interpreted as the user is not subscribed to the vSRVCC. + +### 7.3.151 Equivalent-PLMN-List + +The Equivalent-PLMN-List AVP is of type Grouped. This AVP shall contain the equivalent PLMN IDs of the registered PLMN (i.e. the visited PLMN) of the MME or the SGSN. + +AVP format + +Equivalent-PLMN-List ::= + +1\*{ Visited-PLMN-Id } + +\*[AVP] + +### 7.3.152 CLR-Flags + +The CLR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.152/1: + +**Table 7.3.152/1: CLR-Flags** + +| Bit | Name | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | S6a/S6d-Indicator (Note 1) | This bit, when set, indicates that the CLR message is sent on the S6a interface, i.e. the message is to the MME or the MME part on the combined MME/SGSN.
This bit, when cleared, indicates that the CLR message is sent on the S6d interface, i.e. the message is to the SGSN or the SGSN part on the combined MME/SGSN. | +| 1 | Reattach-Required | This bit, when set, indicates that the MME or SGSN shall request the UE to initiate an immediate re-attach procedure as described in 3GPP TS 23.401 [2] and in 3GPP TS 23.060 [12]. | +| NOTE 1: The S6a/S6d-Indicator flag shall be used during initial attach procedure for a combined MME/SGSN. The S6a/S6d-Indicator flag may also be sent to a standalone node.
NOTE 2: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN.
NOTE 3: For the purpose of withdrawing "Aerial UE Subscription", HSS may send CLR with CLR-Flag set to Reattach-Required. | | | + +### 7.3.153 UVR-Flags + +The UVR-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.154/1: + +**Table 7.3.154/1: UVR-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Skip Subscriber Data | This bit, when set, indicates that the CSS may skip subscription data in UVA. If the CSG subscription data has changed in the CSS after the last successful update of the MME/SGSN, the CSS shall ignore this bit and send the updated CSG subscription data. | +| Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving CSS. | | | + +### 7.3.154 UVA-Flags + +The UVA-Flags AVP is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.156/1: + +**Table 7.3.156/1: UVA-Flags** + +| Bit | Name | Description | +|----------------------------------------------------------------------------------------------------------------|---------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Temporary Empty VPLMN CSG Subscription Data | This bit, when set, indicates that the CSS has currently no VPLMN CSG subscription data for this user but has registered the MME or SGSN, so to inform them if later changes in VPLMN CSG subscription data occur. | +| Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving CSS. | | | + +### 7.3.155 VPLMN-CSG-Subscription-Data + +The VPLMN-CSG-Subscription-Data AVP is of type Grouped. This AVP shall contain the CSG-Id, and optionally an associated expiration date. + +AVP format + +``` +VPLMN-CSG-Subscription-Data ::= + { CSG-Id } + [ Expiration-Date ] + *[AVP] +``` + +### 7.3.156 Local-Time-Zone + +The Local-Time-Zone AVP is of type Grouped and shall contain the Time Zone and the Daylight Saving Time (DST) adjustment of the location in the visited network where the UE is attached. + +The AVP format shall conform to: + +``` +Local-Time-Zone ::= + { Time-Zone } + { Daylight-Saving-Time } + * [ AVP ] +``` + +### 7.3.157 A-MSISDN + +The A-MSISDN AVP is of type OctetString. See 3GPP TS 23.003 [3] for the definition of the Additional MSISDN. This AVP contains an A-MSISDN, in international number format as described in ITU-T Rec E.164 [41], encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +This AVP may be present in the Subscription-Data AVP when sent within ULA. + +It may also be present in the Subscription-Data AVP, sent within an IDR, if the current value in the MME or SGSN needs to be changed. + +### 7.3.158 Void + +### 7.3.159 MME-Number-for-MT-SMS + +The MME-Number-for-MT-SMS AVP is of type OctetString and it shall contain the ISDN number corresponding to the MME for MT SMS. For further details on the definition of this AVP, see 3GPP TS 23.003 [3]. This AVP contains an international number with the format as described in ITU-T Rec E.164 [41] and shall be encoded as a TBCD-string. See 3GPP TS 29.002 [24] for encoding of TBCD-strings. This AVP shall not include leading indicators for the nature of address and the numbering plan; it shall contain only the TBCD-encoded digits of the address. + +### 7.3.160 Void + +### 7.3.161 Void + +### 7.3.162 SMS-Register-Request + +The SMS-Register-Request AVP is of type Enumerated and it shall indicate whether the MME or the SGSN requires to be registered for SMS (e.g. SGs interface not supported) or if the MME or the SGSN prefers not to be registered for SMS or if the MME or the SGSN has no preference. + +The following values are defined: + +SMS\_REGISTRATION\_REQUIRED (0) + +SMS\_REGISTRATION\_NOT\_PREFERRED (1) + +NO\_PREFERENCE (2) + +The criteria for setting these values are defined in 3GPP TS 23.272 [44] and 3GPP TS 23.060 [12]. + +When the MME/SGSN includes the SMS-Register-Request AVP in ULR in order to modify its registration status for SMS, the MME/SGSN shall not set the "Skip Subscriber Data" flag within the ULR-Flags AVP. + +### 7.3.163 Time-Zone + +The Time-Zone AVP is of type UTF8String and shall contain the time zone of the location in the visited network where the UE is attached. + +It contains the offset from UTC (Coordinated Universal Time) in units of 15 minutes, as defined in 3GPP TS 22.042 [42]. It shall be expressed as positive (i.e. with the leading plus sign [+]) if the local time is ahead of or equal to UTC of day and as negative (i.e. with the leading minus sign [-]) if it is behind UTC of day. + +The value contained in the Time-Zone AVP shall take into account daylight saving time, such that when the sending entity changes from regular (winter) time to daylight saving (summer) time, there is a change to the value in the Time-Zone AVP. + +The contents of the Time-Zone AVP shall be formatted as a character string with the following format: + +Basic format: $\pm n$ , with "n" being the number of units of 15 minutes from UTC. + +For example, if the offset is +2h=+8x15mn, the value of the Time-Zone AVP will be: "+8". + +### 7.3.164 Daylight-Saving-Time + +The Daylight-Saving-Time AVP is of type Enumerated and shall contain the Daylight Saving Time (in steps of 1 hour) used to adjust for summertime the time zone of the location where the UE is attached in the visited network. + +The following values are defined: + +NO\_ADJUSTMENT (0) + +PLUS\_ONE\_HOUR\_ADJUSTMENT (1) + +PLUS\_TWO\_HOURS\_ADJUSTMENT (2) + +### 7.3.165 Subscription-Data-Flags + +The Subscription-Data-Flags is of type Unsigned32 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.165/1: + +**Table 7.3.165/1: Subscription-Data-Flags** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | PS-And-SMS-Only-Service-Provision-Indication | This bit, when set, indicates that the subscription is for PS Only and permits CS service access only for SMS. | +| 1 | SMS-In-SGSN-Allowed-Indication | This bit, when set, indicates that SMS in SGSN for the user is allowed. | +| 2 | User Plane Integrity Protection | This bit, when set, indicates that the SGSN may decide to activate integrity protection of the user plane when GERAN is used (see 3GPP TS 43.020 [58]). The MME shall ignore it. | +| 3 | PDN-Connection-Restricted | This bit, when set, indicates to the MME that it shall not establish any non-emergency PDN connection for this user if the MME and the UE supports Attach without PDN connection. The SGSN shall ignore it. | +| 4 | Acknowledgement-Of-Downlink-NAS-Data PDUs disabled | This bit, when set, indicates to the MME that acknowledgement of downlink NAS data PDUs for Control Plane CIoT Optimization is disabled for this UE (even for APN configurations with RDS Indicator set to ENABLED (1)). When not set it indicated to the MME that acknowledgement of downlink NAS data PDUs for Control Plane CIoT Optimization is enabled (for APN configurations with RDS Indicator set to ENABLED (1)) for this UE, which is the default (see 3GPP TS 23.401 [2]). The SGSN shall ignore it. | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +### 7.3.166 Measurement-Period-LTE + +The Measurement-Period-LTE AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Measurement period LTE. + +### 7.3.167 Measurement-Period-UMTS + +The Measurement-Period-UMTS AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Measurement period UMTS. + +### 7.3.168 Collection-Period-RRM-LTE + +The Collection-Period-RRM-LTE AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Collection period for RRM measurements LTE. + +### 7.3.169 Collection-Period-RRM-UMTS + +The Collection-Period-RRM-UMTS AVP is of type Enumerated. The possible values are those defined in 3GPP TS 32.422 [23] for Collection period for RRM measurements UMTS. + +### 7.3.170 Positioning-Method + +The Positioning-Method AVP is of type OctetString. It contains one octet carrying a bit map of 8 bits. The possible values are those defined in 3GPP TS 32.422 [23] for Positioning Method. + +### 7.3.171 Measurement-Quantity + +The Measurement-Quantity AVP is of type OctetString. It contains one octet carrying a bit map of 8 bits. The possible values are those defined in 3GPP TS 32.422 [23] for Measurement quantity. + +### 7.3.172 Event-Threshold-Event-1F + +The Event-Threshold-Event-1F AVP is of type Integer32. See 3GPP TS 32.422 [23] for allowed values. + +### 7.3.173 Event-Threshold-Event-1I + +The Event-Threshold-Event-1I AVP is of type Integer32. See 3GPP TS 32.422 [23] for allowed values + +### 7.3.174 Restoration-Priority + +The Restoration-Priority AVP is of type Unsigned32. It shall indicate the relative priority of a user's PDN connection among PDN connections to the same APN when restoring PDN connections affected by an SGW or PGW failure/restart (see 3GPP TS 23.007 [43]). + +Values 1 to 16 are defined, with value 1 as the highest level of priority. + +### 7.3.175 SGs-MME-Identity + +The SGs-MME-Identity AVP is of type UTF8String. This AVP shall contain the MME identity used over the SGs interface and specified in 3GPP TS 23.003 [3] clause 19.4.2.4. + +### 7.3.176 SIPTO-Local-Network-Permission + +The SIPTO-Local-Network-Permission AVP is of type Unsigned32. It shall indicate whether the traffic associated with this particular APN is allowed or not for SIPTO at the local network. + +The following values are defined: + +| | | +|-------------------------------------|---| +| "SIPTO at Local Network ALLOWED" | 0 | +| "SIPTO at Local Network NOTALLOWED" | 1 | + +### 7.3.177 Coupled-Node-Diameter-ID + +The Coupled-Node-Diameter-ID AVP is of type DiameterIdentity. This AVP shall contain the S6a or S6d Diameter identity of the coupled node as specified in 3GPP TS 23.003 [3] clause 19.4.2.4 and clause 19.4.2.6. + +### 7.3.178 OC-Supported-Features + +The OC-Supported-Features AVP is of type Grouped and it is defined in IETF RFC 7683 [50]. This AVP is used to support Diameter overload control mechanism, see Annex C for more information. + +### 7.3.179 OC-OLR + +The OC-OLR AVP is of type Grouped and it is defined in IETF RFC 7683 [50]. This AVP is used to support Diameter overload control mechanism, see Annex C for more information. + +### 7.3.180 ProSe-Subscription-Data + +The ProSe-Subscription-Data AVP is of type Grouped. It shall contain the ProSe related subscription data. It was originally defined in 3GPP TS 29.344 [49]. + +AVP format + +``` +ProSe-Subscription-Data ::= + { ProSe-Permission } + *[AVP] +``` + +### 7.3.181 WLAN-offloadability + +The WLAN-offloadability AVP is of type Grouped. This AVP contains WLAN offloadability for E-UTRAN or UTRAN. + +AVP format: + +``` +WLAN-offloadability ::= + [ WLAN-offloadability-EUTRAN ] + [ WLAN-offloadability-UTRAN ] + *[ AVP ] +``` + +### 7.3.182 WLAN-offloadability-EUTRAN + +The WLAN-offloadability-EUTRAN AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.182/1: + +**Table 7.3.182/1: WLAN-offloadability-EUTRAN** + +| bit | name | Description | +|-------|----------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | WLAN offloadability for E-UTRAN | This bit, when set, shall indicate that the traffic associated with the APN is allowed to be offloaded to WLAN from E-UTRAN using the WLAN/3GPP Radio Interworking feature. If not set, it means the traffic associated with the APN is not allowed to be offloaded to WLAN from E-UTRAN. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | + +### 7.3.183 WLAN-offloadability-UTRAN + +The WLAN-offloadability-UTRAN AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.183/1: + +**Table 7.3.183/1: WLAN-offloadability-UTRAN** + +| bit | name | Description | +|-------|-----------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | WLAN offloadability for UTRAN | This bit, when set, shall indicate that the traffic associated with the APN is allowed to be offloaded to WLAN from UTRAN using the WLAN/3GPP Radio Interworking feature. If not set, it means the traffic associated with the APN is not allowed to be offloaded to WLAN from UTRAN. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN.. | | + +### 7.3.184 Reset-ID + +The Reset-ID is of type OctetString. The value shall uniquely (within the HSS's realm) identify a resource in the HSS that may fail or has restarted. + +In the Reset procedure, when used to add/modify/delete subscription data shared by multiple subscribers, the Reset-ID is used to identify the set of affected subscribers. + +### 7.3.185 MDT-Allowed-PLMN-Id + +The MDT-Allowed-PLMN-Id AVP is of type OctetString. This AVP shall contain the concatenation of MCC and MNC. See 3GPP TS 23.003 [3]. The content of this AVP shall be encoded as an octet string according to table 7.3.185/1. + +This AVP identifies the PLMN in which the MDT data collection shall take place. + +See 3GPP TS 24.008 [31], clause 10.5.1.13, PLMN list, for the coding of MCC and MNC. If MNC is 2 digits long, bits 5 to 8 of octet 2 are coded as "1111". + +**Table 7.3.185/1: Encoding format for MDT-Allowed-PLMN-Id AVP** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|---|---|---|---|---|---|---|---|--| +| | | | | | | | | | +| | | | | | | | | | +| | | | | | | | | | + +### 7.3.186 Adjacent-PLMNs + +The Adjacent-PLMNs AVP is of type Grouped. This AVP shall contain a list of PLMN IDs where an UE served by the MME/SGSN is likely to make a handover from the PLMN where the MME/SGSN is located. + +AVP format: + +Adjacent-PLMNs ::= + +1\*{ Visited-PLMN-Id } + +\*[AVP] + +### 7.3.187 Adjacent-Access-Restriction-Data + +The Adjacent-Access-Restriction-Data AVP is of type Grouped. This AVP shall contain a pair of PLMN ID and the associated Access Restriction Data for that PLMN. + +AVP format: + +Adjacent-Access-Restriction-Data ::= + +{ Visited-PLMN-Id } + +{ Access-Restriction-Data } + +\*[AVP] + +### 7.3.188 DL-Buffering-Suggested-Packet-Count + +The DL-Buffering-Suggested-Packet-Count AVP is of type Integer32. It shall indicate whether extended buffering of downlink packets at the SGW, for High Latency Communication, is requested or not. When requested, it may also suggest the number of downlink packets to buffer at the SGW for this user. + +The following values are defined: + +"Extended DL Data Buffering NOT REQUESTED" 0 + +"Extended DL Data Buffering REQUESTED, without a suggested number of packets" -1 + +"Extended DL Data Buffering REQUESTED, with a suggested number of packets" > 0 + +"Extended DL Data Buffering REQUESTED", with or without a suggested number of packets to be buffered for this user, indicates that extended buffering of downlink packets at the SGW is applicable to this user. + +"Extended DL Data Buffering NOT REQUESTED" indicates that extended buffering of downlink packets at the SGW is not applicable to this user. + +### 7.3.189 IMSI-Group-Id + +The IMSI-Group-Id AVP shall be of type Grouped. This AVP shall contain the information about the IMSI-Group-Id. + +AVP format + +IMSI-Group-Id ::= + +{ Group-Service-Id } +{ Group-PLMN-Id } +{ Local-Group-Id } +\*[AVP] + +For details see 3GPP TS 23.003 [3], clause 19.9). + +### 7.3.190 Group-Service-Id + +The Group-Service-Id AVP is of type Unsigned32 and it shall identify the specific service for which the IMSI-Group-Id is used. The following values are defined: + +**Table 7.3.190-1: Group-Service-Id** + +| Value | Description | +|-------|---------------------------------------------------------------------------| +| 1 | Group specific NAS level congestion control | +| 2 | Group specific Monitoring of Number of UEs present in a geographical area | + +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. + +### 7.3.191 Group-PLMN-Id + +The Group-PLMN-Id AVP is of type OctetString. This AVP shall contain the concatenation of MCC and MNC. See 3GPP TS 23.003 [3]. The content of this AVP shall be encoded as an octet string according to table 7.3.191-1. + +See 3GPP TS 24.008 [31], clause 10.5.1.13, PLMN list, for the coding of MCC and MNC. If MNC is 2 digits long, bits 5 to 8 of octet 2 are coded as "1111". + +**Table 7.3.191-1: Encoding format for Group-PLMN-Id AVP** + +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +|-------------|---|---|---|-------------|---|---|---|---------| +| MCC digit 2 | | | | MCC digit 1 | | | | octet 1 | +| MNC digit 3 | | | | MCC digit 3 | | | | octet 2 | +| MNC digit 2 | | | | MNC digit 1 | | | | octet 3 | + +### 7.3.192 Local-Group-Id + +The Local-Group-Id AVP is of type OctetString. It shall contain an operator defined value, representing a group. + +### 7.3.193 AESE-Communication-Pattern + +AESE-Communication-Pattern AVP is of type Grouped and is defined in 3GPP TS 29.336 [54]. + +AVP format + +AESE-Communication-Pattern ::= + +[ SCEF-Reference-ID ] +[ SCEF-Reference-ID-Ext ] +{ SCEF-ID } +\*[ SCEF-Reference-ID-for-Deletion ] +\*[ SCEF-Reference-ID-for-Deletion-Ext ] +\*[ Communication-Pattern-Set ] +[ MTC-Provider-Info ] +\*[AVP] + +At least one reference ID (either in SCEF-Reference-ID or in SCEF-Reference-ID-Ext) or a reference ID for deletion (either in SCEF-Reference-ID-for-Deletion or in SCEF-Reference-ID-for-Deletion-Ext) shall be present. + +When the "Extended Reference IDs" feature is supported by the HSS and MME/SGSN, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used insted of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. + +### 7.3.194 Communication-Pattern-Set + +Communication-Pattern-Set AVP is of type Grouped and is defined in 3GPP TS 29.336 [54]. + +AVP format + +Communication-Pattern-Set ::= + +[ Periodic-Communication-Indicator ] +[ Communication-Duration-Time ] +[ Periodic-Time ] +\*[ Scheduled-Communication-Time ] +[ Stationary-Indication ] +[ Reference-ID-Validity-Time ] +[ Traffic-Profile ] +[ Battery-Indicator ] +\*[AVP] + +If the Reference-ID-Validity-Time AVP is absent, it indicates that there is no expiration time defined for the Communication-Pattern-Set. + +### 7.3.195 Monitoring-Event-Configuration + +The Monitoring-Event-Configuration AVP is of type Grouped. It shall contain the Monitoring event configuration related subscription data. It is originally defined in 3GPP TS 29.336 [54]. + +For S6a/S6d interface, the Monitoring-Event-Configuration AVP format is specified as following: + +AVP format: + +Monitoring-Event-Configuration ::= + +``` + +[ SCEF-Reference-ID ] +[ SCEF-Reference-ID-Ext ] +{ SCEF-ID } +{ Monitoring-Type } +*[ SCEF-Reference-ID-for-Deletion ] +*[ SCEF-Reference-ID-for-Deletion-Ext ] +[ Maximum-Number-of-Reports ] +[ Monitoring-Duration ] +[ Charged-Party ] +[ UE-Reachability-Configuration ] +[ Location-Information-Configuration ] +[ SCEF-Realm ] +[ External-Identifier ] +[ MTC-Provider-Info ] +[ PDN-Connectivity-Status-Configuration ] +*[ AVP ] + +``` + +When the Monitoring-Event-Configuration AVP is used over the S6a/S6d interfaces, the SCEF-Realm AVP shall be present and its value shall be obtained by the HSS from the Origin-Realm AVP of the Configuration-Information-Request command conveying the corresponding monitoring event configuration over the S6t interface from the SCEF to the HSS. + +The Monitoring-Type AVP shall only be taken into account in combination with SCEF-Reference-ID/SCEF-Reference-ID-Ext AVP; Monitoring-Type AVP shall be ignored for deletion of an event (i.e. when SCEF-Reference-ID-for-Deletion/SCEF-Reference-ID-for-Deletion-Ext AVP is present). + +Maximum-Number-of-Reports shall not be present over S6a/S6d interfaces if Monitoring-Type is AVAILABILITY\_AFTER\_DDN\_FAILURE (6). + +Maximum-Number-of-Reports shall not be greater than one over S6a/S6d interfaces if Monitoring-Type is LOCATION\_REPORTING (2) and MONTE-Location-Type is LAST\_KNOWN\_LOCATION (1). + +When multiple External Identifiers are defined for the same subscription, the External-Identifier in this grouped AVP, if present, shall contain the specific External Identifier to be associated with this monitoring event; if it is not present, the External Identifier associated with this monitoring event shall be the default External Identifier defined in the subscription (see clause 7.3.2). + +When the "Extended Reference IDs" feature is supported by the HSS and MME/SGSN, the SCEF-Reference-ID-Ext and SCEF-Reference-ID-for-Deletion-Ext AVPs shall be used insted of SCEF-Reference-ID and SCEF-Reference-ID-for-Deletion respectively. + +### 7.3.196 Monitoring-Event-Report + +The Monitoring-Event-Report AVP is of type Grouped. It shall contain the Monitoring event report data. It is originally defined in 3GPP TS 29.336 [54]. + +For S6a/S6d interface, the Monitoring-Event-Report AVP format is specified as following: + +AVP format: + +``` +Monitoring Event Report ::= + { SCEF-Reference-ID } + [ SCEF-Reference-ID-Ext ] + [ SCEF-ID ] + [ Reachability-Information ] + [ Reachability-Cause ] + [ EPS-Location-Information ] + [ Monitoring-Type ] + [ Loss-Of-Connectivity-Reason ] + [ Idle-Status-Indication ] + [ Maximum-UE-Availability-Time ] + *[ PDN-Connectivity-Status-Report ] + *[ AVP ] +``` + +For S6a/S6d interface, when the Monitoring-Type AVP takes the value UE\_REACHABILITY (1), the Reachability-Information AVP shall take the value REACHABLE\_FOR\_DATA (1), and the Reachability-Cause AVP may be present. + +For S6a/S6d interface, when the Monitoring-Type AVP takes the value PDN\_CONNECTIVITY\_STATUS (10), the PDN-Connectivity-Status-Report AVP(s) shall contain the list of active PDNs, for the given APN provided in the monitoring event configuration, or for all APNs if no APN was provided; each PDN-Connectivity-Status-Report shall have the PDN-Connectivity-Status-Type set to value "CREATED (0)". + +When the "Extended Reference IDs" feature is supported by the HSS and MME/SGSN, the SCEF-Reference-ID-Ext AVP shall be used insted of SCEF-Reference-ID; in such case, the required AVP "SCEF-Reference-ID" shall be included in the grouped AVP by the sender, but its content shall be discarded by the receiver. + +### 7.3.197 UE-Reachability-Configuration + +The UE-Reachability-Configuration AVP is of type Grouped, and it shall contain the details for configuration for UE reachability. It is originally defined in 3GPP TS 29.336 [54]. + +For S6a/S6d interface, the UE-Reachability-Configuration AVP format is specified as following: + +AVP format: + +``` +UE-Reachability-Configuration ::= + [ Reachability-Type ] + [ Maximum-Response-Time ] + *[ AVP ] +``` + +NOTE: When a Maximum-Response-Time value is not received from the SCEF, the HSS can send an O&M configured desired active time value within the Maximum-Response-Time AVP. + +For S6a/S6d interface, the Reachability-Type AVP shall have bit 0 ("Reachability for SMS") cleared, and it shall have bit 1 ("Reachability for Data") set. + +### 7.3.198 eNodeB-ID + +The eNodeB-ID AVP is of type OctetString, and indicates the eNodeB in which the UE is currently located. It is originally defined in 3GPP TS 29.217 [56]. + +### 7.3.199 Supported-Services + +The Supported-Services AVP is of type Grouped and it shall contain the different bit masks representing the services supported by the MME/SGSN: + +AVP format + +``` +Supported-Services ::= + [ Supported-Monitoring-Events ] + *[AVP] +``` + +### 7.3.200 Supported-Monitoring-Events + +The Supported-Monitoring-Events AVP is of type Unsigned64 and it shall contain a bit mask. The meaning of the bits shall be as defined in table 7.3.200-1: + +**Table 7.3.200 -1: Supported-Monitoring-Events** + +| Bit | Name | Description | +|-------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 0 | UE and UICC and/or new IMSI-IMEI-SV association | only used on S6t interface | +| 1 | UE-reachability | This bit shall be set if UE reachability Monitoring event is supported in the MME/SGSN | +| 2 | Location-of-the-UE | This bit shall be set if Location of the UE and change in location of the UE Monitoring event is supported in the MME/SGSN | +| 3 | Loss-of-connectivity | This bit shall be set if Loss of connectivity Monitoring event is supported in the MME/SGSN | +| 4 | Communication-failure | This bit shall be set if Communication failure Monitoring event is supported in the MME/SGSN | +| 5 | Roaming-status | only used on S6t interface | +| 6 | Availability after DDN failure | This bit shall be set if Availability after DDN failure Monitoring event is supported in the MME/SGSN | +| 7 | Idle Status Indication | This bit shall be set if Idle Status Indication reporting is supported in the MME/SGSN | +| 8 | PDN Connectivity Status | This bit shall be set if PDN Connectivity Status monitoring event is supported in the MME/SGSN | +| NOTE: Bits not defined in this table shall be cleared by the sender and discarded by the receiver of the command. | | | + +### 7.3.201 AIR-Flags + +The AIR-Flags AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.201/1: + +**Table 7.3.201/1: AIR-Flags** + +| bit | name | Description | +|----------------------------------------------------------------------------------------------------------------------|--------------------|-------------------------------------------------------------------------------------------------------------------------| +| 0 | Send UE Usage Type | This bit, when set, indicates that the MME or SGSN requests the HSS to send the subscription parameter "UE Usage Type". | +| NOTE: Bits not defined in this table shall be cleared by the sending MME or SGSN and discarded by the receiving HSS. | | | + +### 7.3.202 UE-Usage-Type + +The UE-Usage-Type AVP is of type Unsigned32. This value shall indicate the usage characteristics of the UE that enables the selection of a specific Dedicated Core Network (DCN). See clause 4.3.25 of 3GPP TS 23.401 [2]. + +The allowed values of UE-Usage-Type shall be in the range of 0 to 255. + +Values in the range of 0 to 127 are standardized and defined as follows: + +0: Spare, for future use + +... + +127: Spare, for future use + +Values in the range of 128 to 255 are operator-specific. + +### 7.3.203 DRMP + +The DRMP AVP is of type Enumerated and it is defined in IETF RFC 7944 [57]. This AVP allows the HSS, the CSS, the EIR and the MME/SGSN to indicate the relative priority of Diameter messages. The DRMP AVP may be used to set the DSCP marking for transport of the associated Diameter message. + +### 7.3.204 Non-IP-PDN-Type-Indicator + +The Non-IP-PDN-Type-Indicator AVP is of type Enumerated and indicates whether the APN has a Non-IP PDN type. + +The following values are defined: + +FALSE (0) + +This value indicates that the APN does not have a Non-IP PDN type. + +TRUE (1) + +This value indicates that the APN has a Non-IP PDN type and, in this case, the value indicated by the PDN-Type AVP inside APN-Configuration AVP shall be ignored. + +The default value when this AVP is not present is FALSE (0). + +### 7.3.205 Non-IP-Data-Delivery-Mechanism + +The Non-IP-Data-Delivery-Mechanism AVP is of type Unsigned32 and indicates the mechanism to be used for Non-IP data delivery for a given APN. The following values are defined: + +SGI-BASED-DATA-DELIVERY (0) + +This value indicates that the Non-IP data is delivered via Point-To-Point tunnelling over the SGI interface. + +SCEF-BASED-DATA-DELIVERY (1) + +This value indicates that the Non-IP data is delivered via the SCEF. + +The default value when this AVP is not present is SGI-BASED-DATA-DELIVERY (0). + +### 7.3.206 Additional-Context-Identifier + +The Additional-Context-Identifier AVP is of type Unsigned32 and indicates the identity of another default APN to be used when the subscription profile of the user contains APNs with more than one PDN type among IP-based PDN types, non-IP PDN types and Ethernet PDN types. + +### 7.3.207 SCEF-Realm + +The SCEF-Realm AVP is of type DiameterIdentity and it shall contain the Diameter realm of the SCEF. For further details on the encoding of this AVP, see IETF RFC 6733 [61]. + +### 7.3.208 Subscription-Data-Deletion + +The Subscription-Data-Deletion AVP is of type Grouped and indicates the shared subscription data that need to be deleted from the subscription profiles of the impacted subscribers. + +AVP format + +Subscription-Data-Deletion ::= + +``` +{ DSR-Flags } +[ SCEF-ID ] +*[ Context-Identifier ] +[ Trace-Reference ] +*[ TS-Code ] +*[ SS-Code ] +*[ AVP ] +``` + +### 7.3.209 Preferred-Data-Mode + +The Preferred-Data-Mode AVP is of type Unsigned32 and it shall contain a bitmask. The meaning of the bits is defined in table 7.3.209/1: + +**Table 7.3.209/1: Preferred-Data-Mode** + +| bit | name | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 0 | Data over User Plane Preferred | This bit, when set, shall indicate that the User Plane is preferred for transmitting the traffic associated with the APN. If not set, it means that the User Plane is not preferred for transmitting the traffic associated with the APN. | +| 1 | Data over Control Plane Preferred | This bit, when set, shall indicate that the Control Plane is preferred for transmitting the traffic associated with the APN. If not set, it means that the Control Plane is not preferred for transmitting the traffic associated with the APN. | +| NOTE 1: Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME.
NOTE 2: At least one of the bits 0 and 1 shall be set to 1. Both bits 0 and 1 may be set to 1 to indicate that both User Plane and Control Plane are preferred for transmitting the traffic associated with the APN.
NOTE 3: This parameter only applies to E-UTRAN and SGi PDN connections. Data over User Plane refers to PDN data transported over S1-U and Data Radio Bearer. Data over Control Plane refers to PDN data transported over NAS and Signalling Radio Bearer. | | | + +### 7.3.210 Emergency-Info + +The Emergency-Info AVP is of type Grouped. It shall contain the identity of the PDN-GW used for the establishment of emergency PDN connections. + +The AVP format shall conform to: + +Emergency-Info ::= + +[ MIP6-Agent-Info ] + \*[ AVP ] + +### 7.3.211 Load + +The Load AVP is of type Grouped and it is defined in IETF RFC 8583 [60]. This AVP is used to support Diameter load control mechanism, see Annex F for more information. + +### 7.3.212 V2X-Subscription-Data + +The V2X-Subscription-Data AVP is of type Grouped. It shall contain the V2X related subscription data for the network scheduled LTE sidelink communication.. + +AVP format: + +V2X-Subscription-Data ::= + [ V2X-Permission ] + [ UE-PC5-AMBR ] + \*[AVP] + +The UE-PC5-AMBR AVP within the V2X-Subscription-Data AVP indicates the UE AMBR used for LTE PC5 interface. + +### 7.3.213 V2X-Permission + +The V2X-Permission AVP is of type Unsigned32 and it shall contain a bit mask that indicates the permissions for V2X service subscribed by the user. The meaning of the bits shall be as defined in table 7.3.x2-1: + +**Table 7.3.x2-1: V2X-Permission** + +| Bit | Name | Description | +|--------------------------------------------------------------------------------------------|---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------| +| 0 | Allow V2X communication over PC5 as Vehicle UE | This bit, when set, indicates that the user is allowed to use V2X communication over PC5 as Vehicle UE in the serving PLMN. | +| 1 | Allow V2X communication over PC5 as Pedestrian UE | This bit, when set, indicates that the user is allowed to use V2X communication over PC5 as Pedestrian UE in the serving PLMN. | +| NOTE: Bits not defined in this table shall be cleared by the HSS and discarded by the MME. | | | + +### 7.3.214 PDN-Connection-Continuity + +The PDN-Connection-Continuity AVP is of type Unsigned32 and indicates how to handle the PDN connection when the UE moves between "broadband" (WB-E-UTRAN, UTRAN) and "narrowband" (NB-IoT, GPRS, EC-GSM-IoT). The following values are defined: + +MAINTAIN-PDN-CONNECTION (0) + +DISCONNECT-PDN-CONNECTION-WITH-REACTIVATION-REQUEST (1) + +DISCONNECT-PDN-CONNECTION-WITHOUT-REACTIVATION-REQUEST (2) + +This AVP corresponds to the "PDN continuity at inter RAT mobility" field as defined in 3GPP TS 23.401 [2] table 5.7.1-1. + +### 7.3.215 eDRX-Cycle-Length + +The eDRX-Cycle-Length AVP is of type Grouped. This AVP shall contain an eDRX cycle length, along with the RAT type for which this cycle length is applicable to (e.g. E-UTRAN and NB-IOT). + +AVP format: + +``` +eDRX-Cycle-Length ::= + { RAT-Type } + { eDRX-Cycle-Length-Value } + *[ AVP ] +``` + +### 7.3.216 eDRX-Cycle-Length-Value + +The eDRX-Cycle-Length-Value AVP is of type OctetString. This AVP shall contain the extended DRX cycle value subscribed for this user for a given RAT type. The contents of eDRX-Cycle-Length-Value shall consist of 1 octet. + +The encoding shall be as defined in 3GPP TS 24.008 [31], clause 10.5.5.32, and it shall only contain the value of the field "eDRX value" for a given RAT type, i.e., the 4 least significant bits of the octet in this AVP shall contain bits 1-4 of octet 3 in the "Extended DRX parameter" IE (see Figure 10.5.5.32 of 3GPP TS 24.008 [31]), and the 4 most significant bits of the octet in this AVP shall be set to 0. + +### 7.3.217 UE-PC5-AMBR + +The UE-PC5-AMBR AVP is of type Unsigned32. It indicates the maximum bits delivered by UE over the PC5 interface within a period of time. The unit of UE-PC5-AMBR is bits/s. + +### 7.3.218 Extended eNodeB-ID + +The Extended eNodeB-ID AVP is of type OctetString, and indicates the eNodeB in which the UE is currently located. It is originally defined in 3GPP TS 29.217 [56]. + +### 7.3.219 MBSFN-Area + +The MBSFN-Area AVP is of type Grouped. It contains a MBSFN Area ID and a Carrier Frequency (see 3GPP TS 32.422 [23]). + +The AVP format shall conform to: + +``` +MBSFN-Area ::= + [ MBSFN-Area-ID ] + [ Carrier-Frequency ] + *[ AVP ] +``` + +If both MBSFN-Area-ID and Carrier-Frequency values are present, a specific MBSFN area is indicated. If Carrier-Frequency value is present, but MBSFN-Area-ID is absent, all MBSFN areas on that carrier frequency are indicated. If both MBSFN-Area-ID and Carrier-Frequency are absent, any MBSFN area is indicated. + +### 7.3.220 MBSFN-Area-ID + +The MBSFN-Area-ID AVP is of type Unsigned32 and it shall contain the MBSFN Area ID value, in the range of 0..255 (see 3GPP TS 36.331 [62]). + +### 7.3.221 Carrier-Frequency + +The Carrier-Frequency AVP is of type Unsigned32 and it shall contain the Carrier Frequency value, in the range of 0..262143 (see 3GPP TS 36.331 [62]). + +### 7.3.222 RDS-Indicator + +The RDS-Indicator AVP is of type Enumerated and indicates whether the Reliable Data Service (RDS) is enabled or disabled for the APN. See 3GPP TS 23.682 [55]. + +The following values are defined: + +DISABLED (0) + +ENABLED (1) + +The default value when this AVP is not present is DISABLED (0). + +### 7.3.223 Service-Gap-Time + +The Service-Gap-Time AVP is of type Unsigned32 and indicates the minimum number of seconds during which the UE shall stay in ECM-IDLE mode, after leaving the ECM-CONNECTED mode, before being allowed to send a subsequent connection request to enter ECM-CONNECTED mode again. See description of the Service Gap Control feature in 3GPP TS 23.401 [2]. + +### 7.3.224 Aerial-UE-Subscription-Information + +The Aerial-UE-Subscription-Information AVP is of type Unsigned32 and indicates the subscription of Aerial UE function. The following values are defined: + +AERIAL\_UE\_ALLOWED (0) + +AERIAL\_UE\_NOT\_ALLOWED (1) + +This AVP corresponds to the "Aerial UE subscription information" information element as defined in 3GPP TS 36.413[19] and TS 36.423 [65]. + +### 7.3.225 Broadcast-Location-Assistance-Data-Types + +The Broadcast-Location-Assistance-Data-Types AVP is of type Unsigned64. The content of this AVP is a bit mask which indicates the broadcast location assistance data types for which the UE is subscribed to receive ciphering keys used to decipher broadcast assistance data. + +The meaning of the bits is defined in table 7.3.225-1: + +**Table 7.3.225-1: Broadcast-Location-Assistance-Data-Types** + +| bit | name | Description | +|-----|---------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 0 | Positioning SIB Type 1-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-1. | +| 1 | Positioning SIB Type 1-2 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-2. | +| 2 | Positioning SIB Type 1-3 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-3. | +| 3 | Positioning SIB Type 1-4 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-4. | +| 4 | Positioning SIB Type 1-5 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-5. | +| 5 | Positioning SIB Type 1-6 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-6. | +| 6 | Positioning SIB Type 1-7 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-7. | +| 7 | Positioning SIB Type 2-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-1. | +| 8 | Positioning SIB Type 2-2 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-2. | +| 9 | Positioning SIB Type 2-3 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-3. | +| 10 | Positioning SIB Type 2-4 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-4. | +| 11 | Positioning SIB Type 2-5 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-5. | +| 12 | Positioning SIB Type 2-6 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-6. | +| 13 | Positioning SIB Type 2-7 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-7. | +| 14 | Positioning SIB Type 2-8 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-8. | +| 15 | Positioning SIB Type 2-9 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-9. | +| 16 | Positioning SIB Type 2-10 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-10. | +| 17 | Positioning SIB Type 2-11 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-11. | +| 18 | Positioning SIB Type 2-12 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-12. | +| 19 | Positioning SIB Type 2-13 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-13. | +| 20 | Positioning SIB Type 2-14 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-14. | +| 21 | Positioning SIB Type 2-15 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-15. | +| 22 | Positioning SIB Type 2-16 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-16. | +| 23 | Positioning SIB Type 2-17 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-17. | +| 24 | Positioning SIB Type 2-18 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-18. | +| 25 | Positioning SIB Type 2-19 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-19. | +| 26 | Positioning SIB Type 3-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 3-1. | +| 27 | Positioning SIB Type 1-8 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 1-8. | +| 28 | Positioning SIB Type 2-20 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-20. | +| 29 | Positioning SIB Type 2-21 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-21. | +| 30 | Positioning SIB Type 2-22 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-22. | +| 31 | Positioning SIB Type 2-23 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-23. | +| 32 | Positioning SIB Type 2-24 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-24. | + +| | | | +|-------|----------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------| +| 33 | Positioning SIB Type 2-25 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 2-25. | +| 34 | Positioning SIB Type 4-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 4-1. | +| 35 | Positioning SIB Type 5-1 | This bit, when set, indicates that the UE is subscribed to receive ciphering keys applicable to positioning SIB Type 5-1. | +| NOTE: | Bits not defined in this table shall be cleared by the sending HSS and discarded by the receiving MME or SGSN. | | + +### 7.3.226 Paging-Time-Window + +The Paging-Time-Window AVP is of type Grouped. This AVP shall contain the Paging Time Window length, along with the Operation Mode (see clause 7.3.227) for which this time window length is applicable to. + +AVP format: + +``` +Paging-Time-Window ::= + { Operation-Mode } + { Paging-Time-Window-Length } + *[ AVP ] +``` + +### 7.3.227 Operation-Mode + +The Operation-Mode AVP is of type Unsigned32. This value shall indicate the operation mode for which the Paging-Time-Window-Length applies. See clause 3GPP TS 24.008 [31], clause 10.5.5.32. + +The allowed values of Operation-Mode shall be in the range of 0 to 255. + +Values are defined as follows: + +- 0: Spare, for future use +- 1: Iu mode +- 2: WB-S1 mode +- 3: NB-S1 mode +- 4 to 255: Spare, for future use + +### 7.3.228 Paging-Time-Window-Length + +The Paging-Time-Window-Length AVP is of type OctetString. This AVP shall contain the Paging time window length subscribed for this user for a given operation mode. The contents of Paging-Time-Window-Length shall consist of 1 octet. + +The encoding shall be as defined in 3GPP TS 24.008 [31], clause 10.5.5.32, and it shall only contain the value of the field "Paging Time Window length" for a given RAT type, i.e., the 4 most significant bits of the octet in this AVP shall contain bits 5-8 of octet 3 in the "Extended DRX parameter" IE (see Figure 10.5.5.32 of 3GPP TS 24.008 [31]), and the 4 least significant bits of the octet in this AVP shall be set to 0. + +### 7.3.229 eDRX-Related-RAT + +The eDRX-Related-RAT AVP is of type Grouped. This AVP shall contain the RAT type to which the eDRX Cycle Length is related: + +AVP format + +``` +eDRX-Related-RAT ::= +``` + +1 \* { RAT-Type } + \*[AVP] + +### 7.3.230 Core-Network-Restrictions + +The Core-Network-Restrictions AVP is of type Unsigned32 and shall contain a bitmask indicating the types of Core Network that are disallowed for a given user. The meaning of the bits shall be as defined in table 7.3.230-1: + +**Table 7.3.230-1: Core-Network-Restrictions** + +| Bit | Name | Description | +|-------|--------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------| +| 0 | Reserved | The use of this bit is deprecated. This bit shall be discarded by the receiving MME. | +| 1 | 5GC not allowed | Access to 5GC not allowed. | +| NOTE: | Bits not defined in this table shall be cleared by the HSS and discarded by the MME. | | + +### 7.3.231 Interworking-5GS-Indicator + +The Interworking-5GS-Indicator AVP is of type Enumerated and indicates whether the interworking between 5GS and EPS is subscribed or not subscribed for the APN. See 3GPP TS 23.502 [67]. + +The following values are defined: + +NOT-SUBSCRIBED (0) + +SUBSCRIBED (1) + +The default value when this AVP is not present is NOT-SUBSCRIBED (0). + +### 7.3.232 Ethernet-PDN-Type-Indicator + +The Ethernet-PDN-Type-Indicator AVP is of type Enumerated and indicates whether the APN has an Ethernet PDN type. + +The following values are defined: + +FALSE (0) + +This value indicates that the APN does not have an Ethernet PDN type. + +TRUE (1) + +This value indicates that the APN has an Ethernet PDN type and in this case the value indicated by the PDN-Type AVP inside APN-Configuration AVP shall be ignored. + +The default value when this AVP is not present is FALSE (0). + +### 7.3.233 Subscribed-ARPI + +The Subscribed-ARPI AVP is of type Unsigned32 and shall contain the subscribed value of the Additional RRM Policy Index. For details, see 3GPP TS 23.401 [2]. + +### 7.3.234 IAB-Operation-Permission + +The IAB-Operation-Permission AVP is of type Enumerated. It shall indicate to the MME or SGSN whether the UE is allowed for IAB operation. See 3GPP TS 23.401 [2]. + +The following values are defined: + +IAB\_OPERATION\_ALLOWED (0) + +IAB\_OPERATION\_NOTALLOWED (1) + +### 7.3.235 V2X-Subscription-Data-Nr + +The V2X-Subscription-Data-Nr AVP is of type Grouped. It shall contain the V2X related subscription data for the network scheduled NR sidelink communication. + +AVP format: + +``` +V2X-Subscription-Data-Nr ::= + [ V2X-Permission ] + [ UE-PC5-AMBR ] + [ UE-PC5-QoS ] + *[AVP] +``` + +The UE-PC5-AMBR AVP within the V2X-Subscription-Data AVP indicates the UE AMBR used for NR PC5 interface. + +### 7.3.236 UE-PC5-QoS + +The UE-PC5-QoS AVP is of type Grouped. It shall contain the PC5 QoS parameters for V2X communication over NR PC5 reference point. + +AVP format: + +``` +UE-PC5-QoS ::= + 1*{ PC5-QoS-Flow } + [ PC5-Link-AMBR ] + *[AVP] +``` + +### 7.3.237 PC5-QoS-Flow + +The PC5-QoS-Flow AVP is of type Grouped. It shall contain the QoS parameters for a PC5 flow. + +AVP format: + +``` +PC5-QoS-Flow ::= + { 5QI } + [ PC5-Flow-Bitrates ] + [ PC5-Range ] + *[AVP] +``` + +### 7.3.238 5QI + +The 5QI AVP is of type Integer32. It shall contain the 5QI. See 3GPP TS 23.501 [69] for allowed values. If the 5QI is used in PC5 QoS parameter, it shall contain PQI, PQI is a special 5QI (see clause 5.4.2.1 of 3GPP TS 23.287 [68]). + +### 7.3.239 PC5-Flow-Bitrates + +The PC5-Flow-Bitrates AVP is of type Grouped. It shall contain the PC5 Flow Bit Rates, it's for GBR QoS Flows only. + +AVP format: + +PC5-Flow-Bitrates ::= + +[ Guaranteed-Flow-Bitrates ] + +[ Maximum-Flow-Bitrates ] + +### 7.3.240 Guaranteed-Flow-Bitrates + +The Guaranteed-Flow-Bitrates AVP is of type Integer32. It indicates the guaranteed bits delivered for the PC5 QoS flow by UE over the PC5 interface within a period of time. The unit of Guaranteed-Flow-Bitrates is bits/s. + +### 7.3.241 Maximum-Flow-Bitrates + +The Maximum-Flow-Bitrates AVP is of type Integer32. It indicates the maximum bits delivered for the PC5 QoS flow by UE over the PC5 interface within a period of time. The unit of Maximum-Flow-Bitrates is bits/s. + +### 7.3.242 PC5-Range + +The PC5-Range AVP is of type Integer32. It indicates the Range in the unit of meters. See clause 5.4.2.4 of 3GPP TS 23.287 [68]. + +### 7.3.243 PC5-Link-AMBR + +The PC5-Link-AMBR AVP is of type Integer32. It indicates the PC5 Link Aggregated Bit Rates for all the Non-GBR QoS Flows. The unit of PC5-Link-AMBR is bits/s. + +### 7.3.244 Third-Context-Identifier + +The Third-Context-Identifier AVP is of type Unsigned32 and indicates the identity of another default APN to be used when the subscription profile of the user contains APNs with three PDN types, i.e. IP-based PDN types, non-IP PDN types and Ethernet PDN types. + +## 7.4 Result-Code and Experimental-Result Values + +### 7.4.1 General + +This clause defines result code values that shall be supported by all Diameter implementations that conform to this specification. + +### 7.4.2 Success + +Result codes that fall within the Success category shall be used to inform a peer that a request has been successfully completed. The Result-Code AVP values defined in the Diameter base protocol IETF RFC 6733 [61] shall be applied. + +### 7.4.3 Permanent Failures + +Errors that fall within the Permanent Failures category shall be used to inform the peer that the request has failed, and should not be attempted again. The Result-Code AVP values defined in the Diameter base protocol IETF RFC 6733 [61] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 7.4.3.1 DIAMETER\_ERROR\_USER\_UNKNOWN (5001) + +This result code shall be sent by the HSS to indicate that the user identified by the IMSI is unknown + +#### 7.4.3.2 DIAMETER\_ERROR\_UNKNOWN\_EPS\_SUBSCRIPTION (5420) + +This result code shall be sent by the HSS to indicate that no EPS subscription is associated with the IMSI. + +#### 7.4.3.3 DIAMETER\_ERROR\_RAT\_NOT\_ALLOWED (5421) + +This result code shall be sent by the HSS to indicate the RAT type the UE is using is not allowed for the IMSI. + +#### 7.4.3.4 DIAMETER\_ERROR\_ROAMING\_NOT\_ALLOWED (5004) + +This result code shall be sent by the HSS to indicate that the subscriber is not allowed to roam within the MME or SGSN area. + +#### 7.4.3.5 DIAMETER\_ERROR\_EQUIPMENT\_UNKNOWN (5422) + +This result code shall be sent by the EIR to indicate that the mobile equipment is not known in the EIR. + +#### 7.4.3.6 DIAMETER\_ERROR\_UNKNOWN\_SERVING\_NODE (5423) + +This result code shall be sent by the HSS to indicate that a Notify command has been received from a serving node which is not registered in HSS as the node currently serving the user. + +### 7.4.4 Transient Failures + +Result codes that fall within the transient failures category shall be 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 the Diameter base protocol IETF RFC 6733 [61] shall be applied. When one of the result codes defined here is included in a response, it shall be inside an Experimental-Result AVP and the Result-Code AVP shall be absent. + +#### 7.4.4.1 DIAMETER\_AUTHENTICATION\_DATA\_UNAVAILABLE (4181) + +This result code shall be sent by the HSS to indicate that an unexpectedly transient failure occurs. The requesting node can try the request again in the future. + +#### 7.4.4.2 DIAMETER\_ERROR\_CAMEL\_SUBSCRIPTION\_PRESENT (4182) + +This result code shall be sent by the HSS to indicate that the subscriber to be registered has SGSN CAMEL Subscription data. + +--- + +## 8 User identity to HSS resolution + +The User identity to HSS resolution mechanism enables the MME, SGSN (for non-roaming case) or Diameter Relay/proxy agents in the home network (for roaming case) to find the identity of the HSS that holds the subscriber data for a given user identity when multiple and separately addressable HSSs have been deployed in the home network. The resolution mechanism is not required in networks that utilise a single HSS. + +This User identity to HSS resolution mechanism may rely on routing capabilities provided by Diameter and be implemented in the home operator network within dedicated Diameter Agents (Redirect Agents or Proxy Agents) responsible for determining the HSS identity based on the provided user identity. If this Diameter based implementation is selected by the Home network operator, the principles described below shall apply. + +In non-roaming case, in networks where more than one independently addressable HSS are deployed in the home network, each MME and SGSN shall be configured with the address/identity of a Diameter Agent (Redirect Agent or Proxy Agent) implementing this resolution mechanism. + +For support of roaming case, Diameter Relay agents and/or Diameter Proxy agents in the home network receiving the Diameter signalling from visited networks shall be configured with the address/identity of a Diameter Agent (Redirect Agent or Proxy Agent) implementing this resolution mechanism. + +To get the HSS identity that holds the subscriber data for a given user identity in the home network, the Diameter request normally destined to the HSS shall be sent to a pre-configured address/identity of a Diameter agent supporting the User identity to HSS resolution mechanism. + +- If this Diameter request is received by a Diameter Redirect Agent, the Diameter Redirect Agent shall determine the HSS identity based on the provided user identity and shall return a notification of redirection towards the HSS identity, in response to the Diameter request. Multiple HSS identities may be included in the response, as specified in IETF RFC 6733 [61]. In such a case, the requesting Diameter entity shall send the Diameter request to the first HSS identity in the ordered list received in the Diameter response from the Diameter Redirect Agent. If no successful response to the Diameter request is received, the requesting Diameter entity shall send a Diameter request to the next HSS identity in the ordered list. This procedure shall be repeated until a successful response from an HSS is received. After the user identity to HSS resolution, the MME or the SGSN shall store the determined HSS identity/name/Realm and shall use it in further Diameter requests to the same user identity. +- If this Diameter request is received by a Diameter Proxy Agent, the Diameter Proxy Agent shall determine the HSS identity based on the provided user identity and - if the Diameter load control mechanism is supported (see IETF RFC 8583 [60]) - optionally also based on previously received load values from Load AVPs of type HOST. The Diameter Proxy Agent shall then forward the Diameter request directly to the determined HSS. In this case, the user identity to HSS resolution decision is communicated to the MME/SGSN in the Origin-Host/Origin-Realm AVPs of the response. The MME or the SGSN may store the determined HSS identity/name/Realm and may use it in further Diameter requests to the same user identity. + +In roaming case, whereas a Diameter Relay Agent is stateless, a stateful Diameter Proxy Agent in the home network may store the determined HSS identity/name/Realm and use it in further Diameter requests associated to the same user identity. + +NOTE: Alternatives to the user identity to HSS resolution Diameter based implementation are outside the scope of this specification. + +--- + +## Annex A (normative): MME mapping table for S6a and NAS Cause Code values + +When the UE initiates Attach, Tracking Area Update or Service Request, there may be the need for the MME to communicate with the HSS via S6a to retrieve authentication data and/or subscription data. If this retrieval is rejected by the HSS, the received Diameter-Result-Code values or Experimental-Result values need to be mapped to appropriate cause codes over NAS to the UE. + +This mapping shall be as shown in Table A.1. + +If the retrieval is successful, not needed (e.g. because data are already available) or not possible (e.g. because HSS is unavailable or overloaded), detected error conditions need to be mapped to appropriate cause codes over NAS to the UE. + +This mapping shall be as shown in Table A.2. + +**Table A.1: Mapping from S6a error code to NAS Cause Code values** + +| Reject indication received at MME over S6a | NAS Cause Code sent to UE | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| DIAMETER_ERROR_USER_UNKNOWN (5001) | #8 "EPS services and non-EPS services not allowed" | +| DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION (5420) without Error Diagnostic, or with Error Diagnostic of GPRS_DATA_SUBSCRIBED | #15 "No suitable cells in tracking area" | +| DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION (5420) with Error Diagnostic of NO_GPRS_DATA_SUBSCRIBED | #7 "EPS services not allowed" | +| DIAMETER_ERROR_RAT_NOT_ALLOWED (5421) | #15 "No suitable cells in tracking area", or
#13 "Roaming not allowed in this tracking area", or
#12 "Tracking area not allowed"
(NOTE 1) | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), without Error Diagnostic | #11 "PLMN not allowed" | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), with Error Diagnostic of ODB_HPLMN_APN or ODB_VPLMN_APN | #14 "EPS services not allowed in this PLMN" | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), with Error Diagnostic of ODB_ALL_APN | #15 "No suitable cells in tracking area" | +| DIAMETER_AUTHORIZATION_REJECTED (5003)
DIAMETER_UNABLE_TO_DELIVER (3002)
DIAMETER_REALM_NOT_SERVED (3003) | #15 "No suitable cells in tracking area", or
#17 "Network failure", or
#42 "Severe network failure"
(NOTE 1) | +| DIAMETER_UNABLE_TO_COMPLY (5012),
DIAMETER_INVALID_AVP_VALUE (5004)
DIAMETER_AVP_UNSUPPORTED (5001)
DIAMETER_MISSING_AVP (5005)
DIAMETER_RESOURCES_EXCEEDED (5006)
DIAMETER_AVP_OCCURS_TOO_MANY_TIMES (5009)
DIAMETER_AUTHENTICATION_DATA_UNAVAILABLE (4181)
(NOTE 2) | #17 "Network failure" or #42 "Severe network failure"
(NOTE 1) | +| NOTE 1: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice.
NOTE 2: Any other permanent errors from the Diameter base protocol as defined in IETF RFC 6733 [61], not listed here, should be mapped to NAS Cause Code #17 "Network failure". | | + +**Table A.2: Mapping from detected error condition to NAS Cause Code values** + +| Condition | NAS cause code sent to UE | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| The MME receives a SGsAP-LOCATION-UPDATE-REJECT message from the VLR indicating in the reject cause "IMSI unknown in HLR" or if the UE has packet only subscription. Only used in the Combined Tracking and Location Area Update procedure. | #2 "IMSI Unknown in HSS" | +| The MME receives in Update-Location-Answer message an indication of Roaming restricted in MME due to unsupported feature | #14 "EPS services not allowed in this PLMN" | +| The MME cannot service an UE generated request because CS domain is not available and SMS in MME is not supported. | #18 "CS domain not available" | +| The value OPERATOR_DETERMINED_BARRING is received in the Subscriber-Status AVP | #15 "No suitable cells in tracking area" | +| The HSS indicates that due to subscription to a "regionally restricted service" the UE is not allowed to operate in the tracking area. | #12 "Tracking area not allowed" | +| The CSG ID of the cell from where the UE has sent the TRACKING AREA UPDATE REQUEST message is not contained in the Allowed CSG list. | #25 "Not authorized for this CSG" | +| The MME detects that it cannot communicate with the HSS in the HPLMN of the subscriber. How the MME detect this is implementation specific. | #15 "No suitable cells in tracking area"
#14 "EPS services not allowed in this PLMN"
#111 "Protocol error, unspecified"

NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice / configuration, e.g. NAS Cause Code #14 is to be sent to the UE if the network is an LTE only network. | +| The MME detects by internal configuration that roaming is not allowed. | #11 "PLMN not allowed" | +| The MME detects that it cannot send a request to the HSS due to HSS overload (see Annex C). | #22 "Congestion"
#42 "Severe network failure"

NOTE 1: Cause #22 should be used. In addition, the MME may ask the UE not to retry before a backoff timer expires, based on an operator policy. The eventual timer value may take into account the value received in the corresponding active overload report and operator policy.

NOTE 2: Cause #42 may be used, for attach requests, in case of severe overload, according to operator policy. | + +## Annex B(normative): SGSN mapping table for S6d and NAS Cause Code values + +When the UE initiates Attach, Routing Area Update or Service Request, there may be the need for the SGSN to communicate with the HSS via S6d to retrieve authentication data and/or subscription data. If this retrieval is rejected by the HSS, the received Diameter-Result-Code values or Experimental-Result values need to be mapped to appropriate cause codes over NAS to the UE. + +NOTE: Mapping from MAP Gr error codes to NAS Cause Code values is described in the 3GPP TS 29.010 [45]. + +This mapping shall be as shown in Table B.1. + +If the retrieval is successful, not needed (e.g. because data are already available) or not possible (e.g. because HSS is unavailable or overloaded), detected error conditions need to be mapped to appropriate cause codes over NAS to the UE. + +This mapping shall be as shown in Table and B.2. + +**Table B.1: Mapping from S6d error code to NAS Cause Code values** + +| Reject indication received at SGSN over S6d | NAS Cause Code sent to UE | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| DIAMETER_ERROR_USER_UNKNOWN (5001) | #8 "GPRS services and non-GPRS services not allowed" | +| DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION (5420) | #7 "GPRS services not allowed" | +| DIAMETER_ERROR_RAT_NOT_ALLOWED (5421) | #15 "No suitable cells in location area", or
#13 "Roaming not allowed in this location area", or
#12 "Location area not allowed"
(NOTE 1) | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004)
, without Error Diagnostic | #11 "PLMN not allowed" | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), with Error Diagnostic of ODB_HPLMN_APN or ODB_VPLMN_APN | #14 "GPRS services not allowed in this PLMN" | +| DIAMETER_ERROR_ROAMING_NOT_ALLOWED (5004), with Error Diagnostic of ODB_ALL_APN | #15 "No suitable cells in location area" | +| DIAMETER_AUTHORIZATION_REJECTED (5003)
DIAMETER_UNABLE_TO_DELIVER (3002) | #15 "No suitable cells in location area" | +| DIAMETER_UNABLE_TO_COMPLY (5012),
DIAMETER_INVALID_AVP_VALUE (5004)
DIAMETER_AUTHENTICATION_DATA_UNAVAILABLE (4181) and no retry takes place
(NOTE 2) | #17 "Network failure" | + +NOTE 1: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice. +NOTE 2: Any other permanent errors from the Diameter base protocol as defined in IETF RFC 6733 [61], not listed here, should be also mapped to NAS Cause Code #17 "Network failure". + +**Table B.2: Mapping from detected error condition to NAS Cause Code values** + +| Condition | NAS cause code to UE | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| The SGSN receives a BSSAP+-LOCATION-UPDATE-REJECT message from the VLR indicating in the reject cause "IMSI unknown in HLR" or if the UE has packet only subscription. Only used in the Combined Routing and Location Area Update procedure. | #2 "IMSI Unknown in HLR" | +| The SGSN receives in Update-Location-Answer message an indication of Roaming restricted in SGSN due to unsupported feature | #14 "GPRS services not allowed in this PLMN" | +| The value OPERATOR_DETERMINED_BARRING is received in the Subscriber-Status AVP | #15 "No suitable cells in routing area" | +| The HLR indicates that due to subscription to a "regionally restricted service" the MS is not allowed to operate in the location area. | #12 "Location area not allowed" | +| The CSG ID of the cell from where the UE has sent the ROUTING AREA UPDATE REQUEST message is not contained in the Allowed CSG list. | #25 "Not authorized for this CSG" | +| The SGSN indicates that the MS has requested "SMS-only services" and the SMS services are provided by the SGSN in the PS domain. | #28 "SMS provided via GPRS in this routing area" | +| The SGSN detects that it cannot communicate with the HLR in the HPLMN of the subscriber. How the SGSN detect this is implementation specific. | #15 "No suitable cells in routing area"
#14 "GPRS services not allowed in this PLMN"

NOTE: Any of those NAS Cause Code values may be sent to the UE, depending on operator's choice / configuration, e.g. NAS Cause Code #14 is to be sent to the UE if the network is an LTE only network. | +| The SGSN detects by internal configuration that roaming is not allowed. | #11 "PLMN not allowed" | +| The SGSN detects that it cannot send a request to the HSS due to HSS overload (see Annex C). | #22 "Congestion".

In addition, the MME may ask the UE not to retry before a backoff timer expires, based on an operator policy. The eventual timer value may take into account the value received in the corresponding active overload report and operator policy. | + +--- + +## Annex C (normative): Diameter overload control mechanism + +### C.1 General + +IETF RFC 7683 [50] specifies a Diameter overload control mechanism which includes the definition and the transfer of related AVPs between Diameter nodes. + +Depending on regional/national requirements and network operator policy, priority traffic (e.g. MPS as described in 3GPP TS 22.153 [52]) 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. + +--- + +### C.2 S6a/S6d interfaces + +#### C.2.1 General + +Diameter overload control mechanism is an optional feature. + +It is recommended to make use of IETF RFC 7683 [50] on the S6a/S6d interfaces where, when applied, the MME or the SGSN shall behave as reacting nodes and the HSS as a reporting node. + +#### C.2.2 HSS behaviour + +The HSS requests traffic reduction from its clients when the HSS is in an overload situation, including OC-OLR AVP in answer commands as described in IETF RFC 7683 [50]. + +The HSS identifies that it is in an overload situation by implementation specific means. For example, the HSS may take into account the traffic over the S6a/d interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources, etc. + +The HSS determines the specific contents of OC-OLR AVP in overload reports and the HSS decides when to send OC-OLR AVPs by implementation specific means. + +#### C.2.3 MME/SGSN behaviour + +The MME/SGSN applies required traffic reduction received in answer commands to subsequent applicable requests, as per RFC 7683 [50]. + +Requested traffic reduction is achieved by the MME/SGSN by implementation specific means. For example, it may implement message throttling with prioritization or a message retaining mechanism for operations that can be postponed. + +Diameter requests related to priority traffic (e.g. MPS as identified by the MME/SGSN through access procedures) and emergency have the highest priority. Depending on regional/national regulatory and operator policies, these Diameter requests shall be the last to be throttled, when the MME/SGSN has to apply traffic reduction. Relative priority amongst various priority traffic (e.g. MPS) and emergency traffic is subject to regional/national regulatory and operator policies. + +As a result of the need to throttle traffic, the MME or SGSN may reject Attach, Tracking Area Update or Service Requests initiated by UEs. The possible NAS causes are described in the Annex A and B. + +--- + +## Annex D (Informative): Diameter overload control node behaviour + +### D.1 Message prioritisation over S6a/d + +This clause describes possible behaviours of the MME/SGSN regarding message prioritisation as guidance and for an informative purpose when Diameter overload control is applied over S6a/d. + +When the HSS is overloaded, the MME/SGSN will receive overload reports from the HSS requesting a reduction of the requests sent by the MME/SGSN. The following and not exhaustive considerations may be taken into account for the MME/SGSN throttling decisions: + +- Prioritisation of requests related to priority traffic (e.g. MPS as identified by the MME/SGSN through access procedures, emergency) +- Identification of the procedures that can be deferred (e.g. UE reachable notification, purge after a long inactivity time), so to avoid to drop non deferrable procedures; +- Prioritisation of certain types of requests (i.e. between AIR, ULR, PUR, NOR) according to the context of their use, in particular: + - Higher prioritisation of ULR commands when used in relation with mobility management (e.g. handover) for an attached user, so to avoid the interruption of the service for the user; + - Lower prioritisation of AIR and ULR commands when related to an initial attach, so to avoid the attachment of new users; +- Skipping of optional authentication (e.g. in TAU procedures). + +--- + +## Annex E (normative): Diameter message priority mechanism + +### E.1 General + +IETF RFC 7944 [57] specifies a Diameter routing message priority mechanism that allows Diameter nodes to indicate the relative priority of Diameter messages. With this information, other Diameter nodes may 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. + +--- + +### E.2 S6a/S6d interfaces + +#### E.2.1 General + +The Diameter message priority mechanism is an optional feature. + +It is recommended to make use of IETF RFC 7944 [57] over the S6a/S6d interfaces of an operator network when the overload control defined in Annex C is applied on these S6a/d interfaces. + +#### E.2.2 HSS, CSS, EIR behaviour + +When the HSS, the CSS or the EIR supports the Diameter message priority mechanism, the HSS, the CSS, or the EIR shall comply with IETF RFC 7944 [57]. + +The HSS or the CSS sending a request shall determine the required priority according to its policies. When priority is required, the HSS or the CSS 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 HSS or the CSS receives the corresponding response, the HSS or the CSS 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 the HSS, the CSS, or the EIR receives a request, it shall handle the request according to the received DRMP AVP priority level. For the response, the HSS, the CSS, or the EIR 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, the HSS, the CSS, or the EIR shall include the DRMP AVP in the response. If: + +- the HSS, the CSS or the EIR 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 HSS, the CSS or the EIR shall set the DSCP marking for transport of the request or response according to the required priority level. + +When not-explicitly requested, the inclusion and priority value of the DRMP AVP in Diameter messages are implementation specific. + +## E.2.3 MME/SGSN behaviour + +When the MME/SGSN supports the Diameter message priority mechanism, the MME/SGSN shall comply with IETF RFC 7944 [57]. + +The MME/SGSN sending a request shall determine the required priority according to its policies. When priority is required, the MME/SGSN shall include the DRMP AVP indicating the required priority level in the request it sends, and shall prioritise the requests according to the required priority level. + +When the MME/SGSN 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 the MME/SGSN 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: + +- the MME/SGSN 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 MME/SGSN shall set the DSCP marking for transport of the request or response according to the required priority level. + +Diameter requests related to high priority traffic (e.g. MPS as identified by the MME/SGSN via the RRC Establishment Cause IE set to the highPriorityAccess value as per 3GPP TS 36.413 [19] or through subscription information in the MPS-Priority AVP, emergency) shall contain a DRMP AVP with a high priority of which the level value is operator dependent. + +When not-explicitly requested, the inclusion and priority value of the DRMP AVP in Diameter messages are implementation specific. + +--- + +## Annex F (normative): Diameter load control mechanism + +### F.1 General + +IETF RFC 8583 [60] specifies a mechanism for sharing of Diameter load information. It includes the definition and the transfer of related AVPs between Diameter nodes. + +--- + +### F.2 S6a/S6d interfaces + +#### F.2.1 General + +Diameter load control mechanism is an optional feature. + +It is recommended to make use of IETF RFC 8583 [60] on the S6a/S6d interfaces where, when applied, the MME or the SGSN shall behave as receiving nodes and the HSS as a reporting node. + +#### F.2.2 HSS behaviour + +The HSS may report its current load by including a Load AVP of type HOST in answer commands as described in IETF RFC 8583 [60]. + +The HSS calculates its current load by implementation specific means. For example, the HSS may take into account the traffic over the S6a/d interfaces or other interfaces, the level of usage of internal resources (CPU, memory), the access to external resources, etc. + +The HSS determines when to send Load AVPs of type HOST by implementation specific means. + +#### F.2.3 MME/SGSN behaviour + +When performing next hop Diameter Agent selection for requests that are routed based on realm, the MME/SGSN may take into account load values from Load AVPs of type PEER received from candidate next hop Diameter nodes, as per IETF RFC 8583 [60]. + +## Annex G (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|--------------------------------------------------------------------------|-------| +| 2008-09 | CT#41 | CP-080475 | | | | V2.0.0 approved in CT#41 | 8.0.0 | +| 2008-12 | CT#42 | CP-080691 | 0001 | 1 | | S6a Vendor-Specific-Application-Id AVP | 8.1.0 | +| | | CP-080691 | 0002 | 1 | | RegSub feature | | +| | | CP-080691 | 0005 | - | | Clarification on Immediate-Response-Preferred | | +| | | CP-080691 | 0006 | 1 | | Correction of the Reference of Supported Features | | +| | | CP-080691 | 0007 | - | | Definition of RAT-Frequency-Selection-Priority | | +| | | CP-080691 | 0008 | 2 | | ME Identity Check | | +| | | CP-080703 | 0009 | 2 | | Gr alignment | | +| | | CP-080971 | 0010 | 3 | | Closed Subscriber Group | | +| | | CP-080691 | 0011 | - | | AVP codes | | +| | | CP-080691 | 0012 | 1 | | MSISDN AVP | | +| | | CP-080691 | 0013 | - | | Result codes | | +| | | CP-080691 | 0014 | - | | Removal of Editor's note in ULA Flag | | +| | | CP-080691 | 0015 | 2 | | Duplicated AMBR AVP and Use of Called-Station-Id | | +| | | CP-080691 | 0017 | - | | Change of AVP to carry the APN information | | +| | | CP-080691 | 0018 | 1 | | Reference to 3GPP-Charging-Characteristics | | +| | | CP-080691 | 0019 | - | | Access Restriction Data Definition | | +| | | CP-080691 | 0020 | - | | AMBR Definition | | +| | | CP-080691 | 0021 | 1 | | AVPs Encoding | | +| | | CP-080691 | 0022 | 1 | | PDN-GW Delete | | +| | | CP-080691 | 0023 | 1 | | Requesting Node Type Clarification | | +| | | CP-080691 | 0024 | - | | Authn Session State AVP | | +| | | CP-080691 | 0026 | 2 | | Trace Session Activation and Deactivation | | +| | | CP-080691 | 0027 | 1 | | Context-Identifier in APN-Configuration-Profile | | +| | | CP-080691 | 0029 | - | | APN-OIReplacement | | +| | | CP-080703 | 0032 | - | | Access Restriction | | +| | | CP-080691 | 0033 | 1 | | Context Identifier clarification | | +| | | CP-080691 | 0034 | 1 | | APN-Configuration correction | | +| | | CP-080691 | 0037 | - | | Removal of Supported RAT Types | | +| | | CP-080691 | 0039 | 1 | | Extension of the Terminal-Information AVP for non-3GPP accesses | | +| | | CP-080691 | 0040 | - | | Conditionality of ULA-Flags and PUA-Flags AVPs | | +| | | CP-080691 | 0042 | - | | Wrong Description for Complete APN Configuration Profile Withdrawal | | +| | | CP-080691 | 0043 | - | | Purge UE Detailed Behaviour | | +| | | CP-080691 | 0044 | 1 | | MME/SGSN area restricted flag cleanup | | +| | | | | | | TS number in cover page corrected | 8.1.1 | +| 2009-03 | CT#43 | CP-090056 | 0048 | 2 | | Context Identifier for Update or Removal of PDN GW | 8.2.0 | +| | | CP-090046 | 0049 | - | | Clarification of the relationship between Subscriber-Status and ODB | | +| | | CP-090046 | 0051 | 2 | | Context-Identifier in APN-Configuration-Profile | | +| | | CP-090024 | 0052 | - | | Update of the AVP Codes | | +| | | CP-090236 | 0053 | 2 | | PDN GW update for Wildcard APN | | +| | | CP-090044 | 0054 | 1 | | Ready for SM | | +| | | CP-090046 | 0055 | - | | ODB for SM | | +| | | CP-090044 | 0056 | 2 | | Handling LCS Subscription Data | | +| | | CP-090046 | 0057 | 2 | | Charging Characteristics | | +| | | CP-090046 | 0058 | 2 | | Regional-Subscription-Zone-Code AVP Correction | | +| | | CP-090046 | 0059 | 2 | | Trace Depth corrections | | +| | | CP-090046 | 0060 | 2 | | Delete Subscriber Data Request procedure | | +| | | CP-090046 | 0063 | 1 | | Coding definition for STN-SR | | +| | | CP-090046 | 0064 | - | | Trace Reference in DSR | | +| | | CP-090046 | 0065 | 1 | | DSR-Flags | | +| | | CP-090046 | 0066 | 2 | | Clarification on All-APN-Configurations-Included-Indicator | | +| | | CP-090046 | 0069 | - | | User-Name AVP contains only the IMSI | | +| | | CP-090046 | 0070 | 1 | | MIP6-Agent-Info Definition and Usage | | +| | | CP-090046 | 0075 | 1 | | Allocation Retention Priority | | +| | | CP-090046 | 0076 | 1 | | APN includes only the Network Identifier | | +| | | CP-090046 | 0077 | - | | Error Codes and ABNF Corrections | | +| | | CP-090039 | 0078 | 4 | | User to HSS resolution | | +| | | CP-090046 | 0079 | 1 | | Introducing the Trace-Collection-Entity AVP | | +| | | CP-090046 | 0081 | 4 | | Usage of Immediate-Response-Preferred AVP | | +| | | CP-090044 | 0082 | 3 | | Handling SMS Subscription Data | | +| | | CP-090046 | 0083 | - | | SCTP version | | +| | | CP-090046 | 0084 | - | | RFC 5447 References | | +| 2009-06 | CT#44 | CP-090287 | 0086 | 1 | | Notification of SMS over IP Non-Delivery for E-UTRAN and UE Reachability | 8.3.0 | +| | | CP-090287 | 0087 | 1 | | Coding of Immediate Response Preferred AVP | | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|-------------------------------------------------------------------------------|-------| +| | | CP-090287 | 0088 | - | | Trace Event List | | +| | | CP-090287 | 0089 | - | | Removal of Requesting Node Type from AIR | | +| | | CP-090287 | 0091 | - | | Regional-Subscription-Zone-Code clarification | | +| | | CP-090287 | 0092 | - | | Clarification of PLMN encoding | | +| | | CP-090287 | 0093 | - | | Diameter Command Codes for S6a/S6d/S13/S13' | | +| | | CP-090287 | 0094 | - | | Update of Diameter Codes | | +| | | CP-090287 | 0095 | 1 | | Formatting of APN in Service-Selection AVP | | +| | | CP-090378 | 0096 | 3 | | User Data Download Indication | | +| | | CP-090315 | 0097 | - | | Usage of Single-Registration-Indication | | +| | | CP-090495 | 0098 | 3 | | ULR processing enhancement | | +| 2009-09 | CT#45 | CP-090531 | 0100 | 2 | | Correction on APN-OI-Replacement | 8.4.0 | +| | | CP-090726 | 0101 | 3 | | GPRS subscription data over S6d | | +| | | CP-090531 | 0102 | 1 | | Usage of DIAMETER_ERROR_UNKNOWN_EPS_SUBSCRIPTION | | +| | | CP-090531 | 0103 | 6 | | Cancel Location for Initial Attach | | +| | | CP-090531 | 0104 | 4 | | Subscriber Data Update | | +| | | CP-090531 | 0105 | 1 | | Usage of Single Registration Indication | | +| | | CP-090531 | 0106 | 2 | | Charging Characteristics Reference | | +| | | CP-090531 | 0107 | 1 | | Alerting Reason Behaviour | | +| | | CP-090531 | 0108 | 1 | | Wildcard APN | | +| | | CP-090531 | 0109 | - | | Subscriber's NAM | | +| | | CP-090531 | 0111 | - | | Trace ID length correction | | +| | | CP-090531 | 0112 | 1 | | Subscription-Data AVP in Update Location Answer | | +| | | CP-090531 | 0113 | 1 | | Default values for Allocation Retention Priority AVP | | +| | | CP-090531 | 0114 | - | | Default APN and Wildcard APN | | +| | | CP-090531 | 0115 | 2 | | Correction in behavior of DSR-Flags | | +| | | CP-090531 | 0116 | 1 | | PDN Type | | +| | | CP-090531 | 0118 | 1 | | Clarification on the process of skip subscriber data flag in the HSS | | +| | | CP-090532 | 0119 | 1 | | Corrections on IDR ABNF and Service Type AVP | | +| | | CP-090532 | 0120 | 1 | | TS-Code AVP is missing in DSR command | | +| | | CP-090532 | 0123 | 1 | | Cleanup of the TS | | +| | | CP-090532 | 0124 | 1 | | Format of User-Id | | +| | | CP-090532 | 0125 | 1 | | GPRS Subscription Data Update | | +| | | CP-090532 | 0126 | 2 | | APN-Configuration-Profile | | +| | | CP-090532 | 0128 | 1 | | 3GPP2-MEID AVP | | +| | | CP-090532 | 0129 | 1 | | MIP6-Agent-Info AVP | | +| | | CP-090532 | 0130 | - | | Alignment of Supported Feature concept with 29.229 | | +| | | CP-090532 | 0133 | 1 | | EPS Subscribed QoS | | +| | | CP-090532 | 0137 | 1 | | Restruction of the TS 29.272 | | +| | | CP-090532 | 0138 | 1 | | Trace Depth per session | | +| | | CP-090532 | 0140 | - | | Clarification of Unsigned32 bit flag AVPs | | +| | | CP-090532 | 0141 | 1 | | Extra Regional-Subscription-Zone-Codes | | +| | | CP-090532 | 0142 | 1 | | Clarification of Service-Selection AVP encoding | | +| | | CP-090532 | 0143 | 1 | | User to HSS identity resolution for Diameter Proxy Agents | | +| | | CP-090532 | 0144 | - | | RFSP coding | | +| 2009-09 | CT#45 | CP-090556 | 0122 | 3 | | Optimization of Subscriber Data Update | 9.0.0 | +| | | CP-090562 | 0131 | | | Emergency Support in S6a | | +| 2009-12 | CT#46 | CP-091030 | 0148 | 4 | | Clarification on Some Subscription Data List Handling in MME/SGSN | 9.1.0 | +| | | CP-090793 | 0149 | 1 | | APN level APN-OI-Replacement | | +| | | CP-090800 | 0150 | 2 | | ICS-Flag | | +| | | CP-090767 | 0152 | 2 | | RFSP alignment in 29.272 | | +| | | CP-090801 | 0153 | 1 | | Notify Request for Emergency Attached UEs | | +| | | CP-090767 | 0155 | 2 | | Wildcard APN | | +| | | CP-090767 | 0157 | 1 | | Lifetime of Charging Characteristics after Change | | +| | | CP-091030 | 0159 | 2 | | Correction on the UE initiated detach procedure | | +| | | CP-090767 | 0163 | 2 | | FQDN for S6a NOR | | +| | | CP-090767 | 0165 | - | | HPLMN-ODB AVP correction | | +| | | CP-091032 | 0167 | | | From GMLC-Address to GMLC-Number | | +| | | CP-091030 | 0171 | 1 | | Static PDN GW | | +| | | CP-091030 | 0177 | 1 | | Clarification on Usage of Re-Synchronization-Info AVP | | +| | | CP-091030 | 0179 | 1 | | Clarification on the Number of PDP-Contexts in the GPRS-Subscription-Data AVP | | +| | | CP-090767 | 0185 | - | | APN-Configuration-Profile usage in IDR | | +| | | CP-091030 | 0187 | 2 | | IMEI encoding | | +| | | CP-091030 | 0189 | 1 | | APN-Configuration Service-Selection values | | +| | | CP-091030 | 0191 | 1 | | QoS attributes | | +| | | CP-090789 | 0196 | 1 | | Subscription-Data clarification for UE Reachability | | +| | | CP-091030 | 0198 | 2 | | Vendor Specific Application ID | | +| | | CP-090776 | 0200 | 1 | | Destination Realm | | +| | | CP-090767 | 0202 | - | | Correction to fault recovery procedure and ME identity check procedure | | +| | | CP-090767 | 0204 | - | | Reference of 3GPP-Charging-Characteristics | | +| | | CP-090767 | 0206 | - | | Reset procedure MME/SGSN behavior | | + +| | | | | | | | +|---------------|-----------|------|---|--|----------------------------------------------------------------------------------------------|--------| +| 2010-03 CT#47 | CP-100020 | 0181 | 2 | | Correction to Purge UE Detailed Behaviour | 9.2.0 | +| | CP-100020 | 0210 | | | HPLMN ODB | | +| | CP-100048 | 0211 | 2 | | TADS support in S6a/S6d | | +| | CP-100020 | 0217 | | | Cancellation-Type clarifications | | +| | CP-100020 | 0219 | 1 | | IETF References update | | +| | CP-100020 | 0221 | | | Static PDN GW | | +| | CP-100046 | 0222 | 1 | | Addition of V-GMLC address for S6a | | +| | CP-100020 | 0223 | 1 | | Handling of UE Reachability MME Parameter | | +| | CP-100020 | 0227 | | | Indication of PLMN ID of the selected PGW | | +| | CP-100040 | 0228 | | | Context-Identifier in NOR | | +| | CP-100235 | 0230 | 5 | | EPS Subscriber State and Location Information Request | | +| | CP-100040 | 0233 | 1 | | Reset to Combined MME/SGSN | | +| | CP-100040 | 0234 | 1 | | NOR-Flags correction | | +| 2010-06 CT#48 | CP-100040 | 0236 | 2 | | Indication of LCS Capabilities support over S6a/S6d | 9.3.0 | +| | CP-100040 | 0238 | 1 | | Fix ambiguity on context id AVP | | +| | CP-100264 | 0241 | 1 | | Service-Selection values | | +| | | 0243 | 1 | | MIP6-Agent-Info | | +| | | 0245 | 2 | | Fix ambiguity on usage of the Supported-Features AVP | | +| | | 0260 | 1 | | Correction of Context-Identifier | | +| | CP-100277 | 0247 | 1 | | Dynamic information update after a Reset procedure | | +| | | 0248 | 1 | | Notify command from unknown MME | | +| | CP-100416 | 0249 | 4 | | S6a Error Codes | | +| 2010-09 CT#49 | CP-100279 | 0258 | 3 | | URRP for SGSN | 9.4.0 | +| | CP-100265 | 0262 | 3 | | MME mapping between Diameter error codes and NAS Cause Code values | | +| | CP-100456 | 0268 | 1 | | Restoration of the SGSN Number in the VLR | | +| | CP-100457 | 0272 | | | QoS-Subscribed | | +| | CP-100457 | 0273 | | | Trace-Reference AVP encoding | | +| | CP-100457 | 0284 | | | Usage of MIP-Home-Agent-Host AVP | | +| | CP-100457 | 0285 | | | Correction on HSS behaviour about IMEI | | +| | CP-100577 | 0275 | 2 | | NAS Cause Code values | | +| | CP-100463 | 0276 | | | LCS Privacy Features for MME | | +| | CP-100443 | 0281 | 2 | | Correction to Delete Subscriber Data for SGSN | | +| 2010-09 CT#49 | CP-100443 | 0283 | 1 | | Unclear Cancel-Type Setting for Single Registration and Initial Attach | 10.0.0 | +| | CP-100465 | 0267 | 1 | | Addition of SIPTO permissions in PS subscription data | | +| 2010-10 CT#50 | CP-100689 | 0324 | 1 | | HSS Error Returned due to ODB | 10.1.0 | +| | CP-100689 | 0316 | 1 | | Clarification on Access Restriction Data | | +| | CP-100698 | 0297 | 1 | | Removal of Notify Messages during detach or last PDN connection deactivation via 3GPP access | | +| | CP-100679 | 0303 | 1 | | Usage of Served Party IP Address AVP inside the APN Configuration | | +| | CP-100679 | 0305 | 1 | | Usage of APN-OI-Replacement AVP | | +| | CP-100679 | 0307 | | | AMBR clarification | | +| | CP-100679 | 0308 | | | Store HSS Identity in MME/SGSN after successful ULA | | +| | CP-100679 | 0315 | 3 | | Fix ambiguity in the LCS related indication | | +| | CP-100679 | 0327 | 2 | | Unknown EPS Subscription | | +| | CP-100688 | 0325 | 1 | | Periodic TAU/RAU timer in HSS subscription | | +| | CP-100707 | 0313 | 1 | | Correction of Restoration flag | | +| | CP-100707 | 0319 | | | Default APN and Wildcard APN | | +| | CP-100707 | 0322 | 1 | | Usage of PGW Allocation Type AVP | | +| | CP-100699 | 0323 | | | Usage of STN-SR AVP | | +| | CP-100699 | 0291 | 3 | | Enhanced SRVCC | | +| 2011-03 CT#51 | CP-100687 | 0290 | 4 | | Addition of MPS Priority in Subscription Data | 10.2.0 | +| | CP-100683 | 0289 | 1 | | Addition of LIPA permission in Subscription Data | | +| | CP-100684 | 0288 | 1 | | SIPTO Permission for Wildcard APN | | +| | CP-110087 | 0329 | 2 | | Minimization of Drive Tests (MDT) | | +| | CP-110042 | 0330 | 2 | | Feature Flags for UE Reachability Notification and State/Location Info Retrieval | | +| | CP-110042 | 0337 | 3 | | Correction of error cause handling | | +| | CP-110042 | 0339 | 2 | | Setting of M bit AVP flag | | +| | CP-110042 | 0343 | 1 | | AMBR Correction | | +| | CP-110073 | 0332 | 2 | | Correction on PGW PLMN ID | | +| 2011-06 CT#52 | CP-110088 | 0334 | 2 | | Relay Node Indicator | 10.3.0 | +| | CP-110051 | 0346 | 1 | | PDP Address correction | | +| | CP-110051 | 0351 | 2 | | Ambiguity in IDR flags | | +| 2011-09 CT#53 | CP-110051 | 0353 | | | Homogeneous Support for IMS Voice over PS AVP missing | 10.4.0 | +| | CP-110351 | 0362 | | | SGSN-Number AVP correction | | +| | CP-110380 | 0357 | 2 | | MDT user consent | | +| | CP-110375 | 0363 | 1 | | Purge from Combined MME/SGSN | | +| | CP-110562 | 0372 | 1 | | Active-APN AVP definition | | +| | CP-110562 | 0374 | | | Context-Identifier when interworking with GTPv1 | | +| | CP-110562 | 0380 | 1 | | APN-AMBR for GPRS | | + +| | | | | | | | +|---------------|-----------|------|----|--|----------------------------------------------------------------------------|--------| +| 2011-09 CT#53 | CP-110565 | 0377 | | | Correction on DIAMETER_AUTHORIZATION_REJECTED | 11.0.0 | +| | CP-110699 | 0381 | | | Correction of implementation error in TS 29.272, CR 324 | | +| | CP-110581 | 0369 | 2 | | Behaviour of HSS in abnormal case of Immediate-Response-Preferred AVP | | +| | CP-110584 | 0370 | 3 | | Add vSRVCC updates to the S6a interface | | +| 2011-12 CT#54 | CP-110787 | 0390 | 1 | | Unknown EPS Subscription over S6d/S6a | 11.1.0 | +| | CP-110811 | 0387 | 2 | | Equivalent PLMN CSG Subscription Request | | +| | CP-110787 | 0397 | 1 | | M-bit Handling | | +| 2012-03 CT#55 | CP-120023 | 0409 | 1 | | GMLC-Number format | 11.2.0 | +| | CP-120025 | 0399 | 3 | | Initial Attach Indication in CLR | | +| | CP-120029 | 0406 | | | T-ADS data request for detached UE | | +| | CP-120029 | 0410 | 1 | | Removal of Subscribed Periodic TAU/RAU timer in HSS subscription | | +| | CP-120037 | 0400 | | | Clarification on UE-SRVCC-Capability AVP in ULR | | +| | CP-120037 | 0402 | | | ODB clarification | | +| | CP-120037 | 0403 | 2 | | S6a location reporting | | +| 2012-06 CT#56 | CP-120240 | 0401 | 3 | | CSG ID and Local Time for NPLI | 11.3.0 | +| | CP-120413 | 0415 | 4 | | Ready for SM in MME | | +| | CP-120249 | 0418 | 1 | | ULR handling for combined MME/SGSN | | +| | CP-120249 | 0419 | | | Clarification on Update of PGW ID | | +| 2012-09 CT#57 | CP-120476 | 0382 | 10 | | VCSG procedures over S7a/S7d | 11.4.0 | +| | CP-120476 | 0394 | 5 | | Delete CSG subscription Data over S7a /S7d | | +| | CP-120476 | 0416 | 4 | | VCSG Reset procedure over S7a/S7d | | +| | CP-120481 | 0404 | 5 | | PS additional number over S6a/S6d | | +| | CP-120462 | 0421 | - | | Single Registration Indication | | +| | CP-120462 | 0422 | - | | Zone Codes | | +| | CP-120462 | 0423 | - | | Clarification on Notification of UE Reachability | | +| | CP-120462 | 0428 | - | | CSG-Subscription-Data replacement | | +| | CP-120462 | 0430 | 1 | | Update of Homogeneous Support of IMS Over PS Sessions | | +| | CP-120462 | 0434 | 2 | | Mapping S6a and NAS cause code | | +| | CP-120473 | 0429 | 4 | | SMS in MME | | +| | CP-120473 | 0432 | 1 | | SMS in SGSN | | +| | CP-120480 | 0433 | 2 | | Local Time Zone | | +| | CP-120722 | 0441 | 1 | | User-CSG-Information | | +| | CP-120713 | 0457 | 1 | | SGSN-Number AVP | | +| 2012-12 CT#58 | CP-120740 | 0436 | 1 | | Application ID for S7a/S7d | 11.5.0 | +| | CP-120740 | 0443 | 2 | | Empty VCSG Subscription Data | | +| | CP-120742 | 0438 | 1 | | Notification Procedure clarification for UE with Emergency Bearer Services | | +| | CP-120742 | 0445 | - | | Inclusion of APN-OI Replacement in PDP Context | | +| | CP-120742 | 0450 | - | | Correction in the chapter of Reset-Answer (RSA) command | | +| | CP-120742 | 0452 | 1 | | UE Time Zone | | +| | CP-120742 | 0453 | 1 | | Corrections to Local Time Zone | | +| | CP-120742 | 0454 | 2 | | Clarification on IDR-Flags | | +| | CP-120742 | 0455 | - | | Correction of General Description of Delete Subscriber Data | | +| | CP-120742 | 0458 | - | | DSR-Flags | | +| | CP-120742 | 0461 | 1 | | Wrong implementation of the Daylight-Saving-Time AVP | | +| | CP-120736 | 0446 | 1 | | A-MSISDN Correction | | +| | CP-120732 | 0447 | 1 | | MME network condition to NAS cause code mapping | | +| | CP-120732 | 0448 | 2 | | SGSN network condition to NAS cause code mapping | | +| | CP-120732 | 0449 | 3 | | MME de-registration for "SMS in MME" | | +| | CP-120732 | 0451 | 1 | | Correction on Update Location Request | | +| | CP-120732 | 0459 | 1 | | Alignment of stage 3 SMS in MME with stage 2 | | +| | CP-120741 | 0460 | 1 | | Use of Flag instead of Enumerated AVPs | | +| 2013-03 CT#59 | CP-130022 | 0466 | - | | Corrections to wrong references and command/AVP name | 11.6.0 | +| | CP-130022 | 0467 | 1 | | Update to Subscription-Data-Flags | | +| | CP-130022 | 0471 | 1 | | Values not allowed for QCI over S6a/S6d | | +| | CP-130022 | 0472 | 1 | | Cause Code Mapping | | +| | CP-130022 | 0470 | 1 | | Registration for SMS Request for SMS in SGSN | | +| | CP-130025 | 0474 | - | | MDT parameters | | +| 2013-03 CT#59 | CP-130031 | 0442 | 3 | | Check of Serving Node for S6a Security | 12.0.0 | +| | CP-130031 | 0468 | 1 | | MME name encoding over S6a | | +| | CP-130156 | 0475 | 1 | | SGSN indicating support of Lgd interface to HSS | | +| 2013-06 CT#60 | CP-130380 | 0490 | 1 | | Removal of SMS-Only AVP and Typo Corrections on Some AVP Definitions | 12.1.0 | +| | CP-130380 | 0501 | 2 | | MME identity for restoration procedures | | +| | CP-130380 | 0492 | 1 | | Definition of A New Feature-List | | +| | CP-130380 | 0488 | 1 | | UE-SRVCC-Capability Update Clarification | | +| | CP-130380 | 0483 | - | | Reset clarification | | +| | CP-130380 | 0481 | 2 | | AIR rejection | | +| | CP-130380 | 0479 | 1 | | Storing Last known Location Information of purged UE in HSS | | +| | CP-130380 | 0512 | 1 | | Maximum value for the subscribed periodic RAU TAU timer | | +| | CP-130279 | 0497 | 1 | | Definition of SS Status for Call Barring | | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|------------------------------------------------------------------------------------------------------------------------------|--------| +| | | CP-130378 | 0489 | 2 | | SIPTO permission for Local Network enhancements | | +| | | CP-130288 | 0487 | - | | PS Location Info request with RAT-type | | +| | | CP-130309 | 0482 | - | | CSS clarification | | +| | | CP-130295 | 0478 | - | | Restoration Priority during SGW and PGW restoration procedures | | +| | | CP-130410 | 0508 | 1 | | HSS handling of T-ADS for detached subscriber | | +| 2013-09 | CT#61 | CP-130444 | 0515 | - | | Correction to the restoration priority levels during SGW and PGW restoration procedures | 12.2.0 | +| | | CP-130450 | 0517 | - | | HPLMN-ODB Correction | | +| | | CP-130463 | 0518 | 2 | | CancelLocation requesting reattach | | +| | | CP-130456 | 0519 | 1 | | Indication of Gdd support over S6d | | +| | | CP-130461 | 0520 | 2 | | Homogeneous Support Of Voice over IP | | +| | | CP-130461 | 0521 | 1 | | Definition of User-State values | | +| | | CP-130461 | 0522 | 1 | | Context Identifier Range Inconsistency | | +| 2013-12 | CT#62 | CP-130611 | 0528 | 1 | | Addition of S6aS6d-Indicator in NOR | 12.3.0 | +| | | CP-130617 | 0533 | 1 | | MME Initiated Removal of MME Registration for SMS | | +| | | CP-130624 | 0523 | 1 | | Combined MME/SGSN indicating the support for optimized LCS procedure | | +| | | CP-130624 | 0526 | 1 | | Clarification on Description of Features for LCS | | +| | | CP-130644 | 0525 | 1 | | SMS in MME | | +| | | CP-130623 | 0529 | 1 | | Alert Service Center sent over S6c | | +| | | CP-130632 | 0530 | 1 | | Purge Clarification | | +| | | CP-130639 | 0531 | 1 | | SGSN CAMEL Subscription Indication | | +| 2014-03 | CT#63 | CP-140035 | 0534 | 2 | | Clarification on Current-Location-Retrieved and Age-of-Location-Information | 12.4.0 | +| | | CP-140035 | 0536 | 3 | | Mechanism to determine if the UE is served by the MME and SGSN parts of the same combined MME/SGSN | | +| | | CP-140035 | 0537 | - | | Call-Barring-Info AVP | | +| | | CP-140035 | 0538 | - | | Missing SGs-MME-Identity AVP in the ULR | | +| 2014-06 | CT#64 | CP-140257 | 0544 | 1 | | SS-Status AVP Definition | 12.5.0 | +| | | CP-140264 | 0555 | 3 | | Cause Mapping for ODB | | +| | | CP-140264 | 0556 | 2 | | NOR Error User Unknown | | +| | | CP-140254 | 0557 | 1 | | Enhancement for ProSe | | +| | | CP-140413 | 0558 | - | | Correction on SGSN CAMEL Capability in Supported-Features | | +| | | CP-140243 | 0540 | 5 | | Diameter overload control mechanism | | +| | | CP-140243 | 0559 | 1 | | Diameter overload over S6a/d | | +| 2014-09 | CT#65 | CP-140523 | 0564 | 2 | | Clarification on ProSe Subscription Data | 12.6.0 | +| | | CP-140514 | 0565 | 2 | | WLAN offloadability defined in HSS | | +| | | CP-140506 | 0567 | 2 | | P-CSCF Restoration Indication | | +| 2014-12 | CT#66 | CP-140772 | 0569 | 2 | | Reset-ID | 12.7.0 | +| | | CP-140772 | 0581 | 3 | | M-bit setting of Supported-Features AVP | | +| | | CP-140764 | 0571 | - | | MDT PLMN List | | +| | | CP-140764 | 0580 | 1 | | S6a/S6d-Indicator in NOR | | +| | | CP-140790 | 0575 | 1 | | Priority Consideration for Diameter Overload Control | | +| 2014-12 | CT#66 | CP-140765 | 0574 | 2 | | Roaming Subscription Corresponding to Specific RAT | 13.0.0 | +| | | CP-140759 | 0578 | 2 | | Stored HSS Identity for HSS Restoration Procedure | | +| 2015-03 | CT#67 | CP-150035 | 0582 | 1 | | Clarification on the usage of SV in IMEI check procedure | 13.1.0 | +| 2015-06 | CT#68 | CP-150265 | 0583 | 1 | | Cleanup and small error corrections | 13.2.0 | +| | | CP-150263 | 0584 | 2 | | Access Restriction Data per PLMN | | +| | | CP-150279 | 0585 | 1 | | Alignment of using ProSe and ProSe services | | +| 2015-09 | CT#69 | CP-150427 | 0597 | - | | Wrong Application-ID for S7a Diameter Application | 13.3.0 | +| | | CP-150454 | 0586 | 3 | | Subscription data for extended buffering at the SGW | | +| | | CP-150453 | 0587 | 2 | | Introducing IMSI-Group ID Lists to the subscription Info | | +| | | CP-150449 | 0588 | 3 | | Addition of CP parameters to subscription data | | +| 2015-12 | CT#70 | CP-150778 | 0590 | 9 | | Add MTC Monitoring support | 13.4.0 | +| | | CP-150778 | 0606 | 1 | | Roaming and interaction with the IWK-SCEF | | +| | | CP-150778 | 0607 | 4 | | Introducing a Bitmask to inform the HSS of the Monitoring capabilities of the MME/SGSN | | +| | | CP-150778 | 0609 | 2 | | Deletion of all Monitoring events assigned to a subscriber (UE) | | +| | | CP-150785 | 0598 | 1 | | DL-Buffering-Suggested-Packet-Count AVP | | +| | | CP-150781 | 0600 | 1 | | Retrieval of "UE Usage Type" over S6a/S6d | | +| | | CP-150762 | 0601 | 1 | | Clarification of precedence between UE-level "HO to non-3GPP access" access restriction, and APN-level "WLAN-Offloadability" | | +| | | CP-150768 | 0602 | 4 | | Diameter message priority over S6a/d | | +| | | CP-150771 | 0604 | 2 | | Introduction of validity time delete and replace procedure for CP sets | | +| | | CP-150755 | 0611 | 1 | | ProSe in combined MME/SGSN | | +| | | CP-150744 | 0614 | - | | Erroneous AVP code for some MDT parameters | | +| | | CP-150759 | 0614 | 1 | | Update reference to DOIC new IETF RFC | | +| | | CP-150776 | 0615 | 1 | | Mobile Terminating SMS handling for extended Idle mode DRX | | +| 2016-03 | CT#71 | CP-160029 | 0618 | 2 | | Notifying the status of MONTE event configuration at the IWK-SCEF to the HSS | 13.5.0 | +| | | CP-160043 | 0619 | 1 | | Fix the issue on HSS restart procedure | | +| | | CP-160039 | 0620 | 1 | | User Plane Integrity Protection Indicator | | +| | | CP-160029 | 0621 | 3 | | Configure Monitoring Event to Multiple Serving Nodes | | + +| | | | | | | | | +|---------|-------|-----------|------|---|--|---------------------------------------------------------------------------------|--------| +| | | CP-160033 | 0623 | 1 | | Allow SMS for NB-IoT UE without Combined Attach | | +| | | CP-160045 | 0625 | - | | Adjacent PLMNs | | +| | | CP-160045 | 0626 | 1 | | Invocation of Alert procedure by HSS after ULR | | +| | | CP-160023 | 0629 | 1 | | Diameter message priority over S7a/d, S13, S13' | | +| | | CP-160033 | 0630 | 2 | | Addition of NB-IoT radio access type to the Access-Restriction-Data feature | | +| | | CP-160033 | 0631 | 3 | | New PDN-Type for Cellular IoT | | +| 2016-03 | | | | | | Table 7.3.1/1 formatted | 13.5.1 | +| 2016-06 | CT#72 | CP-160215 | 0643 | 1 | | Diameter requests for priority traffic during overload control mechanism | 13.6.0 | +| 2016-06 | CT#72 | CP-160238 | 0628 | 3 | | Subscription Data for combined MME/SGSN | 13.6.0 | +| 2016-06 | CT#72 | CP-160238 | 0632 | 1 | | Cause Mapping | 13.6.0 | +| 2016-06 | CT#72 | CP-160238 | 0633 | - | | Correction on Service-Selection | 13.6.0 | +| 2016-06 | CT#72 | CP-160238 | 0639 | 2 | | Group-Service-Id | 13.6.0 | +| 2016-06 | CT#72 | CP-160233 | 0635 | - | | Renaming of Validity-Time AVP | 13.6.0 | +| 2016-06 | CT#72 | CP-160228 | 0636 | - | | Update SMS Support for NB-IoT | 13.6.0 | +| 2016-06 | CT#72 | CP-160225 | 0637 | 2 | | SCEF realm | 13.6.0 | +| 2016-06 | CT#72 | CP-160222 | 0638 | 2 | | Shared Subscription data update | 14.0.0 | +| 2016-06 | CT#72 | CP-160217 | 0640 | 1 | | Support for Non-IP PDP types | 14.0.0 | +| 2016-06 | CT#72 | CP-160221 | 0641 | 1 | | MSISDN Removal from Subscription Profile | 14.0.0 | +| 2016-09 | CT#73 | CP-160423 | 0645 | - | | PDN-Connection-Restricted flag | 14.1.0 | +| 2016-09 | CT#73 | CP-160423 | 0647 | 1 | | Preferred Data Mode for an SGi PDN connection | 14.1.0 | +| 2016-09 | CT#73 | CP-160428 | 0652 | - | | CR implementation error on ECR and ECA commands | 14.1.0 | +| 2016-09 | CT#73 | CP-160426 | 0658 | 2 | | Current Location Retrieval | 14.1.0 | +| 2016-09 | CT#73 | CP-160437 | 0649 | 1 | | Removal of Editor's Note on non shareable subscription data | 14.1.0 | +| 2016-09 | CT#73 | CP-160437 | 0650 | - | | Removal of Editor's Note on detailed checks for shared subscription data update | 14.1.0 | +| 2016-09 | CT#73 | CP-160437 | 0656 | 2 | | Solution to avoid high load resulting from shared subscription data update | 14.1.0 | +| 2016-09 | CT#73 | CP-160433 | 0653 | - | | Change of Network Access Mode | 14.1.0 | +| 2016-09 | CT#73 | CP-160432 | 0654 | - | | Usage of Supported Features | 14.1.0 | +| 2016-09 | CT#73 | CP-160432 | 0655 | - | | Handling of MSISDN removal from subscription profile | 14.1.0 | +| 2016-12 | CT#74 | CP-160679 | 0659 | 4 | | Handover of Emergency PDN Connections | 14.2.0 | +| 2016-12 | CT#74 | CP-160673 | 0660 | 1 | | Reset-ID AVP description for shared subscription data update | 14.2.0 | +| 2016-12 | CT#74 | CP-160673 | 0671 | 1 | | Update of "Homogeneous Support" Status | 14.2.0 | +| 2016-12 | CT#74 | CP-160673 | 0684 | 1 | | Missing S7a/S7d application identifier | 14.2.0 | +| 2016-12 | CT#74 | CP-160654 | 0662 | 1 | | Communication-Pattern Feature | 14.2.0 | +| 2016-12 | CT#74 | CP-160681 | 0666 | 1 | | Load Control | 14.2.0 | +| 2016-12 | CT#74 | CP-160681 | 0677 | 1 | | Host Load | 14.2.0 | +| 2016-12 | CT#74 | CP-160665 | 0668 | 1 | | Dynamic Removal of UE Usage Type | 14.2.0 | +| 2016-12 | CT#74 | CP-160665 | 0674 | 1 | | Presence of UE Usage Type in Error Responses | 14.2.0 | +| 2016-12 | CT#74 | CP-160657 | 0670 | 1 | | Undefined Bits in Access Restriction Data | 14.2.0 | +| 2016-12 | CT#74 | CP-160678 | 0672 | 1 | | Add V2X Subscription Data to S6a Interface | 14.2.0 | +| 2016-12 | CT#74 | CP-160664 | 0682 | - | | Correction to change IETF drmp draft version to official RFC 7944 | 14.2.0 | +| 2016-12 | CT#74 | CP-160660 | 0683 | 1 | | Deletion of all monitoring events | 14.2.0 | +| 2017-03 | CT#75 | CP-170028 | 0692 | 1 | | Maximum Response Time | 14.3.0 | +| 2017-03 | CT#75 | CP-170039 | 0687 | 1 | | Enhanced Coverage | 14.3.0 | +| 2017-03 | CT#75 | CP-170039 | 0688 | 1 | | Inter-RAT PDN-Continuity | 14.3.0 | +| 2017-03 | CT#75 | CP-170044 | 0693 | 1 | | Emergency-Info AVP in ULA | 14.3.0 | +| 2017-03 | CT#75 | CP-170043 | 0696 | 1 | | Correct UE-PC5-AMBR Format | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0697 | 2 | | Removal of complete APN Configuration Profile | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0698 | 1 | | Clarification of MDT User Consent | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0699 | 1 | | Missing M/O values in several feature flags | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0700 | 2 | | Subscription parameters for eDRX | 14.3.0 | +| 2017-03 | CT#75 | CP-170036 | 0701 | 2 | | Support of long and short Macro eNodeB IDs | 14.3.0 | +| 2017-03 | CT#75 | CP-170048 | 0704 | - | | Update of reference for the Diameter base protocol | 14.3.0 | +| 2017-03 | CT#75 | CP-170048 | 0705 | - | | Handling of the Vendor-Specific-Application-Id AVP | 14.3.0 | +| 2017-03 | CT#75 | CP-170048 | 0706 | - | | Cardinality of the Failed-AVP AVP in answer | 14.3.0 | +| 2017-06 | CT#76 | CP-171029 | 0707 | 1 | | External Identifier in Subscription-Data | 14.4.0 | +| 2017-06 | CT#76 | CP-171021 | 0709 | - | | Alignment of PDN-Connection-Restricted Flag handling on NAS specification | 14.4.0 | +| 2017-06 | CT#76 | CP-171017 | 0713 | 1 | | Add MBSFN Area List to MDT Configuration parameters | 14.4.0 | +| 2017-06 | CT#76 | CP-171184 | 0715 | 2 | | Communication Patterns without Expiry Time | 14.4.0 | +| 2017-06 | CT#76 | CP-171029 | 0717 | 1 | | Loss Of Connectivity Reason in S6a/d IDA | 14.4.0 | +| 2017-06 | CT#76 | CP-171018 | 0720 | 1 | | Support for signaling transport level packet marking | 14.4.0 | +| 2017-06 | CT#76 | CP-171043 | 0718 | 1 | | Clarification of S6a/Notification-Request command for non-IP APNs | 15.0.0 | +| 2017-06 | CT#76 | CP-171041 | 0721 | - | | Removal of UE-Usage-Type | 15.0.0 | +| 2017-09 | CT#77 | CP-172027 | 0727 | 1 | | Access Restriction to NR as Secondary RAT | 15.1.0 | +| 2017-09 | CT#77 | CP-172027 | 0728 | 1 | | Extended QoS for 5G NR | 15.1.0 | +| 2017-09 | CT#77 | CP-172018 | 0729 | 1 | | Acknowledgements of downlink NAS data PDUs | 15.1.0 | +| 2017-09 | CT#77 | CP-172018 | 0730 | 1 | | Reliable Data Service | 15.1.0 | +| 2017-09 | CT#77 | CP-172026 | 0731 | 1 | | Enhancements for NAPS on Idle Status Indication | 15.1.0 | +| 2017-09 | CT#77 | CP-172013 | 0736 | - | | Correction of DRMP Procedures | 15.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------|--------| +| 2017-12 | CT#78 | CP-173016 | 0743 | 1 | | Correction on subscribed eDRX parameter value | 15.2.0 | +| 2017-12 | CT#78 | CP-173028 | 0740 | 1 | | Clarification of UE Reachability monitoring event over S6a/S6d | 15.2.0 | +| 2017-12 | CT#78 | CP-173025 | 0741 | - | | Error in the DIAMETER_ERROR_EQUIPMENT_UNKNOWN name | 15.2.0 | +| 2017-12 | CT#78 | CP-173025 | 0744 | 3 | | Active Time in Insert Subscriber Data | 15.2.0 | +| 2017-12 | CT#78 | CP-173035 | 0746 | 1 | | Access restriction to unlicensed spectrum as secondary RAT | 15.2.0 | +| 2017-12 | CT#78 | CP-173036 | 0747 | 1 | | Access Restrictions to NR as Secondary RAT on MM Context | 15.2.0 | +| 2018-03 | CT#79 | CP-180013 | 0755 | 2 | | Handling of Homogenous-Support-of-IMS-Voice-Over-PS-Sessions AVP | 15.3.0 | +| 2018-03 | CT#79 | CP-180021 | 0756 | - | | Service Gap Time | 15.3.0 | +| 2018-03 | CT#79 | CP-180025 | 0757 | 1 | | Filtering the Report for Number of UEs in a Geographic Area | 15.3.0 | +| 2018-06 | CT#80 | CP-181122 | 0758 | - | | Bandwidth Clarification | 15.4.0 | +| 2018-06 | CT#80 | CP-181122 | 0759 | 1 | | Supported-Services AVP code | 15.4.0 | +| 2018-06 | CT#80 | CP-181122 | 0762 | 1 | | Subscription for Aerial UE in 3GPP system | 15.4.0 | +| 2018-06 | CT#80 | CP-181124 | 0765 | 1 | | Subscription data for ciphering keys | 15.4.0 | +| 2018-06 | CT#80 | CP-181133 | 0763 | 1 | | Access Restrictions | 15.4.0 | +| 2018-09 | CT#81 | CP-182077 | 0766 | - | | Update of Broadcast-Location-Assistance-Data-Types AVP | 15.5.0 | +| 2018-09 | CT#81 | CP-182067 | 0767 | 2 | | Access Restriction Data for NR as Secondary RAT not supported by HSS | 15.5.0 | +| 2018-09 | CT#81 | CP-182067 | 0774 | - | | Applicable values for AMBR | 15.5.0 | +| 2018-09 | CT#81 | CP-182075 | 0768 | 1 | | Handling of monitoring events in ULA | 15.5.0 | +| 2018-09 | CT#81 | CP-182072 | 0769 | 1 | | Subscribed PTW length | 15.5.0 | +| 2018-09 | CT#81 | CP-182072 | 0770 | 1 | | DSR-Flag for Active-Time | 15.5.0 | +| 2018-09 | CT#81 | CP-182071 | 0771 | 2 | | DSR-Flag for eDRX-Cycle-Length | 15.5.0 | +| 2018-09 | CT#81 | CP-182084 | 0773 | - | | Access Restrictions | 15.5.0 | +| 2018-12 | CT#82 | CP-183092 | 0775 | 4 | | Single Registration | 15.6.0 | +| 2018-12 | CT#82 | CP-183092 | 0776 | 1 | | Interworking with 5GS indicator in APN Subscription | 15.6.0 | +| 2018-12 | CT#82 | CP-183092 | 0789 | 2 | | MME_UPDATE_PROCEDURE | 15.6.0 | +| 2018-12 | CT#82 | CP-183098 | 0785 | 1 | | Deletion of monitoring events when unknown in SCEF | 15.6.0 | +| 2018-12 | CT#82 | CP-183098 | 0786 | - | | Event configuration failure in ULA | 15.6.0 | +| 2018-12 | CT#82 | CP-183098 | 0787 | 1 | | Idle-Status-Indication is missing in monitoring event report | 15.6.0 | +| 2018-12 | CT#82 | CP-183098 | 0788 | 1 | | Applicability of Maximum Number of Reports | 15.6.0 | +| 2018-12 | CT#82 | CP-183100 | 0784 | 3 | | Behavior of MME/SGSN upon reception of DIAMETER_UNABLE_TO_COMPLY for NOR | 15.6.0 | +| 2018-12 | CT#82 | CP-183100 | 0790 | 1 | | Paging Time Window | 15.6.0 | +| 2019-03 | CT#83 | CP-190034 | 0791 | 1 | | eDRX AVPs | 15.7.0 | +| 2019-03 | CT#83 | CP-190038 | 0792 | - | | Missing Maximum-UE-Availability-Time AVP | 15.7.0 | +| 2019-03 | CT#83 | CP-190034 | 0794 | 1 | | Access Restriction to NR as Secondary RAT for SGSN | 15.7.0 | +| 2019-03 | CT#83 | CP-190034 | 0795 | - | | Paging-Time-Window AVP name | 15.7.0 | +| 2019-03 | CT#83 | CP-190037 | 0796 | 1 | | Handling of multiple external IDs for the same UE | 15.7.0 | +| 2019-06 | CT#84 | CP-191023 | 0797 | - | | Service Gap Time Deletion | 15.8.0 | +| 2019-09 | CT#85 | CP-192094 | 0804 | 2 | | draft-ietf-dime-load published as RFC 8583 | 15.9.0 | +| 2019-09 | CT#85 | CP-192121 | 0801 | 1 | | Communication pattern enhancement | 16.0.0 | +| 2019-09 | CT#85 | CP-192122 | 0800 | 1 | | Event type PDN Connectivity Status | 16.0.0 | +| 2019-09 | CT#85 | CP-192122 | 0802 | - | | Ethernet PDN Type | 16.0.0 | +| 2019-12 | CT#86 | CP-193024 | 0808 | - | | Applicability of Core Network Restrictions | 16.1.0 | +| 2019-12 | CT#86 | CP-193038 | 0809 | 1 | | Subscribed ARPI | 16.1.0 | +| 2019-12 | CT#86 | CP-193038 | 0810 | - | | LTE-M Access Restriction | 16.1.0 | +| 2019-12 | CT#86 | CP-193038 | 0812 | - | | Missing protocol code-point values | 16.1.0 | +| 2019-12 | CT#86 | CP-193052 | 0807 | 1 | | Battery Indication for Communication pattern enhancement | 16.1.0 | +| 2020-03 | CT#87e | CP-200027 | 0813 | 1 | | Addition of IAB-Operation-Permission to subscriber data | 16.2.0 | +| 2020-03 | CT#87e | CP-200036 | 0814 | 1 | | Subscription data for NR V2X | 16.2.0 | +| 2020-06 | CT#88e | CP-201053 | 0815 | - | | Alignments on definitions | 16.3.0 | +| 2020-06 | CT#88e | CP-201053 | 0816 | - | | Supported Monitoring Events | 16.3.0 | +| 2020-06 | CT#88e | CP-201053 | 0818 | - | | Error cause handling | 16.3.0 | +| 2020-06 | CT#88e | CP-201053 | 0819 | 1 | | Update of RAT restrictions | 16.3.0 | +| 2020-06 | CT#88e | CP-201053 | 0821 | 1 | | Supported Features for combined MME/SGSN | 16.3.0 | +| 2020-06 | CT#88e | CP-201049 | 0817 | 1 | | Subscribed PC5 QoS Parameters for NR V2X | 16.3.0 | +| 2020-06 | CT#88e | CP-201033 | 0820 | 1 | | SGSN Interworking with 5G | 16.3.0 | +| 2020-09 | CT#89e | CP-202109 | 0822 | 2 | | Monitoring Configurations in ULA | 16.4.0 | +| 2020-09 | CT#89e | CP-202094 | 0823 | - | | Immediate Event Report in IDA | 16.4.0 | +| 2020-09 | CT#89e | CP-202094 | 0824 | 1 | | Corrections on Broadcast-Location-Assistance-Data-Types | 16.4.0 | +| 2020-12 | CT#90e | CP-203032 | 0826 | - | | Extended Reference ID | 16.5.0 | +| 2020-12 | CT#90e | CP-203032 | 0825 | 1 | | Correction for implementation error | 16.5.0 | +| 2021-03 | CT#91e | CP-210057 | 0828 | - | | Default APN for Ethernet PDN types | 16.6.0 | +| 2021-03 | CT#91e | CP-210053 | 0829 | 2 | | Cancellation Type for UDICOM | 16.6.0 | +| 2021-03 | CT#91e | CP-210027 | 0827 | 1 | | Use of inclusive terminology | 17.0.0 | +| 2021-09 | CT#93e | CP-212053 | 0830 | - | F | Superfluous AVPs in re-used Diameter AVPs table | 17.1.0 | +| 2022-03 | CT#93e | CP-220063 | 0832 | - | F | Removal of Monitoring Events when External ID or MSISDN is deleted | 17.1.0 | +| 2022-03 | CT#93e | CP-220093 | 0831 | 1 | B | Access Restriction for IoT Satellite Access | 17.2.0 | +| 2022-06 | CT#96 | CP-221060 | 0834 | - | F | Clarification on Withdrawal of eDRX Cycle Length | 17.3.0 | +| 2022-06 | CT#96 | CP-221060 | 0836 | 1 | F | Withdrawal of Paging Time Window Subscription | 17.3.0 | +| 2022-06 | CT#96 | CP-221060 | 0837 | 1 | F | Emergency service session continuity | 17.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------|--------| +| 2022-06 | CT#96 | CP-221066 | 0840 | - | A | CR 0828 has not been correctly implemented | 17.3.0 | +| 2022-09 | CT#97e | CP-222073 | 0842 | 2 | F | Update ULR flags in support of handover | 17.4.0 | +| 2023-03 | CT#99 | CP-230054 | 0843 | - | F | Skip Subscriber Data in ULR-Flags | 18.0.0 | +| 2023-06 | CT#100 | CP-231063 | 0844 | - | F | Reachability Cause in immediate reports | 18.1.0 | +| 2023-12 | CT#102 | | 0847 | 1 | A | Preventing LTE to NR NTN handover for users without NR NTN subscription | 18.2.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29275/raw.md b/marked/Rel-18/29_series/29275/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..ca25545aa3e841ffd262e65f3dd58a5a7c8b4736 --- /dev/null +++ b/marked/Rel-18/29_series/29275/raw.md @@ -0,0 +1,3624 @@ + + +# 3GPP TS 29.275 V18.0.0 (2024-03) + +Technical Specification + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Proxy Mobile IPv6 (PMIPv6) based Mobility and Tunnelling protocols; Stage 3 (Release 18)** + +![LTE Advanced Pro logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for LTE Advanced Pro, featuring the word "lte" in bold lowercase letters, with "Advanced Pro" in smaller text above the "e". A green signal icon is positioned above the "l". + +LTE Advanced Pro logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The 3GPP logo, consisting of the letters "3GPP" in a stylized font, with a red signal icon below the "P". Below the logo, the text "A GLOBAL INITIATIVE" is written in all caps. + +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. + +© 2024, 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 ..... | 10 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions and abbreviations ..... | 13 | +| 3.1 Definitions..... | 13 | +| 3.2 Abbreviations ..... | 13 | +| 4 General..... | 14 | +| 4.1 PDN connection ..... | 14 | +| 4.2 PMIPv6 protocol stacks ..... | 14 | +| 5 Mobility Management procedures ..... | 15 | +| 5.1 Proxy Mobile IPv6 PDN Connection Creation procedure ..... | 15 | +| 5.1.1 General ..... | 15 | +| 5.1.1.1 Proxy Binding Update ..... | 15 | +| 5.1.1.2 Proxy Binding Acknowledgement..... | 19 | +| 5.1.2 MAG procedures ..... | 21 | +| 5.1.3 LMA procedures..... | 22 | +| 5.2 Proxy Mobile IPv6 PDN Connection Lifetime Extension procedure ..... | 22 | +| 5.2.1 General ..... | 22 | +| 5.2.1.1 Proxy Binding Update ..... | 22 | +| 5.2.1.2 Proxy Binding Acknowledgement..... | 25 | +| 5.2.2 MAG procedures ..... | 26 | +| 5.2.3 LMA procedures..... | 26 | +| 5.3 Proxy Mobile IPv6 PDN Connection Handover procedure ..... | 28 | +| 5.3.1 General ..... | 28 | +| 5.3.1.1 Proxy Binding Update ..... | 28 | +| 5.3.1.2 Proxy Binding Acknowledgement..... | 32 | +| 5.3.2 MAG procedures ..... | 34 | +| 5.3.3 LMA procedures..... | 34 | +| 5.4 Proxy Mobile IPv6 MAG Initiated PDN Connection Deletion procedure ..... | 35 | +| 5.4.1 General ..... | 35 | +| 5.4.1.1 Proxy Binding Update ..... | 36 | +| 5.4.1.2 Proxy Binding Acknowledgement..... | 38 | +| 5.4.2 MAG procedures ..... | 39 | +| 5.4.3 LMA procedures..... | 39 | +| 5.5 Proxy Mobile IPv6 LMA Initiated PDN Connection Deletion procedure ..... | 40 | +| 5.5.1 General ..... | 40 | +| 5.5.1.1 Binding Revocation Indication ..... | 40 | +| 5.5.2 MAG procedures ..... | 42 | +| 5.5.3 LMA procedures..... | 42 | +| 5.6 Proxy Mobile IPv6 PDN Connection IPv4 address allocation procedure ..... | 42 | +| 5.6.1 General ..... | 42 | +| 5.6.1.1 Proxy Binding Update ..... | 43 | +| 5.6.1.2 Proxy Binding Acknowledgement..... | 44 | +| 5.6.2 MAG procedures ..... | 45 | +| 5.6.3 LMA procedures..... | 46 | +| 5.7 Proxy Mobile IPv6 LMA Initiated IPv4 Address Release procedure ..... | 46 | +| 5.7.1 General ..... | 46 | +| 5.7.1.1 Binding Revocation Indication ..... | 46 | +| 5.7.1.2 Binding Revocation Acknowledgment..... | 47 | +| 5.7.2 MAG procedures ..... | 48 | +| 5.7.3 LMA procedures..... | 48 | +| 5.8 Proxy Mobile IPv6 Multiple PDN Extensions ..... | 48 | +| 5.8.1 General ..... | 48 | +| 5.8.2 Extensions to PMIPv6 Data Structure ..... | 48 | + +| | | | +|----------|--------------------------------------------------------------------------|----| +| 5.8.3 | Extensions to PMIPv6 BULE and BCE Lookups ..... | 49 | +| 5.8.3.1 | General..... | 49 | +| 5.8.3.2 | Extensions to PMIPv6 BCE Lookups..... | 49 | +| 5.8.3.3 | Extensions to PMIPv6 BULE Lookups ..... | 49 | +| 5.8.4 | Extensions to PMIPv6 Procedure..... | 50 | +| 5.8.4.1 | General..... | 50 | +| 5.8.4.2 | MAG procedure ..... | 50 | +| 5.8.4.3 | LMA procedure..... | 50 | +| 5.9 | Serving GW Procedure at Chaining Case ..... | 50 | +| 5.9.1 | General ..... | 50 | +| 5.9.2 | Signalling procedures ..... | 50 | +| 5.9.2.1 | PMIP-based S8 Serving GW procedures..... | 50 | +| 5.9.3 | Payload packets at chained case..... | 51 | +| 5.10 | Proxy Mobile IPv6 MAG Initiated IPv4 Address Release procedure ..... | 51 | +| 5.10.1 | General ..... | 51 | +| 5.10.1.1 | Proxy Binding Update ..... | 51 | +| 5.10.1.2 | Proxy Binding Acknowledgement..... | 52 | +| 5.10.2 | MAG procedures ..... | 53 | +| 5.10.3 | LMA procedures..... | 53 | +| 5.11 | Proxy Mobile IPv6 LMA Initiated Update Notification procedure ..... | 53 | +| 5.11.1 | General ..... | 53 | +| 5.11.1.1 | Update Notification..... | 54 | +| 5.11.1.2 | Update Notification Acknowledgement ..... | 54 | +| 5.11.2 | LMA procedures..... | 55 | +| 5.11.3 | MAG procedures ..... | 55 | +| 5.12 | Proxy Mobile IPv6 Mobile Network Prefix Allocation procedure ..... | 55 | +| 5.12.1 | General ..... | 55 | +| 5.12.1.1 | Proxy Binding Update ..... | 55 | +| 5.12.1.2 | Proxy Binding Acknowledgement..... | 56 | +| 5.12.2 | MAG procedures ..... | 57 | +| 5.12.3 | LMA procedures..... | 57 | +| 6 | Tunnel Management procedures..... | 58 | +| 6.1 | General ..... | 58 | +| 6.2 | MAG procedure..... | 58 | +| 6.3 | LMA procedure..... | 59 | +| 6.4 | Data Structures ..... | 59 | +| 6.4.1 | Binding Update List Entry..... | 59 | +| 6.4.2 | Binding Cache Entry ..... | 60 | +| 6.5 | Security..... | 61 | +| 7 | Path Management procedures ..... | 62 | +| 7.1 | General ..... | 62 | +| 7.2 | Heartbeat Mechanism..... | 62 | +| 7.2.1 | General ..... | 62 | +| 7.2.2 | Heartbeat Message..... | 62 | +| 7.2.2.1 | Heartbeat Request..... | 62 | +| 7.2.2.2 | Heartbeat Response..... | 62 | +| 7.3 | Void..... | 63 | +| 7.4 | Void..... | 63 | +| 7.5 | Void..... | 63 | +| 7.6 | UE-specific Error Handling ..... | 63 | +| 7.6.1 | General ..... | 63 | +| 7.6.2 | MAG and LMA procedure ..... | 63 | +| 7.7 | Void..... | 63 | +| 7.8 | Partial node failure requiring the removal of a subset of sessions ..... | 63 | +| 7.8.1 | General ..... | 63 | +| 7.8.2 | Binding Revocation Indication message ..... | 63 | +| 7.8.3 | Binding Revocation Acknowledgement message ..... | 64 | +| 7.8.4 | MAG procedures ..... | 64 | +| 7.8.5 | LMA procedures..... | 64 | + +| | | | +|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|----| +| 8 | PMIP-based S5 and PMIP-based S8 description ..... | 65 | +| 8.1 | Initial Attach procedures ..... | 65 | +| 8.1.1 | General ..... | 65 | +| 8.1.2 | Serving GW procedures ..... | 65 | +| 8.1.3 | PDN GW procedures ..... | 65 | +| 8.2 | Serving GW Initiated PDN Connection Lifetime Extension procedures..... | 65 | +| 8.2.1 | General ..... | 65 | +| 8.2.2 | Serving GW procedures ..... | 65 | +| 8.2.3 | PDN GW procedures ..... | 65 | +| 8.3 | UE, MME or HSS initiated Detach procedures ..... | 65 | +| 8.3.1 | General ..... | 65 | +| 8.3.2 | Serving GW procedures ..... | 65 | +| 8.3.3 | PDN GW procedures ..... | 65 | +| 8.4 | PDN GW Initiated PDN Disconnection procedures ..... | 66 | +| 8.4.1 | General ..... | 66 | +| 8.4.2 | Serving GW procedures ..... | 66 | +| 8.4.3 | PDN GW procedures ..... | 66 | +| 8.5 | UE Requested Additional PDN Connectivity procedures..... | 66 | +| 8.5.1 | General ..... | 66 | +| 8.5.2 | Serving GW procedures ..... | 66 | +| 8.5.3 | PDN GW procedures ..... | 66 | +| 8.6 | Handover procedures..... | 66 | +| 8.6.1 | Intra-LTE TAU and Inter-eNodeB Handover with Serving GW Relocation procedures ..... | 66 | +| 8.6.1.1 | General ..... | 66 | +| 8.6.1.2 | Serving GW procedures ..... | 66 | +| 8.6.1.3 | PDN GW procedures ..... | 66 | +| 8.6.2 | TAU/RAU or Handover between GERAN A/Gb Mode or UTRAN Iu Mode and E-UTRAN procedures..... | 67 | +| 8.6.2.1 | General ..... | 67 | +| 8.6.2.2 | Serving GW procedures ..... | 67 | +| 8.6.2.3 | PDN GW procedures ..... | 67 | +| 8.6.3 | Handover from Trusted or Untrusted Non-3GPP IP Access over S2a/S2b to 3GPP Access Handover E-UTRAN over PMIP based S5/S8 without optimization procedures ..... | 67 | +| 8.6.3.1 | General ..... | 67 | +| 8.6.3.2 | Serving GW procedures ..... | 67 | +| 8.6.3.3 | PDN GW procedures ..... | 67 | +| 8.6.4 | Handover from Trusted or Untrusted Non-3GPP IP Access over S2a/S2b to 3GPP Access UTRAN/GERAN over PMIP based S5/S8 without optimization ..... | 67 | +| 8.6.4.1 | General ..... | 67 | +| 8.6.4.2 | Serving GW procedures ..... | 67 | +| 8.6.4.3 | PDN GW procedures ..... | 67 | +| 8.6.5 | Handover from Trusted or Untrusted Non-3GPP IP Access over S2c to 3GPP Access over PMIP based S5/S8 without optimization ..... | 68 | +| 8.6.5.1 | General ..... | 68 | +| 8.6.5.2 | Serving GW procedures ..... | 68 | +| 8.6.5.3 | PDN GW procedures ..... | 68 | +| 8.6.6 | Void ..... | 68 | +| 8.6.7 | Void ..... | 68 | +| 8.7 | UE Requested PDN Disconnection procedures ..... | 68 | +| 8.7.1 | General ..... | 68 | +| 8.7.2 | Serving GW procedures ..... | 68 | +| 8.7.3 | PDN GW procedures ..... | 68 | +| 8.8 | IPv4 Address Allocation using DHCP ..... | 68 | +| 8.8.1 | General ..... | 68 | +| 8.8.2 | Serving GW procedures ..... | 68 | +| 8.8.3 | PDN GW procedures ..... | 68 | +| 8.9 | PDN-GW Initiated IPv4 Address Delete Procedure ..... | 69 | +| 8.9.1 | General ..... | 69 | +| 8.9.2 | Serving GW procedures ..... | 69 | +| 8.9.3 | PDN GW procedures ..... | 69 | +| 8.10 | Mobile Network Prefix Allocation using DHCPv6 Prefix Delegation ..... | 69 | +| 8.10.1 | General ..... | 69 | + +| | | | +|--------|-------------------------------------------------------------------------------------------------------------|----| +| 8.10.2 | Serving GW procedures ..... | 69 | +| 8.10.3 | PDN GW procedures ..... | 69 | +| 9 | Trusted Non-3GPP Access over S2a Description ..... | 69 | +| 9.0 | General ..... | 69 | +| 9.1 | Initial Attach procedures ..... | 69 | +| 9.1.1 | General ..... | 69 | +| 9.1.2 | Trusted Non-3GPP Access procedures ..... | 69 | +| 9.1.3 | PDN GW procedures ..... | 69 | +| 9.2 | Trusted Non-3GPP Access Initiated PDN Connection Lifetime Extension procedures ..... | 70 | +| 9.2.1 | General ..... | 70 | +| 9.2.2 | Trusted Non-3GPP Access procedures ..... | 70 | +| 9.2.3 | PDN GW procedures ..... | 70 | +| 9.3 | UE / Trusted Non-3GPP Access Initiated Detach and UE Requested PDN Disconnection procedures ..... | 70 | +| 9.3.1 | General ..... | 70 | +| 9.3.2 | Trusted Non-3GPP Access procedures ..... | 70 | +| 9.3.3 | PDN GW procedures ..... | 70 | +| 9.4 | HSS / AAA Initiated Detach procedures ..... | 70 | +| 9.4.1 | General ..... | 70 | +| 9.4.2 | Trusted Non-3GPP Access procedures ..... | 70 | +| 9.4.3 | PDN GW procedures ..... | 70 | +| 9.5 | UE Initiated Connectivity to Additional PDN procedures ..... | 71 | +| 9.5.1 | General ..... | 71 | +| 9.5.2 | Trusted Non-3GPP Access procedures ..... | 71 | +| 9.5.3 | PDN GW procedures ..... | 71 | +| 9.6 | 3GPP Access to Trusted Non-3GPP IP Access with PMIPv6 on S2a Handover procedures without optimization ..... | 71 | +| 9.6.1 | General ..... | 71 | +| 9.6.2 | Trusted Non-3GPP Access procedures ..... | 71 | +| 9.6.3 | PDN GW procedures ..... | 71 | +| 9.7 | PDN GW Initiated Resource Allocation Deactivation procedures ..... | 71 | +| 9.7.1 | General ..... | 71 | +| 9.7.2 | Trusted Non-3GPP Access procedures ..... | 71 | +| 9.7.3 | PDN GW procedures ..... | 71 | +| 9.8 | IPv4 Address Allocation using DHCP ..... | 72 | +| 9.8.1 | General ..... | 72 | +| 9.8.2 | Trusted Non-3GPP Access procedures ..... | 72 | +| 9.8.3 | PDN GW procedures ..... | 72 | +| 9.9 | PDN-GW Initiated IPv4 Address Delete Procedure ..... | 72 | +| 9.9.1 | General ..... | 72 | +| 9.9.2 | Trusted Non-3GPP Access procedures ..... | 72 | +| 9.9.3 | PDN GW procedures ..... | 72 | +| 9.10 | Optimized E-UTRAN to CDMA2000 eHRPD Handover procedure ..... | 72 | +| 9.10.1 | General ..... | 72 | +| 9.10.2 | CDMA2000 HRPD access procedure ..... | 72 | +| 9.10.3 | PDN GW procedures ..... | 72 | +| 9.11 | Optimized Idle Mode Mobility: E-UTRAN Access to cdma2000 eHRPD Access procedure ..... | 73 | +| 9.11.1 | General ..... | 73 | +| 9.11.2 | CDMA2000 eHRPD access procedure ..... | 73 | +| 9.11.3 | PDN GW procedures ..... | 73 | +| 10 | Untrusted Non-3GPP Access over S2b Description ..... | 73 | +| 10.1 | Initial Attach procedures ..... | 73 | +| 10.1.1 | General ..... | 73 | +| 10.1.2 | ePDG procedures ..... | 73 | +| 10.1.3 | PDN GW procedures ..... | 74 | +| 10.2 | ePDG Initiated PDN Connection Lifetime Extension procedures ..... | 74 | +| 10.2.1 | General ..... | 74 | +| 10.2.2 | ePDG procedures ..... | 74 | +| 10.2.3 | PDN GW procedures ..... | 74 | +| 10.3 | UE / ePDG Initiated Detach and UE Requested PDN Disconnection procedures ..... | 74 | +| 10.3.1 | General ..... | 74 | + +| | | | +|----------|--------------------------------------------------------------------------------------------------------------|----| +| 10.3.2 | ePDG procedures ..... | 74 | +| 10.3.3 | PDN GW procedures ..... | 75 | +| 10.4 | HSS / AAA Initiated Detach procedures..... | 75 | +| 10.4.1 | General ..... | 75 | +| 10.4.2 | ePDG procedures ..... | 75 | +| 10.4.3 | PDN GW procedures ..... | 75 | +| 10.5 | UE Initiated Connectivity to Additional PDN procedures ..... | 75 | +| 10.5.1 | General ..... | 75 | +| 10.5.2 | ePDG procedures ..... | 75 | +| 10.5.3 | PDN GW procedures ..... | 76 | +| 10.6 | 3GPP Access to Untrusted Non-3GPP IP Access with PMIPv6 on S2b Handover procedures without optimization..... | 76 | +| 10.6.1 | General ..... | 76 | +| 10.6.2 | ePDG procedures ..... | 76 | +| 10.6.3 | PDN GW procedures ..... | 76 | +| 10.7 | PDN GW Initiated Resource Allocation Deactivation procedures ..... | 76 | +| 10.7.1 | General ..... | 76 | +| 10.7.2 | ePDG procedures ..... | 76 | +| 10.7.3 | PDN GW procedures ..... | 76 | +| 10.8 | PDN-GW Initiated IPv4 Address Delete Procedure ..... | 77 | +| 10.8.1 | General ..... | 77 | +| 10.8.2 | ePDG procedures ..... | 77 | +| 10.8.3 | PDN GW procedures ..... | 77 | +| 11 | S2a and S2b Chaining with PMIP-based S8 Description ..... | 77 | +| 11.1 | Initial Attach procedures ..... | 77 | +| 11.1.1 | General ..... | 77 | +| 11.1.2 | ePDG / Trusted Non-3GPP Access procedures..... | 77 | +| 11.1.3 | Serving GW procedures ..... | 77 | +| 11.2 | ePDG / Trusted Non-3GPP Access Initiated PDN Connection Lifetime Extension procedures ..... | 78 | +| 11.2.1 | General ..... | 78 | +| 11.2.2 | ePDG / Trusted Non-3GPP Access procedures..... | 78 | +| 11.2.3 | Serving GW procedures ..... | 78 | +| 11.3 | UE / ePDG / Trusted Non-3GPP Access Initiated Detach procedures ..... | 78 | +| 11.3.1 | General ..... | 78 | +| 11.3.2 | ePDG / Trusted Non-3GPP Access procedures..... | 78 | +| 11.3.3 | Serving GW procedures ..... | 78 | +| 11.4 | HSS / AAA Initiated Detach procedures..... | 78 | +| 11.4.1 | General ..... | 78 | +| 11.4.2 | ePDG / Trusted Non-3GPP Access procedures..... | 78 | +| 11.4.3 | Serving GW procedures ..... | 78 | +| 11.5 | UE Initiated Connectivity to Additional PDN procedures ..... | 79 | +| 11.5.1 | General ..... | 79 | +| 11.5.2 | ePDG / Trusted Non-3GPP Access procedures..... | 79 | +| 11.5.3 | Serving GW procedures ..... | 79 | +| 11.6 | 3GPP Access to Trusted / Untrusted Non-3GPP IP Access Handover procedures without optimization..... | 79 | +| 11.6.1 | General ..... | 79 | +| 11.6.2 | ePDG / Trusted Non-3GPP Access procedures..... | 79 | +| 11.6.3 | Serving GW procedures ..... | 79 | +| 11.7 | UE Requested PDN Disconnection procedures ..... | 80 | +| 11.7.1 | General ..... | 80 | +| 11.7.2 | ePDG / Trusted Non-3GPP Access procedures..... | 80 | +| 11.7.3 | Serving GW procedures ..... | 80 | +| 11.8 | PDN GW Initiated Resource Allocation Deactivation procedures ..... | 80 | +| 11.8.1 | General ..... | 80 | +| 11.8.2 | ePDG / Trusted Non-3GPP Access procedures..... | 80 | +| 11.8.3 | Serving GW procedures ..... | 80 | +| 12 | Information Elements..... | 80 | +| 12.1 | Additional Proxy Mobile IPv6 Information Elements ..... | 80 | +| 12.1.1 | 3GPP-Specific PMIPv6 Information Elements ..... | 80 | +| 12.1.1.0 | General ..... | 80 | + +| | | | +|-----------|---------------------------------------------------------------------------------------|----| +| 12.1.1.1 | 3GPP Specific PMIPv6 error code ..... | 82 | +| 12.1.1.2 | Fully Qualified PDN Connection Set Identifier (FQ-CSID) ..... | 82 | +| 12.1.1.3 | PDN Type Indication ..... | 83 | +| 12.1.1.4 | PDN GW IP address ..... | 83 | +| 12.1.1.5 | DHCPv4 Address Allocation Procedure Indication ..... | 84 | +| 12.1.1.6 | Charging ID ..... | 84 | +| 12.1.1.7 | Selection Mode ..... | 84 | +| 12.1.1.8 | Charging Characteristics ..... | 84 | +| 12.1.1.9 | Serving Network ..... | 85 | +| 12.1.1.10 | Mobile Equipment Identity ..... | 85 | +| 12.1.1.11 | MSISDN ..... | 85 | +| 12.1.1.12 | APN Restriction ..... | 86 | +| 12.1.1.13 | Maximum APN Restriction ..... | 86 | +| 12.1.1.14 | Unauthenticated IMSI ..... | 86 | +| 12.1.1.15 | PDN Connection ID ..... | 86 | +| 12.1.1.16 | PGW Back-Off Time ..... | 87 | +| 12.1.1.17 | Signalling Priority Indication ..... | 87 | +| 12.1.1.18 | Static IP Address Allocation Indication ..... | 87 | +| 12.1.1.19 | Additional Protocol Configuration Options ..... | 88 | +| 12.1.1.20 | MME/SGSN Identifier ..... | 88 | +| 12.1.1.21 | End Marker Notification ..... | 88 | +| 12.1.1.22 | Trusted WLAN Mode Indication ..... | 88 | +| 12.1.1.23 | UE Time Zone ..... | 89 | +| 12.1.1.24 | Access Network Identifier Timestamp ..... | 89 | +| 12.1.1.25 | Logical Access ID ..... | 90 | +| 12.1.1.26 | Origination Time Stamp ..... | 90 | +| 12.1.1.27 | Maximum Wait Time ..... | 90 | +| 12.1.1.28 | TWAN Capabilities ..... | 91 | +| 13 | Trusted WLAN Access over S2a Description ..... | 91 | +| 13.1 | Initial Attach procedures ..... | 91 | +| 13.1.1 | General ..... | 91 | +| 13.1.2 | TWAN procedures ..... | 91 | +| 13.1.3 | PDN GW procedures ..... | 92 | +| 13.2 | TWAN Initiated PDN Connection Lifetime Extension procedures ..... | 92 | +| 13.2.1 | General ..... | 92 | +| 13.2.2 | TWAN procedures ..... | 92 | +| 13.2.3 | PDN GW procedures ..... | 93 | +| 13.3 | UE / TWAN Initiated Detach and UE/TWAN Requested PDN Disconnection procedures ..... | 93 | +| 13.3.1 | General ..... | 93 | +| 13.3.2 | TWAN procedures ..... | 93 | +| 13.3.3 | PDN GW procedures ..... | 93 | +| 13.4 | HSS / AAA Initiated Detach procedures ..... | 93 | +| 13.4.1 | General ..... | 93 | +| 13.4.2 | TWAN procedures ..... | 93 | +| 13.4.3 | PDN GW procedures ..... | 93 | +| 13.5 | PDN GW Initiated Resource Allocation Deactivation procedures ..... | 94 | +| 13.5.1 | General ..... | 94 | +| 13.5.2 | TWAN procedures ..... | 94 | +| 13.5.3 | PDN GW procedures ..... | 94 | +| 13.6 | 3GPP Access to TWAN with PMIPv6 on S2a Handover procedures without optimization ..... | 94 | +| 13.6.1 | General ..... | 94 | +| 13.6.2 | TWAN procedures ..... | 94 | +| 13.6.3 | PDN GW procedures ..... | 94 | +| 13.7 | UE Initiated Connectivity to Additional PDN procedures ..... | 95 | +| 13.7.1 | General ..... | 95 | +| 13.7.2 | TWAN procedures ..... | 95 | +| 13.7.3 | PDN GW procedures ..... | 95 | +| 14 | Proxy Mobile IPv6 EPC Restoration Procedure ..... | 95 | +| 14.1 | PGW triggered SGW restoration procedure ..... | 95 | +| 14.1.1 | General ..... | 95 | + +| | | | +|-------------------------------|----------------------------------------------------------------|------------| +| 14.1.2 | Serving GW procedures ..... | 96 | +| 14.1.3 | PDN GW procedures ..... | 96 | +| 14.2 | Update PDP context/Bearer at P-CSCF failure..... | 96 | +| 14.2.1 | General ..... | 96 | +| 14.2.2 | PDN GW procedures ..... | 96 | +| 14.2.3 | Serving GW, TWAN and ePDG procedures ..... | 96 | +| 14.3 | Inform UE about P-CSCF failure..... | 97 | +| 14.3.1 | General ..... | 97 | +| 14.3.2 | PDN GW procedures ..... | 97 | +| 14.3.3 | Serving GW procedures ..... | 97 | +| 15 | Proxy Mobile IPv6 End Marker Notification Procedure ..... | 97 | +| 15.1 | General ..... | 97 | +| 15.2 | Serving GW procedures ..... | 97 | +| 15.3 | PDN GW procedures..... | 98 | +| Annex A: | void..... | 99 | +| Annex B (Normative): | Definition of the protocol number in pseudo-header..... | 99 | +| B.1 | General ..... | 99 | +| B.2 | Interworking of different protocol number ..... | 99 | +| Annex C (informative): | Change History..... | 100 | + +--- + +--- + +## 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 of the PMIPv6 Based Mobility and Tunnelling Protocols used over the PMIP-based S2a, S2b, S5, and S8 reference points defined in 3GPP TS 23.402 [3], and are thus applicable to the Serving GW, PDN Gateway, ePDG, and Trusted Non-3GPP Access. Protocols specifications are compliant with relevant IETF RFCs. In this specification PMIP refers to PMIPv6 as defined in IETF RFC5213 [4] taking into account the corrections regarding the protocol number definition in IETF RFC6275 [8]. + +# 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.401: "GPRS enhancements for E-UTRAN access ". +- [3] 3GPP TS 23.402: "Architecture Enhancements for non-3GPP accesses". +- [4] IETF RFC 5213: "Proxy Mobile IPv6". +- [5] IETF RFC 5844: "IPv4 Support for Proxy Mobile IPv6". +- [6] IETF RFC 5846: "Binding Revocation for IPv6 Mobility". +- [7] IETF RFC 5845: "Generic Routing Encapsulation (GRE) Key Option for Proxy Mobile IPv6". +- [8] IETF RFC 6275: "Mobility Support in IPv6". +- [9] IETF RFC 4282: "The Network Access Identifier". +- [10] IETF RFC 4283: "Mobile Node Identifier Option for Mobile IPv6 (MIPv6)". +- [11] IETF RFC 5149: "Service Selection for Mobile Ipv6". +- [12] 3GPP TS 23.003: "Numbering, addressing and identification". +- [13] 3GPP TS 23.007: "Restoration Procedures". +- [14] Void +- [15] Void +- [16] 3GPP TS 24.008: "Mobile radio interface Layer 3 specification; Core network protocols". +- [17] IETF RFC 5847: "Heartbeat Mechanism for Proxy Mobile IPv6". +- [18] IANA Mobile Ipv6 Parameters Registry, <>. +- [19] 3GPP TS 33.402: "3GPP System Architecture Evolution (SAE); Security aspects of non-3GPP accesses". +- [20] IETF RFC 2784: "Generic Routing Encapsulation (GRE)". + +- [21] IETF RFC 2890: "Key and Sequence Number Extensions to GRE". +- [22] 3GPP TS 29.274: "3GPP Evolved Packet System (EPS); Evolved General Packet Radio Service (GPRS) Tunnelling Protocol for Control plane (GTPv2-C); Stage 3". +- [23] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [24] 3GPP TS 29.282: "Mobile IPv6 vendor specific option format and usage within 3GPP". +- [25] 3GPP TS 32.251: "Charging Management; Packet Switched (PS) domain charging". +- [26] 3GPP TS 32.298: "Charging Management; Charging Data Record (CDR) parameter description". +- [27] IETF RFC 4291: "IP Version 6 Addressing Architecture". +- [28] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp interface". +- [29] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [30] 3GPP TS 29.212: "Policy and Charging Control (PCC); Reference points". +- [31] IETF RFC 2473: "Generic Packet Tunneling in IPv6 Specification". +- [32] IANA Registry of Assigned Numbers. Mobile IPv6 parameters, Status Codes: +. +- [33] IANA Registry of Assigned Numbers. Mobile IPv6 parameters, Binding Revocation Acknowledgement Status Codes: +. +- [34] IETF RFC5555: "Mobile IPv6 Support for Dual Stack Hosts and Routers". +- [35] IETF RFC 7077: "Update Notifications for Proxy Mobile IPv6". +- [36] 3GPP TS 23.380: "IMS Restoration Procedures". +- [37] IETF RFC 6757: "Access Network Identifier Option". +- [38] IETF RFC 3775, "Mobility Support in IPv6". +- [39] 3GPP TS 24.302: "Access to the 3GPP Evolved Packet Core (EPC) via non-3GPP access networks; Stage 3". +- [40] IETF RFC 5905, "Network Time Protocol Version 4: Protocol and Algorithms Specification". +- [41] IETF RFC 7563: "Extensions to the Proxy Mobile IPv6 (PMIPv6) Access Network Identifier Option". +- [42] IETF RFC 3046: "DHCP Relay Agent Information Option". +- [43] IETF RFC 6463: "Runtime Local Mobility Anchor (LMA) Assignment Support for Proxy Mobile IPv6". +- [44] IETF RFC 7389: "Separation of Control and User Plane for Proxy Mobile IPv6". +- [45] IETF RFC 7148: "Prefix Delegation Support for Proxy Mobile IPv6". + +## 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]. + +The following terms used in this Technical Specification are defined in: + +- the PMIPv6 specification IETF RFC 5213 [4]: IPv6 Home Network Prefix, Proxy Care-of Address, Local Mobility Anchor Address; +- the IPv4 Support for PMIPv6 specification IETF RFC 5844 [5]: IPv4 Home Address, IPv4 Local Mobility Anchor Address; +- the MIPv6 specification [8] and extended by the PMIPv6 specification IETF RFC 5213 [4]: Binding Cache Entry, Binding Update List Entry; +- the Binding Revocation for IPv6 Mobility [6]: Binding Revocation Indication and Binding Revocation Acknowledgement; +- the Separation of Control and User Plane for PMIPv6 specification IETF RFC 7389 [44]: LMA User-Plane Address. + +**Local Mobility Anchor:** Within EPS the Local Mobility Anchor functionality consists of a PMIPv6 Local Mobility Anchor as described in the PMIPv6 specification IETF RFC 5213 [4] with support of IPv4 Support for PMIPv6 as defined in IETF RFC 5844 [5], Binding Revocation for IPv6 Mobility as defined in IETF RFC 5846 [6], GRE Key Option for PMIPv6 as defined in IETF RFC 5845 [7], and PMIPv6 Heartbeat Mechanism as defined in IETF RFC 5847 [17]. + +**Mobile Access Gateway:** Within EPS the Mobility Access Gateway functionality consists of a PMIPv6 Mobility Access Gateway as described in the PMIPv6 specification IETF RFC 5213 [4] with support of IPv4 Support for PMIPv6 as defined in IETF RFC 5844 [5], Binding Revocation for IPv6 Mobility as defined in IETF RFC 5846 [6], GRE Key Option for PMIPv6 as defined in IETF RFC 5845 [7], and PMIPv6 Heartbeat Mechanism as defined in IETF RFC 5847 [17]. + +**PDN Connection:** The association between a UE represented by one IPv4 Home Address and/or one IPv6 Home Network Prefix, and a PDN represented by an APN. On a PMIPv6 peer (MAG or LMA) there is a one-to-one mapping between a PDN connection and a PMIPv6 binding. + +### 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]. + +| | | +|-----------|-------------------------------------------------| +| 3GSPEC | 3GPP Specific PMIPv6 Error Code | +| BCE | Binding Cache Entry | +| BRA | Binding Revocation Acknowledgement | +| BRI | Binding Revocation Indication | +| BULE | Binding Update List Entry | +| EPC | Evolved Packet Core | +| ePDG | Evolved Packet Data Gateway | +| GRE | Generic Routing Encapsulation | +| GW | Gateway | +| IMSI | International Mobile Subscriber Identity | +| IMEI | International Mobile station Equipment Identity | +| IPv4-LMAA | IPv4 LMAA | +| LMA | Local Mobility Anchor | +| LMAA | LMA Address | + +| | | +|-----------|------------------------------------| +| MAG | Mobility Access Gateway | +| MIPv6 | Mobile IPv6 | +| NAI | Network Access Identifier | +| PBA | Proxy Binding Acknowledgment | +| PBU | Proxy Binding Update | +| PMIPv6 | Proxy MIPv6 | +| Proxy-CoA | Proxy Care-of Address | +| TWAN | Trusted WLAN Access Network | +| UPN | Update Notification | +| UPA | Update Notification Acknowledgment | + +## 4 General + +### 4.1 PDN connection + +On a PMIPv6 peer (MAG or LMA) there is a one-to-one mapping between a PDN connection and a PMIPv6 binding. + +Traffic sent over a given PDN connection is encapsulated with GRE [20] using different, per-interface per-PDN connection, per direction (uplink and downlink) GRE keys [21] to allow multiplexing and demultiplexing of traffic belonging to different PDN connections at MAG and LMA. For the handover between 3GPP access and non-3GPP access, the uplink GRE Key shall be the same. + +### 4.2 PMIPv6 protocol stacks + +Protocol stacks for PMIPv6 are depicted in Figure 4.2-1. The MAG functions are defined in 3GPP TS 23.402 [3], e. g., relaying DHCPv4/DHCPv6 packets between the UE and the DHCP server, forwarding the payload packets between the UE and the LMA. + +![Figure 4.2-1: Protocol stacks for PMIPv6. The diagram shows three protocol stacks: Control Plane A, Control Plane B, and User Plane. Control Plane A and B show PMIPv6 over UDP over IPv4/IPv6 over L2/L1. User Plane shows PMIPv6 over GRE over IPv4/IPv6 over L2/L1.](d17f75945bbb3feb84a153ecfedb9b81_img.jpg) + +The diagram illustrates three protocol stacks for PMIPv6, labeled Control Plane A, Control Plane B, and User Plane. Each stack shows the protocol layers on the MAG (Mobility Access Gateway) and LMA (LMA) sides, separated by a vertical dashed line. + +- Control Plane A:** Both MAG and LMA have a stack of PMIPv6, UDP, IPv4, and L2/L1. +- Control Plane B:** Both MAG and LMA have a stack of PMIPv6, IPv6, and L2/L1. +- User Plane:** Both MAG and LMA have a stack of IPv4/IPv6, GRE, IPv4/IPv6, and L2/L1. + +Figure 4.2-1: Protocol stacks for PMIPv6. The diagram shows three protocol stacks: Control Plane A, Control Plane B, and User Plane. Control Plane A and B show PMIPv6 over UDP over IPv4/IPv6 over L2/L1. User Plane shows PMIPv6 over GRE over IPv4/IPv6 over L2/L1. + +Figure 4.2-1: Protocols stacks for PMIPv6 + +The Control Plane A shall be used if PMIPv6 messages are transported over IPv4 as described in IETF RFC 5844 [5]. The Control Plane B shall be used if PMIPv6 messages are transported over IPv6 as described in IETF RFC 5213 [4]. User Plane traffic shall be transported with GRE encapsulation as described in IETF RFC 2890 [21] (see also IETF RFC 2784 [20]). + +Figure 4.2-2: Void + +## 5 Mobility Management procedures + +### 5.1 Proxy Mobile IPv6 PDN Connection Creation procedure + +#### 5.1.1 General + +The PMIPv6 PDN Connection Creation procedure is initiated by the node acting as a MAG to create a new PDN connection with the node acting as an LMA for an UE that either attaches for the first time to the EPC, or connects to an additional PDN. The procedure starts with the MAG sending a PBU including the APN to the LMA to register with the LMA a binding for the UE's PDN connection. If multiple PDN connections to the same APN function is supported by the MAG, a PDN connection ID shall also be included in the same PBU message. The LMA confirms establishment of the binding by sending a PBA to the MAG. If multiple PDN connections to the same APN function is supported by the LMA, the received PDN connection ID shall also be included in the same PBA message. Establishment of the binding achieves the following: + +- **PDN selection:** The LMA select the PDN based on the APN contained in the PBU. +- **IPv6 Home Network Prefix assignment:** The LMA assigns to the UE's PDN connection an IPv6 Home Network Prefix valid in the selected PDN. +- **IPv4 Home Address assignment:** The LMA assigns to the UE's PDN connection an IPv4 Home Address valid in the selected PDN. +- **Downlink and Uplink GRE Key Assignment:** The MAG and LMA will establish downlink and uplink GRE keys to be used for GRE encapsulation of the PDN connection's downlink and uplink traffic, respectively. +- **GRE Tunnel Establishment:** A GRE tunnel is established between the MAG and LMA with the assigned GRE keys to carry uplink and downlink traffic that the UE respectively sends and receives on the PDN connection. +- **BCE Creation:** The LMA creates a BCE for the PDN connection. +- **BULE Creation:** The MAG creates a BULE for the PDN connection. +- **MAG Link Local Address assignment:** The LMA assigns the MAG link local address. +- **UE Interface Identifier (IID) assignment:** The LMA assigns to the UE an IPv6 Interface Identifier to allow formation of an UE Link Local Address from the well-known link local address prefix (fe80::/64). +- **PDN connection ID:** The PDN connection ID is provided by the MAG and accepted by LMA, if multiple PDN connections to the same APN function is supported by both MAG and LMA. +- **LMA Control Plane Address:** the LMA may assign an alternate LMAA or IPv4-LMAA, if this option is supported by both MAG and LMA. +- **LMA User Plane Address:** the LMA may assign an alternate LMA address for user plane, if this option is supported by both MAG and LMA. + +Regarding the usage and support of the protocol number in the pseudo-header see Annex B. + +##### 5.1.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 PDN Connection Creation procedure are depicted in Table 5.1.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 PDN Connection Creation procedure are depicted in Table 5.1.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +**Table 5.1.1.1-1: Fields of a PBU message for the PMIPv6 PDN Connection Creation procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to the requested number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.1.1.1-2: Mobility Options in a PBU message for the PMIPv6 PDN Connection Creation procedure** + +| Information element | Cat. | IE Description | Reference | +|---------------------------------------------------|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Set to the NAI identifier of the UE as specified in 3GPP TS 23.003 [12]. The format of the NAI is specified in the subclause 19.3 in 3GPP TS 23.003 [12]. | 3GPP TS 23.003 [12] | +| Ipv6 Home Network Prefix option | C | For dynamic allocation, set the Home Network Prefix to the value "0::0" and Prefix Length to the value "0" to request allocation for the UE's PDN connection of an Ipv6 Home Network Prefix in the PDN corresponding the EPS Access Point Name. For static allocation, set the Home Network Prefix to the received static allocated Ipv6 Home Network Prefix and Prefix Length to the value "64".
NOTE 1. | IETF RFC 5213 [4] | +| Link-local Address | C | Present when Ipv6 Home Network Prefix option is present. Link-local address of the MAG. Set to ALL_ZERO (all bits set to 0), indicating that the MAG requests a link-local address to be used on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Set to the value "1" to indicate attachment over a new interface. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the 3GPP access type, i.e. GERAN, UTRAN, E-UTRAN or NB-IoT, or to the value matching the characteristics of the non-3GPP access (e.g., HRPD) the UE is using to attach to the EPS as defined in the Access Technology Type Option type values registry of the IANA Mobile Ipv6 Parameters Registry [18].
The ePDG may use the access technology type of the untrusted non-3GPP access network if it is able to acquire it; otherwise it shall indicate Virtual as the access technology.
The TWAN shall set the Access Technology Type Option value to 4 i.e. "IEEE 802.11a/b/g" on the S2a interface.
NOTE 2.
NOTE 3. | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| GRE key option | M | Set to the downlink GRE key to be used for downlink GRE encapsulated packets sent over the PDN connection. | IETF RFC 5845 [7] | +| Ipv4 Home Address Request option | C | For dynamic allocation, set the Ipv4 Home Address to the value "0.0.0.0" and Prefix-len to the value "0" or "32" to request allocation for the UE's PDN connection of an Ipv4 Home Address in the PDN corresponding to the EPS Access Point Name. For static allocation, set the Ipv4 Home Address to the received static allocated Ipv4 Home Address and Prefix-len to the value "32".
NOTE 1. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE attaches the new PDN connection.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte.
The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 4. | IETF RFC 5149 [11] | +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| PDN GW IP Address | O | Contain PDN GW IP address (on S2a or S2b when used for chained S2a/S2b-PMIP based S8). | Subclause 12.1.1.4 | +| MAG Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the MAG on the S5/S8, S2a (for Trusted WLAN Access) and S2b interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| MME Fully Qualified | O | Contain a Fully Qualified PDN Connection Set Identifier | Subclause 12.1.1.2 | + +| | | | | +|-------------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| PDN Connection Set Identifier | | if generated by the MME, and included by the MAG on the S5/S8 interfaces as specified in 3GPP TS 23.007 [13]. | | +| Selection Mode | O | Contains APN selection mode (on S5/S8). | Subclause 12.1.1.7 | +| Charging Characteristics | O | Contains the Charging Characteristics to be applied for EPC charging | Subclause 12.1.1.8 | +| Serving Network | C | This IE shall be included on S2a (for TWAN access), S5 and S8 interfaces to identify the Serving Network.
This IE may be included on S2a to identify the Serving Network of the eHRPD access network. | Subclause 12.1.1.9 | +| Mobile Equipment Identity | O | This IE shall contain the MEI of the UE and shall be present, if available, on the S5, S8, S2a or S2b interface. | Subclause 12.1.1.10 | +| MSISDN | O | This IE shall contain the MSISDN and shall be present, if available, on the S5, S8, S2a or S2b interfaces. | Subclause 12.1.1.11 | +| Maximum APN Restriction | O | Contains the most stringent restriction of already active PDN connections (on S5/S8). | Subclause 12.1.1.13 | +| Unauthenticated IMSI | O | Contains the Unauthenticated IMSI | Subclause 12.1.1.14 | +| PDN connection ID | O | Contains the PDN connection ID | Subclause 12.1.1.15 | +| Signalling Priority Indication | O | The SGW shall forward this IE on the S5/S8 interfaces if received from the MME/SGSN. | Subclause 12.1.1.17 | +| Additional Protocol Configuration Options | O | Contains Additional Protocol Configuration Options. | Subclause 12.1.1.19 | +| MME/SGSN Identifier | O | The SGW shall include the MME/SGSN Identifier on the S5 interface if the SGW supports the PGW triggered SGW restoration procedure and this information is received from the MME/SGSN as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.20 | +| Access Network Identifier Option | O | The TWAN shall include the access network identifier on S2a. | IETF RFC 6757 [37]
IETF RFC 7563 [41] | +| Trusted WLAN Mode Indication | O | Contains the selected trusted WLAN mode (SCM or MCM) on S2a interface. | Subclause 12.1.1.22 | +| UE Time Zone | O | The TWAN shall include the UE Timezone on the S2a interface. | Subclause 12.1.1.23 | +| Logical Access ID | O | Contains the Circuit-ID with the Relay Identity that allocated it. | Subclause 12.1.1.25 | +| Redirect-Capability Mobility Option | O | The MAG shall include this IE on the S5, S8, S2a and S2b interface if it supports the capability to receive from the LMA an alternate LMAA or Ipv4-LMAA. | IETF RFC 6463 [43] | +| LMA User-Plane Address Mobility Option | O | The MAG shall include this IE on the S5, S8, S2a and S2b interface if it supports the capability to receive from the LMA an alternate LMA address for user plane. If so, the LMA User-Plane Address field within this Mobility Option shall be a zero-length field, or have a value of ALL_ZERO with all bits in the Ipv4 address or the Ipv6 address set to zero. | IETF RFC 7389 [44] | +| Origination Time Stamp | O | The SGW shall forward this IE on the S5/S8 interface if received from the MME/SGSN and if it supports the procedure specified in subclause 13.2 of 3GPP TS 29.274 [22].
The TWAN/ePDG shall include this IE on the S2a/S2b interface for the conditions specified in subclause 13.2 of 3GPP TS 29.274 [22]. | Subclause 12.1.1.26 | +| Maximum Wait Time | O | The SGW shall forward this IE on the S5/S8 interface if received from the MME/SGSN and if it supports the procedure specified in subclause 13.3 of 3GPP TS 29.274 [22].
The TWAN/ePDG shall include this IE on the S2a/S2b interface for the conditions specified in subclause 13.3 of 3GPP TS 29.274 [22]. | Subclause 12.1.1.27 | +| TWAN capabilities | O | The MAG shall include this IE on the S2a interface if any of the applicable flags is set to 1.
Applicable flags are:
- WLCP PDN Connection Modification Support Indication: This flag shall be set to 1 on the S2a interface if the TWAN supports the WLCP PDN | Subclause 12.1.1.28 | + +| | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|------------------------------------|--| +| | | Connection Modification procedure. | | +| NOTE 1: At least one of the two options, namely, the IPv6 Home Network Prefix option or the IPv4 Home Address Request option shall be present. If both an IPv6 Home Network Prefix and an IPv4 Home Address are requested, both options shall be included in the same PBU message. | | | | +| NOTE 2: The methods that the ePDG may use to acquire the access technology type of the untrusted non-3GPP IP access network are not specified in this release. | | | | +| NOTE 3: The PDN-GW can be informed about the type of access network used by the UE over several reference points, see 3GPP TS 29.212 [30] for the mapping between the code values for the different access network types. | | | | +| NOTE 4: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | + +### 5.1.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 PDN Connection Creation procedure are depicted in Table 5.1.1.2-1. + +The Mobility Options in a PBA message for the PMIPv6 PDN Connection Creation procedure are depicted in Table 5.1.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.1.1.2-1: Fields of a PBA message for the PMIPv6 PDN Connection Creation procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to the value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to the granted number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.1.1.2-2: Mobility Options in a PBA message for the PMIPv6 PDN Connection Creation procedure** + +| Information element | Cat. | IE Description | Reference | +|---------------------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| IPv6 Home Network Prefix option | C | Present if IPv6 Home Network Prefix is allocated. When it's present, set the Home Network Prefix to the IPv6 Home Network Prefix Allocated for the UE's PDN connection based on the selected PDN corresponding to the EPS Access Point Name for dynamic allocation, or set to the static IPv6 Home Network Prefix received in the PBU for static allocation. The Prefix Length is set to the value "64". In addition, the Interface Identifier (IID) allocated for the UE is encoded in the low order 64 bits of this option, i.e., the IPv6 Home Network Prefix option. | IETF RFC 5213 [4] | +| Link-local Address | C | Present when IPv6 Home Network Prefix option is present. Link-local address to be used by the MAG on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| GRE key option | M | Set to the uplink GRE key to be used for uplink GRE encapsulated packets sent over the PDN connection. | IETF RFC 5845 [7] | +| IPv4 Home Address Reply Option | C | Present if IPv4 address is allocated. When it's present, set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN corresponding to the EPS Access Point Name for dynamic allocation, or set to the static IPv4 Home Address received in the PBU for static allocation. The Prefix-len is set to a non-zero value.
NOTE 1 | IETF RFC 5844 [5] | +| IPv4 Default Router Address Option | C | This option shall be present if and only if IPv4 Home Address Reply Option is present and for trusted WLAN access if the transparent Single-connection mode is used.
The LMA sets the value of the UE's IPv4 default router address which belongs to the same subnet as the IPv4 Home Address allocated to the UE. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message, formatted as defined in 3GPP TS 23.003 [12]. The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 2. | IETF RFC 5149[11] | +| PDN Type Indication | C | This option shall be present if and only if PDN type is changed in the PDN GW compared to what was requested in the PBU. | Subclause 12.1.1.3 | +| DHCPv4 Address Allocation Procedure Indication | C | This option shall be present if and only if DHCPv4 is to be used to allocate the IPv4 address to the UE. | Subclause 12.1.1.5 | +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8/S2a) | Subclause 12.1.1.1 | +| LMA Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the LMA on the S5/S8 interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| Charging ID | M | Contain the Charging ID information | Subclause 12.1.1.6 | +| APN Restriction | O | Contains the restriction of this PDN connection (on | Subclause 12.1.1.12 | + +| | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| | | S5/S8). | | +| PDN connection ID | O | Contains the PDN connection ID received in PBU | Subclause 12.1.1.15 | +| PGW Back-Off Time | O | This IE may be included on the S5/S8/S2a interfaces when the PDN GW rejects the Proxy Binding Update with the 3GSPEC set to "APN congestion". | Subclause 12.1.1.16 | +| Additional Protocol Configuration Options | O | Contains Additional Protocol Configuration Options. | Subclause 12.1.1.19 | +| Access Network Identifier Option | O | Contains the access network identifier option received in PBU with the sub-options accepted (on S2a when TWAN access is used) | IETF RFC 6757 [37]
IETF RFC 7563 [41] | +| Redirect Mobility Option | O | The LMA may include this IE on the S5, S8, S2a and S2b interface if the LMA supports sending an alternate LMAA or IPv4-LMAA and the MAG indicated corresponding support in the PBU message. If so, the LMA shall include one instance of this IE and set it to the alternate LMAA or IPv4-LMAA (for an IPv6 or IPv4 transport network respectively).
(see NOTE 3) | IETF RFC 6463 [43] | +| LMA User-Plane Address Mobility Option | O | The LMA may include this IE on the S5, S8, S2a and S2b interface if the LMA supports sending an alternate LMA address for user plane and the MAG indicated corresponding support in the PBU message. If so, the LMA shall include only one instance of this IE and set it to the IPv4 or IPv6 address for user plane (for an IPv4 or IPv6 transport network respectively). | IETF RFC 7389 [44] | +| NOTE 1: If the PDN type is IPv4v6 and DHCPv4 is to be used to allocate the IPv4 address to the UE, the IPv4 Home Address Reply Option shall not be included. | | | | +| NOTE 2: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | +| NOTE 3: As specified in IETF RFC 6463 [43], a binding for the UE's PDN connection is created at the LMA (with the alternate LMAA or IPv4-LMAA) and thus the MAG does not need to send a new PBU to that LMA for creating such a binding. | | | | + +## 5.1.2 MAG procedures + +A MAG initiating the PMIPv6 PDN Connection Creation procedure shall follow the "Mobile Node Attachment and Initial Binding Registration" procedure described in the PMIPv6 IETF RFC 5213 [4] taking into account the corrections regarding the protocol number definition in IETF RFC6275 [8] and interworking solution specified in Annex B and IPv4 support for PMIPv6 IETF RFC 5844 [5] specifications with the following additional requirements: + +1. Generate a downlink GRE key that is not already in use locally for the PDN connection's downlink traffic to that UE, as specified in the GRE Key Option for PMIPv6 specification IETF RFC 5845 [7]. +2. For IP address allocation, the IPv6 Home Network Prefix option and/or the IPv4 Home Address Request option shall be present according to the UE request and the user subscription for non-3GPP access, or according to the PDN Type received from the MME/SGSN for 3GPP access. +3. If the static IPv4 Home Address and/or IPv6 Home Network Prefix are available at the MAG, set them in the IPv4 home address Request option and/or the IPv6 home prefix option in the PBU. +4. Optionally, assign a Fully Qualified PDN Connection Set Identifier that identifies a set of PDN connections belonging to an arbitrary number of UEs. +5. Provide a PDN connection ID, if multiple PDN connections to the same APN function is supported by the MAG. +6. Include the Redirect-Capability Mobility Option if the MAG supports the capability to receive from the LMA an alternate LMAA or IPv4-LMAA. +7. Include the LMA User Plane Address Mobility Option if the MAG supports the capability to receive from the LMA an alternate LMA address for user plane. +8. Set other parameters in the PBU as specified by the PBU parameters section for this procedure. + +### 5.1.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the "Initial Binding Registration (New Mobility session)" and "Processing Binding Registrations" procedures described in the PMIPv6 IETF RFC 5213 [4] taking into account the corrections regarding the protocol number definition in IETF RFC6275 [8] and interworking solution specified in Annex B and IPv4 support for PMIPv6 IETF RFC 5844 [5] specifications with the following additional requirements: + +1. Select the PDN for the UE's PDN connection based on the APN present in the PBU. +2. Check if the received IPv6 Home prefix and/or IPv4 Home address are topologically correct. +3. If no static IPv6 Home Network Prefix and/or IPv4 Home Address were received in the PBU, allocate the IPv6 Home Network Prefix and/or an IPv4 Home Address for the selected PDN. +4. If a PCO with value IPv4 Address Allocation via DHCPv4 is present in the PBU, + - if the LMA allocates an IPv4 address, it shall include the IPv4 Home Address Reply Option in the PBA message + - if the LMA allocates an IPv6 prefix, the LMA shall not allocate an IPv4 address and shall not include the IPv4 Home Address Reply Option in the PBA message +5. Generate a uplink GRE key that is not already in use locally for the PDN connection's uplink traffic from that UE, as specified in the GRE Key Option for PMIPv6 specification IETF RFC 5845 [7]. +6. Assign to the UE an IPv6 Interface Identifier to allow formation of an UE Link Local Address from the well-known link local address prefix (fe80::/64). +7. Optionally, assign a Fully Qualified PDN Connection Set Identifier that identifies a set of PDN connections belonging to an arbitrary number of UEs. +8. If PDN connection ID was received in the PBU message, + - the LMA includes the received PDN connection ID in the PBA message, if the multiple PDN connections to the same APN function is supported by the LMA; or + - the LMA ignores the received PDN connection ID and does not include it in the PBA message , if the multiple PDN connections to the same APN function is not supported by the LMA. +9. If the Redirect-Capability Mobility Option was received in the PBU message, optionally assign an alternate LMAA or IPv4-LMAA. +10. If the LMA User Plane Address Mobility Option was received in the PBU message, optionally assign an alternate LMA address for user plane. +11. Set parameters in the PBA as specified by the PBA parameters section for this procedure. + +## 5.2 Proxy Mobile IPv6 PDN Connection Lifetime Extension procedure + +### 5.2.1 General + +The PMIPv6 PDN Connection Lifetime Extension procedure is initiated by the node acting as a MAG to prolong the lifetime of an existing PDN connection with the node acting as an LMA for an UE that is already attached. This procedure may also be used when the MME is relocated and the MAG remains unchanged (see 3GPP TS 23.007 [13]). The procedure starts with the MAG sending a PBU to the LMA to extend the binding lifetime for the UE's PDN connection. The LMA confirms that the binding lifetime is extended by sending a PBA to the MAG. + +#### 5.2.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 PDN Connection Lifetime Extension procedure are depicted in Table 5.2.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 PDN Connection Lifetime Extension procedure are depicted in Table 5.2.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +**Table 5.2.1.1-1: Fields of a PBU message for the PMIPv6 PDN Connection Lifetime Extension procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to the requested number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.2.1.1-2: Mobility Options in a PBU message for the PMIPv6 PDN Connection Lifetime Extension procedure** + +| Information element | Cat. | IE Description | Reference | +|---------------------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003 [12]. | IETF RFC 5213 [4],
3GPP TS 23.003 [12] | +| IPv6 Home Network Prefix option | C | Set the Home Network Prefix to the IPv6 Home Network Prefix allocated to the UE's PDN connection based on the selected PDN and Prefix Length to the value "64".
NOTE 1. | IETF RFC 5213 [4] | +| Link-local Address | C | Present when IPv6 Home Network Prefix option is present. Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Set to the value "5" to indicate handoff state not changed (Re-registration). | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the 3GPP access type, i.e. GERAN, UTRAN, E-UTRAN or NB-IoT, or to the value matching the characteristics of the non-3GPP access (e.g., HRPD) the UE is using to attach to the EPS as defined in the Access Technology Type Option type values registry of the IANA Mobile IPv6 Parameters Registry [18].
The ePDG may use the access technology type of the untrusted non-3GPP access network if it is able to acquire it; otherwise it shall indicate Virtual as the access technology.
The TWAN shall set the Access Technology Type Option value to 4 i.e. "IEEE 802.11a/b/g" on the S2a interface.
NOTE 2
NOTE 3 | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| GRE Key option | M | Set to the previously exchanged downlink GRE key to be used for downlink GRE encapsulated packets sent over the PDN connection. | IETF RFC 5845 [7] | +| IPv4 Home Address Request option | C | Set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN and Prefix-len to the non-zero value received from LMA.
NOTE 1. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte.
The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 4. | IETF RFC 5149[11] | +| MME Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the MME, and included by the MAG on the S5/S8 interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| MAG Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the MAG on the S5/S8, S2a (for Trusted WLAN Access) and S2b interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| PDN connection ID | C | Contains the PDN connection ID if the BULE contains the PDN Connection ID. | Subclause 12.1.1.15 | + +NOTE 1: At least one of the two options, namely, the IPv6 Home Network Prefix option or the IPv4 Home Address Request option shall be present. If the UE has both IPv4 home address and IPv6 home network prefix registered, both the IPv6 Home Network Prefix option and IPv4 Home Address Request option shall be included in the same PBU message. + +NOTE 2: The methods that the ePDG may use to acquire the access technology type of the untrusted non- + +| | | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 3: | 3GPP IP access network are not specified in this release.
The PDN-GW can be informed about the type of access network used by the UE over several reference points, see 3GPP TS 29.212 [30] for the mapping between the code values for the different access network types. | +| NOTE 4: | The APN field is not encoded as a dotted string as commonly used in documentation. | + +### 5.2.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 PDN Connection Lifetime Extension procedure are depicted in Table 5.2.1.2-1. + +The Mobility Options in a PBA message for the PMIPv6 PDN Connection Lifetime Extension procedure are depicted in Table 5.2.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.2.1.2-1: Fields of a PBA message for the PMIPv6 PDN Connection Lifetime Extension procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to the value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to the granted number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.2.1.2-2: Mobility Options in a PBA message for the PMIPv6 PDN Connection Lifetime Extension procedure** + +| Information element | Cat. | IE Description | Reference | +|--------------------------------------------------------------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| IPv6 Home Network Prefix option | C | If it is present in the corresponding PBU, set the Home Network Prefix to the IPv6 Home Network Prefix allocated to the UE's PDN connection based on the selected PDN and Prefix Length to the value "64". | IETF RFC 5213 [4] | +| Link-local Address | C | Present when IPv6 Home Network Prefix option is present. Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| GRE key option | M | Set to the previously exchanged uplink GRE key to be used for uplink GRE encapsulated packets sent over the PDN connection. | IETF RFC 5845 [7] | +| IPv4 Home Address Reply Option | C | If it is present in the corresponding PBU, set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN and Prefix-len to the non-zero value present in the corresponding PBU. | IETF RFC 5844 [5] | +| IPv4 Default Router Address Option | C | This option shall be present if and only if IPv4 Home Address Reply Option is present and PBU is accepted. The LMA sets the value of the UE's IPv4 default router address which belongs to the same subnet as the IPv4 Home Address allocated to the UE. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149[11] | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8). | Subclause 12.1.1.1 | +| LMA Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the LMA on the S5/S8 interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| PDN connection ID | C | Contains the PDN connection ID received in PBU | Subclause 12.1.1.15 | +| NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | + +## 5.2.2 MAG procedures + +A MAG initiating the PMIPv6 PDN Connection Lifetime Extension procedure shall follow the "Extending Binding Lifetime" procedure described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications, while parameters in the PBU are set as specified by the PBU parameters section for this procedure. When an MME FQ-CSID is received by the MAG during MME relocation, if the MAG supports the feature according to 3GPP TS 23.007 [13], it shall store the Node ID and CSID from the MME FQ-CSID for the PDN connection and forward the MME FQ-CSID to the LMA in the PBU. + +## 5.2.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the "Binding Lifetime Extension without Handover" procedure as described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications, while parameters in the PBA are set as + +specified by the PBA parameters section for this procedure. When an MME FQ-CSID is received by the LMA, if the LMA supports the feature according to 3GPP TS 23.007 [13], it shall store the Node-ID and CSID from the MME FQ-CSID in place of those previously stored for the PDN connection. + +## 5.3 Proxy Mobile IPv6 PDN Connection Handover procedure + +### 5.3.1 General + +The PMIPv6 PDN Connection Handover procedure is initiated by the node acting as a new MAG for the UE to update an existing PDN connection for an UE that is already attached to the EPC. The procedure starts with the new MAG sending a PBU including the APN to the LMA to update the binding for the UE's PDN connection. If multiple PDN connections to the same APN function is supported by the new MAG, a PDN connection ID shall also be included in the same PBU message. The LMA confirms update of the binding by sending a PBA to the MAG. If multiple PDN connections to the same APN function is supported by the LMA, the received PDN connection ID shall also be included in the same PBA message. Update of the binding achieves the following: + +- **IPv6 Home Network Prefix re-assignment:** The LMA re-assigns to the UE's PDN connection the IPv6 Home Network Prefix valid in the selected PDN. +- **IPv4 Home Address re-assignment:** The LMA re-assigns to the UE's PDN connection the IPv4 Home Address valid in the selected PDN. +- **Downlink and Uplink GRE Key Assignment:** The MAG and LMA will establish downlink and uplink GRE keys to be used for GRE encapsulation of downlink and uplink traffic, respectively on the PDN connection. +- **GRE Tunnel Establishment:** A GRE tunnel is established between the MAG and LMA with the assigned GRE keys to carry uplink and downlink traffic that UE respectively sends and receives on the PDN connection. +- **BCE Update:** The LMA updates or creates the BCE for the PDN connection. +- **BULE Creation: The new MAG creates a BULE for the PDN connection.** +- **IP address(es) preservation:** the IP addresses allocated in the previous initial attachment are reused if IP address(es) preservation decision is made. +- **MAG Link Local Address re-assignment:** The LMA re-assigns the same MAG link local address. +- **UE Interface Identifier (IID) re-assignment:** The LMA re-assigns to the UE the same IPv6 Interface Identifier to allow formation of the same UE Link Local Address from the well-known link local address prefix (fe80::/64). +- **PDN connection ID:** The PDN connection ID is provided by the MAG and accepted by LMA, if multiple PDN connections to the same APN function is supported by both MAG and LMA. +- **LMA Control Plane Address:** for handover between non-3GPP and 3GPP access, the LMA may assign a possibly different alternate LMAA or IPv4-LMAA if this option is supported by both MAG and LMA. For an intra-3GPP access handover, the LMA shall re-assign the same alternate LMAA or IPv4-LMAA if such an address was allocated during the PDN connection establishment or during a handover between non-3GPP and 3GPP access. +- **LMA User Plane Address:** for handover between non-3GPP and 3GPP access, the LMA may assign a possibly different alternate LMA address for user plane, if this option is supported by both MAG and LMA. For an intra-3GPP access handover, the LMA shall re-assign the same alternate LMA address for user plane if such an address was allocated during the PDN connection establishment or during a handover between non-3GPP and 3GPP access. + +The PMIPv6 LMA Initiated Update Notification procedure is then initiated by the LMA to notify the old MAG for handover with SGW relocation as specified in 3GPP TS 23.402 [3], to trigger the generation of End Marker by the MAG as specified in subclause 5.11. + +#### 5.3.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 PDN Connection Handover procedure are depicted in Table 5.3.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 PDN Connection Handover procedure are depicted in Table 5.3.1.1-2. When the mobility option is present in the message, only the first instance shall be recognized. If multiple instances are included in the message, the receiver ignores all other instances. + +**Table 5.3.1.1-1: Fields of a PBU message for the PDN Connection Handover procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to the requested number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.3.1.1-2: Mobility Options in a PBU message for the PMIPv6 PDN Connection Handover procedure** + +| Information element | Cat. | IE Description | Reference | +|----------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003 [12]. | IETF RFC 5213 [4],
3GPP TS 23.003 [12] | +| IPv6 Home Network Prefix option | C | If available at the MAG, set the Home Network Prefix to the IPv6 Home Network Prefix allocated to the UE's PDN connection and Prefix Length to the value "64". Otherwise, set the Home Network Prefix to the value "0::0" and Prefix Length to the value "0" to request allocation for the UE's PDN connection of an IPv6 Home Network Prefix for the UE in the PDN corresponding to the EPS Access Point Name.
NOTE 1. | IETF RFC 5213 [4] | +| Link-local Address | C | Present when IPv6 Home Network Prefix option is present. If available, set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. If not available, set to ALL_ZERO (all bits set to 0), indicating that the MAG requests a link-local address. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Set to the value "2" (Handoff between two different interfaces) in case the handover is an inter access handover (i.e. from 3GPP to non-3GPP, from non-3GPP to 3GPP, or between two non-3GPP accesses) and IP address(es) preservation decision is taken; or Set to the value "3" (Handoff between mobile access gateways for the same interface) in case the handover is an intra access (i.e. between two 3GPP accesses) handover; or Set to the value "4" (Handoff state unknown) in case the handover is an inter access handover (i.e. from 3GPP to non-3GPP, from non-3GPP to 3GPP, or between two non-3GPP accesses) and IP address(es) preservation decision is negative or unknown. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the 3GPP access type, i.e., to GERAN, UTRAN or E-UTRAN, or to the value matching the characteristics of the non-3GPP access (e.g., HRPD) the UE is using to attach to the EPS as defined in the Access Technology Type Option type values registry of the IANA Mobile IPv6 Parameters Registry [18].
The ePDG may use the access technology type of the untrusted non-3GPP access network if it is able to acquire it; otherwise it shall indicate Virtual as the access technology.
The TWAN shall set the Access Technology Type Option value to 4 i.e. "IEEE 802.11a/b/g" on the S2a interface.
NOTE 2
NOTE 3 | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| GRE key option | M | Set to the downlink GRE key to be used for downlink GRE encapsulated packets sent over the PDN connection. | IETF RFC 5845 [7] | +| IPv4 Home Address Request option | C | If available at the MAG, set the IPv4 Home Address to the IPv4 Address allocated to the UE's PDN connection and Prefix-len to the value "32". Otherwise, set the IPv4 Home Address to the value "0.0.0.0" and Prefix-len to the value "0" or "32" to request allocation for the UE's PDN connection of an IPv4 Home Address in the PDN corresponding to the EPS Access Point Name.
NOTE 1. | IETF RFC 5844 [5] | +| Service Selection | M | Set to the EPS Access Point Name to which the UE's | IETF RFC 5149[11] | + +| | | | | +|---------------------------------------------------|---|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Mobility Option | | PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 4. | | +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| PDN GW IP Address | O | Contain PDN GW IP address (on S2a or S2b when used for chained S2a/S2b-PMIP based S8).. | Subclause 12.1.1.4 | +| MAG Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the MAG on the S5/S8 interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| MME Fully Qualified PDN Connection Set Identifier | O | Contain a Fully Qualified PDN Connection Set Identifier if generated by the MME, and included by the MAG on the S5/S8 interfaces as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.2 | +| Selection Mode | C | Contains APN selection mode (on S5/S8). Shall be present if the PDN connection is initiated by S4 SGSN or MME. | Subclause 12.1.1.7 | +| Charging Characteristics | O | Contains the Charging Characteristics to be applied for EPC charging | Subclause 12.1.1.8 | +| Serving Network | C | This IE shall be included on S2a (for TWAN access), S5 and S8 interfaces to identify the Serving Network. This IE may be included on S2a to identify the Serving Network of the eHRPD access network. | Subclause 12.1.1.9 | +| Mobile Equipment Identity | O | This IE shall contain the MEI of the UE and shall be present, if available, on the S5, S8, S2a or S2b interface. | Subclause 12.1.1.10 | +| MSISDN | O | This IE shall contain the MSISDN and shall be present, if available, on the S5, S8, S2a or S2b interfaces. | Subclause 12.1.1.11 | +| Maximum APN Restriction | O | Contains the most stringent restriction of already active PDN connections (on S5/S8). | Subclause 12.1.1.13 | +| PDN connection ID | O | Contains the PDN connection ID | Subclause 12.1.1.15 | +| Signalling Priority Indication | O | The SGW shall forward this IE on the S5/S8 interfaces during the handover from non-3GPP to 3GPP procedure. | Subclause 12.1.1.17 | +| MME/SGSN Identifier | O | The SGW shall include the MME/SGSN Identifier on the S5 interface if the SGW supports the PGW triggered SGW restoration procedure and this information is received from the MME/SGSN as specified in 3GPP TS 23.007 [13]. | Subclause 12.1.1.20 | +| Access Network Identifier Option | O | The TWAN shall include the access network identifier on S2a. | IETF RFC 6757 [37]
IETF RFC 7563 [41] | +| Trusted WLAN Mode Indication | O | Contains the selected trusted WLAN mode (SCM or MCM) on S2a interface. | Subclause 12.1.1.22 | +| UE Time Zone | O | The TWAN shall include the UE Timezone on the S2a interface. | Subclause 12.1.1.23 | +| Logical Access ID | O | Contains the Circuit-ID with the Relay Identity that allocated it. | Subclause 12.1.1.25 | +| Redirect-Capability Mobility Option | O | The MAG shall include this IE on the S5, S8, S2a and S2b interface if it supports the capability to receive from the LMA an alternate LMAA or IPv4-LMAA. | IETF RFC 6463 [43] | +| LMA User-Plane Address Mobility Option | O | The MAG shall include this IE on the S5, S8, S2a and S2b interface if it supports the capability to receive from the LMA an alternate LMA address for user plane. If so, the LMA User Plane Address field within this Mobility Option shall be a zero-length field, or have a value of ALL_ZERO with all bits in the IPv4 address or the IPv6 address set to zero. | IETF RFC 7389 [44] | +| TWAN capabilities | O | The MAG shall include this IE on the S2a interface if any of the applicable flags is set to 1.
Applicable flags are:
- WLCP PDN Connection Modification Support | Subclause 12.1.1.28 | + +| | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|-----------------------------------------------------------------------------------------------------------------------------------|--| +| | | Indication: This flag shall be set to 1 on the S2a interface if the TWAN supports the WLCP PDN Connection Modification procedure. | | +| NOTE 1: At least one of the two options, namely, the IPv6 Home Network Prefix option or the IPv4 Home Address Request option shall be present. If the MAG knows the UE has both IPv4 home address and IPv6 home network prefix registered, both the IPv6 Home Network Prefix option and IPv4 Home Address Request option shall be included in the same PBU message.
NOTE 2: The methods that the ePDG may use to acquire the access technology type of the untrusted non-3GPP IP access network are not specified in this release.
NOTE 3: The PDN-GW can be informed about the type of access network used by the UE over several reference points, see 3GPP TS 29.212 [30] for the mapping between the code values for the different access network types.
NOTE 4: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | + +### 5.3.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 PDN Connection Handover procedure are depicted in Table 5.3.1.2-1. + +The Mobility Options in a PBA message for the PMIPv6 PDN Connection Handover procedure are depicted in Table 5.3.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.3.1.2-1: Fields of a PBA message for the PMIPv6 PDN Connection Handover procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to the value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to the granted number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.3.1.2-2: Mobility Options in a PBA message for the PMIPv6 PDN Connection Handover procedure** + +| Information element | Cat. | IE Description | Reference | +|-------------------------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| IPv6 Home Network Prefix option | C | Present if IPv6 Home Network Prefix is allocated. When it's present, set the Home Network Prefix to the IPv6 Home Network Prefix Allocated for the UE's PDN connection based on the selected PDN corresponding to the EPS Access Point Name for dynamic allocation, or set to the static IPv6 Home Network Prefix received in the PBU for static allocation. The Prefix Length is set to the value "64". In addition, the Interface Identifier (IID) allocated for the UE is encoded in the low order 64 bits of this option, i.e., the IPv6 Home Network Prefix option. | IETF RFC 5213 [4] | +| Link-local Address | C | Present when IPv6 Home Network Prefix option is present. Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| GRE key option | M | Set to the uplink GRE key to be used for uplink GRE encapsulated packets sent over the PDN connection. The same uplink GRE key used for the UE's PDN connection with the previous MAG shall be re-assigned. | IETF RFC 5845 [7] | +| IPv4 Home Address Reply Option | C | Present if IPv4 address is allocated. When it's present, set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN corresponding to the EPS Access Point Name for dynamic allocation, or set to the static IPv4 Home Address received in the PBU for static allocation. The Prefix-len is set to a non-zero value. | IETF RFC 5844 [5] | +| IPv4 Default Router Address Option | C | This option shall be present if and only if IPv4 Home Address Reply Option is present and for trusted WLAN access if the transparent Single-connection mode is used.
The LMA sets the value of the UE's IPv4 default router address which belongs to the same subnet as the IPv4 Home Address allocated to the UE. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149 [11] | +| PDN Type Indication | C | This option shall be present if and only if PDN type is changed in the PDN GW compared to what was requested in the PBU. | Subclause 12.1.1.3 | +| PMIPv6 DHCPv4 Address Allocation Procedure Indication | C | This option shall be present if and only if DHCPv4 is to be used to allocate the IPv4 address to the UE. | Subclause 12.1.1.5 | +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8). | Subclause 12.1.1.1 | +| LMA Fully Qualified PDN Connection Set | O | Contain a Fully Qualified PDN Connection Set Identifiers if generated by the LMA on the S5/S8 | Subclause 12.1.1.2 | + +| | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Identifier List | | interfaces as specified in 3GPP TS 23.007 [13]. | | +| Charging ID | M | Contain the Charging ID information | Subclause 12.1.1.6 | +| APN Restriction | O | Contains the restriction of this PDN connection (on S5/S8). | Subclause 12.1.1.12 | +| PDN connection ID | O | Contains the PDN connection ID received in PBU | Subclause 12.1.1.15 | +| Static IP Address Allocation Indication | O | Contains Static IP Address Allocation Indication if the IPv4 address and/or IPv6 Home Network Prefix is statically allocated. See NOTE 2 | Subclause 12.1.1.18 | +| Access Network Identifier Option | O | Contains the access network identifier option received in PBU with the sub-options accepted (on S2a when TWAN access is used) | IETF RFC 6757 [37]
IETF RFC 7563 [41] | +| Redirect Mobility Option | O | The LMA may include this IE on the S5, S8, S2a and S2b interface if the LMA supports sending an alternate LMAA or IPv4-LMAA and the MAG indicated corresponding support in the PBU message. If so, the LMA shall include one instance of this IE and set it to the alternate LMAA or IPv4-LMAA (for an IPv6 or IPv4 transport network respectively). (see NOTE 3) | IETF RFC 6463 [43] | +| LMA User-Plane Address Mobility Option | O | The LMA may include this IE on the S5, S8, S2a and S2b interface if the LMA supports sending an alternate LMA address for user plane and the MAG indicated corresponding support in the PBU message. If so, the LMA shall include only one instance of this IE and set it to the IPv4 or IPv6 address for user plane (for an IPv4 or IPv6 transport network respectively). | IETF RFC 7389 [44] | +| NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | +| NOTE 2: Static IP Address Allocation Indication is used by MAG to provide dynamic IPv4/v6 address flag information as specified in 3GPP TS 32.251 [25]. | | | | +| NOTE 3: As specified in IETF RFC 6463 [43], a binding for the UE's PDN connection is created at the LMA (with the alternate LMAA or IPv4-LMAA) and thus the MAG does not need to send a new PBU to that LMA for creating such a binding. | | | | + +### 5.3.2 MAG procedures + +A MAG initiating the PMIPv6 PDN Connection Handover procedure shall follow the "Mobile Node Attachment and Initial Binding Registration" procedure described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications with the following additional requirements: + +1. Generate a downlink GRE key that is not already in use locally for the PDN connection's downlink traffic to that UE, as specified in the GRE Key Option for PMIPv6 specification [7]. +2. Provide a PDN connection ID, if multiple PDN connections to the same APN function is supported by the MAG. +3. Set other parameters in the PBU as specified by the PBU parameters section for this procedure. +4. Optionally, assign a Fully Qualified PDN Connection Set Identifier that identifies a set of PDN connections belonging to an arbitrary number of UEs. +5. Include the Redirect-Capability Mobility Option if the MAG supports the capability to receive from the LMA an alternate LMAA or IPv4-LMAA. +6. Include the LMA User Plane Address Mobility Option if the MAG supports the capability to receive from the LMA an alternate LMA address for user plane. + +### 5.3.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the "Binding Lifetime Extension (After handoff)" and "Processing Proxy Binding Updates" procedures described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications with the following additional requirements: + +1. Re-assign the same uplink GRE key that was used by the previous MAG for the PDN connection's uplink traffic from the UE, as specified in the GRE Key Option for PMIPv6 specification [7]. + +2. Check if the received IPv6 Home prefix and/or IPv4 Home address are topologically correct. +3. Dynamic IP address allocation: + - a) If Handoff Indicator option is "2" or "3": Re-allocate the IPv6 Home Network Prefix and/or the IPv4 Home Address for the selected PDN which were/was allocated during the previous attachment. + - b) If Handoff Indicator option is "4": Make the IP address preservation decision as per the PMIPv6 specification [4]. +- 3a. Static IP address allocation: If the IPv4 address and/or IPv6 Home Network Prefix is statically allocated, the LMA includes Static IP Address Allocation Indication in the PBA message. +4. Optionally, assign or reuse a Fully Qualified PDN Connection Set Identifier that identifies a set of PDN connections belonging to an arbitrary number of UEs. +5. If PDN connection ID was received in the PBU message, + - a) the LMA updates PDN connection ID in the BCE accordingly and includes the received a PDN connection ID in the PBA message, if the multiple PDN connections to the same APN function is supported by the LMA; or + - b) the LMA ignores the received PDN connection ID and does not include the received a PDN connection ID in the PBA message, if the multiple PDN to the same APN function is not supported by the LMA. +6. If the Redirect-Capability Mobility Option was received in the PBU message, + - for handover between non-3GPP and 3GPP access, the LMA may assign a possibly different alternate LMAA or IPv4-LMAA; + - for an intra-3GPP access handover, the LMA shall re-assign the same alternate LMAA or IPv4-LMAA if such an address was allocated during the PDN connection establishment or during a handover between non-3GPP and 3GPP access. +7. If the LMA User Plane Address Mobility Option was received in the PBU message, + - for handover between non-3GPP and 3GPP access, the LMA may assign a possibly different alternate LMA address for user plane; + - for an intra-3GPP access handover, the LMA shall re-assign the same alternate LMA address for user plane if such an address was allocated during the PDN connection establishment or during a handover between non-3GPP and 3GPP access. +8. Set parameters in the PBA as specified by the PBA parameters section for this procedure. + +The LMA performs the lookup of BCE as described in subclause 5.8.3. If no existing BCE is found, the LMA shall follow the Proxy Mobile IPv6 PDN Connection Creation procedure as specified in section 5.1.3. + +## 5.4 Proxy Mobile IPv6 MAG Initiated PDN Connection Deletion procedure + +### 5.4.1 General + +The PMIPv6 MAG Initiated PDN Connection Deletion procedure is initiated by the node acting as a MAG to tear down an existing PDN connection with the node acting as an LMA. The procedure starts with the MAG sending a PBU to the LMA to deregister with the LMA a binding for the UE's PDN connection. The LMA confirms deregistration of the binding by sending a PBA to the MAG. Deregistration of the binding achieves the following: + +- **IPv6 Home Network Prefix deallocation:** When the PDN connection is released, the LMA returns the IPv6 Home Network Prefix assigned to the UE's PDN connection to the pool of free IPv6 Home Network Prefixes. +- **IPv4 Home Address deallocation:** When the PDN connection is released, the LMA returns the IPv4 Home Address assigned to the UE's PDN connection to the pool of free IPv4 Home Network Addresses. + +- **Downlink and Uplink GRE Key de-assignment:** The MAG and LMA will return, respectively, the PDN connection's uplink and downlink GRE keys to their respective pool of free GRE keys. +- **GRE Tunnel Tear-down:** The GRE tunnel between the MAG and LMA is deleted. +- **BCE Deletion:** The LMA deletes the BCE for the PDN connection. +- **BULE Deletion:** The MAG deletes the BULE for the PDN connection. + +#### 5.4.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure are depicted in Table 5.4.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure are depicted in Table 5.4.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +**Table 5.4.1.1-1: Fields of a PBU message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to "0" to request deletion of the BCE. | IETF RFC 6275 [8] | + +**Table 5.4.1.1-2: Mobility Options in a PBU message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure** + +| Information element | Cat. | IE Description | Reference | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003 [12]. | IETF RFC 5213 [4],
3GPP TS 23.003 [12] | +| IPv6 Home Network Prefix option | C | Set the Home Network Prefix to the IPv6 Home Network Prefix allocated to the UE's PDN connection based on the selected PDN and Prefix Length to the value "64".
NOTE 1. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Set to the value "4" to indicate Handoff state unknown. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the 3GPP access type, i.e., to GERAN, UTRAN, E-UTRAN or NB-IoT, or to the value matching the characteristics of the non-3GPP access (e.g., HRPD) the UE is using to attach to the EPS as defined in the Access Technology Type Option type values registry of the IANA Mobile IPv6 Parameters Registry [18].
The ePDG may use the access technology type of the untrusted non-3GPP access network if it is able to acquire it; otherwise it shall indicate Virtual as the access technology.
The TWAN shall set the Access Technology Type Option value to 4 i.e. "IEEE 802.11a/b/g" on the S2a interface.
NOTE 2
NOTE 3 | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| IPv4 Home Request Address option | C | Set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN and Prefix-len to the non-zero value received from the LMA.
NOTE 1. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte.
The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 4. | IETF RFC 5149[11] | +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| PDN connection ID | C | Contains the PDN connection ID if the BULE contains the PDN Connection ID. | Subclause 12.1.1.15 | +| Access Network Identifier Option | O | The TWAN shall include the access network identifier on S2a. | IETF RFC 6757 [37]
IETF RFC 7563 [41] | +| UE Time Zone | O | The TWAN shall include the UE Timezone on the S2a interface. | Subclause 12.1.1.23 | +| Access Network Identifier Timestamp | O | The TWAN shall include the timestamp on the S2a interface if the Access Network Identifier option is present. It shall indicate the time when the TWAN acquired the Access Network Identifier. | Subclause 12.1.1.24 | +| NOTE 1: At least one of the two options, namely, the IPv6 Home Network Prefix option or the IPv4 Home Address Request option shall be present. If the UE has both IPv4 home address and IPv6 home network prefix registered, both the IPv6 Home Network Prefix option and IPv4 Home Address Request option shall be included in the same PBU message. | | | | +| NOTE 2: The methods that the ePDG may use to acquire the access technology type of the untrusted non-3GPP IP access network are not specified in this release. | | | | +| NOTE 3: The PDN-GW can be informed about the type of access network used by the UE over several reference points, see 3GPP TS 29.212 [30] for the mapping between the code values for the different access network types. | | | | + +| | +|--------------------------------------------------------------------------------------------| +| NOTE 4: The APN field is not encoded as a dotted string as commonly used in documentation. | +|--------------------------------------------------------------------------------------------| + +#### 5.4.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure are depicted in Table 5.4.1.2-1. + +The Mobility Options in a PBA message for the MAG Initiated PDN Connection Deletion procedure are depicted in Table 5.4.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.4.1.2-1: Fields of a PBA message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to a value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to "0" to request deletion of the binding. | IETF RFC 6275 [8] | + +**Table 5.4.1.2-2: Mobility Options in a PBA message for the PMIPv6 MAG Initiated PDN Connection Deletion procedure** + +| Information element | Cat. | IE Description | Reference | +|------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| IPv6 Home Network Prefix option | C | If it is present in the corresponding PBU, set to the IPv6 Home Network Prefix allocated to the UE's PDN connection based on the selected PDN. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| IPv4 Home Address Reply Option | C | If it is present in the corresponding PBU, set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN and Prefix-len to a non-zero value received in the corresponding PBU. | IETF RFC 5844 [5] | +| IPv4 Default Router Address Option | C | This option shall be present if and only if IPv4 Home Address Reply Option is present and PBU is accepted. The LMA sets the value of the UE's IPv4 default router address which belongs to the same subnet as the IPv4 Home Address allocated to the UE. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149[11] | +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code | Subclause 12.1.1.1 | +| PDN connection ID | C | Contains the PDN connection ID received in PBU | Subclause 12.1.1.15 | +| Access Network Identifier Option | O | Contains the access network identifier option received in PBU with the sub-options accepted (on S2a when TWAN access is used) | IETF RFC 6757 [37]
IETF RFC 7563 [41] | + +NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. + +## 5.4.2 MAG procedures + +A MAG initiating the PMIPv6 Initial MAG Initiated PDN Connection Deletion procedure shall follow the "Mobile Node Detachment and Binding De-Registration" procedure described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications, while parameters in the PBU are set as specified by the PBU parameters section for this procedure. + +## 5.4.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the "Binding De-Registration" procedure described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications, while parameters in the PBA are set as specified by the PBA parameters section for this procedure. + +## 5.5 Proxy Mobile IPv6 LMA Initiated PDN Connection Deletion procedure + +### 5.5.1 General + +In EPC the PMIPv6 LMA Initiated PDN Connection Deletion is initiated by the node acting as a LMA to notify the node acting as a MAG, that the Binding Cache Entry related to the UE is about to be deactivated, so the MAG should remove the resources related to that PDN connection. The procedure starts with the LMA sending a BRI to the MAG to revoke the binding. The MAG confirms the revocation of the binding by sending a BRA to the LMA. + +The LMA Initiated PDN Connection Deletion Procedure initiated by the LMA achieves the following: + +- **IPv6 Home Network Prefix release:** When the UE's PDN connection is deactivated, the LMA returns the IPv6 Home Network Prefix assigned to the UE's PDN connection to the pool of free IPv6 Home Network Prefixes. +- **IPv4 Home Address release:** When the UE's PDN connection is deactivated, the LMA returns the IPv4 Home Address assigned to the UE's PDN connection to the pool of free IPv4 Home Network Addresses. +- **Downlink and Uplink GRE keys de-assignment:** The MAG and LMA will return, respectively, the PDN connection's uplink and downlink GRE keys to their respective pool of free GRE keys. +- **GRE tunnel Deletion:** The GRE tunnel is removed from the LMA and the MAG. +- **BCE Deletion:** The LMA deletes the BCE for the PDN connection. +- **BULE Deletion:** The MAG deletes the BULE for the PDN connection. + +#### 5.5.1.1 Binding Revocation Indication + +The fields of a BRI message for the PMIPv6 LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.5.1.1-1. + +The Mobility Options in a BRI message for the LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.5.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +**Table 5.5.1.1-1: Fields of a BRI message for the PMIPv6** + +| Information element | IE Description | Reference | +|------------------------------|---------------------------------------------------------------------------------------------------|-------------------| +| Revocation Trigger | Set to a value indicating the event which triggered the revoking node to send the BRI message | IETF RFC 5846 [6] | +| Sequence Number | A sequence number generated by the LMA, and increased for every BRI sent. | IETF RFC 5846 [6] | +| Proxy Binding Flag (P) | Set to "1" to indicate that the Binding Revocation Indication is for a proxy MIPv6 binding entry. | IETF RFC 5213 [4] | +| IPv4 HoA Binding Only (V) | Set to "0" to request for complete binding revocation | IETF RFC 5846 [6] | +| Global Per-Peer Bindings (G) | Set to 0 to indicate that the request is for a specific PMIPv6 BCE. | IETF RFC 5846 [6] | + +**Table 5.5.1.1-2: Mobility Options in a BRI message for the PMIPv6 LMA Initiated PDN Connection Deletion** + +| Information element | Cat. | IE Description | Reference | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003[12]. | IETF RFC 5213 [4],
3GPP TS 23.003[12] | +| IPv6 Home Network Prefix option | C | Set the Home Network Prefix to the Home Network Prefix of the UE's PDN connection.
Set the Prefix Length to the value "64".
NOTE 1. | IETF RFC 5213 [4] | +| IPv4 Home Address Request option | C | Set the IPv4 Home Address to the IPv4 home address of the UE's PDN connection.
Set the Prefix-len to the non-zero value which was sent to the MAG at PMIPv6 PDN connection creation procedure or Handover procedure.
NOTE 1. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 2. | IETF RFC 5149[11] | +| Protocol Configuration Options | O | Contain Protocol Configuration Options. | Subclause 12.1.1.0 | +| PDN connection ID | C | Contains the PDN connection ID if the BCE contains the PDN Connection ID. | Subclause 12.1.1.15 | +| 3GPP Specific PMIPv6 Error Code | O | For the S5/S8 and S2a/S2b interfaces, contain 3GPP Specific PMIPv6 Error Code. | Subclause 12.1.1.1 | +| NOTE 1: At least one of the two options, namely, the IPv6 Home Network Prefix option or the IPv4 Home Address Request option shall be present. If the UE has both IPv4 home address and IPv6 home network prefix registered, both the IPv6 Home Network Prefix option and IPv4 Home Address Request option shall be included in the same BRI message. | | | | +| NOTE 2: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | + +### 5.5.1.2 Binding Revocation Acknowledgment + +The fields of a BRA message for the PMIPv6 LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.5.1.2-1. + +The Mobility Options in a BRA message for the LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.5.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.5.1.2-1: Fields of a BRA message for a PMIPv6 LMA Initiated PDN Connection Deletion** + +| Information element | IE Description | Reference | +|------------------------------|-------------------------------------------------------------------------------------------------------|-------------------| +| Status | Indicates the result of the BRI | IETF RFC 5846 [6] | +| Sequence Number | Set to the value received in the corresponding BRI. | IETF RFC 5846 [6] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Revocation Acknowledgment is for a proxy MIPv6 binding entry. | IETF RFC 5213 [4] | +| IPv4 HoA Binding Only (V) | Set to "0"; the same value as for BRI | IETF RFC 5846 [6] | +| Global Per-Peer Bindings (G) | Set to "0"; the same value as for the BRI. | IETF RFC 5846 [6] | + +**Table 5.5.1.2-2: Mobility Options in a BRA message for the PMIPv6 LMA Initiated PDN Connection Deletion** + +| Information element | Cat. | IE Description | Reference | +|--------------------------------------------------------------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of BRI. | IETF RFC 5213 [4] | +| IPv6 Home Network Prefix option | C | Set the Home Network Prefix to the IPv6 Home Network Prefix of the UE's PDN connection received in BRI.
Set the Prefix Length to the value "64". | IETF RFC 5213 [4] | +| IPv4 Home Address Reply Option | C | Set the IPv4 Home Address to the IPv4 home address of the UE's PDN connection received in BRI.
Set the Prefix-len to the non-zero value received in BRI. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the BRI message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte.
The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149[11] | +| Protocol Configuration Options | O | Contain Protocol Configuration Options | Subclause 12.1.1.0 | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8). | Subclause 12.1.1.1 | +| PDN connection ID | C | Contains the PDN connection ID received in BRI | Subclause 12.1.1.15 | +| Access Network Identifier Option | O | The TWAN shall include the access network identifier on S2a. | IETF RFC 6757 [37] | +| Access Network Identifier Timestamp | O | The TWAN shall include the timestamp on the S2a interface if the Access Network Identifier option is present. It shall indicate the time when the TWAN acquired the Access Network Identifier. | Subclause 12.1.1.24 | +| UE Time Zone | O | The TWAN shall include the UE Timezone on the S2a interface. | Subclause 12.1.1.23 | +| NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | + +## 5.5.2 MAG procedures + +The MAG shall follow the "Local Mobility Anchor Revokes a PMIPv6 Binding" procedure described in the IETF RFC 5846 [6]. The MAG should release the resources associated with the UE's PDN connection referred to in the BRI message. + +The MAG shall respond with a BRA. + +## 5.5.3 LMA procedures + +The LMA shall send a BRI to the MAG as described in the "Local Mobility Anchor Revokes a PMIPv6 binding" procedure described in the IETF RFC 5846 [6]. The LMA shall clear the BCE related to the UE's PDN connection after sending the BRI in case of UE detach. + +# 5.6 Proxy Mobile IPv6 PDN Connection IPv4 address allocation procedure + +## 5.6.1 General + +The IPv4 address allocation procedure is initiated by the node acting as a MAG when DHCPv4 message is received from the UE which requires a new IPv4 address. The MAG sends a PBU to LMA requesting a new IPv4 address for an existing PDN connection. The LMA assigns a new IPv4 address by sending a PBA to the MAG. IPv4 address assignment procedure achieves the following: + +- **IPv4 Home Address assignment:** The LMA assigns to the UE's PDN connection an IPv4 Home Address valid in the selected PDN. + +### 5.6.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 PDN Connection IPv4 address allocation procedure are depicted in Table 5.6.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 PDN Connection IPv4 address allocation procedure are depicted in Table 5.6.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +**Table 5.6.1.1-1: Fields of a PBU message for the PMIPv6 PDN Connection IPv4 address allocation procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to the requested number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.6.1.1-2: Mobility Options in a PBU message for the PMIPv6 PDN Connection IPv4 address allocation procedure** + +| Information element | Cat. | IE Description | Reference | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003 [12]. | IETF RFC 5213 [4],
3GPP TS 23.003 [12] | +| IPv6 Home Network Prefix option | M | Set the Home Network Prefix to the IPv6 Home Network Prefix allocated to the UE's PDN connection based on the selected PDN and Prefix Length to the value "64". | IETF RFC 5213 [4] | +| Link-local Address | M | Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Set to the value "5" to indicate handoff state not changed (Re-registration). | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the 3GPP access type, i.e., to GERAN, UTRAN, E-UTRAN or NB-IoT, or to the value matching the characteristics of the non-3GPP access (e.g., HRPD) the UE is using to attach to the EPS as defined in the Access Technology Type Option type values registry of the IANA Mobile IPv6 Parameters Registry [18].
NOTE 1 | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| IPv4 Home Address Request option | M | For dynamic allocation, set the IPv4 Home Address to the value "0.0.0.0" and Prefix-len to the value "0" or "32" to request allocation for the UE's PDN connection of an IPv4 Home Address in the PDN corresponding to the EPS Access Point Name. For static allocation, set the IPv4 Home Address to the received static allocated IPv4 Home Address and Prefix-len to the value "32". | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 2. | IETF RFC 5149[11] | +| PDN connection ID | C | Contains the PDN connection ID if the BULE contains the PDN Connection ID. | Subclause 12.1.1.15 | +| NOTE 1: The PDN-GW can be informed about the type of access network used by the UE over several reference points, see 3GPP TS 29.212 [30] for the mapping between the code values for the different access network types. | | | | +| NOTE 2: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | + +### 5.6.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 PDN Connection IPv4 address allocation procedure are depicted in Table 5.6.1.2-1. + +The Mobility Options in a PBA message for the PMIPv6 PDN Connection IPv4 address allocation procedure are depicted in Table 5.6.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.6.1.2-1: Fields of a PBA message for the PMIPv6 PDN Connection IPv4 address allocation procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to the value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to the granted number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.6.1.2-2: Mobility Options in a PBA message for the PMIPv6 PDN Connection IPv4 address allocation procedure** + +| Information element | Cat. | IE Description | Reference | +|--------------------------------------------------------------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| IPv6 Home Network Prefix option | M | Set the Home Network Prefix to the IPv6 Home Network Prefix allocated to the UE's PDN connection based on the selected PDN and Prefix Length to the value "64". | IETF RFC 5213 [4] | +| Link-local Address | M | Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| IPv4 Home Address Reply option | M | Set the IPv4 Home Address to the IPv4 Home Address allocated for the UE's PDN connection based on the selected PDN corresponding to the EPS Access Point Name for dynamic allocation, or set to the static IPv4 Home Address received in the PBU for static allocation. The Prefix-len is set to a non-zero value. | IETF RFC 5844 [5] | +| IPv4 Default Router Address Option | M | The LMA sets the value of the UE's IPv4 default router address which belongs to the same subnet as the IPv4 Home Address allocated to the UE. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149[11] | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8). | Subclause 12.1.1.1 | +| PDN connection ID | C | Contains the PDN connection ID received in PBU | Subclause 12.1.1.15 | +| NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | + +## 5.6.2 MAG procedures + +The MAG initiating IPv4 Address Allocation using DHCPv4 procedure shall follow the "Extending Binding Lifetime" procedure described in the PMIPv6 [4] and "DHCP Relay Agent co-located with MAG" or "DHCP Server co-located with MAG" procedure as described in IPv4 support for PMIPv6 [5] specifications, while parameters in the PBU are set as specified by the PBU parameters section for this procedure. + +1. If the static IPv4 Home Address is available at the MAG, set it in the IPv4 home address Request option in the PBU. +2. Set other parameters in the PBU as specified by the PBU parameters section for this procedure. + +### 5.6.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the "Binding Lifetime Extension without Handover" procedures as described in the PMIPv6 [4] and IPv4 support for PMIPv6 [5] specifications with the following additional requirements: + +1. Check if the received IPv4 Home address is topologically correct. +2. Allocate an IPv4 Home Address for the selected PDN. +3. Set parameters in the PBA as specified by the PBA parameters section for this procedure. + +## 5.7 Proxy Mobile IPv6 LMA Initiated IPv4 Address Release procedure + +### 5.7.1 General + +In the case when UE is assigned both IPv6 HNP and IPv4 Home Address, if IPv4 Address lease expires or DHCPv4 Release procedure, the node acting as LMA initiates IPv4 Address Release procedure to notify the node acting as MAG about release of IPv4 address of UE for a certain PDN connection. LMA indicates MAG by sending a BRI and MAG confirms by replying with a BRA as described in IETF RFC 5846 [6]. + +LMA Initiated IPv4 Address Release procedure achieves the following: + +- **IPv4 Home Address release:** The LMA returns the IPv4 Home Address assigned to the UE's PDN connection to the pool of free IPv4 Home Network Addresses. + +#### 5.7.1.1 Binding Revocation Indication + +The fields of a BRI message for the PMIPv6 LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.7.1.1-1. + +The Mobility Options in a BRI message for the LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.7.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +**Table 5.7.1.1-1: Fields of a BRI message for the LMA Initiated IPv4 Address Release** + +| Information element | IE Description | Reference | +|------------------------------|---------------------------------------------------------------------------------------------------|-------------------| +| Revocation Trigger | Set to a value indicating the event which triggered the revoking node to send the BRI message. | IETF RFC 5846 [6] | +| Sequence Number | A sequence number generated by the LMA, and increased for every BRI sent. | IETF RFC 5846 [6] | +| Proxy Binding Flag (P) | Set to "1" to indicate that the Binding Revocation Indication is for a proxy MIPv6 binding entry. | IETF RFC 5213 [4] | +| IPv4 HoA Binding Only (V) | Set to "1" to revoke IPv4 address only | IETF RFC 5846 [6] | +| Global Per-Peer Bindings (G) | Set to 0 to indicate that the request is for a specific PMIPv6 BCE. | IETF RFC 5846 [6] | + +**Table 5.7.1.1-2: Mobility Options in a BRI message for the LMA Initiated IPv4 Address Release** + +| Information element | Cat. | IE Description | Reference | +|-----------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003[12]. | IETF RFC 5213 [4],
3GPP TS 23.003[12] | +| IPv4 Home Address Request option | M | Set the IPv4 Home Address to the IPv4 home address of the UE's PDN connection and Prefix-len to the non-zero value which was sent to the MAG at PMIPv6 PDN connection creation procedure or Handover procedure. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte.
The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149[11] | +| PDN connection ID | C | Contains the PDN connection ID if the BCE contains the PDN Connection ID. | Subclause 12.1.1.15 | + +NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. + +### 5.7.1.2 Binding Revocation Acknowledgment + +The fields of a BRA message for the PMIPv6 LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.7.1.2-1. + +The Mobility Options in a BRA message for the LMA Initiated PDN Connection Deletion procedure are depicted in Table 5.7.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.7.1.2-1: Fields of a BRA message for a LMA Initiated IPv4 Address Release** + +| Information element | IE Description | Reference | +|------------------------------|---------------------------------------------------------------------------------------------------|-------------------| +| Status | Indicates the result of the BRI | IETF RFC 5846 [6] | +| Sequence Number | Set to the value received in the corresponding BRI. | IETF RFC 5846 [6] | +| Proxy Binding Flag (P) | Set to "1" to indicate that the Binding Revocation Indication is for a proxy MIPv6 binding entry. | IETF RFC 5213 [4] | +| IPv4 HoA Binding Only (V) | Set to "1"; the same value as for BRI | IETF RFC 5846 [6] | +| Global Per-Peer Bindings (G) | Set to 0 to indicate that the request is for a specific PMIPv6 BCE. | IETF RFC 5846 [6] | + +**Table 5.7.1.2-2: Mobility Options in a BRA message for the LMA Initiated IPv4 Address Release** + +| Information element | Cat. | IE Description | Reference | +|--------------------------------------------------------------------------------------------|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of BRI. | IETF RFC 5213 [4] ,
3GPP TS 23.003 [12] | +| IPv4 Home Address Reply Option | M | Set the IPv4 Home Address to the IPv4 home address of the UE's PDN connection received in BRI.
Set the Prefix-len to the non-zero value received in BRI. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the BRI message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte.
The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149[11] | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8) | Subclause 12.1.1.1 | +| PDN connection ID | C | Contains the PDN connection ID received in BRI | Subclause 12.1.1.15 | +| NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | + +## 5.7.2 MAG procedures + +The MAG shall follow the procedure for Revocation Trigger in BRI as "IPv4 HoA only" in "Binding Revocation Responder" sub-section of "Mobile Access Gateway" described in the IETF RFC 5846 [6]. The MAG shall respond with a BRA. BRA message parameters are set as per the details in BRA section of the procedure. + +## 5.7.3 LMA procedures + +The LMA shall send a BRI to the MAG as described for revoking IPv4 address only in the "Binding Revocation Initiator" sub-section of "Local Mobility Anchor" described in the IETF RFC 5846 [6]. The LMA shall delete the IPv4 Address from corresponding BCE related to the UE's PDN connection after receiving the BRA in reply to the BRI sent from LMA. BRI message parameters are set as per the details in BRI section of the procedure. + +# 5.8 Proxy Mobile IPv6 Multiple PDN Extensions + +## 5.8.1 General + +In EPC a UE can connect or disconnect to multiple distinct PDNs in an independent manner. Thus a distinct PMIPv6 BCE and BULE exist for each of the PDN connections of an UE. + +Supporting multiple PDN connections to the same APN function is optional for MAG and LMA. A MAG which supports the multiple PDN connections to the same APN function shall include PDN connection ID in the PBU message at initial attach/handover procedure. If the LMA supports the multiple PDN connections to the same APN function, it shall include the received PDN connection ID in the PBA message. If the LMA does not support the multiple PDN connections to the same APN function, it shall ignore the received PDN connection ID and shall not include the PDN connection ID in the PBA message. If the received PBA message does not contain a PDN connection ID, the MAG shall not send any PBU message for additional PDN connectivity request to the same APN for the same UE. + +## 5.8.2 Extensions to PMIPv6 Data Structure + +There shall be a unique BCE and BULE for each PDN connection. Each PDN connection can be uniquely identified by MN ID, an APN, and optionally a PDN connection ID in the BCE and BULE. + +To support Multiple PDNs the MAG and LMA maintains extended data structure compared to the standard PMIPv6 as defined in IETF RFC 5213 [4]. Since multiple PDN connections of a UE can be distinguished based on an APN, both the BCE on the LMA and the BULE on the MAG need to be extended with the following additional field: + +- APN of a UE's PDN connection. + +Moreover, to support multiple PDN connections to the same APN function, the MAG and LMA shall maintain extended data structure compared to the PMIPv6 data structure described above. This extension is only applicable if multiple PDN connections to the same APN function is supported by both MAG and LMA. + +Since the multiple PDN connections with the same APN of a UE shall be distinguished based on MN ID, an APN, and a PDN connection ID, both the BCE on the LMA and the BULE on the MAG need to be extended with the following additional field: + +- PDN connection ID of a UE's PDN connection. The PDN connection ID is provided by the MAG to the LMA at PDN Connection Creation procedure or Handover procedure. For S2a/S2b interface, the MAG generates the PDN connection ID which shall be unique per MN-ID per APN. How the MAG generates the PDN Connection ID for the S2a and S2b reference points is out of scope of 3GPP. For S5/S8 interface, the MAG uses the EPS bearer identity of the default bearer as PDN connection ID. + +### 5.8.3 Extensions to PMIPv6 BULE and BCE Lookups + +#### 5.8.3.1 General + +To support Multiple PDNs the MAG and LMA perform extended lookups on the extended data structure compared to the standard PMIPv6 as defined in IETF RFC 5213 [4]. + +In standard PMIPv6 as defined in IETF RFC 5213 [4], a PMIPv6 BCE/BULE is looked up based on the Mobile Node Identifier (MN-Id), the access technology types (ATT) and if it exist the MN's link-layer identifier (MN-LL-Id). + +In EPC the MN-LL-Id is not used and the EPC support handover between different interfaces for handover between non-3GPP and 3GPP accesses. + +Distinct PMIPv6 BCE and BULE exist for each of the PDN connections of an UE. + +The feature of having multiple PDN connections to the same APN is only supported if both MAG and LMA support it. + +#### 5.8.3.2 Extensions to PMIPv6 BCE Lookups + +If the multiple PDN connections to the same APN feature is not supported, all PDN connections of a UE can be distinguished based on an APN and there is a one-to-one mapping between a PMIPv6 BCE, a PDN connection, and the (MN-Id, APN) tuple. An UE PDN connection can be uniquely identified by a (MN-Id, APN) tuple, the BCE is accordingly looked up on a per (MN-Id, APN) tuple basis. + +If the multiple PDN connections to the same APN feature is supported, the LMA shall store the received PDN connection ID in the BCE. There is a one-to-one mapping between a PMIPv6 BCE, a PDN connection, and the (MN-Id, APN, PDN connection ID) tuple. Thus, an UE PDN connection can be uniquely identified by a (MN-Id, APN, PDN connection ID) tuple. The BCE is accordingly looked up as follows: + +- If a PDN connection ID is received in the request message, the PMIPv6 BCE is looked up based on the (MN-Id, APN, PDN connection ID) tuple. If no existing binding is found based on the (MN-Id, APN, PDN connection ID) tuple, the LMA shall re-perform the PMIPv6 BCE lookup based on a per (MN-Id, APN) tuple. +- If a PDN connection ID is not received in the request message, the PMIPv6 BCE lookup is based on a per (MN-Id, APN) tuple. + +#### 5.8.3.3 Extensions to PMIPv6 BULE Lookups + +If the multiple PDN connections to the same APN feature is not supported, an UE PDN connection can be uniquely identified by a (MN-Id, APN) tuple. In this case the BULE is accordingly looked up on a per (MN-Id, APN) tuple basis. + +If the multiple PDN connections to the same APN feature is supported, the MAG shall generate a PDN connection ID per PDN connection and store it in the BULE. Thus, there is a one-to-one mapping between a PMIPv6 BULE, a PDN connection, and the (MN-Id, APN, PDN connection ID) tuple. An UE PDN connection can be uniquely identified by a per (MN-Id, APN, PDN connection ID) tuple. The BULE is accordingly looked up on a per (MN-Id, APN, PDN connection ID) tuple basis. + +## 5.8.4 Extensions to PMIPv6 Procedure + +### 5.8.4.1 General + +The processing rules on the received PMIPv6 message are specified in IETF RFC 5213 [4] and IETF RFC 5844 [5]. This subclause specifies the additional PMIPv6 procedures. + +### 5.8.4.2 MAG procedure + +If the PMIPv6 PBU retransmission is triggered, a PMIPv6 PBU message with identical mobility options, except the value of the Timestamp option is new, shall be sent. + +### 5.8.4.3 LMA procedure + +If before responding to a received PMIPv6 PBU message, a new PMIPv6 PBU message with the same MN-ID, APN (and PDN connection ID) mobility options is received, then the LMA may respond to one or all of the received PMIPv6 PBU messages. + +If the LMA receives a PMIPv6 PBU message with HI = 1 from the same MAG and an existing BCE with the same MN-ID, APN (and PDN connection ID) is found, the LMA may refresh the BCE or release the old BCE and create a new one based on the received PBU message. + +## 5.9 Serving GW Procedure at Chaining Case + +### 5.9.1 General + +Chained S2a/S2b with GTP-based S8 is not supported in this release. + +Chained S2a/S2b with PMIP-based S8 is used when VPLMN has business relationship with Non-3GPP Networks and Serving GW in VPLMN supporting a LMA function as local non-3GPP Anchor. + +### 5.9.2 Signalling procedures + +When either of the S2a or S2b interfaces is chained with a PMIP-based S8 interface, the Serving GW acts as the signaling endpoint for each interface. On the S2a or S2b interface, the Serving GW acts as an LMA. On the chained PMIP-based S8 interface, the Serving GW acts as MAG. When a procedure is initiated by its peer on a given interface for a given PDN connection, the Serving GW shall trigger an equivalent procedure over the chained interface for the designated PDN connection. The procedure initiated by its peer cannot be completed before the completion of the equivalent procedure initiated over the chained interface. + +#### 5.9.2.1 PMIP-based S8 Serving GW procedures + +Upon receiving a PMIPv6 message over S8 for an LMA initiated procedure for a given PDN connection, the Serving GW shall initiate the corresponding LMA procedure over S2a or S2b for the designated PDN connection. + +Upon receiving a PMIPv6 message over S2a or S2b for a MAG initiated procedure for a given PDN connection, the Serving GW shall initiate the corresponding MAG procedure over PMIP-based S8 for the designated PDN connection. + +Table 5.9.2.1-1: procedure, message and IE mapping at PMIPv6 based S8 + +| Initiated procedure | Messages | Initiating interface | Chained interface | Corresponding procedure
Chained interface | Corresponding messages | +|---------------------------------------------------------------------|----------|----------------------|-------------------|---------------------------------------------------------------------|------------------------| +| PDN Connection Creation as specified in subclause 5.1 | PBU/PBA | S2a or S2b | PMIPv6 based S8 | PDN Connection Creation as specified in subclause 5.1 | PBU/PBA | +| PDN Connection Lifetime Extension as specified in subclause 5.2 | PBU/PBA | S2a or S2b | PMIPv6 based S8 | PDN Connection Lifetime Extension as specified in subclause 5.2 | PBU/PBA | +| PDN Connection Handover as specified in subclause 5.3 | PBU/PBA | S2a or S2b | PMIPv6 based S8 | PDN Connection Handover as specified in subclause 5.3 | PBU/PBA | +| MAG Initiated PDN Connection Deletion as specified in subclause 5.4 | PBU/PBA | S2a or S2b | PMIPv6 based S8 | MAG Initiated PDN Connection Deletion as specified in subclause 5.4 | PBU/PBA | +| LMA Initiated PDN Connection Deletion as specified in subclause 5.5 | BRI/BRA | PMIPv6 based S8 | S2a or S2b | LMA Initiated PDN Connection Deletion as specified in subclause 5.5 | BRI/BRA | + +### 5.9.3 Payload packets at chained case + +When the S2a or S2b interfaces is chained with a PMIPv6-based S8 interface, both uplink and downlink payload packets are forwarded by the Serving GW between the S2a or S2b PMIPv6 GRE tunnel and the S8 PMIPv6 GRE tunnel for a given PDN connection. + +## 5.10 Proxy Mobile IPv6 MAG Initiated IPv4 Address Release procedure + +### 5.10.1 General + +In the case when UE is assigned both IPv6 HNP and IPv4 Home Address, for DHCPv4 Release procedure, the node acting as MAG initiates the selective de-registration of IPv4 home address procedure to notify the node acting as LMA about release of IPv4 address of UE for a certain PDN connection. MAG notifies LMA by sending a PBU and LMA confirms by replying with a PBA as described in IETF RFC 5844 [5]. IPv4 address release procedure achieves the following: + +**IPv4 Home Address release:** The LMA releases an IPv4 Home Address of the UE's PDN connection. + +#### 5.10.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 MAG Initiated IPv4 Address Release procedure are depicted in Table 5.10.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 MAG Initiated IPv4 Address Release procedure are depicted in Table 5.10.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +**Table 5.10.1.1-1: Fields of a PBU message for the PMIPv6 MAG Initiated IPv4 Address Release procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to "0" to request deletion of the IPv4 binding. | IETF RFC 5844 [5] | + +**Table 5.10.1.1-2: Mobility Options in a PBU message for the PMIPv6 MAG Initiated IPv4 Address Release procedure** + +| Information element | Cat. | IE Description | Reference | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Set to the NAI identifier of the UE as specified in 3GPP TS 23.003 [12]. | 3GPP TS 23.003 [12] | +| Handoff Indicator option | M | Set to the value "4" to indicate Handoff state unknown. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the value matching the characteristics of the non-3GPP access on S2a (e.g., HRPD) the UE is using to attach to the EPS as defined in the Access Technology Type Option type values registry of the IANA Mobile IPv6 Parameters Registry [18].
NOTE 1 | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| IPv4 Home Address Request option | M | Set the IPv4 Home Address to the IPv4 Home Address to be released of the UE's PDN connection and Prefix-len to the non-zero value received from LMA. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached, formatted as defined in 3GPP TS 23.003 [12] | IETF RFC 5149[11] | +| NOTE 1: The PDN-GW can be informed about the type of access network used by the UE over several reference points, see 3GPP TS 29.212 [30] for the mapping between the code values for the different access network types. | | | | + +## 5.10.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 MAG Initiated IPv4 Address Release procedure are depicted in Table 5.10.1.2-1. + +The Mobility Options in a PBA message for the PMIPv6 MAG Initiated IPv4 Address Release procedure are depicted in Table 5.10.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.10.1.2-1: Fields of a PBA message for the PMIPv6 MAG Initiated IPv4 Address Release procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to the value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to "0" to request deletion of the IPv4 binding. | IETF RFC 5844 [5] | + +**Table 5.10.1.2-2: Mobility Options in a PBA message for the PMIPv6 MAG Initiated IPv4 Address Release procedure** + +| Information element | Cat. | IE Description | Reference | +|------------------------------------|------|-----------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| IPv4 Home Address Reply Option | M | Set the IPv4 Home Address to the released IPv4 Home Address of the UE's PDN connection and Prefix-len to the non-zero value received in BRI. | IETF RFC 5844 [5] | +| IPv4 Default Router Address Option | M | The LMA sets the value of the UE's IPv4 default router address which belongs to the same subnet as the IPv4 Home Address allocated to the UE. | IETF RFC 5844 [5] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message, formatted as defined in 3GPP TS 23.003 [12] | IETF RFC 5149[11] | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8). | Subclause 12.1.1.1 | + +## 5.10.2 MAG procedures + +The MAG initiating IPv4 Address Release using DHCPv4 procedure shall follow the "Selective De-Registration" procedure and "DHCP Server co-located with MAG" procedure as described in IPv4 support for PMIPv6 [5] specifications, while parameters in the PBU are set as specified by the PBU parameters section for this procedure. + +1. Set the IPv4 home address to be released in the IPv4 home address Request option in the PBU. +2. Set other parameters in the PBU as specified by the PBU parameters section for this procedure. + +## 5.10.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the "Selective De-Registration" procedures as described in the IPv4 support for PMIPv6 [5] specifications with the following additional requirements: + +1. Release the IPv4 Home Address corresponding to the IPv4 home address Request option in the PBU message. +2. Set parameters in the PBA as specified by the PBA parameters section for this procedure. + +# 5.11 Proxy Mobile IPv6 LMA Initiated Update Notification procedure + +## 5.11.1 General + +In EPC the PMIPv6 LMA Initiated Update Notification procedure is initiated by the node acting as a LMA to notify the node acting as a MAG, that the Binding Cache Entry related to the UE is about to be updated, so the MAG updates the + +resources related to that PDN connection. The procedure starts with the LMA sending a PMIPv6 UPN message to the MAG. The MAG confirms by sending a PMIPv6 UPA message to the LMA. + +The PMIPv6 LMA Initiated Update Notification procedure is initiated by the node acting as a LMA to notify the node acting as a MAG, to trigger the generation of End Marker by the MAG. The procedure starts with the LMA sending a PMIPv6 UPN message to the MAG. The LMA shall not request an acknowledgement message from the MAG. See clause 15. + +This PMIPv6 LMA Initiated Update Notification procedure is based on the PMIPv6 notification procedure as specified in the IETF RFC 7077 [35]. + +#### 5.11.1.1 Update Notification + +The fields of a UPN message for the PMIPv6 LMA Initiated Update Notification procedure are depicted in Table 5.11.1.1-1. + +The Mobility Options in a UPN message for the PMIPv6 LMA Initiated Update Notification procedure are depicted in Table 5.11.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver shall ignore all other instances. + +Other flags are not used by this specification. + +**Table 5.11.1.1-1: Fields of a UPN message for the PMIPv6 LMA Initiate Update Notification procedure** + +| Information element | Description | Reference | +|---------------------|------------------------------------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per LMA) monotonically increasing value. | IETF RFC 5213 [4] | +| Notification Reason | Set to the corresponding notification reason | IETF RFC 7077 [35] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message.
Set to "0" not to request an acknowledgement message. | IETF RFC 7077 [35] | + +**Table 5.11.1.1-2: Mobility Options in a UPN message for the PMIPv6 LMA Initiated Update Notification procedure** + +| Information element | Cat. | IE Description | Reference | +|------------------------------------------|------|-------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Set to the NAI identifier of the UE as specified in 3GPP TS 23.003 [12]. | 3GPP TS 23.003 [12] | +| Service Selection Mobility Option | O | This IE shall be set to the EPS Access Point Name to which the UE's PDN connection is attached. | IETF RFC 5149 [11] | +| PDN connection ID | O | This IE shall contain the PDN connection ID if the BCE contains the PDN Connection ID. | Subclause 12.1.1.15 | +| MME/SGSN Identifier | O | Contains the MME/S4-SGSN identifier | Subclause 12.1.1.20 | +| Protocol Configuration Option | O | Contains Protocol Configuration Options. | Subclause 12.1.1.0 | +| End Marker Notification | O | Contains the End Marker Notification (on S5/S8). | Subclause 12.1.1.21 | +| PDN GW IP Address | O | Contains PDN GW IP address for control plane used by the PDN connection. | Subclause 12.1.1.4 | +| GRE key option | O | Contains the uplink GRE key for control plane used by the PDN connection. | IETF RFC 5845 [7] | +| Additional Protocol Configuration Option | O | Contains Additional Protocol Configuration Options. | Subclause 12.1.1.19 | + +#### 5.11.1.2 Update Notification Acknowledgement + +The fields of a UPA message for the PMIPv6 LMA Initiated Update procedure are depicted in Table 5.11.1.2-1. + +The Mobility Options in a UPA message for the PMIPv6 LMA Initiated Update procedure are depicted in Table 5.11.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver shall ignore all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.11.1.2-1: Fields of a UPA message for the PMIPv6 LMA Initiated Update Notification procedure** + +| Information element | Description | | Reference | +|---------------------|-----------------------------------------------------|--|--------------------| +| Sequence Number | Set to the value received in the corresponding UPN. | | IETF RFC 5213 [4] | +| Status | Indicates the result of the UPN | | IETF RFC 7077 [35] | + +**Table 5.11.1.2-2: Mobility Options in a UPA message for the PMIPv6 LMA Initiated Update Notification procedure** + +| Information element | Cat. | IE Description | Reference | +|-----------------------------------|------|-------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Copied from the corresponding field in the UPN. | 3GPP TS 23.003 [12] | +| Service Selection Mobility Option | O | This IE shall be copied from the corresponding field in the UPN message if present. | IETF RFC 5149 [11] | +| PDN connection ID | C | Contains the PDN connection ID received in UPN | Subclause 12.1.1.15 | +| 3GPP Specific PMIPv6 Error Code | O | Contains a 3GPP Specific PMIPv6 Error Code. | Subclause 12.1.1.1 | + +## 5.11.2 LMA procedures + +A LMA initiating the PMIPv6 LMA Initiated Update Notification procedure shall follow the procedure described in IETF RFC 7077 [35], while parameters in the UPN message are set as specified by the UPN message parameters section for this procedure. + +## 5.11.3 MAG procedures + +On reception of a UPN, the MAG shall follow the procedure described in IETF RFC 7077 [35], while parameters in the UPA message are set as specified by the UPA message parameters section for this procedure. + +# 5.12 Proxy Mobile IPv6 Mobile Network Prefix Allocation procedure + +## 5.12.1 General + +Proxy Mobile IPv6 Mobile Network Prefix Allocation procedure is initiated by the node acting as a MAG when DHCPv6 Reply message is received from the node acting as a LMA which is co-located with delegating router if the UE requests a network prefix shorter than the default /64 prefix (i.e. prefixes in addition to the default prefix) as specified in 3GPP TS 23.402 [3]. The MAG sends a PBU to LMA associating the network prefix with an existing PDN connection. The LMA confirms the assigned network prefix by sending a PBA to the MAG. Proxy Mobile IPv6 Mobile Network Prefix Allocation achieves the following: + +- **Delegated Mobile Network Prefix assignment:** The LMA assigns to the UE's PDN connection the mobile network prefix shorter than the default /64 prefix valid in the selected PDN. +- **BCE Update:** The LMA includes the delegated mobile network prefix in the BCE for the PDN connection. +- **BULE Update:** The MAG includes the delegated mobile network prefix in the BULE for the PDN connection. + +### 5.12.1.1 Proxy Binding Update + +The fields of a PBU message for the PMIPv6 Mobile Network Prefix Allocation procedure are depicted in Table 5.12.1.1-1. + +The Mobility Options in a PBU message for the PMIPv6 Mobile Network Prefix Allocation procedure are depicted in Table 5.12.1.1-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +**Table 5.12.1.1-1: Fields of a PBU message for the PMIPv6 Mobile Network Prefix Allocation procedure** + +| Information element | IE Description | Reference | +|------------------------------------------|---------------------------------------------------------------------------------|--------------------| +| Sequence Number | Set to a locally (i.e. per MAG) monotonically increasing value. | IETF RFC 5213 [4] | +| Acknowledge (A) | Set to "1" to request an acknowledgement message. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Force UDP encapsulation request (F) Flag | Set to "0" to indicate that UDP encapsulation is not used for the user plane. | IETF RFC 5555 [34] | +| Lifetime | Set to the requested number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.12.1.1-2: Mobility Options in a PBU message for the PMIPv6 Mobile Network Prefix Allocation procedure procedure** + +| Information element | Cat. | IE Description | Reference | +|----------------------------------------|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| Mobile Node Identifier option | M | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003 [12]. | IETF RFC 5213 [4],
3GPP TS 23.003 [12] | +| Delegated Mobile Network Prefix Option | M | Set the Delegated Mobile Network Prefix Option to the mobile network prefix allocated to the UE's PDN connection. | IETF RFC 7148 [45] | +| Link-local Address | M | Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Set to the value "5" to indicate handoff state not changed (Re-registration). | IETF RFC 5213 [4] | +| Access Technology Type option | M | Set to the 3GPP access type, i.e., to GERAN, UTRAN or E-UTRAN. | IETF RFC 5213 [4] | +| Timestamp option | M | Set to the current time | IETF RFC 5213 [4] | +| Service Selection Mobility Option | M | Set to the EPS Access Point Name to which the UE's PDN connection is attached.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149 [11] | +| PDN connection ID | C | Contains the PDN connection ID if the BULE contains the PDN Connection ID. | Subclause 12.1.1.15 | + +NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. + +## 5.12.1.2 Proxy Binding Acknowledgement + +The fields of a PBA message for the PMIPv6 Mobile Network Prefix Allocation procedure are depicted in Table 5.12.1.2-1. + +The Mobility Options in a PBA message for the PMIPv6 Mobile Network Prefix Allocation procedure are depicted in Table 5.12.1.2-2. When the mobility option is present in the message, only the first instance shall be recognised. If multiple instances are included in the message, the receiver ignores all other instances. + +Other flags are not used by this specification. + +Only the message fields and mobility options used for acceptance cases are present in the following tables. + +**Table 5.12.1.2-1: Fields of a PBA message for the PMIPv6 Mobile Network Prefix Allocation procedure** + +| Information element | IE Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------|-------------------| +| Status | Set to indicate the result. | IETF RFC 6275 [8] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Update message is a proxy registration. | IETF RFC 5213 [4] | +| Sequence Number | Set to the value received in the corresponding PBU. | IETF RFC 5213 [4] | +| Lifetime | Set to the granted number of time units the binding shall remain valid. | IETF RFC 6275 [8] | + +**Table 5.12.1.2-2: Mobility Options in a PBA message for the PMIPv6 Mobile Network Prefix Allocation procedure** + +| Information element | Cat. | IE Description | Reference | +|--------------------------------------------------------------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| Mobile Node Identifier option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Delegated Mobile Network Prefix Option | M | Copied from corresponding field of PBU. | IETF RFC 7148 [45] | +| Link-local Address | M | Set to the link-local address already allocated to the MAG (in the previous initial binding registration) for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| Handoff Indicator option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Access Technology Type option | M | Copied from corresponding field of PBU. | IETF RFC 5213 [4] | +| Timestamp option | M | Copied from corresponding field of PBU, or set to the current time of LMA in case of timestamp error. | IETF RFC 5213 [4] | +| Service Selection Mobility Option | M | Copied from the corresponding field in the PBU message.
The encoding of the APN field follows 3GPP TS 23.003 [12] subclause 9.1 but excluding the trailing zero byte. The content of the APN field shall be the full APN with both the APN Network Identifier and APN Operator Identifier being present as specified in 3GPP TS 23.003 [12] subclauses 9.1.1 and 9.1.2.
NOTE 1. | IETF RFC 5149 [11] | +| 3GPP Specific PMIPv6 Error Code | O | Contain 3GPP Specific PMIPv6 Error Code (on S5/S8). | Subclause 12.1.1.1 | +| PDN connection ID | C | Contains the PDN connection ID received in PBU | Subclause 12.1.1.15 | +| NOTE 1: The APN field is not encoded as a dotted string as commonly used in documentation. | | | | + +## 5.12.2 MAG procedures + +The MAG initiating PMIPv6 Mobile Network Prefix Allocation using DHCPv6 prefix delegation procedure shall follow the "Delegating Router Co-located with Local Mobility Anchor" procedure as described in IETF RFC 7148 [45], while parameters in the PBU message are set as specified by the PBU message parameters section for this procedure. + +## 5.12.3 LMA procedures + +On reception of a PBU, the LMA shall initiate the " Delegating Router Co-located with Local Mobility Anchor " procedures as described described in IETF RFC 7148 [45], while parameters in the PBA message are set as specified by the PBA message parameters section for this procedure. + +## 6 Tunnel Management procedures + +### 6.1 General + +The Mobile Anchor Gateway (MAG) and the Local Mobility Anchor (LMA) establish and maintain a bi-directional tunnel for each PDN connection, which is used for routing the UE's PDN connection user-plane traffic between the MAG and the LMA. This tunnel is based on GRE encapsulation as specified in IETF RFC 2890 [21] (see also IETF RFC 2784 [20]) and is established as a result of exchanging the Proxy Binding Update (PBU) and the Proxy Binding Acknowledgment (PBA) messages between the MAG and LMA. The PBU and PBA messages establish unique Binding Cache Entry (BCE) and Binding Update List Entry (BULE) entries for each PDN connection at the LMA and the MAG respectively. The tunnel end points are: + +- the Proxy-CoA at the MAG and LMAA or LMA User Plane Address (if an alternate address is used for user plane) at the LMA with GRE encapsulation (for IPv6 transport network); or +- the IPv4-Proxy-CoA at the MAG and IPv4-LMAA or LMA User Plane Address (if an alternate address is used for user plane) at the LMA with GRE encapsulation (for IPv4 transport network), as described in IETF RFC 5845 [7]. + +GRE encapsulation shall always be used; the GRE tunneling negotiation described in IETF RFC 5845 [7] is not applicable and the GRE Key Identifier Option shall always be present in the PBU messages for PMIPv6 PDN Connection Creation and binding registration after handover. + +The LMA may assign an alternate LMAA or IPv4-LMAA during the setup of the PDN connection, if this option is supported by both MAG and LMA. + +Tear down of GRE tunnels and cleanup of state is done explicitly by MAG Initiated PDN Connection Deletion or LMA Initiated PDN Connection Deletion; additionally, the tunnel is torn down when the binding lifetime expires as described in IETF RFC 5213 [4]. + +A PMIPv6 node (MAG or LMA), which uses the control plane A protocol stack (see subclause 4.2) shall send signalling messages specified in Section 5 with IPv4-UDP encapsulation in IPv4 transport network as specified in IETF RFC 5844 [5]. + +A PMIPv6 node (MAG or LMA), which uses the control plane B protocol stack (see subclause 4.2) shall send signalling messages specified in Section 5 natively, without encapsulation in IPv6 transport network as specified in IETF RFC 5213 [4]. + +The maximum size of an inner IP packet that may be transmitted without fragmentation by the PDN GW or the MS/UE is the same as the maximum N-PDU size that can be transmitted without IP fragmentation as defined in 3GPP TS 23.060 [23]. + +Recommendations on how to set the default inner MTU size at the PDN GW and UE/MS to avoid IP fragmentation of both inner IP packets (in the PDN GW or UE/MS) and outer IP packets in the backbone are specified in clause 9.3 of 3GPP TS 23.060 [23]. + +To avoid network overload due to excessive signalling, when sending a PBU message, the requested binding lifetime should be sufficiently large, e.g. greater than 300 seconds. After accepting a PBU request, the binding lifetime may be reset to another value by the LMA based on local configuration. + +### 6.2 MAG procedure + +When the PDN connectivity is established, the downlink GRE key for the PDN connection downlink traffic is selected by the MAG and sent to LMA in PBU message. This downlink GRE key shall be unique within the MAG for a given LMAA or IPv4-LMAA, or for a given (IPv4-)Proxy-CoA if the MAG indicates to the LMA that it supports the capability to receive an alternate LMA address for user plane. + +The uplink GRE key is received from LMA in a PBA message, and also from the MME in case Serving GW relocation occurs. The MAG shall be able to send the PDN connection uplink traffic using the received uplink GRE key towards + +the LMAA or IPv4-LMAA or LMA User Plane Address (if an alternate address is used for user plane) before sending the PBU or before receiving the PBA. + +When the PDN connection is released, the downlink GRE key shall be released by the MAG. + +## 6.3 LMA procedure + +When the PDN connectivity is established, the uplink GRE key for the PDN connection uplink traffic is selected by the LMA and sent to MAG in PBA message. This uplink GRE key shall be unique within the LMA. + +The LMA function shall be able to accept the PDN connection uplink packets from any MAG without enforcing that the source IP address of the outer IP header matches the Proxy-CoA in the UE BCE. + +If GTP based S5/S8 is used for E-UTRAN access and PMIP based S2a is used for HRPD access, and optimized handover from E-UTRAN to HRPD is supported, when the PGW allocates an uplink TEID for a default bearer of a GTP tunnel, it shall also reserve an uplink GRE key with the same value of the default bearer uplink TEID. + +When the PDN connection is released, the uplink GRE key shall be released by the LMA. + +## 6.4 Data Structures + +### 6.4.1 Binding Update List Entry + +MAG maintains a unique Binding Update List Entry for for each PDN connection of a UE. The required elements of BULE as per 3GPP requirements are described in table 6.4.1-1. + +Table 6.4.1-1: Elements of BULE + +| Element | Description | Reference | +|-----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------| +| Mobile Node Identifier | Set to the UE NAI that is derived from the UE IMSI if an authenticated IMSI is available, or from the UE IMEI if IMSI is not available or the IMSI is not authenticated by the network. The NAI format is specified in 3GPP TS 23.003 [12]. | 3GPP TS 23.003 [12], IETF RFC 5213 [4] | +| Access Point Name | Set to the EPS Access Point Name to which the UE's PDN connection is attached, formatted as defined in 3GPP TS 23.003 [12] | 3GPP TS 23.003 [12] | +| Lifetime | Set to lifetime granted for the binding as received in PBA. | IETF RFC 6275 [8] | +| Remaining Lifetime | This lifetime is initialized from the lifetime granted for the binding and is decremented until it reaches 0. | IETF RFC 6275 [8] | +| Sequence Number | The sequence number of the last Proxy Binding Update message sent. | IETF RFC 6275 [8] | +| Timestamp | Time at which last PBU was sent. | IETF RFC 6275 [8] | +| Binding Flag | Set to 1 if MAG receives an ICMPv6 parameter problem, code 1, error message in response to a PBU. Set to 0 if MAG continues to send PBU. | IETF RFC 6275 [8] | +| IPv6 Home Network Prefix | IPv6 Home Network Prefix assigned to the UE's PDN connection. | IETF RFC 5213 [4] | +| Link-local Address | IPv6 Link-local address to be used by the MAG on the access link shared with the UE. | IETF RFC 5213 [4] | +| IPv4 Home Address | IPv4 Home Address assigned to UE's PDN connection. | IETF RFC 5213 [4] | +| IPv4 default-router address | The IPv4 default-router address of the mobile node. | IETF RFC 5844 [5] | +| LMA IPv6 Address | IPv6 Address of the LMA for control plane, and for user plane if no alternate LMA user plane address is used. | IETF RFC 6275 [8] | +| LMA IPv4 Address | IPv4 Address of the LMA for control plane, and for user plane if no alternate LMA user plane address is used. | IETF RFC 5844 [5] | +| LMA User-Plane Address | IPv4 or IPv6 Address of the LMA for user plane. | IETF RFC 7389 [44] | +| Downlink GRE Key | Downlink GRE key for the PDN connection as selected by MAG. | IETF RFC 5845 [7] | +| Uplink GRE key | Uplink GRE key for the PDN connection selected by LMA as received in GRE Key option of PBA. | IETF RFC 5845 [7] | +| Chained Binding Cache Entry | Reference to the corresponding BCE used for the binding on the S8 interface.
It shall be present only in the Serving GW, in case of S2a/S2b - PMIP based-S8 chaining. | | +| PDN Connection ID | Set to the PDN Connection ID if multiple PDN connections to the same APN is supported by both MAG and LMA | Subclause 12.1.1.15 | + +## 6.4.2 Binding Cache Entry + +LMA maintains a unique Binding Cache Entry for each PDN connection for a UE. The required elements of BCE as per 3GPP requirements are described in table 6.4.1-2. + +**Table 6.4.2-1: Elements of BCE** + +| Element | Element Description | Reference | +|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------| +| Mobile Node Identifier | The MN-Id mobility option as received in PBU. | 3GPP TS 23.003 [12], IETF RFC 5213 [4] | +| Access Point Name | The Service Selection Mobility option received in PBU | 3GPP TS 23.003 [12] | +| Lifetime | Lifetime granted for the binding. | IETF RFC 6275 [8] | +| Sequence Number | Sequence number of last received PBU. | IETF RFC 6275 [8] | +| IPv6 Home Network Prefix | IPv6 Home Network Prefix assigned to the UE's PDN connection. | IETF RFC 5213 [4] | +| Link-local Address | The assigned IPv6 link local address to MAG for use on the access link shared with the UE. | IETF RFC 5213 [4] | +| IPv4 Home Address | IPv4 Home Address assigned to UE's PDN connection. | IETF RFC 5213 [4] | +| IPv4 default-router address | The IPv4 default-router address of the mobile node. | IETF RFC 5844 [5] | +| IPv6 Proxy care-of-address | MAG IPv6 Address, i.e. the source address of the IP packet in which PBU was received. | IETF RFC 6275 [8] | +| IPv4 Proxy care-of-address | MAG IPv4 Address. | IETF RFC 5844 [5] | +| LMA User-Plane Address | IPv4 or IPv6 Address of the LMA for user plane. | IETF RFC 7389 [44] | +| Access Technology Type | Access Technology Type as received in PBU. | IETF RFC 5213 [4] | +| Timestamp | Timestamp as received in PBU. | | +| Binding Flag | '1' as it is proxy registration. | IETF RFC 5213 [4] | +| Downlink GRE key | Downlink GRE key for the PDN connection selected by MAG as received in GRE key option of PBU. | IETF RFC 5845 [7] | +| Uplink GRE key | Uplink GRE key for the PDN connection selected by LMA. | IETF RFC 5845 [7] | +| Chained Binding Update List Entry | Reference to the corresponding BULE used for binding on the S2a / S2b interface.
It shall be present only in the Serving GW, in case of S2a/S2b – PMIP-based S8 chaining. | | +| PDN Connection ID | Set to the PDN Connection ID if multiple PDN connections to the same APN is supported by both MAG and LMA | Subclause 12.1.1.15 | + +## 6.5 Security + +Security aspects for PMIPv6 are described in 3GPP TS 33.402 [19]. + +## 7 Path Management procedures + +### 7.1 General + +The path management for PMIPv6 is very similar to that of GTP; the main difference is the use of PMIPv6 messages instead of GTP messages. + +Path failure handling procedures are specified in 3GPP TS 23.007 [13]. + +### 7.2 Heartbeat Mechanism + +#### 7.2.1 General + +A LMA or MAG shall support sending Heartbeat Message to a peer MAG or LMA for Failure Detection and Restart Detection. The Heartbeat Message and procedures of Failure Detection and Restart Detection are defined in IETF RFC 5847 [17]. When and how often a Heartbeat Request message are sent is implementation specific but a periodic Heartbeat Request shall not be sent more often than every 60 s on each path. + +#### 7.2.2 Heartbeat Message + +##### 7.2.2.1 Heartbeat Request + +Table 7.2.2.1-1 specifies the information elements included in the Heartbeat Request message. + +**Table 7.2.2.1-1: Fields of a Heartbeat message for the Heartbeat request** + +| Information element | IE Description | Reference | +|---------------------|--------------------------------------------------|--------------------| +| R flag | Set to 0 for a request message. | IETF RFC 5847 [17] | +| Sequence Number | Set to a locally monotonically increasing value. | IETF RFC 5847 [17] | + +##### 7.2.2.2 Heartbeat Response + +Table 7.2.2.2-1 and 7.2.2.2-2 specifies the information elements included in the Heartbeat Response message. + +**Table 7.2.2.2-1: Fields of a Heartbeat message for the Heartbeat Response** + +| Information element | IE Description | Reference | +|---------------------|-----------------------------------------------------------------------------------------------------|--------------------| +| R flag | Set to 1 for a response message. | IETF RFC 5847 [17] | +| U flag | Set to 0 if the heartbeat response is sent as an answer to a heartbeat request. Set to 1 otherwise. | IETF RFC 5847 [17] | +| Sequence Number | Set to the value received in the corresponding Heartbeat Request message. | IETF RFC 5847 [17] | + +**Table 7.2.2.2-2: Mobility Options in a Heartbeat message for the Heartbeat Response** + +| Information element | IE Description | Reference | +|---------------------|---------------------------------------------|--------------------| +| Restart Counter | indicates the current Restart Counter value | IETF RFC 5847 [17] | + +## 7.3 Void + +## 7.4 Void + +## 7.5 Void + +## 7.6 UE-specific Error Handling + +### 7.6.1 General + +A PMIPv6 node (i.e., LMA or MAG) may support the UE-specific error indication such that a PMIPv6 node may send a message to the source PMIPv6 node when no binding exists for a packet received from a GRE tunnel. + +### 7.6.2 MAG and LMA procedure + +If a PMIPv6 receiving node (i.e. MAG or LMA) verifies that no PMIPv6 binding exists for a received user packet based on GRE Key, the receiving PMIPv6 node shall discard the packet. The PMIPv6 node may report the error to the peer PMIPv6 node, in the form of an ICMP message, as specified in Sections 8.1, 8.2 and 8.3 of IETF RFC2473 [31] for the node unreachable error case. + +Handling of the received error in the form of an ICMP message is specified in 3GPP TS 23.007 [13]. + +## 7.7 Void + +## 7.8 Partial node failure requiring the removal of a subset of sessions + +### 7.8.1 General + +See 3GPP TS 23.007 [13] for the description of this function. + +### 7.8.2 Binding Revocation Indication message + +The fields of a BRI message to revoke bulk PMIPv6 bindings initiated by the LMA or the MAG are depicted in Table 7.8.2-1. + +The Mobility Options in a BRI message to revoke bulk PMIPv6 bindings sent by the LMA or the MAG are depicted in Table 7.8.2-2. + +**Table 7.8.2-1: Fields of a BRI message for the PMIPv6** + +| Information element | IE Description | Reference | +|------------------------------|---------------------------------------------------------------------------------------------------|-------------------| +| Revocation Trigger | Set to the value of "Revoking Mobility Node Local Policy" | IETF RFC 5846 [6] | +| Sequence Number | A sequence number generated by the LMA, and increased for every BRI sent. | IETF RFC 5846 [6] | +| Proxy Binding Flag (P) | Set to "1" to indicate that the Binding Revocation Indication is for a proxy MIPv6 binding entry. | RFC 5213 [4] | +| IPv4 HoA Binding Only (V) | Set to "0" to request for complete binding revocation | IETF RFC 5846 [6] | +| Global Per-Peer Bindings (G) | Set to 1 | IETF RFC 5846 [6] | + +**Table 7.8.2-2: Mobility Options in a BRI message for the PMIPv6 LMA or MAG Initiated bulk PDN Connections Deletion for Partial Node failure** + +| Information element | Cat. | IE Description | Reference | +|-----------------------------------------------|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| Mobile Node Identifier | C | Set to the IP address of the MAG, only when the BRI message is sent by the MAG. | 3GPP TS 23.402[3] | +| Fully Qualified PDN Connection Set Identifier | M | This IE shall be included by the MAG or LMA on the S5/S8, S2a (for Trusted WLAN Access) and S2b interfaces (see 3GPP TS 23.007 [13]) and contains the Fully Qualified PDN Connection Set Identifier(s) that need to be revoked. | Subclause 12.1.1.2 | + +### 7.8.3 Binding Revocation Acknowledgement message + +The fields of a BRA message to revoke bulk PMIPv6 bindings for the PMIPv6 LMA or MAG Initiated PDN Connection Deletion procedure are depicted in Table 7.8.3-1. + +**Table 7.8.3-1: Fields of a BRA message for a PMIPv6 for a MAG or LMA Initiated bulk PDN Connections Deletion for Partial Node failure** + +| Information element | IE Description | Reference | +|------------------------------|-------------------------------------------------------------------------------------------------------|-------------------| +| Status | Indicates the result of the BRI. | IETF RFC 5846 [6] | +| Sequence Number | Set to the value received in the corresponding BRI. | IETF RFC 5846 [6] | +| Proxy Registration Flag (P) | Set to "1" to indicate that the Binding Revocation Acknowledgment is for a proxy MIPv6 binding entry. | RFC 5213 [4] | +| IPv4 HoA Binding Only (V) | Set to "0"; the same value as for BRI | IETF RFC 5846 [6] | +| Global Per-Peer Bindings (G) | Set to 1; the same value as for the BRI. | IETF RFC 5846 [6] | + +### 7.8.4 MAG procedures + +The MAG can be the initiator or the receiver of a BRI message to revoke bulk PMIPv6 bindings. + +The MAG shall follow the "Local Mobility Anchor Revokes Bulk PMIPv6 Bindings" procedure described in the IETF RFC 5846 [6] when it receives a Binding Revocation Indication message with G bit set, removing the sessions identified by the Fully Qualified PDN Connection Set Identifier Mobility Option. + +The MAG shall follow the "Mobile Access Gateway Revoke Bulk PMIPv6 Bindings" when it sends a Binding Revocation Indication message with G bit set to the LMA, including the Fully Qualified PDN Connection Set Identifier Mobility Option. + +### 7.8.5 LMA procedures + +The LMA can be the initiator or the receiver of a BRI message to revoke bulk PMIPv6 bindings. + +The LMA shall follow the "Mobile Access Gateway Revokes Bulk PMIPv6 Bindings" procedure described in the IETF RFC 5846 [6] when it receives a Binding Revocation Indication message with G bit set, removing the sessions identified by the Fully Qualified PDN Connection Set Identifier Mobility Option. + +The LMA shall follow the "Local Mobility Anchor Revoke Bulk PMIPv6 Bindings" when it sends a Binding Revocation Indication message with G bit set to the LMA, including the Fully Qualified PDN Connection Set Identifier Mobility Option. + +--- + +## 8 PMIP-based S5 and PMIP-based S8 description + +### 8.1 Initial Attach procedures + +#### 8.1.1 General + +#### 8.1.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. + +#### 8.1.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3 + +### 8.2 Serving GW Initiated PDN Connection Lifetime Extension procedures + +#### 8.2.1 General + +#### 8.2.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.2. + +#### 8.2.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.3. + +### 8.3 UE, MME or HSS initiated Detach procedures + +#### 8.3.1 General + +#### 8.3.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2 repeated for each PDN connection of the UE. + +#### 8.3.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +## 8.4 PDN GW Initiated PDN Disconnection procedures + +### 8.4.1 General + +### 8.4.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.2. + +### 8.4.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 LMA Initiated PDN Connection Deletion for the selected PDN connection as outlined in subclause 5.5.3. + +The PGW shall include the 3GPP Specific PMIPv6 error code IE and set it to the cause "Reactivation requested" when the PGW initiates the PDN GW Initiated Resource Allocation Deactivation procedure as part of the P-CSCF restoration procedure over 3GPP access, as specified in 3GPP TS 23.380 [36]. + +## 8.5 UE Requested Additional PDN Connectivity procedures + +### 8.5.1 General + +### 8.5.2 Serving GW procedures + +If the Request Type indicates "initial attach", the Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. + +If the Request Type indicates "Handover", the Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +### 8.5.3 PDN GW procedures + +If the Request Type indicates "initial attach", the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3. + +If the Request Type indicates "Handover", the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +## 8.6 Handover procedures + +### 8.6.1 Intra-LTE TAU and Inter-eNodeB Handover with Serving GW Relocation procedures + +#### 8.6.1.1 General + +#### 8.6.1.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2 repeated for each PDN connection of the UE. + +#### 8.6.1.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +## 8.6.2 TAU/RAU or Handover between GERAN A/Gb Mode or UTRAN Iu Mode and E-UTRAN procedures + +### 8.6.2.1 General + +### 8.6.2.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2 repeated for each PDN connection of the UE. + +### 8.6.2.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +## 8.6.3 Handover from Trusted or Untrusted Non-3GPP IP Access over S2a/S2b to 3GPP Access Handover E-UTRAN over PMIP based S5/S8 without optimization procedures + +### 8.6.3.1 General + +### 8.6.3.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2 repeated for each PDN connection of the UE. + +### 8.6.3.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +## 8.6.4 Handover from Trusted or Untrusted Non-3GPP IP Access over S2a/S2b to 3GPP Access UTRAN/GERAN over PMIP based S5/S8 without optimization + +### 8.6.4.1 General + +### 8.6.4.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2 repeated for each PDN connection of the UE. + +### 8.6.4.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +## 8.6.5 Handover from Trusted or Untrusted Non-3GPP IP Access over S2c to 3GPP Access over PMIP based S5/S8 without optimization + +### 8.6.5.1 General + +### 8.6.5.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2 repeated for each PDN connection of the UE. + +### 8.6.5.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +## 8.6.6 Void + +## 8.6.7 Void + +## 8.7 UE Requested PDN Disconnection procedures + +### 8.7.1 General + +### 8.7.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion, for the selected PDN connection as outlined in subclause 5.4.2. + +### 8.7.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion, for the selected PDN connection as outlined in subclause 5.4.3. + +## 8.8 IPv4 Address Allocation using DHCP + +### 8.8.1 General + +### 8.8.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the Proxy Mobile IPv6 PDN Connection IPv4 Address Allocation Procedure as defined in sub clause 5.6.2. + +### 8.8.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the Proxy Mobile IPv6 PDN Connection IPv4 Address Allocation Procedure as defined in sub clause 5.6.3. + +## 8.9 PDN-GW Initiated IPv4 Address Delete Procedure + +### 8.9.1 General + +### 8.9.2 Serving GW procedures + +If UE is assigned both IPv6 HNP and IPv4 HoA, the Serving GW shall follow the MAG procedure for the LMA Initiated IPv4 Address Release procedure as defined in sub clause 5.7.2. + +### 8.9.3 PDN GW procedures + +If UE is assigned both IPv6 HNP and IPv4 HoA, the PDN GW shall follow the LMA procedure for the LMA Initiated IPv4 Address Release procedure as defined in sub clause 5.7.3. + +If UE is assigned only IPv4 HoA, then PDN-GW initiated PDN Disconnection procedure is initiated. + +## 8.10 Mobile Network Prefix Allocation using DHCPv6 Prefix Delegation + +### 8.10.1 General + +### 8.10.2 Serving GW procedures + +The Serving GW shall follow the MAG procedure for the Proxy Mobile IPv6 Mobile Network Prefix Allocation procedure as defined in subclause 5.12.2. + +### 8.10.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the Proxy Mobile IPv6 Mobile Network Prefix Allocation procedure as defined in sub clause 5.12.3. + +--- + +## 9 Trusted Non-3GPP Access over S2a Description + +### 9.0 General + +Please refer to clause 13 for the description of the Trusted WLAN Access over S2a interface. + +### 9.1 Initial Attach procedures + +#### 9.1.1 General + +#### 9.1.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. + +#### 9.1.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3. + +The PGW may include a PGW Back-Off Time IE when rejecting the PBU with the cause "APN congestion" (see subclause 4.5.8 of 3GPP TS 23.402 [3]). + +## 9.2 Trusted Non-3GPP Access Initiated PDN Connection Lifetime Extension procedures + +### 9.2.1 General + +### 9.2.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.2. + +### 9.2.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.3. + +## 9.3 UE / Trusted Non-3GPP Access Initiated Detach and UE Requested PDN Disconnection procedures + +### 9.3.1 General + +### 9.3.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2 for PDN Disconnection procedure,. + +For Detach the Trusted Non-3GPP Access shall follow the above repeated for each PDN connection of the UE. + +### 9.3.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +## 9.4 HSS / AAA Initiated Detach procedures + +### 9.4.1 General + +The HSS/AAA may initiate a detach procedure resulting in a PMIPv6 De-Registration. + +### 9.4.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2 repeated for each PDN connection of the UE. + +### 9.4.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +## 9.5 UE Initiated Connectivity to Additional PDN procedures + +### 9.5.1 General + +### 9.5.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, if the Request Type indicates "initial attach", the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. If the Request Type indicates "Handover", the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +### 9.5.3 PDN GW procedures + +In PMIPv6 mode, if the Request Type indicates "initial attach", the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3. If the Request Type indicates "Handover", the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +If the Request Type indicates "initial attach" or "handover", the PGW may include a PGW Back-Off Time IE when rejecting the PBU with the cause "APN congestion" (see subclause 4.5.8 of 3GPP TS 23.402 [3]). + +## 9.6 3GPP Access to Trusted Non-3GPP IP Access with PMIPv6 on S2a Handover procedures without optimization + +### 9.6.1 General + +### 9.6.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +### 9.6.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +If IPv6 network prefix preservation is supported at a handover from 3GPP Access with a GTP-based S5/S8 to non-3GPP Access, the LMA shall provide to the MAG the link-local address which is used by the PDN GW at the link shared with the UE in the 3GPP Access. + +## 9.7 PDN GW Initiated Resource Allocation Deactivation procedures + +### 9.7.1 General + +### 9.7.2 Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.2. + +### 9.7.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.3. + +## 9.8 IPv4 Address Allocation using DHCP + +### 9.8.1 General + +### 9.8.2 Trusted Non-3GPP Access procedures + +The Trusted Non-3GPP Access shall follow the MAG procedure for the Proxy Mobile IPv6 PDN Connection IPv4 Address Allocation Procedure as defined in sub clause 5.6.2. + +### 9.8.3 PDN GW procedures + +The PDN GW shall follow the LMA procedure for the Proxy Mobile IPv6 PDN Connection IPv4 Address Allocation Procedure as defined in sub clause 5.6.3. + +## 9.9 PDN-GW Initiated IPv4 Address Delete Procedure + +### 9.9.1 General + +### 9.9.2 Trusted Non-3GPP Access procedures + +If UE is assigned both IPv6 HNP and IPv4 HoA, the Trusted Non-3GPP Access shall follow the MAG procedure for the LMA Initiated IPv4 Address Release procedure as defined in sub clause 5.7.2. + +### 9.9.3 PDN GW procedures + +If UE is assigned both IPv6 HNP and IPv4 HoA, the PDN GW shall follow the LMA procedure for the LMA Initiated IPv4 Address Release procedure as defined in sub clause 5.7.3. + +If UE is assigned only IPv4 HoA, then PDN-GW initiated Resource Allocation Deactivation procedure is initiated. + +## 9.10 Optimized E-UTRAN to CDMA2000 eHRPD Handover procedure + +### 9.10.1 General + +### 9.10.2 CDMA2000 HRPD access procedure + +In PMIPv6 mode, the CDMA2000 HRPD access shall follow the MAG procedure for the PMIPv6 PDN Connection Handover procedure as outlined in subclause 5.3.2. + +### 9.10.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover procedure as outlined in subclause 5.3.3. + +## 9.11 Optimized Idle Mode Mobility: E-UTRAN Access to cdma2000 eHRPD Access procedure + +### 9.11.1 General + +### 9.11.2 CDMA2000 eHRPD access procedure + +In PMIPv6 mode, the CDMA2000 eHRPD access shall follow the MAG procedure for the PMIPv6 PDN Connection Handover procedure as outlined in subclause 5.3.2. + +### 9.11.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover procedure as outlined in subclause 5.3.3. + +--- + +## 10 Untrusted Non-3GPP Access over S2b Description + +### 10.1 Initial Attach procedures + +#### 10.1.1 General + +If multiple authentications are supported by the network both ePDG and PDN GW shall support the corresponding procedures as specified for PAP and CHAP authentication of the UE with external networks in 3GPP TS 33.402 [19]. Multiple authentication is per PDN connection when the UE requested additional PDN connectivity as specified in subclause 10.5. + +#### 10.1.2 ePDG procedures + +In PMIPv6 mode, the ePDG shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. + +If ePDG supports multiple authentication exchanges with the UE in the IKEv2 protocol, the ePDG shall send the PAP or CHAP additional authentication and authorization information received from the UE in the Additional Protocol Configuration Options IE in the PBU to the PDN-GW as specified 3GPP TS 33.402 [19]. The ePDG shall follow the multiple authentication procedures when receiving PAP or CHAP additional authentication and authorization information in the Additional Protocol Configuration Options IE in the PBA from the PDN-GW and sending the information to the UE as specified in 3GPP TS 33.402 [19]. + +If the UE requests the DNS IPv4/IPv6 address in the Configuration Payload (CFG\_REQ) during the IPsec tunnel establishment procedure, as specified 3GPP TS 33.402 [19], and if the ePDG supports the Additional Protocol Configuration Options IE, the ePDG may include this IE in the PBU to the PDN-GW and correspondingly set "DNS IPv4/IPv6 Server Address Request" parameter. If the ePDG receives the Additional Protocol Configuration Options IE with "DNS Server IPv4/v6 Address" parameter in the PBA from the PDN-GW, the ePDG shall send this information in the Configuration Payload (CFG\_REPLY) to the UE as specified in 3GPP TS 33.402 [19]. + +If the UE includes the P-CSCF\_IP6\_ADDRESS attribute, or the P-CSCF\_IP4\_ADDRESS attribute or both in the CFG\_REQUEST configuration payload during the IPsec tunnel establishment procedure as specified in 3GPP TS 24.302 [39], and if the ePDG supports these IKEv2 attributes and the Additional Protocol Configuration Options IE, the ePDG shall include the Additional Protocol Configuration Options IE in the PBU to the PDN-GW and correspondingly set the P-CSCF IPv6 Address Request, or P-CSCF IPv4 Address Request, or both parameters as defined in 3GPP TS 24.008 [16]. If the ePDG receives the Additional Protocol Configuration Options IE with the P-CSCF IPv4 Address, or P-CSCF IPv6 Address, or both parameters respectively in the PBA from the PDN-GW, the ePDG shall send these information in the Configuration Payload (CFG\_REPLY) to the UE as specified in 3GPP TS 24.302 [39]. + +If the UE includes the P-CSCF\_RESELECTION\_SUPPORT attribute in the CFG\_REQUEST configuration payload during the IPsec tunnel establishment procedure as specified in 3GPP TS 24.302 [39], and if the ePDG supports the P-CSCF restoration extension procedure for the untrusted WLAN access (see 3GPP TS 23.380 [36]), the ePDG shall include the Additional Protocol Configuration Options IE in the PBU to the PDN-GW and correspondingly set the P-CSCF\_RESELECTION\_SUPPORT, as defined in 3GPP TS 24.008 [16]. + +### 10.1.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3. + +If PDN GW supports multiple authentications it shall send the PAP or CHAP additional authentication and authorization information received from the ePDG in the Additional Protocol Configuration Options IE in the PBU to the external AAA server and the PDN GW shall send the PAP or CHAP additional authentication and authorization information received from the external AAA server to the ePDG in the Additional Protocol Configuration Options IE in the PBA as specified in 3GPP TS 33.402 [19]. + +If the PDN-GW supports Additional Protocol Configuration Options IE and if the PDN-GW receives it with the "DNS IPv4/IPv6 Server Address Request" parameter in the PBU from the ePDG, the PGW may include the Additional Protocol Configuration Options IE in the PBA and correspondingly set "DNS IPv4/IPv6 Address" as specified in 3GPP TS 24.008 [16]. + +If the PDN-GW supports the Additional Protocol Configuration Options IE and if the PGW receives it with the P-CSCF IPv4 Address Request, or P-CSCF IPv6 Address Request or both parameters in the PBU from the ePDG, the PGW may include the Additional Protocol Configuration Options IE in the PBA and correspondingly set it with the P-CSCF IPv4 Address, or P-CSCF IPv6 Address, or both parameters respectively as specified in 3GPP TS 24.008 [16]. + +## 10.2 ePDG Initiated PDN Connection Lifetime Extension procedures + +### 10.2.1 General + +### 10.2.2 ePDG procedures + +In PMIPv6 mode, the ePDG shall follow the MAG procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.2. + +### 10.2.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.3. + +## 10.3 UE / ePDG Initiated Detach and UE Requested PDN Disconnection procedures + +### 10.3.1 General + +### 10.3.2 ePDG procedures + +In PMIPv6 mode, the ePDG shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2 for PDN Disconnection procedure, + +For Detach the ePDG shall follow the above repeated for each PDN connection of the UE. + +### 10.3.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +## 10.4 HSS / AAA Initiated Detach procedures + +### 10.4.1 General + +The HSS/AAA may initiate a detach procedure resulting in a PMIPv6 De-Registration. + +### 10.4.2 ePDG procedures + +In PMIPv6 mode, the ePDG shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2 repeated for each PDN connection of the UE. + +### 10.4.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +## 10.5 UE Initiated Connectivity to Additional PDN procedures + +### 10.5.1 General + +### 10.5.2 ePDG procedures + +In PMIPv6 mode, if the Request Type indicates "initial attach", the ePDG shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. If the Request Type indicates "Handover", the ePDG shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +If the UE requests the DNS IPv4/IPv6 address in the Configuration Payload (CFG\_REQ) during the IPsec tunnel establishment procedure, as specified 3GPP TS 33.402 [19], and if the ePDG supports the Additional Protocol Configuration Options IE, the ePDG may include this IE in the PBU to the PDN-GW and correspondingly set "DNS IPv4/IPv6 Server Address Request" parameter. If the ePDG receives the Additional Protocol Configuration Options IE with "DNS Server IPv4/v6 Address" parameter in the PBA from the PDN-GW, the ePDG shall send this information in the Configuration Payload (CFG\_REPLY) to the UE as specified in 3GPP TS 33.402 [19]. + +If the UE includes the P-CSCF\_IP6\_ADDRESS attribute, or the P-CSCF\_IP4\_ADDRESS attribute or both in the CFG\_REQUEST configuration payload during the IPsec tunnel establishment procedure as specified in 3GPP TS 24.302 [39], and if the ePDG supports these IKEv2 attributes and the Additional Protocol Configuration Options IE, the ePDG shall include the Additional Protocol Configuration Options IE in the PBU to the PDN-GW and correspondingly set the P-CSCF IPv6 Address Request, or P-CSCF IPv4 Address Request, or both parameters as defined in 3GPP TS 24.008 [16]. If the ePDG receives the Additional Protocol Configuration Options IE with the P-CSCF IPv4 Address, or P-CSCF IPv6 Address, or both parameters respectively in the PBA from the PDN-GW, the ePDG shall send these information in the Configuration Payload (CFG\_REPLY) to the UE as specified in 3GPP TS 24.302 [39]. + +If the UE includes the P-CSCF\_RESELECTION\_SUPPORT attribute in the CFG\_REQUEST configuration payload during the IPsec tunnel establishment procedure as specified in 3GPP TS 24.302 [39], and if the ePDG supports the P-CSCF restoration extension procedure for the untrusted WLAN access (see 3GPP TS 23.380 [36]), the ePDG shall include the Additional Protocol Configuration Options IE in the PBU to the PDN-GW and correspondingly set the P-CSCF\_RESELECTION\_SUPPORT, as defined in 3GPP TS 24.008 [16]. + +### 10.5.3 PDN GW procedures + +In PMIPv6 mode, if the Request Type indicates "initial attach", the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3. If the Request Type indicates "Handover", the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +If the PDN-GW supports Additional Protocol Configuration Options IE and if the PDN-GW receives it with the "DNS IPv4/IPv6 Server Address Request" parameter in the PBU from the ePDG, the PGW may include the Additional Protocol Configuration Options IE in the PBA and correspondingly set "DNS IPv4/IPv6 Address" as specified in 3GPP TS 24.008 [16]. + +If the PDN-GW supports the Additional Protocol Configuration Options IE and if the PGW receives it with the P-CSCF IPv4 Address Request, or P-CSCF IPv6 Address Request or both parameters in the PBU from the ePDG, the PGW may include the Additional Protocol Configuration Options IE in the PBA and correspondingly set it with the P-CSCF IPv4 Address, or P-CSCF IPv6 Address, or both parameters respectively as specified in 3GPP TS 24.008 [16]. + +## 10.6 3GPP Access to Untrusted Non-3GPP IP Access with PMIPv6 on S2b Handover procedures without optimization + +### 10.6.1 General + +### 10.6.2 ePDG procedures + +In PMIPv6 mode, the ePDG shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +If the UE includes the P-CSCF\_RESELECTION\_SUPPORT attribute in the CFG\_REQUEST configuration payload during the IPsec tunnel establishment procedure as specified in 3GPP TS 24.302 [39], and if the ePDG supports the P-CSCF restoration extension procedure for the untrusted WLAN access (see 3GPP TS 23.380 [36]), the ePDG shall include the Additional Protocol Configuration Options IE in the PBU to the PDN-GW and correspondingly set the P-CSCF\_RESELECTION\_SUPPORT, as defined in 3GPP TS 24.008 [16]. + +### 10.6.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +If IPv6 network prefix preservation is supported at a handover from 3GPP Access with a GTP-based S5/S8 to non-3GPP Access, the LMA shall provide to the MAG the link-local address which is used by the PDN GW at the link shared with the UE in the 3GPP Access. + +## 10.7 PDN GW Initiated Resource Allocation Deactivation procedures + +### 10.7.1 General + +### 10.7.2 ePDG procedures + +In PMIPv6 mode, the ePDG shall follow the MAG procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.2. + +### 10.7.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.3. + +The PGW shall include the 3GPP Specific PMIPv6 error code IE and set it to the cause "Reactivation requested" when the PGW initiates the PDN GW Initiated Resource Allocation Deactivation procedure as part of the P-CSCF restoration procedure over WLAN access, as specified in 3GPP TS 23.380 [36]. + +## 10.8 PDN-GW Initiated IPv4 Address Delete Procedure + +### 10.8.1 General + +### 10.8.2 ePDG procedures + +If UE is assigned both IPv6 HNP and IPv4 HoA, the ePDG shall follow the MAG procedure for the LMA Initiated IPv4 Address Release procedure as defined in sub clause 5.7.2. + +### 10.8.3 PDN GW procedures + +If UE is assigned both IPv6 HNP and IPv4 HoA, the PDN GW shall follow the LMA procedure for the LMA Initiated IPv4 Address Release procedure as defined in sub clause 5.7.3. + +If UE is assigned only IPv4 HoA, then PDN-GW initiated Resource Allocation Deactivation procedure is initiated. + +--- + +## 11 S2a and S2b Chaining with PMIP-based S8 Description + +### 11.1 Initial Attach procedures + +#### 11.1.1 General + +#### 11.1.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Creation. In addition to the general procedure, it shall include the PDN GW IP address received during the authorization procedure into the PBU request, encoding it into a Vendor-Specific Option (refer to clause 12.1.1.4). + +#### 11.1.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 PDN Connection Creation on the S2a/S2b interface. In addition to the general procedure, the Serving GW shall include the PDN GW IP address received in the PBU request into the PBA, using the same encoding (refer to clause 12.1.1.4). +- the MAG procedure for the PMIPv6 PDN Connection Creation on the S8 interface. The Serving GW shall send the PBU request to the PDN GW IP address received on the chained S2a / S2b interface. + +## 11.2 ePDG / Trusted Non-3GPP Access Initiated PDN Connection Lifetime Extension procedures + +### 11.2.1 General + +### 11.2.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Lifetime Extension. + +### 11.2.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 PDN Connection Lifetime Extension on the S2a/S2b interface. +- the MAG procedure for the PMIPv6 PDN Connection Lifetime Extension on the S8 interface. + +## 11.3 UE / ePDG / Trusted Non-3GPP Access Initiated Detach procedures + +### 11.3.1 General + +### 11.3.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion repeated for each PDN connection of the UE. + +### 11.3.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion on the S2a/S2b interface. +- the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion on the S8 interface. + +## 11.4 HSS / AAA Initiated Detach procedures + +### 11.4.1 General + +The HSS/AAA may initiate a detach procedure resulting in a PMIPv6 De-Registration. + +### 11.4.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion repeated for each PDN connection of the UE. + +### 11.4.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion on the S2a/S2b interface. +- the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion on the S8 interface. + +## 11.5 UE Initiated Connectivity to Additional PDN procedures + +### 11.5.1 General + +### 11.5.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Creation if the Request Type indicates "initial attach", or the PMIPv6 PDN Connection Handover if the Request Type indicates "Handover". In addition to the general procedure, it shall include the PDN GW IP address received during the authorization procedure into the PBU request, encoding it to the Vendor-Specific Option (refer to clause 12.1.1.4). + +### 11.5.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 PDN Connection Creation if the Request Type indicates "initial attach", or the PMIPv6 PDN Connection Handover if the Request Type indicates "Handover" on the S2a/S2b interface. In addition to the general procedure, the Serving GW shall include the PDN GW IP address received in the PBU request into the PBA, using the same encoding (refer to clause 12.1.1.4). +- the MAG procedure for the PMIPv6 PDN Connection Creation if the Request Type indicates "initial attach", or the PMIPv6 PDN Connection Handover if the Request Type indicates "Handover" on the S8 interface. The Serving GW shall send the PBU request to the PDN GW IP address received on the chained S2a / S2b interface. + +## 11.6 3GPP Access to Trusted / Untrusted Non-3GPP IP Access Handover procedures without optimization + +### 11.6.1 General + +### 11.6.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 PDN Connection Handover. In addition to the general procedure, it shall include the PDN GW IP address received during the authorization procedure into the PBU request, encoding it to the Vendor-Specific Option (refer to clause 12.1.1.4). + +### 11.6.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 PDN Connection Handover on the S2a/S2b interface. In addition to the general procedure, the Serving GW shall include the PDN GW IP address received in the PBU request into the PBA, using the same encoding (refer to clause 12.1.1.4). +- the MAG procedure for the PMIPv6 PDN Connection Handover on the S8 interface. The Serving GW shall send the PBU request to the PDN GW IP address received on the chained S2a / S2b interface. + +## 11.7 UE Requested PDN Disconnection procedures + +### 11.7.1 General + +### 11.7.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion, for the selected PDN connection. + +### 11.7.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion, for the selected PDN connection on the S2a/S2b interface. +- the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion, for the selected PDN connection on the S8 interface. + +## 11.8 PDN GW Initiated Resource Allocation Deactivation procedures + +### 11.8.1 General + +### 11.8.2 ePDG / Trusted Non-3GPP Access procedures + +In PMIPv6 mode, the ePDG or Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 LMA Initiated PDN Connection Deletion. + +### 11.8.3 Serving GW procedures + +In PMIPv6 mode, the Serving GW shall follow: + +- the MAG procedure for the PMIPv6 LMA Initiated PDN Connection Deletion on the S8 interface. +- the LMA procedure for the PMIPv6 LMA Initiated PDN Connection Deletion on the S2a/S2b interface. + +--- + +## 12 Information Elements + +### 12.1 Additional Proxy Mobile IPv6 Information Elements + +#### 12.1.1 3GPP-Specific PMIPv6 Information Elements + +##### 12.1.1.0 General + +This specification requires the encoding of additional 3GPP-specific Information Elements for PMIPv6 with the 3GPP Mobility Option, as defined by 3GPP TS 29.282 [24]. The 3GPP specific Information Elements defined by this specification are listed in the table 12.1.1.0-1. + +**Table 12.1.1.0-1: 3GPP Specific PMIPv6 Information Elements** + +| 3GPP Specific PMIPv6 Information Element | 3GPP Specific PMIPv6 Information Element Description | +|-------------------------------------------------|--------------------------------------------------------------------------------------------------| +| Protocol Configuration Options | 3GPP PCO data, in the format from 3GPP TS 24.008 [16] subclause 10.5.6.3, starting with octet 3. | +| 3GPP Specific PMIPv6 error code | 3GPP Vendor-Specific PMIPv6 error code, as specified in subclause 12.1.1.1 | +| PDN GW IP address | PDN GW IP address, as specified in subclause 12.1.1.4 | +| DHCPv4 Address Allocation Procedure Indication | DHCPv4 Address Allocation Procedure Indication, as specified in subclause 12.1.1.5. | +| Fully Qualified PDN Connection Set Identifier | FQ-CSID as specified in subclause 12.1.1.2 | +| PDN Type Indication | PDN type indication as specified in subclause 12.1.1.3 | +| Charging ID | Charging ID as specified in subclause 12.1.1.6 | +| Selection Mode | Selection Mode as specified in subclause 12.1.1.7 | +| Charging Characteristics | Subclause 12.1.1.8 | +| Serving Network | Subclause 12.1.1.9 | +| Mobile Equipment Identity | Subclause 12.1.1.10 | +| MSISDN | Subclause 12.1.1.11 | +| APN Restriction | Subclause 12.1.1.12 | +| Maximum APN Restriction | Subclause 12.1.1.13 | +| Unauthenticated IMSI | Subclause 12.1.1.14 | +| PDN Connection ID | Subclause 12.1.1.15 | +| PGW Back-Off Time | Subclause 12.1.1.16 | +| Signalling Priority Indication | Subclause 12.1.1.17 | +| Static IP Address Allocation Indication | Subclause 12.1.1.18 | +| Additional Protocol Configuration Options | Subclause 12.1.1.19 | +| MME/SGSN Identifier | Subclause 12.1.1.20 | +| End Marker Notification | Subclause 12.1.1.21 | +| Trusted WLAN Mode Indication | Subclause 12.1.1.22 | +| UE Time Zone | Subclause 12.1.1.23 | +| Access Network Identifier Timestamp | Subclause 12.1.1.24 | +| Logical Access ID | Subclause 12.1.1.25 | +| Origination Time Stamp | Subclause 12.1.1.26 | +| Maximum Wait Time | Subclause 12.1.1.27 | +| TWAN Capabilities | Subclause 12.1.1.28 | + +Depending on the need for 3GPP-specific information content, there several items of this information element may be added to the PBU, PBA, BRI, BRA, UPN or UPA. + +The subtype for a 3GPP specific PMIPv6 Information Element is defined in 3GPP TS 29.282 [24]. The data format of the 3GPP specific PMIPv6 Information Element is defined in this specification. If the data format is defined by another specification, that specification shall be referenced in the table above. + +### 12.1.1.1 3GPP Specific PMIPv6 error code + +Proxy Binding Acknowledgement (PBA) and Binding Revocation Acknowledgment (BRA) contain a mandatory Status information element and also may contain a 3GPP Specific PMIPv6 Error Code (3GSPEC) information element, which is coded within Mobility Options field. + +NOTE: IETF RFC 5213 [4] and IETF RFC 6275 [8] specify PMIPv6 Status values for a PBA message for indicating the acceptance of a message, or for reporting an error. Up-to-date values for the Status field are specified in the IANA registry of assigned numbers [32]. IETF RFC 5846 [6] specifies PMIPv6 Status values for the BRA message. Up-to-date BRA status values are specified in the IANA registry of assigned numbers [33]. + +Binding Revocation Indication (BRI) may contain a 3GPP Specific PMIPv6 Error Code (3GSPEC) information element, which is coded within Mobility Options field. + +The purpose of the 3GSPEC information element, which is depicted in Figure 12.1.1.1-1 is to carry a GTPv2 Cause value within PMIPv6 messages. 3GPP TS 29.274 [22] specifies GTPv2 Cause values. + +![](a175bdeacb50b8a60869f6c68c5d0a07_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|---------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 3GPP Specific PMIPv6 Error Code | | | | | | | | + +**Figure 12.1.1.1-1: 3GPP Specific PMIPv6 Error Code** + +If MAG/SGW receives a 3GSPEC IE in Proxy Binding Acknowledgement message from LMA/PGW, which requires that the MAG/SGW shall send a GTPv2 message to MME/SGSN, then the MAG/SGW shall copy 3GSPEC value into GTPv2 Cause IE. If in such case, the MAG/SGW does not receive 3GSPEC IE with PBA, depending on the overall meaning of the PMIPv6 Status IE the MAG/SGW shall send to MME/SGSN one of the following GTPv2 Cause values with CS bit set to 1: + +- "Request Accepted" (decimal 16), if the received PMIPv6 Status indicates PBU acceptance. +- "Request rejected for a PMIP reason" (decimal 112), if the received PMIPv6 Status indicates PBU rejection. + +If MAG/SGW receives a 3GSPEC IE in Binding Revocation Indication message from LMA/PGW, which requires that the MAG/SGW shall send a GTPv2 message to MME/SGSN, then the MAG/SGW shall copy 3GSPEC value into GTPv2 Cause IE with CS bit set to 1. + +If MAG/SGW receives a Cause IE with a GTPv2 message, which requires sending a Binding Revocation Acknowledgement message to LMA/PGW, the MAG/SGW shall copy the GTPv2 Cause value into the 3GSPEC IE. + +### 12.1.1.2 Fully Qualified PDN Connection Set Identifier (FQ-CSID) + +A fully qualified PDN Connection Set Identifier (FQ-CSID) identifies a set of PDN connections belonging to an arbitrary number of UEs on a node such as a MME, SGW or PGW. The FQ-CSID is generated by the MAG, the LMA and any other node such as the MME for 3GPP access. It is generated for each new PDN connection, and it is used in case of partial node failure to identify the PDN connections associated with a Connection Set Identifier. + +The FQ-CSID is coded as follows: + +![](dbd4bab54b57e8d1abf80e3de6471130_img.jpg) + +| Octets | Bits | | | | | | | | +|----------------|------------------------------------------------------|---|---|--------------------|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Node-ID Type | | | Number of CSIDs= m | | | | | +| 2 to p | Node-ID | | | | | | | | +| (p+1) to (p+2) | First PDN Connection Set Identifier (CSID) | | | | | | | | +| (p+3) to (p+4) | Second PDN Connection Set Identifier (CSID) | | | | | | | | +| ... | ... | | | | | | | | +| (m-1) to m | m th PDN Connection Set Identifier (CSID) | | | | | | | | + +Figure 12.1.1.2-1: FQ-CSID + +The details of each field and value are specified in 3GPP TS 29.274[22]. + +### 12.1.1.3 PDN Type Indication + +The purpose of the PDN type indication option is to indicate the GW decision to change the PDN type and a cause for the change. This attribute is set by the LMA in the PBA. + +The MAG shall set the PDN type accordingly, if this option is present in the PBA. + +![](4430c1d8e78ac97fda782321410349a9_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | PDN type | | | | | | | | +| 2 | Cause | | | | | | | | + +Figure 12.1.1.3-1: PMIPv6 PDN type indication + +The following defines the value of the PMIPv6 PDN type indication. + +| | +|----------------------------------------------| +| PDN type value | +| #1: IPv4 | +| #2: IPv6 | +| Cause value as defined in 3GPP TS 29.274[13] | +| #18: New PDN type due to network preference; | + +### 12.1.1.4 PDN GW IP address + +The purpose of the PDN GW IP address information element is to carry the IP address of the PDN GW to which the receiving Serving GW shall send a PBU on the chained S8 interface. This information element shall be included in a PBU for initial attach or handover sent on S2a or S2b interface for S2a/S2b - PMIP based S8 chaining scenario. + +This information element shall be included in an Update Notification message according to the conditions specified in subclause 20.2.7.1 of 3GPP TS 23.007 [13]. + +The content and encoding of the PDN GW IP address is depicted on Figure 12.1.1.4-1. + +![](65a58df2e3689847351c19e7a9435e0a_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-4/16 | IPv4 or IPv6 Address | | | | | | | | + +Figure 12.1.1.4-1: PDN GW IP Address + +#### 12.1.1.5 DHCPv4 Address Allocation Procedure Indication + +The purpose of the DHCPv4 Address Allocation option is to indicate that DHCPv4 is to be used in allocating the IPv4 address to the UE if the option is present in the PBA message. + +#### 12.1.1.6 Charging ID + +The Charging ID is defined in figure 12.1.1.6-1. + +![](afd9ce64c136f2090b978ea5f3ef9d8d_img.jpg) + +| | | | | | | | | | +|---------------|-------------------|---|---|---|---|---|---|---| +| | Bits | | | | | | | | +| Octets | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-4 | Charging ID value | | | | | | | | + +**Figure 12.1.1.6-1: Charging ID** + +### 12.1.1.7 Selection Mode + +Selection Mode indicates the way the MME or SGSN selected the APN: whether a subscribed APN was selected, or whether a non-subscribed APN sent by a UE or a non-subscribed APN chosen by the SGSN was selected. The Selection Mode is defined in 3GPP TS 23.060 [23] + +The encoding of the Selection Mode is shown in Figure 12.1.1.7-1. + +![](f40480872b021d2ac7c29202c199b695_img.jpg) + +| | | | | | | | | | +|---------------|-------------|---|---|---|---|---|----------------|---| +| | Bits | | | | | | | | +| Octets | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Reserved | | | | | | Selection Mode | | + +**Figure 12.1.1.7-1: Selection mode** + +The reserved bits shall be set to 1 by the MAG and not processed by the LMA. + +The defined Selection Mode values are shown in Table 12.1.1.7-1. + +**Table 12.1.1.7-1: Selection Mode** + +| Value | Selection mode value | +|-------|----------------------------------------------------------------------------------------| +| 0 | MS or network provided APN, subscribed verified | +| 1 | MS provided APN, subscription not verified | +| 2 | Network provided APN, subscription not verified | +| 3 | For future use. Shall not be sent. If received, shall be interpreted as the value '2'. | + +#### 12.1.1.8 Charging Characteristics + +The Charging Characteristics information element is defined in 3GPP TS 32.251 [25] and is a way of informing both the SGW and PGW of the rules for producing charging information based on operator configured triggers. For the encoding of this information element see 3GPP TS 32.298 [26]. + +The Charging Characteristics is defined in figure 12.1.1.8-1. + +![](c07e21a8d65991db04263322f859c94f_img.jpg) + +| Octets
1-2 | Bits | | | | | | | | +|---------------|--------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| | Charging Characteristics value | | | | | | | | + +Figure 12.1.1.8-1: Charging Characteristics + +### 12.1.1.9 Serving Network + +Serving Network identifies the serving network the UE is attached to. The format of the Serving Network 3GPP-specific Information Element is defined below. + +![](b71ad9fc874230de9ba4480e12a216f7_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|------|-------------|---|---|---|-------------|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | | MCC digit 2 | | | | MCC digit 1 | | | +| 2 | | MNC digit 3 | | | | MNC digit 2 | | | +| 3 | | MNC digit 2 | | | | MNC digit 1 | | | + +Figure 12.1.1.9-1 + +### 12.1.1.10 Mobile Equipment Identity + +The purpose of the Mobile Equipment Identity (MEI) information element is used to convey the UE's terminal identity from the Serving GW, TWAN or ePDG to the PDN GW over the S5/S8, S2a or S2b interface. + +The encoding of the MEI is depicted in Figure 12.1.1.10-1. + +![](e8c2fa58b461352bbb1b098928737da2_img.jpg) + +| Octets
1 to 8 | Bits | | | | | | | | +|------------------|---------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| | Mobile Equipment Identity | | | | | | | | + +Figure 12.1.1.10-1: Mobile Equipment Identity (MEI) + +The MEI contains either the IMEI or IMEISV in the format defined in subclause 6.2 of 3GPP TS 23.003 [12]. + +The MEI shall contain the IMEISV if it is available. If only the IMEI is available, then the last semi-octet of octet 8 of MEI shall be set to "1111". Both IMEI and IMEISV are TBCD encoded, where IMEI is 15 BCD digits and IMEISV is 16 BCD digits. Bits 5 to 8 of octet n encodes digit 2n, bits 1 to 4 of octet n encodes digit 2n-1. Digits are packed contiguously with no internal padding. + +NOTE: This encoding follows that of the IMEI(SV) field in the International Mobile Equipment Identity (and Software Version) (IMEI(SV)) information element defined in clause 7.7.53 of 3GPP TS 29.060 [28]. + +### 12.1.1.11 MSISDN + +The purpose of the MSISDN information element is used to convey the user's MSISDN from the Serving GW to the PDN GW over the S5/S8 interface, from the trusted non-3GPP access network to the PDN-GW over S2a and from ePDG to the PDN-GW over S2b. MSISDN is defined in 3GPP TS 23.003 [12]. + +The content and encoding of the MSISDN is depicted on Figure 12.1.1.11-1. + +![](9c45844d796e85ae05505870a54e4eb4_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------|---|---|---|------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Number digit 2 | | | | Number digit 1 | | | | +| | | | | | | | | | +| n | Number digit m | | | | Number digit m-1 | | | | + +Figure 12.1.1.11-1: MSISDN + +Octets 1 to n represent the MSISDN value in international number format as described in ITU-T Rec E.164 [29], encoded as TBCD digits, i.e. digits from 0 through 9 are encoded "0000" to "1001". When there is an odd number of digits, bits 8 to 5 of the last octet are encoded with the filler "1111". + +#### 12.1.1.12 APN Restriction + +The APN Restriction is defined in figure 12.1.1.12-1. The APN Restriction value is specified in 3GPP TS 29.274 [22]. + +![](0d9b44054c70dcda35129f11b97a912f_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | APN Restriction value | | | | | | | | + +Figure 12.1.1.12-1: APN Restriction + +#### 12.1.1.13 Maximum APN Restriction + +The Maximum APN Restriction is defined in figure 12.1.1.13-1. The Maximum APN Restriction value is specified in 3GPP TS 29.274 [22]. + +![](34f46103a0c07981b0b51490ea639e25_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Maximum APN Restriction value | | | | | | | | + +Figure 12.1.1.13-1: Maximum APN Restriction + +#### 12.1.1.14 Unauthenticated IMSI + +The purpose of the Unauthenticated IMSI information element is used to convey the user's IMSI for the emergency attached UE with an IMSI which is not authenticated by the network. The format of IMSI is defined in 3GPP TS 23.003 [12]. + +The content and encoding of the Unauthenticated IMSI is depicted on Figure 12.1.1.14-1. + +![](b60f017acac2f85adcfd13cde1a4192c_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------|---|---|---|------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Number digit 2 | | | | Number digit 1 | | | | +| | | | | | | | | | +| n | Number digit m | | | | Number digit m-1 | | | | + +Figure 12.1.1.14-1: Unauthenticated IMSI + +Octets 1 to n represent the IMSI value in international number format as described in ITU-T Rec E.164 [29], encoded as TBCD digits, i.e. digits from 0 through 9 are encoded "0000" to "1001". When there is an odd number of digits, bits 8 to 5 of the last octet are encoded with the filler "1111". The maximum number of digits is 15. + +#### 12.1.1.15 PDN Connection ID + +The purpose of the PDN Connection ID information element is used to convey the PDN Connection ID. + +The content and encoding of the PDN Connection ID is depicted on Figure 12.1.1.15-1. + +![](4dd5f00d74e7db5bbb2d011609bcc43d_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|---------------------------|---|---|---|-------------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Spare (all bits set to 0) | | | | PDN Connection ID | | | | + +Figure 12.1.1.15-1: PDN Connection ID + +NOTE: The format of the PDN connection ID is aligned with EPS bearer ID defined for GTPv2 in 3GPP TS 29.274 [22]. + +### 12.1.1.16 PGW Back-Off Time + +The PGW Back-Off Time information element is coded as shown in figure 12.1.1.16-1. The timer unit and timer value are specified in 3GPP TS 29.274 [22]. + +![](f92e919c70b7adda2d0e778889f44fae_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|------------|---|---|---|-------------|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Timer unit | | | | Timer value | | | | + +Figure 12.1.1.16-1: PGW Back-Off Time + +### 12.1.1.17 Signalling Priority Indication + +The Signalling Priority Indication information element contains signalling priority indications received from the UE for a specific PDN connection. + +The Signalling Priority Indication information element is coded as shown in figure 12.1.1.17-1. + +![](d5661c3661190c44429a1a75f61d7550_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------|---|---|---|---|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Spare | | | | | | | LAPI | + +Figure 12.1.1.17-1: Signalling Priority Indication + +The following bits within Octet 1 shall indicate: + +- Bit 8 to 2 – Spare, for future use and set to zero. +- Bit 1 – LAPI (Low Access Priority Indication): This bit defines if the UE indicated low access priority when establishing the PDN connection. It shall be encoded as the Low Priority parameter of the Device Properties IE in 3GPP TS 24.008 [16]. The receiver shall assume the value "0" if the Signalling Priority Indication IE is applicable for a message but not included in that message by the sender. The low access priority indication may be included in charging records. + +### 12.1.1.18 Static IP Address Allocation Indication + +The Static IP Address Allocation Indication information element contains Static IP Address Allocation Indication for the Handover procedures. These indications are equivalent for the Static IPv4/IPv6 Address Flag defined in 3GPP TS 29.274 [22]. + +The Static IP Address Allocation Indication information element is coded as shown in figure 12.1.1.18-1. + +![](5cf80bac69830ea773ac17c87e0ae24d_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------|---|---|---|---|---|------|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Spare | | | | | | S6PI | S4AI | + +Figure 12.1.1.18-1: Static IP Address Allocation Indication + +The following bits within Octet 1 shall indicate: + +- Bit 8 to 3 – Spare, for future use and set to zero. +- Bit 2 – S6PI (Static IPv6 Home Network Prefix Indication): if this bit is set to 1, it indicates that IPv6 Home Network Prefix is statically allocated. +- Bit 1 – S4AI (Static IPv4 Address Indication): if this bit is set to 1, it indicates that IPv4 address is statically allocated. + +### 12.1.1.19 Additional Protocol Configuration Options + +The Additional Protocol Configuration Options IE contains additional 3GPP protocol configuration options information. The IE is in the same format as the PCO IE specified in 3GPP TS 24.008 [16] subclause 10.5.6.3, starting with octet 3. + +### 12.1.1.20 MME/SGSN Identifier + +The purpose of the MME/SGSN Identifier information element is to carry the IP address of the MME/SGSN. The content and encoding of the MME/SGSN Identifier is depicted on Figure 12.1.1.20-1. + +![](8fe194ec0e70ac418890f8f1ad02a102_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-4/16 | IPv4 or IPv6 Address | | | | | | | | + +Figure 12.1.1.20-1: MME/SGSN Identifier + +### 12.1.1.21 End Marker Notification + +The purpose of the End Marker Notification information element is used to convey the End Marker Notification. + +The content and encoding of the End Marker Notification is depicted on Figure 12.1.1.21-1. + +![](5ba26df60eea8e9b4688559e47cd9c0f_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------|---|---|---|---|---|---|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Spare | | | | | | | EMN | + +Figure 12.1.1.21-1: End Marker Notification + +The following bits within Octet 1 shall indicate: + +- Bit 8 to 2 – Spare, for future use and set to zero. +- Bit 1 – EMN (End Marker Notification): This bit shall be set to the value "1". + +### 12.1.1.22 Trusted WLAN Mode Indication + +The purpose of the Trusted WLAN Mode Indication information element is to convey the selected trusted WLAN Mode. + +The content and encoding of the Trusted WLAN Mode Indication is depicted on Figure 12.1.1.22-1. + +![](750b1652a4f4791b84c02aa755a1dedd_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------|---|---|---|---|---|-----|-----| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Spare | | | | | | MCM | SCM | + +Figure 12.1.1.22-1: Trusted WLAN Mode Indication + +The following bits within Octet 1 shall indicate: + +- Bit 8 to 3 – Spare, for future use and set to zero. +- Bit 2 –MCM (Multiple-connection mode Indication): if this bit is set to 1, it indicates that the Multiple-connection mode is used. +- Bit 1 –SCM (Single-connection mode Indication): if this bit is set to 1, it indicates that the Single-connection mode is used. + +### 12.1.1.23 UE Time Zone + +UE Time Zone is used to indicate the offset between universal time and local time in steps of 15 minutes of where the UE currently resides. The "Time Zone" field uses the same format as the "Time Zone" IE in 3GPP TS 24.008 [5]. + +The content and encoding of the UE Time Zone is depicted on Figure 12.1.1.23-1. + +![](fbdd4682fb49c08ff8415c854336a6ab_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-----------|---|---|---|---|---|----------------------|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Time Zone | | | | | | | | +| 2 | Spare | | | | | | Daylight Saving Time | | + +Figure 12.1.1.23-1: UE Time Zone + +The value of the Time Zone field in octet 1 represents the time zone adjusted for daylight saving time. + +The following bits within Octet 2 shall indicate: + +- Bit 8 to 3 – Spare, for future use and set to zero. +- Bit 2 to 1 – The value of the Daylight Saving Time field specifies the adjustment that has been made. Possible values for the Daylight Saving Time field are given below in Table 12.1.1.23-2 + +Table 12.1.1.23-1 Possible values for the "Daylight Saving Time" field and their meanings. + +| Daylight Saving Time | Value (binary) | | +|----------------------------------------------|----------------|-------| +| | Bit 2 | Bit 1 | +| No adjustment for Daylight Saving Time | 0 | 0 | +| +1 hour adjustment for Daylight Saving Time | 0 | 1 | +| +2 hours adjustment for Daylight Saving Time | 1 | 0 | +| Spare | 1 | 1 | + +### 12.1.1.24 Access Network Identifier Timestamp + +The Access Network Identifier Timestamp indicates the UTC time when the Access Network Identifier information was acquired. The content and encoding of the Access Network Identifier Timestamp is depicted on Figure 12.1.1.24-1. Octets 1 to 4 are encoded in the same format as the first four octets of the 64-bit timestamp format as defined in section 6 of IETF RFC 5905 [40]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900 + +![](f61d0925551545b5938b3a4d1bbf63c3_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-4 | Access Network Identifier Timestamp | | | | | | | | + +Figure 12.1.1.24-1: Access Network Identifier Timestamp + +### 12.1.1.25 Logical Access ID + +The purpose of the Logical Access ID information element is to convey the Logical Access ID. The Logical Access ID is implemented by providing both the Relay Identity which is either an IP Address or and FQDN along with the allocated Circuit-ID. + +The Logical Access ID is depicted on Figure 12.1.1.25-1. + +![](223c6f5bda05ffdd254a828a148b53f1_img.jpg) + +| Octets | Bits | | | | | | | | +|----------------|-----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Relay Identity Type | | | | | | | | +| 2 | Relay Identity Length | | | | | | | | +| 3 to k | Relay Identity | | | | | | | | +| (k+1) to (k+2) | Circuit-ID Length | | | | | | | | +| (k+3) to q | Circuit-ID | | | | | | | | + +Figure 12.1.1.25-1: Logical Access ID + +The Relay Identity Type is encoded in octet 1. It indicates the type of identity as described in Table 12.1.1.25-1. The Relay Identity Length is encoded in the octet 2. It indicates the length of the relay identity. The octets 3 to K contains the Relay Identity. If the Relay Identity type is set to 1 (i.e. an FQDN), it is encoded as described in section 3.1 of IETF RFC 1035 [31] but excluding the trailing zero byte. The Circuit-ID length in the octet (k+1) to (k+2) indicates the length of the Circuit-ID. The Circuit-ID is as defined in IETF RFC 3046 [42], it is encoded in octets (k+3) to q as an Octetstring and provided by the Relay. + +Table 12.1.1.25-1: Relay Identity Type + +| Relay Identity Type | Values (Decimal) | +|----------------------|------------------| +| IPv4 or IPv6 Address | 0 | +| FQDN | 1 | + +### 12.1.1.26 Origination Time Stamp + +The Origination Time Stamp information element is coded as shown in figure 12.1.1.26-1. The Origination Time Stamp value shall be encoded as specified in 3GPP TS 29.274 [22]. + +![](a5af75db42b20d999e69c4930b56e26e_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-6 | Origination Time Stamp value | | | | | | | | + +Figure 12.1.1.26-1: Origination Time Stamp + +### 12.1.1.27 Maximum Wait Time + +The Maximum Wait Time information element is coded as shown in figure 12.1.1.27-1. The Maximum Wait Time value shall be encoded as specified in 3GPP TS 29.274 [22]. + +| Octets | Bits | | | | | | | | +|--------|-------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1-2 | Maximum Wait Time value | | | | | | | | + +Figure 12.1.1.27-1: Maximum Wait Time + +### 12.1.1.28 TWAN Capabilities + +The purpose of the TWAN Capabilities information element is to convey the capabilities supported by the TWAN to the PGW. + +The content and encoding of the TWAN Capabilities is depicted on Figure 12.1.1.28-1. + +![](572cf014db14c8234f91c07d5a5a28c6_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-------|---|---|---|---|---|---|-----------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Spare | | | | | | | WPM
SI | + +Figure 12.1.1.28-1: TWAN Capabilities + +The following bits within Octet 1 shall indicate: + +- Bit 8 to 2 – Spare, for future use and set to zero. +- Bit 1 – WLCP PDN Connection Modification Support Indication (WPMSI): if this bit is set to 1, it indicates that the TWAN supports the WLCP PDN Connection Modification procedure. This indication is used by the P-CSCF restoration extension procedure for TWAN access (see 3GPP TS 23.380 [36]). + +## 13 Trusted WLAN Access over S2a Description + +### 13.1 Initial Attach procedures + +#### 13.1.1 General + +#### 13.1.2 TWAN procedures + +In PMIPv6 mode, the TWAN shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2. + +If the transparent single-connection mode is used as specified in 3GPP TS 23.402 [3], the TWAN may include Additional Protocol Configuration Options IE in PBU to retrieve additional IP configuration parameters from the PGW (e.g. DNS server). + +The TWAN shall include the Trusted WLAN Mode Indication for single-connection mode or multi-connection mode. It shall not do so for transparent single-connection mode. The PGW shall assume that transparent single-connection mode is used if it receives the PBU from the TWAN without this IE. + +If the single-connection mode or multi-connection mode is used as specified in 3GPP TS 23.402 [3], the TWAN shall include Protocol Configuration Options IE in PBU if the TWAN receives the PCO from the UE. + +The TWAN shall include the Access Network Identifier Option IE in the PBU message and set its contents as follows: + +- the Access Network Identifier Option IE shall contain the SSID and, unless otherwise determined by the TWAN operator's policies, at least one of the following Information Elements: + - the Logical Access ID in the Logical Access ID IE; + +- the BSSID in the Access Network Identifier Option IE and/or +- the civic address of the access point to which the UE is attached in the Access Network Identifier Option IE. +- It may also contain the identifier of the TWAN operator, i.e. either the TWAN PLMN-ID if the TWAN is operated by a mobile operator, or the TWAN Operator Name otherwise; +- the SSID and the BSSID (when present) shall be encoded in the Network-Identifier sub-option as specified in IETF RFC 6757 [37], respectively in the "Network Name" field and the "Access-Point Name" field; +- the TWAN PLMN-ID (when present) shall be encoded in the Operator-Identifier sub-option with the "Operator-Identifier (Op-ID) Type" field set to "2" indicating realm of the operator. The TWAN PLMN-ID shall indicate the PLMN-ID of the TWAN operator and shall be encoded as specified in subclause 19.2 of 3GPP TS 23.003 [12]; +- the TWAN Operator Name (when present) shall be encoded in the Operator-Identifier sub-option with the "Operator-Identifier (Op-ID) Type" field set to "2" indicating realm of the operator. The TWAN Operator Name shall indicate the realm name of the TWAN operator and shall be encoded as specified in subclause 19.8 of 3GPP TS 23.003 [12]. +- the Civic Address shall be encoded in the Civic Location Sub-Option with the "Format" field set to "0" indicating that the value denotes binary encoding. The Civic Address is specified in IETF RFC 7563 [41]. + +NOTE: The Access Network Identifier Option IE defined in this specification contains similar information as the TWAN Identifier IE defined for GTPv2 in 3GPP TS 29.274 [22] apart from the Logical Access ID which is defined in a separate 3GPP specific IE called Logical Access ID. The Access Network Identifier Option information does not relate to the Access Network Identity (ANID) defined in 3GPP TS 24.302 [39]. + +The TWAN shall include the Serving Network IE in PBU and set it to the PLMN identity of the selected PLMN used for 3GPP-based access authentication. The selected PLMN is the PLMN of the 3GPP AAA Proxy in roaming case and the PLMN of the 3GPP AAA Server in non-roaming case. + +The TWAN shall include the UE Time Zone IE and shall set its content as specified in subclause 12.1.1.23. + +### 13.1.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3. + +The PDN GW may include Additional Protocol Configuration Options IE in PBA message to provide the TWAN with additional IP configuration parameters (e.g. DNS server), if a corresponding request was received in the PBU message. + +The PDN GW may include Protocol Configuration Options IE in the PBA message, if the Trusted WLAN Mode Indication indicating single-connection mode or multi-connection mode was received in the PBU message. + +If the PGW supports Access Network Identifier Option and the TWAN had included the Access Network Identifier Option IE in the PBU message, the PGW shall include the Access Network Identifier Option IE with the sub-option(s) that it accepted as outlined in subclause 4.2 of IETF RFC 6757 [37]. The PGW shall not alter the contents of the sub-option(s) received from the TWAN. + +## 13.2 TWAN Initiated PDN Connection Lifetime Extension procedures + +### 13.2.1 General + +### 13.2.2 TWAN procedures + +In PMIPv6 mode, the TWAN shall follow the MAG procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.2. + +### 13.2.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Lifetime Extension as outlined in subclause 5.2.3. + +## 13.3 UE / TWAN Initiated Detach and UE/TWAN Requested PDN Disconnection procedures + +### 13.3.1 General + +### 13.3.2 TWAN procedures + +In PMIPv6 mode, the TWAN shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2 for Detach/PDN Disconnection procedure. + +The TWAN shall include the Access Network Identifier Option IE and the Access Network Identifier Timestamp IE and shall set its content as specified in subclause 13.1.2 and 12.1.1.24 respectively. + +The TWAN shall include the UE Time Zone IE and shall set its content as specified in subclause 12.1.1.23. + +### 13.3.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +If the PGW supports Access Network Identifier Option and the TWAN had included the Access Network Identifier Option IE in the PBU message, the PGW shall include the Access Network Identifier Option IE with the sub-option(s) that it accepted as outlined in subclause 4.2 of IETF RFC 6757 [37]. The PGW shall not alter the contents of the sub-option(s) received from the TWAN. + +## 13.4 HSS / AAA Initiated Detach procedures + +### 13.4.1 General + +The HSS/AAA may initiate a detach procedure resulting in a PMIPv6 De-Registration. + +### 13.4.2 TWAN procedures + +In PMIPv6 mode, the TWAN shall follow the MAG procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.2. + +The TWAN shall include the Access Network Identifier Option IE and the Access Network Identifier Timestamp IE and shall set its content as specified in subclause 13.1.2 and 12.1.1.24 respectively. + +The TWAN shall include the UE Time Zone IE and shall set its content as specified in subclause 12.1.1.23. + +### 13.4.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 MAG Initiated PDN Connection Deletion as outlined in subclause 5.4.3. + +If the PGW supports Access Network Identifier Option and the TWAN had included the Access Network Identifier Option IE in the PBU message, the PGW shall include the Access Network Identifier Option IE with the sub-option(s) that it accepted as outlined in subclause 4.2 of IETF RFC 6757 [37]. The PGW shall not alter the contents of the sub-option(s) received from the TWAN. + +## 13.5 PDN GW Initiated Resource Allocation Deactivation procedures + +### 13.5.1 General + +### 13.5.2 TWAN procedures + +In PMIPv6 mode, the Trusted Non-3GPP Access shall follow the MAG procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.2. + +The TWAN shall include the Access Network Identifier Option IE and the Access Network Identifier Timestamp IE and shall set its content as specified in subclause 13.1.2 and 12.1.1.24 respectively. + +The TWAN shall include the UE Time Zone IE and shall set its content as specified in subclause 12.1.1.23. + +### 13.5.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 LMA Initiated PDN Connection Deletion as outlined in subclause 5.5.3. + +The PGW shall include the 3GPP Specific PMIPv6 error code IE and set it to the cause "Reactivation requested" when the PGW initiates the PDN GW Initiated Resource Allocation Deactivation procedure as part of the P-CSCF restoration procedure over WLAN access, as specified in 3GPP TS 23.380 [36]. + +## 13.6 3GPP Access to TWAN with PMIPv6 on S2a Handover procedures without optimization + +### 13.6.1 General + +This procedure shall apply for a TWAN access using single-connection mode or multi-connection mode. + +### 13.6.2 TWAN procedures + +In PMIPv6 mode, the TWAN shall follow the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +The TWAN shall include in the PBU message: + +- the Protocol Configuration Options IE if the TWAN received the PCO from the UE. +- the Access Network Identifier Option IE and set its content as specified in subclause 13.1.2. +- the Serving Network IE and set it to the PLMN identity of the selected PLMN used for 3GPP-based access authentication. The selected PLMN is the PLMN of the 3GPP AAA Proxy in roaming case and the PLMN of the 3GPP AAA Server in non-roaming case. +- the Trusted WLAN Mode Indication for single-connection mode or multi-connection mode. + +The TWAN shall include the UE Time Zone IE and shall set its content as specified in subclause 12.1.1.23. + +The TWAN shall include the TWAN Capabilities IE in the PBU message and set the WLCP PDN Connection Modification Support Indication flag to 1 if the TWAN supports this procedure. + +### 13.6.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +If the PGW supports Access Network Identifier Option and the TWAN had included the Access Network Identifier Option IE in the PBU message, the PGW shall include the Access Network Identifier Option IE with the sub-option(s) that it accepted as outlined in subclause 4.2 of IETF RFC 6757 [37]. The PGW shall not alter the contents of the sub-option(s) received from the TWAN. + +The PDN GW may include Protocol Configuration Options IE in the PBA message. + +## 13.7 UE Initiated Connectivity to Additional PDN procedures + +### 13.7.1 General + +This procedure only applies for a TWAN access using the multiconnection mode. + +### 13.7.2 TWAN procedures + +In PMIPv6 mode, the TWAN shall follow the MAG procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.2, or the MAG procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.2. + +The TWAN shall include in the PBU message: + +- the Protocol Configuration Options IE if the TWAN received the PCO from the UE; +- the Access Network Identifier Option IE and the UE timezone IE and set their contents as specified in subclause 13.1.2; +- the Serving Network IE and set it to the PLMN identity of the selected PLMN used for 3GPP-based access authentication. The selected PLMN is the PLMN of the 3GPP AAA Proxy in roaming case and the PLMN of the 3GPP AAA Server in non-roaming case; +- the Trusted WLAN Mode Indication for multi-connection mode; +- the TWAN Capabilities IE and set the WLCP PDN Connection Modification Support Indication flag to 1 if the TWAN supports this procedure. + +### 13.7.3 PDN GW procedures + +In PMIPv6 mode, the PDN GW shall follow the LMA procedure for the PMIPv6 PDN Connection Creation as outlined in subclause 5.1.3, or the LMA procedure for the PMIPv6 PDN Connection Handover as outlined in subclause 5.3.3. + +If the PGW supports Access Network Identifier Option and the TWAN had included the Access Network Identifier Option IE in the PBU message, the PGW shall include the Access Network Identifier Option IE with the sub-option(s) that it accepted as outlined in subclause 4.2 of IETF RFC 6757 [37]. The PGW shall not alter the contents of the sub-option(s) received from the TWAN. + +The PDN GW may include the Protocol Configuration Options IE in the PBA message. + +--- + +## 14 Proxy Mobile IPv6 EPC Restoration Procedure + +### 14.1 PGW triggered SGW restoration procedure + +#### 14.1.1 General + +The PGW triggered SGW restoration procedure is specified in 3GPP TS 23.007 [13]. The Proxy Mobile IPv6 LMA Initiated Update Notification procedure specified in subclause 5.11 is used to initiate the PGW triggered SGW restoration procedure. + +## 14.1.2 Serving GW procedures + +The Serving GW shall follow the PGW triggered SGW restoration procedure as specified in subclause 27.2.3.3 of 3GPP TS 23.007 [13]. When receiving the Update Notification message with notification reason "PGW Downlink Trigger Notification", the Serving GW shall response with an Update Notification Acknowledgement message specified as the MAG procedure in subclause 5.11. + +## 14.1.3 PDN GW procedures + +The PDN GW shall follow the PGW triggered SGW restoration procedure as specified in subclause 27.2.3.4 and 20.2.7.1 of 3GPP TS 23.007 [13]. When sending the Update Notification message, the PDN GW shall follow the LMA procedure specified in subclause 5.11 as follows: + +1. The notification reason shall be set to "PGW Downlink Trigger Notification". + +**Editor's Note:** The Notification reason "PGW Downlink Trigger Notification " needs to be registered in IANA. + +2. If the MME/S4-SGSN identifier was received in the last Create Session Request or Modify Bearer Request message as specified in 3GPP TS 23.007 [13], the MME/SGSN Identifier mobility option shall contain the stored MME/S4-SGSN identifier. +3. If the restoration procedure is caused by S5 path failure as specified in subclause 20.2.7.1 of 3GPP TS 23.007 [13], the Update Notification Message shall contain the PDN GW IP Address and GRE key option which shall contain the PGW IP address and uplink GRE key for control plane for the PDN connection. + +## 14.2 Update PDP context/Bearer at P-CSCF failure + +### 14.2.1 General + +The update PDP context/Bearer at P-CSCF failure procedure is specified in subclause 5.1 of 3GPP TS 23.380 [36]. The Proxy Mobile IPv6 LMA Initiated Update Notification procedure specified in subclause 5.11 is used to inform the SGW at P-CSCF failure. + +This procedure is also used from the PGW to the TWAN or ePDG to provide the UE with a list of available P-CSCF addresses as part of the P-CSCF restoration extension procedure for TWAN access and untrusted WLAN access (3GPP TS 23.380 [36]). + +### 14.2.2 PDN GW procedures + +The PDN GW shall follow the update PDP context/Bearer at P-CSCF failure procedure as specified in subclause 5.1 of 3GPP TS 23.380 [36], or the P-CSCF restoration extension procedure for TWAN access and untrusted WLAN access as specified in 3GPP TS 23.380 [36]. When sending the Update Notification message, the PDN GW shall follow the LMA procedure specified in subclause 5.11 as follows: + +1. The notification reason shall be set to "PGW-TRIGGERED-PCSCF-RESTORATION-PCO". +2. The Service Selection Mobility Option shall be set to the corresponding APN to which the UE PDN connection is attached +3. The PDN connection ID Mobility Option shall contain the PDN connection ID stored in the BCE if multiple PDN connection to a given APN is supported. +4. The PCO Mobility Option (for S5/S8 and S2a) or the APCO Mobility Option (for S2b) shall contain a list of available P-CSCF addresses. + +### 14.2.3 Serving GW, TWAN and ePDG procedures + +The Serving GW shall follow the update PDP context/Bearer at P-CSCF failure procedure as specified in subclause 5.1 of 3GPP TS 23.380 [36]. When receiving the Update Notification message with notification reason "PGW triggered P- + +CSCF restoration using PCO", the Serving GW shall respond with an Update Notification Acknowledgement message specified as the MAG procedure in subclause 5.11. + +The TWAN and ePDG shall follow the P-CSCF restoration extension procedure for TWAN access and untrusted WLAN access as specified in 3GPP TS 23.380 [36]. When receiving the Update Notification message with notification reason "PGW triggered P-CSCF restoration using PCO", the TWAN or ePDG shall respond with an Update Notification Acknowledgement message specified as the MAG procedure in subclause 5.11. + +## 14.3 Inform UE about P-CSCF failure + +### 14.3.1 General + +The Inform UE about P-CSCF failure procedure is specified in subclause 5.2 of 3GPP TS 23.380 [36]. The Proxy Mobile IPv6 LMA Initiated Update Notification procedure specified in subclause 5.11 is used to inform the SGW at P-CSCF failure. + +### 14.3.2 PDN GW procedures + +The PDN GW shall follow the inform UE about P-CSCF failure procedure as specified in subclause 5.2 of 3GPP TS 23.380 [36]. When sending the Update Notification message, the PDN GW shall follow the LMA procedure specified in subclause 5.11 as follows: + +1. The notification reason shall be set to "PGW-TRIGGERED-PCSCF-RESTORATION-DHCP". +2. The Service Selection Mobility Option shall be set to the corresponding APN to which the UE PDN connection is attached +3. The PDN connection ID Mobility Option shall contain the PDN connection ID stored in the BCE if multiple PDN connection to a given APN is supported. +4. The PCO Mobility Option shall contain an indicator that there is P-CSCF failure. + +### 14.3.3 Serving GW procedures + +The Serving GW shall follow the inform UE about P-CSCF failure procedure as specified in subclause 5.2 of 3GPP TS 23.380 [36]. When receiving the Update Notification message with notification reason "PGW triggered P-CSCF restoration using DHCP", the Serving GW shall response with an Update Notification Acknowledgement message specified as the MAG procedure in subclause 5.11. + +--- + +## 15 Proxy Mobile IPv6 End Marker Notification Procedure + +### 15.1 General + +Proxy Mobile IPv6 End Marker notification procedure is specified in subclause 5.7.1 and 5.7.2 of 3GPP TS 23.402 [3]. The Proxy Mobile IPv6 LMA Initiated Update Notification procedure specified in subclause 5.11 is used to initiate the Proxy Mobile IPv6 End Marker Notification Procedure. + +### 15.2 Serving GW procedures + +The Serving GW shall follow the Proxy Mobile IPv6 End Marker notification procedure as specified in subclause 5.7.1 and 5.7.2 of 3GPP TS 23.402 [3]. When receiving the Update Notification message with notification reason "VENDOR-SPECIFIC-REASON" and End Marker Notification mobility option and the serving GW has downlink user plane established, the Serving GW shall generate End Marker as specified in subclause 5.7.1 and 5.7.2 of 3GPP TS 23.402 [3]. When receiving the Update Notification message, the Serving GW shall follow the MAG procedure specified in subclause 5.11. + +## 15.3 PDN GW procedures + +The PDN GW shall follow Proxy Mobile IPv6 End Marker notification procedure as specified in subclause 5.7.1 and 5.7.2 of 3GPP TS 23.402 [3]. When sending the Update Notification message, the PDN GW shall follow the LMA procedure specified in subclause 5.11 as follows: + +1. The PDN GW shall set the notification reason to "VENDOR-SPECIFIC-REASON" as specified in IETF RFC 7077 [35]. +2. The PDN GW shall include End Marker Notification mobility option. +3. The PDN GW shall set the Acknowledge (A) flag to "0", thereby not requesting an acknowledgement message from the Serving GW. + +--- + +## Annex A: void + +## Annex B (Normative): Definition of the protocol number in pseudo-header + +### B.1 General + +In this specification PMIP refers to PMIPv6 as defined in IETF RFC5213 [4] and IETF RFC5213 [4] is based on Mobile IPv6 IETF RFC 3775[8]. IETF RFC 3775[38], however, is obsolete by IETF RFC 6275 [8], which specifies protocol number 135 instead of 2 to be used in the checksum pseudo-header. For forward compatibility with future 3GPP releases, the protocol number 135 shall be supported. In addition the protocol number 2 may also be supported. + +NOTE: Some nodes complying to an earlier version of this specification can be implemented according to IETF RFC 3775[38] and this could result in the use of different protocol numbers within a network. + +To migrate a protocol number 2 based PMIP network into a protocol number 135 based PMIP network, the network migration may be achieved by static configuration or supporting a migration solution as specified in this Annex B. Any other alternatives for a specific development use case are possible. + +### B.2 Interworking of different protocol number + +If a PMIPv6 node (LMA) supports both protocol numbers (2 and 135), it shall silently discard the received PBU message if the checksum value calculated from the protocol number 2 and 135 are both invalid. If one of the protocol number (2 or 135) is valid in checksum calculation, the node shall use this protocol number in the "pseudo-header" when sending any subsequent PMIPv6 messages with the same peer PMIPv6 node. If the checksum validation is skipped, the LMA shall use the configured protocol number for the subsequent PMIPv6 messages to that peer node. + +If a PMIPv6 node (MAG) supports both protocol numbers (2 and 135), it shall construct PBU message using protocol number 135 which takes precedence over protocol number 2. If no response is received from LMA, the MAG sends another PBU message to the peer node using protocol number 2. The MAG shall store the protocol number of the response message and use it for the subsequent message interaction. If the checksum validation is skipped, the MAG shall use the configured protocol number for the subsequent PMIPv6 messages to that peer node. + +## Annex C (informative): Change History + +| Change history | | | | | | | | | +|----------------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------------|-------------|--| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | | +| 2008-09 | CT#41 | CP-080476 | | | | V2.0.0 approved in CT#41 | 8.0.0 | | +| 2008-12 | CT#42 | CP-080692 | 0002 | | | IPv4 Address Acknowledgement option in PBA | 8.1.0 | | +| | | CP-080692 | 0006 | | | IPv4 Address Deletion | | | +| | | CP-080692 | 0007 | | | PDN-GW Initiated Resource Allocation Deactivation | | | +| | | CP-080692 | 0008 | | | PDNType-IP Address Option | | | +| | | CP-080692 | 0009 | | | PMIP Bulk Revocation Support. | | | +| | | CP-080692 | 0010 | | | Link local address | | | +| | | CP-080692 | 0011 | | | Service selection option in the PBA message | | | +| | | CP-080692 | 0012 | | | PMIP IPv4 address allocation | | | +| | | CP-080692 | 0019 | | | Interface Id in PBA at HO case | | | +| | | CP-080692 | 0022 | | | Clarification to subclause PMIP6 LMA Initiated PDN Connection Deletion Procedure | | | +| | | CP-080692 | 0023 | | | Update references to latest version of IETF documents | | | +| | | CP-080692 | 0025 | | | Putting back GSM logo on front page | | | +| | | CP-080692 | 0026 | | | PMIPv6 Heartbeat/Path Management Update | | | +| | | CP-080692 | 0031 | | | PMIPv6 clarification | | | +| | | CP-080692 | 0033 | | | Optimized E-UTRAN to CDMA2000 HRPD Handover procedure cleanup | | | +| | | CP-080692 | 0036 | | | IPv4-UDP encapsulation option | | | +| | | CP-080692 | 0037 | | | S5/S8 procedure corrections | | | +| | | CP-080692 | 0038 | | | S2a procedure corrections | | | +| | | CP-080692 | 0039 | | | S2b procedure corrections | | | +| | | CP-080692 | 0040 | | | Chaining case procedure corrections | | | +| | | CP-080692 | 0042 | | | DHCPv4 Address Allocation 3GPP VSO | | | +| | | CP-080692 | 0043 | | | PDN type indicator | | | +| | | CP-080692 | 0044 | | | FFS cleanup | | | +| | | CP-080692 | 0045 | | | HI FFS cleanup | | | +| | | CP-080692 | 0046 | | | Clean up on BULE and BCE | | | +| | | CP-080692 | 0047 | | | Clarification on PMIPv6 Protocol Stack | | | +| | | CP-080692 | 0048 | | | Modifications for S2a/S2b - PMIP based S8 chaining | | | +| 2009-03 | CT#43 | CP-090052 | 0054 | | | 3GPP VSO PDN type cause value | 8.2.0 | | +| | | CP-090052 | 0055 | | | 3GPP VSO DHCPv4 Address Allocation Procedure Indication | | | +| | | CP-090052 | 0056 | | | 3GPP VSO PMIP error code missing in PBA and BRA | | | +| | | CP-090052 | 0059 | | | 3GPP VSO PCO in PBU/PBA message | | | +| | | CP-090052 | 0061 | | | Old BCE is lost at handover | | | +| | | CP-090052 | 0062 | | | Partial Node Failure | | | +| | | CP-090052 | 0064 | | | Alignments of cause codes | | | +| | | CP-090052 | 0065 | | | UE specific Error Indication | | | +| | | CP-090052 | 0066 | | | Clarification on Heartbeat Request Message | | | +| | | CP-090052 | 0071 | | | Link-local Address Option | | | +| | | CP-090052 | 0072 | | | IPv4 Deferred Address Allocation and PDN Type | | | +| | | CP-090052 | 0073 | | | PMIP VSO Charging ID | | | +| | | CP-090052 | 0074 | | | ATT Values for PMIP base S5/S8 | | | +| | | CP-090052 | 0077 | | | Detach or PDN Disconnection | | | +| | | CP-090052 | 0079 | | | Status Field update | | | +| | | CP-090052 | 0080 | | | Correction to tunnel management | | | +| | | CP-090052 | 0085 | | | Carrying APN selection mode in PMIP | | | +| | | CP-090271 | 0086 | | | Removing 3GPP Vendor Specific Mobility Option format | | | +| 2009-04 | | | | | | Correction to history table | 8.2.1 | | +| 2009-06 | CT#44 | CP-090290 | 0090 | | | PMIP VSO Charging Characteristics | 8.3.0 | | +| | | CP-090290 | 0092 | | | PDN Type Cause Value | | | +| | | CP-090290 | 0093 | | | UE Requested additional PDN Connectivity Procedure | | | +| | | CP-090290 | 0094 | | | IP address allocation Procedure | | | +| | | CP-090290 | 0095 | | | FQ-CSID | | | +| | | CP-090290 | 0097 | | | Timestamp | | | +| | | CP-090290 | 0098 | | | Serving Network VSO in PBU | | | +| | | CP-090290 | 0099 | | | GRE Key usage in PDN Connection Lifetime Extension | | | +| | | CP-090290 | 0101 | | | PMIPv6 messages transport over IPv4 | | | +| | | CP-090290 | 0102 | | | PDN Type for PMIPv6 | | | +| | | CP-090290 | 0106 | | | Carrying MEI over PMIP based S5/S8 | | | + +| | | | | | | | | +|---------|-------|-----------|------|--|--|------------------------------------------------------------------------------------|--------| +| | | CP-090290 | 0107 | | | Carrying MSISDN over PMIP based S5/S8 | | +| | | CP-090290 | 0109 | | | Access technology type to be used by ePDG | | +| | | CP-090290 | 0110 | | | Binding Revocation Indication | | +| 2009-09 | CT#45 | CP-090538 | 0114 | | | APN Restriction for PMIPv6 | 8.4.0 | +| | | CP-090538 | 0116 | | | The IPv4 address allocation procedure | | +| | | CP-090538 | 0117 | | | Clean up on 3GPP Specific PMIPv6 Error Code | | +| | | CP-090538 | 0118 | | | GRE Key usage in PDN Connection Lifetime Extension | | +| | | CP-090538 | 0120 | | | Defining values for 3GPP specific PMIPv6 error code | | +| | | CP-090538 | 0121 | | | Conditional 3GPP specific PMIPv6 information elements | | +| | | CP-090538 | 0122 | | | Reintroducing specific 3GPP Access Technology Types | | +| | | CP-090538 | 0124 | | | Clarifications for HO 3GPP to non-3GPP | | +| | | CP-090538 | 0125 | | | Default MTU size to avoid IP fragmentation in EPS | | +| | | CP-090538 | 0126 | | | Heartbeat Mechanism condition for path failure detection | | +| | | CP-090538 | 0127 | | | Correct on GRE key assignment | | +| | | CP-090538 | 0128 | | | E-UTRAN to HRPD optimized handover | | +| | | CP-090538 | 0130 | | | The revision of LMA's dynamic IP address allocation in handover procedure | | +| | | CP-090729 | 0131 | | | Partial failure handling alignment with stage 2 | | +| | | CP-090729 | 0132 | | | Partial failure handling for S1 based handovers | | +| 2009-12 | CT#46 | CP-090971 | 0133 | | | UE-specific Error Indication | 8.5.0 | +| | | CP-090775 | 0139 | | | IPv4 Address Release for PMIPv6 based S2a | | +| | | CP-090775 | 0140 | | | Correct IPv4 Home Address Reply option IE name | | +| | | CP-090775 | 0142 | | | Clarification on Heartbeat Mechanism | | +| | | CP-090775 | 0143 | | | FFS Cleanup for Service Selection Mobility Option | | +| | | CP-090775 | 0144 | | | IPv4 Default-Router Address option | | +| | | CP-090775 | 0145 | | | Clarifications on the format of Mobile Node Identifier option | | +| | | CP-090775 | 0146 | | | Removing access type mapping table from annex B | | +| | | CP-090775 | 0152 | | | Clarifications on the format of Service Selection Mobility Option | | +| | | CP-090775 | 0154 | | | Correct fields of revocation message | | +| 2009-12 | CT#46 | CP-090801 | 0134 | | | IMEI based NAI | 9.0.0 | +| | | CP-090801 | 0135 | | | Unauthenticated IMSI | | +| | | CP-090802 | 0136 | | | Multiple PDN to the Same APN for PMIP-based Interfaces | | +| | | CP-090802 | 0137 | | | BCE extensions for MUPSAP | | +| 2010-03 | CT#47 | CP-100026 | 0157 | | | Correction of the UE-specific Error Indication | 9.1.0 | +| | | | 0159 | | | Bulk Binding Revocation Indication | | +| | | | 0161 | | | FQ-CSID option | | +| 2010-06 | CT#48 | CP-100265 | 0167 | | | Cause Mapping | 9.2.0 | +| 2010-09 | CT#49 | CP-100444 | 0171 | | | PMIPv6 Reference Update | 9.3.0 | +| 2010-12 | CT#50 | CP-100669 | 0174 | | | Essential correction to the mapping between PMIP 3GSPEC and GTP Cause | 9.4.0 | +| 2010-12 | CT#50 | CP-100694 | 0177 | | | IPv4 Default Router Address | 10.0.0 | +| 2011-03 | CT#51 | CP-110081 | 0180 | | | Clarification on IE using interfaces | 10.1.0 | +| | | CP-110072 | 0189 | | | Handling of UE specific Error Indication over the PMIP | | +| | | CP-110072 | 0190 | | | LMA initiated PDN Connection Deletion with Reactivation requested | | +| | | CP-110208 | 0191 | | | Clarification of PCO decoding | | +| 2011-06 | CT#52 | CP-110369 | 0178 | | | APN based congestion control | 10.2.0 | +| | | CP-110369 | 0179 | | | Low access priority indicator | | +| | | CP-110372 | 0193 | | | Incorrect RFC reference for the UE-specific Error Handling | | +| | | CP-110372 | 0194 | | | PDN GW IP address Correction | | +| 2011-09 | CT#53 | CP-110558 | 0198 | | | PMIP message format | 10.3.0 | +| | | CP-110567 | 0201 | | | Signalling path failure handling | | +| 2011-09 | CT#53 | CP-110580 | 0200 | | | Default inner MTU size | 11.0.0 | +| 2011-12 | CT#54 | CP-110785 | 0211 | | | Correction of the protocol stack for PMIP | 11.1.0 | +| | | CP-110785 | 0212 | | | Migration solution of the PMIP protocol stack issue | | +| | | CP-110791 | 0220 | | | Static IP Address Allocation Indication for Handover procedure | | +| | | CP-110791 | 0225 | | | Learn capability of MUPSAP from PDN connection ID | | +| | | CP-110792 | 0218 | | | Authentication with external networks over PMIP S2b | | +| 2012-03 | CT#55 | CP-120018 | 0232 | | | PMIP binding lifetime | 11.2.0 | +| | | CP-120036 | 0234 | | | PGW based provisioning of the DNS server address for the S2b interface | | +| 2012-06 | CT#56 | CP-120248 | 0237 | | | IPv4 Address Allocation procedure | 11.3.0 | +| | | CP-120248 | 0239 | | | Clarification for IPv4 Home Address Request option in dynamic IP allocation | | +| | | CP-120248 | 0240 | | | S2a related changes when Trusted WLAN Access is used | | +| | | CP-120248 | 0241 | | | Clarifying the use of Default Router Address Option in case of Trusted WLAN access | | +| | | CP-120248 | 0238 | | | Multiple PDN connections | | +| | | CP-120248 | 0247 | | | GRE key reference correction | | +| 2012-09 | CT#57 | CP-120477 | 0249 | | | RAT Type for EPC access via TWAN | 11.4.0 | +| | | CP-120464 | 0250 | | | Extensions to PMIPv6 signalling | | +| | | | 0251 | | | Correction to references for TS 29.275 | | +| | | CP-120656 | 0252 | | | Reference list correction to align with the corrected TS 29.212 title | | + +| | | | | | | | | +|---------|-------|-----------|------|--|--|---------------------------------------------------------------------------------------------------------------------|--------| +| 2012-12 | CT#58 | CP-120729 | 0255 | | | Signalling Priority Indication in handover | 11.5.0 | +| | | CP-120729 | 0266 | | | Static IP Address Allocation Indication | | +| | | CP-120739 | 0253 | | | New PMIP message for EPC Restoration Procedure | | +| | | CP-120739 | 0254 | | | MME/SGSN Id for the PGW triggered SGW restoration procedure | | +| | | CP-120733 | 0259 | | | MSISDN over PMIPv6 S2b/S2a interface | | +| | | CP-120733 | 0262 | | | TWAN operator identification for EPC access charging | | +| | | CP-120733 | 0268 | | | Trusted WLAN AP identity over S2a | | +| 2013-03 | CT#59 | CP-130019 | 0272 | | | IETF Draft Reference- Update Notifications for Proxy Mobile IPv6 | 11.6.0 | +| | | CP-130024 | 0273 | | | Completion of replacing RFC 3775 with RFC 6275 references | | +| | | CP-130024 | 0274 | | | Protocol number used in pseudo-header Migration RFC 3775 to RFC 6275 | | +| | | CP-130027 | 0275 | | | Sending SSID for SaMOG in PMIP | | +| 2013-06 | CT#60 | CP-130284 | 0277 | | | Lifetime in PBU message | 11.7.0 | +| 2013-09 | CT#61 | CP-130465 | 0278 | | | Clarification of operator identifier field within APN encoding | 12.0.0 | +| | | CP-130465 | 0280 | | | Incorrect IE description for Service Selection Mobility Option in BRA | | +| | | CP-130464 | 0281 | | | Addition of End Marker Support for Handover Scenarios with SGW Relocation | | +| 2013-12 | CT#62 | CP-130609 | 0285 | | | Correction of reference to Update Notifications for Proxy Mobile IPv6 | 12.1.0 | +| | | CP-130637 | 0283 | | | Clarification on mobility options for APN congestion control over S2a PMIP | | +| | | CP-130633 | 0286 | | | 3GPP Access to TWAN Handover procedures without optimization | | +| | | CP-130633 | 0287 | | | Clarification on how to use PCO on the S2a PMIP interface | | +| 2014-03 | CT#63 | CP-140020 | 0289 | | | Update the reference of IETF draft Update Notifications for Proxy Mobile IPv6 to RFC 7077 | 12.2.0 | +| | | CP-140023 | 0295 | | | Reflecting back Access Network Identifier options in Proxy Binding Acknowledgement message for TWAN access | | +| | | CP-140031 | 0290 | | | Clarification on usage of APCO on the S2a PMIP interface | | +| | | CP-140031 | 0293 | | | Trusted WLAN mode indication | | +| | | CP-140030 | 0291 | | | Extension of ANI to convey other types of location information | | +| | | CP-140030 | 0292 | | | Providing the NAI in MAG Initiated PDN Connection Deletion procedure | | +| | | CP-140030 | 0296 | | | Access Network Identifier clarification | | +| | | CP-140029 | 0282 | | | Implementation error of "Apply Serving Network on S2a for eHRPD access" C4-131878. | | +| 2014-06 | CT#64 | CP-140252 | 0298 | | | UE Time Zone information for TWAN S2a access | 12.3.0 | +| | | CP-140252 | 0299 | | | Access Network Identifier Timestamp in PDN disconnection procedure | | +| | | CP-140252 | 0300 | | | TWAN ID Timestamp in Bearer Revocation Ack message for PGW initiated bearer deactivation procedure in Trusted WLAN. | | +| | | CP-140252 | 0305 | | | Encoding of the civic address | | +| | | CP-140252 | 0306 | | | A new 3GPP specific option to carry the Logical Access ID in PMIPv6 | | +| | | CP-140252 | 0309 | | | Remove editor's note from TWAN procedures | | +| | | CP-140252 | 0311 | | | SSID not sufficient for TWAN location | | +| | | CP-140261 | 0301 | | | Alternate LMAA or IPv4-LMAA | | +| | | CP-140261 | 0302 | | | Alternate LMA address for user plane | | +| | | CP-140261 | 0307 | | | Alternate LMAA or IPv4-LMAA during Handover | | +| | | CP-140261 | 0308 | | | Alternate LMA address for user plane during Handover | | +| | | CP-140247 | 0303 | | | UE Initiated Connectivity to Additional PDN procedures | | +| | | CP-140247 | 0304 | | | HO procedures for non-transparent mode | | +| 2014-09 | CT#65 | CP-140518 | 0313 | | | PGW IP Address and GRE key in the Update Notification | 12.4.0 | +| 2014-12 | CT#66 | CP-140779 | 0314 | | | Update the reference to IETF draft on carrying Civic address in ANI IE | 12.5.0 | +| | | CP-140972 | 0315 | | | Removal of Optimized HO procedure from HRPD to EUTRAN | | +| | | CP-140972 | 0317 | | | Missing description on Access Technology Type option for TWAN access | | +| 2014-12 | CT#66 | CP-140796 | 0316 | | | Provisioning of P-CSCF address via APCO for S2b | 13.0.0 | +| 2015-03 | CT#67 | CP-150025 | 0318 | | | Update reference RFC Separation of Control and User Plane for PMIPv6 | 13.1.0 | +| 2015-06 | CT#68 | CP-150270 | 0320 | | | Correction on the rejection of the PBU for APN congestion | 13.2.0 | +| | | CP-150270 | 0321 | | | Normative Text for the Optional IEs in the UPN and UPA | | +| | | CP-150270 | 0322 | | | Support of IPv6 Prefix Delegation over PMIP-based S5/S8 | | +| | | CP-150270 | 0324 | | | Editorial corrections to clause 13 | | +| | | CP-150274 | 0325 | | | Add MEI to S2a/S2b interfaces | | +| 2015-09 | CT#69 | CP-150442 | 0326 | | | Origination Time Stamp and Maximum Wait Time in PBU | 13.3.0 | +| 2015-12 | CT#70 | CP-150780 | 0327 | | | Extensions for P-CSCF restoration for trusted and untrusted WLAN access | 13.4.0 | +| | | CP-150751 | 0329 | | | Update the reference for Civic Address | | +| | | CP-150745 | 0332 | | | IANA registration of new Update Notification Reasons | | +| 2016-06 | CT#72 | CP-160228 | 0333 | | | Addition of NB-IoT radio access type | 13.5.0 | +| 2017-03 | CT#72 | | | | | Update to Rel-14 version (MCC) | 14.0.0 | +| 2018-06 | CT#80 | | | | | Update to Rel-15 version (MCC) | 15.0.0 | + +| | | | | | | | | +|---------|--------|---|---|---|---|--------------------------------|--------| +| 2020-07 | CT#88e | | | | | Update to Rel-16 version (MCC) | 16.0.0 | +| 2022-04 | - | - | - | - | - | Update to Rel-17 version (MCC) | 17.0.0 | +| 2024-03 | - | - | - | - | - | Update to Rel-18 version (MCC) | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29281/raw.md b/marked/Rel-18/29_series/29281/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..007ff0ca2b5bf4edbf541e4b5e1e33efba39bc7c --- /dev/null +++ b/marked/Rel-18/29_series/29281/raw.md @@ -0,0 +1,1461 @@ + + +# 3GPP TS 29.281 V18.0.0 (2023-06) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; General Packet Radio System (GPRS) Tunnelling Protocol User Plane (GTPv1-U) (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 and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 General..... | 9 | +| 4.1 GTP Path ..... | 9 | +| 4.2 GTP-U Tunnels ..... | 9 | +| 4.2.1 GTP-U Tunnel description ..... | 9 | +| 4.2.2 IP transport ..... | 10 | +| 4.2.3 GTP-U Tunnel IP transport ..... | 10 | +| 4.2.4 Ingress GTP tunnel (GTPv1-U sending endpoint) ..... | 10 | +| 4.2.5 Egress GTP tunnel (GTPv1-U receiving endpoint)..... | 10 | +| 4.2.6 IP Multicast Distribution of User Plane Data for MBMS and MBS ..... | 11 | +| 4.2.6.1 General..... | 11 | +| 4.2.6.2 IP multicast distribution of User Plane Data ..... | 11 | +| 4.3 GTP-U Protocol Entity ..... | 11 | +| 4.3.0 General ..... | 11 | +| 4.3.1 Handling of Sequence Numbers..... | 12 | +| 4.4 Protocol stack..... | 12 | +| 4.4.0 GTP-PDU Stacks..... | 12 | +| 4.4.1 UDP/IP ..... | 13 | +| 4.4.2 UDP header and port numbers ..... | 13 | +| 4.4.2.0 General..... | 13 | +| 4.4.2.1 Echo Request Message ..... | 14 | +| 4.4.2.2 Echo Response Message ..... | 14 | +| 4.4.2.3 Encapsulated T-PDUs..... | 14 | +| 4.4.2.4 Error Indication..... | 14 | +| 4.4.2.5 Supported Extension Headers Notification..... | 14 | +| 4.4.2.6 End Marker ..... | 14 | +| 4.4.2.7 Tunnel Status ..... | 14 | +| 4.4.3 IP header and IP addresses ..... | 14 | +| 4.4.3.1 Echo Request Message ..... | 14 | +| 4.4.3.2 Echo Response Message ..... | 14 | +| 4.4.3.3 Encapsulated T-PDUs..... | 14 | +| 4.4.3.4 Error Indication..... | 15 | +| 4.4.3.5 Supported Extension Headers Notification..... | 15 | +| 4.4.3.6 End Marker ..... | 15 | +| 4.4.3.7 Tunnel Status ..... | 15 | +| 4.5 Transmission Order and Bit Definitions ..... | 15 | +| 4.6 New Functionality ..... | 15 | +| 5 GTP-U header ..... | 15 | +| 5.1 General format..... | 15 | +| 5.2 GTP-U Extension Header..... | 17 | +| 5.2.1 General format of the GTP-U Extension Header ..... | 17 | +| 5.2.2 Extension Header types ..... | 19 | +| 5.2.2.1 UDP Port..... | 19 | +| 5.2.2.2 PDCP PDU Number ..... | 19 | +| 5.2.2.2A Long PDCP PDU Number..... | 19 | +| 5.2.2.3 Service Class Indicator ..... | 20 | +| 5.2.2.4 RAN Container ..... | 21 | +| 5.2.2.5 Xw RAN Container ..... | 21 | +| 5.2.2.6 NR RAN Container..... | 22 | + +| | | | +|-------------------------------|----------------------------------------------------------------------|-----------| +| 5.2.2.7 | PDU Session Container ..... | 22 | +| 6 | GTP-U Message Formats ..... | 23 | +| 6.1 | General ..... | 23 | +| 6.2 | Presence requirements of Information Elements ..... | 23 | +| 7 | GTP-U Messages ..... | 23 | +| 7.1 | General ..... | 23 | +| 7.2 | Path Management Messages ..... | 24 | +| 7.2.1 | Echo Request ..... | 24 | +| 7.2.2 | Echo Response ..... | 24 | +| 7.2.3 | Supported Extension Headers Notification ..... | 25 | +| 7.3 | Tunnel Management Messages ..... | 25 | +| 7.3.1 | Error Indication ..... | 25 | +| 7.3.2 | End Marker ..... | 25 | +| 7.3.2.1 | General ..... | 25 | +| 7.3.2.2 | End Marker in EPS ..... | 26 | +| 7.3.2.3 | End Marker in 5GS ..... | 26 | +| 7.3.3 | Tunnel Status ..... | 26 | +| 8 | Information Elements ..... | 27 | +| 8.1 | Information Element Types ..... | 27 | +| 8.2 | Recovery ..... | 27 | +| 8.3 | Tunnel Endpoint Identifier Data I ..... | 28 | +| 8.4 | GTP-U Peer Address ..... | 28 | +| 8.5 | Extension Header Type List ..... | 28 | +| 8.6 | Private Extension ..... | 29 | +| 8.7 | GTP-U Tunnel Status Information ..... | 29 | +| 8.7 | Recovery Time Stamp ..... | 30 | +| 9 | Error Handling ..... | 30 | +| 9.1 | Protocol Errors ..... | 30 | +| 9.2 | Path Failure ..... | 30 | +| 10 | Security ..... | 30 | +| 11 | Reliable Delivery of Signalling Messages ..... | 30 | +| 12 | GTP Parameters ..... | 31 | +| 12.1 | General ..... | 31 | +| 12.2 | Timers ..... | 31 | +| 12.3 | Others ..... | 31 | +| 13 | Tunnelling Scenarios ..... | 31 | +| 13.1 | General ..... | 31 | +| 13.2 | Tunnelling between SGWs ..... | 31 | +| 13.3 | Transfer of the user plane data between PDN GWs ..... | 31 | +| 13.4 | Tunnelling between SGSNs ..... | 31 | +| 13.5 | Tunnelling between Source RNC and Target RNC ..... | 32 | +| 13.6 | Transfer of the user plane data between GGSNs ..... | 32 | +| 13.7 | Tunnelling between RNC and eNodeB ..... | 32 | +| 13.8 | Tunnelling between SGSN and eNodeB ..... | 32 | +| 13.9 | Tunnelling between Source eNodeB and Target eNodeB ..... | 32 | +| 13.10 | Tunnelling between SGSN and RNC ..... | 32 | +| 13.11 | Tunnelling between SGSN and SGW ..... | 32 | +| 13.12 | Tunnelling between SGW and eNodeB ..... | 32 | +| 13.13 | Tunnelling between SGW and RNC ..... | 33 | +| 13.14 | Tunnelling between SGW and SGSN ..... | 33 | +| Annex A (Normative): | PDU session user plane protocol over N9, N3mb and N19mb ..... | 34 | +| Annex B (informative): | Change history ..... | 34 | + +# 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 the user plane of GTP used on: + +- the Gn and Gp interfaces of the General Packet Radio Service (GPRS); +- the Iu, Gn and Gp interfaces of the UMTS system; +- the S1-U, S11-U, S2a, S2b, X2, S4, S5, S8, S12, M1 and Sn interfaces of the Evolved Packet System (EPS); +- the F1-U, Xn, W1-U, N3, N9, N19, N3mb and N19mb interfaces of the 5G System (5GS). + +This definition ensures full backwards compatibility with RNC, SGSN and GGSN implementations according to release 7 of 3GPP TS 29.060 [6]. + +NOTE: Releases previous to Release-8 have used 3GPP TS 29.060 [6] as normative definition of the user plane of GTP. This shall be considered when essential corrections are included in the present document or in pre-release-8 version of 3GPP TS 29.060 [6]. + +Fallback from GTPv1-U to GTPv0-U shall not be supported. Therefore, 3GPP Rel-8 and onwards GTPv1-U entity should not listen to the well-known GTPv0 port 3386. If GTPv1 entity listens to the GTPv0 port, the entity shall silently discard any received GTPv0-U message. + +# --- 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.003: "Numbering, addressing and identification". +- [3] 3GPP TS 23.007: "Restoration procedures". +- [4] 3GPP TS 23.060: "General Packet Radio Service (GPRS); Service description; Stage 2". +- [5] 3GPP TS 23.401: "General Packet Radio Service (GPRS) enhancements for Evolved Universal Terrestrial Radio Access Network (E-UTRAN) access". +- [6] 3GPP TS 29.060: "General Packet Radio Service (GPRS); GPRS Tunnelling Protocol (GTP) across the Gn and Gp interface". + +- [7] 3GPP TS 29.274: "3GPP Evolved Packet System; Evolved GPRS Tunnelling Protocol for EPS (GTPv2)". +- [8] 3GPP TS 32.295: "Telecommunication management; Charging management; Charging Data Record (CDR) transfer". +- [9] IETF RFC 768 (STD 0006): "User Datagram Protocol", J. Postel. +- [10] IETF RFC 791 (STD 0005): "Internet Protocol", J. Postel. +- [11] IETF RFC 4291: "IP Version 6 Addressing Architecture". +- [12] 3GPP TS 33.210: "3G security; Network Domain Security (NDS); IP network layer security". +- [13] 3GPP TS 23.121: "Architectural requirements for Release 1999". +- [14] 3GPP TS 43.129: "Packet-switched handover for GERAN A/Gb mode; Stage 2". +- [15] IETF RFC 2460: "Internet Protocol, Version 6 (IPv6) Specification". +- [16] 3GPP TS 25.413: "UTRAN Iu interface RANAP signalling". +- [17] 3GPP TS 36.300: "Evolved Universal Terrestrial Radio Access (E-UTRA) and Evolved Universal Terrestrial Radio Access Network (E-UTRAN); Overall description; Stage 2". +- [18] 3GPP TS 23.246: "Multimedia Broadcast/Multicast Service (MBMS); Architecture and functional description; Stage 2". +- [19] IETF RFC 4604 (2006): "Using Internet Group Management Protocol Version 3 (IGMPv3) and Multicast Listener Discovery Protocol Version 2 (MLDv2) for Source-Specific Multicast". +- [20] IETF RFC 4607 (2006): "Source-Specific Multicast for IP". +- [21] 3GPP TS 33.102: "3G Security; Security architecture". +- [22] 3GPP TS 33.401: "3GPP System Architecture Evolution (SAE): Security architecture". +- [23] 3GPP TS 23.402: "Architecture enhancements for non-3GPP accesses". +- [24] 3GPP TS 36.323: "Evolved Universal Terrestrial Radio Access (E-UTRA); Packet Data Convergence Protocol (PDCP) specification". +- [25] 3GPP TS 36.425: "E-UTRAN X2 interface user plane protocol". +- [26] IETF RFC 2474, "Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers". +- [27] 3GPP TS 36.465: "Evolved Universal Terrestrial Radio Access (E-UTRAN) and Wireless LAN (WLAN) Xw interface user plane protocol". +- [28] 3GPP TS 23.501: "System Architecture for the 5G System; Stage 2". +- [29] 3GPP TS 23.502: "Procedures for the 5G System; Stage 2". +- [30] 3GPP TS 38.425: "NG-RAN; NR user plane protocol". +- [31] 3GPP TS 38.415: "NG-RAN; PDU Session User Plane Protocol". +- [32] 3GPP TS 33.250: "Security assurance specification for the PGW network product class". +- [33] 3GPP TS 23.527: "5G System; Restoration Procedures". +- [34] 3GPP TS 38.300: "NR; NR and NG-RAN Overall Description; Stage 2". +- [35] 3GPP TS 38.323: "NR; Packet Data Convergence Protocol (PDCP) specification". +- [36] IETF RFC 8200: "Internet Protocol, Version 6 (IPv6) Specification" + +- [37] IETF RFC 6437: "IPv6 Flow Label Specification". +- [38] 3GPP TS 37.340: "Evolved Universal Terrestrial Radio Access (E-UTRA) and NR; Multi-connectivity; Stage 2". +- [39] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane Nodes". +- [40] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services". +- [41] IETF RFC 5905: "Network Time Protocol Version 4: Protocol and Algorithms Specification". +- [42] 3GPP TS 37.470: "W1 interface; General aspects and principles". + +# --- 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 TR 21.905 [1]. + +**Common Tunnel Endpoint Identifier (C-TEID):** Unambiguously identifies a tunnel endpoint in the receiving GTP-U protocol entity for a given UDP/IP endpoint. The sending end side of a GTP tunnel locally assigns the C-TEID value used in the TEID field and signals it to the destination Tunnel Endpoint using a control plane message. + +**GTP-U Message:** GTP-U (user plane) messages are either user plane messages or signalling messages. User plane messages are used to carry user data packets between GTP-U entities. Signalling messages are sent between network nodes for path management and tunnel management. **GTP-U peer:** node implementing at least one side of any of the GTP user plane based protocols. RNC, SGSN, GGSN, eNodeB, SGW, ePDG, gNB, N3IWF, UPF, PGW or TWAN or MME. + +**GTP-U Tunnel:** A GTP-U tunnel is identified in each node with a TEID, an IP address and a UDP port number. A GTP-U tunnel is necessary to enable forwarding packets between GTP-U entities. + +**GTP-U Tunnel Endpoint:** A GTP-U tunnel endpoint identifies a user plane context (e.g EPS bearer, PDU session or a RAB) for which a received GTP-U packet is intended. A given GTP-U tunnel endpoint may receive GTP-U packets from more than one source GTP-U peer (See clause 4.3.0). **UDP/IP Path:** Connection-less unidirectional or bidirectional path defined by two end-points. An IP address and a UDP port number define an end-point. A UDP/IP path carries GTP messages between network nodes related to one or more GTP tunnels. + +**GTP-PDU:** GTP Protocol Data Unit (PDU) is a GTP-U message, which may be either a G-PDU or a signalling message. + +**G-PDU:** User data packet (T-PDU) plus GTP-U header, sent between GTP network nodes. + +**Signalling Message:** A GTP-U message (GTP-PDU that is not a G-PDU) sent between GTP network nodes. These may be Path Management messages or Tunnel Management messages. + +**T-PDU:** A user data packet, for example an IP datagram, sent between a UE and a network entity in an external packet data network. A T-PDU is the payload that is tunnelled in the GTP-U tunnel. + +**Tunnel Endpoint Identifier (TEID):** Unambiguously identifies a tunnel endpoint in the receiving GTP-U protocol entity for a given UDP/IP endpoint. The receiving end side of a GTP tunnel locally assigns the TEID value the transmitting side has to use. The TEID values are exchanged between tunnel endpoints using control plane message. + +**Trusted WLAN Access Network:** see 3GPP TS 23.402 [23]. + +## 3.2 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]. + +| | | +|--------|---------------------------------------| +| C-TEID | Common Tunnel Endpoint IDentifier | +| EN-DC | E-UTRA-NR Dual Connectivity | +| ePDG | Evolved Packet Data Gateway | +| GSN | GPRS Support Node | +| GGSN | Gateway GPRS Support Node | +| G-PDU | GTP encapsulated user Plane Data Unit | +| GTP | GPRS Tunnelling Protocol | +| GTP-C | GTP Control | +| GTP-U | GTP User | +| IE | Information Element | +| IGMP | Internet Group Management Protocol | +| IP | Internet Protocol | +| IPv4 | Internet Protocol version 4 | +| IPv6 | Internet Protocol version 6 | +| MME | Mobility Management Entity | +| PDU | Packet Data Unit | +| PGW | PDN Gateway | +| QoS | Quality of Service | +| RANAP | Radio Access Network Application Part | +| RNC | Radio Network Controller | +| SGSN | Serving GPRS Support Node | +| SGW | Serving Gateway | +| TEID | Tunnel Endpoint IDentifier | +| T-PDU | Transport PDU | +| TWAN | Trusted WLAN Access Network | +| UDP | User Datagram Protocol | +| UTRAN | UMTS Terrestrial Radio Access Network | + +# --- 4 General + +## 4.1 GTP Path + +For the definition of UDP/IP Path and GTP Endpoint, see 3GPP TS 29.060 [6]. + +## 4.2 GTP-U Tunnels + +### 4.2.1 GTP-U Tunnel description + +GTP-U Tunnels are used to carry encapsulated T-PDUs and signalling messages between a given pair of GTP-U Tunnel Endpoints. The Tunnel Endpoint ID (TEID) which is present in the GTP header shall indicate which tunnel a particular T-PDU belongs to. In this manner, packets are multiplexed and de-multiplexed by GTP-U between a given pair of Tunnel Endpoints. The TEID value to be used in the TEID field shall be signalled to the peer GTP-U entity using a control plane protocol like GTPv1-C, GTPv2-C, RANAP or S1-AP. + +In what follows we refer to the outer GTPv1-U IP packet as the IP packet that carries a GTPv1-U packet. The inner IP packet in a GTPv1-U packet (T-PDU) is either + +- An IP packet sent to the UE/MS in the downlink direction over one or more tunnels from the external network identified by the APN. +- An IP packet sent from a UE/MS in the uplink direction over one or more tunnels to the external network identified by the APN. + +NOTE 1: Not all tunnels in 3GPP networks will necessarily be GTPv1-U, + +NOTE 2: The inner MTU size of the GTPv1-U tunnel is typically not the same as the outer MTU size of the IP path carrying the outer IP packets. + +The maximum size of a T-PDU that may be transmitted without fragmentation by GGSN or the MS is defined in 3GPP TS 23.060 [4]. + +### 4.2.2 IP transport + +According to IETF RFC 791 [10], any IPv4 router in the backbone may fragment the outer IPv4 GTPv1-U packet with a flag of DF=0. + +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 both GTPv1-U endpoints and IP routers. It also requires additional memory at the receiver. +- If one fragment is lost, the complete packet has to be discarded. The reason is there is no selective retransmission of IP fragments provided in IPv4 or IPv6. + +Recommendations on how to set the default inner MTU size at the PDN GW and UE/MS to avoid IP fragmentation of both inner IP packets (in the PDN GW or UE/MS) and outer IP packets in the backbone are specified in clause 9.3 of 3GPP TS 23.060 [4]. + +### 4.2.3 GTP-U Tunnel IP transport + +Functionality for IP transport and IP fragmentation at a RAN node on the Iu interface or S12 is defined in 3GPP TS 25.414 [16]. + +Functionality for IP transport and IP fragmentation at an eNodeB on the S1-U and X2 interface is defined in 3GPP TS 36.300 [17]. + +Functionality for IP transport and IP fragmentation at an NG-RAN on the N3 and Xn interface is defined in 3GPP TS 38.300 [34]. + +Functionality for IP transport and IP fragmentation for interconnecting an ng-eNB-CU and an ng-eNB-DU of an ng-eNB within an NG-RAN on the W1-U interface is defined in 3GPP TS 37.470 [42]. + +The outer GTPv1-U packet layer shall support IPv4 as defined by IETF RFC 791 [10] and should support IPv6 as defined by IETF RFC 8200 [36]. + +The following text as well as clauses 4.2.4 and 4.2.5 apply only to core network GTPv1-U endpoints. + +GTPv1-U tunnel endpoints do not need to change the hopcount/TTL or to perform any IP routing functions in respect to inner IP packet other than the functions explicitly stated here. However, other co-located functions may do so. For example, the GGSN/PGW/UPF may change the hopcount/TTL as the IP datagram enters/leaves the Gi/SGi/N6 interface from/to the GTPv1-U tunnel interface and IP packets may be discarded or rejected at any point by a co-located function due to local policy and/or QoS (the policy enforcement point). + +### 4.2.4 Ingress GTP tunnel (GTPv1-U sending endpoint) + +An inner IP packet shall be encapsulated at the GTPv1-U sender with a GTP header, UDP and IP header. If the resulting outer IP packet is larger than the MTU of the first link towards the destination GTPv1-U endpoint, fragmentation of the IP packet shall be performed by the sender as per IETF RFC 791 [10] for an outer layer of IPv4 and IETF RFC 8200 [36] for an outer layer of IPv6. The GTPv1-U sender should preferably fragment the IP packet to the smallest MTU of any link between GTPv1-U sender and GTPv1-U receiver. + +Fragmentation policy of the inner datagram is implementation dependent but shall interwork with IETF RFC 791 [10] for inner IPv4 datagrams and IETF RFC 8200 [36] for inner IPv6 packets. + +### 4.2.5 Egress GTP tunnel (GTPv1-U receiving endpoint) + +The GTPv1-U receiving endpoint packets shall reassemble any IP fragments in datagrams received from the GTPv1-U sending endpoint as per IETF RFC 791 [10] for outer IPv4 datagrams and as per IETF RFC 8200 [36] for outer IPv6 + +datagrams. The IP reassembly buffer in the receiving endpoint shall be at least the inner MTU size plus the size of the tunnel headers (outer IP header, outer UDP header, and GTP header, including any GTP extension headers). + +The completely reassembled IP packet shall then be passed to the IP/UDP/GTPv1-U layers to extract the inner IP packet which is then processed further according to the receiving node's functionality. + +### 4.2.6 IP Multicast Distribution of User Plane Data for MBMS and MBS + +#### 4.2.6.1 General + +In GPRS and EPS, MBMS data may be delivered between the GGSN and RNC, or between the MBMS GW and the eNodeB or RNC, using IP multicast transport, as specified in clause 6.5 of 3GPP TS 23.246 [18]. + +In 5GS, MBS data may be delivered between the 5GC and NG-RAN using 5GC Individual MBS traffic delivery (applicable only to multicast MBS sessions) and/or 5GC Shared MBS traffic delivery (applicable to broadcast and multicast MBS sessions), as specified in clause 4.1 of 3GPP TS 23.247 [40]. The user plane from the MB-UPF to NG-RANs (for 5GC Shared MBS traffic delivery) and the user plane from the MB-UPF to UPFs (for 5GC Individual MBS traffic delivery) may use IP multicast transport via a common GTP-U tunnel per MBS session, or use unicast transport via separate GTP-U tunnels at NG-RAN or at UPF per MBS session, as specified in clause 6.7 of 3GPP TS 23.247 [40]. + +Specific requirements for IP multicast distribution of user plane data are specified in clause 4.2.6.2. + +#### 4.2.6.2 IP multicast distribution of User Plane Data + +When using IP multicast transport, GTP-U Multicast Tunnels shall be used for unidirectional transfer of the encapsulated T-PDUs from one GTP-U Tunnel Endpoint acting as an IP multicast source to multiple GTP-U Tunnel Endpoints acting as IP multicast listeners. The Common Tunnel Endpoint ID (C-TEID) which is present in the GTP header shall indicate which tunnel a particular T-PDU belongs to. The C-TEID value to be used in the TEID field shall be allocated at the source Tunnel Endpoint and signalled to the destination Tunnel Endpoint using a control plane protocol, i.e. GTPv1-C and RANAP, GTPv2-C and S1-AP, 5GC SBIs and/or NGAP. One C-TEID shall be allocated per MBMS bearer service or per MBS session. + +The destination IP address in the outer GTPv1-U IP header shall be an address in the multicast address range as specified in IETF RFC 4607 [20]. + +If the RNC decides to receive IP multicast packets, then the RNC shall join the IP multicast group as specified by IETF RFC 4604 [19] and IETF RFC 4607 [20]. + +If the eNodeB supports MBMS as specified in 3GPP TS 23.246 [18], it shall join the IP multicast group as specified in IETF RFC 4604 [19] and IETF RFC 4607 [20]. + +If the gNB supports MBS as specified in 3GPP TS 23.247 [40], it shall join the IP multicast group as specified in IETF RFC 4604 [19] and IETF RFC 4607 [20]. + +The characteristics for point-to-multipoint GTP-U Multicast Tunnels used for MBMS or MBS are the same as for a point-to-point GTP-U Tunnels unless specified otherwise. The differences are specified in clause 7.1. + +## 4.3 GTP-U Protocol Entity + +### 4.3.0 General + +The GTP-U protocol entity provides packet transmission and reception services to user plane entities in the RNC, SGSN, GGSN, eNodeB, SGW, ePDG, PGW, TWAN, MME, gNB, N3IWF, UPF and MB-UPF. The GTP-U protocol entity receives traffic from a number of GTP-U tunnel endpoints and transmits traffic to a number of GTP-U tunnel endpoints. There is a GTP-U protocol entity per IP address. + +The TEID in the GTP-U header is used to de-multiplex traffic incoming from remote tunnel endpoints so that it is delivered to the User plane entities in a way that allows multiplexing of different users, different packet protocols and different QoS levels. The GTP-U protocol supports the possibility for one GTP-U tunnel endpoint to receive packets from multiple remote GTP-U endpoints. This may be used in the following scenarios: + +- Tracking Area Update procedure with Serving GW change and data forwarding as specified in clause 5.3.3.1A of 3GPP TS 23.401 [5], if the above capability is supported by the receiving eNB; +- Dual connectivity in 5GC as specified in clause 5.11.1 of 3GPP TS 23.501 [28], where the master and secondary NG-RAN may be assigned the same uplink F-TEID of the UPF by the SMF for uplink traffic of the same PDU session; and +- IPv6 multihoming scenario as specified in clause 5.6.4.3 of 3GPP TS 23.501 [28], where the downlink traffic from multiple PDU Session Anchors of the same PDU session may be assigned the same N9 F-TEID of the branching point UPF by the SMF. + +### 4.3.1 Handling of Sequence Numbers + +This functionality is provided only when the S bit is set to 1 in the GTP-U header. + +For PGW, SGW, ePDG, eNodeB, TWAN, MME, gNB, N3IWF, and UPF, the usage of sequence numbers in G-PDUs is optional, but if GTP-U protocol entities in these nodes are relaying G-PDUs to other nodes, then they shall relay the sequence numbers as well. For all other cases, the PGW, SGW, ePDG, eNodeB, TWAN, MME, gNB, N3IWF and UPF should set the "S" flag to 0 in the GTPv1 header which then indicates that the sequence number is not used in the T-PDU. + +An RNC, SGSN or GGSN shall reorder out of sequence T-PDUs when in sequence delivery is required. This is optional at the SGSN for UTRAN access. The GTP-U protocol entity shall deliver to the user plane entity only in sequence T-PDUs and notify the sequence number associated to each of them. The notification of the sequence number is not necessary at the GGSN, but it is mandatory at the SGSN and RNC. The user plane entity shall provide a sequence number to the GTP-U layer together with T-PDUs to be transmitted in sequence. GTP-U protocol entities at the GGSN may optionally generate autonomously the sequence number, but should be able to use sequence numbers provided by the user plane entity. The sequence number is handled on a per GTP-U Tunnel (that is TEID) basis. During relocations and handovers, if a buffered packet is forwarded from the source to the target GTP-U protocol entity along with PDCP T-PDU extension headers, the source of the T-PDU may be considered different and may not relay the sequence numbers. + +When the sequence number is included in the GTP-U header, a user plane entity acting as a relay of T-PDUs between GTP-U protocol entities, or between PDCP (or SNDPCP) protocol entities and GTP-U protocol entities, shall relay the sequence numbers between those entities as well. In this way it is possible to keep consistent values of sequence numbers from the GGSN to the UE (MS in GPRS) by relaying the sequence number across the CN GTP-U bearer, the Iu GTP-U bearer and the Radio bearer (via PDCP or SNDPCP N-PDU numbers). This functionality is beneficial during SRNS relocation. + +For GTP-U signalling messages having a response message defined for a request message, Sequence Number shall be a message number valid for a path. Within a given set of continuous Sequence Numbers from 0 to 65535, a given Sequence Number shall, if used, unambiguously define a GTP-U signalling request message sent on the path (see clause Reliable delivery of signalling messages). The Sequence Number in a signalling response message shall be copied from the signalling request message that the GTP-U entity is replying to. For GTP-U messages not having a defined response message for a request message, i.e. for messages Supported Extension Headers Notification and Error Indication, the Sequence Number shall be ignored by the receiver. + +## 4.4 Protocol stack + +### 4.4.0 GTP-PDU Stacks + +The protocol stack for a GTP-PDU G-PDU is shown in Figure 4.4-1. The protocol stack for a GTP-PDU signaling message is shown in Figure 4.4-2. + +![Figure 4.4-1 G-PDU Protocol Stack diagram showing three stacked layers: T-PDU, GTPv1-U Header, and UDP/IP. A bracket on the right groups the top two layers as G-PDU.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +The diagram illustrates the G-PDU Protocol Stack. It consists of three vertically stacked rectangular boxes. The top box is labeled 'T-PDU', the middle box is labeled 'GTPv1-U Header', and the bottom box is labeled 'UDP/IP'. A large curly bracket on the right side of the stack groups the 'T-PDU' and 'GTPv1-U Header' layers together, with the label 'G-PDU' positioned to the right of the bracket. + +Figure 4.4-1 G-PDU Protocol Stack diagram showing three stacked layers: T-PDU, GTPv1-U Header, and UDP/IP. A bracket on the right groups the top two layers as G-PDU. + +Figure: 4.4-1 G-PDU Protocol Stack + +NOTE: T-PDU may contain an IP Datagram, Ethernet or unstructured PDU Data frames as specified in 3GPP TS 23.501 [28]. + +![Figure 4.4-2 Signalling Message Protocol Stack diagram showing three stacked layers: Zero or more IEs, GTPV1-U Header, and UDP/IP. A bracket on the right groups the top two layers as Signaling Message (Path Management or Tunnel Management).](ddc7460821484f1ae2835c67955c554c_img.jpg) + +The diagram illustrates the Signalling Message Protocol Stack. It consists of three vertically stacked rectangular boxes. The top box is labeled 'Zero or more IEs', the middle box is labeled 'GTPV1-U Header', and the bottom box is labeled 'UDP/IP'. A large curly bracket on the right side of the stack groups the 'Zero or more IEs' and 'GTPV1-U Header' layers together, with the label 'Signaling Message (Path Management or Tunnel Management)' positioned to the right of the bracket. + +Figure 4.4-2 Signalling Message Protocol Stack diagram showing three stacked layers: Zero or more IEs, GTPV1-U Header, and UDP/IP. A bracket on the right groups the top two layers as Signaling Message (Path Management or Tunnel Management). + +Figure: 4.4-2 Signalling Message Protocol Stack + +### 4.4.1 UDP/IP + +UDP/IP is the only path protocol defined to transfer GTP messages in the version 1 of GTP. + +A GTPv1-U peer shall support the User Datagram Protocol (UDP) as defined by IETF RFC 768 [9] shall be used. + +A GTPv1-U peer shall support IPv4 as defined by IETF RFC 791 [10] and should support IPv6 as defined by IETF RFC 8200 [36]. + +The DSCP marking as defined by IETF RFC 2474 [26] shall be set: + +- based on the QCI, and optionally the ARP priority level, of the associated EPS bearer, as described in clause 4.7.3 of 3GPP TS 23.401 [5]; +- based on the 5QI and ARP of the associated 5G QoS Flow, as described in clause 5.7.1.6 and clause 5.7.1.7 of 3GPP TS 23.501 [28]. + +### 4.4.2 UDP header and port numbers + +#### 4.4.2.0 General + +For the GTP-U messages described below (other than the Echo Response message, see clause 4.4.2.2), the UDP Source Port or the Flow Label field (see IETF RFC 6437 [37]) should be set dynamically by the sending GTP-U entity to help balancing the load in the transport network. + +When using GTP-U over IPv6 (see IETF RFC 8200 [36]), the UDP checksum shall not be set to zero by the sending GTP-U entity unless it is ensured that the peer GTP-U entity and the path in-between supports UDP zero checksum. + +NOTE 1: GTP-U entities complying with an earlier version of the specification or on path IPv6 middleboxes can implement IPv6 as specified in IETF RFC 2460 [15] and discard UDP packets containing a zero checksum. + +NOTE 2: How a sending GTP-U entity knows whether the peer GTP-U entity and the path in-between supports UDP zero checksum is out of scope of this specification. + +#### 4.4.2.1 Echo Request Message + +The UDP Destination Port number for GTP-U request messages is 2152. It is the registered port number for GTP-U. + +#### 4.4.2.2 Echo Response Message + +The UDP Destination Port value shall be the value of the UDP Source Port of the corresponding request message. + +The UDP Source Port shall be the value from the UDP Destination Port of the corresponding request message. + +#### 4.4.2.3 Encapsulated T-PDUs + +The UDP Destination Port number shall be 2152. It is the registered port number for GTP-U. + +#### 4.4.2.4 Error Indication + +The UDP destination port for the Error Indication shall be the user plane UDP port (2152). + +NOTE: In network deployments including non-GTP-aware stateful firewalls, those firewalls must be configured to allow response messages coming from a different UDP port and IP address than the triggering message. + +#### 4.4.2.5 Supported Extension Headers Notification + +The UDP destination port for the Supported Extension Headers Notification shall be the user plane UDP port (2152). + +#### 4.4.2.6 End Marker + +The UDP Destination Port number shall be 2152. It is the registered port number for GTP-U. + +The UDP Destination Port and UDP Source Port shall be the same as those of the corresponding GTP-U tunnel for which the End Marker message is sent. + +#### 4.4.2.7 Tunnel Status + +The UDP destination port for the Tunnel Status shall be the user plane UDP port (2152). + +### 4.4.3 IP header and IP addresses + +#### 4.4.3.1 Echo Request Message + +The IP Source Address shall be an IP address of the source GTP-U entity from which the message is originating. + +The IP Destination Address in a GTP request message shall be an IP address of the destination GTP-U entity. + +#### 4.4.3.2 Echo Response Message + +The IP Source Address shall be copied from the IP destination address of the GTP request message to which this GTP-U entity is replying. + +The IP Destination Address shall be copied from the IP Source Address of the GTP request message to which this GTP-U entity is replying. + +#### 4.4.3.3 Encapsulated T-PDUs + +The IP Source Address shall be an IP address of the source GTP-U entity from which the message is originating. + +The IP Destination Address shall be an IP address of the destination GTP-U entity. + +#### 4.4.3.4 Error Indication + +The IP source address shall be an address of the source GTP-U entity from which the message is originated + +NOTE: In network deployments including non-GTP-aware stateful firewalls, those firewalls must be configured to allow response messages coming from a different UDP port and IP address than the triggering message. + +The IP destination address for Error Indication shall be the source address of the GTP-PDU that is the cause for this GTP-U entity to send this message. + +#### 4.4.3.5 Supported Extension Headers Notification + +The IP Source Address for the Supported Extension Headers Notification shall be copied from the IP destination address of the GTP message that triggered the GTP-U entity to send this message. + +The IP Destination Address for the Supported Extension Headers Notification shall be copied from the IP source address of the GTP message that triggered the GTP-U entity to send this message. + +#### 4.4.3.6 End Marker + +The IP Source Address shall be an IP address of the source GTP-U entity from which the message is originating. + +The IP Destination Address shall be an IP address of the destination GTP-U entity. + +The IP Destination Address and IP Source Address shall be the same as those of the corresponding GTP-U tunnel for which the End Marker message is sent. + +#### 4.4.3.7 Tunnel Status + +The IP Source Address shall be an IP address of the source GTP-U entity from which the message is originating. + +The IP Destination Address shall be an IP address of the destination GTP-U entity. + +The IP Destination Address and IP Source Address shall be the same as the corresponding GTP-U tunnel (to send G-PDU) for which the Tunnel Status message is sent. + +## 4.5 Transmission Order and Bit Definitions + +As specified in 3GPP TS 29.060 [6], clause 5. + +## 4.6 New Functionality + +With regard to the previous releases, the present specification may define some new functions. Such new functions shall ensure full backwards compatibility with Pre-Rel-8 nodes conforming to 3GPP TS 29.060 [6]. If the new functions are specified with the Extension Headers, bits 8 and 7 of the Extension Header Type shall be set to 0, 0 respectively or 0, 1 respectively. If the new functions are specified with Information Elements, such Information Elements shall be TLV-encoded and optional. + +# --- 5 GTP-U header + +## 5.1 General format + +The GTP-U header is a variable length header whose minimum length is 8 bytes. There are three flags that are used to signal the presence of additional optional fields: the PN flag, the S flag and the E flag. The PN flag is used to signal the + +presence of N-PDU Numbers. The S flag is used to signal the presence of the GTP Sequence Number field. The E flag is used to signal the presence of the Extension Header field, used to enable future extensions of the GTP header defined in this document, without the need to use another version number. If and only if one or more of these three flags are set, the fields Sequence Number, N-PDU and Extension Header shall be present. The sender shall set all the bits of the unused fields to zero. The receiver shall not evaluate the unused fields. For example, if only the E flag is set to 1, then the N-PDU Number and Sequence Number fields shall also be present, but will not have meaningful values and shall not be evaluated. + +### Always present fields: + +- Version field: This field is used to determine the version of the GTP-U protocol. The version number shall be set to '1'. +- Protocol Type (PT): This bit is used as a protocol discriminator between GTP (when PT is '1') and GTP' (when PT is '0'). GTP is described in this document and the GTP' protocol in 3GPP TS 32.295 [8]. Note that the interpretation of the header fields may be different in GTP' than in GTP. +- Extension Header flag (E): This flag indicates the presence of a meaningful value of the Next Extension Header field. When it is set to '0', the Next Extension Header field either is not present or, if present, shall not be interpreted. When it is set to '1', the Next Extension Header field is present, and shall be interpreted, as described below in this clause. +- Sequence number flag (S): This flag indicates the presence of a meaningful value of the Sequence Number field. When it is set to '0', the Sequence Number field either is not present or, if present, shall not be interpreted. When it is set to '1', the Sequence Number field is present, and shall be interpreted, as described below in this clause. For the Echo Request, Echo Response, Error Indication and Supported Extension Headers Notification messages, the S flag shall be set to '1'. Since the use of Sequence Numbers is optional for G-PDUs, the PGW, SGW, ePDG, eNodeB and TWAN should set the flag to '0'. However, when a G-PDU (T-PDU+header) is being relayed by the Indirect Data Forwarding for Inter RAT HO procedure, then if the received G-PDU has the S flag set to '1', then the relaying entity shall set S flag to '1' and forward the G-PDU (T-PDU+header). In an End marker and Tunnel Status messages the S flag shall be set to '0'. +- N-PDU Number flag (PN): This flag indicates the presence of a meaningful value of the N-PDU Number field. When it is set to '0', the N-PDU Number field either is not present, or, if present, shall not be interpreted. When it is set to '1', the N-PDU Number field is present, and shall be interpreted, as described below in this clause. +- Message Type: This field indicates the type of GTP-U message. +- Length: This field indicates the length in octets of the payload, i.e. the rest of the packet following the mandatory part of the GTP header (that is the first 8 octets). The Sequence Number, the N-PDU Number or any Extension headers shall be considered to be part of the payload, i.e. included in the length count. +- Tunnel Endpoint Identifier (TEID): This field unambiguously identifies a tunnel endpoint in the receiving GTP-U protocol entity. The receiving end side of a GTP tunnel locally assigns the TEID value the transmitting side has to use. The TEID value shall be assigned in a non-predictable manner for PGW S5/S8/S2a/S2b interfaces (see 3GPP TS 33.250 [32]). The TEID shall be used by the receiving entity to find the PDP context, except for the following cases: + - The Echo Request/Response and Supported Extension Headers notification messages, where the Tunnel Endpoint Identifier shall be set to all zeroes. + - The Error Indication message where the Tunnel Endpoint Identifier shall be set to all zeros. +- When setting up a GTP-U tunnel, the GTP-U entity shall not assign the value 'all zeros' to its own TEID. However, for backward compatibility, if a GTP-U entity receives (via respective control plane message) a peer's TEID that is set to the value 'all zeros', the GTP-U entity shall accept this value as valid and send the subsequent G-PDU with the TEID field in the header set to the value 'all zeros'. + +### Optional fields: + +- Sequence Number: If Sequence Number field is used for G-PDUs (T-PDUs+headers), an increasing sequence number for T-PDUs is transmitted via GTP-U tunnels, when transmission order must be preserved. For + +Supported Extension Headers Notification and Error Indication messages, the Sequence Number shall be ignored by the receiver, even though the S flag is set to '1'. + +- N-PDU Number: This field is used at the Inter SGSN Routeing Area Update procedure and some inter-system handover procedures (e.g. between 2G and 3G radio access networks). This field is used to co-ordinate the data transmission for acknowledged mode of communication between the MS and the SGSN. The exact meaning of this field depends upon the scenario. (For example, for GSM/GPRS to GSM/GPRS, the SNDCP N-PDU number is present in this field). +- Next Extension Header Type: This field defines the type of Extension Header that follows this field in the GTP-PDU. + +| Octets | Bits | | | | | | | | | | +|--------|----------------------------------------------------------|---|----|---|-----|---|---|----|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 | Version | | PT | | (*) | E | S | PN | | | +| 2 | Message Type | | | | | | | | | | +| 3 | Length (1 st Octet) | | | | | | | | | | +| 4 | Length (2 nd Octet) | | | | | | | | | | +| 5 | Tunnel Endpoint Identifier (1 st Octet) | | | | | | | | | | +| 6 | Tunnel Endpoint Identifier (2 nd Octet) | | | | | | | | | | +| 7 | Tunnel Endpoint Identifier (3 rd Octet) | | | | | | | | | | +| 8 | Tunnel Endpoint Identifier (4 th Octet) | | | | | | | | | | +| 9 | Sequence Number (1 st Octet) 1) 4) | | | | | | | | | | +| 10 | Sequence Number (2 nd Octet) 1) 4) | | | | | | | | | | +| 11 | N-PDU Number 2) 4) | | | | | | | | | | +| 12 | Next Extension Header Type 3) 4) | | | | | | | | | | + +NOTE 0: (\*) This bit is a spare bit. It shall be sent as '0'. The receiver shall not evaluate this bit. + +NOTE 1: 1) This field shall only be evaluated when indicated by the S flag set to 1. + +NOTE 2: 2) This field shall only be evaluated when indicated by the PN flag set to 1. + +NOTE 3: 3) This field shall only be evaluated when indicated by the E flag set to 1. + +NOTE 4: 4) This field shall be present if and only if any one or more of the S, PN and E flags are set. + +Figure 5.1-1: Outline of the GTP-U Header + +## 5.2 GTP-U Extension Header + +### 5.2.1 General format of the GTP-U Extension Header + +The format of GTP-U Extension Headers is depicted in figure 5.2.1-1. The Extension Header Length field specifies the length of the particular Extension header in 4 octets units. The Next Extension Header Type field specifies the type of any Extension Header that may follow a particular Extension Header. If no such Header follows, then the value of the Next Extension Header Type shall be 0. + +| | | | +|--------|-------|----------------------------| +| Octets | 1 | Extension Header Length | +| | 2 – m | Extension Header Content | +| | m+1 | Next Extension Header Type | + +Figure 5.2.1-1: Outline of the Extension Header Format + +The length of the Extension header shall be defined in a variable length of 4 octets, i.e. $m+1 = n*4$ octets, where n is a positive integer. + +Bits 7 and 8 of the Next Extension Header Type define how the recipient shall handle unknown Extension Types, see Figure 5.2.1-2. The recipient of an extension header of unknown type but marked as 'comprehension not required' for that recipient shall read the 'Next Extension Header Type' field (using the Extension Header Length field to identify its location in the GTP-PDU). + +The recipient of an extension header of unknown type, but marked as 'comprehension required' for that recipient, shall: + +- If the message with the unknown extension header was a request or a G-PDU, send a Supported Extension Headers Notification to the originator of the GTP-PDU, discard the message and log an error. + +Bits 7 and 8 of the Next Extension Header Type have the following meaning: + +| Bits | | Meaning | +|------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 8 | 7 | | +| 0 | 0 | Comprehension of this extension header is not required. An Intermediate Node shall forward it to any Receiver Endpoint | +| 0 | 1 | Comprehension of this extension header is not required. An Intermediate Node shall discard the Extension Header Content and not forward it to any Receiver Endpoint. Other extension headers shall be treated independently of this extension header. | +| 1 | 0 | Comprehension of this extension header is required by the Endpoint Receiver but not by an Intermediate Node. An Intermediate Node shall forward the whole field to the Endpoint Receiver. | +| 1 | 1 | Comprehension of this header type is required by recipient (either Endpoint Receiver or Intermediate Node) | + +**Figure 5.2.1-2: Definition of bits 7 and 8 of the Extension Header Type** + +An Endpoint Receiver is the ultimate receiver of the GTP-PDU (e.g. an RNC or the GGSN for the GTP-U plane). An Intermediate Node is a node that handles GTP but is not the ultimate endpoint (e.g. an SGSN for the GTP-U plane traffic between GGSN and RNC). + +| Next Extension Header Field Value | Type of Extension Header | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------| +| 0000 0000 | No more extension headers | +| 0000 0001 | Reserved - Control Plane only. | +| 0000 0010 | Reserved - Control Plane only. | +| 0000 0011 | Long PDCP PDU Number. See NOTE 2. | +| 0010 0000 | Service Class Indicator | +| 0100 0000 | UDP Port. Provides the UDP Source Port of the triggering message. | +| 1000 0001 | RAN Container | +| 1000 0010 | Long PDCP PDU Number. See NOTE 3. | +| 1000 0011 | Xw RAN Container | +| 1000 0100 | NR RAN Container | +| 1000 0101 | PDU Session Container. See NOTE 4. | +| 1100 0000 | PDCP PDU Number [4]-[5]. See NOTE 1. | +| 1100 0001 | Reserved - Control Plane only. | +| 1100 0010 | Reserved - Control Plane only. | +| NOTE 1: As an exception to the comprehension rule specified above, for a G-PDU with a Next Extension Header Field set to the value "1100 0000", the SGW shall consider this corresponding extension header as 'comprehension not required'. | | +| NOTE 2: This value shall be used by a source eNB or gNB complying with this release of the specification. | | +| NOTE 3: This value shall not be used by a source eNB or gNB complying with this release of the specification. It may be received from a source eNB complying with an earlier release of the specification, i.e. not supporting the extension header value "0000 0011". | | +| NOTE 4: For a GTP-PDU with several Extension Headers, the PDU Session Container should be the first Extension Header. | | + +**Figure 5.2.1-3: Definition of Extension Header Type** + +### 5.2.2 Extension Header types + +Extension header types marked as "Reserved – Control Plane only" in figure 5.2.1-3 are not used in the GTP user plane. These extension header types are defined in 3GPP TS 29.060 [6]. + +The following clauses define the format of the extension header types applicable to the GTP user plane. + +#### 5.2.2.1 UDP Port + +This extension header may be transmitted in Error Indication messages to provide the UDP Source Port of the G-PDU that triggered the Error Indication. It is 4 octets long, and therefore the Length field has value 1. + +| Octets | Bits | | | | | | | | +|--------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0x01 | | | | | | | | +| 2-3 | UDP Port number | | | | | | | | +| 4 | Next Extension Header Type (note) | | | | | | | | + +NOTE: The value of this field is 0 if no other Extension header follows. + +**Figure 5.2.2.1-1: UDP Port Extension Header** + +#### 5.2.2.2 PDCP PDU Number + +This extension header is transmitted, for example in UTRAN, at SRNS relocation time, to provide the PDCP sequence number of not yet acknowledged N-PDUs. It is 4 octets long, and therefore the Length field has value 1. + +When used during a handover procedure between two eNBs at the X2 interface (direct DL data forwarding) or via the S1 interface (indirect DL data forwarding) in E-UTRAN, bit 8 of octet 2 is spare and shall be set to zero. + +When used during a handover procedure between two NG-RANs at the Xn interface (direct DL data forwarding) or via the N3 interface (indirect DL data forwarding), bits 5-8 of octet 2 are spare and shall be set to zero. + +NOTE 1: The PDCP PDU number field of the PDCP PDU number extension header has a maximum value which requires 15 bits (see 3GPP TS 36.323 [24]); thus, bit 8 of octet 2 is spare. + +NOTE 2: The PDCP PDU number field of the PDCP PDU number extension header has a maximum value which requires 12 bits (see 3GPP TS 38.323 [35]); thus, bit 5-8 of octet 2 are spare. + +| Octets | Bits | | | | | | | | +|--------|-------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0x01 | | | | | | | | +| 2 | PDCP PDU number | | | | | | | | +| 3 | PDCP PDU number. | | | | | | | | +| 4 | Next Extension Header Type (Note 3) | | | | | | | | + +NOTE 3: The value of this field is 0 if no other Extension header follows. + +**Figure 5.2.2.2-1: PDCP PDU Number Extension Header** + +#### 5.2.2.2A Long PDCP PDU Number + +This extension header is used for direct X2 or indirect S1 DL data forwarding during a Handover procedure between two eNBs. This extension header is also used for direct Xn or indirect N3 DL data forwarding during a Handover procedure between two NG-RANs. The Long PDCP PDU number extension header is 8 octets long, and therefore the Length field has value 2. + +The PDCP PDU number field of the Long PDCP PDU number extension header has a maximum value which requires 18 bits (see 3GPP TS 36.323 [24] and 3GPP TS 38.323 [35]). Bit 2 of octet 2 is the most significant bit and bit 1 of octet 4 is the least significant bit, see Figure 5.2.2.2A-1. Bits 8 to 3 of octet 2, and Bits 8 to 1 of octets 5 to 7 shall be set to 0. + +NOTE: A G-PDU which includes a PDCP PDU Number contains either the extension header PDCP PDU Number or Long PDCP PDU Number. + +| Octets | Bits | | | | | | | | | | +|--------|-------------------------------------|---|---|---|---|---|-----------------|---|--|--| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | | +| 1 | 0x02 | | | | | | | | | | +| 2 | Spare | | | | | | PDCP PDU number | | | | +| 3 | PDCP PDU number | | | | | | | | | | +| 4 | PDCP PDU number | | | | | | | | | | +| 5 | Spare | | | | | | | | | | +| 6 | Spare | | | | | | | | | | +| 7 | Spare | | | | | | | | | | +| 8 | Next Extension Header Type (Note 1) | | | | | | | | | | + +NOTE 1: The value of this field is 0 if no other Extension header follows. + +**Figure 5.2.2.2A-1: Long PDCP PDU Number Extension Header** + +#### 5.2.2.3 Service Class Indicator + +This extension header identifies the service class indicator (SCI) associated with the T-PDU carried by the downlink G-PDU. This information may be used by the A/Gb mode GERAN access for improved radio utilisation (see clause 5.3.5.3 of 3GPP TS 23.060 [4]). + +In this version of the specification, this extension header may be transmitted over the Gn/Gp, S5/S8 and S4 interface. An eNodeB, RNC or MME shall ignore this information if received over the S1-U, S12, Iu, S11-U or any other interfaces not defined above, but still shall handle the G-PDU. + +NOTE1: This extension header is also sent over the S1-U, S12, Iu interface and S11-U if the SGW receives the Service Class Indicator from S5/S8 for a UE having a user plane connection with an RNC or an eNodeB. This can happen when the PGW does not have an accurate knowledge of the current RAT of the user e.g. after a handover from GERAN to (E)UTRAN. + +It is 4 octets long and therefore the Length field has the value 1. + +| Octets | Bits | | | | | | | | +|--------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0x01 | | | | | | | | +| 2 | Service Class Indicator | | | | | | | | +| 3 | Spare | | | | | | | | +| 4 | Next Extension Header Type (note) | | | | | | | | + +NOTE: The value of this field is 0 if no other Extension header follows. + +**Figure 5.2.2.3-1: Service Class Indicator Extension Header** + +If the bit 8 of octet 2 is set to 0, this indicates an operator specific Service Class Indicator value is included. Otherwise, it shall indicate that a standardised SCI is included. + +NOTE 2: No standardized SCI value is defined in this release, it is intended to standardize SCIs in a future release. + +Bits 8 to 1 of the octet 2 represent the binary coded value of the SCI, applications with similar Radio Resource Management treatment in GERAN shall be represented by the same value. + +The octet 2 is coded as shown in Table 5.2.2.3-1. + +Bits 8 to 1 of the octet 3 are spare bits and shall be set to zero. + +**Table 5.2.2.3-1: Service Class Indicator** + +| | | +|----------------------------------------|------------------------| +| Service Class Indicator (SCI), octet 2 | | +| Bit | | +| 8 | | +| 0 | Operator-specific SCI | +| Bits | | +| 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 | | +| to | | +| 0 0 0 1 1 1 1 | Operator-specific SCIs | +| 0 0 1 0 0 0 0 | | +| to | | +| 1 1 1 1 1 1 1 | Spare for future use | +| Bit | | +| 8 | | +| 1 | Standardised SCI | +| Bits | | +| 7 6 5 4 3 2 1 | | +| 0 0 0 0 0 0 0 | | +| to | | +| 1 1 1 1 1 1 1 | Spare for future use | + +#### 5.2.2.4 RAN Container + +This extension header may be transmitted in a G-PDU over the X2 user plane interface between the eNBs. The RAN Container has a variable length and its content is specified in 3GPP TS 36.425 [25]. A G-PDU message with this extension header may be sent without a T-PDU. + +| Octets | Bits | | | | | | | | +|-----------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0xn | | | | | | | | +| 2-(4n -1) | RAN Container | | | | | | | | +| 4n | Next Extension Header Type (NOTE) | | | | | | | | + +NOTE: The value of this field is '0' if no other Extension header follows. + +**Figure 5.2.2.4-1: RAN Container Extension Header** + +#### 5.2.2.5 Xw RAN Container + +This extension header may be transmitted in a G-PDU over the Xw user plane interface between the eNB and the WLAN Termination (WT). The Xw RAN Container has a variable length and its content is specified in 3GPP TS 36.465 [27]. A G-PDU message with this extension header may be sent without a T-PDU. + +| Octets | Bits | | | | | | | | +|-----------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0xn | | | | | | | | +| 2-(4n -1) | Xw RAN Container | | | | | | | | +| 4n | Next Extension Header Type (NOTE) | | | | | | | | + +NOTE: The value of this field is '0' if no other Extension header follows. + +**Figure 5.2.2.5-1: Xw RAN Container Extension Header** + +#### 5.2.2.6 NR RAN Container + +This extension header may be transmitted in a G-PDU over the X2-U, Xn-U and F1-U user plane interfaces, within NG-RAN and, for EN-DC, within E-UTRAN. The NR RAN Container has a variable length and its content is specified in 3GPP TS 38.425 [30]. A G-PDU message with this extension header may be sent without a T-PDU. + +| Octets | Bits | | | | | | | | +|-----------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0xn | | | | | | | | +| 2-(4n -1) | NR RAN Container | | | | | | | | +| 4n | Next Extension Header Type (NOTE) | | | | | | | | + +NOTE: The value of this field is '0' if no other Extension header follows. + +**Figure 5.2.2.6-1: NR RAN Container Extension Header** + +#### 5.2.2.7 PDU Session Container + +This extension header shall be transmitted in: + +- G-PDUs over the N3 and N9 user plane interfaces, between NG-RAN and UPF, or between two UPFs; +- G-PDUs over the N3mb and N19mb user plane interfaces, between the MB-UPF and NG-RAN, or between the MB-UPF and UPF; and +- in End Marker packets over data forwarding tunnels in 5GS, for data forwarding between 5GS and EPS. + +The PDU Session Container has a variable length and its content is specified in 3GPP TS 38.415 [31]. + +A G-PDU message with this extension header may be sent without a T-PDU, e.g. when the G-PDU message is used as a dummy GTP-U packet for QoS Monitoring per QoS flow as specified in clause 5.33.3.2 of 3GPP TS 23.501 [28], where the PDU Session Container contains QoS Monitoring related parameters. An Intermediate UPF between the PSA UPF and the NG-RAN shall forward any received such G-PDU messages together with the GTP-U PDU Session Container extension header to the next GTP-U entity. + +| Octets | Bits | | | | | | | | +|-----------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | 0xn | | | | | | | | +| 2-(4n -1) | PDU Session Container | | | | | | | | +| 4n | Next Extension Header Type (NOTE) | | | | | | | | + +NOTE: The value of this field is '0' if no other Extension header follows. + +Figure 5.2.2.7-1: PDU Session Container Extension Header + +# 6 GTP-U Message Formats + +## 6.1 General + +GTP-U defines a set of messages between the two ends of the user plane of the interfaces Iu, Gn, Gp, S1-U, S11-U, S2a, S2b, S4, S5, S8, S12, X2, M1, Sn, Xn, N3, N9 and N19. + +GTP-U messages are sent across a GTP user plane tunnel. A GTP-U message may be either a signalling message across the user plane tunnel, or a G-PDU message. + +- GTP-U signalling messages are used for user plane path management, or for user plane tunnel management. +- G-PDU is a vanilla user plane message, which carries the original packet (T-PDU). In G-PDU message, GTP-U header is followed by a T-PDU. + +A T-PDU is an original packet, for example an IP datagram, Ethernet frame or unstructured PDU Data, from an UE, or from a network node in an external packet data network. + +The complete range of message types defined for GTPv1 is defined in 3GPP TS 29.060 [6]. The table below includes those applicable to GTP user plane. The three columns to the right define which of the three protocols sharing the common header of GTPv1 (GTP-C, GTP-U or GTP') might implement the specific message type. + +Table 6.1-1: Messages in GTP-U + +| Message Type value (Decimal) | Message | Reference | GTP-C | GTP-U | GTP' | +|------------------------------|-------------------------------------------------------|-----------|-------|-------|------| +| 1 | Echo Request | | X | X | x | +| 2 | Echo Response | | X | X | x | +| 3-25 | Reserved in 3GPP TS 32.295 [8] and 3GPP TS 29.060 [6] | | | | | +| 26 | Error Indication | | | X | | +| 27-30 | Reserved in 3GPP TS 29.060 [6] | | | | | +| 31 | Supported Extension Headers Notification | | X | X | | +| 32-252 | Reserved in 3GPP TS 29.060 [6] | | | | | +| 253 | Tunnel Status | | | X | | +| 254 | End Marker | | | X | | +| 255 | G-PDU | | | X | | + +## 6.2 Presence requirements of Information Elements + +As specified in 3GPP TS 29.060 [6], clause 7.1.1. + +# 7 GTP-U Messages + +## 7.1 General + +GTP-U Tunnels are used to carry encapsulated T-PDUs and signalling messages between a given pair of GTP-U Tunnel Endpoints. The Tunnel Endpoint ID (TEID) which is present in the GTP header shall indicate which tunnel a particular T-PDU belongs to. In this manner, packets are multiplexed and de-multiplexed by GTP-U between a given pair of Tunnel Endpoints. The TEID value to be used in the TEID field shall be negotiated for instance during the GTP-C Create PDP Context and the RAB assignment procedures that take place on the control plane. + +For IP Multicast Distribution of User Plane Data for MBMS and MBS: + +- the TEID value to be used in the TEID field shall be allocated at the source Tunnel Endpoint and signalled to the destination Tunnel Endpoint as specified in clause 4.2.6; +- because of the point-to-multipoint characteristics of IP Multicast Distribution, the path management messages Echo Request and Echo Response, the tunnel management message Error Indication, the message Supported Extension Headers Notification and the message End Marker shall not be used. + +User payload is transmitted in G-PDU packets. A G-PDU is a packet including a GTP-U header and a T-PDU. A G-PDU may include extension headers. A G-PDU shall not include any information element. + +GTP-U signalling messages are classified into path management messages, defined in clause 7.2 of the present document, and tunnel management messages, defined in clause 7.3 of the present document. + +## 7.2 Path Management Messages + +### 7.2.1 Echo Request + +A GTP-U peer may send an Echo Request on a path to the other GTP-U peer to find out if it is alive (see clause Path Failure). Echo Request messages may be sent for each path in use. A path is considered to be in use if at least one PDP context, EPS Bearer, PDU Session, MBMS UE context, or MBMS bearer context uses the path to the other GTP-U peer. When and how often an Echo Request message may be sent is implementation specific but an Echo Request shall not be sent more often than every 60 s on each path. This doesn't prevent resending an Echo Request with the same sequence number according to the T3-RESPONSE timer. + +Even if there is no path in use, a GTP-U peer shall be prepared to receive an Echo Request at any time and it shall reply with an Echo Response. The optional Private Extension contains vendor or operator specific information. + +Handling of the Recovery Time Stamp is specified in 3GPP TS 23.007 [3] and 3GPP TS 23.527 [33]. + +**Table 7.2.1-1: Information Elements in an Echo Request** + +| Information element | Presence requirement | Reference | +|---------------------|----------------------|-----------| +| Recovery Time Stamp | Optional | 8.7 | +| Private Extension | Optional | 8.6 | + +For the GTP-U tunnel setup between two nodes for forwarding user traffic, e.g. between eNodeBs for direct forwarding over X2, Echo Request path maintenance message shall not be sent except if the forwarded data and the normal data are sent over the same path. + +### 7.2.2 Echo Response + +The message shall be sent as a response to a received Echo Request. + +The Restart Counter value in the Recovery information element shall not be used, i.e. it shall be set to zero by the sender and shall be ignored by the receiver. The Recovery information element is mandatory due to backwards compatibility reasons. + +Handling of the Recovery Time Stamp is specified in 3GPP TS 23.007 [3] and 3GPP TS 23.527 [33]. The optional Private Extension contains vendor or operator specific information. + +**Table 7.2.2-1: Information Elements in an Echo Response** + +| Information element | Presence requirement | Reference | +|---------------------|----------------------|-----------| +| Recovery | Mandatory | 8.2 | +| Recovery Time Stamp | Optional | 8.7 | +| Private Extension | Optional | 8.6 | + +### 7.2.3 Supported Extension Headers Notification + +This message indicates a list of supported Extension Headers that the GTP entity on the identified IP address can support. This message is sent only in case a GTP entity was required to interpret a mandatory Extension Header but the GTP entity was not yet upgraded to support that extension header. The GTP endpoint sending this message is marked as not enabled to support some extension headers (as derived from the supported extension header list). The peer GTP entity may retry to use all the extension headers with that node, in an attempt to verify it has been upgraded. Implementers should avoid repeated attempts to use unknown extension headers with an endpoint that has signalled its inability to interpret them. + +**Table 7.2.3-1: Information Elements in Supported Extension Headers Notification** + +| Information element | Presence requirement | Reference | +|----------------------------|----------------------|-----------| +| Extension Header Type List | Mandatory | 8.5 | + +## 7.3 Tunnel Management Messages + +### 7.3.1 Error Indication + +When a GTP-U node receives a G-PDU for which no EPS Bearer context, PDP context, PDU Session, MBMS Bearer context, or RAB exists, the GTP-U node shall discard the G-PDU. If the TEID of the incoming G-PDU is different from the value 'all zeros' the GTP-U node shall also return a GTP error indication to the originating node. GTP entities may include the "UDP Port" extension header (Type 0x40), in order to simplify the implementation of mechanisms that can mitigate the risk of Denial-of-Service attacks in some scenarios. + +Handling of the received Error Indication and the Recovery Time Stamp is specified in 3GPP TS 23.007 [3] and 3GPP TS 23.527 [33]. + +The information element Tunnel Endpoint Identifier Data I shall be the TEID fetched from the G-PDU that triggered this procedure. + +The information element GTP-U Peer Address shall be the destination address (e.g. destination IP address, MBMS Bearer Context) fetched from the original user data message that triggered this procedure. A GTP-U Peer Address can be a GGSN, SGSN, RNC, PGW, SGW, ePDG, eNodeB, TWAN, MME, gNB, N3IWF, or UPF address. The TEID and GTP-U peer Address together uniquely identify the related PDP context, RAB, PDU session or EPS bearer in the receiving node. + +The optional Private Extension contains vendor or operator specific information. + +**Table 7.3.1-1: Information Elements in an Error Indication** + +| Information element | Presence requirement | Reference | +|-----------------------------------|----------------------|-----------| +| Tunnel Endpoint Identifier Data I | Mandatory | 8.3 | +| GTP-U Peer Address | Mandatory | 8.4 | +| Recovery Time Stamp | Optional | 8.7 | +| Private Extension | Optional | 8.6 | + +### 7.3.2 End Marker + +#### 7.3.2.1 General + +The End Marker message indicates the end of the payload stream on a given tunnel, i.e. a G-PDU that arrives after an End Marker message on this tunnel may be silently discarded. Table 7.3.2.1-1 specifies the information element included in the End Marker message. + +If an End Marker message is received with a TEID for which there is no context, then the receiver shall ignore this message. + +The optional Private Extension contains vendor or operator specific information. + +**Table 7.3.2.1-1: Information Elements in End Marker message** + +| Information element | Presence requirement | Reference | +|---------------------|----------------------|-----------| +| Private Extension | Optional | 8.6 | + +#### 7.3.2.2 End Marker in EPS + +The End Marker message(s) shall be sent after sending the last G-PDU that needs to be sent on a GTP-U tunnel as specified in 3GPP TS 23.401 [5] or after receiving an End Marker Indication as specified in clause 5.7.1 of 3GPP TS 23.402 [23]. + +The End Marker message(s) shall be sent for each GTP-U tunnel, except for the case of an E-UTRAN Initiated E-RAB modification procedure. During an E-UTRAN Initiated E-RAB modification procedure, the SGW shall send End marker message(s) to the eNodeB on the old S1-U tunnel for the tunnel(s) that are switched, i.e. if the S1 eNodeB F-TEID of the GTP-U tunnel provided by the MME in a Modify Bearer Request or Modify Access Bearer Request is not the same as the one previously stored in the SGW. Each GTP-U tunnel is identified with a respective TEID value in the GTP-U header. + +An MME may receive End Marker packets over an S11-U tunnel during the following procedures: + +- Inter-MME TAU procedure; +- Establishment of S1-U bearer during Data Transport in Control Plane CIoT EPS optimisation. + +The MME shall discard the End Marker packets. The MME may also initiate the release of the corresponding S11-U resources; however the release of the S11-U resources is implementation dependent. + +#### 7.3.2.3 End Marker in 5GS + +The End Marker message(s) shall also be sent after sending the last G-PDU that needs to be sent on a GTP-U tunnel or after receiving an End Marker Indication as specified in 3GPP TS 23.501 [28] and 3GPP TS 23.502 [29]. End marker packets sent over data forward tunnels in 5GS, for data forwarding between 5GS and EPS, shall be sent with the PDU Session Container extension header including the Qos Flow Identifier of one of the QoS flows mapped to the same E-RAB. + +For QoS Flows transferred to and from Secondary RAN Node in Dual Connectivity (see clause 4.14.1 of 3GPP TS 23.502 [29]), end marker packets shall be sent over old tunnel for the transferred QoS flows without the Qos Flow Identifier included as specified in 3GPP TS 37.340 [38]. + +End Marker messages shall not be sent over the N19 interface. + +### 7.3.3 Tunnel Status + +The Tunnel Status message is optional. A GTP-U entity, if it supports the message, may send one or more Tunnel Status message to the peer GTP-U entity to provide the status information related to the corresponding GTP-U tunnel in the sending GTP-U entity. Table 7.3.2.1-1 specifies the information element included in the Tunnel Status message. + +If a Tunnel Status message is received with a TEID for which there is no context, or the message is not supported, then the receiver shall ignore this message. + +The optional Private Extension contains vendor or operator specific information. + +**Table 7.3.3-1: Information Elements in Tunnel Status message** + +| Information element | Presence requirement | Reference | +|---------------------------------|----------------------|-----------| +| GTP-U Tunnel Status Information | Mandatory | 8.7 | +| Private Extension | Optional | 8.6 | + +# 8 Information Elements + +## 8.1 Information Element Types + +A GTP-U Signalling message may contain several information elements. The TLV (Type, Length, Value) or TV (Type, Value) encoding format shall be used for the GTP information elements. The information elements shall be sorted, with the Type fields in ascending order, in the signalling messages. The Length field contains the length of the information element excluding the Type and Length field. + +For all the length fields, bit 8 of the lowest numbered octet is the most significant bit and bit 1 of the highest numbered octet is the least significant bit. + +Within information elements, certain fields may be described as spare. These bits shall be transmitted with the value defined for them. To allow for future features, the receiver shall not evaluate these bits. + +The most significant bit in the Type field is set to 0 when the TV format is used and set to 1 for the TLV format. + +![Diagram showing the Type field structure for TV and TLV formats. It consists of two octets. The top octet is for TV format, with bit 8 set to 0 and bits 7-1 labeled 'Type -> TV format'. The bottom octet is for TLV format, with bit 8 set to 1 and bits 7-1 labeled 'Type -> TLV format'.](15e4a144a88176b71ea3eff2722253b0_img.jpg) + +| | | Bits | | | | | | | | +|--------|--|------|-------------------|---|---|---|---|---|---| +| Octets | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | | 0 | Type -> TV format | | | | | | | + + + +| | | Bits | | | | | | | | +|--------|--|------|--------------------|---|---|---|---|---|---| +| Octets | | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | | 1 | Type -> TLV format | | | | | | | + +Diagram showing the Type field structure for TV and TLV formats. It consists of two octets. The top octet is for TV format, with bit 8 set to 0 and bits 7-1 labeled 'Type -> TV format'. The bottom octet is for TLV format, with bit 8 set to 1 and bits 7-1 labeled 'Type -> TLV format'. + +Figure 8.1-1: Type field for TV and TLV format + +The complete range of information element types defined for GTPv1 is defined in 3GPP TS 29.060 [6]. The table below includes those applicable to GTP user plane. + +Table 8.1-1: Information Elements + +| IE Type Value | Format | Information Element | Reference | +|---------------|--------|-----------------------------------|-----------| +| 0-13 | TV | Reserved in 3GPP TS 29.060 [6] | | +| 14 | TV | Recovery | 8.2 | +| 15 | TV | Reserved in 3GPP TS 29.060 [6] | | +| 16 | TV | Tunnel Endpoint Identifier Data I | 8.3 | +| 17-132 | TV/TLV | Reserved in 3GPP TS 29.060 [6] | | +| 133 | TLV | GSN Address. See NOTE 1. | 8.4 | +| 134-140 | TLV | Reserved in 3GPP TS 29.060 [6] | | +| 141 | TLV | Extension Header Type List | 8.5 | +| 142-229 | TLV | Reserved in 3GPP TS 29.060 [6] | | +| 230 | TLV | GTP-U Tunnel Status Information | 8.7 | +| 231 | TLV | Recovery Time Stamp | 8.7 | +| 232-237 | TLV | Spare. For future use. | | +| 238-254 | TLV | Reserved in 3GPP TS 29.060 [6] | | +| 255 | TLV | Private Extension | 8.6 | + +NOTE 1: This IE is named as " GTP-U Peer Address" in the rest of this specification. + +## 8.2 Recovery + +The value of the restart counter shall be set to 0 by the sending entity and ignored by the receiving entity. This information element is used in GTP user plane due to backwards compatibility reasons. + +![](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|---------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 14 (Decimal) | | | | | | | | +| 2 | Restart counter | | | | | | | | + +Figure 8.2-1: Restart Counter Information Element + +## 8.3 Tunnel Endpoint Identifier Data I + +The Tunnel Endpoint Identifier Data I information element contains the Tunnel Endpoint Identifier used by a GTP entity for the user plane. + +![](805c475f0859e607af0530ba43194bf1_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|-----------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 16 (Decimal) | | | | | | | | +| 2 - 5 | Tunnel Endpoint Identifier Data I | | | | | | | | + +Figure 8.3-1: Tunnel Endpoint Identifier Data I Information Element + +## 8.4 GTP-U Peer Address + +The GTP-U peer Address information element contains the address of a GTP. The Length field may have only two values (4 or 16) that determine if the Value field contains IPv4 or IPv6 address. + +The IPv4 address structure is defined in RFC 791 [10]. + +The IPv6 address structure is defined in RFC 4291 [11]. + +The encoded address might belong not only to a GSN, but also to an RNC, eNodeB, SGW, ePDG, gNB, N3IWF, UPF, PGW or TWAN. + +![](9a159e2112eac7be06bdb97e84a0c49a_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 133 (Decimal) | | | | | | | | +| 2-3 | Length | | | | | | | | +| 4-n | IPv4 or IPv6 Address | | | | | | | | + +Figure 8.4-1: GTP-U Peer Address Information Element + +## 8.5 Extension Header Type List + +This information element contains a list of 'n' Extension Header Types. The length field is set to the number of extension header types included. + +![](28d75f39a24203712ee907b32cf0bbe5_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 141 (Decimal) | | | | | | | | +| 2 | Length (value= n) | | | | | | | | +| 3-n+2 | Extension types list | | | | | | | | + +Figure 8.5-1: Extension Header Type List Information Element + +## 8.6 Private Extension + +The Private Extension information element contains vendor specific information. The Extension Identifier is a value defined in the Private Enterprise number list in the most recent "Assigned Numbers" RFC (RFC 1700 or later). + +This is an optional information element that may be included in any GTP Signalling message. A signalling message may include more than one information element of the Private Extension type. + +![](f2ea0f64a770b22b902820457d262265_img.jpg) + +| Octets | Bits | | | | | | | | +|--------|----------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = 255 (Decimal) | | | | | | | | +| 2-3 | Length | | | | | | | | +| 4-5 | Extension Identifier | | | | | | | | +| 6-m | Extension Value | | | | | | | | + +Figure 8.6-1: Private Extension Information Element + +## 8.7 GTP-U Tunnel Status Information + +The GTP-U Tunnel Status Information contains the status information related to the corresponding GTP-U tunnel in the sending GTP-U entity. + +![](68d8089266ace7197304b43dcaf5d08e_img.jpg) + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|------| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 to 2 | Type = 230 (decimal) | | | | | | | | +| 3 to 4 | Length = n | | | | | | | | +| 5 | Spare | | | | | | | SPOC | +| 6 to (n+4) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.7-1: GTP-U Tunnel Status Information + +The octet 5 shall be encoded as follows: + +- Bit 1 – SPOC (Start Pause Of Charging): when set to "1", this indicates a request to the receiving GTP-U entity to stop usage measurement for the URR(s) with the Applicable for Start of Pause of Charging Flag set to "1" as specified in 3GPP TS 29.244 [39] for the PFCP session (identified by the IP address and TEID of the header of the Tunnel Status message). The GTP-U entity shall forward Tunnel Status message to the upstream GTP-U entity if it is not a PSA UPF or PGW-U connecting to N6/SGi interface. +- Bit 2 to 8 – Spare, for future use and set to "0". + +## 8.7 Recovery Time Stamp + +The Recovery Time Stamp IE is coded as shown in Figure 8.7-1. It indicates the UTC time when the GTP-U entity started. Octets 4 to 7 are encoded in the same format as the first four octets of the 64-bit timestamp format as defined in clause 6 of IETF RFC 5905 [41]. + +NOTE: The encoding is defined as the time in seconds relative to 00:00:00 on 1 January 1900. + +| Octets | Bits | | | | | | | | +|------------|------------------------------------------------------------|---|---|---|---|---|---|---| +| | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | +| 1 | Type = aa (decimal) | | | | | | | | +| 2 to 3 | Length = n | | | | | | | | +| 4 to 7 | Recovery Time Stamp value | | | | | | | | +| 8 to (n+3) | These octet(s) is/are present only if explicitly specified | | | | | | | | + +Figure 8.7-1: Recovery Time Stamp + +# 9 Error Handling + +## 9.1 Protocol Errors + +As specified in 3GPP TS 29.060 [6], clauses 11.1. + +## 9.2 Path Failure + +Path failure handling procedures are specified in 3GPP TS 23.007 [17] and 3GPP TS 23.527 [33]. + +# 10 Security + +Network domain security is specified in 3GPP TS 33.102 [21] and 3GPP TS 33.401 [22]. + +# 11 Reliable Delivery of Signalling Messages + +Each path maintains a queue with signalling messages to be sent to the peer. The message at the front of the queue, if it is a request for which a response has been defined, shall be sent with a Sequence Number, and shall be held in a path list until a response is received. Each path has its own list. The Sequence Number shall be unique for each outstanding request message sourced from the same IP/UDP endpoint. + +The T3-RESPONSE timer shall be started when a signalling request message (for which a response has been defined) is sent. A signalling message request or response has probably been lost if a response has not been received before the T3-RESPONSE timer expires. At the expiry of the timer the request is retransmitted if the total number of request attempts is less than N3-REQUESTS times. + +All received request messages shall be responded to and all response messages associated with a certain request shall always include the same information. Duplicated response messages shall be discarded. A response message without a matching outstanding request should be considered as a duplicate. + +If a GTP protocol entity is not successful with the transfer of a signalling message, it shall inform the upper layer of the unsuccessful transfer so that the controlling upper entity may take the necessary measures. + +# --- 12 GTP Parameters + +## 12.1 General + +The GTP system parameters defined here and their recommended values shall not be fixed, but shall be possible to configure as described in clause 'Reliable delivery of messages'. + +## 12.2 Timers + +The timer T3-RESPONSE holds the maximum wait time for a response of a request message. + +## 12.3 Others + +The counter N3-REQUESTS holds the maximum number of attempts made by GTP to send a request message. The recommended value is 5. + +# --- 13 Tunnelling Scenarios + +## 13.1 General + +There are user packets sent between network nodes without a GTP-U reference point defined. The scenarios and applicability of GTP-U tunnelling are described in the following clauses. + +## 13.2 Tunnelling between SGWs + +GTP T-PDU tunnelling is applicable from the old SGW to the new S GW only when indirect forwarding is applicable during a S1-based Handover procedure or inter-RAT handover procedure with SGW Relocation, as described in the 3GPP TS 23.401 [5]. For the GTP-U tunnel setup between SGWs, path maintenance messages do not need to be sent. + +GTP T-PDU tunnelling is applicable from the old SGW to the forwarding SGW during a TAU/RAU with SGW change procedure when indirect data forwarding is used to forward DL data buffered in the old SGW to the UE via the forwarding SGW, as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.3 Transfer of the user plane data between PDN GWs + +GTP shall not specify tunnelling between PDN GWs. Transfer of UE-to-UE traffic between PDN GWs shall use the SGi interface. + +## 13.4 Tunnelling between SGSNs + +T-PDUs, stored in the old SGSN and not yet sent to the MS, shall be tunnelled to the new SGSN as a part of the Inter SGSN Routeing Update procedure described in 3GPP TS 23.060 [4]. Some T-PDUs may still be on their way from the GGSN/PGW to the old SGSN because they have been sent before the tunnel change. These T-PDUs shall also be tunnelled to the new SGSN. + +For intersystem SRNS Relocation, the establishment of the GTP tunnel(s) for the forwarding of G-PDUs is as described in the 3GPP TS 23.121 [13] and in the 3GPP TS 23.060 [4] specifications. + +For PS Handover, the establishment of the GTP tunnel(s) for the forwarding of G-PDUs is as described in the 3GPP TS 43.129 [14]. + +The GTP T-PDU tunnelling between SGSNs is applicable also for RAU interaction with a Gn/Gp SGSN when forwarding DL data buffered in the old Gn/Gp SGSN to the UE, via the new SGSN (e.g. when direct tunnel is not established) as described in the 3GPP TS 23.060 [4]. + +## 13.5 Tunnelling between Source RNC and Target RNC + +For the 3G-3G SRNS Relocation, the establishment of the GTP tunnel for the forwarding of G-PDUs between source and target RNC, is as described in the 3GPP TS 23.121 [13] and in the 3GPP TS 23.060 [4] specifications. + +## 13.6 Transfer of the user plane data between GGSNs + +GTP shall not specify tunnelling between GGSNs. Transfer of MS-to-MS traffic between GGSNs shall use the Gi interface. + +## 13.7 Tunnelling between RNC and eNodeB + +GTP T-PDU tunnelling is applicable between RNC and eNodeB during an inter-RAT handover between E-UTRAN and UTRAN Iu mode procedure as described in the 3GPP TS 23.401 [5]. + +## 13.8 Tunnelling between SGSN and eNodeB + +GTP T-PDU tunnelling is applicable between SGSN and eNodeB during an inter-RAT handover between E-UTRAN and GERAN A/Gb mode/UTRAN Iu mode procedure as described in the 3GPP TS 23.401 [5]. + +GTP T-PDU tunnelling between SGSN and eNodeB is applicable also for a TAU interaction with a Gn/Gp SGSN when forwarding DL data buffered in the old Gn/Gp SGSN to the UE via the target eNodeB, if such forwarding is supported by the eNodeB as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.9 Tunnelling between Source eNodeB and Target eNodeB + +GTP T-PDU tunnelling is applicable between eNodeBs during an X2-based handover and E-UTRAN initiated E-RAB modification procedure as described in the 3GPP TS 23.401 [5]. + +## 13.10 Tunnelling between SGSN and RNC + +GTP T-PDU tunnelling between SGSN and RNC is applicable also for a TAU interaction with a Gn/Gp SGSN when forwarding DL data buffered in the old Gn/Gp SGSN to the UE, via the new RNC (e.g. when direct tunnel is established), if such forwarding is supported by the RNC as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.11 Tunnelling between SGSN and SGW + +GTP T-PDU tunnelling is applicable from the old Gn/Gp SGSN to the forwarding SGW during a TAU/RAU interaction with a Gn/Gp SGSN when indirect data forwarding is used to forward DL data buffered in the old Gn/Gp SGSN to the UE via the forwarding SGW, as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.12 Tunnelling between SGW and eNodeB + +GTP T-PDU tunnelling between SGW and eNodeB is applicable also for a TAU with SGW change procedure when forwarding DL data buffered in the old SGW to the UE via the target eNodeB, if such forwarding is supported by the eNodeB as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.13 Tunnelling between SGW and RNC + +GTP T-PDU tunnelling between SGW and RNC is applicable also for a RAU with SGW change procedure when forwarding DL data buffered in the old SGW to the UE via the new RNC when Direct Tunnel is used at the target side, if such forwarding is supported by the RNC as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +## 13.14 Tunnelling between SGW and SGSN + +GTP T-PDU tunnelling between SGW and SGSN is applicable also for a RAU with SGW change procedure when forwarding DL data buffered in the old SGW to the UE via the new SGSN when Direct Tunnel is not used at the target side as described in the clause 5.3.3.1A of 3GPP TS 23.401 [5]. + +# Annex A (Normative): PDU session user plane protocol over N9, N3mb and N19mb + +The PDU session user plane protocol shall be supported over the N9, N3mb and N19mb interface as specified in 3GPP TS 38.415 [31]. + +# Annex B (informative): Change history + +| Date | TSG # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +|---------|-------|-----------|------|-----|-----|-------------------------------------------------------------------|--------| +| 2008-12 | CT#42 | CP-080716 | | | | V2.0.0 approved in CT#42 | 8.0.0 | +| 2009-03 | CT#43 | CP-090048 | 0001 | 1 | | Correction on GTP-U path failure | 8.1.0 | +| | | | 0002 | | | UDP Port Extension Header | | +| | | | 0003 | 1 | | Correction to IP support | | +| | | | 0006 | | | Handling of End Marker packet | | +| 2009-06 | CT#44 | CP-090481 | 0007 | 3 | | GTP-U tunnelling over X2 | 8.2.0 | +| | | | 0008 | 2 | | GTP-U updates for MBMS HSPA Evolution | | +| 2009-09 | CT#45 | CP-090539 | 0010 | 1 | | Forwarding Tunnel Error Indication handling | 8.3.0 | +| | | | 0011 | 1 | | Clarification on the usage of Echo Request | | +| | | | 0012 | 2 | | Clarification to the Sequence Number usage in EPC | | +| | | | 0014 | 3 | | Updating the Error Indication clause | | +| | | | 0016 | | | Eliminating Editor's Notes | | +| | | | 0018 | 1 | | Path Failure text correction | | +| | | | 0019 | 1 | | Support of NDS/IP for LTE | | +| 2009-09 | CT#45 | CP-090559 | 0013 | 1 | | MBMS for EPS support in GTPv1-U | 9.0.0 | +| 2009-12 | CT#46 | CP-090773 | 0023 | 2 | | End Marker in S1 based handover and Inter RAT handover procedures | 9.1.0 | +| | | | 0025 | | | GTP-U sequence number handling | | +| 2010-03 | CT#47 | CP-100023 | 0027 | 1 | | Sequence Number corrections | 9.2.0 | +| 2010-06 | CT#48 | CP-100287 | 0028 | 1 | | Message applicability of MBMS in GTP-U | 9.3.0 | +| 2010-12 | CT#50 | CP-100686 | 0031 | 1 | | Addition of GTP-U interface over S2b | 10.0.0 | +| | | | 0033 | 2 | | End Marker message | | +| | | | 0035 | 1 | | Echo Request & Echo Response | | +| 2011-03 | CT#51 | CP-110258 | 0037 | 2 | | TEID value 0 for GTP-U tunnel | 10.1.0 | +| | | | 0038 | 3 | | GTP-U protocol missing information | | +| | | | 0039 | | | Scope of GTPv1 | | +| 2011-06 | CT#52 | CP-110374 | 0040 | | | eNB Error Indication Handling | 10.2.0 | +| | | | 0042 | 1 | | Addition of the MBMS reference points | | +| 2011-09 | CT#53 | CP-110567 | 0044 | | | User plane path failure handling | 10.3.0 | +| 2011-09 | CT#53 | CP-110580 | 0043 | | | Default inner MTU size | 11.0.0 | +| | | CP-110577 | 0045 | 1 | | Correction to references | | +| 2011-12 | CT#54 | CP-110810 | 0046 | 1 | | Add the definition of C-TEID | 11.1.0 | +| | | | 0048 | 1 | | Dynamic allocation of UDP source ports | | +| | | | 0049 | | | Requirement for sending Error Indication | | +| 2012-03 | CT#55 | CP-120036 | 0050 | | | Tunnelling between eNodeB and RNC | 11.2.0 | +| | | CP-120036 | 0053 | 1 | | GTP-U header | | +| | | | 0052 | 1 | | Addition of GTP based S2a | | +| 2012-06 | CT#56 | | 0054 | | | Tunnelling Scenarios | 11.3.0 | +| 2012-09 | CT#57 | CP-120682 | 0059 | 6 | | New extension header in GTP-U for SIRIG | 11.4.0 | +| 2012-12 | CT#58 | CP-120751 | 0060 | 2 | | Length of PDCP PDU number | 11.5.0 | +| | | CP-120735 | 0061 | - | | Removal of editor's note in extension header in GTP-U for SIRIG | | +| 2013-03 | CT#59 | CP-130021 | 0062 | - | | Clarification on support of GTP-U over the S2a interface | 11.6.0 | +| 2014-09 | CT#65 | CP-140521 | 0064 | 2 | | Introduction of Dual Connectivity Function | 12.0.0 | +| | | | 0065 | - | | Correct the ambiguous GTP-U PDU | | +| 2014-12 | CT#66 | CP-140789 | 0067 | 1 | | Definition of RAN Container for flow control during X2UP handover | 12.1.0 | +| | | CP-140972 | 0068 | 1 | | End Marker used in PMIP-based S5/S8 case | | +| | | CP-140972 | 0069 | 2 | | Correct the GSN Address IE name | | +| 2015-09 | CT#69 | CP-150454 | 0071 | 2 | | Tunnelling scenarios for supporting High Latency communication | 13.0.0 | +| | | CP-150448 | 0072 | 3 | | G-PDU extension header handling | | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------|--------| +| 2016-03 | CT#71 | CP-160033 | 0074 | 1 | | S11-U tunneling for MO/MT data transport in control plane (SGi based) | 13.1.0 | +| | | CP-160033 | 0075 | 1 | | End Marker handling by MME | | +| | | CP-160038 | 0076 | 1 | | Comprehension requirement for PDCP PDU Number | | +| | | CP-160040 | 0077 | 2 | | 18 bits PDCP PDU Number | | +| 2016-06 | CT#72 | CP-160228 | 0078 | 1 | | Handling of End Marker packets over S11-U by MME | 13.2.0 | +| 2017-03 | CT#75 | CP-170032 | 0080 | 1 | | Support for transport level packet marking over GTP-U interfaces | 14.0.0 | +| 2017-06 | CT#76 | CP-171019 | 0082 | - | | Xw RAN Container for LTE-WLAN Aggregation (LWA) | 14.1.0 | +| 2017-09 | CT#77 | CP-172025 | 0083 | 1 | | GTP-U Extension Header Handling | 15.0.0 | +| 2017-12 | CT#78 | CP-173034 | 0084 | 1 | | Supports N3, N9 and Xn userplane interface | 15.1.0 | +| 2018-03 | CT#79 | CP-180026 | 0086 | 1 | | New GTP-U extension header for 5GS | 15.2.0 | +| 2018-03 | CT#79 | CP-180026 | 0087 | 1 | | Support End Marker in 5GS | 15.2.0 | +| 2018-03 | CT#79 | CP-180026 | 0089 | 1 | | New GTP-U Extension Header for the PDU Session Container | 15.2.0 | +| 2018-03 | CT#79 | CP-180023 | 0088 | 1 | | Unpredictability of GTP TEID for PGW GTP-U | 15.2.0 | +| 2018-06 | CT#80 | CP-181128 | 0092 | 1 | | Change of Comprehension for 'Long PDCP PDU Number' extension header | 15.3.0 | +| 2018-06 | CT#80 | CP-181132 | 0093 | 2 | | Fix the location of the PDU Session Container | 15.3.0 | +| 2018-06 | CT#80 | CP-181132 | 0095 | - | | User Plane Protocol over N9 | 15.3.0 | +| 2018-09 | CT#81 | CP-182084 | 0096 | 1 | | General 5G Corrections | 15.4.0 | +| 2018-09 | CT#81 | CP-182084 | 0097 | 2 | | GTP-U Tunnel Endpoint Description | 15.4.0 | +| 2018-09 | CT#81 | CP-182084 | 0099 | 1 | | DSCP Marking on IPv4 Outer Header based on 5QI/ARP | 15.4.0 | +| 2018-12 | CT#82 | CP-183092 | 0100 | 1 | | T-PDU content | 15.5.0 | +| 2018-12 | CT#82 | CP-183092 | 0101 | - | | Referencing F1-U in the Introduction clause | 15.5.0 | +| 2018-12 | CT#82 | CP-183092 | 0102 | - | | Data forwarding between 5GS and EPS | 15.5.0 | +| 2018-12 | CT#82 | CP-183092 | 0103 | - | | Receiving packets from multiple remote GTP-U endpoints | 15.5.0 | +| 2019-09 | CT#85 | CP-192116 | 0104 | 1 | | Error Indication and Path Failure in 5GS | 15.6.0 | +| 2019-12 | CT#85 | CP-193024 | 0108 | 1 | | PDCP PDU Number | 15.7.0 | +| 2019-12 | CT#85 | CP-193041 | 0109 | - | | Implementing the conclusions of TR 29.892 for GTP-U | 16.0.0 | +| 2019-12 | CT#85 | CP-193050 | 0107 | - | | N19 user plane interface for 5G VN group communication | 16.0.0 | +| 2020-09 | CT#89e | CP-202099 | 0110 | 1 | | End marker in EPS and 5GS | 16.1.0 | +| 2021-03 | CT#91e | CP-210056 | 0114 | 1 | | End Marker in NG-RAN initiated QoS Flow mobility | 16.2.0 | +| 2021-03 | CT#91e | CP-210033 | 0111 | 1 | | Tunnel Status notifying Pause of Charging | 17.0.0 | +| 2021-09 | CT#93e | CP-212035 | 0115 | - | B | GTP-U tunneling for N3mb and N19mb | 17.1.0 | +| 2022-03 | CT#95e | CP-220037 | 0116 | 1 | B | Detecting of the restart of a GTP-U entity | 17.2.0 | +| 2022-06 | CT#96 | CP-221023 | 0117 | - | F | PDU Session Container used over N3mb and N19mb | 17.2.0 | +| 2022-06 | CT#96 | CP-221046 | 0119 | - | F | A G-PDU message without a T-PDU | 17.3.0 | +| 2022-09 | CT#97e | CP-222031 | 0120 | 1 | F | MB-UPF | 17.4.0 | +| 2023-06 | CT#100 | CP-231066 | 0125 | - | F | Adding W1-U interface | 18.0.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29292/raw.md b/marked/Rel-18/29_series/29292/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..8541001ffe5ff304c9d83e2276a085182a15121c --- /dev/null +++ b/marked/Rel-18/29_series/29292/raw.md @@ -0,0 +1,2648 @@ + + +# 3GPP TS 29.292 V18.1.0 (2024-06) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core network and Terminals; Interworking between the IP Multimedia (IM) Core Network (CN) Subsystem (IMS) and MSC Server for IMS Centralized Services (ICS) (Release 18)** --- + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a stylized '5G' in black with a green wave-like graphic above the 'G', and the word 'ADVANCED' in smaller black letters to the right. + +5G Advanced logo + +## --- **Keywords** + +GSM, LTE, UMTS, IP, multimedia, telephony, +supplementary services + +## **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. + +© 2024, 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 ..... | 11 | +| 4 Interworking overview ..... | 12 | +| 4.1 Interworking reference model ..... | 12 | +| 4.2 Interworking reference points and interfaces ..... | 13 | +| 4.3 Interworking functional entities ..... | 13 | +| 4.3.1 MSC Server enhanced for ICS ..... | 13 | +| 4.3.2 Circuit Switched Media Gateway Function (CS-MGW) ..... | 13 | +| 4.4 Control plane interworking ..... | 13 | +| 4.5 User plane interworking..... | 14 | +| 5 Control plane procedures and interworking..... | 14 | +| 5.1 General ..... | 14 | +| 5.2 IMS registration procedures interworking ..... | 15 | +| 5.2.1 Initial registration ..... | 15 | +| 5.2.2 Reregistration ..... | 15 | +| 5.2.3 MSC Server initiated deregistration ..... | 15 | +| 5.3 Interworking of mobile originating call setup from NAS signalling to SIP ..... | 15 | +| 5.3.1 General ..... | 15 | +| 5.3.2 Receipt of a setup message..... | 15 | +| 5.3.3 Sending of INVITE ..... | 16 | +| 5.3.3.1 General..... | 16 | +| 5.3.3.2 Coding of INVITE ..... | 16 | +| 5.3.3.3 Coding of the SDP offer ..... | 17 | +| 5.3.3.4 Actions on the SDP answer ..... | 17 | +| 5.3.4 Sending of ALERTING..... | 18 | +| 5.3.4a Sending of PROGRESS ..... | 18 | +| 5.3.4b Through-Connecting early media from IMS..... | 18 | +| 5.3.5 Applying ringback tone ..... | 18 | +| 5.3.6 Receipt of 200 OK (INVITE)..... | 18 | +| 5.3.7 Receipt of status-codes 3xx..... | 19 | +| 5.3.8 Receipt of SIP status-codes 4xx, 5xx or 6xx..... | 19 | +| 5.3.9 Receipt of DISCONNECT ..... | 24 | +| 5.3.10 Restoration procedures ..... | 24 | +| 5.3.11 Autonomous clearing initiated by the MSC Server..... | 25 | +| 5.4 Interworking of mobile terminating call setup from SIP to NAS signalling ..... | 25 | +| 5.4.1 General ..... | 25 | +| 5.4.2 Receipt of initial INVITE ..... | 25 | +| 5.4.3 Sending of SETUP ..... | 26 | +| 5.4.4 Receipt of CALL CONFIRMED..... | 29 | +| 5.4.5 Bearer establishment ..... | 30 | +| 5.4.5.1 Network side bearer establishment..... | 30 | +| 5.4.5.2 Access bearer assignment..... | 30 | +| 5.4.5.3 Transcoding ..... | 30 | +| 5.4.6 Receipt of ALERTING..... | 30 | +| 5.4.7 Applying early media ..... | 30 | +| 5.4.8 Call rejection or abandonment..... | 31 | +| 5.4.8.1 Receipt of RELEASE COMPLETE or DISCONNECT..... | 31 | +| 5.4.8.2 Receipt of CANCEL or BYE..... | 34 | +| 5.4.9 Receipt of CONNECT..... | 34 | +| 5.4.10 Call failure procedures ..... | 34 | + +| | | | +|-------------|-------------------------------------------------------------------------------|----| +| 5.4.11 | Autonomous clearing initiated by the MSC Server..... | 34 | +| 5.5 | Interworking of established call clearing between NAS signalling and SIP..... | 35 | +| 5.5.1 | General ..... | 35 | +| 5.5.2 | Clearing initiated by the mobile ..... | 35 | +| 5.5.3 | Clearing initiated by the IM CN subsystem ..... | 35 | +| 5.5.4 | Autonomous clearing initiated by the MSC Server..... | 35 | +| 5.6 | Supplementary Services invocation ..... | 35 | +| 5.6.1 | Originating identification presentation/restriction (OIP/OIR) ..... | 35 | +| 5.6.2 | Terminating identification presentation/restriction (TIP/TIR)..... | 36 | +| 5.6.2.1 | Terminating identification presentation (TIP) ..... | 36 | +| 5.6.2.2 | Terminating identification restriction (TIR) ..... | 36 | +| 5.6.3 | Communication Hold (HOLD)..... | 37 | +| 5.6.3.1 | HOLD initiated via NAS signalling..... | 37 | +| 5.6.3.1.1 | Hold..... | 37 | +| 5.6.3.1.2 | Resume ..... | 37 | +| 5.6.3.2 | HOLD initiated via SIP signalling..... | 37 | +| 5.6.3.2.1 | Hold..... | 37 | +| 5.6.3.2.2 | Resume ..... | 38 | +| 5.6.4 | Communication Waiting (CW) ..... | 38 | +| 5.6.4.1 | Receipt of initial INVITE ..... | 38 | +| 5.6.4.2 | Accepting the waiting call ..... | 38 | +| 5.6.4.3 | Rejecting the waiting call ..... | 39 | +| 5.6.4.4 | Communication release during waiting condition..... | 39 | +| 5.6.4.5 | CW condition timeout..... | 39 | +| 5.6.4.6 | Notification to originator ..... | 40 | +| 5.6.5 | Communication Barring (CB) ..... | 40 | +| 5.6.6 | Communication Diversion..... | 40 | +| 5.6.6.1 | General ..... | 40 | +| 5.6.6.2 | CDIV invocation..... | 40 | +| 5.6.6.2.1 | Communication Forwarding Unconditional (CFU) ..... | 40 | +| 5.6.6.2.2 | Communication Forwarding Busy (CFB)..... | 40 | +| 5.6.6.2.3 | Communication Forwarding No Reply (CFNR)..... | 40 | +| 5.6.6.2.4 | Communication Forwarding on Not Logged-In (CFNL)..... | 41 | +| 5.6.6.2.5 | Communication Deflection (CD)..... | 41 | +| 5.6.6.2.6 | Communication Forwarding on Subscriber Not Reachable (CFNRc)..... | 41 | +| 5.6.6.3 | Notifications relating to CDIV ..... | 41 | +| 5.6.6.3.1 | Void..... | 41 | +| 5.6.6.3.2 | Notification to an originating user on CS access ..... | 41 | +| 5.6.6.3.3 | Notification to a terminating user on CS access ..... | 42 | +| 5.6.7 | Explicit Communication Transfer (ECT)..... | 43 | +| 5.6.7.1 | General ..... | 43 | +| 5.6.7.2 | MSC Server as transferor on behalf of UE ..... | 43 | +| 5.6.7.3 | MSC Server as transferee on behalf of UE..... | 43 | +| 5.6.7.3.1 | Actions without 3PCC..... | 43 | +| 5.6.7.3.2 | Actions with 3PCC..... | 44 | +| 5.6.7.4 | MSC Server as transfer target on behalf of UE ..... | 44 | +| 5.6.8 | Conference (CONF) ..... | 44 | +| 5.6.8.1 | General ..... | 44 | +| 5.6.8.2 | MSC Server as conference creator..... | 44 | +| 5.6.8.2.1 | Conference creation..... | 44 | +| 5.6.8.2.2 | Putting the conference on hold..... | 45 | +| 5.6.8.2.3 | Resuming a held conference ..... | 45 | +| 5.6.8.2.4 | Adding a party to the conference ..... | 45 | +| 5.6.8.2.5 | Terminating the conference or disconnecting a party from the conference..... | 45 | +| 5.6.8.2.6 | Receipt of a SplitMPTY message ..... | 46 | +| 5.6.8.2.7 | Remote party disconnects from the conference ..... | 46 | +| 5.6.8.3 | MSC Server as conference participant..... | 46 | +| 5.6.8.3.1 | Receipt of invitation to conference ..... | 46 | +| 5.6.8.3.1.1 | General ..... | 46 | +| 5.6.8.3.1.2 | Receipt of REFER within a dialog ..... | 46 | +| 5.6.8.3.1.3 | Receipt of REFER outside a dialog..... | 46 | +| 5.6.8.3.1.4 | Receipt of INVITE ..... | 47 | + +| | | | +|------------|---------------------------------------------------------------------|----| +| 5.6.8.3.2 | Notification of conference invocation..... | 47 | +| 5.6.9 | Customized Alerting Tones (CAT) ..... | 47 | +| 5.6.9.1 | General..... | 47 | +| 5.6.9.2 | Early session model ..... | 47 | +| 5.6.9.2.1 | Originating request..... | 47 | +| 5.6.9.3 | Forking model..... | 48 | +| 5.6.9.4 | Gateway model ..... | 48 | +| 5.6.10 | Communication Completion Services (CCBS/CCNL/CCNR) ..... | 48 | +| 5.6.10.1 | General..... | 48 | +| 5.6.10.2 | Communication Completion Terminated at Served User..... | 48 | +| 5.6.10.3 | Communication Completion Originated at Served User ..... | 48 | +| 5.6.10.3.1 | Actions without 3PCC..... | 48 | +| 5.6.10.3.2 | Actions with 3PCC..... | 48 | +| 5.7 | Supplementary Service Configuration ..... | 48 | +| 5.7.1 | General ..... | 48 | +| 5.7.2 | Receipt of REGISTER message..... | 49 | +| 5.7.3 | Receipt of HTTP response..... | 49 | +| 5.7.4 | Service data interworking..... | 49 | +| 5.7.4.1 | Originating identification presentation/restriction (OIP/OIR)..... | 49 | +| 5.7.4.1.1 | Registration/erasure..... | 49 | +| 5.7.4.1.2 | Activation/deactivation ..... | 49 | +| 5.7.4.1.3 | Interrogation ..... | 49 | +| 5.7.4.2 | Terminating identification presentation/restriction (TIP/TIR) ..... | 50 | +| 5.7.4.2.1 | Registration/erasure..... | 50 | +| 5.7.4.2.2 | Activation/deactivation ..... | 50 | +| 5.7.4.2.3 | Interrogation ..... | 50 | +| 5.7.4.3 | Communication Hold (HOLD)..... | 50 | +| 5.7.4.4 | Communication Waiting (CW)..... | 51 | +| 5.7.4.4.1 | Registration/erasure..... | 51 | +| 5.7.4.4.2 | Activation/deactivation ..... | 51 | +| 5.7.4.4.3 | Interrogation ..... | 51 | +| 5.7.4.5 | Communication Barring (CB) ..... | 51 | +| 5.7.4.5.1 | Registration/erasure..... | 51 | +| 5.7.4.5.2 | Activation/deactivation ..... | 52 | +| 5.7.4.5.3 | Interrogation ..... | 53 | +| 5.7.4.6 | Communication Diversion (CDIV) ..... | 53 | +| 5.7.4.6.1 | Registration ..... | 53 | +| 5.7.4.6.1a | Erasure..... | 54 | +| 5.7.4.6.2 | Activation/deactivation ..... | 55 | +| 5.7.4.6.3 | Interrogation ..... | 55 | +| 5.7.4.7 | Explicit Communication Transfer (ECT) ..... | 56 | +| 5.7.4.8 | Conference (CONF)..... | 56 | +| 5.7.4.9 | Communication Completion Services (CCBS/CCNL/CCNR)..... | 56 | +| 5.7.4.9.1 | Activation/deactivation ..... | 56 | +| 5.7.4.9.2 | Interrogation ..... | 56 | +| 5.8 | Handover / Relocation..... | 57 | +| 5.8.1 | Intra-MSC Handover/Relocation..... | 57 | +| 5.8.2 | Inter-MSC Handover/Relocation..... | 57 | +| 6 | User plane interworking..... | 57 | +| 6.1 | General ..... | 57 | +| 6.2 | IuCS to Mb interworking ..... | 57 | +| 6.2.1 | Interworking with transcoding ..... | 57 | +| 6.2.2 | Transcoder-less interworking ..... | 58 | +| 6.3 | TDM-based A-interface to Mb interworking ..... | 59 | +| 6.3.1 | Interworking with transcoding ..... | 59 | +| 6.3.2 | Transcoder-less interworking ..... | 59 | +| 6.4 | IP-based A-interface to Mb interworking ..... | 60 | +| 6.4.1 | Interworking with transcoding ..... | 60 | +| 6.4.2 | Transcoder-less interworking ..... | 60 | + +| | | | +|-------------------------------|---------------------------------------------------------------|-----------| +| 7 | MSC Server – CS-MGW interaction ..... | 61 | +| 7.1 | Mobile originated call ..... | 61 | +| 7.1.1 | CS-MGW selection ..... | 61 | +| 7.1.2 | IMS session side establishment ..... | 61 | +| 7.1.2.1 | General ..... | 61 | +| 7.1.2.2 | Additions to Reserve RTP Connection Point Procedure ..... | 61 | +| 7.1.2.3 | Additions to Configure RTP Connection Point Procedure ..... | 63 | +| 7.1.3 | Access bearer establishment ..... | 64 | +| 7.1.3.1 | General ..... | 64 | +| 7.1.3.2 | Iu interface on IP ..... | 64 | +| 7.1.3.3 | A interface over IP ..... | 64 | +| 7.1.3.4 | A interface over TDM ..... | 64 | +| 7.1.3.5 | Iu over UTRAN and GERAN ..... | 64 | +| 7.1.4 | Apply ringing tone ..... | 64 | +| 7.1.5 | Through connection ..... | 64 | +| 7.1.5a | Handling of Forking ..... | 64 | +| 7.1.6 | Failure handling in MSC server ..... | 65 | +| 7.2 | Mobile terminated call ..... | 65 | +| 7.2.1 | CS-MGW selection ..... | 65 | +| 7.2.2 | Network side session establishment ..... | 65 | +| 7.2.2.1 | General ..... | 65 | +| 7.2.2.2 | Additions to Reserve and Configure RTP Connection Point ..... | 65 | +| 7.2.3 | Access bearer assignment ..... | 68 | +| 7.2.3.1 | General ..... | 68 | +| 7.2.3.2 | Iu interface on IP ..... | 68 | +| 7.2.3.3 | A interface over IP ..... | 68 | +| 7.2.3.4 | A interface over TDM ..... | 68 | +| 7.2.3.5 | Iu over UTRAN and GERAN ..... | 68 | +| 7.2.4 | Apply ringing tone ..... | 69 | +| 7.2.5 | Through connection ..... | 69 | +| 7.2.6 | Announcement ..... | 69 | +| 7.2.7 | Failure handling in the MSC server ..... | 69 | +| 7.2A | Notification Procedures ..... | 69 | +| 7.2A.1 | General information ..... | 69 | +| 7.2A.2 | ECN Failure Indication ..... | 69 | +| 7.2A.3 | ICE Connectivity Check Result Notification ..... | 70 | +| 7.2A.4 | ICE New Peer Reflexive Candidate Notification ..... | 70 | +| 7.3 | Call clearing ..... | 71 | +| 7.3.1 | Clearing received from the network ..... | 71 | +| 7.3.1.1 | Access bearer clearing ..... | 71 | +| 7.3.1.2 | Network side clearing ..... | 71 | +| 7.3.2 | Clearing received from the user ..... | 71 | +| 7.3.2.1 | Access bearer clearing ..... | 71 | +| 7.3.2.2 | Network side clearing ..... | 71 | +| 7.3.3 | Call clearing received from the CS-MGW ..... | 72 | +| 7.3.3.1 | Bearer released received on the access side ..... | 72 | +| 7.3.3.2 | Bearer released received on the network side ..... | 72 | +| 7.4 | Call independent procedures ..... | 72 | +| 7.5 | Explicit Congestion Notification ..... | 72 | +| 7.6 | Multimedia Priority Service (MPS) Support ..... | 72 | +| 7.7 | Interactive Connectivity Establishment ..... | 72 | +| 7.8 | Codec Parameters Handling ..... | 72 | +| 7.8.1 | Handling of common codec parameters ..... | 72 | +| 7.8.2 | EVS speech codec ..... | 73 | +| 7.8.3 | IVAS speech codec ..... | 73 | +| 7.9 | SDP Capability Negotiation (SDPCapNeg) ..... | 73 | +| Annex A (informative): | Change history ..... | 74 | + +# --- 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 + +IMS Centralized Services (ICS) enable the delivery of IM CN subsystem based multimedia telephony and supplementary services as defined in 3GPP TS 24.173 [4] to users regardless of the attached access network type; e.g. CS domain access or IP-CAN. + +The present document specifies the principles of interworking between the IM CN subsystem and CS domain in order to enable ICS for UEs using CS domain access. + +The present document addresses the area of registration procedures interworking between the CS domain and IM CN subsystem. + +The present document addresses the areas of control and user plane interworking between the IM CN subsystem and CS domain through an MSC Server enhanced for ICS and CS-MGW respectively. This includes the signalling procedures between the MSC Server and CS-MGW. For the specification of control plane interworking, present document defines the protocol interworking between the 3GPP profile of SIP as described in 3GPP TS 24.229 [2] and NAS signalling as described in 3GPP TS 24.008 [3] required for the support of IM CN subsystem based multimedia telephony and supplementary services. + +The present document addresses the area of supplementary service configuration interworking between the CS domain and IM CN subsystem. + +The present document is applicable to the MSC Server and CS-MGW. + +# --- 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.229: "IP Multimedia Call Control Protocol based on SIP and SDP". +- [3] 3GPP TS 24.008: "Mobile radio interface layer 3 specification; Core Network protocols; Stage 3". +- [4] 3GPP TS 24.173: "IMS multimedia telephony communication service and supplementary services; Stage 3". +- [5] 3GPP TS 23.292: "IP Multimedia Subsystem (IMS) Centralized Services; Stage 2". +- [6] 3GPP TS 23.002: "Network Architecture". +- [7] 3GPP TS 24.292: "IP Multimedia (IM) Core Network (CN) subsystem Centralized Services (ICS); Stage 3". +- [8] 3GPP TS 23.018: "Basic call handling; Technical realization". +- [9] 3GPP TS 22.003: "Circuit Teleservices supported by a Public Land Mobile Network (PLMN)". +- [10] 3GPP TS 23.003: "Numbering, addressing and identification". +- [11] 3GPP TS 29.232: "Media Gateway Controller (MGC) – Media Gateway (MGW) interface; Stage 3". + +- [12] 3GPP TS 24.081: "Line Identification Supplementary Services – Stage 3". +- [13] Void +- [14] 3GPP TS 24.608: "Terminating Identification Presentation (TIP) and Terminating Identification Restriction (TIR) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [15] 3GPP TS 25.414: "UTRAN Iu interface data transport and transport signalling". +- [16] 3GPP TS 25.415: "UTRAN Iu interface user plane protocols". +- [17] 3GPP TS 25.411: "UTRAN Iu interface layer 1". +- [18] 3GPP TS 29.414: "Core network Nb data transport and transport signalling". +- [19] 3GPP TS 48.004: "Base Station System – Mobile-services Switching Centre (BSS – MSC) interface; Layer 1 specification". +- [20] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [21] Void. +- [22] 3GPP TS 26.226: "CTM Cellular Text telephony Modem, General description". +- [23] 3GPP TS 24.604: "Communication Diversion (CDIV) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [24] 3GPP TS 24.082: "Call Forwarding (CF) supplementary services; Stage 3". +- [25] 3GPP TS 24.072: "Call Deflection (CD) Supplementary Service; Stage 3". +- [26] 3GPP TS 24.083: "Call Waiting (CS) and Call Hold (HOLD) supplementary services; Stage 3". +- [27] 3GPP TS 24.610: "Communication HOLD (HOLD) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [28] 3GPP TS 26.114: "IP Multimedia Subsystem (IMS); Multimedia Telephony; Media handling and interaction". +- [29] 3GPP TS 24.080: "Mobile radio interface layer 3 supplementary services specification; Formats and coding". +- [30] 3GPP TS 24.088: "Call Barring (CB) Supplementary Service – Stage 3". +- [31] 3GPP TS 24.611: "Anonymous Communication Rejection (ACR) and Communication Barring (CB); using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [32] 3GPP TS 24.091: "Explicit Call Transfer (ECT) supplementary service; Stage 3". +- [33] 3GPP TS 24.629: "Explicit Communication Transfer (ECT) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [34] 3GPP TS 24.084: "Multi Party (MPTY) supplementary service – Stage 3". +- [35] 3GPP TS 24.605: "Conference (CONF) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [36] 3GPP TS 24.147: "Conferencing using the IP Multimedia (IM) Core Network (CN) subsystem; Stage 3". +- [37] 3GPP TS 23.009: "Handover procedures". +- [38] 3GPP TS 48.103: "Base Station System – Media GateWay (BSS-MGW) interface; User Plane transport mechanism". +- [39] 3GPP TS 23.205: "Bearer Independent switched core network; Stage 2". + +- [40] 3GPP TS 23.231: "SIP-I based circuit-switched core network; Stage 2". +- [41] 3GPP TS 24.010: "Mobile radio interface layer 3 Supplementary services specification; General aspects". +- [42] 3GPP TS 24.623: "Extensible Markup Language (XML) Configuration Access Protocol (XCAP) over the Ut interface for Manipulating Supplementary Services". +- [43] 3GPP TS 24.607: "Originating Identification Presentation (OIP) and Originating Identification Restriction (OIR) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [44] 3GPP TS 24.615: "Communication Waiting (CW) using IP Multimedia (IM) Core Network (CN) subsystem; Protocol specification". +- [45] IETF RFC 3326: "The Reason Header Field for the Session Initiation Protocol (SIP)". +- [46] 3GPP TS 29.163: "Interworking between the IP Multimedia (IM) Core Network (CN) subsystem and Circuit Switched (CS) networks". +- [47] IETF RFC 5009: "Private Header (P-Header) Extension to the Session Initiation Protocol (SIP) for Authorization of Early Media". +- [48] IETF RFC 3168: "The Addition of Explicit Congestion Notification (ECN) to IP". +- [49] IETF RFC 6679: "Explicit Congestion Notification (ECN) for RTP over UDP". +- [50] IETF RFC 3959: "The Early Session Disposition Type for the Session Initiation Protocol (SIP)". +- [51] 3GPP TS 24.182: "IP Multimedia Subsystem (IMS) Customized Alerting Tones (CAT); Protocol specification". +- [52] 3GPP TS 24.642: "Completion of Communications to Busy Subscriber (CCBS) and Completion of Communications by No Reply (CCNR) using IP Multimedia (IM) Core Network (CN) subsystem". +- [53] 3GPP TS 24.093: "Completion of Calls to Busy Subscriber (CCBS); Stage 3". +- [54] 3GPP TS 22.153: "Multimedia Priority Service". +- [55] IETF RFC 4458: "Session Initiation Protocol (SIP) URIs for Applications such as Voicemail and Interactive Voice Response (IVR)". +- [56] 3GPP TS 32.260: "Telecommunication management; Charging management; IP Multimedia Subsystem (IMS) charging". +- [57] IETF RFC 3262: "Reliability of provisional responses in Session Initiation Protocol (SIP)". +- [58] IETF RFC 3312: "Integration of Resource Management and Session Initiation Protocol (SIP)". +- [59] IETF RFC 4032: "Update to the Session Initiation Protocol (SIP) Preconditions Framework". +- [60] Void. +- [61] 3GPP TS 26.441: "Codec for Enhanced Voice Services (EVS); General Overview". +- [62] 3GPP TS 26.445: "Codec for Enhanced Voice Services (EVS); Detailed Algorithmic Description". +- [63] IETF RFC 5939: "Session Description Protocol (SDP) Capability Negotiation". +- [64] 3GPP TS 23.333: "Multimedia Resource Function Controller (MRFC) - Multimedia Resource Function Processor (MRFP) Mp interface: Procedures Descriptions". +- [65] IETF RFC 8197: "A SIP Response Code for Unwanted Calls". +- [66] IETF RFC 8224: "Authenticated Identity Management in the Session Initiation Protocol (SIP)". + +- [67] ITU-T Recommendation Q.850 (05/1998) including Amendment 1 (07/2001): "Usage of cause and location in the Digital Subscriber Signalling System No. 1 and the Signalling System No. 7 ISDN User Part". +- [68] IETF RFC 8606: "ISDN User Part (ISUP) Cause Location Parameter for the SIP Reason Header Field". +- [69] IETF RFC 8445: "Interactive Connectivity Establishment (ICE): A Protocol for Network Address Translator (NAT) Traversal". +- [70] IETF RFC 8839: "Session Description Protocol (SDP) Offer/Answer Procedures for Interactive Connectivity Establishment (ICE)". +- [71] 3GPP TS 26.250: "Codec for Immersive Voice and Audio Services; General overview". +- [72] 3GPP TS 26.253: "Codec for Immersive Voice and Audio Services; Detailed Algorithmic Description incl. RTP payload format and SDP parameter definitions". + +# --- 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]. + +**ICE lite:** The lite implementation of the Interactive Connectivity Establishment (ICE) specified in IETF RFC 8445 [69]. + +**Full ICE:** The full implementation of the Interactive Connectivity Establishment (ICE) specified in IETF RFC 8445 [69]. + +**NAS signalling:** layer 3 signalling carried over CS domain access between the UE and MSC Server as defined in 3GPP TS 24.008 [3]. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 24.629 [33] apply: + +**transferee** + +**transferor** + +**transfer target** + +## 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]. + +| | | +|-----------|----------------------------------------------------------------------------------------| +| 3PCC | 3 rd Party Call Control | +| ACR | Anonymous Communication Rejection | +| BAIC | Barring of All Incoming Calls | +| BAOC | Barring of All Outgoing Calls | +| BIC-Roam | Barring of Incoming Calls when Roaming outside the home PLMN country | +| BOIC | Barring of Outgoing International Calls | +| BOIC-exHC | Barring of Outgoing International Calls except those directed to the Home PLMN Country | +| CB | Communication Barring | +| CCBS | Completion of Communication to Busy Subscriber | +| CCNL | Completion of Communications on Not Logged-in | +| CCNR | Completion of Communications on No Reply | +| CD | Communication Deflection | + +| | | +|-----------|------------------------------------------------------| +| CDIV | Communication DIVersion | +| CFNL | Communication Forwarding on Not Logged-in | +| CFNR | Communication Forwarding No Reply | +| CFNRe | Communication Forwarding on subscriber Not Reachable | +| CFU | Communication Forwarding Unconditional | +| CONF | CONFerence | +| CS | Circuit Switched | +| CS-MGW | Circuit Switched Media Gateway | +| ECN | Explicit Congestion Notification | +| ECT | Explicit Communication Transfer | +| EVS | Enhanced Voice Services | +| GRUU | Globally Routable User Agent URI | +| HOLD | communication HOLD | +| ICB | Incoming Communication Barring | +| ICE | Interactive Connectivity Establishment | +| ICS | IM CN subsystem Centralized Services | +| IMS-MGW | IP Multimedia Subsystem-Media Gateway Function | +| IuFP | Iu Framing Protocol | +| IVAS | Immersive Voice and Audio Services | +| MboIP | Mb over IP | +| MRFP | Media Resource Function Processor | +| MPS | Multimedia Priority Service | +| NAS | Non Access Stratum | +| OCB | Outgoing Communication Barring | +| OIP | Originating Identification Presentation | +| OIR | Originating Identification Restriction | +| RTCP | RTP Control Protocol | +| SDPCapNeg | SDP Capability Negotiation | +| TDM | Time Division Multiplex | +| TIP | Terminating Identification Presentation | +| TIR | Terminating Identification Restriction | + +# --- 4 Interworking overview + +## 4.1 Interworking reference model + +Figure 4.1.1 details the reference model required to support interworking between the 3GPP IM CN subsystem and CS domain access for IM basic voice calls and supplementary services. + +![Figure 4.1.1: MSC Server – IM CN subsystem interworking reference model. The diagram shows a GERAN/UTRAN connected to an MSC Server enhanced for ICS and a CS-MGW via A/luCS interfaces. The MSC Server is connected to a CSCF via an I2 interface and to the CS-MGW via an Mc interface. The CS-MGW is connected to a (NOTE2) entity via an Mb interface. A legend indicates that dashed lines represent the control plane and solid lines represent the user plane.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +graph LR + GERAN[GERAN/UTRAN] -- "A/luCS (Control plane)" --> MSC[MSC Server enhanced for ICS] + GERAN -- "A/luCS (User plane)" --> MGW[CS-MGW] + MSC -- "I2 (Control plane)" --> CSCF[CSCF] + MSC -- "Mc (Control plane)" --> MGW + MGW -- "Mb (User plane)" --> NOTE2[(NOTE2)] + +``` + +Figure 4.1.1: MSC Server – IM CN subsystem interworking reference model. The diagram shows a GERAN/UTRAN connected to an MSC Server enhanced for ICS and a CS-MGW via A/luCS interfaces. The MSC Server is connected to a CSCF via an I2 interface and to the CS-MGW via an Mc interface. The CS-MGW is connected to a (NOTE2) entity via an Mb interface. A legend indicates that dashed lines represent the control plane and solid lines represent the user plane. + +NOTE 1: The logical split of the signalling and bearer path between the CS access network and MSC Server enhanced for ICS is as shown; however, the signalling and bearer may be directly connected to the MGW. + +NOTE 2: The CS-MGW may be connected via the Mb reference point to various network entities, such as a UE (via a GTP tunnel to a GGSN), an MRFP, or an IMS-MGW, or a remote CS-MGW. + +**Figure 4.1.1: MSC Server – IM CN subsystem interworking reference model** + +## 4.2 Interworking reference points and interfaces + +The reference points and network interfaces shown in figure 4.1.1 are as described: + +**A reference point:** The A reference point is defined in 3GPP TS 23.002 [6]. + +**IuCS reference point:** The IuCS reference point is defined in 3GPP TS 23.002 [6]. + +**I2 reference point:** The call control protocol specified in this document for use on the I2 reference point (i.e. between MSC Server enhanced for ICS and CSCF) is based on Mw reference point as defined in 3GPP TS 23.002 [6] and the 3GPP profile of SIP as defined in accordance with 3GPP TS 24.229 [2]. + +**Mc reference point:** The Mc reference point is defined in 3GPP TS 23.002 [6]. + +**Mb reference point:** The Mb reference point is defined 3GPP TS 23.002 [6]. + +## 4.3 Interworking functional entities + +### 4.3.1 MSC Server enhanced for ICS + +This is the component which provides the interworking between CS domain access and IM CN subsystem control planes, and it shall support the functions as defined in accordance with 3GPP TS 23.002 [6]. + +For brevity, where the term "MSC Server" is used in the rest of the specification, this shall be understood as "MSC Server enhanced for ICS". + +### 4.3.2 Circuit Switched Media Gateway Function (CS-MGW) + +This is the component which provides the interworking between CS domain access and IM CN subsystem user planes, and it shall support the functions as defined in accordance with 3GPP TS 23.002 [6]. + +## 4.4 Control plane interworking + +Within the IM CN subsystem, the 3GPP profile of SIP defined in 3GPP TS 24.229 [2] is used for session control. + +Over CS domain access, NAS signalling is used for call origination, call termination and supplementary services. + +Therefore, in order to provide the required interworking to enable ICS for UE using CS domain access, the control plane protocols shall be interworked within the MSC Server. + +## 4.5 User plane interworking + +Within the IM CN subsystem, framing protocols such as RTP are used to transport media packets to and from IM CN subsystem entities such as the UE, MRFP or IMS-MGW. + +CS domain access uses circuit switched bearer channels like TDM circuits (e.g. 64kbps PCM), ATM/AAL2 circuits or IP bearers using the IuFP framing protocol or RTP to carry voice frames. + +Therefore, in order to provide the required interworking to enable ICS for a UE using CS domain access, the user plane protocols shall be interworked within the CS-MGW, under the control of the MSC Server. + +# --- 5 Control plane procedures and interworking + +## 5.1 General + +The following subclauses define the procedures and signalling interworking performed by the MSC Server to enable ICS for UEs attached to the CS domain. The interworking between NAS signalling and the Session Initiation Protocol (SIP) with its associated Session Description Protocol (SDP) is specified. + +The capabilities of SIP and SDP that are interworked with NAS signalling are defined in 3GPP TS 24.229 [2]. + +Table 5.1.1 lists the service interworking within the scope of the present document. + +**Table 5.1.1: Interworking between NAS signalling and SIP/SDP** + +| Telephony or Supplementary Service | +|----------------------------------------------------| +| TS11 non-emergency speech calls | +| Originating Identification Presentation (OIP) | +| Originating Identification Restriction (OIR) | +| Terminating Identification presentation (TIP) | +| Terminating Identification restriction (TIR) | +| Communication Hold and Resume | +| Communication Waiting | +| Communication Barring | +| Communication Diversion | +| Explicit Communication Transfer | +| Conferencing | +| Communication Completion to Busy Subscriber (CCBS) | +| Communication Completion on No Reply (CCNR) | +| Communication Completion on Not Logged-in (CCNL) | + +## 5.2 IMS registration procedures interworking + +### 5.2.1 Initial registration + +Upon successful completion of the location updating procedure as specified in 3GPP TS 24.008 [3], an MSC Server supporting the ICS Indicator parameter as specified in 3GPP TS 29.002 [20] shall determine whether to perform initial IMS registration on behalf of the UE. + +The relevant location update case, when an initial registration is needed to the IM CN subsystem is a location update to new MSC/VLR service area (the MSC/VLR was not the previous serving network element). + +In accordance with 3GPP TS 23.292 [5], clause 7.2.1.1, the MSC Server may perform an initial IMS registration. The optional flag referred to in clause 7.2.1.1 of 3GPP TS 23.292 [5] is implemented as the ICS Indicator parameter in 3GPP TS 29.002 [20]. + +When performing initial IMS registration, the MSC Server shall send a REGISTER request on behalf of the UE as described in 3GPP TS 24.292 [7]. + +### 5.2.2 Reregistration + +The MSC Server shall initiate reregistration for a previously registered Public User Identity as described in 3GPP TS 24.292 [7] if that subscriber is still registered in the MSC Server via CS domain access. + +### 5.2.3 MSC Server initiated deregistration + +The MSC Server shall send a REGISTER request for deregistration on behalf of the UE as described in 3GPP TS 24.292 [7] upon receipt of any indication that the subscriber is no longer registered in this MSC Server. + +Prior to sending a REGISTER request for deregistration, the MSC Server shall release all IMS dialogs related to the Public User Identity that is going to be deregistered or to one of the implicitly registered Public User Identities. + +## 5.3 Interworking of mobile originating call setup from NAS signalling to SIP + +### 5.3.1 General + +The mobile originating call shall be established in accordance with 3GPP TS 23.018 [8] and 3GPP TS 24.008 [3]. The IM CN subsystem originating session shall be established in accordance with 3GPP TS 24.292 [7] and 3GPP TS 24.229 [2]. The following subclauses describe the additional requirements for interworking between NAS signalling and SIP. + +The following subclauses also assume the originating call is received from a subscriber with an active IM CN subsystem registration via the MSC Server performing the interworking. + +### 5.3.2 Receipt of a setup message + +Upon receipt of a setup message (a SETUP message or an EMERGENCY SETUP message), the MSC Server shall determine whether the originating call shall be directed to the IM CN subsystem. + +The originating call shall be directed to the IM CN subsystem if all of the following conditions are met: + +- the setup message is a SETUP message and is determined by the MSC Server not to be an emergency call, and +- the bearer capability 1 information element indicates teleservice 11 as described in 3GPP TS 22.003 [9], and +- the CTM text telephony indication in the bearer capability 1 information element is set to "CTM text telephony is not supported", and +- the bearer capability 2 information element is not present. + +Otherwise the originating call shall be handled by the MSC Server without interworking to the IM CN subsystem. + +### 5.3.3 Sending of INVITE + +#### 5.3.3.1 General + +Upon determining that an incoming SETUP message shall be interworked to the IM CN subsystem, the MSC Server shall generate an INVITE request as further detailed in the subclauses below. + +#### 5.3.3.2 Coding of INVITE + +The INVITE request shall be coded as described in 3GPP TS 24.292 [7] with the following SETUP message interworking applied: + +- The called party BCD number information element in the SETUP message is used to derive the Request URI of the INVITE request as follows: + 1. if the type of number field is set to "international number", then the number digit fields, prefixed with a "+", shall be used to build a tel URI or a SIP URI with "user=phone"; or + 2. if the type of number field is set to "national number", according to local policy: + - a) if the called party BCD number is considered as if the mobile station sent a "geo-local number" then the MSC Server shall, as an operator option, either: + - convert the number to international format by prefixing the number digits with "+CC" (where CC is the country code of the network in which the MSC Server is located) and use this to build a tel URI or a SIP URI with "user=phone"; or + - use the number digit fields to build a tel URI or a SIP URI with "user=phone". The phone-context parameter shall include the home network domain name defined for IMS centralized services in 3GPP TS 23.003 [10]. The phone-context which includes the home network domain name of the calling party is prefixed by the "geo-local" string according to 3GPP TS 24.229 [2]. + - b) if the called party BCD number is considered as if the mobile station sent a "home-local number", then the MSC Server shall, as an operator option, either: + - convert the number to international format by prefixing the number digits with "+CC" (where CC is the country code of the home network of the calling party) and use this to build a tel URI or a SIP URI with "user=phone"; or + - use the number digit fields to build a tel URI or a SIP URI with "user=phone". The phone-context parameter shall include the home network domain name defined for IMS centralized services in 3GPP TS 23.003 [10]. + +NOTE 1: When the calling party is not in roaming situation, the current physical location of the user is identical to the home network of the user; by default, the called party BCD number information element received in the SETUP message should be considered as a "geo-local number". + +3. if the type of number field is set to "unknown", then the MSC Server shall build a SIP URI with "user=phone" or a tel URI, including the received digits as an unprocessed dial string to the IM CN subsystem, using one of the formats for UEs without dial string processing capabilities, as defined in 3GPP TS 24.229 [2], clause 5.1.2A.1.3; + +NOTE 2: This sets the requirement that the dialling plan is designed so it enables the IM CN subsystem to differentiate local numbers from other numbers; refer to clause 5.1.2A.1.3. + +- if the CLIR invocation information element is present in the SETUP message, the From header shall be set to an Anonymous User Identity as defined in 3GPP TS 23.003 [10] and the MSC Server shall include a Privacy header with priv-value set to "id"; +- if the CLIR suppression information element is present in the SETUP message, the MSC Server shall include a Privacy header with priv-value set to "none"; + +- if the CLIR invocation information element and CLIR suppression information element are not present in the SETUP message, the MSC Server shall not include a Privacy header; +- the P-Asserted-Identity header shall be set to the default public identity received during registration procedures; +- the Contact header shall be set to: + - the public GRUU received at registration as specified in 3GPP TS 24.229 [2]; or + - if the CLIR suppression information element is present in the SETUP message to the temporary GRUU received at registration as specified in 3GPP TS 24.229 [2]. + +When a SIP URI is used for the Request URI, the host portion of the SIP URI shall be set to the home network domain name defined for IMS centralized services in 3GPP TS 23.003 [10]. + +If the MSC server supports the P-Early-Media header as a network option, then it shall include the header in each outgoing SIP INVITE request. + +The MSC Server shall include a P-Charging-Vector header field in the initial INVITE request with an "icid-value" header field parameter as specified in 3GPP TS 32.260 [56]. + +Unless local configuration indicates that the network is serving users not supporting SIP preconditions, the MSC server shall include in a Supported header field of the initial INVITE request: + +- 1) a "100rel" option tag as defined in IETF RFC 3262 [57] to indicate the support for reliable provisional responses; and +- 2) a "precondition" option tag as defined in IETF RFC 3312 [58] to indicate the support for the SIP preconditions mechanism. + +#### 5.3.3.3 Coding of the SDP offer + +The MSC Server shall determine the speech codecs supported by the UE as specified in 3GPP TS 24.008 [3] and use this information when constructing a codec list for the SDP offer. The MSC Server may also add speech codecs. The added speech codecs are based on configuration data in the MSC Server. + +If the MSC Server indicated the support for the SIP preconditions mechanism as described in clause 5.3.3.2 and + +- the access bearer establishment has been initiated prior to the sending of the INVITE request (e.g. no speech codec or one speech codec is indicated from the originating UE) the MSC Server shall indicate that preconditions have been met in the initial SDP offer using the segmented status type, as defined in IETF RFC 3312 [58] and IETF RFC 4032 [59], as well as the strength-tag value "mandatory" for the local segment and the strength-tag value "optional" for the remote segment. The MSC Server may indicate in the bearer establishment procedure to the UE the speech codec the UE shall use; or +- the access side bearer establishment has not been performed prior to sending the INVITE request, + - a) the MSC Server shall indicate that preconditions have not been met in the SDP offer using the segmented status type, as defined in IETF RFC 3312 [58] and IETF RFC 4032 [59], as well as the strength-tag value "mandatory" for the local segment and the strength-tag value "optional" for the remote segment; and. + - b) once access side bearer establishment has been performed, the MSC Server shall indicate that preconditions have been met in a new SDP offer in a subsequent UPDATE or PRACK request. + +#### 5.3.3.4 Actions on the SDP answer + +At the receipt of the SDP answer the MSC Server shall analyse the received speech codecs: + +- If the received speech codecs in the SDP answer do not include any of the speech codecs provided by the UE in the SETUP message or the SDP answer only include the default speech codec the MSC Server shall instruct the CS-MGW to perform transcoding and indicate in the bearer establishment procedure to the UE the speech codec the UE shall use. Which of the codecs used is based on local policy; +- if only one speech codec is received in the SDP answer, the MSC Server shall select that speech codec and may indicate the speech codec in the bearer establishment procedure to the UE; + +- if more than one speech codec is received in the SDP answer the MSC Server shall select one codec based on local configuration and may indicate the speech codec in the bearer establishment procedure to the UE; and send a new SDP offer which shall indicate the speech codec that the MSC Server has selected. + +For UTRAN and GERAN Iu-mode, the NAS Synchronisation Indicator information element shall be used to inform the UE of the selected codec as specified in 3GPP TS 24.008 [3]. + +### 5.3.4 Sending of ALERTING + +The MSC Server shall send an ALERTING message towards the UE upon receiving the first 180 Ringing response. + +### 5.3.4a Sending of PROGRESS + +Once all the following conditions have been met: + +- 1) the MSC server supports the P-Early-Media header field, and received the first SIP 181 (Call is being forwarded) response, or 182 (Queued) response, or 183 (Session Progress) response, or a SIP UPDATE request that includes a P-Early-Media header field authorizing backward early media; +- 2) SDP preconditions are not used, or applicable SDP preconditions have been met; +- 3) the MSC server did not receive a SIP 180 (Ringing) response; and +- 4) a PROGRESS message has not been sent before; + +then the MSC server shall send a PROGRESS message. + +### 5.3.4b Through-Connecting early media from IMS + +If a SIP 18x response or a SIP UPDATE request is received by the MSC server, once all the following conditions have been met: + +- 1) the MSC server supports the P-Early-Media header field, and the response or request includes a P-Early-Media header field authorizing backward early media; and +- 2) SDP preconditions are not used, or applicable SDP preconditions have been met; + +then the MSC server shall instruct the CS-MGW to through-connect as described in clause 7.1.5 for early media from the IMS side unless the CS-MGW has already been through-connected. + +NOTE: An MSC server supporting the early session model CAT supplementary service applies additional procedure described in clause 5.6.9. + +### 5.3.5 Applying ringback tone + +The MSC Server shall instruct the CS-MGW to apply ringback tone towards the UE in the following conditions: + +- a 180 Ringing response is received and either: + - the MSC Server does not support the P-Early-Media header as a network option; or + - the MSC Server supports the P-Early-Media header as a network option and according to IETF RFC 5009 [47] backward early media is not authorized (the most recently received P-Early-Media header does not authorize backward early media or the P-Early-Media header has not yet been received). + +### 5.3.6 Receipt of 200 OK (INVITE) + +Upon receipt of the first 200 OK (INVITE) response, the MSC Server shall: + +- instruct the CS-MGW to stop ringback if ringback was previously applied; and +- instruct the CS-MGW to through-connect the bearer in both directions; and + +- send a CONNECT message towards the UE as described in 3GPP TS 24.008 [3]. + +Interworking applied for the TIP service is described in clause 5.6.2.1. + +The MSC Server shall not progress any further early dialogs to established dialogs. Therefore, upon receipt of a subsequent 200 OK final response to the initial INVITE request (e.g. due to forking), the MSC Server shall: + +- acknowledge the response with an ACK request; and +- send a BYE request to this dialog in order to terminate it. + +### 5.3.7 Receipt of status-codes 3xx + +Upon receipt of a 3xx response to the initial INVITE, the default behaviour of the MSC Server shall be to release the call with a cause code value of 127 (Interworking unspecified). + +NOTE: The MSC Server may also decide to redirect the call toward the URI in the Contact header field of the 3xx response, as an operator option. Such handling is outside the scope of the present document. + +### 5.3.8 Receipt of SIP status-codes 4xx, 5xx or 6xx + +If the MSC Server receives a 4xx, 5xx or 6xx SIP response to the initial SIP INVITE request and the MSC Server has not sent a SIP CANCEL request, the MSC Server shall initiate call clearing procedures by sending a CC DISCONNECT message towards the UE as described in 3GPP TS 24.008 [3] with the following interworking applied: + +- 1) If one or more Reason header fields are included in the 4xx, 5xx or 6xx SIP response, then the cause value of each Reason header field shall be mapped to a cause information element in the CC DISCONNECT message as follows: + - a) if the Reason header field contains a Q.850 cause value, the numeric "cause" parameter value shall be mapped to the cause value octet of the cause information element in the CC DISCONNECT message according to table 5.3.8.2. The MSC Server shall set: + - the coding standard to "Standard defined for the GSM PLMNs"; and + - the location as follows: + - I) to "network beyond interworking point"; or + - II) if, as a network option, the MSC Server supports the location header field parameter as described in IETF RFC 8606 [68], the MSC Server shall derive the value of the location from the location parameter in the SIP Reason header field according to table 5.3.8.3; + - b) if the Reason header field contains a SIP status-code, the coding of the cause information element in the CC DISCONNECT message shall be as follows: + - set the coding standard to "Standard defined for the GSM PLMNs"; + - set the location to "network beyond interworking point"; and + - derive the cause value from the SIP status-code received in the Reason header field according to table 5.3.8.1. The 4xx, 5xx, and 6xx SIP responses that are not covered in this table shall be interworked to a cause value of 127 (Interworking, unspecified); and + - c) if no Reason header field is included in the 4xx, 5xx or 6xx SIP response, the coding of the cause information element in the CC DISCONNECT message is derived from the SIP status-code of the SIP response according to table 5.3.8.1, where the following information elements shall be set to: + - coding standard to "Standard defined for the GSM PLMNs"; and + - location to "network beyond interworking point". + +**Table 5.3.8.1: Mapping the 4xx/5xx/6xx status-code to the cause information element** + +| SIP status-code | Cause value | +|--------------------------------------|------------------------------------------------------| +| 400 Bad Request | 127 (Interworking, unspecified) | +| 401 Unauthorized | 127 (Interworking, unspecified) | +| 402 Payment Required | 127 (Interworking, unspecified) | +| 403 Forbidden | 79 (Service or option not implemented, unspecified) | +| 404 Not Found | 1 (Unassigned (unallocated) number) | +| 405 Method Not Allowed | 127 (Interworking, unspecified) | +| 406 Not Acceptable | 127 (Interworking, unspecified) | +| 407 Proxy authentication required | 127 (Interworking, unspecified) | +| 408 Request Timeout | 102 (Recovery on timer expiry) | +| 410 Gone | 22 (Number changed) | +| 413 Request Entity too long | 127 (Interworking, unspecified) | +| 414 Request-URI too long | 127 (Interworking, unspecified) | +| 415 Unsupported Media type | 127 (Interworking, unspecified) | +| 416 Unsupported URI scheme | 127 (Interworking, unspecified) | +| 417 Unknown Resource-Priority | 79 (Service or option not implemented, unspecified) | +| 420 Bad Extension | 127 (Interworking, unspecified) | +| 421 Extension required | 127 (Interworking, unspecified) | +| 422 Session Interval Too Small | 31 (Normal, unspecified) | +| 423 Interval Too Brief | 127 (Interworking, unspecified) | +| 424 Bad Location Information | 127 (Interworking, unspecified) | +| 428 Use Identity Header (NOTE 2) | 127 (Interworking, unspecified) | +| 433 Anonymity Disallowed | 24 (Call rejected due to feature at the destination) | +| 436 Bad Identity Info (NOTE 2) | 127 (Interworking, unspecified) | +| 437 Unsupported Credential (NOTE 2) | 127 (Interworking, unspecified) | +| 438 Invalid Identity Header (NOTE 2) | 127 (Interworking, unspecified) | +| 436 Bad Identity Info (NOTE 2) | 127 (Interworking, unspecified) | +| 480 Temporarily Unavailable | 41 (Temporary Failure) | +| 481 Call/Transaction does not exist | 127 (Interworking, unspecified) | +| 482 Loop detected | 127 (Interworking, unspecified) | +| 483 Too many hops | 127 (Interworking, unspecified) | +| 484 Address Incomplete | 28 (Invalid number format (incomplete number)) | +| 485 Ambiguous | 127 (Interworking, unspecified) | +| 486 Busy Here | 17 (User busy) | +| 487 Request terminated | 127 (Interworking, unspecified) | +| 488 Not acceptable here | 127 (Interworking, unspecified) | + +| SIP status-code | Cause value | +|-----------------------------------------------------------------------------------------|-----------------------------------------------------| +| 493 Undecipherable | 127 (Interworking, unspecified) | +| 500 Server Internal error | 127 (Interworking, unspecified) | +| 501 Not implemented | 79 (Service or option not implemented, unspecified) | +| 502 Bad Gateway | 127 (Interworking, unspecified) | +| 503 Service Unavailable | 127 (Interworking, unspecified) | +| 504 Server timeout | 102 (Recovery on timer expiry) | +| 505 Version not supported | 127 (Interworking, unspecified) | +| 513 Message too large | 127 (Interworking, unspecified) | +| 580 Precondition failure | 127 (Interworking, unspecified) | +| 600 Busy Everywhere | 17 (User busy) | +| 603 Decline | 21 (Call rejected) | +| 604 Does not exist anywhere | 1 (Unassigned (unallocated) number) | +| 606 Not acceptable | 127 (Interworking, unspecified) | +| 607 Unwanted (NOTE) | 21 (Call rejected) | +| NOTE 1: The "607 Unwanted" SIP status code is defined in IETF RFC 8197 [65]. | | +| NOTE 2: The 428, 436, 437 and 438 SIP response codes are defined in IETF RFC 8224 [66]. | | + +If the MSC Server supports restoration procedures, the MSC Server shall in addition to the procedures in this clause perform the procedures in clause 5.3.10. + +**Table 5.3.8.2: Mapping of "cause" parameter for protocol "Q.850" to the cause information element** + +| Reason header field with protocol value "Q.850" | Cause information element | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------| +| "cause" parameter value | Cause value | +| 1 (Unallocated (unassigned) number) | 1 (Unallocated (unassigned) number) | +| 3 (No route to destination) | 3 (No route to destination) | +| 8 (Pre-emption) | 25 (Pre-emption) | +| 16 (Normal call clearing) | 16 (Normal call clearing) | +| 17 (User busy) | 17 (User busy) | +| 18 (No user responding) | 18 (No user responding) | +| 19 (No answer from user (user alerted)) | 19 (User alerting, no answer) | +| 21 (Call rejected) | 21 (Call rejected) | +| 22 (Number changed) | 22 (Number changed) | +| 24 (Call rejected due to feature at the destination) | 24 (Call rejected due to feature at the destination) | +| 26 (Non-selected user clearing) | 26 (Non selected user clearing) | +| 27 (Destination out of order) | 27 (Destination out of order) | +| 28 (Invalid number format (address incomplete)) | 28 (Invalid number format (incomplete number)) | +| 29 (Facility rejected) | 29 (Facility rejected) | +| 31 (Normal, unspecified)
(class default) (NOTE 1, NOTE 2) | 31 (Normal, unspecified) | +| 34 (No circuit/channel available) | 34 (No circuit/channel available) | +| 38 (Network out of order) | 38 (Network out of order) | +| 41 (Temporary failure) | 41 (Temporary failure) | +| 42 (Switching equipment congestion) | 42 (Switching equipment congestion) | +| 43 (Access information discarded) | 43 (Access information discarded) | +| 44 (Requested circuit/channel not available) | 44 (requested circuit/channel not available) | +| 47 (Resource unavailable, unspecified)
(class default) (NOTE 3) | 47 (Resource unavailable, unspecified) | +| 50 (Requested facility not subscribed) | 50 (Requested facility not subscribed) | +| 55 (Incoming calls barred within CUG) | 55 (Incoming calls barred within the CUG) | +| 57 (Bearer capability not authorised) | 57 (Bearer capability not authorised) | +| 58 (Bearer capability not presently available) | 58 (Bearer capability not presently available) | +| 63 (Service option not available, unspecified)
(class default) (NOTE 4) | 63 (Service option not available, unspecified) | +| 65 (Bearer capability not implemented) | 65 (Bearer capability not implemented) | +| 69 (Requested facility not implemented) | 69 (Requested facility not implemented) | +| 70 (Only restricted digital information capability is available) | 70 (Only restricted digital information capability is available) | +| 79 (Service or option not implemented, unspecified)
(class default) (NOTE 5) | 79 (Service or option not implemented, unspecified) | +| 87 (User not member of CUG) | 87 (User not member of CUG) | +| 88 (Incompatible destination) | 88 (Incompatible destination) | +| 91 (Invalid transit network selection) | 91 (Invalid transit network selection) | +| 95 (Invalid message, unspecified)
(class default) (NOTE 6) | 95 (Semantically incorrect message) | +| 97 (Message type non-existent or not implemented) | 97 (Message type non-existent or not implemented) | +| 98 (Message not compatible with call state or message type non-existent or not implemented) | 98 (Message type not compatible with protocol state) | +| 99 (Information element/parameter non-existent or not implemented) | 99 (Information element non-existent or not implemented) | +| 102 (Recovery on timer expiry) | 102 (Recovery on timer expiry) | +| 111 (Protocol error, unspecified)
(class default) (NOTE 7) | 111 (Protocol error, unspecified) | +| 127 (Interworking, unspecified)
(class default) (NOTE 8) | 127 (Interworking, unspecified) | +| NOTE 1: Class 0 and class 1 have the same default value. | | +| NOTE 2: All other values in the range 0 to 31 not appearing in table shall be treated as cause 31. | | +| NOTE 3: All other values in the range 32 to 47 not appearing in table shall be treated as cause 47. | | +| NOTE 4: All other values in the range 48 to 63 not appearing in table shall be treated as cause 63. | | +| NOTE 5: All other values in the range 64 to 79 not appearing in table shall be treated as cause 79. | | +| NOTE 6: All other values in the range 80 to 95 not appearing in table shall be treated as cause 95. | | +| NOTE 7: All other values in the range 96 to 111 not appearing in table shall be treated as cause 111. | | +| NOTE 8: All other values in the range 112 to 127 not appearing in table shall be treated as cause 127. | | +| NOTE 9: There are values which are specified in ITU-T Recommendation Q.850 [67] but not included in the present table. The reasons for not including them are: | | +|
  • - the corresponding value is not specified in 3GPP TS 24.008 [3]; or
  • - the value is specified in 3GPP TS 24.008 [3] but not applicable to be sent to the user (for example value 6 "Channel unacceptable").
| | + +**Table 5.3.8.3: Mapping of SIP Reason header field location parameter to location parameter of Cause information element** + +| Reason header field with protocol value "Q.850" | Cause information element | +|--------------------------------------------------------|-----------------------------------------| +| "location" parameter value | "Location" parameter value | +| U | user | +| LPN | private network serving the local user | +| LN | public network serving the local user | +| TN | transit network | +| RLN | public network serving the remote user | +| RPN | private network serving the remote user | +| LOC-6 | network beyond interworking point | +| INTL | international network | +| LOC-8 | network beyond interworking point | +| LOC-9 | network beyond interworking point | +| BI | network beyond interworking point | +| LOC-11 | network beyond interworking point | +| LOC-12 | network beyond interworking point | +| LOC-13 | network beyond interworking point | +| LOC-14 | network beyond interworking point | +| LOC-15 | network beyond interworking point | + +### 5.3.9 Receipt of DISCONNECT + +If the MSC Server receives a DISCONNECT message from the UE prior to receiving a final response to the initial INVITE, the MSC Server shall send a CANCEL request. If a 200 OK response to the initial INVITE is received after sending the CANCEL request, the MSC Server shall send a BYE request to the IM CN subsystem to terminate the session. + +If the DISCONNECT message contains one or more cause information elements, the first cause information element shall be mapped to a Reason header field in the CANCEL or BYE request as follows: + +- set the protocol field to "Q.850"; and +- set the numeric "cause" parameter value to the cause value field of the cause information element according to table 5.4.8.1.2. + +NOTE: The inclusion of reason-text in the Reason header is implementation specific. + +If, as a network option, the MSC Server supports the location header field parameter as described in IETF RFC 8606 [68], the MSC Server shall map the location parameter of the cause information element to the location parameter in the SIP Reason header field according to table 5.4.8.1.3. + +### 5.3.10 Restoration procedures + +If the MSC Server receives a SIP 504 (Server Time-out) response and all the following conditions are fulfilled: + +- 1) there is no re-registration ongoing; +- 2) a P-Asserted-Identity header field set to a value equal to an URI: + - from the Service-Route header field value received during registration; or + - from the Path header field value received during registration; and +- 3) the SIP response contains a Content-Type header field set to "application/3gpp-ims+xml" as defined in 3GPP TS 24.229 [2] clause 7.6; and +- 4) the SIP response includes an IM CN subsystem XML body as specified in 3GPP TS 24.229 [2] clause 7.6 with the element, including a version attribute, with the child element: + +- with the child element set to "restoration" (see 3GPP TS 24.229 [2] table 7.6.2); and +- with the child element set to "initial-registration" (see 3GPP TS 24.229 [2] table 7.6.3); + +then the MSC Server shall initiate restoration procedures by performing an initial registration as specified in clause 5.2.1. + +If the MSC Server is unsuccessful to send an initial SIP INVITE request to the next hop determined by one of the following: + +- there is no response to the SIP INVITE request by the MSC Server; or +- by unspecified means available to the MSC Server; + +and if there is no re-registration ongoing then the MSC Server may initiate restoration procedures by performing an initial registration as specified in clause 5.2.1. + +NOTE: If there is an ongoing re-registration and the conditions in this clause for initiating an initial registration were fulfilled the MSC Server regards this user as not registered and waits until a successful registration before sending any more INVITE request for this user. Meanwhile the MSC Server can fall back to the procedures for non ICS UE attached to a legacy MSC for call establishment as described in 3GPP TS 23.292 [5]. + +### 5.3.11 Autonomous clearing initiated by the MSC Server + +If the MSC Server determines due to internal procedures that the call shall be released, call release shall be in accordance with 3GPP TS 24.008 [3] clause 5.4.4 with the additional interworking defined here. + +The MSC Server shall send a SIP-CANCEL request as specified in 3GPP TS 24.229 [2] to the IM CN subsystem. The MSC Server shall include a Reason header field in the request populated as follows: + +- the protocol field set to "Q.850"; and +- a "cause" header field parameter aligned with the value used in the cause information element of the call clearing message towards the UE. + +NOTE: The inclusion of reason-text in the Reason header is implementation specific. + +## 5.4 Interworking of mobile terminating call setup from SIP to NAS signalling + +### 5.4.1 General + +The IM CN subsystem terminating session shall be established in accordance with 3GPP TS 24.292 [7] and 3GPP TS 24.229 [2]. The mobile terminating call shall be established at the visited MSC Server in accordance with 3GPP TS 23.018 [8] and 3GPP TS 24.008 [3]. The following subclauses describe the additional requirements for interworking between SIP and NAS signalling. + +### 5.4.2 Receipt of initial INVITE + +Upon receipt of an initial INVITE request, the MSC Server shall validate the INVITE request and SDP offer, if present, as described in 3GPP TS 24.292 [7]. + +After validating the INVITE request, the terminating party shall be validated as follows: + +- a) the MSC Server shall identify the terminating subscriber using the P-Called-Party-ID header or Request-URI from the INVITE request and use this to retrieve the VLR data; +- b) if the VLR data cannot be retrieved, the MSC Server shall send a 500 (Server Internal Error) response to the INVITE request and shall include the Reason header field with the protocol header field parameter set to "Q.850" and the cause header field parameter set to "20"; + +NOTE 1: The inclusion of the text header field parameter set to "Subscriber absent" in the Reason header field is implementation specific. + +- c) if the VLR data can be retrieved, the following check shall be performed: + - if the IMSI is detached, the MSC Server shall send a 480 (Temporarily unavailable) response to the INVITE request. + +Upon successful validation of the terminating party, the MSC Server shall initiate the establishment of a MM connection as specified in 3GPP TS 24.008 [3]. If a MM connection cannot be established (e.g. no PAGE RESPONSE message is received), the MSC Server shall send a 408 (Request Timeout) response to the INVITE request. + +If the initial INVITE request includes a MIME body (part) according to clause 4.4.1 of 3GPP TS 24.615 [44] with the "communication-waiting-indication" element contained in the "ims-cw" root element according to 3GPP TS 24.615 [44], and if the MSC Server determines that the incoming call can be presented to the subscriber as described in 3GPP TS 24.083 [26], then clause 5.6.4.1 applies. + +NOTE 2: Clause 5.6.8.3.1.4 contains additional applicable procedures executed upon receipt of an initial INVITE request if the MSC Server is as conference participant. + +The MSC Server shall store the "icid-value" header field parameter received in the P-Charging-Vector header field. + +If the received INVITE request: + +- a) does not contain a "precondition" option-tag in a Supported header field or in a Require header field, the MSC Server shall not make use of the SIP precondition mechanism; or +- b) contains the "precondition" option-tag in the Supported header field or in the Require header field and local configuration indicates support of the SIP precondition mechanism, the MSC Server shall make use of the SIP precondition mechanism and shall include the Require header field with the "precondition" option-tag in any corresponding response containing the SDP body, which the MSC Server sends towards to the originating end point. When the MSC Server sends a 183 (Session Progress) response with an SDP answer, the MSC Server shall only request confirmation for the result of the resource reservation (as defined in as defined in IETF RFC 3312 [59]) at the originating end point if an SDP offer has been received indicating that there are any remaining unfulfilled preconditions at the originating end point. + +If the MSC Server rejects the received INVITE request, then depending on operator policy, the MSC Server may insert in a SIP failure response a Response-Source header field with an "fe" header field parameter constructed with the URN namespace "urn:3gpp:fe", the "fe-id" part of the URN set to "msc-server" and the "role" header field parameter set to "msc-server-ics" in accordance with subclause 7.2.17 of 3GPP TS 24.229 [2]. + +### 5.4.3 Sending of SETUP + +After successful MM connection establishment, the MSC Server shall send a SETUP message as described in 3GPP TS 24.008 [3] with the following INVITE request interworking applied: + +- the MSC Server may include a bearer capability 1 information element set to indicate teleservice 11 as described in 3GPP TS 22.003 [9]; +- the MSC Server shall not include a bearer capability 2 information element; and +- the MSC Server shall build the calling party number BCD information element according to the tables 5.4.3.1 or 5.4.3.2 below. + +![Flowchart mapping INVITE message to SETUP message based on Privacy header and P-Asserted-Identity header.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` + +graph TD + Start([INVITE received]) --> Q1{Privacy header "id" +or "header" present?} + Q1 -- Yes --> Result1["digits = empty +Type of number = unknown +presentation restricted +Network provided"] + Q1 -- No --> Q2{Is P-Asserted-Id +present and +Id=E.164?} + + Q2 -- Yes --> NetOpt1[Network option] + NetOpt1 -- "#1 (From)" --> Q3{Is From = E.164? +and Privacy ? user} + NetOpt1 -- "#2 (PAI)" --> Result2["digits = P-Asserted-Id +Type of number = national +or international +presentation allowed +Network provided"] + + Q2 -- No --> NetOpt2[Network option] + NetOpt2 -- "#1 (From)" --> Q4{Is From = E.164? +and Privacy ? user} + NetOpt2 -- "#2 (PAI)" --> Result3["digits = empty +Type of number = unknown +presentation allowed +Network provided"] + + Q3 -- Yes --> Result4["digits = From +Type of number = national +or international +presentation allowed +User-provided, not screened"] + Q3 -- No --> Result2 + + Q4 -- Yes --> Result4 + Q4 -- No --> Result3 + +``` + +The flowchart illustrates the mapping of an INVITE message to a SETUP message. It starts with 'INVITE received' and checks for the presence of 'Privacy header "id" or "header"'. If present, the mapping results in 'digits = empty', 'Type of number = unknown', 'presentation restricted', and 'Network provided'. If not present, it checks if 'P-Asserted-Id' is present and has an 'Id=E.164' value. If yes, it proceeds to a 'Network option' box where path #1 (From) leads to a check if 'From = E.164' and 'Privacy ? user'. If that check is yes, it results in 'digits = From', 'Type of number = national or international', 'presentation allowed', and 'User-provided, not screened'. If no, or if path #2 (PAI) was taken, it results in 'digits = P-Asserted-Id', 'Type of number = national or international', 'presentation allowed', and 'Network provided'. If the 'P-Asserted-Id' check was no, it proceeds to another 'Network option' box where path #1 (From) leads to the same 'From = E.164' check, and path #2 (PAI) or a 'no' on the From check results in 'digits = empty', 'Type of number = unknown', 'presentation allowed', and 'Network provided'. + +Flowchart mapping INVITE message to SETUP message based on Privacy header and P-Asserted-Identity header. + +**Figure 5.4.3.1: Mapping of INVITE message (with From and/or P-Asserted-Identity) to SETUP message (informative)** + +The default mapping is based on table 5.4.3.1. + +As a network option, the mapping described in table 5.4.3.2 can be applied to create the calling party number BCD information element in the SETUP message based on the From header field in the following cases: + +- when the received P-Asserted-Identity header field and the From header field contain URIs with an E.164 number format and the Privacy header field does not contain values "id", "header" or "user"; or +- when the P-Asserted-Identity header field is absent or not in the E.164 number format and the received From header field contains the URI with an E.164 number format and the Privacy header field does not contain values "id", "header" or "user". + +**Table 5.4.3.1: Setting of the calling party BCD number information element in SETUP message from P-Asserted-Identity** + +| SIP Component | Value | Calling party BCD number information element | Value | +|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------|----------------------------------------------|---------------------------------------------------------------------------| +| P-Asserted-Identity header field (NOTE 1, NOTE 2) and Privacy header field | E.164 number

and
Priv-value≠ "id" or "header" | Digits | digits contained in tel URI or SIP URI | +| | | Type of number | "national number" or "international number" | +| | | Numbering Plan Identification | "ISDN/telephony numbering plan" | +| | | Presentation Indicator | "presentation allowed" | +| | | Screening indicator | "Network provided" (NOTE 5) | +| P-Asserted-Identity header field present or not and Privacy header field is present | priv-value= "id" or "header" | Digits | do not include any number digits fields | +| | | Type of number | "unknown" | +| | | Numbering Plan Identification | "unknown" | +| | | Presentation Indicator | "presentation restricted" | +| | | Screening indicator | "Network provided" (NOTE 5) | +| P-Asserted-Identity header field

and
Privacy header field | Absent or other than E.164 number

and
Priv-value≠ "id" or "header" | Digits | do not include any number digits fields except for NOTE 3 and NOTE 4 case | +| | | Type of number | "unknown" | +| | | Numbering Plan Identification | "unknown" | +| | | Presentation Indicator | "presentation allowed" | +| | | Screening indicator | "Network provided" (NOTE 5) | +| Privacy header field | priv-value | Presentation Indicator | "Presentation Indicator" | +| priv-value | "header" | Presentation Indicator | Presentation restricted | +| | "user" | Presentation Indicator | Presentation allowed | +| | "none" | Presentation Indicator | Presentation allowed | +| | "id" | Presentation Indicator | Presentation restricted | + +NOTE 1: It is possible that a P-Asserted-Identity header field includes both a tel URI and a SIP or SIPS URI. In this case, either the tel URI or the SIP URI with user="phone" and a specific host portion, as selected by operator policy, may be used. + +NOTE 2: The number mapping does not include any digits contained in the phone-context parameter. + +NOTE 3: If a display-name is present in the P-Asserted-Identity header and if the MSC Server supports the network option of mapping display name to calling name identity, the MSC Server may use the P-Asserted-Identity header to build a facility information element with a name indicator parameter set to the display name. + +NOTE 4: Interworking of display name received in conjunction with a tel URI or SIP URI to calling name presentation using CNAP is subject to local regulatory requirements on calling line identity and whether the originating network of the call is trusted to provide an authentic identity. + +NOTE 5: As a network option, the MSC Server may support "Calling number verification using signature verification and attestation information" feature defined in 3GPP TS 24.229 [2]. If the MSC Server received a "verstat" tel URI parameter (defined in 3GPP TS 24.229 [2] clause 7.2A.20) in the P-Asserted-Identity header field the MSC Server may map the "verstat" tel URI parameter to the Screening Indicator field as follows: +- the value "No-TN-Validation" to the value "User-provided, not screened"; +- the value "TN-Validation-Passed" to the value "User-provided, verified and passed"; and +- the value "TN-Validation-Failed" to the value "User-provided, verified and failed". + +**Table 5.4.3.2: Setting of the calling party BCD number information element in SETUP message from From header field** + +| SIP Component | Value | Calling party BCD number information element | Value | +|-------------------------------------------------------------|------------------------------------------------|----------------------------------------------|---------------------------------------------------------------------------| +| From header field (NOTE 1, NOTE 2) and Privacy header field | E.164 number and Priv-value≠ "user" | Digits | digits contained in tel URI or SIP URI | +| | | Type of number | "national number" or "international number" | +| | | Numbering Plan Identification | "ISDN/telephony numbering plan" | +| | | Presentation Indicator | "presentation allowed" | +| | | Screening indicator | "User-provided, not screened" (NOTE 5) | +| From header field and Privacy header field | other than E.164 number and Priv-value≠ "user" | Digits | do not include any number digits fields except for NOTE 3 and NOTE 4 case | +| | | Type of number | "unknown" | +| | | Numbering Plan Identification | "unknown" | +| | | Presentation Indicator | "presentation allowed" | +| | | Screening indicator | "User-provided, not screened" (NOTE 5) | +| Privacy header field | priv-value | Presentation Indicator | "Presentation Indicator" | +| priv-value | "header" | Presentation Indicator | Presentation allowed | +| | "user" | Presentation Indicator | Presentation restricted | +| | "none" | Presentation Indicator | Presentation allowed | +| | "id" | Presentation Indicator | Presentation allowed | + +NOTE 1: It is possible that a From header field includes both a tel URI and a SIP or SIPS URI. In this case, either the tel URI or the SIP URI with user="phone" and a specific host portion, as selected by operator policy, may be used. + +NOTE 2: The number mapping does not include any digits contained in the phone-context parameter. + +NOTE 3: If a display-name is present in the From header and if the MSC Server supports the network option of mapping display name to calling name identity, the MSC Server may use the From header to build a facility information element with a name indicator parameter set to the display name. + +NOTE 4: Interworking of display name received in conjunction with a tel URI or SIP URI to calling name presentation using CNAP is subject to local regulatory requirements on calling line identity and whether the originating network of the call is trusted to provide an authentic identity. + +NOTE 5: As a network option, the MSC Server may support "Calling number verification using signature verification and attestation information" feature defined in 3GPP TS 24.229 [2]. If the MSC Server received a "verstat" tel URI parameter (defined in 3GPP TS 24.229 [2] clause 7.2A.20) in the From header field the MSC Server may map the "verstat" tel URI parameter to the Screening Indicator field as follows: + +- the value "No-TN-Validation" to the value "User-provided, not screened"; +- the value "TN-Validation-Passed" to the value "User-provided, verified and passed"; and +- the value "TN-Validation-Failed" to the value "User-provided, verified and failed". + +### 5.4.4 Receipt of CALL CONFIRMED + +Upon receipt of a CALL CONFIRMED message: + +- if a bearer capabilities 1 information element is present and indicates a teleservice other than 11 as described in 3GPP TS 22.003 [9], the MSC Server shall initiate call clearing procedures using a cause value of 58 (bearer capability not presently available); +- if a bearer capabilities 1 information element is present and includes a CTM text telephony indication set to "CTM text telephony is supported", the default behaviour of the MSC Server shall be to continue with call setup but not to provide user plane interworking between CTM and real-time-text at the CS-MGW. + +NOTE: Conversion between CTM as described in 3GPP TS 26.226 [22] and real-time-text as described in 3GPP TS 26.114 [28] may be provided as an implementation option if the SDP offer included the payload type for real-time-text. Such conversion is outside the scope of the present document. + +### 5.4.5 Bearer establishment + +#### 5.4.5.1 Network side bearer establishment + +If the initial INVITE request contained an SDP offer, the MSC Server should use the codecs received in the SDP offer and determine the codecs supported by the UE as specified in 3GPP TS 24.008 [3] to select and return a single codec in the SDP answer. + +The MSC Server shall reject all non-audio media descriptions from the SDP offer in the SDP answer. + +The SDP answer shall be returned in the first reliable response. + +If the initial INVITE request did not contain an SDP offer, the MSC Server should determine the codecs supported by the UE as specified in 3GPP TS 24.008 [3] and use this information when constructing a codec list for the SDP offer and send the SDP offer in the first reliable response to the INVITE request. + +#### 5.4.5.2 Access bearer assignment + +The MSC Server shall initiate access bearer assignment only after the following conditions are satisfied: + +- the incoming side RTP connection point has been successfully reserved and configured in the CS-MGW; and +- either: + - preconditions were not requested in the SDP of the initial INVITE request; or + - an SDP offer has been received indicating that remote preconditions have been met. + +For UTRAN and GERAN Iu-mode, the NAS Synchronisation Indicator information element shall be used to inform the UE of the selected codec as specified in 3GPP TS 24.008 [3]. + +#### 5.4.5.3 Transcoding + +The CS-MGW may include a speech transcoder based upon the speech coding information provided to each bearer termination. + +### 5.4.6 Receipt of ALERTING + +Upon receipt of the ALERTING message from the UE, the MSC Server shall send a 180 Ringing response. + +NOTE: Starting timer T301 (or a corresponding internal alerting supervision timing function) as specified in 3GPP TS 24.008 [3] at the MSC Server is an implementation option. The default value for T301 in 3GPP TS 24.008 [3] is longer than the range specified for the IM CN subsystem's no reply timer specified in 3GPP TS 24.604 [23], which should allow the IM CN subsystem to properly control CFNA. However, if T301 is started and expires prior to the no reply timer in the IM CN subsystem, the non-2xx response returned to the IM CN subsystem will prevent invocation of the CFNA service. + +### 5.4.7 Applying early media + +The MSC Server may instruct the CS-MGW to apply ringback tone or an announcement towards the IM CN subsystem in the following condition: + +- the MSC Server supports the P-Early-Media header as a network option; and +- the P-Early-Media header was received in the initial INVITE request. + +If these conditions are met and the MSC Server chooses to apply early media, the following actions are taken: + +- prior to applying an announcement, the MSC Server shall include in the 183 Session Progress response a P-Early-Media header authorizing backward early media; +- prior to applying ringback tone, the MSC Server shall include in the 180 Ringing response a P-Early-Media header authorizing backward early media. + +### 5.4.8 Call rejection or abandonment + +#### 5.4.8.1 Receipt of RELEASE COMPLETE or DISCONNECT + +If the MSC Server receives a RELEASE COMPLETE or DISCONNECT message from the UE during call establishment, the MSC Server shall send a status-code 4xx, 5xx or 6xx response to the initial INVITE. The status-code sent shall be determined by examining the first cause information element received in the RELEASE COMPLETE or DISCONNECT message and applying the mapping specified in table 5.4.8.1.1. + +**Table 5.4.8.1.1: Mapping the cause information element to the 4xx/5xx/6xx status-code** + +| Cause value | SIP status-code | +|------------------------------------------------|-----------------------------| +| 1 (Unassigned (unallocated) number) | 404 Not Found | +| 3 (No route to destination) | 500 Server Internal Error | +| 6 (Channel unacceptable) | 500 Server Internal Error | +| 8 (Operator determined barring) | 603 Decline | +| 16 (Normal call clearing) | 480 Temporarily Unavailable | +| 17 (User busy) | 486 Busy Here | +| 18 (No user responding) | 480 Temporarily Unavailable | +| 19 (User alerting, no answer) | 480 Temporarily Unavailable | +| 21 (Call rejected) | 603 Decline | +| 22 (Number changed) | 410 Gone | +| 25 (Pre-emption) | 480 Temporarily Unavailable | +| 26 (Non selected user clearing) | 480 Temporarily Unavailable | +| 27 (Destination out of order) | 502 Bad Gateway | +| 28 (Invalid number format (incomplete number)) | 484 Address Incomplete | +| 29 (Facility rejected) | 501 Not Implemented | +| 30 (Response to STATUS ENQUIRY) | 500 Server Internal Error | +| 31 (Normal, unspecified) | 480 Temporarily Unavailable | +| 34 (No circuit/channel available) | 480 Temporarily Unavailable | +| 38 (Network out of order) | 500 Server Internal Error | +| 41 (Temporary failure) | 500 Server Internal Error | +| 42 (Switching equipment congestion) | 500 Server Internal Error | +| 43 (Access information discarded) | 500 Server Internal Error | +| 44 (Requested circuit/channel not available) | 500 Server Internal Error | +| 47 (Resources unavailable, unspecified) | 500 Server Internal Error | +| 49 (Quality of service unavailable) | 500 Server Internal Error | + +| Cause value | SIP status-code | +|-------------------------------------------------------------------------|-----------------------------| +| 50 (Requested facility not subscribed) | 500 Server Internal Error | +| 55 (Incoming calls barred within the CUG) | 603 Decline | +| 57 (Bearer capability not authorized) | 500 Server Internal Error | +| 58 (Bearer capability not presently available) | 500 Server Internal Error | +| 63 (Service or option not available, unspecified) | 501 Not Implemented | +| 65 (Bearer service not implemented) | 500 Server Internal Error | +| 68 (ACM equal to or greater than ACMmax) | 500 Server Internal Error | +| 69 (Requested facility not implemented) | 501 Not Implemented | +| 70 (Only restricted digital information bearer capability is available) | 501 Not Implemented | +| 79 (Service or option not implemented, unspecified) | 501 Not Implemented | +| 81 (Invalid transaction identifier value) | 500 Server Internal Error | +| 87 (User not member of CUG) | 403 Forbidden | +| 88 (Incompatible destination) | 500 Server Internal Error | +| 91 (Invalid transit network selection) | 404 Not Found | +| 95 (Semantically incorrect message) | 500 Server Internal Error | +| 96 (Invalid mandatory information) | 500 Server Internal Error | +| 97 (Message type non-existent or not implemented) | 501 Not Implemented | +| 98 (Message type not compatible with protocol state) | 501 Not Implemented | +| 99 (Information element non-existent or not implemented) | 501 Not Implemented | +| 100 (Conditional IE error) | 500 Server Internal Error | +| 101 (Message not compatible with protocol state) | 500 Server Internal Error | +| 102 (Recovery on timer expiry) | 504 Server timeout | +| 111 (Protocol error, unspecified) | 500 Server Internal Error | +| 127 (Interworking, unspecified) | 480 Temporarily Unavailable | + +NOTE 1: Alternative mappings are allowed per operator policy. + +The first cause information element included in the RELEASE COMPLETE or DISCONNECT message shall be mapped to a Reason header field in the SIP final response sent as a result of this clause as follows: + +- set the protocol field to "Q.850"; and +- set the numeric "cause" parameter value to the cause value field of the cause information element according to table 5.4.8.1.2. + +NOTE 2: The inclusion of reason-text in the Reason header is implementation specific. + +If, as a network option, the MSC Server supports the location header field parameter as described in IETF RFC 8606 [68], the MSC Server shall map the location parameter of the cause information element to the location parameter in the SIP Reason header field according to table 5.4.8.1.3. + +**Table 5.4.8.1.2: Mapping of cause information element to "cause" parameter for protocol "Q.850"** + +| Cause information element | Reason header field with protocol value "Q.850" | +|--------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------| +| Cause value | "cause" parameter value | +| 1 (Unallocated (unassigned) number) | 1 (Unallocated (unassigned) number) | +| 3 (No route to destination) | 3 (No route to destination) | +| 6 (Channel unacceptable) | 6 (Channel unacceptable) | +| 16 (Normal call clearing) | 16 (Normal call clearing) | +| 17 (User busy) | 17 (User busy) | +| 18 (No user responding) | 18 (No user responding) | +| 19 (User alerting, no answer) | 19 (No answer from user (user alerted)) | +| 21 (Call rejected) | 21 (Call rejected) | +| 22 (Number changed) | 22 (Number changed) | +| 24 (Call rejected due to feature at the destination) | 24 (Call rejected due to feature at the destination) | +| 25 (Pre-emption) | 8 (Preemption) | +| 26 (Non selected user clearing) | 26 (Non-selected user clearing) | +| 27 (Destination out of order) | 27 (Destination out of order) | +| 28 (Invalid number format (incomplete number)) | 28 (Invalid number format (address incomplete)) | +| 29 (Facility rejected) | 29 (Facility rejected) | +| 30 (Response to STATUS ENQUIRY) | 30 (Response to STATUS ENQUIRY) | +| 31 (Normal, unspecified) (NOTE 1) | 31 (Normal, unspecified) | +| 34 (No circuit/channel available) | 34 (No circuit/channel available) | +| 38 (Network out of order) | 38 (Network out of order) | +| 41 (Temporary failure) | 41 (Temporary failure) | +| 42 (Switching equipment congestion) | 42 (Switching equipment congestion) | +| 43 (Access information discarded) | 43 (Access information discarded) | +| 44 (requested circuit/channel not available) | 44 (Requested circuit/channel not available) | +| 47 (Resource unavailable, unspecified) (NOTE 2) | 47 (Resource unavailable, unspecified) | +| 49 (Quality of service unavailable) | 49 (Quality of service not available) | +| 50 (Requested facility not subscribed) | 50 (Requested facility not subscribed) | +| 55 (Incoming calls barred within the CUG) | 55 (Incoming calls barred within CUG) | +| 57 (Bearer capability not authorised) | 57 (Bearer capability not authorised) | +| 58 (Bearer capability not presently available) | 58 (Bearer capability not presently available) | +| 63 (Service option not available, unspecified) (NOTE 3) | 63 (Service option not available, unspecified) | +| 65 (Bearer capability not implemented) | 65 (Bearer capability not implemented) | +| 69 (Requested facility not implemented) | 69 (Requested facility not implemented) | +| 70 (Only restricted digital information capability is available) | 70 (Only restricted digital information capability is available) | +| 79 (Service or option not implemented, unspecified) (NOTE 4) | 79 (Service or option not implemented, unspecified) | +| 81 (Invalid transaction identifier value) | 81 (Invalid call reference value) | +| 87 (User not member of CUG) | 87 (User not member of CUG) | +| 88 (Incompatible destination) | 88 (Incompatible destination) | +| 91 (Invalid transit network selection) | 91 (Invalid transit network selection) | +| 95 (Semantically incorrect message) (NOTE 5) | 95 (Invalid message, unspecified) | +| 97 (Message type non-existent or not implemented) | 97 (Message type non-existent or not implemented) | +| 98 (Message type not compatible with protocol state) | 98 (Message not compatible with call state or message type non-existent or not implemented) | +| 99 (Information element non-existent or not implemented) | 99 (Information element/parameter non-existent or not implemented) | +| 101 (Message not compatible with protocol state) | 101 (Message not compatible with call state) | +| 102 (Recovery on timer expiry) | 102 (Recovery on timer expiry) | +| 111 (Protocol error, unspecified) (NOTE 6) | 111 (Protocol error, unspecified) | +| 127 (Interworking, unspecified) (NOTE 7) | 127 (Interworking, unspecified) | +| NOTE 1: All other values in the range 0 to 31 not appearing in table shall be treated as cause 31. | | +| NOTE 2: All other values in the range 32 to 47 not appearing in table shall be treated as cause 47. | | +| NOTE 3: All other values in the range 48 to 63 not appearing in table shall be treated as cause 63. | | +| NOTE 4: All other values in the range 64 to 79 not appearing in table shall be treated as cause 79. | | +| NOTE 5: All other values in the range 80 to 95 not appearing in table shall be treated as cause 95. | | +| NOTE 6: All other values in the range 96 to 111 not appearing in table shall be treated as cause 111. | | +| NOTE 7: All other values in the range 112 to 127 not appearing in table shall be treated as cause 127. | | + +**Table 5.4.8.1.3: Mapping of location parameter of Cause information element to SIP Reason header field location parameter** + +| Cause information element | Reason header field with protocol value "Q.850" | +|-----------------------------------------|-------------------------------------------------| +| "Location" parameter value | "location" parameter value | +| user | U | +| private network serving the local user | LPN | +| public network serving the local user | LN | +| transit network | TN | +| public network serving the remote user | RLN | +| private network serving the remote user | RPN | +| international network | INTL | +| network beyond interworking point | BI | + +#### 5.4.8.2 Receipt of CANCEL or BYE + +If the MSC Server receives a CANCEL or BYE request, the MSC Server shall initiate call clearing procedures by sending a DISCONNECT message towards the UE as described in 3GPP TS 24.008 [3] with the following interworking applied: + +- if one or more Reason header fields are included in the CANCEL or BYE request, then the cause value of each Reason header field shall be mapped to a cause information element in the DISCONNECT message as follows: + - a) if the Reason header field contains the protocol header field parameter set to "Q.850", or "SIP" with a cause header field parameter value other than "200", the cause information element shall be built as described in clause 5.3.8; and + - b) if the Reason header field contains the protocol header field parameter set to "SIP", the cause header field parameter set to "200" as specified in IETF RFC 3326 [45], the cause information element shall be set to cause value 13 (call completed elsewhere). +- if no Reason header field is included in the CANCEL or BYE request, a cause value set to 31 (normal, unspecified), coding standard set to "Standard defined for the GSM PLMNs" and location set to "network beyond interworking point" shall be used in the cause information element in the DISCONNECT message. + +### 5.4.9 Receipt of CONNECT + +Upon receipt of the CONNECT message from the UE, the MSC Server shall send a 200 OK response to the initial INVITE. + +Interworking applied for the TIR services is described in clause 5.6.2.2. + +### 5.4.10 Call failure procedures + +The MSC Server shall handle call failures (e.g. timer expiration) during mobile terminating call establishment in accordance with 3GPP TS 24.008 [3]. The cause value used towards the calling user as specified in 3GPP TS 24.008 [3] shall be mapped to a final response to the INVITE request as specified in clause 5.4.8.1. + +### 5.4.11 Autonomous clearing initiated by the MSC Server + +If the MSC Server determines due to internal procedures that the call shall be released, call release shall be in accordance with 3GPP TS 24.008 [3] clause 5.4.4 with the additional interworking defined here. + +NOTE 1: If a SIP 200 (OK) response has been sent but the SIP ACK request is not yet received, the procedure in clause 5.5.4 is used instead. + +Depending on the reason for the clearing, the MSC Server shall send a SIP 4xx or 5xx response as specified in 3GPP TS 24.229 [2] to the IM CN subsystem. The MSC Server shall include a Reason header field populated as follows: + +- the protocol field set to "Q.850"; and + +- a "cause" header field parameter aligned with the value used in the cause information element of the call clearing message towards the UE. + +NOTE 2: The inclusion of reason-text in the Reason header is implementation specific. + +## 5.5 Interworking of established call clearing between NAS signalling and SIP + +### 5.5.1 General + +The following subclauses define the procedure and signalling interworking performed by the MSC Server for call clearing of an established call. This interworking is independent of the direction of original call establishment. + +Call clearing during call setup is described in subclauses 5.3.7, 5.3.8, 5.3.9, 5.4.8.1 and 5.4.10. + +### 5.5.2 Clearing initiated by the mobile + +MSC Server handling of call clearing initiated by the mobile shall be in accordance with 3GPP TS 24.008 [3] with the additional interworking defined here. + +Upon receipt of a DISCONNECT message, the MSC Server shall send a BYE request as specified in 3GPP TS 24.229 [2] to the IM CN subsystem. The first cause information element in the DISCONNECT message shall be included in a Reason header field in the BYE request as follows: + +- set the protocol value to "Q.850"; and +- set the numeric "cause" parameter value to the cause value field of the cause information element according to table 5.4.8.1.2. + +NOTE: The inclusion of the "text" header field parameter in the Reason header field is implementation specific. + +If, as a network option, the MSC Server supports the location header field parameter as described in IETF RFC 8606 [68], the MSC Server shall map the location parameter of the cause information element to the location parameter in the SIP Reason header field according to table 5.4.8.1.3. + +### 5.5.3 Clearing initiated by the IM CN subsystem + +Upon receipt of a BYE request, the MSC Server shall send a DISCONNECT message towards the mobile. If one or more Reason header fields is included in the BYE request, each Reason header field shall be mapped to a cause information element in the DISCONNECT message according to clause 5.3.8. + +If no Reason header is present, a cause information element value of 16 (Normal call clearing) shall be used. + +### 5.5.4 Autonomous clearing initiated by the MSC Server + +If the MSC Server determines due to internal procedures that the call shall be released, call release shall be in accordance with 3GPP TS 24.008 [3] with the additional interworking defined here. + +The MSC Server shall send a BYE request to the IM CN subsystem. The MSC Server shall align according to table 5.4.8.1.2 the value used in the cause information element in the DISCONNECT message with the value used in the "cause" parameter for the "Q.850" protocol field in the Reason header of the BYE request. + +## 5.6 Supplementary Services invocation + +### 5.6.1 Originating identification presentation/restriction (OIP/OIR) + +The interworking required for OIP is defined in clause 5.4.3. + +The interworking required for OIR is defined in clause 5.3.3.2. + +### 5.6.2 Terminating identification presentation/restriction (TIP/TIR) + +#### 5.6.2.1 Terminating identification presentation (TIP) + +When interworking a SIP 200 OK (INVITE) response to a CONNECT message as described in clause 5.3.6, a MSC Server which supports the normal operation of the connected number supplementary service as described in 3GPP TS 24.081 [12] shall apply the following interworking for the TIP supplementary service: + +- if a P-Asserted-Identity header containing a tel URI or a SIP URI with "user=phone" is present, the MSC Server shall use this header to build a connected number information element as follows: + - if the tel URI or number within the userinfo part of the SIP URI is in international format, set the type of number to "international number", otherwise set the type of number to "national number"; and + - set the number plan identification to "ISDN/telephony numbering plan"; and + - set the presentation indicator to "presentation allowed"; and + - set the screening indicator to "network provided"; and + - set the number digits fields to the telephone number contained in the tel URI or the userinfo part of the SIP URI; or + +NOTE 1: If the P-Asserted-Identity header contains both a tel URI and a SIP URI with "user=phone", the URI used for mapping is implementation specific. + +NOTE 2: The number mapping does not include any digits contained in the phone-context parameter. + +- if a P-Asserted-Identity header is present but does not contain a tel URI or a SIP URI with "user=phone", the MSC Server shall build a connected number information element as follows: + - set the type of number to "unknown"; and + - set the number plan identification to "unknown"; and + - set the presentation indicator to "number not available due to interworking"; and + - set the screening indicator to "network provided"; and + - do not include any number digits fields; or +- if no P-Asserted-Identity header is present but a Privacy header with priv-value set to "id" is present, the MSC Server shall build a connected number information element as follows: + - set the type of number to "unknown"; and + - set the number plan identification to "unknown"; and + - set the presentation indicator to "presentation restricted"; and + - set the screening indicator to "network provided"; and + - do not include any number digits fields; or +- if neither a P-Asserted-Identity header nor a Privacy header field with a priv-value set to "id" is present, then no connected number information element shall be included. + +#### 5.6.2.2 Terminating identification restriction (TIR) + +The MSC Server shall not include a Privacy header in any response to an INVITE request. + +NOTE: 3GPP TS 24.081 [12] does not provide a mechanism for a terminator to temporarily override default settings for this service. The inclusion of a Privacy header could lead to the AS serving the terminating user to mistakenly assume that a default setting is being temporarily overridden by the terminating user. Omitting the Privacy header allows the AS supporting the terminating user to perform the appropriate actions for the TIR service in "permanent mode" as specified in 3GPP TS 24.608 [14]. + +### 5.6.3 Communication Hold (HOLD) + +#### 5.6.3.1 HOLD initiated via NAS signalling + +##### 5.6.3.1.1 Hold + +When the MSC Server receives a HOLD message as specified in 3GPP TS 24.083 [26] and the media on the IM CN subsystem side of the CS-MGW is "sendonly" or "inactive", no interworking is required and the MSC Server shall send a HOLD ACKNOWLEDGE message to the UE as specified in 3GPP TS 24.083 [26]. If the media on the IM CN subsystem side is "recvonly" or "sendrecv", the MSC Server shall send an UPDATE or re-INVITE request containing an SDP offer configured as follows: + +- mark the media as "sendonly" or "inactive" as described in 3GPP TS 24.610 [27]; and +- if RTCP is disabled for this media stream, include RR and RS bandwidth modifiers with values greater than zero to enable RTCP as described in 3GPP TS 26.114 [28] clause 7.3.1. + +Upon receipt of the SDP answer in a 200 OK response to the UPDATE or re-INVITE request, the MSC Server shall send a HOLD ACKNOWLEDGE message to the UE as specified in 3GPP TS 24.083 [26]. + +If the SDP offer is rejected or a non-200 response is received to the UPDATE or re-INVITE request, the MSC Server shall send a HOLD REJECT message to the UE as specified in 3GPP TS 24.083 [26] with cause parameter set to "Facility rejected". + +##### 5.6.3.1.2 Resume + +When the MSC Server receives a RETRIEVE message as specified in 3GPP TS 24.083 [26] and the media on the IM CN subsystem side of the CS-MGW is "recvonly" or "sendrecv", no interworking is required and the MSC Server shall send a RETRIEVE ACKNOWLEDGE message to the UE as specified in 3GPP TS 24.083 [26]. If the media on the IM CN subsystem side is "sendonly" or "inactive", the MSC Server shall send an UPDATE or re-INVITE request containing an SDP offer with media marked as "recvonly" or "sendrecv" as described in 3GPP TS 24.610 [27]. The MSC Server may include RR and RS bandwidth modifiers set to zero in the SDP offer to disable RTCP. + +Upon receipt of the SDP answer in a 200 OK response to the UPDATE or re-INVITE request, the MSC Server shall send a RETRIEVE ACKNOWLEDGE message to the UE as specified in 3GPP TS 24.083 [26]. + +If the SDP offer is rejected or a non-200 response is received to the UPDATE or re-INVITE request, the MSC Server shall send a RETRIEVE REJECT message to the UE as specified in 3GPP TS 24.083 [26] with cause parameter set to "Facility rejected". + +#### 5.6.3.2 HOLD initiated via SIP signalling + +##### 5.6.3.2.1 Hold + +The IM CN subsystem makes a hold request by sending an UPDATE or re-INVITE request with an "inactive" or "sendonly" SDP attribute, depending on the current state of the session. Upon receipt of a hold request from the IM CN subsystem, the MSC Server shall perform the following interworking: + +- if the MSC Server received a non-zero SS screening indicator as defined in 3GPP TS 24.080 [29] from the UE, the MSC Server shall send a FACILITY message indicating the call has been placed on hold as specified in 3GPP TS 24.083 [26]; +- if the MSC Server did not receive a non-zero SS screening indicator from the UE, the MSC Server shall not send any message to the UE. + +##### 5.6.3.2.2 Resume + +The IM CN subsystem requests to resume a session by sending an UPDATE or re-INVITE request with an "recvonly" or "sendrecv" SDP attribute, depending on the current state of the session. Upon receipt of a resume request from the IM CN subsystem, the MSC Server shall perform the following interworking: + +- if the MSC Server received a non-zero SS screening indicator as defined in 3GPP TS 24.080 [29] from the UE, the MSC Server shall send a FACILITY message indicating the call has been retrieved as specified in 3GPP TS 24.083 [26]; +- if the MSC Server did not receive a non-zero SS screening indicator from the UE, the MSC Server shall not send any message to the UE. + +### 5.6.4 Communication Waiting (CW) + +#### 5.6.4.1 Receipt of initial INVITE + +NOTE: Clause 5.4.2 contains general applicable procedures executed upon receipt of an initial INVITE request. + +If the initial INVITE request includes: + +- a MIME body (part) according to clause 4.4.1 of 3GPP TS 24.615 [44] with the "communication-waiting-indication" element contained in the "ims-cw" root element according to 3GPP TS 24.615 [44]; or +- does not contain a Replaces header field corresponding to a established dialog and the target of the INVITE request is engaged in the established SIP dialog; + +then, upon interworking the initial INVITE request to a SETUP message as described in clause 5.4.3, the MSC Server shall apply the following additional interworking: + +- the MSC Server shall include a Signal information element with value 7 (call waiting tone on); and +- if the INVITE request includes a MIME body (part) according to clause 4.4.1 of 3GPP TS 24.615 [44] with the "communication-waiting-indication" element contained in the "ims-cw" root element according to 3GPP TS 24.615 [44]: +- the MSC Server shall store an indication that this session includes a CW AS; and +- the MSC Server may start timer TUE-CW as described in 3GPP TS 24.615 [44]. + +If the CALL CONFIRMED message received by the MSC Server during mobile terminating call setup contains a Cause information element set to a value of 17 (User busy), then upon interworking the subsequent ALERTING message to a 180 Ringing response as described in clause 5.4.6, the MSC Server shall apply the following additional interworking: + +- the MSC Server shall insert an Alert-Info header set to "urn:alert:service:call-waiting" as described in 3GPP TS 24.615 [44] into the 180 Ringing response. + +#### 5.6.4.2 Accepting the waiting call + +If the subscriber chooses to accept the waiting call and put the existing call on hold, the MSC Server shall: + +- upon receipt of the HOLD message for the existing call, apply the interworking specified in clause 5.6.3.1.1; and +- upon receipt of the CONNECT message for the waiting call, stop timer TUE-CW if it was started and apply the interworking specified in clause 5.4.9. + +If the subscriber chooses to accept the waiting call and release the existing call, the MSC Server shall: + +- upon receipt of the DISCONNECT message for the existing call, apply the interworking specified in clause 5.5.2; and +- upon receipt of the CONNECT message for the waiting call, stop timer TUE-CW if it was started and apply the interworking specified in clause 5.4.9. + +#### 5.6.4.3 Rejecting the waiting call + +If the MSC Server receives a first clearing message from the UE during call establishment, the cause value used towards the calling user as specified in 3GPP TS 24.008 [3] shall be mapped to a final response to the INVITE request as specified in clause 5.4.8.1, except for cause codes: + +- 19 (User alerting, no answer) and 18 (No user responding). A first clearing message from the UE during call establishment with cause code 19 (User alerting, no answer) or 18 (No user responding) shall be mapped to the 480 (Temporarily unavailable) final response including a Reason header field (see RFC 3326 [45]) with the protocol set to "Q.850" and the cause set to "19" or "18", respectively; +- 63 (Service or option not available, unspecified) and 69 (Requested facility not implemented): + - if the MSC Server stored an indication that the session includes a CW AS, a first clearing message from the UE during call establishment with cause code 63 (Service or option not available, unspecified) or 69 (Requested facility not implemented) used towards the calling user as specified in 3GPP TS 24.008 [3] shall be mapped to the 415 (Unsupported Media Type) final response; or + - if the MSC Server did not store an indication that the session includes a CW AS, the cause codes 63 (Service or option not available, unspecified) and 69 (Requested facility not implemented) used towards the calling user as specified in 3GPP TS 24.008 [3] shall be mapped to a final response to the INVITE request as specified in clause 5.4.8.1. + +Depending on operator policy, the MSC Server may insert in a SIP failure response a Response-Source header field with an "fe" header field parameter constructed with the URN namespace "urn:3gpp:fe", the "fe-id" part of the URN set to "msc-server" and the "role" header field parameter set to "msc-server-ics" in accordance with subclause 7.2.17 of 3GPP TS 24.229 [2]. + +The MSC Server shall stop timer TUE-CW if it was started. + +#### 5.6.4.4 Communication release during waiting condition + +Upon receipt of a BYE or CANCEL request for the waiting call, the MSC Server shall stop timer TUE-CW if it was started, and: + +- if the BYE or CANCEL request includes a Reason header field (see RFC 3326 [45]) with the protocol set to "SIP" and the cause set to "408" then the MSC Server shall send a first clearing message according to clause 5.4.8.2, with the following addition: + - the Cause information element shall be set to cause 102 "recovery on timer expiry"; or +- the MSC Server shall act in accordance with clause 5.4.8.2. + +#### 5.6.4.5 CW condition timeout + +If timer TUE-CW was started and expires, the MSC Server shall: + +- send a DISCONNECT message as described in 3GPP TS 24.008 [3], towards the UE for the waiting call, including the Cause information element, where the cause values is set to 102 "recovery on timer expiry", the coding standard set to "Standard defined for the GSM PLMNs" and location set to "network beyond interworking point"; +- if the MSC Server stored an indication that the session includes a CW AS, send a 480 (Temporarily unavailable) final response, including a Reason header field set to cause 19, according to 3GPP TS 24.615 [44] in response to the initial INVITE request, and depending on operator policy, the MSC Server may insert a Response-Source header field with an "fe" header field parameter constructed with the URN namespace "urn:3gpp:fe", the "fe-id" part of the URN set to "msc-server" and the "role" header field parameter set to "msc-server-ics" in accordance with subclause 7.2.17 of 3GPP TS 24.229 [2]; +- ; +- if the MSC Server did not store an indication that the session includes a CW AS, the MSC Server shall act in accordance with clause 5.4.10. + +NOTE: Starting timer T2 or (optionally) T3 (or corresponding internal alerting supervision timing functions) as specified in 3GPP TS 24.083 [26] is an implementation option. Corresponding timers have been defined in 3GPP TS 24.615 [44] and 3GPP TS 24.604 [23]. If timers T2 or optionally T3 are started and expire, any resulting SIP responses that are not a 480 (Temporarily unavailable) final response, including a Reason header field set to cause 19, can interact with CW and (optionally) CDIV. + +#### 5.6.4.6 Notification to originator + +For originating calls interworked to the IM CN subsystem as described in clause 5.3, if the MSC Server receives a 180 Ringing response with a Alert-Info header field set to "urn:alert:service:call-waiting" according to 3GPP TS 24.615 [44], the MSC Server shall, according to 3GPP TS 24.083 [26], send if possible, the ALERTING message as the carrier message for the Call Waiting notification. Otherwise the MSC Server shall send a FACILITY message as the carrier message for the Call Waiting notification as specified in 3GPP TS 24.083 [26]. + +### 5.6.5 Communication Barring (CB) + +When interworking a 4xx, 5xx or 6xx response to the initial INVITE request to a DISCONNECT message as described in clause 5.3.8, the MSC Server shall apply the following additional interworking for the CB services described in 3GPP TS 24.611 [31]: + +- if a 433 Anonymity Disallowed response is received, the MSC Server shall include in the DISCONNECT a NotifySS operation containing an SS-Code set to the common code for incoming barring services and an SS-Status set to indicate the service is active and operative as specified in 3GPP TS 24.088 [30]; +- if a 603 Decline response is received, the MSC Server shall include in the DISCONNECT a NotifySS operation containing an SS-Code set to the common code for all barring services and an SS-Status set to indicate the service is active and operative as specified in 3GPP TS 24.088 [30]. + +NOTE: The common SS code is used as 3GPP TS 24.611 [31] specifies the use of a 603 Decline response for both the OCB and ICB services. + +### 5.6.6 Communication Diversion + +#### 5.6.6.1 General + +The following subclauses describe the MSC Server interworking behaviour related to the Communication Diversion (CDIV) services defined in 3GPP TS 24.604 [23]. + +#### 5.6.6.2 CDIV invocation + +##### 5.6.6.2.1 Communication Forwarding Unconditional (CFU) + +Invocation of CFU is handled by the IM CN subsystem as described in 3GPP TS 24.604 [23] and requires no interworking at the MSC Server. + +##### 5.6.6.2.2 Communication Forwarding Busy (CFB) + +For network determined user busy, invocation of CFB is handled by the IM CN subsystem as described in 3GPP TS 24.604 [23] and requires interworking at the MSC Server. + +For user determined user busy during mobile terminating call establishment as described in clause 5.4, if the MSC Server receives a DISCONNECT, RELEASE or RELEASE COMPLETE message from the UE with a cause information element set to "User Busy", the MSC Server shall perform the interworking described in clause 5.4.8.1. + +##### 5.6.6.2.3 Communication Forwarding No Reply (CFNR) + +Invocation of CFNR is handled by the IM CN subsystem as described in 3GPP TS 24.604 [23] and requires no interworking at the MSC Server. + +##### 5.6.6.2.4 Communication Forwarding on Not Logged-In (CFNL) + +Invocation of CFNL is handled by the IM CN subsystem as described in 3GPP TS 24.604 [23] and requires no interworking at the MSC Server. + +##### 5.6.6.2.5 Communication Deflection (CD) + +During mobile terminating call establishment as described in clause 5.4, if the MSC Server receives a DISCONNECT message from the UE with a facility information element containing a call deflection request as specified in 3GPP TS 24.072 [25], the MSC Server shall send a 302 (Moved Temporarily) response to the initial INVITE with the following interworking applied: + +- the DeflectedToNumber parameter in the facility information element received in the DISCONNECT message is used to derive a Contact header as follows: + - if the nature of address indicator is set to "international number", then the address digits in the DeflectedToNumber parameter, prefixed with a "+", shall be used to build a tel URI or a SIP URI with "user=phone"; or + - if the nature of address indicator is not set to "international number", then the MSC Server shall either: + - convert the address digits in the DeflectedToNumber parameter to international format by prefixing the number digits with "+CC" and use this to build a tel URI or a SIP URI with "user=phone"; or + +NOTE 1: CC is the country code of the network in which the MSC Server is located. + +- use the address digits in the DeflectedToNumber parameter to build a tel URI or a SIP URI with "user=phone". The phone-context parameter shall include the home network domain name defined for IMS centralized services in 3GPP TS 23.003 [10]. For geo-local numbers, the home domain name shall be prefixed by the "geo-local" string according to 3GPP TS 24.229 [2]. + +NOTE 2: The manner in which the MSC Server distinguishes between geo-local and home-local numbers is implementation specific. + +Depending on operator policy, the MSC Server may insert in a 302 (Moved Temporarily) response a Response-Source header field with an "fe" header field parameter constructed with the URN namespace "urn:3gpp:fe", the "fe-id" part of the URN set to "msc-server" and the "role" header field parameter set to "msc-server-ics" in accordance with subclause 7.2.17 of 3GPP TS 24.229 [2]. + +##### 5.6.6.2.6 Communication Forwarding on Subscriber Not Reachable (CFNRc) + +Clause 5.4.2 describes a number of scenarios where the MSC Server determines the terminating user is not reachable prior to sending the SETUP message and returns the appropriate response to the INVITE request to allow CFNRc to be initiated in the IM CN subsystem. If the MSC Server determines the terminating user is not reachable prior to sending the SETUP message for any other scenario not described in clause 5.4.2, the MSC Server shall send a 500 Server Internal Error response to the initial INVITE request and depending on operator policy, the MSC Server may insert in the 500 (Server Internal Error) response a Response-Source header field with an "fe" header field parameter constructed with the URN namespace "urn:3gpp:fe", the "fe-id" part of the URN set to "msc-server" and the "role" header field parameter set to "msc-server-ics" in accordance with subclause 7.2.17 of 3GPP TS 24.229 [2]. + +#### 5.6.6.3 Notifications relating to CDIV + +##### 5.6.6.3.1 Void + +##### 5.6.6.3.2 Notification to an originating user on CS access + +For originating calls interworked to the IM CN subsystem as described in clause 5.3, if communication diversion occurs for a served user with the subscription option "Originating user receives notification that his communication has been diverted (forwarded or deflected)" as described in 3GPP TS 24.604 [23], the following interworking shall be applied upon receipt of a 181 (Call Is Being Forwarded) response: + +- if a History-Info header field is present and any history entry contains a "cause" SIP URI parameter, as defined in IETF RFC 4458 [55] set to a value listed in table 5.6.6.3.2.1, the MSC Server shall send a FACILITY message containing a NotifySS operation indicating the call has been forwarded. The NotifySS operation shall contain an SS-Code as specified in 3GPP TS 24.082 [24] and 3GPP TS 24.072 [25] mapped from the value of the last "cause" SIP URI parameter according to table 5.6.6.3.2.1; + +**Table 5.6.6.3.2.1: Mapping the History-Info cause value to SS-Code** + +| Cause value | SS-Code | +|-------------|--------------------------------------| +| 302 | CFU | +| 404 | Common SS-Code for all forwarding SS | +| 408 | CFNRy | +| 480 | CD | +| 486 | CFB | +| 487 | CD | +| 503 | CFNRc | + +NOTE: Per 3GPP TS 24.604 [23] the History-Info header field can also be received in a SIP 180 (Ringing) or SIP 200 (OK) response to the initial SIP INVITE request. No interworking is performed in these scenarios as 3GPP TS 24.082 [24] does not allow this information to be presented to the subscriber in a manner consistent with 3GPP TS 24.604 [23]. + +##### 5.6.6.3.3 Notification to a terminating user on CS access + +When interworking a SIP INVITE request to a SETUP message as described in clause 5.4.3, the MSC Server shall apply the following interworking to provide notification of CDIV if a History-Info header field is present in the INVITE request: + +- if any history entry in the History-Info header field contains a "cause" SIP URI parameter, as defined in IETF RFC 4458 [55], set to a value listed in table 5.6.6.3.2.1, the MSC Server shall send a FACILITY information element containing a NotifySS operation indicating the call has been forwarded. The NotifySS operation shall contain an SS-Code as specified in 3GPP TS 24.082 [24] and 3GPP TS 24.072 [25] mapped from the value of the last "cause" SIP URI parameter according to table 5.6.6.3.2.1. +- if + - a) the SIP INVITE request does not contain a Privacy header field with any of the privacy values "header", "session" or "history"; and + - b) the history entry in the History-Info header field preceding the last history entry in History-Info header field containing a "cause" SIP URI parameter defined in IETF RFC 4458 [55] set to a value listed in table 5.6.6.3.2.1 does not contain an escaped privacy header with a value of "history", +- then the following additional interworking shall be applied: + - if the hi-targeted-to-uri within the history entry preceding the last history entry containing a "cause" SIP URI parameter contains a tel URI or a SIP URI with "user=phone", the MSC Server shall include a redirecting party BCD number information element set as follows: + - if the tel URI or telephone number within the SIP URI is in international format, set the type of number to "international number", otherwise set the type of number to "national number"; + - set the number plan identification to "ISDN/telephony numbering plan"; + - set the presentation indicator to "presentation allowed"; + - set the screening indicator to "network provided"; and + +- set the number digits fields to the telephone number contained in the tel URI or SIP URI; + +NOTE: The number mapping does not include any digits contained in the phone-context parameter. + +- otherwise, + - the MSC Server shall build a redirecting party BCD number information element as follows: + - set the type of number to "unknown"; + - set the number plan identification to "unknown"; + - set the presentation indicator to "number not available due to interworking"; and + - set the screening indicator to "network provided". + +### 5.6.7 Explicit Communication Transfer (ECT) + +#### 5.6.7.1 General + +The following subclauses describe the MSC Server interworking behaviour related to the ECT service defined in 3GPP TS 24.629 [33] and a UE using CS access domain signalling specified in 3GPP TS 24.091 [32]. + +#### 5.6.7.2 MSC Server as transferor on behalf of UE + +When the MSC Server receives a FACILITY message containing an ECT request from a UE with one answered call in a held state and another call in an answered and active or alerting state as specified in 3GPP TS 24.091 [32], the MSC Server shall build and send a REFER request as specified for a transferor UE in 3GPP TS 24.629 [33]. + +When the MSC Server receives a NOTIFY request on the REFER dialog, interworking shall be applied based upon the SIP response status-code contained in the "message/sipfrag" message body as follows: + +- if status-code 100 Trying is received, no interworking is applied; +- if status-code 200 OK is received, the MSC Server shall send a FACILITY message indicating transfer success to the UE as specified in 3GPP TS 24.091 [32]. The MSC Server shall then initiate clearing of the two calls towards the UE as specified in 3GPP TS 24.091 [32] and initiate clearing of the IM CN subsystem session with the transferee as specified in clause 5.5.4. +- if status-code 503 is received, the MSC Server shall send a FACILITY message with a return error parameter set to "SystemFailure" and leave the two calls from the UE in the conditions they were in prior to the ECT request; +- if any other status-code is received, the MSC Server shall send a FACILITY message with a return error parameter set to "IllegalSS-Operation" and leave the two calls from the UE in the conditions they were in prior to the ECT request. + +#### 5.6.7.3 MSC Server as transferee on behalf of UE + +##### 5.6.7.3.1 Actions without 3PCC + +NOTE 1: CS domain access signalling as specified in 3GPP TS 24.091 [32] does not provide a mechanism to present the transfer request to the transferee for authorization of the transfer. Automatic acceptance and execution of the REFER request by the MSC Server can therefore pose a security risk or have unwanted charging consequences. Acceptance of REFER requests is therefore subject to operator policy, which is outside the scope of the present document. + +When the MSC Server receives a REFER request in the context of a call transfer scenario as described in 3GPP TS 24.629 [33] clause 4.5.2.4.1.2.2, the MSC Server may perform the actions specified for a transferee UE in 3GPP TS 24.629 [33]. + +If the MSC Server does not support accepting REFER requests on behalf of the UE per operator policy, then the MSC Server shall return a 403 (Forbidden) response and depending on operator policy, the MSC Server may insert in the 403 (Forbidden) response a Response-Source header field with an "fe" header field parameter constructed with the URN + +namespace "urn:3gpp:fe", the "fe-id" part of the URN set to "msc-server" and the "role" header field parameter set to "msc-server-ics" in accordance with subclause 7.2.17 of 3GPP TS 24.229 [2]. + +If the MSC Server received a non-zero SS screening indicator from the UE as defined in 3GPP TS 24.080 [29], then upon sending the NOTIFY request indicating that the transfer is complete, the MSC Server may send a FACILITY message to the UE as specified in 3GPP TS 24.091 [32]. The MSC Server may include an Rdn parameter set to indicate that the remote party number is not available due to interworking. + +NOTE 2: The remote party number, as indicated in the Refer-To header sent by the transferor, is not available to the MSC Server as it is replaced by the transferor AS as specified in 3GPP TS 24.629 [33]. + +NOTE 3: Depending on the conferencing implementation in the IM CN subsystem (e.g. the manner in which users are invited to a conference), the MSC Server might not be able to distinguish between REFER requests for the ECT service and REFER requests for the conferencing service. In such cases, the MSC Server will not know which SS operation to indicate in the FACILITY message. Handling of this scenario is implementation specific. + +##### 5.6.7.3.2 Actions with 3PCC + +When 3PCC is used for ECT as specified in 3GPP TS 24.629 [33], no special interworking is required at the MSC Server. + +#### 5.6.7.4 MSC Server as transfer target on behalf of UE + +When the MSC Server receives an INVITE request which does not replace an existing session (e.g. blind ECT), the MSC Server shall follow the interworking procedures specified in clause 5.4. + +When the MSC Server receives an INVITE request which replaces an existing session, the MSC Server shall perform the actions specified for a transfer target UE in 3GPP TS 24.629 [33]. If the MSC Server received a non-zero SS screening indicator as defined in 3GPP TS 24.080 [29], then upon successful session establishment with the transferee the MSC Server shall send a FACILITY message to the UE as specified in 3GPP TS 24.091 [32] with the following interworking applied: + +- if a Privacy header with priv-value set to "id" is present, the MSC Server may include an Rdn parameter in the FACILITY message set to indicate presentation restricted as specified in 3GPP TS 24.080 [29]; +- if a Privacy header with a priv-value set to "id" is not present in the INVITE request, then: + - if a P-Asserted-Identity header containing a tel URI or a SIP URI with "user=phone" is present in the INVITE, the MSC Server may include an Rdn parameter in the FACILITY message with a value set to the telephone number contained in this URI; + - if a P-Asserted-Identity header is present but does not contain a tel URI or a SIP URI with "user=phone", the MSC Server may include an Rdn parameter in the FACILITY message set to indicate the number is not available due to interworking as specified in 3GPP TS 24.080 [29]. + +### 5.6.8 Conference (CONF) + +#### 5.6.8.1 General + +IM CN subsystem CONF functionality at a MSC Server is specified in 3GPP TS 24.292 [7]. The following subclauses describe the MSC Server interworking behaviour related to the CONF service defined in 3GPP TS 24.605 [35] and a UE using CS access domain signalling specified in 3GPP TS 24.084 [34]. + +#### 5.6.8.2 MSC Server as conference creator + +##### 5.6.8.2.1 Conference creation + +When the MSC Server receives a BuildMPTY request from a UE with one active call and one held call as described in 3GPP TS 24.084 [34], the MSC Server shall initiate conference creation and invite the remote parties to the conference as described in 3GPP TS 24.292 [7]. + +NOTE: Conference creation and inviting users to the conference are two distinct actions in the IM CN subsystem. However, in CS access signalling a single message creates the conference and adds the existing calls to the conference. + +After receiving NOTIFY requests indicating both remote parties have successfully transferred to the conference, the MSC Server shall send a FACILITY message indicating BuildMPTY success as specified in 3GPP TS 24.084 [34]. + +If a non-200 final response to the INVITE request which attempts to create the conference is received, the MSC Server shall send a FACILITY message with a return error parameter set to "SystemFailure" and leave the two calls from the UE in the conditions they were in prior to the conference creation request. + +##### 5.6.8.2.2 Putting the conference on hold + +When the MSC Server receives a HoldMPTY request from a UE with an active conference, the MSC Server shall send an UPDATE or re-INVITE request containing a new SDP offer as described in clause 5.6.3.1.1. + +Upon receipt of the SDP answer in a 200 OK response to the UPDATE or re-INVITE request, the MSC Server shall send a FACILITY message indicating success as specified in 3GPP TS 24.084 [34]. + +If the SDP offer is rejected or a non-200 response is received to the UPDATE or re-INVITE request, the MSC Server shall send a FACILITY message as specified in 3GPP TS 24.084 [34] with a return error parameter set to "SystemFailure". + +##### 5.6.8.2.3 Resuming a held conference + +When the MSC Server receives a RetrieveMPTY request from a UE with a conference on hold, the MSC Server shall send an UPDATE or re-INVITE request containing a new SDP offer as described in clause 5.6.3.1.2. + +Upon receipt of the SDP answer in a 200 OK response to the UPDATE or re-INVITE request, the MSC Server shall send a FACILITY message indicating success as specified in 3GPP TS 24.084 [34]. + +If the SDP offer is rejected or a non-200 response is received to the UPDATE or re-INVITE request, the MSC Server shall send a FACILITY message with a return error parameter set to "SystemFailure". + +##### 5.6.8.2.4 Adding a party to the conference + +When the MSC Server receives a BuildMPTY from a UE with a conference on hold and separate active or waiting call as described in 3GPP TS 24.084 [34], the MSC Server shall: + +- invite the remote party to the conference as described in 3GPP TS 24.292 [7]; and +- send an UPDATE or re-INVITE request to resume the held conference as described in clause 5.6.3.1.2. + +##### 5.6.8.2.5 Terminating the conference or disconnecting a party from the conference + +When the MSC Server receives a DISCONNECT message from a UE with an established conference, with a transaction identifier corresponding to a specific remote party, the MSC Server shall start a conference termination specific timer. While the timer is running, MSC Server shall collect potential further DISCONNECT messages from the UE, with valid transaction identifiers, corresponding to other remote parties. These additional DISCONNECT messages shall not trigger starting a new timer and shall not restart the timer. + +NOTE 1: The value for the conference termination timer is implementation specific. The timer has to be long enough to allow that the UE encodes and transmits all the DISCONNECT messages to the MSC Server but it should be kept short so that the DISCONNECT messages used for disconnecting a single conference participant are not delayed too long. A value around 1 sec is seen as satisfactory. + +When the timer expires, MSC Server shall examine, whether it has received a DISCONNECT message corresponding to all remote parties that have been participants of the established conference and depending on that shall act as follows: + +- If a DISCONNECT messages has been received for each participant, the MSC Server shall send a BYE request to the conference-URI. + +NOTE 2: A complete set of DISCONNECT messages is interpreted as request to terminate the established conference. The BYE request will lead to a termination of the conference by the conference focus, after removal all the participants, as described in 3GPP TS 24.147 [36], clause 5.3.2.7. + +- Otherwise, the MSC Server shall generate a separate REFER request for each DISCONNECT message to remove the corresponding party/parties from the conference as specified in 3GPP TS 24.147 [36] clause 5.3.1.6.3, with the Refer-To header of the REFER request set to the address of the conference participant being removed and also containing a "method" URI parameter set to "BYE". If the address of the conference participant being removed is a tel URI, the MSC server shall convert the tel URI to a SIP URI and shall set the host portion of the SIP URI to the home network domain name defined for IMS centralized services in 3GPP TS 23.003 [10]. + +NOTE 3: The MSC Server thus treats the DISCONNECT message(s) received before timer expiry as the user's request for disconnecting the party/parties belonging to the received transaction identity/identities. + +##### 5.6.8.2.6 Receipt of a SplitMPTY message + +When the MSC Server receives a SplitMPTY request from the UE, the MSC Server shall send a FACILITY message with a return error parameter set to "ss-NotAvailable". + +##### 5.6.8.2.7 Remote party disconnects from the conference + +When the MSC Server receives a SIP NOTIFY request from a conference focus indicating that a specific remote party has disconnected from the conference, the MSC Server shall send a CC DISCONNECT message to the UE, with a transaction identifier corresponding to the specific remote party. + +#### 5.6.8.3 MSC Server as conference participant + +##### 5.6.8.3.1 Receipt of invitation to conference + +###### 5.6.8.3.1.1 General + +The methods by which the MSC Server, on behalf of the UE, can be invited to a conference are described in 3GPP TS 24.605 [35] clause 4.5.2.1.2 and 3GPP TS 24.147 [36] clause 5.3.1.5. + +###### 5.6.8.3.1.2 Receipt of REFER within a dialog + +Upon receipt of a REFER request within a dialog, the MSC Server shall act as a transferee on behalf of the UE as specified in clause 5.6.7.3.1. + +NOTE 1: If the Refer-To header of the REFER request contains a conference URI, this will result in the user joining a conference. + +NOTE 2: CS domain access signalling as specified in 3GPP TS 24.091 [32] does not provide a mechanism to present the transfer request to the transferee for authorization of the transfer. Automatic acceptance and execution of the REFER request by the MSC Server can therefore pose a security risk or have unwanted charging consequences. Acceptance of REFER requests is therefore subject to operator policy, which is outside the scope of the present document. + +###### 5.6.8.3.1.3 Receipt of REFER outside a dialog + +If the MSC Server does not support accepting REFER requests on behalf of the UE per operator policy, then the MSC Server shall return a 403 Forbidden response. + +Support for the MSC Server, on behalf of a UE, joining a conference in this manner requires that the MSC Server shall: + +- initiate a terminating call leg toward the UE in accordance with 3GPP TS 24.008 [3]; and + +NOTE: If the user is involved in a call, then the call waiting procedures described in 3GPP TS 24.008 [3] and 3GPP TS 24.083 [26] apply. + +- initiate an originating call toward the URI identified in the Refer-To header (e.g. the conference URI); and + +- combine these two call legs into a single call. + +Support for this method of joining a conference may be provided as an implementation option but is outside the scope of the present document. + +###### 5.6.8.3.1.4 Receipt of INVITE + +NOTE: Clause 5.4.2 contains general applicable procedures executed upon receipt of an initial INVITE request. + +If an INVITE request is received, the MSC Server shall act as follows: + +- if the user is idle, the MSC Server shall act according to the mobile terminating call set up procedures specified in clause 5.4; +- if the user is engaged in an established SIP dialog and the INVITE request contains a Replaces header field corresponding to the established dialog, the MSC Server act as a transfer target on behalf of the UE as specified in clause 5.6.7.4; or +- if the user is engaged in an established SIP dialog and the INVITE request does not contain a Replaces header field corresponding to the established dialog, the MSC Server shall follow the communication waiting procedures described in clause 5.6.4.1. + +##### 5.6.8.3.2 Notification of conference invocation + +If the MSC Server received a non-zero SS screening indicator from the UE as defined in 3GPP TS 24.080 [29], then upon joining a conference on behalf of a UE, the MSC Server may send a FACILITY message to the UE indicating a multiparty call has been invoked as specified in 3GPP TS 24.084 [34]. + +NOTE: If the MSC Server was invited to the conference via reception of a REFER request as specified in 3GPP TS 24.147 [36] clause 5.3.1.5.2, the MSC Server is not able to distinguish between REFER requests for the conferencing service and REFER requests for the ECT service. In such cases, the MSC Server will not know which SS operation to indicate in the FACILITY message. Handling of this scenario is implementation specific. + +### 5.6.9 Customized Alerting Tones (CAT) + +#### 5.6.9.1 General + +The following subclauses describe the MSC Server interworking behaviour related to the Customized Alerting Tones (CAT) services defined in 3GPP TS 24.182 [51]. + +Based on operator options, one of three different models described in 3GPP TS 24.182 [51] is used in an IM CN subsystem to provide the CAT service. The CAT interworking procedures at the MSC server differ between these models and are described separately for each model in the subsequent sub-clauses. Support of the interworking procedures for each of those models is optional. + +No special interworking procedures for the CAT service when MSC server receive a terminating request from IMS network are required. + +#### 5.6.9.2 Early session model + +##### 5.6.9.2.1 Originating request + +If the MSC server supports early-session as a network option, upon receiving an incoming SETUP message, before the MSC server sending the generated SIP INVITE request as described in clause 5.3.3, it shall include the option tag "early-session", as defined in IETF RFC 3959 [50], in Supported header field. + +After receiving the first SIP 18x response including an early-session SDP, the MSC server shall send the ALERTING message as described in 3GPP TS 24.008 [3], then the MSC server shall follow the same procedure as described for MGCF in 3GPP TS 29.163 [46] clause 7.5.13 to negotiate with IMS side for early-session and normal session establishment. + +#### 5.6.9.3 Forking model + +Interworking at MSC server follows the basic call interworking procedures. Support of the P-Early-Media header field and related procedures as described in clause 5.3.4a and clause 5.3.4b are required in addition. + +#### 5.6.9.4 Gateway model + +Interworking at MSC server follows the basic call interworking procedures. Support of the P-Early-Media header field and related procedures as described in clause 5.3.4a and clause 5.3.4b are required in addition. + +### 5.6.10 Communication Completion Services (CCBS/CCNL/CCNR) + +#### 5.6.10.1 General + +The following subclauses describe the MSC Server interworking behaviour related to the Communication Completion services defined in 3GPP TS 24.642 [52] and a UE using CS access domain signalling specified in 3GPP TS 24.093 [53]. + +#### 5.6.10.2 Communication Completion Terminated at Served User + +When the Served User is the terminating user, no special interworking is required at the MSC Server. + +#### 5.6.10.3 Communication Completion Originated at Served User + +##### 5.6.10.3.1 Actions without 3PCC + +When the MSC Server receives a CC Recall as a REFER request as described in 3GPP TS 24.642 [52] clause 4.5.4.2.3.1, the MSC Server may assign a CCBS Index to this recall if not already done, and may perform the CC Recall procedures as specified by 3GPP TS 24.093 [53]. When the SETUP message is received, normal call handling continues. + +If the MSC Server does not support accepting REFER requests on behalf of the UE per operator policy, then the MSC Server shall return a 403 Forbidden response. + +##### 5.6.10.3.2 Actions with 3PCC + +When 3PCC is used for CCBS/CCNL/CCNR as specified in 3GPP TS 24.642 [52], no special interworking is required at the MSC Server. + +## 5.7 Supplementary Service Configuration + +### 5.7.1 General + +The MSC Server may support the interworking between call independent supplementary service signalling described in 3GPP TS 24.010 [41] and the XCAP application usage for manipulating supplementary services data described in 3GPP TS 24.623 [42]. This MSC Server may support this interworking for any subset of the supplementary services within the scope of the present document. This interworking shall only be performed for the TS11 service code. If the MSC Server interworks a supplementary service invoke operation received via NAS signalling to the IM CN subsystem, the MSC Server shall not also transfer the received information to the VLR as described in 3GPP TS 29.002 [20]. This interworking is defined in the following subclauses. + +**NOTE:** This interworking is subject to the limitations inherited by the NAS signalling procedures defined for each supplementary service. For example, if no NAS signalling procedure is defined for registration, erasure, activation, deactivation or interrogation of a particular supplementary service that is being controlled by the IM CN subsystem, then no interworking procedure is defined. + +### 5.7.2 Receipt of REGISTER message + +Upon receipt of a REGISTER message for a supplementary service whose interworking is within the scope of the present document, the MSC Server shall generate the appropriate HTTP request according to table 5.7.2.1 if supplementary service configuration interworking for that supplementary service is supported by the MSC Server. + +**Table 5.7.2.1: Mapping REGISTER / FACILITY to HTTP request** + +| Invoke operation in the REGISTER message | HTTP request | +|-------------------------------------------------|---------------------| +| RegisterSS | PUT | +| ActivateSS | PUT | +| DeactivateSS | PUT | +| InterrogateSS | GET | +| EraseSS | PUT | + +NOTE: Not all invoke operations are valid for all supplementary services. Interworking definitions for each supplementary service are only provided for invoke operations explicitly defined for each supplementary service. + +The interworking of message contents for each supplementary service is described in clause 5.7.4. + +### 5.7.3 Receipt of HTTP response + +Upon receipt of an HTTP response to a previously sent HTTP request as described in clause 5.7.2, the MSC Server shall terminate the appropriate service interaction by sending a RELEASE COMPLETE message. The interworking of message contents for each supplementary service is described in clause 5.7.4. + +### 5.7.4 Service data interworking + +#### 5.7.4.1 Originating identification presentation/restriction (OIP/OIR) + +##### 5.7.4.1.1 Registration/erasure + +The OIP/OIR services require no registration. Erasure is not applicable. + +##### 5.7.4.1.2 Activation/deactivation + +The OIP/OIR services are activated at provisioning and deactivated at withdrawal and therefore require no interworking at the MSC Server. + +##### 5.7.4.1.3 Interrogation + +If the MSC Server supports supplementary service configuration interworking for the OIP/OIR services, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an InterrogateSS invoke operation for the CLIP or CLIR supplementary service code as described in 3GPP TS 24.081 [12], the MSC Server shall generate and send an HTTP GET request to fetch the instance of the Originating Identity document as specified in 3GPP TS 24.623 [42]. + +Upon receiving a response to the HTTP GET request, the MSC Server shall apply the following interworking: + +- If a 200 OK response is received which includes an Originating Identity document as defined in 3GPP TS 24.607 [43], the MSC Server shall send a RELEASE COMPLETE message as follows: + - If the Originating Identity document indicates the interrogated service (CLIP/OIP or CLIR/OIR) is active, the MSC Server shall indicate an SS-Status of provisioned and active; or + +- If the Originating Identity document indicates the interrogated service (CLIP/OIP or CLIR/OIR) service is not active, the MSC Server shall indicate an SS-Status of provisioned but not active; +- If the CLIR/OIR service was interrogated, then the following additional interworking shall be applied: + - If there is a "default-behaviour" attribute included and set to "presentation-restricted" in the Originating Identity document, the MSC Server shall set the CLI Restriction Option parameter to indicate Temporary (Default Restricted); + - If there is a "default-behaviour" attribute included and set to "presentation-not-restricted" in the Originating Identity document the MSC Server shall set the CLI Restriction Option parameter to Temporary (Default Allowed); +- If a non 200 OK response is received or if a 200 OK response is received which does not include an Originating Identity document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +#### 5.7.4.2 Terminating identification presentation/restriction (TIP/TIR) + +##### 5.7.4.2.1 Registration/erasure + +The TIP/TIR services require no registration. Erasure is not applicable. + +##### 5.7.4.2.2 Activation/deactivation + +The TIP/TIR services are activated at provisioning and deactivated at withdrawal and therefore require no interworking at the MSC Server. + +##### 5.7.4.2.3 Interrogation + +If the MSC Server supports supplementary service configuration interworking for the TIP/TIR services, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an InterrogateSS invoke operation for the COLP or COLR supplementary service code as described in 3GPP TS 24.081 [12], the MSC Server shall generate an HTTP GET request to fetch the instance of the Terminating Identity document as specified in 3GPP TS 24.623 [42]. + +Upon receiving a response to the HTTP GET request, the MSC Server shall apply the following interworking: + +- If a 200 OK response is received which includes a Terminating Identity document as defined in 3GPP TS 24.608 [14], the MSC Server shall send a RELEASE COMPLETE message as follows: + - If the Terminating Identity document indicates the interrogated service (COLP/TIP or COLR/TIR) is active, the MSC Server shall indicate an SS-Status of provisioned and active; or + - If the Terminating Identity document indicates the interrogated service (COLP/TIP or COLR/TIR) service is not active, the MSC Server shall indicate an SS-Status of provisioned but not active; + +NOTE: CS signalling defined in 3GPP TS 24.081 [12] does not allow for the temporary mode status of the COLR service to be sent to the UE. + +- If a non 200 OK response is received or if a 200 OK response is received which does not include a Terminating Identity document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +### 5.7.4.3 Communication Hold (HOLD) + +Configuration of the HOLD service involves no signalling and therefore requires no interworking at the MSC Server. + +#### 5.7.4.4 Communication Waiting (CW) + +##### 5.7.4.4.1 Registration/erasure + +The CW service requires no registration. Erasure is not applicable. + +##### 5.7.4.4.2 Activation/deactivation + +If the MSC Server supports supplementary service configuration interworking for the CW service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an ActivateSS or DeactivateSS invoke operation for the CW supplementary service code as described in 3GPP TS 24.083 [26], the MSC Server shall include an instance of the call waiting document described in 3GPP TS 24.615 [44] in the HTTP PUT request as follows: + +- If the invoke operation is ActivateSS, the MSC Server shall set the "active" attribute to "true"; +- If the invoke operation is DeactivateSS, the MSC Server shall set the "active" attribute to "false". + +##### 5.7.4.4.3 Interrogation + +If the MSC Server supports supplementary service configuration interworking for the CW service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an InterrogateSS invoke operation for the CW supplementary service code as described in 3GPP TS 24.083 [26], the MSC Server shall generate and send an HTTP GET request to fetch the instance of the call waiting document as specified in 3GPP TS 24.623 [42]. + +When a response to the HTTP GET request is received, the MSC Server shall apply the following interworking: + +- If a 200 OK is received which includes a call waiting document as defined in 3GPP TS 24.615 [44], the MSC Server shall send a RELEASE COMPLETE message as follows: + - If the call waiting document includes an "active" attribute set to "true", the MSC Server shall indicate an SS-Status of provisioned and active; + - If the call waiting document includes an "active" attribute set to "false", the MSC Server shall indicate an SS-Status of provisioned but not active; +- If a non 200 OK response is received or if a 200 OK response is received which does not include a call waiting document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +#### 5.7.4.5 Communication Barring (CB) + +##### 5.7.4.5.1 Registration/erasure + +If the user has the subscription option "control of barring services" set to "by subscriber using a password" a password is registered at provisioning time and the UE can change the registered password at any later time using the procedures in this subclause. + +When the MSC Server receives a REGISTER message with an invoke component of the operation "register password" as specified in 3GPP TS 24.010 [41], the MSC Server enhanced for ICS first sends a FACILITY message towards the UE with an invoke component of the operation "get password". After receiving a FACILITY message from the UE with a return result component including a password, the MSC Server enhanced for ICS shall use this password to perform a password check procedure by sending an HTTP POST request towards the XCAP server as specified in 3GPP TS 24.623 [42]. + +Upon receiving an HTTP 200 (OK) response to the password check request as above, the MSC Server enhanced for ICS requests the new password from the UE as specified in 3GPP TS 24.010 [41] by sending a FACILITY message towards the UE with an invoke component of the operation "get password". When the UE returns the password the MSC Server enhanced for ICS requests the new password again. After receiving the password again, the MSC Server enhanced for + +ICS compares the two passwords, and if they are equal, registers the new password by performing the password change procedure as specified in 3GPP TS 24.623 [42]. + +Upon receiving the HTTP 200 (OK) response to the password change request as above, the MSC Server enhanced for ICS sends a Release Complete with the return result component of the operation "register password" as specified in 3GPP TS 24.010 [41]. + +Error responses towards the UE are sent as specified in 3GPP TS 24.010 [41]. + +Erasure of the CB service is not specified for NAS signalling in 3GPP TS 24.088 [30], therefore interworking procedures for service erasure are not applicable. + +#### 5.7.4.5.2 Activation/deactivation + +When the MSC Server receives a REGISTER message with an ActivateSS or DeactivateSS invoke operation for any call barring supplementary service code as described in 3GPP TS 24.088 [30], the MSC Server shall perform the password procedure as specified in 3GPP TS 24.088 [30], and store the received password for later mapping to the password portion of the SIP URI in the XCAP user identity as specified in 3GPP TS 24.623 [42]. The MSC Server shall then perform an interrogation as specified in 3GPP TS 24.611 [31] of either the element or the element depending on whether the received supplementary service code indicated an incoming or an outgoing barring service. + +To perform the interrogation the MSC Server populates the HTTP GET request as specified in 3GPP TS 24.623 [42]. If the result of the interrogation is that the user is not provisioned with the service indicated in the received REGISTER message, the MSC Server sends an appropriate error response. + +If the result of the interrogation is that the user is provisioned with the supplementary service indicated in the REGISTER request, and the activation status is different than the desired status, the MSC Server sends an HTTP PUT request as specified in 3GPP TS 24.623 [42] including the following rule: + +- 1) If the invoke operation is ActivateSS, the MSC Server shall set the "active" attribute to "true": + - a) If the supplementary service code is BAOC the MSC Server shall include an element including barring rule where the condition element is empty or no condition element is included, and not include the element, as defined in 3GPP TS 24.611 [31]. + - b) If the supplementary service code is BOIC the MSC Server shall include an element including a barring rule for the international condition, and not include the element, as defined in 3GPP TS 24.611 [31]. + - c) If the supplementary service code is BOIC-exHC excluding home the MSC Server shall include an element including a barring rule for the international-exHC condition, and not include the element, as defined in 3GPP TS 24.611 [31]. + - d) If the supplementary service code is BAIC the MSC Server shall include an element including a barring rule where the condition element is empty or no condition element is included, and not include the element, as defined in 3GPP TS 24.611 [31]. + - e) If the supplementary service code is BIC-Roam the MSC Server shall include an element including a barring rule for the roaming condition, and not include the element, as defined in 3GPP TS 24.611 [31]. +- 2) If the invoke operation is DeactivateSS: + - a) If the supplementary service code is BAOC the MSC Server shall include an element including barring rule where the condition element is empty or no condition element is included, as defined in 3GPP TS 24.611 [31]. In addition, the MSC server shall in the condition element add a element. + - b) If the supplementary service code is BOIC the MSC Server shall include an element including a barring rule for the international condition, as defined in 3GPP TS 24.611 [31]. In addition, the MSC server shall in the condition element add a element. + - c) If the supplementary service code is BOIC-exHC excluding home the MSC Server shall include an element including a barring rule for the international-exHC condition, as + +defined in 3GPP TS 24.611 [31]. In addition, the MSC server shall in the condition element add a element. + +- d) If the supplementary service code is BAIC the MSC Server shall include an element including a barring rule where the condition element is empty or no condition element is included, as defined in 3GPP TS 24.611 [31]. In addition, the MSC server shall in the condition element add a element. +- e) If the supplementary service code is BIC-Roam the MSC Server shall include an element including a barring rule for the roaming condition, as defined in 3GPP TS 24.611 [31]. In addition, the MSC server shall in the condition element add a element. + +#### 5.7.4.5.3 Interrogation + +If the MSC Server supports supplementary service configuration interworking for the CB service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an InterrogateSS invoke operation for the BAOC, BAIC, BOIC, BOIC-exHC or BIC-Roam supplementary service code as described in 3GPP TS 24.088 [30], the MSC Server shall generate and send an HTTP GET request to fetch the instance of the Communication Barring document as specified in 3GPP TS 24.623 [42]. + +When a response to the HTTP GET request is received, the MSC Server shall apply the following interworking: + +- 1) If an HTTP 200 (OK) response is received which includes a Communication Barring document as defined in 3GPP TS 24.611 [31], the MSC Server shall send a RELEASE COMPLETE message as follows: + - If the Communication Barring document indicates the call barring service being interrogated is active, the MSC Server shall include a BasicServiceCode set to the TS11 service code; + - If the Communication Barring document indicates the call barring service being interrogated is not active, the MSC Server shall include an SS-Status of deactivated; +- 2) If an HTTP non 200 (OK) response is received or if an HTTP 200 OK response is received which does not include a Communication Barring document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +#### 5.7.4.6 Communication Diversion (CDIV) + +##### 5.7.4.6.1 Registration + +If the MSC Server supports supplementary service configuration interworking for the CDIV service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with a RegisterSS invoke operation for a supplementary service code listed below, the MSC Server shall include Communication Diversion document as described in 3GPP TS 24.604 [23] in the HTTP PUT request as follows: + +- The MSC Server shall set the active attribute to "true"; +- If the supplementary service code is CFU as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule where the condition element is empty or no condition element is included, as defined in 3GPP TS 24.604 [23];; +- If the supplementary service code is CFB as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule for the busy condition defined in 3GPP TS 24.604 [23]; +- If the supplementary service code is CFNRy as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule for the no-answer condition defined in 3GPP TS 24.604 [23]; +- If the supplementary service code is CFNRc as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule for the not-reachable condition defined in 3GPP TS 24.604 [23]; + +- The MSC Server shall include a "target" element set to the TEL URI representation of the ForwardedToNumber parameter received in the REGISTER message. The TEL URI shall be constructed as described in clause 5.3.3.2. + +NOTE: The Communication Diversion document described in 3GPP TS 24.604 [23] defines XML elements which have no functional equivalent in the service configuration signalling defined in 3GPP TS 24.082 [24]. The inclusion of these elements and the values assigned to them is subject to operator policy. + +The MSC Server shall store a copy of the Communication Diversion document until the HTTP PUT response is received and processed. + +When a response to the HTTP PUT request is received, the MSC Server shall apply the following interworking: + +- If a 200 OK is received, the MSC Server shall send a RELEASE COMPLETE message as follows: + - The MSC Server shall indicate an SS-Status of provisioned and active; + - The MSC Server shall set the ForwardedToNumber parameter to the "target" element in the stored Communication Diversion document. +- If a non 200 OK response is received or if a 200 OK response is received which does not include a Communication Diversion document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +#### 5.7.4.6.1a Erasure + +If the MSC Server supports supplementary service configuration interworking for the CDIV service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an EraseSS invoke operation for a supplementary service listed below, the MSC Server shall first fetch the instance of the Communication Diversion document as described in clause 5.7.4.6.3. If the MSC Server is unable to fetch the Communication Diversion document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +The MSC Server shall then include the Communication Diversion document as described in 3GPP TS 24.604 [23] in an HTTP PUT request, modified as follows: + +- If the supplementary service code is CFU, the MSC Server shall remove the forwarding rule with an empty condition element or no condition element included, if present; +- If the supplementary service code is CFB, the MSC Server shall remove the forwarding rule for the busy condition defined in 3GPP TS 24.604 [23], if present; +- If the supplementary service code is CFNRy, the MSC Server shall remove the forwarding rule for the no-answer condition defined in 3GPP TS 24.604 [23], if present; +- If the supplementary service code is CFNRc, the MSC Server shall remove the forwarding rule for the not-reachable condition defined in 3GPP TS 24.604 [23], if present; +- If the supplementary service code is "all forwarding SS", the MSC Server shall remove all forwarding rules described above. + +When a response to the HTTP PUT request is received, the MSC Server shall apply the following interworking: + +- If a 200 OK is received, the MSC Server shall send a RELEASE COMPLETE message as follows: + - If an SS-Status parameter is required as specified in 3GPP TS 24.082 [24] clause 1.3.1, the MSC Server shall indicate an SS-Status of not active; +- If a non 200 OK response is received or if a 200 OK response is received which does not include a Communication Diversion document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +#### 5.7.4.6.2 Activation/deactivation + +If the MSC Server supports supplementary service configuration interworking for the CDIV service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an ActivateSS or DeactivateSS invoke operation for the CFU, CFB, CFNRy or CFNRc supplementary service code as described in 3GPP TS 24.082 [24], the MSC Server shall include a Communication Diversion document as described in 3GPP TS 24.604 [23] in the HTTP PUT request as follows: + +- If the invoke operation is ActivateSS, the MSC Server shall set the "active" attribute to "true"; +- If the invoke operation is DeactivateSS, the MSC Server shall set the "active" attribute to "false"; +- If the supplementary service code is CFU as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule with an empty condition element or no condition element included; +- If the supplementary service code is CFB as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule for the busy condition defined in 3GPP TS 24.604 [23]; +- If the supplementary service code is CFNRy as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule for the no-answer condition defined in 3GPP TS 24.604 [23]; +- If the supplementary service code is CFNRc as described in 3GPP TS 24.082 [24], the MSC Server shall include a forwarding rule for the not-reachable condition defined in 3GPP TS 24.604 [23]; + +NOTE: The Communication Diversion document described in 3GPP TS 24.604 [23] defines XML elements which have no functional equivalent in the service configuration signalling defined in 3GPP TS 24.082 [24]. The inclusion of these elements and the values assigned to them is subject to operator policy. + +The MSC Server shall store a copy of the Communication Diversion document until the HTTP PUT response is received and processed. + +When a response to the HTTP PUT request is received, the MSC Server shall apply the following interworking: + +- If a 200 OK is received, the MSC Server shall send a RELEASE COMPLETE message as follows: + - If the "active" attribute in the stored Communication Diversion document is set to "true", the MSC Server shall indicate an SS-Status of provisioned and active; + - If the "active" attribute in the stored Communication Diversion document is set to "false", the MSC Server shall indicate an SS-Status of provisioned but not active; +- If a non 200 OK response is received or if a 200 OK response is received which does not include a Communication Diversion document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +#### 5.7.4.6.3 Interrogation + +If the MSC Server supports supplementary service configuration interworking for the CDIV service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an InterrogateSS invoke operation for the CFU, CFB, CFNRy or CFNRc supplementary service code as described in 3GPP TS 24.082 [24], the MSC Server shall generate and send an HTTP GET request to fetch the instance of the Communication Diversion document as specified in 3GPP TS 24.604 [23]. + +When a response to the HTTP GET request is received, the MSC Server shall apply the following interworking: + +- If a 200 OK is received which includes a Communication Diversion document as defined in 3GPP TS 24.604 [23], the MSC Server shall send a RELEASE COMPLETE message as follows: + - If the Communication Diversion document indicates the call forwarding service being interrogated is active, the MSC Server shall indicate an SS-Status of provisioned and active; + +- If the Communication Diversion document indicates the call forwarding service being interrogated is not active, the MSC Server shall indicate an SS-Status of provisioned but not active; +- If the Communication Diversion document contains a "target" attribute containing a TEL URI, the MSC Server shall set the ForwardedToNumber parameter to the TEL URI. +- If a non 200 OK response is received or if a 200 OK response is received which does not include a Communication Diversion document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +#### 5.7.4.7 Explicit Communication Transfer (ECT) + +Configuration of the ECT service involves no signalling and therefore requires no interworking at the MSC Server. + +#### 5.7.4.8 Conference (CONF) + +Configuration of the CONF service involves no signalling and therefore requires no interworking at the MSC Server. + +#### 5.7.4.9 Communication Completion Services (CCBS/CCNL/CCNR) + +##### 5.7.4.9.1 Activation/deactivation + +Activation in the IMS network as specified in 3GPP TS 24.642 [52] is performed using announcement procedures and inband interaction and no special interworking is needed. + +If the MSC Server supports interworking of deactivating all outstanding CCBS requests, the MSC Server shall upon receipt of a REGISTER message with a Deactivate all CCBS Requests Invoke operation revoke all outstanding CCBS requests using the methods in 3GPP TS 24.642 [52]. + +If the MSC receives a REGISTER message with a Deactivate specific CCBS Request the MSC Server shall if no interworking is supported respond with a RELEASE COMPLETE message with an implementation specific error code. + +##### 5.7.4.9.2 Interrogation + +If the MSC Server supports supplementary service configuration interworking for the CCBS service, the interworking procedures in this clause shall be applied. + +When the MSC Server receives a REGISTER message with an InterrogateSS invoke operation for the CCBS supplementary service code as described in 3GPP TS 24.093 [53], the MSC Server shall generate and send an HTTP GET request to fetch the instance of the Communication Completion document as specified in 3GPP TS 24.642 [52]. + +When an HTTP 200 OK response is received which includes a Communication Completion document as defined in 3GPP TS 24.642 [52], the MSC Server shall: + +- 1) if the Communication Completion document indicates the call forwarding service being interrogated is active generate an HTTP GET request to fetch an instance of the Communication Completion Request Records document as defined in 3GPP TS 24.642 [52]; + +when a response to the HTTP GET request is received the MSC server shall: + +- a) if an HTTP 200 OK is received which includes a Communication Completion Request Records document as defined in 3GPP TS 24.642 [52] where there is one or more instances of the "cc-entry" element, assign to each of these elements a CCBS Index and send a RELEASE COMPLETE message indicating an SS-Status of provisioned and include the list of outstanding CCBS requests; and + - b) if an HTTP non 200 OK response is received or if there are no instances of the "cc-entry" element, send a RELEASE COMPLETE message indicating an SS-status set to "provisioned", but there are no outstanding requests; and +- 2) if the Communication Completion document indicates the communication completion service being interrogated is not active, send a RELEASE COMPLETE message indicating an SS-Status of not provisioned. + +When an HTTP non 200 OK response is received or if an HTTP 200 OK response is received which does not include a Communication Completion document, the MSC Server shall send a RELEASE COMPLETE message with an implementation-specific error code. + +## 5.8 Handover / Relocation + +### 5.8.1 Intra-MSC Handover/Relocation + +The MSC Server applies the procedures specified in 3GPP TS 23.009 [37] for Intra-MSC handover/relocation in the CS domain. After the handover/relocation is completed, the MSC Server shall process the interworking between the NAS signalling with the SIP signalling as specified in sub-clauses 5.3 through 5.6. + +### 5.8.2 Inter-MSC Handover/Relocation + +The MSC Server applies the procedures specified in 3GPP TS 23.009 [37] for Inter-MSC handover/relocation in the CS domain. After the handover/relocation is completed, the anchor MSC Server shall process the interworking between the NAS signalling with the SIP signalling as specified in sub-clauses 5.3 through 5.6. The NAS signalling contained in the MAP messages is passed between the anchored MSC Server and the target MSC Server through the E interface as specified in 3GPP TS 29.002 [20]. + +--- + +## 6 User plane interworking + +### 6.1 General + +The following subclauses define the interworking performed by the CS-MGW between the IM CN subsystem and CS domain access. The interworking between the Mb reference point and the user plane portions of the IuCS and A reference points is specified. + +### 6.2 IuCS to Mb interworking + +#### 6.2.1 Interworking with transcoding + +Figure 6.2.1.1 shows the user plane protocol stacks for the IuCS and IM CN subsystem interworking when transcoding is required. + +![Protocol stack diagram for transcoding between IuCS and Mb via CS-MGW.](3337af75dfee8af7687b4f49914d6c93_img.jpg) + +This diagram illustrates the protocol stack for transcoding between IuCS and Mb via a CS-MGW. At the top, a 'Transcoding' label with a double-headed arrow indicates a conversion between 'voice codec 1' and 'voice codec 2'. Below this, the stack consists of several layers: IuFP, RTP/UDP, L3/IP, L2, and L1. The stack is shown in two columns: the left column represents the stack on the IuCS side, and the right column represents the stack on the Mb side. The CS-MGW is shown as the central element where these two stacks meet. Vertical lines with cross-ticks at the bottom indicate the interfaces to IuCS and Mb. + +| | | +|---------------|---------------| +| Transcoding | | +| voice codec 1 | voice codec 2 | +| IuFP | RTP | +| | UDP | +| L3 | IP | +| L2 | L2 | +| L1 | L1 | + +IuCS                      CS-MGW                      Mb + +Protocol stack diagram for transcoding between IuCS and Mb via CS-MGW. + +**Figure 6.2.1.1: IuCS to Mb protocol stack (transcoding)** + +IuFP is defined is defined in 3GPP TS 25.415 [16]. IuCS layer 2 and layer 3 are defined in 3GPP TS 25.414 [15]. The IuCS layer 1 is defined in 3GPP TS 25.411 [17]. + +### 6.2.2 Transcoder-less interworking + +Figure 6.2.2.1 shows the user plane protocol stacks for the interworking when the same codec configuration is used on the IuCS and Mb reference points and transcoding is not required. + +![Protocol stack diagram for transcoder-less interworking between IuCS and Mb via CS-MGW.](39536a630fa74c3bcfd1670ee2152809_img.jpg) + +This diagram illustrates the protocol stack for transcoder-less interworking between IuCS and Mb via a CS-MGW. At the top, a 'Transcoder-less user plane interworking' block spans both columns. Below this, the stack consists of several layers: IuFP, RTP/UDP, L3/IP, L2, and L1. The stack is shown in two columns: the left column represents the stack on the IuCS side, and the right column represents the stack on the Mb side. The CS-MGW is shown as the central element where these two stacks meet. Vertical lines with cross-ticks at the bottom indicate the interfaces to IuCS and Mb. + +| | | +|-----------------------------------------|-----| +| Transcoder-less user plane interworking | | +| IuFP | RTP | +| | UDP | +| L3 | IP | +| L2 | L2 | +| L1 | L1 | + +IuCS                      CS-MGW                      Mb + +Protocol stack diagram for transcoder-less interworking between IuCS and Mb via CS-MGW. + +**Figure 6.2.2.1: IuCS to Mb protocol stack (no transcoding)** + +If no transcoder is inserted, the CS-MGW shall interwork procedures between the IuCS and Mb reference points as specified in 3GPP TS 29.414 [18] clause 7.4. + +## 6.3 TDM-based A-interface to Mb interworking + +### 6.3.1 Interworking with transcoding + +Figure 6.3.1.1 shows the user plane protocol stacks for the TDM-based A and Mb reference point interworking when transcoding is required. + +![Transcoding arrow](4842f073775fb1e84d101c02fd74e59e_img.jpg) + +Transcoding + +| | | +|--------------------------------|---------------| +| voice codec 1 | voice codec 2 | +| TDM
CS
Bearer
Channel | RTP | +| | UDP | +| | IP | +| | L2 | +| L1 | L1 | + +—+— +A +CS-MGW +—+— +Mb + +Transcoding arrow + +**Figure 6.3.1.1: TDM-based A to Mb protocol stack (transcoding)** + +Layer 1 for the TDM-based A-interface is defined in 3GPP TS 48.004 [19]. + +### 6.3.2 Transcoder-less interworking + +Figure 6.3.2.1 shows the user plane protocol stacks for the interworking when the same codec is used on the TDM-based A and Mb reference points and transcoding is not required. + +![](d4ed35f72863013455b8f015e0f2e47e_img.jpg) + +| | | +|-----------------------------------------------|-----| +| Transcoder-less
user plane
interworking | | +| TDM
CS
Bearer
Channel | RTP | +| | UDP | +| | IP | +| | L2 | +| L1 | L1 | + +—+— +A +CS-MGW +—+— +Mb + +**Figure 6.3.2.1: TDM-based A to Mb protocol stack (no transcoding)** + +## 6.4 IP-based A-interface to Mb interworking + +### 6.4.1 Interworking with transcoding + +Figure 6.4.1.1 shows the user plane protocol stacks for the IP-based A and Mb reference point interworking when transcoding is required. + +![Diagram of IP-based A to Mb protocol stack with transcoding](3e8e3bdb3d90f0856266d4eaf36abba1_img.jpg) + +The diagram illustrates the user plane protocol stack for IP-based A to Mb interworking with transcoding. It features a central 'CS-MGW' block with two columns of protocol layers. The left column, labeled 'A', contains 'Voice Codec 1', 'RTP', 'UDP', 'IP', 'L2', and 'L1'. The right column, labeled 'Mb', contains 'Voice Codec 2', 'RTP', 'UDP', 'IP', 'L2', and 'L1'. A curved double-headed arrow labeled 'Transcoding' is positioned above the Voice Codec layers, indicating the conversion between the two different codecs. The stack is connected to external interfaces 'A' on the left and 'Mb' on the right. + +Diagram of IP-based A to Mb protocol stack with transcoding + +Figure 6.4.1.1: IP-based A to Mb protocol stack (transcoding) + +The IP-based A-interface user plane transport is defined in 3GPP TS 48.103 [38]. + +### 6.4.2 Transcoder-less interworking + +Figure 6.4.2.1 shows the user plane protocol stacks for the interworking when the same codec is used on the IP-based A and Mb reference points and transcoding is not required. + +![Diagram of IP-based A to Mb protocol stack without transcoding](ec035e97a11ce40541dec6d88d54c7cb_img.jpg) + +The diagram illustrates the user plane protocol stack for IP-based A to Mb interworking without transcoding. It features a central 'CS-MGW' block. The top section is a single box labeled 'Transcoder-less user plane interworking'. Below this box, the stack consists of two columns of protocol layers: 'RTP', 'UDP', 'IP', 'L2', and 'L1'. The stack is connected to external interfaces 'A' on the left and 'Mb' on the right. + +Diagram of IP-based A to Mb protocol stack without transcoding + +Figure 6.4.2.1: IP-based A to Mb protocol stack (no transcoding) + +The IP-based A-interface user plane transport is defined in 3GPP TS 48.103 [38]. + +## 7 MSC Server – CS-MGW interaction + +### 7.1 Mobile originated call + +#### 7.1.1 CS-MGW selection + +The MSC Server shall select a CS-MGW for the bearer connection before it performs the access bearer assignment or the network side connection point reservation. + +#### 7.1.2 IMS session side establishment + +##### 7.1.2.1 General + +The MSC Server shall either select bearer characteristics or request the CS-MGW to select and provide the bearer characteristics for the network side session before sending the INVITE request. The MSC Server shall use the Reserve RTP Connection Point procedure as defined in 3GPP TS 23.205 [39] and in 3GPP TS 29.232 [11], with additional information elements as specified in the present subclause. + +Within this procedure, the MSC Server shall indicate the received speech codecs from the UE and the MSC Server may indicate some configured speech codec(s) to the CS-MGW and request a local IP address and UDP port from the CS-MGW and the MSC Server may also indicate that the IP interface type is for MboIP as defined in 3GPP TS 23.205 [39] and in 3GPP TS 29.232 [11], with additional information elements as specified in the present subclause. The local IP address and UDP port are used by the CS-MGW to receive user plane data. + +The CS-MGW shall reply to the MSC Server with the selected local speech codec(s) and the selected local IP address and UDP port(s). + +After the succeeding node has provided the SDP answer, the MSC Server uses the Configure RTP Resources procedure as defined in 3GPP TS 29.232 [11] to request the CS-MGW to configure the bearer. + +##### 7.1.2.2 Additions to Reserve RTP Connection Point Procedure + +This procedure is used to reserve an RTP bearer termination. The Reserve RTP Connection Point procedure defined in 3GPP TS 23.205 [39] shall be applied with additional information elements as defined in table 7.1.2.2.1. + +Table 7.1.2.2.1: Additions to Reserve RTP Connection Point Procedure + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|----------------------------------|---------------|----------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve RTP Connection Point | (G)MSC-Server | Priority information | O | This information element requests the CS-MGW to apply priority treatment for the terminations and bearer connections in the specified context. | +| | | ECN Enable | O | This information element requests the CS-MGW to apply ECN procedures. | +| | | ECN Initiation Method | C | This information element specifies the ECN Initiation method and requests the CS-MGW to perform IP header settings as an ECN endpoint. It may be included only if ECN is enabled. | +| | | Notify ECN Failure Event | C | This information element requests a notification if an ECN failure occurs. It may only be supplied if ECN is enabled. | +| | | ICE password request | O | This information element is present if MSC Server requests an ICE password. | +| | | ICE Ufrag request | O | This information element is present if MSC Server requests an ICE ufrag. | +| | | ICE host candidate request | O | This information element is present if MSC Server requests an ICE host candidate. | +| | | ICE pacing request | O | This information element is present if MSC Server requests a pacing value for connectivity checks (Ta timer value). It is only applicable for full ICE. | +| | | STUN server request | O | This information element is present if MSC Server requests the CS-MGW to answer STUN connectivity checks for ICE. | +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| Reserve RTP Connection Point Ack | MGW | ICE password | C | This information element shall be present only if it was contained in the request. It indicates the ICE password assigned by the CS-MGW. | +| | | ICE Ufrag | C | This information element shall be present only if it was contained in the request. It indicates the ICE Ufrag assigned by the CS-MGW. | +| | | ICE host candidate | C | This information element shall be present only if it was contained in the request. It indicates the ICE host candidate assigned by the CS-MGW. | +| | | ICE pacing | C | This information element shall be present only if it was contained in the request. It indicates a desired pacing value for connectivity checks (Ta timer value). | +| | | ICE lite indication | C | This information element shall be present only if an ICE host candidate request was contained in the request, and the CS-MGW supports ICE lite, but not full ICE. It indicates that the CS-MGW only supports ICE lite. | +| | | SDPCapNeg configuration | C | This information element shall be present only if it was contained in the request. It provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | + +### 7.1.2.3 Additions to Configure RTP Connection Point Procedure + +This procedure is used to configure or reconfigure an RTP bearer termination. The Configure RTP Connection Point procedure defined in 3GPP TS 23.205 [39] shall be applied with additional information elements as defined in table 7.1.2.3.1. + +**Table 7.1.2.3.1: Additions to Configure RTP Connection Point Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------------------------|---------------|--------------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Configure RTP Connection Point | (G)MSC-Server | Allowed RTCP APP message types | O | This information element is present if MSC server allows the MGW to send RTCP APP packets of the indicated types defined in TS 26.114 [28]. The MGW shall not send other RTCP APP packets. If the parameter is not supplied, the MGW shall not send any RTCP APP packets. | +| | | ECN Enable | O | This information element requests the CS-MGW to apply ECN procedures. | +| | | ECN Initiation Method | C | This information element specifies the ECN Initiation method and requests the CS-MGW to perform IP header settings as an ECN endpoint. It may be included only if ECN is enabled. | +| | | Notify ECN Failure Event | C | This information element requests a notification if an ECN failure occurs. It may only be supplied if ECN is enabled. | +| | | ICE Connectivity Check | C | This information element requests the CS-MGW to perform ICE connectivity check as defined by IETF RFC 8445 [69]. It is only applicable for full ICE. | +| | | Notify ICE Connectivity Check Result | C | This information element requests a notification of ICE connectivity check result. It is only applicable for full ICE. | +| | | Notify New Peer Reflexive Candidate | C | This information element requests a notification of new peer reflexive candidate was discovered during a connectivity check. It is only applicable for full ICE. | +| | | Additional ICE Connectivity Check | C | This information element requests the CS-MGW to perform additional ICE connectivity check as defined by IETF RFC 8445 [69]. It is only applicable for full ICE. | +| | | ICE received candidate | O | This information element is present if MSC Server indicates a received candidate for ICE. | +| | | ICE received password | O | This information element is present if MSC Server indicates a received password for ICE. | +| | | ICE received pacing | O | This information element is present if MSC Server indicates a received pacing value for connectivity checks (Ta timer value). It is only applicable for full ICE. | +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| Configure RTP Connection Point Ack | MGW | | | | +| | | | | | + +### 7.1.3 Access bearer establishment + +#### 7.1.3.1 General + +The way the MSC Server media gateway interaction is carried out depends on the characteristics of the access bearer network. + +#### 7.1.3.2 Iu interface on IP + +The MSC Server and the CS-MGW shall act in accordance with clause 6.1.3 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +#### 7.1.3.3 A interface over IP + +The MSC Server and the CS-MGW shall act in accordance with clause 6.1.5 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +#### 7.1.3.4 A interface over TDM + +The MSC Server and the CS-MGW shall act in accordance with clause 6.1.1.4 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +#### 7.1.3.5 Iu over UTRAN and GERAN + +The MSC Server and the CS-MGW shall act in accordance with clause 6.1.1.4 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +### 7.1.4 Apply ringing tone + +If the condition as defined in clause 5.3.5 is fulfilled the MSC Server shall instruct the CS-MGW to send ringing tone towards the calling party. In this case the MSC Server shall use the Send Tone procedure in accordance with 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11]. + +If the MSC Server wishes to stop sending the ringing tone e.g. due to the receipt of a 200 OK response to the INVITE request the MSC Server shall apply the Stop Tone procedure as defined in 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11]. + +### 7.1.5 Through connection + +If the MSC Server wants to configure the CS-MGW so that the bearer will be through-connected in the backward direction the MSC Server shall: + +- use Change Through-Connection procedure as defined in 3GPP TS 29.232 [11] during any one of the Prepare Bearer and Reserve Circuit procedures as defined in 3GPP TS 29.232 [11]; or +- use Configure the RTP Connection Point procedure as defined in 3GPP TS 29.232 [11] during Prepare IP bearer procedure as defined in 3GPP TS 29.232 [11]. + +If the MSC Server wants to configure the CS-MGW so that the bearer will be both-way through connected the MSC Server shall use Change Through-Connection procedure as defined in 3GPP TS 29.232 [11]. + +### 7.1.5a Handling of Forking + +The procedures described in subclauses 7.1.1 to 7.1.6 shall be applied with the addition that the MSC Server and the CS-MGW shall act in accordance with subclauses 9.2.3.4.1 to 9.2.3.4.4 in 3GPP TS 29.163 [46]. + +NOTE: For the references to 3GPP TS 29.163 [46], the O-MGCF and I-MGCF in 3GPP TS 29.163 [46] is to be understood as MSC Server, the IM-MGW is to be understood as CS-MGW, and the Configure IMS Resources procedure is to be understood as Configure RTP Resources procedure. + +### 7.1.6 Failure handling in MSC server + +If any procedure between the MSC Server and the CS-MGW has not completed successfully or the MSC Server receives a Bearer Released procedure from the CS-MGW the procedure in accordance with clause 6.1.1.12 of 3GPP TS 23.231 [40] and 3GPP TS 29.232 [11] shall be applied. + +## 7.2 Mobile terminated call + +### 7.2.1 CS-MGW selection + +The MSC Server shall select an CS-MGW for the bearer connection before it performs the network side bearer establishment or the access bearer assignment. The selection of the CS-MGW does not take place before the call proceeding has been received by the MSC Server. + +### 7.2.2 Network side session establishment + +#### 7.2.2.1 General + +The MSC Server shall request the CS-MGW to prepare for the network side session establishment using the Reserve and Configure RTP Connection Point procedure as specified in 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11], with additional information elements as specified in the present subclause. Within this procedure, the MSC Server shall indicate the received speech codecs from the remote UE and request a local IP address and UDP port from the CS-MGW and the MSC Server may also indicate that the IP interface type is for MboIP as defined in 3GPP TS 29.232 [11]. The local IP address and UDP ports are used by the CS-MGW to receive user plane data. The MSC Server shall include the local IP address and UDP port number in the SDP answer for the selected codec. + +#### 7.2.2.2 Additions to Reserve and Configure RTP Connection Point + +This procedure is used to reserve and configure an RTP bearer termination. The Reserve and Configure RTP Connection Point procedure defined in 3GPP TS 23.205 [39] shall be applied with additional information elements as defined in table 7.2.2.2.1. + +**Table 7.2.2.2.1: Additions to Reserve and Configure RTP Connection Point Procedure** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|--------------------------------------------|---------------|--------------------------------------|------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Reserve and Configure RTP Connection Point | (G)MSC-Server | Allowed RTCP APP message types | O | This information element is present if MSC server allows the MGW to send RTCP APP packets of the indicated types defined in TS 26.114 [28]. The MGW shall not send other RTCP APP packets. If the parameter is not supplied, the MGW shall not send any RTCP APP packets. | +| | | Priority information | O | This information element requests the CS-MGW to apply priority treatment for the terminations and bearer connections in the specified context. | +| | | ECN Enable | O | This information element requests the CS-MGW to apply ECN procedures and IP header settings as an ECN endpoint. | +| | | ECN Initiation Method | C | This information element specifies the ECN Initiation method and requests the CS-MGW to perform IP header settings as an ECN endpoint. It may be included only if ECN is enabled. | +| | | Notify ECN Failure Event | C | This information element requests a notification if an ECN failure occurs. It may only be supplied if ECN is enabled. | +| | | STUN server request | O | This information element is present if MSC Server requests the CS-MGW to answer STUN connectivity checks for ICE. | +| | | ICE Connectivity Check | C | This information element requests the CS-MGW to perform ICE connectivity check as defined by IETF RFC 8445 [69]. It is only applicable for full ICE. | +| | | Notify ICE Connectivity Check Result | C | This information element requests a notification of ICE connectivity check result. It is only applicable for full ICE. | +| | | Notify New Peer Reflexive Candidate | C | This information element requests a notification of new peer reflexive candidate was discovered during a connectivity check. It is only applicable for full ICE. | +| | | ICE password request | O | This information element is present if MSC Server requests an ICE password. | +| | | ICE Ufrag request | O | This information element is present if MSC Server requests an ICE ufrag. | +| | | ICE host candidate request | O | This information element is present if MSC Server requests an ICE host candidate. | +| | | ICE pacing request | O | This information element is present if MSC Server requests a pacing value for connectivity checks (Ta timer value). It is only applicable for full ICE. | +| | | ICE received candidate | O | This information element is present if MSC Server indicates a received candidate for ICE. | +| | | ICE received password | O | This information element is present if MSC Server indicates a received password for ICE. | +| | | ICE received Ufrag | O | This information element is present if MSC Server indicates a received Ufrag for ICE. | +| | | ICE received pacing | O | This information element is present if MSC Server indicates a received pacing value for connectivity checks (Ta timer value). It is only applicable for full ICE. | + +| | | | | | +|------------------------------------------------|-----|-------------------------|---|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | SDPCapNeg configuration | O | This information element provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | +| Reserve and Configure RTP Connection Point Ack | MGW | ICE password | C | This information element shall be present only if it was contained in the request. It indicates the ICE password assigned by the CS-MGW. | +| | | ICE Ufrag | C | This information element shall be present only if it was contained in the request. It indicates the ICE Ufrag assigned by the CS-MGW. | +| | | ICE host candidate | C | This information element shall be present only if it was contained in the request. It indicates the ICE host candidate assigned by the CS-MGW. | +| | | ICE pacing | C | This information element shall be present only if it was contained in the request. It indicates a desired pacing value for connectivity checks (Ta timer value). | +| | | ICE lite indication | C | This information element shall be present only if an ICE host candidate request was contained in the request, and the CS-MGW supports ICE lite, but not full ICE. It indicates that the CS-MGW only supports ICE lite. | +| | | SDPCapNeg configuration | C | This information element shall be present only if it was contained in the request. It provides SDPCapNeg configuration(s) using as "a=acap", "a=tcap", "a=pcfg" and "a=acfg" SDP attributes. | + +## 7.2.3 Access bearer assignment + +### 7.2.3.1 General + +The way the MSC Server-CS-MGW interaction is carried out depends on the characteristics of the access bearer network. + +### 7.2.3.2 Iu interface on IP + +The MSC Server and the CS-MGW shall act in accordance with clause 6.2.3 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +### 7.2.3.3 A interface over IP + +The MSC Server and the CS-MGW shall act in accordance with clause 6.2.4 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +### 7.2.3.4 A interface over TDM + +The MSC Server and the CS-MGW shall act in accordance with clause 6.2.2.2.4 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +### 7.2.3.5 Iu over UTRAN and GERAN + +The MSC Server and the CS-MGW shall act in accordance with clause 6.2.2.2.4 in 3GPP TS 23.205 [39] and apply the coding in accordance with 3GPP TS 29.232 [11]. + +## 7.2.4 Apply ringing tone + +If the condition as defined in clause 5.4.7 is fulfilled the MSC Server shall instruct the CS-MGW to send ringing tone towards the calling party. In this case the MSC Server shall use the Send Tone procedure in accordance with 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11]. + +If the MSC Server wishes to stop sending the ringing tone, e.g. due to receipt of the CONNECT message, the MSC Server shall apply the Stop Tone procedure as defined in 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11]. + +## 7.2.5 Through connection + +If the MSC Server wants to configure the CS-MGW so that the bearer will not be through-connected the MSC Server shall: + +- use Change Through-Connection procedure as defined in 3GPP TS 29.232 [11] during any one of the Prepare Bearer and Reserve Circuit procedures as defined in 3GPP TS 29.232 [11]; or +- use Configure the RTP Connection Point procedure as defined in 3GPP TS 29.232 [11] during Prepare IP bearer procedure as defined in 3GPP TS 29.232 [11]. + +If the MSC Server wants to configure the CS-MGW so that the bearer will be both-way through connected the MSC Server shall use the Change Through-Connection procedure as defined in 3GPP TS 29.232 [11]. + +## 7.2.6 Announcement + +If the MSC Server wants to provide an announcement, e.g. when the condition in clause 5.4.7 is fulfilled, the MSC Server shall instruct the CS-MGW to send an announcement. In this case the MSC Server shall use the Play Announcement procedure in accordance with 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11]. + +If the MSC Server wishes to stop the sending of an announcement the MSC Server shall apply the Stop Announcement procedure as defined in 3GPP TS 23.205 [39] and 3GPP TS 29.232 [11]. + +## 7.2.7 Failure handling in the MSC server + +If any procedure between the MSC Server and the CS-MGW has not completed successfully or the MSC Server receives a Bearer Released procedure from the CS-MGW the procedure in accordance with clause 6.2.1.3.13 of 3GPP TS 23.231 [40] and 3GPP TS 29.232 [11] shall be applied. + +# 7.2A Notification Procedures + +## 7.2A.1 General information + +This subclause contains procedures common to mobile originated and mobile terminated calls which are not defined in 3GPP TS 23.205 [39] but are applicable to the MSC Server enhanced for ICS and the CS-MGW. + +## 7.2A.2 ECN Failure Indication + +This procedure is used to report ECN related errors (see 3GPP TS 29.163 [46] clause 9.2.11.1c). + +**Table 7.2A.2.1: Procedures between MSC Server and CS-MGW: ECN Failure Indication** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|----------------------------|------------|--------------------------|------------------------------|--------------------------------------------------------------------------------------------------| +| ECN Failure Indication | CS-MGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ECN failure is reported. | +| | | ECN Failure Indication | M | This IE indicates an ECN failure event. | +| ECN Failure Indication Ack | MSC Server | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +### 7.2A.3 ICE Connectivity Check Result Notification + +This procedure is used to report ICE connectivity check result for Full ICE. + +**Table 7.2A.3.1: Procedures between MSC Server and CS-MGW: ICE Connectivity Check Result Notification** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|------------------------------------------------|------------|-------------------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------| +| ICE Connectivity Check Result Notification | CS-MGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ICE Connectivity Check Result is reported. | +| | | ICE Connectivity Check Result | M | This information element indicates an ICE Connectivity Check Result event. | +| ICE Connectivity Check Result Notification Ack | MSC Server | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +### 7.2A.4 ICE New Peer Reflexive Candidate Notification + +This procedure is used to report ICE new peer reflexive candidate for Full ICE. + +**Table 7.2A.4.1: Procedures between MSC Server and CS-MGW: ICE New Peer Reflexive Candidate Notification** + +| Procedure | Initiated | Information element name | Information element required | Information element description | +|---------------------------------------------------|------------|----------------------------------|------------------------------|----------------------------------------------------------------------------------------------------------------------| +| ICE New Peer Reflexive Candidate Notification | CS-MGW | Context | M | This information element indicates the context for the bearer termination. | +| | | Bearer Termination | M | This information element indicates the bearer termination for which the ICE New Peer Reflexive Candidate is reported | +| | | ICE New Peer Reflexive Candidate | M | This information element indicates an ICE New Peer Reflexive Candidate event. | +| ICE New Peer Reflexive Candidate Notification Ack | MSC Server | Context | M | This information element indicates the context where the command was executed. | +| | | Bearer Termination | M | This information element indicates the bearer termination where the command was executed. | + +## 7.3 Call clearing + +### 7.3.1 Clearing received from the network + +#### 7.3.1.1 Access bearer clearing + +Once the call clearing and the release of the associated radio resources have been completed, the MSC Server releases any CS-MGW allocated resources for the access side. If any resources were seized in the CS-MGW, the MSC Server uses the Release Termination procedure as specified in 3GPP TS 29.232 [11] to request the CS-MGW to remove the access side bearer termination. + +#### 7.3.1.2 Network side clearing + +If the MSC Server requires to release resources due to the receipt of a BYE or CANCEL request or a response including a failure indication from the network the MSC Server shall act in accordance with clause 7.2.6 in 3GPP TS 23.231 [40] and 3GPP TS 29.232 [11]. + +### 7.3.2 Clearing received from the user + +#### 7.3.2.1 Access bearer clearing + +Once the call clearing and the release of the associated radio resources have been completed, the MSC Server releases any CS-MGW allocated resources for the access side. If any resources were seized in the CS-MGW, the MSC Server uses the Release Termination procedure as specified in 3GPP TS 29.232 [11] to request the CS-MGW to remove the access side bearer termination. + +#### 7.3.2.2 Network side clearing + +If the MSC Server requires to release resources due to the receipt of a BYE or CANCEL request or a response including a failure indication from the originating or terminating UE the MSC Server shall act in accordance with clause 7.2.6 in 3GPP TS 23.231 [40] and 3GPP TS 29.232 [11]. + +### 7.3.3 Call clearing received from the CS-MGW + +#### 7.3.3.1 Bearer released received on the access side + +After the MSC Server has received the Bearer Released procedure from the CS-MGW on the access side, the MSC Server shall release the access resources as described in 3GPP TS 24.008 [3]. If the call is already established towards the network side, call clearing to the network side is performed as described in clause 5.5.3. + +#### 7.3.3.2 Bearer released received on the network side + +After the MSC Server has received the Bearer Released procedure from the CS-MGW on the network side, the MSC Server shall clear the call to the network side as described in clause 5.5.3 and clear the call to the UE as described in 3GPP TS 24.008 [3]. + +## 7.4 Call independent procedures + +The MSC Server and the CS-MGW are involved in a number of procedures which are not related to the setting up and clearing of calls. The MSC Server and the CS-MGW shall comply with the requirements stated in the different subclauses 10.1 - 10.10 of 3GPP TS 23.205 [39] and subclauses 10.12 - 10.16 of 3GPP TS 23.205 [39]. + +## 7.5 Explicit Congestion Notification + +An MSC Server and a CS-MGW may support Multimedia Telephony using Explicit Congestion Notification (see IETF RFC 3168 [48], IETF RFC 6679 [49], and 3GPP TS 26.114 [28]), and may then act as an ECN endpoint to enable ECN with a local ECN-capable terminal within a local network that properly handles ECN-marked packets. + +The ECN procedures described in 3GPP TS 29.163 [46], clause 9.2.11, for MGCF and IM-MGW are then applicable for MSC Server and the CS-MGW. + +## 7.6 Multimedia Priority Service (MPS) Support + +The Multimedia Priority Service (MPS) is specified in 3GPP TS 22.153 [54]. An MSC Server and a CS-MGW may support the priority treatment of a call/session identified as an MPS call/session. + +The MPS procedures described in 3GPP TS 29.163 [46], clause 9.4, for MGCF and IM-MGW are then applicable for MSC Server and the CS-MGW. + +## 7.7 Interactive Connectivity Establishment + +An MSC Server and a CS-MGW may support ICE functionality as specified in IETF RFC 8445 [69] and IETF RFC 8839 [70], and 3GPP TS 24.229 [2]. + +Support of full ICE functionality is optional, but if ICE is supported, the MSC Server and the CS-MGW shall at least support ICE lite as specified in IETF RFC 8445 [69]. + +The requirements as described in clause 9.2.12 of 3GPP TS 29.163 [46] for MGCF and IM-MGW, apply to the MSC Server and the CS-MGW when the ICE procedures are supported. + +## 7.8 Codec Parameters Handling + +### 7.8.1 Handling of common codec parameters + +The requirements as described in clause 9.2.13.1 of 3GPP TS 29.163 [46] for the MGCF and the IM-MGW, apply to the MSC Server and the CS-MGW. + +## 7.8.2 EVS speech codec + +The Enhanced Voice Services (EVS) speech codec is defined in 3GPP TS 26.441 [61]. Its RTP payload type is defined in 3GPP TS 26.445 [62], and procedures for its usage as IMS Multimedia Telephony speech codec are defined in 3GPP TS 26.114 [28]. + +The MSC Server and the CS-MGW may support transcoding to and from the EVS speech codec. If they do so, the requirements as described in clause 9.2.13.2 of 3GPP TS 29.163 [46] for the MGCF and the IM-MGW, apply to the MSC Server and the CS-MGW. + +## 7.8.3 IVAS speech codec + +The Immersive Voice and Audio Service (IVAS) speech and audio codec is defined in 3GPP TS 26.250 [71]. Its RTP payload type is defined in 3GPP TS 26.253 [72], and procedures for its usage as IMS Multimedia Telephony speech codec are defined in 3GPP TS 26.114 [28]. + +The MSC Server and the CS-MGW may support transcoding to and from the IVAS speech and audio codec. If they do so, the requirements as described in clause 9.2.13.4 of 3GPP TS 29.163 [46] for the MGCF and the IM-MGW, apply to the MSC Server and the CS-MGW. + +## 7.9 SDP Capability Negotiation (SDPCapNeg) + +The SDP Capability Negotiation (SDPCapNeg) as specified in IETF RFC 5939 [63] is adopted as an optional functionality to negotiate capabilities and their associated configurations according to 3GPP TS 24.229 [2]. + +The SDPCapNeg requirements and procedures described in subclause 5.2.23 of 3GPP TS 23.333 [64] for MRFC and MRFP are then applicable for MSC Server and the CS-MGW. \ No newline at end of file diff --git a/marked/Rel-18/29_series/29379/raw.md b/marked/Rel-18/29_series/29379/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..bf45805c947551798fc7aff62a641d01525ca9d0 --- /dev/null +++ b/marked/Rel-18/29_series/29379/raw.md @@ -0,0 +1,5209 @@ + + +# 3GPP TS 29.379 V18.0.0 (2024-04) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; Mission Critical Push To Talk (MCPTT) call control interworking with Land Mobile Radio (LMR) systems; 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. + +© 2024, 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..... | 11 | +| 2 References..... | 11 | +| 3 Definitions of terms, symbols and abbreviations..... | 12 | +| 3.1 Terms..... | 12 | +| 3.2 Abbreviations ..... | 13 | +| 4 General..... | 13 | +| 4.1 IWF overview..... | 13 | +| 4.2 Warning Header Field..... | 13 | +| 4.2.1 General ..... | 13 | +| 4.2.2 Warning texts..... | 13 | +| 4.3 MCPTT priority calls and alerts..... | 14 | +| 4.4 Media security at the IWF..... | 14 | +| 4.5 Broadcast group calls ..... | 14 | +| 5 Functional entities ..... | 14 | +| 5.1 General ..... | 14 | +| 5.2 Functional connectivity models ..... | 15 | +| 6 Call control common procedures ..... | 17 | +| 6.1 SDP..... | 17 | +| 6.1.1 SDP offer generation ..... | 17 | +| 6.1.2 SDP answer generation..... | 18 | +| 6.2 Commencement modes ..... | 18 | +| 6.2.1 Automatic commencement mode for private calls..... | 18 | +| 6.2.2 Manual commencement mode for private calls..... | 19 | +| 6.3 Receiving an MCPTT session release request ..... | 19 | +| 6.4 Priority call conditions ..... | 19 | +| 6.4.1 MCPTT emergency group call conditions ..... | 19 | +| 6.4.1.1 SIP INVITE request for originating MCPTT emergency group calls ..... | 19 | +| 6.4.1.2 Resource-Priority header field for MCPTT emergency group calls..... | 20 | +| 6.4.1.3 SIP re-INVITE request for cancelling MCPTT in-progress emergency group state..... | 21 | +| 6.4.1.4 Receiving a SIP 2xx response to a SIP request for a priority call ..... | 21 | +| 6.4.1.5 Receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to a SIP request for a priority group call ..... | 22 | +| 6.4.1.6 SIP request for originating MCPTT imminent peril group calls ..... | 22 | +| 6.4.1.7 SIP re-INVITE request for cancelling MCPTT in-progress imminent peril group state..... | 23 | +| 6.4.1.8 Resource-Priority header field for MCPTT imminent peril group calls..... | 23 | +| 6.4.1.9 Receiving a SIP INFO request in the dialog of a SIP request for a priority group call..... | 23 | +| 6.4.1.10 SIP re-INVITE request for cancelling the in-progress emergency group state of a group by a third-party ..... | 24 | +| 6.4.1.11 Resource-Priority header field values..... | 25 | +| 6.4.2 MCPTT emergency private call conditions..... | 25 | +| 6.4.2.1 SIP request for originating MCPTT emergency private calls..... | 25 | +| 6.4.2.2 Resource-Priority header field for MCPTT emergency private calls ..... | 25 | +| 6.4.2.3 SIP re-INVITE request for cancelling MCPTT emergency private call state ..... | 26 | +| 6.5 Location information..... | 26 | +| 6.5.1 Location information for location reporting ..... | 26 | +| 6.6 IWF server role procedures ..... | 27 | +| 6.6.1 Distinction of requests sent to the IWF ..... | 27 | +| 6.6.1.1 SIP INVITE request..... | 27 | +| 6.6.1.2 SIP MESSAGE request ..... | 27 | +| 6.6.1.3 SIP SUBSCRIBE request ..... | 28 | +| 6.6.2 IWF participating role ..... | 28 | +| 6.6.2.1 Requests initiated by a participant homed in the IWF..... | 28 | + +| | | | +|------------|-------------------------------------------------------------------------------------|----| +| 6.6.2.1.1 | SDP offer generation ..... | 28 | +| 6.6.2.1.2 | Sending an INVITE request ..... | 29 | +| 6.6.2.1.3 | IWF sending a SIP BYE request ..... | 30 | +| 6.6.2.1.4 | Priority call conditions ..... | 30 | +| 6.6.2.1.5 | Sending a SIP INVITE request on receipt of SIP 3xx response ..... | 31 | +| 6.6.2.2 | Requests terminated to the IWF ..... | 32 | +| 6.6.2.2.1 | SDP offer generation ..... | 32 | +| 6.6.2.2.2 | SIP BYE request towards the terminating IWF ..... | 32 | +| 6.6.3 | IWF controlling role ..... | 32 | +| 6.6.3.1 | Requests initiated by the IWF performing the controlling role ..... | 32 | +| 6.6.3.1.1 | Sending an INVITE request ..... | 32 | +| 6.6.3.1.2 | Sending a SIP BYE request ..... | 33 | +| 6.6.3.1.3 | Sending a SIP re-INVITE request for MCPTT emergency group call ..... | 33 | +| 6.6.3.1.4 | Sending a SIP INVITE request for MCPTT emergency group call ..... | 34 | +| 6.6.3.1.5 | Sending a SIP UPDATE request for Resource-Priority header field correction ..... | 35 | +| 6.6.3.1.6 | Generating a SIP re-INVITE request to cancel an in-progress emergency ..... | 36 | +| 6.6.3.1.7 | Populate mcptt-info and location-info MIME bodies for emergency alert ..... | 36 | +| 6.6.3.1.8 | Authorisations ..... | 37 | +| 6.6.3.1.9 | Generating a SIP 403 response for priority call request rejection ..... | 40 | +| 6.6.3.1.10 | Handling the expiry of timer TNG2 (in-progress emergency group call timer) ..... | 40 | +| 6.6.3.1.11 | Sending a SIP INFO request in the dialog of a SIP request for a priority call ..... | 41 | +| 6.6.3.1.12 | Retrieving Resource-Priority header field values ..... | 41 | +| 6.6.3.2 | Requests terminated by the IWF performing the controlling role ..... | 41 | +| 6.6.3.2.1 | Receiving a SIP BYE request ..... | 41 | +| 6.6.3.3 | Handling of the acknowledged call setup timer (TNG1) ..... | 42 | +| 6.6.3.4 | Generating a SIP NOTIFY request ..... | 44 | +| 6.6.3.5 | Handling of the group call timer (TNG3) ..... | 45 | +| 6.6.3.5.1 | General ..... | 45 | +| 6.6.3.5.2 | Interaction with the in-progress emergency group call timer (TNG2) ..... | 45 | +| 6.6.4 | IWF non-controlling role ..... | 46 | +| 6.6.4.1 | Request initiated by the IWF performing the non-controlling role of a group ..... | 46 | +| 6.6.4.1.1 | SDP offer generation ..... | 46 | +| 6.6.4.1.2 | Sending an INVITE request towards the MCPTT client ..... | 46 | +| 6.6.4.1.3 | Sending a SIP INFO request ..... | 47 | +| 6.6.4.1.4 | Sending an INVITE request towards the controlling MCPTT function ..... | 48 | +| 6.6.4.2 | Requests terminated by the non-controlling MCPTT function of an MCPTT group ..... | 49 | +| 6.6.4.2.1 | SDP answer generation ..... | 49 | +| 6.6.4.2.2 | Sending a SIP response to the SIP INVITE request ..... | 49 | +| 6.6.4.3 | Generating a SIP NOTIFY request ..... | 50 | +| 6.6.5 | Retrieving and processing a group document ..... | 51 | +| 6.6.5.1 | General ..... | 51 | +| 6.6.5.2 | Rules for joining a group session ..... | 51 | +| 6.6.5.3 | Determining the group members to invite ..... | 51 | +| 6.6.6 | Error handling ..... | 51 | +| 6.6.6.1 | Public service identity does not exist ..... | 51 | +| 6.6.7 | Session release policy ..... | 51 | +| 6.6.7.1 | Session release policy for group call ..... | 51 | +| 6.6.7.2 | Session release policy for private call ..... | 52 | +| 6.7 | Implicit floor request ..... | 52 | +| 6.8 | Confidentiality and Integrity Protection ..... | 52 | +| 6.8.1 | General ..... | 52 | +| 6.8.1.1 | Applicability and exclusions ..... | 52 | +| 6.8.1.2 | Performing XML content encryption ..... | 52 | +| 6.8.1.3 | Performing integrity protection on an XML body ..... | 52 | +| 6.8.1.4 | Keys used in confidentiality protection procedures ..... | 53 | +| 6.8.2 | Confidentiality Protection ..... | 53 | +| 6.8.2.1 | Procedures for sending confidentiality protected content ..... | 53 | +| 6.8.2.1.1 | IWF performing any role of an MCPTT server ..... | 53 | +| 6.8.2.2 | IWF copying received XML content ..... | 53 | +| 6.8.3 | Integrity Protection of XML documents ..... | 54 | +| 6.8.3.1 | Keys used in integrity protection procedures ..... | 54 | +| 6.8.3.2 | Integrity protection at the IWF ..... | 54 | + +| | | | +|------------|-------------------------------------------------------------------------------------------|----| +| 6.9 | Priority sharing ..... | 54 | +| 6.10 | Void ..... | 55 | +| 7 | Registration and service authorisation ..... | 55 | +| 8 | Pre-established session ..... | 55 | +| 9 | Affiliation ..... | 55 | +| 9.1 | General ..... | 55 | +| 9.2 | Procedures ..... | 56 | +| 9.2.1 | IWF procedures towards the MCPTT system ..... | 56 | +| 9.2.1.1 | General ..... | 56 | +| 9.2.1.2 | Procedures towards the MCPTT system of an IWF serving the user homed in the IWF ..... | 56 | +| 9.2.1.2.1 | General ..... | 56 | +| 9.2.1.2.2 | Stored information ..... | 56 | +| 9.2.1.2.3 | Procedure for handling affiliation status change of a user homed in the IWF ..... | 56 | +| 9.2.1.2.4 | Receiving subscription to affiliation status procedure ..... | 59 | +| 9.2.1.2.5 | Sending notification of change of affiliation status procedure ..... | 59 | +| 9.2.1.2.6 | Sending affiliation status change towards MCPTT server owning MCPTT group procedure ..... | 60 | +| 9.2.1.2.7 | Affiliation status determination from MCPTT server owning MCPTT group procedure ..... | 61 | +| 9.2.1.2.8 | Affiliation status determination ..... | 64 | +| 9.2.1.2.9 | Affiliation status change by implicit affiliation ..... | 64 | +| 9.2.1.2.10 | Implicit affiliation status change completion ..... | 66 | +| 9.2.1.2.11 | Implicit affiliation status change cancellation ..... | 66 | +| 9.2.1.2.12 | Automatic affiliation to configured groups procedure ..... | 66 | +| 9.2.1.3 | Procedures of MCPTT server owning the MCPTT group ..... | 66 | +| 9.2.1.3.1 | General ..... | 66 | +| 9.2.1.3.2 | Stored information ..... | 67 | +| 9.2.1.3.3 | Receiving group affiliation status change procedure ..... | 67 | +| 9.2.1.3.4 | Receiving subscription to affiliation status procedure ..... | 68 | +| 9.2.1.3.5 | Sending notification of change of affiliation status procedure ..... | 69 | +| 9.2.1.3.6 | Implicit affiliation eligibility check procedure ..... | 70 | +| 9.2.1.3.7 | Affiliation status change by implicit affiliation procedure ..... | 70 | +| 9.2.1.3.8 | Affiliation eligibility check procedure ..... | 71 | +| 9.2.1.3.9 | Receiving subscription to group dynamic data procedure ..... | 71 | +| 9.2.1.3.10 | Sending notification of change of group dynamic data procedure ..... | 72 | +| 10 | Call signalling - group call ..... | 72 | +| 10.1 | Prearranged group call ..... | 72 | +| 10.1.2 | Client derived procedures ..... | 72 | +| 10.1.2.1 | IWF originating procedures ..... | 72 | +| 10.1.2.2 | IWF performing the participating role terminating procedures ..... | 74 | +| 10.1.2.3 | MCPTT upgrade to in-progress emergency or imminent peril ..... | 75 | +| 10.1.2.4 | MCPTT in-progress emergency cancel ..... | 75 | +| 10.1.2.5 | MCPTT in-progress imminent peril cancel ..... | 77 | +| 10.1.2.6 | Reception of SIP re-INVITE request ..... | 77 | +| 10.1.3 | IWF participating role procedures ..... | 78 | +| 10.1.3.1 | Originating procedures ..... | 78 | +| 10.1.3.1.1 | On demand prearranged group call ..... | 78 | +| 10.1.3.1.2 | Sending of a SIP re-INVITE request towards MCPTT controlling function ..... | 79 | +| 10.1.3.2 | Terminating Procedures ..... | 80 | +| 10.1.3.3 | IWF participating role ending group call ..... | 81 | +| 10.1.3.3.1 | IWF ending group call on-demand ..... | 81 | +| 10.1.3.4 | End group call at the IWF performing the participating role ..... | 81 | +| 10.1.3.4.1 | Receipt of SIP BYE request for private call on-demand ..... | 81 | +| 10.1.3.5 | Re-join procedures ..... | 81 | +| 10.1.3.5.1 | Originating procedures - on demand prearranged group call ..... | 81 | +| 10.1.3.6 | Reception of a SIP re-INVITE request for terminating a priority call ..... | 81 | +| 10.1.4 | IWF Controlling role procedures ..... | 82 | +| 10.1.4.1 | Originating Procedures ..... | 82 | +| 10.1.4.1.1 | INVITE targeted to an MCPTT client ..... | 82 | +| 10.1.4.1.2 | INVITE targeted to the non-controlling MCPTT function of an MCPTT group ..... | 83 | +| 10.1.4.2 | Terminating Procedures ..... | 84 | + +| | | | +|------------|--------------------------------------------------------------------------------------------------------------------|-----| +| 10.1.4.3 | End group call at the IWF performing the terminating controlling role..... | 92 | +| 10.1.4.4 | End group call initiated by the IWF performing the controlling role ..... | 92 | +| 10.1.4.4.1 | General ..... | 92 | +| 10.1.4.4.2 | SIP BYE request for releasing MCPTT session for a group call ..... | 92 | +| 10.1.4.4.3 | SIP BYE request towards a MCPTT client..... | 92 | +| 10.1.4.5 | Re-join procedures..... | 93 | +| 10.1.4.5.1 | Terminating procedures..... | 93 | +| 10.1.4.6 | Late call entry initiated by IWF performing the controlling role ..... | 94 | +| 10.1.4.7 | Receipt of a SIP re-INVITE request ..... | 94 | +| 10.1.4.8 | Handling of a SIP re-INVITE request for imminent peril session ..... | 97 | +| 10.1.5 | Non-controlling role procedures..... | 99 | +| 10.2 | Chat group (restricted) call..... | 99 | +| 10.2.1 | Client derived procedures..... | 99 | +| 10.2.1.1 | On-demand chat group call..... | 99 | +| 10.2.1.1.1 | Procedure for initiating an MCPTT chat group session and procedure for joining an MCPTT chat group session ..... | 99 | +| 10.2.1.1.2 | IWF performing the terminating participating role receives SIP re-INVITE request for an MCPTT chat group..... | 101 | +| 10.2.1.1.3 | MCPTT in-progress emergency cancel..... | 101 | +| 10.2.1.1.4 | MCPTT upgrade to in-progress emergency or imminent peril ..... | 102 | +| 10.2.1.1.5 | MCPTT in-progress imminent peril cancel..... | 103 | +| 10.2.1.1.6 | IWF performing the terminating participating role receives a SIP INVITE request for an MCPTT chat group call..... | 104 | +| 10.2.2 | IWF performing the participating role procedures ..... | 105 | +| 10.2.2.1 | On-demand chat group call..... | 105 | +| 10.2.2.1.1 | MCPTT chat session establishment ..... | 105 | +| 10.2.2.1.2 | Sending of a SIP re-INVITE request towards the MCPTT controlling function..... | 106 | +| 10.2.2.1.3 | Reception of a SIP INVITE request by an IWF performing the terminating participating role .... | 107 | +| 10.2.2.1.4 | Reception of a SIP re-INVITE request by an IWF performing the terminating participating role..... | 107 | +| 10.2.2.2 | End group call at the originating participating IWF ..... | 107 | +| 10.2.2.2.1 | IWF ending on-demand chat session ..... | 107 | +| 10.2.2.3 | End group call at the terminating participating IWF ..... | 107 | +| 10.2.2.3.1 | Receipt of SIP BYE request for on-demand chat session ..... | 107 | +| 10.2.3 | IWF controlling role procedures ..... | 107 | +| 10.2.3.1 | On-demand chat group call..... | 107 | +| 10.2.3.1.1 | Procedure for establishing an MCPTT chat session and procedure for joining an established MCPTT chat session ..... | 107 | +| 10.2.3.1.2 | Receipt of a SIP re-INVITE request ..... | 112 | +| 10.2.3.1.3 | Handling of a SIP re-INVITE request for imminent peril session..... | 115 | +| 10.2.3.2 | End group call at the terminating IWF performing the controlling role..... | 118 | +| 10.2.3.3 | End group call initiated by the IWF performing the controlling role ..... | 118 | +| 10.2.3.3.1 | General ..... | 118 | +| 10.2.3.3.2 | SIP BYE request for releasing MCPTT session for a group call ..... | 118 | +| 10.2.3.3.3 | SIP BYE request towards a MCPTT client..... | 118 | +| 10.2.3.3.4 | Removal of participant homed in the IWF ..... | 118 | +| 10.2.4 | Non-controlling role procedures..... | 118 | +| 10.3 | Subscription to the conference event package ..... | 118 | +| 10.3.1 | General ..... | 118 | +| 10.3.2 | IWF performing the participating role..... | 119 | +| 10.3.3 | IWF performing the controlling role ..... | 119 | +| 10.3.3.1 | Receiving a subscription to the conference event package..... | 119 | +| 10.3.3.2 | Sending notifications to the conference event package ..... | 120 | +| 10.3.3.3 | Sending subscriptions to the conference event package ..... | 120 | +| 10.3.3.4 | Terminating a subscription ..... | 121 | +| 10.3.4 | IWF performing the non-controlling role ..... | 122 | +| 10.4 | Remotely initiated group call ..... | 122 | +| 10.4.1 | Participating MCPTT function procedures ..... | 122 | +| 10.4.1.1 | IWF performing the participating role..... | 122 | +| 10.4.1.1.1 | Originating procedures ..... | 122 | +| 10.4.1.1.2 | Terminating procedures..... | 122 | +| 10.4.1.2 | IWF performing the controlling role ..... | 122 | + +| | | | +|------------|-------------------------------------------------------------------------------------------------|-----| +| 11 | Private call call control ..... | 122 | +| 11.1 | Private call with floor control..... | 122 | +| 11.1.1 | Client derived procedures..... | 122 | +| 11.1.1.1 | On-demand private call..... | 122 | +| 11.1.1.1.1 | Originating procedures..... | 122 | +| 11.1.1.1.2 | IWF terminating procedures..... | 124 | +| 11.1.1.1.3 | Terminating procedures for reception of SIP re-INVITE request..... | 125 | +| 11.1.1.1.4 | MCPTT in-progress emergency cancel..... | 126 | +| 11.1.1.1.5 | Upgrade to MCPTT emergency private call ..... | 127 | +| 11.1.2 | IWF participating role procedures..... | 127 | +| 11.1.2.1 | Originating procedures ..... | 127 | +| 11.1.2.1.1 | On-demand private call..... | 127 | +| 11.1.2.1.2 | SIP re-INVITE for MCPTT private call ..... | 128 | +| 11.1.2.2 | Terminating procedures ..... | 129 | +| 11.1.2.3 | Receipt of SIP re-INVITE request by terminating participating function..... | 129 | +| 11.1.3 | IWF controlling role procedures ..... | 130 | +| 11.1.3.1 | Originating procedures ..... | 130 | +| 11.1.3.2 | Terminating procedures ..... | 131 | +| 11.1.3.3 | Receiving a SIP re-INVITE for upgrade to emergency private call..... | 132 | +| 11.1.3.4 | Receiving a SIP re-INVITE for cancellation of emergency private call ..... | 133 | +| 11.1.3.5 | Sending a SIP re-INVITE for upgrade to emergency private call..... | 135 | +| 11.1.3.6 | Sending a SIP re-INVITE for cancellation of emergency private call ..... | 136 | +| 11.2 | Private call without floor control ..... | 136 | +| 11.2.1 | Participating role procedures ..... | 136 | +| 11.2.1.1 | Originating procedures ..... | 136 | +| 11.2.1.2 | Terminating procedures ..... | 136 | +| 11.2.2 | Controlling role procedures ..... | 137 | +| 11.2.2.1 | Originating procedures ..... | 137 | +| 11.3 | Ending the private call initiated by a client..... | 137 | +| 11.3.1 | IWF performing the participating role procedures ..... | 137 | +| 11.3.1.1 | Terminating procedures ..... | 137 | +| 11.3.1.1.1 | Receipt of SIP BYE request for private call on-demand ..... | 137 | +| 11.4 | Ending the private call initiated by the MCPTT server ..... | 137 | +| 11.4.1 | Client derived procedures..... | 137 | +| 11.4.1.1 | Receiving a SIP BYE request for private call session ..... | 137 | +| 11.4.2 | IWF participating role procedures..... | 137 | +| 11.4.2.1 | Terminating procedures ..... | 137 | +| 11.4.2.1.1 | Receipt of SIP BYE request for private call on-demand ..... | 137 | +| 11.4.3 | IWF controlling role procedures ..... | 137 | +| 12 | Emergency alert ..... | 138 | +| 12.1 | IWF performing the participating role procedures..... | 138 | +| 12.1.1 | IWF to send SIP MESSAGE request for emergency notification..... | 138 | +| 12.1.2 | Receipt of a SIP MESSAGE request for emergency notification for terminating LMR user..... | 138 | +| 12.1.3 | Receipt of a SIP MESSAGE request indicating successful delivery of emergency notification ..... | 139 | +| 12.2 | IWF controlling role procedures ..... | 139 | +| 12.2.1 | Handling of a SIP MESSAGE request for emergency notification..... | 139 | +| 12.2.2 | Handling of a SIP MESSAGE request for emergency alert cancellation..... | 141 | +| 13 | Location procedures..... | 144 | +| 13.1 | General ..... | 144 | +| 13.2 | IWF participating role location procedures..... | 145 | +| 13.2.1 | General ..... | 145 | +| 13.2.2 | Location reporting configuration..... | 145 | +| 13.2.3 | Location reporting request..... | 145 | +| 13.2.4 | Location information report ..... | 145 | +| 14 | Handling of Interworking Security Data messages..... | 145 | +| 14.1 | IWF..... | 145 | +| 14.1.1 | IWF originates Interworking Security Data message..... | 145 | +| 14.1.2 | IWF receives Interworking Security Data message ..... | 146 | +| 14.2 | Interworking Security Data message payload..... | 146 | +| 14.2.1 | Message definition..... | 146 | + +14.2.2 External network type..... 146 + +**Annex A (normative): XML Schema ..... 147** + +A.1 General..... 147 + +A.2 Void..... 147 + +**Annex B (normative): IANA registration forms..... 148** + +B.1 Media type for transporting interworking data content ..... 148 + +**Annex C (informative): Change history..... 150** + +## 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 call control protocols needed to support a Mission Critical Push To Talk (MCPTT) system interworking with a Land Mobile Radio (LMR) system. + +The IWF supports the basic group and other features as specified in 3GPP TS 23.283 [28]. The present document describes functionality modelled on 3GPP TS 24.379 [29]. + +--- + +# 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.379: "Functional architecture and information flows to support mission critical communication services; Stage 2". +- [3] 3GPP TS 24.229: "IP multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3". +- [4] 3GPP TS 24.380: "Mission Critical Push To Talk (MCPTT) floor control Protocol specification". +- [5] IETF RFC 3841 (August 2004): "Caller Preferences for the Session Initiation Protocol (SIP)". +- [6] IETF RFC 4028 (April 2005): "Session Timers in the Session Initiation Protocol (SIP)". +- [7] IETF RFC 6050 (November 2010): "A Session Initiation Protocol (SIP) Extension for the Identification of Services". +- [8] IETF RFC 4566 (July 2006): "Session Description Protocol". +- [9] IETF RFC 3840 (August 2004): "Indicating User Agent Capabilities in the Session Initiation Protocol (SIP)". +- [10] IETF RFC 5373 (November 2008): "Requesting Answering Modes for the Session Initiation Protocol (SIP)". +- [11] IETF RFC 5366 (October 2008): "Conference Establishment Using Request-Contained Lists in the Session Initiation Protocol (SIP)". +- [12] IETF RFC 4488 (May 2006): "Suppression of Session Initiation Protocol (SIP) REFER Method Implicit Subscription". +- [13] IETF RFC 4538 (June 2006): "Request Authorization through Dialog Identification in the Session Initiation Protocol (SIP)". +- [14] IETF RFC 3261 (June 2002): "SIP: Session Initiation Protocol". +- [15] IETF RFC 4575 (August 2006): "A Session Initiation Protocol (SIP) Event Package for Conference State". +- [16] 3GPP TS 24.481: "Mission Critical Services (MCS) group management Protocol specification". + +- [17] IETF RFC 4483 (May 2006): "A Mechanism for Content Indirection in Session Initiation Protocol (SIP) Messages". +- [18] IETF RFC 3428 (December 2002): "Session Initiation Protocol (SIP) Extension for Instant Messaging". +- [19] IETF RFC 4964 (October 2007): "The P-Answer-State Header Extension to the Session Initiation Protocol for the Open Mobile Alliance Push-to-talk over Cellular". +- [20] IETF RFC 5318 (December 2008): "The Session Initiation Protocol (SIP) P-Refused-URI-List Private-Header (P-Header)". +- [21] IETF RFC 3903 (October 2004): "Session Initiation Protocol (SIP) Extension for Event State Publication". +- [22] IETF RFC 4567 (July 2006): "Key Management Extensions for Session Description Protocol (SDP) and Real Time Streaming Protocol (RTSP)". +- [23] IETF RFC 8101 "IANA Registration of New Session Initiation Protocol (SIP) Resource-Priority Namespace for Mission Critical Push To Talk service". +- [24] IETF RFC 3856 (August 2004): "A Presence Event Package for the Session Initiation Protocol (SIP)". +- [25] IETF RFC 6665 (July 2012): "SIP-Specific Event Notification". +- [26] IETF RFC 6086 (January 2011): "Session Initiation Protocol (SIP) INFO Method and Package Framework". +- [27] 3GPP TS 33.180: "Security of the mission critical service". +- [28] 3GPP TS 23.283: "Mission Critical Communication Interworking with Land Mobile Radio Systems; Stage 2". +- [29] 3GPP TS 24.379: "Mission Critical Push To Talk (MCPTT) call control; Protocol specification". +- [30] 3GPP TS 24.282: "Mission Critical Data (MCData) signalling control; Protocol specification". +- [31] 3GPP TS 29.380: "Mission Critical Push To Talk (MCPTT) media plane control interworking with LMR systems". +- [32] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [33] 3GPP TS 29.582: "Mission Critical Data (MCData) interworking with LMR systems". +- [34] 3GPP TS 24.484: "Mission Critical Services (MCS) configuration management Protocol specification". + +--- + +## 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]. + +**IWF performing the controlling role:** an IWF role in which the IWF interacts with MCPTT participating functions and MCPTT non-controlling functions across the IWF-1 interface. + +**IWF performing the non-controlling role:** an IWF role in which the IWF interacts with MCPTT participating functions and MCPTT controlling functions across the IWF-1 interface + +**IWF performing the participating role:** an IWF role in which the IWF interacts with MCPTT controlling functions and MCPTT non-controlling functions across the IWF-1 interface. + +**Participant homed in the IWF:** same as "User homed in the IWF". + +**User homed in the IWF:** A user represented by an MCPTT ID in the IWF with the same domain as the IWF. + +For the purposes of the present document, the following terms and definitions given in 3GPP TS 23.283 [28] apply: + +**Interworking Function (IWF)** + +## 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]. + +| | | +|-------|-------------------------------| +| IWF | InterWorking Function | +| KMS | Key Management Service | +| LMR | Land Mobile Radio | +| MC | Mission Critical | +| MCPTT | Mission Critical Push To Talk | +| URI | Uniform Resource Identifier | + +--- + +## 4 General + +### 4.1 IWF overview + +The IWF interacts with the controlling, participating and non-controlling MCPTT functions of an MCPTT system as a peer system via the IWF-1 interface and with MCData systems via the IWF-2 interface. The IWF supports a subset of the client-server group management interfaces defined in 3GPP TS 24.481 [16] required to support IWF-3, with the exceptions and additions defined in the present document. + +### 4.2 Warning Header Field + +#### 4.2.1 General + +An IWF can include a free text string in a SIP response to a SIP request. When the IWF includes a text string in a response to a SIP INVITE request the text string is included in a Warning header field as specified in IETF RFC 3261 [14]. The IWF includes the Warning code set to 399 (miscellaneous warning) and includes the host name set to the host name of the IWF. + +#### 4.2.2 Warning texts + +Warning texts specified in table 4.2.2-1 for interworking are used, in conjunction with existing warning texts as specified in 3GPP TS 24.379 [29]. + +**Table 4.2.2-1: Warning texts for interworking defined for the Warning header field** + +| Code | Explanatory text | Description | +|------|-----------------------------------------|-----------------------------------------------------------| +| 300 | LMR end-to-end encryption not permitted | The call is not allowed to use LMR end-to-end encryption. | +| 301 | LMR end-to-end encryption required | The call is required to use LMR end-to-end encryption. | +| 302 | LMR codec required | The call requires an LMR defined codec to be used. | + +## 4.3 MCPTT priority calls and alerts + +Clauses 4.6.1, 4.6.2, 4.6.3 and 4.6.4 in 3GPP TS 24.379 [29] describe the aspects and states that are key in managing priority calls and alerts. + +The IWF manages the states on behalf of its homed users. For states that are managed by clients, the IWF manages an instance of the state for each client homed in the IWF. + +## 4.4 Media security at the IWF + +With respect to LMR interworking, the IWF provides the interfaces as specified in 3GPP TS 23.283 [28] and 3GPP TS 33.180 [27] to key management and group management capabilities of the LMR system. + +## 4.5 Broadcast group calls + +See 3GPP TS 24.379 [29] for a description of broadcast group calls. + +--- + +# 5 Functional entities + +## 5.1 General + +An IWF can perform the controlling role for group calls and private calls. The controlling role serves as the group home, managing the floor and tracking group affiliations. + +An IWF can perform the participating role for group calls and private calls. The participating role serves as the user home, checking user authorizations and forwarding signalling and media between the controlling role and clients. + +An IWF can perform a non-controlling role for temporary group calls involving groups from multiple MCPTT systems. The non-controlling role serves as the controlling role for a constituent group of a regroup and coordinates with the controlling server of the temporary group. + +An IWF performing the participating role can serve an originating LMR user. How the IWF serves LMR users is out of scope of 3GPP. + +An IWF performing the participating role can serve a terminating LMR user. How the IWF serves LMR users is out of scope of 3GPP. + +The same IWF can perform the participating role and controlling role for the same group session. + +The same IWF can perform the participating role and non-controlling role for the same group session. + +When referring to the procedures in the present document for the IWF acting in a participating role, the term, "IWF performing the participating role" is used. + +When referring to the procedures in the present document for the IWF acting in a controlling role, the term "IWF performing the controlling role" is used. + +When referring to the procedures in the present document for the IWF acting in a non-controlling role for a group call, the term " IWF performing the non-controlling role " is used. + +To be compliant with the procedures in the present document, an IWF shall: + +- support the IWF procedures defined in 3GPP TS 23.283 [28]; +- generate SDP offer and SDP answer in accordance with 3GPP TS 24.229 [3] and clause 6.3 of 3GPP TS 24.379 [29]; +- implement the role of a centralised floor control server and implement the on-network procedures for floor control as specified in 3GPP TS 29.380 [31]; + +- for registration and service authorisation, IWF procedures are out of scope of the present document; +- for affiliation of users hosted in the MCPTT system, implement the procedures specified in the present document; for LMR users, the affiliation process is out of scope of the present document; +- for group call functionality (including broadcast, emergency and imminent peril), implement the procedures specified in the present document; and +- for private call functionality (including emergency), implement the procedures specified in the present document. + +To be compliant with the procedures in the present document requiring the distribution of private call keying material between MCPTT clients as specified in 3GPP TS 33.180 [27], an IWF shall behave as an encryption endpoint on behalf of its LMR users. + +NOTE: A scenario with the IWF acting as an encryption endpoint is not end to end encryption. End to end encryption with LMR users is out of scope of the present document, but some tools are provided to allow end to end encryption to be defined outside of 3GPP. + +To be compliant with the procedures for confidentiality protection of XML elements in the present document, the IWF shall implement the procedures specified in clause 6.6.2 of 3GPP TS 24.379 [29]. + +To be compliant with the procedures for integrity protection of XML MIME bodies in the present document, the IWF shall implement the procedures specified in clause 6.6.3 of 3GPP TS 24.379 [29]. + +To be compliant with the procedures for obtaining information on a group homed in the MCPTT system, the IWF shall implement the procedures of the group management client specified in 3GPP TS 24.481 [16]. + +To be compliant with the procedures for obtaining information on an MCPTT user homed in the MCPTT system, the IWF shall obtain the MCPTT user profile described in 3GPP TS 24.484 [34]. + +## 5.2 Functional connectivity models + +The following figures give an overview of the connectivity between the IWF and the MCPTT system with the IWF in different roles as described in clause 5.1. + +NOTE: The MCPTT functional roles are not defined here. They are defined in 3GPP TS 24.379 [29] but are shown here to illustrate the relationship with the IWF. + +Figure 5.2-1 shows the role of the IWF relative to an MCPTT system. Here, the controlling MCPTT function is in the MCPTT system and the called user is homed in the IWF. The IWF plays the role of the terminating participating function. + +![Diagram showing the relationship between the IWF and an MCPTT system. The flow is: MCPTT Client -> Originating Participating MCPTT Function -> Controlling MCPTT Function -> IWF (terminating participating role).](df0bcbfa8f8e1937e071445426c28022_img.jpg) + +``` +graph LR; A[MCPTT Client] --- B[Originating Participating MCPTT Function]; B --- C[Controlling MCPTT Function]; C --- D[IWF (terminating participating role)]; +``` + +Diagram showing the relationship between the IWF and an MCPTT system. The flow is: MCPTT Client -> Originating Participating MCPTT Function -> Controlling MCPTT Function -> IWF (terminating participating role). + +**Figure 5.2-1: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system** + +Figure 5.2-2 shows the role of the IWF relative to an MCPTT system. Here, the controlling MCPTT function is in the MCPTT system and the calling user is homed in the IWF. The IWF plays the role of the originating participating function. + +![Figure 5.2-2: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` +graph LR; MCPTT_Client[MCPTT Client] --- Terminating_Participating_MCPTT_Function[Terminating Participating MCPTT Function]; Terminating_Participating_MCPTT_Function --- Controlling_MCPTT_Function[Controlling MCPTT Function]; Controlling_MCPTT_Function --- IWF[IWF (originating participating role)]; +``` + +A block diagram showing four components connected in a linear sequence from left to right: 'MCPTT Client', 'Terminating Participating MCPTT Function', 'Controlling MCPTT Function', and 'IWF (originating participating role)'. The components are connected by straight lines. + +Figure 5.2-2: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system + +**Figure 5.2-2: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system** + +Figure 5.2-3 shows the role of the IWF relative to an MCPTT system. Here, the controlling MCPTT function is in the IWF and the called user is homed in the IWF. The IWF plays the role of the controlling function. + +![Figure 5.2-3: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the IWF](41a438d7e4adc17c3a4005e7c9500091_img.jpg) + +``` +graph LR; MCPTT_Client[MCPTT Client] --- Originating_Participating_MCPTT_Function[Originating Participating MCPTT Function]; Originating_Participating_MCPTT_Function --- IWF[IWF (controlling role)]; +``` + +A block diagram showing three components connected in a linear sequence from left to right: 'MCPTT Client', 'Originating Participating MCPTT Function', and 'IWF (controlling role)'. The components are connected by straight lines. + +Figure 5.2-3: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the IWF + +**Figure 5.2-3: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the IWF** + +Figure 5.2-4 shows the role of the IWF relative to an MCPTT system. Here, the controlling MCPTT function is in the IWF and the calling user is homed in the IWF. The IWF plays the role of the controlling function. + +![Figure 5.2-4: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the IWF](6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg) + +``` +graph LR; MCPTT_Client[MCPTT Client] --- Terminating_Participating_MCPTT_Function[Terminating Participating MCPTT Function]; Terminating_Participating_MCPTT_Function --- IWF[IWF (controlling role)]; +``` + +A block diagram showing three components connected in a linear sequence from left to right: 'MCPTT Client', 'Terminating Participating MCPTT Function', and 'IWF (controlling role)'. The components are connected by straight lines. + +Figure 5.2-4: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the IWF + +**Figure 5.2-4: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the IWF** + +Figure 5.2-5 shows the role of the IWF relative to an MCPTT system. Here, the controlling MCPTT function is in the MCPTT system, the non-controlling function is in the IWF and the called user is homed in the IWF. The IWF plays the role of the non-controlling function. + +![Figure 5.2-5: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system and a non-controlling function in the IWF](df1d0e45191302de72176e4390224c16_img.jpg) + +``` +graph LR; MCPTT_Client[MCPTT Client] --- Originating_Participating_MCPTT_Function[Originating Participating MCPTT Function]; Originating_Participating_MCPTT_Function --- Controlling_MCPTT_Function[Controlling MCPTT Function]; Controlling_MCPTT_Function --- IWF[IWF (non-controlling role)]; +``` + +A block diagram showing four components connected in a linear sequence from left to right: 'MCPTT Client', 'Originating Participating MCPTT Function', 'Controlling MCPTT Function', and 'IWF (non-controlling role)'. The components are connected by straight lines. + +Figure 5.2-5: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system and a non-controlling function in the IWF + +**Figure 5.2-5: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system and a non-controlling function in the IWF** + +Figure 5.2-6 shows the role of the IWF relative to an MCPTT system. Here, the controlling MCPTT function is in the MCPTT system, the non-controlling function is in the IWF and the calling user is homed in the IWF. The IWF plays the role of the non-controlling function. + +![Figure 5.2-6: Relationship between the IWF and an MCPTT system. The diagram shows four boxes connected in a linear sequence from left to right: 'MCPTT Client', 'Terminating Participating MCPTT Function', 'Controlling MCPTT Function', and 'IWF (non-controlling role)'.](df82d77a0d2637cbf2da9ea920a554fa_img.jpg) + +``` + +graph LR + A[MCPTT Client] --- B[Terminating Participating MCPTT Function] + B --- C[Controlling MCPTT Function] + C --- D[IWF (non-controlling role)] + +``` + +Figure 5.2-6: Relationship between the IWF and an MCPTT system. The diagram shows four boxes connected in a linear sequence from left to right: 'MCPTT Client', 'Terminating Participating MCPTT Function', 'Controlling MCPTT Function', and 'IWF (non-controlling role)'. + +**Figure 5.2-6: Relationship between the IWF and an MCPTT system with the controlling MCPTT function in the MCPTT system and a non-controlling function in the IWF** + +Other functional connectivity models can exist. + +## 6 Call control common procedures + +### 6.1 SDP + +#### 6.1.1 SDP offer generation + +The SDP offer shall contain only one SDP media-level section for offered speech according to 3GPP TS 24.229 [3] and, if floor control shall be used during the session, shall contain one SDP media-level section for a media-floor control entity according to 3GPP TS 29.380 [31]. + +When composing an SDP offer according to 3GPP TS 24.229 [3] the IWF: + +- 1) shall set the IP address of the IWF for the offered speech media stream and, if floor control shall be used, for the offered media-floor control entity; +- 2) shall include an "m=audio" media-level section for the MCPTT media stream consisting of: + - a) the port number for the media stream selected; + - b) the codec(s) and media parameters and attributes with the following clarification: + - i) if the IWF is initiating a call to a group identity; + - ii) if the element is present in the group document as specified in 3GPP TS 24.481 [16] containing an element with a "name" attribute; and + - iii) if the IWF supports the encoding name indicated in the value of the "name" attribute; + then the IWF shall insert the value of the "name" attribute in the field of the "a=rtpmap" attribute as defined in IETF RFC 4566 [8]; and + - c) "i=" field set to "speech" according to 3GPP TS 24.229 [3]; +- 3) if floor control shall be used during the session, shall include an "m=application" media-level section as specified in 3GPP TS 29.380 [31] clause 12 for a media-floor control entity, consisting of: + - a) the port number for the media-floor control entity selected as specified in 3GPP TS 29.380 [31]; and + - b) the 'fmt' attributes as specified in 3GPP TS 29.380 [31] clause 14; and + +- 4) if media security is required between the MCPTT client and the IWF for a private call, shall include the MIKEY-SAKKE\_I\_MESSAGE in an "a=key-mgmt" attribute as a "mikey" attribute value in the SDP offer as specified in IETF RFC 4567 [22]. + +## 6.1.2 SDP answer generation + +When the IWF receives an initial SDP offer for an MCPTT session, the IWF shall process the SDP offer and shall compose an SDP answer according to 3GPP TS 24.229 [3]. + +When composing an SDP answer, the IWF: + +- 1) shall accept the speech media stream in the SDP offer; +- 2) shall set the IP address of the IWF for the accepted speech media stream and, if included in the SDP offer, for the accepted media-floor control entity; + +NOTE: If the IWF is behind a NAT the IP address and port included in the SDP answer can be a different IP address and port than the actual IP address and port of the IWF depending on the NAT traversal method used by the SIP/IP Core. + +- 3) shall include an "m=audio" media-level section for the accepted MCPTT speech media stream consisting of: + - a) the port number for the media stream; + - b) media-level attributes as specified in 3GPP TS 24.229 [3]; + - c) if the "a=recvonly" attribute is present in the SDP offer, include an "a=sendonly" attribute; + - d) if the "a=sendonly" attribute is present in the SDP offer, include an "a=recvonly" attribute; and + - e) "i=" field set to "speech" according to 3GPP TS 24.229 [3]; and +- 4) if included in the SDP offer, shall include the media-level section of the offered media-floor control entity consisting of: + - a) an "m=application" media-level section as specified in 3GPP TS 29.380 [31] clause 12; and + - b) 'fmt' attributes as specified in 3GPP TS 29.380 [31] clause 14. + +## 6.2 Commencement modes + +### 6.2.1 Automatic commencement mode for private calls + +When performing the automatic commencement mode procedures, the IWF performing the participating role: + +- 1) shall accept the SIP INVITE request and generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [3]; +- 2) shall include the option tag "timer" in a Require header field of the SIP 200 (OK) response; +- 3) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP 200 (OK) response; +- 4) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP 200 (OK) response; +- 5) shall include the Session-Expires header field in the SIP 200 (OK) response and start the SIP session timer according to IETF RFC 4028 [6]. The "refresher" parameter in the Session-Expires header field shall be set to "uas"; +- 6) shall include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP INVITE request according to 3GPP TS 24.229 [3] with the clarifications given in clause 6.1.2; +- 7) shall send the SIP 200 (OK) response towards the MCPTT server according to rules and procedures of 3GPP TS 24.229 [3]; + +- 8) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.2. + +## 6.2.2 Manual commencement mode for private calls + +When performing the manual commencement mode procedures: + +- 1) if the user homed in the IWF declines the MCPTT session invitation the IWF performing the participating role shall send a SIP 480 (Temporarily Unavailable) response towards the MCPTT controlling function with the warning text set to: "110 user declined the call invitation" in a Warning header field as specified in clause 4.4, and not continue with the rest of the steps in this clause. + +The IWF performing the participating role: + +- 1) shall accept the SIP INVITE request and generate a SIP 180 (Ringing) response according to rules and procedures of 3GPP TS 24.229 [3]; +- 2) shall include the option tag "timer" in a Require header field of the SIP 180 (Ringing) response; +- 3) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP 180 (Ringing) response; +- 4) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP 180 (Ringing) response; and +- 5) shall send the SIP 180 (Ringing) response to the controlling MCPTT function. + +When sending the SIP 200 (OK) response to the incoming SIP INVITE request, the IWF performing the participating role shall follow the procedures in clause 6.2.1. + +## 6.3 Receiving an MCPTT session release request + +Upon receiving a SIP BYE request, the IWF: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- 2) shall send a SIP 200 (OK) response towards the MCPTT server according to 3GPP TS 24.229 [3]. + +## 6.4 Priority call conditions + +### 6.4.1 MCPTT emergency group call conditions + +#### 6.4.1.1 SIP INVITE request for originating MCPTT emergency group calls + +This clause is referenced from other procedures. + +When the MCPTT emergency state is set, the IWF performing the participating role: + +- 1) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body in the SIP INVITE request, an element set to "true" and if the MCPTT emergency group call state is set to "MEGC 1: emergency-gc-capable", shall set the MCPTT emergency group call state to "MEGC 2: emergency-call-requested"; +- 2) if the IWF has determined that an MCPTT emergency alert is to be sent, and the MCPTT emergency alert state is set to "MEA 1: no-alert", shall: + - a) set the <>alert-ind> element of the application/vnd.3gpp.mcptt-info+xml MIME body to "true" and set the MCPTT emergency alert state to "MEA 2: emergency-alert-confirm-pending"; and + - b) include in the SIP INVITE request the specific location information for MCPTT emergency alert as specified in clause 6.5.1; + +- 3) if the IWF has determined that an MCPTT emergency alert is not to be sent and the MCPTT emergency alert state is set to "MEA 1: no-alert", shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to "false"; and +- 4) if the MCPTT client emergency group state of the user homed in the IWF of the group is set to a value other than "MEG 2: in-progress" set the MCPTT client emergency group state of the user homed in the IWF of the MCPTT group to "MEG 4: confirm-pending". + +NOTE 1: This is the case of a user homed in the IWF already being in the MCPTT emergency state it initiated previously while originating an MCPTT emergency group call or MCPTT emergency alert. All group calls the user homed in the IWF originates while in MCPTT emergency state will be MCPTT emergency group calls. + +When the MCPTT emergency state is clear and the MCPTT emergency group call state is set to "MEGC 1: emergency-gc-capable" and the IWF determines that the request for MCPTT emergency group call is authorized by local policy, the IWF performing the participating role shall set the MCPTT emergency state and perform the following actions: + +- 1) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body in the SIP INVITE request an element set to "true" and set the MCPTT emergency group call state to "MEGC 2: emergency-call-requested" state; +- 2) if the user homed in the IWF has also requested an MCPTT emergency alert to be sent, shall: + - a) include in the application/vnd.3gpp.mcptt-info+xml MIME body the element set to "true" and set the MCPTT emergency alert state to "MEA 2: emergency-alert-confirm-pending"; and + - b) include in the SIP INVITE request the specific location information, if available, for MCPTT emergency alert as specified in clause 6.5.1; +- 3) if the IWF has determined that an MCPTT emergency alert is not to be sent, shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to "false"; and +- 4) if the MCPTT client emergency group state of the user homed in the IWF of the group is set to a value other than "MEG 2: in-progress" shall set the MCPTT client emergency group state of the user homed in the IWF of the MCPTT group to "MEG 4: confirm-pending". + +NOTE 2: This is the case of an initial MCPTT emergency group call and optionally an MCPTT emergency alert being sent. As the MCPTT emergency state is not sent, there is no MCPTT emergency alert outstanding. + +NOTE 3: An MCPTT group call originated by an affiliated member of an MCPTT group which is in an in-progress emergency state (as tracked on the MCPTT client by the MCPTT client emergency group state) but is not in an MCPTT emergency state of their own will also be an MCPTT emergency group call. The and elements of the application/vnd.3gpp.mcptt-info+xml MIME body do not need to be included in this case and hence no action needs to be taken in this clause. + +#### 6.4.1.2 Resource-Priority header field for MCPTT emergency group calls + +This clause is referenced from other procedures. + +If the MCPTT emergency group call state is set to either "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted", or the MCPTT client emergency group state of the group is set to "MEG 2: in-progress", the IWF performing the participating role shall include in the SIP INVITE request a Resource-Priority header field populated with the values for an MCPTT emergency group call as specified in clause 6.4.1.11. + +NOTE: The IWF performing the participating role ideally would not need to maintain knowledge of the in-progress emergency state of the group (as tracked for the client by the MCPTT client emergency group state by the IWF performing the participating role) but can use this knowledge to provide a Resource-Priority header field set to emergency level priority, which starts the infrastructure priority adjustment process sooner than otherwise would be the case. + +If the MCPTT client emergency group state of the group is "no-emergency" or "cancel-pending", the IWF performing the participating role shall include in the SIP INVITE request a Resource-Priority header field populated with the values for a normal MCPTT group call as specified in clause 6.4.1.11. + +#### 6.4.1.3 SIP re-INVITE request for cancelling MCPTT in-progress emergency group state + +This clause is referenced from other procedures. + +If the MCPTT emergency group call state is set to "MEGC 3: emergency-call-granted" and the MCPTT emergency alert state is set to "MEA 1: no-alert", the IWF performing the participating role shall generate a SIP re-INVITE request according to 3GPP TS 24.229 [3] with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; +- 2) shall clear the MCPTT emergency state; and +- 3) shall set MCPTT emergency group state of the MCPTT group to "MEG 3: cancel-pending". + +NOTE 1: This is the case of a user homed in the IWF who has initiated an MCPTT emergency group call and wants to cancel it. + +If the MCPTT emergency group call state is set to "MEGC 3: emergency-call-granted" and the MCPTT emergency alert state is set to a value other than "MEA 1: no-alert" and only the MCPTT emergency group call is to be cancelled, the IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; and +- 2) shall set the MCPTT emergency group state of the MCPTT group to "MEG 3: cancel-pending". + +NOTE 2: This is the case of a user homed in the IWF that has initiated both an MCPTT emergency group call and an MCPTT emergency alert and wishes to only cancel the MCPTT emergency group call. This leaves the MCPTT emergency state set. + +If the MCPTT emergency group call state is set to "MEGC 3: emergency-call-granted" and the MCPTT emergency alert state is set to a value other than "MEA 1: no-alert" and the user homed in the IWF has indicated that the MCPTT emergency alert on the MCPTT group should be cancelled in addition to the MCPTT emergency group call, the IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; +- 2) shall: + - a) include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to "false"; + - b) set the MCPTT emergency alert state to "MEA 4: Emergency-alert-cancel-pending"; and + - c) clear the MCPTT emergency state; and +- 3) shall set the MCPTT emergency group state of the MCPTT group to "MEG 3: cancel-pending". + +NOTE 3: This is the case of a user homed in the IWF that has initiated both an MCPTT emergency group call and an MCPTT emergency alert and wishes to cancel both. + +#### 6.4.1.4 Receiving a SIP 2xx response to a SIP request for a priority call + +In the procedures in this clause, a priority group call refers to an MCPTT emergency group call or an MCPTT imminent peril group call. + +On receiving a SIP 2xx response to a SIP request for a priority group call, the IWF: + +- 1) if the MCPTT emergency group call state is set to "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted": + +- a) shall set the emergency group state of the user homed in the IWF of the group to "MEG 2: in-progress" if it was not already set; + - b) if the MCPTT emergency alert state of the user homed in the IWF is set to "MEA 2: emergency-alert-confirm-pending" and the SIP 2xx response to the SIP request for a priority group call does not contain a Warning header field as specified in TS 24.379 [29] clause 4.4 with the warning text containing the mcptt-warn-code set to "149", shall set the MCPTT emergency alert state of the user homed in the IWF to "MEA 3: emergency-alert-initiated"; + - c) shall set the MCPTT emergency group call state to "MEGC 3: emergency-call-granted"; and + - d) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-capable" and the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; or +- 2) if the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted" and the SIP 2xx response to the SIP request for an imminent peril group call does not contain a Warning header field as specified in TS 24.379 [29] clause 4.4 with the warning text containing the mcptt-warn-code set to "149": + - a) set the MCPTT imminent peril group call state to "MIGC 3: imminent-peril-call-granted"; and + - b) set the MCPTT imminent peril group state to "MIG 2: in-progress". + +#### 6.4.1.5 Receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to a SIP request for a priority group call + +In the procedures in this clause, a priority group call refers to an MCPTT emergency group call or an MCPTT imminent peril group call. + +Upon receiving a SIP 4xx response, SIP 5xx response or a SIP 6xx response to a SIP request for a priority group call the IWF: + +- 1) if the MCPTT emergency group call state is set to "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted": + - a) shall set the MCPTT emergency group call state to "MEGC 1: emergency-gc-capable"; + - b) if the emergency group state of the user homed in the IWF of the group is "MEG 4: confirm-pending" shall set the emergency group state of the user homed in the IWF of the group to "MEG 1: no-emergency"; and + - c) if the sent SIP request for a priority group call contained an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true", shall set the MCPTT emergency alert state of the user homed in the IWF to "MEA 1: no-alert"; and +- 2) if the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted": + - a) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + - b) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-gc-capable". + +#### 6.4.1.6 SIP request for originating MCPTT imminent peril group calls + +This clause is referenced from other procedures. + +When the IWF performing the participating role determines to originate an MCPTT imminent peril group call, the IWF performing the participating role: + +- 1) if the client homed in the IWF's imminent peril group state is set to "MIGC 1: imminent-peril-gc-capable" and the in-progress emergency state of the group is set to a value of "false": + - a) shall include in the SIP request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], clause F.1 with the element set to "true" and set the MCPTT emergency group call state to "MIGC 2: imminent-peril-call-requested" state; and + +- b) if the client homed in the IWF's imminent peril group state of the group is set to a value other than "MIG 2: in-progress" shall set the client homed in the IWF's emergency group state of the MCPTT group to "MIG 4: confirm-pending". + +NOTE: An MCPTT group call originated by an affiliated member of an MCPTT group which is in an in-progress imminent peril state (as tracked on the client by the client imminent peril group state) will also have the priority associated with MCPTT imminent peril group calls. The element of the application/vnd.3gpp.mcptt-info MIME body does not need to be included in this case, nor do any state changes result and hence no action needs to be taken in this clause. + +#### 6.4.1.7 SIP re-INVITE request for cancelling MCPTT in-progress imminent peril group state + +This clause is referenced from other procedures. + +If the MCPTT imminent peril group call state is set to "MIGC 3: imminent-peril-call-granted" or the MCPTT imminent peril group state of the MCPTT group is set to "MIG 2: in-progress", the IWF shall generate a SIP re-INVITE request according to 3GPP TS 24.229 [3] with the clarifications given below. + +The IWF: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in clause F.1 with the element set to "false"; and +- 2) shall set MCPTT imminent peril group state of the MCPTT group to "MIG 3: cancel-pending". + +NOTE: This is the case of a user who has initiated an MCPTT imminent peril group call and wants to cancel it, or another authorised member of the group who wishes to cancel the in-progress imminent peril state of the group. + +#### 6.4.1.8 Resource-Priority header field for MCPTT imminent peril group calls + +This clause is referenced from other procedures. + +When the MCPTT imminent peril group call state is set "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted", or the client homed in the IWF's imminent peril state of the group is set to "MIG 2: in-progress", the IWF performing the participating role: + +- 1) shall include in the SIP INVITE request a Resource-Priority header field populated with the values for an MCPTT imminent peril group call as specified in clause 6.4.1.11. + +NOTE: The IWF performing the participating role ideally would not need to maintain knowledge of the in-progress imminent peril state of the group (as tracked for the client by the client imminent peril group state) but can use this knowledge to provide a Resource-Priority header field set to imminent peril level priority, which starts the infrastructure priority adjustment process sooner than otherwise would be the case. + +When the MCPTT imminent peril group call state is set to "MIGC 1: imminent-peril-gc-capable" and the IWF performing the participating role determines that cancellation of the MCPTT imminent peril group call is authorized, or the MCPTT client imminent peril group state of the group is "MIG 1: no-imminent-peril" or "MIG 3: cancel-pending", the IWF performing the participating role: + +- 1) shall include in the SIP INVITE request a Resource-Priority header field populated with the values for a normal MCPTT group call as specified in clause 6.4.1.11. + +#### 6.4.1.9 Receiving a SIP INFO request in the dialog of a SIP request for a priority group call + +This clause is referenced from other procedures. + +Upon receiving a SIP INFO request within the dialog of the SIP request for a priority group call: + +- with the Info-Package header field containing the g.3gpp.mcptt-info package name; + +- with the application/vnd.3gpp.mcptt-info+xml MIME body associated with the info package according to IETF RFC 6086 [26]; and +- with one or more of the , and elements set in the application/vnd.3gpp.mcptt-info+xml MIME body; + +the IWF: + +- 1) shall send a SIP 200 (OK) response to the SIP INFO request as specified in 3GPP TS 24.229 [3]; +- 2) if the MCPTT emergency group call state is set to "MEGC 3: emergency-call-granted": + - a) if the MCPTT emergency alert state of the user homed in the IWF is set to "MEA 2: emergency-alert-confirm-pending": + - i) if the element is set to a value of "false", shall set the MCPTT emergency alert state to "MEA 1: no-alert"; and + - ii) if the element is set to a value of "true", shall set the MCPTT emergency alert state of the user homed in the IWF to "MEA 3: emergency-alert-initiated"; +- 3) if the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted": + - a) if the element is set to a value of "false" and an element is set to a value of "true", shall: + - i) set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; + - ii) set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-capable"; and + - iii) set the emergency group state of the user homed in the IWF of the group to "MEG 2: in-progress"; and + +NOTE 1: This is the case of an IWF attempting to make an imminent peril group call when the group is in an in-progress emergency group state. The IWF will then receive a notification that the imminent peril call request was denied, however the IWF will be participating at the emergency level priority of the group. + +NOTE 2: the emergency group state of the user homed in the IWF above is the view of the in-progress emergency state of the group for each user homed in the IWF. + +- 4) if the SIP request for a priority group call sent by the IWF did not contain an element and if the MCPTT emergency alert state of the user homed in the IWF is set to "MEA 4: Emergency-alert-cancel-pending": + - a) if the element contained in the SIP INFO request is set to a value of "true", shall set the MCPTT emergency alert state of the user homed in the IWF to "MEA 3: emergency-alert-initiated"; and + - b) if the element contained in the SIP INFO request is set to a value of "false", shall set the MCPTT emergency alert state of the user homed in the IWF to "MEA 1: no-alert". + +#### 6.4.1.10 SIP re-INVITE request for cancelling the in-progress emergency group state of a group by a third-party + +This clause is referenced from other procedures. + +Upon the need to cancel an in-progress emergency group state of a group, the IWF performing the participating role shall generate a SIP re-INVITE request according to 3GPP TS 24.229 [3] with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; +- 2) shall set MCPTT emergency group state of the MCPTT group to "MEG 3: cancel-pending"; and +- 3) if the MCPTT emergency alert on the MCPTT group originated by a MCPTT user is to be cancelled: + +- a) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set a value of "false"; and +- b) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to the MCPTT ID of the MCPTT user who originated the MCPTT emergency alert. + +NOTE: When an MCPTT emergency alert is cancelled by a user other than its originator, the element is needed to identify which MCPTT emergency alert is being cancelled, as more than one MCPTT user could have originated emergency alerts to the same group. + +#### 6.4.1.11 Resource-Priority header field values + +This clause is referenced from other procedures. + +The IWF performing the participating role may populate the Resource-Priority header as described for the IWF performing the controlling role in clause 6.6.3.1.12. + +### 6.4.2 MCPTT emergency private call conditions + +#### 6.4.2.1 SIP request for originating MCPTT emergency private calls + +This clause is referenced from other procedures. + +When the MCPTT emergency private call state is set to "MEPC 1: emergency-pc-capable", the IWF: + +- 1) shall set the MCPTT emergency state if not already set; +- 2) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body in the SIP request an element set to "true" and set the MCPTT emergency private call state to "MEPC 2: emergency-pc-requested"; +- 3) if an MCPTT emergency alert is to be sent, shall: + - a) include in the application/vnd.3gpp.mcptt-info+xml MIME body the element set to "true" and set the MCPTT private emergency alert state to "MPEA 2: emergency-alert-confirm-pending"; and + - b) include in the SIP request the specific location information for MCPTT emergency alert as specified in clause 6.5.1; +- 4) if the IWF has determined not to request an MCPTT emergency alert to be sent, shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to "false"; and +- 5) if the MCPTT emergency private priority state of this private call is set to a value other than "MEPP 2: in-progress" shall set the MCPTT emergency private priority state to "MEPP 3: confirm-pending". + +#### 6.4.2.2 Resource-Priority header field for MCPTT emergency private calls + +This clause is referenced from other procedures. + +If the MCPTT emergency private call state is set to either "MEPC 2: emergency-pc-requested" or "MEPC 3: emergency-pc-granted", or the MCPTT emergency private priority state of the call is set to "MEPP 2: in-progress", the IWF shall include in the SIP request a Resource-Priority header field populated with the values for an MCPTT emergency private call as specified in clause 6.4.1.11. + +NOTE: The IWF ideally would not need to maintain knowledge of the in-progress emergency state of the call (as tracked on the MCPTT client by the MCPTT client emergency private state) but can use this knowledge to provide a Resource-Priority header field set to emergency level priority, which starts the infrastructure priority adjustment process sooner than otherwise would be the case. + +If this is a request to cancel the MCPTT emergency private call and the MCPTT emergency private priority state of the private call is "MEPP 1: no-emergency" or "MEPP 3: cancel-pending", the IWF shall include in the SIP request a Resource-Priority header field populated with the values for a normal MCPTT private call as specified in clause 6.4.1.11. + +### 6.4.2.3 SIP re-INVITE request for cancelling MCPTT emergency private call state + +This clause is referenced from other procedures. + +When the MCPTT emergency private call state is set to "MEPC 3: emergency-pc-granted" and the MCPTT emergency alert state is set to "MPEA 1: no-alert", the IWF performing the participating role shall generate a SIP re-INVITE request according to 3GPP TS 24.229 [3] with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; +- 2) shall clear the MCPTT emergency state; and +- 3) shall set MCPTT emergency private priority state of the MCPTT emergency private call to "MEPP 3: cancel-pending". + +NOTE 1: This is the case where a private call is in emergency and the emergency is to be cancelled. + +When the MCPTT emergency private call state is set to "MEPPC 3: emergency-pc-granted" and the MCPTT emergency alert state is set to a value other than "MPEA 1: no-alert" and the IWF decides that only the MCPTT emergency private call should be cancelled, the IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; and +- 2) shall set the MCPTT emergency private priority state of the MCPTT emergency private call to "MEPP 3: cancel-pending"; + +NOTE 2: This is the case where both an MCPTT emergency private call and an MCPTT emergency alert have been initiated and only the MCPTT emergency on the private call is to be cancelled. This leaves the MCPTT emergency state set. + +When the MCPTT emergency private call state is set to "MEPC 3: emergency-pc-granted" and the MCPTT emergency alert state is set to a value other than "MPEA 1: no-alert" and the IWF performing the participating role has indicated that the MCPTT emergency alert on the MCPTT private call should be cancelled in addition to the MCPTT emergency private call, the IWF performing the participating role: + +- 1) shall include in the SIP re-INVITE request an application/vnd.3gpp.mcptt-info+xml MIME body as defined in 3GPP TS 24.379 [29], clause F.1 with the element set to "false"; +- 2) shall: + - a) include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to "false"; and + - b) set the MCPTT private emergency alert state to "MPEA 4: emergency-alert-cancel-pending"; +- 3) shall set the MCPTT emergency private priority state of the MCPTT to "MEPP 3: cancel-pending"; and +- 4) shall clear the MCPTT emergency state. + +NOTE 3: This is the case where both an MCPTT emergency private call and an MCPTT emergency alert have been initiated and both are to be cancelled. + +## 6.5 Location information + +### 6.5.1 Location information for location reporting + +This procedure is initiated by the IWF performing the participating role when it is including location report information as part of a SIP request containing an MCPTT emergency alert. + +NOTE 1: Location triggers are out of scope of the present document. + +The IWF performing the participating role: + +- 1) shall include an application/vnd.3gpp.mcptt-location-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.3 with a element included in the root element; +- 2) shall set the element of the element to a value of "Emergency"; and +- 3) shall include in the element of the element of the application/vnd.3gpp.mcptt-location-info+xml MIME body a element populated as specified in 3GPP TS 24.379 [29], clause F.3.3. + +NOTE 2: According to local policy, additional location information elements specified in 3GPP TS 24.379 [29], clause F.3.3 can be included in the element. + +## 6.6 IWF server role procedures + +### 6.6.1 Distinction of requests sent to the IWF + +#### 6.6.1.1 SIP INVITE request + +The IWF needs to distinguish between the following initial SIP INVITE requests for originations and terminations: + +- SIP INVITE requests routed to the IWF performing the participating role as a result of processing initial filter criteria at the S-CSCF in accordance with the termination procedures as specified in 3GPP TS 24.229 [3] and the Request-URI contains a PSI of the IWF performing the terminating participating role. Such requests are known as "SIP INVITE request for terminating participating MCPTT function" in the procedures in the present document; +- SIP INVITE requests routed to the IWF performing the controlling role as a result of PSI routing on the originating side in accordance with the originating procedures as specified in 3GPP TS 24.229 [3], or as a result of direct PSI routing, in accordance with the termination procedures as specified in 3GPP TS 24.229 [3], the Request-URI is set to a public service identity for MCPTT private call and the Contact header field does not contain the isfocus media feature tag specified in IETF RFC 3840 [9]. Such requests are known as "SIP INVITE request for controlling MCPTT function of a private call" in the procedures in the present document; +- SIP INVITE requests routed to the IWF performing the controlling role as a result of PSI routing on the originating side in accordance with the originating procedures as specified in 3GPP TS 24.229 [3], or as a result of direct PSI routing, in accordance with the termination procedures as specified in 3GPP TS 24.229 [3], the Request-URI is set to a public service identity serving an MCPTT group and the Contact header field does not contain the isfocus media feature tag specified in IETF RFC 3840 [9]. Such requests are known as "SIP INVITE request for controlling MCPTT function of an MCPTT group" in the procedures in the present document; and +- SIP INVITE requests routed to the IWF performing the non-controlling role of an MCPTT group as a result of direct PSI routing, in accordance with the termination procedures as specified in 3GPP TS 24.229 [3], the Request-URI is set to a public service identity serving an MCPTT group and the Contact header field contains the isfocus media feature tag specified in IETF RFC 3840 [9]; Such requests are known as "SIP INVITE request for non-controlling MCPTT function of an MCPTT group" in the procedures in the present document. + +#### 6.6.1.2 SIP MESSAGE request + +The IWF needs to distinguish between the following SIP MESSAGE request for originations and terminations: + +- SIP MESSAGE requests routed to the IWF performing the controlling role and containing a Content-Type header field set to "application/vnd.3gpp.mcptt-info+xml" and includes an XML body containing a root element with a element containing an element with the element set to a value of "remotely-initiated-group-call-request". Such requests are known as "SIP MESSAGE request for remotely initiated group call request for controlling MCPTT function"; +- SIP MESSAGE requests routed to the IWF performing the controlling role and containing a Content-Type header field set to "application/vnd.3gpp.mcptt-info+xml" and includes an XML body containing a root element with a element containing an element with the element + +set to a value of "remotely-initiated-group-call-response". Such requests are known as "SIP MESSAGE request for remotely initiated group call response for controlling MCPTT function"; + +- SIP MESSAGE requests routed to the IWF performing the terminating participating role as a result of initial filter criteria with the Request-URI set to the public service identity of the IWF performing the terminating participating role and containing a Content-Type header field set to "application/vnd.3gpp.mcptt-info+xml" and includes an XML body containing a root element with a element containing an element with the element set to a value of "remotely-initiated-group-call-request" or with the element set to a value of "remotely-initiated-group-call-response". Such requests are known as "SIP MESSAGE request for remotely initiated group call for terminating participating MCPTT function"; +- SIP MESSAGE requests routed to the IWF performing the terminating participating role with the Request-URI set to the public service identity of the IWF and containing a Content-Type header field set to "application/vnd.3gpp.mcptt-info+xml" and includes an XML body containing a root element containing a element containing an element or an element. Such requests are known as "SIP MESSAGE request for emergency notification for terminating participating MCPTT function" in the procedures in the present document; and +- SIP MESSAGE requests routed to the IWF performing the controlling role with the Request-URI set to the public service identity of the IWF and containing a Content-Type header field set to "application/vnd.3gpp.mcptt-info+xml" and includes an XML body containing a root element containing a element containing an element or an element. Such requests are known as "SIP MESSAGE request for emergency notification for controlling MCPTT function" in the procedures in the present document. + +### 6.6.1.3 SIP SUBSCRIBE request + +The IWF needs to distinguish between the following SIP SUBSCRIBE requests for originations and terminations: + +- SIP SUBSCRIBE requests routed to the IWF performing the controlling role with the Request-URI set to the MCPTT session identity identifying the IWF performing the controlling role and containing an Event header field set to "conference". Such requests are known as "SIP SUBSCRIBE request for event status subscription in the controlling MCPTT function" in the procedures in the present document; and +- SIP SUBSCRIBE requests routed to the IWF performing non-controlling role with the Request-URI set to the MCPTT session identity identifying the IWF performing non-controlling role and containing an Event header field set to "conference". Such requests are known as "SIP SUBSCRIBE request for event status subscription in the non-controlling MCPTT function" in the procedures in the present document. + +## 6.6.2 IWF participating role + +### 6.6.2.1 Requests initiated by a participant homed in the IWF + +#### 6.6.2.1.1 SDP offer generation + +##### 6.6.2.1.1.1 On-demand session + +This clause is referenced from other clauses. + +The SDP offer generated by the IWF performing the participating role: + +- 1) shall contain only one SDP media-level section for speech; and +- 2) shall contain an SDP media-level section for one media-floor control entity. + +When composing the SDP offer according to 3GPP TS 24.229 [3], the IWF performing the participating role: + +- 1) shall insert the IP address and port number selected by the IWF performing the participating role for the media stream in the SDP offer; + +NOTE 1: Requirements can exist for the IWF performing the participating role to be always included in the path of the offered media stream, for example: for the support of features such as lawful interception and recording. Other examples can exist. + +- 2) shall insert the IP address and port number selected by the IWF performing the participating role for the offered media floor control entity, if any, in the received SDP offer; and +- 3) shall include an "m=audio" media-level section for the media stream consisting of: + - a) the port number for the media stream selected; and + - b) the codec(s) and media parameters and attributes with the following clarification: + - i) if a call is being initiated to a group identity; and + - ii) if the IWF performing the participating role determines one or more preferred codecs;then the IWF: + - i) shall include the name of the chosen codec in the field of the "a=rtpmap" attribute as defined in IETF RFC 4566 [8]; + - c) "i=" field set to "speech" according to 3GPP TS 24.229 [3]; +- 4) if floor control shall be used during the session, shall include an "m=application" media-level section as specified in 3GPP TS 29.380 [31] clause 12 for a media-floor control entity, consisting of: + - a) the port number for the media-floor control entity selected as specified in 3GPP TS 29.380 [31]; and + - b) the 'fmt' attributes as specified in 3GPP TS 29.380 [31] clause 14; +- 5) if security between the IWF and the MCPTT system is required for a private call, shall include the MIKEY-SAKKE\_I\_MESSAGE in an "a=key-mgmt" attribute as a "mikey" attribute value in the SDP offer as specified in IETF RFC 4567 [22]; and +- 6) shall contain an "a=key-mgmt" attribute field with a "mikey" attribute value. + +NOTE: End-to-end security of voice traffic is supported through the use of Interworking Security Data messages specified in 3GPP TS 29.582 [33]. Through the use of these messages, an LMR system can communicate security information to the LMR functionality of a device on the MCPTT system. This will allow the use of LMR algorithms and keys for encrypting and decrypting voice packets within the device that can be transmitted to and received from the LMR system. + +#### 6.6.2.1.2 Sending an INVITE request + +This clause is referenced from other procedures. + +When generating an initial SIP INVITE request according to 3GPP TS 24.229 [3] the IWF performing the participating role: + +- 1) should include the Session-Expires header field according to IETF RFC 4028 [6]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 2) shall include the option tag "timer" in the Supported header field; +- 3) shall include in the P-Asserted-Identity header field the public service identity of the IWF performing the participating role; +- 4) shall include the g.3gpp.mcptt media feature tag into the Contact header; and +- 5) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), into the P-Asserted-Service header field. + +#### 6.6.2.1.3 IWF sending a SIP BYE request + +When the IWF is ending participation in an MCPTT session and decides to send a SIP BYE request, the IWF: + +- 1) shall interact with the media plane as specified in clause 6.4 in 3GPP TS 29.380 [31]; +- 2) shall generate a SIP BYE request as specified in 3GPP TS 24.229 [3]; +- 3) shall set the Request-URI to the MCPTT session identity of the MCPTT session; +- 4) shall set the P-Asserted-Identity header field of the outgoing SIP BYE request to the public service identity of the IWF; +- 5) may insert an application/vnd.3gpp.mcptt-info+xml MIME body into the outgoing SIP BYE request; and +- 6) shall send the SIP BYE request towards the controlling MCPTT function, according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP 200 (OK) response to the SIP BYE request the IWF should complete any further actions necessary to dissociate the LMR user from the MCPTT session and shall interact with the media plane to release any resources as specified in clause 6.4 in 3GPP TS 29.380 [31] for releasing media plane resources associated with the SIP session with the controlling MCPTT function. + +#### 6.6.2.1.4 Priority call conditions + +##### 6.6.2.1.4.1 General + +The clauses of the parent clause contain common procedures to be used for MCPTT emergency group calls and MCPTT imminent peril group calls. + +##### 6.6.2.1.4.2 Determining authorisation for originating a priority group call + +When the IWF performing the participating role needs to send a request to originate an MCPTT emergency group call and needs to determine if the request is an authorised request for an MCPTT emergency call, the IWF performing the participating role shall obtain the group information per 3GPP TS 24.481 [16] and check the following: + +- 1) if the IWF determines that the calling user is authorized for emergency-group-call; and +- 2) if the IWF determines that emergency-group-calls for the selected group are allowed; + +then the IWF performing the participating role shall consider the MCPTT emergency group call request to be an authorised request for an MCPTT emergency group call; + +In all other cases, the IWF performing the participating role shall consider the request to originate an MCPTT emergency group call to be an unauthorised request to originate an MCPTT emergency group call. + +When the IWF performing the participating role needs to send a request to originate an MCPTT imminent peril group call and needs to determine if the request is an authorised request for an MCPTT imminent peril group call the IWF performing the participating role shall obtain the group information per 3GPP TS 24.481 [16] and check the following: + +- 1) if the IWF determines that the calling user is authorized for imminent peril call; and +- 2) if the IWF determines that imminent peril calls for the selected group are allowed; + +then the IWF performing the participating role shall consider the MCPTT imminent peril group call request to be an authorised request for an imminent peril group call; + +In all other cases, the IWF performing the participating role shall consider the request to originate an MCPTT imminent peril group call to be an unauthorised request to originate an MCPTT imminent peril call. + +##### 6.6.2.1.4.3 Determining authorisation for initiating or cancelling an MCPTT emergency alert + +If the IWF performing the participating role needs to send a SIP request for an MCPTT emergency alert and: + +- 1) if the calling user is authorized by the IWF to activate emergency alert; and + +- 2) if the IWF allows emergency alert for the selected group; + +then the MCPTT emergency alert request shall be considered to be an authorised request for an MCPTT emergency alert. In all other cases, it shall be considered to be an unauthorised request for an MCPTT emergency alert. + +NOTE 1: How the IWF authorizes a user to originate a request for an MCPTT emergency alert is out of scope of the present document. + +If the IWF performing the participating role needs to send a SIP request to cancel an MCPTT emergency alert to an MCPTT group, and if the calling user is authorized by the IWF to cancel an emergency alert, then the MCPTT emergency alert cancellation request shall be considered to be an authorised request to cancel an MCPTT emergency alert. In all other cases, it shall be considered to be an unauthorised request to cancel an MCPTT emergency alert. + +NOTE 2: How the IWF authorizes a user to cancel an MCPTT emergency alert is out of scope of the present document. + +#### 6.6.2.1.4.4 Validate priority request parameters + +This clause is referenced from other procedures. + +To validate the combinations of , and <>alert-ind> which need to be sent in SIP requests, the IWF performing the participating role shall follow the procedures specified in 3GPP TS 24.379 [29], clause 6.3.3.1.17, with the IWF acting as the controlling function. + +#### 6.6.2.1.4.5 Retrieving Resource-Priority header field values + +This clause is referenced from other procedures. + +The IWF performing the participating role shall follow the procedures specified in clause 6.6.3.1.12 with the clarification that references in that procedure to the IWF performing the controlling role should be replaced with references to the IWF participating role. + +#### 6.6.2.1.5 Sending a SIP INVITE request on receipt of SIP 3xx response + +This clause is referenced from other procedures. + +Upon: + +- 1) having sent a SIP INVITE request to the controlling MCPTT function; and +- 2) having received a SIP 302 (Moved Temporarily) response from the controlling MCPTT function sent to the SIP INVITE request in step 1) with: + - a) a Contact header field containing a SIP URI; and + - b) an application/vnd.3gpp.mcptt-info+xml MIME body with an element; + +the IWF performing the participating role: + +- 1) shall generate a SIP INVITE request with the Request-URI set to the contents of the Contact header field of the SIP 302 (Moved Temporarily) response; +- 2) shall include in the SIP INVITE request all Accept-Contact header fields and all Reject-Contact header fields, with their feature tags and their corresponding values along with parameters according to rules and procedures of IETF RFC 3841 [5] included in the original SIP INVITE request sent to the controlling MCPTT function; +- 3) should include the Session-Expires header field according to IETF RFC 4028 [6]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 4) shall include the option tag "timer" in the Supported header field; +- 5) shall set the P-Asserted-Identity header field of the outgoing SIP INVITE request to the contents of the P-Asserted-Identity header field of the original SIP INVITE request sent to the controlling MCPTT function; + +- 6) shall include the g.3gpp.mcptt media feature tag into the Contact header field of the outgoing SIP INVITE request; +- 7) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the outgoing SIP INVITE request; +- 8) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), into the P-Asserted-Service header field of the outgoing SIP INVITE request; +- 9) shall copy the contents of the application/vnd.3gpp.mcptt-info+xml MIME body of the original SIP INVITE request sent to the controlling MCPTT function into the outgoing SIP INVITE request; +- 10) shall copy the contents of the element of the application/vnd.3gpp.mcptt-info+xml MIME body received in the SIP 302 (Moved Temporarily) response, to the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the outgoing SIP INVITE request; +- 11) shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP INVITE request to the MCPTT ID of the calling user that was determined by the IWF performing the participating role; and +- 12) if the element is received in the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP 3xx response, shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP INVITE request to the value of the element received in the SIP 3xx response. + +## 6.6.2.2 Requests terminated to the IWF + +### 6.6.2.2.1 SDP offer generation + +The IWF performing the participating role shall follow the procedure in clause 6.6.2.1.1. + +### 6.6.2.2.2 SIP BYE request towards the terminating IWF + +#### 6.6.2.2.2.1 On-demand + +Upon receiving a SIP BYE request from the controlling MCPTT function, the IWF performing the participating role: + +- 1) shall interact with the media plane as specified in clause 6.4 in 3GPP TS 29.380 [31] for releasing media plane resource associated with the SIP session; and +- 2) shall send a SIP 200 (OK) response to the SIP BYE request received from the controlling MCPTT function according to 3GPP TS 24.229 [3]. + +## 6.6.3 IWF controlling role + +### 6.6.3.1 Requests initiated by the IWF performing the controlling role + +#### 6.6.3.1.1 Sending an INVITE request + +This clause is referenced from other procedures. + +The IWF performing the controlling role shall generate an initial SIP INVITE request according to 3GPP TS 24.229 [3]. + +The IWF performing the controlling role: + +- 1) shall include in the Contact header field an MCPTT session identity for the MCPTT session with the g.3gpp.mcptt media feature tag, the isfocus media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" according to IETF RFC 3840 [9]; +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcptt media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; + +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7] in the SIP INVITE request; +- 4) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" along with parameters "require" and "explicit" according to IETF RFC 3841 [5]; +- 5) shall include a Referred-By header field with the public service identity of the IWF; +- 6) should include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [6]. The refresher parameter shall be omitted; +- 7) shall include the Supported header field set to "timer"; +- 9) may include an unmodified Priv-Answer-Mode header field; +- 10) if the request will not contain a Priv-Answer-Mode header field, shall include an Answer-Mode header field; and +- 11) may include an application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing INVITE request. + +#### 6.6.3.1.2 Sending a SIP BYE request + +When the IWF performing the controlling role needs to remove an MCPTT participant: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31] for the MCPTT session release; +- 2) shall generate a SIP BYE request according to 3GPP TS 24.229 [3]; and +- 3) shall send the SIP BYE request to the MCPTT participants according to 3GPP TS 24.229 [3]. + +If timer TNG3 (group call timer) has not expired, then when the last participant is removed from the MCPTT session, the IWF performing the controlling role shall stop timer TNG3 (group call timer). + +When the MCPTT group session needs to be released, the IWF performing the controlling role shall send SIP BYE requests as described in this clause, to all MCPTT participants of the group session. + +Upon receiving a SIP 200 (OK) response to a SIP BYE request the IWF performing the controlling role shall interact with the media plane as specified in clause 6.3 in 3GPP TS 29.380 [31] for releasing media plane resources associated with the session with the MCPTT clients. + +#### 6.6.3.1.3 Sending a SIP re-INVITE request for MCPTT emergency group call + +This clause is referenced from other procedures. + +The IWF performing the controlling role shall generate a SIP re-INVITE request according to 3GPP TS 24.229 [3]. + +The IWF performing the controlling role: + +- 1) shall include an SDP offer with the media parameters as currently established with the terminating MCPTT client according to 3GPP TS 24.229 [3]; +- 2) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to the MCPTT ID of the initiating MCPTT user; +- 3) if the in-progress emergency group state of the group is set to a value of "true" the IWF performing the controlling role: + - a) shall include a Resource-Priority header field with the namespace populated with the values for an MCPTT emergency group call as specified in clause 6.6.3.1.12; + - b) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body the element set to a value of "true"; + - c) if the received request included a request for an emergency alert and MCPTT emergency alerts are authorised for this group and MCPTT user as determined by the procedures of clause 6.6.3.1.8.1, shall populate the application/vnd.3gpp.mcptt-info+xml MIME body and application/vnd.3gpp.mcptt-location-info+xml MIME + +body as specified in clause 6.6.3.1.7. Otherwise, shall set the element to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body; and + +- d) if the in-progress imminent peril state of the group is set to a value of "true" shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "false"; and + +NOTE: If the imminent peril state of the group is true at this point, the controlling function will be setting it to false as part of the calling procedure. This is in effect an upgrade of an MCPTT imminent peril group call to an MCPTT emergency group call. + +- 4) if the in-progress emergency group state of the group is set to a value of "false": + - a) shall include a Resource-Priority header field populated with the values for a normal MCPTT group call as specified in clause 6.6.3.1.12; and + - b) if the received SIP re-INVITE request contained an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and this is an authorised request to cancel an MCPTT emergency group call as determined by the procedures of clause 6.6.3.1.8.4: + - i) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false"; and + - ii) if the received SIP re-INVITE request contained an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and this is an authorised request to cancel an MCPTT emergency alert as determined by the procedures of 3GPP TS 24.379 [29], clause 6.3.3.1.15 with the IWF acting as the controlling function, shall: + - A) include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "false"; and + - B) if the received SIP request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, copy the contents of the received element to an element in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP re-INVITE request. + +#### 6.6.3.1.4 Sending a SIP INVITE request for MCPTT emergency group call + +This clause is referenced from other procedures. + +This clause describes the procedures for inviting an MCPTT user to an MCPTT session associated with an MCPTT emergency group call or MCPTT imminent peril group call. The procedure is initiated by the IWF performing the controlling role as the result of an action in clause 10.2.3.1.1. + +The IWF performing the controlling role: + +- 1) shall generate a SIP INVITE request as specified in clause 6.6.3.1.1; +- 2) shall set the Request-URI to the address of the terminating participating MCPTT function associated with the MCPTT ID of the targeted MCPTT user; +- 3) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element populated as follows: + - a) the element set to the value of the MCPTT ID of the targeted MCPTT user; + - b) the element set to the value of the MCPTT ID of the calling user; and + - c) the element set to the value of the MCPTT group ID of the emergency group call. +- 4) shall include in the P-Asserted-Identity header field the public service identity of the IWF performing the controlling role; +- 5) shall include in the SIP INVITE request an SDP offer according to the procedures specified in 3GPP TS 24.379 [29], clause 6.3.3.1.1, with the IWF acting as the controlling function; and + +- 6) if the in-progress emergency group state of the group is set to a value of "true" the IWF performing the controlling role: + - a) shall include a Resource-Priority header field populated with the values for an MCPTT emergency group call as specified in clause 6.6.3.1.12; + - b) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "true"; + - c) if + - i) the element is set to "true" in the received SIP INVITE request and the requesting MCPTT user and MCPTT group are authorised for the initiation of MCPTT emergency alerts as determined by the procedures of clause 6.6.3.1.8.1, shall populate the application/vnd.3gpp.mcptt-info+xml MIME body and the application/vnd.3gpp.mcptt-location-info+xml MIME body as specified in clause 6.6.3.1.7. Otherwise, shall set the element to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body; or + - ii) the call request originated from the IWF, and the IWF decides to indicate an emergency alert, shall populate the application/vnd.3gpp.mcptt-info+xml MIME body and the application/vnd.3gpp.mcptt-location-info+xml MIME body as specified in clause 6.6.3.1.7. Otherwise, shall set the element to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body; + - d) if the in-progress imminent peril state of the group is set to a value of "true" shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "false"; and + +NOTE: If the imminent peril state of the group is true at this point, the controlling function will set it to false as part of the calling procedure. + +- 7) if the in-progress emergency state of the group is set to a value of "false" and the in-progress imminent peril state of the group is set to a value of "true", the IWF performing the controlling role: + - a) shall include a Resource-Priority header field populated with the values for an MCPTT imminent peril group call as specified in clause 6.6.3.1.12; and + - b) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true". + +#### 6.6.3.1.5 Sending a SIP UPDATE request for Resource-Priority header field correction + +This clause is referenced from other procedures. + +This clause describes the procedures for updating an MCPTT session associated with an MCPTT emergency group call or MCPTT imminent peril group call when the received SIP INVITE request did not include a correctly populated Resource-Priority header field. The procedure is initiated by the IWF performing the controlling role for the purpose of providing the correct Resource-Priority header field. + +- 1) shall generate a SIP 183 (Session Progress) response according to 3GPP TS 24.229 [3] with the clarifications provided specified in 3GPP TS 24.379 [29], clause 6.3.3.2.3.1, with the IWF acting as the controlling function; +- 2) shall include the option tag "100rel" in a Require header field in the SIP 183 (Session Progress) response; +- 3) shall include in the SIP 183 (Session Progress) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; and +- 4) shall send the SIP 183 (Session Progress) response towards the MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP PRACK request to the SIP 183 (Session Progress) response the IWF performing the controlling role: + +- 1) shall send the SIP 200 (OK) response to the SIP PRACK request according to 3GPP TS 24.229 [3]. +- 2) shall generate a SIP UPDATE request according to 3GPP TS 24.229 [3] with the following clarifications: + +- 3) shall include in the SIP UPDATE request an SDP offer based on the SDP offer in the received SIP INVITE request from the originating network according to the procedures specified in 3GPP TS 24.379 [29], clause 6.3.3.1.1, with the IWF acting as the controlling function; +- 4) if the in-progress emergency group state of the group is set to a value of "true" the IWF performing the controlling role shall include a Resource-Priority header field populated for an MCPTT emergency group call as specified in clause 6.6.3.1.12; and + +NOTE 1: This is the case when the sending MCPTT client did not send a Resource-Priority header field populated appropriately to receive emergency-level priority. In this case, the Resource-Priority header field is populated appropriately to provide emergency-level priority. + +- 5) if the in-progress emergency group state of the group is set to a value of "false" the IWF performing the controlling role: + - a) if the in-progress imminent peril state of the group is set to a value of "false", shall include a Resource-Priority header field populated for a normal priority MCPTT group call as specified in clause 6.6.3.1.12; and + - b) if the in-progress imminent peril state of the group is set to a value of "true", shall include a Resource-Priority header field populated for an MCPTT imminent peril group call as specified in clause 6.6.3.1.12. + +NOTE 2: This is the case when the sending MCPTT client incorrectly populated a Resource-Priority header field for emergency-level or imminent peril-level priority and the controlling MCPTT function re-populates it as appropriate to an imminent peril level priority or normal priority level. + +#### 6.6.3.1.6 Generating a SIP re-INVITE request to cancel an in-progress emergency + +This clause is referenced from other procedures. + +This clause describes the procedures for generating a SIP re-INVITE request to cancel the in-progress emergency state of a group. The procedure is initiated by the IWF performing the controlling role when it determines the cancellation of the in-progress emergency state of a group is required. + +The IWF performing the controlling role: + +- 1) shall generate a SIP re-INVITE request as specified in 3GPP TS 24.229 [3] with the clarifications specified in 3GPP TS 24.379 [29] clause 6.3.3.1.9, with the IWF acting as the controlling function; +- 2) shall include a Resource-Priority header field populated with the values for a normal MCPTT group call as specified in clause 6.6.3.1.12; and +- 3) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false". + +#### 6.6.3.1.7 Populate mcptt-info and location-info MIME bodies for emergency alert + +This clause is referenced from other procedures. + +This clause describes the procedures for populating the application/vnd.3gpp.mcptt-info+xml and application/vnd.3gpp.mcptt-location-info+xml MIME bodies for an MCPTT emergency alert. The procedure is initiated by the IWF performing the controlling role when it has received request initiating an MCPTT emergency alert and generates a message containing the MCPTT emergency alert information required by 3GPP TS 23.379 [2]. + +The IWF performing the controlling role: + +- 1) shall include, if not already present, an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1, and set the element to a value of "true"; +- 2) shall determine the value of the user's Mission Critical Organization identity. + +NOTE: How the IWF determines the user's Mission Critical Organization identity is out of scope of the present document; + +- 3) shall include in the element containing the element containing an element set to the value of the user's Mission Critical Organization identity; and + +- 4) shall include an application/vnd.3gpp.mcptt-location-info+xml MIME body in the outgoing SIP request. + +#### 6.6.3.1.8 Authorisations + +##### 6.6.3.1.8.1 Determining authorisation for initiating an MCPTT emergency alert + +If the IWF performing the controlling role has received a SIP request targeted to an MCPTT group with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "true", the IWF performing the controlling role shall obtain the MCPTT user profile described in 3GPP TS 24.484 [34] and check the following conditions: + +- 1) if the user is authorized to initiate an emergency alert; and +- 2) if the IWF allows emergency alerts on the group; + +then the MCPTT emergency alert request shall be considered to be an authorised request for an MCPTT emergency alert targeted to an MCPTT group. In all other cases, the MCPTT emergency alert request shall be considered to be an unauthorised request for an MCPTT emergency alert targeted to an MCPTT group. + +If the IWF performing the controlling role has received a SIP request targeted to a user with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "true", the IWF performing the controlling role shall obtain the MCPTT user profile described in 3GPP TS 24.484 [34] and check the following condition: + +- 1) if the calling user is authorized for emergency alerts; + +then the MCPTT emergency alert request shall be considered to be an authorised request for an MCPTT emergency alert targeted to a user. In all other cases, it shall be considered to be an unauthorised request for an MCPTT emergency alert targeted to a user. + +NOTE 1: How the IWF determines relevant contents of the MCPTT user profile document is out of scope of the present document. + +##### 6.6.3.1.8.2 Determining authorisation for initiating an MCPTT emergency group or private call + +If the IWF performing the controlling role has received a SIP request for an MCPTT group call with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "true", the IWF shall obtain the MCPTT user profile described in 3GPP TS 24.484 [34] and the group information per 3GPP TS 24.481 [16] and: + +- 1) if the MCPTT user is authorized to initiate emergency calls and if the group is configured to allow emergency calls, then the IWF performing the controlling role shall consider the MCPTT emergency group call request to be an authorised request for an MCPTT emergency group call and skip the remaining step; or +- 2) if the IWF performing the controlling role does not consider the MCPTT emergency group call request to be an authorised request for an MCPTT emergency group call by step 1) above, then the IWF performing the controlling role shall consider the MCPTT emergency group call request to be an unauthorised request for an MCPTT emergency group call. + +If the IWF performing the controlling role has received a SIP request for an MCPTT private call with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "true", the IWF performing the controlling role shall obtain the MCPTT user profile described in 3GPP TS 24.484 [34] and determines whether the user is authorized to initiate an emergency private call. + +NOTE 1: How the IWF determines relevant contents of the MCPTT user profile document is out of scope of the present document. + +##### 6.6.3.1.8.3 Determining authorisation for cancelling an MCPTT emergency alert + +If the IWF performing the controlling role has received a SIP request with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "false", the IWF may authorize the MCPTT emergency alert cancellation. + +NOTE: How the IWF determines whether to authorize a user to cancel an emergency alert is out of scope of the present document. + +#### 6.6.3.1.8.4 Determining authorisation for cancelling an MCPTT emergency group or private call + +If the IWF performing the controlling role has received a SIP request for an MCPTT group call with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "false", the IWF may authorize the MCPTT emergency group call cancellation request. + +NOTE 1: How the IWF determines whether to authorize a user to cancel a group call emergency is out of scope of the present document. + +If the IWF performing the controlling role has received a SIP request for an MCPTT private call with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "false", the IWF may authorize the MCPTT emergency private call cancellation request. + +NOTE 2: How the IWF determines whether to authorize a user to cancel a private call emergency is out of scope of the present document. + +#### 6.6.3.1.8.5 Determining authorisation for initiating an MCPTT imminent peril call + +If the IWF performing the controlling role has received a SIP request with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "true", the IWF shall obtain the MCPTT user profile described in 3GPP TS 24.484 [34] and the group information per 3GPP TS 24.481 [16] and + +- 1) if the MCPTT user is authorized to initiate an imminent peril call; and +- 2) if the IWF allows the group to support imminent peril calls; + +then the MCPTT imminent peril call request shall be considered to be an authorised request for an MCPTT imminent peril call. In all other cases, it shall be considered to be an unauthorised request for an MCPTT imminent peril call. + +NOTE 1: How the IWF determines relevant contents of the MCPTT user profile document is out of scope of the present document. + +#### 6.6.3.1.8.6 Determining authorisation for cancelling an MCPTT imminent peril call + +If the IWF performing the controlling role has received a SIP request with the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to a value of "false", the IWF may authorize the MCPTT imminent peril call cancellation request. + +NOTE: How the IWF determines whether to authorize a user to cancel an imminent peril call is out of scope of the present document. + +#### 6.6.3.1.8.7 Sending a SIP OPTIONS request to authorise an MCPTT user at a non-controlling MCPTT function of a MCPTT group + +This clause is referenced from other procedures. + +The IWF performing the controlling role: + +- 1) if the element is included in the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request, shall generate a SIP OPTIONS request according to 3GPP TS 24.229 [3] and the IETF RFC 3261 [14] populated as follows: + - a) shall set the Request-URI to the public service identity of the non-controlling MCPTT function associated with the MCPTT Group ID which was present in the element in the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; + +NOTE 1: How the IWF performing the controlling role finds the address of the non-controlling MCPTT function is out of the scope of the current release. + +- b) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7]; +- c) shall include in the P-Asserted-Identity header field, the public service identity of the IWF performing the controlling role; + +- d) shall include an application/vnd.3gpp.mcptt-info+xml MIME body where: + - i) the element shall be set to the value of the element in the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; and + - ii) the element is set to the same value as in the element in the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; + - e) shall include the following in the Contact header field: + - i) the g.3gpp.mcptt media feature tag; and + - ii) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; and + - f) send the SIP OPTIONS request as specified in 3GPP TS 24.229 [3]; and +- 2) if the element is not included in the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request, shall for each constituent MCPTT group not homed in the IWF performing the controlling role generate a SIP OPTIONS request according to 3GPP TS 24.229 [3] and IETF RFC 3261 [14] populated as follows: +- a) shall set the Request-URI to the public service identity of the non-controlling MCPTT function associated with the MCPTT group ID of the constituent group; + +NOTE 2: How the IWF performing the controlling role finds the address of the non-controlling MCPTT function is out of the scope of the current release. + +- b) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7]; +- c) shall include in the P-Asserted-Identity header field, the public service identity of the IWF performing the controlling role; +- d) shall include an application/vnd.3gpp.mcptt-info+xml MIME body where: + - i) the element shall be set to the MCPTT group ID of the constituent group; and + - ii) the element is set to the same value as in the element in the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; +- e) shall include the following in the Contact header field: + - i) the g.3gpp.mcptt media feature tag; and + - ii) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; and +- f) send the SIP OPTIONS request as specified in 3GPP TS 24.229 [3]. + +Upon receipt of the first SIP 200 (OK) response to the SIP OPTIONS request with the mcptt-warn-code set to "147" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, the IWF acting as the controlling function shall return a SIP 302 (Moved Temporarily) response to the "SIP INVITE request for controlling MCPTT function of an MCPTT group" populated as follows: + +- 1) the URI in the Contact header field set to the P-Asserted-Identity received in the SIP 200 (OK) response; +- 2) an application/vnd.3gpp.mcptt-info MIME body with: + - a) the element set to the same value as received in the in the SIP 2xx response to the SIP OPTIONS request; and + - b) the element set to the value received in the element in the application/vnd.3gpp.mcptt.info+xml MIME body of the received SIP 2xx response to the SIP OPTIONS request; and +- 3) if more than one OPTIONS request were sent, shall remove any cached SIP response and ignore any other responses to any other OPTIONS request. + +Upon receipt of a SIP 404 (Not Found) response to the SIP OPTIONS request such that the mcptt-warn-code set to "113" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the controlling function: + +- 1) if more than one SIP OPTIONS request were sent and if no other responses to SIP OPTIONS request are expected; shall send a SIP 404 (Not Found) response to "SIP INVITE request for controlling MCPTT function of an MCPTT group" and include the Warning header field received in the SIP 404 (Not Found) response; and +- 2) if more than one OPTIONS request were sent and other responses to SIP OPTIONS request are expected, shall cache the received SIP 404 (Not Found) response. + +Upon receipt of a SIP 403 (Forbidden) response to the SIP OPTIONS request, the mcptt-warn-code set to "106" or "109" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server, and if more than one OPTIONS request were sent and if no other responses to the SIP OPTIONS request are expected, the IWF performing the controlling role: + +- 1) if a SIP 404 (Not Found) response is cached, send a SIP 404 (Not Found) response to "SIP INVITE request for controlling MCPTT function of an MCPTT group" and include the Warning header field received in the SIP 404 (Not Found) response; and +- 2) if a SIP 404 (Not Found) response is not cached, shall return a SIP 403 (Forbidden) response to "SIP INVITE request for controlling MCPTT function of an MCPTT group" and include the Warning header field received in the SIP 403 (Forbidden) response. + +Upon receipt of any other response to the SIP OPTIONS response than specified above and if more than one OPTIONS request were sent and if no other responses to the SIP OPTIONS request are expected, the IWF performing the controlling role: + +- 1) if a SIP 404 (Not Found) response is cached, send a SIP 404 (Not Found) response to "SIP INVITE request for controlling MCPTT function of an MCPTT group" and include the Warning header field received in the SIP 404 (Not Found) response; and +- 2) if a SIP 404 (Not Found) response is not cached, shall return a SIP 403 (Forbidden) response to "SIP INVITE request for controlling MCPTT function of an MCPTT group". + +NOTE 3: The reason for selecting the SIP 404 (Not Found) response when a SIP 404 (Not Found) response is cached is to indicate that it was a valid request but the MCPTT user identified in the is not a member of any of the constituent MCPTT groups in the temporary group. + +#### 6.6.3.1.9 Generating a SIP 403 response for priority call request rejection + +If the IWF performing the controlling role has received a SIP request with the element of the application/vnd.3gpp.mcptt-info+xml MIME body is set to "true" and this is an unauthorised request for an MCPTT emergency call as determined by the procedures of clause 6.6.3.1.8.2, the controlling MCPTT function shall: + +- 1) include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the . + +#### 6.6.3.1.10 Handling the expiry of timer TNG2 (in-progress emergency group call timer) + +Upon expiry of timer TNG2 (in-progress emergency group call timer) for an MCPTT group, the IWF performing the controlling role: + +- 1) shall set the in-progress emergency state of the group to a value of "false"; +- 2) shall, if an MCPTT group call or MCPTT group session is in progress on the indicated group, for each of the participating members: + - a) generate a SIP re-INVITE request as specified in clause 6.6.3.1.6; and + - b) send the SIP re-INVITE request towards the MCPTT client according to 3GPP TS 24.229 [3]; and +- 3) shall for each affiliated but non-participating member of the group: + +- a) generate a SIP MESSAGE request according to 3GPP TS 24.379 [29] clause 6.3.3.1.11, with the IWF acting as the controlling function and include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "false"; +- b) shall include in the P-Asserted-Identity header field the public service identity of the controlling MCPTT function; +- c) include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7]; and +- d) send the SIP MESSAGE request towards the MCPTT client according to rules and procedures of 3GPP TS 24.229 [3]. + +Upon receiving a SIP 200 (OK) response to a re-SIP INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]. + +#### 6.6.3.1.11 Sending a SIP INFO request in the dialog of a SIP request for a priority call + +This clause is referenced from other procedures and describes how the IWF performing the controlling role generates a SIP INFO request due to the receipt of a SIP request for a priority call. + +The IWF performing the controlling role: + +- 1) shall generate a SIP INFO request according to rules and procedures of 3GPP TS 24.229 [3] and IETF RFC 6086 [26]; +- 2) shall include the Info-Package header field set to g.3gpp.mcptt-info in the SIP INFO request; +- 3) shall include an application/vnd.3gpp.mcptt-info+xml MIME body in the SIP INFO request and: + - a) if the received SIP request contained application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall set the element to a value of "true" and the element to a value of "false"; + - b) if the received SIP request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and if this is an unauthorised request for an MCPTT emergency alert cancellation, shall set element to a value of "true"; and + - c) if the received SIP request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true", this is an authorised request for an MCPTT imminent peril group call and the in-progress emergency state of the group is set to a value of "true", shall set the element to a value of "false" and the element set to a value of "true"; and +- 4) shall send the SIP INFO request towards the inviting MCPTT client in the dialog created by the SIP request from the inviting MCPTT client, as specified in 3GPP TS 24.229 [3]. + +#### 6.6.3.1.12 Retrieving Resource-Priority header field values + +This clause is referenced from other procedures. + +The IWF performing the controlling role may populate the Resource-Priority header field to assist interworked MC systems in setting bearer priorities. The IWF can set emergency, imminent peril and normal priorities for private and group calls. The priority values and namespaces are as specified in IETF RFC 8101 [23]. + +NOTE: How the IWF obtains the values for Resource-Priority header fields is out of scope of the present document. + +### 6.6.3.2 Requests terminated by the IWF performing the controlling role + +#### 6.6.3.2.1 Receiving a SIP BYE request + +Upon receiving a SIP BYE request the IWF performing the controlling role: + +- 1) shall interact with the media plane as specified in clause 6.3 in 3GPP TS 29.380 [31] for releasing the media plane resource associated with the SIP session towards the MCPTT client; + +NOTE: The IWF performing the non-controlling role is also regarded as a MCPTT client in a temporary MCPTT group session. + +- 2) shall generate a SIP 200 (OK) response and send the SIP response towards the MCPTT client according to 3GPP TS 24.229 [3]; +- 3) shall check the MCPTT session release policy as specified in clause 6.6.7.1 and clause 6.6.7.2 whether the MCPTT session needs to be released for each participant of the MCPTT session; +- 4) if release of the MCPTT session is required: + - a) shall perform the procedures as specified in the clause 6.6.3.1.2 with the clarification that if the received SIP BYE request contains an application/vnd.3gpp.mcptt-info+xml MIME body, copy the application/vnd.3gpp.mcptt-info+xml MIME body into the outgoing SIP BYE request; and +- 5) if a release of the MCPTT session is not required: + - a) shall send a SIP NOTIFY request to all remaining MCPTT clients in the MCPTT session with a subscription to the conference event package as specified in 3GPP TS 24.379 [29], clause 10.1.3.4.2 with the IWF acting as the controlling MCPTT function. + +Upon receiving a SIP 200 (OK) response to the SIP BYE request the IWF performing the controlling shall interact with the media plane as specified in clause 6.3 in 3GPP TS 29.380 [31] for releasing media plane resources associated with the SIP session with the MCPTT participant. + +### 6.6.3.3 Handling of the acknowledged call setup timer (TNG1) + +When the IWF performing the controlling role receives a SIP INVITE request to initiate a group session and there are members of the group that are affiliated and are deemed by the IWF to be required for the call, then the IWF performing the controlling role shall start timer TNG1 (acknowledged call setup timer), prior to sending out SIP INVITE requests inviting group members to the group session. + +NOTE 1: How the IWF obtains the value of the TNG1 timer is out of scope of the present document. + +NOTE 2: How the IWF determines the required participants for the call, whether to require certain participants for the call or whether to require a certain number of participants for the call is out of scope of the present document. + +When the IWF performing the controlling role receives all SIP 200 (OK) responses to the SIP INVITE requests, from all affiliated and required members then the IWF performing the controlling role shall stop timer TNG1 (acknowledged call setup timer) and if the local counter of the number of SIP 200 (OK) responses received from invited members is greater than or equal to the required number of participants, the IWF performing the controlling role shall send a SIP 200 (OK) response to the initiating MCPTT client and shall interact with the media plane as specified in 3GPP TS 29.380 [31]. + +NOTE 3: MCPTT clients that are affiliated but are not required members that have not yet responded will be considered as joining an ongoing session when the IWF performing the controlling role receives SIP 200 (OK) responses from these MCPTT clients. + +After expiry of timer TNG1 (acknowledged call setup timer) and the local counter of the number of SIP 200 (OK) responses received from invited members is less than the value required by the IWF performing the controlling role, then the IWF performing the controlling role shall wait until further responses have been received from invited clients and the value of the local counter of the number of SIP 200 (OK) responses received from invited members is equal to the number required by the IWF performing the controlling role, before continuing with the timer TNG1 expiry procedures in this clause. + +After expiry of timer TNG1 (acknowledged call setup timer) and the local counter of the number of SIP 200 (OK) responses received from invited members is greater or equal to the number required by the IWF performing the controlling role, the IWF performing the controlling role shall execute the steps described below: + +- 1) if the IWF is configured to "proceed" with the setup of the group call, then the IWF performing the controlling role: + +- a) shall perform the following actions: + - i) generate a SIP 200 (OK) response to the SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.2 before continuing with the rest of the steps; + - ii) include in the SIP 200 (OK) response the warning text set to "111 group call proceeded without all required group members" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server MCPTT function; + - iii) include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; + - iv) interact with the media plane as specified in 3GPP TS 29.380 [31]; and + +NOTE 4: Resulting media plane processing is completed before the next step is performed. + +- v) send a SIP 200 (OK) response to the inviting MCPTT client according to 3GPP TS 24.229 [3]; + - b) when a SIP 200 (OK) response to a SIP INVITE request is received from an invited MCPTT client the IWF performing the controlling role may send an in-dialog SIP MESSAGE request to the MCPTT client that originated the group session with the text "group call proceeded without all required group members"; + - c) when the IWF performing the controlling role receives a SIP BYE request from an invited MCPTT client, shall take the actions specified in clause 6.6.3.2.1 and may send an in-dialog SIP MESSAGE request to the MCPTT client that originated the group session with the text "group call proceeded without all required group members"; and + - d) shall generate a notification package as specified in clause 6.6.3.4 and send a SIP NOTIFY request according to 3GPP TS 24.229 [3] to the MCPTT clients which have subscribed to the conference event package; and +- 2) if the IWF is configured to "abandon" the setup of the group call, then the IWF performing the controlling role shall: + - a) send a SIP 480 (Temporarily Unavailable) response to the MCPTT client that originated the group session with the warning text set to "112 group call abandoned due to required group members not part of the group session" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; + - b) for each confirmed dialog at the IWF performing the controlling role, send a SIP BYE request towards the MCPTT clients invited to the group session in accordance with 3GPP TS 24.229 [3] and interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - c) for each non-confirmed dialog at the IWF performing the controlling role, send a SIP CANCEL request towards the MCPTT clients invited to the group session in accordance with 3GPP TS 24.229 [3]. + +If the IWF performing the controlling role receives a final SIP 4xx, 5xx or 6xx response from an affiliated and required group member prior to expiry of timer TNG1 (acknowledged call setup timer) and based on policy, the IWF performing the controlling role decides not to continue with the establishment of the group call without the affiliated and required group member, then the IWF performing the controlling role: + +NOTE 5: It is expected that this action is taken if the policy is to abandon the call on expiry of timer TNG1 (acknowledged call setup timer). + +- 1) shall stop timer TNG1 (acknowledged call setup timer); and +- 2) shall forward the final SIP 4xx, 5xx or 6xx response towards the inviting MCPTT client with the warning text set to "112 group call abandoned due to required group member not part of the group session" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server. + +If: + +- 1) the IWF performing the controlling role receives a final SIP 4xx, 5xx or 6xx response from an affiliated and required group member prior to expiry of timer TNG1 (acknowledged call setup timer); + +- 2) the local counter of the number of SIP 200 (OK) responses received from invited members is greater than or equal to the required number of participants; and +- 3) based on policy, the IWF performing the controlling role decides to continue with the establishment of the group call without the affiliated and required group member; + +then the IWF performing the controlling role: + +NOTE 6: It is expected that this action is taken if the policy is to proceed with the call on expiry of timer TNG1 (acknowledged call setup timer). + +- 1) if all other invited clients have not yet responded, shall continue running timer TNG1 (acknowledged call setup timer); and +- 2) if all other invited clients have responded with SIP 200 (OK) responses, shall + - a) stop timer TNG1 (acknowledged call setup timer); + - b) generate SIP 200 (OK) response to the SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.2 before continuing with the rest of the steps; + - c) include in the SIP 200 (OK) response the warning text set to "111 group call proceeded without all required group members" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; + - d) include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; + - e) interact with the media plane as specified in 3GPP TS 29.380 [31]; and + +NOTE 7: Resulting media plane processing is completed before the next step is performed. + +- f) send a SIP 200 (OK) response to the inviting MCPTT client according to 3GPP TS 24.229 [3]. + +#### 6.6.3.4 Generating a SIP NOTIFY request + +The IWF performing the controlling role shall generate a SIP NOTIFY request according to 3GPP TS 24.229 [3] with the clarification in this clause. + +In the SIP NOTIFY request, the IWF performing the controlling role: + +- 1) shall set the P-Asserted-Identity header field to the public service identity of the IWF performing the controlling role; +- 2) shall include an Event header field set to "conference"; +- 3) shall include an Expires header field set to 3600 seconds according to IETF RFC 4575 [15], as default value; +- 4) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Preferred-Service header field according to IETF RFC 6050 [7]; and +- 5) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the set to the value of the MCPTT group ID; + - b) if the target is a MCPTT user, the value of element set to the value of MCPTT ID of the targeted MCPTT user; and + - c) if the target is the non-controlling MCPTT function, the value of element set to the constituent MCPTT group ID. + +In the SIP NOTIFY request, the IWF performing the controlling role shall include an application/conference-info+xml MIME body according to IETF RFC 4575 [15] with the following limitations: + +- 1) the IWF performing the controlling role shall include the MCPTT group ID of the MCPTT group in the "entity" attribute of the element; +- 2) for each non-IWF connected participant in the MCPTT session with the exception of non-controlling MCPTT functions, the IWF performing the controlling role shall include a element. The element: + +NOTE 1: Non-controlling MCPTT functions will appear as a participant in temporary group sessions. + +- a) shall include the "entity" attribute. The "entity" attribute: + - i) shall for the MCPTT client, which initiated, joined or re-joined an MCPTT session, include the MCPTT ID of the user that originated the request; and + - ii) shall for an invited MCPTT client include the MCPTT ID of the invited MCPTT user in case of a prearranged group call or chat group call; +- b) shall include a single element. The element: + - i) shall include the "entity" attribute; and + - ii) shall include the element indicating the status of the MCPTT session according to IETF RFC 4575 [14]; and +- c) may include the element. + +NOTE 2: The usage of is only applicable for human consumption. + +### 6.6.3.5 Handling of the group call timer (TNG3) + +#### 6.6.3.5.1 General + +When the IWF performing the controlling role receives a SIP INVITE request to initiate a group session, then after an MCPTT session identity has been allocated for the group session, the IWF performing the controlling role shall start timer TNG3 (group call timer). + +NOTE 1: How the IWF determines the value of the TNG3 timer is out of scope of the present document. + +If the IWF does not have a TNG3 timer value, then the IWF performing the controlling role shall not start timer TNG3 (group call timer). + +NOTE 2: The group call timer is mandated for a pre-arranged group and is optional for a chat group. + +When merging two or more active group calls into a temporary group call, if the IWF is hosting at least one of the active group calls shall stop timer TNG3 (group call timer) for each hosted group call, and the IWF performing the controlling role hosting the temporary group call shall start timer TNG3 (group call timer) for the temporary group call. + +NOTE 3: MCPTT server(s) other than the IWF that are hosting the independent active group calls become non-controlling MCPTT function(s) of an MCPTT group, for the temporary group call. + +When splitting a temporary group call into independent group calls, the IWF performing the controlling role hosting the temporary group call shall stop timer TNG3 (group call timer) and the controlling MCPTT function(s) hosting the independent group calls shall start TNG3 (group call timer) for each group call. + +When the last MCPTT client leaves the MCPTT session, the IWF performing the controlling role shall stop timer TNG3 (group call timer). + +On expiry of timer TNG3 (group call timer), the IWF performing the controlling role shall release the MCPTT session by following the procedures in clause 6.6.3.1.2; + +#### 6.6.3.5.2 Interaction with the in-progress emergency group call timer (TNG2) + +If the IWF performing the controlling role starts timer TNG2 (in-progress emergency group call timer), it shall not start timer TNG3 (group call timer). + +If timer TNG3 (group call timer) is running and the MCPTT group call is upgraded to an MCPTT emergency group call, then the IWF performing the controlling role shall stop timer TNG3 (group call timer) and shall start timer TNG2 (in-progress emergency group call timer). If timer TNG2 (in-progress emergency group call timer) is running and the MCPTT emergency group call is cancelled, then the IWF performing the controlling role shall stop timer TNG2 (in-progress emergency group call timer) and shall start timer TNG3 (group call timer). + +NOTE 1: How the IWF determines the value of the TNG2 and TNG3 timers is out of scope of the present document. + +If timer TNG2 (in-progress emergency group call timer) is running and sequentially expires, then the controlling MCPTT function shall start timer TNG3 (group call timer). + +NOTE 2: The above conditions for starting timer TNG2 (in-progress emergency group call timer) and timer TNG3 (group call timer) also apply in the case that these timers are re-started. For example: the case where the timer TNG3 was initially running, the MCPTT group call is upgraded to an MCPTT emergency group call and then the MCPTT emergency group call is cancelled. + +## 6.6.4 IWF non-controlling role + +### 6.6.4.1 Request initiated by the IWF performing the non-controlling role of a group + +#### 6.6.4.1.1 SDP offer generation + +The SDP offer is generated based on the received SDP offer to be sent to MCPTT clients that are a member of the group homed in the IWF. The SDP offer generated by the IWF performing the non-controlling role of a group: + +- 1) shall include only one SDP media-level section for speech as contained in the received SDP offer; and +- 2) shall include an SDP media-level section for one media-floor control entity, if present in the received SDP offer. + +When composing the SDP offer according to 3GPP TS 24.229 [3], the IWF performing the non-controlling role of a group: + +- 1) shall replace the IP address and port number for the offered media stream in the received SDP offer with the IP address and port number of the IWF performing the non-controlling role; +- 2) shall include all media-level attributes from the received SDP offer; +- 3) shall replace the IP address and port number for the offered media floor control entity, if any, in the received SDP offer with the IP address and port number of the IWF performing the non-controlling role; and +- 4) shall include the offered media floor control entity 'fmtp' attributes as specified in 3GPP TS 29.380 [31] clause 14. + +#### 6.6.4.1.2 Sending an INVITE request towards the MCPTT client + +This clause is referenced from other procedures. + +This clause covers the situation where a group homed in the IWF is a constituent group of a group homed in an MCPTT system. + +If the IWF receives a "SIP INVITE request for non-controlling MCPTT function of an MCPTT group" and does not support group regroup procedures, the IWF shall reject the SIP INVITE request with a SIP 403 (Forbidden) response with the warning text set to "100 function not allowed due to local policy" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, and shall not execute the remainder of this procedure. + +If there are MCPTT clients that are members of the group, the IWF performing the non-controlling role of a group shall generate initial SIP INVITE requests according to 3GPP TS 24.229 [3]. + +NOTE 1: How the IWF includes participants homed in the IWF is out of scope. + +For each SIP INVITE request, the IWF performing the non-controlling role of a group: + +- 1) shall generate a new MCPTT session identity for the MCPTT session with the invited MCPTT client and include it in the Contact header field together with the g.3gpp.mcptt media feature tag, the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt", and the isfocus media feature tag according to IETF RFC 3840 [9]; +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcptt media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7] in the SIP INVITE request; +- 4) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" along with parameters "require" and "explicit" according to IETF RFC 3841 [5]; +- 5) shall set the Request-URI to the public service identity of the terminating participating MCPTT function associated to the MCPTT ID of the MCPTT user to be invited; + +NOTE 2: How the IWF finds the address of the terminating participating MCPTT function is out of the scope of the current release. + +NOTE 3: If the terminating MCPTT user is part of a partner MCPTT system, then the public service identity can identify an entry point in the partner network that is able to identify the terminating participating MCPTT function. + +- 6) shall copy the application/vnd.3gpp.mcptt-info+xml MIME body in the received SIP INVITE request to the outgoing SIP INVITE request; +- 7) shall update the application/vnd.3gpp.mcptt-info+xml MIME body with: a element set to the MCPTT ID of the invited MCPTT user; +- 8) shall include the public service identity of the IWF in the P-Asserted-Identity header field; +- 9) shall include the received Referred-By header field with the public service identity of the IWF; +- 10) should include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [6]. The refresher parameter shall be omitted; +- 11) shall include the Supported header field set to "timer"; +- 12) shall include an unmodified Answer-Mode header field, if present in the incoming SIP INVITE request; and +- 13) shall include the warning text set to "148 MCPTT group is regrouped" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4. + +NOTE 4: As long as the MCPTT group is regrouped the floor control messages in the media plane includes a grouped regrouped indication as specified in 3GPP TS 29.380 [31]. + +#### 6.6.4.1.3 Sending a SIP INFO request + +This clause is referenced from other procedures. + +This clause covers the situation where a group homed in the IWF is a constituent group of a group homed in an MCPTT system. + +If the IWF performing the non-controlling role receives a "SIP INVITE request for non-controlling MCPTT function of an MCPTT group" and does not support group regroup procedures, the IWF shall reject the SIP INVITE request with a SIP 403 (Forbidden) response with the warning text set to "100 function not allowed due to local policy" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, and shall not execute the remainder of this procedure. + +The IWF shall generate a SIP INFO request according to rules and procedures of 3GPP TS 24.229 [3] and IETF RFC 6086 [26]. + +The IWF: + +- 1) shall include the Info-Package header field set to g.3gpp.mcptt-floor-request; + +- 2) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the set to the temporary MCPTT group ID and the element with the constituent MCPTT group ID; +- 3) shall include an application/vnd.3gpp.mcptt-floor-request+xml MIME body with the Content-Disposition header field set to "Info-Package". For each current speaker the application/vnd.3gpp.mcptt-floor-request+xml MIME body shall be populated as follows: + - a) the element set to "general" or "dual" as described in 3GPP TS 24.379 [29] clause F.5.3; + - b) the SSRC of the MCPTT client or participant homed in the IWF with the permission to send media in the element; + - c) the actual floor priority in the element; + - d) the MCPTT ID of the MCPTT user or participant homed in the IWF with the permission to send media in the element; + - e) the queueing capability in the element of the element; + - f) the participant type in the in the element; + - g) one or more elements in the element in the same order as they would appear in the Track Info field as specified in 3GPP TS 29.380 [31] clause 8.2.3.13; and + - h) if available, additional information in the element; and +- 4) if: + - a) the user with permission to send media is an MCPTT client, and if: + - i) the IWF has location information (see 3GPP TS 24.379 [29] clause 13.2.4) for the MCPTT client; + - ii) the location information for the MCPTT client either has not been sent to the controlling MCPTT function or has changed since last sent to the MCPTT controlling function; and + - iii) the IWF determines that the location of the MCPTT client is allowed to be sent when the MCPTT user is talking; or + - b) the user with permission to send media is a participant homed in the IWF, and if: + - i) location information for the user with permission to send media homed in the IWF is available; + - ii) the location information for the participant homed in the IWF has either not been sent to the controlling MCPTT function or has changed since last sent to the controlling MCPTT function; and + - iii) the IWF determines that the location of the participant homed in the IWF is allowed to be sent when the participant homed in the IWF is talking; + +then shall include an application/vnd.3gpp.mcptt-location-info+xml MIME body with a element included in the root element. + +#### 6.6.4.1.4 Sending an INVITE request towards the controlling MCPTT function + +This clause is referenced from other procedures. + +The IWF shall generate a SIP INVITE request according to rules and procedures of 3GPP TS 24.229 [3]. + +The IWF: + +- 1) shall include in the Contact header field the g.3gpp.mcptt media feature tag, the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt", and the isfocus media feature tag according to IETF RFC 3840 [9]; +- 2) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7] in the SIP INVITE request; +- 3) shall set the Request-URI to the public service identity of the controlling MCPTT function; + +- 4) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with: + - a) the element set to the group identity; + - b) the element set to the MCPTT ID of the calling user; and + - c) the element set to "true", if the group document retrieved from the group management server contains group members as specified in 3GPP TS 24.481 [16]; +- 5) shall include the public service identity of the IWF in the P-Asserted-Identity header field; +- 6) should include the Session-Expires header field according to rules and procedures of IETF RFC 4028 [6]. The refresher parameter shall be omitted; and +- 7) shall include the Supported header field set to "timer". + +#### 6.6.4.2 Requests terminated by the non-controlling MCPTT function of an MCPTT group + +##### 6.6.4.2.1 SDP answer generation + +When composing the SDP answer according to 3GPP TS 24.229 [3], the IWF performing the non-controlling role of a group: + +- 1) for the accepted media stream in the received SDP offer: + - a) shall replace the IP address and port number in the received SDP offer with the IP address and port number of the IWF performing the non-controlling role; and +- 2) for the accepted media-floor control entity, if present in the received SDP offer: + - a) shall replace the IP address and port number in the received SDP offer with the IP address and port number of the IWF performing the non-controlling role; and + - b) shall include 'fmt' attributes as specified in 3GPP TS 29.380 [31] clause 14. + +##### 6.6.4.2.2 Sending a SIP response to the SIP INVITE request + +###### 6.6.4.2.2.1 Sending a SIP 183 (Session Progress) response + +When sending a SIP 183 (Session Progress) the IWF performing the non-controlling role of a group: + +- 1) shall generate a SIP 183 (Session Progress) response according to 3GPP TS 24.229 [3]; +- 2) shall include the following in the Contact header field: + - a) the g.3gpp.mcptt media feature tag; and + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; +- 3) shall include the public service identity determined by the IWF performing the non-controlling role in the P-Asserted-Identity header field; and +- 4) shall include the option tag "tdialog" in a Supported header field according to rules and procedures of IETF RFC 4538 [13]. + +###### 6.6.4.2.2.2 Sending a SIP 200 (OK) response + +When sending a SIP 200 (OK) response, the IWF performing the non-controlling role of a group homed in the IWF: + +- 1) shall generate the SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [3]; + +- 2) shall include the Session-Expires header field and start supervising the SIP session according to rules and procedures of IETF RFC 4028 [6], "UAS Behaviour". The "refresher" parameter in the Session-Expires header field shall be set to "uac"; +- 3) shall include the option tag "timer" in a Require header field; +- 4) shall include the public service identity of the IWF performing the non-controlling role in the P-Asserted-Identity header field; +- 5) shall include the following in the Contact header field: + - a) the g.3gpp.mcptt media feature tag; and + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; +- 6) shall include Warning header field(s) received from MCPTT clients in incoming responses to the SIP INVITE request; +- 7) shall include the option tag "tdialog" in a Supported header field according to rules and procedures of IETF RFC 4538 [13]; and +- 8) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to the constituent MCPTT group ID and the element set to the state of the floor. + +#### 6.6.4.3 Generating a SIP NOTIFY request + +The IWF performing the non-controlling role shall generate a SIP NOTIFY request according to 3GPP TS 24.229 [3] with the clarification in this clause. + +In the SIP NOTIFY request, the IWF: + +- 1) shall set the P-Asserted-Identity header field to the public service identity of the IWF; +- 2) shall include an Event header field set to "conference"; +- 3) shall include an Expires header field set to 3600 seconds according to IETF RFC 4575 [15], as default value; +- 4) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Preferred-Service header field according to IETF RFC 6050 [7]; and +- 5) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the set to the value of the constituent MCPTT group ID; + - b) if the target is a MCPTT user, the value of element set to the MCPTT ID of the targeted MCPTT user; and + - c) if the target is the controlling MCPTT function the value of element set to the temporary MCPTT group ID. + +In the SIP NOTIFY request, the IWF shall include application/conference-info+xml MIME body according to IETF RFC 4575 [15] as specified in clause 6.6.3.4 with the following exceptions: + +- 1) the IWF performing the non-controlling role shall not regard the controlling MCPTT function as a participant and not include the controlling MCPTT function in a element; and + +NOTE: The controlling MCPTT function initiated the temporary group call and will appear as a participant in the group session. + +- 2) the IWF shall include stored conference status information received in SIP NOTIFY requests from the controlling MCPTT function in 3GPP TS 24.379 [29] clause 10.1.3.5.3 and status information about MCPTT participants that are members of the group. + +## 6.6.5 Retrieving and processing a group document + +### 6.6.5.1 General + +How an IWF performing the controlling role of a group or performing the non-controlling role of a group obtains information about the group is out of scope of the present document. + +NOTE: During the group regrouping operation as specified in 3GPP TS 24.481 [16], the IWF performing the controlling role is notified of the constituent MCPTT group identities associated with the TGI. + +### 6.6.5.2 Rules for joining a group session + +The following conditions shall be met for the IWF performing the controlling role to allow an MCPTT user to join an existing group session: + +- 1) the MCPTT user is a member of the group; and +- 2) the MCPTT user is authorized to join the group; + +If both of the above conditions are met, then the MCPTT user shall be authorised to join the group session. + +### 6.6.5.3 Determining the group members to invite + +The IWF shall only invite affiliated group members to a group session. The IWF determines whether MCPTT users are affiliated members of its group by following the procedures specified in 3GPP TS 24.379 [29], clause 6.3.6. + +NOTE 1: The term "affiliated group members" used above also includes those members that are implicitly affiliated by the IWF performing the controlling role. + +NOTE 2: The IWF need not store its group parameters in a GMS as described in 3GPP TS 24.481 [16] the IWF will have to respond to queries from other systems on its IWF-3 interface, which is based upon the CSC-16 interface described in 3GPP TS 23.283 [28]. + +The IWF may limit the maximum number of participants. + +## 6.6.6 Error handling + +### 6.6.6.1 Public service identity does not exist + +Upon receiving a request that includes the Request-URI set to a public service identity that is not allocated in the IWF, the IWF performing the participating role or the controlling role shall return a SIP 404 (Not Found) response. + +## 6.6.7 Session release policy + +### 6.6.7.1 Session release policy for group call + +If: + +- 1) the call is a pre-arranged group call and if the IWF performing the controlling role receives an indication from the media plane that the T4 (Inactivity) timer specified in 3GPP TS 29.380 [31] expired and if there is at least one participant of the prearranged group call that is an MCPTT user; +- 2) there are only one or no participants in the call, including both MCPTT participants and participants homed in the IWF; +- 3) if the call is a pre-arranged group call and if it is according to local policy, the initiator of the group call leaves the call; +- 4) less than the minimum number of affiliated group members is present; +- 5) timer TNG3 (group call timer) expires; or + +- 6) the call is a broadcast group call and if the controlling MCPTT function receives an indication from the media plane that the T4 (Inactivity) timer specified in 3GPP TS 29.380 [31] expired; + +then the IWF performing the controlling role; + +- 1) shall release the MCPTT session for the group call if any participants are MCPTT users. + +### 6.6.7.2 Session release policy for private call + +If: + +- 1) IWF performing the controlling role decides that a private call has been inactive for longer than a locally determined period; or +- 2) there are only one or no participants in the MCPTT session; + +the IWF performing the controlling role shall release the MCPTT session for a private call. + +## 6.7 Implicit floor request + +A SIP re-INVITE request fulfilling the following criteria shall be regarded by the IWF performing the controlling role as an implicit floor request when the originator of the request: + +- 1) performs an upgrade of: + - a) an MCPTT group call to an emergency MCPTT group call; + - b) an MCPTT private call to an emergency MCPTT private call; or + - c) an MCPTT group call to an imminent peril MCPTT group call; and +- 2) includes the "mc\_implicit\_request" 'fmtp' attribute in the associated UDP stream for the floor control in the SDP offer/answer as specified in 3GPP TS 29.380 [31] clause 12. + +In all other cases the SIP (re-)INVITE request shall be regarded as received without an implicit floor request. + +## 6.8 Confidentiality and Integrity Protection + +### 6.8.1 General + +#### 6.8.1.1 Applicability and exclusions + +The procedures in clause 6.8 apply in general to all procedures described in clause 9, clause 10, clause 11 and clause 12. + +#### 6.8.1.2 Performing XML content encryption + +Whenever the IWF includes XML elements or attributes pertaining to the data specified in 3GPP TS 24.379 [29] clause 4.8 in SIP requests or SIP responses, the IWF shall perform the procedures in clause 6.8.2.1.1, with the exception that when the IWF receives a SIP request with XML elements or attributes in an MIME body that need to be copied from the incoming SIP request to an outgoing SIP request without modification, the IWF shall perform the procedures specified in clause 6.8.2.2. + +- NOTE: The procedure in clause 6.8.2.1.1 first determines (by referring to configuration) if confidentiality protection is enabled and then call the necessary procedures to encrypt the contents of the XML elements if confidentiality protection is enabled. + +#### 6.8.1.3 Performing integrity protection on an XML body + +The IWF shall perform the procedures in clause 6.8.3.2 just prior to sending a SIP request or SIP response. + +NOTE: The procedure in clause 6.8.3.2 first determines if integrity protection of XML MIME bodies is required and then calls the necessary procedures to integrity protect each XML MIME body if integrity protection is required. Each XML MIME body has its own signature. + +#### 6.8.1.4 Keys used in confidentiality protection procedures + +Confidentiality protection uses an XPK to encrypt the data which (depending on who is the sender and who is the receiver of the encrypted information) can be an SPK as specified in 3GPP TS 24.379 [29] clause 4.8. An XPK-ID (SPK-ID) is used to key the XPK (SPK). It is assumed that before the procedures in this clause are called, the SPK/SPK-ID is available on the sender and recipient of the encrypted content as described in 3GPP TS 24.379 [29] clause 4.8. + +The procedures in 3GPP TS 24.379 [29], clause 6.6.2.3 and 3GPP TS 24.379 [29] clause 6.6.2.4 are used with an XPK equal to the SPK and a XPK-ID equal to the SPK-ID in the following circumstances as described in 3GPP TS 33.180 [27]: + +- 1) IWF sends confidentiality protected content to an MCPTT server in the same domain; and +- 2) IWF sends confidentiality protected content to an MCPTT server in another domain. + +### 6.8.2 Confidentiality Protection + +#### 6.8.2.1 Procedures for sending confidentiality protected content + +##### 6.8.2.1.1 IWF performing any role of an MCPTT server + +If the IWF performing any role of an MCPTT server determines locally that it needs to confidentiality protect content sent to an MCPTT server, then sending confidentiality protected content between MCPTT servers is enabled. + +When sending confidentiality protected content, the IWF: + +- 1) shall use the appropriate keying information specified in clause 6.8.1.4; +- 2) shall perform the procedures in 3GPP TS 24.379 [29] clause 6.6.2.3.3 to confidentiality protect XML elements containing the content described in 3GPP TS 24.379 [29] clause 4.8; and +- 3) shall perform the procedures in 3GPP TS 24.379 [29] clause 6.6.2.3.4 to confidentiality protect URIs in XML attributes for URIs described in 3GPP TS 24.379 [29] clause 4.8. + +If the IWF determines locally that it does not need to confidentiality protect content sent to an MCPTT server, then sending confidentiality protected content between MCPTT servers is disabled, and content is included in XML elements and attributes without encryption. + +#### 6.8.2.2 IWF copying received XML content + +The following procedure is executed when an IWF receives a SIP request containing XML MIME bodies, where the content needs to be copied from the incoming SIP request to the outgoing SIP request. + +The IWF: + +- 1) shall copy the XML elements from the XML MIME body of the incoming SIP request that do not contain a XML element, to the same XML body in the outgoing SIP request; +- 2) for each encrypted XML element in the XML MIME body of the incoming SIP request as determined by 3GPP TS 24.379 [29] clause 6.6.2.4.1: + - a) shall use the keying information described in clause 6.8.1.4 to decrypt the content within the XML element by following the procedures specified in 3GPP TS 24.379 [29] clause 6.6.2.4.2, and shall continue with the steps below if the encrypted XML element was successfully decrypted; + - b) if confidentiality protection is enabled as specified in clause 6.8.2.1.1, then for each decrypted XML element: + +- i) shall re-encrypt the content within the XML element using the keying information described in clause 6.8.1.4 and by following the procedures specified in 3GPP TS 24.379 [29] clause 6.6.2.3.3; and + - ii) shall include the re-encrypted content into the same XML MIME body of the outgoing SIP request; and + - c) if confidentiality protection is disabled as specified in clause 6.8.2.1.1, shall include the decrypted content in the same XML MIME body of the outgoing SIP request. +- 3) for each encrypted XML URI attribute in the XML MIME body of the incoming SIP request as determined by 3GPP TS 24.379 [29] clause 6.6.2.4.1: +- a) shall use the keying information described in clause 6.8.1.4 to decrypt the URI value of the XML attribute by following the procedures specified in 3GPP TS 24.379 [29] clause 6.6.2.4.3, and shall continue with the steps below if the encrypted XML attribute value was successfully decrypted; + - b) if confidentiality protection is enabled as specified in clause 6.8.2.1.1, then for each decrypted XML element: + - i) shall re-encrypt the URI value of the XML attribute using the keying information described in clause 6.8.1.4 and by following the procedures specified in 3GPP TS 24.379 [29] clause 6.6.2.3.4; and + - ii) shall include the re-encrypted attribute value into the same XML MIME body of the outgoing SIP request; and + - c) if confidentiality protection is disabled as specified in clause 6.8.2.1.1, shall include the decrypted value in the same XML MIME body of the outgoing SIP request. + +## 6.8.3 Integrity Protection of XML documents + +### 6.8.3.1 Keys used in integrity protection procedures + +Integrity protection uses an XPK to sign the data which (depending on who is the sender and who is the receiver of the signed information) can be an SPK as specified in 3GPP TS 24.379 [29] clause 4.8. An XPK-ID (SPK-ID) is used to key the XPK (SPK). It is assumed that before the procedures in 3GPP TS 24.379 [29] clause 6.6.3.3 and 3GPP TS 24.379 [29] clause 6.6.3.4 are called, the SPK/SPK-ID are available on the sender and recipient of the integrity protected content, as described in 3GPP TS 24.379 [29] clause 4.8. + +The procedures in 3GPP TS 24.379 [29] clause 6.6.3.3 and 3GPP TS 24.379 [29] clause 6.6.3.4 shall be used with a XPK equal to the SPK and a XPK-ID equal to the SPK-ID in the following circumstances as described in 3GPP TS 33.180 [27]: + +- 1) IWF sends integrity protected content to an MCPTT server in the same domain; and +- 2) IWF sends integrity protected content to an MCPTT server in another domain. + +### 6.8.3.2 Integrity protection at the IWF + +The IWF determines locally whether sending integrity protected content from the IWF to an MCPTT server is enabled. + +NOTE 1: How the IWF determines whether to integrity protect content is out of scope of the present document. + +When sending integrity protected content, the IWF shall use the appropriate keying information specified in clause 6.8.3.1 and shall perform the procedures in 3GPP TS 24.379 [29] clause 6.6.3.3.3 to integrity protect XML MIME bodies. + +NOTE 2: Each XML MIME body is integrity protected separately. + +## 6.9 Priority sharing + +The IWF performing the participating role shall enable or disable priority sharing as specified in 3GPP TS 24.229 [3]. + +## 6.10 Void + +--- + +## 7 Registration and service authorisation + +The present document does not specify any registration or service authorization procedures for users homed in the IWF. + +--- + +## 8 Pre-established session + +The present document does not specify any pre-established session procedures for users homed in the IWF. + +--- + +## 9 Affiliation + +### 9.1 General + +Clause 9.2.1.2 contains the procedures for explicit and implicit affiliation of a user homed in the IWF at the IWF homing that user. + +Clauses in 9.2.1.2 also cover the case where the IWF manages affiliation to a group on behalf of the users homed in that IWF (i.e. having only one affiliation for a whole set of users homed in the IWF). In that case, the IWF needs to implement the same set of procedures but in those procedures, it shall use the MCPTT ID and the MCPTT client ID that are associated with the IWF itself instead of the ones associated with a user homed in the IWF. + +NOTE: How the MCPTT ID and MCPTT client ID associated with the IWF are determined is out of the scope of this specification. + +Clause 9.2.1.3 contains the procedures for explicit and implicit affiliation of an MCPTT user at the IWF owning the MCPTT group. + +The procedures for implicit affiliation in this clause are triggered at the IWF for a user homed in the IWF in the following circumstances: + +- when the IWF performing the participating role attempts to join an MCPTT chat group for a user homed in the IWF that is not already affiliated to the MCPTT group; +- when the IWF performing the participating role attempts to initiate an MCPTT emergency group call or MCPTT imminent peril group call for a user homed in the IWF that is not already affiliated to the MCPTT group; +- when the IWF performing the participating role attempts to initiate an MCPTT emergency alert targeted to an MCPTT group for a user homed in the IWF that is not already affiliated to the MCPTT group. + +The procedures for implicit affiliation in this clause are triggered at the IWF owning the MCPTT group in the following circumstances: + +- on receipt of a SIP INVITE request from an MCPTT server serving an MCPTT user where the MCPTT user wants to join an MCPTT chat group homed in the IWF and the MCPTT client is not already affiliated to the MCPTT group homed in the IWF; +- on receipt of a SIP INVITE request from an MCPTT server serving an MCPTT user where the MCPTT user initiates an MCPTT emergency group call or MCPTT imminent peril group call to a group homed in the IWF and the MCPTT client is not already affiliated to the MCPTT group homed in the IWF; and +- on receipt of a SIP MESSAGE request from an MCPTT server serving an MCPTT user when the MCPTT user initiates an MCPTT emergency alert targeted to an MCPTT group homed in the IWF and the MCPTT client is not already affiliated to the MCPTT group homed in the IWF. + +When the IWF affiliates to an MCPTT group on behalf of multiple users homed in the IWF using the MCPTT ID and the MCPTT client ID that are associated with the IWF itself, the IWF internally determines when such affiliation is to be made to the MCPTT group and when de-affiliation from the MCPTT group is to be done. + +It is understood that, since the MCPTT IDs of the actual LMR users participating in the MCPTT group are not provided to the MCPTT system, functions such as listing all affiliated group members and counting affiliated group members can give inaccurate results. It is further understood that the MCPTT ID appearing in call control signalling and floor control messages can be different from the IWF's MCPTT ID and MCPTT client ID. + +## 9.2 Procedures + +### 9.2.1 IWF procedures towards the MCPTT system + +#### 9.2.1.1 General + +The IWF procedures towards the MCPTT system consist of: + +- procedures towards the MCPTT system of an IWF serving the user homed in the IWF; and +- procedures of an IWF owning a group that is visible to the MCPTT system. + +#### 9.2.1.2 Procedures towards the MCPTT system of an IWF serving the user homed in the IWF + +##### 9.2.1.2.1 General + +The procedures towards the MCPTT system of an IWF serving the user homed in the IWF consist of: + +- a receiving subscription to affiliation status procedure; +- a sending notification of change of affiliation status procedure; +- a sending affiliation status change towards MCPTT server owning MCPTT group procedure; +- an affiliation status determination from MCPTT server owning MCPTT group procedure; +- an affiliation status determination procedure; +- an affiliation status change by implicit affiliation procedure; +- an implicit affiliation status change completion procedure; +- an implicit affiliation status change cancellation procedure; and +- an automatic affiliation to configured groups procedure. + +##### 9.2.1.2.2 Stored information + +The IWF maintains information equivalent to that defined in TS 24.379 [29] clause 9.2.2.2.2. + +NOTE: The virtual data structure referenced in this clause is for information only. Implementors may choose other means to track affiliation status for users homed in the IWF. References to the elements of this virtual data structure are made in other clauses with the understanding that implementors choosing not to use this virtual data structure will take other appropriate actions. + +##### 9.2.1.2.3 Procedure for handling affiliation status change of a user homed in the IWF + +When the IWF determines that affiliation status should change for a user homed in the IWF, the IWF performing the participating role: + +- 1) shall determine the served MCPTT ID associated with the user homed in the IWF; +- 2) shall determine the candidate expiration interval for the affiliation according to IETF RFC 3903 [21]; +- 3) shall determine the served MCPTT client ID associated with the user homed in the IWF; +- 4) shall consider an MCPTT user information entry such that: + - a) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and + - b) the MCPTT ID of the MCPTT user information entry is equal to the served MCPTT ID;as the served MCPTT user information entry; +- 5) shall consider an MCPTT client information entry such that: + - a) the MCPTT client information entry is in the list of MCPTT client information entries of the served MCPTT user information entry; and + - b) the MCPTT client ID of the MCPTT client information entry is equal to the served MCPTT client ID;as the served MCPTT client information entry; +- 6) shall consider a copy of the list of the MCPTT group information entries of the served MCPTT client information entry as the served list of the MCPTT group information entries; +- 7) if the candidate expiration interval is nonzero: + - a) shall construct the candidate list of the MCPTT group information entries as follows: + - i) for each MCPTT group ID which has an MCPTT group information entry in the served list of the MCPTT group information entries, such that the expiration time of the MCPTT group information entry has not expired yet, and which is determined by the IWF to be a group to which the user homed in the IWF is to be affiliated: + - A) shall copy the MCPTT group information entry into a new MCPTT group information entry of the candidate list of the MCPTT group information entries; + - B) if the affiliation status of the MCPTT group information entry is "deaffiliating" or "deaffiliated", shall set the affiliation status of the new MCPTT group information entry to the "affiliating" state and shall reset the affiliating p-id of the new MCPTT group information entry; and + - C) shall set the expiration time of the new MCPTT group information entry to the current time increased with the candidate expiration interval; + - ii) for each MCPTT group ID which has an MCPTT group information entry in the served list of the MCPTT group information entries, such that the expiration time of the MCPTT group information entry has not expired yet, and which is determined by the IWF to be a group to which the user homed in the IWF is not to be affiliated: + - A) shall copy the MCPTT group information entry into a new MCPTT group information entry of the candidate list of the MCPTT group information entries; and + - B) if the affiliation status of the MCPTT group information entry is "affiliated" or "affiliating": + - shall set the affiliation status of the new MCPTT group information entry to the "de-affiliating" state; and + - shall set the expiration time of the new MCPTT group information entry to the current time increased with twice the value of timer F; and + - iii) for each MCPTT group ID: + - A) which does not have an MCPTT group information entry in the served list of the MCPTT group information entries; or + +B) which has an MCPTT group information entry in the served list of the MCPTT group information entries, such that the expiration time of the MCPTT group information entry has already expired; + +and which is determined by the IWF to be a group to which the user homed in the IWF is to be affiliated: + +A) shall add a new MCPTT group information entry in the candidate list of the MCPTT group information list for the MCPTT group ID; + +B) shall set the affiliation status of the new MCPTT group information entry to the "affiliating" state; + +C) shall set the expiration time of the new MCPTT group information entry to the current time increased with the candidate expiration interval; and + +D) shall reset the affiliating p-id of the new MCPTT group information entry; + +b) determine the candidate number of MCPTT group IDs as the number of different MCPTT group IDs which have an MCPTT group information entry: + +i) in the candidate list of the MCPTT group information entries; or + +ii) in the list of the MCPTT group information entries of an MCPTT client information entry such that: + +A) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry; and + +B) the MCPTT client ID of the MCPTT client information entry is not equal to the served MCPTT client ID; + +with the affiliation status set to the "affiliating" state or the "affiliated" state and with the expiration time which has not expired yet; and + +c) if the candidate number of MCPTT group IDs is bigger than N2 value of the served MCPTT ID, shall be based on service provider policy reduce the candidate MCPTT group IDs to that equal to N2; + +NOTE: The service provider policy can determine to remove an MCPTT group ID based on the importance or priority of the MCPTT group or some other policy to determine which groups are preferred. + +8) if the candidate expiration interval is zero, constructs the candidate list of the MCPTT group information entries as follows: + +a) for each MCPTT group ID which has an entry in the served list of the MCPTT group information entries: + +i) shall copy the MCPTT group entry of the served list of the MCPTT group information into a new MCPTT group information entry of the candidate list of the MCPTT group information entries; + +ii) shall set the affiliation status of the new MCPTT group information entry to the "de-affiliating" state; and + +iii) shall set the expiration time of the new MCPTT group information entry to the current time increased with twice the value of timer F; + +9) shall replace the list of the MCPTT group information entries stored in the served MCPTT client information entry with the candidate list of the MCPTT group information entries; + +10) shall perform the procedures specified in clause 9.2.1.2.6 for the served MCPTT ID and each MCPTT group ID: + +a) which does not have an MCPTT group information entry in the served list of the MCPTT group information entries and which has an MCPTT group information entry in the candidate list of the MCPTT group information entries with the affiliation status set to the "affiliating" state; + +b) which has an MCPTT group information entry in the served list of the MCPTT group information entries with the expiration time already expired, and which has an MCPTT group information entry in the candidate list of the MCPTT group information entries with the affiliation status set to the "affiliating" state; + +c) which has an MCPTT group information entry in the served list of the MCPTT group information entries with the affiliation status set to the "deaffiliating" state or the "deaffiliated" state and with the expiration time not expired yet, and which has an MCPTT group information entry in the candidate list of the MCPTT group information entries with the affiliation status set to the "affiliating" state; or + +- d) which has an MCPTT group information entry in the served list of the MCPTT group information entries with the affiliation status set to the "affiliated" state and with the expiration time not expired yet, and which has an MCPTT group information entry in the candidate list of the MCPTT group information entries with the affiliation status set to the "de-affiliating" state. + +#### 9.2.1.2.4 Receiving subscription to affiliation status procedure + +Upon receiving a SIP SUBSCRIBE request such that: + +- 1) the Request-URI of the SIP SUBSCRIBE request contains the public service identity identifying the IWF performing the terminating participating role serving the user homed in the IWF; +- 2) the SIP SUBSCRIBE request contains an application/vnd.3gpp.mcptt-info+xml MIME body containing the element which identifies an MCPTT ID associated with a user homed in the IWF performing the terminating participating role; +- 3) the SIP SUBSCRIBE request contains the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; and +- 4) the Event header field of the SIP SUBSCRIBE request contains the "presence" event type; + +the IWF performing the terminating participating role: + +- 1) if the IWF does not support receiving a SIP SUBSCRIBE request to the affiliation status of a user homed in the IWF, the IWF shall generate and send a SIP 501 (Not Implemented) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 6665 [25], and shall skip the remainder of this procedure; +- 2) shall identify the served MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; +- 3) if the Request-URI of the SIP SUBSCRIBE request contains the public service identity identifying the IWF performing the terminating participating role serving the user homed in the IWF, shall identify the originating MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; +- 4) if the originating MCPTT ID is not authorized to subscribe to the affiliation status of the user homed in the IWF, shall send a 403 (Forbidden) response and shall not continue with the rest of the steps; and +- 5) shall generate a 200 (OK) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 6665 [25]. + +For the duration of the subscription, the IWF performing the terminating participating role shall notify the subscriber about changes of the information of the served MCPTT ID, as described in clause 9.2.1.2.5. + +#### 9.2.1.2.5 Sending notification of change of affiliation status procedure + +In order to notify the subscriber about changes of the served MCPTT ID, the IWF: + +NOTE: the served MCPTT ID identifies the user homed in the IWF whose affiliation status has been subscribed. + +- 1) shall consider an MCPTT user information entry such that: + - a) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and + - b) the MCPTT ID of the MCPTT user information entry is equal to the served MCPTT ID;as the served MCPTT user information entry; +- 2) shall consider the list of the MCPTT client information entries of the served MCPTT user information entry as the served list of the MCPTT client information entries; +- 3) shall generate an application/pidf+xml MIME body indicating per-user affiliation information according to 3GPP TS 24.379 [29], clause 9.3.1 and the served list of the MCPTT client information entries with the following clarifications: + +- a) the IWF shall not include information from an MCPTT group information entry with the expiration time already expired; + - b) the IWF shall not include information from an MCPTT group information entry with the affiliation status set to the "deaffiliated" state; and + - c) if the SIP SUBSCRIBE request creating the subscription of this notification contains an application/simple-filter+xml MIME body indicating per-client restrictions of presence event package notification information according to 3GPP TS 24.379 [29], clause 9.3.2, the IWF shall restrict the application/pidf+xml MIME body according to the application/simple-filter+xml MIME body; and +- 4) send a SIP NOTIFY request according to 3GPP TS 24.229 [3], and IETF RFC 6665 [25] for the subscription created in clause 9.2.1.2.4. In the SIP NOTIFY request, the IWF shall include the generated application/pidf+xml MIME body indicating per-user affiliation information. + +#### 9.2.1.2.6 Sending affiliation status change towards MCPTT server owning MCPTT group procedure + +NOTE 1: Usage of one SIP PUBLISH request to carry information about change of affiliation state of several users homed in the same IWF and/or to several MCPTT groups owned by the same MCPTT server is not supported in this version of the specification. + +In order: + +- to send an affiliation request of a user homed in the IWF to a handled MCPTT group ID; +- to send a de-affiliation request of a user homed in the IWF from a handled MCPTT group ID; or +- to send an affiliation request of a user homed in the IWF to a handled MCPTT group ID due to near expiration of the previously published information; + +the IWF shall generate a SIP PUBLISH request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24]. In the SIP PUBLISH request, the IWF: + +- 1) shall set the Request-URI to the public service identity of the controlling MCPTT function associated with the handled MCPTT group ID; +- 2) shall include an application/vnd.3gpp.mcptt-info+xml MIME body. In the application/vnd.3gpp.mcptt-info+xml MIME body, the MCPTT server: + - a) shall include the element set to the handled MCPTT group ID; and + - b) shall include the element set to MCPTT ID associated with the user homed in the IWF; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) if sending an affiliation request, shall set the Expires header field according to IETF RFC 3903 [21], to 4294967295; + +NOTE 2: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [14]. + +- 5) if sending a de-affiliation request, shall set the Expires header field according to IETF RFC 3903 [21], to zero; +- 6) shall include a P-Asserted-Identity header field set to the public service identity of the IWF according to 3GPP TS 24.229 [3]; +- 7) shall set the current p-id to a globally unique value; +- 8) shall consider an MCPTT user information entry such that: + - a) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and + +- b) the MCPTT ID of the MCPTT user information entry is equal to the MCPTT ID associated with the user homed in the IWF; + +as the served MCPTT user information entry; + +- 9) for each MCPTT group information entry such that: + +- a) the MCPTT group information entry has the "affiliating" affiliation status, the MCPTT group ID set to the handled MCPTT group ID, the expiration time has not expired yet and the affiliating p-id is not set; +- b) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry; and +- c) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry; + +shall set the affiliating p-id of the MCPTT group information entry to the current p-id; and + +- 10) shall include an application/pidf+xml MIME body indicating per-group affiliation information for a user homed in the IWF constructed according to 3GPP TS 24.379 [29], clause 9.3.1.2. The IWF shall indicate all MCPTT client IDs associated with the user homed in the IWF, such that: + +- a) the affiliation status is set to "affiliating" or "affiliated", and the expiration time has not expired yet in an MCPTT group information entry with the MCPTT group ID set to the handled MCPTT group; +- b) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry; +- c) the MCPTT client information entry has the MCPTT client ID set to the served MCPTT client ID; and +- d) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry. + +The IWF shall set the child element of the root element to the current p-id. + +The IWF shall not include the "expires" attribute in the element. + +The IWF shall send the SIP PUBLISH request according to 3GPP TS 24.229 [3]. + +If timer F expires for the SIP PUBLISH request sent for a (de)affiliation request of the user homed in the IWF to the MCPTT group ID or upon receiving a SIP 3xx, 4xx, 5xx or 6xx response to the SIP PUBLISH request, the IWF: + +- 1) shall remove each MCPTT group ID entry such that: + - a) the MCPTT group information entry has the MCPTT group ID set to the handled MCPTT group ID; + - b) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry; and + - c) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry. + +#### 9.2.1.2.7 Affiliation status determination from MCPTT server owning MCPTT group procedure. + +NOTE 1: Usage of one SIP SUBSCRIBE request to subscribe for notification about change of affiliation state of several users homed in the same IWF is not supported in this version of the specification. + +In order to discover whether a user homed in the IWF was successfully affiliated to a handled MCPTT group in the MCPTT server owning the handled MCPTT group, the IWF shall generate an initial SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 3856 [24], and IETF RFC 6665 [25]. + +In the SIP SUBSCRIBE request, the IWF: + +- 1) shall set the Request-URI to the public service identity of the controlling MCPTT function associated with the handled MCPTT group ID; + +- 2) shall include an application/vnd.3gpp.mcptt-info+xml MIME body. In the application/vnd.3gpp.mcptt-info+xml MIME body, the IWF: + - a) shall include the element set to the handled MCPTT group ID; and + - b) shall include the element set to the MCPTT ID associated with the user homed in the IWF; +- 3) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) if the IWF wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [25], to 4294967295; + +NOTE 2: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [14]. + +- 5) if the IWF wants to fetch the current state only, shall set the Expires header field according to IETF RFC 6665 [25], to zero; +- 6) shall include an Accept header field containing the application/pidf+xml MIME type; and +- 7) shall include an application/simple-filter+xml MIME body indicating per-user restrictions of presence event package notification information according to 3GPP TS 24.379 [29], clause 9.3.2, indicating the MCPTT ID associated with the user homed in the IWF. + +The IWF shall send the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3]. + +In order to re-subscribe or de-subscribe, the IWF shall generate an in-dialog SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 3856 [24], and IETF RFC 6665 [25]. In the SIP SUBSCRIBE request, the IWF: + +- 1) if the IWF wants to receive the current status and later notification, shall set the Expires header field according to IETF RFC 6665 [25], to 4294967295; + +NOTE 3: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [14]. + +- 2) if the MCPTT server wants to de-subscribe, shall set the Expires header field according to IETF RFC 6665 [25], to zero; and +- 3) shall include an Accept header field containing the application/pidf+xml MIME type. + +Upon receiving a SIP NOTIFY request according to 3GPP TS 24.229 [3], IETF RFC 3856 [24], and IETF RFC 6665 [25], if the SIP NOTIFY request contains an application/pidf+xml MIME body indicating per-group affiliation information constructed according to 3GPP TS 24.379 [29], clause 9.3.1, then the IWF: + +- 1) for each served MCPTT ID and served MCPTT client ID such that the application/pidf+xml MIME body of SIP NOTIFY request contains: + - a) a element of the root element; + - b) the "id" attribute of the element indicating the MCPTT ID associated with the user homed in the IWF; + - c) an child element of the element of the element; + - d) the "client" attribute of the element indicating the MCPTT client ID associated with the user homed in the IWF; and + - e) the "expires" attribute of the element indicating expiration of affiliation; + +perform the following: + +- a) if an MCPTT group information entry exists such that: + - i) the MCPTT group information entry has the "affiliating" affiliation status, the MCPTT group ID set to the handled MCPTT group ID, and the expiration time has not expired yet; + +- ii) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry with the MCPTT client ID set to the MCPTT client ID associated with the user homed in the IWF; + - iii) the MCPTT client information entry is in the list of the MCPTT client information entries of a served MCPTT user information entry with the MCPTT ID set to the MCPTT ID associated with the user homed in the IWF; and + - iv) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and +- b) shall set the affiliation status of the MCPTT group information entry to "affiliated"; and + - c) shall set the next publishing time of the MCPTT group information entry to the current time and half of the time between the current time and the expiration of affiliation; +- 2) for each MCPTT group information entry such that: + - a) the MCPTT group information entry has the "affiliated" affiliation status or the "deaffiliating" affiliation status, the MCPTT group ID set to the handled MCPTT group ID, and the expiration time has not expired yet; + - b) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry with the MCPTT client ID set to the MCPTT client ID associated with the user homed in the IWF; + - c) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry with the MCPTT ID set to the MCPTT ID associated with the user homed in IWF; and + - d) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and + +for which the application/pidf+xml MIME body of SIP NOTIFY request does not contain + +- a) a element of the root element; +- b) the "id" attribute of the element indicating the MCPTT ID associated with the user homed in the IWF; +- c) an child element of the child element of the element; and +- d) the "client" attribute of the element indicating the MCPTT client ID associated with the user homed in the IWF; + +perform the following: + +- a) shall set the affiliation status of the MCPTT group information entry to "deaffiliated"; and + - b) shall set the expiration time of the MCPTT group information entry to the current time; and +- 3) if a element is included in the root element of the application/pidf+xml MIME body of the SIP NOTIFY request, then for each MCPTT group information entry such that: + - a) the MCPTT group information entry has the "affiliating" affiliation status, the MCPTT group ID set to the handled MCPTT group ID, the expiration time has not expired yet and with the affiliating p-id set to the value of the element; + - b) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry with the MCPTT client ID set to the MCPTT client ID associated with the user homed in the IWF; + - c) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry with the MCPTT ID set to the MCPTT ID associated with the user homed in the IWF; and + +- d) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and + +for which the application/pidf+xml MIME body of SIP NOTIFY request does not contain: + +- a) a element of the root element; +- b) the "id" attribute of the element indicating the MCPTT ID associated with the user homed in the IWF; +- c) an child element of the child element of the element; and +- d) the "client" attribute of the element indicating the MCPTT client ID associated with the user homed in the IWF; + +perform the following: + +- a) shall set the affiliation status of the MCPTT group information entry to "deaffiliated"; and +- b) shall set the expiration time of the MCPTT group information entry to the current time. + +#### 9.2.1.2.8 Affiliation status determination + +This clause is referenced from other procedures. + +If the IWF performing the participating role needs to determine the affiliation status of a user homed in the IWF to an MCPTT group, the IWF performing the participating role: + +- 1) shall determine the client and MCPTT client ID associated with the user homed in the IWF; +- 2) shall find the user information entry in the list of MCPTT user information entries described in clause 9.2.1.2.2 such that the MCPTT ID of the MCPTT user information entry is equal to the MCPTT ID associated with the user homed in the IWF; + - a) if the applicable MCPTT group information entry cannot be found, then the IWF performing the participating role shall determine that the user homed in the IWF is not affiliated to the MCPTT group at the determined client and the skip the rest of the steps; +- 3) shall find the MCPTT client information entry in the list of MCPTT client information entries of MCPTT user information entry found in step 1) in which the MCPTT client id matches the value of the determined MCPTT client ID; + - a) if the applicable MCPTT client information entry cannot be found, then the IWF performing the participating role shall determine that the user homed in the IWF is not affiliated to the MCPTT group at the determined client and the skip the rest of the steps; +- 4) shall find the MCPTT group information entry in the list of MCPTT group information entries of MCPTT client information entry found in step 2 such that the MCPTT group identity matches the value of the identity of the targeted MCPTT group; + - a) if the applicable MCPTT group information entry was found in step 3) and the affiliation status of the MCPTT group information entry is "affiliating" or "affiliated", shall determine that the user homed in the IWF at the determined client is affiliated to the targeted MCPTT group and skip the rest of the steps; + - b) if the applicable MCPTT group information entry was found in step 3) and the affiliation status of the MCPTT group information entry is "deaffiliating" or "deaffiliated", shall determine that the user homed in the IWF at the determined client to is not affiliated to the targeted MCPTT group and skip the rest of the steps; or + - c) if the applicable MCPTT group information entry was not found in step 3), shall determine that the user homed in the IWF at the determined client is not affiliated to the targeted MCPTT group. + +#### 9.2.1.2.9 Affiliation status change by implicit affiliation + +This clause is referenced from other procedures. + +Upon determining that a user homed in the IWF is to be implicitly affiliated to an MCPTT group as per the triggers defined in clause 9.1, the IWF performing the participating role: + +- 1) shall determine the served MCPTT client ID as being the MCPTT ID associated with the user homed in the IWF; +- 2) shall determine the MCPTT group ID to which the user homed in the IWF is to be implicitly affiliated; +- 3) shall determine the served MCPTT ID as being the MCPTT ID associated with the user homed in the IWF; +- 4) shall consider an MCPTT user information entry such that: + - a) the MCPTT user information entry is in the list of MCPTT user information entries described in clause 9.2.1.2.2; and + - b) the MCPTT ID of the MCPTT user information entry is equal to the served MCPTT ID;as the served MCPTT user information entry; +- 5) shall consider an MCPTT client information entry such that: + - a) the MCPTT client information entry is in the list of MCPTT client information entries of the served MCPTT user information entry; and + - b) the MCPTT client ID of the MCPTT client information entry is equal to the served MCPTT client ID;as the served MCPTT client information entry; +- 6) shall consider a copy of the list of the MCPTT group information entries of the served MCPTT client information entry as the served list of the MCPTT group information entries; +- 7) shall construct the candidate list of the MCPTT group information entries as follows: + - a) for each MCPTT group ID which has an MCPTT group information entry in the served list of the MCPTT group information entries shall copy the MCPTT group information entry into a new MCPTT group information entry of the candidate list of the MCPTT group information entries; and + - b) if the determined MCPTT group ID does not have an MCPTT group information entry in the served list of the MCPTT group information entries or has an MCPTT group information entry in the served list of the MCPTT group information entries, such that the expiration time of the MCPTT group information entry has already expired: + - i) shall add a new MCPTT group information entry in the candidate list of the MCPTT group information list for the determined MCPTT group ID; + - ii) shall set the affiliation status of the new MCPTT group information entry to the "affiliating" state; and + - iii) shall set the expiration time of the new MCPTT group information entry to the current time increased with the candidate expiration interval; +- 8) determine the candidate number of MCPTT group IDs as the number of different MCPTT group IDs which have an MCPTT group information entry: + - a) in the candidate list of the MCPTT group information entries; or + - b) in the list of the MCPTT group information entries of an MCPTT client information entry such that: + - i) the MCPTT client information entry is in the list of the MCPTT client information entries of the served MCPTT user information entry; and + - ii) the MCPTT client ID of the MCPTT client information entry is not equal to the served MCPTT client ID;with the affiliation status set to the "affiliating" state or the "affiliated" state and with the expiration time which has not expired yet; and +- 9) if the candidate number of MCPTT group IDs is bigger than the N2 value of the served MCPTT ID, shall be based on MCPTT service provider policy reduce the candidate MCPTT group IDs to that equal to N2; + +NOTE: The MCPTT service provider policy can determine to remove an MCPTT group ID based on the importance or priority of other MCPTT groups, received SIP requests containing an authorised request for originating a priority call as determined by clause 6.6.2.1.4.2 or other policy to determine which MCPTT groups are preferred. + +- 10) if the determined MCPTT group ID cannot be added to the candidate list of the MCPTT group information entries due to exceeding the N2 limit for the user homed in the IWF, shall discard the candidate list of the MCPTT group information entries and skip the remaining steps of the current procedure; and +- 11) shall replace the list of the MCPTT group information entries stored in the served MCPTT client information entry with the candidate list of the MCPTT group information entries. + +#### 9.2.1.2.10 Implicit affiliation status change completion + +This clause is referenced from other procedures. + +If the IWF performing the participating role has received a SIP 2xx response from the controlling MCPTT function to a SIP request that had triggered an affiliation status change by implicit affiliation as per clause 9.2.1.2.9, the IWF performing the participating role: + +- 1) shall set the affiliation status of the MCPTT group information entry added to the candidate list of the MCPTT group information entries by the procedures of clause 9.2.1.2.9 to "affiliated"; and +- 2) shall perform the procedures specified in clause 9.2.1.2.5 for the MCPTT ID associated with the user homed in the IWF. + +#### 9.2.1.2.11 Implicit affiliation status change cancellation + +This clause is referenced from other procedures. + +If the IWF performing the participating role for a user homed in the IWF receives a SIP 4xx, 5xx or 6xx response from the controlling MCPTT function to a SIP request that had triggered an affiliation status change by implicit affiliation as per clause 9.2.1.2.9, the IWF performing the participating role: + +- 1) shall remove the MCPTT group ID entry added by the procedures of clause 9.2.1.2.9 such that: + - a) the MCPTT group information entry has the MCPTT group ID set to the MCPTT group ID of the MCPTT group targeted by the received SIP request; + - b) the MCPTT group information entry is in the list of the MCPTT group information entries of an MCPTT client information entry containing the MCPTT client ID associated with the user homed in the IWF; and + - c) the MCPTT client information entry is in the list of the MCPTT client information entries of the MCPTT user information entry containing the MCPTT ID associated with the user homed in the IWF. + +#### 9.2.1.2.12 Automatic affiliation to configured groups procedure + +This clause is referenced from other procedures. + +When the IWF determines that automatic affiliation of a user homed in the IWF to configured groups is needed, the IWF shall perform procedures 9.2.1.2.6 and 9.2.1.2.7 for the user homed in the IWF and the targeted groups. + +### 9.2.1.3 Procedures of MCPTT server owning the MCPTT group + +#### 9.2.1.3.1 General + +The procedures of the IWF owning the MCPTT group consist of: + +- receiving group affiliation status change procedure; +- receiving subscription to affiliation status procedure; +- sending notification of change of affiliation status procedure; + +- affiliation eligibility check procedure; +- implicit affiliation eligibility check procedure; +- affiliation status change by implicit affiliation procedure; +- receiving subscription to group dynamic data procedure and; +- sending notification of change of group dynamic data procedure. + +#### 9.2.1.3.2 Stored information + +The IWF maintains information equivalent to that defined in clause 9.2.1.3.2. + +NOTE: The virtual data structure referenced in this clause is for information only. Implementors may choose other means to track affiliation status to groups owned by the IWF. References to the elements of this virtual data structure are made in other clauses with the understanding that implementors choosing not to use this virtual data structure will take other appropriate actions. + +#### 9.2.1.3.3 Receiving group affiliation status change procedure + +Upon receiving a SIP PUBLISH request such that: + +- 1) Request-URI of the SIP PUBLISH request contains the public service identity of the IWF owning the served MCPTT group; +- 2) the SIP PUBLISH request contains an application/vnd.3gpp.mcptt-info+xml MIME body containing the element and the element; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) the Event header field of the SIP PUBLISH request contains the "presence" event type; and +- 5) The SIP PUBLISH request contains an application/pidf+xml MIME body indicating per-group affiliation information constructed according to 3GPP TS 24.379 [29], clause 9.3.1.2, with the IWF acting as the controlling MCPTT function; + +then the IWF: + +- 1) shall identify the served MCPTT group ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP PUBLISH request; +- 2) shall identify the handled MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP PUBLISH request; +- 3) if the Expires header field of the SIP PUBLISH request is not included or has nonzero value lower than 4294967295, shall send a SIP 423 (Interval Too Brief) response to the SIP PUBLISH request, where the SIP 423 (Interval Too Brief) response contains a Min-Expires header field set to 4294967295, and shall not continue with the rest of the steps; +- 4) if an MCPTT group for the served MCPTT group ID does not exist in the IWF, shall reject the SIP PUBLISH request with SIP 403 (Forbidden) response to the SIP PUBLISH request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24] and skip the rest of the steps; +- 5) if the handled MCPTT ID is not a member of the MCPTT group identified by the served MCPTT group ID, shall reject the SIP PUBLISH request with SIP 403 (Forbidden) response to the SIP PUBLISH request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24] and skip the rest of the steps; +- 6) shall respond with SIP 200 (OK) response to the SIP PUBLISH request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21]. In the SIP 200 (OK) response, the IWF: + - a) shall set the Expires header field according to IETF RFC 3903 [21], to the selected expiration time; + +- 7) if the "entity" attribute of the element of the application/pidf+xml MIME body of the SIP PUBLISH request is different than the served MCPTT group ID, shall not continue with the rest of the steps; +- 8) if the handled MCPTT ID is different from the MCPTT ID in the "id" attribute of the element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request, shall not continue with the rest of the steps; +- 9) shall consider an MCPTT group information entry such that: + - a) the MCPTT group information entry is in the list of MCPTT group information entries described in clause 9.2.1.3.2; and + - b) the MCPTT group ID of the MCPTT group information entry is equal to the served MCPTT group ID;as the served MCPTT group information entry; +- 10) if the selected expiration time is zero: + - a) shall remove the MCPTT user information entry such that: + - i) the MCPTT user information entry is in the list of the MCPTT user information entries of the served MCPTT group information entry; and + - ii) the MCPTT user information entry has the MCPTT ID set to the handled MCPTT ID; +- 11) if the selected expiration time is not zero: + - a) shall consider an MCPTT user information entry such that: + - i) the MCPTT user information entry is in the list of the MCPTT user information entries of the served MCPTT group information entry; and + - ii) the MCPTT ID of the MCPTT user information entry is equal to the handled MCPTT ID;as the served MCPTT user information entry; + - b) if the MCPTT user information entry does not exist: + - i) shall insert an MCPTT user information entry with the MCPTT ID set to the handled MCPTT ID into the list of the MCPTT user information entries of the served MCPTT group information entry; and + - ii) shall consider the inserted MCPTT user information entry as the served MCPTT user information entry; and + - c) shall set the following information in the served MCPTT user information entry: + - i) set the MCPTT client ID list according to the "client" attributes of the elements of the element of the element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request; and + - ii) set the expiration time according to the selected expiration time; +- 12) shall identify the handled p-id in the child element of the root element of the application/pidf+xml MIME body of the SIP PUBLISH request; and +- 13) shall perform the procedures specified in clause 9.2.1.3.5 for the served MCPTT group ID. + +#### 9.2.1.3.4 Receiving subscription to affiliation status procedure + +NOTE: Usage of one SIP SUBSCRIBE request to subscribe for notification about change of affiliation state of several MCPTT users served by the same IWF is not supported in this version of the specification. + +Upon receiving a SIP SUBSCRIBE request such that: + +- 1) Request-URI of the SIP SUBSCRIBE request contains the public service identity of the IWF owning the served MCPTT group; + +- 2) the SIP SUBSCRIBE request contains an application/vnd.3gpp.mcptt-info+xml MIME body containing the element and the element; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) the Event header field of the SIP SUBSCRIBE request contains the "presence" event type; and +- 5) the SIP SUBSCRIBE request contains an application/simple-filter+xml MIME body indicating per-user restrictions of presence event package notification information according to 3GPP TS 24.379 [29], clause 9.3.2 indicating the same MCPTT ID as in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; + +then the IWF: + +- 1) shall identify the served MCPTT group ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; +- 2) shall identify the handled MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; +- 3) if the Expires header field of the SIP SUBSCRIBE request is not included or has nonzero value lower than 4294967295, shall send a SIP 423 (Interval Too Brief) response to the SIP SUBSCRIBE request, where the SIP 423 (Interval Too Brief) response contains a Min-Expires header field set to 4294967295, and shall not continue with the rest of the steps; +- 4) if an MCPTT group for the served MCPTT group ID does not exist in the IWF, shall reject the SIP SUBSCRIBE request with SIP 403 (Forbidden) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24] and skip the rest of the steps; +- 5) if the handled MCPTT ID is not a member of the MCPTT group identified by the served MCPTT group ID, shall reject the SIP SUBSCRIBE request with SIP 403 (Forbidden) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24] and skip the rest of the steps; and +- 6) shall generate and send a SIP 200 (OK) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 6665 [25]. + +For the duration of the subscription, the IWF shall notify subscriber about changes of the information of the served MCPTT ID, as described in clause 9.2.1.3.5. + +#### 9.2.1.3.5 Sending notification of change of affiliation status procedure + +In order to notify the subscriber identified by the handled MCPTT ID about changes of the affiliation status of the served MCPTT group ID, the IWF: + +- 1) shall consider an MCPTT group information entry such that: + - a) the MCPTT group information entry is in the list of MCPTT group information entries described in clause 9.2.1.3.2; and + - b) the MCPTT group ID of the MCPTT group information entry is equal to the served MCPTT group ID; +- 2) shall consider an MCPTT user information entry such: + - a) the MCPTT user information entry is in the list of the MCPTT user information entries of the served MCPTT group information entry; and + - b) the MCPTT ID of the MCPTT user information entry is equal to the handled MCPTT ID;as the served MCPTT user information entry; +- 3) shall generate an application/pidf+xml MIME body indicating per-group affiliation information according to 3GPP TS 24.379 [29], clause 9.3.1 and the served list of the served MCPTT user information entry of the MCPTT group information entry with following clarifications: + +- a) the MCPTT server shall include the "expires" attribute in the element; and + - b) if this procedure is invoked by procedure in clause 9.2.1.3.3 where the handled p-id was identified, the IWF shall set the child element of the root element of the application/pidf+xml MIME body of the SIP NOTIFY request to the handled p-id value; and +- 4) send a SIP NOTIFY request according to 3GPP TS 24.229 [3], and IETF RFC 6665 [25] for the subscription created in clause 9.2.1.3.4. In the SIP NOTIFY request, the IWF shall include the generated application/pidf+xml MIME body indicating per-group affiliation information. + +#### 9.2.1.3.6 Implicit affiliation eligibility check procedure + +This clause is referenced from other procedures. + +Upon receiving a SIP request for an MCPTT group that the MCPTT user is not currently affiliated to and that requires the IWF performing the controlling role to check on the eligibility of the MCPTT user to be implicitly affiliated to the MCPTT group, the IWF performing the controlling role: + +- 1) shall perform the procedures of clause 9.2.1.3.8 to determine if the MCPTT user is eligible to be affiliated to the MCPTT group; and +- 2) if the MCPTT user was determined eligible to be affiliated to the MCPTT group by the procedures of clause 9.2.1.3.8, shall consider the MCPTT user to be eligible for implicit affiliation to the MCPTT group. + +#### 9.2.1.3.7 Affiliation status change by implicit affiliation procedure + +This clause is referenced from other procedures. + +Upon receiving a SIP request for an MCPTT group that the MCPTT user is not currently affiliated to and that requires the IWF performing the controlling role to perform an implicit affiliation to, the IWF performing the controlling role: + +- 1) shall identify the served MCPTT group ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP request; +- 2) shall identify the handled MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP request; +- 3) shall consider an MCPTT group information entry such that: + - a) the MCPTT group information entry is in the list of MCPTT group information entries described in clause 9.2.1.3.2 with the IWF acting as the controlling MCPTT function; and + - b) the MCPTT group ID of the MCPTT group information entry is equal to the served MCPTT group ID;as the served MCPTT group information entry; +- 4) shall consider an MCPTT user information entry such that: + - a) the MCPTT user information entry is in the list of the MCPTT user information entries of the served MCPTT group information entry; and + - b) the MCPTT ID of the MCPTT user information entry is equal to the handled MCPTT ID;as the served MCPTT user information entry; +- c) if the MCPTT user information entry does not exist: + - i) shall insert an MCPTT user information entry with the MCPTT ID set to the handled MCPTT ID into the list of the MCPTT user information entries of the served MCPTT group information entry; and + - ii) shall consider the inserted MCPTT user information entry as the served MCPTT user information entry; and +- d) shall make the following modifications in the served MCPTT user information entry: + +- i) add the MCPTT client ID derived from the received SIP request to the MCPTT client ID list if not already present; and + - ii) set the expiration time as determined by local policy; +- 5) shall perform the procedures specified in clause 9.2.1.3.5 for the served MCPTT group ID. + +#### 9.2.1.3.8 Affiliation eligibility check procedure + +This clause is referenced from other procedures. + +Upon receiving a SIP request for an MCPTT group that the MCPTT user is not currently affiliated to and that requires the IWF performing the controlling role to check on the eligibility of the MCPTT user to be affiliated to the MCPTT group, the IWF performing the controlling role: + +- 1) shall identify the served MCPTT group ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP request; +- 2) shall identify the handled MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP request; +- 3) if an MCPTT group for the served MCPTT group ID does not exist in the IWF, shall consider the MCPTT user to be ineligible for affiliation and skip the rest of the steps; +- 4) if the handled MCPTT ID is not a member of the MCPTT group identified by the served MCPTT group ID, shall consider the MCPTT user to be ineligible for affiliation and skip the rest of the steps; +- 5) if there is no MCPTT group information entry in the list of MCPTT group information entries described in clause 9.2.1.3.2, with the IWF acting as the controlling MCPTT function, with an MCPTT group identity matching the served MCPTT group ID, then shall consider the MCPTT user to be ineligible for affiliation and skip the rest of the steps; or +- 6) shall consider the MCPTT user to be eligible for affiliation. + +#### 9.2.1.3.9 Receiving subscription to group dynamic data procedure + +Upon receiving a SIP SUBSCRIBE request such that: + +- 1) Request-URI of the SIP SUBSCRIBE request contains the public service identity of the IWF owning the served MCPTT group; +- 2) the SIP SUBSCRIBE request contains an application/vnd.3gpp.mcptt-info+xml MIME body containing the element and the element; +- 3) the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 4) the Event header field of the SIP SUBSCRIBE request contains the "presence" event type; and +- 5) the SIP SUBSCRIBE request contains an application/simple-filter+xml MIME body indicating per-group dynamic data of presence event package notification information according to 3GPP TS 24.379 [29] clause 9.3.2 indicating the same MCPTT group ID as in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; + +then the IWF: + +- 1) shall identify the served MCPTT group ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; +- 2) shall identify the handled MCPTT ID in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP SUBSCRIBE request; +- 3) if the Expires header field of the SIP SUBSCRIBE request is not included or has nonzero value lower than 4294967295, shall send a SIP 423 (Interval Too Brief) response to the SIP SUBSCRIBE request, where the SIP + +423 (Interval Too Brief) response contains a Min-Expires header field set to 4294967295, and shall not continue with the rest of the steps; + +- 4) if an MCPTT group for the served MCPTT group ID does not exist in the IWF, shall reject the SIP SUBSCRIBE request with SIP 403 (Forbidden) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24] and skip the rest of the steps; +- 5) if the IWF does not support receiving a SIP SUBSCRIBE request to the group dynamic data of a group owned by the IWF, the IWF shall generate and send a SIP 501 (Not Implemented) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 6665 [25], and skip the rest of the steps; +- 6) if the handled MCPTT ID is not authorized to subscribe to group dynamic data of the MCPTT group identified by the served MCPTT group ID, shall reject the SIP SUBSCRIBE request with SIP 403 (Forbidden) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 3903 [21] and IETF RFC 3856 [24] and skip the rest of the steps; and +- 7) shall generate a SIP 200 (OK) response to the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3], IETF RFC 6665 [25]. + +For the duration of the subscription, the MCPTT server shall notify subscriber about changes of the information of the served MCPTT ID, as described in clause 9.2.1.3.10. + +#### 9.2.1.3.10 Sending notification of change of group dynamic data procedure + +In order to notify the subscriber identified by the handled MCPTT ID about changes of the per-group dynamic data of the served MCPTT group ID, the IWF: + +- 1) shall consider an MCPTT group information entry such that: + - a) the MCPTT group information entry is in the list of MCPTT group information entries described in clause 9.2.1.3.2; and + - b) the MCPTT group ID of the MCPTT group information entry is equal to the served MCPTT group ID; +- 2) shall generate an application/pidf+xml MIME body indicating per-group dynamic data according to 3GPP TS 24.379 [29], clause 9.3.1 with the following clarifications: + - a) the IWF shall include the "expires" attribute in the element; and +- 3) shall send a SIP NOTIFY request according to 3GPP TS 24.229 [3], and IETF RFC 6665 [25] for the subscription created in clause 9.2.1.3.8. In the SIP NOTIFY request, the IWF shall include the generated application/pidf+xml MIME body indicating per-group dynamic data. + +--- + +## 10 Call signalling - group call + +### 10.1 Prearranged group call + +#### 10.1.2 Client derived procedures + +##### 10.1.2.1 IWF originating procedures + +This clause is referred to by other clauses. + +To establish an MCPTT prearranged group session, the IWF performing the participating role shall generate an initial SIP INVITE request by following the UE originating session procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) if originating an MCPTT emergency group call or originating an MCPTT prearranged group call and the MCPTT emergency state is already set, the IWF performing the participating role shall comply with the procedures in clause 6.4.1.1; +- 2) if originating an MCPTT imminent peril group call, the IWF performing the participating role shall comply with the procedures in clause 6.4.1.6; +- 3) if originating a broadcast group call, the IWF performing the participating role shall include in the application/vnd.3gpp.mcptt-info+xml MIME body the element set to "true" as defined in 3GPP TS 24.379 [29], clause F.1; +- 4) shall include the g.3gpp.mcptt media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP INVITE request according to IETF RFC 3840 [9]; +- 5) shall include an Accept-Contact header field containing the g.3gpp.mcptt media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 6) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 7) should include the "timer" option tag in the Supported header field; +- 8) should include the Session-Expires header field according to IETF RFC 4028 [6]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; +- 9) if the emergency group state for this group is set to "MEG 2: in-progress" or "MEG 4: confirm-pending", the IWF performing the participating role shall include the Resource-Priority header field and comply with the procedures in clause 6.4.1.2; +- 10) if the imminent peril group state for this group is set to "MIG 2: in-progress" or "MIG 4: confirm-pending" shall include the Resource-Priority header field and comply with the procedures in clause 6.4.1.8; +- 11) shall contain an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the element set to a value of "prearranged"; + - b) the element set to the group identity; + - c) the element set to a value determined by the IWF; and + +NOTE 1: How the IWF determines the value of the element is out of scope of the present document. + +- d) if the group identity can be determined to be a TGI and if the IWF performing the participating role can associate the TGI with a MCPTT group ID, the element set to the MCPTT group ID; + +NOTE 2: The MCPTT ID will be inserted into the body of the SIP INVITE request by the referring clause. + +NOTE 3: The text "can associate the TGI with a MCPTT group ID" means that the IWF performing the participating role is able to determine that there is a constituent group of the temporary group that it is a member of. + +NOTE 4: The IWF performing the participating role is informed about temporary groups and regrouping of MCPTT groups that the users homed in the IWF are members of as specified in 3GPP TS 24.481 [16]. + +NOTE 5: If the TGI has several MCPTT groups as constituent groups, where the user homed in the IWF is a member, the IWF performing the participating role selects one of those MCPTT groups. + +- 12) shall include an SDP offer according to 3GPP TS 24.229 [3] with the clarifications given in clause 6.1.1; and +- 13) if an implicit floor request is required, shall indicate this as specified in clause 6.7; and shall skip the rest of the steps. + +On receiving a SIP 2xx response to the SIP INVITE request, the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; +- 2) if the MCPTT emergency group call state is set to "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted" or the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted", the IWF performing the participating role shall perform the actions specified in clause 6.4.1.4; and +- 3) may subscribe to the conference event package as specified in clause 10.3. + +On receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request: + +- 1) if the MCPTT emergency group call state is set to "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted"; or +- 2) if the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted"; + +the IWF performing the participating role shall perform the actions specified in clause 6.4.1.5. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in clause 6.4.1.9. + +#### 10.1.2.2 IWF performing the participating role terminating procedures + +This clause is referenced from other procedures. + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +The IWF performing the participating role: + +- 1) may reject the SIP INVITE request, + +NOTE: The conditions under which the IWF rejects the request are out of scope of the present document. + +- 2) if the SIP INVITE request is rejected in step 1), shall respond towards the controlling MCPTT function either with an appropriate reject code as specified in 3GPP TS 24.229 [3] and warning texts as specified in clause 4.2.2 or with a SIP 480 (Temporarily unavailable) response and skip the rest of the steps of this clause; +- 3) if the SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - a) shall set the MCPTT emergency group state to "MEG 2: in-progress"; + - b) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + - c) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-ge-capable"; otherwise +- 4) if the SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true", shall set the MCPTT imminent peril group state to "MIG 2: in-progress"; +- 5) shall perform the automatic commencement procedures specified in clause 6.2.1 if one of the following conditions are met: + - a) if the SIP INVITE request contains an Answer-Mode header field with the value "Auto" and IWF is configured for automatic commencement mode for receiving the call; + +- b) if the SIP INVITE request contains an Answer-Mode header field with the value "Auto" and IWF is configured to allow automatic commencement mode for receiving the call; or + - c) SIP INVITE request contains an Answer-Mode header field with the value "Manual" and IWF is not configured to allow manual commencement mode for receiving the call; +- 6) shall perform the manual commencement procedures specified in clause 6.2.2 if one of the following conditions are met: + - a) if the SIP INVITE request contains an Answer-Mode header field with the value "Manual" and IWF is configured for manual commencement mode for receiving the call; + - b) if the SIP INVITE request contains an Answer-Mode header field with the value "Manual" and IWF is configured to allow manual commencement mode for receiving the call; or + - c) SIP INVITE request contains an Answer-Mode header field with the value "Automatic" and IWF is not configured to allow automatic commencement mode for receiving the call; and + - 7) when the SIP 200 (OK) response to the SIP INVITE request is sent, may subscribe to the conference event package as specified in clause 10.3. + +### 10.1.2.3 MCPTT upgrade to in-progress emergency or imminent peril + +This clause is referenced from other procedures. + +To upgrade the MCPTT group session to an emergency condition or an imminent peril condition on an MCPTT prearranged group, the IWF performing the participating role shall perform the steps below. + +- 1) if the request is to upgrade the MCPTT group session to an MCPTT emergency call, the IWF performing the participating role: + - a) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.1; and + - b) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.2. +- 2) if the MCPTT user has requested to upgrade the MCPTT group session to an MCPTT imminent peril call, the IWF performing the participating role: + - a) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.6; and + - b) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.8; +- 3) if the SIP re-INVITE request is to be sent within an on-demand session, shall include in the SIP re-INVITE request an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; + +NOTE: The SIP re-INVITE request can be sent within an on-demand session. + +- 4) if an implicit floor request is required, shall indicate this as specified in clause 6.7; and +- 5) shall exit the procedure in the present clause. + +On receiving a SIP 2xx response to the SIP re-INVITE request the IWF performing the participating role: + +- 1) shall perform the actions specified in clause 6.4.1.4. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in clause 6.4.1.9. + +On receiving a SIP 4xx response, SIP 5xx response or a SIP 6xx response to the SIP re-INVITE request the IWF performing the participating role shall perform the actions specified in clause 6.4.1.5. + +### 10.1.2.4 MCPTT in-progress emergency cancel + +This clause is referenced from other procedures. + +To cancel the in-progress emergency condition on a prearranged MCPTT group, the IWF performing the participating role shall generate a SIP re-INVITE request by following the UE originating session procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall, if cancelling an in-progress emergency condition and optionally an MCPTT emergency alert originated by the user homed in the IWF, include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.3; +- 2) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the element set to a value of "prearranged"; and + - b) the element set to the group identity; +- 3) shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request to the MCPTT ID of the calling user; +- 4) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP re-INVITE request according to IETF RFC 3840 [9]; +- 5) shall include in the SIP re-INVITE request an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; +- 6) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.2; and +- 7) shall exit the procedure in the present clause. + +On receiving a SIP 2xx response to the SIP re-INVITE request, the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; +- 2) shall set the MCPTT emergency group state of the group to "MEG 1: no-emergency"; +- 3) shall set the MCPTT emergency group call state of the group to "MEGC 1: emergency-gc-capable"; and +- 4) if the MCPTT emergency alert state is set to "MEA 4: Emergency-alert-cancel-pending", the sent SIP re-INVITE request did not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body and the SIP 2xx response to the SIP request for a priority group call does not contain a Warning header field as specified in clause 4.4 with the warning text containing the mcptt-warn-code set to "149", shall set the MCPTT emergency alert state to "MEA 1: no-alert". + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in clause 6.4.1.9 with the IWF acting as the MCPTT client. + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request: + +- 1) shall set the MCPTT emergency group state as "MEG 2: in-progress"; +- 2) if the SIP 4xx response, SIP 5xx response or SIP 6xx response contains an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true" and the sent SIP re-INVITE request did not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, the IWF performing the participating role shall set the MCPTT emergency alert state to "MEA 3: emergency-alert-initiated"; and +- 3) if the SIP 4xx response, SIP 5xx response or SIP 6xx response did not contain an application/vnd.3gpp.mcptt-info+xml MIME body with an element and did not contain an element, the MCPTT emergency alert (MEA) state shall revert to its value prior to entering the current procedure. + +NOTE: If the in-progress emergency group state cancel request is rejected, the state of the session does not change, i.e. continues with MCPTT emergency group call level priority. + +### 10.1.2.5 MCPTT in-progress imminent peril cancel + +This clause is referenced from other procedures. + +To cancel the in-progress imminent peril condition on a prearranged MCPTT group, the IWF performing the participating role shall generate a SIP re-INVITE request by following the procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.7; +- 2) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.8; +- 3) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the element set to a value of "prearranged"; and + - b) the element set to the group identity; +- 4) shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request to the MCPTT ID of the calling user; +- 5) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP re-INVITE request according to IETF RFC 3840 [9]; +- 6) shall include in the SIP re-INVITE request an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; and +- 7) shall exit the procedure in the present clause. + +On receiving a SIP 2xx response to the SIP re-INVITE request, the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; +- 2) shall set the MCPTT imminent peril group state of the group to "MIG 1: no-imminent-peril"; and +- 3) shall set the MCPTT imminent peril group call state of the group to "MIGC 1: imminent-peril-gc-capable". + +On receiving a SIP 4xx, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request: + +- 1) if the SIP 4xx response, SIP 5xx response or SIP 6xx response: + - a) contains an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true"; or + - b) does not contain an application/vnd.3gpp.mcptt-info+xml MIME body with an element; + +then the IWF performing the participating role shall set the MCPTT imminent peril group state as "MIG 2: in-progress". + +NOTE: This is the case where the IWF performing the participating role requested the cancellation of the MCPTT imminent peril in-progress state and was rejected. + +### 10.1.2.6 Reception of SIP re-INVITE request + +This clause is referred to by other clauses. + +The IWF: + +- 1) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - a) shall set the MCPTT emergency group state to "MEG 2: in-progress"; + - b) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + +- c) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-gc-capable"; +- 2) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - a) shall set the MCPTT imminent peril group state to "MIG 2: in-progress"; + - 3) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "false": + - a) if the element containing the element contains an element set to "false": + - i) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body including an element: + - A) if the MCPTT ID contained in the element is the MCPTT ID of the receiving user homed in the IWF, shall set the MCPTT emergency alert state to "MEA 1: no-alert"; + - b) shall set the MCPTT emergency group state to "MEG 1: no-emergency"; and + - c) if the MCPTT emergency group call state of the group is set to "MEGC 3: emergency-call-granted", shall set the MCPTT emergency group call state of the group to "MEGC 1: emergency-gc-capable"; + - 4) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "false": + - a) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + - b) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-gc-capable"; + - 5) shall accept the SIP re-INVITE request and generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [3]; + - 6) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP 200 (OK) response; + - 7) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP 200 (OK) response; and + - 8) shall include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP re-INVITE request according to 3GPP TS 24.229 [3] with the clarifications given in clause 6.1.2. + +### 10.1.3 IWF participating role procedures + +#### 10.1.3.1 Originating procedures + +##### 10.1.3.1.1 On demand prearranged group call + +In this clause, the IWF originates a prearranged group session on behalf of an LMR user. + +NOTE 1: How the IWF determines the MCPTT ID of the calling user is out of scope of the present document. + +The IWF, performing the originating participating function: + +- 1) if the user identified by the MCPTT ID is not affiliated to the group as determined by clause 9.2.1.2.8 and this is an authorised request for originating a priority call as determined by clause 6.6.2.1.4.2, shall perform the actions specified in clause 9.2.1.2.9 for implicit affiliation; +- 2) shall determine the public service identity of the controlling MCPTT function associated with the group identity of the group on which the call is to be originated; + +NOTE 2: How the IWF discovers the public service identity of the controlling MCPTT function associated with the group identity is out of scope of the present document. + +- 3) shall generate a SIP INVITE request as specified in clause 10.1.2.1; +- 4) shall modify the SIP INVITE request as specified in clause 6.6.2.1.2; +- 5) may insert the calling user's location information into an application/vnd.3gpp.mcptt-location-info+xml MIME body to be included in the outgoing SIP request; +- 6) shall set the Request-URI to the public service identity of the controlling MCPTT function associated with the group identity; +- 7) shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP INVITE request to the MCPTT ID of the calling user; +- 8) shall update the SDP as specified in clause 6.6.2.1.1.1; and +- 9) shall send the SIP INVITE request to the controlling MCPTT function as specified in 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 302 (Moved Temporarily) response to the above SIP INVITE request, the participating IWF function: + +- 1) shall generate a SIP INVITE request as specified in clause 6.6.2.1.5; +- 2) shall include an SDP offer based upon the SDP offer in the SIP INVITE request generated by the IWF in the step above; and +- 3) shall forward the SIP INVITE request according to 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 2xx response in response to the above SIP INVITE request, the IWF performing the participating role: + +NOTE 3: If an element is received, the IWF ignores that element. + +- 1) if the procedures of clause 9.2.1.2.9 for implicit affiliation were performed in the present clause, shall complete the implicit affiliation by performing the procedures of clause 9.2.1.2.10; +- 2) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [6]. +- 3) shall perform the steps for SIP 2xx as specified in clause 10.1.2.1. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the above SIP INVITE request, the participating IWF function: + +- 1) if the implicit affiliation procedures of clause 9.2.1.2.9 were invoked in this procedure, shall perform the procedures of clause 9.2.1.2.11; and +- 2) shall perform the steps for the received SIP 4xx, 5xx or 6xx as specified in clause 10.1.2.1. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF shall perform the steps for the received SIP INFO in clause 10.1.2.1. + +#### 10.1.3.1.2 Sending of a SIP re-INVITE request towards MCPTT controlling function + +Upon a need to send a SIP re-INVITE request for an MCPTT session identifying an on-demand prearranged MCPTT group session, the IWF performing the participating role: + +- 1) if the request is for an upgrade to an in-progress emergency or an imminent peril, shall perform the steps in clause 10.1.2.3; +- 2) if the request is for a cancellation of an in-progress emergency, shall perform the steps in clause 10.1.2.4; +- 3) if the request is for a cancellation of an in-progress imminent peril, shall perform the steps in clause 10.1.2.5; +- 4) shall include the MCPTT ID of the originating user in element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request; + +NOTE 1: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. + +- 5) shall include in the SIP re-INVITE request an SDP offer as specified in clause 6.6.2.1.1; +- 6) if the SIP re-INVITE requires a Resource-Priority header field, shall include a Resource-Priority header field according to 6.4.1.11; and +- 7) shall send the SIP re-INVITE request according to 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 2xx response to the above SIP re-INVITE request, the IWF performing the participating role: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; +- 2) if the request in the present clause above is for an upgrade for emergency or imminent peril, shall follow the procedures for SIP 200 (OK) response as specified in clause 10.1.2.3; +- 3) if the request in the present clause above is for an in-progress emergency cancel, shall follow the procedures for SIP 200 (OK) response as specified in clause 10.1.2.4; and +- 4) if the request in the present clause above is for an in-progress imminent peril cancel, shall follow the procedures for SIP 200 (OK) response as specified in clause 10.1.2.5. + +Upon receipt of a SIP 403 (Forbidden) response to the above SIP re-INVITE request, the IWF performing the participating role shall interact with the media plane as specified in 3GPP TS 29.380 [31]. + +On receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP re-INVITE request, the IWF performing the participating role: + +- 1) if the request in the present clause above is for an upgrade for emergency or imminent peril, shall follow the procedures for SIP 4xx, SIP 5xx and SIP 6xx responses as specified in clause 10.1.2.3; +- 2) if the request in the present clause above is for an in-progress emergency cancel, shall follow the procedures for SIP 4xx, SIP 5xx and SIP 6xx responses as specified in clause 10.1.2.4; or +- 3) if the request in the present clause above is for an in-progress imminent peril cancel, shall follow the procedures for SIP 4xx, SIP 5xx and SIP 6xx responses as specified in clause 10.1.2.5. + +Upon receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing session, the IWF performing the participating role: + +- 1) if the SIP re-INVITE request in the present clause above is for an upgrade for emergency or imminent peril, shall follow the procedures for SIP INFO as specified in clause 10.1.2.3; +- 2) if the SIP re-INVITE request in the present clause above is for an in-progress emergency cancel, shall follow the procedures for SIP INFO as specified in clause 10.1.2.4; or +- 3) if the SIP re-INVITE request in the present clause above is for an in-progress imminent peril cancel, shall follow the procedures for SIP INFO as specified in clause 10.1.2.5. + +### 10.1.3.2 Terminating Procedures + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a "SIP INVITE request for terminating participating MCPTT function", the IWF performing the participating role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The IWF performing the participating role may + +include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14], and shall not continue with the rest of the steps; + +- 2) shall check the presence of the isfocus media feature tag in the URI of the Contact header field and if it is not present then the IWF performing the participating role shall reject the request with a SIP 403 (Forbidden) response with the warning text set to "104 isfocus not assigned" in a Warning header field as specified in clause 4.4, and shall not continue with the rest of the steps; +- 3) may reject the request with a SIP 480 (Temporarily Unavailable) response with the warning text set to "146 T-PF unable to determine the service settings for the called user" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the MCPTT server and shall not continue with the rest of the steps; and + +NOTE: If an element is received, the IWF ignores it. + +- 4) shall perform the steps in 3GPP TS 24.379 [29], clause 10.1.2.1.2. + +### 10.1.3.3 IWF participating role ending group call + +#### 10.1.3.3.1 IWF ending group call on-demand + +When the IWF performing the participating role determines it has to send a SIP BYE request, the IWF shall follow the procedures as specified in clause 6.6.2.1.3. + +### 10.1.3.4 End group call at the IWF performing the participating role + +#### 10.1.3.4.1 Receipt of SIP BYE request for private call on-demand + +Upon receiving a SIP BYE request from the controlling MCPTT function, the IWF performing the participating role shall follow the procedures as specified in clause 6.6.2.2.1. + +### 10.1.3.5 Re-join procedures + +#### 10.1.3.5.1 Originating procedures - on demand prearranged group call + +To rejoin an on demand prearranged group call, the IWF performing the participating role shall follow the procedures specified in clause 10.1.3.1.1 with the clarification that the Request-URI of the SIP INVITE request shall contain a URI of the MCPTT session identity to re-join. + +### 10.1.3.6 Reception of a SIP re-INVITE request for terminating a priority call + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a SIP re-INVITE request for an MCPTT group containing an emergency indication or imminent peril indication, the IWF performing the participating role: + +- 1) shall perform the steps in clause 10.1.2.6; +- 2) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- 3) shall send the SIP 200 (OK) response according to 3GPP TS 24.229 [3]. + +## 10.1.4 IWF Controlling role procedures + +### 10.1.4.1 Originating Procedures + +#### 10.1.4.1.1 INVITE targeted to an MCPTT client + +This clause describes the procedures for inviting an MCPTT user to an MCPTT session. The procedure is initiated by the IWF performing the controlling role as the result of a request from the LMR system or an action in clause 10.1.4.2 or as the result of receiving a SIP 403 (Forbidden) response as described in this clause. + +The IWF performing the controlling role: + +- 1) shall generate a SIP INVITE request as specified in clause 6.6.3.1.1; +- 2) shall set the Request-URI to the public service identity of the terminating participating MCPTT function associated to the MCPTT user to be invited; + +NOTE 1: How the IWF performing the controlling role finds the address of the terminating MCPTT participating function is out of the scope of the current release. + +NOTE 2: If the terminating MCPTT user is part of a partner MCPTT system, then the public service identity can identify an entry point in the partner network that is able to identify the terminating participating MCPTT function. + +- 3) shall set the P-Asserted-Identity header field to the public service identity of the IWF performing the controlling role; + +- 4) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP INVITE request: + +- a) the element set to the MCPTT ID of the terminating user; and +- b) the element set to the group identity; + +NOTE 3: The is already included in the MIME body as a result of calling clause 6.6.3.1.1 in step 1). + +- 5) shall include in the SIP INVITE request an SDP offer based on the SDP offer in the received SIP INVITE request from the originating network according to the procedures specified in TS 24.379 [29], clause 6.3.3.1.1, with the IWF acting as the controlling MCPTT function; +- 6) if the in-progress emergency state of the group is set to a value of "true" the IWF performing the controlling role: + - a) shall include a Resource-Priority header field populated with the values for an MCPTT emergency group call as specified in clause 6.6.3.1.12. + - b) if the IWF needs to set the group state to emergency: + - i) shall include in the outgoing SIP INVITE request in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "true"; and + - ii) if the IWF needs to set an emergency alert and the MCPTT group is authorised for the initiation of MCPTT emergency alerts as determined by the procedures of clause 6.6.3.1.8.1, shall populate the application/vnd.3gpp.mcptt-info+xml MIME body and the application/vnd.3gpp.mcptt-location-info+xml MIME body as specified in clause 6.6.3.1.7. Otherwise, shall set the <>alert-ind> element to a value of "false"; and + - c) if the in-progress imminent peril state of the group is set to a value of "true" shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "false"; +- 7) if the in-progress emergency state of the group is set to a value of "false" and the in-progress imminent peril state of the group is set to a value of "true", the IWF performing the controlling role: + - a) shall include a Resource-Priority header field populated with the values for an MCPTT imminent peril group call as specified in clause 6.6.3.1.12; and + +- b) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true"; and +- 8) shall send the SIP INVITE request towards the terminating network in accordance with 3GPP TS 24.229 [3]. + +Upon receiving a SIP 183 (Session Progress) response containing a Require header field with the option tag "100rel" and containing a P-Answer-State header field with the value "Unconfirmed" in response to the SIP INVITE request the IWF performing the controlling role: + +- 1) shall send a SIP PRACK request towards the MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP 200 (OK) response for the SIP INVITE request the IWF performing the controlling role: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; +- 2) shall send a SIP NOTIFY request to all MCPTT participants with a subscription to the conference event package as specified in clause 10.3; and +- 3) shall increment the local counter of the number of SIP 200 (OK) responses received from invited members, by 1. + +#### 10.1.4.1.2 INVITE targeted to the non-controlling MCPTT function of an MCPTT group + +The IWF performing the controlling role: + +- 1) shall generate a SIP INVITE request as specified in clause 6.6.3.1.1; +- 2) shall set the Request-URI to the public service identity of the non-controlling MCPTT function serving the group identity of the MCPTT group owned by the partner MCPTT system; +- 3) shall set the P-Asserted-Identity to the public service identity of the IWF performing the controlling role; +- 4) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP INVITE request: + - a) the element set to the group identity of the MCPTT group hosted by the non-controlling MCPTT function in the partner MCPTT system; and + - b) the element set to the group identity of the group served by the IWF performing the controlling role; +- 5) shall include the Recv-Info header field set to g.3gpp.mcptt-floor-request; +- 6) void +- 7) shall include in the SIP INVITE request an SDP offer; and +- 8) shall send the SIP INVITE request towards the partner MCPTT system in accordance with 3GPP TS 24.229 [3]. + +Upon receiving SIP 403 (Forbidden) response for the SIP INVITE request, if according to local policy and if: + +- 1) the response contains a Warning header field with the MCPTT warning code "128"; and +- 2) the response contains a P-Refused-URI-List header field and an application/resource-lists+xml MIME body as specified in IETF RFC 5318 [20]; + +NOTE 1: The application/resource-lists+xml MIME body contains MCPTT IDs identifying MCPTT users in a partner MCPTT system that need to be invited to the prearranged group call in case of group regrouping using interrogating method as specified in 3GPP TS 23.379 [2] clause 10.6.2.4.2. + +then the IWF performing the controlling role: + +- 1) shall check if the number of members of the MCPTT group exceeds the maximum participants allowed by the IWF performing the controlling role. If exceeded, the IWF performing the controlling role shall invite only enough members from the application/resource-lists+xml MIME body to reach the maximum allowed by the IWF performing the controlling role; and + +NOTE 2: The IWF determines the maximum number of participants allowed in the prearranged group session. It is operator policy that determines which participants in the application/resource-lists+xml MIME body are invited to the group call. + +- 2) shall invite MCPTT users as specified in this clause using the list of MCPTT IDs in URI-List. + +Upon receiving a SIP 200 (OK) response for the SIP INVITE request the IWF performing the controlling role: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; + +NOTE 3: The procedures executed by the IWF performing the controlling role prior to sending a response to the inviting MCPTT client are specified in clause 10.1.4.2. + +- 2) if at least one of the invited MCPTT clients has subscribed to the conference package, shall subscribe to the conference event package in the non-controlling MCPTT function as specified in clause 10.3; and +- 3) if the 200 (OK) response includes the element set to "floor-taken", shall wait for a SIP INFO request containing a floor request from the non-controlling MCPTT function. + +Upon receiving a SIP INFO request containing a floor request where: + +- 1) the Request-URI contains an MCPTT session ID identifying an ongoing temporary group session; and +- 2) the application/vnd.3gpp.mcptt-info+xml MIME body contains the element with the MCPTT group ID of a MCPTT group invited to the temporary group session; + +then the IWF performing the controlling role: + +- 1) shall send a SIP 200 (OK) response to the SIP INFO request to the non-controlling MCPTT function as specified in 3GPP TS 24.229 [3]; and +- 2) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3. + +#### 10.1.4.2 Terminating Procedures + +In this clause, the IWF is performing the controlling role and is terminating a call from an MCPTT participating function or an MCPTT non-controlling function destined for the IWF. For cases where both the call origination and termination are MCPTT functions, the IWF shall follow 3GPP TS 24.379 [29], clause 10.1.1.4.2, with the IWF acting as the controlling MCPTT function. + +In the procedures in this clause: + +- 1) MCPTT ID in an incoming SIP INVITE request refers to the MCPTT ID of the originating user from the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; +- 2) group identity in an incoming SIP INVITE request refers to the group identity from the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; +- 3) indication of required group members in a SIP 183 (Session Progress) response refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body set to "true" in a SIP 183 (Session Progress) sent by the non-controlling MCPTT function of an MCPTT group; +- 4) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 5) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a "SIP INVITE request for controlling MCPTT function of an MCPTT group", the IWF performing the controlling role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The IWF performing the controlling role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14] and skip the rest of the steps; + +NOTE 1: If the SIP INVITE request contains an emergency indication or an imminent peril indication set to a value of "true" and this is an authorised request for originating an MCPTT emergency group call as determined by clause 6.6.3.1.8.2, or for originating an MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5, the IWF performing the non-controlling role can, according to local policy, choose to accept the request. + +- 2) shall determine if the media parameters are acceptable and if not reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; +- 3) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if: + - a) an Accept-Contact header field does not include the g.3gpp.mcptt media feature tag; or + - b) an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; +- 4) if received SIP INVITE request includes an application/vnd.3gpp.mcptt-info+xml MIME body with an element included or an element included, shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17 with the IWF acting as the controlling MCPTT function; +- 5) shall retrieve the necessary group document(s) and carry out initial processing as specified in 3GPP TS 24.379 [29], clause 6.3.5.2 with the IWF acting as the controlling MCPTT function; +- 6) if the result of the initial processing in 3GPP TS 24.379 [29], clause 6.3.5.2 was: + - a) that authorization of the MCPTT ID at a non-controlling MCPTT function of an MCPTT group is required, perform the actions in clause 6.6.3.1.8.7 and do not continue with the rest of the steps in this clause; and + - b) that a SIP 3xx, 4xx, 5xx or 6xx response to the "SIP INVITE request for controlling MCPTT function of an MCPTT group" has been sent, do not continue with the rest of the steps in this clause; +- 7) shall perform the actions as described in 3GPP TS 24.379 [29], clause 6.3.3.2.2 with the IWF acting as the controlling MCPTT function; +- 8) shall maintain a local counter of the number of SIP 200 (OK) responses received from invited members and shall initialise this local counter to zero; +- 9) shall determine if an MCPTT group call for the group identity is already ongoing by determining if an MCPTT session identity has already been allocated for the group call and the MCPTT session is active; +- 10) if the SIP INVITE request contains an unauthorised request for an MCPTT emergency group call as determined by clause 6.6.3.1.8.2: + - a) shall reject the SIP INVITE request with a SIP 403 (Forbidden) response as specified in clause 6.6.3.1.9; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 11) if the SIP INVITE request contains an unauthorised request for an MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response with the following clarifications: + - a) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the element set to a value of "false"; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 12) void +- 13) if the received SIP INVITE request contains an application/vnd.3gpp.mcptt-location-info+xml MIME body with a element included in the root element, the IWF performing the controlling role can remember the location information contained in the root element; +- 14) if the MCPTT group call is not ongoing then: + - a) if: + +- i) the user identified by the MCPTT ID is not affiliated to the group identity contained in the SIP INVITE request as specified in 3GPP TS 24.379 [29], clause 6.3.6, with the IWF acting as the controlling MCPTT function; +- ii) the group identity contained in the SIP INVITE request is not a constituent MCPTT group ID; +- iii) the received SIP INVITE request does not contain an emergency indication or imminent peril indication; or +- iv) the received SIP INVITE request is an authorised request for an MCPTT emergency group call as determined by clause 6.6.3.1.8.2 or MCPTT imminent peril group call as determined by steps clause 6.6.3.1.8.5 and is determined to not be eligible for implicit affiliation as specified in clause 9.2.1.3.6; + +then shall return a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server, and skip the rest of the steps below; + +- b) if the user identified by the MCPTT ID is not authorised to initiate the prearranged group session, shall send a SIP 403 (Forbidden) response with the warning text set to: "119 user is not authorised to initiate the group call" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server and skip the rest of the steps below; + +NOTE 2: How the IWF determines whether the MCPTT user is authorized to initiate a prearranged group is out of scope of the present document. + +- c) if the received SIP INVITE request contains an authorised request for an MCPTT emergency group call as determined by clause 6.6.3.1.8.2 or MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5 and the MCPTT user is eligible to be implicitly affiliated with the MCPTT group as determined as determined in step 13) a) iv) above, shall perform the implicit affiliation as specified in clause 9.2.1.3.7; +- d) void +- e) shall create a prearranged group session and allocate an MCPTT session identity for the prearranged group call, and shall handle timer TNG3 (group call timer) as specified in clause 6.6.3.5; +- f) if the group identity in the "SIP INVITE request for controlling MCPTT function of an MCPTT group" is a TGI: + - i) shall for each of the constituent MCPTT groups homed in the IWF: + - A) invite each member of the IWF homed group to the group session; and + - B) interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; and + - ii) shall for each of the constituent MCPTT groups homed on the partner MCPTT system generate a SIP INVITE request for the MCPTT group identity homed on the partner MCPTT system as specified in clause 10.1.4.1.2; +- g) if the group identity in the "SIP INVITE request for controlling MCPTT function of an MCPTT group" is an MCPTT group ID: + - i) shall determine the members to invite to the prearranged MCPTT group call as specified in clause 6.6.5.3; + - ii) if necessary, shall start timer TNG1 (acknowledged call setup timer) according to the conditions stated in clause 6.6.3.3; + - iii) if the received SIP INVITE request includes an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true": + - A) shall cache the information that the MCPTT user has initiated an MCPTT emergency call; + - B) if the received SIP INVITE contains an alert indication set to a value of "true" and this is an authorised request for an MCPTT emergency alert meeting the conditions specified in clause 6.6.3.1.8.1, shall cache the information that the MCPTT user has initiated an MCPTT emergency alert; and + +- C) if the in-progress emergency state of the group is set to a value of "false": + - I) shall set the value of the in-progress emergency state of the group to "true"; and + - II) shall start timer TNG2 (in-progress emergency group call timer) and handle its expiry as specified in clause 6.6.3.1.10; + - iv) if the in-progress emergency state of the group is set to a value of "false" and if the received SIP INVITE request contains an imminent peril indication set to a value of "true", the controlling MCPTT function: + - A) shall cache the information that the MCPTT user has initiated an MCPTT imminent peril call; and + - B) if the in-progress imminent peril state of the group is set to a value of "false", shall set the in-progress imminent peril state of the group to a value of "true"; + - v) shall invite each group member determined in step 13)g)i) above, to the group session, as specified in clause 10.1.4.1.1; and + - vi) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; and +- 15) if the MCPTT group call is ongoing then: +- a) if: + - i) the user identified by the MCPTT ID in the SIP INVITE request is not affiliated to the group identity contained in the SIP INVITE request as specified in 3GPP TS 24.379 [29] clause 6.3.6; + - ii) the group identity contained in the SIP INVITE request is not a constituent MCPTT group ID; + - iii) the received SIP INVITE request does not contain an emergency indication or imminent peril indication; or + - iv) the received SIP INVITE request is an authorised request for an MCPTT emergency group call as determined by clause 6.6.3.1.8.2 or MCPTT imminent peril group call as determined clause 6.6.3.1.8.5 and is determined to not be eligible for implicit affiliation as specified in clause 9.2.1.3.6; + +then shall return a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server, and skip the rest of the steps below; + - b) if the user identified by the MCPTT ID in the SIP INVITE request is not authorised to join the prearranged group session as specified in clause 6.6.5.2, shall send a SIP 403 (Forbidden) response with the warning text set to "121 user is not allowed to join the group call" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the MCPTT server and skip the rest of the steps below; + - c) void + - d) if the maximum number of participants allowed by the IWF performing the controlling role is already reached: + - i) if, according to local policy, the user identified by the MCPTT ID in the SIP INVITE request is deemed to have a higher priority than an existing user in the group session, may remove a participant from the session by following clause 10.1.4.4.3, and skip the next step; and +- NOTE 3: The local policy for deciding whether to admit a user to a call that has reached its maximum amount of participants can include the user's priority and the participant type of the user as well as other information about the user. The local policy decisions can also include taking into account whether the imminent-peril indicator or emergency indicator was received in the SIP INVITE request. +- ii) shall return a SIP 486 (Busy Here) response with the warning text set to "122 too many participants" to the originating network as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the MCPTT server and skip the rest of the steps; +- e) if the received SIP INVITE request contains an authorised request for an MCPTT emergency group call as determined by clause 6.6.3.1.8.2 or MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5 + +- and the MCPTT user is eligible to be implicitly affiliated with the MCPTT group as determined in step 14) a) iv) above, shall perform the implicit affiliation as specified in clause 9.2.1.3.7; +- f) if the received SIP INVITE request includes an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true": + - i) shall cache the information that the MCPTT user has initiated an MCPTT emergency call; + - ii) if the received SIP INVITE contains an alert indication set to a value of "true" and this is an authorised request for an MCPTT emergency alert meeting the conditions specified in clause 6.6.3.1.8.1, shall cache the information that the MCPTT user has initiated an MCPTT emergency alert; + - iii) if the in-progress emergency state of the group is set to a value of "false": + - A) shall set the value of the in-progress emergency state of the group to "true"; + - B) shall start timer TNG2 (in-progress emergency group call timer) and handle its expiry as specified in clause 6.6.3.1.10; and + - C) shall generate SIP re-INVITE requests for the MCPTT emergency group call to the other call participants of the MCPTT group as specified in clause 6.6.3.1.3; + - iv) if the in-progress imminent peril state of the group is set to a value of "true": + - A) for each of the other affiliated member of the group generate a SIP MESSAGE request notification of the MCPTT user's imminent peril indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, setting the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; and + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; and + - v) upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; + - g) if the in-progress emergency state of the group is set to a value of "false" and if the SIP INVITE request contains an imminent peril indication set to a value of "true", the controlling MCPTT function: + - i) shall cache the information that the MCPTT user has initiated an MCPTT imminent peril call; and + - ii) if the in-progress imminent peril state of the group is set to a value of "false": + - A) shall set the in-progress imminent peril state of the group to a value of "true"; + - B) shall generate SIP re-INVITE requests for the MCPTT imminent peril group call to the other call participants of the MCPTT group as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.15; and + - C) upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the controlling MCPTT function shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - iii) if the in-progress imminent peril state of the group is set to a value of "true": + - A) for each of the other affiliated member of the group generate a SIP MESSAGE request notification of the MCPTT user's imminent peril indication as specified in 3GPP TS 24.379 [29] clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, setting the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; and + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; + - h) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.379 [29], clause 6.3.3.2.3.2; + - i) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; + - j) shall include in the SIP 200 (OK) response with the warning text set to "123 MCPTT session already exists" as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; + +- k) if the received SIP re-INVITE request contains an alert indication set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; +- l) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and if the in-progress emergency state of the group is set to a value of "true", shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; + +NOTE 4: In this case, the request was for an imminent peril call but a higher priority MCPTT emergency call was already in progress on the group. Hence, the imminent peril call request aspect of the request is denied but the request is granted with emergency level priority. + +- m) shall interact with media plane as specified in 3GPP TS 29.380 [31] clause 6.3; + +NOTE 5: Resulting media plane processing is completed before the next step is performed. + +- n) shall send the SIP 200 (OK) response towards the inviting MCPTT client or inviting non-controlling MCPTT function according to 3GPP TS 24.229 [3]; +- o) shall generate a notification to the MCPTT clients, which have subscribed to the conference event package that the inviting MCPTT User has joined in the MCPTT group session, as specified in clause 6.6.3.4; + +NOTE 6: As a group document can potentially have a large content, the IWF performing the controlling role can notify using content-indirection as defined in IETF RFC 4483 [17]. + +- p) shall send a SIP NOTIFY request to each MCPTT client according to 3GPP TS 24.229 [3]; +- q) Upon receiving a SIP ACK to the above SIP 200 (OK) response and the SIP 200 (OK) response contained a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server with the warning text containing the mcptt-warn-code set to "149", shall follow the procedures in clause 6.6.3.1.11; and +- r) shall not continue with the rest of the clause. + +Upon receiving a SIP 183 (Session Progress) response to the SIP INVITE request specified in clause 10.1.4.1 containing a P-Answer-State header field with the value "Unconfirmed" as specified in IETF RFC 4964 [19], the timer TNG1 (acknowledged call setup timer) is not running, the controlling MCPTT function supports media buffering and the SIP final response is not yet sent to the inviting MCPTT client: + +- 1) shall generate a SIP 200 (OK) response to SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.3.2, with the IWF acting as the controlling MCPTT function; +- 2) shall include the warning text set to "122 too many participants" as specified in 3GPP TS 24.379 [29] clause 4.4 with the IWF acting as the MCPTT server, in the SIP 200 (OK) response, if the prearranged MCPTT group has more than the maximum number of members as allowed by the IWF; +- 3) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; +- 4) shall include a P-Answer-State header field with the value "Unconfirmed"; +- 5) if the SIP INVITE request contains an alert indication set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; +- 6) if the received SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and if the in-progress emergency state of the group is set to a value of "true", shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; + +- 7) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; + +NOTE 7: Resulting user plane processing is completed before the next step is performed. + +- 8) shall send the SIP 200 (OK) response towards the inviting MCPTT client according to 3GPP TS 24.229 [3]; + +- 9) shall generate a notification to the MCPTT clients, which have subscribed to the conference event package that the inviting MCPTT User has joined in the MCPTT group session, as specified in clause 6.6.3.4; and + +NOTE 8: As a group document can potentially have a large content, the controlling MCPTT function can notify using content-indirection as defined in IETF RFC 4483 [17]. + +- 10) shall send a SIP NOTIFY request to each MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP 183 (Session Progress) response for a SIP INVITE request as specified in clause 10.1.4.1.2 containing an indication of required group members, the timer TNG1 (acknowledged call setup timer) is running and all SIP 200 (OK) responses have been received to all SIP INVITE requests sent to MCPTT clients specified in clause 10.1.4.1.1, then the IWF performing the controlling role shall wait until the SIP 200 (OK) response has been received to the SIP INVITE request specified in clause 10.1.4.1.2 before generating a SIP 200 (OK) response to the "SIP INVITE request for controlling MCPTT function of an MCPTT group". + +Upon receiving a SIP 200 (OK) response for a SIP INVITE request as specified in clause 10.1.4.1 that was sent to an affiliated and required group member; and + +- 1) if the MCPTT ID in the SIP 200 (OK) response matches to the MCPTT ID in the corresponding SIP INVITE request; +- 2) there are no outstanding SIP 200 (OK) responses to SIP INVITE requests which were sent to affiliated and required group members; and +- 3) there is no outstanding SIP 200 (OK) response to a SIP INVITE request sent in clause 10.1.4.1.2 where the SIP 183 (Session Progress) response contained an indication of required group members; + +the IWF performing the controlling role: + +- 1) shall stop timer TNG1 (acknowledged call setup timer) as described in clause 6.6.3.3; +- 2) shall generate SIP 200 (OK) response to the SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.3.2, with the IWF acting as the controlling MCPTT function, before continuing with the rest of the steps; +- 3) shall include the warning text set to "122 too many participants" as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server in the SIP 200 (OK) response, if all members were not invited because the prearranged MCPTT group has been exceeded the maximum number of members as allowed by the IWF; +- 4) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; + +- 5) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; + +NOTE 9: Resulting media plane processing is completed before the next step is performed. + +- 6) shall send a SIP 200 (OK) response to the inviting MCPTT client according to 3GPP TS 24.229 [3]; + +- 7) shall generate a notification to the MCPTT clients, which have subscribed to the conference event package that the inviting MCPTT user has joined in the MCPTT group session, as specified in clause 6.6.3.4; and + +NOTE 10: As a group document can potentially have a large content, the IWF performing the controlling role can notify using content-indirection as defined in IETF RFC 4483 [17]. + +- 8) shall send the SIP NOTIFY request to the MCPTT clients according to 3GPP TS 24.229 [3]. + +Upon: + +- 1) receiving a SIP 200 (OK) response for a SIP INVITE request as specified in clause 10.1.4.1; + +- 2) the timer TNG1 (acknowledged call setup timer) is not running; +- 3) the local counter of the number of SIP 200 (OK) responses received from invited members is equal to the value of the minimum number of participants that the IWF requires to start a call; +- 4) the IWF performing the controlling role supports media buffering; and +- 5) the SIP final response has not yet been sent to the inviting MCPTT client; + +the IWF performing the controlling role according to local policy: + +- 1) shall generate SIP 200 (OK) response to the SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.2, with the IWF acting as the controlling MCPTT function; +- 2) shall include the warning text set to "122 too many participants" as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server in the SIP 200 (OK) response, if all members were not invited because the prearranged MCPTT group has exceeded the number of members as allowed by the IWF performing the controlling role; +- 3) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; +- 4) if the SIP INVITE request contains an alert indication set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; +- 5) if the received SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and if the in-progress emergency state of the group is set to a value of "true", shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server; +- 6) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.3; + +NOTE 11:Resulting media plane processing is completed before the next step is performed. + +- 7) shall send a SIP 200 (OK) response to the inviting MCPTT client according to 3GPP TS 24.229 [3]; +- 8) shall generate a notification to the MCPTT clients, which have subscribed to the conference event package that the inviting MCPTT user has joined in the MCPTT group session, as specified in clause 6.6.3.4; and + +NOTE 12:As a group document can potentially have a large content, the IWF performing the controlling role can notify using content-indirection as defined in IETF RFC 4483 [17]. + +- 9) shall send the SIP NOTIFY request to the MCPTT clients according to 3GPP TS 24.229 [3]. + +Upon expiry of timer TNG1 (acknowledged call setup timer), if there are outstanding SIP 200 (OK) responses to SIP INVITE requests sent to affiliated and required group members, the IWF performing the controlling role shall follow the procedures specified in clause 6.6.3.3. + +If timer TNG1 (acknowledged call setup timer) is running and a final SIP 4xx, 5xx or 6xx response is received from an affiliated and required group member, the IWF performing the controlling role shall follow the relevant procedures specified in clause 6.6.3.3. + +If: + +- 1) timer TNG1 (acknowledged call setup timer) is not running; +- 2) the local counter of the number of SIP 200 (OK) responses received from invited members is equal to the value of the minimum number of group members required by the IWF to start a call; and +- 3) a final SIP 4xx, 5xx or 6xx response is received from an invited MCPTT client; + +then the IWF performing the controlling role shall perform one of the following based on policy: + +- 1) send the SIP final response towards the inviting MCPTT client, according to 3GPP TS 24.229 [3], if a SIP final response was received from all the other invited MCPTT clients and the SIP 200 (OK) response is not yet sent; or +- 2) remove the invited MCPTT client from the MCPTT Session as specified in clause 6.6.3.1.2, if a SIP final response other than 2xx or 3xx was received from all the invited MCPTT clients and the SIP 200 (OK) response is already sent. The IWF performing the controlling role may invite an additional member of the prearranged MCPTT group as specified in clause 10.1.4.1 that has not already been invited, if the prearranged MCPTT group has less than the maximum number of members as allowed by the IWF, and all members have not yet been invited. + +If the group identity in the "SIP INVITE request for controlling MCPTT function of an MCPTT group" is a TGI and constituent MCPTT groups were invited as specified in clause 10.1.4.1.2 and, + +- 1) if all non-controlling MCPTT functions hosting the constituent MCPTT groups have responded with a SIP 2xx, SIP 3xx, SIP 4xx, SIP 5xx or SIP 6xx responses to the "SIP INVITE request for non-controlling MCPTT function of an MCPTT group"; and +- 2) if all expected SIP INFO requests containing a floor request are received; + +then the IWF performing the controlling role shall indicate to the media plane that all final responses are received. + +NOTE 13:If the SIP 200 (OK) response to the SIP INVITE request for non-controlling MCPTT function of an MCPTT group included the application/vnd.3gpp.mcptt-info+xml MIME body with the element set to "floor-taken", the controlling MCPTT function expects that the non-controlling MCPTT functions sends a SIP INFO request containing a floor request. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, and the SIP 200 (OK) response was sent with the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29] clause 4.4, with the IWF acting as the MCPTT server, the controlling MCPTT function shall follow the procedures in clause 6.6.3.1.11. + +#### 10.1.4.3 End group call at the IWF performing the terminating controlling role + +Upon receiving a SIP BYE request the IWF performing the controlling role shall follow the procedures as specified in clause 6.6.3.2.1. + +#### 10.1.4.4 End group call initiated by the IWF performing the controlling role + +##### 10.1.4.4.1 General + +This clause describes the procedures of each functional entity for ending the group call initiated by the IWF performing the controlling role. + +##### 10.1.4.4.2 SIP BYE request for releasing MCPTT session for a group call + +When the MCPTT session for group call needs to be released as specified in clause 6.6.7.1, the IWF performing the controlling role, shall follow the procedures in clause 6.6.3.1.2. + +##### 10.1.4.4.3 SIP BYE request towards a MCPTT client + +When an MCPTT client needs to be removed from the MCPTT session (e.g. due to de-affiliation or admitting a higher priority user), the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.2. + +After successful removing the MCPTT client from the MCPTT session, the IWF performing the controlling role may generate a notification to the MCPTT clients, which have subscribed to the conference event package that an MCPTT user has been removed from the MCPTT session, as specified in clause 6.6.3.4 and send the SIP NOTIFY request to the MCPTT client according to 3GPP TS 24.229 [3]. + +## 10.1.4.5 Re-join procedures + +### 10.1.4.5.1 Terminating procedures + +Upon receipt of a SIP INVITE request that includes an MCPTT session identity of an ongoing MCPTT session in the Request-URI the IWF performing the controlling role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The IWF performing the controlling role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14]. Otherwise, continue with the rest of the steps; + +NOTE 1: if the SIP INVITE request contains an emergency indication or an imminent peril indication set to a value of "true" and this is an authorised request for originating an MCPTT emergency group call as determined by clause 6.6.3.1.8.2, or for originating an MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5, with the IWF performing the controlling role can according to local policy choose to accept the request. + +- 2) shall reject the SIP request with a SIP 404 (Not Found) response if the MCPTT group call represented by the MCPTT session identity in Request-URI header is not present; +- 3) shall validate that the received SDP offer includes at least one media stream for which the media parameters and at least one codec or media format is acceptable by the IWF performing the controlling role and if not, reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps Otherwise, continue with the rest of the steps; +- 4) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if: + - a) an Accept-Contact header field does not include the g.3gpp.mcptt media feature tag; or + - b) an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; +- 5) shall determine the MCPTT ID of the calling user; +- 6) if the user identified by the MCPTT ID is not authorised to join the prearranged group session as specified in clause 6.6.5.2, shall send a SIP 403 (Forbidden) response with the warning text set to "121 user is not authorised to join the group call" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function. Otherwise continue with the rest of the steps below; +- 7) shall perform the actions on receipt of an initial SIP INVITE request as described in 3GPP TS 24.379 [29], clause 6.3.3.2.2, with the IWF acting as the controlling MCPTT function; +- 8) if the user identified by the MCPTT ID is not affiliated to the MCPTT group ID associated with the MCPTT session identity as specified in clause 6.6.5.2, shall return a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in clause 4.4; +- 9) shall check if a Resource-Priority header field is included in the incoming SIP INVITE request and may apply any preferential treatment to the SIP request as specified in 3GPP TS 24.229 [3]; +- 10) if as specified in 3GPP TS 24.481 [16] is already reached: + - a) if, according to local policy, the user identified by the MCPTT ID in the SIP INVITE request is deemed to have a higher priority than an existing user in the group session, may remove a participant from the session by following clause 10.1.4.4.3, and skip the next step; and + +NOTE 2: The local policy for deciding whether to admit a user to a call that has reached its maximum amount of participants can include the and the of the user as well as other information of the user from the group document as specified in 3GPP TS 24.481 [16]. The local policy decisions can also include taking into account whether the imminent-peril indicator or emergency indicator was received in the SIP INVITE request. + +- b) shall return a SIP 486 (Busy Here) response with the warning text set to "122 too many participants" to the originating network as specified in 3GPP TS 24.379 [29], clause 4.4 with the IWF acting as the controlling MCPTT function. Otherwise, continue with the rest of the steps; + +- 11) shall generate a SIP 200 (OK) response as specified in 3GPP TS 24.379 [29], clause 6.3.3.2.3.2, with the IWF acting as the controlling MCPTT function; +- 12) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; +- 13) shall interact with media plane as specified in 3GPP TS 29.380 [31] clause 6.3; + +NOTE 3: Resulting media plane processing is completed before the next step is performed. + +- 14) shall send the SIP 200 (OK) response towards the inviting MCPTT client according to 3GPP TS 24.229 [3]; +- 15) shall generate a notification to the MCPTT clients, which have subscribed to the conference event package that the inviting MCPTT User has joined in the MCPTT group session, as specified in clause 6.6.3.4; and + +NOTE 4: As a group document can potentially have a large content, the IWF performing the controlling role can notify using content-indirection as defined in IETF RFC 4483 [17]. + +- 16) shall send a SIP NOTIFY request to each MCPTT client according to 3GPP TS 24.229 [3]. + +#### 10.1.4.6 Late call entry initiated by IWF performing the controlling role + +When the IWF performing the controlling role is notified that an MCPTT client is newly affiliated or comes back from out of coverage, the IWF performing the controlling role shall invite the MCPTT client to join an ongoing MCPTT group call by following the procedures specified in clause 10.1.4.1. + +NOTE: How the IWF is informed when an MCPTT client is coming back from out of coverage is out of scope of present document. + +#### 10.1.4.7 Receipt of a SIP re-INVITE request + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a SIP re-INVITE request for an MCPTT session identity identifying an on-demand prearranged MCPTT group session, the IWF performing the controlling role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP re-INVITE request with a SIP 500 (Server Internal Error) response. The IWF performing the controlling role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14] and skip the rest of the steps; + +NOTE 1: If the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true", the IWF performing the controlling role can choose to accept the request. + +- 2) if received SIP re-INVITE request includes an application/vnd.3gpp.mcptt-info+xml MIME body with an element included or an element included, shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17, with the IWF acting as the controlling MCPTT function; +- 3) if the received SIP re-INVITE request contains an unauthorised request for an MCPTT emergency call as determined by clause 6.6.3.1.8.2: + - a) shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response as specified in clause 6.6.3.1.9; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 4) if the received SIP re-INVITE request contains an imminent peril indication set to "true" for an MCPTT imminent peril group call and this is an unauthorised request for an MCPTT imminent peril group call as + +determined by clause 6.6.3.1.8.6, shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response with the following clarifications: + +- a) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the element set to a value of "false"; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 5) if a Resource-Priority header field is included in the received SIP re-INVITE request: +- a) if the Resource-Priority header field is set to the value indicated for emergency calls and the SIP re-INVITE request does not contain an emergency indication and the in-progress emergency state of the group is set to a value of "false", shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response and skip the rest of the steps; and + - b) if the Resource-Priority header field is set to the value indicated for imminent peril calls and the SIP re-INVITE request does not contain an imminent peril indication and the in-progress imminent peril state of the group is set to a value of "false", shall reject the SIP INVITE request with a SIP 403 (Forbidden) response and skip the rest of the steps; +- 6) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and is an authorised request to initiate an MCPTT emergency group call as determined by clause 6.6.3.1.8.2, the IWF performing the controlling role: +- i) shall cache the MCPTT ID of the MCPTT user that has initiated an MCPTT emergency call; + - ii) if the received SIP INVITE contains an alert indication set to a value of "true" and this is an authorised request for an MCPTT emergency alert meeting the conditions specified in clause 6.6.3.1.8.1, shall cache the MCPTT ID of the MCPTT user that has initiated an MCPTT emergency alert; + - iii) if the in-progress emergency state of the group is set to a value of "true": + - A) for each of the other affiliated MCPTT members of the group generate a SIP MESSAGE request notification of the MCPTT user's emergency indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, setting the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; and + - C) if the in-progress imminent peril state of the group is set to a value of "true", shall set it to a value of "false"; and + - iv) if the in-progress emergency state of the group is set to a value of "false": + - A) shall set the value of the in-progress emergency state of the group to "true"; + - B) shall start timer TNG2 (in-progress emergency group call timer) and handle its expiry as specified in clause 6.6.3.1.10; +- NOTE 2: The interactions of TNG2 with the TNG3 (group call timer) are explained in clause 6.6.3.5.2. +- C) shall generate SIP re-INVITE requests for the MCPTT emergency group call to the other MCPTT participants of the MCPTT group call as specified in clause 6.6.3.1.3; + - D) shall send the SIP re-INVITEs towards the other MCPTT participants of the MCPTT group call; and + - E) upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; +- 7) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is an unauthorised request for an MCPTT emergency group call cancellation as determined by clause 6.6.3.1.8.4: +- a) shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response; + +- b) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with an element set to a value of "true"; + - c) if an element of the application/vnd.3gpp.mcptt-info+xml MIME body is included in the SIP re-INVITE request set to "false", and there is an outstanding MCPTT emergency alert for the MCPTT user, shall include in the application/vnd.3gpp.mcptt-info+xml MIME body an element set to a value of "true"; and + - d) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 8) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is determined to be an authorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.10 and the in-progress emergency state of the group to is set to a value of "true" the IWF performing the controlling role: +- a) shall set the in-progress emergency group state of the group to a value of "false"; + - b) shall clear the cache of the MCPTT ID of the MCPTT user as having an outstanding MCPTT emergency group call; + - c) if an element of the application/vnd.3gpp.mcptt-info+xml MIME body is included and set to "false" and is determined to be an authorised request for an MCPTT emergency alert cancellation as specified in clause 6.6.3.1.8.3 and there is an outstanding MCPTT emergency alert for the MCPTT user shall: + - i) if the received SIP re-INVITE request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, clear the cache of the MCPTT ID of the MCPTT user identified by the element as having an outstanding MCPTT emergency alert; or + - ii) if the received SIP re-INVITE request does not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, clear the cache of the MCPTT ID of the sender of the SIP re-INVITE request as having an outstanding MCPTT emergency alert; + - d) shall generate SIP re-INVITE requests to the MCPTT participants in the group call as specified in clause 6.6.3.1.3. The MCPTT controlling function: + - i) for each of the other MCPTT participants in the group call shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - ii) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; +- NOTE 3: Clause 6.6.3.1.3 will inform the group call (MCPTT) participants of the cancellation of the MCPTT group's in-progress emergency state and the cancellation of the MCPTT emergency alert if applicable. +- e) shall stop timer TNG2 (in-progress emergency group call timer); and +- NOTE 4: The interactions of TNG2 with the TNG3 (group call timer) are explained in clause 6.6.3.5.2; +- f) for each of the affiliated MCPTT members of the group that are not participating in the call: + - i) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function; + - ii) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; + - iii) if indicated above in step 8) c), set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; and + - iv) send the SIP MESSAGE request according to 3GPP TS 24.229 [3]; +- 9) if the received SIP re-INVITE request contains an imminent peril indication and the in-progress emergency group state of the group is set to a value of "false", shall perform the procedures specified in clause 10.1.4.8 and skip the rest of the steps. + +Upon receiving a SIP 200 (OK) response to a SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; + +- 1) shall generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [3]; +- 2) shall include in the SIP 200 (OK) response an SDP answer according to 3GPP TS 24.229 [3] with the clarifications specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; +- 3) shall include the "norefersub" option tag in a Supported header field according to IETF RFC 4488 [12]; +- 4) shall include the "tdialog" option tag in a Supported header field according to IETF RFC 4538 [13]; +- 5) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and if this is an unauthorised request for an MCPTT emergency alert as determined by clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; +- 6) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and if this is an unauthorised request for an MCPTT emergency alert cancellation as determined by clause 6.6.3.1.8.3, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; +- 7) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true", this is an authorised request for an MCPTT imminent peril group call and the in-progress emergency state of the group is set to a value of "true", shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; + +NOTE 5: In this case, the request was for an imminent peril call but a higher priority MCPTT emergency call was already in progress on the group. Hence, the imminent peril call request aspect of the request is denied but the request is granted with emergency level priority. + +- 8) shall interact with media plane as specified in 3GPP TS 29.380 [31]; and +- 9) shall send the SIP 200 (OK) response towards the MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, and the SIP 200 (OK) response was sent with the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function, the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.11. + +Upon receipt of a SIP 2xx response for an outgoing SIP MESSAGE request, shall handle according to 3GPP TS 24.229 [3]. + +#### 10.1.4.8 Handling of a SIP re-INVITE request for imminent peril session + +This procedure is initiated by the IWF performing the controlling role as the result of an action in clause 10.1.4.7. + +In the procedures in this clause: + +- 1) imminent peril indication in an incoming SIP re-INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +When the IWF performing the controlling role receives a SIP re-INVITE request with an imminent peril indication set to "true", the IWF performing the controlling role: + +- 1) if the in-progress emergency state of the group is set to a value of "false" and if the SIP re-INVITE request contains an imminent peril indication set to a value of "true" or the in-progress imminent peril state of the group to "true", the IWF performing the controlling role shall: + +NOTE 1: The calling procedure has already determined that this is not an unauthorised request for an MCPTT imminent peril call, therefore that check does not need to be repeated in the current procedure. + +- a) if the in-progress imminent peril state of the group is set to a value of "true" and the MCPTT user is indicating a new imminent peril indication: + - i) for each of the other affiliated MCPTT member of the group generate a SIP MESSAGE request notification of the MCPTT user's imminent peril indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, with the following clarifications; + - A) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; and + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; + - b) if the in-progress imminent peril state of the group is set to a value of "false"; + - i) set the value of the in-progress imminent peril state of the group to "true"; + - ii) generate SIP re-INVITE requests for the MCPTT imminent peril group call to MCPTT participants in the MCPTT group call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function; + - iii) send the SIP re-INVITES to all of the other MCPTT participants in the MCPTT group call; + - iv) for each of the affiliated MCPTT members of the group not participating in the group call, generate a SIP MESSAGE request notification of the MCPTT user's imminent peril indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, with the following clarifications; + - A) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; and + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; and + - c) cache the information that the MCPTT user has initiated an MCPTT imminent peril call; +- 2) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is an unauthorised request for an MCPTT imminent peril group call cancellation as determined by clause 6.6.3.1.8.6 shall: + - a) reject the SIP re-INVITE request with a SIP 403 (Forbidden) response to the SIP re-INVITE request; and + - b) include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the element set to a value of "false"; + - c) send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3]; and + - d) skip the rest of the steps; + - 3) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is determined to be an authorised request for an MCPTT imminent peril call cancellation as specified in clause 6.6.3.1.8.6 and the in-progress imminent peril state of the group to is set to a value of "true" the IWF performing the controlling role shall: + - a) set the in-progress imminent peril state of the group to a value of "false"; + - b) cache the information that the MCPTT user no longer has an outstanding MCPTT imminent peril group call; + - c) generate SIP re-INVITES requests to the other MCPTT participants in the MCPTT group call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function. The MCPTT controlling function: + - i) for each MCPTT participant shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + +- ii) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role interact with the media plane as specified in 3GPP TS 29.380 [31]; and + +NOTE 2: 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function, will inform the affiliated and joined MCPTT members of the cancellation of the MCPTT group's in-progress emergency state and the cancellation of the MCPTT emergency alert if applicable. + +- d) for each of the affiliated MCPTT members of the group not participating in the call shall: + - i) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's imminent peril call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function; + - ii) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; and + - iii) send the SIP MESSAGE request according to 3GPP TS 24.229 [3]; +- 4) shall include in the SIP 200 (OK) response an SDP answer according to 3GPP TS 24.229 [3] with the clarifications specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function; +- 5) shall include the "norefersub" option tag in a Supported header field according to IETF RFC 4488 [12]; +- 6) shall include the "tdialog" option tag in a Supported header field according to IETF RFC 4538 [13]; +- 7) shall interact with media plane as specified in 3GPP TS 29.380 [31]; and +- 8) shall send the SIP 200 (OK) response towards the MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 2xx response for an outgoing SIP MESSAGE request, shall handle according to 3GPP TS 24.229 [3]. + +## 10.1.5 Non-controlling role procedures + +Editor's note: Content to be added. + +## 10.2 Chat group (restricted) call + +### 10.2.1 Client derived procedures + +#### 10.2.1.1 On-demand chat group call + +##### 10.2.1.1.1 Procedure for initiating an MCPTT chat group session and procedure for joining an MCPTT chat group session + +This clause is referenced from other procedures. + +To initiate or join an MCPTT group session using an MCPTT group identity, identifying an MCPTT chat group, the IWF performing the participating role shall generate an initial SIP INVITE request by following the UE originating session procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) if the IWF is originating an MCPTT emergency group call shall comply with the procedures in clause 6.4.1.1; +- 2) if the IWF is originating an MCPTT imminent peril group call, shall comply with the procedures in clause 6.4.1.6; +- 3) shall include the g.3gpp.mcptt media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP INVITE request according to IETF RFC 3840 [9]; + +- 4) shall include an Accept-Contact header field containing the g.3gpp.mcptt media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 5) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Preferred-Service header field according to IETF RFC 6050 [7] in the SIP INVITE request; +- 6) shall include an Accept-Contact header field with the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 7) if the emergency group state for this group is set to "MEG 2: in-progress" or "MEG 4: confirm-pending", shall comply with the procedures in clause 6.4.1.2; +- 8) if the imminent peril group state for this group is set to "MIG 2: in-progress" or "MIG 4: confirm-pending", shall include the Resource-Priority header field and comply with the procedures in clause 6.4.1.8; +- 9) shall contain an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the element set to a value of "chat"; + - b) the element set to the group identity; and + - c) the element set to a value determined by the IWF; + +NOTE 1: How the IWF determines the value of the element is out of scope of the present document. + +NOTE 2: The will be inserted into the body of the SIP INVITE request by the referring clause. + +- 10) shall include an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; +- 11) if an implicit floor request is required, shall indicate this as specified in clause 6.7; and +- 12) shall not perform the remainder of this procedure. + +On receiving a SIP 2xx response to the SIP INVITE request, the IWF performing the participating role: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; +- 2) if the MCPTT emergency group call state is set to "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted" or the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted", shall perform the actions specified in clause 6.4.1.4, with the IWF acting as the MCPTT client on behalf of the IWF user homed in the IWF; and +- 3) may subscribe to the conference event package as specified in clause 10.3. + +On receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request, the IWF performing the participating role: + +- 1) if the MCPTT emergency group call state is set to "MEGC 2: emergency-call-requested" or "MEGC 3: emergency-call-granted"; or +- 2) if the MCPTT imminent peril group call state is set to "MIGC 2: imminent-peril-call-requested" or "MIGC 3: imminent-peril-call-granted"; + +shall perform the actions specified in clause 6.4.1.5, with the IWF acting as the MCPTT client on behalf of the user homed in the IWF. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in clause 6.4.1.9, with the IWF acting as the MCPTT client on behalf of the user homed in the IWF. + +#### 10.2.1.1.2 IWF performing the terminating participating role receives SIP re-INVITE request for an MCPTT chat group + +This clause is referenced from other procedures. + +Upon receipt of a SIP re-INVITE request the IWF performing the participating role: + +- 1) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - a) shall set the MCPTT emergency group state to "MEG 2: in-progress"; + - b) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + - c) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-gc-capable"; +- 2) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true", shall set the MCPTT imminent peril group state to "MIG 2: in-progress"; +- 3) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "false": + - a) if the element containing the element contains an <>alert-ind> element set to "false": + - i) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body including an element: + - A) if the MCPTT ID contained in the element is the MCPTT ID associated with the targeted user, shall set the MCPTT emergency alert state to "MEA 1: no-alert"; + - b) shall set the MCPTT emergency group state to "MEG 1: no-emergency"; and + - c) if the MCPTT emergency group call state of the group is set to "MEGC 3: emergency-call-granted", shall set the MCPTT emergency group call state of the group to "MEGC 1: emergency-gc-capable"; +- 4) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "false": + - a) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + - b) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-gc-capable"; +- 5) shall accept the SIP re-INVITE request and generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [3]; +- 6) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP 200 (OK) response; +- 7) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP 200 (OK) response; +- 8) shall include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP re-INVITE request according to 3GPP TS 24.229 [3] with the clarifications given in clause 6.1.2; and +- 9) shall send the SIP 200 (OK) response towards the controlling MCPTT server according to rules and procedures of 3GPP TS 24.229 [3]. + +#### 10.2.1.1.3 MCPTT in-progress emergency cancel + +This clause is referenced from other procedures. + +To cancel an in-progress emergency state on an MCPTT chat group, the IWF performing the participating role shall generate a SIP re-INVITE request as specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall, if cancelling an in-progress emergency state and optionally an MCPTT emergency alert originated by the user homed in the IWF, include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.3; +- 2) shall, if cancelling an in-progress emergency state and optionally an MCPTT emergency alert originated by another MCPTT user, include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.10; +- 3) shall include in the SIP re-INVITE request an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; +- 4) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.2; and +- 5) shall exit the procedure in the present clause. + +On receiving a SIP 2xx response to the SIP re-INVITE request, the IWF performing the participating role: + +- 1) shall set the MCPTT emergency group state of the group to "MEG 1: no-emergency"; +- 2) shall set the MCPTT emergency group call state of the group to "MEGC 1: emergency-gc-capable"; and +- 3) if the MCPTT emergency alert state is set to "MEA 4: Emergency-alert-cancel-pending", the sent SIP re-INVITE request did not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body and the SIP 2xx response to the SIP request for a priority group call does not contain a Warning header field as specified in TS 24.379 [29], clause 4.4, with the IWF acting as the MCPTT server with the warning text containing the mcptt-warn-code set to "149", shall set the MCPTT emergency alert state to "MEA 1: no-alert". + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request: + +- 1) shall set the MCPTT emergency group state as "MEG 2: in-progress"; +- 2) if the SIP 4xx response, SIP 5xx response or SIP 6xx response contains an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true" and the sent SIP re-INVITE request did not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, the IWF performing the participating role shall set the MCPTT emergency alert state to "MEA 3: emergency-alert-initiated"; and +- 3) if the SIP 4xx response, SIP 5xx response or SIP 6xx response did not contain an application/vnd.3gpp.mcptt-info+xml MIME body with an element and did not contain an element, the MCPTT emergency alert (MEA) state shall revert to its value prior to entering the current procedure. + +NOTE: If the in-progress emergency group state cancel request is rejected, the state of the session does not change, i.e. continues with MCPTT emergency group call level priority. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in clause 6.4.1.9. + +#### 10.2.1.1.4 MCPTT upgrade to in-progress emergency or imminent peril + +This clause is referenced from other procedures. To upgrade the MCPTT group session to an emergency condition or an imminent peril condition on a MCPTT chat group, the IWF performing the participating role shall generate a SIP re-INVITE request as specified in 3GPP TS 24.229 [3], with the clarifications given below. + +- 1) if upgrading the MCPTT group session to an MCPTT emergency call, the IWF performing the participating role: + - a) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.1; and + - b) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.2 + +- 2) if upgrading the MCPTT group session to an MCPTT imminent peril call, the IWF performing the participating role: + - a) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.6; and + - b) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.8; +- 3) if the SIP re-INVITE request is to be sent within an on-demand session, the IWF performing the participating role shall include in the SIP re-INVITE request an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; +- 4) if an implicit floor request is required, shall indicate this as specified in clause 6.7; and +- 5) shall skip the rest of the steps. + +On receiving a SIP 2xx response to the SIP re-INVITE request the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; and +- 2) shall perform the actions specified in clause 6.4.1.4, with the IWF acting as the MCPTT client. + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request the IWF performing the participating role shall perform the actions specified in clause 6.4.1.5, with the IWF acting as the MCPTT client. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in clause 6.4.1.9. + +#### 10.2.1.1.5 MCPTT in-progress imminent peril cancel + +This clause is referenced from other procedures. + +To cancel the in-progress imminent peril state on a MCPTT chat group, the IWF performing the participating role shall generate a SIP re-INVITE request by following the procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.1.7; +- 2) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.1.8; +- 3) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with: + - a) the element set to a value of "chat"; and + - b) the element set to the group identity; +- 4) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP re-INVITE request according to IETF RFC 3840 [9]; +- 5) if the SIP re-INVITE request is to be sent within an on-demand session, shall include in the SIP re-INVITE request an SDP offer according to 3GPP TS 24.229 [3] with the clarifications specified in clause 6.1.1; and +- 6) shall exit the procedure in the present clause. + +On receiving a SIP 2xx response to the SIP re-INVITE request, the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; +- 2) shall set the MCPTT imminent peril group state of the group to "MIG 1: no-imminent-peril"; and +- 3) shall set the MCPTT imminent peril group call state of the group to "MIGC 1: imminent-peril-gc-capable". + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request: + +- 1) if the SIP 4xx response, SIP 5xx response or SIP 6xx response: + - a) contains an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true"; or + - b) does not contain an application/vnd.3gpp.mcptt-info+xml MIME body with an element; + +then the IWF performing the participating role shall set the MCPTT imminent peril group state as "MIG 2: in-progress". + +NOTE: This is the case where the IWF performing the participating role requested the cancellation of the MCPTT imminent peril in-progress state and was rejected. + +#### 10.2.1.1.6 IWF performing the terminating participating role receives a SIP INVITE request for an MCPTT chat group call + +This clause is referenced from other procedures. + +This procedure is used for MCPTT emergency and MCPTT imminent peril calls when the targeted client is affiliated but not joined to the chat group. + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of an initial SIP INVITE request, the IWF performing the participating role: + +- 1) may reject the SIP INVITE request for any reason outside the scope of this specification; +- 2) if the SIP INVITE request is rejected in step 1), shall respond towards controlling MCPTT function either with appropriate reject code as specified in 3GPP TS 24.229 [3] and warning texts as specified in clause 4.2.2 or with SIP 480 (Temporarily unavailable) and skip the rest of the steps of this clause; +- 3) if the SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - a) shall set the MCPTT emergency group state to "MEG 2: in-progress"; + - b) shall set the MCPTT imminent peril group state to "MIG 1: no-imminent-peril"; and + - c) shall set the MCPTT imminent peril group call state to "MIGC 1: imminent-peril-gc-capable"; otherwise +- 4) if the SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true", shall set the MCPTT imminent peril group state to "MIG 2: in-progress"; +- 5) shall accept the SIP INVITE request and generate a SIP 200 (OK) response according to rules and procedures of 3GPP TS 24.229 [3]; +- 6) shall include the option tag "timer" in a Require header field of the SIP 200 (OK) response; +- 7) shall include the g.3gpp.mcptt media feature tag in the Contact header field of the SIP 200 (OK) response; +- 8) shall include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP 200 (OK) response; +- 9) shall include the Session-Expires header field in the SIP 200 (OK) response and start the SIP session timer according to IETF RFC 4028 [6]. If no "refresher" parameter was included in the received SIP INVITE request the "refresher" parameter in the Session-Expires header field shall be set to "uas", otherwise shall include a "refresher" parameter set to the value received in the Session-Expires header field the received SIP INVITE request; + +- 10) shall include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP INVITE request according to 3GPP TS 24.229 [3] with the clarifications given in clause 6.1.2; +- 11) shall send the SIP 200 (OK) response towards the controlling MCPTT server according to rules and procedures of 3GPP TS 24.229 [3]; and +- 12) shall interact with the media plane as specified in 3GPP TS 29.380 [31]. + +## 10.2.2 IWF performing the participating role procedures + +### 10.2.2.1 On-demand chat group call + +#### 10.2.2.1.1 MCPTT chat session establishment + +In this clause, the IWF originates a chat group session on behalf of a user homed in the IWF. + +NOTE 1: How the IWF determines the public user identity and the MCPTT ID of the calling user is out of scope of the present document. + +The IWF, performing the originating participating role: + +- 1) shall determine the public service identity of the controlling MCPTT function associated with the group identity of the group on which the call is to be originated; + +NOTE 2: How the IWF discovers the public service identity of the controlling MCPTT function associated with the group identity is out of scope of the current document. + +- 2) if the calling user identified by the MCPTT ID is not affiliated to the group on which the call is to be originated, as determined by clause 9.2.1.2.8, shall perform the actions specified in clause 9.2.1.2.9 for implicit affiliation; +- 3) shall generate a SIP INVITE request as specified in clause 10.2.1.1.1; +- 4) if step 3 was performed successfully, shall complete the SIP INVITE request as specified in clause 6.6.2.1.2; +- 5) if steps 3 and 4 were performed successfully: + - a) shall set the Request-URI to the public service identity of the controlling MCPTT function; + - b) shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to the MCPTT ID of the calling user; + - c) may insert the calling user's location information into an application/vnd.3gpp.mcptt-location-info+xml MIME body; + - d) shall send the SIP INVITE request to the controlling MCPTT function as specified in 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 302 (Moved Temporarily) response to the above SIP INVITE request, the IWF, performing the originating participating role: + +- 1) shall generate a SIP INVITE request as specified in clause 6.6.2.1.5; +- 2) shall include an SDP offer based upon the SDP offer in the SIP INVITE request generated by the IWF in the step above; and +- 3) shall send the SIP INVITE request to the controlling MCPTT function according to 3GPP TS 24.229 [3]; + +Upon receipt of a SIP 2xx response to the above SIP INVITE request in step 3) the IWF performing the participating role: + +- 1) shall perform the procedures for receiving a SIP 2xx response as specified in clause 10.2.1.1.1; +- 2) if the procedures of clause 9.2.1.2.9 for implicit affiliation were performed in the present clause, shall complete the implicit affiliation by performing the procedures of clause 9.2.1.2.10. +- 3) shall start the SIP Session timer according to rules and procedures of IETF RFC 4028 [6]. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the above SIP INVITE request in step 14) the IWF performing the participating role: + +- 1) shall perform the procedures for receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response as specified in clause 10.2.1.1.1; +- 2) if the implicit affiliation procedures of clause 9.2.1.2.9 were invoked in the current procedure, shall perform the procedures of clause 9.2.1.2.10. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions for SIP INFO as specified in clause 10.2.1.1.1. + +#### 10.2.2.1.2 Sending of a SIP re-INVITE request towards the MCPTT controlling function + +Upon a need to send a SIP re-INVITE request for an MCPTT session identifying an on-demand MCPTT chat group session, the IWF performing the participating role: + +- 1) if the request is for an upgrade to an in-progress emergency group state or an imminent peril group state, the IWF performing the participating role shall perform the steps in clause 10.2.1.1.4; +- 2) if the request is for a cancellation of an in-progress emergency group state, the IWF performing the participating role shall perform the steps in clause 10.2.1.1.3; +- 3) if the request is for a cancellation of an in-progress imminent peril group state, the IWF performing the participating role shall perform the steps in clause 10.2.1.1.5; +- 4) shall include the MCPTT ID of the originating user in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request; + +NOTE: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. + +- 5) shall include in the SIP re-INVITE request an SDP offer as specified in clause 6.6.2.1.1.1; and +- 6) shall send the SIP re-INVITE request according to 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 2xx response to the above SIP re-INVITE request, the participating MCPTT function: + +- 1) if the SIP re-INVITE request above is for an upgrade for emergency or imminent peril, follow the procedures for SIP 2xx response as specified in clause 10.2.1.1.4; +- 2) if the SIP re-INVITE request above is for an in-progress emergency cancel, follow the procedures for SIP 2xx response as specified in clause 10.2.1.1.3; or +- 3) if the SIP re-INVITE request above is for an in-progress imminent peril cancel, follow the procedures for SIP 2xx response as specified in clause 10.2.1.1.5. + +Upon receipt of a SIP 403 (Forbidden) response to the sent SIP re-INVITE request the participating MCPTT function, the IWF action is out of scope of the present document. + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request the IWF: + +- 1) if the SIP re-INVITE request above is for an upgrade for emergency or imminent peril, follow the procedures for SIP 4xx, 5xx or 6xx response as specified in clause 10.2.1.1.4; +- 2) if the SIP re-INVITE request above is for an in-progress emergency cancel, follow the procedures for SIP 4xx, 5xx or 6xx response as specified in clause 10.2.1.1.3; or +- 3) if the SIP re-INVITE request above is for an in-progress imminent peril cancel, follow the procedures for SIP 4xx, 5xx or 6xx response as specified in clause 10.2.1.1.5. + +Upon receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing session, the IWF performing the participating role shall: + +- 1) if the SIP re-INVITE request above is for an upgrade for emergency or imminent peril, follow the procedures for SIP INFO as specified in clause 10.2.1.1.4; or +- 2) if the SIP re-INVITE request above is for an in-progress emergency cancel, follow the procedures for SIP INFO as specified in clause 10.2.1.1.3. + +#### 10.2.2.1.3 Reception of a SIP INVITE request by an IWF performing the terminating participating role + +Upon receipt of a "SIP INVITE request for terminating participating MCPTT function", targeting a user homed in the IWF for an MCPTT chat group, the IWF performing the participating role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the "SIP INVITE request for terminating participating MCPTT function" with a SIP 500 (Server Internal Error) response. The IWF performing the participating role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14]. Otherwise, continue with the rest of the steps; +- 2) shall check the presence of the isfocus media feature tag in the Contact header field and if it is not present then the IWF performing the participating role shall reject the request with a SIP 403 (Forbidden) response with the warning text set to "104 isfocus not assigned" in a Warning header field as specified in clause 4.4. Otherwise, continue with the rest of the steps; and +- 3) shall perform the steps in 10.2.1.1.6. + +#### 10.2.2.1.4 Reception of a SIP re-INVITE request by an IWF performing the terminating participating role + +Upon receipt of a SIP re-INVITE targeting a user homed in the IWF for an MCPTT chat group, the IWF performing the participating role shall perform the steps in 10.2.1.1.2. + +### 10.2.2.2 End group call at the originating participating IWF + +#### 10.2.2.2.1 IWF ending on-demand chat session + +When the IWF performing the participating role determines a need to send a SIP BYE request, the IWF shall follow the procedures as specified in clause 6.6.2.1.3. + +### 10.2.2.3 End group call at the terminating participating IWF + +#### 10.2.2.3.1 Receipt of SIP BYE request for on-demand chat session + +Upon receiving a SIP BYE request from the controlling MCPTT function, the IWF performing the participating role shall follow the procedures as specified in clause 6.6.2.2.1. + +## 10.2.3 IWF controlling role procedures + +### 10.2.3.1 On-demand chat group call + +#### 10.2.3.1.1 Procedure for establishing an MCPTT chat session and procedure for joining an established MCPTT chat session + +In the procedures in this clause: + +- 1) MCPTT ID in an incoming SIP INVITE request refers to the MCPTT ID of the originating user from the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; +- 2) group identity in an incoming SIP INVITE request refers to the group identity from the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request; + +- 3) MCPTT ID in an outgoing SIP INVITE request refers to the MCPTT ID of the called user in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the outgoing SIP INVITE request; +- 4) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 5) alert indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a "SIP INVITE request for controlling MCPTT function of an MCPTT group" containing a group identity identifying a MCPTT chat group, the IWF performing the controlling role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP INVITE request with a SIP 500 (Server Internal Error) response. The IWF performing the controlling role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14] and skip the rest of the steps; + +NOTE 1: If the SIP INVITE request contains an emergency indication set to a value of "true", the IWF performing the controlling role can by means beyond the scope of this specification choose to accept the request. + +- 2) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if: + - a) an Accept-Contact header field does not include the g.3gpp.mcptt media feature tag; + - b) an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; or + - c) the isfocus media feature tag is present in the Contact header field; +- 3) if received SIP INVITE request includes an application/vnd.3gpp.mcptt-info+xml MIME body with an element included or an element included, shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17, with the IWF acting as the controlling MCPTT function; +- 4) shall retrieve the necessary group document(s) from the group management server for the group identity contained in the SIP INVITE request and carry out initial processing as specified in 3GPP TS 24.379 [29], clause 6.3.5.2, with the IWF acting as the participating MCPTT function and continue with the rest of the steps if the checks in 3GPP TS 24.379 [29], clause 6.3.5.2 succeed; +- 5) if the MCPTT user identified by the MCPTT ID in the SIP INVITE request is not affiliated with the MCPTT group identified by the group identity in the SIP INVITE request as determined by the procedures of 3GPP TS 24.379 [29], clause 6.3.6, with the IWF acting as the controlling MCPTT function: + - a) shall check if the MCPTT user is eligible to be implicitly affiliated with the MCPTT chat group as determined by clause 9.2.1.3.6; and + - b) if the MCPTT user is not eligible for implicit affiliation, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function and skip the rest of the steps below; +- 6) if the SIP INVITE request contains unauthorised request for an MCPTT emergency group call as determined by clause 6.6.3.1.8.2: + - a) shall reject the SIP INVITE request with a SIP 403 (Forbidden) response as specified in clause 6.6.3.1.9; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 7) if the SIP INVITE request contains an unauthorised request for an MCPTT imminent peril group call as determined by clause 6.6.3.1.8.6, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response with the following clarifications: + - a) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the element set to a value of "false"; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; + +- 8) if a Resource-Priority header field is included in the SIP INVITE request: + - a) if the Resource-Priority header field is set to the value indicated for emergency calls and the SIP INVITE request does not contain an emergency indication and the in-progress emergency state of the group is set to a value of "false", shall reject the SIP INVITE request with a SIP 403 (Forbidden) response and skip the remaining steps; and + - b) if the Resource-Priority header field is set to the value indicated for imminent peril calls and the SIP INVITE request does not contain an imminent peril indication and the in-progress imminent peril state of the group is set to a value of "false", shall reject the SIP INVITE request with a SIP 403 (Forbidden) response; and skip the remaining steps; + - 9) shall validate that the received SDP offer includes at least one media stream for which the media parameters and at least one codec or media format is acceptable by the IWF performing the controlling role and if not, reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; + - 10) shall create a chat group session and allocate an MCPTT session identity for the chat group session if the MCPTT chat group session identity does not already exist, and may handle timer TNG3 (group call timer) as specified in clause 6.6.3.5; + - 11) if the chat group session is ongoing and the as specified in 3GPP TS 24.481 [16] is already reached: + - a) if, according to local policy, the user identified by the MCPTT ID in the SIP INVITE request is deemed to have a higher priority than an existing user in the chat group session, may remove a participant from the session by following clause 10.1.4.4.3, and skip the next step; and +- NOTE 2: The local policy for deciding whether to admit a user to a call that has reached its maximum amount of participants can include the and the of the user as well as other information of the user from the group document as specified in 3GPP TS 24.481 [16]. The local policy decisions can also include taking into account whether the imminent-peril indicator or emergency indicator was received in the SIP INVITE request. +- b) shall return a SIP 486 (Busy Here) response with the warning text set to "122 too many participants" to the originating network as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function. Otherwise, continue with the rest of the steps; + - 12) if the received SIP INVITE request was determined to be eligible for implicit affiliation in step 5) and if clause 9.2.1.3.7 was not previously invoked in the present clause, shall perform the implicit affiliation as specified in clause 9.2.1.3.7; + - 13) if the SIP INVITE request contains an emergency indication set to a value of "true" or the in-progress emergency state of the group to "true" the IWF performing the controlling role shall: + - a) validate that the SIP INVITE request includes a Resource-Priority header field populated with the values for an MCPTT emergency group call as specified in clause 6.6.3.1.12, and if not: + - i) perform the actions specified in clause 6.6.3.1.5; + - ii) send the SIP UPDATE request generated in clause 6.6.3.1.5 towards the initiator of the SIP INVITE request according to 3GPP TS 24.229 [3]; and + - iii) upon receiving a SIP 200 (OK) response to the SIP UPDATE request sent in clause 6.6.3.1.5, proceed with the rest of the steps. +- NOTE 3: Verify that the Resource-Priority header is included and properly populated for both ongoing and newly-entered in-progress emergency states of the specified group. +- b) if the in-progress emergency state of the group is set to a value of "true" and the MCPTT user is indicating a new emergency indication: + - i) for each of the other affiliated MCPTT members of the group generate a SIP MESSAGE request notification of the MCPTT user's emergency indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, with the following clarifications: + +- A) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; + - B) if the received SIP INVITE contains an alert indication set to a value of "true" and this is an authorised request for an MCPTT emergency alert meeting the conditions specified in clause 6.6.3.1.8.1, perform the procedures specified in clause 6.6.3.1.7; and + - C) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; +- ii) cache the information that the MCPTT user has initiated an MCPTT emergency call; and + - iii) if the SIP INVITE request contains an authorised request for an MCPTT emergency alert as determined in step i) B) above, cache the information that the MCPTT user has initiated an MCPTT emergency alert; and +- c) if the in-progress emergency state of the group is set to a value of "false": + - i) shall set the value of the in-progress emergency state of the group to "true"; + - ii) shall start timer TNG2 (in-progress emergency group call timer) and handle its expiry as specified in clause 6.6.3.1.10; + - iii) shall generate SIP re-INVITE requests for the MCPTT emergency group call to the other MCPTT affiliated and joined participants of the MCPTT chat group as specified in clause 6.6.3.1.3; + - iv) shall generate SIP INVITE requests for the MCPTT emergency group call to the affiliated but not joined MCPTT members of the MCPTT chat group as specified in clause 6.6.3.1.4; + - A) for each affiliated but not joined MCPTT member shall send the SIP INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) upon receiving a SIP 200 (OK) response to the SIP INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; + - v) shall cache the information that the MCPTT user has initiated an MCPTT emergency call; and + - vi) if the <>alert-ind> element of the application/vnd.3gpp.mcptt-info+xml MIME body is set to "true" and is an authorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall cache the information that the MCPTT user has initiated an MCPTT emergency alert; and + - vii) if the in-progress imminent peril state of the group is set to a value of "true", shall set it to a value of "false"; +- 14) if the in-progress emergency state of the group is set to a value of "false" and if the SIP INVITE request contains an imminent peril indication set to a value of "true" or the in-progress imminent peril state of the group is set to "true", the IWF performing the controlling role shall: +- a) validate that the SIP INVITE request includes a Resource-Priority header field populated with the values for an MCPTT imminent peril group call as specified in clause 6.6.3.1.12, and if not: + - i) perform the actions specified in clause 6.6.3.1.5; + - ii) send the SIP UPDATE request generated in clause 6.6.3.1.5 towards the initiator of the SIP INVITE request according to 3GPP TS 24.229 [3]; and + - iii) upon receiving a SIP 200 (OK) response to the SIP UPDATE request sent in clause 6.6.3.1.5 proceed with the rest of the steps. +- NOTE 4: Verify that the Resource-Priority header is included and properly populated for both ongoing and newly-entered in-progress imminent peril states of the specified group. +- b) if the in-progress imminent peril state of the group is set to a value of "true" and the MCPTT user is indicating a new imminent peril indication: + - i) for each of the other affiliated MCPTT member of the group generate a SIP MESSAGE request notification of the MCPTT user's imminent peril indication as specified in 3GPP TS 24.379 [29], + +clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, with the following clarifications; + +- A) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; and + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; and +- ii) cache the information that the MCPTT user has initiated an MCPTT imminent peril call; and +- c) if the in-progress imminent peril state of the group is set to a value of "false": + - i) shall set the value of the in-progress imminent peril state of the group to "true"; + - ii) shall generate SIP re-INVITE requests for the MCPTT imminent peril group call to the other MCPTT affiliated and joined participants of the MCPTT chat group as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function; + - iii) shall generate SIP INVITE requests for the MCPTT imminent peril call to the affiliated but not joined MCPTT members of the MCPTT chat group as specified in clause 6.6.3.1.4; + - A) for each affiliated but not joined MCPTT member shall send the SIP INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) Upon receiving a SIP 200 (OK) response to the SIP INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - iv) shall cache the information that the MCPTT user has initiated an MCPTT imminent peril call; +- 15) shall accept the SIP request and generate a SIP 200 (OK) response to the SIP INVITE request according to 3GPP TS 24.229 [3]; + - 16) shall include in the SIP 200 (OK) response an SDP answer according to 3GPP TS 24.229 [3] with the clarifications specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function, unless the procedures of clause 6.6.3.1.5 were performed in step 13)a) or step 14)a) above; + - 17) should include the Session-Expires header field and start supervising the SIP session according to IETF RFC 4028 [6]. It is recommended that the "refresher" header field parameter is omitted. If included, the "refresher" header field parameter shall be set to "uac"; + - 18) shall include the "timer" option tag in a Require header field; + - 19) shall include the following in a Contact header field: + - a) the g.3gpp.mcptt media feature tag; + - b) the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; + - c) the MCPTT session identity; and + - d) the media feature tag isfocus; + - 20) shall include the "tdialog" option tag in a Supported header field according to IETF RFC 4538 [13]; + - 21) if the SIP INVITE request contains an alert indication set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; + - 22) if the received SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and if the in-progress emergency state of the group is set to a value of "true", shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; + +NOTE 5: In this case, the request was for an imminent peril call but a higher priority MCPTT emergency call was already in progress on the group. Hence, the imminent peril call request aspect of the request is denied but the request is granted with emergency level priority. + +23) shall interact with media plane as specified in 3GPP TS 29.380 [31]; + +24) shall send the SIP 200 (OK) response to the MCPTT client according to 3GPP TS 24.229 [3]; and + +25) if the chat group session was already ongoing and if at least one of the MCPTT participants has subscribed to the conference event package, shall send a SIP NOTIFY request to all MCPTT participants with a subscription to the conference event package as specified in 3GPP TS 24.379 [29], clause 10.1.3.4.2 with the IWF acting as the controlling MCPTT function. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, and the SIP 200 (OK) response was sent with the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in clause 4.4, the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.11. + +#### 10.2.3.1.2 Receipt of a SIP re-INVITE request + +In the procedures in this clause: + +1) emergency indication in an incoming SIP re-INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and + +2) imminent peril indication in an incoming SIP re-INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a SIP re-INVITE request for an MCPTT session identity identifying a MCPTT chat group session, the IWF performing the controlling role: + +1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP re-INVITE request with a SIP 500 (Server Internal Error) response. The IWF performing the controlling role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14] and skip the rest of the steps; + +NOTE 1: if the SIP re-INVITE request contains an emergency indication or an imminent peril indication set to a value of "true" and this is an authorised request for originating an MCPTT emergency group call as determined by clause 6.6.3.1.8.2, or for originating an MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5, the IWF performing the controlling role can according to local policy choose to accept the request. + +2) if the received SIP re-INVITE request includes an application/vnd.3gpp.mcptt-info+xml MIME body with an element included or an element included, shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17, with the IWF acting as the controlling MCPTT function; + +3) if the SIP re-INVITE request contains an unauthorised request for an MCPTT emergency call as determined by clause 6.6.3.1.8.2: + +a) shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response as specified in clause 6.6.3.1.9; and + +b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; + +4) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and is an authorised request to initiate an MCPTT emergency group call as determined by clause 6.6.3.1.8.2, the IWF performing the controlling role shall: + +a) validate that the SIP re-INVITE request includes a Resource-Priority header field is populated correctly for an MCPTT emergency group call as specified in clause 6.6.3.1.12, and if not: + +i) shall perform the actions specified in clause 6.6.3.1.5; and + +ii) upon receiving a SIP 200 (OK) response to the SIP UPDATE request sent in clause 6.6.3.1.5 shall proceed with the rest of the steps. + +NOTE 2: Verify that the Resource-Priority header is included and properly populated for both ongoing and newly-entered in-progress emergency states of the specified group. + +- b) if the in-progress emergency state of the group is set to a value of "true" and the MCPTT user is indicating a new emergency indication: + - i) shall cache the MCPTT ID of the MCPTT user that has initiated an MCPTT emergency call; + - ii) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and is an authorised request for an MCPTT emergency alert as determined by clause 6.6.3.1.8.1, shall cache the MCPTT ID of the MCPTT user that has initiated an MCPTT emergency alert; and + - iii) for each of the other affiliated members of the group, generate a SIP MESSAGE request notification of the MCPTT user's emergency indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, with the following clarifications: + - A) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; + - B) if the received SIP re-INVITE contains an alert indication set to a value of "true" and this is an authorised request for an MCPTT emergency alert meeting the conditions specified in clause 6.6.3.1.8.1, perform the procedures specified in clause 6.6.3.1.7; and + - C) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; and +- c) if the in-progress emergency state of the group is set to a value of "false": + - i) shall set the value of the in-progress emergency state of the group to "true"; + - ii) shall cache the MCPTT ID of the MCPTT user that has initiated an MCPTT emergency call; + - iii) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and this is an authorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall cache the MCPTT ID of the MCPTT user that has initiated an MCPTT emergency alert; + - iv) shall start timer TNG2 (in-progress emergency group call timer) and handle its expiry as specified in clause 6.6.3.1.10; + - v) shall generate SIP re-INVITE requests for the MCPTT emergency group call to the other affiliated and joined participants of the MCPTT chat group as specified in clause 6.6.3.1.3. The IWF performing the controlling role: + - A) for each affiliated and joined member shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - vi) shall generate SIP INVITE requests for the MCPTT emergency group call to the affiliated but not joined MCPTT members of the MCPTT chat group as specified in clause 6.6.3.1.4. The IWF performing the controlling role: + - A) for each affiliated but not joined MCPTT member shall send the SIP INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) Upon receiving a SIP 200 (OK) response to the SIP INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - vii) if the in-progress imminent peril state of the group is set to a value of "true", shall set it to a value of "false"; +- 5) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is an unauthorised request for an MCPTT emergency group call cancellation as determined by clause 6.6.3.1.8.4: + +- a) shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response; + - b) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with an element set to a value of "true"; + - c) if an element of the application/vnd.3gpp.mcptt-info+xml MIME body is included set to "false" and there is an outstanding MCPTT emergency alert for the MCPTT user, shall include in the application/vnd.3gpp.mcptt-info+xml MIME body and element set to a value of "true"; and + - d) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 6) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is determined to be an authorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.8.4 and the in-progress emergency state of the group to is set to a value of "true" the IWF performing the controlling role shall: +- a) validate that the SIP re-INVITE request includes a Resource-Priority header field is populated correctly for a normal priority MCPTT group call as specified in clause 6.6.3.1.12, and if not: + - i) shall perform the actions specified in clause 6.6.3.1.5; and + - ii) upon receiving a SIP 200 (OK) response to the SIP UPDATE request sent in clause 6.6.3.1.5 shall proceed with the rest of the steps; + +NOTE 3: Verify that the Resource-Priority header is included and properly populated for an in-progress emergency state cancellation of the specified group. + +- b) set the in-progress emergency group state of the group to a value of "false"; +- c) clear the cache of the MCPTT ID of the MCPTT user identified by the element as having an outstanding MCPTT emergency group call; +- d) if an element of the application/vnd.3gpp.mcptt-info+xml MIME body is included and set to "false" and is determined to be an authorised request for an MCPTT emergency alert cancellation as specified in clause 6.6.3.1.8.3 and there is an outstanding MCPTT emergency alert for the MCPTT user shall: + - i) if the received SIP re-INVITE request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, clear the cache of the MCPTT ID of the MCPTT user identified by the element as having an outstanding MCPTT emergency alert; and + - ii) if the received SIP re-INVITE request does not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, clear the cache of the MCPTT ID of the sender of the SIP re-INVITE request as having an outstanding MCPTT emergency alert; +- e) generate SIP re-INVITE requests to the other affiliated and joined members of the MCPTT group as specified in clause 6.6.3.1.3. The IWF performing the controlling role: + - i) for each affiliated and joined member shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - ii) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + +NOTE 4: Clause 6.6.3.1.3 will inform the affiliated and joined members of the cancellation of the MCPTT group's in-progress emergency state and the cancellation of the MCPTT emergency alert if applicable. + +- f) for each of the affiliated but not joined members of the group shall: + - i) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function; + - ii) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; + +- iii) if indicated above in step d), set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; and + - iv) send the SIP MESSAGE request according to 3GPP TS 24.229 [3]; +- 7) if a Resource-Priority header field is included in the SIP re-INVITE request: +- a) if the Resource-Priority header field is set to the value indicated for emergency calls and the received SIP re-INVITE request does not contain an authorised request for an MCPTT emergency call as determined in step 4) above and the in-progress emergency state of the group is set to a value of "false", shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response and skip the remaining steps; or + - b) if the Resource-Priority header field is set to the value indicated for imminent peril calls and the received SIP re-INVITE request does not contain an authorised request for an MCPTT imminent peril call as determined by the procedures of clause 6.6.3.1.8.5 and the in-progress imminent peril state of the group is set to a value of "false", shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response and skip the remaining steps; +- 8) if the received SIP re-INVITE request contains an imminent peril indication, shall perform the procedures specified in clause 10.2.3.1.3 and skip the rest of the steps; +- 9) shall include in the SIP 200 (OK) response an SDP answer according to 3GPP TS 24.229 [3] with the clarifications specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1, with the IWF acting as the controlling MCPTT function, unless the procedures of clause 6.6.3.1.5 were performed in step 6) a) i) above; +- 10) shall include the "tdialog" option tag in a Supported header field according to IETF RFC 4538 [13]; +- 11) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true" and if this is an unauthorised request for an MCPTT emergency alert as determined by clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; +- 12) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and if this is an unauthorised request for an MCPTT emergency alert cancellation as determined by clause 6.6.3.1.8.3, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; +- 13) if the received SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true", this is an authorised request for an MCPTT imminent peril group call and if the in-progress emergency state of the group is set to a value of "true", shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function; +- NOTE 5: In this case, the request was for an imminent peril call but a higher priority MCPTT emergency call was already in progress on the group. Hence, the imminent peril call request aspect of the request is denied but the request is granted with emergency level priority. +- 14) shall interact with media plane as specified in 3GPP TS 29.380 [31]; and +- 15) shall send the SIP 200 (OK) response towards the MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, and the SIP 200 (OK) response was sent with the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling MCPTT function, the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.11. + +### 10.2.3.1.3 Handling of a SIP re-INVITE request for imminent peril session + +In the procedures in this clause: + +- 1) imminent peril indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +When the IWF performing the controlling role receives a SIP re-INVITE request with an imminent peril indication, the IWF performing the controlling role: + +- 1) if the SIP re-INVITE request contains an unauthorised request for an MCPTT imminent peril group call as determined by clause 6.6.3.1.8.5, shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response with the following clarifications: + - a) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the element set to a value of "false"; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 2) if the in-progress emergency group state of the group is set to a value of "false" and if the SIP re-INVITE request contains an imminent peril indication set to a value of "true" or the in-progress imminent peril state of the group to "true", the IWF performing the controlling role shall: + - a) validate that the SIP re-INVITE request includes a Resource-Priority header field with the namespace set to the MCPTT-specific namespace specified in IETF RFC 8101 [23] and the priority set to the priority designated for imminent peril calls and if not: + - i) perform the actions specified in clause 6.6.3.1.5; + - ii) send the SIP UPDATE request generated in clause 6.6.3.1.5 towards the initiator of the SIP re-INVITE request according to 3GPP TS 24.229 [3]; and + - iii) upon receiving a SIP 200 (OK) response to the SIP UPDATE request sent in clause 6.6.3.1.5 proceed with the rest of the steps. + +NOTE 1: Verify that the Resource-Priority header is included and properly populated for both ongoing and newly-entered in-progress imminent peril states of the specified group. + +- b) if the in-progress imminent peril state of the group is set to a value of "true" and the MCPTT user is indicating a new imminent peril indication: + - i) for each of the other affiliated member of the group generate a SIP MESSAGE request notification of the MCPTT user's imminent peril indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling function, with the following clarifications; + - A) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; and + - B) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; and + - ii) cache the information that the MCPTT user has initiated an MCPTT imminent peril call; and +- c) if the in-progress imminent peril state of the group is set to a value of "false": + - i) shall set the value of the in-progress imminent peril state of the group to "true"; + - ii) shall generate SIP re-INVITE requests for the MCPTT imminent peril group call to the other affiliated and joined participants of the MCPTT chat group as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function; + - iii) shall generate SIP INVITE requests for the MCPTT imminent peril group call to the affiliated but not joined members of the MCPTT chat group as specified in clause 6.6.3.1.4; + - A) for each affiliated but not joined member shall send the SIP INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) Upon receiving a SIP 200 (OK) response to the SIP INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - iv) shall cache the information that the MCPTT user has initiated an MCPTT imminent peril call; + +- 3) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is an unauthorised request for an MCPTT imminent peril group call cancellation as determined by clause 6.6.3.1.8.6 shall: + - a) reject the SIP re-INVITE request with a SIP 403 (Forbidden) response to the SIP re-INVITE request; and + - b) include in the SIP 403 (Forbidden) response: + - i) include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with the element containing the element with the element set to a value of "false"; + - ii) send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3]; and + - iii) skip the rest of the steps; + - 4) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false" and is determined to be an authorised request for an MCPTT imminent peril call cancellation as specified in clause 6.6.3.1.8.6 and the in-progress imminent peril state of the group to is set to a value of "true" the IWF performing the controlling role shall: + - a) validate that the SIP re-INVITE request includes a Resource-Priority header field with the namespace set to the MCPTT-specific namespace specified in IETF RFC 8101 [23], and the priority set to the priority level designated for a normal priority MCPTT group call, and if not: + - i) perform the actions specified in clause 6.6.3.1.5; and + - ii) upon receiving a SIP 200 (OK) response to the SIP UPDATE request sent in clause 6.6.3.1.5, proceed with the rest of the steps; +- NOTE 2: verify that the Resource-Priority header is included and properly populated for an in-progress emergency group state cancellation of the specified group. +- b) set the in-progress imminent peril state of the group to a value of "false"; + - c) cache the information that the MCPTT user no longer has an outstanding MCPTT imminent peril group call; + - d) generate SIP re-INVITES requests to the other affiliated and joined members of the MCPTT group as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function. The IWF performing the controlling role: + - i) for each affiliated and joined member shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - ii) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request the IWF performing the controlling role shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- NOTE 3: 3GPP TS 24.379 [29], clause 6.3.3.1.15, with the IWF acting as the controlling MCPTT function, will inform the affiliated and joined members of the cancellation of the MCPTT group's in-progress emergency group state and the cancellation of the MCPTT emergency alert if applicable. +- e) for each of the affiliated but not joined MCPTT members of the group: + - i) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's imminent peril call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function; + - ii) set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; and + - iii) send the SIP MESSAGE request according to 3GPP TS 24.229 [3]; +- 5) include in the SIP 200 (OK) response an SDP answer according to 3GPP TS 24.229 [3] with the clarifications specified in 3GPP TS 24.379 [29], clause 6.3.3.2.1 unless the procedures of clause 6.6.3.1.5 were performed in step 2) or 4) above; + +- 6) include the "norefersub" option tag in a Supported header field according to IETF RFC 4488 [12]; +- 7) include the "tdialog" option tag in a Supported header field according to IETF RFC 4538 [13]; +- 8) interact with media plane as specified in 3GPP TS 29.380 [31]; and +- 9) send the SIP 200 (OK) response towards the MCPTT client according to 3GPP TS 24.229 [3]. + +### 10.2.3.2 End group call at the terminating IWF performing the controlling role + +Upon receiving a SIP BYE request the IWF performing the controlling role shall follow the procedures as specified in clause 6.6.3.2.1. + +### 10.2.3.3 End group call initiated by the IWF performing the controlling role + +#### 10.2.3.3.1 General + +This clause describes the procedures of each functional entity for ending the group call initiated by the IWF performing the controlling role. + +#### 10.2.3.3.2 SIP BYE request for releasing MCPTT session for a group call + +When the MCPTT session for group call needs to be released as specified in clause 6.6.7.1, the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.2. + +#### 10.2.3.3.3 SIP BYE request towards a MCPTT client + +When an MCPTT client needs to be removed from the MCPTT session (e.g. due to de-affiliation or admitting a higher priority user), the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.2. + +After successfully removing the MCPTT client from the MCPTT session, the IWF performing the controlling role may generate a notification to the MCPTT clients, which have subscribed to the conference event package that an MCPTT user has been removed from the MCPTT session, as specified in clause 6.6.3.4 and send the SIP NOTIFY request to the MCPTT client according to 3GPP TS 24.229 [3]. + +#### 10.2.3.3.4 Removal of participant homed in the IWF + +After successfully removing a participant homed in the IWF from the MCPTT session, the IWF performing the controlling role may generate a notification to any MCPTT clients in the session, which have subscribed to the conference event package that a user has been removed from the MCPTT session, as specified in clause 6.6.3.4 and send the SIP NOTIFY request to the MCPTT client according to 3GPP TS 24.229 [3]. + +### 10.2.4 Non-controlling role procedures + +**Editor's note:** Content to be added. + +## 10.3 Subscription to the conference event package + +### 10.3.1 General + +The IETF RFC 4575 [15] defines a conference event package that shall be used to obtain the status of participants in group sessions. + +The IWF performing the participating role can send conference state subscriptions and receive notifications as specified in clause 10.3.2. + +The IWF performing the controlling role can handle subscriptions and notification of conference events as specified in clause 10.3.3. + +The IWF performing the non-controlling role can handle subscriptions and notification of conference events as specified in clause 10.3.4. + +When the non-controlling function connection model is used, the IWF performing the controlling role subscribes to the conference event package from the non-controlling MCPTT function as specified in clause 10.3.3.3. + +## 10.3.2 IWF performing the participating role + +When the IWF performing the participating role decides to subscribe to the conference event package, the IWF: + +- 1) shall generate a SUBSCRIBE request as specified in 3GPP TS 24.229 [3]; +- 2) shall set the SIP URI in the Request-URI with the MCPTT session identity that is mapped to the MCPTT group session; +- 3) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body the element set to the MCPTT ID of the IWF; +- 4) shall insert a Record-Route header containing a URI identifying its own address; and +- 5) shall send the SIP SUBSCRIBE request according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP response to the SIP SUBSCRIBE request the IWF performing the participating role can store the information. + +Upon receiving a SIP NOTIFY request within the dialog created by the SIP SUBSCRIBE request, the IWF performing the participating role: + +- 1) shall create an outgoing SIP 200 (OK) response; +- 2) shall include the MCPTT group session identity in the outgoing SIP response; and +- 3) shall forward the SIP response according to 3GPP TS 24.229 [3]. + +The IWF performing the participating role can use of the information provided by the conference event package is outside the scope of the present document. + +## 10.3.3 IWF performing the controlling role + +### 10.3.3.1 Receiving a subscription to the conference event package + +Upon receipt of a SIP SUBSCRIBE request for event package subscription, if the IWF performing the controlling role does not support the conference event package, the IWF performing the controlling role: + +- 1) shall reject the "SIP SUBSCRIBE request for event status subscription in the controlling MCPTT function" with a SIP 403 (Forbidden) response to the SIP SUBSCRIBE request, with warning text set to "138 subscription of conference events not allowed" as specified in clause 4.2; and +- 2) shall not continue with the remaining steps. + +If the SIP SUBSCRIBE request: + +- 1) contains an application/vnd.3gpp.mcptt-info+xml MIME body with + - a) the element set to the group identity of the group session and the element set to either: + - i) the MCPTT ID of a participant in the group session; or + - ii) a constituent MCPTT group ID of a non-controlling MCPTT function in a temporary group session; +- 2) contains the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service header field according to IETF RFC 6050 [7]; +- 3) contains an Accept header field containing the application/conference-info+xml MIME type; and + +- 4) is not received in a group call initiated as a broadcast group call; + +then the IWF performing the controlling role: + +- 1) shall determine if the MCPTT ID or the constituent MCPTT group ID in the element is allowed to subscribe to the conference event package and if not allowed: + - a) shall reject the "SIP SUBSCRIBE request for event status subscription in the controlling MCPTT function" with a SIP 403 (Forbidden) response to the SIP SUBSCRIBE request, with warning text set to "138 subscription of conference events not allowed" as specified in clause 4.2; and + - b) shall not continue with the remaining steps; +- 2) shall handle the request according to IETF RFC 6665 [25] and IETF RFC 4575 [15]; +- 3) shall cache information about the subscription; +- 4) shall send a conference state notification as specified in clause 10.3.4.2; and +- 5) if the SIP SUBSCRIBE request is the first SUBSCRIBE request from a participant in a temporary group session, shall subscribe to the conference event package from all non-controlling MCPTT functions in the group session as specified in clause 10.3.4.3. + +Upon receipt of a SIP SUBSCRIBE request for event package subscription in the IWF performing the controlling role in a group call initiated as a broadcast group call, the IWF performing the controlling role: + +- 1) shall generate a SIP 480 (Temporarily Unavailable) response to the SIP SUBSCRIBE request as specified in 3GPP TS 24.229 [3]; +- 2) shall include a Warning header field with the warning text set to "105 subscription not allowed in a broadcast group call" as specified in clause 4.2; and +- 3) send the SIP 480 (Temporarily Unavailable) response according to 3GPP TS 24.229 [3]. + +### 10.3.3.2 Sending notifications to the conference event package + +The procedures in this clause is triggered by: + +- 1) the receipt of a SIP SUBSCRIBE request as specified in clause 10.3.4.1; +- 2) the receipt of a SIP BYE request from one of the participants in a pre-arranged or a chat group session; or +- 3) when a new participant is added in a pre-arranged or chat group session. + +When sending a conference event notification, the IWF performing the controlling role: + +- 1) shall generate a notification package as specified in clause 6.6.3.4 to all MCPTT clients which have subscribed to the conference event package; and + +NOTE: As a group document can potentially have a large content, the IWF performing the controlling role can notify using content-indirection as defined in IETF RFC 4483 [17]. + +- 2) shall send a SIP NOTIFY request to all MCPTT participants which have subscribed to the conference event package as specified in 3GPP TS 24.229 [3]. + +### 10.3.3.3 Sending subscriptions to the conference event package + +The procedure in this clause is triggered by: + +- 1) the receipt of a SIP 200 (OK) response to a SIP INVITE request for non-controlling MCPTT function of an MCPTT group and if at least one participant already has subscribed to the conference event package in the IWF performing the controlling role as specified in clause 10.3.4.1; or +- 2) the receipt of the first SIP SUBSCRIBE request as specified in clause 10.3.4.1 and one or more participants in the group session is a non-controlling MCPTT function; + +then, for each non-controlling MCPTT function from where a SIP 200 (OK) response to a SIP INVITE request for non-controlling MCPTT function of an MCPTT group has been received and where a SIP SUBSCRIBE request is not already sent, the IWF performing the controlling role: + +- 1) shall generate a SIP SUBSCRIBE request and use a new SIP-dialog according to IETF RFC 6665 [25], IETF RFC 4575 [15] and 3GPP TS 24.229 [3]; +- 2) shall set the Request-URI of the SIP SUBSCRIBE request to the public service identity of the non-controlling MCPTT function serving the group identity of the MCPTT group owned by the partner MCPTT system; +- 3) shall include the same P-Asserted-Identity header field as included in the SIP INVITE request for non-controlling MCPTT function of an MCPTT group; +- 4) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Preferred-Service header field according to IETF RFC 6050 [7]; +- 5) shall include an Accept-Contact header with the g.3gpp.mcptt along with "require" and "explicit" header field parameters according to IETF RFC 3841 [7]; +- 6) shall set the Expires header field according to IETF RFC 6665 [25], to 4294967295; + +NOTE 1: 4294967295, which is equal to $2^{32}-1$ , is the highest value defined for Expires header field in IETF RFC 3261 [14]. + +- 7) shall include an Accept header field containing the application/conference-info+xml MIME type; +- 8) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with: + - a) the element set to the constituent MCPTT group ID; and + - b) the set to the temporary MCPTT group ID; and +- 9) shall send the SIP SUBSCRIBE request using a new SIP dialog according to 3GPP TS 24.229 [3]. + +The responses to the SIP SUBSCRIBE request shall be handled according to IETF RFC 6665 [25], IETF RFC 4575 [15] and 3GPP TS 24.229 [3]. + +Upon receiving an incoming SIP NOTIFY requests to the previously sent SIP SUBSCRIBE request, the IWF performing the controlling role: + +- 1) shall handle the request according to IETF RFC 6665 [25] and IETF RFC 4575 [15]; +- 2) shall modify the SIP NOTIFY request as specified in clause 6.6.3.4; and +- 3) shall forward the modified SIP NOTIFY request according to 3GPP TS 24.229 [3] to all other participants with a subscription to the conference event package. + +NOTE 2: A non-controlling MCPTT function of an MCPTT group is regarded as a participant in a temporary group session. + +### 10.3.3.4 Terminating a subscription + +Upon receipt of a SIP SUBSCRIBE request for event status subscription in the IWF performing the controlling role that terminates the subscription of the conference event package as specified in IETF RFC 6665 [25], the IWF performing the controlling role: + +- 1) shall send a SIP 200 (OK) response as specified in IETF RFC 6665 [25]; and +- 2) if there are no remaining subscriptions to the event package in the ongoing call in a temporary group session, shall terminate the subscriptions to the conference event package as specified in IETF RFC 6665 [25] in all non-controlling MCPTT functions in the temporary group session. + +Upon expiry of the subscription timer and if there are no remaining subscriptions to the event package in the ongoing call in a temporary group session, the IWF performing the controlling role shall terminate the subscriptions to the conference event package as specified in IETF RFC 6665 [25] in all non-controlling MCPTT functions in the temporary group session. + +### 10.3.4 IWF performing the non-controlling role + +**Editor's Note:** Actions by the IWF performing the non-controlling role are FFS and need to be considered after the other clauses of TS 29.379 dealing with the IWF performing the non-controlling role become stable. + +## 10.4 Remotely initiated group call + +### 10.4.1 Participating MCPTT function procedures + +#### 10.4.1.1 IWF performing the participating role + +##### 10.4.1.1.1 Originating procedures + +Originating procedures are not supported in this version of the specification. + +##### 10.4.1.1.2 Terminating procedures + +Upon receiving a "SIP MESSAGE request for remotely initiated group call for terminating participating function" the IWF performing the participating role shall reject the SIP MESSAGE request with a SIP 501 (Not Implemented) response. + +#### 10.4.1.2 IWF performing the controlling role + +Upon receiving: + +- a "SIP MESSAGE request for remotely initiated group call request for controlling MCPTT function"; or +- a "SIP MESSAGE request for remotely initiated group call response for controlling MCPTT function"; + +the IWF performing the controlling role shall reject the SIP MESSAGE request with a SIP 501 (Not Implemented) response. + +--- + +## 11 Private call call control + +### 11.1 Private call with floor control + +#### 11.1.1 Client derived procedures + +##### 11.1.1.1 On-demand private call + +###### 11.1.1.1.1 Originating procedures + +This clause is referenced from other procedures. + +To establish an MCPTT private call the IWF performing the participating role shall generate an initial SIP INVITE request by following the UE originating session procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) if originating an MCPTT emergency private call or originating an MCPTT private call and the MCPTT emergency state is already set, the IWF performing the participating role, shall comply with the procedures in clause 6.4.2.1; + +- 2) shall include the g.3gpp.mcptt media feature tag and the g.3gpp.icsi-ref media feature tag with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" in the Contact header field of the SIP INVITE request according to IETF RFC 3840 [9]; +- 3) shall include an Accept-Contact header field containing the g.3gpp.mcptt media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 4) shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref contain with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" along with parameters "require" and "explicit" according to IETF RFC 3841 [5]; +- 5) for the establishment of a private call shall insert in the SIP INVITE request a MIME resource-lists body with the MCPTT ID of the invited MCPTT user, according to rules and procedures of IETF RFC 5366 [11]; +- 6) if a security context needs to be established between the IWF and the MCPTT client and if the user homed in the IWF is initiating a private call then: + - a) if necessary, request keying material from the key management server as described in 3GPP TS 33.180 [27]; + - b) shall use the keying material to generate a PCK as described in 3GPP TS 33.180 [27]; + - c) shall use the PCK to generate a PCK-ID with the four most significant bits set to "0000" to indicate that the purpose of the PCK is to protect private call communications and with the remaining twenty-eight bits being randomly generated as described in 3GPP TS 33.180 [27]; + - d) shall encrypt the PCK to a UID associated to the MCPTT client using the MCPTT ID and KMS URI of the invited user and a time related parameter as described in 3GPP TS 33.180 [27]; + +NOTE 1: How the IWF obtains the KMS URI of the invited user is out of scope of the present document. + +- e) shall generate a MIKEY-SAKKE I\_MESSAGE using the encapsulated PCK and PCK-ID as specified in 3GPP TS 33.180 [27]; and + - f) shall add the MCPTT ID of the originating user homed in the IWF to the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [27]; and + - g) shall sign the MIKEY-SAKKE I\_MESSAGE using the originating user homed in the IWF's signing key provided in the keying material together with a time related parameter, and add this to the MIKEY-SAKKE payload, as described in 3GPP TS 33.180 [27]; +- 7) shall include an SDP offer according to 3GPP TS 24.229 [3] with the clarification given in clause 6.1.1 and with a media stream of the offered media-floor control entity; + - 8) if implicit floor control is required, shall comply with the conditions specified in clause 6.7; + - 9) if force of automatic commencement mode at the invited MCPTT client is requested by the user homed in the IWF, shall include in the SIP INVITE request a Priv-Answer-Mode header field with the value "Auto" according to the rules and procedures of IETF RFC 5373 [10]; + - 10) if force of automatic commencement mode at the invited MCPTT client is not requested by the user homed in the IWF: + - a) if automatic commencement mode at the invited MCPTT client is requested by the user homed in the IWF, shall include in the SIP INVITE request an Answer-Mode header field with the value "Auto" according to the rules and procedures of IETF RFC 5373 [10]; and + - b) if manual commencement mode at the invited MCPTT client is requested by the user homed in the IWF, shall include in the SIP INVITE request an Answer-Mode header field with the value "Manual" according to the rules and procedures of IETF RFC 5373 [10]; and + - 11) shall contain an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "private"; and + - 12) if the MCPTT emergency private call state of the user homed in the IWF is set to either "MEPC 2: emergency-pc-requested" or "MEPC 3: emergency-pc-granted" or the MCPTT emergency private priority state for this private call is set to "MEPP 2: in-progress", the IWF shall comply with the procedures in clause 6.4.2.2. + +NOTE 2: Upon receiving a SIP 183(Session Progress) response to the SIP INVITE request the IWF performing the participating role's actions are out of scope of the present document. + +Upon receiving a SIP 200 (OK) response to the SIP INVITE request the IWF performing the participating role: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; +- 2) if the MCPTT emergency private call state is set to "MEPC 2: emergency-pc-requested" or "MEPC 3: emergency-pc-granted", shall perform the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.4, with the IWF acting as the MCPTT client on behalf of the IWF user homed in the IWF; and +- 3) shall consider the call successfully established. + +On receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request: + +- 1) if the MCPTT emergency private call state is set to "MEPC 2: emergency-pc-requested"; or +- 2) if the MCPTT emergency private call state is set to "MEPC 3: emergency-pc-granted"; + +the IWF performing the participating role shall perform the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.5, with the IWF acting as the MCPTT client on behalf of the IWF user homed in the IWF. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing session, the IWF performing the participating role shall follow the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.7 with the IWF acting as the MCPTT client on behalf of the IWF user homed in the IWF. + +#### 11.1.1.1.2 IWF terminating procedures + +This clause is referenced from other procedures. + +The IWF performing the participating role: + +- 1) may reject the SIP INVITE request for any other reason outside the scope of this specification otherwise, continue with the rest of the steps. +- 2) if the SIP INVITE request is rejected in step 1), shall respond towards the controlling MCPTT function either with appropriate reject code as specified in 3GPP TS 24.229 [3] and warning texts as specified in clause 4.2.2 or with SIP 480 (Temporarily unavailable) response and skip the rest of the steps of this clause; +- 3) if the SIP INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - c) shall set the MCPTT emergency private priority state to "MEPP 2: in-progress" for this private call; +- 4) if the SDP offer of the SIP INVITE request contains an "a=key-mgmt" attribute field with a "mikey" attribute value containing a MIKEY-SAKKE I\_MESSAGE: + - a) shall extract the MCPTT ID of the originating MCPTT from the initiator field (IDRi) of the I\_MESSAGE as described in 3GPP TS 33.180 [27]; + - b) shall convert the MCPTT ID to a UID as described in 3GPP TS 33.180 [27]; + - c) shall use the UID to validate the signature of the MIKEY-SAKKE I\_MESSAGE as described in 3GPP TS 33.180 [27]; + - d) if authentication verification of the MIKEY-SAKKE I\_MESSAGE fails, shall reject the SIP INVITE request with a SIP 488 (Not Acceptable Here) response as specified in IETF RFC 4567 [22], and include warning text set to "136 authentication of the MIKEY-SAKKE I\_MESSAGE failed" in a Warning header field as specified in clause 4.4; and + - e) if the signature of the MIKEY-SAKKE I\_MESSAGE was successfully validated: + - i) shall extract and decrypt the encapsulated PCK using the terminating user's (KMS provisioned) UID key as described in 3GPP TS 33.180 [27]; and + - ii) shall extract the PCK-ID, from the payload as specified in 3GPP TS 33.180 [27]; + +NOTE: With the PCK successfully shared between the originating and the terminating parties, the IWF and the MCPTT client are able to use SRTP/SRTCP to create a secure session. + +- 5) shall perform the automatic commencement procedures specified in clause 6.2.1 if one of the following conditions are met: + - a) SIP INVITE request contains an Answer-Mode header field with the value "Auto" and the IWF is configured for automatic commencement mode for the user receiving the call; + - c) SIP INVITE request contains a Priv-Answer-Mode header field with the value of "Auto" and the IWF is able to process an automatic commencement; and +- 6) shall perform the manual commencement procedures specified in clause 6.2.2 if either of the following conditions are met: + - a) SIP INVITE request contains an Answer-Mode header field with the value "Manual" and the IWF is configured for manual commencement mode for the user receiving the call; + - b) SIP INVITE request contains a Priv-Answer-Mode header field with the value of "Manual" and the IWF is able to process a manual commencement. + +Upon receiving the SIP CANCEL request cancelling a SIP INVITE request for which a dialog exists at the IWF performing the participating role and a SIP 200 (OK) response has not yet been sent to the SIP INVITE request then the IWF performing the participating role: + +- 1) shall send a SIP 200 (OK) response to the SIP CANCEL request according to 3GPP TS 24.229 [3]; and +- 2) shall send a SIP 487 (Request Terminated) response to the SIP INVITE request according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP BYE request for an established dialog, the IWF performing the participating role: + +- 1) shall follow the procedures in clause 11.4.1.1. + +#### 11.1.1.1.3 Terminating procedures for reception of SIP re-INVITE request + +This clause is referenced from other procedures. + +Upon receipt of a SIP re-INVITE request for an existing private call session, the IWF performing the participating role shall: + +- 1) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "true": + - b) shall set the MCPTT emergency private priority state to "MEPP 2: in-progress" for this private call; +- 2) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to a value of "false": + - a) if the SIP re-INVITE request contains an application/vnd.3gpp.mcptt-info+xml MIME body including an element: + - i) if the MCPTT ID contained in the element is the MCPTT ID of the receiving MCPTT user, shall set the MCPTT emergency alert state to "MPEA 1: no-alert"; + - b) shall set the MCPTT emergency private priority state to "MEPP 1: no-emergency" for this private call; and + - c) if the MCPTT emergency private call state of the call is set to "MEPC 3: emergency-call-granted", shall set the MCPTT emergency private call state of the call to "MEPC 1: emergency-pc-capable"; +- 3) may check if a Resource-Priority header field is included in the incoming SIP INVITE request and may perform further actions outside the scope of this specification to act upon an included Resource-Priority header field as specified in 3GPP TS 24.229 [3]; and + +NOTE: As this is a re-INVITE for an existing MCPTT private call session, there is no attempt made to change the answer-mode from its current state. + +- 4) include an SDP answer in the SIP 200 (OK) response to the SDP offer in the incoming SIP INVITE request according to 3GPP TS 24.229 [3] with the clarifications given in clause 6.1.2 with the IWF acting as the MCPTT client. + +#### 11.1.1.1.4 MCPTT in-progress emergency cancel + +This clause is referenced from other procedures. + +To cancel the in-progress emergency condition on an MCPTT emergency private call, the IWF performing the participating role shall generate a SIP re-INVITE request by following the UE session procedures specified in 3GPP TS 24.229 [3], with the clarifications given below. + +The IWF performing the participating role: + +- 1) shall, if cancelling an in-progress emergency condition and optionally an MCPTT emergency alert originated for the user homed in the IWF, include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.2.3; +- 2) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.2.2; +- 3) shall include in the SIP re-INVITE request an SDP offer with the media parameters as currently established; +- 4) if an implicit floor request is required, shall indicate this as specified in clause 6.7; and +- 5) shall send the SIP re-INVITE request according to 3GPP TS 24.229 [3]. + +On receiving a SIP 2xx response to the SIP re-INVITE request, the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; +- 2) shall set the MCPTT emergency private priority state of the MCPTT private call to "MEPP 1: no-emergency"; +- 3) shall set the MCPTT emergency private call state of the call to "MEPC 1: emergency-pc-capable"; and +- 4) if the MCPTT emergency alert state is set to "MPEA 4: Emergency-alert-cancel-pending", the sent SIP re-INVITE request did not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body and the SIP 2xx response to the SIP request for a priority group call does not contain a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4 with the warning text containing the mcptt-warn-code set to "149", shall set the MCPTT emergency alert state to "MPEA 1: no-alert". + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request: + +- 1) if the SIP 4xx response, SIP 5xx response or SIP 6xx response contains an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to a value of "true", the IWF performing the participating role shall set the MCPTT emergency private priority state as "MEPP 2: in-progress"; +- 2) if the SIP 4xx response, SIP 5xx response or SIP 6xx response contains an application/vnd.3gpp.mcptt-info+xml MIME body with an <>alert-ind> element set to a value of "true" and the sent SIP re-INVITE request did not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, the IWF performing the participating role shall set the MCPTT emergency alert state to "MPEA 3: emergency-alert-initiated"; and +- 3) if the SIP 4xx response, SIP 5xx response or SIP 6xx response did not contain an application/vnd.3gpp.mcptt-info+xml MIME body, the IWF performing the participating role shall set the MCPTT emergency private priority state as "MEPP 2: in-progress" and the MCPTT emergency alert (MPEA) state shall revert to its value prior to entering the current procedure. + +NOTE: If the in-progress emergency private priority state cancel request is rejected, the state of the session does not change, i.e. continues with MCPTT emergency private call level priority. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.7 with the IWF acting as the MCPTT client. + +#### 11.1.1.1.5 Upgrade to MCPTT emergency private call + +This clause is referenced by other clauses. + +To upgrade the ongoing MCPTT private call to an MCPTT emergency private call, the IWF performing the participating role shall generate a SIP re-INVITE request as specified in 3GPP TS 24.229 [3], with the clarifications given below. + +- 1) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.2.1; +- 2) shall include a Resource-Priority header field and comply with the procedures in clause 6.4.2.2. +- 3) shall include an SDP offer with the media parameters as currently established according to 3GPP TS 24.229 [3]; +- 4) if an implicit floor request is required, shall indicate this as specified in clause 6.7; and +- 5) shall send the SIP re-INVITE request according to 3GPP TS 24.229 [3]. + +On receiving a SIP 2xx response to the SIP re-INVITE request the IWF performing the participating role: + +- 1) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; and +- 2) shall perform the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.4 with the IWF acting as the MCPTT client. + +On receiving a SIP 4xx response, SIP 5xx response or SIP 6xx response to the SIP re-INVITE request, the IWF performing the participating role shall perform the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.5 with the IWF acting as MCPTT client. + +On receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing group session, the IWF performing the participating role shall follow the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.7 with the IWF acting as the MCPTT client. + +### 11.1.2 IWF participating role procedures + +#### 11.1.2.1 Originating procedures + +##### 11.1.2.1.1 On-demand private call + +In the present clause, the IWF performing the participating role initiates an on-demand private call. The IWF performing the participating role: + +- 1) shall determine the MCPTT ID of the calling user; + +NOTE: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. + +- 2) shall determine the public service identity of the controlling MCPTT function for the private call service associated with the originating user's MCPTT ID identity; +- 3) shall generate a SIP INVITE request as specified in clause 11.1.1.1.1; +- 4) shall modify the SIP INVITE as specified in clause 6.6.2.1.2; +- 5) shall set the Request-URI to the public service identity of the controlling MCPTT function hosting the private call service as determined by step 3; +- 6) shall set the element in an application/vnd.3gpp.mcptt-info+xml MIME body of the SIP INVITE request to the MCPTT ID of the calling user; +- 7) if the SIP INVITE request contains an emergency indication set to a value of "true", may include a Resource-Priority header field populated with the values for an emergency call as specified in clause 6.4.1.11; otherwise, may include a Resource-Priority header field populated with the values for a normal call as specified in clause 6.4.1.11; and + +- 8) shall forward the SIP INVITE request, according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP 180 (Ringing) response, the IWF performing the participating role's action are out of scope of the present document. + +Upon receiving a SIP 200 (OK) response, the IWF performing the participating role: + +- 1) shall perform the procedures for receiving a SIP 200 ok as specified in clause 11.1.1.1.1; and +- 2) shall start the SIP session timer according to rules and procedures of IETF RFC 4028 [6]. + +On receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request, the IWF performing the participating role shall follow the procedures for SIP 4xx, SIP 5xx and SIP 6xx responses as specified in clause 11.1.1.1.1. + +Upon receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing session, the IWF performing the participating role shall follow the procedures for SIP INFO as specified in clause 11.1.1.1.1. + +#### 11.1.2.1.2 SIP re-INVITE for MCPTT private call + +Upon deciding to send a SIP re-INVITE for an existing private call session, the IWF performing the participating role: + +- 1) shall determine the MCPTT ID of the calling user; + +NOTE 1: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. + +- 2) if the SIP re-INVITE is to upgrade the call to an emergency call, shall generate a SIP re-INVITE request as specified in clause 11.1.1.1.5; +- 3) if the SIP re-INVITE is to cancel the emergency on the call, shall generate a SIP re-INVITE request as specified in clause 11.1.1.1.4; +- 4) shall set the element in an application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request to the MCPTT ID of the calling user homed in the IWF; + +NOTE 2: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. + +- 5) shall, if the SIP re-INVITE is to be sent within an on-demand session include in the SIP re-INVITE request an SDP containing the current media parameters used by the existing session; +- 6) shall include a Resource-Priority header field as specified in clause 6.4.1.11; and +- 7) shall forward the SIP re-INVITE request, according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP 200 (OK) response, the IWF performing the participating role: + +- 1) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- 2) shall follow the procedures for SIP 200 (OK) response as specified in clause 11.1.1.1.4 if an emergency is being cancelled in the present clause or as specified in clause 11.1.1.1.5 if the call is being upgraded to emergency in the present clause. The IWF performing the participating role shall forward any other SIP response that does not contain SDP, including any MIME bodies contained therein, along the signalling path to the originating network according to 3GPP TS 24.229 [3]. + +On receiving a SIP 4xx response, a SIP 5xx response or a SIP 6xx response to the SIP INVITE request, the IWF performing the participating role shall follow the procedures for SIP 4xx, SIP 5xx and SIP 6xx responses as specified in clause 11.1.1.1.4 if an emergency is being cancelled in the present clause or as specified in clause 11.1.1.1.5 if the call is being upgraded to emergency in the present clause. + +Upon receiving a SIP INFO request where the Request-URI contains an MCPTT session ID identifying an ongoing session, the IWF performing the participating role shall follow the procedures for SIP INFO as specified in clause 11.1.1.1.4 if an emergency is being cancelled in the present clause or as specified in clause 11.1.1.1.5 if the call is being upgraded to emergency in the present clause. + +### 11.1.2.2 Terminating procedures + +Upon receipt of a "SIP INVITE request for terminating participating MCPTT function", the IWF performing the participating role: + +- 1) shall respond with a SIP 488 (not acceptable here) with a body part as described in clause 6.10.2 if the IWF does not support one or more parameters of the call as described in clause 6.10.1; +- 2) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the "SIP INVITE request for terminating participating MCPTT function" with a SIP 500 (Server Internal Error) response. The IWF may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14], and shall not continue with the rest of the steps; + +NOTE: If the received SIP INVITE request contains an emergency indication set to a value of "true", the IWF can choose to accept the request. + +- 3) shall check the presence of the isfocus media feature tag in the URI of the Contact header field and if it is not present then the IWF shall reject the request with a SIP 403 (Forbidden) response with the warning text set to "104 isfocus not assigned" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, and shall not continue with the rest of the steps; +- 4) shall use the MCPTT ID present in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP INVITE request to retrieve the binding between the MCPTT ID and public user identity; and +- 5) the IWF may reject the "SIP INVITE request for terminating participating MCPTT function" with a SIP 403 (Forbidden) response including warning text set to "127 user not authorised to be called in private call" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4. + +The IWF performing the participating role sends the SIP 200 (OK) response to the originating network: + +- 1) shall generate a SIP 200 (OK) response as described in 3GPP TS 24.379 [29], clause 6.3.2.2.4.2; +- 2) shall include in the SIP 200 (OK) response an SDP answer based on the SDP answer in the received SIP 200 (OK) response as specified in 3GPP TS 24.379 [29], clause 6.3.2.2.1; +- 3) shall copy the P-Asserted-Identity header field from the incoming SIP 200 (OK) response to the outgoing SIP 200 (OK) response; +- 4) shall interact with the media plane as specified in 3GPP TS 29.380 [31] clause 6.4; and +- 5) shall forward the SIP 200 (OK) response according to 3GPP TS 24.229 [3]. + +### 11.1.2.3 Receipt of SIP re-INVITE request by terminating participating function + +This clause covers the on-demand session case only. + +Upon receipt of a SIP re-INVITE request for an existing MCPTT private call session the IWF performing the participating role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, shall reject the SIP re-INVITE with a SIP 500 (Server Internal Error) response. The IWF performing the participating role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14] and shall skip the rest of the steps; + +NOTE 1: If the SIP re-INVITE request contains an emergency indication, the IWF performing the participating role can choose to accept the request. + +NOTE 2: As this is the modification of an in-progress MCPTT private call, this procedure does not attempt modification of the existing answer-mode of the call. + +- 2) shall generate a SIP 200 (OK) response as described in 3GPP TS 24.379 [29], clause 6.3.2.2.4.2, with the IWF acting as the participating MCPTT function; +- 3) shall perform the procedures in clause 11.1.1.1.3; + +- 4) shall modify the SDP answer in the received SIP 200 (OK) response as specified in 3GPP TS 24.379 [29], clause 6.3.2.2.2.1 with the IWF acting as the participating function; +- 5) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- 6) shall forward the SIP 200 (OK) response according to 3GPP TS 24.229 [3]. + +### 11.1.3 IWF controlling role procedures + +#### 11.1.3.1 Originating procedures + +This clause describes the procedures for inviting an MCPTT user to an MCPTT session. The procedure is initiated by the IWF performing the controlling role. + +The IWF performing the controlling role: + +- 1) shall generate a SIP INVITE request as specified in clause 6.6.3.1.1; +- 2) shall set the to the calling user's MCPTT ID in the outgoing SIP INVITE; +- 3) if the received request is for an MCPTT emergency private call as determined by clause 6.6.3.1.8.2: + - a) shall set the element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "true"; + - b) if the request is for an MCPTT emergency alert, shall perform the procedures specified in clause 6.6.3.1.7; and + - c) if the request is not for an MCPTT emergency alert, shall set the <>alert-ind> element of the application/vnd.3gpp.mcptt-info+xml MIME body to a value of "false"; +- 4) shall copy the MCPTT ID of the called MCPTT user into the element in the application/vnd.3gpp.mcptt-info+xml MIME body of the outgoing SIP INVITE request; +- 5) shall set the Request-URI to the public service identity of the terminating participating MCPTT function associated to the MCPTT user to be invited; + +NOTE 1: How the IWF performing the controlling role finds the address of the terminating MCPTT participating function is out of the scope of the current release. + +NOTE 2: The terminating MCPTT user is part of a partner MCPTT system, therefore the public service identity can identify an entry point in the partner network that is able to identify the terminating participating MCPTT function. + +- 6) shall include a Resource-Priority header field populated with the values for an MCPTT emergency private call as specified in clause 6.6.3.1.12, if either of the following conditions is met: + - a) if the request is for an MCPTT emergency private call as determined in step 2 above; or + - b) the originating user homed in the IWF is in an in-progress emergency private call state with the targeted MCPTT user; +- 7) shall include an SDP offer according to 3GPP TS 24.229 [3] with the clarification given in clause 6.1.1 and with a media stream of the offered media-floor control entity and according to the procedures specified in 3GPP TS 24.379 [29], clause 6.3.3.1.1 with the IWF acting as the controlling MCPTT function; +- 8) shall send the SIP INVITE request towards the core network according to 3GPP TS 24.229 [3]; and +- 9) shall start a private call timer with a value set to the configured max private call duration for the user. + +Upon receiving SIP 200 (OK) response for the SIP INVITE request the IWF performing the controlling role: + +- 1) shall cache the contact received in the Contact header field; and +- 2) shall interact with the media plane as specified in 3GPP TS 29.380 [31]. + +Upon expiry of the private call timer, the IWF performing the controlling role shall follow the procedure for releasing private call session as specified in clause 11.4.3. + +### 11.1.3.2 Terminating procedures + +In the procedures in this clause: + +- 1) refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; +- 2) refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 3) refers to the element of an application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a "SIP INVITE request for controlling MCPTT function of a private call", the IWF performing the controlling role: + +- 1) if the in the SIP INVITE request is set to "private": + - a) shall check whether the public service identity contained in the Request-URI is allocated for private call and perform the actions specified in clause 6.6.6.1 if it is not allocated and skip the rest of the steps; and + - b) shall perform actions to verify the MCPTT ID of the inviting MCPTT user in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP INVITE request, and authorise the request according to local policy, and if it is not authorised the IWF performing the controlling role shall return a SIP 403 (Forbidden) response with the warning text as specified in "Warning header field" and skip the rest of the steps; +- 2) if the incoming SIP INVITE request does not contain an application/resource-lists MIME body shall reject the SIP INVITE request with a SIP 403 (Forbidden) response including warning text set to "145 unable to determine called party" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, and shall not continue with the rest of the steps; +- 3) if the is set to "private" and the application/resource-lists MIME body contains more than one element, shall reject the "SIP INVITE request for controlling MCPTT function of a private call" with a SIP 403 (Forbidden) response including warning text set to "145 unable to determine called party" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, and shall not continue with the rest of the steps; +- 4) shall validate that the received SDP offer includes at least one media stream for which the media parameters and at least one codec or media format is acceptable by the IWF performing the controlling role and if not, reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; +- 5) if received SIP INVITE request includes an , shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17, with the IWF acting as the controlling function; +- 6) if the received SIP INVITE request contains an unauthorised request for an MCPTT emergency private call as determined by clause 6.6.3.1.8.2: + - a) shall reject the SIP INVITE request with a SIP 403 (Forbidden) response as specified in clause 6.6.3.1.9; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 7) if a Resource-Priority header field is included in the received SIP INVITE request and if the Resource-Priority header field is set to the value indicated for emergency calls, shall reject the SIP INVITE request with a SIP 403 (Forbidden) response and skip the remaining steps if neither one of the following conditions are true: + - a) the SIP INVITE request does not contain an authorised request for an MCPTT emergency call as determined in step 4 above; or + - b) the originating MCPTT user is not in an in-progress emergency private call state with the targeted MCPTT user; +- 8) if: + - a) the received SIP INVITE request contains an emergency indication set to a value of "true"; + +- b) the originating MCPTT user is not in an in-progress emergency private call state with the targeted user homed in the IWF; and + - c) if the in the SIP INVITE request is set to "private"; +- then: +- a) shall cache the information that the MCPTT user has initiated an MCPTT emergency private call to the targeted user; and + - b) shall cache the information that the MCPTT user is in an in-progress emergency private call state with the targeted user homed in the IWF; +- 9) shall perform actions as described in 3GPP TS 24.379 [29], clause 6.3.3.2.2, with the IWF acting as the controlling MCPTT function; + - 10) shall allocate an MCPTT session identity for the MCPTT session; and + - 11) shall set up a private call with the targeted user homed in the IWF (the user whose MCPTT ID is listed in the MIME resource-lists body of received SIP INVITE request). + +NOTE 1: How the IWF sets up calls internally is out of scope of the present document. + +Upon deciding to send a SIP 180 (Ringing) response and if the SIP 180 (Ringing) response or the SIP final response has not yet been sent to the inviting MCPTT client, the IWF performing the controlling role shall generate a SIP 180 (Ringing) response to the SIP INVITE request and send the SIP 180 (Ringing) response towards the inviting MCPTT client according to 3GPP TS 24.229 [3]. + +Upon deciding to accept the call, the IWF performing the controlling role: + +- 1) shall generate a SIP 200 (OK) response to the SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.2, with the IWF acting as the MCPTT controlling function, before continuing with the rest of the steps; +- 2) shall include in the SIP 200 (OK) response an SDP answer to the SDP offer in the incoming SIP INVITE request as specified in the 3GPP TS 24.379 [29] clause 6.3.3.2.2, with the IWF acting as the controlling MCPTT function; +- 3) if the received SIP INVITE request contains an alert indication set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling function; + +NOTE 2: This is the case when the MCPTT user's request for an MCPTT emergency private call was granted but the request for the MCPTT emergency alert was denied. + +- 4) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + +NOTE 3: Resulting media plane processing is completed before the next step is performed. + +- 5) shall send a SIP 200 (OK) response towards the inviting MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, where the SIP 200 (OK) response was sent with a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4, with the IWF acting as the controlling function with the warning text containing the mcptt-warn-code set to "149", the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.11. + +Upon receiving a SIP BYE request from the originating MCPTT client containing an application/vnd.3gpp.mcptt-info+xml MIME body containing a element set to a value of "authentication of the MIKEY-SAKE I\_MESSAGE failed", the IWF performing the controlling role shall follow the procedures in clause 6.6.3.2.1. + +### 11.1.3.3 Receiving a SIP re-INVITE for upgrade to emergency private call + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP re-INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) alert indication in an incoming SIP re-INVITE request refers to the <>alert-ind> element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receiving a SIP re-INVITE request with an emergency indication set to a value of "true", the IWF performing the controlling role: + +- 1) shall validate that the received SDP offer includes at least one media stream for which the media parameters and at least one codec or media format is acceptable by the IWF performing the controlling role and if not, reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; +- 2) shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17 with the IWF acting as the MCPTT server; +- 3) if the SIP re-INVITE request contains an unauthorised request for an MCPTT emergency private call as determined by clause 6.6.3.1.8.2: + - a) shall reject the SIP INVITE request with a SIP 403 (Forbidden) response as specified in clause 6.6.3.1.9; and + - b) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 4) if the SIP re-INVITE request contains an emergency indication set to a value of "true" and the originating MCPTT user is not in an in-progress emergency private call state with the targeted user: + - a) shall cache the information that the MCPTT user is in an in-progress emergency private call state with the targeted user; and + - b) if the SIP re-INVITE request contains an alert indication set to "true", shall cache the information that the MCPTT user has sent an MCPTT emergency alert to the targeted user; and +- 5) shall perform the steps in clause 11.1.2.3 with the IWF performing the participating role but shall not forward the SIP 200 (OK) response. + +If the SIP response has not yet been sent towards the inviting MCPTT client, the IWF performing the controlling role: + +- 1) shall modify the SIP 200 (OK) response to the SIP re-INVITE request as specified in 3GPP TS 24.379 [29], clause 6.3.3.2.3.2 with the IWF acting as the controlling function before continuing with the rest of the steps; +- 2) if the received SIP re-INVITE request contains an alert indication set to a value of "true" and this is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4 with the IWF acting as the MCPTT server. + +NOTE: When a SIP 200 (OK) response sent towards the originator as a response to a SIP INVITE request that contained authorised request(s) for an MCPTT emergency private call and optionally an MCPTT emergency alert, the originator will consider a SIP 200 (OK) response populated in this manner as confirmation that its request(s) for an upgrade to an MCPTT emergency private call and optionally an MCPTT emergency alert were accepted by the IWF performing the controlling role. + +- 3) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- 4) shall send the SIP 200 (OK) response towards the inviting MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, and the SIP 200 (OK) response was sent with the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4 with the IWF acting as the MCPTT server, the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.11. + +#### 11.1.3.4 Receiving a SIP re-INVITE for cancellation of emergency private call + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) alert indication in an incoming SIP INVITE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receiving a SIP re-INVITE request with an emergency indication set to a value of "false", the IWF performing the controlling role: + +- 1) shall validate that the received SDP offer includes at least one media stream for which the media parameters and at least one codec or media format is acceptable by the IWF performing the controlling role and if not, reject the request with a SIP 488 (Not Acceptable Here) response and skip the rest of the steps; +- 2) shall validate the request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.17 with the IWF acting as the controlling function; +- 3) if the SIP re-INVITE request contains an unauthorised request for an MCPTT emergency private call cancellation as determined by local policy: + - a) shall reject the SIP re-INVITE request with a SIP 403 (Forbidden) response; + - b) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 with an element set to a value of "true"; + - c) if the SIP re-INVITE request contains an alert indication set to "false" and this is an unauthorised request for an MCPTT emergency alert cancellation as determined by local policy, shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body with an element set to "true"; and + - d) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; +- 4) if the SIP re-INVITE request contains an authorised request for an MCPTT emergency private call cancellation as determined by clause 6.6.3.1.8.4: + - a) shall clear the cache of the MCPTT ID of the originator of the MCPTT emergency private call that is no longer in an in-progress emergency private call state with the targeted user; and + - b) if the SIP re-INVITE request contains an alert indication set to "false" and this is an authorised request for an MCPTT emergency alert cancellation meeting the conditions specified in clause 6.6.3.1.8.3: + - i) if the received SIP re-INVITE request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, shall clear the cache of the MCPTT ID of user identified by the element as having an outstanding MCPTT emergency alert; and + - ii) if the received SIP re-INVITE request does not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, clear the cache of the MCPTT ID of the sender of the SIP re-INVITE request as having an outstanding MCPTT emergency alert; and +- 5) shall perform the steps in clause 11.1.2.3 but shall not forward the SIP 200 (OK) response. + +If the SIP response has not yet been sent towards the inviting MCPTT client, the IWF performing the controlling role: + +- 1) shall modify the SIP 200 (OK) response to the SIP re-INVITE request as specified in 3GPP TS 24.379 [29], clause 6.3.3.2.3.2 with the IWF acting as the controlling function before continuing with the rest of the steps; +- 2) if the received SIP re-INVITE request contains an alert indication set to a value of "false" and this is an unauthorised request for an MCPTT emergency alert cancellation as specified in clause 6.6.3.1.8.3, shall include in the SIP 200 (OK) response the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4 with the IWF acting as the MCPTT server. + +NOTE: When a SIP 200 (OK) response sent towards the originator as a response to a SIP INVITE request that contained authorised request(s) for an MCPTT emergency private call cancellation and optionally an MCPTT emergency alert cancellation, the originator will consider a SIP 200 (OK) response populated in this manner as confirmation that its request(s) for cancellation of an MCPTT emergency private call and optionally an MCPTT emergency alert were accepted by the IWF performing the controlling role. + +- 3) shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- 4) shall send the SIP 200 (OK) response towards the inviting MCPTT client according to 3GPP TS 24.229 [3]. + +Upon receiving a SIP ACK to the SIP 200 (OK) response sent towards the inviting MCPTT client, and the SIP 200 (OK) response was sent with the warning text set to "149 SIP INFO request pending" in a Warning header field as specified in 3GPP TS 24.379 [29], clause 4.4 with the IWF acting as the MCPTT server, with the IWF acting as the controlling function shall follow the procedures in clause 6.6.3.1.11. + +### 11.1.3.5 Sending a SIP re-INVITE for upgrade to emergency private call + +This clause describes the procedures for sending a re-INVITE request to an MCPTT user in an MCPTT private call for the purpose of upgrading the session to an emergency private call session. The procedure is initiated by the IWF performing the controlling role. + +The IWF performing the controlling role: + +- 1) shall generate a SIP re-INVITE request as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.9, with the IWF acting as the controlling function; +- 2) if the originating user homed in the IWF is not in an in-progress emergency private call state with the targeted MCPTT user: + - a) shall cache the information that the user homed in the IWF is in an in-progress emergency private call state with the targeted MCPTT user; and + - b) if this is a request for an MCPTT emergency alert, shall cache the information that the user homed in the IWF has sent an MCPTT emergency alert to the targeted user; +- 3) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.2.1; +- 4) if an implicit floor request is required, shall indicate this as specified in clause 6.7 and may include an application/vnd.3gpp.mcptt-location-info+xml MIME body with a element included in the root element; +- 5) shall set the element in an application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request to the MCPTT ID of the calling user homed in the IWF; + +NOTE 1: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. + +- 6) shall include in the SIP re-INVITE request an SDP containing the current media parameters used by the existing session; +- 7) if this is a request for an MCPTT emergency alert: + - a) shall determine the value of the user's Mission Critical Organization identity; and. + +NOTE 2: How the IWF determines the user's Mission Critical Organization identity is out of scope of the present document; + +- b) shall include in the element containing the element containing an element set to the value of the user's Mission Critical Organization identity; +- 8) shall include a Resource-Priority header field populated with the values for an MCPTT emergency private call as specified in clause 6.6.3.1.12; and +- 9) shall send the SIP re-INVITE request towards the core network according to 3GPP TS 24.229 [3]. + +Upon receiving SIP 200 (OK) response for the SIP re-INVITE request the IWF performing the controlling role: + +- 1) shall cache the contact received in the Contact header field; +- 2) shall interact with the user plane as specified in 3GPP TS 29.380 [31]; and + +- 3) shall perform the actions specified in 3GPP TS 24.379 [29], clause 6.2.8.3.4 with the IWF acting as the MCPTT client. + +### 11.1.3.6 Sending a SIP re-INVITE for cancellation of emergency private call + +This clause describes the procedures for sending a re-INVITE request to an MCPTT user in an MCPTT emergency private call for the purpose of downgrading the session to a normal priority private call session. The procedure is initiated by the IWF performing the controlling role. + +The IWF performing the controlling role: + +- 1) shall generate a SIP re-INVITE request as specified 3GPP TS 24.379 [29], clause 6.3.3.1.9, with the IWF acting as the controlling function; + - 2) shall clear the cache of the MCPTT ID of the originator of the MCPTT emergency private call that is no longer in an in-progress emergency private call state with the targeted user; + - 3) if this is a request for an MCPTT emergency alert cancellation, shall clear the cache of the MCPTT ID of user homed in the IWF as having an outstanding MCPTT emergency alert; + - 4) shall include an application/vnd.3gpp.mcptt-info+xml MIME body populated as specified in clause 6.4.2.3; + - 5) if an implicit floor request is required, shall indicate this as specified in clause 6.7; + - 6) shall set the element in an application/vnd.3gpp.mcptt-info+xml MIME body of the SIP re-INVITE request to the MCPTT ID of the calling user homed in the IWF; +- NOTE: How the IWF determines the MCPTT ID of a user homed in the IWF is out of scope of the present document. +- 7) shall include in the SIP re-INVITE request an SDP containing the current media parameters used by the existing session; + - 8) shall include a Resource-Priority header field populated with the values for a normal MCPTT private call as specified in clause 6.6.3.1.12; and + - 9) shall send the SIP re-INVITE request towards the core network according to 3GPP TS 24.229 [3]. + +Upon receiving SIP 200 (OK) response for the SIP re-INVITE request the IWF performing the controlling role: + +- 1) shall cache the contact received in the Contact header field; +- 2) shall set the MCPTT emergency private priority state of the MCPTT private call to "MEPP 1: no-emergency"; +- 3) shall set the MCPTT emergency private call state of the call to "MEPC 1: emergency-pc-capable"; and +- 4) shall interact with the user plane as specified in 3GPP TS 29.380 [31]. + +## 11.2 Private call without floor control + +### 11.2.1 Participating role procedures + +#### 11.2.1.1 Originating procedures + +To request a private call without floor control, the IWF performing the participating role shall follow the procedures as specified in clause 11.1.2.1.1 for an on-demand session but with an SDP offer not including media-level section for media-floor control entity. + +#### 11.2.1.2 Terminating procedures + +Upon receipt of a "SIP INVITE request for terminating participating MCPTT function" for the private call with SDP offer not including media-level section for media-floor control entity, the IWF performing the participating role + +consider it as the request for the private call without floor control and shall follow the procedures as specified in clause 11.1.2.2. + +## 11.2.2 Controlling role procedures + +### 11.2.2.1 Originating procedures + +The IWF performing the controlling role shall follow the procedures as specified in clause 11.1.3.1. + +## 11.3 Ending the private call initiated by a client + +### 11.3.1 IWF performing the participating role procedures + +#### 11.3.1.1 Terminating procedures + +##### 11.3.1.1.1 Receipt of SIP BYE request for private call on-demand + +Upon receiving a SIP BYE request from the controlling MCPTT function, the IWF performing the participating role shall follow the procedures as specified in clause 6.6.2.2.2.1. + +## 11.4 Ending the private call initiated by the MCPTT server + +### 11.4.1 Client derived procedures + +#### 11.4.1.1 Receiving a SIP BYE request for private call session + +Upon receiving a SIP BYE request for private call session, the IWF shall follow the procedures as specified in clause 6.3. + +### 11.4.2 IWF participating role procedures + +#### 11.4.2.1 Terminating procedures + +##### 11.4.2.1.1 Receipt of SIP BYE request for private call on-demand + +Upon receiving a SIP BYE request from the controlling MCPTT function, the IWF performing the participating role shall follow the procedures as specified in clause 6.6.2.2.2.1. + +### 11.4.3 IWF controlling role procedures + +When the MCPTT session for private call needs to be released as specified in clause 6.6.7.2 with the IWF acting as the controlling MCPTT function, the IWF performing the controlling role shall follow the procedures in clause 6.6.3.1.2. + +## 12 Emergency alert + +### 12.1 IWF performing the participating role procedures + +#### 12.1.1 IWF to send SIP MESSAGE request for emergency notification + +When the IWF performing originating participating role needs to send a SIP MESSAGE request for emergency notification, the IWF: + +- 1) void; +- 2) if the MCPTT ID for which the SIP MESSAGE is sent is not affiliated with the MCPTT group as determined by clause 9.2.1.2.8, shall perform the actions specified in clause 9.2.1.2.9 for implicit affiliation; +- 3) if the actions for implicit affiliation specified in step 2) above were performed but not successful, shall skip the rest of the steps. +- 4) shall determine the public service identity of the controlling MCPTT function associated with the group identity in the received request for emergency notification; +- 5) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [3] and IETF RFC 3428 [18]; +- 6) shall set the Request-URI of the outgoing SIP MESSAGE request to the public service identity of the controlling MCPTT function associated with the MCPTT group; +- 7) shall include an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 included in the outgoing SIP MESSAGE request based on information received from signalling received from the originating LMR user and its network entities; +- 8) shall set the element of the element containing the element to the MCPTT ID of the user homed in the IWF; +- 9) if location information is available in the received request for emergency notification, include an application/vnd.3gpp.mcptt-location-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.3 in the outgoing SIP MESSAGE request; +- 10) shall set the P-Asserted-Identity in the outgoing SIP MESSAGE request to the public service identity of the IWF; and +- 11) shall send the SIP MESSAGE request as specified to 3GPP TS 24.229 [3]. + +Upon receipt of a SIP 2xx response to the SIP MESSAGE request: + +- 1) if the procedures of clause 9.2.1.2.9 for implicit affiliation were performed in the present clause, shall complete the implicit affiliation by performing the procedures of clause 9.2.1.2.10. + +Upon receipt of a SIP 4xx, 5xx or 6xx response to the sent SIP MESSAGE request and if the implicit affiliation procedures of clause 9.2.1.2.9 were invoked in the present clause, the IWF shall perform the procedures of clause 9.2.1.2.11. + +#### 12.1.2 Receipt of a SIP MESSAGE request for emergency notification for terminating LMR user + +In the procedures in this clause: + +- 1) emergency indication in an incoming SIP MESSAGE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body; and +- 2) alert indication in an incoming SIP MESSAGE request refers to the element of the application/vnd.3gpp.mcptt-info+xml MIME body. + +Upon receipt of a "SIP MESSAGE request for emergency notification for terminating participating MCPTT function", the IWF performing the participating role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The IWF performing the participating role may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14] and skip the rest of the steps; + +NOTE 1: if the SIP MESSAGE request contains an emergency indication set to a value of "true" or an alert indication set to a value of "true", the IWF can by means beyond the scope of this specification choose to accept the request. + +- 2) shall use the MCPTT ID present in the element of the application/vnd.3gpp.mcptt-info+xml MIME body of the incoming SIP MESSAGE request to determine the terminating target; and +- 3) if the terminating target is not served by the IWF the IWF shall reject the SIP MESSAGE request with a SIP 404 (Not Found) response. + +NOTE 2: LMR specific signalling is outside the scope of this specification. + +The IWF shall generate a SIP 2xx response and follow the procedures specified in 3GPP TS 24.229 [3]. + +### 12.1.3 Receipt of a SIP MESSAGE request indicating successful delivery of emergency notification + +Upon receipt of an indication for successful delivery of an emergency notification, internal actions performed by the IWF performing the terminating participating role are out of scope of the present document. + +## 12.2 IWF controlling role procedures + +### 12.2.1 Handling of a SIP MESSAGE request for emergency notification + +Upon receipt of a "SIP MESSAGE request for emergency notification for controlling MCPTT function", the IWF performing the controlling role: + +- 1) if unable to process the request due to a lack of resources or a risk of congestion exists, may reject the SIP MESSAGE request with a SIP 500 (Server Internal Error) response. The controlling MCPTT function may include a Retry-After header field to the SIP 500 (Server Internal Error) response as specified in IETF RFC 3261 [14]. Otherwise, continue with the rest of the steps; + +NOTE: If the SIP MESSAGE request contains an alert indication set to a value of "true", the controlling MCPTT function can, according to local policy, choose to accept the request. + +- 2) shall reject the SIP request with a SIP 403 (Forbidden) response and not process the remaining steps if an Accept-Contact header field does not include the g.3gpp.icsi-ref media feature tag containing the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt"; +- 3) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false", shall perform the procedures specified in clause 12.2.2 and skip the rest of the steps; +- 4) if the received SIP MESSAGE request contains an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "true": + - a) if the received SIP MESSAGE request is an unauthorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1 shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response to the SIP MESSAGE request as specified in 3GPP TS 24.229 [3] with the following clarifications: + - i) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29], clause F.1 of 3GPP TS 24.379 [29] with the element containing the element with the element set to a value of "false"; and + +- ii) shall send the SIP 403 (Forbidden) response as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; and +- b) if the received SIP MESSAGE request is an authorised request for an MCPTT emergency alert as specified in clause 6.6.3.1.8.1: + - i) if the sending MCPTT user identified by the element included in the application/vnd.3gpp.mcptt-info+xml MIME body is not affiliated with the MCPTT group identified by the element of the MIME body as determined by the procedures of 3GPP TS 24.379 [29], clause 6.3.6, with the IWF acting as the MCPTT server: + - I) shall check if the MCPTT user is eligible to be implicitly affiliated with the MCPTT group as determined by clause 9.2.1.3.6; + - II) if the MCPTT user is determined not to be eligible to be implicitly affiliated to the MCPTT group shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response with the warning text set to "120 user is not affiliated to this group" in a Warning header field as specified in clause 4.4 and skip the rest of the steps below; or + - III) if the procedures of clause 9.2.1.3.6 determined the MCPTT user to be eligible to be implicitly affiliated to the MCPTT group shall, perform the implicit affiliation as specified in clause 9.2.1.3.7; + - ii) for each of the other affiliated members of the group: + - A) generate an outgoing SIP MESSAGE request notification of the MCPTT user's emergency alert indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11, with the IWF acting as the controlling MCPTT function, with the clarifications of clause 6.6.3.1.7; + - B) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to the value of the element in the received SIP MESSAGE request; and + - C) send the SIP MESSAGE request according to according to rules and procedures of 3GPP TS 24.229 [3]; + - iii) shall generate a SIP 200 (OK) response to the received SIP MESSAGE request as specified in 3GPP TS 24.229 [3] with the following clarifications: + - A) shall cache the information that the MCPTT user has initiated an MCPTT emergency alert; + - iv) shall send the SIP 200 (OK) response to the received SIP MESSAGE according to rules and procedures of 3GPP TS 24.229 [3]. + - v) shall generate a SIP MESSAGE request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.20, with the IWF acting as the controlling MCPTT function, to indicate successful receipt of an emergency alert, and shall include in the application/vnd.3gpp.mcptt-info+xml MIME body: + - A) the element set to a value of "true"; + - B) the element set to a value of true; and + - C) the element with the MCPTT client ID that was included in the incoming SIP MESSAGE request; and + - vi) shall send the SIP MESSAGE request according to according to rules and procedures of 3GPP TS 24.229 [3]. + +Upon receipt of SIP 2xx responses to the outgoing SIP MESSAGE requests, the controlling MCPTT function shall follow the procedures specified in 3GPP TS 24.229 [3]. + +If the IWF performing the controlling role needs to generate a SIP MESSAGE request for emergency notification, the IWF performing the controlling role: + +- 1) for each of the affiliated MCPTT group members: + +- a) shall generate an outgoing SIP MESSAGE request notification of the MCPTT user's emergency alert indication as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11 with the IWF acting as the controlling MCPTT function, with the clarifications of clause 6.6.3.1.7; +- b) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element; and +- c) shall send the SIP MESSAGE request according to according to rules and procedures of 3GPP TS 24.229 [3]; + +## 12.2.2 Handling of a SIP MESSAGE request for emergency alert cancellation + +Upon receipt of a "SIP MESSAGE request for emergency notification for controlling MCPTT function" containing an application/vnd.3gpp.mcptt-info+xml MIME body with the element set to a value of "false", the IWF performing the controlling role: + +- 1) if the received SIP MESSAGE request is an unauthorised request for an MCPTT emergency alert cancellation as specified in clause 6.6.3.1.8.1: + - a) and if the received SIP MESSAGE request does not contain an element or is an unauthorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.8.4, shall reject the SIP MESSAGE request with a SIP 403 (Forbidden) response to the SIP MESSAGE request as specified in 3GPP TS 24.229 [3] with the following clarifications: + - i) shall include in the SIP 403 (Forbidden) response an application/vnd.3gpp.mcptt-info+xml MIME body as specified in 3GPP TS 24.379 [29] clause F.1 with the element containing the element with the element set to a value of "true"; + - ii) if the received SIP MESSAGE request contains an element of the element set to a value of "false" and if the in-progress emergency state of the group is set to a value of "true" and this is an unauthorised request for an MCPTT emergency call cancellation as determined in step i) above, shall include an element set to a value of "true" in the application/vnd.3gpp.mcptt-info+xml MIME body in the SIP 403 (Forbidden) response; and + - iii) shall send the SIP 403 (Forbidden) response according to rules and procedures of 3GPP TS 24.229 [3] and skip the rest of the steps; and + - b) and if the received SIP MESSAGE request contains an element and is an authorised request for an MCPTT emergency call cancellation as specified in 3GPP TS 24.379 [29] clause 6.6.3.1.8.4 and the in-progress emergency state of the MCPTT group is set to a value of "true": + - i) shall set the in-progress emergency state of the group to a value of "false"; + - ii) shall clear the cache of the MCPTT ID of the MCPTT user that triggered the setting of the in-progress emergency state of the MCPTT group to "true"; + - iii) shall generate SIP re-INVITE request to the other affiliated and joined members of the MCPTT group as specified in clause 6.6.3.1.3. The IWF performing the controlling role: + - A) for each affiliated and joined member shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) upon receiving a SIP 200 (OK) response to the SIP re-INVITE request shall interact with the media plane as specified in 3GPP TS 29.380 [31]; + - iv) for each of the affiliated but not joined members of the group: + - A) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11 with the IWF acting as the controlling MCPTT function; + - B) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to the value of the element in the received SIP MESSAGE request; and + +- C) shall include an element set to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; + - v) shall generate a SIP 200 (OK) response to the received SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; + - vi) shall send the SIP 200 (OK) response to the received SIP MESSAGE as specified in 3GPP TS 24.229 [3] and skip the rest of the steps; + - vii) shall generate a SIP MESSAGE request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.20 with the IWF acting as the controlling MCPTT function to indicate successful receipt of the request for emergency alert cancellation + - viii) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body of the SIP MESSAGE request: + - A) the <>alert-ind> element set to a value of "true"; + - B) the <>alert-ind-rcvd> element set to a value of true; + - C) the element set to a value of "false"; and + - D) the element with the MCPTT client ID that was included in the incoming SIP MESSAGE request; and + - ix) shall send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [3]; and +- 2) if the received SIP MESSAGE request is an authorised request for an MCPTT emergency alert cancellation as specified in clause 6.6.3.1.8.1: +- a) if the received SIP MESSAGE request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, shall clear the cache of the MCPTT ID of the MCPTT user identified by the element as having an outstanding MCPTT emergency alert; + - b) if the received SIP MESSAGE request does not contain an element in the application/vnd.3gpp.mcptt-info+xml MIME body, clear the cache of the MCPTT ID of the sender of the SIP MESSAGE request as having an outstanding MCPTT emergency alert; + - c) if the received SIP MESSAGE request does not contain an element or is an unauthorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.8.4, for each of the affiliated but not joined members of the group: + - i) shall generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency alert as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11 with the IWF acting as the controlling MCPTT function; + - ii) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to the value of the element in the received SIP MESSAGE request; + - iii) if the received SIP MESSAGE request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, shall copy the contents of the received element to an element in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; + - iv) shall include an <>alert-ind> element set to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; and + - v) send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; + - d) if the received SIP MESSAGE request contains an element and is an authorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.8.4 and the in-progress emergency state of the MCPTT group is set to a value of "true": + - i) shall set the in-progress emergency state of the group to a value of "false"; + +- ii) cache the information that the MCPTT user has cancelled the outstanding in-progress emergency state of the group; +- iii) shall generate SIP re-INVITES requests to the other affiliated and joined members of the MCPTT group as specified in clause 6.6.3.1.3. The MCPTT controlling function: + - A) for each affiliated and joined member shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - B) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and +- iv) for each of the affiliated but not joined members of the group shall: + - A) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11 with the IWF acting as the controlling MCPTT function; + - B) include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to the value of the element in the received SIP MESSAGE request; + - C) if the received SIP MESSAGE request contains an element in the application/vnd.3gpp.mcptt-info+xml MIME body, copy the contents of the received element to an element in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; + - D) include in the application/vnd.3gpp.mcptt-info+xml MIME body an <>alert-ind> element set to a value of "false"; and + - E) shall include an element set to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; +- e) shall generate a SIP 200 (OK) response to the received SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; +- f) shall send the SIP 200 (OK) response to the received SIP MESSAGE as specified in 3GPP TS 24.229 [3]. +- g) shall generate a SIP MESSAGE request as described in 3GPP TS 24.379 [29], clause 6.3.3.1.20 with the IWF acting as the controlling MCPTT function to indicate successful receipt of the request for emergency alert cancellation; +- h) shall include in the application/vnd.3gpp.mcptt-info+xml MIME body, the <>alert-ind> element set to a value of "false" and the <>alert-ind-revcd> set to "true"; +- i) shall populate the element with the MCPTT client ID that was included in the incoming SIP MESSAGE request; +- j) if the received SIP MESSAGE request contains an element of the element set to a value of "false": + - i) if this is an authorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.8.4, shall include an element set to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; and + - B) otherwise, if this is an unauthorised request for an MCPTT emergency call cancellation as specified in clause 6.6.3.1.8.4, and the in-progress emergency state of the group is set to a value of "true", shall include an element set to a value of "true" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; and +- k) shall send the SIP MESSAGE request according to the rules and procedures of 3GPP TS 24.229 [3]. + +Upon receipt of SIP 2xx responses to the outgoing SIP MESSAGE requests, the IWF performing the controlling role shall follow the procedures specified in 3GPP TS 24.229 [3]. + +If the IWF performing the controlling role needs to generate a SIP MESSAGE for emergency alert cancellation, the IWF performing the controlling role: + +- 1) if the in-progress emergency state of the MCPTT group is set to a value of "false", for each of the affiliated but not joined MCPTT members of the group: + - a) shall generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency alert as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11 with the IWF acting as the controlling MCPTT function; + - b) shall include an element in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request set to the MCPTT ID of the user homed in the IWF; + - c) shall include an <>alert-ind> element set to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; and + - d) shall send the SIP MESSAGE request as specified in 3GPP TS 24.229 [3]; +- 2) if the in-progress emergency state of the MCPTT group is set to a value of "true": + - a) shall set the in-progress emergency state of the group to a value of "false"; + - b) cache the information that the outstanding in-progress emergency state of the group has been cancelled; + - c) shall generate SIP re-INVITE requests to the other affiliated and joined MCPTT members of the MCPTT group as specified in clause 6.6.3.1.3. The IWF performing the controlling function: + - i) for each affiliated and joined MCPTT member shall send the SIP re-INVITE request towards the MCPTT client as specified in 3GPP TS 24.229 [3]; and + - ii) Upon receiving a SIP 200 (OK) response to the SIP re-INVITE request shall interact with the media plane as specified in 3GPP TS 29.380 [31]; and + - d) for each of the affiliated but not joined MCPTT members of the group shall: + - i) generate a SIP MESSAGE request notification of the cancellation of the MCPTT user's emergency call as specified in 3GPP TS 24.379 [29], clause 6.3.3.1.11 with the IWF acting as the controlling MCPTT function; + - ii) include in the application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to MCPTT ID of the user home in the IWF; + - iii) include in the application/vnd.3gpp.mcptt-info+xml MIME body an <>alert-ind> element set to a value of "false"; and + - iv) shall include an element set to a value of "false" in the application/vnd.3gpp.mcptt-info+xml MIME body in the outgoing SIP MESSAGE request; and +- 3) shall send the SIP MESSAGE requests according to the rules and procedures of 3GPP TS 24.229 [3]. + +Upon receipt of SIP 2xx responses to the outgoing SIP MESSAGE requests, the IWF performing the controlling role shall follow the procedures specified in 3GPP TS 24.229 [3]. + +--- + +## 13 Location procedures + +### 13.1 General + +It is outside the scope of this specification how the IWF performing the participating role configures a participant homed in the IWF to provide location information or how the IWF performing the participating role explicitly request a participant homed in the IWF to provide location information. + +## 13.2 IWF participating role location procedures + +### 13.2.1 General + +The IWF performing participating role provides procedures to send a location information report from a participant homed in the IWF. + +### 13.2.2 Location reporting configuration + +Procedures for configuration of location reporting of participants homed in the IWF are out of scope of the current document. + +### 13.2.3 Location reporting request + +Procedures for requesting participants homed in the IWF to report location information are out of scope of the current document. + +### 13.2.4 Location information report + +The IWF performing the participating role uses location information of users homed in the IWF as appropriate. + +--- + +## 14 Handling of Interworking Security Data messages + +### 14.1 IWF + +#### 14.1.1 IWF originates Interworking Security Data message + +Upon deciding to send an Interworking Security Data message, the IWF: + +- 1) shall generate a SIP MESSAGE request in accordance with 3GPP TS 24.229 [3] and IETF RFC 3428 [18]; +- 2) shall include an Accept-Contact header field containing the g.3gpp.mcptt media feature tag along with the "require" and "explicit" header field parameters according to IETF RFC 3841 [5]; +- 3) the IWF shall include an Accept-Contact header field with the media feature tag g.3gpp.icsi-ref with the value of "urn:urn-7:3gpp-service.ims.icsi.mcptt" along with parameters "require" and "explicit" according to IETF RFC 3841 [5]; +- 4) shall include an application/vnd.3gpp.mcptt-info+xml MIME body with the element containing the element with the element set to the value of the MCPTT ID of the targeted MCPTT user; and +- 5) shall include the ICSI value "urn:urn-7:3gpp-service.ims.icsi.mcptt" (coded as specified in 3GPP TS 24.229 [3]), in a P-Asserted-Service-Id header field according to IETF RFC 6050 [7]; +- 6) shall set the Request-URI to the address of the terminating participating function associated with the MC service ID of the targeted MC service user; +- 7) shall include a P-Asserted-Identity header field set to the public service identity of the IWF; +- 8) shall include an application/vnd.3gpp.interworking-data MIME body with the Interworking Security Data message payload as defined in clause 14.2.1; +- 9) if a security context between the MCPTT client and the IWF needs to be established and the security context does not exist or if the existing security context has expired, procedures in clause 11.2.2 in 3GPP TS 33.180 [29] shall be followed; and +- 10) send the SIP MESSAGE request according to rules and procedures of 3GPP TS 24.229 [3]. + +## 14.1.2 IWF receives Interworking Security Data message + +Upon receiving a "SIP MESSAGE request for Interworking Security Data message for participating function", the actions performed by the IWF are out of scope of the present document. The received message, described in clause 14.2, contains an opaque payload, the contents of which are out of scope of the present document. + +## 14.2 Interworking Security Data message payload + +### 14.2.1 Message definition + +This clause specifies the payload to be used when sending an Interworking Security Data message between the IWF and MCPTT clients. The Interworking Security Data (InterSD) message is defined as a MONP message. + +Message type: InterSD-MESSAGE + +Direction: IWF to MCPTT client, MCPTT client to IWF + +**Table 14.2.1-1: Interworking Security Data message content** + +| IEI | Information Element | Type/Reference | Presence | Format | Length | +|-----|---------------------------------------------|-------------------------------------------------------------------------------|----------|--------|--------| +| | SDS signalling payload message identity | Message type
3GPP TS 24.282 [30] | M | V | 1 | +| | External network type | 14.2.2 | M | V | 1 | +| 7D | URI of LMR key management functional entity | URI encoded as specified in IETF RFC 3986 [32] | O | TLV-E | 3-x | +| 78 | Payload | 3GPP TS 24.282 [30], clause 15.2.13 with Payload content type set to 'BINARY' | O | TLV-E | 3-x | + +### 14.2.2 External network type + +The purpose of the external network type information element is to identify the type of the network represented by the IWF. + +The value part of the external network type information element is coded as shown in Table 14.2.2-1. + +The external network type information element is a type 3 information element with a length of 1 octet. + +**Table 14.2.2-1: External network type** + +| Bits | | | | | | | | | +|--------------------------------|---|---|---|---|---|---|---|-------| +| 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | | +| 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | P25 | +| 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | TETRA | +| All other values are reserved. | | | | | | | | | + +--- + +## Annex A (normative): XML Schema + +### A.1 General + +The XML schema elements defined in the present clause extend those in 3GPP TS 24.379 [29] or other 3GPP technical specifications as noted. + +--- + +### A.2 Void + +--- + +## Annex B (normative): IANA registration forms + +### B.1 Media type for transporting interworking data content + +Your Name: + + + +Your Email Address: + + + +Media Type Name: + +Application + +Subtype name: + +vnd.3gpp.interworking-data + +Required parameters: + +None + +Optional parameters: + +None + +Encoding considerations: + +binary. + +Security considerations: + +General mechanisms for privacy and integrity protection of protocol parameters exist. Those mechanisms as well as authentication and further security mechanisms are described in 3GPP TS 24.229. + +Security mechanisms specific to this media type are dependent upon the business and trust relationship between the Interworking function operator, the mission critical services operator and the SIP carrier operator. Mission critical services operators may wish to encrypt and integrity protect the content transported by this media type independently of mechanisms provided by the transport layer. Such mechanisms have been specified by 3GPP SA3. + +The information transported in this media type does not include active or executable content. + +This media type may include provisions for directives that institute actions on a recipient's files or other resources. + +This media type does not include provisions for directives that institute actions that, while not directly harmful to the recipient, may result in disclosure of information that either facilitates a subsequent attack or else violates a recipient's privacy in any way. + +This media type does not employ compression. + +Interoperability considerations: + +The content transported within this media type does not need to be interpreted by a server as specific decisions are made based on the signalling content (e.g. store disposition history). The final destination point of the content is the terminating UE. Each UE and server that handles the content transported using this media type shall understand the definition of the messages and protocol elements as defined in 3GPP TS 29.379. Any messages and protocol elements not defined by 3GPP TS 29.379 shall be ignored by the recipient UE or server. + +Published specification: + +3GPP TS 29.379 "Mission Critical Push To Talk (MCPTT) call control interworking with LMR systems; Protocol specification", available via . + +Application Usage: + +Applications supporting the mission critical interworking with LMR systems procedures as described in the published specification. This media type shall contain LMR specific content that is related to the payload that is delivered to a terminating user or an application of the terminating user. + +Fragment identifier considerations: + +None. + +Restrictions on usage: + +None + +Provisional registration? (standards tree only): + +N/A + +Additional information: + +1. Deprecated alias names for this type: none +2. Magic number(s): none +3. File extension(s): none +4. Macintosh File Type Code(s): none +5. Object Identifier(s) or OID(s): none + +Intended usage: + +Common + +Person to contact for further information: + +- Name: +- Email: +- Author/Change controller: + - i) Author: 3GPP CT1 Working Group/3GPP\_TSG\_CT\_WG1@LIST.ETSI.ORG + - ii) Change controller: / \ No newline at end of file diff --git a/marked/Rel-18/29_series/29510/raw.md b/marked/Rel-18/29_series/29510/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..cb1e795f0fe13702108d51b323ca76a55248adbe --- /dev/null +++ b/marked/Rel-18/29_series/29510/raw.md @@ -0,0 +1,17530 @@ + + +# 3GPP TS 29.510 V18.5.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Network Function Repository 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, stylized font with a red signal wave icon below the 'P', 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..... | 11 | +| 1 Scope..... | 12 | +| 2 References..... | 12 | +| 3 Definitions and abbreviations..... | 14 | +| 3.1 Definitions..... | 14 | +| 3.2 Abbreviations..... | 14 | +| 4 Overview..... | 14 | +| 5 Services Offered by the NRF..... | 15 | +| 5.1 Introduction..... | 15 | +| 5.2 Nnrf_NFManagement Service..... | 16 | +| 5.2.1 Service Description..... | 16 | +| 5.2.2 Service Operations..... | 17 | +| 5.2.2.1 Introduction..... | 17 | +| 5.2.2.2 NFRegister..... | 18 | +| 5.2.2.2.1 General..... | 18 | +| 5.2.2.2.2 NF (other than NRF) registration to NRF..... | 18 | +| 5.2.2.2.3 NRF registration to another NRF..... | 19 | +| 5.2.2.3 NFUpdate..... | 19 | +| 5.2.2.3.1 General..... | 19 | +| 5.2.2.3.2 NF Heart-Beat..... | 21 | +| 5.2.2.4 NFDeregister..... | 22 | +| 5.2.2.4.1 General..... | 22 | +| 5.2.2.5 NFStatusSubscribe..... | 23 | +| 5.2.2.5.1 General..... | 23 | +| 5.2.2.5.2 Subscription to NF Instances in the same PLMN..... | 23 | +| 5.2.2.5.3 Subscription to NF Instances in a different PLMN..... | 24 | +| 5.2.2.5.4 Subscription to NF Instances with intermediate forwarding NRF..... | 25 | +| 5.2.2.5.5 Subscription to NF Instances with intermediate redirecting NRF..... | 26 | +| 5.2.2.5.6 Update of Subscription to NF Instances..... | 27 | +| 5.2.2.5.7 Update of Subscription to NF Instances in a different PLMN..... | 28 | +| 5.2.2.6 NFStatusNotify..... | 29 | +| 5.2.2.6.1 General..... | 29 | +| 5.2.2.6.2 Notification from NRF in the same PLMN..... | 29 | +| 5.2.2.6.3 Notification from NRF in a different PLMN..... | 31 | +| 5.2.2.6.4 Notification for subscription via intermediate NRF..... | 32 | +| 5.2.2.7 NFStatusUnSubscribe..... | 32 | +| 5.2.2.7.1 General..... | 32 | +| 5.2.2.7.2 Subscription removal in the same PLMN..... | 32 | +| 5.2.2.7.3 Subscription removal in a different PLMN..... | 33 | +| 5.2.2.8 NFListRetrieval..... | 33 | +| 5.2.2.8.1 General..... | 33 | +| 5.2.2.9 NFProfileRetrieval..... | 34 | +| 5.2.2.9.1 General..... | 34 | +| 5.3 Nnrf_NFDiscovery Service..... | 35 | +| 5.3.1 Service Description..... | 35 | +| 5.3.2 Service Operations..... | 35 | +| 5.3.2.1 Introduction..... | 35 | +| 5.3.2.2 NFDiscover..... | 36 | +| 5.3.2.2.1 General..... | 36 | +| 5.3.2.2.2 Service Discovery in the same PLMN..... | 37 | +| 5.3.2.2.3 Service Discovery in a different PLMN..... | 38 | +| 5.3.2.2.4 Service Discovery with intermediate redirecting NRF..... | 39 | +| 5.3.2.2.5 Service Discovery with intermediate forwarding NRF..... | 40 | +| 5.3.2.2.6 Service Discovery with resolution of the target PLMN..... | 41 | + +| | | | +|-----------|-------------------------------------------------------------|----| +| 5.3.2.3 | SCPDomainRoutingInfoGet..... | 42 | +| 5.3.2.4 | SCPDomainRoutingInfoSubscribe..... | 43 | +| 5.3.2.5 | SCPDomainRoutingInfoNotify..... | 43 | +| 5.3.2.6 | SCPDomainRoutingInfoUnSubscribe..... | 44 | +| 5.4 | Nnrf_AccessToken Service..... | 44 | +| 5.4.1 | Service Description..... | 44 | +| 5.4.2 | Service Operations..... | 45 | +| 5.4.2.1 | Introduction..... | 45 | +| 5.4.2.2 | Get (Access Token Request)..... | 45 | +| 5.4.2.2.1 | General..... | 45 | +| 5.4.2.2.2 | Access Token request with intermediate forwarding NRF..... | 46 | +| 5.4.2.2.3 | Access Token request with intermediate redirecting NRF..... | 47 | +| 5.5 | Nnrf_Bootstrapping Service..... | 48 | +| 5.5.1 | Service Description..... | 48 | +| 5.5.2 | Service Operations..... | 49 | +| 5.5.2.1 | Introduction..... | 49 | +| 5.5.2.2 | Get..... | 49 | +| 5.5.2.2.1 | General..... | 49 | +| 6 | API Definitions..... | 50 | +| 6.1 | Nnrf_NFManagement Service API..... | 50 | +| 6.1.1 | API URI..... | 50 | +| 6.1.2 | Usage of HTTP..... | 50 | +| 6.1.2.1 | General..... | 50 | +| 6.1.2.2 | HTTP standard headers..... | 50 | +| 6.1.2.2.1 | General..... | 50 | +| 6.1.2.2.2 | Content type..... | 50 | +| 6.1.2.2.3 | Accept-Encoding..... | 51 | +| 6.1.2.2.4 | ETag..... | 51 | +| 6.1.2.2.5 | If-Match..... | 51 | +| 6.1.2.3 | HTTP custom headers..... | 51 | +| 6.1.2.3.1 | General..... | 51 | +| 6.1.3 | Resources..... | 51 | +| 6.1.3.1 | Overview..... | 51 | +| 6.1.3.2 | Resource: nf-instances (Store)..... | 53 | +| 6.1.3.2.1 | Description..... | 53 | +| 6.1.3.2.2 | Resource Definition..... | 53 | +| 6.1.3.2.3 | Resource Standard Methods..... | 53 | +| 6.1.3.2.4 | Resource Custom Operations..... | 57 | +| 6.1.3.3 | Resource: nf-instance (Document)..... | 57 | +| 6.1.3.3.1 | Description..... | 57 | +| 6.1.3.3.2 | Resource Definition..... | 57 | +| 6.1.3.3.3 | Resource Standard Methods..... | 58 | +| 6.1.3.4 | Resource: subscriptions (Collection)..... | 64 | +| 6.1.3.4.1 | Description..... | 64 | +| 6.1.3.4.2 | Resource Definition..... | 64 | +| 6.1.3.4.3 | Resource Standard Methods..... | 64 | +| 6.1.3.5 | Resource: subscription (Document)..... | 66 | +| 6.1.3.5.1 | Description..... | 66 | +| 6.1.3.5.2 | Resource Definition..... | 66 | +| 6.1.3.5.3 | Resource Standard Methods..... | 66 | +| 6.1.4 | Custom Operations without associated resources..... | 68 | +| 6.1.5 | Notifications..... | 68 | +| 6.1.5.1 | General..... | 68 | +| 6.1.5.2 | NF Instance Status Notification..... | 69 | +| 6.1.5.2.1 | Description..... | 69 | +| 6.1.5.2.2 | Notification Definition..... | 69 | +| 6.1.6 | Data Model..... | 70 | +| 6.1.6.1 | General..... | 70 | +| 6.1.6.2 | Structured data types..... | 76 | +| 6.1.6.2.1 | Introduction..... | 76 | +| 6.1.6.2.2 | Type: NFProfile..... | 77 | + +| | | | +|------------|--------------------------------------------|-----| +| 6.1.6.2.3 | Type: NFService..... | 87 | +| 6.1.6.2.4 | Type: DefaultNotificationSubscription..... | 94 | +| 6.1.6.2.5 | Type: IpEndPoint..... | 96 | +| 6.1.6.2.6 | Type: UdrInfo..... | 97 | +| 6.1.6.2.7 | Type: UdmInfo..... | 98 | +| 6.1.6.2.8 | Type: AusfInfo..... | 99 | +| 6.1.6.2.9 | Type: SupiRange..... | 99 | +| 6.1.6.2.10 | Type: IdentityRange..... | 100 | +| 6.1.6.2.11 | Type: AmfInfo..... | 101 | +| 6.1.6.2.12 | Type: SmfInfo..... | 103 | +| 6.1.6.2.13 | Type: UpfInfo..... | 105 | +| 6.1.6.2.14 | Type: SnssaiUpfInfoItem..... | 107 | +| 6.1.6.2.15 | Type: DnnUpfInfoItem..... | 108 | +| 6.1.6.2.16 | Type: SubscriptionData..... | 109 | +| 6.1.6.2.17 | Type: NotificationData..... | 113 | +| 6.1.6.2.18 | Void..... | 114 | +| 6.1.6.2.19 | Type: NFServiceVersion..... | 114 | +| 6.1.6.2.20 | Type: PcfInfo..... | 115 | +| 6.1.6.2.21 | Type: BsfInfo..... | 116 | +| 6.1.6.2.22 | Type: Ipv4AddressRange..... | 116 | +| 6.1.6.2.23 | Type: Ipv6PrefixRange..... | 117 | +| 6.1.6.2.24 | Type: InterfaceUpfInfoItem..... | 117 | +| 6.1.6.2.25 | Type: UriList..... | 117 | +| 6.1.6.2.26 | Type: N2InterfaceAmfInfo..... | 118 | +| 6.1.6.2.27 | Type: TaiRange..... | 118 | +| 6.1.6.2.28 | Type: TacRange..... | 118 | +| 6.1.6.2.29 | Type: SnssaiSmfInfoItem..... | 119 | +| 6.1.6.2.30 | Type: DnnSmfInfoItem..... | 119 | +| 6.1.6.2.31 | Type: NrfInfo..... | 120 | +| 6.1.6.2.32 | Type: ChfInfo..... | 123 | +| 6.1.6.2.33 | Void..... | 124 | +| 6.1.6.2.34 | Type: PlmnRange..... | 124 | +| 6.1.6.2.35 | Type: SubscrCond..... | 125 | +| 6.1.6.2.36 | Type: NfInstanceIdCond..... | 125 | +| 6.1.6.2.37 | Type: NfTypeCond..... | 126 | +| 6.1.6.2.38 | Type: ServiceNameCond..... | 126 | +| 6.1.6.2.39 | Type: AmfCond..... | 126 | +| 6.1.6.2.40 | Type: GuamiListCond..... | 126 | +| 6.1.6.2.41 | Type: NetworkSliceCond..... | 126 | +| 6.1.6.2.42 | Type: NfGroupCond..... | 127 | +| 6.1.6.2.43 | Type: NotifCondition..... | 127 | +| 6.1.6.2.44 | Type: PlmnSnssai..... | 127 | +| 6.1.6.2.45 | Type: NwdafInfo..... | 128 | +| 6.1.6.2.46 | Type: LmfInfo..... | 129 | +| 6.1.6.2.47 | Type: GmlcInfo..... | 130 | +| 6.1.6.2.48 | Type: NefInfo..... | 131 | +| 6.1.6.2.49 | Type: PfdData..... | 132 | +| 6.1.6.2.50 | Type: AfEventExposureData..... | 132 | +| 6.1.6.2.51 | Type: WAgfInfo..... | 132 | +| 6.1.6.2.52 | Type: TngfInfo..... | 133 | +| 6.1.6.2.53 | Type: PscfInfo..... | 133 | +| 6.1.6.2.54 | Type: NfSetCond..... | 134 | +| 6.1.6.2.55 | Type: NfServiceSetCond..... | 134 | +| 6.1.6.2.56 | Type: NfInfo..... | 134 | +| 6.1.6.2.57 | Type: HssInfo..... | 135 | +| 6.1.6.2.58 | Type: ImsiRange..... | 135 | +| 6.1.6.2.59 | Type: InternalGroupIdRange..... | 136 | +| 6.1.6.2.60 | Type: UpfCond..... | 136 | +| 6.1.6.2.61 | Type: TwifInfo..... | 136 | +| 6.1.6.2.62 | Type: VendorSpecificFeature..... | 137 | +| 6.1.6.2.63 | Type: UdsfInfo..... | 137 | + +| | | | +|-------------|------------------------------------|-----| +| 6.1.6.2.64 | Type: NfInstanceIdListCond..... | 137 | +| 6.1.6.2.65 | Type: ScpInfo..... | 138 | +| 6.1.6.2.66 | Type: ScpDomainInfo..... | 140 | +| 6.1.6.2.67 | Type: ScpDomainCond..... | 140 | +| 6.1.6.2.68 | Type: OptionsResponse..... | 141 | +| 6.1.6.2.69 | Type: NwdafCond..... | 141 | +| 6.1.6.2.70 | Type: NefCond..... | 142 | +| 6.1.6.2.71 | Type: SuciInfo..... | 142 | +| 6.1.6.2.72 | Type: SeppInfo..... | 143 | +| 6.1.6.2.73 | Type: AanfInfo..... | 143 | +| 6.1.6.2.74 | Type: 5GDnmfInfo..... | 143 | +| 6.1.6.2.75 | Type: MfafInfo..... | 144 | +| 6.1.6.2.76 | Type: NwdafCapability..... | 145 | +| 6.1.6.2.77 | Type: EasdfInfo..... | 145 | +| 6.1.6.2.78 | Type: SnssaiEasdfInfoItem..... | 146 | +| 6.1.6.2.79 | Type: DnnEasdfInfoItem..... | 146 | +| 6.1.6.2.80 | Type: DccfInfo..... | 146 | +| 6.1.6.2.81 | Type: NsacfInfo..... | 147 | +| 6.1.6.2.82 | Type: NsacfCapability..... | 147 | +| 6.1.6.2.83 | Type: DccfCond..... | 148 | +| 6.1.6.2.84 | Type: MIAnalyticsInfo..... | 148 | +| 6.1.6.2.85 | Type: MbSmfInfo..... | 149 | +| 6.1.6.2.86 | Type: TmgiRange..... | 149 | +| 6.1.6.2.87 | Type: MbsSession..... | 150 | +| 6.1.6.2.88 | Type: SnssaiMbSmfInfoItem..... | 150 | +| 6.1.6.2.89 | Type: DnnMbSmfInfoItem..... | 150 | +| 6.1.6.2.90 | Void..... | 151 | +| 6.1.6.2.91 | Type: TsctsInfo..... | 151 | +| 6.1.6.2.92 | Type: SnssaiTsctsInfoItem..... | 151 | +| 6.1.6.2.93 | Type: DnnTsctsInfoItem..... | 151 | +| 6.1.6.2.94 | Type: MbUpfInfo..... | 152 | +| 6.1.6.2.95 | Type: UnTrustAfInfo..... | 153 | +| 6.1.6.2.96 | Type: TrustAfInfo..... | 153 | +| 6.1.6.2.97 | Type: SnssaiInfoItem..... | 154 | +| 6.1.6.2.98 | Type: DnnInfoItem..... | 154 | +| 6.1.6.2.99 | Type: CollocatedNfInstance..... | 154 | +| 6.1.6.2.100 | Type: ServiceNameListCond..... | 154 | +| 6.1.6.2.101 | Type: NfGroupListCond..... | 155 | +| 6.1.6.2.102 | Type: PlmnOAuth2..... | 155 | +| 6.1.6.2.103 | Type: V2xCapability..... | 155 | +| 6.1.6.2.104 | Type: NssaaInfo..... | 156 | +| 6.1.6.2.105 | Type: ProSeCapability..... | 157 | +| 6.1.6.2.106 | Type: SharedDataIdRange..... | 158 | +| 6.1.6.2.107 | Type: SubscriptionContext..... | 158 | +| 6.1.6.2.108 | Type: IwmscInfo..... | 158 | +| 6.1.6.2.109 | Type: MnpfInfo..... | 159 | +| 6.1.6.2.110 | Type: DefSubServiceInfo..... | 159 | +| 6.1.6.2.111 | Type: LocalityDescriptionItem..... | 159 | +| 6.1.6.2.112 | Type: LocalityDescription..... | 159 | +| 6.1.6.2.113 | Type: SmsfInfo..... | 160 | +| 6.1.6.2.114 | Type: DcsfInfo..... | 160 | +| 6.1.6.2.115 | Type: MIModelInterInfo..... | 160 | +| 6.1.6.2.116 | Type: PruExistenceInfo..... | 161 | +| 6.1.6.2.117 | Type: MrfInfo..... | 161 | +| 6.1.6.2.118 | Type: MrfpInfo..... | 161 | +| 6.1.6.2.119 | Type: MfInfo..... | 161 | +| 6.1.6.2.120 | Type: A2xCapability..... | 162 | +| 6.1.6.2.121 | Type: RuleSet..... | 163 | +| 6.1.6.2.122 | Type: AdrfInfo..... | 164 | +| 6.1.6.2.123 | Type: SelectionConditions..... | 164 | +| 6.1.6.2.124 | Type: ConditionItem..... | 165 | + +| | | | +|-------------|--------------------------------------------------------------------------|-----| +| 6.1.6.2.125 | Type: ConditionGroup..... | 166 | +| 6.1.6.2.126 | Type: EpdgInfo..... | 166 | +| 6.1.6.2.127 | Type: CallbackUriPrefixItem..... | 166 | +| 6.1.6.3 | Simple data types and enumerations..... | 166 | +| 6.1.6.3.1 | Introduction..... | 166 | +| 6.1.6.3.2 | Simple data types..... | 166 | +| 6.1.6.3.3 | Enumeration: NFType..... | 167 | +| 6.1.6.3.4 | Enumeration: NotificationType..... | 170 | +| 6.1.6.3.5 | Enumeration: TransportProtocol..... | 172 | +| 6.1.6.3.6 | Enumeration: NotificationEventType..... | 172 | +| 6.1.6.3.7 | Enumeration: NFStatus..... | 172 | +| 6.1.6.3.8 | Enumeration: DataSetId..... | 172 | +| 6.1.6.3.9 | Enumeration: UPInterfaceType..... | 174 | +| 6.1.6.3.10 | Relation Types..... | 174 | +| 6.1.6.3.11 | Enumeration: ServiceName..... | 175 | +| 6.1.6.3.12 | Enumeration: NFServiceStatus..... | 177 | +| 6.1.6.3.13 | Enumeration: AnNodeType..... | 178 | +| 6.1.6.3.14 | Enumeration: ConditionEventType..... | 178 | +| 6.1.6.3.15 | Enumeration: IpReachability..... | 178 | +| 6.1.6.3.16 | Enumeration: ScpCapability..... | 178 | +| 6.1.6.3.17 | Enumeration: CollocatedNfType..... | 178 | +| 6.1.6.3.18 | Enumeration: LocalityType..... | 179 | +| 6.1.6.3.19 | Enumeration: FICapabilityType..... | 179 | +| 6.1.6.3.20 | Void..... | 179 | +| 6.1.6.3.21 | Enumeration: RuleSetAction..... | 179 | +| 6.1.7 | Error Handling..... | 179 | +| 6.1.7.1 | General..... | 179 | +| 6.1.7.2 | Protocol Errors..... | 179 | +| 6.1.7.3 | Application Errors..... | 179 | +| 6.1.8 | Security..... | 180 | +| 6.1.9 | Features supported by the NFManagement service..... | 180 | +| 6.2 | Nnrf_NFDiscovery Service API..... | 181 | +| 6.2.1 | API URI..... | 181 | +| 6.2.2 | Usage of HTTP..... | 181 | +| 6.2.2.1 | General..... | 181 | +| 6.2.2.2 | HTTP standard headers..... | 182 | +| 6.2.2.2.1 | General..... | 182 | +| 6.2.2.2.2 | Content type..... | 182 | +| 6.2.2.2.3 | Cache-Control..... | 182 | +| 6.2.2.2.4 | ETag..... | 182 | +| 6.2.2.2.5 | If-None-Match..... | 182 | +| 6.2.2.3 | HTTP custom headers..... | 182 | +| 6.2.2.3.1 | General..... | 182 | +| 6.2.3 | Resources..... | 182 | +| 6.2.3.1 | Overview..... | 182 | +| 6.2.3.2 | Resource: nf-instances (Store)..... | 184 | +| 6.2.3.2.1 | Description..... | 184 | +| 6.2.3.2.2 | Resource Definition..... | 184 | +| 6.2.3.2.3 | Resource Standard Methods..... | 184 | +| 6.2.3.2.4 | Resource Custom Operations..... | 207 | +| 6.2.3.3 | Resource: Stored Search (Document)..... | 207 | +| 6.2.3.3.1 | Description..... | 207 | +| 6.2.3.3.2 | Resource Definition..... | 207 | +| 6.2.3.4 | Resource: Complete Stored Search (Document)..... | 208 | +| 6.2.3.4.1 | Description..... | 208 | +| 6.2.3.4.2 | Resource Definition..... | 208 | +| 6.2.3.5 | Resource: SCP Domain Routing Information (Document)..... | 209 | +| 6.2.3.5.1 | Description..... | 209 | +| 6.2.3.5.2 | Resource Definition..... | 209 | +| 6.2.3.6 | Resource: SCP Domain Routing Information Subscriptions (Collection)..... | 210 | +| 6.2.3.6.1 | Description..... | 210 | + +| | | | +|------------|----------------------------------------------------------------------------------|-----| +| 6.2.3.6.2 | Resource Definition..... | 210 | +| 6.2.3.6.3 | Resource Standard Methods..... | 210 | +| 6.2.3.7 | Resource: Individual SCP Domain Routing Information Subscription (Document)..... | 211 | +| 6.2.3.7.1 | Description..... | 211 | +| 6.2.3.7.2 | Resource Definition..... | 211 | +| 6.2.3.7.3 | Resource Standard Methods..... | 211 | +| 6.2.4 | Custom Operations without associated resources..... | 212 | +| 6.2.5 | Notifications..... | 212 | +| 6.2.5.1 | General..... | 212 | +| 6.2.5.2 | SCP Domain Routing Information Change Notification..... | 212 | +| 6.2.5.2.1 | Description..... | 212 | +| 6.2.5.2.2 | Notification Definition..... | 212 | +| 6.2.6 | Data Model..... | 213 | +| 6.2.6.1 | General..... | 213 | +| 6.2.6.2 | Structured data types..... | 216 | +| 6.2.6.2.1 | Introduction..... | 216 | +| 6.2.6.2.2 | Type: SearchResult..... | 217 | +| 6.2.6.2.3 | Type: NFProfile..... | 219 | +| 6.2.6.2.4 | Type: NFService..... | 226 | +| 6.2.6.2.5 | Type: StoredSearchResult..... | 230 | +| 6.2.6.2.6 | Type: PreferredSearch..... | 231 | +| 6.2.6.2.7 | Type: NfInstanceInfo..... | 233 | +| 6.2.6.2.8 | Type: ScpDomainRoutingInformation..... | 233 | +| 6.2.6.2.9 | Type: ScpDomainConnectivity..... | 234 | +| 6.2.6.2.10 | Type: ScpDomainRoutingInfoSubscription..... | 234 | +| 6.2.6.2.11 | Type: ScpDomainRoutingInfoNotification..... | 235 | +| 6.2.6.2.12 | Type: NfServiceInstance..... | 235 | +| 6.2.6.2.13 | Type: NoProfileMatchInfo..... | 235 | +| 6.2.6.2.14 | Type: QueryParamCombination..... | 235 | +| 6.2.6.2.15 | Type: QueryParameter..... | 235 | +| 6.2.6.2.16 | Type: AfData..... | 236 | +| 6.2.6.2.17 | Type: SearchResultInfo..... | 236 | +| 6.2.6.3 | Simple data types and enumerations..... | 236 | +| 6.2.6.3.1 | Introduction..... | 236 | +| 6.2.6.3.2 | Simple data types..... | 236 | +| 6.2.6.3.3 | Enumeration: NoProfileMatchReason..... | 236 | +| 6.2.7 | Error Handling..... | 237 | +| 6.2.7.1 | General..... | 237 | +| 6.2.7.2 | Protocol Errors..... | 237 | +| 6.2.7.3 | Application Errors..... | 237 | +| 6.2.8 | Security..... | 237 | +| 6.2.9 | Features supported by the NFDiscovery service..... | 238 | +| 6.3 | Nnrf_AccessToken Service API..... | 242 | +| 6.3.1 | General..... | 242 | +| 6.3.2 | API URI..... | 243 | +| 6.3.3 | Usage of HTTP..... | 243 | +| 6.3.3.1 | General..... | 243 | +| 6.3.3.2 | HTTP standard headers..... | 243 | +| 6.3.3.2.1 | General..... | 243 | +| 6.3.3.2.2 | Content type..... | 243 | +| 6.3.3.3 | HTTP custom headers..... | 243 | +| 6.3.3.3.1 | General..... | 243 | +| 6.3.4 | Custom Operations without associated resources..... | 243 | +| 6.3.4.1 | Overview..... | 243 | +| 6.3.4.2 | Operation: Get (Access Token Request)..... | 244 | +| 6.3.4.2.1 | Description..... | 244 | +| 6.3.4.2.2 | Operation Definition..... | 244 | +| 6.3.5 | Data Model..... | 246 | +| 6.3.5.1 | General..... | 246 | +| 6.3.5.2 | Structured data types..... | 246 | +| 6.3.5.2.1 | Introduction..... | 246 | + +| | | | +|-----------|---------------------------------------------------------------------------------|-----| +| 6.3.5.2.2 | Type: AccessTokenReq..... | 247 | +| 6.3.5.2.3 | Type: AccessTokenRsp..... | 250 | +| 6.3.5.2.4 | Type: AccessTokenClaims..... | 251 | +| 6.3.5.2.5 | Type: AccessTokenErr..... | 252 | +| 6.3.5.3 | Simple data types and enumerations..... | 253 | +| 6.3.5.3.1 | Introduction..... | 253 | +| 6.3.5.3.2 | Simple data types..... | 253 | +| 6.3.5.3.3 | Void..... | 253 | +| 6.3.5.4 | Data types describing alternative data types or combinations of data types..... | 253 | +| 6.3.5.4.1 | Type: Audience..... | 253 | +| 6.3.6 | Error Handling..... | 253 | +| 6.3.6.1 | General..... | 253 | +| 6.3.6.2 | Protocol Errors..... | 253 | +| 6.3.6.3 | Application Errors..... | 253 | +| 6.4 | Nnrf_Bootstrapping Service API..... | 254 | +| 6.4.1 | API URI..... | 254 | +| 6.4.2 | Usage of HTTP..... | 254 | +| 6.4.2.1 | General..... | 254 | +| 6.4.2.2 | HTTP standard headers..... | 254 | +| 6.4.2.2.1 | General..... | 254 | +| 6.4.2.2.2 | Content type..... | 254 | +| 6.4.2.2.3 | Cache-Control..... | 254 | +| 6.4.2.2.4 | ETag..... | 254 | +| 6.4.2.2.5 | If-None-Match..... | 254 | +| 6.4.2.3 | HTTP custom headers..... | 255 | +| 6.4.2.3.1 | General..... | 255 | +| 6.4.3 | Resources..... | 255 | +| 6.4.3.1 | Overview..... | 255 | +| 6.4.3.2 | Resource: Bootstrapping (Document)..... | 255 | +| 6.4.3.2.1 | Description..... | 255 | +| 6.4.3.2.2 | Resource Definition..... | 255 | +| 6.4.3.2.3 | Resource Standard Methods..... | 256 | +| 6.4.4 | Custom Operations without associated resources..... | 256 | +| 6.4.5 | Notifications..... | 256 | +| 6.4.6 | Data Model..... | 256 | +| 6.4.6.1 | General..... | 256 | +| 6.4.6.2 | Structured data types..... | 257 | +| 6.4.6.2.1 | Introduction..... | 257 | +| 6.4.6.2.2 | Type: BootstrappingInfo..... | 258 | +| 6.4.6.3 | Simple data types and enumerations..... | 258 | +| 6.4.6.3.1 | Introduction..... | 258 | +| 6.4.6.3.2 | Enumeration: Status..... | 258 | +| 6.4.6.3.3 | Relation Types..... | 259 | + +| | | | +|-------------------------------|-----------------------------------------------------------------------------------------------------------------------|------------| +| Annex A (normative): | OpenAPI specification..... | 260 | +| A.1 | General..... | 260 | +| A.2 | Nnrf_NFManagement API..... | 260 | +| A.3 | Nnrf_NFDiscovery API..... | 328 | +| A.4 | Nnrf_AccessToken API (NRF OAuth2 Authorization)..... | 360 | +| A.5 | Nnrf_Bootstrapping API..... | 364 | +| Annex B (normative): | NF Profile changes in NFRegister and NFUpdate responses..... | 366 | +| B.1 | General..... | 366 | +| Annex C (normative): | Enhanced Authorization Policy using RuleSets in NF (Service) Profile..... | 367 | +| C.1 | General..... | 367 | +| C.2 | Examples of NF-Producer profile only using RuleSets (i.e. without AllowedXXX parameters) in NF (Service) Profile..... | 367 | +| C.3 | Example of NF-Producer profile using RuleSets and AllowedXXX parameters in NF (Service) Profile..... | 368 | +| C.4 | Backward Compatibility..... | 369 | +| Annex D (normative): | Support of "Canary Release" testing in the NRF..... | 369 | +| Annex E (informative): | Change history..... | 373 | + +## 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 Nnrf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the NRF. + +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.518: "5G System; Access and Mobility Management Services; Stage 3". +- [7] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [8] ECMA-262: "ECMAScript® Language Specification", . +- [9] IETF RFC 9113: "HTTP/2". +- [10] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", . +- [11] IETF RFC 9457: "Problem Details for HTTP APIs". +- [12] 3GPP TS 23.003: "Numbering, Addressing and Identification". +- [13] IETF RFC 6902: "JavaScript Object Notation (JSON) Patch". +- [14] IETF RFC 6901: "JavaScript Object Notation (JSON) Pointer". + +- [15] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [16] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [17] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [18] IETF RFC 4122: "A Universally Unique Identifier (UUID) URN Namespace". +- [19] Void. +- [20] IETF RFC 9111: "HTTP Caching". +- [21] 3GPP TS 29.244: "Interface between the Control Plane and the User Plane Nodes; Stage 3". +- [22] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [23] IETF RFC 2782: "A DNS RR for specifying the location of services (DNS SRV)". +- [24] IETF RFC 7515: "JSON Web Signature (JWS)". +- [25] IETF RFC 7519: "JSON Web Token (JWT)". +- [26] W3C HTML 4.01 Specification, . +- [27] 3GPP TS 23.527: "5G System; Restoration Procedures; Stage 2". +- [28] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [29] 3GPP TS 38.413: "NG-RAN; NG Application Protocol (NGAP)". +- [30] IETF RFC 1952: "GZIP file format specification version 4.3". +- [31] 3GPP TR 21.900: "Technical Specification Group working methods". +- [32] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [33] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". +- [34] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [35] 3GPP TS 29.517: "Application Function Event Exposure Service". +- [36] 3GPP TS 29.503: "Unified Data Management Services". +- [37] 3GPP TS 29.336: "Home Subscriber Server (HSS) diameter interfaces for interworking with packet data networks and applications". +- [38] IANA: "SMI Network Management Private Enterprise Codes", . +- [39] Semantic Versioning Specification: . +- [40] IETF RFC 9110: "HTTP Semantics". +- [41] Void. +- [42] 3GPP TS 29.531: "5G System; Network Slice Selection Services; Stage 3". +- [43] 3GPP TS 23.247: "Architectural enhancements for 5G multicast-broadcast services". +- [44] ITU-T Recommendation E.164: "The international public telecommunication numbering plan". +- [45] 3GPP TS 23.380: "IMS Restoration Procedures". +- [46] 3GPP TS 32.255: "Telecommunication management; Charging management; 5G data connectivity domain charging; Stage 2". + +- [47] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [48] 3GPP TS 23.540: "5G System; Technical realization of Service Based Short Message Service; Stage 2". +- [49] 3GPP TS 29.564: "5G System; User Plane Function 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]. + +**Canary Release:** When an NF Instance is software upgraded, a canary release allows to have features incrementally tested by a small set of users, which can be targeted by geographic locations or user attributes (e.g., SUPI, PEI, ...). If a feature's performance is not satisfactory, then it can be rolled back without any adverse effects on the rest of the system. + +### 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 | +| CEF | Charging Enablement Function | +| CH | Credentials Holder | +| CHF | Charging Function | +| DCS | Default Credentials Server | +| DCSF | Data Channel Signaling Function | +| IPUPS | Inter-PLMN User Plane Security | +| MBS | Multicast/Broadcast Service | +| MB-SMF | Multicast/Broadcast Session Management Function | +| NF | Network Function | +| NRF | NF Repository Function | +| NWDAF | Network Data Analytics Function | +| PFD | Packet Flow Description | +| PRU | Positioning Reference Unit | +| SNPN | Stand-alone Non-Public Network | +| SSM | Source Specific IP Multicast (address) | +| TNGF | Trusted Non-3GPP Gateway Function | +| TSCTSF | Time Sensitive Communication and Time Synchronization Function | +| TWIF | Trusted WLAN Interworking Function | +| W-AGF | Wireline Access Gateway Function | + +--- + +## 4 Overview + +The Network Function (NF) Repository Function (NRF) is the network entity in the 5G Core Network (5GC) supporting the following functionality: + +- Maintains the NF profile of available NF instances and their supported services; +- Maintains the SCP profile of available SCP instances; +- Maintains the SEPP profile of available SEPP instances; + +- Allows other NF or SCP instances to subscribe to, and get notified about, the registration in NRF of new NF instances of a given type or of SEPP instances. It also allows SCP instances to subscribe to, and get notified about, the registration in NRF of new SCP instances; +- Supports service discovery function. It receives NF Discovery Requests from NF or SCP instances, and provides the information of the available NF instances fulfilling certain criteria (e.g., supporting a given service); +- Support SCP discovery function. It receives NF Discovery Requests for SCP profiles from other SCP instances, and provides the information of the available SCP instances fulfilling certain criteria (e.g., serving a given NF set); +- Support SEPP discovery function. It receives NF Discovery Requests for SEPP profiles from other NF or SCP instances, and provides the information of the available SEPP instances fulfilling certain criteria (e.g. supporting connectivity with a remote PLMN). + +Figures 4-1 shows the reference architecture for the 5GC, with focus on the NRF: + +![Figure 4-1: 5G System architecture diagram showing the HPLMN and VPLMN components and their interactions.](9b6b5924b48bf2fd5f347f88f06f45b3_img.jpg) + +The diagram illustrates the 5G System architecture, divided into HPLMN (Home PLMN) and VPLMN (Visited PLMN) by a vertical dashed line. On the HPLMN side, a Service Based Interface (SBI) bus connects various Network Functions (NFs). Above the bus are: MBSF, MB-SMF, NSSAAF, NWDAF, GMLC, NSSF, NEF, NRF (highlighted in blue), PCF, and UDM. Below the bus are: MBSTF, MNPF, SMS-IWMSC, LMF, UDR, AUSF, AMF, SMF, SCP, AF, CHF, and SEPP. The NRF is connected to the SBI and has a dashed line labeled 'Nnrf' pointing to it. A dotted line labeled 'N27' connects the NRF in the HPLMN to another NRF in the VPLMN. The VPLMN side contains several empty boxes representing other NFs, with one NRF also present. + +Figure 4-1: 5G System architecture diagram showing the HPLMN and VPLMN components and their interactions. + +**Figure 4-1: 5G System architecture** + +Figure 4-1 illustrates PLMN level scenarios, but this architecture is also applicable to the SNPn scenarios, as explained below. + +For the sake of clarity, the NRF is never depicted in reference point representation figures, given that the NRF interacts with every other NF in the 5GC. As an exception, in the roaming case, the reference point between the vNRF and the hNRF is named as N27. The reference point name of N27 is used only for representation purposes, but its functionality is included in the services offered by the Nnrf Service-Based Interface. + +In the case of SNPn, the NRF provides services e.g. in the following scenarios: + +- For a 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). + +## 5 Services Offered by the NRF + +### 5.1 Introduction + +The NRF offers to other NFs the following services: + +- Nnrf\_NFManagement +- Nnrf\_NFDiscovery +- Nnrf\_AccessToken (OAuth2 Authorization) +- Nnrf\_Bootstrapping + +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 | +|--------------------|--------|--------------------------|---------------------------------|-----------|-------| +| Nnrf_NFManagement | 6.1 | NRF NFManagement Service | TS29510_Nnrf_NFManagement.yaml | nnrf-nfm | A.2 | +| Nnrf_NFDiscovery | 6.2 | NRF NFDiscovery Service | TS29510_Nnrf_NFDiscovery.yaml | nnrf-disc | A.3 | +| Nnrf_AccessToken | 6.3 | NRF OAuth2 Authorization | TS29510_Nnrf_AccessToken.yaml | | A.4 | +| Nnrf_Bootstrapping | 6.4 | NRF Bootstrapping | TS29510_Nnrf_Bootstrapping.yaml | | A.5 | + +NRF provides services to the following SNPN scenarios (see clauses 4.17.4a, 4.17.5a, 5.2.7.2 and 5.2.7.3 in 3GPP TS 23.502 [3]): + +- In a SNPN where roaming is not supported, which corresponds to the NRF services in the same PLMN; +- In the case of UE access to SNPN using credentials from Credentials Holder with AAA-S, which corresponds to the NRF services in the same PLMN; +- In the case of UE access to SNPN using credentials from Credentials Holder with AUSF and UDM, which corresponds to the NRF services across different PLMNs; +- In the case of Onboarding of UEs for SNPNs without using Default Credentials Server, which corresponds to the NRF services in the same PLMN; +- In the case of Onboarding of UEs for SNPNs using Default Credentials Server with AAA-S, which corresponds to the NRF services in the same PLMN; +- In the case of Onboarding of UEs for SNPNs using Default Credentials Server with AUSF and UDM, which corresponds to the NRF services across different PLMNs. + +## 5.2 Nnrf\_NFManagement Service + +### 5.2.1 Service Description + +The Nnrf\_NFManagement service allows an NF, SCP or SEPP Instance in the serving PLMN to register, update or deregister its profile in the NRF. + +The Nnrf\_NFManagement service also allows an NRF Instance to register, update or deregister its profile in another NRF in the same PLMN. + +NOTE: Alternatively, other means such as OA&M can also be used to register, update or deregister NRF profile in another NRF. + +It also allows an NF or an SCP to subscribe to be notified of registration, deregistration and profile changes of NF Instances, along with their potential NF services, or of SEPP instances. It also enables an SCP to subscribe to be notified of registration, deregistration and profile changes of other SCP instances. + +The NF profile consists of general parameters of the NF Instance, and also the parameters of the different NF Service Instances exposed by the NF Instance, if applicable. + +The PLMN of the NRF may comprise one or multiple PLMN IDs (i.e. MCC and MNC). An NRF configured with multiple PLMN IDs shall support registering, updating and deregistering the profile of Network Function Instances from any of these PLMN IDs. + +The Nnrf\_NFManagement service also allows retrieving a list of NF, SCP or SEPP Instances currently registered in the NRF or the NF Profile of a given NF, SCP or SEPP Instance. + +The Nnrf\_NFManagement service also allows checking whether the registered NFs, SCPs and SEPPs are operative. + +## 5.2.2 Service Operations + +### 5.2.2.1 Introduction + +The services operations defined for the Nnrf\_NFManagement service are as follows: + +- NFRegister: It allows an NF, SCP or SEPP Instance to register its profile in the NRF; it includes the registration of the general parameters of the NF, SCP or SEPP Instance, together with the list of potential services exposed by the NF Instance. This service operation is not allowed to be invoked from an NRF in a different PLMN. +- NFUpdate: It allows an NF, SCP or SEPP Instance to replace, or update partially, the parameters of its profile (including the parameters of the associated services, if any) in the NRF; it also allows to add or delete individual services offered by the NF Instance. This service operation is not allowed to be invoked from an NRF in a different PLMN. +- NFDeregister: It allows an NF, SCP or SEPP Instance to deregister its profile in the NRF, including the services offered by the NF Instance, if any. This service operation is not allowed to be invoked from an NRF in a different PLMN. +- NFStatusSubscribe: It allows an NF or SCP Instance to subscribe to changes on the status of NF or SEPP Instances registered in NRF. It also allows an SCP Instance to subscribe to changes on the status of other SCP Instances registered in NRF. This service operation can be invoked by an NF Instance in a different PLMN (via the local NRF in that PLMN) for changes on the status of NF Instances. It cannot be invoked by an SCP instance in a different PLMN. For changes on the status of SEPP Instance, this operation can only be invoked between the NRF and an NF Instance or SCP in the same PLMN. +- NFStatusNotify: It allows the NRF to notify subscribed NF or SCP Instances of changes on the status of NF or SEPP Instances. It also allows the NRF to notify subscribed SCP Instances of changes on the status of SCP Instances. This service operation can be invoked directly between the NRF and an NF Instance in a different PLMN (without involvement of the local NRF in that PLMN) for changes on the status of NF Instances. It cannot be invoked between the NRF and an SCP instance in a different PLMN. For changes on the status of SEPP Instance, this operation can only be invoked between the NRF and an NF Instance or SCP in the same PLMN. +- NFStatusUnsubscribe: It allows an NF or SCP Instance to unsubscribe to changes on the status of NF or SEPP Instances registered in NRF. It also allows an SCP Instance to unsubscribe to changes on the status of other SCP Instances registered in NRF. This service operation can be invoked by an NF Instance in a different PLMN (via the local NRF in that PLMN) for changes on the status of NF Instances. It cannot be invoked by an SCP instance in a different PLMN. For changes on the status of SEPP Instance, this operation can only be invoked between the NRF and an NF Instance or SCP in the same PLMN. + +NOTE 1: The "change of status" of the NFStatus service operations can imply a request to be notified of newly registered NF, SCP or SEPP Instances in NRF, or to be notified of profile changes of a specific NF, SCP or SEPP Instance, or to be notified of the deregistration of an NF, SCP or SEPP Instance. + +NOTE 2: An NRF instance can also use the NFRegister, NFUpdate or NFDeregister service operations or OA&M system to register, update or deregister its profile in another NRF in the same PLMN. + +- NFListRetrieval: It allows retrieving a list of NFs, SCPs and SEPPs currently registered in the NRF. This service operation is not allowed to be invoked from an NRF in a different PLMN. +- NFProfileRetrieval: It allows retrieving the profile of a given NF, SCP or SEPP instance. This service operation is not allowed to be invoked from an NRF in a different PLMN. + +The NFStatusSubscribe / NFStatusNotify / NFStatusUnsubscribe operations can be invoked by an NF Service Consumer (i.e., "source NF" or "SCP") requesting to be notified about events (registration, deregistration, profile change) related to an NF instance (i.e., "target NF") located in the same PLMN, or in a different PLMN, or related to a SEPP instance located in the same PLMN. An SCP can also invoke these operations to be notified about events (registration, deregistration, profile change) related to an SCP instance or SEPP instance located in the same PLMN. + +In the description of these operations in clauses 5.2.2.5, 5.2.2.6 and 5.2.2.7, when the NF instances are located in the same PLMN, both source NF and target NF are said to be located in the "Serving PLMN" but, in the general case, the functionality is not restricted to the PLMN that is serving a given UE, and it shall be applicable as well to any scenario in which source NF and target NFs belong to the same PLMN. + +When source NF and target NF are located in different PLMNs, the source NF is said to be in the "Serving PLMN", and the target NF (and the NRF where such NF is registered) is said to be in the "Home PLMN", similarly to the scenarios described in 3GPP TS 23.502 [3], but the functionality shall be equally applicable to any scenario between any pair of PLMNs (e.g. with the source NF in the Home PLMN and the target NF in the Serving PLMN). + +The SCP and SEPP are treated by the Nnrf\_NFManagement service in the same way as NFs. Specifically, the SCP and SEPP are designated with a specific NF type and NF Instance ID. However, the SCP and SEPP do not support services. Accordingly, references to "NF" or "NF Profile" in the description of the service operations in the following clauses also apply to an SCP and SEPP. + +## 5.2.2.2 NFRegister + +### 5.2.2.2.1 General + +This service operation is used: + +- to register an NF in the NRF by providing the NF profile of the requesting NF to the NRF, and the NRF marks the requesting NF as available to be discovered by other NFs; +- to register services associated to an existing NF Instance; +- to register NRF information in another NRF, and this information is used for forwarding or redirecting service discovery request. + +### 5.2.2.2.2 NF (other than NRF) registration to NRF + +![Sequence diagram showing NF Instance Registration. An NF Service Consumer sends a PUT request to the NRF. The NRF responds with either a 201 Created (NFProfile) or a 4xx/5xx (ProblemDetails) or 3xx response.](e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 1. PUT .../nf-instances/{nfInstanceID} (NFProfile) + NF Service Consumer->>NRF: 1. PUT .../nf-instances/{nfInstanceID} (NFProfile) + Note left of NF Service Consumer: 2a. 201 Created (NFProfile) +2b. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>NF Service Consumer: 2a. 201 Created (NFProfile) +2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing NF Instance Registration. An NF Service Consumer sends a PUT request to the NRF. The NRF responds with either a 201 Created (NFProfile) or a 4xx/5xx (ProblemDetails) or 3xx response. + +**Figure 5.2.2.2.2-1: NF Instance Registration** + +1. The NF Service Consumer shall send a PUT request to the resource URI representing the NF Instance. The URI is determined by the NF Instance. The variable {nfInstanceID} represents an identifier, provided by the NF Service Consumer that shall be globally unique inside the PLMN of the NRF where the NF is being registered. The format of the NF Instance ID shall be a Universally Unique Identifier (UUID) version 4, as described in IETF RFC 4122 [18]. + +The UUIDs in URIs, HTTP request content and HTTP response content should be formatted using lower-case hexadecimal digits; if the NF Service Consumer sends a request where the UUIDs are formatted with upper-case hexadecimal letters, the NRF shall handle it as if the request had been formatted with lower-case characters. + +EXAMPLE: UUID version 4: "4947a69a-f61b-4bc1-b9da-47c9c5d14b64" + +The content of the PUT request shall contain a representation of the NF Instance to be created. + +- 2a. On success, "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. Additionally, the NRF returns a "heart-beat timer" containing the number of seconds expected between two consecutive heart-beat messages from an NF Instance to the NRF (see clause 5.2.2.3.2). The representation of the created resource may + +be a complete NF Profile or a NF Profile just including the mandatory attributes of the NF Profile and the attributes which the NRF added or changed (see Annex B). + +2b. On failure or redirection: + +- If the registration of the NF instance fails at the NRF due to errors in the encoding of the NFProfile JSON object, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. +- If the registration of the NF instance fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +The NRF shall allow the registration of a Network Function instance with any of the NF types described in clause 6.1.6.3.3, and it shall also allow registration of Network Function instances with custom NF types (e.g., NF type values not defined by 3GPP, or NF type values not defined by this API version). + +NOTE 1: When registering a custom NF in NRF, it is recommended to use a NF type name that prevents collisions with other custom NF type names, or with NF types defined in the future by 3GPP. E.g., prefixing the custom NF type name with the string "CUSTOM\_". + +During the registration of a Network Function instance with a custom NF type, the NF instance may provide NF-specific data (in the "customInfo" attribute), that shall be stored by the NRF as part of the NF profile of the NF instance. + +The NRF shall accept the registration of NF Instances containing Vendor-Specific attributes (see 3GPP TS 29.500 [4], clause 6.6.3), and therefore, it shall accept NF Profiles containing attributes whose type may be unknown to the NRF, and those attributes shall be stored as part of the NF's profile data in NRF. + +Before an NF Instance registers its NF Profile in NRF, the NF Instance should check the capabilities of the NRF by issuing an OPTIONS request to the "nf-instances" resource (see clause 6.1.3.2.3.2), unless the NF Instance already sent a Bootstrapping Request to the NRF and received the nrfFeatures attribute in the response. The NRF may indicate in the response capabilities such as the support of receiving compressed content in the HTTP PUT request used for registration of the NF Profile, or support of specific attributes of the NF Profile. + +NOTE 2: A Rel-16 NF needs to register the list of NF Service Instances in the "nfServices" array attribute towards an NRF not supporting the Service-Map feature (i.e. a Rel-15 NRF). + +### 5.2.2.2.3 NRF registration to another NRF + +The procedure specified in clause 5.2.2.2.2 applies. Additionally: + +- the registering NRF shall set the nfType to "NRF" in the nfProfile; +- the registering NRF shall set the nfService to contain "nnrf-disc", "nnrf-nfm" and optionally "nnrf-oauth2" in the nfProfile; +- the registering NRF may include nrfInfo which contains the information of e.g. udrInfo, udmInfo, ausfInfo, amfInfo, smfInfo, upfInfo, pcfInfo, bsfInfo, nefInfo, chfInfo, pscfInfo, lmfInfo, gmfcInfo, aanfInfo, nfnInfo and nsacfInfo in the nfProfile locally configured in the NRF or the NRF received during registration of other NFs, this means the registering NRF is able to provide service for discovery of NFs subject to that information; +- if the NRF receives an NF registration with the nfType set to "NRF", the NRF shall use the information contained in the nfProfile to target the registering NRF when forwarding or redirecting NF service discovery request. + +### 5.2.2.3 NFUpdate + +#### 5.2.2.3.1 General + +This service operation updates the profile of a Network Function previously registered in the NRF by providing the updated NF profile of the requesting NF to the NRF. The update operation may apply to the whole profile of the NF (complete replacement of the existing profile by a new profile), or it may apply only to a subset of the parameters of the profile (including adding/deleting/replacing services to the NF profile). + +To perform a complete replacement of the NF Profile of a given NF Instance, the NF Service Consumer shall issue an HTTP PUT request, as shown in Figure 5.2.2.3.1-1: + +![Sequence diagram for NF Profile Complete Replacement. The NF Service Consumer sends a PUT request to the NRF. The NRF responds with either a 200 OK (containing the NFPProfile) or a 4xx/5xx (containing ProblemDetails) or a 3xx status code.](523ab7b925beb555f88b2e1e1336974f_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF + Note left of NF Service Consumer: 1. PUT .../nf-instances/{nfInstanceID} (NFPProfile) + NF Service Consumer->>NRF: 1. PUT .../nf-instances/{nfInstanceID} (NFPProfile) + Note right of NRF: 2a. 200 OK (NFPProfile) +2b. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>NF Service Consumer: 2a. 200 OK (NFPProfile) +2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for NF Profile Complete Replacement. The NF Service Consumer sends a PUT request to the NRF. The NRF responds with either a 200 OK (containing the NFPProfile) or a 4xx/5xx (containing ProblemDetails) or a 3xx status code. + +**Figure 5.2.2.3.1-1: NF Profile Complete Replacement** + +1. The NF Service Consumer shall send a PUT request to the resource URI representing the NF Instance. The content of the PUT request shall contain a representation of the NF Instance to be completely replaced in the NRF. +- 2a. On success, "200 OK" shall be returned, the content of the PUT response shall contain the representation of the replaced resource. The representation of the replaced resource may be a complete NF Profile or a NF Profile just including the mandatory attributes of the NF Profile and the attributes which the NRF added or changed (see Annex B). +- 2b. On failure or redirection: + - If the update of the NF instance fails at the NRF due to errors in the encoding of the NFPProfile JSON object, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the update of the NF instance fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +To perform a partial update of the NF Profile of a given NF Instance, the NF Service Consumer shall issue an HTTP PATCH request, as shown in Figure 5.2.2.3.1-2. This partial update shall be used to add/delete/replace individual parameters of the NF Instance, and also to add/delete/replace any of the services (and their parameters) offered by the NF Instance. + +![Sequence diagram for NF Profile Partial Update. The NF Service Consumer sends a PATCH request to the NRF. The NRF responds with either a 200 OK (containing the NFPProfile) or a 204 No Content (empty), or a 4xx/5xx (containing ProblemDetails) or a 3xx status code.](1a85642ed2356d183ce598f2c8b3ee8b_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF + Note left of NF Service Consumer: 1. PATCH .../nf-instances/{nfInstanceID} (PatchData) + NF Service Consumer->>NRF: 1. PATCH .../nf-instances/{nfInstanceID} (PatchData) + Note right of NRF: 2a. 200 OK (NFPProfile) / 204 No Content () +2b. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>NF Service Consumer: 2a. 200 OK (NFPProfile) / 204 No Content () +2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for NF Profile Partial Update. The NF Service Consumer sends a PATCH request to the NRF. The NRF responds with either a 200 OK (containing the NFPProfile) or a 204 No Content (empty), or a 4xx/5xx (containing ProblemDetails) or a 3xx status code. + +**Figure 5.2.2.3.1-2: NF Profile Partial Update** + +1. The NF Service Consumer shall send a PATCH request to the resource URI representing the NF Instance. The content of the PATCH request shall contain the list of operations (add/delete/replace) to be applied to the NF Profile of the NF Instance; these operations may be directed to individual parameters of the NF Profile or to the list of services (and their parameters) offered by the NF Instances. In order to leave the NF Profile in a consistent state, all the operations specified by the PATCH request body shall be executed atomically. + +The NF Service Consumer should include a "If-Match" HTTP header carrying the latest entity-tag received from NRF for the NF profile to which the PATCH document shall be applied. + +- 2a. On success, if all update operations are accepted by the NRF, "204 No Content" should be returned; the NRF may instead return "200 OK" with the content of the PATCH response containing the representation of the + +replaced resource. The representation of the replaced resource may be a complete NF Profile or a NF Profile just including the mandatory attributes of the NF Profile and the attributes which the NRF added or changed (see Annex B). + +2b. On failure or redirection: + +- If the NF Instance, identified by the "nfInstanceID", is not found in the list of registered NF Instances in the NRF's database, the NRF shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. +- If "If-Match" header is received with an entity tag different from the entity-tag in NRF for NF profile of the target NF instance, the NRF shall return "412 Precondition Failed" status code with the ProblemDetails IE providing details of the error. +- If no precondition was defined in the request and another confliction has been detected (e.g. to change value of a non-existing IE), the NRF shall return "409 Conflicting" status code with the ProblemDetails IE providing details of the error. + +The NRF shall allow updating Vendor-Specific attributes (see 3GPP TS 29.500 [4], clause 6.6.3) that may exist in the NF Profile of a registered NF Instance. + +### 5.2.2.3.2 NF Heart-Beat + +Each NF that has previously registered in NRF shall contact the NRF periodically (heart-beat), by invoking the NFUpdate service operation, in order to show that the NF is still operative. + +The time interval at which the NRF shall be contacted is deployment-specific, and it is returned by the NRF to the NF Service Consumer as a result of a successful registration. + +When the NRF detects that a given NF has not updated its profile for a configurable amount of time (longer than the heart-beat interval), the NRF changes the status of the NF to SUSPENDED and considers that the NF and its services can no longer be discovered by other NFs via the NFDiscovery service. The NRF notifies NFs subscribed to receiving notifications of changes of the NF Profile that the NF status has been changed to SUSPENDED. + +If the NRF modifies the heart-beat interval value of a given NF instance currently registered (e.g. as a result of an OA&M operation), it shall return the new value to the registered NF in the response of the next periodic heart-beat interaction received from that NF and, until then, the NRF shall apply the heart-beat check procedure according to the original interval value. + +![Sequence diagram illustrating the NF Heart-Beat interaction between an NF Service Consumer and an NRF.](35127fe87029df6f5f0b2ee85f6193f1_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 1. PATCH .../nf-instances/{nfInstanceID} (PatchData) + NF Service Consumer->>NRF: 1. PATCH .../nf-instances/{nfInstanceID} (PatchData) + Note left of NF Service Consumer: 2a. 200 OK (NFProfile) / 204 No Content () + Note left of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>NF Service Consumer: 2a. 200 OK (NFProfile) / 204 No Content () + NRF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +The diagram shows a sequence of interactions between an NF Service Consumer and an NRF. The NF Service Consumer sends a PATCH request to the NRF. The NRF responds with either a 200 OK (NFProfile) / 204 No Content () or a 4xx/5xx (ProblemDetails) or 3xx status code. + +Sequence diagram illustrating the NF Heart-Beat interaction between an NF Service Consumer and an NRF. + +**Figure 5.2.2.3.2-1: NF Heart-Beat** + +1. The NF Service Consumer shall send a PATCH request to the resource URI representing the NF Instance. The content of the PATCH request shall contain a "replace" operation on the "nfStatus" attribute of the NF Profile of the NF Instance, and set it to the value "REGISTERED" or "UNDISCOVERABLE". + +In addition, the NF Service Consumer may also provide the load information of the NF, and/or the load information of the NF associated NF services. The provision of such load information may be limited by this NF via appropriate configuration (e.g. granularity threshold) in order to avoid notifying minor load changes. + +The NF Service Consumer shall not include "If-Match" HTTP header in the Heart-Beat request if the request is not modifying any attribute in the NF profile. + +- 2a. On success, the NRF should return "204 No Content"; the NRF may also answer with "200 OK" along with the full NF Profile, e.g. in cases where the NRF determines that the NF Profile has changed significantly since the last heart-beat, and wants to send the new profile to the NF Service Consumer (note that this alternative has bigger signalling overhead). + +The NRF shall not generate a new entity tag for the NF profile in Heart-Beat operation if no attribute is modified. + +- 2b. On failure or redirection: + +- If the NF Instance, identified by the "nfInstanceID", is not found in the list of registered NF Instances in the NRF's database, the NRF shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +EXAMPLE: + +``` +PATCH ../nf-instances/4947a69a-f61b-4bc1-b9da-47c9c5d14b64 +Content-Type: application/json-patch+json + +[ + { "op": "replace", "path": "/nfStatus", "value": "REGISTERED" }, + { "op": "replace", "path": "/load", "value": 50 } +] + +HTTP/2 204 No Content +Content-Location: ../nf-instances/4947a69a-f61b-4bc1-b9da-47c9c5d14b64 +``` + +## 5.2.2.4 NFDeregister + +### 5.2.2.4.1 General + +This service operation removes the profile of a Network Function previously registered in the NRF. + +It is executed by deleting a given resource identified by a "NF Instance ID". The operation is invoked by issuing a DELETE request on the URI representing the specific NF Instance. + +![Sequence diagram for NF Instance Deregistration. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'NRF' on the right. Step 1: A solid arrow points from the NF Service Consumer to the NRF with the message '1. DELETE ../nf-instances/{nfInstanceID} ()'. Step 2: A return message is shown with two possible outcomes: '2a. 204 No Content ()' and '2b. 4xx/5xx (ProblemDetails) or 3xx'. This return message is represented by a dashed arrow pointing from the NRF back to the NF Service Consumer, with the text split into two lines within a single message box.](8ed7f57cc317f6574bec781d01ae6ad2_img.jpg) + +Sequence diagram for NF Instance Deregistration. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'NRF' on the right. Step 1: A solid arrow points from the NF Service Consumer to the NRF with the message '1. DELETE ../nf-instances/{nfInstanceID} ()'. Step 2: A return message is shown with two possible outcomes: '2a. 204 No Content ()' and '2b. 4xx/5xx (ProblemDetails) or 3xx'. This return message is represented by a dashed arrow pointing from the NRF back to the NF Service Consumer, with the text split into two lines within a single message box. + +Figure 5.2.2.4.1-1: NF Instance Deregistration + +1. The NF Service Consumer shall send a DELETE request to the resource URI representing the NF Instance. The request body shall be empty. +- 2a. On success, "204 No Content" shall be returned. The response body shall be empty. +- 2b. On failure or redirection: + - If the NF Instance, identified by the "nfInstanceID", is not found in the list of registered NF Instances in the NRF's database, the NRF shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. + +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +## 5.2.2.5 NFStatusSubscribe + +### 5.2.2.5.1 General + +This service operation is used to: + +- create a subscription so an NF Service Consumer can request to be notified when NF Instances of a given set, following certain filter criteria are registered/deregistered in NRF or when their profile is modified; +- create a subscription to a specific NF Instance so an NF Service Consumer can request to be notified when the profile of such NF Instance is modified or when the NF Instance is deregistered from NRF. + +### 5.2.2.5.2 Subscription to NF Instances in the same PLMN + +The subscription to notifications on NF Instances is executed creating a new individual resource under the collection resource "subscriptions". The operation is invoked by issuing a POST request on the URI representing the "subscriptions" resource. + +![Sequence diagram showing the interaction between an NF Service Consumer and an NRF in the same PLMN for subscription creation.](f0b7aaa539a2f77c98d53ed6c1c2366b_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer in Serving PLMN + participant NRF as NRF in Serving PLMN + Note right of Consumer: 1. POST .../subscriptions (SubscriptionData) + Consumer->>NRF: Request + Note left of NRF: 2a. 201 Created (SubscriptionData) +2b. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>Consumer: Response + +``` + +The diagram illustrates a sequence of messages between an NF Service Consumer and an NRF, both located within the same Serving PLMN. The interaction begins with the Consumer sending a POST request to the subscriptions resource. The NRF responds with either a 201 Created status containing SubscriptionData, or a 4xx/5xx status containing ProblemDetails, or a 3xx redirection status. + +Sequence diagram showing the interaction between an NF Service Consumer and an NRF in the same PLMN for subscription creation. + +**Figure 5.2.2.5.2-1: Subscription to NF Instances in the same PLMN** + +1. The NF Service Consumer shall send a POST request to the resource URI representing the "subscriptions" collection resource. The custom HTTP header "3gpp-Sbi-Notif-Accepted-Encoding", as defined in 3GPP TS 29.500 [4] clause 5.2.3.3.6, may be included to indicate the content-encodings supported by the NF Service Consumer receiving the notification. + +The request body shall include the data indicating the type of notifications that the NF Service Consumer is interested in receiving; it also contains a callback URI, where the NF Service Consumer shall be prepared to receive the actual notification from the NRF (see NFStatusNotify operation in 5.2.2.6) and it may contain a validity time, suggested by the NF Service Consumer, representing the time span during which the subscription is desired to be kept active. When the NF Service Consumer creates multiple subscriptions in the NRF, it should use distinct callback URIs for each subscription. + +The subscription request may also include additional parameters indicating the list of attributes (including Vendor-Specific attributes, see 3GPP TS 29.500 [4], clause 6.6.3) in the NF Profile to be monitored (or to be excluded from monitoring), in order to determine whether a notification from NRF should be sent, or not, when any of those attributes is changed in the profile. + +The NF Service Consumer may request the creation of a subscription to a specific NF Instance, or to a set of NF Instances, where the set is determined according to different criteria specified in the request body, in the "subscrCond" attribute of the "SubscriptionData" object type (see clause 6.1.6.2.16). + +The subscription shall be authorized, or rejected, by the NRF by checking the relevant input attributes (e.g. reqNfType, reqNfFqdn, reqSnssais, reqPerPlmnSnssais, reqPlmnList, reqSnpnList, etc.) in the subscription request body (along with the contents of any optional Oauth2 access token provided in the API request) against the list of authorization attributes in the NF Profile of the target NF Instance to be monitored. + +An SCP may request a subscription to the complete profile of NF Instances (including, e.g. the authorization attributes of the target NF Instances to be monitored). Upon receiving such a request, the NRF shall verify that the requesting entity is authorized to subscribe to the complete profile of NF instances, based on local policies or + +the receipt of an Oauth2 access token granting such permission. If the requesting entity is not authorized to do so, the NRF shall reject the request or handle it as a subscription request without access to the complete profile. + +When the subscription request is for a set of NFs, the authorization attributes of the NF Instances in the set may differ, resulting in positive authorization of the subscription for only a part of the NF Instances in the set; in that case, the subscription to the set of NFs may be accepted by the NRF, but the NF Instances in the set that are not authorized for the NF Service Consumer that requested the subscription, shall not result in triggering any notification event from the NRF to the NF Service Consumer. + +- 2a. On success, "201 Created" shall be returned. The response shall contain the data related to the created subscription, including the validity time, as determined by the NRF, after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving status notifications, it shall create a new subscription in the NRF. +- 2b. On failure or redirection: + - If the creation of the subscription fails at the NRF due to errors in the SubscriptionData JSON object in the request body, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the creation of the subscription fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +### 5.2.2.5.3 Subscription to NF Instances in a different PLMN + +The subscription to notifications on NF Instances in a different PLMN is done by creating a resource under the collection resource "subscriptions", in the NRF of the Home PLMN. + +For that, step 1 in clause 5.2.2.5.2 is executed (send a POST request to the NRF in the Serving PLMN); this request shall include the identity of the PLMN of the home NRF in the SubscriptionData parameter in the request body. + +If the NRF in Serving PLMN knows that Oauth2-based authorization is required for accessing the NFManagement service of the NRF in Home PLMN, e.g. by learning this during an earlier Bootstrapping procedure or local configuration, and if the request received at the NRF in Serving PLMN does not include an access token, the NRF in Serving PLMN may reject the request with a 401 Unauthorized as specified in clause 6.7.3 of 3GPP TS 29.500 [4]. + +Then, steps 1-2 in Figure 5.2.2.5.3-1 are executed, between the NRF in the Serving PLMN and the NRF in the Home PLMN. In this step, the PLMN ID may be present in the SubscriptionData parameter. The NRF in the Home PLMN returns a subscriptionID identifying the created subscription. + +Finally, step 2 in clause 5.2.2.5.2 is executed; a new subscriptionID shall be generated by the NRF in the Serving PLMN as indicated in step 2 of Figure 5.2.2.5.3-1, and shall be sent to the NF Service Consumer in the Serving PLMN. + +![Sequence diagram showing the interaction between the NRF in the Serving PLMN and the NRF in the Home PLMN for subscription creation. The Serving PLMN sends a POST request to the Home PLMN, which responds with 201 Created or an error/redirection status code.](14515d82ffeec9475b9add3036ff26ab_img.jpg) + +``` + +sequenceDiagram + participant NRF_Serving as NRF in Serving PLMN + participant NRF_Home as NRF in Home PLMN + Note left of NRF_Serving: NF Service Consumer in Serving PLMN + NRF_Serving->>NRF_Home: 1. POST .../subscriptions (SubscriptionData) + NRF_Home-->>NRF_Serving: 2a. 201 Created (SubscriptionData) + NRF_Home-->>NRF_Serving: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between the NRF in the Serving PLMN and the NRF in the Home PLMN for subscription creation. The Serving PLMN sends a POST request to the Home PLMN, which responds with 201 Created or an error/redirection status code. + +**Figure 5.2.2.5.3-1: Subscription to NF Instances in a different PLMN** + +1. The NRF in Serving PLMN shall send a POST request to the resource URI in the NRF in Home PLMN representing the "subscriptions" collection resource. The request body shall include the SubscriptionData as received by the NRF in Serving PLMN from the NF Service Consumer in the Serving PLMN (see 5.2.2.5.2), containing the data about the type of notifications that the NF Service Consumer is interested in receiving and + +the callback URI where the NF Service Consumer shall be prepared to receive the notifications from the NRF (see NFStatusNotify operation in 5.2.2.6). + +- 2a. On success, "201 Created" shall be returned. If the subscription is created in a different NRF in the HPLMN than the NRF in the HPLMN that receives the subscription request, the latter should include information in the subscriptionID (after the first 5 or 6 digits and "-") such as to be able to forward the subsequent subscription modification or deletion request it may receive from the NRF in the serving PLMN towards the NRF in the HPLMN holding the subscription. The information to be included in the subscriptionID is left to implementation. + +If the Home NRF is located in a PLMN: + +The NRF in Serving PLMN should not keep state for this created subscription and shall send to the NF Service Consumer in Serving PLMN (step 2 in 5.2.2.5.2) a subscriptionID that shall consist on the following structure: +++"-"+ + +If the Home NRF is located in an SNPN: + +++"-"+"x3Lf57A"+"nid="++"-"+ + +NOTE: The fixed 7-character string "x3Lf57A" is used to prevent accidental collisions with subscription IDs generated according to earlier versions of this specification, where the subscription ID could only contain MCC and MNC values; this mechanism is commonly known as "magic cookie". + +EXAMPLE 1: If the NRF in a Home PLMN (where MCC = 123, and MNC=456) creates a subscription with value "subs987654", the subscriptionID that the NRF in Serving PLMN would send to the NF Service Consumer in Serving PLMN is: "123456-subs987654" + +EXAMPLE 2: If the NRF in an SNPN (where MCC = 321, MNC = 654 and NID = 023f245ac42) creates a subscription with value "subs987654", the subscriptionID that the NRF in Serving PLMN would send to the NF Service Consumer in Serving PLMN is: +"321654-x3Lf57A:nid=023f245ac42:subs987654". + +The URI in the Location header that the NRF in Serving PLMN returns to the NF Service Consumer in Serving PLMN shall contain a modified as described above and, if it is as an absolute URI, an apiRoot pointing to the address of the NRF in Serving PLMN. The subscriptionId attribute in the message body that the NRF in Serving PLMN returns to the NF Service Consumer in Serving PLMN shall also contain a modified as described above. + +2b. On failure or redirection: + +- If the creation of the subscription fails at the NRF due to errors in the SubscriptionData JSON object in the request body, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. +- If the creation of the subscription fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +#### 5.2.2.5.4 Subscription to NF Instances with intermediate forwarding NRF + +When multiple NRFs are deployed in one PLMN, an NF Instance can subscribe to changes of NF Instances registered in an NRF to which it is not directly interacting. The subscription message is forwarded by an intermediate NRF to which the subscribing NF instance is directly interacting. + +For that, step 1 in clause 5.2.2.5.2 is executed (send a POST request to the NRF-1 in the Serving PLMN); this request shall include the SubscriptionData parameter in the request body. + +Then, steps 1-4 in Figure 5.2.2.5.4-1 are executed between NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN and NRF-2 in Serving PLMN. In these steps, NRF-1 sends the subscription request to a pre-configured NRF-2. NRF-2 requests corresponding NRF (e.g. the NF Service Producer registered NRF) and returns a subscriptionID identifying the created subscription and this subscriptionID is sent to the NF Service Consumer via NRF-1. + +Finally, step 2 in clause 5.2.2.5.2 is executed; the subscriptionID shall be sent to the NF Service Consumer. + +![Sequence diagram illustrating 'Subscription with intermediate forwarding NRF'. The diagram shows three participants: NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN, and NRF-2 in Serving PLMN. The sequence of messages is: 1. POST ../subscriptions(SubscriptionData) from Consumer to NRF-1; 2. POST ../subscriptions(SubscriptionData) from NRF-1 to NRF-2; 3. Responses from NRF-2 to NRF-1 (3a. 201 Created, 3b. 4xx/5xx, 3c. 3xx Redirect); 4. Responses from NRF-1 to Consumer (4a. 201 Created, 4b. 4xx/5xx, 4c. 3xx Redirect).](90ddb84c323b956e2d50a54d3f870566_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer in Serving PLMN + participant NRF1 as NRF-1 in Serving PLMN + participant NRF2 as NRF-2 in Serving PLMN + Note left of Consumer: 1. POST ../subscriptions(SubscriptionData) + Consumer->>NRF1: 1. POST ../subscriptions(SubscriptionData) + Note right of NRF1: 2. POST ../subscriptions(SubscriptionData) + NRF1->>NRF2: 2. POST ../subscriptions(SubscriptionData) + Note right of NRF2: 3a. 201 Created(Subscription ID) +3b. 4xx/5xx(ProblemDetails) +3c. 3xx Temporary/Permanent Redirect + NRF2-->>NRF1: 3a. 201 Created(Subscription ID) +3b. 4xx/5xx(ProblemDetails) +3c. 3xx Temporary/Permanent Redirect + Note left of NRF1: 4a. 201 Created(Subscription ID) +4b. 4xx/5xx(ProblemDetails) +4c. 3xx Temporary/Permanent Redirect + NRF1-->>Consumer: 4a. 201 Created(Subscription ID) +4b. 4xx/5xx(ProblemDetails) +4c. 3xx Temporary/Permanent Redirect + +``` + +Sequence diagram illustrating 'Subscription with intermediate forwarding NRF'. The diagram shows three participants: NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN, and NRF-2 in Serving PLMN. The sequence of messages is: 1. POST ../subscriptions(SubscriptionData) from Consumer to NRF-1; 2. POST ../subscriptions(SubscriptionData) from NRF-1 to NRF-2; 3. Responses from NRF-2 to NRF-1 (3a. 201 Created, 3b. 4xx/5xx, 3c. 3xx Redirect); 4. Responses from NRF-1 to Consumer (4a. 201 Created, 4b. 4xx/5xx, 4c. 3xx Redirect). + +**Figure 5.2.2.5.4-1: Subscription with intermediate forwarding NRF** + +1. NRF-1 receives a subscription request and sends the subscription request to a pre-configured NRF-2. This may for example include cases where NRF-1 does not have sufficient information as determined by the operator policy to fulfill the request locally. +2. Upon receiving a subscription request, based on the SubscriptionData contained in the subscription request (e.g. NF type) and locally stored information (see clause 5.2.2.2.3), NRF-2 shall identify the next hop NRF and forward the subscription request to that NRF (i.e. NF Service Producer registered NRF). +- 3a. On success, "201 Created" shall be returned by NRF-2. +- 3b. On failure, i.e. if the creation of the subscription fails, the NRF-2 shall return "4XX/5XX" response. +- 3c. In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. +- 4a. NRF-1 forwards the success response to NF Service Consumer. The content of the POST response shall contain the representation describing the status of the request and the "Location" header shall be present and shall contain the URI of the created resource. The authority and/or deployment-specific string of the apiRoot of the created resource URI may differ from the authority and/or deployment-specific string of the apiRoot of the request URI received in the POST request. +- 4b. On failure, NRF-1 forwards the error response to NF Service Consumer. +- 4c. In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +#### 5.2.2.5.5 Subscription to NF Instances with intermediate redirecting NRF + +When multiple NRFs are deployed in one PLMN, an NF Instance can subscribe to changes of NF Instances registered in another NRF. The subscription message is redirected by a third NRF. + +For that, step 1 in clause 5.2.2.5.2 is executed (send a POST request to the NRF-1 in the Serving PLMN); this request shall include the SubscriptionData parameter in the request body. + +Then, steps 2-5 in Figure 5.2.2.5.5-1 are executed between NRF-1, NRF-2 and NRF-3. + +Finally, step 2 in clause 5.2.2.5.2 is executed; the subscriptionID shall be sent to the NF Service Consumer. + +![Sequence diagram showing the subscription process to NF instances with intermediate redirecting NRF. The diagram involves four lifelines: NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN, NRF-2 in Serving PLMN, and NRF-3 in Serving PLMN. The sequence of messages is: 1. POST ../subscriptions(SubscriptionData) from Consumer to NRF-1; 2. POST ../subscriptions(SubscriptionData) from NRF-1 to NRF-2; 3. 307 Temporary Redirect from NRF-2 to NRF-1; 4. POST ../subscriptions(SubscriptionData) from NRF-1 to NRF-3; 5a. 201 Created(Subscription ID) from NRF-3 to NRF-1; 5b. 4xx/5xx(ProblemDetails) from NRF-3 to NRF-1; 6a. 201 Created(Subscription ID) from NRF-1 to Consumer; 6b. 4xx/5xx(ProblemDetails) from NRF-1 to Consumer.](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer in Serving PLMN + participant NRF1 as NRF-1 in Serving PLMN + participant NRF2 as NRF-2 in Serving PLMN + participant NRF3 as NRF-3 in Serving PLMN + Note left of Consumer: 1. POST ../subscriptions(SubscriptionData) + Consumer->>NRF1: 1. POST ../subscriptions(SubscriptionData) + Note right of NRF1: 2. POST ../subscriptions(SubscriptionData) + NRF1->>NRF2: 2. POST ../subscriptions(SubscriptionData) + Note right of NRF2: 3. 307 Temporary Redirect + NRF2->>NRF1: 3. 307 Temporary Redirect + Note right of NRF1: 4. POST ../subscriptions(SubscriptionData) + NRF1->>NRF3: 4. POST ../subscriptions(SubscriptionData) + Note right of NRF3: 5a. 201 Created(Subscription ID) + NRF3->>NRF1: 5a. 201 Created(Subscription ID) + Note right of NRF3: 5b. 4xx/5xx(ProblemDetails) + NRF3->>NRF1: 5b. 4xx/5xx(ProblemDetails) + Note right of NRF1: 6a. 201 Created(Subscription ID) + NRF1->>Consumer: 6a. 201 Created(Subscription ID) + Note right of NRF1: 6b. 4xx/5xx(ProblemDetails) + NRF1->>Consumer: 6b. 4xx/5xx(ProblemDetails) + +``` + +Sequence diagram showing the subscription process to NF instances with intermediate redirecting NRF. The diagram involves four lifelines: NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN, NRF-2 in Serving PLMN, and NRF-3 in Serving PLMN. The sequence of messages is: 1. POST ../subscriptions(SubscriptionData) from Consumer to NRF-1; 2. POST ../subscriptions(SubscriptionData) from NRF-1 to NRF-2; 3. 307 Temporary Redirect from NRF-2 to NRF-1; 4. POST ../subscriptions(SubscriptionData) from NRF-1 to NRF-3; 5a. 201 Created(Subscription ID) from NRF-3 to NRF-1; 5b. 4xx/5xx(ProblemDetails) from NRF-3 to NRF-1; 6a. 201 Created(Subscription ID) from NRF-1 to Consumer; 6b. 4xx/5xx(ProblemDetails) from NRF-1 to Consumer. + +**Figure 5.2.2.5.5-1: Subscription to NF Instances with intermediate redirecting NRF** + +1. NF Service Consumer send a subscription request to NRF-1. +2. NRF-1 receives a subscription request but does not have the information to fulfil the request. Then NRF-1 sends the subscription request to a pre-configured NRF-2. +3. Upon receiving a subscription request, based on the SubscriptionData contained in the subscription request (e.g. NF type) and locally stored information (see clause 5.2.2.2.3), NRF-2 shall identify the next hop NRF, and redirect the subscription request by returning HTTP 307 Temporary Redirect response. +The 307 Temporary Redirect response shall contain a Location header field, the host part of the URI in the Location header field represents NRF-3. +4. Upon receiving 307 Temporary Redirect response, NRF-1 sends the subscription request to NRF-3 by using the URI contained in the Location header field of the 307 Temporary Redirect response. +- 5a. On success, "201 Created" shall be returned by NRF-3. +- 5b. On failure, if the creation of the subscription fails at the NRF-3, the NRF-3 shall return "4XX/5XX" response. +- 6a. On success, "201 Created" shall be forwarded to NF Service Consumer via NRF-1. The content of the POST response shall contain the representation describing the status of the request and the "Location" header shall be present and shall contain the URI of the created resource. The authority and/or deployment-specific string of the apiRoot of the created resource URI may differ from the authority and/or deployment-specific string of the apiRoot of the request URI received in the POST request. +- 6b. On failure, if the creation of the subscription fails, "4XX/5XX" shall be forwarded to NF Service Consumer via NRF-1. + +#### 5.2.2.5.6 Update of Subscription to NF Instances + +The subscription to notifications on NF Instances may be updated to refresh the validity time, when this time is about to expire. The NF Service Consumer may request a new validity time to the NRF, and the NRF shall answer with the new assigned validity time, if the operation is successful. + +This operation is executed by updating the resource identified by "subscriptionID". It is invoked by issuing an HTTP PATCH request on the URI representing the individual resource received in the Location header field of the "201 Created" response received during a successful subscription (see clause 5.2.2.5). + +![Sequence diagram showing the interaction between an NF Service Consumer and an NRF for subscription management. The consumer sends a PATCH request to the NRF. The NRF responds with one of three options: 2a. 204 No Content, 2b. 200 OK with SubscriptionData, or 2c. 4xx/5xx ProblemDetails or 3xx redirection.](9c1d3678db4a12d5864cb2a4def1135d_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 2a. 204 No Content () +2b. 200 OK (SubscriptionData) +2c. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer->>NRF: 1. PATCH .../subscriptions/{subscriptionID} (PatchData) + NRF-->>NF Service Consumer: 2a. 204 No Content () + Note right of NRF: 2b. 200 OK (SubscriptionData) + NRF-->>NF Service Consumer: 2b. 200 OK (SubscriptionData) + Note right of NRF: 2c. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>NF Service Consumer: 2c. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an NRF for subscription management. The consumer sends a PATCH request to the NRF. The NRF responds with one of three options: 2a. 204 No Content, 2b. 200 OK with SubscriptionData, or 2c. 4xx/5xx ProblemDetails or 3xx redirection. + +**Figure 5.2.2.5.6-1: Subscription to NF Instances in the same PLMN** + +1. The NF Service Consumer shall send a PATCH request to the resource URI identifying the individual subscription resource. The content of the PATCH request shall contain a "replace" operation on the "validityTime" attribute of the SubscriptionData structure and shall contain a new suggested value for it; no other attribute of the resource shall be updated as part of this operation. +- 2a. On success, if the NRF accepts the extension of the lifetime of the subscription, and it accepts the requested value for the "validityTime" attribute, a response with status code "204 No Content" shall be returned. +- 2b. On success, if the NRF accepts the extension of the lifetime of the subscription, but it assigns a validity time different than the value suggested by the NF Service Consumer, a "200 OK" response code shall be returned. The response shall contain the new resource representation of the "subscription" resource, which includes the new validity time, as determined by the NRF, after which the subscription becomes invalid. +- 2c. On failure or redirection: + - If the update of the subscription fails at the NRF due to errors in the JSON Patch object in the request body, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the update of the subscription fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +**EXAMPLE:** + +``` + +PATCH .../subscriptions/2a58bf47 +Content-Type: application/json-patch+json + +[ + { "op": "replace", "path": "/validityTime", "value": "2018-12-30T23:20:50Z" }, +] + +``` + +``` + +HTTP/2 204 No Content + +``` + +## 5.2.2.5.7 Update of Subscription to NF Instances in a different PLMN + +The update of subscription in a different PLMN is done by updating a subscription resource identified by a "subscriptionID". + +For that, step 1 in clause 5.2.2.5.6 is executed (send a PATCH request to the NRF in the Serving PLMN); this request shall include the identity of the PLMN or SNPN of the home NRF (MCC/MNC/NID values) as a component values of the subscriptionID. + +Then, steps 1-2 in Figure 5.2.2.5.7-1 are executed, between the NRF in the Serving PLMN and the NRF in the Home PLMN. In this step, the subscriptionID sent to the NRF in the Home PLMN shall not contain the identity of the PLMN (i.e., it shall be the same subscriptionID value as originally generated by the NRF in the Home PLMN). The NRF in the Home PLMN returns a status code with the result of the operation. + +If the subscription was created in a different NRF in the HPLMN than the NRF in the HPLMN that receives the subscription update request, the latter shall forward the request received from the NRF in the serving PLMN towards the NRF in the HPLMN holding the subscription, using the information included in the subscriptionID (see + +clause 5.2.2.5.3). The subscriptionID value in the request forwarded to the NRF in the HPLMN holding the subscription shall contain the same value as originally generated by the latter. + +Finally, step 2 in clause 5.2.2.5.7-2 is executed; a status code is returned to the NF Service Consumer in Serving PLMN in accordance to the result received from NRF in the Home PLMN. + +![Sequence diagram showing the update of a subscription to NF instances in a different PLMN. The diagram involves two main entities: 'NRF in Serving PLMN' and 'NRF in Home PLMN'. Step 1 shows a PATCH request from the Serving PLMN to the Home PLMN. Step 2 shows the response from the Home PLMN back to the Serving PLMN, with three possible outcomes: 2a. 204 No Content, 2b. 200 OK with SubscriptionData, and 2c. 4xx/5xx (ProblemDetails) or 3xx.](6ca05954842b17f14dfd52f26b9d43d2_img.jpg) + +``` + +sequenceDiagram + participant NRF_Serving as NRF in Serving PLMN + participant NRF_Home as NRF in Home PLMN + Note right of NRF_Home: 2a. 204 No Content () +2b. 200 OK (SubscriptionData) +2c. 4xx/5xx (ProblemDetails) or 3xx + NRF_Serving->>NRF_Home: 1. PATCH .../subscriptions/{subscriptionID} (PatchData) + NRF_Home-->>NRF_Serving: 2a. 204 No Content () + NRF_Home-->>NRF_Serving: 2b. 200 OK (SubscriptionData) + NRF_Home-->>NRF_Serving: 2c. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the update of a subscription to NF instances in a different PLMN. The diagram involves two main entities: 'NRF in Serving PLMN' and 'NRF in Home PLMN'. Step 1 shows a PATCH request from the Serving PLMN to the Home PLMN. Step 2 shows the response from the Home PLMN back to the Serving PLMN, with three possible outcomes: 2a. 204 No Content, 2b. 200 OK with SubscriptionData, and 2c. 4xx/5xx (ProblemDetails) or 3xx. + +**Figure 5.2.2.5.7-1: Update of Subscription to NF Instances in a different PLMN** + +1. The NRF in Serving PLMN shall send a PATCH request to the resource URI representing the individual subscription. The content of the PATCH request shall contain a "replace" operation on the "validityTime" attribute of the SubscriptionData structure and shall contain a new suggested value for it; +- 2a. On success, if the NRF in the Home PLMN accepts the extension of the lifetime of the subscription, and it accepts the requested value for the "validityTime" attribute, a response with status code "204 No Content" shall be returned. +- 2b. On success, if the NRF in the Home PLMN accepts the extension of the lifetime of the subscription, but it assigns a validity time different than the value suggested by the NF Service Consumer, a "200 OK" response code shall be returned. The response shall contain the new resource representation of the "subscription" resource, which includes the new validity time, as determined by the NRF in the Home PLMN, after which the subscription becomes invalid. +- 2c. On failure or redirection: + - If the update of the subscription fails at the NRF due to errors in the JSON Patch object in the request body, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the update of the subscription fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +## 5.2.2.6 NFStatusNotify + +### 5.2.2.6.1 General + +This service operation notifies each NF Service Consumer that was previously subscribed to receiving notifications of registration/deregistration of NF Instances, or notifications of changes of the NF profile of a given NF Instance. The notification is sent to a callback URI that each NF Service Consumer provided during the subscription (see NFStatusSubscribe operation in 5.2.2.5). + +### 5.2.2.6.2 Notification from NRF in the same PLMN + +The operation is invoked by issuing a POST request to each callback URI of the different subscribed NF Instances. + +![Sequence diagram showing notification from NRF in the same PLMN. The diagram shows two lifelines: 'NF Service Consumer in Serving PLMN' and 'NRF in Serving PLMN'. The NRF sends a POST request (1. POST {nfStatusNotificationUri} (NotificationData)) to the consumer. The consumer responds with either a 204 No Content (2a) or an error status (2b. 4xx/5xx (ProblemDetails) or 3xx).](dd5771673aececa53d42ece89218299d_img.jpg) + +``` + +sequenceDiagram + participant NRF as NRF in Serving PLMN + participant Consumer as NF Service Consumer in Serving PLMN + Note right of Consumer: 2a. 204 No Content () + Note right of Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NRF->>Consumer: 1. POST {nfStatusNotificationUri} (NotificationData) + Consumer-->>NRF: 2a. 204 No Content () + Consumer-->>NRF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing notification from NRF in the same PLMN. The diagram shows two lifelines: 'NF Service Consumer in Serving PLMN' and 'NRF in Serving PLMN'. The NRF sends a POST request (1. POST {nfStatusNotificationUri} (NotificationData)) to the consumer. The consumer responds with either a 204 No Content (2a) or an error status (2b. 4xx/5xx (ProblemDetails) or 3xx). + +**Figure 5.2.2.6.2-1: Notification from NRF in the same PLMN** + +1. The NRF shall send a POST request to the callback URI. + +For notifications of newly registered NF Instances, the request body shall include the data associated to the newly registered NF, and its services, according to the criteria indicated by the NF Service Consumer during the subscription operation. These data shall contain the `nfInstanceURI` of the NF Instance, an indication of the event being notified ("registration"), and the new profile data (including, among others, the services offered by the NF Instance). + +For notifications of changes of the profile of a NF Instance, the request body shall include the `NFInstanceID` of the NF Instance whose profile was changed, an indication of the event being notified ("profile change"), and the new profile data. + +For notifications of deregistration of the NF Instance from NRF, the request body shall include the `NFInstanceID` of the deregistered NF Instance, and an indication of the event being notified ("deregistration"). + +**NOTE:** When the NF Instance changes its `NFStatus`, the NRF notifies subscribing entities with an "NF\_PROFILE\_CHANGED" event, except if the new `NFStatus` changes to "CANARY\_RELEASE" and the subscribing entity does not support the "Canary-Release" feature (see clause 6.1.9); in such case, the NRF notifies the subscribing entities with an "NF\_DEREGISTERED" event (see clause 6.1.6.3.6). + +When an NF Instance is newly registered in NRF, the NRF notifies subscribing entities with an "NF\_REGISTERED" event, except if such NF instance newly registers with status "CANARY\_RELEASE" and the subscribing entity does not support the "Canary-Release" feature; in such case, the NRF does not send an "NF\_REGISTERED" event to the subscribing entity. + +When an NF Service Instance changes its `NFServiceStatus` to "CANARY\_RELEASE", and the subscribing entity does not support the "Canary-Release" feature, the NRF sends a notification with an "NF\_PROFILE\_CHANGED" event that removes such NF Service Instance from the NF profile, so the subscribing entity can remove such instance from the list of available service instances of the corresponding NF producer. + +When an NF Service Consumer subscribes to a set of NFs (using the different subscription conditions specified in clause 6.1.6.2.35), a change in the profile of the monitored NF Instance may result in such NF becoming a part of the NF set, or stops becoming a part of it (e.g., an NF Service Consumer subscribing to all NFs offering a given NF Service, and then, a certain NF Instance changes its profile by adding or removing an NF Service of its NF Profile); in such case, the NRF shall use the "NF\_PROFILE\_CHANGED" event type in the notification. Similarly, a change of the status (i.e. the "`nfStatus`" attribute of the NF Profile) shall result into the NRF to send notifications to subscribing NFs with event type set to "NF\_PROFILE\_CHANGED". + +When an NF Service Consumer subscribes to a set of NFs, using the subscription conditions specified in clause 6.1.6.2.35, in case of a change of profile(s) of NFs potentially related to those subscription conditions, the NRF shall send notification to subscribing NF Service Consumer(s) to those NFs no longer matching the subscription conditions, and to subscribing NF Service Consumer(s) to NFs that start matching the subscription conditions. In that case, the NRF indicates in the notification data whether the notification is due to the NF Instance to newly start or stop matching the subscription condition (i.e. based on the presence of the "`conditionEvent`" attribute of the `NotificationData`). + +The notification of changes of the profile may be done by the NRF either by sending the entire new NF Profile, or by indicating a number of "delta" changes (see clause 6.1.6.2.17) from an existing NF Profile that might have been previously received by the NF Service Consumer during an `NFDiscovery` search operation (see clause 5.3.2.2). If the NF Service Consumer receives "delta" changes related to an NF Service Instance (other than + +adding a new NF Service Instance) that had not been previously discovered, those changes shall be ignored by the NF Service Consumer, but any other "delta" changes related to NF Service Instances previously discovered or adding a new NF Service Instance shall be applied. + +Change of authorization attributes (allowedNfTypes, allowedNfDomains, allowedNssais, allowedPlmns etc) shall trigger a "NF\_PROFILE\_CHANGED" notification from NRF, if the change of the NF Profile results in that the NF Instance starts or stops being authorized to be accessed by an NF having subscribed to be notified about NF profile changes. In this case, the NRF indicates in the notification data whether the notification is due to the NF Instance to newly start or stop matching the subscription condition (i.e. based on the presence of the "conditionEvent" attribute of the NotificationData). Otherwise change of authorization attributes shall not trigger notification. + +The notifications of new registrations, or updates of existing registrations, shall not include the content (or the changes) of the authorization attributes ("allowedXXX" attributes) of the target NF profile being monitored, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request. + +2a. On success, "204 No content" shall be returned by the NF Service Consumer. + +2b. On failure or redirection: + +- If the NF Service Consumer does not consider the "nfStatusNotificationUri" as a valid notification URI (e.g., because the URI does not belong to any of the existing subscriptions created by the NF Service Consumer in the NRF), the NF Service Consumer shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NF service consumer shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NF service consumer endpoint. + +#### 5.2.2.6.3 Notification from NRF in a different PLMN + +The operation is invoked by issuing a POST request to each callback URI of the different subscribed NF Instances. + +![Sequence diagram showing notification from NRF in Home PLMN to NF Service Consumer in Serving PLMN.](ca5dc5fde2061d0ca2051ef7840fc842_img.jpg) + +``` + +sequenceDiagram + participant NRF as NRF in Home PLMN + participant NSC as NF Service Consumer in Serving PLMN + Note right of NSC: 1. POST {nfStatusNotificationUri} (NotificationData) + NSC->>NRF: + Note left of NRF: 2a. 204 No Content () + Note left of NRF: 2b. 4xx/5xx (ProblemDetails) or 3xx + NRF-->>NSC: + +``` + +The diagram illustrates a sequence of interactions between an NF Service Consumer in a Serving PLMN and an NRF in a Home PLMN. + Step 1: A POST request containing {nfStatusNotificationUri} (NotificationData) is sent from the NRF in Home PLMN to the NF Service Consumer in Serving PLMN. + Step 2: The NF Service Consumer in Serving PLMN responds with either a 204 No Content () status code (2a) or a 4xx/5xx (ProblemDetails) or 3xx status code (2b) back to the NRF in Home PLMN. + +Sequence diagram showing notification from NRF in Home PLMN to NF Service Consumer in Serving PLMN. + +**Figure 5.2.2.6.3-1: Notification from NRF in a different PLMN** + +Steps 1 and 2 are identical to steps 1 and 2 in Figure 5.2.2.6.2-1. + +It should be noted that the POST request shall be sent directly from the NRF in Home PLMN to the NF Service Consumer in Serving PLMN, without involvement of the NRF in Serving PLMN. + +#### 5.2.2.6.4 Notification for subscription via intermediate NRF + +![Sequence diagram for Notification for subscription via intermediate NRF. Lifelines: NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN, NRF-2 in Serving PLMN. Step 0: Subscription via intermediate NRF. Step 1: POST {nfSatusModificationURI}(NotificationData) from NRF-2 to Consumer. Step 2a: 204 No Content () from NRF-2 to Consumer. Step 2b: 4xx/5xx(ProblemDetails) or 3xx from NRF-2 to Consumer.](9f9386d5b3d6cbeb1ed104a799320ebf_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer in Serving PLMN + participant NRF1 as NRF-1 in Serving PLMN + participant NRF2 as NRF-2 in Serving PLMN + Note over Consumer, NRF2: 0. Subscription via intermediate NRF + NRF2->>Consumer: 1. POST {nfSatusModificationURI}(NotificationData) + NRF2-->>Consumer: 2a. 204 No Content () + NRF2-->>Consumer: 2b. 4xx/5xx(ProblemDetails) or 3xx + +``` + +Sequence diagram for Notification for subscription via intermediate NRF. Lifelines: NF Service Consumer in Serving PLMN, NRF-1 in Serving PLMN, NRF-2 in Serving PLMN. Step 0: Subscription via intermediate NRF. Step 1: POST {nfSatusModificationURI}(NotificationData) from NRF-2 to Consumer. Step 2a: 204 No Content () from NRF-2 to Consumer. Step 2b: 4xx/5xx(ProblemDetails) or 3xx from NRF-2 to Consumer. + +**Figure 5.2.2.6.4-1: Notification for subscription via intermediate NRF** + +Step 0 is the NF Service Consumer creates a subscription to NRF-2 via intermediate NRF. + +Steps 1 and 2 are identical to steps 1 and 2 in Figure 5.2.2.6.2-1. + +The POST request shall be sent directly from NRF-2 to the NF Service Consumer without involvement of NRF-1. + +#### 5.2.2.7 NFStatusUnSubscribe + +##### 5.2.2.7.1 General + +This service operation removes an existing subscription to notifications. + +##### 5.2.2.7.2 Subscription removal in the same PLMN + +It is executed by deleting a given resource identified by a "subscriptionID". The operation is invoked by issuing a DELETE request on the URI representing the specific subscription received in the Location header field of the "201 Created" response received during a successful subscription (see clause 5.2.2.5). + +![Sequence diagram for Subscription removal in the same PLMN. Lifelines: NF Service Consumer in Serving PLMN, NRF in Serving PLMN. Step 1: DELETE .../subscriptions/{subscriptionID} () from Consumer to NRF. Step 2a: 204 No Content () from NRF to Consumer. Step 2b: 4xx/5xx (ProblemDetails) or 3xx from NRF to Consumer.](e5d1bcc699904ca5d56caf65ec83f5f3_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer in Serving PLMN + participant NRF as NRF in Serving PLMN + Consumer->>NRF: 1. DELETE .../subscriptions/{subscriptionID} () + NRF-->>Consumer: 2a. 204 No Content () + NRF-->>Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Subscription removal in the same PLMN. Lifelines: NF Service Consumer in Serving PLMN, NRF in Serving PLMN. Step 1: DELETE .../subscriptions/{subscriptionID} () from Consumer to NRF. Step 2a: 204 No Content () from NRF to Consumer. Step 2b: 4xx/5xx (ProblemDetails) or 3xx from NRF to Consumer. + +**Figure 5.2.2.7.2-1: Subscription removal in the same PLMN** + +1. The NF Service Consumer shall send a DELETE request to the resource URI representing the individual subscription. The request body shall be empty. +- 2a. On success, "204 No Content" shall be returned. The response body shall be empty. +- 2b. On failure or redirection: + - If the subscription, identified by the "subscriptionID", is not found in the list of active subscriptions in the NRF's database, the NRF shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +### 5.2.2.7.3 Subscription removal in a different PLMN + +The subscription removal in a different PLMN is done by deleting a resource identified by a "subscriptionID", in the NRF of the Home PLMN. + +For that, step 1 in clause 5.2.2.7.2 is executed (send a DELETE request to the NRF in the Serving PLMN); this request shall include the identity of the PLMN or SNPN of the home NRF (MCC/MNC/NID values) as component values of the subscriptionID (see clause 5.2.2.5.3). + +Then, steps 1-2 in Figure 5.2.2.7.3-1 are executed, between the NRF in the Serving PLMN and the NRF in the Home PLMN. In this step, the subscriptionID sent to the NRF in the Home PLMN shall not contain the identity of the PLMN (i.e., it shall be the same subscriptionID value as originally generated by the NRF in the Home PLMN). The NRF in the Home PLMN returns a status code with the result of the operation. + +If the subscription was created in a different NRF in the HPLMN than the NRF in the HPLMN that receives the subscription delete request, the latter shall forward the request received from the NRF in the serving PLMN towards the NRF in the HPLMN holding the subscription, using the information included in the subscriptionID (see clause 5.2.2.5.3). The subscriptionID value in the request forwarded to the NRF in the HPLMN holding the subscription shall contain the same value as originally generated by the latter. + +Finally, step 2 in clause 5.2.2.7.2 is executed; a status code is returned from the NRF in serving PLMN to the NF Service Consumer in Serving PLMN in accordance to the result received from NRF in Home PLMN. + +![Sequence diagram showing subscription removal in a different PLMN. The diagram involves two main entities: 'NRF in Serving PLMN' and 'NRF in Home PLMN'. The sequence of messages is: 1. A DELETE request is sent from the Serving PLMN to the Home PLMN. 2a. A '204 No Content' response is sent from the Home PLMN back to the Serving PLMN. 2b. Alternatively, a '4xx/5xx (ProblemDetails)' or '3xx' response is sent from the Home PLMN back to the Serving PLMN.](dfaa8b98082261913dac00eae86b2889_img.jpg) + +``` + +sequenceDiagram + participant NRF_Serving as NRF in Serving PLMN + participant NRF_Home as NRF in Home PLMN + Note left of NRF_Serving: 1. DELETE .../subscriptions/{subscriptionID} () + NRF_Serving->>NRF_Home: 1. DELETE .../subscriptions/{subscriptionID} () + Note right of NRF_Home: 2a. 204 No Content () + NRF_Home-->>NRF_Serving: 2a. 204 No Content () + Note right of NRF_Home: 2b. 4xx/5xx (ProblemDetails) or 3xx + NRF_Home-->>NRF_Serving: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing subscription removal in a different PLMN. The diagram involves two main entities: 'NRF in Serving PLMN' and 'NRF in Home PLMN'. The sequence of messages is: 1. A DELETE request is sent from the Serving PLMN to the Home PLMN. 2a. A '204 No Content' response is sent from the Home PLMN back to the Serving PLMN. 2b. Alternatively, a '4xx/5xx (ProblemDetails)' or '3xx' response is sent from the Home PLMN back to the Serving PLMN. + +**Figure 5.2.2.7.3-1: Subscription removal in a different PLMN** + +1. The NF Service Consumer shall send a DELETE request to the resource URI representing the individual subscription. The request body shall be empty. +- 2a. On success, "204 No Content" shall be returned. The response body shall be empty. +- 2b. On failure or redirection: + - If the subscription, identified by the "subscriptionID", is not found in the list of active subscriptions in the NRF's database, the NRF shall return "404 Not Found" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +### 5.2.2.8 NFListRetrieval + +#### 5.2.2.8.1 General + +This service operation allows the retrieval of a list of NF Instances that are currently registered in NRF. The operation may apply to the whole set of registered NF instances or only to a subset of the NF instances, based on a given NF type and/or maximum number of NF instances to be returned. + +![Sequence diagram for NF instance list retrieval](05eb72d372e4bf78e3d6a64949d77bcc_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 1. GET .../nf-instances? + NRF->>NF Service Consumer: 2a. 200 OK (UriList) + Note right of NRF: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +The diagram illustrates the interaction for NF instance list retrieval. It features two lifelines: 'NF Service Consumer' on the left and 'NRF' on the right. A solid arrow labeled '1. GET .../nf-instances?' points from the consumer to the NRF. A return arrow points from the NRF back to the consumer, with two possible response boxes: '2a. 200 OK (UriList)' and '2b. 4xx/5xx (ProblemDetails) or 3xx'. + +Sequence diagram for NF instance list retrieval + +**Figure 5.2.2.8.1-1: NF instance list retrieval** + +1. The NF Service Consumer shall send an HTTP GET request to the resource URI "nf-instances" collection resource. The optional input filter criteria (e.g. "nf-type") and pagination parameters for the retrieval request may be included in query parameters. +- 2a. On success, "200 OK" shall be returned. The response body shall contain the URI (conforming to the resource URI structure as described in clause 5.2.2.9.1) of each registered NF in the NRF that satisfy the retrieval filter criteria (e.g., all NF instances of the same NF type), or an empty list if there are no NFs to return in the query result (e.g., because there are no registered NFs in the NRF, or because there are no matching NFs of the type specified in the "nf-type" query parameter, currently registered in the NRF). The total count of items satisfying the filter criteria (e.g. "nf-type") should be returned in the response. +- 2b. On failure or redirection: + - If the NF Service Consumer is not allowed to retrieve the registered NF instances, the NRF shall return "403 Forbidden" status code. + - If the NF Instance list retrieval fails at the NRF due to errors in the input data in the URI query parameters, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the discovery request fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +## 5.2.2.9 NFProfileRetrieval + +### 5.2.2.9.1 General + +This service operation allows the retrieval of the NF profile of a given NF instance currently registered in NRF. + +![Sequence diagram for NF profile retrieval](1841f348dfa81a3438d4e1f8465d9ac7_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 1. GET .../nf-instances/{nfInstanceId} + NRF->>NF Service Consumer: 2a. 200 OK (NFProfile) + Note right of NRF: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +The diagram illustrates the interaction for NF profile retrieval. It features two lifelines: 'NF Service Consumer' on the left and 'NRF' on the right. A solid arrow labeled '1. GET .../nf-instances/{nfInstanceId}' points from the consumer to the NRF. A return arrow points from the NRF back to the consumer, with two possible response boxes: '2a. 200 OK (NFProfile)' and '2b. 4xx/5xx (ProblemDetails) or 3xx'. + +Sequence diagram for NF profile retrieval + +**Figure 5.2.2.9.1-1: NF profile retrieval** + +1. The NF Service Consumer shall send an HTTP GET request to the resource URI "nf-instances/{nfInstanceId}". +- 2a. On success, "200 OK" shall be returned. The response body shall contain the NF profile of the NF instance identified in the request. +- 2b. On failure or redirection: + +- If the NF Service Consumer is not allowed to retrieve the NF profile of this specific registered NF instance, the NRF shall return "403 Forbidden" status code. +- If the NF Profile retrieval fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +## 5.3 Nnrf\_NFDiscovery Service + +### 5.3.1 Service Description + +The Nnrf\_NFDiscovery service allows a NF or SCP Instance to discover other NF Instances with the potential services they offer, or to discover SEPP instances in the same PLMN, by querying the local NRF. + +The Nnrf\_NFDiscovery service also allows: + +- an SCP to discover other SCP instances, +- an NF or SCP to discover the list of NRF instances that are part of the NRF set with, for each NRF instance, its NRF instance ID and addressing information, if the NRF is part of an NRF set. + +It also allows an NRF in a PLMN to re-issue a discovery request towards an NRF in another PLMN (e.g., the HPLMN of a certain UE). + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operations defined for the Nnrf\_NFDiscovery service are as follows: + +- NFDiscover: It provides to the NF service consumer or SCP the profile (including IP address(es) or FQDN) of the NF Instance(s) or NF Service(s) or SEPP instances matching certain input criteria. It also provides to the SCP the profile (including IP address(es) or FQDN) of the SCP Instance(s) matching certain input criteria. + +The NFDiscover operation can be invoked by an NF Service Consumer (i.e., "source NF") or SCP requesting to discover NF instances (i.e., "target NFs") located in the same PLMN, or in a different PLMN, or SEPP instances located in the same PLMN. It can also be invoked by an SCP requesting to discover SCP instances located in the same PLMN. + +In the description of these operations in clause 5.3.2.2, when the NF instances are located in the same PLMN, both source NF and target NFs are said to be located in the "Serving PLMN" but, in the general case, the functionality is not restricted to the PLMN that is serving a given UE, and it shall be applicable as well to any scenario in which source NF and target NFs belong to the same PLMN. + +When source NF and target NFs are located in different PLMNs, the source NF is said to be in the "Serving PLMN", and the target NFs (and the NRF where they are registered) are said to be in the "Home PLMN", similarly to the scenarios described in 3GPP TS 23.502 [3], but the functionality shall be equally applicable to any scenario between any pair of PLMNs (e.g. with the source NF in the Home PLMN and the target NF in the Serving PLMN). + +The SCP and SEPP are treated by the Nnrf\_NFDiscovery service in the same way as NFs. Specifically, the SCP and SEPP are designated with a specific NF type and NF Instance ID. However, the SCP and SEPP do not support services. Accordingly, references to "NF" or "NF Profile" in the description of the service operations in the following clauses also apply to an SCP and SEPP. + +- SCPDomainRoutingInfoGet: It allows a service consumer (e.g. SCP) to fetch the SCP domain routing information (list of all SCP Domains registered by SCPs and the interconnected SCP domains per SCP domain), if both the SCP and the NRF supports the "SCPDR" feature. It also allows a service consumer (e.g. NRF) to fetch the local SCP domain routing information (based on SCPs registered in the NRF as service producer), if both the NRF as service consumer and NRF as service producer supports the "SCPDR" feature. + +NOTE: Two SCP domains are considered interconnected when at least one SCP belongs to both SCP domains, i.e. at least one SCP can bridge messages between these two SCP domains. + +- SCPDomainRoutingInfoSubscribe: It allows a service consumer (e.g. SCP) to create a subscription for changes of the SCP domain routing information, if both the SCP and the NRF supports the "SCPDRI" feature. It also allows a service consumer (e.g. NRF) to create a subscription for changes of local SCP domain routing information, if both the NRF as service consumer and NRF as service producer supports the "SCPDRI" feature. +- SCPDomainRoutingInfoNotify: It allows the NRF to send notification(s) to a service consumer (e.g. SCP) previously subscribed to the changes of the SCP domain routing information, if both the SCP and the NRF supports the "SCPDRI" feature. It also allows the NRF as service producer to send notification(s) to a service consumer (e.g. NRF) previously subscribed to the changes of the local SCP domain routing information, if both the NRF as service consumer and NRF as service producer supports the "SCPDRI" feature. +- SCPDomainRoutingInfoUnsubscribe: It allows a service consumer (e.g. SCP or NRF) to delete a previously created subscription for changes of the SCP domain routing information, if both the service consumer and the NRF as service producer supports the "SCPDRI" feature. + +A NRF may be part of an NRF set, whereby all NRF instances of the NRF Set share the same context data (e.g. registered NF profiles, NF status subscriptions). If so, the NF Service Consumer may be configured with the NRF Set ID or it may discover the same in the NRF Bootstrapping response. + +If the NRF is part of an NRF set, the NF Service Consumer may retrieve the NRF Set Information from the NRF via the Nnrf\_NFDiscovery service, which allows to discover the list of NRF instances that are part of the NRF set with, for each NRF instance, its NRF Instance ID and addressing information (i.e. part of NRF profile). + +NOTE: As part of the discovery of NRF instances belonging to an NRF Set, not all attributes in the NFProfile and NFService data structures (typically used for NF Consumer – NF Producer interaction) are needed for the NF Consumer to interact with the instances of the NRF Set, so the discovery response from NRF can be simplified and omit certain parameters. + +The NF Service Consumer may register with any of the NRF Instance Id within the NRF Set. If the NRF instance where an NF Service Consumer registered is down, the NF Service Consumer need not re-register to any new NRF instance within the NRF Set. The NRF may provide a binding indication to the NF service consumer, e.g. when the NF Service Consumer registers or updates its NF profile in the NRF or when it issues heartbeat requests, to indicate a preferred binding of the NF Service Consumer to one NRF instance within the NRF set, e.g. based on the location or data center of the registering/registered NF Service Consumer. + +## 5.3.2.2 NFDiscover + +### 5.3.2.2.1 General + +This service operation discovers the set of NF Instances (and their associated NF Service Instances), represented by their NF Profile, that are currently registered in NRF and satisfy a number of input query parameters. + +Before a service consumer invokes this service operation, it shall consider if it is possible to reuse the results from a previous searching (service discovery). + +The service consumer should reuse the previous result if input query parameters in the new service discovery request are the same as used for the previous search and the validity period of the result is not expired. + +The service consumer may consider reusing the previous result if the attributes as required for the new query consist of the query attributes from the previous query and additional query attributes. In such case, when the results of a previous query are reused, the service consumer need consider that the previous results will possibly include NF profiles that the new query would not; hence, the service consumer has to complete the filtering itself against the additional filter attributes in the new internal query. + +Otherwise, if the query parameters in the new service discovery are different and don't consist of the previous query attributes and additional ones (i.e. the new query parameters, in general, don't have any relationship with those of the previous search), the reuse of cached profiles may still be done. + +In these two last cases (i.e. where the query parameters of the new query are not identical to the previous query), re-using data from cached profiles may possibly yield to different results than if a new discovery was performed, and thus may be subject to operator's policy. + +NOTE: Certain types of query attributes affect the contents of the NF Profiles returned in the discovery responses (e.g., "preferred-location" typically affects the setting of the "priority" attribute inside the NF Profiles returned by NRF); reusing the results from a previous query, when the new query involves any of such parameters, may not be feasible. + +If an SCP receives complete NF profiles (including, e.g. the authorization attributes) from the NRF (see clauses 5.3.2.2.2 and 5.2.2.5.2), the SCP may use these cached profiles to serve new service requests received from NFs with different requester's information (e.g. different NF type, domain, S-NSSAI), but if it does so, the SCP shall check the authorization parameters of the complete profiles to ascertain that the requesting NFs are authorized to access the related NF services. + +The NF Service Consumer should avoid to send multiple NF discovery requests with the same query parameters to NRF simultaneously. + +### 5.3.2.2.2 Service Discovery in the same PLMN + +This service operation is executed by querying the "nf-instances" resource. The request is sent to an NRF in the same PLMN of the NF Service Consumer. + +![Sequence diagram showing Service Discovery Request in the same PLMN. The NF Service Consumer in Serving PLMN sends a GET request to the NRF in Serving PLMN. The NRF responds with either a 200 OK (SearchResult) or a 4xx/5xx (ProblemDetails) or 3xx.](9ff1b32449ea068bba9647d71904bd59_img.jpg) + +``` + +sequenceDiagram + participant NFSC as NF Service Consumer in Serving PLMN + participant NRF as NRF in Serving PLMN + Note left of NFSC: + NFSC->>NRF: 1. GET ../nf-instances? + Note right of NRF: + NRF-->>NFSC: 2a. 200 OK (SearchResult) + Note right of NRF: + NRF-->>NFSC: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing Service Discovery Request in the same PLMN. The NF Service Consumer in Serving PLMN sends a GET request to the NRF in Serving PLMN. The NRF responds with either a 200 OK (SearchResult) or a 4xx/5xx (ProblemDetails) or 3xx. + +**Figure 5.3.2.2.2-1: Service Discovery Request in the same PLMN** + +1. The NF Service Consumer shall send an HTTP GET request to the resource URI "nf-instances" collection resource. The input filter criteria for the discovery request shall be included in query parameters. + +An SCP may request to discover the complete profile of NF instances (including, e.g. the authorization attributes) matching the query parameters. Upon receiving such a request, the NRF shall verify that the requesting entity is authorized to discover the complete profile of NF instances, based on local policies or the receipt of an access token granting such permission. If the requesting entity is not authorized to do so, the NRF shall reject the request or handle it as a service discovery request without access to the complete profile. + +When certain query parameters in the discovery request are not supported by the NRF, the NRF shall ignore the unsupported query parameters and continue processing the request with the rest of the query parameters. + +- 2a. On success, "200 OK" shall be returned. The response body shall contain a validity period, during which the search result can be cached by the NF Service Consumer, and an array of NF Profile objects, and/or a map of NFInstanceInfo objects of NF instances (if the NF service consumer indicated support of the Enh-NF-Discovery feature in the request) that satisfy the search filter criteria (e.g., all NF Instances offering a certain NF Service name in REGISTERED status, or empty array in case search filter criteria do not match a NF Instance in REGISTERED status). In the latter case, the response may include the noProfileMatchInfo attribute to provide the specific reason for not finding any NF instance that can match the search filter criteria. + +If the NRF has ignored certain unsupported query parameter(s) when processing the discovery request, the NRF may additionally include the indication of ignored unsupported query parameters in the search result. The NF consumer may use the indication to identify whether the NF candidates in the search result are all usable for the service logic, i.e. all query parameter related to the key service logic are not ignored. + +- 2b. On failure or redirection: + +- If the NF Service Consumer is not allowed to discover the NF services for the requested NF type provided in the query parameters, the NRF shall return "403 Forbidden" response. +- If the discovery request fails at the NRF due to errors in the input data in the URI query parameters, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. +- If the discovery request fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +The NF Profile objects returned in a successful result shall contain generic data of each NF Instance, applicable to any NF type, and it may also contain NF-specific data, for those NF Instances belonging to a specific type (e.g., the attribute "udrInfo" is typically present in the NF Profile when the type of the NF Instance takes the value "UDR"). In addition, the attribute "customInfo", may be present in the NF Profile for those NF Instances with custom NF types. + +For those NF Instances, the "customInfo" attribute shall be returned by NRF, if available, as part of the NF Profiles returned in the discovery response. + +The NRF shall also include, in the returned NF Profile objects, the Vendor-Specific attributes (see 3GPP TS 29.500 [4], clause 6.6.3) that may have been provided by the registered NF Instances. + +If the response includes a map of NFInstanceInfo objects of NF instances, the NF Service Consumer may retrieve the NF profiles by issuing service discovery requests with the target-nf-instance-id parameter identifying the target NF Instance ID, or with the target-nf-instance-id-list parameter identifying a list of target NF Instance IDs held by the same NRF; the service discovery request shall also include the nrf-disc-uri parameter set to the API URI of the Nnrf\_NFDiscovery service of the NRF holding the NF profile(s), if the nrfDiscApiUri attribute was received in the NFInstanceInfo object and if the service discovery request is addressed to a different NRF than the NRF holding the NF profile(s). + +### 5.3.2.2.3 Service Discovery in a different PLMN + +The service discovery in a different PLMN is done by querying the "nf-instances" resource in the NRF of the Home PLMN. + +For that, step 1 in clause 5.3.2.2.2 is executed (send a GET request to the NRF in the Serving PLMN); this request shall include the identity of the PLMN of the home NRF in a query parameter of the URI. + +If the NRF in Serving PLMN knows that Oauth2-based authorization is required for accessing the NF Discovery service of the NRF in Home PLMN, e.g. by learning this during an earlier Bootstrapping procedure or local configuration, and if the request received at the NRF in Serving PLMN does not include an access token, the NRF in Serving PLMN may reject the request with a 401 Unauthorized as specified in clause 6.7.3 of 3GPP TS 29.500 [4]. + +Then, steps 1-2 in Figure 5.3.2.2.3-1 are executed, between the NRF in the Serving PLMN and the NRF in the Home PLMN. In this step, the presence of the PLMN ID of the Home NRF in the query parameter of the URI is not required. The NRF in the Home PLMN returns a status code with the result of the operation. The NRF in the Serving PLMN shall be configured with: + +- a telescopic FQDN (see 3GPP TS 23.003 [12] and 3GPP TS 29.500 [4]) of the NRF in the Home PLMN, if TLS protection between the NRF and the SEPP in the serving PLMN relies on using telescopic FQDN; or + +NOTE: This is required for the NRF in the serving PLMN to route the NF discovery request to the NRF in the HPLMN through a SEPP in the serving PLMN and the SEPP to terminate the TLS connection with a wildcard certificate. + +- with the SEPP FQDN (or the FQDN of the SCP if the communication between the NRF and the SEPP goes through an SCP), if TLS protection between the NRF and the SEPP in the serving PLMN relies on using the 3gpp-Sbi-Target-apiRoot header. + +See clause 6.1.4.3 of 3GPP TS 29.500 [4]. + +Finally, step 2 in clause 5.3.2.2.2 is executed; a status code is returned to the NF Service Consumer in Serving PLMN in accordance to the result received from NRF in Home PLMN. + +![Sequence diagram for Service Discovery in a different PLMN. It shows two lifelines: 'NRF in Serving PLMN' and 'NRF in Home PLMN'. Step 1: 'NRF in Serving PLMN' sends a 'GET .../nf-instances?' request to 'NRF in Home PLMN'. Step 2: 'NRF in Home PLMN' responds with '2a. 200 OK (SearchResult)' or '2b. 4xx/5xx (ProblemDetails) or 3xx' back to 'NRF in Serving PLMN'.](9f6dec4d4e9fde40bce018861ef1278e_img.jpg) + +``` + +sequenceDiagram + participant NRF_Serving as NRF in Serving PLMN + participant NRF_Home as NRF in Home PLMN + Note left of NRF_Serving: + NRF_Serving->>NRF_Home: 1. GET .../nf-instances? + Note right of NRF_Home: + NRF_Home-->>NRF_Serving: 2a. 200 OK (SearchResult) +2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Service Discovery in a different PLMN. It shows two lifelines: 'NRF in Serving PLMN' and 'NRF in Home PLMN'. Step 1: 'NRF in Serving PLMN' sends a 'GET .../nf-instances?' request to 'NRF in Home PLMN'. Step 2: 'NRF in Home PLMN' responds with '2a. 200 OK (SearchResult)' or '2b. 4xx/5xx (ProblemDetails) or 3xx' back to 'NRF in Serving PLMN'. + +**Figure 5.3.2.2.3-1: Service Discovery in a different PLMN** + +Steps 1 and 2 are similar to steps 1 and 2 in Figure 5.3.2.2.2-1, where the originator of the service invocation is the NRF in Serving PLMN, and the recipient of the service invocation is the NRF in the Home PLMN. + +As most NF Service Consumers in Serving PLMN do not need the entire data in the NF profile of the NF producer, the NRF in the home PLMN, based on operator policies, may simplify the NF discovery response by not including the entire data which is not directly relevant to the NF discovery request (e.g. returning a subset of supiRanges, or not including taiList). + +If the NRF in the home PLMN has ignored certain unsupported query parameter(s) when processing the discovery request, the NRF may additionally include the indication of ignored unsupported query parameters in the search result. If the indication of ignored unsupported query parameters is supported by the NRF in the serving PLMN, it should forward the received indication of ignored unsupported query parameters to the NF service consumer. + +#### 5.3.2.2.4 Service Discovery with intermediate redirecting NRF + +When multiple NRFs are deployed in one PLMN, one NRF may query the "nf-instances" resource in a different NRF so as to fulfil the service discovery request from a NF service consumer. The query between these two NRFs is redirected by a third NRF. + +![Sequence diagram for Service Discovery with intermediate redirecting NRF. It shows three lifelines: 'NRF-1', 'NRF-2', and 'NRF-3'. Step 1: 'NRF-1' sends a 'GET .../nf-instances?' request to 'NRF-2'. Step 2: 'NRF-2' responds with '2a. 307 Temporary Redirect' or '2b. 404 Not Found' back to 'NRF-1'. Step 3: 'NRF-1' then sends the 'GET .../nf-instances?' request to 'NRF-3'. Step 4: 'NRF-3' responds with '4a. 200 OK (SearchResult)' or '4b. 4xx/5xx (ProblemDetails) or 3xx' back to 'NRF-1'.](b560268ea8f6526970f23f0da225b099_img.jpg) + +``` + +sequenceDiagram + participant NRF1 as NRF-1 + participant NRF2 as NRF-2 + participant NRF3 as NRF-3 + Note left of NRF1: + NRF1->>NRF2: 1. GET .../nf-instances? + Note right of NRF2: + NRF2-->>NRF1: 2a. 307 Temporary Redirect +2b. 404 Not Found + Note left of NRF1: + NRF1->>NRF3: 3. GET .../nf-instances? + Note right of NRF3: + NRF3-->>NRF1: 4a. 200 OK (SearchResult) +4b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Service Discovery with intermediate redirecting NRF. It shows three lifelines: 'NRF-1', 'NRF-2', and 'NRF-3'. Step 1: 'NRF-1' sends a 'GET .../nf-instances?' request to 'NRF-2'. Step 2: 'NRF-2' responds with '2a. 307 Temporary Redirect' or '2b. 404 Not Found' back to 'NRF-1'. Step 3: 'NRF-1' then sends the 'GET .../nf-instances?' request to 'NRF-3'. Step 4: 'NRF-3' responds with '4a. 200 OK (SearchResult)' or '4b. 4xx/5xx (ProblemDetails) or 3xx' back to 'NRF-1'. + +**Figure 5.3.2.2.4-1: Service Discovery with intermediate redirecting NRF** + +1. NRF-1 receives a service discovery request but does not have the information to fulfil the request. Then NRF-1 sends the service discovery request to a pre-configured NRF-2. +- 2a. Upon receiving a service discovery request, based on the information contained in the service discovery request (e.g. the "supi" query parameter in the URI) and locally stored information NRF-2 shall identify the next hop NRF (see clause 5.2.2.2.3), and redirect the service discovery request by returning HTTP 307 Temporary Redirect response. The locally stored information in NRF-2 may: + - a) be preconfigured; or + +- b) registered by other NRFs (see clause 5.2.2.2.3). + +The 307 Temporary Redirect response shall contain a Location header field, the host part of the URI in the Location header field represents NRF-3. + +- 2b. if NRF-2 does not have enough information to redirect the service discovery request, then it responds with 404 Not Found, and the rest of the steps are omitted. +- 3. Upon receiving 307 Temporary Redirect response, NRF-1 sends the service discovery request to NRF-3 by using the URI contained in the Location header field of the 307 Temporary Redirect response. +- 4a. Upon success, NRF-3 returns the search result. +- 4b. On failure or redirection: + - If the NF Service Consumer is not allowed to discover the NF services for the requested NF type provided in the query parameters, the NRF shall return "403 Forbidden" response. + - If the discovery request fails at the NRF due to errors in the input data in the URI query parameters, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the discovery request fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +#### 5.3.2.2.5 Service Discovery with intermediate forwarding NRF + +When multiple NRFs are deployed in one PLMN, one NRF may query the "nf-instances" resource in a different NRF so as to fulfil the service discovery request from a NF service consumer. The query between these two NRFs is forwarded by a third NRF. + +![Sequence diagram illustrating Service Discovery with intermediate forwarding NRF. The diagram shows three NRFs: NRF-1, NRF-2, and NRF-3. NRF-1 sends a GET request to NRF-2. NRF-2 then forwards the request to NRF-3. NRF-3 returns a response to NRF-2, which in turn returns a response to NRF-1. The responses can be 200 OK (SearchResult), 4xx/5xx (ProblemDetails), or 3xx (redirect).](132cff7e872feb31f629703959beddd7_img.jpg) + +``` + +sequenceDiagram + participant NRF-1 + participant NRF-2 + participant NRF-3 + Note left of NRF-1: 1. GET .../nf-instances? + NRF-1->>NRF-2: 1. GET .../nf-instances? + Note right of NRF-2: 2a. GET .../nf-instances? + NRF-2->>NRF-3: 2a. GET .../nf-instances? + Note right of NRF-3: 3a. 200 OK (SearchResult) +3b. 4xx/5xx (ProblemDetails) or 3xx + NRF-3-->>NRF-2: 3a. 200 OK (SearchResult) +3b. 4xx/5xx (ProblemDetails) or 3xx + Note left of NRF-2: 4a. 200 OK (SearchResult) +4b. 4xx/5xx (ProblemDetails) or 3xx + NRF-2-->>NRF-1: 4a. 200 OK (SearchResult) +4b. 4xx/5xx (ProblemDetails) or 3xx + Note left of NRF-1: 2b. 404 Not Found + NRF-2-->>NRF-1: 2b. 404 Not Found + +``` + +Sequence diagram illustrating Service Discovery with intermediate forwarding NRF. The diagram shows three NRFs: NRF-1, NRF-2, and NRF-3. NRF-1 sends a GET request to NRF-2. NRF-2 then forwards the request to NRF-3. NRF-3 returns a response to NRF-2, which in turn returns a response to NRF-1. The responses can be 200 OK (SearchResult), 4xx/5xx (ProblemDetails), or 3xx (redirect). + +**Figure 5.3.2.2.5-1: Service Discovery with intermediate forwarding NRF** + +1. NRF-1 receives a service discovery request and sends the service discovery request to a pre-configured NRF-2. This may for example include cases where NRF-1 does not have sufficient information as determined by the operator policy to fulfill the request locally. +- 2a. Upon receiving a service discovery request, based on the information contained in the service discovery request (e.g. the "supi" query parameter in the URI) and locally stored information, NRF-2 shall identify the next hop NRF (see clause 5.2.2.2.3), and forward the service discovery request to that NRF (i.e. NRF-3 in this example) similarly to steps 1 and 2 in Figure 5.3.2.2.2-1 where the originator of the service invocation is NRF-2 and the recipient of the service invocation is NRF-3. The locally stored information in NRF-2 may: + - a) be preconfigured; or + - b) registered by other NRFs (see clause 5.2.2.2.3). + +- 2b. if NRF-2 does not have enough information to forward the service discovery request, then it responds with 404 Not Found, and the rest of the steps are omitted. +- 3a. Upon success, NRF-3 returns the search result. +- 3b. On failure or redirection: +- If the NF Service Consumer is not allowed to discover the NF services for the requested NF type provided in the query parameters, the NRF shall return "403 Forbidden" response. + - If the discovery request fails at the NRF due to errors in the input data in the URI query parameters, the NRF shall return "400 Bad Request" status code with the ProblemDetails IE providing details of the error. + - If the discovery request fails at the NRF due to NRF internal errors, the NRF shall return "500 Internal Server Error" status code with the ProblemDetails IE providing details of the error. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. +- 4a. NRF-2 forwards the success response to NRF-1. +- 4b. On failure or redirection: +- NRF-2 forwards the error response to NRF-1. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. +- NOTE: It is not assumed that there can only be two NRF hierarchies, i.e. the NRF-3 can go on to forward the service discovery request to another NRF. + +### 5.3.2.2.6 Service Discovery with resolution of the target PLMN + +This service discovery is done by querying the "nf-instances" resource in the NRF of the target PLMN, similar to the "Service Discovery in a different PLMN", as described in clause 5.3.2.2.3. + +The main difference compared with clause 5.3.2.2.3 is that the identity of the target PLMN is not explicitly provided by the NF Service Consumer. + +NOTE: This can happen, e.g., when the identity of the UE involved in the service discovery is not based on IMSI, but on GPSI (MSISDN) and, therefore, the MNC/MCC of the target PLMN cannot be derived from the UE identity. It should also be noted that, in these scenarios, the MSISDN may be subject to Mobile Number Portability. + +![Sequence diagram for Service Discovery with resolution of the target PLMN. The diagram shows three lifelines: NF Service Consumer, NRF in Local PLMN, and NRF in Target PLMN. The process starts with the NF Service Consumer sending a GET request to the NRF in Local PLMN with query parameters including 'gpsi' and 'target-nw-resolution=true'. The NRF in Local PLMN then performs a 'Determination of Target PLMN'. It then sends a GET request to the NRF in Target PLMN. The NRF in Target PLMN returns a response (200 OK with SearchResult, or 4xx/5xx with ProblemDetails, or 3xx). The NRF in Local PLMN then forwards this response to the NF Service Consumer.](4669a2ca9d019b9c2de9a9d9a0c4e644_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF in Local PLMN + participant NRF in Target PLMN + + Note right of NRF in Local PLMN: 2. Determination of Target PLMN + + NF Service Consumer->>NRF in Local PLMN: 1. GET .../nf-instances?&gpsi=&target-nw-resolution=true + NRF in Local PLMN->>NRF in Target PLMN: 3. GET .../nf-instances? + NRF in Target PLMN-->>NRF in Local PLMN: 4a. 200 OK (SearchResult) +4b. 4xx/5xx (ProblemDetails) or 3xx + NRF in Local PLMN-->>NF Service Consumer: 5a. 200 OK (SearchResult) +5b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for Service Discovery with resolution of the target PLMN. The diagram shows three lifelines: NF Service Consumer, NRF in Local PLMN, and NRF in Target PLMN. The process starts with the NF Service Consumer sending a GET request to the NRF in Local PLMN with query parameters including 'gpsi' and 'target-nw-resolution=true'. The NRF in Local PLMN then performs a 'Determination of Target PLMN'. It then sends a GET request to the NRF in Target PLMN. The NRF in Target PLMN returns a response (200 OK with SearchResult, or 4xx/5xx with ProblemDetails, or 3xx). The NRF in Local PLMN then forwards this response to the NF Service Consumer. + +**Figure 5.3.2.2.6-1: Service Discovery with resolution of the target PLMN** + +1. The NF Service Consumer (e.g. an SMS-GMSC) sends a GET request to the NRF in the Local PLMN (i.e., the same PLMN where the NF Service Consumer is located); given that the identity of the target PLMN is not + +known to the NF Service Consumer, this request shall include as query parameters the identity of the target UE for which NF Service Producers need to be discovered (i.e., the "gpsi" query parameter) and also a parameter indicating that the resolution of the target PLMN must be performed (i.e., "target-nw-resolution" set to true). + +2. The NRF in the Local PLMN determines the identity of the Target PLMN, as described in 3GPP TS 23.540 [48], and determines the URI of the Nnrf\_NFDiscovery service of the NRF in the Target PLMN. +3. This step is similar to step 1 in Figure 5.3.2.2.3-1, for "Service Discovery in a different PLMN", with the only difference that the "Serving/Home" PLMNs in clause 5.3.2.2.3 are replaced by "Local/Target" PLMNs in the present clause. +4. Steps 4a, 4b are similar to steps 2a, 2b in Figure 5.3.2.2.3-1. +5. Steps 5a, 5b are similar to steps 2a, 2b in Figure 5.3.2.2.2-1. + +### 5.3.2.3 SCPDomainRoutingInfoGet + +This service operation retrieves the SCP domain routing information, by sending a HTTP GET request to the resource URI representing the "SCP Domain Routing Information" resource. + +![Sequence diagram for SCP Domain Routing Information Get](43979979715bb3304389a0cb18f34444_img.jpg) + +``` +sequenceDiagram + participant Service Consumer (e.g. SCP) + participant NRF + Note right of Service Consumer: 1. GET ../scp-domain-routing-info + Service Consumer->>NRF: 1. GET ../scp-domain-routing-info + Note right of NRF: 2a. 200 OK (ScpDomainRoutingInfo) +2b. 4xx/5xx (ProblemDetails) + NRF-->>Service Consumer: 2a. 200 OK (ScpDomainRoutingInfo) +2b. 4xx/5xx (ProblemDetails) +``` + +The diagram shows a sequence of interactions between a Service Consumer (e.g. SCP) and an NRF. The Service Consumer sends a GET request to the resource URI "scp-domain-routing-info". The NRF responds with either a 200 OK status containing the ScpDomainRoutingInfo, or a 4xx/5xx status containing ProblemDetails. + +Sequence diagram for SCP Domain Routing Information Get + +Figure 5.3.2.3-1: SCP Domain Routing Information Get + +1. The Service Consumer (i.e. SCP) shall send an HTTP GET request to the resource URI "scp-domain-routing-info" document resource. +- 2a. On success, "200 OK" shall be returned with SCP Domain Routing Information in response body. SCP Domain Routing Information with empty map indicates that no SCP domain is registered in the network. +- 2b. On failure, the NRF shall return "4xx/5xx" response and the response body may contain a ProblemDetails object describing the detailed information of the failure. + +When SCPs are registered to multiple NRFs in the network, any NRF providing SCP domain routing information for the whole network shall retrieve the local SCP domain routing information in other NRF(s) and perform aggregation. This service operation retrieves the local SCP domain routing information, e.g. by another NRF, by sending a HTTP GET request to the resource URI representing the "SCP Domain Routing Information" resource with "local" query parameter set to value "true". + +![Sequence diagram for Local SCP Domain Routing Information Get](4c9ba399ca7df11cbe9b6322cd9aee0a_img.jpg) + +``` +sequenceDiagram + participant Service Consumer (e.g. NRF) + participant NRF + Note right of Service Consumer: 1. GET ../scp-domain-routing-info?local=true + Service Consumer->>NRF: 1. GET ../scp-domain-routing-info?local=true + Note right of NRF: 2a. 200 OK (ScpDomainRoutingInfo) +2b. 4xx/5xx (ProblemDetails) + NRF-->>Service Consumer: 2a. 200 OK (ScpDomainRoutingInfo) +2b. 4xx/5xx (ProblemDetails) +``` + +The diagram shows a sequence of interactions between a Service Consumer (e.g. NRF) and an NRF. The Service Consumer sends a GET request to the resource URI "scp-domain-routing-info" with the query parameter "local=true". The NRF responds with either a 200 OK status containing the ScpDomainRoutingInfo, or a 4xx/5xx status containing ProblemDetails. + +Sequence diagram for Local SCP Domain Routing Information Get + +Figure 5.3.2.3-2: Local SCP Domain Routing Information Get + +1. The Service Consumer (i.e. SCP) shall send an HTTP GET request to the resource URI "scp-domain-routing-info" document resource with "local" query parameter set to value "true". + +- 2a. On success, "200 OK" shall be returned with local SCP Domain Routing Information in response body. SCP Domain Routing Information with empty map indicates that no SCP domain is registered in the producer NRF. +- 2b. On failure, the NRF shall return "4xx/5xx" response and the response body may contain a ProblemDetails object describing the detailed information of the failure. + +NOTE: In deployments where all SCPs in the network can be managed by the same NRF, i.e. all SCPs register to and discover each other with the same NRF, the NRF managing the SCPs can generate the SCP Domain Routing Information accordingly without involvement of other NRFs. + +### 5.3.2.4 SCPDomainRoutingInfoSubscribe + +This service operation is used to create a subscription to get notification when SCP Domain Routing Information is changed, e.g. due to a SCP has registered or updated or deregistered in the network, or to get notification when local SCP Domain Routing Information is changed, e.g. due to a SCP has registered or updated or deregistered in the producer NRF. The operation is invoked by issuing a POST request to the resource URI representing the "SCP Domain Routing Info Subscriptions" collection resource. + +![Sequence diagram showing the subscription process between a Service Consumer and an NRF.](3b00a61116faef21d3a6009fd350b46a_img.jpg) + +``` + +sequenceDiagram + participant SC as Service Consumer (e.g. SCP or NRF) + participant NRF + Note right of SC: 1. POST ../scp-domain-routing-info-subs (ScpDomainRoutingInfoSubscription) + SC->>NRF: Request + Note left of NRF: 2a. 201 Created (ScpDomainRoutingInfoSubscription) +2b. 4xx/5xx (ProblemDetails) + NRF-->>SC: Response + +``` + +The diagram illustrates the interaction for subscribing to SCP Domain Routing Information changes. A Service Consumer (e.g., SCP or NRF) sends a POST request to the NRF. The request is labeled '1. POST ../scp-domain-routing-info-subs (ScpDomainRoutingInfoSubscription)'. The NRF responds with either a '201 Created' status containing subscription details (2a) or a '4xx/5xx' error status with problem details (2b). + +Sequence diagram showing the subscription process between a Service Consumer and an NRF. + +**Figure 5.3.2.4-1: Subscription to SCP Domain Routing Information change** + +1. The Service Consumer (i.e. SCP) shall send a POST request to the URI representing the "SCP Domain Routing Info Subscriptions" collection resource. The request body shall contain the callback URI on the Service Consumer to receive the notifications. + +To create a subscription for changes of local SCP Domain Routing Information, the request body shall contain the "localInd" with value "true". + +- 2a. On success, "201 Created" shall be returned with "Location" header containing the resource URI to the newly created subscription resource. The response shall contain the data related to the created subscription, including the validity time, as determined by the NRF, after which the subscription becomes invalid. Once the subscription expires, if the Service Consumer wants to keep receiving notifications, it shall create a new subscription in the NRF. +- 2b. On failure, the NRF shall return "4xx/5xx" response and the response body may contain a ProblemDetails object describing the detailed information of the failure. + +### 5.3.2.5 SCPDomainRoutingInfoNotify + +This service operation notifies each subscriber for (local) SCP Domain Routing Information change. The notification is sent to a callback URI that Service Consumer provided during the subscription (see SCPDomainRoutingInfoSubscribe operation in clause 5.3.2.4). The operation is invoked by sending a POST request to the callback URI. + +![Sequence diagram for Figure 5.3.2.5-1: Notification of SCP Domain Routing Info Change. A Service Consumer (e.g. SCP or NRF) sends a POST {callbackUri} (ScpDomainRoutingInfoNotification) to the NRF. The NRF responds with 2a. 204 No Content () or 2b. 4xx/5xx (ProblemDetails).](32ff77da4286b58c4778033acaa10836_img.jpg) + +``` + +sequenceDiagram + participant Service Consumer (e.g. SCP or NRF) + participant NRF + Note right of Service Consumer: 1. POST {callbackUri} (ScpDomainRoutingInfoNotification) + Service Consumer->>NRF: 1. POST {callbackUri} (ScpDomainRoutingInfoNotification) + Note left of NRF: 2a. 204 No Content () +2b. 4xx/5xx (ProblemDetails) + NRF-->>Service Consumer: 2a. 204 No Content () +2b. 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram for Figure 5.3.2.5-1: Notification of SCP Domain Routing Info Change. A Service Consumer (e.g. SCP or NRF) sends a POST {callbackUri} (ScpDomainRoutingInfoNotification) to the NRF. The NRF responds with 2a. 204 No Content () or 2b. 4xx/5xx (ProblemDetails). + +**Figure 5.3.2.5-1: Notification of SCP Domain Routing Info Change** + +1. The NRF shall send a POST request to the callback URI. The request body shall contain the updated SCP Domain Routing Information. The request body shall contain the "localInd" IE with value "true" if the notification is for a change of local SCP Domain Routing Information. SCP Domain Routing Information with empty map indicates that no SCP domain is registered in the network (or in the producer NRF for local SCP Domain Routing Information) after the change. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure, the NRF shall return "4xx/5xx" response and the response body may contain a ProblemDetails object describing the detailed information of the failure. + +### 5.3.2.6 SCPDomainRoutingInfoUnSubscribe + +This service operation removes an existing subscription to SCP (local) Domain Information Change. The operation is invoked by issuing a DELETE request on the resource URI representing the "Individual SCP Domain Routing Info Subscription", which was received in the Location header field of the "201 Created" response received during a successful subscription (see clause 5.3.2.4). + +![Sequence diagram for Figure 5.3.2.6-1: Unsubscribe to SCP Domain Routing Information Change. An NF Service Consumer (e.g. SCP or NRF) sends a DELETE ../subscriptions/{subscriptionID} () to the NRF. The NRF responds with 2a. 204 No Content () or 2b. 4xx/5xx (ProblemDetails).](09e20a17ecd8042b3d9b7fd462f2d9b4_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer (e.g. SCP or NRF) + participant NRF + Note right of NF Service Consumer: 1. DELETE ../subscriptions/{subscriptionID} () + NF Service Consumer->>NRF: 1. DELETE ../subscriptions/{subscriptionID} () + Note left of NRF: 2a. 204 No Content () +2b. 4xx/5xx (ProblemDetails) + NRF-->>NF Service Consumer: 2a. 204 No Content () +2b. 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram for Figure 5.3.2.6-1: Unsubscribe to SCP Domain Routing Information Change. An NF Service Consumer (e.g. SCP or NRF) sends a DELETE ../subscriptions/{subscriptionID} () to the NRF. The NRF responds with 2a. 204 No Content () or 2b. 4xx/5xx (ProblemDetails). + +**Figure 5.3.2.6-1: Unsubscribe to SCP Domain Routing Information Change** + +1. The Service Consumer (e.g. SCP or NRF) shall send a DELETE request to the resource URI representing the individual subscription. The request body shall be empty. +- 2a. On success, "204 No Content" shall be returned. The response body shall be empty. +- 2b. On failure, the NRF shall return "4xx/5xx" response and the response body may contain a ProblemDetails object describing the detailed information of the failure. + +## 5.4 Nnrf\_AccessToken Service + +### 5.4.1 Service Description + +The NRF offers an Nnrf\_AccessToken service (used for OAuth2 authorization, see IETF RFC 6749 [16]), following the "Client Credentials" authorization grant, as specified in 3GPP TS 33.501 [15]. It exposes a "Token Endpoint" where the Access Token Request service can be requested by NF Service Consumers. + +## 5.4.2 Service Operations + +### 5.4.2.1 Introduction + +The services operations defined for the Nnrf\_AccessToken service are as follows: + +- Access Token Request (i.e. Nnrf\_AccessToken\_Get) + +### 5.4.2.2 Get (Access Token Request) + +#### 5.4.2.2.1 General + +This service operation is used by an NF Service Consumer to request an OAuth 2.0 access token from the authorization server (NRF). + +![Sequence diagram showing the Access Token Request process between an NF Service Consumer and an NRF. The consumer sends a POST /oauth2/token request to the NRF. The NRF responds with either a 200 OK (AccessTokenRsp) or an error response (400 Bad Request, 403 Forbidden, or 3xx).](080a7af02bc47cf21ebfae4e0be39745_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 1. POST /oauth2/token (AccessTokenReq) + NRF-->>NF Service Consumer: 2a. 200 OK (AccessTokenRsp) + Note right of NRF: 2b. 400 Bad Request (AccessTokenErr) or 403 Forbidden (ProblemDetails) or 3xx + NRF-->>NF Service Consumer: + +``` + +Sequence diagram showing the Access Token Request process between an NF Service Consumer and an NRF. The consumer sends a POST /oauth2/token request to the NRF. The NRF responds with either a 200 OK (AccessTokenRsp) or an error response (400 Bad Request, 403 Forbidden, or 3xx). + +**Figure 5.4.2.2.1-1: Access Token Request** + +1. The NF Service Consumer shall send a POST request to the "Token Endpoint", as described in IETF RFC 6749 [16], clause 3.2. The "Token Endpoint" URI shall be: + +{nrfApiRoot}/oauth2/token + +where {nrfApiRoot} represents the concatenation of the "scheme" and "authority" components of the NRF, as defined in IETF RFC 3986 [17]. + +The OAuth 2.0 Access Token Request includes in the body of the HTTP POST request shall contain: + +- An OAuth 2.0 grant type set to "client\_credentials"; +- The "scope" parameter indicating the names of the NF Services that the NF Service Consumer is trying to access (i.e., the expected NF service names); +- The NF Instance Id of the the NF Service Consumer requesting the OAuth 2.0 access token; +- NF type of the NF Service Consumer, if this is an access token request not for a specific NF Service Producer; +- NF type of the expected NF Service Producer, if this is an access token request not for a specific NF Service Producer; +- The NF Instance Id of the expected NF Service Producer, if this is an access token request for a specific NF Service Producer; +- Home and Serving PLMN IDs, if this is an access token request for use in roaming scenarios (see clause 13.4.1.2 of 3GPP TS 33.501 [15]). + +The request may additionally contain: + +- the NF Set ID of the expected NF service producer instances, if this is an access token request not for a specific NF Service Producer. + +- the NF Instance Id of the source NF (the NF that requests data), if this is an access token request from the DCCF as NF Service Consumer request data from NF Service Producers on behalf of the source NF. + +The NF Service Consumer shall use TLS for mutual authentication with the NRF in order to access this endpoint, if the PLMN uses protection at the transport layer. Otherwise, the NF Service Consumer shall use NDS or physical security to mutually authenticate with the NRF as specified in clause 13.3.1 of 3GPP TS 33.501 [15]. + +The NRF may verify that the input attributes (e.g. NF type) in the access token request match with the corresponding ones in the public key certificate of the NF service consumer. If the verification is successful, other authorization check shall be performed, otherwise, the request shall be rejected immediately with "400 Bad Request" status code, and "error" attribute set to "invalid\_client". + +2a. On success, "200 OK" shall be returned, the content of the POST response shall contain the requested access token and the token type set to value "Bearer". The response in addition: + +- should contain the expiration time for the token as indicated in IETF RFC 6749 [16] unless the expiration time of the token is made available by other means (e.g. deployment-specific documentation); and +- shall contain the NF service name(s) of the requested NF service producer(s), if it is different from the scope included in the access token request (see IETF RFC 6749 [16]). + +The access token shall be a JSON Web Token (JWT) as specified in IETF RFC 7519 [25]. The access token returned by the NRF shall include the claims encoded as a JSON object as specified in clause 6.3.5.2.4 and then digitally signed using JWS as specified in IETF RFC 7515 [24] and in clause 13.4.1 of 3GPP TS 33.501 [15]. + +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 [24]. + +2b. On failure or redirection: + +- If the access token request fails at the NRF, the NRF shall return "400 Bad Request" status code, including in the response content a JSON object that provides details about the specific error that occurred. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. +- If based on operator policy the required information used to authorize the access token request, e.g. requesterSnsSaiList, is not included, the NRF may return "403 Forbidden" status code with the ProblemDetails IE indicating that the missing information shall be provided. + +#### 5.4.2.2.2 Access Token request with intermediate forwarding NRF + +When multiple NRFs are deployed in one PLMN, one NRF may request an OAuth2 access token to a different NRF so as to fulfil the Access Token Request from a NF service consumer. The access token request between these two NRFs is forwarded by a third NRF in this case. + +For this, step 1 in clause 5.4.2.2.1 is executed (send a POST request to NRF-1 in the Serving PLMN); this request shall include the OAuth 2.0 Access Token Request in the request body. + +Then, steps 1-4 in Figure 5.4.2.2.2-1 hereinafter are executed between NRF-1 in Serving PLMN, NRF-2 in Serving PLMN and NRF-3 in Serving PLMN. + +Finally, step 2 in clause 5.4.2.2.1 is executed, the Access Token Response containing the requested access token, the token type and additional attributes shall be sent to the NF Service Consumer. + +![Sequence diagram illustrating the Access Token Request with intermediate forwarding NRF. The diagram shows three NRFs: NRF-1, NRF-2, and NRF-3, all in the serving PLMN. The sequence of messages is: 1. NRF-1 sends a POST /oauth2/token (AccessTokenReq) to NRF-2. 2a. NRF-2 forwards the request to NRF-3. 2b. NRF-2 returns a 404 Not Found response to NRF-1. 3a. NRF-3 returns a 200 OK (AccessTokenRsp) to NRF-2. 3b. NRF-3 returns a 400 Bad Request (AccessTokenErr) or 3xx response to NRF-2. 4a. NRF-2 forwards the 200 OK response to NRF-1. 4b. NRF-2 forwards a 400 Bad Request (AccessTokenErr) or 3xx response to NRF-1.](be3e5fe8be7cc5a74f67a4b8ac93193d_img.jpg) + +``` + +sequenceDiagram + participant NRF1 as NRF-1 +in serving PLMN + participant NRF2 as NRF-2 +in serving PLMN + participant NRF3 as NRF-3 +in serving PLMN + + NRF1->>NRF2: 1. POST /oauth2/token (AccessTokenReq) + NRF2->>NRF3: 2a. POST /oauth2/token (AccessTokenReq) + NRF2-->>NRF1: 2b. 404 Not Found + NRF3-->>NRF2: 3a. 200 OK (AccessTokenRsp) + NRF3-->>NRF2: 3b. 400 Bad Request (AccessTokenErr) or 3xx + NRF2-->>NRF1: 4a. 200 OK (AccessTokenRsp) + NRF2-->>NRF1: 4b. 400 Bad Request (AccessTokenErr) or 3xx + +``` + +Sequence diagram illustrating the Access Token Request with intermediate forwarding NRF. The diagram shows three NRFs: NRF-1, NRF-2, and NRF-3, all in the serving PLMN. The sequence of messages is: 1. NRF-1 sends a POST /oauth2/token (AccessTokenReq) to NRF-2. 2a. NRF-2 forwards the request to NRF-3. 2b. NRF-2 returns a 404 Not Found response to NRF-1. 3a. NRF-3 returns a 200 OK (AccessTokenRsp) to NRF-2. 3b. NRF-3 returns a 400 Bad Request (AccessTokenErr) or 3xx response to NRF-2. 4a. NRF-2 forwards the 200 OK response to NRF-1. 4b. NRF-2 forwards a 400 Bad Request (AccessTokenErr) or 3xx response to NRF-1. + +**Figure 5.4.2.2.2-1: Access Token Request with intermediate forwarding NRF** + +1. NRF-1 receives an Access token request but does not have the information to fulfil the request. Then NRF-1 sends the Access token request to a pre-configured NRF-2. + - 2a. Upon reception of the Access token request and based on the information contained in the Acces token request and locally stored information, NRF-2 shall identify the next hop NRF (see clause 5.2.2.2.3), and forward the Access token request to that NRF (i.e. NRF-3 in this example) by replacing the originator of the service invocation with NRF-2, and the recipient of the service invocation with NRF-3. The locally stored information in NRF-2 may: + - a) be preconfigured; or + - b) registered by other NRFs (see clause 5.2.2.2.3). + - 2b. if NRF-2 does not have enough information to forward the Access token request, then it responds with 404 Not Found, and the rest of the steps are omitted. + - 3a. Upon success, NRF-3 shall return a "200 OK" status code, including in the response content the Access token response containing the requested access token, the token type and additional attributes. + - 3b. Upon failure, NRF-3 shall return "400 Bad Request" status code, including in the response content a JSON object that provides details about the specific error(s) that occurred. + - 4a. NRF-2 forwards the success response to NRF-1. + - 4b. On failure or redirection: + - NRF-2 forwards the error response to NRF-1. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. +- NOTE: It is not assumed that there can only be two NRF hierarchies, i.e. the NRF-3 can go on and forward the Access token request to another NRF. + +### 5.4.2.2.3 Access Token request with intermediate redirecting NRF + +When multiple NRFs are deployed in one PLMN, one NRF may request an OAuth2 access token to a different NRF so as to fulfil the Access Token Request from a NF service consumer. The acces token request between these two NRFs is redirected by a third NRF in this case. + +For this, step 1 in clause 5.4.2.2.1 is executed (send a POST request to NRF-1 in the Serving PLMN); this request shall include the OAuth 2.0 Access Token Request in the request body + +Then, steps 1-4 in Figure 5.4.2.2.3-1 hereinafter are executed between NRF-1in Serving PLMN, NRF-2 in Serving PLMN and NRF-3 in Serving PLMN. + +Finally, step 2 in clause 5.4.2.2.1 is executed, the Access token response containing the requested access token, the token type and additional attributes shall be sent to the NF Service Consumer. + +![Sequence diagram illustrating the Access Token Request with intermediate redirecting NRF. The diagram shows three NRFs: NRF-1, NRF-2, and NRF-3, all in the serving PLMN. The sequence of messages is: 1. NRF-1 sends a POST /oauth2/token (AccessTokenReq) to NRF-2. 2a. NRF-2 responds with a 307 Temporary Redirect. 2b. Alternatively, NRF-2 could respond with a 404 Not Found. 3. Upon receiving the 307 redirect, NRF-1 sends the POST /oauth2/token (AccessTokenReq) to NRF-3. 4a. NRF-3 responds with a 200 OK (AccessTokenRsp). 4b. Alternatively, NRF-3 could respond with a 400 Bad Request (AccessTokenErr) or a 3xx status code.](a003ffe7299e0a48bceb7f1e45a4f1a3_img.jpg) + +``` + +sequenceDiagram + participant NRF-1 as NRF-1 in serving PLMN + participant NRF-2 as NRF-2 in serving PLMN + participant NRF-3 as NRF-3 in serving PLMN + Note left of NRF-1: Request + NRF-1->>NRF-2: 1. POST /oauth2/token (AccessTokenReq) + NRF-2-->>NRF-1: 2a. 307 Temporary Redirect + Note right of NRF-2: 2b. 404 Not Found + Note left of NRF-1: Redirect + NRF-1->>NRF-3: 3. POST /oauth2/token (AccessTokenReq) + NRF-3-->>NRF-1: 4a. 200 OK (AccessTokenRsp) + Note right of NRF-3: 4b. 400 Bad Request (AccessTokenErr) or 3xx + +``` + +Sequence diagram illustrating the Access Token Request with intermediate redirecting NRF. The diagram shows three NRFs: NRF-1, NRF-2, and NRF-3, all in the serving PLMN. The sequence of messages is: 1. NRF-1 sends a POST /oauth2/token (AccessTokenReq) to NRF-2. 2a. NRF-2 responds with a 307 Temporary Redirect. 2b. Alternatively, NRF-2 could respond with a 404 Not Found. 3. Upon receiving the 307 redirect, NRF-1 sends the POST /oauth2/token (AccessTokenReq) to NRF-3. 4a. NRF-3 responds with a 200 OK (AccessTokenRsp). 4b. Alternatively, NRF-3 could respond with a 400 Bad Request (AccessTokenErr) or a 3xx status code. + +**Figure 5.4.2.2.3-1: Access Token Request with intermediate redirecting NRF** + +1. NRF-1 receives an Access token request but does not have the information to fulfil the request. Then NRF-1 sends the Access token request to a pre-configured NRF-2. +- 2a. Upon reception of the Access token request and based on the information contained in the Access token request and locally stored information, NRF-2 shall identify the next hop NRF (see clause 5.2.2.2.3), and redirect the Access token request by returning HTTP "307 Temporary Redirect" response. The locally stored information in NRF-2 may: + - a) be preconfigured; or + - b) registered by other NRFs (see clause 5.2.2.2.3). + The "307 Temporary Redirect" response shall contain a Location header field, the host part of the URI in the Location header field represents NRF-3. +- 2b. if NRF-2 does not have enough information to forward the Access token request, then it responds with "404 Not Found", and the rest of the steps are omitted. +3. Upon reception of "307 Temporary Redirect" response, NRF-1 sends the Access token request to NRF-3 by using the URI contained in the Location header field of the "307 Temporary Redirect" response. +- 4a. Upon success, NRF-3 shall return a "200 OK" status code including in the response content the Access token response containing the requested access token, the token type and additional attributes. +- 4b. On failure or redirection: + - Upon failure, the NRF-3 shall return "400 Bad Request" status code, including in the response content a JSON object that provides details about the specific error(s) that occurred. + - In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +## 5.5 Nnrf\_Bootstrapping Service + +### 5.5.1 Service Description + +The NRF offers a Nnrf\_Bootstrapping service to let NF Service Consumers of the NRF know about the services endpoints it supports, the NRF Instance ID and NRF Set ID if the NRF is part of an NRF set, by using a version-independent URI endpoint that does not need to be discovered by using a Discovery service. + +This service shall be used in inter-PLMN scenarios where the NRF in a PLMN-A needs to invoke services from an NRF in PLMN-B, when there is no pre-configured information indicating the version of the services deployed in PLMN-B. + +This service may also be used in intra-PLMN scenarios, to avoid configuring statically in the different NFs information about the service versions deployed in the NRF to be used by those NFs. + +## 5.5.2 Service Operations + +### 5.5.2.1 Introduction + +The services operations defined for the Nnrf\_Bootstrapping service are as follows: + +- Nnrf\_Bootstrapping\_Get + +### 5.5.2.2 Get + +#### 5.5.2.2.1 General + +This service operation is used by an NF Service Consumer to request bootstrapping information from the NRF. + +![Sequence diagram showing the bootstrapping request process between an NF Service Consumer and an NRF. The consumer sends a GET /bootstrapping() request to the NRF. The NRF responds with either a 200 OK (BootstrappingInfo) or a 400 Bad Request (ProblemDetails) or a 3xx status.](1174e0fd3f2c73de8e5c6ce8ea6bdda1_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NRF + Note right of NRF: 1. GET /bootstrapping () + NRF->>NF Service Consumer: 2a. 200 OK (BootstrappingInfo) +2b. 400 Bad Request (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the bootstrapping request process between an NF Service Consumer and an NRF. The consumer sends a GET /bootstrapping() request to the NRF. The NRF responds with either a 200 OK (BootstrappingInfo) or a 400 Bad Request (ProblemDetails) or a 3xx status. + +**Figure 5.5.2.2.1-1: Bootstrapping Request** + +1. The NF Service Consumer shall send a GET request to the "Bootstrapping Endpoint". + +The "Bootstrapping Endpoint" URI shall be constructed as: + +{nrfApiRoot}/bootstrapping + +where {nrfApiRoot} represents the concatenation of the "scheme" and "authority" components of the NRF, as defined in IETF RFC 3986 [17]; see also the definition of NRF FQDN and NRF URI in 3GPP TS 23.003 [12], clause 28.3.2.3. + +- 2a. On success, "200 OK" shall be returned, the content of the GET response shall contain the requested bootstrapping information. + +#### EXAMPLE: + +``` +GET https://nrf.example.com/bootstrapping +Accept: application/3gppHal+json +``` + +``` +HTTP/2 200 OK +``` + +``` +Content-Type: application/3gppHal+json +``` + +``` +{ + "status": "OPERATIVE", + "_links": { + "self": { + "href": "https://nrf.example.com/bootstrapping" + }, + "manage": { + "href": "https://nrf.example.com/nnrf-nfm/v1/nf-instances" + }, + "subscribe": { + "href": "https://nrf.example.com/nnrf-nfm/v1/subscriptions" + }, + "discover": { + "href": "https://nrf.example.com/nnrf-disc/v1/nf-instances" + }, + "authorize": { + "href": "https://nrf.example.com/oauth2/token" + } + }, +} +``` + +``` + "nrfFeatures": { + "nnrf-nfm": "1", + "nnrf-disc": "D", + "nnrf-oauth2": "0" + }, + "oauth2Required": { + "nnrf-nfm": true, + "nnrf-disc": false + }, + "nrfSetId": "set12.nrfset.5gc.mnc012.mcc345", + "nrfInstanceId": "4947a69a-f61b-4bc1-b9da-47c9c5d14b67" + } +} +``` + +2b. On failure or redirection: + +- Upon failure, the NRF shall return "400 Bad Request" status code, including in the response content a JSON object that provides details about the specific error(s) that occurred. +- In the case of redirection, the NRF shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another NRF service instance. + +--- + +## 6 API Definitions + +### 6.1 Nnrf\_NFManagement Service API + +#### 6.1.1 API URI + +URIs of this API shall have the following root: + +{apiRoot}/{apiName}/{apiVersion} + +where "apiRoot" is defined in clause 4.4.1 of 3GPP TS 29.501 [5], the "apiName" shall be set to "nnrf-nfm" and the "apiVersion" shall be set to "v1" for the current version of this specification. + +#### 6.1.2 Usage of HTTP + +##### 6.1.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [9], 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 Nnrf\_NFManagement service shall comply with the OpenAPI [10] specification contained in Annex A. + +##### 6.1.2.2 HTTP standard headers + +###### 6.1.2.2.1 General + +The mandatory standard HTTP headers as specified in clause 5.2.2.2 of 3GPP TS 29.500 [4] shall be supported. + +###### 6.1.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [22], 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". +- JSON Patch (IETF RFC 6902 [13]). The use of the JSON Patch format in a HTTP request body shall be signalled by the content type "application/json-patch+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.2.3 Accept-Encoding + +The NRF should support gzip coding (see IETF RFC 1952 [30]) 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]. + +NF Service Consumers of the NFManagement API should support gzip coding in HTTP requests and responses and they should support gzip coding in the reception of notification requests sent by the NRF. + +#### 6.1.2.2.4 ETag + +An "ETag" (entity-tag) header should be included in HTTP responses for resource creation and resource update, as described in IETF RFC 9110 [40], clause 8.8.3. 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. + +An "Etag" (entity-tag) header shall not be included in HTTP responses for Heart-Beat operation. + +#### 6.1.2.2.5 If-Match + +An NF Service Consumer should issue conditional PATCH request towards NRF, by including an If-Match header in HTTP requests, as described in IETF RFC 9110 [40], clause 13.1.1, containing an entity tags received in latest response for the same resource. + +An NF Service Consumer shall not include If-Match header in HTTP requests for Heart-Beat operation. + +#### 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 Nnrf\_NFManagement 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 + +The structure of the Resource URIs of the NFManagement service is shown in figure 6.1.3.1-1. + +![Resource URI structure of the NFManagement API diagram](40a8c30f7ea5ecea4912e040c97c5b9c_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnrf-nfm/v1"] --> NFInstances["/nf-instances"] + Root --> Subscriptions["/subscriptions"] + NFInstances --> NFInstanceID["/{nflInstanceID}"] + Subscriptions --> SubscriptionID["/{subscriptionID}"] + +``` + +The diagram illustrates the hierarchical structure of the NFManagement API. The root path is {apiRoot}/nnrf-nfm/v1. It branches into two main resource paths: /nf-instances and /subscriptions. The /nf-instances path further branches into a specific instance identified by {nflInstanceID}. The /subscriptions path further branches into a specific subscription identified by {subscriptionID}. + +Resource URI structure of the NFManagement API diagram + +**Figure 6.1.3.1-1: Resource URI structure of the NFManagement 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 | +|----------------------------|---------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------| +| 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/{nflInstanceID} | 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. | +| 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.1.3.2 Resource: nf-instances (Store) + +#### 6.1.3.2.1 Description + +This resource represents a collection of the different NF instances registered in the NRF. + +This resource is modelled as the Store resource archetype (see clause C.3 of 3GPP TS 29.501 [5]). + +#### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-nfm/v1/nf-instances + +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 a list of all NF instances currently registered in the NRF. 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 | +|-------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nf-type | NFType | O | 0..1 | The type of NF to restrict the list of returned NF Instances. | +| limit | integer | C | 0..1 | Maximum number of items to be returned in this query; this parameter should only be provided if the "nf-type" parameter is provided.
If the "page-number" and "page-size" parameters are present, the "limit" parameter shall be absent. | +| page-number | integer | C | 0..1 | This parameter shall be present if the NF Service Consumer requests the retrieval of NF Instance URIs based on pages (i.e. a subset of the total number of items).

If present, it shall contain the page number to retrieve.

The total number of pages available, N, can be determined based on the "totalItemCount" attribute of the response (see clause 6.1.6.2.25) as:

$N = \text{ceiling}(\text{totalItemCount} / \text{page-size})$

The first page shall be identified by "page-number" set to 1.

Minimum: 1

(See NOTE 1, NOTE 2) | +| page-size | integer | C | 0..1 | This parameter shall be present if the NF Service Consumer requests the retrieval of NF Instance URIs based on pages .

If present, it shall contain the maximum number of items to be returned per page.

Minimum: 1

(See NOTE 1, NOTE 2) | + +NOTE 1: The parameters "page-number" and "page-size" shall be either both present, or both absent. +NOTE 2: If the NRF supports the pagination query parameters, it shall ensure that the response to these requests always return the same set of items for the same query parameters, as long as the ETag of the collection resource is not changed. + +EXAMPLE: The NF Service Consumer can retrieve the whole set of NF Instances URIs available in the NRF, using paginated requests, by issuing multiple GET requests, as: + +GET .../nnrf-nfm/v1/nf-instances?page-number=1&page-size=100 + +(returns items from 0 to 99) + +GET .../nnrf-nfm/v1/nf-instances?page-number=2&page-size=100 + +(returns items from 100 to 199) + +... + +GET .../nnrf-nfm/v1/nf-instances?page-number=N&page-size=100 + +(returns items from (N-1)\*100 up to totalItemCount-1) + +where the first N-1 requests return 100 items each, and the last request (page-number=N) returns between 1 and 100 items. + +The NF Service Consumer can also retrieve arbitrary page numbers and page sizes, independently from any prior request previously issued; e.g. + +GET .../nnrf-nfm/v1/nf-instances?page-number=4&page-size=50 + +(returns items from 150 to 199; assuming totalItemCount >= 200) + +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 | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UriList | M | 1 | 200 OK |

The response body contains a "_links" object containing the URI of each registered NF in the NRF.

If there are no NFs to return in the query result (e.g., because there are no registered NFs in the NRF, or because there are no matching NFs of the type specified in the "nf-type" query parameter, currently registered in the NRF), the "_links" attribute may be absent or, if present, it shall contain only the "self" attribute (i.e. the "item" attribute shall be absent).

| +| RedirectResponse | O | 0..1 | 307 Temporary Redirect |

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

| +| RedirectResponse | O | 0..1 | 308 Permanent Redirect |

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

| + +NOTE: 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]). + +**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 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**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 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.2.3.1-6: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ETag | string | C | 0..1 | Entity Tag containing a strong validator, described in IETF RFC 9110 [40], clause 8.8.3.
In this resource, this header shall contain a different value if the list of NF instances (regardless of the contents of each NF instance profile) stored in the NRF has changed; i.e. it shall change if there are new instances added to the NRF, or if existing instances are removed from the NRF.
If the NF Service Consumer, during the course of successive paginated requests, receives a different ETag value, it shall conclude that the list of NF Instances in the NRF has changed, so it may re-start the paginated NFListRetrieval service operation. | + +#### 6.1.3.2.3.2 OPTIONS + +This method queries the communication options supported by the NRF (see clause 6.9 of 3GPP TS 29.500 [4]). This method shall support the URI query parameters specified in table 6.1.3.2.3.2-1. + +**Table 6.1.3.2.3.2-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.1.3.2.3.2-2 and the response data structures and response codes specified in table 6.1.3.2.3.2-3. + +**Table 6.1.3.2.3.2-2: Data structures supported by the OPTIONS Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.2.3.2-3: Data structures supported by the OPTIONS Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | | +| OptionsResponse | M | 1 | 200 OK | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| ProblemDetails | O | 0..1 | 405 Method Not Allowed | | +| ProblemDetails | O | 0..1 | 501 Not Implemented | | + +NOTE: 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]). + +**Table 6.1.3.2.3.2-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 [40] | + +**Table 6.1.3.2.3.2-5: 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 the NRF service instance to which the request should be sent | + +**Table 6.1.3.2.3.2-6: 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 the NRF service instance to which the request should be sent | + +#### 6.1.3.2.4 Resource Custom Operations + +There are no resource custom operations for the Nnrf\_NFManagement service in this release of the specification. + +#### 6.1.3.3 Resource: nf-instance (Document) + +##### 6.1.3.3.1 Description + +This resource represents a single NF instance. + +### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-nfm/v1/nf-instances/{nfInstanceID} + +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 | +| nfInstanceID | NfInstanceId | Represents a specific NF Instance | + +### 6.1.3.3.3 Resource Standard Methods + +#### 6.1.3.3.3.1 GET + +This method retrieves the NF Profile of a given NF instance. + +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 GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| requester-features | SupportedFeatures | C | 0..1 | Nnrf_NFManagement features supported by the NF Service Consumer that is invoking the Nnrf_NFManagement service. See clause 6.1.9.

This IE shall be included if at least one feature is supported by the NF Service Consumer. | + +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 GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NFProfile | M | 1 | 200 OK | The response body contains the profile of a given NF Instance. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | + +NOTE: 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]). + +**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 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**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 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.3.3.1-6: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| ETag | string | C | 0..1 | Entity Tag containing a strong validator, described in IETF RFC 9110 [40], clause 8.8.3 | + +#### 6.1.3.3.3.2 PUT + +This method registers a new NF instance in the NRF, or replaces completely an existing NF instance. + +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 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.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 PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|------------------------------------------------------------------------------| +| NFProfile | M | 1 | Profile of the NF Instance to be registered, or completely replaced, in NRF. | + +**Table 6.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NFProfile | M | 1 | 200 OK | This case represents the successful replacement of an existing NF Instance profile.

Upon success, a response body is returned containing the replaced profile of the NF Instance. | +| NFProfile | M | 1 | 201 Created | This case represents the successful registration of a new NF Instance.

Upon success, a response body is returned containing the newly created NF Instance profile; also, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created NF Instance. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | + +NOTE: 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]). + +**Table 6.1.3.3.3.2-4: 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 [40] | + +**Table 6.1.3.3.3.2-5: 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 [40] | +| ETag | string | C | 0..1 | Entity Tag containing a strong validator, described in IETF RFC 9110 [40], clause 8.8.3 | + +**Table 6.1.3.3.3.2-6: 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}/nnrf-nfm/v1/nf-instances/{nfInstanceId} | +| Accept-Encoding | string | O | 0..1 | Accept-Encoding, described in IETF RFC 9110 [40] | +| ETag | string | C | 0..1 | Entity Tag containing a strong validator, described in IETF RFC 9110 [40], clause 8.8.3 | + +**Table 6.1.3.3.3.2-7: 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 the NRF service instance to which the request should be sent | + +**Table 6.1.3.3.3.2-8: 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 the NRF service instance to which the request should be sent | + +#### 6.1.3.3.3.3 PATCH + +This method updates partially the profile of a given NF instance. + +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 | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +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 | It contains the list of changes to be made to the profile of the NF Instance, according to the JSON PATCH format specified in IETF RFC 6902 [13]. | + +**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 | +|------------------|---|-------------|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NFProfile | M | 1 | 200 OK | Upon success, a response body is returned containing the updated profile of the NF Instance. | +| n/a | | | 204 No Content | Successful response sent when there is no need to provide a full updated profile of the NF Instance (e.g., in the partial update procedure when all update operations are accepted by the NRF, as described in clause 5.2.2.3.1, or in the Heart-Beat operation response described in clause 5.2.2.3.2). | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| ProblemDetails | O | 0..1 | 412 Precondition Failed | The modification has failed due to the precondition in the request is not fulfilled. | +| ProblemDetails | O | 0..1 | 409 Conflict | The modification has failed due to confliction (e.g. to change a value of a non-existing IE). | + +NOTE: 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]). + +**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 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**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 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.3.3.3.3-6: Headers supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|----------------------------------------------------------------------------------------| +| If-Match | string | C | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [40], clause 13.1.1. | + +**Table 6.1.3.3.3.3-7: Headers supported by the 200 Response Code on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|------------------------------------------------------------------------------------------| +| ETag | string | C | 0..1 | Entity Tag containing a strong validator, described in IETF RFC 9110 [40], clause 8.8.3. | + +#### 6.1.3.3.3.4 DELETE + +This method deregisters an existing NF instance from the NRF. + +This method shall support the URI query parameters specified in table 6.1.3.3.3.4-1. + +**Table 6.1.3.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 6.1.3.3.3.4-2 and the response data structures and response codes specified in table 6.1.3.3.3.4-3. + +**Table 6.1.3.3.3.4-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.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 | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect |

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

| +| RedirectResponse | O | 0..1 | 308 Permanent Redirect |

The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent.

| +| NOTE: 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]). | | | | | + +**Table 6.1.3.3.3.4-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 the NRF service instance to which the request should be sent | + +**Table 6.1.3.3.3.4-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 the NRF service instance to which the request should be sent | + +### 6.1.3.4 Resource: subscriptions (Collection) + +#### 6.1.3.4.1 Description + +This resource represents a collection of subscriptions of NF Instances to newly registered NF Instances. + +#### 6.1.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-nfm/v1/subscriptions + +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 | + +#### 6.1.3.4.3 Resource Standard Methods + +##### 6.1.3.4.3.1 POST + +This method creates a new subscription. 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 | +|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | The request body contains the input parameters for the subscription. These parameters include, e.g.:
- Target NF type
- Target Service Name
- Callback URI of the Requester NF | + +**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 | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | 201 Created | This case represents the successful creation of a subscription.

Upon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate one of the following application errors:
- SUBSCRIPTION_NOT_ALLOWED | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- NF_NOT_FOUND | + +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]). + +**Table 6.1.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}/nnrf-nfm/v1/subscriptions/{subscriptionId} | + +**Table 6.1.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 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.1.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 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +### 6.1.3.5 Resource: subscription (Document) + +#### 6.1.3.5.1 Description + +This resource represents an individual subscription of a given NF Instance to newly registered NF Instances. + +#### 6.1.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-nfm/v1/subscriptions/{subscriptionID} + +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 | +| subscriptionID | string | Represents a specific subscription | + +#### 6.1.3.5.3 Resource Standard Methods + +##### 6.1.3.5.3.1 DELETE + +This method terminates an existing subscription. 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 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.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 DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.5.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 | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | + +NOTE: 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]). + +**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 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**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 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +#### 6.1.3.5.3.2 PATCH + +This method updates an existing subscription. This method shall support the URI query parameters specified in table 6.1.3.5.3.2-1. + +**Table 6.1.3.5.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 6.1.3.5.3.2-2 and the response data structures and response codes specified in table 6.1.3.5.3.2-3. + +**Table 6.1.3.5.3.2-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 an individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [13]. | + +**Table 6.1.3.5.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SubscriptionData | M | 1 | 200 OK | | +| n/a | | | 204 No Content | | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to indicate one of the following application errors:
- NF_NOT_FOUND | + +**Table 6.1.3.5.3.2-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 the NRF service instance to which the request should be sent | + +**Table 6.1.3.5.3.2-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 the NRF service instance to which the request should be sent | + +## 6.1.4 Custom Operations without associated resources + +There are no custom operations defined without any associated resources for the Nnrf\_NFManagement service in this release of the specification. + +## 6.1.5 Notifications + +### 6.1.5.1 General + +This clause specifies the notifications provided by the Nnrf\_NFManagement service. + +The delivery of notifications shall be supported as specified in clause 6.2 of 3GPP TS 29.500 [4] for Server-initiated communication. + +**Table 6.1.5.1-1: Notifications overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------|--------------------------------------------------------------------------------|---------------------------------|---------------------------------------------------------------------------------| +| NF Instance Status Notification | {nfStatusNotificationUri}
(NF Service Consumer provided callback reference) | POST | Notify about registrations / deregistrations or profile changes of NF Instances | + +## 6.1.5.2 NF Instance Status Notification + +### 6.1.5.2.1 Description + +The NF Service Consumer provides a callback URI for getting notified about NF Instances status events, the NRF shall notify the NF Service Consumer, when the conditions specified in the subscription are met. + +### 6.1.5.2.2 Notification Definition + +The POST method shall be used for NF Instance Status notification and the URI shall be the callback reference provided by the NF Service Consumer during the subscription to this notification. + +Resource URI: {nfStatusNotificationUri} + +Support of URI query parameters is specified in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.1.5.2.2-2, and support of response data structures and response codes is specified in table 6.1.5.2-3. + +**Table 6.1.5.2.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------| +| NotificationData | M | 1 | Representation of the NF Instance status notification. | + +**Table 6.1.5.2.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| N/A | | | 204 No Content | This case represents a successful notification of the NF Instance status event. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF Service Consumer instance to which the notification should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF Service Consumer instance to which the notification should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent. | + +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]). + +**Table 6.1.5.2.2-4: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer instance to which the request should be sent | + +**Table 6.1.5.2.2-5: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NF service consumer instance to which the request should be sent | + +## 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 Nnrf\_NFManagement service-based interface protocol. + +**Table 6.1.6.1-1: Nnrf\_NFManagement specific Data Types** + +| Data type | Clause defined | Description | +|---------------------------------|----------------|---------------------------------------------------------------------------------------------------------------------| +| NFProfile | 6.1.6.2.2 | Information of an NF Instance registered in the NRF. | +| NFService | 6.1.6.2.3 | Information of a given NF Service Instance; it is part of the NFProfile of an NF Instance. | +| DefaultNotificationSubscription | 6.1.6.2.4 | Data structure for specifying the notifications the NF service subscribes by default along with callback URI. | +| IpEndPoint | 6.1.6.2.5 | IP addressing information of a given NFService; it consists on, e.g. IP address, TCP port, transport protocol... | +| UdrInfo | 6.1.6.2.6 | Information of an UDR NF Instance. | +| UdmInfo | 6.1.6.2.7 | Information of an UDM NF Instance. | +| AusfInfo | 6.1.6.2.8 | Information of an AUSF NF Instance. | +| SupiRange | 6.1.6.2.9 | A range of SUPIs (subscriber identities), either based on a numeric range, or based on regular-expression matching. | +| IdentityRange | 6.1.6.2.10 | A range of subscriber identities, either based on a numeric range, or based on regular-expression matching. | +| AmfInfo | 6.1.6.2.11 | Information of an AMF NF Instance. | +| SmfInfo | 6.1.6.2.12 | Information of an SMF NF Instance. | +| UpfInfo | 6.1.6.2.13 | Information of an UPF NF Instance. | +| SnssaiUpfInfoItem | 6.1.6.2.14 | Set of parameters supported by UPF for a given S-NSSAI. | +| DnnUpfInfoItem | 6.1.6.2.15 | Set of parameters supported by UPF for a given DNN. | +| SubscriptionData | 6.1.6.2.16 | Information of a subscription to notifications to NRF events, included in subscription requests and responses. | +| NotificationData | 6.1.6.2.17 | Data sent in notifications from NRF to subscribed NF Instances. | +| NFServiceVersion | 6.1.6.2.19 | Contains the version details of an NF service. | +| PcfInfo | 6.1.6.2.20 | Information of a PCF NF Instance. | +| BsfInfo | 6.1.6.2.21 | Information of a BSF NF Instance. | +| Ipv4AddressRange | 6.1.6.2.22 | Range of IPv4 addresses. | +| Ipv6PrefixRange | 6.1.6.2.23 | Range of IPv6 prefixes. | +| InterfaceUpfInfoItem | 6.1.6.2.24 | Information of a given IP interface of an UPF. | +| UriList | 6.1.6.2.25 | Set of URIs following 3GPP hypermedia format (containing a " _links" attribute). | +| N2InterfaceAmfInfo | 6.1.6.2.26 | AMF N2 interface information | +| TaiRange | 6.1.6.2.27 | Range of TAIIs (Tracking Area Identities). | +| TacRange | 6.1.6.2.28 | Range of TACs (Tracking Area Codes). | +| SnssaiSmfInfoItem | 6.1.6.2.29 | Set of parameters supported by SMF for a given S-NSSAI. | +| DnnSmfInfoItem | 6.1.6.2.30 | Set of parameters supported by SMF for a given DNN. | +| NrfInfo | 6.1.6.2.31 | Information of an NRF NF Instance, used in hierarchical NRF deployments. | +| ChfInfo | 6.1.6.2.32 | Information of a CHF NF Instance. | +| PlmnRange | 6.1.6.2.34 | Range of PLMN IDs. | +| SubscrCond | 6.1.6.2.35 | Condition to determine the set of NFs to monitor under a certain subscription in NRF. | +| NfInstanceIdCond | 6.1.6.2.36 | Subscription to a given NF Instance Id. | +| NfTypeCond | 6.1.6.2.37 | Subscription to a set of NFs based on their NF Type. | +| ServiceNameCond | 6.1.6.2.38 | Subscription to a set of NFs based on their support for a given Service Name. | +| AmfCond | 6.1.6.2.39 | Subscription to a set of AMFs, based on AMF Set Id and/or AMF Region Id. | +| GuamiListCond | 6.1.6.2.40 | Subscription to a set of AMFs, based on their GUAMIIs. | +| NetworkSliceCond | 6.1.6.2.41 | Subscription to a set of NFs, based on the slices (S-NSSAI and NSI) they support . | +| NfGroupCond | 6.1.6.2.42 | Subscription to a set of NFs based on their Group Id. | +| NotifCondition | 6.1.6.2.43 | Condition (list of attributes in the NF Profile) to determine whether a notification must be sent by NRF. | +| PlmnSnssai | 6.1.6.2.44 | List of network slices (S-NSSAIs) for a given PLMN ID. | +| NwdaifInfo | 6.1.6.2.45 | Information of a NWDAF NF Instance. | +| LmfInfo | 6.1.6.2.46 | Information of an LMF NF Instance. | +| GmlcInfo | 6.1.6.2.47 | Information of a GMLC NF Instance. | +| NefInfo | 6.1.6.2.48 | Information of an NEF NF Instance. | +| PfdData | 6.1.6.2.49 | List of Application IDs and/or AF IDs managed by a given NEF Instance. | +| AfEventExposureData | 6.1.6.2.50 | AF Event Exposure data managed by a given NEF Instance. | +| WAgfInfo | 6.1.6.2.51 | Information of the W-AGF endpoints. | +| TngfInfo | 6.1.6.2.52 | Information of the TNGF endpoints. | + +| | | | +|-----------------------|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Pscsflnfo | 6.1.6.2.53 | Information of a P-CSCF NF Instance. | +| NfSetCond | 6.1.6.2.54 | Subscription to a set of NFs based on their Set Id. | +| NfServiceSetCond | 6.1.6.2.55 | Subscription to a set of NFs based on their Service Set Id. | +| Nflnfo | 6.1.6.2.56 | Information of a generic NF Instance. | +| Hsslnfo | 6.1.6.2.57 | Information of an HSS NF Instance. | +| ImsiRange | 6.1.6.2.58 | A range of IMSIs (subscriber identities), either based on a numeric range, or based on regular-expression matching. | +| InternalGroupIdRange | 6.1.6.2.59 | A range of Group IDs (internal group identities), either based on a numeric range, or based on regular-expression matching. | +| UpfCond | 6.1.6.2.60 | Subscription to a set of NF Instances (UPFs), able to serve a certain service area (i.e. SMF serving area or TAI list). | +| Twiflnfo | 6.1.6.2.61 | Addressing information (IP addresses, FQDN) of the TWIF. | +| VendorSpecificFeature | 6.1.6.2.62 | Information about a vendor-specific feature | +| Udsflnfo | 6.1.6.2.63 | Information related to UDSF | +| Scplnfo | 6.1.6.2.65 | Information of an SCP Instance | +| ScpDomainInfo | 6.1.6.2.66 | SCP domain information | +| ScpDomainCond | 6.1.6.2.67 | Subscription to an SCP domain | +| OptionsResponse | 6.1.6.2.68 | Communication options of the NRF | +| NwdafCond | 6.1.6.2.69 | Subscription to a set of NF Instances (NWDAFs), identified by Analytics ID(s), S-NSSAI(s) or NWDAF Serving Area information, i.e. list of TAIs for which the NWDAF can provide analytics. | +| NefCond | 6.1.6.2.70 | Subscription to a set of NF Instances (NEFs), identified by Event ID(s) provided by AF, S-NSSAI(s), AF Instance ID, Application Identifier, External Identifier, External Group Identifier, or domain name. | +| Sucilnfo | 6.1.6.2.71 | SUCI information containing Routing Indicator and Home Network Public Key ID. | +| Sepplnfo | 6.1.6.2.72 | Information of a SEPP Instance | +| Aanflnfo | 6.1.6.2.73 | Information of an AAnF NF Instance. | +| 5GDdnmflnfo | 6.1.6.2.74 | Information of a 5G DDNMF NF Instance. | +| Mfaflnfo | 6.1.6.2.75 | Information of the MFAF NF Instance. | +| NwdafCapability | 6.1.6.2.76 | Indicates the capability supported by the NWDAF. | +| Dccflnfo | 6.1.6.2.80 | Information of a DCCF NF Instance. | +| Nsacflnfo | 6.1.6.2.81 | Information of an NSACF NF Instance. | +| NsacfCapability | 6.1.6.2.82 | NSACF service capability. | +| DccfCond | 6.1.6.2.83 | Subscription to a set of NF Instances (DCCFs), identified by NF types, NF Set Id(s) or DCCF Serving Area information, i.e. list of TAIs served by the DCCF. | +| MIAnalyticsInfo | 6.1.6.2.84 | ML Analytics Filter information supported by the Nnwdaf_MLModelProvision service | +| MbSmflnfo | 6.1.6.2.85 | Information of a MB-SMF NF Instance | +| TmgiRange | 6.1.6.2.86 | Range of TMGIs | +| MbsSession | 6.1.6.2.87 | MBS Session served by an MB-SMF | +| SnssaiMbSmflnfoItem | 6.1.6.2.88 | Parameters supported by an MB-SMF for a given S-NSSAI | +| DnnMbSmflnfoItem | 6.1.6.2.89 | Parameters supported by an MB-SMF for a given DNN | +| Tsctsflnfo | 6.1.6.2.91 | Information of a TSCTSF NF Instance. | +| SnssaiTsctsflnfoItem | 6.1.6.2.92 | Set of parameters supported by TSCTSF for a given S-NSSAI. | +| DnnTsctsflnfoItem | 6.1.6.2.93 | Set of parameters supported by TSCTSF for a given DNN. | +| MbUpflnfo | 6.1.6.2.94 | Information of a MB-UPF NF Instance. | +| UnTrustAflnfo | 6.1.6.2.95 | Information of a untrusted AF Instance. | +| TrustAflnfo | 6.1.6.2.96 | Information of a trusted AF Instance | +| SnssaiAflnfoItem | 6.1.6.2.97 | Set of parameters supported by NF for a given S-NSSAI. | +| DnnAflnfoItem | 6.1.6.2.98 | Set of parameters supported by NF for a given DNN. | +| CollocatedNfInstance | 6.1.6.2.99 | Information related to collocated NF type(s) and corresponding NF Instance(s) when the NF is collocated with NFs supporting other NF types. | +| ServiceNameListCond | 6.1.6.2.100 | Subscription to a set of NF Instances that offer a service name in the Service Name list. | +| NfGroupListCond | 6.1.6.2.101 | Subscription to a set of NF Instances, identified by a NF Group Identity in the NF Group Identity list. | +| PlmnOauth2 | 6.1.6.2.102 | Per PLMN Oauth2.0 indication. | +| V2xCapability | 6.1.6.2.103 | Indicate the supported V2X Capability by the PCF. | +| Nssaaflnfo | 6.1.6.2.104 | Information of a NSSAAF NF Instance. | + +| | | | +|-------------------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ProSeCapability | 6.1.6.2.105 | Indicate the supported ProSe Capability by the PCF. | +| SharedDataIdRange | 6.1.6.2.106 | | +| SubscriptionContext | 6.1.6.2.107 | Context data related to a created subscription, to be included in notifications sent by NRF. | +| IwmscInfo | 6.1.6.2.108 | Information of a SMS-IWMSC NF Instance. | +| MnpfInfo | 6.1.6.2.109 | Information of an MNPF Instance. | +| DefSubServiceInfo | 6.1.6.2.110 | Service Specific Information for Default Notification Subscription. | +| LocalityDescriptionItem | 6.1.6.2.111 | Description of locality information item | +| LocalityDescription | 6.1.6.2.112 | Description of locality information comprising one or more locality information items | +| DcsfInfo | 6.1.6.2.114 | Information of a DCSF NF Instance. | +| MIModelInterInfo | 6.1.6.2.115 | ML Model Interoperability Information | +| PruExistenceInfo | 6.1.6.2.116 | PRU Existence Information | +| MrfInfo | 6.1.6.2.117 | Information of a MRF NF instance. | +| MrfpInfo | 6.1.6.2.118 | Information of a MRFP NF instance. | +| MfInfo | 6.1.6.2.119 | Information of a MF NF instance. | +| A2xCapability | 6.1.6.2.120 | Indicate the supported A2X Capability by the PCF. | +| RuleSet | 6.1.6.2.121 | List of rules specifying whether access/scopes are allowed/denied for NF-Consumers. | +| SelectionConditions | 6.1.6.2.123 | List of conditions under which an NF Instance with an NFStatus or NFServiceStatus value set to "CANARY_RELEASE" shall be selected by an NF Service Consumer (e.g. if the UE belongs to a range of SUPIs) | +| ConditionItem | 6.1.6.2.124 | Each of the conditions that compose the SelectionConditions. A ConditionItem consists of a number of attributes representing individual conditions (e.g. a SUPI range, or a TAI list) | +| ConditionGroup | 6.1.6.2.125 | List (array) of conditions (joined by the "and" or "or" logical relationship), under which an NF Instance with an NFStatus or NFServiceStatus value set to "CANARY_RELEASE" shall be selected by an NF Service Consumer. | +| EpdgInfo | 6.1.6.2.126 | Information of the ePDG endpoints. | +| CallbackUriPrefixItem | 6.1.6.2.127 | Callback URI prefix value to be used for specific notification types | +| NefId | 6.1.6.3.2 | Identity of the NEF. | +| VendorId | 6.1.6.3.2 | Vendor ID of the NF Service instance (Private Enterprise Number assigned by IANA) | +| WildcardDnai | 6.1.6.3.2 | Wildcard DNAI | +| MediaCapability | 6.1.6.3.2 | Media capability offered by NF instance. | +| NFType | 6.1.6.3.3 | NF types known to NRF. | +| NotificationType | 6.1.6.3.4 | Types of notifications used in Default Notification URIs in the NF Profile of an NF Instance. | +| TransportProtocol | 6.1.6.3.5 | Types of transport protocol used in a given IP endpoint of an NF Service Instance. | +| NotificationEventType | 6.1.6.3.6 | Types of events sent in notifications from NRF to subscribed NF Instances. | +| NFStatus | 6.1.6.3.7 | Status of a given NF Instance stored in NRF. | +| DataSetId | 6.1.6.3.8 | Types of data sets stored in UDR. | +| UPInterfaceType | 6.1.6.3.9 | Types of User-Plane interfaces of the UPF. | +| ServiceName | 6.1.6.3.11 | Service names known to NRF. | +| NFServiceStatus | 6.1.6.3.12 | Status of a given NF Service Instance of an NF Instance stored in NRF. | +| AnNodeType | 6.1.6.3.13 | Access Network Node Type (gNB, ng-eNB...). | +| ConditionEventType | 6.1.6.3.14 | Indicates whether a notification is due to the NF Instance to start or stop being part of a condition for a subscription to a set of NFs | +| IpReachability | 6.1.6.3.15 | Indicates the type(s) of IP addresses reachable via an SCP. | +| CollocatedNfType | 6.1.6.3.17 | Possible NF types supported by a collocated NF. | +| LocalityType | 6.1.6.3.18 | Type of Locality description item. | +| FICapabilityType | 6.1.6.3.19 | Type of Federated Learning Capability | +| RuleSetAction | 6.1.6.3.21 | Specifies whether access/scope is allowed or denied for a specific NF-Consumer | + +Table 6.1.6.1-2 specifies data types re-used by the Nnrf\_NFManagement 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 Nnrf\_NFManagement service-based interface. + +**Table 6.1.6.1-2: Nnrf\_NFManagement re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| N1MessageClass | 3GPP TS 29.518 [6] | The N1 message type | +| N2InformationClass | 3GPP TS 29.518 [6] | The N2 information type | +| IPv4Addr | 3GPP TS 29.571 [7] | | +| IPv6Addr | 3GPP TS 29.571 [7] | | +| IPv6Prefix | 3GPP TS 29.571 [7] | | +| Uri | 3GPP TS 29.571 [7] | | +| Dnn | 3GPP TS 29.571 [7] | | +| SupportedFeatures | 3GPP TS 29.571 [7] | | +| Snssai | 3GPP TS 29.571 [7] | | +| PlmnId | 3GPP TS 29.571 [7] | | +| Guami | 3GPP TS 29.571 [7] | | +| Tai | 3GPP TS 29.571 [7] | | +| NfInstanceId | 3GPP TS 29.571 [7] | Identifier (UUID) of the NF Instance. The hexadecimal letters of the UUID should be formatted by the sender as lower-case characters and shall be handled as case-insensitive by the receiver. | +| LinksValueSchema | 3GPP TS 29.571 [7] | 3GPP Hypermedia link | +| UriScheme | 3GPP TS 29.571 [7] | | +| AmfName | 3GPP TS 29.571 [7] | | +| DateTime | 3GPP TS 29.571 [7] | | +| Dnai | 3GPP TS 29.571 [7] | | +| ChangeItem | 3GPP TS 29.571 [7] | | +| DiameterIdentity | 3GPP TS 29.571 [7] | | +| AccessType | 3GPP TS 29.571 [7] | | +| NfGroupId | 3GPP TS 29.571 [7] | Network Function Group Id | +| AmfRegionId | 3GPP TS 29.571 [7] | | +| AmfSetId | 3GPP TS 29.571 [7] | | +| PduSessionType | 3GPP TS 29.571 [7] | | +| AtsssCapability | 3GPP TS 29.571 [7] | Capability to support procedures related to Access Traffic Steering, Switching, Splitting. | +| Nid | 3GPP TS 29.571 [7] | | +| PlmnIdNid | 3GPP TS 29.571 [7] | | +| NfSetId | 3GPP TS 29.571 [7] | NF Set ID (see clause 28.12 of 3GPP TS 23.003 [12]) | +| NfServiceSetId | 3GPP TS 29.571 [7] | NF Service Set ID (see clause 28.13 of 3GPP TS 23.003 [12]) | +| GroupId | 3GPP TS 29.571 [7] | Internal Group Identifier | +| RatType | 3GPP TS 29.571 [7] | RAT Type | +| DurationSec | 3GPP TS 29.571 [7] | | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of the redirect response message. | +| ExtSnssai | 3GPP TS 29.571 [7] | | +| AreaSessionId | 3GPP TS 29.571 [7] | Area Session Identifier used for an MBS session with location dependent content | +| MbsSessionId | 3GPP TS 29.571 [7] | MBS Session Identifier | +| MbsServiceArea | 3GPP TS 29.571 [7] | MBS Service Area | +| IpAddr | 3GPP TS 29.571 [7] | IP Address | +| MbsServiceAreaInfo | 3GPP TS 29.571 [7] | MBS Service Area Information for Location dependent MBS session | +| Fqdn | 3GPP TS 29.571 [7] | Fully Qualified Domain Name | +| EventId | 3GPP TS 29.520 [32] | Defined in Nnwdaf_AnalyticsInfo API. | +| NwdafEvent | 3GPP TS 29.520 [32] | Defined in Nnwdaf_EventsSubscription API. | +| ExternalClientType | 3GPP TS 29.572 [33] | | +| LMFIdentification | 3GPP TS 29.572 [33] | LMF Identification | +| AfEvent | 3GPP TS 29.517 [35] | Defined in Naf_EventExposure API | +| SupportedGADShapes | 3GPP TS 29.572 [33] | Supported GAD Shapes | +| NetworkNodeDiameter Address | 3GPP TS 29.503 [36] | Diameter Address of a Network Node | +| IpIndex | 3GPP TS 29.503 [36] | IP Index | +| EventType | 3GPP TS 29.564 [49] | Event type supported by the UPF Event Exposure service | + +## 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: NFProfile + +**Table 6.1.6.2.2-1: Definition of type NFProfile** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nflInstanceId | NflInstanceId | M | 1 | Unique identity of the NF Instance. | +| nfType | NFType | M | 1 | Type of Network Function | +| nfStatus | NFStatus | M | 1 | Status of the NF Instance (NOTE 5) (NOTE 16) | +| collocatedNfInstances | array(Collocated NflInstance) | O | 1..N | Information related to collocated NF type(s) and corresponding NF Instances when the NF is collocated with NFs supporting other NF types. (NOTE 21)

In this release of the specification, following collocation scenarios are supported (see clause 6.1.6.2.99):
- a MB-SMF collocated with a SMF;
- a MB-UPF collocated with a UPF. | +| nflInstanceName | string | O | 0..1 | Human readable name of the NF Instance | +| heartBeatTimer | integer | C | 0..1 | Time in seconds expected between 2 consecutive heart-beat messages from an NF Instance to the NRF.
It may be included in the registration request. When present in the request it shall contain the heartbeat time proposed by the NF service consumer.
It shall be included in responses from NRF to registration requests (PUT) or in NF profile updates (PUT or PATCH). If the proposed heartbeat time is acceptable by the NRF based on the local configuration, it shall use the same value as in the registration request; otherwise the NRF shall override the value using a preconfigured value. | +| plmnList | array(PlmnId) | C | 1..N | PLMN(s) of the Network Function (NOTE 7).
This IE shall be present if this information is available for the NF.
If neither the plmnList IE nor the snpnList IE are provided, PLMN ID(s) of the PLMN of the NRF are assumed for the NF. | +| snpnList | array(PlmnIdNid) | C | 1..N | SNPN(s) of the Network Function.
This IE shall be present if the NF pertains to one or more SNPNs. | +| sNssais | array(ExtSnssai) | O | 1..N | S-NSSAIs of the Network Function.
If not provided, and if the perPlmnSnssaiList attribute is not present, the NF can serve any S-NSSAI.
When present this IE represents the list of S-NSSAIs supported in all the PLMNs listed in the plmnList IE and all the SNPNs listed in the snpnList.
If the sNssais attribute is provided in at least one NF Service, the S-NSSAIs supported by the NF Profile shall be the set or a superset of the S-NSSAIs of the NFService(s). | +| perPlmnSnssaiList | array(PlmnSnssai ) | O | 1..N | This IE may be included when the list of S-NSSAIs supported by the NF for each PLMN it is supporting is different. When present, this IE shall include the S-NSSAIs supported by the Network Function for each PLMN supported by the Network Function. When present, this IE shall override sNssais IE. (NOTE 9)
If the perPlmnSnssaiList attribute is provided in at least one NF Service, the S-NSSAIs supported per PLMN in the NF Profile shall be the set or a superset of the perPlmnSnssaiList of the NFService(s). | +| nsiList | array(string) | O | 1..N | NSI identities of the Network Function.
If not provided, the NF can serve any NSI. | +| fqdn | Fqdn | C | 0..1 | FQDN of the Network Function (NOTE 1) (NOTE 2) (NOTE 18). For AMF, the FQDN registered with the NRF shall be that of the AMF Name (see 3GPP TS 23.003 [12] clause 28.3.2.5). | +| interPlmnFqdn | Fqdn | C | 0..1 | If the NF needs to be discoverable by other NFs in a different PLMN, then an FQDN that is used for inter-PLMN routing as specified in 3GPP TS 23.003 [12] shall be registered with the NRF (NOTE 8). | + +| | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

A change of this attribute shall result in triggering a "NF_PROFILE_CHANGED" notification from NRF towards subscribing NFs located in the same or a different PLMN, but in the latter case the new value shall be notified as a change of the "fqdn" attribute.

The NRF shall not send intra-PLMN notifications containing this attribute to subscribing NFs not supporting the "Inter-Plmn-Fqdn" feature (see clause 6.1.9).

| +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|------------------|------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipv4Addresses | array(Ipv4Addr) | C | 1..N | IPv4 address(es) of the Network Function (NOTE 1) (NOTE 2) (NOTE 18) | +| ipv6Addresses | array(Ipv6Addr) | C | 1..N | IPv6 address(es) of the Network Function (NOTE 1) (NOTE 2) (NOTE 18) | +| allowedPlmns | array(PlmnId) | O | 1..N |

PLMNs allowed to access the NF instance. If not provided, any PLMN is allowed to access the NF.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17)

| +| allowedSnpons | array(PlmnIdNid) | O | 1..N |

SNPNs allowed to access the NF instance.

If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall prevail.

The absence of this attribute in both the NFService and in the NF profile indicates that no SNPN, other than the SNPN(s) registered in the snpnList attribute of the NF Profile (if the NF pertains to an SNPN), is allowed to access the service instance.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17)

| +| allowedNfTypes | array(NFType) | O | 1..N |

Type of the NFs allowed to access the NF instance. If not provided, any NF type is allowed to access the NF.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17)

| +| allowedNfDomains | array(string) | O | 1..N |

Pattern (regular expression according to the ECMA-262 dialect [8]) representing the NF domain names within the PLMN of the NRF allowed to access the NF instance. If not provided, any NF domain is allowed to access the NF.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17)

| +| allowedNssais | array(ExtSnssai) | O | 1..N |

S-NSSAI of the allowed slices to access the NF instance. If not provided, any slice is allowed to access the NF.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the

| + +| | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------| +| | | | | subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17) | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|----------------|--------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedRuleSet | map(RuleSet) | O | 1..N |

Map of rules specifying NF-Consumers allowed or denied to access the NF-Producer. 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.

This IE may be present when the NF-Producer and the NRF support Allowed-ruleset feature as specified in clause 6.1.9.

When NRF utilizes this parameter to determine if the NF-Consumers allowed or denied to access an NF-Producer, it matches the NF-Consumer's properties (PLMN, SNPN, nfType, NfDomain, S-NSSAIs) against each rule in decreasing order of priority (1 being the highest). When a matching rule is found, the search is stopped and the NF-Consumer is allowed/dis-allowed to access the NF-Producer (see Annex C).

This attribute shall not be included in profile change notifications to subscribed NFs.

If the subscribing entity included "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17), the complete IE shall be present in the profile change notification (NOTE 17)

| +| priority | integer | O | 0..1 |

Priority (relative to other NFs of the same type) within the range 0 to 65535, to be used for NF selection; lower values indicate a higher priority. Priority may or may not be present in the nfServiceList parameters, xxxInfo parameters and in this attribute. Priority in the nfServiceList has precedence over the priority in this attribute (NOTE 4).

Priority in xxxInfo parameter shall only be used to determine the relative priority among NF instances with the same priority at NFProfile/NFService.

The NRF may overwrite the received priority value when exposing an NFProfile with the Nnrf_NFDiscovery service.

| +| capacity | integer | O | 0..1 |

Static capacity information within the range 0 to 65535, expressed as a weight relative to other NF instances of the same type; if capacity is also present in the nfServiceList parameters, those will have precedence over this value. (NOTE 4).

| +| load | integer | O | 0..1 |

Dynamic load information, within the range 0 to 100, indicates the current load percentage of the NF.

| +| loadTimeStamp | DateTime | O | 0..1 |

It indicates the point in time in which the latest load information (sent by the NF in the "load" attribute of the NF Profile) was generated at the NF Instance.

If the NF did not provide a timestamp, the NRF should set it to the instant when the NRF received the message where the NF provided the latest load information.

| +| locality | string | O | 0..1 |

Operator defined information about the location of the NF instance (e.g. geographic location, data center) (NOTE 3)

| +| extLocality | map(string) | O | 1..N |

Operator defined information about the location of the NF instance. (NOTE 3)

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, representing a type of

| + +| | | | | | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | locality as defined in clause 6.1.6.3.18.

Example:
{
"DATA_CENTER": "dc-123",
"CITY": "Los Angeles",
"STATE": "California"
} | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|--------------|---------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| udrInfo | UdrInfo | O | 0..1 | Specific data for the UDR (ranges of SUPI, group ID ...) | +| udrInfoList | map(UdrInfo) | O | 1..N | Multiple entries of UdrInfo. This attribute provides additional information to the udrInfo. udrInfoList may be present even if the udrInfo is absent.
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. | +| udmInfo | UdmInfo | O | 0..1 | Specific data for the UDM (ranges of SUPI, group ID...) | +| udmInfoList | map(UdmInfo) | O | 1..N | Multiple entries of UdmInfo. This attribute provides additional information to the udmInfo. udmInfoList may be present even if the udmInfo is absent.
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. | +| ausfInfo | AusfInfo | O | 0..1 | Specific data for the AUSF (ranges of SUPI, group ID...) | +| ausfInfoList | map(AusfInfo) | O | 1..N | Multiple entries of AusfInfo. This attribute provides additional information to the ausfInfo. ausfInfoList may be present even if the ausfInfo is absent.
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. | +| amfInfo | AmfInfo | O | 0..1 | Specific data for the AMF (AMF Set ID, ...) | +| amfInfoList | map(AmfInfo) | O | 1..N | Multiple entries of AmfInfo. This attribute provides additional information to the amfInfo. amfInfoList may be present even if the amfInfo is absent.
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. | +| smfInfo | SmfInfo | O | 0..1 | Specific data for the SMF (DNN's, ...).
(NOTE 12) | +| smfInfoList | map(SmfInfo) | O | 1..N | Multiple entries of SmfInfo. This attribute provides additional information to the smfInfo. smfInfoList may be present even if the smfInfo is absent.
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.
(NOTE 12) | +| upfInfo | UpfInfo | O | 0..1 | Specific data for the UPF (S-NSSAI, DNN, SMF serving area, interface...) | +| upfInfoList | map(UpfInfo) | O | 1..N | Multiple entries of UpfInfo. This attribute provides additional information to the upfInfo. upfInfoList may be present even if the upfInfo is absent.
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. | +| pcfInfo | PcfInfo | O | 0..1 | Specific data for the PCF. | +| pcfInfoList | map(PcfInfo) | O | 1..N | Multiple entries of PcfInfo. This attribute provides additional information to the pcfInfo. pcfInfoList may be present even if the pcfInfo is absent.
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. | +| bsfInfo | BsfInfo | O | 0..1 | Specific data for the BSF. | +| bsfInfoList | map(BsfInfo) | O | 1..N | Multiple entries of BsfInfo. This attribute provides additional information to the bsfInfo. bsfInfoList may be present even if the bsfInfo is absent.
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. | +| chfInfo | ChfInfo | O | 0..1 | Specific data for the CHF. | +| chfInfoList | map(ChfInfo) | O | 1..N | Multiple entries of ChfInfo. This attribute provides additional information to the chfInfo. chfInfoList may be present even if the chfInfo is absent.
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. | +|--|--|--|--|---------------------------| + +| | | | | | +|----------------------------|------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nefInfo | NefInfo | O | 0..1 | Specific data for the NEF. | +| nrfInfo | NrfInfo | O | 0..1 | Specific data for the NRF. | +| udsfInfo | UdsfInfo | O | 0..1 | Specific data for the UDSF. | +| udsfInfoList | map(UdsfInfo) | O | 1..N | Multiple entries of udsfInfo. This attribute provides additional information to the udsfInfo. udsfInfoList may be present even if the udsfInfo is absent. 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. | +| nwdaflInfo | NwdaflInfo | O | 0..1 | Specific data for the NWDAF. | +| nwdaflInfoList | map(NwdaflInfo) | O | 1..N | Multiple entries of nwdaflInfo. This attribute provides additional information to the nwdaflInfo. nwdaflInfoList may be present even if the nwdaflInfo is absent. 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. | +| pcscfInfoList | map(PcscfInfo) | O | 1..N | Specific data for the P-CSCF. 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. (NOTE 11) | +| hssInfoList | map(HssInfo) | O | 1..N | Specific data for the HSS. 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. | +| customInfo | object | O | 0..1 | Specific data for custom Network Functions | +| recoveryTime | DateTime | O | 0..1 | Timestamp when the NF was (re)started (NOTE 5) (NOTE 6) | +| nfServicePersistence | boolean | O | 0..1 |

- true: If present, and set to true, it indicates that the different service instances of a same NF Service in this NF instance, supporting a same API version, are capable to persist their resource state in shared storage and therefore these resources are available after a new NF service instance supporting the same API version is selected by a NF Service Consumer (see 3GPP TS 23.527 [27]).

- false (default): Otherwise, it indicates that the NF Service Instances of a same NF Service are not capable to share resource state inside the NF Instance.

| +| nfServices | array(NFService) | O | 1..N |

List of NF Service Instances. It shall include the services produced by the NF that can be discovered by other NFs, if any. (NOTE 15)

This attribute is deprecated; the attribute "nfServiceList" should be used instead.

| +| nfServiceList | map(NFService) | O | 1..N |

Map of NF Service Instances, where the "serviceInstanceId" attribute of the NFService object shall be used as the key of the map. (NOTE 15)

It shall include the services produced by the NF that can be discovered by other NFs, if any.

| +| nfProfileChangesSupportInd | boolean | O | 0..1 |

NF Profile Changes Support Indicator. See Annex B.

This IE may be present in the NFRegister or NFUpdate (NF Profile Complete Replacement) request and shall be absent in the response.

true: the NF Service Consumer supports receiving NF Profile Changes in the response.

false (default): the NF Service Consumer does not support receiving NF Profile Changes in the response.

Write-Only: true

| + +| | | | | | +|-----------------------------------------|----------------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nfProfilePartialUpdateChangesSupportInd | boolean | O | 0..1 |

NF Profile Partial Update Changes Support Indicator.
See Annex B.

This IE may be present in the NFRegister or NFUpdate request and shall be absent in the response.

true: the NF Service Consumer supports receiving NF Profile Changes in the response to an NF Profile Partial Update operation.

false (default): the NF Service Consumer does not support receiving NF Profile Changes in the response to an NF Profile Partial Update operation.

Write-Only: true

| +| nfProfileChangesInd | boolean | O | 0..1 |

NF Profile Changes Indicator.
See Annex B.

This IE shall be absent in the request to the NRF and may be included by the NRF in NFRegister or NFUpdate response.

true: the NF Profile contains NF Profile changes.
false (default): complete NF Profile.

Read-Only: true

| +| defaultNotificationSubscriptions | array(DefaultNotificationSubscription) | O | 1..N | Notification endpoints for different notification types. (NOTE 10) | +| lmfInfo | LmfInfo | O | 0..1 | Specific data for the LMF. | +| gmlcInfo | GmlcInfo | O | 0..1 | Specific data for the GMLC. | +| nfSetIdList | array(NfSetId) | C | 1..N |

NF Set ID defined in clause 28.12 of 3GPP TS 23.003 [12].

At most one NF Set ID shall be indicated per PLMN-ID or SNPN of the NF. At most one combination of an AMF region and an AMF Set ID shall be indicated per PLMN-ID or SNPN in an AMF profile.

This information shall be present if available. (NOTE 22) (NOTE 23)

| +| servingScope | array(string) | O | 1..N |

The served area(s) of the NF instance.

The absence of this attribute does not imply that the NF instance can serve every area in the PLMN. (NOTE 13)

| +| lchSupportInd | boolean | O | 0..1 |

This IE indicates whether the NF supports Load Control based on LCI Header (see clause 6.3 of 3GPP TS 29.500 [4]).

  • - true: the NF supports the feature.
  • - false (default): the NF does not support the feature.
| +| olchSupportInd | boolean | O | 0..1 |

This IE indicates whether the NF supports Overload Control based on OCI Header (see clause 6.4 of 3GPP TS 29.500 [4]).

  • - true: the NF supports the feature.
  • - false (default): the NF does not support the feature.
| +| nfSetRecoveryTimeList | map(DateTime) | O | 1..N |

Map of recovery time, where the key of the map is the NfSetId of NF Set(s) that the NF instance belongs to.

When present, the value of each entry of the map shall be the recovery time of the NF Set indicated by the key.

| +| serviceSetRecoveryTimeList | map(DateTime) | O | 1..N |

Map of recovery time, where the key of the map is the NfServiceSetId of the NF Service Set(s) configured in the NF instance.

| + +| | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------| +| | | | | When present, the value of each entry of the map shall be the recovery time of the NF Service Set indicated by the key. | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|---------------------------------|-----------------------------------|---|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| scpDomains | array(string) | O | 1..N | When present, this IE shall carry the list of SCP domains the SCP belongs to, or the SCP domain the NF (other than SCP) or the SEPP belongs to. (NOTE 14) | +| scpInfo | ScpInfo | O | 0..1 | Specific data for the SCP. | +| seppInfo | SeppInfo | O | 0..1 | Specific data for the SEPP. | +| vendorId | VendorId | O | 0..1 | Vendor ID of the NF instance, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. | +| supportedVendorSpecificFeatures | map(array(VendorSpecificFeature)) | O | 1..N(1..M) | Map of Vendor-Specific features, where the key of the map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The string used as key of the map shall contain 6 decimal digits; if the SMI code has less than 6 digits, it shall be padded with leading digits "0" to complete a 6-digit string value. The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects. (NOTE 19) | +| aanflInfoList | map(AanflInfo) | O | 1..N | Multiple entries of AanflInfo. 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. | +| 5gDdnmfInfo | 5GDdnmfInfo | O | 0..1 | Specific data for the 5G DDNMF (5G DDNMF ID, ...) | +| mfaflInfo | MfaflInfo | O | 0..1 | Specific data for the MFAF | +| easdfInfoList | map(EasdfInfo) | O | 1..N | EASDF specific data. 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. (NOTE 20) | +| dcclfInfo | DccfInfo | O | 0..1 | Specific data for the DCCF. | +| nsacflInfoList | map(NsacflInfo) | O | 1..N | Specific data for the NSACF. 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. | +| mbSmfInfoList | map(MbSmfInfo) | O | 1..N | MB-SMF specific data. 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. | +| tsctsfInfoList | map(TsctsfInfo) | O | 1..N | Specific data for the TSCTSF. 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. | +| mbUpfInfoList | map(MbUpfInfo) | O | 1..N | MB-UPF specific data. 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. | +| trustAflInfo | TrustAflInfo | O | 0..1 | Specific data for the trusted AF. | +| nssaaflInfo | NssaaflInfo | O | 0..1 | Specific data for the NSSAAF. | +| hniList | array(Fqdn) | C | 1..N | Identifications of Credentials Holder or Default Credentials Server. This IE shall be present if the NFs are available for the case of access to an SNPN using credentials owned by a Credentials Holder or for the case of SNPN Onboarding using a DCS. | +| iwmscflInfo | IwmscflInfo | O | 0..1 | Specific data for the SMS-IWMSC. | +| mnpflInfo | MnpflInfo | O | 0..1 | Specific data for the MNPF. | +| smsflInfo | SmsflInfo | O | 0..1 | Specific data for the SMSF. | +| dcssfInfoList | map(DcsfInfo) | O | 1..N | Specific data for the DCSF. 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. | +| mrfInfoList | map(MrfInfo) | O | 1..N | Specific data for the MRF. 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. | + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mrfpInfoList | map(MrfpInfo) | O | 1..N | Specific data for the MRFP.
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. | +| mflInfoList | map(MflInfo) | O | 1..N | Specific data for the MF.
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. | +| adrflInfoList | map(AdrflInfo) | O | 1..N | Specific data for the ADRF.
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. | +| selectionConditions | SelectionConditions | O | 0..1 | This IE is only applicable if the NFStatus is set to "CANARY_RELEASE".

If present, it includes the conditions under which an NF Instance with an NFStatus value set to "CANARY_RELEASE" shall be selected by an NF Service Consumer (e.g. if the UE belongs to a range of SUPIs) | +| NOTE 1: At least one of the addressing parameters (fqdn, ipv4address or ipv6address) shall be included in the NF Profile. If the NF supports the NF services with "https" URI scheme (i.e use of TLS is mandatory), then the FQDN shall be provided in the NF Profile or the NF Service profile (see clause 6.1.6.2.3) and it shall be used to construct the target URI (unless overridden by a NFService-specific FQDN). See NOTE 1 of Table 6.1.6.2.3-1 for the use of these parameters. If multiple ipv4 addresses and/or ipv6 addresses are included in the NF Profile, the NF Service Consumer of the discovery service shall select one of these addresses randomly, unless operator defined local policy of IP address selection, in order to avoid overload for a specific ipv4 address and/or ipv6 address. | | | | | +| NOTE 2: If the type of Network Function is UPF, the addressing information is for the UPF N4 interface and, if the UPF registers service instances supporting the UPF Event Exposure service or the Nupf_GetUEPrivateIPaddrAndIdentifiers service without registering addressing information at these service instances level, also for accessing the UPF Event Exposure service or the Nupf_GetUEPrivateIPaddrAndIdentifiers service at these service instances. If the type of Network Function is MB-UPF, the addressing information is for the MB-UPF N4mb interface. If the type of Network Function is a P-CSCF and if no Gm FQDN or IP addresses are registered in the pcscfInfoList attribute, the addressing information is also used for the P-CSCF Gm interface. | | | | | +| NOTE 3: A requester NF may use this information to select a NF instance (e.g. a NF instance preferably located in the same data center). | | | | | +| NOTE 4: The capacity and priority parameters, if present, are used for NF selection and load balancing. The priority and capacity attributes shall be used for NF selection in the same way that priority and weight are used for server selection as defined in IETF RFC 2782 [23]. | | | | | +| NOTE 5: The NRF shall notify NFs subscribed to receiving notifications of changes of the NF profile, if the NF recoveryTime or the nfStatus is changed. See clause 6.2 of 3GPP TS 23.527 [27]. | | | | | +| NOTE 6: A requester NF may consider that all the resources created in the NF before the NF recovery time have been lost. This may be used to detect a restart of a NF and to trigger appropriate actions, e.g. release local resources. See clause 6.2 of 3GPP TS 23.527 [27]. | | | | | +| NOTE 7: A NF may register multiple PLMN IDs in its profile within a PLMN comprising multiple PLMN IDs. If so, all the attributes of the NF Profile shall apply to each PLMN ID registered in the plmnList. As an exception, attributes including a PLMN ID, e.g. IMSI-based SUPI ranges, TAIs and GUAMIs, are specific to one PLMN ID and the NF may register in its profile multiple occurrences of such attributes for different PLMN IDs (e.g. the UDM may register in its profile SUPI ranges for different PLMN IDs). | | | | | +| NOTE 8: Other NFs are in a different PLMN if they belong to none of the PLMN ID(s) configured for the PLMN of the NRF. | | | | | +| NOTE 9: This is for the use case where an NF (e.g. AMF) supports multiple PLMNs and the slices supported in each PLMN are different. See clause 9.2.6.2 of 3GPP TS 38.413 [29]. | | | | | +| NOTE 10: For notification types that may be associated with a specific service of the NF Instance receiving the notification (see clause 6.1.6.3.4), if notification endpoints are present both in the profile of the NF instance (NFProfile) and in some of its NF Services (NFService) for a same notification type, the notification endpoint(s) of the NF Services shall be used for this notification type. The defaultNotificationSubscriptions attribute may contain multiple default subscriptions for a same notification type; in that case, those default subscriptions are used as alternative notification endpoints so, for each notification event that needs to be sent, the NF Service Consumer shall select one of such subscriptions and use it to send the notification. | | | | | +| NOTE 11: The absence of the pcscfInfoList attribute in a P-CSCF profile indicates that the P-CSCF can be selected for any DNN and Access Type, and that the P-CSCF Gm addressing information is the same as the addressing information registered in the fqdn, ipv4Addresses and ipv4Addresses attributes of the NF profile. | | | | | +| NOTE 12: The absence of both the smfInfo and smfInfoList attributes in an SMF profile indicates that the SMF can be selected for any S-NSSAI listed in the sNSSAIs and perPlmnSnssaiList IEs, or for any S-NSSAI if neither the | | | | | + +sNSSAI IE nor the perPlmnSnsaiList IE are present, and for any DNN, TAI and access type. + +- NOTE 13: The servingScope attribute may indicate geographical areas. It may be used e.g. to discover and select NFs in centralized Data Centers that are expected to serve users located in specific region(s) or province(s). It may also be used to reduce the large configuration of TAIs in the NF instances. +- NOTE 14: An NF (other than a SCP) can register at most one SCP domain in NF profile, i.e. the NF can belong to only one SCP domain. If an NF (other than a SCP) includes this information in its profile, this indicates that the services produced by this NF should be accessed preferably via an SCP from the SCP domain the NF belongs to. +- NOTE 15: If the NF Service Consumer that issues an NF profile retrieval request indicates support for the "Service-Map" feature, the NRF shall return in the NF profile retrieval response the list of NF Service Instances in the "nfServiceList" map attribute. Otherwise, the NRF shall return the list of NF Service Instances in the "nfServices" array attribute. +- NOTE 16: The nfStatus also indicate the Status of the NF instance as NF Service Consumer for notification delivery. When a notification is to be delivered to the NF instance and the NF Service Producer (or SCP) has been aware that the NF instance is not operative from the nfStatus in its NF profile, the NF Service producer (or SCP) shall reselect another NF Service Consumer as target if possible, e.g. using binding indication or discovery factors previously provided for the notification. When selecting or reselecting an NF Service Consumer for notification delivery, not operative NF instances shall not be selected as target. +- NOTE 17: A change of this attribute shall trigger a "NF\_PROFILE\_CHANGED" notification from NRF, if the change of the NF Profile results in that the NF Instance starts or stops being authorized to be accessed by an NF having subscribed to be notified about NF profile changes. +- NOTE 18: For API URIs constructed with an FQDN, the NF Service Consumer may use the FQDN of the target URI to do a DNS query and obtain the IP address(es) to setup the TCP connection, and ignore the IP addresses that may be present in the NFProfile; alternatively, the NF Service Consumer may use those IP addresses to setup the TCP connection, if no service-specific FQDN or IP address is provided in the NFService data and if the NF Service Consumer supports to indicate specific IP address(es) to establish an HTTP/2 connection with an FQDN in the target URI. +- NOTE 19: When present, this attribute allows an NF requesting NF Discovery (e.g. an NF Service Consumer) to determine which vendor-specific extensions are supported in a given NF (e.g. an NF Service Producer), so as to select an appropriate NF with specific capability, or to include or not the vendor-specific attributes (see 3GPP TS 29.500 [4] clause 6.6.3) required for a given feature in subsequent messages towards a certain NF. One given vendor-specific feature shall not appear in both NF Profile and NF Service Profile. If one vendor-specific feature is service related, it shall only be included in the NF Service Profile. +- NOTE 20: The absence of the easdfInfoList attribute in an EASDF profile indicates that the EASDF can be selected for any S-NSSAI, DNN, DNAI or PSA UPF N6 IP address. +- NOTE 21: The NF service consumer when invoking NF services offered by collocated NF service producers shall follow the respective service API in the same manner as if they were not collocated with any other NF type. The NF service consumer shall not assume any optimization of signaling between the NF service consumer and the collocated NF service producers. +- NOTE 22: The nfSetIdList attribute shall be present only if all NF service instance(s) of the NF instance are redundant at NF Set level. i.e. any NF service instance shall be redundant (i.e. functionally equivalent, interchangeable and sharing contexts) with equivalent service instance(s) of every other NF instance(s) within the indicated NF Set or, if the NF service instance belongs to an NF service set, it shall be redundant with NF service instance(s) in an equivalent NF service set of every other NF instance(s) within the indicated NF set. +- NOTE 23: The NF Instance shall be removed from an NF set or re-assigned to another NF set ONLY when there is NO ongoing resource/context associated with the NF instance. + +## 6.1.6.2.3 Type: NFService + +**Table 6.1.6.2.3-1: Definition of type NFService** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------|----------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| serviceInstanceId | string | M | 1 | Unique ID of the service instance within a given NF Instance | +| serviceName | ServiceName | M | 1 | Name of the service instance (e.g. "nudm-sdm") | +| versions | array(NFService Version) | M | 1..N | The API versions supported by the NF Service and if available, the corresponding retirement date of the NF Service.
The different array elements shall have distinct unique values for "apiVersionInUri", and consequently, the values of "apiFullVersion" shall have a unique first digit version number. | +| scheme | UriScheme | M | 1 | URI scheme (e.g. "http", "https") | +| nfServiceStatus | NFServiceStatus | M | 1 | Status of the NF Service Instance (NOTE 3) (NOTE 12) | +| fqdn | Fqdn | O | 0..1 | FQDN of the NF Service Instance (NOTE 1) (NOTE 8) (NOTE 14)
The FQDN provided as part of the NFService information has precedence over the FQDN and IP addresses provided as part of the NFProfile information (see clause 6.1.6.2.2). | +| interPlmnFqdn | Fqdn | O | 0..1 | If the NF service needs to be discoverable by other NFs in a different PLMN, then an FQDN that is used for inter PLMN routing as specified in 3GPP TS 23.003 [12] may be registered with the NRF (NOTE 1) (NOTE 6).
A change of this attribute shall result in triggering a "NF_PROFILE_CHANGED" notification from NRF towards subscribing NFs located in the same or a different PLMN, but in the latter case the new value shall be notified as a change of the "fqdn" attribute.
The NRF shall not send intra-PLMN notifications containing this attribute to subscribing NFs not supporting the "Inter-Plmn-Fqdn" feature (see clause 6.1.9). | +| ipEndPoints | array(IpEndPoint) | O | 1..N | IP address(es) and port information of the Network Function (including IPv4 and/or IPv6 address) where the service is listening for incoming service requests (NOTE 1) (NOTE 7) (NOTE 14).
IP addresses provided in ipEndPoints have precedence over IP addresses provided as part of the NFProfile information and, when using the HTTP scheme, over FQDN provided as part of the NFProfile information (see clause 6.1.6.2.2). | +| apiPrefix | string | O | 0..1 | Optional path segment(s) used to construct the {apiRoot} variable of the different API URIs, as described in 3GPP TS 29.501 [5], clause 4.4.1 | +| callbackUriPrefixList | array(CallbackUri PrefixItem) | O | 1..N | Optional path segment(s) used to construct the prefix of the Callback URIs during the reselection of an NF service consumer, as described in 3GPP TS 29.501 [5], clause 4.4.3.
When present, this IE shall contain callback URI prefix values to be used for specific notification types. | +| defaultNotificationSubscriptions | array(DefaultNotificationSubscription) | O | 1..N | Notification endpoints for different notification types. (See also NOTE 10 in clause 6.1.6.2.2) | +| allowedPlmns | array(PlmnId) | O | 1..N | PLMNs allowed to access the service instance (NOTE 5).
The absence of this attribute indicates that any PLMN is allowed to access the service instance.
When included, the allowedPlmns attribute needs not include the PLMN ID(s) registered in the plmnList attribute of the NF Profile, i.e. the PLMN ID(s) registered in the NF Profile shall be considered to be | + +| | | | | | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

allowed to access the service instance.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13)

| +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-----------------------------|---------------------|---|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedSnpns | array(PlmnIdNid) | O | 1..N |

SNPNs allowed to access the service instance.

If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall prevail.

The absence of this attribute in both the NFService and in the NF profile indicates that no SNPN, other than the SNPN(s) registered in the snpnList attribute of the NF Profile (if the NF pertains to an SNPN), is allowed to access the service instance.

When included, the allowedSnpns attribute needs not include the PLMN ID/NID(s) registered in the snpnList attribute of the NF Profile (if the NF pertains to an SNPN), i.e. the SNPNs registered in the NF Profile (if any) shall be considered to be allowed to access the service instance.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13)

| +| allowedNfTypes | array(NFType) | O | 1..N |

Type of the NFs allowed to access the service instance (NOTE 5).

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13)

| +| allowedNfDomains | array(string) | O | 1..N |

Pattern (regular expression according to the ECMA-262 dialect [8]) representing the NF domain names within the PLMN of the NRF allowed to access the service instance (NOTE 5).

The absence of this attribute indicates that any NF domain is allowed to access the service instance.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13)

| +| allowedNssais | array(ExtSnssai) | O | 1..N |

S-NSSAI of the allowed slices to access the service instance (NOTE 5).

The absence of this attribute indicates that any slice is allowed to access the service instance.

This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13)

| +| allowedOperationsPerNf Type | map(array(string) ) | C | 1..N(1..M) |

Map of allowed operations on resources for each type of NF; the key of the map is the NF Type, and the value is an array of scopes.

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

The scopes shall be any of those defined in the API that defines the current service (identified by the "serviceName" attribute).

In an NFRegister (or NFUpdate) procedure, this IE should be present if the NF service instance supports and is configured to use resource/operation specific scope(s) for at least one NF type of NF service consumer.

In an NFStatusNotify procedure, this IE should be present, if it is present in the registered NF service instance and if the map contains a key matching the subscriber's NF type. When present, this IE should only contain the key-value pair of the map matching the subscriber's NF type.

(NOTE 11)

| +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-----------------------------------------|--------------------|---|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedOperationsPerNfInstance | map(array(string)) | C | 1..N(1..M) |

Map of allowed operations on resources for a given NF Instance; the key of the map is the NF Instance Id, and the value is an array of scopes.

The scopes shall be any of those defined in the API that defines the current service (identified by the "serviceName" attribute).

In an NFRegister (or NFUpdate) procedure, this IE should be present if the NF service instance supports and is configured to use resource/operation specific scope(s) for at least one NF instance of NF service consumer.

In an NFStatusNotify procedure, this IE should be present, if it is present in the registered NF service instance and if the map contains a key matching the subscriber's NF Instance ID. When present, this IE should only contain the key-value pair of the map matching the subscriber's NF Instance ID.

(NOTE 11)

| +| allowedOperationsPerNfInstanceOverrides | boolean | O | 0..1 |

This IE, when present and set to true, indicates that the scopes defined in attribute "allowedOperationsPerNfInstance" for a given NF Instance ID take precedence over the scopes defined in attribute "allowedOperationsPerNfType" for the corresponding NF type of the NF Instance associated to such NF Instance ID.

If the IE is not present, or set to false (default), it indicates that the allowed scopes are any of the scopes present either in "allowedOperationsPerNfType" or in "allowedOperationsPerNfInstance" for the NF Type and NF Instance ID of the NF Service Consumer.

(NOTE 11)

| +| allowedScopesRuleSet | map(RuleSet) | O | 1..N |

Map of rules specifying scopes allowed or denied for NF-Consumers. 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.

This IE may be present when the NF-Producer and the NRF support Allowed-ruleset feature as specified in Clause 6.1.9.

When NRF utilizes this parameter to determine the scopes allowed or denied to an NF-Consumer, it matches the NF-Consumer's properties (PLMN, SNPN, nfType, NfDomain, S-NSSAIs, NF-Instance Id) against each rule in decreasing order of priority (1 being the highest). When a matching rule is found, the search is stopped and the scopes associated to matching rule are allowed/dis-allowed to the NF-Consumer (see Annex C).

In an NFStatusNotify procedure, this IE may be present if the subscribing NF supports the Allowed-ruleset feature as specified in Clause 6.1.9, and should only contain the highest priority RuleSet matching the requester's NF Instance ID, nfType, PLMN-ID, SNPN-ID, NfDomain and S-NSSAI if any.

If the subscribing entity included "completeProfileSubscription" attribute in the subscription request message, and the NRF

| + +| | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17), the complete IE shall be present in the profile change notification (NOTE 13) | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|---------------------------------|-----------------------------------|---|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| priority | integer | O | 0..1 | Priority (relative to other services of the same type) in the range of 0-65535, to be used for NF Service selection; lower values indicate a higher priority. (NOTE 2).
The NRF may overwrite the received priority value when exposing an NFProfile with the Nnrf_NFDiscovery service. | +| capacity | integer | O | 0..1 | Static capacity information in the range of 0-65535, expressed as a weight relative to other services of the same type. (NOTE 2). | +| load | integer | O | 0..1 | Dynamic load information, ranged from 0 to 100, indicates the current load percentage of the NF Service. | +| loadTimeStamp | DateTime | O | 0..1 | It indicates the point in time in which the latest load information (sent by the NF in the "load" attribute of the NF Service) was generated at the NF Service Instance.

If the NF did not provide a timestamp, the NRF should set it to the instant when the NRF received the message where the NF provided the latest load information. | +| recoveryTime | DateTime | O | 0..1 | Timestamp when the NF service was (re)started (NOTE 3) (NOTE 4) | +| supportedFeatures | SupportedFeatures | O | 0..1 | Supported Features of the NF Service instance | +| nfServiceSetIdList | array(NfServiceSetId) | C | 1..N | NF Service Set ID (see clause 28.13 of 3GPP TS 23.003 [12])
At most one NF Service Set ID shall be indicated per PLMN-ID or SNPN of the NF.
This information shall be present if available. (NOTE 15) | +| sNssais | array(ExtSnssai) | O | 1..N | S-NSSAIs of the NF Service. This may be a subset of the S-NSSAIs supported by the NF (see sNssais attribute in NFProfile).
When present, this IE shall represent the list of S-NSSAIs supported by the NF Service in all the PLMNs listed in the plmnList IE and all the SNPNs listed in the snpnList and it shall prevail over the list of S-NSSAIs supported by the NF instance. | +| perPlmnSnssaiList | array(PlmnSnssai) | O | 1..N | S-NSSAIs of the NF Service per PLMN. This may be a subset of the S-NSSAIs supported per PLMN by the NF (see perPlmnSnssaiList attribute in NFProfile).

This IE may be included when the list of S-NSSAIs supported by the NF Service for each PLMN it is supporting is different. When present, this IE shall include the S-NSSAIs supported by the NF Service for each PLMN and it shall prevail over the list of S-NSSAIs supported per PLMN by the NF instance. When present, this IE shall override the sNssais IE. (NOTE 9) | +| vendorId | VendorId | O | 0..1 | Vendor ID of the NF Service instance, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. | +| supportedVendorSpecificFeatures | map(array(VendorSpecificFeature)) | O | 1..N(1..M) | Map of Vendor-Specific features, where the key of the map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The string used as key of the map shall contain 6 decimal digits; if the SMI code has less than 6 digits, it shall be padded with leading digits "0" to complete a 6-digit string value.
The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects. (NOTE 10) | +| oauth2Required | boolean | O | 0..1 | It indicates whether the NF Service Instance requires Oauth2-based authorization. | + +| | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------| +| | | | | Absence of this IE means that the NF Service Producer has not provided any indication about its usage of Oauth2 for authorization. | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|----------------------|---------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| perPlmnOAuth2ReqList | PlmnOAuth2 | O | 0..1 | When present, this IE shall include the Oauth2-based authorization requirement supported by the NF Service Instance per PLMN of the NF Service Consumer.
This IE may be included when the Oauth2.0 authorization requirement supported by the NF Service Instance for different PLMN is different. When the requester PLMN Id is available in perPlmnOAuth2ReqList IE, this IE shall override the oauth2Required IE. If the requester PLMN ID is not present in perPlmnOAuth2ReqList IE, then the value of oauth2Required IE shall be applicable if available. | +| selectionConditions | SelectionConditions | O | 0..1 | This IE is only applicable if the NFServiceStatus is set to "CANARY_RELEASE".

If present, it includes the conditions under which an NF Service Instance with an NFServiceStatus value set to "CANARY_RELEASE" shall be selected by an NF Service Consumer (e.g. if the UE belongs to a range of SUPIs) | + +NOTE 1: The NF Service Consumer will construct the API URIs of the service using: + +- For intra-PLMN signalling: If TLS is used, the FQDN present in the NF Service Profile, if any; otherwise, the FQDN present in the NF Profile. If TLS is not used, the FQDN should be used if the NF Service Consumer uses Indirect Communication via an SCP; the FQDN or the IP address in the ipEndPoints attribute may be used if the NF Service Consumer uses Direct Communication. + +- For inter-PLMN signalling: the interPlmnFqdn present in the NF Service Profile, if any; otherwise, the interPlmnFqdn present in the NF Profile. + +See Table 6.2.6.2.4-1. + +NOTE 2: The capacity and priority parameters, if present, are used for NF selection and load balancing. The priority and capacity attributes shall be used for NF selection in the same way that priority and weight are used for server selection as defined in IETF RFC 2782 [23]. + +NOTE 3: The NRF shall notify NFs subscribed to receiving notifications of changes of the NF profile, if the recoveryTime or the nfServiceStatus is changed. See clause 6.2 of 3GPP TS 23.527 [27]. + +NOTE 4: A requester NF subscribed to NF status changes may consider that all the resources created in the NF service before the NF service recovery time have been lost. This may be used to detect a restart of a NF service and to trigger appropriate actions, e.g. release local resources. See clause 6.2 of 3GPP TS 23.527 [27]. + +NOTE 5: If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall prevail. The absence of this attribute in the NFService and in the NFProfile indicates that there is no corresponding restriction to access the service instance. If this attribute is absent in the NF Service, but it is present in the NF Profile, the attribute from the NF Profile shall be applied. + +NOTE 6: Other NFs are in a different PLMN if they belong to none of the PLMN ID(s) configured for the PLMN of the NRF. + +NOTE 7: If multiple ipv4 addresses and/or ipv6 addresses are included in the NF Service, the NF Service Consumer of the discovery service shall select one of these addresses randomly, unless operator defined local policy of IP address selection, in order to avoid overload for a specific ipv4 address and/or ipv6 address. + +NOTE 8: If the URI scheme registered for the NF service is "https" then FQDN shall be provided in the NF Service profile or in NF Profile (see clause 6.1.6.2.2). + +NOTE 9: This is for the use case where an NF (e.g. AMF) supports multiple PLMNs and the slices supported in each PLMN are different. See clause 9.2.6.2 of 3GPP TS 38.413 [29]. + +NOTE 10: When present, this attribute allows the NF requesting NF discovery (e.g. an NF Service Consumer) to determine which vendor-specific extensions are supported in a given NF (e.g. an Service Producer) in order to select an appropriate NF, or to include or not include the vendor-specific attributes (see 3GPP TS 29.500 [4] clause 6.6.3) required for a given feature in subsequent service requests towards a certain service instance of the NF Service Producer. One given vendor-specific feature shall not appear in both NF Profile and NF Service Profile. If one vendor-specific feature is service related, it shall only be included in the NF Service Profile. + +NOTE 11: These attributes are used in order to determine whether a given resource/operation-level scope shall be granted to an NF Service Consumer that requested an Oauth2 access token with a specific scope. If attribute "allowedOperationsPerNfInstanceOverrides" is absent, or set to false, the NRF shall only grant such scope in the access token, if the scope is present in either "allowedOperationsPerNfType", for the specific NF type of the NF Service Consumer, or in "allowedOperationsPerNfInstance", for the specific NF instance ID of the NF Service Consumer. If attribute "allowedOperationsPerNfInstanceOverrides" is present and set to true, the NRF shall grant such scope in the access token, if the scope is included in the "allowedOperationsPerNfInstance" attribute for the NF Instance ID of the NF Service Consumer. If attribute "allowedOperationPerNfInstanceOverrides" is present and set to true, but the NF Instance ID of the NF Service Consumer is not included in attribute "allowedOperationPerNfInstance", the NRF shall grant such scope if it is present in the "allowedOperationsPerNfType" for the specific NF type of the NF Service + +Consumer. + +These attributes need not be registered if the NF service instance only supports (or is configured to only use) the service-level scope for all NF service consumers allowed to access the service. When both these attributes are absent, the NRF should grant access tokens for the service-level scope only. + +When at least one of these IEs is present, these IEs shall indicate all the NF types or NF instances allowed to access the NF service instance, with all the corresponding scopes (i.e. the service-level scope and resource/operation specific scopes) allowed for each NF type or NF instance, i.e. any NF type or NF instance not listed in these IEs is disallowed to access the NF service instance. + +Example: if an NF service instance is configured to enable an NF type X to access all service operations including resource/operations defined with resource/operation specific scopes and an NF type Y to access only the service operations not requiring resource/operation specific scopes, the allowedOperationsPerNfType IE should be present and set as follows: + +``` +allowedOperationsPerNfType: { + X: [, , ], + Y: [] +} +``` + +- NOTE 12: The nfServiceStatus also indicate the Status of the NF service instance as NF Service Consumer for notification delivery. When a notification is to be delivered to the NF service instance and the NF Service Producer (or SCP) has been aware that the NF service instance is not operative from the nfServiceStatus in the NF profile, the NF Service producer (or SCP) shall reselect another NF Service Consumer as target if possible, e.g. using binding indication or discovery factors previously provided for the notification. When selecting or reselecting an NF Service Consumer for notification delivery, not operative NF (service) instances shall not be selected as target. +- NOTE 13: A change of this attribute shall trigger a "NF\_PROFILE\_CHANGED" notification from NRF, if the change of the NF Profile results in that the NF Instance starts or stops being authorized to be accessed by an NF having subscribed to be notified about NF profile changes. +- NOTE 14: For API URIs constructed with an FQDN, the NF Service Consumer may use the FQDN in the target URI to do a DNS query and obtain the IP address(es) to setup the TCP connection, and ignore the IP addresses that may be present in the ipEndPoints attribute; alternatively, the NF Service Consumer may use those IP addresses to setup the TCP connection, if the NF Service Consumer supports to indicate specific IP address(es) to establish an HTTP/2 connection with an FQDN in the target URI. +- NOTE 15: The NF service Instance shall be removed from an NF service set or re-assigned to another NF service set ONLY when there is NO ongoing resource/context associated with the NF service instance. + +6.1.6.2.4 Type: DefaultNotificationSubscription + +**Table 6.1.6.2.4-1: Definition of type DefaultNotificationSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationType | NotificationType | M | 1 | Type of notification for which the corresponding callback URI is provided. | +| callbackUri | Uri | M | 1 | This attribute contains a default notification endpoint to be used by a NF Service Producer towards an NF Service Consumer that has not registered explicitly a callback URI in the NF Service Producer (e.g. as a result of an implicit subscription). | +| InterPlmnCallbackUri | Uri | C | 0..1 |

This IE shall be present when the default notification may be sent by a NF Service Producer in a different PLMN (e.g. the NSSAAF in HPLMN sends a notification to the AMF in VPLMN to re-authorize or revoke a S-NSSAI for a roaming UE) and the callback URI indicated in the callbackUri IE is not supporting inter-PLMN access.

When present, this IE shall indicate the callback URI to be used by NF Service Producers located in PLMNs that are different from the PLMN of the NF consumer.

| +| n1MessageClass | N1MessageClass | C | 0..1 | If the notification type is N1_MESSAGES, this IE shall be present and shall identify the class of N1 messages to be notified. | +| n2InformationClass | N2InformationClass | C | 0..1 | If the notification type is N2_INFORMATION, this IE shall be present and shall identify the class of N2 information to be notified. | +| versions | array(string) | O | 1..N | API versions (e.g. "v1") supported for the default notification type. (NOTE 3) | +| binding | string | O | 0..1 | When present, this IE shall contain the value of the Binding Indication for the default subscription notification (i.e. the value part of "3gpp-Sbi-Binding" header), as specified in clause 6.12.4 of 3GPP TS 29.500 [4]. (NOTE 1) | +| acceptedEncoding | string | O | 0..1 |

Content encodings that are accepted by a NF Service Consumer when receiving a notification related to a default notification subscription. The value of this attribute shall be formatted as the value of the Accept-Encoding header defined in IETF RFC 9110 [40] clause 12.5.3 (e.g. acceptedEncoding: "gzip;q=1.0, identity;q=0.5, *;q=0")

The absence of this IE shall not be interpreted as indicating that no specific encodings are supported, but the NF Service Consumer did not register the encodings it may support.

| +| supportedFeatures | SupportedFeatures | O | 0..1 | When present, this attribute shall indicate the features of the service corresponding to the subscribed default notification, which are supported by the NF (Service) instance acting as NF service consumer. (NOTE 2, NOTE 3) | +| serviceInfoList | map(DefSubServiceInfo) | O | 1..N |

This IE may be present when the notification request of the notification type may be generated by multiple services, i.e. notifications from different services may be received by the subscription.

When present, this IE shall contain a map of service specific information. The name of the corresponding service (as specified in ServiceName data type, see clause 6.1.6.3.11) is the key of the map and the value of the map is the specific information for the indicated service supported by the NF (Service) instance acting as NF service consumer.

For example, when the NF subscribes to default notification of "LOCATION_NOTIFICATION" type

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

which may be sent by Namf_Location service and Nlmf_Location service, the NF may provide service specific information as below:

 {   "namf-loc" : {     "versions" : [ "v1" ],     "supportedFeatures" : "AB"   },    "nlmf-loc" : {     "versions" : [ "v1" ],     "supportedFeatures" : "12"   } }

(NOTE 3, NOTE 4)

| +| callbackUriPrefix | string | O | 0..1 | Optional path segment(s) used to construct the prefix of the Callback URIs during the reselection of an NF service consumer, as described in 3GPP TS 29.501 [5], clause 4.4.3 | +|

NOTE 1: The binding indication for default subscription may be used by a NF service producer to reselect an alternative NF service consumer instance, when delivering a notification for a default subscription towards a specific NF consumer but the latter is not reachable. E.g. an AMF notifies corresponding uplink LPP/NRPPa messages via default subscription, to the LMF instance who previously sent downlink LPP/NRPPa message during a location procedure, If the original LMF instance is not reachable, the AMF selects an alternative LMF instance using the binding indication and delivers the notification towards the selected LMF instance.

NOTE 2: When sending notifications towards the subscribed NF service consumer, the NF service producer shall generate the default notifications according to the supported features indicated in this attribute, e.g. to include the attributes or enumerated values related to particular features only if the corresponding features are supported, as specified in clause 6.6.2 of 3GPP TS 29.500 [4].

NOTE 3: When the serviceInfoList IE is present, the versions IE and the supportedFeatures IE shall be absent.

NOTE 4: When the serviceInfoList IE is present, the NF producer shall determine whether the service of the default notification is supported, i.e. whether the service is listed in the map keys. If supported, the NF producer shall generate the default notification according to the specific information of the service, i.e. the corresponding map value.

| | | | | + +## 6.1.6.2.5 Type: IpEndPoint + +Table 6.1.6.2.5-1: Definition of type IpEndPoint + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|---------------------------------------------------| +| ipv4Address | Ipv4Addr | C | 0..1 | IPv4 address (NOTE 1) | +| ipv6Address | Ipv6Addr | C | 0..1 | IPv6 address (NOTE 1) | +| transport | TransportProtocol | O | 0..1 | Transport protocol | +| port | integer | O | 0..1 | Port number (NOTE 2)
Minimum: 0 Maximum: 65535 | + +NOTE 1: At most one occurrence of either ipv4Address or ipv6Address shall be included in this data structure. +NOTE 2: If the port number is absent from the ipEndPoints attribute (see clause 6.1.6.2.3), i.e. there is no "port" attribute in any of the IpEndPoints objects of the ipEndPoints array, the NF service consumer shall use the default HTTP port number, i.e. TCP port 80 for "http" URIs or TCP port 443 for "https" URIs as specified in IETF RFC 9113 [9] when invoking the service. +NOTE 3: If the "port" attribute is present, but the ipv4Address and ipv6Address attributes are absent, the NF service consumer shall use such port number along with the FQDN present in the NFService or NFProfile data types or IP address parameters present in the NFProfile data type to construct the target URI where the NF Service Producer is listening for incoming service requests. +NOTE 4: If the "port" attribute is present with any ipv4Address and ipv6Address attributes and the HTTP scheme of the service is "https", or the inter-PLMN signalling uses the "http" scheme, the NF service consumer shall use such port number along with the FQDN parameter present in the NFService or NFProfile data types to construct the target URI where the NF Service Producer is listening for incoming service requests. +NOTE 5: If the HTTP scheme of the service (see clause 6.1.6.2.3) is "https" or the inter-PLMN signalling uses the "http" scheme, the operator should not configure IpEndPoints having pairs of IP addresses and ports, with different "port" values in each entry. This is so because the authority of the target URI shall consist of an FQDN (due to the "https" scheme or inter-PLMN signalling), and it is not always possible to ensure which IP address will be used by the HTTP/2 stack after the DNS resolution has been performed. +NOTE 6: If the "ipEndPoints" array contains an entry (IpEndPoint object) containing either ipv4Address or ipv6Address, and with the "port" attribute absent, the NF Service Consumer shall use the default port for the given HTTP scheme when building a target URI that uses such IP address in the authority field of the URI. + +The following examples describe valid cases of the authority of target URIs, considering the addressing information present in the NFProfile and in the NFService objects (in the "nfServiceList" map). + +## EXAMPLE 1: + +## NFProfile: + +``` +{ + "fqdn": "nf.example.com", + "ipv4Addresses": [ "1.2.3.4" ], + "nfServiceList": { + "Service1": { + "scheme": "http", + "ipEndPoints": [ + { "port": 8080 }, + { "ipv4Address": "1.2.3.5", "port": 8081 } + ] + } + } +} +``` + +Valid authority for target URIs: + + + +Note that the IP address contained in ipEndPoints override the FQDN and IP address in NFProfile-level, so the value contained in "port" cannot be used, in this configuration. + +## EXAMPLE 2: + +## NFProfile: + +``` +{ + "fqdn": "nf.example.com", + "ipv4Addresses": [ "1.2.3.4" ], + "nfServiceList": { +``` + +``` + + "Service1": { + "scheme": "http", + "fqdn": "service1.example.com", + "ipEndPoints": [ + { "ipv4Address": "1.2.3.5", "port": 8081 }, + { "ipv4Address": "1.2.3.6" } + ] + } + } + } + } +} + +``` + +Valid authority for target URIs: + +``` + +http://1.2.3.5:8081/ +http://1.2.3.6:80/ +http://1.2.3.6/ + +``` + +#### EXAMPLE 3: + +NFProfile: + +``` + +{ + "fqdn": "nf.example.com", + "ipv4Addresses": [ "1.2.3.4" ], + "nfServiceList": { + "Service1": { + "scheme": "http", + "ipEndPoints": [ + { "port": 8080 }, + ] + } + } +} + +``` + +Valid authority for target URIs: + +``` + +http://nf.example.com:8080/ +http://1.2.3.4:8080/ + +``` + +#### 6.1.6.2.6 Type: UdrInfo + +**Table 6.1.6.2.6-1: Definition of type UdrInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| groupId | NfGroupId | O | 0..1 | Identity of the UDR group that is served by the UDR instance.
If not provided, the UDR instance does not pertain to any UDR group.
(NOTE 1) | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPI's whose profile data is available in the UDR instance (NOTE 1) | +| gpsiRanges | array(IdentityRange) | O | 1..N | List of ranges of GPSIs whose profile data is available in the UDR instance (NOTE 1) | +| externalGroupIdentifiersRanges | array(IdentityRange) | O | 1..N | List of ranges of external groups whose profile data is available in the UDR instance (NOTE 1) | +| supportedDataSets | array(DataSetId) | O | 1..N | List of supported data sets in the UDR instance.
If not provided, the UDR supports all data sets. | +| sharedDataIdRanges | array(SharedDataIdRange) | O | 1..N | List of ranges of Shared Data IDs that identify shared data available in the UDR instance (NOTE 1) | + +NOTE 1: If none of these parameters are provided, the UDR can serve any external group and any SUPI or GPSI and any SharedData managed by the PLMN of the UDR instance. If "supiRanges", "gpsiRanges" and "externalGroupIdentifiersRanges" attributes are absent, and "groupId" is present, the SUPIs / GPSIs / ExternalGroups served by this UDR instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). + +## 6.1.6.2.7 Type: UdmInfo + +Table 6.1.6.2.7-1: Definition of type UdmInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| groupId | NfGroupId | O | 0..1 | Identity of the UDM group that is served by the UDM instance.
If not provided, the UDM instance does not pertain to any UDM group.
(NOTE 1) | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPIs whose profile data is available in the UDM instance (NOTE 1) | +| gpsiRanges | array(IdentityRange) | O | 1..N | List of ranges of GPSIs whose profile data is available in the UDM instance (NOTE 1) | +| externalGroupIdentifiersRanges | array(IdentityRange) | O | 1..N | List of ranges of external groups whose profile data is available in the UDM instance (NOTE 1) | +| routingIndicators | array(string) | O | 1..N | List of Routing Indicator information that allows to route network signalling with SUCI (see 3GPP TS 23.003 [12]) to the UDM instance.
(NOTE 4)

If not provided, and "groupId" attribute is absent, the UDM can serve any Routing Indicator.

Pattern: '^[0-9]{1,4}\$' | +| internalGroupIdentifiersRanges | array(InternalGroupIdRange) | O | 1..N | List of ranges of Internal Group Identifiers whose profile data is available in the UDM instance.
If not provided, it does not imply that the UDM supports all internal groups. | +| suciInfos | array(SuciInfo) | O | 1..N | List of SuciInfo. A SUCI that matches this information can be served by the UDM .
(NOTE 2, NOTE 3)
A SUCI that matches all attributes of at least one entry in this array shall be considered as a match of this information. | + +NOTE 1: If none of these parameters are provided, the UDM can serve any external group and any SUPI or GPSI managed by the PLMN of the UDM instance. If "supiRanges", "gpsiRanges" and "externalGroupIdentifiersRanges" attributes are absent, and "groupId" is present, the SUPIs / GPSIs / ExternalGroups served by this UDM instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). + +NOTE 2: The combination of SUCI informations, e.g. Routing Indicator and Home Network Public Key Id, may be used as criteria for UDM discovery. In this release, the usage of Home Network Public Key identifier for UDM discovery is limited to the scenario where the UDM NF consumers belong to the same PLMN as UDM. + +NOTE 3: If the suciInfos attribute is present and contains the routingInds sub-attribute, then the routingIndicators attribute shall also be present. + +NOTE 4: If "routingIndicators" attribute is absent, and "groupId" is present, the set of Routing Indicators served by this UDM instance is determined by the NRF. When "groupId" is present, if the consumer of the Nnrf\_Discovery service does not support the "RID-NfGroupId-Mapping" feature (see clause 6.2.9), the NRF shall include in the discovery response the list of supported "routingIndicators" served by the UDM Group ID to which this UDM instance belongs, as determined by the NRF (or leave absent the "routingIndicators" attribute to indicate that any Routing Indicator is served by this UDM instance). + +## 6.1.6.2.8 Type: AusfInfo + +Table 6.1.6.2.8-1: Definition of type AusfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| groupId | NfGroupId | O | 0..1 | Identity of the AUSF group.
If not provided, the AUSF instance does not pertain to any AUSF group.
(NOTE 1) | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPIs that can be served by the AUSF instance.
(NOTE 1) | +| routingIndicators | array(string) | O | 1..N | List of Routing Indicator information that allows to route network signalling with SUCI (see 3GPP TS 23.003 [12]) to the AUSF instance.
(NOTE 4)

If not provided, and "groupId" attribute is absent, the AUSF can serve any Routing Indicator.

Pattern: '[0-9]{1,4}\$' | +| suciInfos | array(SuciInfo) | O | 1..N | List of SuciInfo. A SUCI that matches this information can be served by the AUSF. (NOTE 2, NOTE 3)
A SUCI that matches all attributes of at least one entry in this array shall be considered as a match of this information. | + +NOTE 1: If none of these parameters are provided, the AUSF can serve any SUPI managed by the PLMN of the AUSF instance. If "supiRanges" attribute is absent, and "groupId" is present, the SUPIs served by this AUSF instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). + +NOTE 2: The combination of SUCI informations, e.g. Routing Indicator and Home Network Public Key Id, can be used as criteria for AUSF discovery. In this release, the usage of Home Network Public Key identifier for AUSF discovery is limited to the scenario where the AUSF NF consumers belong to the same PLMN as AUSF. + +NOTE 3: If the suciInfos attribute is present and contains the routingInds sub-attribute, then the routingIndicators attribute shall also be present. + +NOTE 4: If "routingIndicators" attribute is absent, and "groupId" is present, the set of Routing Indicators served by this AUSF instance is determined by the NRF. When "groupId" is present, if the consumer of the Nnrf\_Discovery service does not support the "RID-NfGroupId-Mapping" feature (see clause 6.2.9), the NRF shall include in the discovery response the list of supported "routingIndicators" served by the AUSF Group ID to which this AUSF instance belongs, as determined by the NRF (or leave absent the "routingIndicators" attribute to indicate that any Routing Indicator is served by this AUSF instance). + +## 6.1.6.2.9 Type: SupiRange + +Table 6.1.6.2.9-1: Definition of type SupiRange + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| start | string | O | 0..1 | First value identifying the start of a SUPI range, to be used when the range of SUPI's can be represented as a numeric range (e.g., IMSI ranges). This string shall consist only of digits.
Pattern: "^[0-9]+\$" | +| end | string | O | 0..1 | Last value identifying the end of a SUPI range, to be used when the range of SUPI's can be represented as a numeric range (e.g. IMSI ranges). This string shall consist only of digits.
Pattern: "^[0-9]+\$" | +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of SUPI's belonging to this range. A SUPI value is considered part of the range if and only if the SUPI string fully matches the regular expression. | + +NOTE: Either the start and end attributes, or the pattern attribute, shall be present. + +- EXAMPLE 1: IMSI range. From: 123 45 6789040000 To: 123 45 6789059999 (i.e., 20,000 IMSI numbers) + JSON: { "start": "123456789040000", "end": "123456789059999" } +- EXAMPLE 2: IMSI range. From: 123 45 6789040000 To: 123 45 6789049999 (i.e., 10,000 IMSI numbers) + JSON: { "pattern": "^imsi-12345678904[0-9]{4}\$" }, or + JSON: { "start": "123456789040000", "end": "123456789049999" } +- EXAMPLE 3: NAI range. "smartmeter-{factoryID}@company.com" where "{factoryID}" can be any string. + JSON: { "pattern": "^nai-smartmeter-.+@company\\.com\$" } + +#### 6.1.6.2.10 Type: IdentityRange + +**Table 6.1.6.2.10-1: Definition of type IdentityRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| start | string | O | 0..1 | First value identifying the start of an identity range, to be used when the range of identities can be represented as a numeric range (e.g., MSISDN ranges). This string shall consist only of digits.
Pattern: "[0-9]+\$" | +| end | string | O | 0..1 | Last value identifying the end of an identity range, to be used when the range of identities can be represented as a numeric range (e.g., MSISDN ranges). This string shall consist only of digits.
Pattern: "[0-9]+\$" | +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of identities belonging to this range. An identity value is considered part of the range if and only if the identity string fully matches the regular expression. | +| NOTE: Either the start and end attributes, or the pattern attribute, shall be present. | | | | | + +## 6.1.6.2.11 Type: AmfInfo + +Table 6.1.6.2.11-1: Definition of type AmfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| amfRegionId | AmfRegionId | M | 1 | AMF region identifier | +| amfSetId | AmfSetId | M | 1 | AMF set identifier. | +| guamiList | array(Guami) | M | 1..N | List of supported GUAMIs | +| taiList | array(Tai) | O | 1..N | The list of TAIs the AMF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the AMF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the AMF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the taiList attribute indicate that the AMF can be selected for any TAI in the serving network. | +| backupInfoAmfFailure | array(Guami) | O | 1..N | List of GUAMIs for which the AMF acts as a backup for AMF failure | +| backupInfoAmfRemoval | array(Guami) | O | 1..N | List of GUAMIs for which the AMF acts as a backup for planned AMF removal | +| n2InterfaceAmfInfo | N2InterfaceAmfInfo | O | 0..1 | N2 interface information of the AMF. This information needs not be sent in NF Discovery responses. It may be used by the NRF to update the DNS for AMF discovery by the 5G Access Network. The procedures for updating the DNS are out of scope of this specification. | +| amfOnboardingCapability | boolean | O | 0..1 | When present, this IE indicates the AMF supports SNPN Onboarding capability. This is used for the case of Onboarding of UEs for SNPNs (see 3GPP TS 23.501 [2], clause 5.30.2.10).
  • - false (default): AMF does not support SNPN Onboarding;
  • - true: AMF supports SNPN Onboarding.
| +| highLatencyCom | boolean | O | 0..1 | When present, this IE indicates whether the AMF supports High Latency communication (e.g. for NR RedCap UE). This is used for CP NF to discover AMF supporting High Latency communication (see 3GPP TS 23.501 [2], clause 6.3.5).
  • - true: AMF supports High Latency communication e.g. for NR RedCap UE;
  • - false: AMF does not support High Latency communication e.g. for NR RedCap UE.
| + +The "backupInfoAmfFailure" attribute and "backupInfoAmfRemoval" attribute indicates the GUAMIs for which the AMF can act as Backup, when the serving AMF has failed or under planned removal. + +## EXAMPLE: + +When AMF-A, AMF-B and AMF-C registered their NF profiles for PLMN (e.g. MCC = 234, MNC = 15) as following: + +AMF-A NF Profile: + +``` +{ + "amfInfo": { + "guamiList": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000001"}], + "backupInfoAmfFailure": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000003"}] + } +} +``` + +**AMF-B NF Profile:** + +``` +{ + "amfInfo": { + "guamiList": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000002"}], + "backupInfoAmfRemoval": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000003"}] + } +} +``` + +**AMF-C NF Profile:** + +``` +{ + "amfInfo": { + "guamiList": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000003"}] + } +} +``` + +When one NF consumer queries NRF with a GUAMI served by AMF-C (i.e. {"plmnId":{"mcc":"234","mnc":"15"},"amfId":"000003"}), then + +- if the NRF detects the AMF-C has failed, e.g. using heartbeat, the NRF shall return AMF-A instance as backup AMF; or +- if the NRF detects AMF-C has entered planned removal, i.e. received a de-registration request from AMF-C, the NRF shall return AMF-B instance as backup AMF. + +6.1.6.2.12 Type: SmfInfo + +**Table 6.1.6.2.12-1: Definition of type SmfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|--------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssaiSmfInfoList | array(SnssaiSmfInfoItem) | M | 1..N | List of parameters supported by the SMF per S-NSSAI (NOTE 1). | +| tailList | array(Tai) | O | 1..N | The list of TAIs the SMF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the SMF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the SMF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the tailList attribute indicate that the SMF can be selected for any TAI in the serving network. | +| pgwFqdn | Fqdn | O | 0..1 | The FQDN of the PGW if the SMF is a combined SMF/PGW-C. | +| pgwIpAddrList | array(IpAddr) | O | 1..N | When present, this IE shall contain the PGW IP addresses of the combined SMF/PGW-C. Each PGW IP address shall be encoded as an IPv4 or an IPv6 address (i.e. not as an IPv6 prefix).

This IE allows the NF Service consumer to find the target combined SMF/PGW-C by PGW IP Address, e.g. when only PGW IP Address is available. | +| accessType | array(AccessType) | C | 1..2 | If included, this IE shall contain the access type (3GPP_ACCESS and/or NON_3GPP_ACCESS) supported by the SMF.
If not included, it shall be assumed the both access types are supported. | +| priority | integer | O | 0..1 | Priority (relative to other NFs of the same type) in the range of 0-65535, to be used for NF selection for a service request matching the attributes of the SmfInfo; lower values indicate a higher priority.

The NRF may overwrite the received priority value when exposing an NFProfile with the Nnrf_NFDiscovery service.

Absence of this attribute equals to having the same smfInfo priority as the priority defined at NFProfile/NFService level.

(NOTE 2) | +| vsmfSupportInd | boolean | O | 0..1 | This IE may be used by an SMF to explicitly indicate the support of V-SMF capability and its preference to be selected as V-SMF.

When present, this IE shall indicate whether the V-SMF capability are supported by the SMF:
- true: V-SMF capability supported by the SMF
- false: V-SMF capability not supported by the SMF.

Absence of this IE indicates the V-SMF capability support of the SMF is not specified.
(NOTE 3) | +| ismfSupportInd | boolean | O | 0..1 | This IE may be used by an SMF to explicitly indicate the support of I-SMF capability and its preference to be selected as I-SMF.

When present, this IE shall indicate whether the I-SMF capability are supported by the SMF:
- true: I-SMF capability supported by the SMF
- false: I-SMF capability not supported by the SMF.

Absence of this IE indicates the I-SMF capability support of the SMF is not specified.
(NOTE 3) | +| pgwFqdnList | array(Fqdn) | O | 1..N | When present, this attribute provides additional FQDNs to the FQDN indicated in the pgwFqdn | + +| | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | attribute. The pgwFqdnList attribute may be present if the pgwFqdn attribute is present. | +| smfOnboardingCapability | boolean | O | 0..1 | When present, this IE indicates the SMF supports SNPN Onboarding capability and User Plane Remote Provisioning. This is used for the case of Onboarding of UEs for SNPNs (see 3GPP TS 23.501 [2], clauses 5.30.2.10 and 6.2.6.2).
  • - false (default): SMF does not support SNPN Onboarding;
  • - true: SMF supports SNPN Onboarding.
(NOTE 4) | +| smfUPRPCapability | boolean | O | 0..1 | When present, this IE indicates the SMF supports User Plane Remote Provisioning (UPRP) capability. This is used for the case of Onboarding of UEs for SNPNs (see 3GPP TS 23.501 [2], clauses 5.30.2.10 and 6.2.6.2).
  • - false (default): SMF does not support UPRP;
  • - true: SMF supports UPRP.
| +| NOTE 1: If this S-NSSAIs is present in the SmfInfo and in the NFprofile, the S-NSSAIs from the SmfInfo shall prevail. | | | | | +| NOTE 2: An SMF profile may e.g. contain multiple SmfInfo entries, with each entry containing a different list of TAIs and a different priority, to differentiate the priority to select the SMF based on the user location. The priority in SmfInfo applies between SMFs or SMF Services with the same priority. | | | | | +| NOTE 3: The IE should only be registered when the SMF is configured to be preferably selected as V-SMF/I-SMF. | | | | | +| NOTE 4: The IE is deprecated and replaced by smfUPRPCapability attribute. | | | | | + +6.1.6.2.13 Type: UpfInfo + +**Table 6.1.6.2.13-1: Definition of type UpfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssaiUpflnfoList | array(SNSSAIUpflnfoItem) | M | 1..N | List of parameters supported by the UPF per S-NSSAI (NOTE 1) | +| smfServingArea | array(string) | O | 1..N | The SMF service area(s) the UPF can serve.
If not provided, the UPF can serve any SMF service area. | +| interfaceUpflnfoList | array(InterfaceUpflnfoItem) | O | 1..N | List of User Plane interfaces configured on the UPF. When this IE is provided in the NF Discovery response, the NF Service Consumer (e.g. SMF) may use this information for UPF selection. (NOTE 7) | +| iwkEpsInd | boolean | O | 0..1 | Indicates whether interworking with EPS is supported by the UPF.
true: Supported
false (default): Not Supported | +| sxaInd | boolean | O | 0..1 | Indicates whether the UPF is configured to support Sxa interface.
true: Supported
false: Not Supported | +| pduSessionTypes | array(PduSessionType) | O | 1..N | List of PDU session type(s) supported by the UPF. The absence of this attribute indicates that the UPF can be selected for any PDU session type. | +| atsssCapability | AtsssCapability | C | 0..1 | If present, this IE shall indicate the ATSSS capability of the UPF.
If not present, the UPF shall be regarded with no ATSSS capability. | +| uelpAddrInd | boolean | O | 0..1 | Indicates whether the UPF supports allocating UE IP addresses/prefixes.
true: supported
false (default): not supported | +| tailList | array(Tai) | O | 1..N | The list of TAIIs the UPF can serve. It may contain one or more non-3GPP access TAIIs. The absence of this attribute and the taiRangeList attribute indicates that the UPF can serve the whole SMF service area defined by the smfServingArea attribute. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIIs the UPF can serve. It may contain non-3GPP access TAIIs. The absence of this attribute and the tailList attribute indicates that the UPF can serve the whole SMF service area defined by the smfServingArea attribute. (NOTE 6) | +| wAgflnfo | WAgflnfo | C | 0..1 | If present, this IE shall indicate that the UPF is collocated with W-AGF.
If not present, the UPF is not collocated with W-AGF. | +| tnzglnfo | Tngzglnfo | C | 0..1 | If present, this IE shall indicate that the UPF is collocated with TNGF.
If not present, the UPF is not collocated with TNGF. | +| twiflnfo | Twiflnfo | C | 0..1 | If present, this IE shall indicate that the UPF is collocated with TWIF.
If not present, the UPF is not collocated with TWIF. | +| preferredEpdglInfoList | array(EpdglInfo) | O | 1..N | If present, this IE shall indicate that ePDG(s) that are preferred (e.g. for traffic efficiency, distance wise or topology wise) to be served by the UPF/PGW-U. | +| preferredWagflnfoList | array(WAgflnfo) | O | 1..N | If present, this IE shall indicate that W-AGF(s) that are preferred (e.g. for traffic efficiency, distance wise or topology wise) to be served by the UPF. | +| preferredTngzglnfoList | array(Tngzglnfo) | O | 1..N | If present, this IE shall indicate that TNGF(s) that are preferred (e.g. for traffic efficiency, distance wise or topology wise) to be served by the UPF. | +| preferredTwiflnfoList | array(Twiflnfo) | O | 1..N | If present, this IE shall indicate that TWIF(s) that are preferred (e.g. for traffic efficiency, distance wise or topology wise) to be served by the UPF. | +| priority | integer | O | 0..1 | Priority (relative to other NFs of the same type) in the range of 0-65535, to be used for NF selection for a service request matching the attributes of the Upflnfo; lower values indicate a higher priority. | + +| | | | | | +|-----------------------|------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | See the precedence rules in the description of the priority attribute in NFPprofile, if Priority is also present in NFPprofile.
The NRF may overwrite the received priority value when exposing an NFPprofile with the Nnrf_NFDiscovery service.
(NOTE 2) | +| redundantGtpu | boolean | O | 0..1 | Indicates whether the UPF supports redundant GTP-U path.
true: supported
false (default): not supported | +| ipups | boolean | O | 0..1 | Indicates whether the UPF is configured for IPUPS.
(NOTE 3)

true: the UPF is configured for IPUPS.
false (default): the UPF is not configured for IPUPS. | +| dataForwarding | boolean | O | 0..1 | Indicates whether the UPF is configured for data forwarding. (NOTE 4)

When present, this IE shall be set as following:
- true: the UPF is configured for data forwarding
- false (default): the UPF is not configured for data forwarding

If the UPF is configured for data forwarding, it shall support UP network interface with type "DATA_FORWARDING". | +| supportedPfcpFeatures | string | O | 0..1 | Supported PFCP Features.

A string used to indicate the PFCP features supported by the UPF, which encodes the "UP Function Features" IE as specified in Table 8.2.25-1 of 3GPP TS 29.244 [21] (starting from Octet 5), in hexadecimal representation.

Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and each two characters shall represent one octet of "UP Function Features" IE (starting from Octet 5, to higher octets). For each two characters representing one octet, the first character representing the 4 most significant bits of the octet and the second character the 4 least significant bits of the octet.

(NOTE 5) | +| upfEvents | array(EventType) | O | 1..N | UPF event(s) exposed by the UPF | + +NOTE 1: If this S-NSSAIs is present in the UpfInfo and in the NFprofile, the S-NSSAIs from the UpfInfo shall prevail. + +NOTE 2: An UPF profile may e.g. contain multiple UpfInfo entries, with each entry containing a different list of TAIs and a different priority, to differentiate the priority to select the UPF based on the user location. The priority in UpfInfo has the least precedence, i.e. it applies between UPFs with the same priority. + +NOTE 3: Any UPF can support the IPUPS functionality. In network deployments where specific UPFs are used to provide IPUPS, UPFs configured for providing IPUPS services shall be selected to provide IPUPS. + +NOTE 4: Based on operator policies, if dedicated UPFs are preferred to be used for indirect data forwarding during handover scenarios, when setting up the indirect data forwarding tunnel, the SMF should preferably select a UPF configured for data forwarding and use the network instance indicated in the Network Instance ID associated to the DATA\_FORWARDING interface type in the interfaceUpfInfoList attribute. + +NOTE 5: The supportedPfcpFeatures shall be provisioned in addition and be consistent with the existing UPF features (atsssCapability, uelpAddrInd, redundantGtpu and ipups) in the upfInfo, e.g. if the uelpAddrInd is set to "true", then the UEIP flag shall also be set to "1" in the supportedPfcpFeatures. + +NOTE 6: This attribute should only be used by the UPF if, based on specific operator's deployment, the NRF and the SMFs intended to interwork with this UPF, have been upgraded to support this feature (i.e. to understand the definition of TAIs in the UPF profile based on ranges of TAIs). + +NOTE 7: The information elements included in the InterfaceUpfInfoItems, e.g. the Network Instance, can be used for any S-NSSAI and/or DNN which have no InterfaceUpfInfoList provisioned in the corresponding SnssaiUpfInfoItem and/or DnnUpfInfoItem. + +## 6.1.6.2.14 Type: SnssaiUpflnfoltem + +**Table 6.1.6.2.14-1: Definition of type SnssaiUpflnfoltem** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | Supported S-NSSAI (NOTE 1) | +| dnnUpflnfolList | array(DnnUpflnfolItem) | M | 1..N | List of parameters supported by the UPF per DNN | +| redundantTransport | boolean | O | 0..1 | Indicates whether the UPF supports redundant transport path on the transport layer in the corresponding network slice.
true: supported
false (default): not supported | +| interfaceUpflnfolList | array(InterfaceUpflnfolItem) | O | 1..N | This IE may be present to contain a list of User Plane interfaces configured on the UPF for the network slice. (NOTE 2) | + +NOTE 1: A UPF may register SD ranges or a wildcard SD if the NRF and all consumers of the UPF profile have been upgraded to support SD ranges and wildcard SD in this attribute. + +NOTE 2: The interfaceUpflnfolList included in this data type SnssaiUpflnfoltem shall prevail over the one included in the Upflnfol. + +## 6.1.6.2.15 Type: DnnUpflnfoltem + +Table 6.1.6.2.15-1: Definition of type DnnUpflnfoltem + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Supported DNN. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. | +| dnaiList | array(Dnai) | O | 1..N | List of Data network access identifiers supported by the UPF for this DNN. The absence of this attribute indicates that the UPF can be selected for this DNN for any DNAI. | +| pduSessionTypes | array(PduSessionType) | O | 1..N | List of PDU session type(s) supported by the UPF for a specific DNN. The absence of this attribute indicates that the UPF can be selected for this DNN for any PDU session type supported by the UPF (see clause 6.1.6.2.13). | +| ipv4AddressRanges | array(Ipv4AddressRange) | O | 1..N | List of ranges of IPv4 addresses handled by UPF. (NOTE 1) | +| ipv6PrefixRanges | array(Ipv6PrefixRange) | O | 1..N | List of ranges of IPv6 prefixes handled by the UPF. (NOTE 1) | +| natedIpv4AddressRanges | array(Ipv4AddressRange) | O | 1..N | List of ranges of NATed IPv4 addresses. | +| natedIpv6PrefixRanges | array(Ipv6PrefixRange) | O | 1..N | List of ranges of NATed IPv6 prefixes. | +| ipv4IndexList | array(IpIndex) | O | 1..N | List of Ipv4 Index supported by the UPF. (NOTE 3) | +| ipv6IndexList | array(IpIndex) | O | 1..N | List of Ipv6 Index supported by the UPF. (NOTE 3) | +| networkInstance | string | O | 0..1 | The N6 Network Instance (See 3GPP TS 29.244 [21]) associated with the S-NSSAI and DNN. (NOTE 4) | +| dnaiNwInstanceList | map(string) | O | 1..N | Map of a network instance per DNAI for the DNN, where the key of the map is the DNAI.

When present, the value of each entry of the map shall contain a N6 network instance that is configured for the DNAI indicated by the key.

(NOTE 2) | +| interfaceUpflnfolList | array(InterfaceUpflnfoltem) | O | 1..N | This IE may be present to contain a list of User Plane interfaces configured on the UPF for the network slice and Dnn. (NOTE 5) | + +NOTE 1: The list of ranges of IPv4/v6 address may be used by the SMF to select a UPF which supports a UE static IP address received in user subscription, or when the UE IP address is to be allocated by an external server, e.g. AAA/Radius Server. + +NOTE 2: This IE may be used by the SMF to determine the Network Instance associated to a given S-NSSAI, DNN and DNAI. If this IE is not present, the SMF needs to be configured with corresponding information. + +NOTE 3: The list of IPv4/v6 Indexes may be used by the SMF to select a UPF which supports a specific IP Index received from the UDM or the PCF for a UE's PDU session. + +NOTE 4: The networkInstance IE and the dnaiNwInstanceList shall not be present simultaneously. The networkInstance IE may be used by the SMF to determine the Network Instance associated to a given S-NSSAI and DNN where DNAI(s) are not configured, i.e. the dnaiNwInstanceList is not present. If this IE is not present and the dnaiNwInstanceList is also not present, the SMF needs to be configured with corresponding information. A network instance can be associated with multiple network slices if the UP function supports the "Per Slice UP Resource Management" feature as specified in clause 5.35.1 of 3GPP TS 29.244 [21]. + +NOTE 5: The interfaceUpflnfolList included in this data type DnnUpflnfoltem shall prevail over the one included in the SnssaiUpflnfoltem. + +6.1.6.2.16 Type: SubscriptionData + +**Table 6.1.6.2.16-1: Definition of type SubscriptionData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nfStatusNotificationUri | Uri | M | 1 | Callback URI where the NF Service Consumer will receive the notifications from NRF. | +| reqNfInstanceId | NfInstanceId | O | 0..1 | If present, this IE shall contain the NF instance id of the NF service consumer. | +| subscrCond | SubscrCond | O | 0..1 | If present, this attributed shall contain the conditions identifying the set of NF Instances whose status is requested to be monitored. If this attribute is not present, it means that the NF Service Consumer requests a subscription to all NFs in the NRF (NOTE 1). | +| subscriptionId | string | C | 0..1 | Subscription ID for the newly created resource. This parameter shall be absent in the request to the NRF and shall be included by NRF in the response to the subscription creation request.
Read-Only: true
Pattern: "^[0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?[^-]+\$" | +| validityTime | DateTime | C | 0..1 | Time instant after which the subscription becomes invalid. This parameter may be sent by the client, as a hint to the server, but it shall be always sent back by the server (regardless of the presence of the attribute in the request) in the response to the subscription creation request. | +| reqNotifEvents | array(NotificationEventType) | O | 1..N | If present, this attribute shall contain the list of event types that the NF Service Consumer is interested in receiving.

If this attribute is not present, it means that notifications for all event types are requested. | +| reqNfType | NFType | C | 0..1 | An NF Service Consumer complying with this version of the specification shall include this IE. If included, this IE shall contain the NF type of the NF Service Consumer that is requesting the creation of the subscription. The NRF shall use it for authorizing the request, in the same way as the "requester-nf-type" is used in the NF Discovery service (see Table 6.2.3.2.3.1-1).

When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services (NOTE 2). | +| reqNfFqdn | Fqdn | O | 0..1 | This IE may be present for a subscription request within the same PLMN as the NRF. If included, this IE shall contain the FQDN of the NF Service Consumer that is requesting the creation of the subscription. The NRF shall use it for authorizing the request, in the same way as the "requester-nf-instance-fqdn" is used in the NF Discovery service (see Table 6.2.3.2.3.1-1). This IE shall be ignored by the NRF if it is received from a requester NF belonging to a different PLMN.

When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services (NOTE 2). | +| reqSnssais | array(ExtSnssai) | O | 1..N | If included, this IE shall contain the list of S-NSSAIs of the NF Service Consumer that is requesting the creation of the subscription. If this IE is included in a subscription request in a different PLMN, the requester NF shall provide S-NSSAI values of the target PLMN, that correspond to the S-NSSAI values | + +| | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

of the requester NF. The NRF shall use it for authorizing the request, in the same way as the "requester-snssais" is used in the NF Discovery service (see Table 6.2.3.2.3.1-1).

When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services (NOTE 2).

| +|--|--|--|--|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|----------------------|-------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reqPerPlmnSnssais | array(PlmnSnssai) | O | 1..N |

If included, this IE shall indicate the list of S-NSSAIs supported by the NF Service Consumer in each of the PLMNs it supports. The NRF shall use it for authorizing the request, in the same way as the "per-plmn-requester-snssais" is used in the NF Discovery service (see Table 6.2.3.2.3.1-1).

When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services (NOTE 2).

| +| plmnId | PlmnId | O | 0..1 |

If present, this attribute contains the target PLMN ID of the NF Instance(s) whose status is requested to be monitored. (NOTE 7)

| +| nid | Nid | O | 0..1 |

If present, this attribute contains the target NID that, together with the plmnId attribute, identifies the SNPn of the NF Instance(s) whose status is requested to be monitored.

| +| onboardingCapability | boolean | O | 0..1 |

If present, this attribute indicates the NF Instance(s) whose status is requested to be monitored support SNPn Onboarding capability.

| +| notifCondition | NotifCondition | O | 0..1 |

If present, this attribute contains the conditions that trigger a notification from NRF; this attribute shall only be present if the NF Service Consumer has subscribed to changes on the NF Profile (i.e., reqNotifEvents contains the value "NF_PROFILE_CHANGED", or reqNotifEvents attribute is absent) (NOTE 3).

If this attribute is absent, it means that the NF Service Consumer does not indicate any restriction, or condition, on which attributes of the NF Profile shall trigger a notification from NRF. (NOTE 5).

| +| reqPlmnList | array(PlmnId) | C | 1..N |

This IE shall be included when subscribing to NF services in a different PLMN. It may be present when subscribing to NF services in the same PLMN. When included, this IE shall contain the PLMN ID(s) of the requester NF. (NOTE 2)

| +| reqSnpnList | array(PlmnIdNid) | C | 1..N |

This IE shall be included when the subscribing NF belongs to one or several SNPns and it subscribes to NF services of a specific SNPn. When included, this IE shall contain the SNPn ID(s) of the requester NF.

When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services. (NOTE 2)

| +| servingScope | array(string) | O | 1..N |

If present, this attribute indicates the target served area(s) of the NF instance(s) whose status is required to be monitored. (NOTE 4)

| +| requesterFeatures | SupportedFeatures | C | 0..1 |

Nnrf_NFManagement features supported by the NF Service Consumer that is invoking the Nnrf_NFManagement service. See clause 6.1.9.

This IE shall be included if at least one feature is supported by the NF Service Consumer.

Write-Only: true

(NOTE 6)

| +| nrfSupportedFeatures | SupportedFeatur | C | 0..1 |

Features supported by the NRF in the

| + +| | | | | | +|--|----|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------| +| | es | | | Nnrf_NFManagement service. See clause 6.1.9.

This IE shall be included if at least one feature is supported by the NRF.

Read-Only: true | +|--|----|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|---|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| hnrfUri | Uri | C | 0..1 |

If included, this IE shall contain the API URI of the NFManagement Service (see clause 6.1.1) of the home NRF.

It shall be included if the NF Service Consumer has previously received such API URI from the NSSF in the home PLMN (see clause 6.1.6.2.11 of 3GPP TS 29.531 [42]).

| +| targetHni | Fqdn | O | 0..1 |

If present, this attribute shall contain the identification of the Default Credentials Server or the identification of the Credentials Holder.

| +| preferredLocality | string | O | 0..1 |

Preferred target NF location (e.g. geographic location, data center).

When present, the NRF should set a priority for the monitored NF instance in the notification as specified in the description of the preferred-locality in Table 6.2.3.2.3.1-1.

| +| extPreferredLocality | map(array(LocalityDescription)) | O | 1..N(1..M) |

Preferred target NF location (e.g. geographic location, data center).

The key of the map shall represent the relative priority, for the requester, of each locality description among the list of locality descriptions in this attribute, encoded as "1" (highest priority), "2", "3", ..., "n" (lowest priority). See examples in the description of the ext-preferred-locality in Table 6.2.3.2.3.1-1.

When present, the NRF should set a priority for the monitored NF instance in the notification as specified in the description of the ext-preferred-locality in Table 6.2.3.2.3.1-1.

| +| completeProfileSubscription | boolean | O | 0..1 |

This IE may be included by an SCP with the value true to request to monitor, and to be notified of, changes on the complete profile of the NF Instance (including authorization attributes such as the "allowedXXX" attributes of NFProfile and NFService data types). See clause 5.2.2.5.2.

Write-Only: true

| +|

NOTE 1: The "subscription to all NFs" may be quite demanding in terms of resources in NRF and also in terms of network traffic of the resulting notifications, so it should be authorized by NRF under very strict policies (e.g. only to a specific requesting NF, as indicated by reqNfType and reqNfFqdn attributes).

NOTE 2: The authorization parameters in NF Profile are those used by NRF to determine whether a given NF Instance / NF Service Instance can be discovered by an NF Service Consumer in order to consume its offered services (e.g. "allowedNfTypes", "allowedNfDomains", etc.). Based on operator's policies, a subscription request not including the requester's information necessary to validate the authorization parameters in NF Profiles may be rejected or may be accepted but with only generating notifications from NF Instances whose authorization parameters allow any NF Service Consumer to access their services.

NOTE 3: The subscription to load changes may be quite demanding in terms of network traffic of the resulting notifications, thus it may be limited by the NRF via appropriate configuration (e.g. granularity threshold)

NOTE 4: An NF instance may explicitly indicate the served areas in the NF profile when registered to NRF. When this IE is present, the NRF shall only monitor the NF instance(s) indicating at least one of the served areas in the list. If an NF instance has not indicated any served area in its NF profile, it shall not be monitored.

NOTE 5: If the attributes to be monitored or excluded from monitoring, included as part of the "notifCondition" attribute, refer to a specific element of an array (e.g. they refer to a specific array index of the "nfServices" attribute of the NFProfile), the NRF shall apply the same condition to all elements of the same array.

NOTE 6: If the NF Service Consumer that issued the subscription request indicated support for the "Service-Map" feature, the NRF shall send notifications of profile changes (see clause 6.1.6.2.17) affecting the list of NF Service Instances, as modifications of specific attributes of the "nfServiceList" map. Otherwise, the NRF shall send those notifications as a complete replacement of the "nfServices" array attribute.

NOTE 7: The PLMN ID should be used by the NRF as an additional subscription condition to monitor the change of target NF profile, unless the subscription is specific to one or a list of NF(s) explicitly indicated by their NF Instance ID(s), e.g. using the NfInstanceIdCond or NfInstanceIdListCond, in which case the NRF shall not use the PLMN ID provided in the subscription (if any) as an additional subscription condition to monitor the change of target NF profile.

| | | | | + +6.1.6.2.17 Type: NotificationData + +**Table 6.1.6.2.17-1: Definition of type NotificationData** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| event | NotificationEventType | M | 1 | Notification type. It shall take the values "NF_REGISTERED", "NF_DEREGISTERED" or "NF_PROFILE_CHANGED". | +| nfInstanceUri | Uri | M | 1 | Uri of the NF Instance (see clause 6.1.3.3.2) associated to the notification event. | +| nfProfile | NFProfile | C | 0..1 |

New NF Profile or Updated NF Profile; it shall be present when the notification type is "NF_REGISTERED" and it may be present when the notification type is "NF_PROFILE_CHANGED".
(NOTE 3)

This IE, if present, shall not contain authorization attributes (such as the "allowedXXX" attributes of the NFProfile or NFService data types).

| +| profileChanges | array(ChangeItem) | C | 1..N | List of changes on the profile of the NF Instance associated to the notification event; it may be present when the notification type is "NF_PROFILE_CHANGED" (see NOTE 1, NOTE 2). | +| conditionEvent | ConditionEventType | C | 0..1 |

Type of event indicating whether a change of NF Profile results in that the NF Instance starts or stops being part of a given set of NF Instances, as indicated in the subscription condition (see attribute "subscrCond" in clause 6.1.6.2.16).

Type of event may also indicate whether a change of NF Profile results in that the NF Instance starts or stops being authorized to be accessed by the NF consumer, as specified in clause 5.2.2.6.2.

It can take the value "NF_ADDED" (if the NF Instance starts being part of a given set or starts being authorized to be accessed by the NF consumer) or "NF_REMOVED" (if the NF Instance stops being part of a given set or stops being authorized to be accessed by the NF consumer).

(NOTE 3)

| +| subscriptionContext | SubscriptionContext | C | 0..1 |

It shall contain data related to the subscription to which this notification belongs to, such as the subscription ID and the subscription conditions.

An NRF complying with this release of the specification shall include this attribute, to facilitate to the subscribing entity the identification of the subscription data, or context, that triggered this notification.

| +| completeNfProfile | NFProfile | C | 0..1 |

Complete new NF Profile or updated NF Profile; it shall be present when the notification type is "NF_REGISTERED" and it may be present when the notification type is "NF_PROFILE_CHANGED".
(NOTE 3)

This IE shall only be present if the NRF supports the "Complete-Profile-Subscription" feature, the "completeProfileSubscription" attribute is present and set to true in the request (see clause 6.1.6.2.16) and if the requesting entity is authorized to subscribe to the complete profile of NF instances.

This IE, if present, should contain the complete set of attributes (including, e.g. the "allowedXXX"

| + +| | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|-------------------------------------------------------| +| | | | | attributes of the NFProfile or NFService data types). | +| NOTE 1: If "event" attribute takes the value "NF_PROFILE_CHANGED", then one and only one of the "nfProfile", "profileChanges" or "completeNfProfile" attributes shall be present. | | | | | +| NOTE 2: The NRF shall notify about NF Profile changes affecting attributes of type "array" only as a complete replacement of the whole array (i.e. it shall not notify about changes of individual array elements). | | | | | +| NOTE 3: When a change in an NF Profile results in an NF to start being part of a given set or an NF Instance starts being authorized to be accessed by the NF consumer, the NRF shall indicate such condition by including the "conditionEvent" attribute with value "NF_ADDED", and it shall include in the notification the "nfProfile" attribute with the full NF Profile of the NF Instance; the "profileChanges" attribute shall not be included. When a change in an NFProfile results in an NF to stop being part of a given set or an NF Instance stops being authorized to be accessed by the NF consumer, the NRF shall indicate such condition by including the "conditionEvent" attribute with value "NF_REMOVED", and it shall include in the notification either the "nfProfile" or the "profileChanges" attribute. The NRF should include the IE with less information if possible. | | | | | + +EXAMPLE: Notification content sent from NRF when an NF Instance has changed its profile by updating the value of the "recoveryTime" attribute of its NF Profile, and updated any attribute of any of its NF Service Instances: + +``` +{ + "event": "NF_PROFILE_CHANGED", + "nfInstanceUri": ".../nf-instances/4947a69a-f61b-4bc1-b9da-47c9c5d14b64", + "profileChanges": [ + { + "op": "REPLACE", + "path": "/recoveryTime", + "newValue": "2018-12-30T23:20:50Z" + }, + { + "op": "REPLACE", + "path": "/nfServices", + "newValue": [ ...new array content... ] + } + ] +} +``` + +6.1.6.2.18 Void + +6.1.6.2.19 Type: NFServiceVersion + +**Table 6.1.6.2.19-1: Definition of type NFServiceVersion** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| apiVersionInUri | string | M | 1 | Version of the service instance to be used in the URI for accessing the API (e.g. "v1"). | +| apiFullVersion | string | M | 1 | Full version number of the API as specified in clause 4.3.1 of 3GPP TS 29.501 [5]. | +| expiry | DateTime | O | 0..1 | Expiry date and time of the NF service. This represents the planned retirement date as specified in clause 4.3.1.5 of 3GPP TS 29.501 [5]. | + +## 6.1.6.2.20 Type: PcflInfo + +Table 6.1.6.2.20-1: Definition of type PcflInfo + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| groupId | NfGroupId | O | 0..1 | Identity of the PCF group that is served by the PCF instance.
If not provided, the PCF instance does not pertain to any PCF group.
(NOTE) | +| dnnList | array(Dnn) | O | 1..N | DNNs supported by the PCF. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile.
If not provided, the PCF can serve any DNN. | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPIs that can be served by the PCF instance.
(NOTE) | +| gpsiRanges | array(IdentityRange) | O | 1..N | List of ranges of GPSIs that can be served by the PCF instance.
(NOTE) | +| rxDiamHost | DiameterIdentity | C | 0..1 | This IE shall be present if the PCF supports Rx interface.

When present, this IE shall indicate the Diameter host of the Rx interface for the PCF. | +| rxDiamRealm | DiameterIdentity | C | 0..1 | This IE shall be present if the PCF supports Rx interface.

When present, this IE shall indicate the Diameter realm of the Rx interface for the PCF. | +| v2xSupportInd | boolean | O | 0..1 | Indicates whether V2X Policy/Parameter provisioning is supported by the PCF.
true: Supported
false (default): Not Supported | +| proseSupportInd | boolean | O | 0..1 | Indicates whether ProSe capability is supported by the PCF.
true: Supported
false (default): Not Supported | +| proseCapability | ProseCapability | C | 0..1 | This IE shall be present if the PCF supports ProSe Capability.

When present, this IE shall indicate the supported ProSe Capability by the PCF. | +| v2xCapability | V2xCapability | C | 0..1 | This IE shall be present if the PCF supports V2X Capability.

When present, this IE shall indicate the supported V2X Capability by the PCF. | +| a2xSupportInd | boolean | O | 0..1 | Indicates whether A2X Policy/Parameter provisioning is supported by the PCF.
true: Supported
false (default): Not Supported | +| a2xCapability | A2xCapability | C | 0..1 | This IE shall be present if the PCF supports A2X Capability.

When present, this IE shall indicate the supported A2X Capability by the PCF. | +| rangingSIPosSupportInd | boolean | O | 0..1 | Indicates whether ranging and sidelink positioning capability is supported by the PCF.
true: Supported
false (default): Not Supported | +| NOTE: | If none of these parameters are provided, the PCF can serve any SUPI or GPSI managed by the PLMN of the PCF instance. If "supiRanges" and "gpsiRanges" attributes are absent, and "groupId" is present, the SUPIs / GPSIs served by this PCF instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). | | | | + +## 6.1.6.2.21 Type: BsflInfo + +Table 6.1.6.2.21-1: Definition of type BsflInfo + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipv4AddressRanges | array(Ipv4AddressRange) | O | 1..N | List of ranges of IPv4 addresses handled by BSF. If not provided, the BSF can serve any IPv4 address. | +| dnnList | array(Dnn) | O | 1..N | List of DNNs handled by the BSF. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. If not provided, the BSF can serve any DNN. | +| ipDomainList | array(string) | O | 1..N | List of IPv4 address domains, as described in clause 6.2 of 3GPP TS 29.513 [28], handled by the BSF. If not provided, the BSF can serve any IP domain. | +| ipv6PrefixRanges | array(Ipv6PrefixRange) | O | 1..N | List of ranges of IPv6 prefixes handled by the BSF. If not provided, the BSF can serve any IPv6 prefix. | +| rxDiamHost | DiameterIdentity | C | 0..1 | This IE shall be present if the BSF supports Rx interface.

When present, this IE shall indicate the Diameter host of the Rx interface for the BSF. | +| rxDiamRealm | DiameterIdentity | C | 0..1 | This IE shall be present if the BSF supports Rx interface.

When present, this IE shall indicate the Diameter realm of the Rx interface for the BSF. | +| groupId | NfGroupId | O | 0..1 | Identity of the BSF group that is served by the BSF instance. If not provided, the BSF instance does not pertain to any BSF group. (NOTE) | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPI's served by the BSF instance (NOTE) | +| gpsiranges | array(IdentityRange) | O | 1..N | List of ranges of GPSIs served by the BSF instance (NOTE) | +| NOTE: If none of these parameters are provided, the BSF can serve any SUPI or GPSI managed by the PLMN of the BSF instance. If "supiRanges" and "gpsiranges" attributes are absent, and "groupId" is present, the SUPIs / GPSIs served by this BSF instance is determined by the NRF. | | | | | + +## 6.1.6.2.22 Type: Ipv4AddressRange + +Table 6.1.6.2.22-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 | + +## 6.1.6.2.23 Type: Ipv6PrefixRange + +Table 6.1.6.2.23-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". + +## 6.1.6.2.24 Type: InterfaceUpflnfoItem + +Table 6.1.6.2.24-1: Definition of type InterfaceUpflnfoItem + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------|---|-------------|-----------------------------------------------------------------------------------| +| interfaceType | UPInterfaceType | M | 1 | User Plane interface type | +| ipv4EndpointAddresses | array(Ipv4Addr) | C | 1..N | Available endpoint IPv4 address(es) of the User Plane interface (NOTE 1) (NOTE 2) | +| ipv6EndpointAddresses | array(Ipv6Addr) | C | 1..N | Available endpoint IPv6 address(es) of the User Plane interface (NOTE 1) (NOTE 2) | +| endpointFqdn | Fqdn | C | 0..1 | FQDN of available endpoint of the User Plane interface (NOTE 1) (NOTE 2) | +| networkInstance | string | O | 0..1 | Network Instance (See 3GPP TS 29.244 [21]) associated to the User Plane interface | + +NOTE 1: At least one of the addressing parameters (ipv4address, ipv6address or endpointFqdn) shall be included in the InterfaceUpflnfoItem. + +NOTE 2: When interfaceType is "DATA\_FORWARDING", the SMF shall ignore these IEs. The UPF shall register a dummy FQDN or IP address for interfaceType "DATA\_FORWARDING" (for backward compatibility reason). + +## 6.1.6.2.25 Type: UriList + +Table 6.1.6.2.25-1: Definition of type UriList + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| _links | map(LinksValueSchema) | O | 1..N | See clause 4.9.4 of 3GPP TS 29.501 [5] for the description of the members.
In this map, the key "item", if present, shall contain an array of objects, where each object contains an "href" attribute containing the URI of the NF Instance.
If the response contains no URIs to return, the "_links" attribute may be absent; if it is included, it shall only contain the "self" key (i.e. the "item" key shall be absent), and the "totalItemCount" attribute shall be set to 0. | +| totalItemCount | integer | C | 0..1 | This attribute should be included in the response and it shall contain the total number of items matching the input filter criteria of the request (e.g. "nf-type"). | + +## 6.1.6.2.26 Type: N2InterfaceAmfInfo + +Table 6.1.6.2.26-1: Definition of type N2InterfaceAmfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------------|---|-------------|---------------------------------------------------------------------| +| ipv4EndpointAddress | array(Ipv4Addr) | C | 1..N | Available AMF endpoint IPv4 address(es) for N2 (see NOTE 1) | +| ipv6EndpointAddress | array(Ipv6Addr) | C | 1..N | Available AMF endpoint IPv6 address(es) for N2 (see NOTE 1) | +| amfName | AmfName | O | 0..1 | AMF Name FQDN as defined in clause 28.3.2.5 of 3GPP TS 23.003 [12]. | + +NOTE 1: At least one of the addressing parameters (ipv4address or ipv6address) shall be included. + +## 6.1.6.2.27 Type: TaiRange + +Table 6.1.6.2.27-1: Definition of type TaiRange + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|------------------------------------------| +| plmnId | PlmnId | M | 1 | PLMN ID related to the TacRange. | +| tacRangeList | array(TacRange) | M | 1..N | The range of the TACs | +| nid | Nid | O | 0..1 | NID related to the TacRange, for an SNPN | + +## 6.1.6.2.28 Type: TacRange + +Table 6.1.6.2.28-1: Definition of type TacRange + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| start | string | O | 0..1 | First value identifying the start of a TAC range, to be used when the range of TAC's can be represented as a hexadecimal range (e.g., TAC ranges). 3-octet string identifying a tracking area code, 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 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.
Pattern: "^[A-Fa-f0-9]{4}[A-Fa-f0-9]{6}\$" | +| end | string | O | 0..1 | Last value identifying the end of a TAC range, to be used when the range of TAC's can be represented as a hexadecimal range (e.g. TAC ranges). 3-octet string identifying a tracking area code, 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 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.
Pattern: "^[A-Fa-f0-9]{4}[A-Fa-f0-9]{6}\$" | +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of TAC's belonging to this range. A TAC value is considered part of the range if and only if the TAC string fully matches the regular expression. | + +NOTE: Either the start and end attributes, or the pattern attribute, shall be present. + +EXAMPLE 1: TAC range. From: 543000 To: 5433E7 (i.e., 1000 TAC numbers) + JSON: { "start": "543000", "end": "5433E7" } + +EXAMPLE 2: TAC range. From: 54E000 To: 54EFFF (i.e., 4096 TAC numbers) + JSON: { "pattern": "^54E[0-9a-fA-F]{3}\$" }, or + JSON: { "start": "54E000", "end": "54EFFF" } + +6.1.6.2.29 Type: SnssaiSmfInfoItem + +**Table 6.1.6.2.29-1: Definition of type SnssaiSmfInfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|-------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | Supported S-NSSAI (NOTE) | +| dnnSmfInfoList | array(DnnSmfInfoItem) | M | 1..N | List of parameters supported by the SMF per DNN | + +NOTE: An SMF may register SD ranges or a wildcard SD if the SMF profile is not discoverable from other PLMNs and if the NRF and all consumers of the SMF profile in the same PLMN have been upgraded to support SD ranges and wildcard SD in this attribute. + +6.1.6.2.30 Type: DnnSmfInfoItem + +**Table 6.1.6.2.30-1: Definition of type DnnSmfInfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Supported DNN (NOTE) or Wildcard DNN if the SMF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. | +| dnaiList | array(Dnai) | O | 1..N | List of DNAIs or Wildcard DNAI supported by the SMF for this DNN.
(See NOTE 2) | + +NOTE 1: For a SMF which only supports the I-SMF related functionalities, the dnn attribute may be an invalid DNN according to operator's local policy. + +NOTE 2: The Wildcard DNAI included in the "dnaiList" attribute indicates that the SMF can be selected for this DNN for any DNAI. The absence of "dnaiList" attribute does not mean that the SMF (e.g. pre-Rel-17 compliant) does not support any DNAI, but the SMF did not indicate which DNAIs it may support. + +6.1.6.2.31 Type: NrflInfo + +**Table 6.1.6.2.31-1: Definition of type NrflInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servedUdrInfo | map(UdrInfo) | O | 1..N | This attribute contains all the udrInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the udrInfo belongs to. | +| servedUdrInfoList | map(map(UdrInfo)) | O | 1..N(1..M) | This attribute contains the udrInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedUdmInfo | map(UdmInfo) | O | 1..N | This attribute contains all the udmInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the udmInfo belongs to. | +| servedUdmInfoList | map(map(UdmInfo)) | O | 1..N(1..M) | This attribute contains the udmInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedAusfInfo | map(AusfInfo) | O | 1..N | This attribute contains all the ausfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the ausfInfo belongs to. | +| servedAusfInfoList | map(map(AusfInfo)) | O | 1..N(1..M) | This attribute contains the ausfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedAmfInfo | map(AmfInfo) | O | 1..N | This attribute contains all the amfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the amfInfo belongs to. | +| servedAmfInfoList | map(map(AmfInfo)) | O | 1..N(1..M) | This attribute contains the amfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedSmfInfo | map(SmfInfo) | O | 1..N | This attribute contains all the smfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the smfInfo belongs to. | +| servedSmfInfoList | map(map(SmfInfo)) | O | 1..N(1..M) | This attribute contains the smfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedUpfInfo | map(UpfInfo) | O | 1..N | This attribute contains all the upfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the upfInfo belongs to. | +| servedUpfInfoList | map(map(UpfInfo)) | O | 1..N(1..M) | This attribute contains the upfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedPcfInfo | map(PcfInfo) | O | 1..N | This attribute contains all the pcfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the pcfInfo belongs to. | +| servedPcfInfoList | map(map(PcfInfo)) | O | 1..N(1..M) | This attribute contains the pcfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnstanceId to which the map entry belongs to. | +| servedBsfInfo | map(BsfInfo) | O | 1..N | This attribute contains all the bsfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnstanceId of which the bsfInfo belongs to. | +| servedBsfInfoList | map(map(BsfInfo)) | O | 1..N(1..M) | This attribute contains the bsfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the | + +| | | | | | +|--|--|--|--|-------------------------------------------------| +| | | | | nfInstanceId to which the map entry belongs to. | +|--|--|--|--|-------------------------------------------------| + +| | | | | | +|--------------------|--------------------|---|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servedChfInfo | map(ChfInfo) | O | 1..N | This attribute contains all the chfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of which the chfInfo belongs to. | +| servedChfInfoList | map(map(ChfInfo)) | O | 1..N(1..M) | This attribute contains the chfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| servedNefInfo | map(NefInfo) | O | 1..N | This attribute contains all the nefInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of which the nefInfo belongs to. | +| servedNwdaInfo | map(NwdaInfo) | O | 1..N | This attribute contains all the nwdaInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of which the nwdaInfo belongs to. | +| servedNwdaInfoList | map(map(NwdaInfo)) | O | 1..N | This attribute contains all the nwdaInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| servedPscfInfoList | map(map(PscfInfo)) | O | 1..N(1..M) | This attribute contains all the pscfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| servedGmlcInfo | map(GmlcInfo) | O | 1..N | This attribute contains all the gmlcInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of which the gmlcInfo belongs to. | +| servedLmfInfo | map(LmfInfo) | O | 1..N | This attribute contains all the lmfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of which the lmfInfo belongs to. | +| servedNfInfo | map(NfInfo) | O | 1..N | This attribute contains information of other NFs without corresponding NF type specific Info extensions locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of the NF. | +| servedHssInfoList | map(map(HssInfo)) | O | 1..N(1..M) | This attribute contains all the hssInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| servedUdsfInfo | map(UdsfInfo) | O | 1..N | This attribute contains all the udsfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| servedUdsfInfoList | map(map(UdsfInfo)) | O | 1..N(1..M) | This attribute contains the udsfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| servedScpInfoList | map(ScpInfo) | O | 1..N | This attribute contains the scpInfo attribute locally configured in the NRF or that the NRF received during SCP registration. The key of the map is the nfnInstanceid to which the scpInfo belongs to. | +| servedSeppInfoList | map(SeppInfo) | O | 1..N | This attribute contains the seppInfo attribute locally configured in the NRF or that the NRF received during SEPP registration. The key of the map is the nfnInstanceid to which the seppInfo belongs to. | +| servedAanfInfoList | map(map(AanfInfo)) | O | 1..N(1..M) | This attribute contains the aanfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnInstanceid to which the map entry belongs to. | +| served5GDnmfInfo | map(5GDnmfInfo) | O | 1..N | This attribute contains all the 5GDnmfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceid of which the 5GDnmfInfo belongs to. | +| servedMfaInfoList | map(MfaInfo) | O | 1..N | This attribute contains the mfaInfo attribute locally | + +| | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | configured in the NRF or that the NRF received during MFAF registration. The key of the map is the nfnInstanceId to which the mfaflnfo belongs to. | +| servedEasdflnfoList | map(map(Easdflnfo)) | O | 1..N(1..M) | This attribute contains the easdflnfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnInstanceId to which the map entry belongs to. | +| servedDccflnfoList | map(Dccflnfo) | O | 1..N | This attribute contains the dccflnfo attribute locally configured in the NRF or that the NRF received during DCCF registration. The key of the map is the nfnInstanceId to which the dccflnfo belongs to. | +| servedMbSmflnfoList | map(map(MbSmflnfo)) | O | 1..N(1..M) | This attribute contains the mbSmflnfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnInstanceId to which the map entry belongs to. | +| servedTsctslfnfoList | map(map(Tsctslfnfo)) | O | 1..N(1..M) | This attribute contains the tsctslfnfoList attribute locally configured in the NRF or that the NRF received during TSCTSF registration. The key of the map is the nfnInstanceId to which the map entry belongs to. | +| servedMbUpflnfoList | map(map(MbUpflnfo)) | O | 1..N(1..M) | This attribute contains the mbUpflnfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfnInstanceId to which the map entry belongs to. | +| servedTrustAflnfo | map(TrustAflnfo) | O | 1..N | This attribute contains the trustAflnfo attribute locally configured in the NRF or that the NRF received during AF registration. The key of the map is the nfnInstanceId to which the map entry belongs to. | +| servedNssaaflnfo | map(Nssaaflnfo) | O | 1..N | This attribute contains all the nssaaflnfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfnInstanceId of which the nssaaflnfo belongs to. | +| NOTE 1: The absence of these parameters means the NRF is able to serve any NF discovery request.
NOTE 2: For any of the servedxxxInfo/servedxxxInfoList attributes (other than servedNflnfo), if the data type definition of the corresponding xxxInfo attribute allows to use an empty JSON object, the registering NRF shall include in the servedxxxInfo/servedxxxInfoList a map entry with an empty JSON object as value, to indicate the registration of an NF Instance that did not include any xxxInfo/xxxInfoList attributes; otherwise, the registering NRF shall check the support of the feature "Empty-Objects-Nrf-Info" (see clause 6.1.9) in the target NRF and, if the feature is not supported, it shall use the generic servedNflnfo attribute (instead of the servedxxxInfo corresponding to its NF type) to signal the registration of such NF instance with absent xxxInfo/xxxInfoList attributes. | | | | | + +## 6.1.6.2.32 Type: ChfInfo + +Table 6.1.6.2.32-1: Definition of type ChfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supiRangeList | array(SupiRange) | O | 1..N | List of ranges of SUPIs that can be served by the CHF instance.
(NOTE 1) | +| gpsiRangeList | array(IdentityRange) | O | 1..N | List of ranges of GPSI that can be served by the CHF instance.
(NOTE 1) | +| plmnRangeList | array(PlmnRange) | O | 1..N | List of ranges of PLMNs (including the PLMN IDs of the CHF instance) that can be served by the CHF instance. If not provided, the CHF can serve any PLMN. | +| groupId | NfGroupId | O | 0..1 | Identity of the CHF group that is served by the CHF instance.
If not provided, the CHF instance does not pertain to any CHF group.
(NOTE 1) | +| primaryChfInstance | NfInstanceId | C | 0..1 | This IE shall be present if the CHF instance serves as a secondary CHF instance of another primary CHF instance. When present, it shall be set to the NF Instance Id of the primary CHF instance.

This IE shall be absent if the secondaryChfInstance is present.
(NOTE 2, NOTE 3) | +| secondaryChfInstance | NfInstanceId | C | 0..1 | This IE shall be present if the CHF instance serves as a primary CHF instance of another secondary CHF instance. When present, it shall be set to the NF Instance Id of the secondary CHF instance.

This IE shall be absent if the primaryChfInstance is present.
(NOTE 2, NOTE 3) | + +NOTE 1: If none of these parameters are provided, the CHF can serve any SUPI or GPSI managed by the PLMN of the CHF instance. If "supiRangeList" and "gpsiRangeList" attributes are absent, and "groupId" is present, the SUPIs / GPSIs served by this CHF instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). + +NOTE 2: The NF Service Consumer of the CHF may use these attributes as primary/secondary redundancy mechanism, or alternatively, it may also rely on the availability of an NF Set (or NF Service Set) of CHF Instances (or CHF Service Instances) for the same purpose. + +NOTE 3: If the CHF does not provide NF set ID or NF Service Set ID in NFProfile, it shall provide one of these attributes. These attributes may be present if the CHF registers an NF set ID or NF service set ID. + +6.1.6.2.33 Void + +6.1.6.2.34 Type: PlmnRange + +**Table 6.1.6.2.34-1: Definition of type PlmnRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| start | string | O | 0..1 | First value identifying the start of a PLMN range. The string shall be encoded as follows:


Pattern: '[0-9]{3}[0-9]{2,3}\$' | +| end | string | O | 0..1 | Last value identifying the end of a PLMN range. The string shall be encoded as follows:


Pattern: '[0-9]{3}[0-9]{2,3}\$' | +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of PLMNs belonging to this range. A PLMN value is considered part of the range if and only if the PLMN string (formatted as ) fully matches the regular expression. | + +NOTE: Either the start and end attributes, or the pattern attribute, shall be present. + +EXAMPLE 1: PLMN range. MCC 123, any MNC + +JSON: { "start": "12300", "end": "123999" } + +EXAMPLE 2: PLMN range. MCC 123, MNC within range 45 to 49 + +JSON: { "pattern": "^1234[5-9]\$" }, or + +JSON: { "start": "12345", "end": "12349" } + +EXAMPLE 3: PLMN range. MCC within range 123 to 257, any MNC + +JSON: { "start": "12300", "end": "257999" } + +## 6.1.6.2.35 Type: SubscrCond + +**Table 6.1.6.2.35-1: Definition of type SubscrCond as a list of mutually exclusive alternatives** + +| Data type | Cardinality | Description | +|----------------------|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NfInstanceIdCond | 1 | Subscription to a given NF Instance | +| NfInstanceIdListCond | 1 | Subscription to a list of NF Instances | +| NfTypeCond | 1 | Subscription to a set of NF Instances, identified by their NF Type | +| ServiceNameCond | 1 | Subscription to a set of NF Instances that offer a certain service name | +| ServiceNameListCond | 1 | Subscription to a set of NF Instances that offer a service name in the Service Name list. | +| AmfCond | 1 | Subscription to a set of NF Instances (AMFs), belonging to a certain AMF Set and/or belonging to a certain AMF Region. | +| GuamiListCond | 1 | Subscription to a set of NF Instances (AMFs) identified by their Guamis (i.e. whose guamiList IE in the amfInfo or amfInfoList IE matches at least one of the GUAMI in the guamiList IE of the subscription). | +| NetworkSliceCond | 1 | Subscription to a set of NF Instances, identified by S-NSSAI(s) and NSI ID(s). | +| NfGroupCond | 1 | Subscription to a set of NF Instances, identified by a NF (UDM, AUSF, PCF, CHF, HSS or UDR) Group Identity. | +| NfGroupListCond | 1 | Subscription to a set of NF Instances, identified by a NF Group Identity in the NF Group Identity list. | +| NfSetCond | 1 | Subscription to a set of NF Instances belonging to a certain NF Set. | +| NfServiceSetCond | 1 | Subscription to a set of NF Service Instances, or to a set of equivalent NF Service Instances. | +| UpfCond | 1 | Subscription to a set of NF Instances (UPFs), able to serve a certain service area (i.e. SMF serving area or TAI list). | +| ScpDomainCond | 1 | Subscription to a set of NF, SCP or SEPP instances belonging to certain SCP domains. | +| NwdafCond | 1 | Subscription to a set of NF Instances (NWDAFs), identified by Analytics ID(s), S-NSSAI(s) or NWDAF Serving Area information, i.e. list of TAIs for which the NWDAF can provide analytics. | +| NefCond | 1 | Subscription to a set of NF Instances (NEFs), identified by Event ID(s) provided by AF, S-NSSAI(s), AF Instance ID, Application Identifier, External Identifier, External Group Identifier, or domain name. | +| DccfCond | 1 | Subscription to a set of NF Instances (DCCFs), identified by NF types, NF Set Id(s) or DCCF Serving Area information, i.e. list of TAIs served by the DCCF. | + +## 6.1.6.2.36 Type: NfInstanceIdCond + +**Table 6.1.6.2.36-1: Definition of type NfInstanceIdCond** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|------------------------------------------------------------------------------| +| nfInstanceId | NfInstanceId | M | 1 | NF Instance ID of the NF Instance whose status is requested to be monitored. | + +## 6.1.6.2.37 Type: NfTypeCond + +Table 6.1.6.2.37-1: Definition of type NfTypeCond + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------|-----------|---|-------------|------------------------------------------------------------------------| +| nfType | NfType | M | 1 | NF type of the NF Instances whose status is requested to be monitored. | +| NOTE: This type shall not contain the attribute "nfGroupId", to avoid that this type has a matching definition with "NfGroupCond" type. | | | | | + +## 6.1.6.2.38 Type: ServiceNameCond + +Table 6.1.6.2.38-1: Definition of type ServiceNameCond + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|-------------------------------------------------------------------------------------| +| serviceName | ServiceName | M | 1 | Service name offered by the NF Instances whose status is requested to be monitored. | + +## 6.1.6.2.39 Type: AmfCond + +Table 6.1.6.2.39-1: Definition of type AmfCond + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|---|-------------|------------------------------------------------------------------------------------| +| amfSetId | AmfSetId | C | 1 | AMF Set ID of the NF Instances (AMF) whose status is requested to be monitored. | +| amfRegionId | AmfRegionId | C | 1 | AMF Region ID of the NF Instances (AMF) whose status is requested to be monitored. | +| NOTE 1: At least amfSetId or amfRegionId shall be present; if both the amfRegionId and amfSetId attributes are present in the SubscriptionData, this indicates a subscription for notifications satisfying both attributes (i.e. notifications for NFs from that amfRegionId and amfSetId). | | | | | +| NOTE 2: The PLMN ID (or PLMN ID and NID) of the AMF Region and AMF Set of the NF Instances (AMF) whose status is requested to be monitored may be indicated in the plmnId attribute (or plmnId and nid attributes) in the SubscriptionData. | | | | | + +## 6.1.6.2.40 Type: GuamiListCond + +Table 6.1.6.2.40-1: Definition of type GuamiListCond + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| guamiList | array(Guami) | M | 1..N | Guamis of the NF Instances (AMFs) whose status is requested to be monitored (i.e. whose guamiList IE in the amfInfo or amfInfoList IE matches at least one of the GUAMI in the guamiList IE of the subscription). | + +## 6.1.6.2.41 Type: NetworkSliceCond + +Table 6.1.6.2.41-1: Definition of type NetworkSliceCond + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------| +| snssaiList | array(SNSSAI) | M | 1..N | S -NSSAIs of the NF Instances whose status is requested to be monitored. | +| nsiList | array(string) | O | 1..N | NSI IDs of the NF Instances whose status is requested to be monitored. | + +## 6.1.6.2.42 Type: NfGroupCond + +**Table 6.1.6.2.42-1: Definition of type NfGroupCond** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------| +| nfType | string | M | 1 | NF type (UDM, AUSF, PCF, UDR, HSS or CHF) of the NF Instances whose status is requested to be monitored. | +| nfGroupId | NfGroupId | M | 1 | Group ID of the NF Instances whose status is requested to be monitored. | + +## 6.1.6.2.43 Type: NotifCondition + +**Table 6.1.6.2.43-1: Definition of type NotifCondition** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| monitoredAttributes | array(string) | C | 1..N | List of JSON Pointers (as specified in IETF RFC 6901 [14]) of attributes in the NF Profile.

If this attribute is present, the NRF shall send notification only for changes in the attributes included in this list (see NOTE 1). | +| unmonitoredAttributes | array(string) | C | 1..N | List of JSON Pointers (as specified in IETF RFC 6901 [14]) of attributes in the NF Profile.

If this attribute is present, the NRF shall send notification for changes on any attribute, except for those included in this list (see NOTE 1). | + +NOTE 1: Attributes "monitoredAttributes" and "unmonitoredAttributes" shall not be included simultaneously + +EXAMPLE 1: The following JSON object would represent a monitoring condition where the client requests to be notified of all changes on the NF Profile, except "load" attribute. + +``` +{ + "unmonitoredAttributes": [ "/load" ] +} +``` + +EXAMPLE 2: The following JSON object would represent a monitoring condition where the client requests to be notified only of changes on attribute "nfStatus": + +``` +{ + "monitoredAttributes": [ "/nfStatus" ] +} +``` + +EXAMPLE 3: The following JSON object would represent a monitoring condition where the client requests to be notified only of changes on the first item of "nfServices": + +``` +{ + "monitoredAttributes": [ "/nfServices/0" ] +} +``` + +## 6.1.6.2.44 Type: PlmnSnssai + +**Table 6.1.6.2.44-1: Definition of type PlmnSnssai** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|--------------------------------------------------------------------| +| plmnId | PlmnId | M | 1 | PLMN ID for which list of supported S-NSSAI(s) is provided. | +| sNssaiList | array(ExtSnssai) | M | 1..N | The specific list of S-NSSAIs supported by the given PLMN or SNPN. | +| nid | Nid | O | 0..1 | NID for which list of supported S-NSSAI(s) is provided. | + +## 6.1.6.2.45 Type: NwdaInfo + +**Table 6.1.6.2.45-1: Definition of type NwdaInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| eventIds | array(EventId) | C | 1..N | EventId(s) supported by the Nnwdaf_AnalyticsInfo service, if none are provided the NWDAF can serve any eventId. | +| nwdafEvents | array(NwdafEvent) | C | 1..N | Event(s) supported by the Nnwdaf_EventsSubscription service, if none are provided the NWDAF can serve any nwdafEvent. | +| taiList | array(Tai) | O | 1..N | The list of TAIs the NWDAF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the NWDAF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the NWDAF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the taiList attribute indicate that the NWDAF can be selected for any TAI in the serving network. | +| nwdafCapability | NwdafCapability | O | 0..1 | If present, this IE shall indicate the capability of the NWDAF.
If not present, the NWDAF shall be regarded with no capability. | +| analyticsDelay | DurationSec | O | 0..1 | Supported Analytics Delay related to the eventIds and nwdafEvents. | +| servingNfTypeList | array(NFType) | O | 1..N | If present, this IE shall contain the list of NF type(s) from which the NWDAF NF can collect data. The absence of this attribute indicates that the NWDAF can collect data from any NF type. | +| servingNfSetIdList | array(NfSetId) | O | 1..N | If present, this IE shall contain the list of NF Set Id(s) from which the NWDAF NF can collect data. The absence of this attribute indicates that the NWDAF can collect data from any NF Set. | +| mlAnalyticsList | array(MlAnalyticsInfo) | C | 1..N | ML Analytics Filter information supported by the Nnwdaf_MLModelProvision service. | + +6.1.6.2.46 Type: LmflInfo + +**Table 6.1.6.2.46-1: Definition of type LmflInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servingClientTypes | array(ExternalClientType) | C | 1..N | This IE shall be present if the LMF is dedicated to serve the listed external client type(s), e.g. emergency client. The NRF should only include this LMF instance to NF discovery with "client-type" query parameter indicating one of the external client types in the list.

Absence of this IE means the LMF is not dedicated to serve specific client types. | +| lmfId | LMFIdentification | C | 0..1 | When present, this ID shall indicate the LMF identification. | +| servingAccessTypes | array(AccessType) | C | 1..N | If included, this IE shall contain the access type (i.e. 3GPP_ACCESS and/or NON_3GPP_ACCESS) supported by the LMF.

If not included, it shall be assumed that all access types are supported. | +| servingAnNodeTypes | array(AnNodeType) | C | 1..N | If included, this IE shall contain the AN node type (i.e. gNB or NG-eNB) supported by the LMF.

If not included, it shall be assumed that all AN node types are supported. | +| servingRatTypes | array(RatType) | C | 1..N | If included, this IE shall contain the RAT type (e.g. 5G NR, eLTE or any of the RAT Types specified for NR satellite access) supported by the LMF.

If not included, it shall be assumed that all RAT types are supported. | +| tailList | array(Tai) | O | 1..N | When present, this IE shall contain TAI list that the LMF can serve. It may contain one or more non-3GPP access TAIs.
The absence of both this attribute and the taiRangeList attribute indicates that the LMF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | When present, this IE shall contain TAI range list that the LMF can serve. It may contain one or more non-3GPP access TAI ranges. The absence of both this attribute and the tailList attribute indicates that the LMF can be selected for any TAI in the serving network. | +| supportedGADShapes | array(SupportedGADShapes) | O | 1..N | If included, this IE shall contain the GAD shapes supported by the LMF.

If not included, it doesn't indicate that the LMF doesn't support any GAD shapes. | +| pruExistenceInfo | PruExistenceInfo | O | 0..1 | When present, this IE shall contain the PRU Existence Information. | +| pruSupportInd | boolean | O | 0..1 | This IE may be used by the LMF to indicate the support of PRU function.

When the IE is present and set to true, it indicates that the PRU function is supported by the LMF.

If the IE is not present or set to false (default), it indicates that the PRU function is not supported by the LMF. | +| rangingslposSupportInd | boolean | O | 0..1 | When present, this ID shall indicate whether ranging and sidelink positioning capability is supported by the LMF.
true: Supported
false (default): Not Supported | +| upPositioningInd | boolean | O | 0..1 | When present, this IE shall indicate whether user plane positioning capability is supported by the LMF.
true: Supported
false (default): Not Supported | + +## 6.1.6.2.47 Type: GmlcInfo + +**Table 6.1.6.2.47-1: Definition of type GmlcInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servingClientTypes | array(ExternalClientType) | C | 1..N |

This IE shall be present if the GMLC is dedicated to serve the listed external client type(s), e.g. emergency client. The NRF should only include this GMLC instance to NF discovery with "client-type" query parameter indicating one of the external client types in the list.

Absence of this IE means the GMLC is not dedicated to serve specific client types.

| +| gmlcNumbers | array(string) | O | 1..N |

This IE shall be present if the GMLC is configured with a number of GMLC Numbers. When present, each item of the array shall carry an OctetString indicating the ISDN number of the GMLC in international number format as described in ITU-T Rec. E.164 [44] and shall be encoded as a TBCD-string.

Pattern for each item of the array: "[0-9]{5,15}\$"

| + +## 6.1.6.2.48 Type: NefInfo + +Table 6.1.6.2.48-1: Definition of type NefInfo + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nefId | NefId | C | 0..1 | This IE shall be present and contain the NEF ID of the NEF if NIDD service is supported. | +| pfdData | PfdData | O | 0..1 | PFD data, containing the list of internal application identifiers and/or the list of application function identifiers for which the PFDs can be provided.

Absence of this attribute indicates that the PFDs for any internal application identifier and for any application function identifier can be provided. | +| afEeData | AfEventExposure Data | O | 0..1 | The AF provided event exposure data. The NEF registers such information in the NRF on behalf of the AF. | +| gpsiRanges | array(IdentityRange) | O | 1..N | Range(s) of External Identifiers | +| externalGroupIdentifiers Ranges | array(IdentityRange) | O | 1..N | Range(s) of External Group Identifiers | +| servedFqdnList | array(string) | O | 1..N | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the Domain names served by the NEF | +| tailList | array(Tai) | O | 1..N | The list of TAIs the NEF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicates that the NEF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the NEF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the tailList attribute indicates that the NEF can be selected for any TAI in the serving network. | +| dnaiList | array(Dnai) | O | 1..N | List of Data network access identifiers supported by the NEF. The absence of this attribute indicates that the NEF can be selected for any DNAI. | +| unTrustAflInfoList | array(UnTrustAflInfo) | O | 1..N | List of information corresponding to the AFs. | +| uasNfFunctionalityInd | boolean | O | 0..1 | When present, this IE shall indicate whether the NEF supports UAS NF functionality:

- true: UAS NF functionality is supported by the NEF
- false (default): UAS NF functionality is not supported by the NEF. | +| multiMemAfSessQosInd | boolean | O | 0..1 | When present, this IE shall indicate whether the NEF supports Multi-member AF session with required QoS functionality:

- true: Multi-member AF session with required QoS functionality is supported by the NEF
- false (default): Multi-member AF session with required QoS functionality is not supported by the NEF. | +| memberUESelAssistInd | boolean | O | 0..1 | When present, this IE shall indicate whether the NEF supports member UE selection assistance functionality:

- true: member UE selection assistance functionality is supported by the NEF
- false (default): member UE selection assistance functionality is not supported by the NEF. | + +## 6.1.6.2.49 Type: PfdData + +Table 6.1.6.2.49-1: Definition of type PfdData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|---------------------------------------------------------------| +| appIds | array(string) | O | 1..N | List of internal application identifiers of the managed PFDs. | +| afIds | array(string) | O | 1..N | List of application function identifiers of the managed PFDs. | + +## 6.1.6.2.50 Type: AfEventExposureData + +Table 6.1.6.2.50-1: Definition of type AfEventExposureData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| afEvents | array(AfEvent) | M | 1..N | AF Event(s) exposed by the NEF after registration of the AF(s) at the NEF. | +| afIds | array(string) | O | 1..N | Associated AF identifications to the AfEvents. The absence of this attribute indicate that the NEF can be selected for any AF.
If present the ordered list of afIds shall contain as many elements as the ordered list of afEvents, where the ordering determines the association between afId and AfEvent. | +| appIds | array(string) | O | 1..N | The list of Application ID(s) the AF(s) connected to the NEF supports. The absence of this attribute indicate that the NEF can be selected for any Application.
If present the ordered list of appIds shall contain as many elements as the ordered list of afEvents, where the ordering determines the association between appId and AfEvent. | +| tailList | array(Tai) | O | 1..N | This IE may be present if the AfEvent is set to "GNSS_ASSISTANCE_DATA".
When present, this IE shall contain the list of TAIs the trusted AF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the trusted AF can be selected for any TAI in the serving network. | +| tailRangeList | array(TaiRange) | O | 1..N | This IE may be present if the AfEvent is set to "GNSS_ASSISTANCE_DATA".
When present, this IE shall contain the range of TAIs the trusted AF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the tailList attribute indicate that the trusted AF can be selected for any TAI in the serving network. | + +## 6.1.6.2.51 Type: WAgfInfo + +Table 6.1.6.2.51-1: Definition of type WAgfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------|---|-------------|----------------------------------------------------------------------| +| ipv4EndpointAddresses | array(Ipv4Addr) | C | 1..N | Available endpoint IPv4 address(es) of the N3 terminations (NOTE 1). | +| ipv6EndpointAddresses | array(Ipv6Addr) | C | 1..N | Available endpoint IPv6 address(es) of the N3 terminations (NOTE 1). | +| endpointFqdn | Fqdn | C | 0..1 | Available endpoint FQDN of the N3 terminations (NOTE 1). | + +NOTE 1: At least one of the addressing parameters (ipv4address, ipv6adress or endpointFqdn) shall be included in the WAgfInfo. + +## 6.1.6.2.52 Type: TngfInfo + +Table 6.1.6.2.52-1: Definition of type TngfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------|---|-------------|----------------------------------------------------------------------| +| ipv4EndpointAddresses | array(Ipv4Addr) | C | 1..N | Available endpoint IPv4 address(es) of the N3 terminations (NOTE 1). | +| ipv6EndpointAddresses | array(Ipv6Addr) | C | 1..N | Available endpoint IPv6 address(es) of the N3 terminations (NOTE 1). | +| endpointFqdn | Fqdn | C | 0..1 | Available endpoint FQDN of the N3 terminations (NOTE 1). | + +NOTE 1: At least one of the addressing parameters (ipv4address, ipv6address or endpointFqdn) shall be included in the TngfInfo. + +## 6.1.6.2.53 Type: PscfInfo + +Table 6.1.6.2.53-1: Definition of type PscfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| accessType | array(AccessType) | C | 1..N | If included, this IE shall contain the access type (3GPP_ACCESS and/or NON_3GPP_ACCESS) supported by the P-CSCF.
If not included, it shall be assumed that all access types are supported. | +| dnnList | array(Dnn) | O | 1..N | DNNs supported by the P-CSCF. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile.
If not provided, the P-CSCF can serve any DNN. | +| gmFqdn | Fqdn | O | 0..1 | FQDN of the P-CSCF for the Gm interface | +| gmlpv4Addresses | array(Ipv4Addr) | O | 1..N | IPv4 address(es) of the P-CSCF for the Gm interface | +| gmlpv6Addresses | array(Ipv6Addr) | O | 1..N | IPv6 address(es) of the P-CSCF for the Gm interface | +| mwFqdn | Fqdn | O | 0..1 | FQDN of the P-CSCF for the Mw interface (NOTE) | +| mwlpv4Addresses | array(Ipv4Addr) | O | 1..N | IPv4 address(es) of the P-CSCF for the Mw interface (NOTE) | +| mwlpv6Addresses | array(Ipv6Addr) | O | 1..N | IPv6 address(es) of the P-CSCF for the Mw interface (NOTE) | +| servedIpv4AddressRanges | array(Ipv4AddressRange) | O | 1..N | List of ranges of UE IPv4 addresses used on the Gm interface, served by P-CSCF.
The absence of this attribute does not mean the P-CSCF can serve any IPv4 address. | +| servedIpv6PrefixRanges | array(Ipv6PrefixRange) | O | 1..N | List of ranges of UE IPv6 prefixes used on the Gm interface, served by P-CSCF.
The absence of this attribute does not mean the P-CSCF can serve any IPv6 prefix. | + +NOTE: The Mw addressing information of the P-CSCF may be used by other NFs (e.g., SMF) in P-CSCF restoration scenarios (see 3GPP TS 23.380 [45], clause 5.8.4.2 and clause 5.8.5.2), where a mapping between Gm and Mw addresses may be used to determine the updated list of P-CSCFs to be sent to the UE, after excluding those P-CSCF instances that have been deemed as failed by the S-CSCF. + +## 6.1.6.2.54 Type: NfSetCond + +**Table 6.1.6.2.54-1: Definition of type NfSetCond** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------| +| nfSetId | NfSetId | M | 1 | NF Set ID (see clause 28.12 of 3GPP TS 23.003 [12]) of NF Instances whose status is requested to be monitored. | + +## 6.1.6.2.55 Type: NfServiceSetCond + +**Table 6.1.6.2.55-1: Definition of type NfServiceSetCond** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nfServiceSetId | NfServiceSetId | M | 1 | NF Service Set ID (see clause 28.13 of 3GPP TS 23.003 [12]) of NF service instances whose status is requested to be monitored. | +| nfSetId | NfSetId | C | 0..1 | NF Set ID (see clause 28.12 of 3GPP TS 23.003 [12]).

This attribute shall be included if the consumer requests to monitor the status of all equivalent NF Service Instances in the provided NF Set ID and NF Service Set ID. | + +## 6.1.6.2.56 Type: NfInfo + +**Table 6.1.6.2.56-1: Definition of type NfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------| +| nfType | NFType | M | 1 | This IE shall indicate the type of the NF. | + +## 6.1.6.2.57 Type: HssInfo + +Table 6.1.6.2.57-1: Definition of type HssInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------|-----------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| groupId | NfGroupId | O | 0..1 | Identity of the HSS group that is served by the HSS instance.
If not provided, the HSS instance does not pertain to any HSS group.
(NOTE 1) | +| imsiRanges | array(ImsiRange) | O | 1..N | List of ranges of IMSIs whose profile data is available in the HSS instance (NOTE 1) | +| imsPrivateIdentityRanges | array(IdentityRange) | O | 1..N | List of ranges of IMS Private Identities whose profile data is available in the HSS instance (NOTE 1, NOTE 2) | +| imsPublicIdentityRanges | array(IdentityRange) | O | 1..N | List of ranges of IMS Public Identities whose profile data is available in the HSS instance (NOTE 1) | +| msisdnRanges | array(IdentityRange) | O | 1..N | List of ranges of MSISDNs whose profile data is available in the HSS instance (NOTE 1) | +| externalGroupIdentifiersRanges | array(IdentityRange) | O | 1..N | List of ranges of external group IDs that can be served by this HSS instance.
If not provided, the HSS instance does not serve any external groups. | +| hssDiameterAddress | NetworkNodeDiameterAddress | O | 0..1 | Diameter Address of the HSS | +| additionalDiamAddresses | array(NetworkNodeDiameterAddress) | O | 1..N | Additional Diameter Addresses of the HSS; may be present if hssDiameterAddress is present | + +NOTE 1: If none of these parameters are provided, the HSS can serve any IMSI or IMS Private Identity or IMS Public Identity or MSISDN managed by the PLMN of the HSS instance. If "imsiRanges", "imsPrivateIdentityRanges", "imsPublicIdentityRanges" and "msisdnRanges" attributes are absent, and "groupId" is present, the IMSIs / IMS Private Identities / IMS Public Identities / MSISDNs served by this HSS instance is determined by the NRF. + +NOTE 2: In deployments where the users IMPIs are derived from their IMSIs (see 3GPP TS 23.003 [12], clause 13.3, the HSS shall only register imsiRanges in NRF. + +## 6.1.6.2.58 Type: ImsiRange + +Table 6.1.6.2.58-1: Definition of type ImsiRange + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| start | string | O | 0..1 | First value identifying the start of a IMSI range.
Pattern: "^[0-9]+\$" | +| end | string | O | 0..1 | Last value identifying the end of a IMSI range.
Pattern: "^[0-9]+\$" | +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of IMSIs belonging to this range. An IMSI value is considered part of the range if and only if the IMSI string fully matches the regular expression. | + +NOTE: Either the start and end attributes, or the pattern attribute, shall be present. + +## 6.1.6.2.59 Type: InternalGroupIdRange + +**Table 6.1.6.2.59-1: Definition of type InternalGroupIdRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| start | GroupId | O | 0..1 | First value identifying the start of an identity range, to be used when the range of identities can be represented as a consecutive numeric range. | +| end | GroupId | O | 0..1 | Last value identifying the end of an identity range, to be used when the range of identities can be represented as a consecutive numeric range. | +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of identities belonging to this range. An identity value is considered part of the range if and only if the identity string fully matches the regular expression. | + +NOTE: Either the start and end attributes, or the pattern attribute, shall be present. + +## 6.1.6.2.60 Type: UpfCond + +**Table 6.1.6.2.60-1: Definition of type UpfCond** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | string | M | 1 | This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive.
In this data type, it shall take the value "UPF_COND". | +| smfServingArea | array(string) | C | 1..N | SMF service area(s) of the UPF whose status is requested to be monitored.
This IE shall be present if the monitored granularity is SMF service area(s). | +| taiList | array(Tai) | C | 1..N | TAI(s) of the UPF whose status is requested to be monitored.
This IE shall be present if the monitored granularity is TAI list. | + +## 6.1.6.2.61 Type: TwifiInfo + +**Table 6.1.6.2.61-1: Definition of type TwifiInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------|---|-------------|---------------------------------------------------------------------| +| ipv4EndpointAddresses | array(Ipv4Addr) | C | 1..N | Available endpoint IPv4 address(es) of the N3 terminations (NOTE 1) | +| ipv6EndpointAddresses | array(Ipv6Addr) | C | 1..N | Available endpoint IPv6 address(es) of the N3 terminations (NOTE 1) | +| endpointFqdn | Fqdn | C | 0..1 | Available endpoint FQDN of the N3 terminations (NOTE 1) | + +NOTE 1: At least one of the addressing parameters (ipv4address, ipv6address or endpointFqdn) shall be included in the TwifiInfo. + +## 6.1.6.2.62 Type: VendorSpecificFeature + +**Table 6.1.6.2.62-1: Definition of type VendorSpecificFeature** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| featureName | string | M | 1 | String representing a proprietary feature specific to a given vendor.

It is recommended that the case convention for these strings is the same as for enumerated data types (i.e. UPPER_WITH_UNDERSCORE; see 3GPP TS 29.501 [5], clause 5.1.1). | +| featureVersion | string | M | 1 | String representing the version of the feature.

It is recommended that the versioning system follows the Semantic Versioning Specification [39]. | + +## 6.1.6.2.63 Type: UdsfInfo + +**Table 6.1.6.2.63-1: Definition of type UdsfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|---------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| groupId | NfGroupId | O | 0..1 | Identity of the UDSF group that is served by the UDSF instance.
If not provided, the UDSF instance does not pertain to any UDSF group. | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPIs whose profile data is available in the UDSF instance (NOTE 1) | +| storageIdRanges | map(array(IdentityRange)) | C | 1..N(1..M) | A map (list of key-value pairs) where realmId serves as key and each value in the map is an array of IdentityRanges. Each IdentityRange is a range of storageIds. A UDSF complying with this version of the specification shall include this IE. Absence indicates that the UDSF's supported realms and storages are determined by the UDSF's consumer by other means such as local provisioning. | + +NOTE 1: If this parameter is not provided, then the UDSF can serve any SUPI range. + +## 6.1.6.2.64 Type: NfInstanceIdListCond + +**Table 6.1.6.2.64-1: Definition of type NfInstanceIdListCond** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|---------------------|---|-------------|-------------------------------------------------------------------| +| nfInstanceIdList | array(NfInstanceId) | C | 1..N | A list of NF Instances whose status is requested to be monitored. | + +6.1.6.2.65 Type: ScpInfo + +**Table 6.1.6.2.65-1: Definition of type ScpInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| scpDomainInfoList | map(ScpDomainInfo) | O | 1..N | SCP domain specific information of the SCP that differs from the common information in NFPProfile data type. The key of the map shall be the string identifying an SCP domain. | +| scpPrefix | string | O | 0..1 | Optional deployment specific string used to construct the apiRoot of the next hop SCP, as described in clause 6.10 of 3GPP TS 29.500 [4]. | +| scpPorts | map(integer) | C | 1..N |

SCP port number(s) for HTTP and/or HTTPS (NOTE 1)

This attribute shall be present if the SCP uses non-default HTTP and/or HTTPS ports and if the SCP does not provision port information within ScpDomainInfo for each SCP domain it belongs to.

When present, it shall contain the HTTP and/or HTTPS ports.

The key of the map shall be "http" or "https".
The value shall indicate the port number for HTTP or HTTPS respectively.
Minimum: 0 Maximum: 65535

| +| addressDomains | array(string) | O | 1..N |

Pattern (regular expression according to the ECMA-262 dialect [8]) representing the address domain names reachable through the SCP.

Absence of this IE indicates the SCP can reach any address domain names in the SCP domain(s) it belongs to.

| +| ipv4Addresses | array(Ipv4Addr) | O | 1..N |

List of IPv4 addresses reachable through the SCP.

This IE may be present if IPv4 addresses are reachable via the SCP.

If IPv4 addresses are reachable via the SCP, absence of both this IE and ipv4AddrRanges IE indicates the SCP can reach any IPv4 addresses in the SCP domain(s) it belongs to.

| +| ipv6Prefixes | array(Ipv6Prefix) | O | 1..N |

List of IPv6 prefixes reachable through the SCP.

This IE may be present if IPv6 addresses are reachable via the SCP.

If IPv6 addresses are reachable via the SCP, absence of both this IE and ipv6PrefixRanges IE indicates the SCP can reach any IPv6 prefixes in the SCP domain(s) it belongs to.

| +| ipv4AddrRanges | array(Ipv4AddressRange) | O | 1..N |

List of IPv4 addresses ranges reachable through the SCP.

This IE may be present if IPv4 addresses are reachable via the SCP.

If IPv4 addresses are reachable via the SCP, absence of both this IE and ipv4Addresses IE indicates the SCP can reach any IPv4 addresses in the SCP domain(s) it belongs to.

| +| ipv6PrefixRanges | array(Ipv6PrefixRange) | O | 1..N |

List of IPv6 prefixes ranges reachable through the SCP.

This IE may be present if IPv6 addresses are reachable via the SCP.

If IPv6 addresses are reachable via the SCP, absence of both this IE and ipv6Prefixes IE indicates the SCP can reach any IPv6 prefixes in the SCP

| + +| | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | domain(s) it belongs to. | +| servedNfSetIdList | array(NfSetId) | O | 1..N | List of NF set ID of NFs served by the SCP.

Absence of this IE indicates the SCP can reach any NF set in the SCP domain(s) it belongs to. | +| remotePlmnList | array(PlmnId) | O | 1..N | List of remote PLMNs reachable through the SCP.

Absence of this IE indicates that no remote PLMN is reachable through the SCP. | +| remoteSnpnList | array(PlmnIdNid) | O | 1..N | List of remote SNPNS reachable through the SCP.
The absence of this IE indicates that no remote SNPN is reachable through the SCP. | +| ipReachability | IpReachability | O | 0..1 | This IE may be present to indicate the type(s) of IP addresses reachable via the SCP in the SCP domain(s) it belongs to.

Absence of this IE indicates that the SCP can be used to reach both IPv4 addresses and IPv6 addresses in the SCP domain(s) it belongs to. | +| scpCapabilities | array(ScpCapability) | C | 0..N | List of SCP capabilities supported by the SCP.
This IE shall be present if the SCP supports at least one SCP capability. It may be present otherwise, with an empty array, to indicate that the SCP does not support any capability of the ScpCapability data type. The absence of this attribute shall not be interpreted as an SCP that does not support any capability; this only means that the SCP (e.g. pre-Rel-17 SCP) did not register the capabilities it may support.
(NOTE 2) | +| NOTE 1: If no SCP port information is present in ScpInfo or in ScpDomainInfo for a specific SCP domain, the HTTP client shall use the default HTTP port number, i.e. TCP port 80 for "http" URIs or TCP port 443 for "https" URIs as specified in IETF RFC 9113 [9] when sending a request to the SCP within the specific SCP domain. | | | | | +| NOTE 2: This IE may be used by another SCP (e.g. SCP-c) to determine whether next hops' SCP(s) (e.g. SCP-p) supports Indirect Communication with Delegated Discovery, e.g. in scenarios with more than one SCP between an NF service consumer and NF service producer. This information is not intended for NF service consumers. This information shall not be used for selecting a next hop SCP. It may only be used by an SCP, once a next hop SCP is selected, to learn the capabilities of the selected SCP, and based on local policy, to determine whether to delegate the selection of the target NF service producer instance to the next hop SCP or not. | | | | | + +## 6.1.6.2.66 Type: ScpDomainInfo + +Table 6.1.6.2.66-1: Definition of type ScpDomainInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| scpFqdn | Fqdn | C | 0..1 | FQDN of the SCP (NOTE) | +| scpIpEndPoints | array(IpEndPoint) | C | 1..N | IP address(es) and port information of the SCP.
If port information is present in this attribute, it applies to any scheme (i.e. HTTP and HTTPS). (NOTE) | +| scpPorts | map(integer) | C | 1..N | SCP port number(s) for HTTP and/or HTTPS.

This attribute shall be present if the SCP uses different ports for HTTP and HTTPS and at least one port is not the default HTTP or HTTPS port, for this SCP domain. This attribute shall be absent if port information is present in the scpIpEndPoints.

When present, it shall contain the HTTP and/or HTTPS ports.

The key of the map shall be "http" or "https".
The value shall indicate the port number for HTTP or HTTPS respectively.
Minimum: 0 Maximum: 65535

If this attribute is present, it has precedence over the scpPorts attribute of ScpInfo. | +| scpPrefix | string | O | 0..1 | Optional deployment specific string used to construct the apiRoot of the next hop SCP, as described in clause 6.10 of 3GPP TS 29.500 [4].
If the scpPrefix attribute is present in ScpInfo and in ScpDomainInfo for a specific SCP domain, the attribute in ScpDomainInfo shall prevail for this SCP domain. | +| NOTE: If any of these attributes is present for a given SCP domain, it shall apply instead of the attributes fqdn, Ipv4Addresses and Ipv6Addresses within the NFProfile data type for the corresponding SCP Domain. If none of these attributes is present for a given SCP domain, the attributes fqdn, Ipv4Addresses, and Ipv6Addresses within the NFProfile data type shall apply for the corresponding SCP Domain. | | | | | + +## 6.1.6.2.67 Type: ScpDomainCond + +Table 6.1.6.2.67-1: Definition of type ScpDomainCond + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| scpDomains | array(string) | M | 1..N | SCP domains of NF, SCP or SEPP instances whose status is requested to be monitored. | +| nfTypeList | array(NFType) | C | 1..N | This IE shall be present if available.
When present, it shall contain the type of the NF Instances or Network Entities (pertaining to any SCP domain in the scpDomains attribute) whose status is requested to be monitored.
If not present, it means that the NF Service Consumer requests a subscription to all NF, SCP and SEPP instances pertaining to any SCP domain in the scpDomains attribute. | + +## 6.1.6.2.68 Type: OptionsResponse + +**Table 6.1.6.2.68-1: Definition of type OptionsResponse** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supportedFeatures | SupportedFeatures | C | 0..1 | Supported features of the NRF, for the nf-instances store resource. See clause 6.1.9.

This IE shall be included if at least one Nnrf_NFManagement feature is supported by the NRF. | + +## 6.1.6.2.69 Type: NwdafCond + +**Table 6.1.6.2.69-1: Definition of type NwdafCond** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | string | M | 1 | This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive.
In this data type, it shall take the value "NWDAF_COND". | +| analyticsIds | array(string) | O | 1..N | Analytics Id(s) provided by consumers of NWDAF. In this data type, it shall take the value as defined in NwdafEvent IE and EventId IE in nwdafInfo. | +| snssaiList | array(SNSSAI) | O | 1..N | S-NSSAIs of the NWDAF whose status is requested to be monitored. | +| taiList | array(TAI) | O | 1..N | TAI(s) of the NWDAF whose status is requested to be monitored. It may contain one or more non-3GPP access TAIs. | +| taiRangeList | array(TAIRange) | O | 1..N | The range of TAIs of the NWDAF whose status is requested to be monitored. It may contain non-3GPP access TAIs. | +| servingNfTypeList | array(NFType) | O | 1..N | NF type(s) served by the NWDAF whose status is requested to be monitored. | +| servingNfSetIdList | array(NfSetId) | O | 1..N | NF Set Id(s) served by the NWDAF whose status is requested to be monitored. | +| mlAnalyticsList | array(MLAnalyticsInfo) | C | 1..N | The list of ML Analytics Filter information per Analytics ID(s) supported by the NWDAF, whose status is requested to be monitored. | + +## 6.1.6.2.70 Type: NefCond + +**Table 6.1.6.2.70-1: Definition of type NefCond** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | string | M | 1 | This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive.
In this data type, it shall take the value "NEF_COND". | +| afEvents | array(AfEvent) | O | 1..N | EventId(s) supported by the AFs. | +| snssaiList | array(SNSSAI) | O | 1..N | S-NSSAIs of the NEF whose status is requested to be monitored. | +| pfdData | PfdData | O | 0..1 | PFD data of the NEF whose status is requested to be monitored. | +| gpsiRanges | array(IdentityRange) | O | 1..N | Range(s) of External Identifiers of the NEF whose status is requested to be monitored. | +| externalGroupIdentifiers | array(IdentityRange) | O | 1..N | Range(s) of External Group Identifiers of the NEF whose status is requested to be monitored. | +| servedFqdnList | array(string) | O | 1..N | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the Domain names of the NEF whose status is requested to be monitored. | + +## 6.1.6.2.71 Type: SuciInfo + +**Table 6.1.6.2.71-1: Definition of type SuciInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------|----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| routingInds | array(string) | O | 1..N | Indicating served Routing Indicator (see 3GPP TS 23.003 [12], clause 2.2B). If not provided, the AUSF/UDM can serve any Routing Indicator. | +| hNwPubKeyIds | array(integer) | O | 1..N | Indicating served Home Network Public Key (see 3GPP TS 23.003 [12], clause 2.2B). If not provided, the AUSF/UDM can serve any public key. | +| NOTE: Any combination of any routingInds value and any hNwPubKeyIds value is valid. | | | | | + +## 6.1.6.2.72 Type: SeppInfo + +Table 6.1.6.2.72-1: Definition of type SeppInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| seppPrefix | string | O | 0..1 | Optional deployment specific string used to construct the apiRoot of the next hop SEPP, as described in clause 6.10 of 3GPP TS 29.500 [4]. | +| seppPorts | map(integer) | C | 1..N | SEPP port number(s) for HTTP and/or HTTPS (NOTE 1)
This attribute shall be present if the SEPP uses non-default HTTP and/or HTTPS ports. When present, it shall contain the HTTP and/or HTTPS ports.

The key of the map shall be "http" or "https".
The value shall indicate the port number for HTTP or HTTPS respectively.
Minimum: 0 Maximum: 65535 | +| remotePlmnList | array(PlmnId) | O | 1..N | List of remote PLMNs reachable through the SEPP. The absence of this attribute indicates that any PLMN is reachable through the SEPP. | +| remoteSnpnList | array(PlmnIdNid) | O | 1..N | List of remote SNPNS reachable through the SEPP. The absence of this attribute indicates that no SNPN is reachable through the SEPP. | +| n32Purposes | array(N32Purpose) | C | 1..N | This IE should be present if the SEPP is configured to support specific N32 purposes. When present, it shall contain the list of N32 purposes supported by the SEPP.
The absence of this IE indicates that the SEPP can be selected for any N32 purpose. | + +NOTE 1: If no SEPP port information is present in SeppInfo, the HTTP client shall use the default HTTP port number, i.e. TCP port 80 for "http" URIs or TCP port 443 for "https" URIs as specified in IETF RFC 9113 [9] when sending a request to the SEPP. + +NOTE 2: The attributes fqdn, ipv4Addresses and ipv6Addresses within the NFProfile data type shall be used to determine the SEPP address. + +## 6.1.6.2.73 Type: AanfInfo + +Table 6.1.6.2.73-1: Definition of type AanfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| routingIndicators | array(string) | O | 1..N | List of Routing Indicators supported by the Aanf instance. If not provided, the Aanf can serve any Routing Indicator.
Pattern: '^[0-9]{1,4}\$' | + +## 6.1.6.2.74 Type: 5GDnmfInfo + +Table 6.1.6.2.74-1: Definition of type 5GDnmfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------| +| plmnId | PlmnId | M | 1 | PLMN ID of the PLMN which the 5G DDNMF served. | + +## 6.1.6.2.75 Type: MfaflInfo + +**Table 6.1.6.2.75-1: Definition of type MfaflInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servingNfTypeList | array(NFType) | O | 1..N | If present, this IE shall contain the list of NF type(s) served by MFAF NF. The absence of this attribute indicates that the MFAF can be selected for any NF type | +| servingNfSetIdList | array(NfSetId) | O | 1..N | If present, this IE shall contain the list of NF Set Id(s) served by MFAF NF. The absence of this attribute indicates that the MFAF can be selected for any NF Set Id. | +| taiList | array(Tai) | O | 1..N | The list of TAIs the MFAF can serve. It may contain one or more non-3GPP access TAIs. The absence of both this attribute and the taiRangeList attribute indicates that the MFAF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the MFAF can serve. It may contain one or more non-3GPP access TAI ranges. The absence of both this attribute and the taiList attribute indicates that the MFAF can be selected for any TAI in the serving network. | + +## 6.1.6.2.76 Type: NwdafCapability + +**Table 6.1.6.2.76-1: Definition of type NwdafCapability** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| analyticsAggregation | boolean | O | 0..1 | When present, this IE shall indicate whether the NWDAF supports analytics aggregation:

- true: analytics aggregation capability is supported by the NWDAF
- false (default): analytics aggregation capability is not supported by the NWDAF. | +| analyticsMetadataProvisioning | boolean | O | 0..1 | When present, this IE shall indicate whether the NWDAF supports analytics metadata provisioning:

- true: analytics metadata provisioning capability is supported by the NWDAF
- false (default): analytics metadata provisioning capability is not supported by the NWDAF. | +| mlModelAccuracyChecking | boolean | O | 0..1 | When present, this IE shall indicate whether the NWDAF containing MTLF supports ML model accuracy checking:

- true: ML model accuracy checking capability is supported by the NWDAF
- false (default): ML model accuracy checking capability is not supported by the NWDAF. | +| analyticsAccuracyChecking | boolean | O | 0..1 | When present, this IE shall indicate whether the NWDAF containing AnLF supports Analytics accuracy checking:

- true: Analytics accuracy checking capability is supported by the NWDAF
- false (default): Analytics accuracy checking capability is not supported by the NWDAF. | +| roamingExchange | boolean | O | 0..1 | When present, this IE shall indicate whether the NWDAF supports roaming exchange capability:

- true: roaming exchange capability is supported by the NWDAF
- false (default): roaming exchange capability is not supported by the NWDAF. | + +## 6.1.6.2.77 Type: EasdfInfo + +**Table 6.1.6.2.77-1: Definition of type EasdfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------|----------------------------|---|-------------|--------------------------------------------------------------| +| sNssaiEasdfInfoList | array(SnssaiEasdfInfoItem) | O | 1..N | List of parameters supported by the EASDF per S-NSSAI (NOTE) | +| easdfN6IpAddressList | array(IpAddr) | O | 1..N | N6 IP addresses of the EASDF | +| upfN6IpAddressList | array(IpAddr) | O | 1..N | N6 IP addresses of PSA UPFs | +| NOTE: If S-NSSAIs are present in the EasdfInfo and in the NFprofile, the S-NSSAIs from the EasdfInfo shall prevail. | | | | | + +## 6.1.6.2.78 Type: SnssaiEasdflnfoltem + +Table 6.1.6.2.78-1: Definition of type SnssaiEasdflnfoltem + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-------------------------|---|-------------|---------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | S-NSSAI | +| dnnEasdflnfoltemList | array(DnnEasdflnfoltem) | M | 1..N | List of parameters supported by the EASDF per DNN | + +## 6.1.6.2.79 Type: DnnEasdflnfoltem + +Table 6.1.6.2.79-1: Definition of type DnnEasdflnfoltem + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Supported DNN or Wildcard DNN if the EASDF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. | +| dnaiList | array(Dnai) | O | 1..N | List of Data network access identifiers supported by the EASDF for this DNN. The absence of this attribute indicates that the EASDF can be selected for this DNN for any DNAI. | + +## 6.1.6.2.80 Type: DccfInfo + +Table 6.1.6.2.80-1: Definition of type DccfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servingNfTypeList | array(NFType) | O | 1..N | If present, this IE shall contain the list of NF type(s) from which the DCCF NF can collect data. The absence of this attribute indicates that the DCCF can collect data from any NF type. | +| servingNfSetIdList | array(NfSetId) | O | 1..N | If present, this IE shall contain the list of NF Set Id(s) from which the DCCF NF can collect data. The absence of this attribute indicates that the DCCF can collect data from any NF Set. | +| taiList | array(Tai) | O | 1..N | The list of TAIs the DCCF can serve. It may contain one or more non-3GPP access TAIs. The absence of both this attribute and the taiRangeList attribute indicates that the DCCF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the DCCF can serve. It may contain one or more non-3GPP access TAI ranges. The absence of both this attribute and the taiList attribute indicates that the DCCF can be selected for any TAI in the serving network. | +| dataSubsRelocInd | boolean | O | 0..1 | When present, this IE shall indicate whether the DCCF supports relocation of data subscription:
- true: relocation of data subscription is supported by the DCCF
- false (default): relocation of data subscription is not supported by the DCCF. | + +## 6.1.6.2.8.1 Type: Nsacflnfo + +Table 6.1.6.2.8.1-1: Definition of type Nsacflnfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nsacfCapability | NsacfCapability | M | 1 | Indicates the NSAC service capability supported by the NSACF. | +| snssaiListForEntirePlmn | array(ExtSnssai) | O | 1..N | Indicates the list of S-NSSAIs for which the NSACF manages for entire PLMN (i.e NSACF is primary or central NSACF for specific S-NSSAIs). | +| tailList | array(Tai) | O | 1..N | The list of TAIs the NSACF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the NSACF can be selected for any TAI in the serving network.

(NOTE 1) (NOTE 2) | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the NSACF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the tailList attribute indicate that the NSACF can be selected for any TAI in the serving network.

(NOTE 1) (NOTE 2) | +| nsacSaiList | array(NsacSai) | O | 1..N | When present, it shall indicate the NSAC service areas which are supported by the NSACF. | + +NOTE 1: When NSACF serving area is configured with TAI list, the serving area of the NSACF should be configured to cover the complete serving area of any of its AMF and SMF consumers, i.e. the TAI list served by NSACF should include all the TAIs served by its AMF and SMF consumers. This can avoid NSACF reselection when the UE moves within the serving area of the NF consumer, e.g. avoid NSACF reselection during intra-AMF UE mobility + +NOTE 2: This attribute is deprecated; the attribute "nsacSaiList" should be used instead. + +## 6.1.6.2.8.2 Type: NsacfCapability + +Table 6.1.6.2.8.2-1: Definition of type NsacfCapability + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supportUeSAC | boolean | C | 0..1 | Indicates the service capability of the NSACF to monitor and control the number of registered UEs per network slice for the network slice that is subject to NSAC.
true: Supported
false (default): Not Supported | +| supportPduSAC | boolean | C | 0..1 | Indicates the service capability of the NSACF to monitor and control the number of established PDU sessions per network slice for the network slice that is subject to NSAC.
true: Supported
false (default): Not Supported | +| supportUeWithPduSAC | boolean | C | 0..1 | Indicates the service capability of the NSACF to monitor and control the number of registered UEs with at least one PDU session / PDN connection for the network slice that is subject to NSAC, if EPS counting is supported by the NSACF.
true: Supported
false (default): Not Supported | + +## 6.1.6.2.83 Type: DccfCond + +Table 6.1.6.2.83-1: Definition of type DccfCond + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | string | M | 1 | This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive.
In this data type, it shall take the value "DCCF_COND". | +| tailList | array(Tai) | O | 1..N | TAI(s) of the DCCF whose status is requested to be monitored. It may contain one or more non-3GPP access TAIs. | +| tailRangeList | array(TaiRange) | O | 1..N | The range of TAIs of the DCCF whose status is requested to be monitored. It may contain non-3GPP access TAIs. | +| servingNfTypeList | array(NFType) | O | 1..N | The list of NF type(s) served by DCCF whose status is requested to be monitored. | +| servingNfSetIdList | array(NfSetId) | O | 1..N | The list of NF Set Id(s) served by DCCF whose status is requested to be monitored. | + +## 6.1.6.2.84 Type: MIAnalyticsInfo + +Table 6.1.6.2.84-1: Definition of type MIAnalyticsInfo + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mlAnalyticsIds | array(NwdafEvent) | C | 1..N | Analytics Id(s) supported by the Nnwdaf_MLModelProvision service, if none are provided the NWDAF can serve any mlAnalyticsId. | +| snssaiList | array(Snssai) | O | 1..N | S-NSSAIs of the ML model, if none are provided the ML model for the analytics can apply to any snssai. | +| trackingAreaList | array(Tai) | O | 1..N | Area of Interest of the ML model, if none are provided the ML model for the analytics can apply to any TAIs.

If present, this IE represents the list of TAIs, it may contain one or more non-3GPP access TAIs. | +| mlModelInterInfo | MLModelInterInfo | O | 0..1 | ML Model Interoperability indicator, if none are provided the ML models are not allowed to be retrieved by any NWDAF vendors. | +| flCapabilityType | FLCapabilityType | O | 0..1 | Federated Learning capability type of the NWDAF as specified in clause 5.2.7.2.2 of 3GPP TS 23.502 [3], if none are provided the NWDAF can not support any type. | +| flTimeInterval | DurationSec | O | 0..1 | Time interval supporting Federated Learning as specified in clause 5.2.7.2.2 of 3GPP TS 23.502 [3]. This IE may be present if the flCapabilityType attribute is present. | +| nfTypeList | array(NFType) | O | 1..N | NF type of the data source where data can be collected as input for local model training. This IE may be present if the flCapabilityType attribute is present. (NOTE) | +| nfSetIdList | array(NfSetId) | O | 1..N | NF Set ID of the data source where data can be collected as input for local model training. This IE may be present if the flCapabilityType attribute is present. (NOTE) | + +NOTE: If the attribute is also present in Nwdaflnfo, the attribute values provided in MIAnalyticsInfo shall be a subset of the attribute values provided in Nwdaflnfo. + +## 6.1.6.2.85 Type: MbSmfInfo + +Table 6.1.6.2.85-1: Definition of type MbSmfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssaiInfoList | map(SNSSAIMbSmfInfoItem) | O | 1..N | S-NSSAIs and DNNs supported by the MB-SMF (NOTE 1)
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. | +| tmgiRangeList | map(TmgiRange) | O | 1..N | TMGI range(s) supported by the MB-SMF
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. | +| tailList | array(Tai) | O | 1..N | List of TAIs the MB-SMF can serve.
The absence of this attribute and the taiRangeList attribute indicates that the MB-SMF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAIs the MB-SMF can serve.
The absence of this attribute and the taiList attribute indicates that the MB-SMF can be selected for any TAI in the serving network. | +| mbsSessionList | map(MbsSession) | O | 1..N | List of MBS sessions currently served by the MB-SMF
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. | + +NOTE 1: If S-NSSAIs are present in MbSmfInfo and in the NFprofile, the S-NSSAIs from MbSmfInfo shall prevail. + +## 6.1.6.2.86 Type: TmgiRange + +Table 6.1.6.2.86-1: Definition of type TmgiRange + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsServiceIdStart | string | M | 1 | First MBS Service ID value identifying the start of a TMGI range.
The value shall be coded as defined for the mbsServiceId attribute of the Tmgi data type defined in 3GPP TS 29.571 [7].
Pattern: '[A-Fa-f0-9]{6}\$' | +| mbsServiceIdEnd | string | M | 1 | Last MBS Service ID value identifying the end of a TMGI range.
The value shall be coded as defined for the mbsServiceId attribute of the Tmgi data type defined in 3GPP TS 29.571 [7].
Pattern: '[A-Fa-f0-9]{6}\$' | +| plmnId | PlmnId | M | 1 | PLMN ID | +| nid | Nid | O | 0..1 | Network Identity used for SNPn | + +## 6.1.6.2.87 Type: MbsSession + +**Table 6.1.6.2.87-1: Definition of type MbsSession** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbsSessionId | MbsSessionId | M | 1 | MBS session identifier | +| mbsAreaSessions | map(MbsServiceAreaInfo) | C | 1..N | Map of Area Session Id and related MBS Service Area information used for MBS session with location dependent content. The Area Session ID together with the mbsSessionId (TMGI) uniquely identifies the MBS session in a specific MBS service area. For an MBS session with location dependent content, one map entry shall be registered for each MBS Service Area served by the MBS session. The key of the map shall be the areaSessionId. | + +## 6.1.6.2.88 Type: SnssaiMbSmfInfoItem + +**Table 6.1.6.2.88-1: Definition of type SnssaiMbSmfInfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|----------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | Supported S-NSSAI | +| dnnInfoList | array(DnnMbSmfInfoItem) | M | 1..N | List of parameters supported by the MB-SMF per DNN | + +## 6.1.6.2.89 Type: DnnMbSmfInfoItem + +**Table 6.1.6.2.89-1: Definition of type DnnMbSmfInfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Supported DNN or Wildcard DNN if the MB-SMF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. | + +6.1.6.2.90 Void + +6.1.6.2.91 Type: Tsctsflnfo + +**Table 6.1.6.2.91-1: Definition of type Tsctsflnfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssaiInfoList | map(SnssaiTsctsflnfoItem) | O | 1..N | S-NSSAIs and DNNs supported by the TSCTSF (NOTE 1)
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. | +| externalGroupIdentifiers Ranges | array(IdentityRange) | O | 1..N | Ranges of External Group Identifiers that can be served by the TSCTSF.

The absence of this IE indicates that the TSCTSF can serve any external group managed by the PLMN (or SNPN) of the TSCTSF instance. | +| supiRanges | array(SupiRange) | O | 1..N | Ranges of SUPIs that can be served by the TSCTSF instance.
(NOTE 2) | +| gpsiRanges | array(IdentityRange) | O | 1..N | Ranges of GPSIs that can be served by the TSCTSF instance.
(NOTE 2) | +| internalGroupIdentifiers Ranges | array(InternalGroupldRange) | O | 1..N | Ranges of Internal Group Identifiers that can be served by the TSCTSF instance.

The absence of this IE indicates that the TSCTSF can serve any internal group managed by the PLMN (or SNPN) of the TSCTSF instance. | + +NOTE 1: If S-NSSAIs are present in Tsctsflnfo and in the NFprofile, the S-NSSAIs from Tsctsflnfo shall prevail. Only one TSCTSF instance, or only the TSCTSF instances belonging to one TSCTSF Set, shall be configured in the PLMN (or SNPN) to serve a specific DNN and S-NSSAI combination. + +NOTE 2: If both parameters are not provided, the TSCTSF can serve any SUPI or GPSI managed by the PLMN (or SNPN) of the TSCTSF instance. + +6.1.6.2.92 Type: SnssaiTsctsflnfoItem + +**Table 6.1.6.2.92-1: Definition of type SnssaiTsctsflnfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------------|---|-------------|-------------------------------------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | Supported S-NSSAI. | +| dnnInfoList | array(DnnTsctsflnfoItem) | M | 1..N | List of parameters supported by the TSCTSF per DNN for the indicated S-NSSAI. | + +6.1.6.2.93 Type: DnnTsctsflnfoItem + +**Table 6.1.6.2.93-1: Definition of type DnnTsctsflnfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Supported DNN or Wildcard DNN if the TSCTSF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. | + +## 6.1.6.2.94 Type: MbUpflInfo + +Table 6.1.6.2.94-1: Definition of type MbUpflInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssaiMbUpflInfoList | array(SnssaiUpflnfoltem) | M | 1..N | List of parameters supported by the MB-UPF per S-NSSAI. (NOTE) | +| mbSmfServingArea | array(string) | O | 1..N | The MB-SMF service area(s) the MB-UPF can serve.
If not provided, the MB-UPF can serve any MB-SMF service area. | +| interfaceMbUpflInfoList | array(InterfaceUpflnfoltem) | O | 1..N | List of User Plane interfaces configured on the MB-UPF. When this IE is provided in the NF Discovery response, the NF Service Consumer (e.g. MB-SMF) may use this information for MB-UPF selection. | +| tailList | array(Tai) | O | 1..N | The list of TAls the MB-UPF can serve.

The absence of this attribute and the taiRangeList attribute indicates that the MB-UPF can serve the whole MB-SMF service area defined by the MbSmfServingArea attribute. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAls the MB-UPF can serve.

The absence of this attribute and the tailList attribute indicates that the MB-UPF can serve the whole MB-SMF service area defined by the MbSmfServingArea attribute. | +| priority | integer | O | 0..1 | Priority (relative to other NFs of the same type) in the range of 0-65535, to be used for NF selection for a service request matching the attributes of the MbUpflInfo; lower values indicate a higher priority. See the precedence rules in the description of the priority attribute in NFProfile, if Priority is also present in NFProfile.
The NRF may overwrite the received priority value when exposing an NFProfile with the Nnrf_NFDiscovery service. | +| supportedPfcpFeatures | string | O | 0..1 | Supported PFCP Features.

A string used to indicate the PFCP features supported by the MB-UPF, which encodes the "UP Function Features" IE as specified in Table 8.2.25-1 of 3GPP TS 29.244 [21] (starting from Octet 5), in hexadecimal representation.

Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and each two characters shall represent one octet of "UP Function Features" IE (starting from Octet 5, to higher octets). For each two characters representing one octet, the first character representing the 4 most significant bits of the octet and the second character the 4 least significant bits of the octet. | + +NOTE : If this S-NSSAI is present in the MbUpflInfo and in the NFprofile, the S-NSSAIs from the MbUpflInfo shall prevail. + +## 6.1.6.2.95 Type: UnTrustAflInfo + +Table 6.1.6.2.95-1: Definition of type UnTrustAflInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aflId | string | M | 1 | Associated AF id. | +| sNssaiInfoList | array(SNSSAIInfoItem) | O | 1..N | S-NSSAIs and DNNs supported by the AF. | +| mappingInd | boolean | O | 0..1 | When present, this IE indicates whether the AF supports mapping between UE IP address (IPv4 address or IPv6 prefix) and UE ID (i.e. GPSI).

true: the AF supports mapping between UE IP address and UE ID;
false (default): the AF does not support mapping between UE IP address and UE ID. | + +#### 6.1.6.2.96 Type: TrustAflInfo + +**Table 6.1.6.2.96-1: Definition of type TrustAflInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssaiInfoList | array(SNSSAIInfoItem) | O | 1..N | S-NSSAIs and DNNs supported by the trusted AF (NOTE 1). | +| afEvents | array(AfEvent) | O | 1..N | AF Event(s) supported by the trusted AF. | +| appIds | array(string) | O | 1..N | The list of Application ID(s) supported by the trusted AF. The absence of this attribute indicate that the AF can be selected for any Application. | +| internalGroupId | array(GroupId) | O | 1..N | List of Internal Group Identifiers supported by the trusted AF.
If not provided, it does not imply that the AF supports all internal groups. | +| mappingInd | boolean | O | 0..1 | When present, this IE indicates whether the trusted AF supports mapping between UE IP address (IPv4 address or IPv6 prefix) and UE ID (i.e. SUPI).

true: the trusted AF supports mapping between UE IP address and UE ID;
false (default): the trusted AF does not support mapping between UE IP address and UE ID. | +| taiList | array(Tai) | O | 1..N | This IE may be present if the AfEvent is set to "GNSS_ASSISTANCE_DATA".
When present, this IE shall contain the list of TAIs the trusted AF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the trusted AF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | This IE may be present if the AfEvent is set to "GNSS_ASSISTANCE_DATA".
When present, this IE shall contain the range of TAIs the trusted AF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the taiList attribute indicate that the trusted AF can be selected for any TAI in the serving network. | + +NOTE 1: If S-NSSAIs are present in TrustAflInfo and in the NFprofile, the S-NSSAIs from TrustAflInfo shall prevail. + +#### 6.1.6.2.97 Type: SnssaiInfoItem + +**Table 6.1.6.2.97-1: Definition of type SnssaiInfoItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------|---|-------------|------------------------------------------------| +| sNssai | ExtSnssai | M | 1 | Supported S-NSSAI | +| dnnInfoList | array(DnnInfoItem) | M | 1..N | List of parameters supported by the NF per DNN | + +## 6.1.6.2.98 Type: DnnInfItem + +**Table 6.1.6.2.98-1: Definition of type DnnInfItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnn | Dnn | M | 1 | Supported DNN or Wildcard DNN if the NF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. | + +## 6.1.6.2.99 Type: CollocatedNfInstance + +**Table 6.1.6.2.99-1: Definition of type CollocatedNfInstance** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|------------------------------------------------------------------| +| nfInstanceId | NfInstanceId | M | 1 | Unique identity of the NF Instance for a collocated NF type. | +| nfType | CollocatedNfType | M | 1 | Possible NF types supported by a collocated NF. (NOTE 1, NOTE 2) | + +NOTE 1: Whether NFs of any NF types are collocated or not, is an implementation and/or deployment issue and needs not be known in general to the NF service consumers and therefore needs not be registered in the NF profile. This data type is only intended for specific scenarios where the discovery and selection of a combined NF service producer by a NF service consumer can allow specific optimizations. In order to retrieve the NFProfile of the collocated NF instance, the NF service consumer shall trigger a separate discovery procedure using the nfType and nfInstanceId in the CollocatedNfInstance data type. + +NOTE 2: The supported collocated NF types in this release of the specification may only be one of the following: +- a MB-SMF may be collocated with a SMF (N16mb internal interface); +- a MB-UPF may be collocated with a UPF (N19mb internal interface). + +## 6.1.6.2.100 Type: ServiceNameListCond + +**Table 6.1.6.2.100-1: Definition of type ServiceNameListCond** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------|--------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | string | M | 1 | This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive.
In this data type, it shall take the value "SERVICE_NAME_LIST_COND". | +| serviceNameList | array(ServiceName) | M | 1..N | Service names offered by the NF Instances whose status is requested to be monitored. | + +## 6.1.6.2.101 Type: NfGroupListCond + +**Table 6.1.6.2.101-1: Definition of type NfGroupListCond** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conditionType | string | M | 1 | This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive.
In this data type, it shall take the value "NF_GROUP_LIST_COND". | +| nfType | string | M | 1 | NF type (UDM, AUSF, PCF, UDR, HSS or CHF) of the NF Instances whose status is requested to be monitored. | +| nfGroupIdList | array(NfGroupId) | M | 1..N | Group IDs of the NF Instances whose status is requested to be monitored. | + +## 6.1.6.2.102 Type: PlmnOauth2 + +**Table 6.1.6.2.102-1: Definition of type PlmnOauth2** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------|---------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------| +| oauth2RequiredPlmnIdList | array(PlmnId) | O | 1..N | It shall indicate the consumer PLMN ID list for which NF Service Instance requires Oauth2-based authorization.
(See NOTE 1) | +| oauth2NotRequiredPlmnIdList | array(PlmnId) | O | 1..N | It shall indicate the consumer PLMN ID list for which NF Service Instance does not require Oauth2-based authorization.
(See NOTE 1) | + +NOTE 1: The same PLMN Id shall not be present in both oauth2RequiredPlmnIdList and oauth2NotRequiredPlmnIdList. + +## 6.1.6.2.103 Type: V2xCapability + +**Table 6.1.6.2.103-1: Definition of type V2xCapability** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lteV2x | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports LTE V2X capability:

- true: LTE V2X capability is supported by the PCF
- false (default): LTE V2X capability is not supported by the PCF. | +| nrV2x | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports NR V2X capability:

- true: NR V2X capability is supported by the PCF
- false (default): NR V2X capability is not supported by the PCF. | + +## 6.1.6.2.104 Type: Nssaaflnfo + +**Table 6.1.6.2.104-1: Definition of type Nssaaflnfo** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------|-----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPIs that can be served by the NSSAAF instance. | +| internalGroupIdentifiersRanges | array(InternalGroupIdRange) | O | 1..N | List of ranges of Internal Group Identifiers that can be served by the NSSAAF instance. If not provided, it does not imply that the NSSAAF supports all internal groups. | + +6.1.6.2.105 Type: ProSeCapability + +**Table 6.1.6.2.105-1: Definition of type ProSeCapability** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| proseDirectDiscover | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Direct Discovery:

- true: ProSe Direct Discovery is supported by the PCF
- false (default): ProSe Direct Discovery is not supported by the PCF. | +| proseDirectCommunication | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Direct Communication:

- true: ProSe Direct Communication is supported by the PCF
- false (default): ProSe Direct Communication is not supported by the PCF. | +| proseL2UetoNetworkRelay | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-2 UE-to-Network Relay:

- true: ProSe Layer-2 UE-to-Network Relay is supported by the PCF
- false (default): ProSe Layer-2 UE-to-Network Relay is not supported by the PCF. | +| proseL3UetoNetworkRelay | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-3 UE-to-Network Relay:

- true: ProSe Layer-3 UE-to-Network Relay is supported by the PCF
- false (default): ProSe Layer-3 UE-to-Network Relay is not supported by the PCF. | +| proseL2RemoteUe | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-2 Remote UE:

- true: ProSe Layer-2 Remote UE is supported by the PCF
- false (default): ProSe Layer-2 Remote UE is not supported by the PCF. | +| proseL3RemoteUe | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-3 Remote UE:

- true: ProSe Layer-3 Remote UE is supported by the PCF
- false (default): ProSe Layer-3 Remote UE is not supported by the PCF. | +| proseL2UetoUeRelay | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-2 UE-to-UE Relay:

- true: ProSe Layer-2 UE-to-UE Relay is supported by the PCF
- false (default): ProSe Layer-2 UE-to-UE Relay is not supported by the PCF. | +| proseL3UetoUeRelay | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-3 UE-to-UE Relay:

- true: ProSe Layer-3 UE-to-UE Relay is supported by the PCF
- false (default): ProSe Layer-3 UE-to-UE Relay is not supported by the PCF. | +| proseL2EndUe | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-2 End UE:

- true: ProSe Layer-2 End UE is supported by the PCF
- false (default): ProSe Layer-2 End UE is not supported by the PCF. | +| proseL3EndUe | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports ProSe Layer-3 End UE:

- true: ProSe Layer-3 End UE is supported by the | + +| | | | | | +|--|--|--|--|-----------------------------------------------------------------------------| +| | | | | PCF
- false (default): ProSe Layer-3 End UE is not supported by the PCF. | +|--|--|--|--|-----------------------------------------------------------------------------| + +#### 6.1.6.2.106 Type: SharedDataIdRange + +**Table 6.1.6.2.106-1: Definition of type SharedDataIdRange** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| pattern | string | O | 0..1 | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of SharedDataIds belonging to this range. A SharedDataId value is considered part of the range if and only if the SharedDataId string fully matches the regular expression. | + +EXAMPLE: SharedDataId range. "123456-sharedAmData{localID}" where "123456" is the HPLMN id (i.e. MCC followed by MNC) and "{localID}" can be any string. + JSON: { "pattern": "^123456-sharedAmData.+\$" } + +#### 6.1.6.2.107 Type: SubscriptionContext + +**Table 6.1.6.2.107-1: Definition of type SubscriptionContext** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| subscriptionId | string | M | 1 | Subscription ID of the corresponding subscription resource that originated the notification. | +| subscrCond | SubscrCond | O | 0..1 | If present, this attribute shall contain the conditions identifying the set of NF Instances whose status was requested to be monitored in the corresponding subscription that originated this notification. | + +#### 6.1.6.2.108 Type: IwmscInfo + +**Table 6.1.6.2.108-1: Definition of type IwmscInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| msisdnRanges | array(IdentityRange) | O | 1..N | List of ranges of MSISDNs supported by the SMS-IWMSC.
See NOTE. | +| supiRanges | array(SupiRange) | O | 1..N | List of ranges of SUPIs supported by the SMS-IWMSC.
See NOTE. | +| taiRangeList | array(TaiRange) | O | 1..N | The range of TAs the SMS-IWMSC can serve.

The absence of this attribute indicates that the SMS-IWMSC can serve any TA. | +| scNumber | string | O | 0..1 | When present, this IE carry an OctetString indicating the ISDN number of the SC in international number format as described in ITU-T Rec. E.164 [44] and shall be encoded as a TBCD-string.

Pattern: "^[0-9]{5,15}\$" | + +NOTE: If both parameters are not provided, the SMS-IWMSC can serve any SUPI or MSISDN. + +## 6.1.6.2.109 Type: Mnpflnfo + +**Table 6.1.6.2.109-1: Definition of type Mnpflnfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------| +| msisdnRanges | array(IdentityRange) | M | 1..N | List of ranges of MSISDNs whose portability status is available in the MNPF | + +## 6.1.6.2.110 Type: DefSubServiceInfo + +**Table 6.1.6.2.110-1: Definition of type DefSubServiceInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| versions | array(string) | O | 1..N | When present, this attribute shall indicate the API version (e.g. "v1") of the indicated service which are supported by the NF (Service) instance acting as NF service consumer. | +| supportedFeatures | SupportedFeatures | O | 0..1 | When present, this attribute shall indicate the features of the indicated service which are supported by the NF (Service) instance acting as NF service consumer. | + +## 6.1.6.2.111 Type: LocalityDescriptionItem + +**Table 6.1.6.2.111-1: Definition of type LocalityDescriptionItem** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|------------------------------| +| localityType | LocalityType | M | 1 | Type of locality description | +| localityValue | string | M | 1 | Locality value | + +## 6.1.6.2.112 Type: LocalityDescription + +**Table 6.1.6.2.112-1: Definition of type LocalityDescription** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|--------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| localityType | LocalityType | M | 1 | Type of locality description | +| localityValue | string | M | 1 | Locality value | +| addLocDescrItems | array(LocalityDescriptionItem) | O | 0..1 | Additional locality description items
This IE may be present to express a preferred locality as a set of locality description items to match with an "AND" relationship, e.g. to express a preference for NF profiles that are located in a given city and state. This may be used e.g. when a locality value of a given locality type may not be unique within the PLMN, such as cities with the same name in different states. | + +## 6.1.6.2.113 Type: SmsfInfo + +Table 6.1.6.2.113-1: Definition of type SmsfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| roamingUeInd | boolean | O | 0..1 | When present, this IE shall indicate whether the SMSF can serve roaming UE:

- true: the SMSF can support roaming UEs.
- false: the SMSF can not support roaming UEs.

Absence of this IE indicates whether the SMSF can serve roaming UEs is not specified. | +| remotePlmnRangeList | array(PlmnRange) | O | 1..N | This IE maybe present when the roamingUeInd IE is present with the value "true".

When present, this IE shall indicate the list of ranges of remote PLMNs served by the SMSF, i.e. the SMSF can serve the roaming UEs which belong to the indicated remote PLMNs. | + +NOTE: If the roamingUeInd IE is present with the value "true", absence of remotePlmnRangeList IE indicates that the SMSF can serve roaming UEs from any remote PLMN. + +## 6.1.6.2.114 Type: DcsfInfo + +Table 6.1.6.2.114-1: Definition of type DcsfInfo + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| imsDomainNameList | array(imsDomainName) | O | 1..N | List of IMS domain names served by the DCSF. | +| imsiRanges | array(ImsiRange) | O | 1..N | List of ranges of IMSIs whose profile data is available in the DCSF instance. (NOTE 1) | +| msisdnRanges | array(IdentityRange) | O | 1..N | List of ranges of MSISDNs whose profile data is available in the DCSF instance. (NOTE 1) | +| imsPrivateIdentityRanges | array(IdentityRange) | O | 1..N | List of ranges of IMS Private Identities whose profile data is available in the DCSF instance. (NOTE 1) | +| imsPublicIdentityRanges | array(IdentityRange) | O | 1..N | List of ranges of IMS Public Identities whose profile data is available in the DCSF instance. (NOTE 1) | + +NOTE 1: If none of these parameters are provided, the DCSF can serve any IMSI or IMS Private Identity or IMS Public Identity or MSISDN managed by the PLMN of the DCSF instance. + +## 6.1.6.2.115 Type: MIModelInterInfo + +Table 6.1.6.2.115-1: Definition of type MIModelInterInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------| +| vendorList | array(VendorId) | O | 1..N | When present, this IE shall include the list of NWDAF vendors that are allowed to retrieve ML models from the NWDAF containing MTLF. | + +## 6.1.6.2.116 Type: PruExistenceInfo + +**Table 6.1.6.2.116-1: Definition of type PruExistenceInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------| +| tailList | array(Tai) | O | 1..N | When present, this IE shall contain PRU(s) TAI list that the LMF can serve. It may contain one or more non-3GPP access TAIs. | +| taiRangeList | array(TaiRange) | O | 1..N | When present, this IE shall contain PRU(s) TAI range list that the LMF can serve. It may contain one or more non-3GPP access TAI ranges. | + +## 6.1.6.2.117 Type: MrfInfo + +**Table 6.1.6.2.117-1: Definition of type MrfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| mediaCapabilityList | array(MediaCapability) | O | 1..N | List of IMS media capabilities offered by the MRF. An IMS media capability that matches this information can be served by the MRF. (NOTE 1) | +| NOTE 1: Locality of MRF may be configured to allow the MRF consumers to discover and select candidate MRF based on Locality information. See NOTE 25 of Table 6.2.3.2.3.1-1. | | | | | + +## 6.1.6.2.118 Type: MrfpInfo + +**Table 6.1.6.2.118-1: Definition of type MrfpInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| mediaCapabilityList | array(MediaCapability) | O | 1..N | List of IMS media capabilities offered by the MRFP. An IMS media capability that matches this information can be served by the MRFP. (NOTE 1) | +| NOTE 1: Locality of MRFP may be configured to allow the MRFP consumers to discover and select candidate MRFP based on Locality information. See NOTE 25 of Table 6.2.3.2.3.1-1. | | | | | + +## 6.1.6.2.119 Type: MfInfo + +**Table 6.1.6.2.119-1: Definition of type MfInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| mediaCapabilityList | array(MediaCapability) | O | 1..N | List of media capabilities offered by the MF. A media capability that matches this information can be served by the MF. E.g. DC, AR. (NOTE 1) | +| NOTE 1: Locality of MF may be configured to allow the MF consumers to discover and select candidate MF based on Locality information. See NOTE 25 of Table 6.2.3.2.3.1-1. | | | | | + +## 6.1.6.2.120 Type: A2xCapability + +**Table 6.1.6.2.120-1: Definition of type A2xCapability** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lteA2x | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports LTE A2X capability:

- true: LTE A2X capability is supported by the PCF
- false (default): LTE A2X capability is not supported by the PCF. | +| nrA2x | boolean | O | 0..1 | When present, this IE shall indicate whether the PCF supports NR A2X capability:

- true: NR A2X capability is supported by the PCF
- false (default): NR A2X capability is not supported by the PCF. | + +## 6.1.6.2.121 Type: RuleSet + +Table 6.1.6.2.121-1: Definition of type RuleSet + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| priority | integer | M | 1 | Unique Priority of the rule. Lower value means higher priority. | +| plmns | array(PlmnId) | O | 1..N | PLMNs allowed/dis-allowed to access the service instance.

When absent, NF-Consumers of all PLMNs are assumed to match this criteria. | +| snpns | array(PlmnIdNid) | O | 1..N | SNPNs allowed/dis-allowed to access the service instance.

When absent, NF-Consumers of all SNPNs are assumed to match this criteria. | +| nfTypes | array(NFType) | O | 1..N | Type of the NFs allowed/dis-allowed to access the service instance.

When absent, NF-Consumers of all nfTypes are assumed to match this criteria. | +| nfDomains | array(string) | O | 1..N | Pattern (regular expression according to the ECMA-262 dialect [8]) representing the NF domain names within the PLMN of the NRF allowed/dis-allowed to access the service instance.

When absent, NF-Consumers of all nfDomains are assumed to match this criteria. | +| nssais | array(ExtSnssai) | O | 1..N | S-NSSAIs of the NF-Consumers allowed/dis-allowed to access the service instance.

When absent, NF-Consumers of all slices are assumed to match this criteria. | +| nfInstances | array(NfInstanceId) | O | 1..N | NF-Instance IDs of the NF-Consumers allowed/dis-allowed to access the NF/NF-Service instance.

When absent, all the NF-Consumers are assumed to match this criteria. | +| scopes | array(string) | O | 1..N | List of scopes allowed or denied to the NF-Consumers matching the rule.

The scopes shall be any of those defined in the API that defines the current service (identified by the "serviceName" attribute), including the service-level scopes.

When absent, the NF-Consumer is allowed or denied full access to all the resources/operations of service instance.

This IE is applicable only in NF-Service definition. | +| action | RuleSetAction | M | 1 | Specifies whether the scopes/access mentioned are allowed or denied for a specific NF-Consumer. | + +## 6.1.6.2.122 Type: AdrflInfo + +**Table 6.1.6.2.122-1: Definition of type AdrflInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mlModelStorageInd | boolean | O | 0..1 | When present, this IE shall indicate whether the ADRF supports ML model storage and retrieval:

- true: ML model storage capability is supported by the ADRF
- false (default): ML model storage capability is not supported by the ADRF. | +| dataStorageInd | boolean | O | 0..1 | When present, this IE shall indicate whether the ADRF supports data and analytics storage and retrieval capability:

- true: data and analytics storage and retrieval capability is supported by the ADRF.
- false (default): data and analytics storage and retrieval capability is not supported by the ADRF. | + +## 6.1.6.2.123 Type: SelectionConditions + +**Table 6.1.6.2.123-1: Definition of type SelectionConditions as a list of mutually exclusive alternatives** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ConditionItem | O | 0..1 | A single condition item that shall be evaluated (as or ) to determine whether a discovered NF (Service) Instance shall be selected. | +| ConditionGroup | O | 0..1 | A group of conditions (joined by a boolean "and" or "or" connector) that shall be evaluated (as or ) to determine whether a discovered NF (Service) Instance shall be selected. | + +## 6.1.6.2.124 Type: ConditionItem + +Table 6.1.6.2.124-1: Definition of type ConditionItem + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| consumerNfTypes | array(NFType) | O | 1..N |

The NF types of the consumers for which the conditions included in this ConditionItem apply.

If this attribute is absent, the conditions are applicable to all NF consumer types.

| +| serviceFeature | integer | O | 0..1 |

This attribute only applies when the selectionConditions, where this ConditionItem is included, is included in a NF Service Instance.

It represents a feature number of that NF Service Instance, under CANARY_RELEASE status.

This condition is evaluated to <true> when the service requests from a consumer of this NF Service Instance require the support of the indicated feature on the NF Service Instance.

EXAMPLE: If "serviceFeature" is set to 2, for a service instance of "nsmf-pdusession", such instance will only be selected for consumers supporting, and requiring the support from the NF Service producer, of the "MAPDU" (ATSSS) feature (see 3GPP TS 29.502, clause 6.1.8),.

| +| vsServiceFeature | integer | O | 0..1 |

This attribute only applies when the selectionConditions, where this ConditionItem is included, is included in a NF Service Instance.

It represents a Vendor-Specific feature number of that NF Service Instance, under CANARY_RELEASE status.

This condition is evaluated to <true> when the service requests from a consumer of this NF Service Instance require the support of the indicated Vendor-Specific feature on the NF Service Instance.

| +| supiRangeList | array(SupiRange) | O | 1..N | A set of SUPIs for which the NF (Service) instance under CANARY_RELEASE status shall be selected | +| gpsirangeList | array(IdentityRange) | O | 1..N | A set of GPSIs for which the NF (Service) instance under CANARY_RELEASE status shall be selected | +| impurangeList | array(IdentityRange) | O | 1..N | A set of IMS Public Identities for which the NF (Service) instance under CANARY_RELEASE status shall be selected. | +| impirangeList | array(IdentityRange) | O | 1..N | A set of IMS Private Identities for which the NF (Service) instance under CANARY_RELEASE status shall be selected | +| peiList | array(Pei) | O | 1..N | A set of PEIs of the UEs for which the NF (Service) instance under CANARY_RELEASE status shall be selected | +| tairangeList | array(TaiRange) | O | 1..N | A set of TAsIs where the NF (Service) instance under CANARY_RELEASE status shall be selected for a certain UE | +| dnnList | array(Dnn) | O | 1..N | A set of DNNs where the NF (Service) instance under CANARY_RELEASE status shall be selected. | +| NOTE 1: If several attributes (conditions) are present, the evaluation logic shall be the result of a boolean "AND" of the conditions expressed in the different attributes of this object. | | | | | +| NOTE 2: If an NF Service Consumer finds an unknown condition/attribute (e.g. because the attribute has been added in a later version of the specification), or if the NF Service Consumer does not have enough data to evaluate the condition, the result of the evaluation of such condition shall be . | | | | | + +## 6.1.6.2.125 Type: ConditionGroup + +**Table 6.1.6.2.125-1: Definition of type ConditionGroup** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------------------|----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| and | array(SelectionConditions) | C | 1..N | A list (array) of conditions where the overall evaluation is only if all the conditions in the list are evaluated as . | +| or | array(SelectionConditions) | C | 1..N | A list (array) of conditions where the overall evaluation is if at least one of the conditions in the list is evaluated as . | +| NOTE: Exactly one of either attribute "and" or attribute "or", but not both, shall be present. | | | | | + +## 6.1.6.2.126 Type: EpdgInfo + +**Table 6.1.6.2.126-1: Definition of type EpdgInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------------------------------------------|-----------------|---|-------------|-----------------------------------------------------------------------| +| ipv4EndpointAddresses | array(Ipv4Addr) | C | 1..N | Available endpoint IPv4 address(es) of the S2b-u terminations (NOTE). | +| ipv6EndpointAddresses | array(Ipv6Addr) | C | 1..N | Available endpoint IPv6 address(es) of the S2b-u terminations (NOTE). | +| NOTE: At least one of the addressing parameters (ipv4EndpointAddresses, ipv6EndpointAddresses) shall be included in the EpdgInfo. | | | | | + +## 6.1.6.2.127 Type: CallbackUriPrefixItem + +**Table 6.1.6.2.127-1: Definition of type CallbackUriPrefixItem** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------------------------------------------------------------------------------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| callbackUriPrefix | string | M | 1 | Optional path segment(s) used to construct the prefix of the Callback URIs during the reselection of an NF service consumer, as described in 3GPP TS 29.501 [5], clause 4.4.3 | +| notificationTypes | array(string) | M | 0..N | List of notification type values using the callback URI prefix of the callbackUriPrefix IE.
Each notification type value shall be encoded as defined in Annex B of 3GPP TS 29.500 [4].
When this IE is set with an empty array, the callback URI prefix indicated in the callbackUriPefix IE shall be used for all notification types not present in any other CallbackUriPrefixItem entry of the callbackUriPrefixList IE. | +| NOTE: A given notification type value shall be associated with only one callbackUriPrefix value. | | | | | + +## 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 | +|-----------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NefId | string | The NEF ID as specified in clause 4.25.2 of 3GPP TS 23.502 [3].

For combined SCEF+NEF, the NEF ID shall contain the SCEF ID encoded as specified in clause 8.4.5 of 3GPP TS 29.336 [37]. | +| VendorId | string | Vendor ID, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [38].
It shall be formatted as a fixed 6-digit string, padding with leading digits "0" to complete a 6-digit length.

Pattern: "[0-9]{6}\$" | +| WildcardDnai | string | String representing the Wildcard DNAI.
It shall contain the string "*".
Pattern: "^[*]\$" | +| ImsDomainName | string | The IMS domain name. | +| MediaCapability | string | String representing the media capability offered by NF instance.
Pattern: "[a-zA-Z0-9_ ]+\$" | + +### 6.1.6.3.3 Enumeration: NFType + +The enumeration NFType represents the different types of Network Functions or Network Entities that can be found in the 5GC. + +**Table 6.1.6.3.3-1: Enumeration NFType** + +| Enumeration value | Description | +|-------------------|------------------------------------| +| "NRF" | Network Function: NRF | +| "UDM" | Network Function: UDM | +| "AMF" | Network Function: AMF | +| "SMF" | Network Function: SMF | +| "AUSF" | Network Function: AUSF | +| "NEF" | Network Function: NEF | +| "PCF" | Network Function: PCF | +| "SMSF" | Network Function: SMSF | +| "NSSF" | Network Function: NSSF | +| "UDR" | Network Function: UDR | +| "LMF" | Network Function: LMF | +| "GMLC" | Network Function: GMLC | +| "5G_EIR" | Network Function: 5G-EIR | +| "SEPP" | Network Entity: SEPP | +| "UPF" | Network Function: UPF | +| "N3IWF" | Network Function and Entity: N3IWF | +| "AF" | Network Function: AF | +| "UDSF" | Network Function: UDSF | +| "BSF" | Network Function: BSF | +| "CHF" | Network Function: CHF | +| "NWDAF" | Network Function: NWDAF | +| "PCSCF" | Network Function: P-CSCF | +| "CBCF" | Network Function: CBCF | +| "UCMF" | Network Function: UCMF | +| "HSS" | Network Function: HSS | +| "SOR_AF" | Network Function: SOR-AF | +| "SPAF" | Network Function: SP-AF | +| "MME" | Network Function: MME | +| "SCSAS" | Network Function: SCS/AS | +| "SCEF" | Network Function: SCEF | +| "SCP" | Network Entity: SCP | +| "NSSAAF" | Network Function: NSSAAF | +| "ICSCF" | Network Function: I-CSCF | +| "SCSCF" | Network Function: S-CSCF | +| "DRA" | Network Function: DRA | +| "IMS_AS" | Network Function: IMS-AS | +| "AANF" | Network Function: AAnF | +| "5G_DDNMF" | Network Function: 5G DDNMF | +| "NSACF" | Network Function: NSACF | +| "MFAF" | Network Function: MFAF | +| "EASDF" | Network Function: EASDF | +| "DCCF" | Network Function: DCCF | +| "MB_SMF" | Network Function: MB-SMF | +| "TSCTSF" | Network Function: TSCTSF | +| "ADRF" | Network Function: ADRF | +| "GBA_BSF" | Network Function: GBA BSF | +| "CEF" | Network Function: CEF | +| "MB_UPF" | Network Function: MB-UPF | +| "NSWOF" | Network Function: NSWOF | +| "PKMF" | Network Function: PKMF | +| "MNPf" | Network Function: MNPf | +| "SMS_GMSC" | Network Function: SMS-GMSC | +| "SMS_IWMSC" | Network Function: SMS-IWMSC | +| "MBSF" | Network Function: MBSF | +| "MBSTF" | Network Function: MBSTF | +| "PANF" | Network Function: PANF | +| "DCSF" | Network Function: DCSF | +| "MRF" | Network Function: MRF | +| "MRFP" | Network Function: MRFP | +| "MF" | Network Function: MF | +| "SLPKMF" | Network Function: SLPKMF | + + + +#### 6.1.6.3.4 Enumeration: NotificationType + +**Table 6.1.6.3.4-1: Enumeration NotificationType** + +| Enumeration value | Description | +|--------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "N1_MESSAGES" |

Notification of N1 messages.

This notification type may be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2) or as part of a specific service instance.

If the AMF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "namf-comm" or with a custom service.

If the LMF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "nlmf-loc" or with a custom service.

| +| "N2_INFORMATION" |

Notification of N2 information.

This notification type may be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2) or as part of a specific service instance.

If the AMF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "namf-comm" or with a custom service.

If the LMF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "nlmf-loc" or with a custom service.

| +| "LOCATION_NOTIFICATION" |

Notification of Location Information sent by AMF/LMF towards NF Service Consumers (e.g GMLC).

This notification type may be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2) or as part of a specific service instance.

If the the GMLC registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "ngmlc-loc" or with a custom service.

| +| "DATA_REMOVAL_NOTIFICATION" |

Notification of Data Removal sent by UDR (e.g., removal of UE registration data upon subscription withdrawal).

This notification type shall be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2).

| +| "DATA_CHANGE_NOTIFICATION" |

Notification of Data Changes sent by UDR.

This notification type shall be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2).

| +| "LOCATION_UPDATE_NOTIFICATION" |

Notification of UE Location Information Update sent by GMLC towards NF Service Consumers (e.g. H-GMLC, NEF), during MO_LR procedure.

This notification type may be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2) or as part of a specific service instance.

If the the GMLC registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "ngmlc-loc" or with a custom service.

If the the NEF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "nnef-eventexposure" or with a custom service.

| +| "NSSAA_REAUTH_NOTIFICATION" |

Re-authentication notification for slice-specific authentication and authorization sent by NSSAAF towards NF Service

| + +| | | +|---------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | Consumers (e.g. AMF).

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | +| "NSSAA_REVOC_NOTIFICATION" | Revocation notification for slice-specific authentication and authorization sent by NSSAAF towards NF Service Consumers (e.g. AMF).

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | +| "MATCH_INFO_NOTIFICATION" | Notification of a matching result, and the information that can be used for charging purpose by 5G DDNMF towards NF Service Consumers (e.g. 5G DDNMF), during Discovery Reporting procedures.

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | +| "DATA_RESTORATION_NOTIFICATION" | Notification by UDR to its NF Service Consumers (e.g. UDM, PCF, NEF...) or by UDM to its NF Service Consumers (e.g. AMF, SMF, SMSF...) of a potential data-loss event originated at UDR. The content of the notification shall be as described in 3GPP TS 29.503 [36], clause 5.3.2.12.2 and 6.2.5.4.

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | +| "TSCTS_NOTIFICATION" | Notification sent by PCF to TSCTSF of TSC user-plane node information. The content of the notification is described in 3GPP TS 29.514 [47], clause 4.2.5.16.

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | +| "LCS_KEY_DELIVERY_NOTIFICATION" | Notification sent by LMF to AMF to deliver ciphering key information.

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | +| "UUAA_MM_AUTH_NOTIFICATION" | Authentication notification sent by UAS-NF towards NF Service Consumers (i.e. AMF), during USS Initiated reauthorization, update authorization data or revoke authorization with UUAA-MM procedures.

This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. | + +### 6.1.6.3.5 Enumeration: TransportProtocol + +**Table 6.1.6.3.5-1: Enumeration TransportProtocol** + +| Enumeration value | Description | +|-------------------|-------------------------| +| "TCP" | Transport protocol: TCP | + +### 6.1.6.3.6 Enumeration: NotificationEventType + +**Table 6.1.6.3.6-1: Enumeration NotificationEventType** + +| Enumeration value | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------| +| "NF_REGISTERED" | The NF Instance has been registered in NRF | +| "NF_DEREGISTERED" | The NF Instance has been deregistered from NRF (NOTE) | +| "NF_PROFILE_CHANGED" | The profile of the NF Instance has been modified (NOTE) | +| NOTE: A change of the NFStatus value shall be notified as "NF_PROFILE_CHANGED" event, except if the NFStatus is set to value "CANARY_RELEASE" and the subscribing entity does not support the "Canary-Release" feature; in such case, the subscribing entity shall be notified as a "NF_DEREGISTERED" event. | | + +### 6.1.6.3.7 Enumeration: NFStatus + +**Table 6.1.6.3.7-1: Enumeration NFStatus** + +| Enumeration value | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "REGISTERED" | The NF Instance is registered in NRF and can be discovered by other NFs. | +| "SUSPENDED" | The NF Instance is registered in NRF but it is not operative and cannot be discovered by other NFs.
This status may result from a NF Heart-Beat failure (see clause 5.2.2.3.2) or a NF failure and may trigger restoration procedures (see clause 6.2 of 3GPP TS 23.527 [27]). | +| "UNDISCOVERABLE" | The NF instance is registered in NRF, is operative but cannot be discovered by other NFs.
This status may be set by the NF e.g. in shutting down scenarios where the NF is still able to process requests for existing resources or sessions but cannot accept new resource creation or session establishment. | +| "CANARY_RELEASE" | The NF instance is registered in NRF, is operative and can be discovered and selected by other NFs under certain conditions (see SelectionConditions, in clause 6.1.6.2.123).

This status may be set by the NF e.g. in upgrade scenarios or during canary testing scenarios where the NF is able to process requests for new resource creation or session establishment under certain conditions (e.g. for a restricted set of users).

(NOTE 2) | +| NOTE 1: An NF instance cannot be discovered by other NFs if the NF status is set to "SUSPENDED" or "UNDISCOVERABLE". | | +| NOTE 2: A discovered NF instance with NFStatus "CANARY_RELEASE" shall only be selected by an NF Service Consumer if the conditions included in the "selectionConditions" attribute of the NFProfile are evaluated to ; if such attribute is not included, the NF instance shall not be selected. | | + +### 6.1.6.3.8 Enumeration: DataSetId + +The enumeration DataSetId represents the different types of data sets supported by an UDR instance. + +**Table 6.1.6.3.8-1: Enumeration DataSetId** + +| Enumeration value | Description | +|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "SUBSCRIPTION" | Data set: Subscription data | +| "POLICY" | Data set: Policy data (including all defined subsets) | +| "EXPOSURE" | Data set: Structured data for exposure | +| "APPLICATION" | Data set: Application data (including all defined subsets) | +| "A_PFD" | ApplicationData subset: Packet Flow Descriptions | +| "A_AFTI" | ApplicationData subset: AF Traffic Influence Data | +| "A_AFQOS" | ApplicationData subset: AF Requested QoS Data | +| "A_IPTV" | ApplicationData subset: IPTV Config Data | +| "A_BDT" | ApplicationData subset: Background Data Transfer | +| "A_SPD" | ApplicationData subset: Service Parameter Data | +| "A_EASD" | ApplicationData subset: EAS Deployment Information | +| "A_AMI" | ApplicationData subset: AM Influence Data | +| "P_UE" | PolicyData subset: UE Specific Data | +| "P_SCD" | PolicyData subset: Sponsored Connectivity Data | +| "P_BDT" | PolicyData subset: Background Data Transfer | +| "P_PLMNUE" | PolicyData subset: PLMN specific UE policy data | +| "P_NSSCD" | PolicyData subset: Network Slice Specific Control Data | +| "P_PDTQ" | PolicyData subset: Planned Data Transfer with QoS requirements Data | +| "P_MBSCD" | PolicyData subset: MBS Session Policy Control Data | +| "P_GROUP" | PolicyData subset: Group Policy Control Data | +| NOTE: | Enumeration values identifying an ApplicationData subset or PolicyData subset should not be used in NF discovery requests unless UDR and NRF have been upgraded to support these values.
If the UDR registers all defined ApplicationData subset values and/or all defined PolicyData subset values, it shall also register the ApplicationData data set value and/or PolicyData data set value.
The UDR that registers the Application Data set value and/or the Policy Data set value shall also register all defined ApplicationData subset values and/or PolicyData subset values. | + +## 6.1.6.3.9 Enumeration: UPInterfaceType + +**Table 6.1.6.3.9-1: Enumeration UPInterfaceType** + +| Enumeration value | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------| +| "N3" | User Plane Interface: N3 (or N3 for 3GPP Access, see NOTE 2) | +| "N6" | User Plane Interface: N6 | +| "N9" | User Plane Interface: N9 (or N9 for non-roaming, see NOTE 3) | +| "DATA_FORWARDING" | User Plane Interface for indirect data forwarding. (NOTE 1) | +| "N6MB" | User Plane Interface: N6mb | +| "N19MB" | User Plane Interface: N19mb | +| "N3MB" | User Plane Interface: N3mb | +| "NMB9" | User Plane Interface: Nmb9 | +| "S1U" | User Plane Interface: S1-U | +| "S5U" | User Plane Interface: S5-U | +| "S8U" | User Plane Interface: S8-U | +| "S11U" | User Plane Interface: S11-U | +| "S12" | User Plane Interface: S12 | +| "S2AU" | User Plane Interface: S2AU | +| "S2BU" | User Plane Interface: S2BU | +| "N3TRUSTEDN3GPP" | User Plane Interface: N3 Trusted Non-3GPP access | +| "N3UNTRUSTEDN3GPP" | User Plane Interface: N3 Untrusted Non-3GPP access | +| "N9ROAMING" | User Plane Interface: N9 for roaming interface | +| "SGI" | User Plane Interface: SGI | +| "N19" | User Plane Interface: N19 | +| "SXAU" | User Plane Interface: Sxa-U | +| "SXBU" | User Plane Interface: Sxb-U | +| "N4U" | User Plane Interface: N4-U | +| NOTE 1: This interface type may be used when a dedicated network instance is deployed for data forwarding. | | +| NOTE 2: If separation of N3 traffic from 3GPP access and non-3GPP access is required for a PLMN, this value should only be used for the N3 for 3GPP access. | | +| NOTE 3: If separation of roaming and non-roaming traffic is desired over N9, this value should only be used for N9 non-roaming interfaces. | | + +## 6.1.6.3.10 Relation Types + +## 6.1.6.3.10.1 General + +This clause describes the possible relation types defined within NRF API. See clause 4.7.5.2 of 3GPP TS 29.501 [5] for the description of the relation types. + +**Table 6.1.6.3.10.1-1: supported registered relation types** + +| Relation Name | +|---------------| +| self | +| item | + +6.1.6.3.11 Enumeration: ServiceName + +**Table 6.1.6.3.11-1: Enumeration ServiceName** + +| Enumeration value | Description | +|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| "nnrf-nfm" | Nnrf_NFManagement Service offered by the NRF | +| "nnrf-disc" | Nnrf_NFDiscovery Service offered by the NRF | +| "nnrf-oauth2" | Nnrf_AccessToken Service offered by the NRF | +| "nudm-sdm" | Nudm_SubscriberDataManagement Service offered by the UDM | +| "nudm-uecm" | Nudm_UEContextManagement Service offered by the UDM | +| "nudm-ueau" | Nudm_UEAuthentication Service offered by the UDM | +| "nudm-ee" | Nudm_EventExposure Service offered by the UDM | +| "nudm-pp" | Nudm_ParameterProvision Service offered by the UDM | +| "nudm-niddau" | Nudm_NIDDAuthorization Service offered by the UDM | +| "nudm-mt" | Nudm_MT Service offered by the UDM | +| "nudm-ssau" | Nudm_ServiceSpecificAuthorization Service offered by the UDM | +| "nudm-rsds" | Nudm_ReportSMDeliveryStatus Service offered by the UDM | +| "nudm-ueid" | Nudm_UEIdentifier Service offered by the UDM | +| "namf-comm" | Namf_Communication Service offered by the AMF | +| "namf-evts" | Namf_EventExposure Service offered by the AMF | +| "namf-mt" | Namf_MT Service offered by the AMF | +| "namf-loc" | Namf_Location Service offered by the AMF | +| "namf-mbs-comm" | Namf_MBSCommunication Service offered by AMF | +| "namf-mbs-bc" | Namf_MBSBroadcast Service offered by AMF | +| "nsmf-pdusession" | Nsmf_PDUSession Service offered by the SMF | +| "nsmf-event-exposure" | Nsmf_EventExposure Service offered by the SMF | +| "nsmf-nidd" | Nsmf_NIDD Service offered by the SMF | +| "nausf-auth" | Nausf_UEAuthentication Service offered by the AUSF | +| "nausf-sorprotection" | Nausf_SoRProtection Service offered by the AUSF | +| "nausf-upuprotection" | Nausf_UPUProtection Service offered by the AUSF | +| "nnef-pfdmanagement" | Nnef_PFDManagement offered by the NEF | +| "nnef-smcontext" | Nnef_SMContext Service offered by the NEF | +| "nnef-eventexposure" | Nnef_EventExposure Service offered by the NEF | +| "nnef-eas-deployment-info" | Nnef_EASDeployment InfoService offered by the NEF. This is the southbound part of the API (e.g. the service operations used by the SMF) | +| "nnef-dnai-mapping" | Nnef_DNAIMapping Service offered by the NEF | +| "nnef-traffic-influence-data" | Nnef_TrafficInfluenceData Service offered by the NEF | +| "nnef-ecs-addr-cfg-info" | Nnef_ECSAddress Service offered by the NEF | +| "3gpp-cp-parameter-provisioning" | Nnef_ParameterProvision Service offered by the NEF | +| "3gpp-device-triggering" | Nnef_Trigger Service offered by the NEF | +| "3gpp-bdt" | Nnef_BDTPNegotiation Service offered by the NEF | +| "3gpp-traffic-influence" | Nnef_TrafficInfluence Service offered by the NEF | +| "3gpp-chargeable-party" | Nnef_ChargeableParty Service offered by the NEF | +| "3gpp-as-session-with-qos" | Nnef_AFSsessionWithQoS Service offered by the NEF | +| "3gpp-msisdn-less-mo-sms" | Nnef_MSISDN-less_MO_SMS Service offered by the NEF | +| "3gpp-service-parameter" | Nnef_ServiceParameter Service offered by the NEF | +| "3gpp-monitoring-event" | Nnef_APISupportCapability Service offered by the NEF | +| "3gpp-nidd-configuration-trigger" | Nnef_NIDDConfiguration Service offered by the NEF | +| "3gpp-nidd" | Nnef_NIDD Service offered by the NEF | +| "3gpp-analyticsexposure" | Nnef_AnalyticsExposure Service offered by the NEF | +| "3gpp-racs-parameter-provisioning" | Nnef_UCMFProvisioning Service offered by the NEF | +| "3gpp-ecr-control" | Nnef_ECRestriction Service offered by the NEF | +| "3gpp-applying-bdt-policy" | Nnef_ApplyPolicy Service offered by the NEF | +| "3gpp-mo-lcs-notify" | Nnef_Location Service offered by the NEF | +| "3gpp-time-sync" | Nnef_TimeSynchronization Service offered by the NEF | +| "3gpp-am-influence" | Nnef_AMInfluence Service offered by the NEF | +| "3gpp-am-policyauthorization" | Nnef_AMPolicyAuthorization | +| "3gpp-akma" | Nnef_AKMA Service offered by the NEF | +| "3gpp-eas-deployment" | Nnef_EASDeployment Service offered by the NEF. This is the northbound part (e.g. the service operations used by the AF). | +| "3gpp-iptvconfiguration" | Nnef_IPTV_configuration Service offered by the NEF | +| "3gpp-mbs-tmgi" | Nnef_MBSTMGI Service offered by the NEF | +| "3gpp-mbs-session" | Nnef_MBSSession Service offered by the NEF | +| "3gpp-authentication" | Nnef_Authentication Service offered by the NEF | +| "3gpp-asti" | Nnef_ASTI Service offered by the NEF | +| "3gpp-pdtq-policy-negotiation" | Nnef_PDTQPolicyNegotiation offered by the NEF | + +| | | +|--------------------------------|--------------------------------------------------------------| +| "3gpp-musa" | Nnef_MemberUESelectionAssistance offered by the NEF | +| "npcf-am-policy-control" | Npcf_AMPolicyControl Service offered by the PCF | +| "npcf-smpolicycontrol" | Npcf_SMPolicyControl Service offered by the PCF | +| "npcf-policyauthorization" | Npcf_PolicyAuthorization Service offered by the PCF | +| "npcf-bdtpolicycontrol" | Npcf_BDTPolicyControl Service offered by the PCF | +| "npcf-eventexposure" | Npcf_EventExposure Service offered by the PCF | +| "npcf-ue-policy-control" | Npcf_UEPolicyControl Service offered by the PCF | +| "npcf-am-policyauthorization" | Npcf_AM_PolicyAuthorization Service offered by the PCF | +| "npcf-pdtq-policy-control" | Npcf_PDTQPolicyControl Service offered by the PCF | +| "npcf-mbspolicycontrol" | Npcf_MBSPolicyControl Service offered by the PCF | +| "npcf-mbspolicyauth" | Npcf_MBSPolicyAuthorization Service offered by the PCF | +| "nsmf-sms" | Nsmf_SMSService Service offered by the SMSF | +| "nssf-nselection" | Nssf_NSSelection Service offered by the NSSF | +| "nssf-nssaiavailability" | Nssf_NSSAIAvailability Service offered by the NSSF | +| "nudr-dr" | Nudr_DataRepository Service offered by the UDR | +| "nudr-group-id-map" | Nudr_GroupIDmap Service offered by the UDR | +| "nlmf-loc" | Nlmf_Location Service offered by the LMF | +| "n5g-eir-eic" | N5g-eir_EquipmentIdentityCheck Service offered by the 5G-EIR | +| "nbsf-management" | Nbsf_Management Service offered by the BSF | +| "nchf-spendinglimitcontrol" | Nchf_SpendingLimitControl Service offered by the CHF | +| "nchf-convergedcharging" | Nchf_Converged_Charging Service offered by the CHF | +| "nchf-offlineonlycharging" | Nchf_OfflineOnlyCharging Service offered by the CHF | +| "nnwdaf-eventssubscription" | Nnwdaf_EventsSubscription Service offered by the NWDAF | +| "nnwdaf-analyticsinfo" | Nnwdaf_AnalyticsInfo Service offered by the NWDAF | +| "nnwdaf-datamanagement" | Nnwdaf_DataManagement Service offered by the NWDAF | +| "nnwdaf-mlmodelprovision" | Nnwdaf_MLModelProvision Service offered by the NWDAF | +| "nnwdaf-mlmodeltraining" | Nnwdaf_MLModelTraining Service offered by the NWDAF | +| "nnwdaf-mlmodelmonitor" | Nnwdaf_MLModelMonitor Service offered by the NWDAF | +| "ngmlc-loc" | Ngmlc_Location Service offered by GMLC | +| "nucmf-provisioning" | Nucmf_Provisioning Service offered by UCMF | +| "nucmf-uecapabilitymanagement" | Nucmf_UECapabilityManagement Service offered by UCMF | +| "nhss-sdm" | Nhss_SubscriberDataManagement Service offered by the HSS | +| "nhss-uecm" | Nhss_UEContextManagement Service offered by the HSS | +| "nhss-ueau" | Nhss_UEAuthentication Service offered by the HSS | +| "nhss-ee" | Nhss_EventExposure Service offered by the HSS | +| "nhss-ims-sdm" | Nhss_imsSubscriberDataManagement Service offered by the HSS | +| "nhss-ims-uecm" | Nhss_imsUEContextManagement Service offered by the HSS | +| "nhss-ims-ueau" | Nhss_imsUEAuthentication Service offered by the HSS | +| "nhss-gba-sdm" | Nhss_gbaSubscriberDataManagement Service offered by the HSS | +| "nhss-gba-ueau" | Nhss_gbaUEAuthentication Service offered by the HSS | +| "nsepp-telescopic" | Nsepp_Telescopic_FQDN_Mapping Service offered by the SEPP | +| "nsoraf-sor" | Nsoraf_SteeringOfRoaming Service offered by the SOR-AF | +| "nspaf-secured-packed" | Nspaf_SecuredPacket Service offered by the SP-AF | +| "nudsf-dr" | Nudsf_Data Repository service offered by the UDSF. | +| "nudsf-timer" | Nudsf_Timer service offered by the UDSF | +| "nnssAAF-nssaa" | NnssAAF_NSSAA service offered by the NSSAAF. | +| "nnssAAF-aiw" | NnssAAF_AIW service offered by the NSSAAF. | +| "naanf-akma" | Naanf_AKMA service offered by the AAnF. | +| "n5gddnmf-discovery" | N5g-ddnmf_Discovery service offered by 5G DDNMF | +| "nmfaf-3dadm" | Nmfaf_3daDataManagement service offered by the MFAF. | +| "nmfaf-3cadm" | Nmfaf_3caDataManagement service offered by the MFAF. | +| "neasdf-dnscontext" | Neasdf_DNSContext service offered by the EASDF | +| "neasdf-baselinednspattern" | Neasdf_BaselineDNSPattern service offered by the EASDF | +| "ndccf-dm" | Ndccf_DataManagement service offered by the DCCF. | +| "ndccf-cm" | Ndccf_ContextManagement service offered by the DCCF. | +| "nnsacf-nsac" | Nnsacf_NSAC service offered by the NSACF. | +| "nnsacf-slice-ee" | Nnsacf_SliceEventExposure service offered by the NSACF. | +| "nmbsmf-tmgi" | Nmbsmf_TMGI service offered by the MB-SMF | +| "nmbsmf-mbssession" | Nmbsmf_MBSSession service offered by the MB-SMF | +| "nadrf-dm" | Nadrf_DataManagement service offered by the ADRF. | +| "nadrf-mlmodelmanagement" | Nadrf_MLModelManagement service offered by the ADRF. | + +| | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------| +| "nbsp-gba" | Nbsp_GBA service offered by the GBA BSF. | +| "ntsctsf-time-sync" | Ntsctsf_TimeSynchronization service offered by the TSCTSF | +| "ntsctsf-qos-tscai" | Ntsctsf_QoSAndTSCAssistance service offered by the TSCTSF | +| "ntsctsf-asti" | Ntsctsf_ASTI service offered by the TSCTSF | +| "npkmf-keyrequest" | Npkmf_PKMFKeyRequest service offered by the PKMF | +| "npkmf-userid" | Npkmf_ResolveRemoteUserId service offered by the PKMF | +| "npkmf-discovery" | Npkmf_Discovery service offered by the PKMF | +| "nmnpf-npstatus" | Nmnpf_NPStatus service offered by the MNPF | +| "niwmsc-smsservice" | Niwmsc_SMSService service offered by the SMS-IWMSC | +| "nmbsf-mbs-us" | Nmbsf_MBSUserService service offered by the MBSF | +| "nmbsf-mbs-ud-ingest" | Nmbsf_MBSUserDataIngestSession service offered by the MBSF | +| "nmbstf-distsession" | Nmbstf_MBSDistributionSession service offered by the MBSTF | +| "npanf-prosekey" | Npanf_ProseKey service offered by the PANF | +| "npanf-userid" | Npanf_ResolveRemoteUserId service offered by the PANF | +| "nupf-ee" | Nupf_EventExposure service offered by the UPF | +| "nupf-gueip" | Nupf_GetUEPrivateIPAddrAndIdentifiers Service offered by the UPF | +| "naf-prose" | Naf_ProSe Service offered by the AF | +| "naf-eventexposure" | Naf_EventExposure Service offered by the AF | +| NOTE: The services defined in this table are those defined by 3GPP NFs in 5GC; however, in order to support custom services offered by standard and custom NFs, the NRF shall also accept the registration of NF Services with other service names. | | + +#### 6.1.6.3.12 Enumeration: NFServiceStatus + +**Table 6.1.6.3.12-1: Enumeration NFServiceStatus** + +| Enumeration value | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "REGISTERED" | The NF Service Instance is registered in NRF and can be discovered by other NFs.
(NOTE 2) | +| "SUSPENDED" | The NF Service Instance is registered in NRF but it is not operative and cannot be discovered by other NFs.
This status may result from a NF Service failure and may trigger restoration procedures (see clause 6.2 of 3GPP TS 23.527 [27]). | +| "UNDISCOVERABLE" | The NF Service instance is registered in NRF, is operative but cannot be discovered by other NFs.
This status may be set by the NF e.g. in shutting down scenarios where the NF service is still able to process requests for existing resources or sessions but cannot accept new resource creation or session establishment. | +| "CANARY_RELEASE" | The NF Service Instance is registered in NRF, is operative and can be discovered and selected by other NFs under certain conditions (see SelectionConditions, in clause 6.1.6.2.123).

This status may be set by the NF e.g. in upgrade scenarios or during canary testing scenarios where the NF is able to process requests for new resource creation or session establishment under certain conditions (e.g. for a restricted set of users).

(NOTE 3) | +| NOTE 1: An NF service cannot be discovered by other NFs if the NF status is set to "SUSPENDED" or "UNDISCOVERABLE", regardless of the NF service status. | | +| NOTE 2: A discovered NF service instance with NFServiceStatus set to "REGISTERED", and with NFStatus of the NF Instance set to "CANARY_RELEASE", shall only be selected by an NF Service Consumer if the conditions included in the "selectionConditions" attribute of the NFProfile are evaluated to ; if such attribute is not included in NFProfile, the NF service instance shall not be selected. | | +| NOTE 3: A discovered NF service instance with NFServiceStatus "CANARY_RELEASE" shall only be selected by an NF Service Consumer if the conditions included in the "selectionConditions" attribute of the NFService are evaluated to ; if such attribute is not included in NFService, the NF service instance shall not be selected. | | + +## 6.1.6.3.13 Enumeration: AnNodeType + +**Table 6.1.6.3.13-1: Enumeration AnNodeType** + +| Enumeration value | Description | +|-------------------|-------------| +| "GNB" | gNB | +| "NG_ENB" | NG-eNB | + +## 6.1.6.3.14 Enumeration: ConditionEventType + +**Table 6.1.6.3.14-1: Enumeration ConditionEventType** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------------------------------| +| "NF_ADDED" | The NF Instance notified by NRF starts being part of a condition for a subscription on a set of NFs. | +| "NF_REMOVED" | The NF Instance notified by NRF stops being part of a condition for a subscription on a set of NFs. | + +## 6.1.6.3.15 Enumeration: IpReachability + +**Table 6.1.6.3.15-1: Enumeration IpReachability** + +| Enumeration value | Description | +|-------------------|-------------------------------------------------------| +| "IPv4" | Only IPv4 addresses are reachable. | +| "IPv6" | Only IPv6 addresses are reachable. | +| "IPv4V6" | Both IPv4 addresses and IPv6 addresses are reachable. | + +## 6.1.6.3.16 Enumeration: ScpCapability + +**Table 6.1.6.3.16-1: Enumeration ScpCapability** + +| Enumeration value | Description | +|--------------------------------|-----------------------------------------------------------| +| "INDIRECT_COM_WITH_DELEG_DISC" | Indirect communication with delegated discovery supported | + +## 6.1.6.3.17 Enumeration: CollocatedNfType + +**Table 6.1.6.3.17-1: Enumeration CollocatedNfType** + +| Enumeration value | Description | +|-------------------|--------------------------| +| "UPF" | Network function: UPF | +| "SMF" | Network function: SMF | +| "MB_UPF" | Network function: MB-UPF | +| "MB_SMF" | Network function: MB-SMF | + +## 6.1.6.3.18 Enumeration: LocalityType + +**Table 6.1.6.3.18-1: Enumeration LocalityType** + +| Enumeration value | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| "DATA_CENTER" | Data center | +| "CITY" | City | +| "COUNTY" | County | +| "DISTRICT" | District | +| "STATE" | State | +| "CANTON" | Canton | +| "REGION" | Region | +| "PROVINCE" | Province | +| "PREFECTURE" | Prefecture | +| "COUNTRY" | Country | +| NOTE 1: An operator may define custom locality types other than those defined in this table. The NRF and NFs shall accept locality types defined with custom locality type values. | | +| NOTE 2: The NRF needs not understand the semantic of the LocalityType enumeration values. The LocalityType information is used by the NRF to correlate a locality description received in the ext-preferred-locality query parameter with a locality description registered in the extLocality attribute of NFProfile with a matching LocalityType. | | + +## 6.1.6.3.19 Enumeration: FICapabilityType + +**Table 6.1.6.3.19-1: Enumeration FICapabilityType** + +| Enumeration value | Description | +|------------------------|----------------------------------------------------------------| +| "FL_SERVER" | NWDAF containing MTLF as Federated Learning server. | +| "FL_CLIENT" | NWDAF containing MTLF as Federated Learning client. | +| "FL_SERVER_AND_CLIENT" | NWDAF containing MTLF as Federated Learning server and client. | + +## 6.1.6.3.20 Void + +## 6.1.6.3.21 Enumeration: RuleSetAction + +**Table 6.1.6.3.21-1: Enumeration RuleSetAction** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------| +| "ALLOW" | The NF consumer is allowed to access NF producer | +| "DENY" | The NF consumer is not allowed to access NF Producer | + +## 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 application errors defined for the Nnrf\_NFManagement service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|--------------------------|-------------------------|---------------------------------------------------------------------------------------------------------| +| SUBSCRIPTION_NOT_ALLOWED | 403 Forbidden | It is used when the validation of the authorization parameters in the subscription request has failed. | +| NF_NOT_FOUND | 404 Not Found | It is used when no NFProfile corresponding to the NF Instance Id in NfInstanceIdCond exists in the NRF. | + +## 6.1.8 Security + +As indicated in clause 13.3 of 3GPP TS 33.501 [15], when static authorization is not used, the access to the Nnrf\_NFManagement API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [16]), using the "Client Credentials" authorization grant, where the NRF plays the role of the authorization server. + +If OAuth2 authorization is used on the Nnrf\_NFManagement API, 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 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 Nnrf\_NFManagement service is invoked by the NF Service Producer. + +The Nnrf\_NFManagement API defines the following scopes for OAuth2 authorization: + +**Table 6.1.8-1: OAuth2 scopes defined in Nnrf\_NFManagement API** + +| Scope | Description | +|------------------------------------------------|------------------------------------------------------------------------------------| +| "nnrf-nfm" | Access to the Nnrf_NFManagement API | +| "nnrf-nfm:nf-instances:read" | Access to read the nf-instances resource, or an individual NF Instance ID resource | +| "nnrf-nfm:subscriptions:subs-complete-profile" | Access to subscribe to the complete profile of NF instances | +| "nnrf-nfm:nf-instance:write" | Access to write (create, update, delete) an individual NF Instance ID resource | + +## 6.1.9 Features supported by the NFManagement service + +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 Nnrf\_NFManagement service. + +**Table 6.1.9-1: Features of supportedFeatures attribute used by Nnrf\_NFManagement service** + +| Feature Number | Feature | M/O | Description | +|----------------|-------------------------------|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Service-Map | M | Support of defining in the profile of the NF Instance the list of NF Service Instances based on a map type (i.e. support of the "nfServiceList" attribute in NFProfile). | +| 2 | Empty-Objects-Nrf-Info | O | Support of receiving empty JSON objects as values in the servedxxxInfo/servedxxxInfoList map attributes of the NrfInfo data structure used by an NRF during registration into another NRF (see clause 6.1.6.2.31).

An NRF that supports registering into another NRF shall support this feature. | +| 3 | Inter-Plmn-Fqdn | M | Support of receiving intra-PLMN notification of changes in the NFProfile/NFService containing the "interPlmnFqdn" attribute (see clauses 6.1.6.2.2 and 6.1.6.2.3).

The NRF shall not send intra-PLMN notifications containing the "interPlmnFqdn" attribute to subscribing NF Instances that don't support this feature. | +| 4 | Complete-Profile-Subscription | O | Support subscriptions to the complete NF Profile of NF Instances (including, e.g. the authorization attributes) and their notifications. | +| 5 | Allowed-ruleset | O | Support registering RuleSets in NF (Service) profile | +| 6 | Canary-Release | O | Support of "CANARY_RELEASE" value for NFStatus and NFServiceStatus, used for e.g. canary testing | + +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 Nnrf\_NFDiscovery Service API + +### 6.2.1 API URI + +The API URI of the Nnrf\_NFDiscovery 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}** + +where: + +- the {apiRoot} shall be set as defined in clause 4.4.1 of 3GPP TS 29.501 [5]; +- the shall be set to "nnrf-disc"; +- the shall be set to "v1" for the current version of this specification; +- 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 [9], 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 Nnrf\_NFDiscovery service shall comply with the OpenAPI [10] specification contained in Annex A. + +## 6.2.2.2 HTTP standard headers + +### 6.2.2.2.1 General + +The mandatory standard HTTP headers as specified in clause 5.2.2.2 of 3GPP TS 29.500 [4] shall be supported. + +### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- The JSON format (IETF RFC 8259 [22]). 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 [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.2.3 Cache-Control + +A "Cache-Control" header should be included in HTTP responses, as described in IETF RFC 9111 [20], clause 5.2. It shall contain a "max-age" value, indicating the amount of time in seconds after which the received response is considered stale; this value shall be the same as the content of the "validityPeriod" element described in clause 6.2.6.2.2. + +### 6.2.2.2.4 ETag + +An "ETag" (entity-tag) header should be included in HTTP responses, as described in IETF RFC 9110 [40], clause 8.8.3. 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.2.2.2.5 If-None-Match + +An NF Service Consumer should issue conditional GET request towards NRF, by including an If-None-Match header in HTTP requests, as described in IETF RFC 9110 [40], clause 13.1.2, containing one or several entity tags received in previous responses for the same resource. + +## 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 Nnrf\_NFDiscovery 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 + +The structure of the Resource URIs of the NFDiscovery service is shown in figure 6.2.3.1-1. + +![Resource URI structure of the NFDiscovery API diagram](cf734b5645d3e02a8df25f67904cd2d3_img.jpg) + +``` +graph TD; Root["{apiRoot}/nnrf-disc/v1"] --- nf_instances["/nf-instances"]; Root --- searches["/searches"]; Root --- scp_domain_routing_info["/scp-domain-routing-info"]; Root --- scp_domain_routing_info_subs["/scp-domain-routing-info-subs"]; searches --- search_id["/{searchId}"]; search_id --- complete["/complete"]; scp_domain_routing_info_subs --- subscription_id["/{subscriptionID}"]; +``` + +The diagram illustrates the hierarchical structure of the NFDiscovery API. The root path is {apiRoot}/nnrf-disc/v1. From this root, four main resource paths branch out: /nf-instances, /searches, /scp-domain-routing-info, and /scp-domain-routing-info-subs. The /searches path further branches into /{searchId}, which in turn branches into /complete. The /scp-domain-routing-info-subs path branches into /{subscriptionID}. + +Resource URI structure of the NFDiscovery API diagram + +**Figure 6.2.3.1-1: Resource URI structure of the NFDiscovery 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 | +|------------------------------------------------------------|------------------------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nf-instances (Store) | /nf-instances | GET | Retrieve a collection of NF Instances according to certain filter criteria. | +| Stored Search (Document) | /searches/{searchId} | GET | Retrieve a collection of NF Instances, previously stored by NRF as a consequence of a prior search result. | +| Complete Stored Search (Document) | /searches/{searchId}/complete | GET | Retrieve a collection of NF Instances, previously stored by NRF as a consequence of a prior search result, without applying any client restriction on the number of instances (e.g. "limit" or "max-payload-size" query parameters). | +| SCP Domain Routing Information (Document) | /scp-domain-routing-info | GET | Retrieve the SCP Domain Routing Information. | +| SCP Domain Routing Info Subscriptions (Collection) | /scp-domain-routing-info-subs | POST | Subscribe to SCP Domain Routing Information change. | +| Individual SCP Domain Routing Info Subscription (Document) | /scp-domain-routing-info-subs/{subscriptionID} | DELETE | Unsubscribe to SCP Domain Routing Information change. | + +## 6.2.3.2 Resource: nf-instances (Store) + +### 6.2.3.2.1 Description + +This resource represents a collection of the different NF instances registered in the NRF. + +This resource is modelled as the Store resource archetype (see clause C.3 of 3GPP TS 29.501 [5]). + +### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-disc/v1/nf-instances + +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.1.1 | + +### 6.2.3.2.3 Resource Standard Methods + +#### 6.2.3.2.3.1 GET + +This operation retrieves a list of NF Instances, and their offered services, currently registered in the NRF, satisfying a number of filter criteria, such as those NF Instances offering a certain service name, or those NF Instances of a given NF type (e.g., AMF). + +**Table 6.2.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| target-nf-type | NFType | M | 1 | This IE shall contain the NF type of the target NF being discovered. | | +| requester-nf-type | NFType | M | 1 | This IE shall contain the NF type of the Requester NF that is invoking the Nnrf_NFDiscovery service. | | +| preferred-collocated-nf-types | array(CollocatedNFType) | O | 1..N | The IE may be present to indicate desired collocated NF type(s) when the NF service consumer wants to discover candidate NFs matching the target NF Type that are preferentially collocated with other NF types. (NOTE 19) | Collocated-NF-Selection | +| requester-nf-instance-id | NfInstanceId | O | 0..1 | If included, this IE shall contain the NF instance id of the Requester NF. | Query-Params-Ext2 | +| service-names | array(ServiceName) | O | 1..N |

If included, this IE shall contain an array of service names for which the NRF is queried to provide the list of NF profiles.

The NRF shall return the NF profiles that have at least one NF service matching the NF service names in this list.

The NF services returned by the NRF (inside the nfServices or nfServiceList attributes) in each matching NFProfile shall be those services whose service name matches one of the service names included in this list.

If not included, the NRF shall not filter based on service name.

This array shall contain unique items.

Example:

 NF1 supports services: A, B, C NF2 supports services:      C, D, E NF3 supports services: A,      C,      E NF4 supports services:    B, C, D  Consumer asks for service-names=A,E  NRF returns:  NF1 containing service A NF2 containing service E NF3 containing services A, E NF4 is not returned
| | +| requester-nf-instance-fqdn | Fqdn | O | 0..1 |

This IE may be present for an NF discovery request within the same PLMN as the NRF.

If included, this IE shall contain the FQDN of the Requester NF that is invoking the Nnrf_NFDiscovery service.

The NRF shall use this to return only those NF profiles that include at least one NF service containing an entry in the "allowedNfDomains" list (see clause 6.1.6.2.3) that matches the domain of the requester NF.

This IE shall be ignored by the NRF if it is received from a requester NF belonging to a different PLMN. (NOTE 12)

| | +| target-plmn-list | array(PlmnId) | C | 1..N |

This IE shall be included when NF services in a different PLMN, or NF services of specific PLMN ID(s) in a same PLMN comprising multiple PLMN IDs, need to be discovered. When included, this IE shall contain the PLMN ID of the target NF. If more than one PLMN ID is included, NFs from any PLMN ID present in the list matches the query parameter.

This IE shall also be included in SNPN scenarios, when the entity owning the subscription, the Credentials Holder (see clause 5.30.2.9 in 3GPP TS 23.501 [2]) is a PLMN.

For inter-PLMN service discovery, at most 1 PLMN ID shall be included in the list; it shall be included in the service discovery from the NF in the source PLMN sent to the NRF in the same PLMN, while it may be absent in the service discovery request sent from the source NRF to the target NRF. In such case, if the NRF receives more than 1 PLMN ID, it shall only consider the

| | + +| | | | | | | +|--|--|--|--|--------------------------------------------------|--| +| | | | | first element of the array, and ignore the rest. | | +|--|--|--|--|--------------------------------------------------|--| + +| | | | | | | +|----------------------------|---------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| requester-plmn-list | array(PlmnId) | C | 1..N | This IE shall be included when NF services in a different PLMN need to be discovered. It may be present when NF services in the same PLMN need to be discovered. When included, this IE shall contain the PLMN ID(s) of the requester NF. (NOTE 12) | | +| requester-snpn-list | array(PlmnIdNid) | C | 1..N | This IE shall be included when the Requester NF belongs to one or several SNPNs, and NF services of a specific SNPN or PLMN need to be discovered. The SNPN scenarios include use cases when CH/DCS is using AAA-S or when CH/DCS is using AUSF/UDM, see clauses 5.30.2.9.2, 5.30.2.9.3 and 5.30.2.10.2.2 in 3GPP TS 23.501 [2]). It may be present when NF services from the same SNPN need to be discovered. When present, this IE shall contain the SNPN ID(s) of the requester NF.
The NRF shall use this to return only those NF profiles of NF Instances allowing to be discovered from the SNPNs identified by this IE, according to the "allowedSnpons" list in the NF Profile and NF Service (see clauses 6.1.6.2.2 and 6.1.6.2.3). | Query-Params-Ext2 | +| target-nf-instance-id | NfInstanceId | O | 0..1 | Identity of the NF instance being discovered. | | +| target-nf-instance-id-list | array(NfInstanceId) | O | 2..N | Identities of the NF instances being discovered. (NOTE 26)
If included, the NRF shall return the NF profile of each NF instance indicated in this query parameter that is available at the NRF. | Enh-NF-Discovery-Ext1 | +| target-nf-fqdn | Fqdn | O | 0..1 | FQDN of the target NF instance being discovered. | | +| hnr-uri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the NFDiscovery Service (see clause 6.2.1) of the home NRF. It shall be included if the Requester NF has previously received such API URI to be used for service discovery (e.g., from the NSSF in the home PLMN as specified in clause 6.1.6.2.11 of 3GPP TS 29.531 [42]). | | +| snssais | array(Snssai) | O | 1..N | If included, this IE shall contain the list of S-NSSAIs that are served by the NF (Service) Instances being discovered. The NRF shall return those NF profiles/NF services of NF (Service) Instances that have at least one of the S-NSSAIs in this list. The S-NSSAIs included in the NF profiles/NF services of NF (Service) Instances returned by the NRF shall be an interclause of the S-NSSAIs requested and the S-NSSAIs supported by those NF (Service) Instances. (NOTE 10)
When the NF Profile of the NF Instances being discovered has defined the list of supported S-NSSAIs in the "perPlmnSnssaiList", the discovered NF Instances shall be those having any of the S-NSSAIs included in this "snssais" parameter in any of the PLMNs included in the "target-plmn-list" attribute, if present; if the "target-plmn-list" is not included, the NRF shall assume that the discovery request is for any of the PLMNs it supports. | | +| additional-snssais | array(ExtSnssai) | O | 1..N | This IE may be included if the "snssais" IE is present.

If this IE is present and supported by the NRF, when the NRF has successfully discovered NF (service) instances based on the "snssais" IE, the S-NSSAIs included in the NF profiles/NF services of NF (Service) Instances returned by the NRF shall additionally include the interclause of the S-NSSAIs listed in this IE and the S-NSSAIs supported by those NF (Service) Instances.

When the NF Profile of the NF Instances in the discovery result has defined the list of supported S-NSSAIs in the "perPlmnSnssaiList", the additional S-NSSAIs to be included shall be the ones supported in the PLMN(s) indicated in the "target-plmn-list" attribute, if present; if the "target-plmn-list" is not present, the additional S-NSSAIs in any supported PLMN(s) shall be included. | Query-SBIProtoc18 | +| requester-snssais | array(ExtSnssai) | O | 1..N | If included, this IE shall contain the list of S-NSSAI of the requester NF. If this IE is included in a service discovery in a different PLMN, the requester NF shall provide S-NSSAI values of the target PLMN, that correspond to the S-NSSAI values of | | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

the requester NF.
The NRF shall use this to return only those NF Instances allowing to be discovered from at least one network slice identified by this IE, according to the "allowedNssais" list in the NF Profile and NF Service (see clause 6.1.6.2.2 and 6.1.6.2.3). (NOTE 12)

| | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------------------------|-------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| plmn-specific-snssai-list | array(PlmnSnssai) | O | 1..N | If included, this IE shall contain the list of S-NSSAI that are served by the NF service being discovered for the corresponding PLMN provided. The NRF shall use this to identify the NF services that have registered their support for the S-NSSAIs for the corresponding PLMN given. The NRF shall return the NF profiles that have at least one S-NSSAI supported in any of the PLMNs provided in this list. The per PLMN list of S-NSSAIs included in the NF profile returned by the NRF shall be an interclause of the list requested and the list registered in the NF profile. (NOTE 10). | | +| requester-plmn-specific-snssai-list | array(PlmnSnssai) | O | 1..N | If included, this IE shall contain the list of S-NSSAI of the requester NF, for each of the PLMNs it supports. The NRF shall use this to return only those NF profiles of NF Instances allowing to be discovered from at least one network slice identified by this IE, according to the "allowedNssais" and "allowedPlmns" attributes in the NF Profile and NF Service (see clause 6.1.6.2.2 and 6.1.6.2.3). (NOTE 12) | Query-Params-Ext3 | +| nsi-list | array(string) | O | 1..N | If included, this IE shall contain the list of NSI IDs that are served by the services being discovered. | | +| dnn | Dnn | O | 0..1 | If included, this IE shall contain the DNN for which NF services serving that DNN is discovered. DNN may be included if the target NF type is e.g. "BSF", "SMF", "PCF", "PCSCF", "UPF", "EASDF", "TSCTSF", "MB-UPF" or "MB-SMF".
The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. (NOTE 11).
If the Snssai(s) are also included, the NF services serving the DNN shall be available in the network slice(s) identified by the Snssai(s). | | +| ipv4-index | lpIndex | O | 0..1 | This IE may be included if the target NF type is "UPF" and the dnn IE is included.

When included, this IE shall indicate the IPv4 index that is supported by the candidate UPF. | Query-Upf-IpIndex | +| ipv6-index | lpIndex | O | 0..1 | This IE may be included if the target NF type is "UPF" and the dnn IE is included.

When included, this IE shall indicate the IPv6 index that is supported by the candidate UPF. | Query-Upf-IpIndex | +| smf-serving-area | string | O | 0..1 | If included, this IE shall contain the serving area of the SMF. It may be included if the target NF type is "UPF". | | +| mbsmf-serving-area | string | O | 0..1 | If included, this IE shall contain the serving area of the MB-SMF. It may be included if the target NF type is "MB-UPF". | Query-MBS | +| tai | Tai | O | 0..1 | Tracking Area Identity. (NOTE 22). | | +| amf-region-id | AmfRegionId | O | 0..1 | AMF Region Identity. | | +| amf-set-id | AmfSetId | O | 0..1 | AMF Set Identity. | | +| guami | Guami | O | 0..1 | Guami used to search for an appropriate AMF. (NOTE 1) | | +| supi | Supi | O | 0..1 | If included, this IE shall contain the SUPI of the requester UE to search for an appropriate NF. SUPI may be included if the target NF type is e.g. "PCF", "CHF", "AUSF", "BSF", "UDM", "TSCTSF", "NSSAAF" or "UDR". | | +| ue-ipv4-address | Ipv4Addr | O | 0..1 | The IPv4 address of the UE for which a BSF or P-CSCF or UPF needs to be discovered. (NOTE 27) | | +| ip-domain | string | O | 0..1 | The IPv4 address domain of the UE for which a BSF needs to be discovered. | | +| ue-ipv6-prefix | Ipv6Prefix | O | 0..1 | The IPv6 prefix of the UE for which a BSF or P-CSCF or UPF needs to be discovered. (NOTE 27) | | +| pgw-ind | boolean | O | 0..1 | When present, this IE indicates whether a combined SMF/PGW-C or a standalone SMF needs to be discovered.

true: A combined SMF/PGW-C is requested to be discovered;
false: A standalone SMF is requested to be discovered.
(See NOTE 2, NOTE 21) | | +| preferred-pgw-ind | boolean | O | 0..1 | When present, this IE indicates whether combined PGW-C+SMF(s) or standalone SMF(s) are preferred. | Query-SBIPROTO | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| | | | | true: Combined PGW-C+SMF(s) are preferred to be discovered;
false: Standalone SMF(s) are preferred to be discovered.
(See NOTE 2, NOTE 20, NOTE 21) | c17 | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------|-----| + +| | | | | | | +|-------------------------|---------------------------------|---|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| pgw | Fqdn | O | 0..1 | If included, this IE shall contain the PGW FQDN which is used by the AMF to find the combined SMF/PGW-C. | | +| pgw-ip | IpAddr | O | 0..1 | If included, this IE shall contain the PGW IP Address used by the AMF to find the combined SMF/PGW-C. | Query-SBIProtoc17 | +| gpsi | Gpsi | O | 0..1 | If included, this IE shall contain the GPSI of the requester UE to search for an appropriate NF. GPSI may be included if the target NF type is "CHF", "PCF", "BSF", "UDM", "TSCTSF" or "UDR". | | +| external-group-identity | ExtGroupId | O | 0..1 | If included, this IE shall contain the external group identifier of the requester UE to search for an appropriate NF. This may be included if the target NF type is "UDM", "UDR", "HSS" or "TSCTSF". | | +| pfd-data | PfdData | O | 0..1 | When present, this IE shall contain the application identifiers and/or application function identifiers in PFD management. This may be included if the target NF type is "NEF".
The NRF shall return those NEF instances which can provide the PFDs for at least one of the provided application identifiers, or for at least one of the provided application function identifiers. | Query-Params-Ext2 | +| data-set | DataSetId | O | 0..1 | Indicates the data set to be supported by the NF to be discovered. May be included if the target NF type is "UDR". | | +| routing-indicator | string | O | 0..1 | Routing Indicator information that allows to route network signalling with SUCI (see 3GPP TS 23.003 [12]) to an AUSF, AAnF and UDM instance capable to serve the subscriber. May be included if the target NF type is "AUSF", "AANF" or "UDM".
Pattern: "^[0-9]{1,4}\$" | | +| group-id-list | array(NfGroupId) | O | 1..N | Identity of the group(s) of the NFs of the target NF type to be discovered. May be included if the target NF type is "UDR", "UDM", "HSS", "PCF", "AUSF", "BSF" or "CHF". | | +| dnai-list | array(Dnai) | O | 1..N | If included, this IE shall contain the Data network access identifiers. It may be included if the target NF type is "UPF", "SMF", "EASDF" or "NEF". | | +| upf-iwk-eps-ind | boolean | O | 0..1 | When present, this IE indicates whether a UPF supporting interworking with EPS needs to be discovered.

true: A UPF supporting interworking with EPS is requested to be discovered;
false: A UPF not supporting interworking with EPS is requested to be discovered.
(NOTE 3) | | +| chf-supported-plmn | PlmnId | O | 0..1 | If included, this IE shall contain the PLMN ID that a CHF supports (i.e., in the PlmnRange of ChfInfo attribute in the NFProfile). This IE may be included when the target NF type is "CHF".

When an SMF discovers CHF(s) for a PDU session, the SMF shall set the value of this IE as specified in clause 5.1.9.2 of 3GPP TS 32.255 [46]. | | +| preferred-locality | string | O | 0..1 | Preferred target NF location (e.g. geographic location, data center).
When present, the NRF shall prefer NF profiles with a locality attribute that matches the preferred-locality.
The NRF may return additional NFs in the response not matching the preferred target NF location, e.g. if no NF profile is found matching the preferred target NF location.
The NRF should set a lower priority for any additional NFs on the response not matching the preferred target NF location than those matching the preferred target NF location. In addition, based on operator's policy, the NRF may set different priorities based on the localities of the NFs.
(NOTE 6, NOTE 25) | | +| ext-preferred-locality | map(array(LocalityDescription)) | O | 1..N(
1..M) | Preferred target NF location (e.g. geographic location, data center).
The key of the map shall represent the relative priority, for the requester, of each locality description among the list of locality descriptions in this query parameter, encoded as "1" (highest priority), "2", "3", ..., "n" (lowest priority). | Query-SBIProtoc18 | + +| | | | | | +|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | |

When present, the NRF shall prefer NF profiles with an extLocality attribute that matches at least one LocalityDescription of the ext-preferred-locality, with the highest possible priority.

The NRF may return additional NFs in the response not matching the preferred target NF location, e.g. if no NF profile is found matching the preferred target NF location.

The NRF should set the priority of each NF profile returned in the response based on the priority associated with the matching locality description of the ext-preferred-locality. The NRF should set a lower priority for any additional NFs in the response not matching the preferred target NF location than those matching the preferred target NF location. In addition, based on operator's policy, the NRF may set different priorities based on the localities of the NFs.
(NOTE 6)

Example 1 indicating a preference to discover an NFp in the data center "dc-123" as a first choice, otherwise in the city of Los Angeles or San Diego as a second choice, otherwise in the state of California as a third choice.

{   "1": [{"localityType": "DATA_CENTER", "localityValue": "dc-123"}],   "2": [{"localityType": "CITY", "localityValue": "Los Angeles"},         {"localityType": "CITY", "localityValue": "San Diego"}],   "3": [{"localityType": "STATE", "localityValue": "California"}] }

Example 2 indicating a preference to discover an NFp in the data center "dc-123" as a first choice, otherwise in the data center "dc-456" or "dc-789" as a second choice.

{   "1": [{"localityType": "DATA_CENTER", "localityValue": "dc-123"}],   "2": [{"localityType": "DATA_CENTER", "localityValue": "dc-456"},         {"localityType": "DATA_CENTER", "localityValue": "dc-789"}] }

Example 3 indicating a preference to discover an NFp in the city of Bath and in the state of Virginia as a first choice, otherwise in the state of Virginia as a second choice.

{   "1": [{"localityType": "CITY", "localityValue": "Bath",         "addLocDescItems": [{"localityType": "STATE", "localityValue":           "Virginia"}]}],   "2": [{"localityType": "STATE", "localityValue": "Virginia"}] }

(NOTE 25)

| | +|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|----------------------|--------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| access-type | AccessType | C | 0..1 | If included, this IE shall contain the Access type which is required to be supported by the target Network Function (i.e. SMF). | | +| supported-features | SupportedFeatures | O | 0..1 | List of features required to be supported by the target Network Function.
This IE may be present only if the service-names attribute is present and if it contains a single service-name. It shall be ignored by the NRF otherwise.
(NOTE 4) | | +| required-features | array(SupportedFeatures) | O | 1..N | List of features required to be supported by the target Network Function, as defined by the supportedFeatures attribute in NFService (see clauses 6.1.6.2.3 and 6.2.6.2.4).
This IE may be present only if the service-names attribute is present.
When present, the required-features attribute shall contain as many entries as the number of entries in the service-names attribute. The n th entry in the required-features attribute shall correspond to the n th entry in the service-names attribute. An entry corresponding to a service for which no specific feature is required shall be encoded as "0".
(NOTE 24) | Query-Params-Ext1 | +| complex-query | ComplexQuery | O | 0..1 | This query parameter is used to override the default logical relationship of query parameters. | Complex-Query | +| limit | integer | O | 0..1 | Maximum number of NFProfiles to be returned in the response.
Minimum: 1 | Query-Params-Ext1 | +| max-payload-size | integer | O | 0..1 | Maximum content size (before compression, if any) of the response, expressed in kilo octets.
When present, the NRF shall limit the number of NF profiles returned in the response such as to not exceed the maximum content size indicated in the request.
Default: 124. Maximum: 2000 (i.e. 2 Mo). | Query-Params-Ext1 | +| max-payload-size-ext | integer | O | 0..1 | Maximum content size (before compression, if any) of the response, expressed in kilo octets.
When present, the NRF shall limit the number of NF profiles returned in the response such as to not exceed the maximum content size indicated in the request.
This query parameter is used when the consumer supports content size bigger than 2 million octets.
Default: 124 | Query-Params-Ext2 | +| pdu-session-types | array(PduSessionType) | O | 1..N | List of the PDU session type (s) requested to be supported by the target Network Function (i.e. UPF). | Query-Params-Ext1 | +| event-id-list | array(EventId) | O | 1..N | If present, this attribute shall contain the list of events requested to be supported by the Nnwdaf AnalyticsInfo Service, the NRF shall return NF which support all the requested events. | Query-Param-Analytics | +| nwdaf-event-list | array(NwdafEvent) | O | 1..N | If present, this attribute shall contain the list of events requested to be supported by the Nnwdaf_EventsSubscription service, the NRF shall return NF which support all the requested events. | Query-Param-Analytics | +| upf-event-list | array(EventType) | O | 1..N | If present, this attribute shall contain the list of events requested to be supported by the Nupf_EventExposure service. The NRF shall return UPFs which support all the requested events. | Query-UPEAS | +| atsss-capability | AtsssCapability | O | 0..1 | When present, this IE indicates the ATSSS capability of the target UPF needs to be supported. | MAPDU | +| upf-ue-ip-addr-ind | boolean | O | 0..1 | When present, this IE indicates whether a UPF supporting allocating UE IP addresses/prefixes needs to be discovered.

true: a UPF supporting UE IP addresses/prefixes allocation is requested to be discovered;
false: a UPF not supporting UE IP addresses/prefixes allocation is requested to be discovered. | Query-Params-Ext2 | +| client-type | ExternalClientType | O | 0..1 | When present, this IE indicates that NF(s) dedicatedly serving the specified Client Type needs to be discovered. This IE may be included when target NF Type is "LMF" and "GMLC".

If no NF profile is found dedicatedly serving the requested client type, the NRF may return NF(s) not dedicatedly serving the request client type in the response. | Query-Params-Ext2 | + +| | | | | | | +|--|--|--|--|--|--| +| | | | | | | +|--|--|--|--|--|--| + +| | | | | | | +|--------------------------|---------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| lmf-id | LMFIdentification | O | 0..1 | When present, this IE shall contain LMF identification to be discovered. This may be included if the target NF type is "LMF". | Query-Params-Ext2 | +| an-node-type | AnNodeType | O | 0..1 | If included, this IE shall contain the AN Node type which is required to be supported by the target Network Function (i.e. LMF). | Query-Params-Ext2 | +| rat-type | RatType | O | 0..1 | If included, this IE shall contain the RAT type which is required to be supported by the target Network Function (i.e. LMF). | Query-Params-Ext2 | +| target-snpn | PlmnIdNid | C | 0..1 | This IE shall be included when NF services of a specific SNPN need to be discovered. When included, this IE shall contain the PLMN ID and NID of the target NF.
This IE shall also be included in SNPN scenarios, when the entity owning the subscription, the Credentials Holder (see clause 5.30.2.9 in 3GPP TS 23.501 [2]) is an SNPN. | Query-Params-Ext2 | +| af-ee-data | AfEventExposureData | O | 0..1 | When present, this shall contain the application events, and optionally application function identifiers, application identifiers of the AF(s). This may be included if the target NF type is "NEF". | Query-Params-Ext2 | +| w-agf-info | WAgfInfo | O | 0..1 | If included, this IE shall contain the W-AGF identifiers of N3 terminations which is received by the SMF to find the combined W-AGF/UPF or the preferred UPF(s) for the W-AGF.

The NRF shall return UPFs co-located with the W-AGF if any exists (see wAgfInfo attribute in UpfInfo). Otherwise, if the NRF supports the Query-UPF-Selection-N3GPP feature, the NRF shall return preferred UPF(s) for the W-AGF if any preferred UPF exist (see preferredWagfInfoList attribute in UpfInfo). | Query-Params-Ext2 | +| tngf-info | TngfInfo | O | 0..1 | If included, this IE shall contain the TNGF identifiers of N3 terminations which is received by the SMF to find the combined TNGF/UPF or the preferred UPF(s) for the TNGF.

The NRF shall return UPFs co-located with the TNGF if any exists (see tngfInfo attribute in UpfInfo). Otherwise, if the NRF supports the Query-UPF-Selection-N3GPP feature, the NRF shall return preferred UPF(s) for the TNGF if any preferred UPF exist (see preferredTngfInfoList attribute in UpfInfo). | Query-Params-Ext2 | +| twif-info | TwifInfo | O | 0..1 | If included, this IE shall contain the TWIF identifiers of N3 terminations which is received by the SMF to find the combined TWIF/UPF or the preferred UPF(s) for the TWIF.

The NRF shall return UPFs co-located with the TWIF if any exists (see twifInfo attribute in UpfInfo). Otherwise, if the NRF supports the Query-UPF-Selection-N3GPP feature, the NRF shall return preferred UPF(s) for the TWIF if any preferred UPF exist (see preferredTwifInfoList attribute in UpfInfo). | Query-Params-Ext2 | +| upf-select-epdg-info | EpdgInfo | O | 0..1 | If included, this IE shall contain the EPDG identifiers of S2b-u terminations which is received by the SMF/PGW-C to find the preferred UPF/PGW-U to serve the ePDG. | Query-UPF-Selection-N3GPP | +| target-nf-set-id | NfSetId | O | 0..1 | When present, this IE shall contain the target NF Set ID (as defined in clause 28.12 of 3GPP TS 23.003 [12]) of the NF instances being discovered. | Query-Params-Ext2 | +| target-nf-service-set-id | NfServiceSetId | O | 0..1 | When present, this IE shall contain the target NF Service Set ID (as defined in clause 28.13 of 3GPP TS 23.003 [12]) of the NF service instances being discovered.

If this IE is provided together with the target-nf-set-id IE, the NRF shall return service instances of the NF Service Set indicated in the request and should additionally return equivalent ones, if any. | Query-Params-Ext2 | +| preferred-tai | Tai | O | 0..1 | When present, the NRF shall prefer NF profiles that can serve the TAI, or the NRF shall return NF profiles not matching the TAI if no NF profile is found matching the TAI.
(NOTE 5) | Query-Params-Ext2 | +| nef-id | NefId | O | 0..1 | When present, this IE shall contain the NEF ID of the NEF to be discovered. This may be included if the target NF type is "NEF".
(NOTE 7) | Query-Params-Ext2 | + +| | | | | | | +|-------------------------|---------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| preferred-nf-instances | array(NfInstanceId) | O | 1..N | When present, this IE shall contain a list of preferred candidate NF instance IDs. (NOTE 8) | Query-Params-Ext2 | +| notification-type | NotificationType | O | 0..1 | If included, this IE shall contain the notification type of default notification subscriptions that shall be registered in the NFProfile or NFService of the NF Instances being discovered. The NF profiles returned by the NRF shall contain all the registered default notification subscriptions, including the one corresponding to the notification-type parameter. (NOTE 9) | Query-Params-Ext2 | +| n1-msg-class | N1MessageClass | O | 0..1 | This IE may be included when "notification-type" IE is present with value "N1_MESSAGES".

When included, this IE shall contain the N1 message class of default notification subscriptions that shall be registered in the NFProfile or NFService of the NF Instances being discovered. The NF profiles returned by the NRF shall contain all the registered default notification subscriptions, including the one corresponding to the n1-msg-class parameter. (NOTE 9) | Query-Params-Ext3 | +| n2-info-class | N2InformationClass | O | 0..1 | This IE may be included when "notification-type" IE is present with value "N2_INFORMATION".

If included, this IE shall contain the notification type of default notification subscriptions that shall be registered in the NFProfile or NFService of the NF Instances being discovered. The NF profiles returned by the NRF shall contain all the registered default notification subscriptions, including the one corresponding to the n2-info-class parameter. (NOTE 9) | Query-Params-Ext3 | +| serving-scope | array(string) | O | 1..N | If present, this attribute shall contain the list of areas that can be served by the NF instances to be discovered. The NRF shall return NF profiles of NFs which can serve all the areas requested in this query parameter. (NOTE 18) | Query-Params-Ext2 | +| ims-domain-name | string | O | 1..N | If included, this IE shall contain the IMS domain name to search for an appropriate NF. IMS domain name may be included if the target NF type is "DCSF". | Query-NG-RTC | +| imsi | string | O | 0..1 | If included, this IE shall contain the IMSI of the requester UE to search for an appropriate NF. IMSI may be included if the target NF type is "HSS" or "DCSF".
pattern: ^[0-9]{5,15}\$ | Query-Params-Ext2 | +| ims-private-identity | string | O | 0..1 | If included, this IE shall contain the IMS Private Identity of the requester UE to search for an appropriate NF. IMS Private Identity may be included if the target NF type is "HSS" or "DCSF". | Query-Params-Ext3 | +| ims-public-identity | string | O | 0..1 | If included, this IE shall contain the IMS Public Identity of the requester UE to search for an appropriate NF. IMS Public Identity may be included if the target NF type is "HSS" or "DCSF". | Query-Params-Ext3 | +| msisdn | string | O | 0..1 | If included, this IE shall contain the MSISDN of the requester UE to search for an appropriate NF. IMS Public Identity may be included if the target NF type is "HSS" or "DCSF". | Query-Params-Ext3 | +| internal-group-identity | GroupId | O | 0..1 | If included, this IE shall contain the internal group identifier of the UE to search for an appropriate NF. This may be included if the target NF type is "UDM", "NSSAAF" or "TSCTSF". | Query-Params-Ext2 | +| preferred-api-versions | map(string) | O | 1..N | When present, this IE indicates the preferred API version of the services that are supported by the target NF instances. The key of the map is the ServiceName (see clause 6.1.6.3.11) for which the preferred API version is indicated. Each element carries the API Version Indication for the service indicated by the key. The NRF may return additional NFs in the response not matching the preferred API versions, e.g. if no NF profile is found matching the preferred-api-versions.

An API Version Indication is a string formatted as {operator}+{API Version}. | Query-Params-Ext2 | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

The following operators shall be supported:

  • "=" match a version equals to the version value indicated.
  • ">" match any version greater than the version value indicated
  • ">=" match any version greater than or equal to the version value indicated
  • "<" match any version less than the version value indicated
  • "<=" match any version less than or equal to the version value indicated
  • "^" match any version compatible with the version indicated, i.e. any version with the same major version as the version indicated.

Precedence between versions is identified by comparing the Major, Minor, and Patch version fields numerically, from left to right.

If no operator or an unknown operator is provided in API Version Indication, "=" operator is applied.

Example of API Version Indication:

Case1: "=1.2.4.operator-ext" or "1.2.4.operator-ext" means matching the service with API version "1.2.4.operator-ext"

Case2: ">1.2.4" means matching the service with API versions greater than "1.2.4"

Case3: "^2.3.0" or "^2" means matching the service with all API versions with major version "2".

| | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------|---------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| v2x-support-ind | boolean | O | 0..1 | When present, this IE indicates whether a PCF supporting V2X Policy/Parameter provisioning needs to be discovered.

true: a PCF supporting V2X Policy/Parameter provisioning is requested to be discovered;
false: a PCF not supporting V2X Policy/Parameter provisioning is requested to be discovered. | Query-Params-Ext2 | +| redundant-gtpu | boolean | O | 0..1 | When present, this IE indicates whether a UPF supporting redundant GTP-U path needs to be discovered.

true: a UPF supporting redundant GTP-U path is requested to be discovered;
false: a UPF not supporting redundant GTP-U path is requested to be discovered. | Query-Params-Ext2 | +| redundant-transport | boolean | O | 0..1 | When present, this IE indicates whether a UPF supporting redundant transport path on the transport layer in the corresponding network slice needs to be discovered.

true: a UPF supporting redundant transport path on the transport layer is requested to be discovered;
false: a UPF not supporting redundant transport path on the transport layer is requested to be discovered.

If the Snssai(s) are also included, the UPF supporting redundant transport path on the transport layer shall be available in the network slice(s) identified by the Snssai(s). | Query-Params-Ext2 | +| ipups | boolean | O | 0..1 | When present, this IE indicates whether a UPF which is configured for IPUPS is requested to be discovered.

true: a UPF which is configured for IPUPS is requested to be discovered;
false: a UPF which is not configured for IPUPS is requested to be discovered. | Query-Params-Ext2 | +| sxa-ind | boolean | O | 0..1 | When present, this IE indicates whether a UPF which is configured to support Sxa interface is requested to be discovered.

true: a UPF which is configured to support Sxa interface is requested to be discovered;
false: a UPF which is not configured to support Sxa interface is requested to be discovered. | Query-SBIProtoc18 | +| scp-domain-list | array(string) | O | 1..N | When present, this IE shall contain the SCP domain(s) the target NF, SCP or SEPP belongs to. The NRF shall return NF, SCP or SEPP profiles that belong to all the SCP domains provided in this list. | Query-Params-Ext2 | +| address-domain | Fqdn | O | 0..1 | If included, this IE shall contain the address domain that shall be reachable through the SCP. This IE may be included when the target NF type is "SCP". | Query-Params-Ext2 | +| ipv4-addr | Ipv4Addr | O | 0..1 | If included, this IE shall contain the IPv4 address that shall be reachable through the SCP. This IE may be included when the target NF type is "SCP". | Query-Params-Ext2 | +| ipv6-prefix | Ipv6Prefix | O | 0..1 | If included, this IE shall contain the IPv6 prefix that shall be reachable through the SCP. This IE may be included when the target NF type is "SCP". | Query-Params-Ext2 | +| served-nf-set-id | NfSetId | O | 0..1 | When present, this IE shall contain the NF Set ID that shall be reachable through the SCP. This IE may be included when the target NF type is "SCP". | Query-Params-Ext2 | +| remote-plmn-id | PlmnId | O | 0..1 | If included, this IE shall contain the remote PLMN ID that shall be reachable through the SCP or SEPP. This IE may be included when the target NF type is "SCP" or "SEPP". | Query-Params-Ext2 | +| remote-snpn-id | PlmnIdNid | O | 0..1 | If included, this IE shall contain the remote SNPN ID that shall be reachable through the SCP or SEPP. This IE may be included when the target NF type is "SCP" or "SEPP". | Query-ENPN | +| data-forwarding | boolean | O | 0..1 | This may be included if the target NF type is "UPF". (NOTE 13)

When present, the IE indicates whether UPF(s) configured for data forwarding needs to be discovered. | Query-Params-Ext2 | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | true: UPF(s) configured for data forwarding is requested to be discovered;
false: UPF(s) not configured for data forwarding is requested to be discovered. | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|------------------------------------|------------------------------------------|---|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| preferred-full-plmn | boolean | O | 0..1 | When present, the NRF shall prefer NF profile(s) that can serve the full PLMN (i.e. can serve any TAI in the PLMN), or the NRF shall return other NF profiles if no NF profile serving the full PLMN is found:

- true: NF instance(s) serving the full PLMN is preferred;
- false: NF instance(s) serving the full PLMN is not preferred.

(NOTE 14) | Query-Params-Ext2 | +| requester-features | SupportedFeatures | C | 0..1 | Nnrf_NFDiscovery features supported by the Requester NF that is invoking the Nnrf_NFDiscovery service.

This IE shall be included if at least one of the following features is supported by the Requester NF:
- Service-Map
- Enh-NF-Discovery

This IE may be included otherwise. | | +| realm-id | string | O | 0..1 | May be included if the target NF type is "UDSF". If included, this IE shall contain the realm-id for which a UDSF shall be discovered. | Query-Params-Ext4 | +| storage-id | string | O | 0..1 | May be included if the target NF type is "UDSF" and realm-id is included. If included, this IE shall contain the storage-id for the realm-id indicated in the realm-id IE for which a UDSF shall be discovered. | Query-Params-Ext4 | +| vsmf-support-ind | boolean | O | 0..1 | This IE may be included when the target NF type is "SMF".

- true: Target SMF(s) supporting V-SMF are preferred to be discovered;

- false: Shall be handled the same way as when this optional query parameter is not received.

(NOTE 15) | Query-Param-vSmf-Capability | +| ismf-support-ind | boolean | O | 0..1 | This IE may be included when the target NF type is "SMF".

- true: Target SMF(s) supporting I-SMF are preferred to be discovered;

- false: Shall be handled the same way as when this optional query parameter is not received.

(NOTE 15) | Query-Param-iSmf-Capability | +| nrf-disc-uri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the NFDiscovery Service (see clause 6.2.1) of the NRF holding the NF Profile.

It shall be included if:
- the target-nf-instance-id or target-nf-instance-id-list is present;

- the NF Service Consumer has previously received such API URI in an earlier NF service discovery, i.e. if the target NF instance was provided in the nflInstanceList attribute in SearchResult (see clause 6.2.6.2.2) and the nrfDiscApiUri attribute was present in the NfInstanceInfo (see clause 6.2.6.2.7); and

- the service discovery request is addressed to a different NRF than the NRF holding the NF profile. | Enh-NF-Discovery | +| preferred-vendor-specific-features | map(map(array (VendorSpecific Feature))) | O | 1..N(
1..M(
1..L)) | When present, this IE indicates the list of preferred vendor-specific features supported by the target Network Function, as defined by the supportedVendorSpecificFeatures attribute in NFService (see clauses 6.1.6.2.3 and 6.2.6.2.4). NF profiles that support all the preferred features, or by default, NF profiles that contain at least one service supporting the preferred features, should be preferentially returned in the response; NF profiles in the response may not support the preferred features. | Query-SBIProtoc17 | + +| | | | | | | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

The key of the external map is the ServiceName (see clause 6.1.6.3.11) for which the preferred vendor-specific features is indicated. Each element carries the preferred vendor-specific features for the service indicated by the key.

The key of the internal map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The string used as key of the internal map shall contain 6 decimal digits; if the SMI code has less than 6 digits, it shall be padded with leading digits "0" to complete a 6-digit string value.

The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects.

The NF profiles returned by the NRF shall include the full list of vendor-specific-features and not just the interclause of supported and preferred vendor-specific features.

| | +|--|--|--|--|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|---------------------------------------|-----------------------------------|---|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| preferred-vendor-specific-nf-features | map(array(VendorSpecificFeature)) | O | 1..N(1..M) |

When present, this IE indicates the list of preferred vendor-specific features supported by the target Network Function, as defined by the supportedVendorSpecificFeatures attribute in NF profile (see clause 6.1.6.2.2 and 6.2.6.2.3). NF profiles that support all the preferred features should be preferentially returned in the response. NF profiles in the response may not support the preferred features.

The key of the map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects.

The NF profiles returned by the NRF shall include the full list of vendor-specific features and not just the interclause of supported and preferred vendor-specific features.

| Query-SBIProtoc17 | +| required-pfcp-features | string | O | 0..1 |

List of features required to be supported by the target UPF or MB-UPF (when selecting a UPF or a MB-UPF), encoded as defined for the supportedPfcpFeatures attribute in UpfInfo (see clause 6.1.6.2.13).

(NOTE 16)

| Query-Upf-Pfcp | +| home-pub-key-id | integer | O | 0..1 |

When present, this IE shall indicate the Home Network Public Key ID which shall be able to be served by the NF instance. May be included if the target NF type is "AUSF" or "UDM". This query parameter may only be present if the routing-indicator query parameter is also present.

(NOTE 17)

| Query-SBIProtoc17 | +| prose-support-ind | boolean | O | 0..1 |

When present, this IE indicates whether supporting ProSe capability by PCF needs to be discovered.

  • - true: a PCF supporting ProSe capability is requested to be discovered;
  • - false: a PCF not supporting ProSe capability is requested to be discovered.
| Query-5G-ProSe | +| analytics-aggregation-ind | boolean | O | 0..1 |

This IE may be included when the target NF type is "NWDAF".

  • - true: An NF supporting analytics aggregation capability is requested to be discovered;
  • - false: Shall be handled the same way as when this optional query parameter is not received.
| Query-eNA-PH2 | +| analytics-metadata-prov-ind | boolean | O | 0..1 |

This IE may be included when the target NF type is "NWDAF".

  • - true: An NF supporting analytics metadata provisioning capability is requested to be discovered;
  • - false: Shall be handled the same way as when this optional query parameter is not received.
| Query-eNA-PH2 | +| serving-nf-set-id | NfSetId | O | 0..1 |

When present, this IE shall contain the NF Set ID that is served by the DCCF, NWDAF or MFAF. This IE may be included when the target NF type is "DCCF" or "NWDAF" or "MFAF".

| Query-eNA-PH2 | +| serving-nf-type | NFType | O | 0..1 |

When present, this IE shall contain the NF type that is served by the DCCF, NWDAF or MFAF. This IE may be included when the target NF type is "DCCF" or "NWDAF" or "MFAF".

| Query-eNA-PH2 | +| ml-analytics-info-list | array(MIAnalyticsInfo) | O | 1..N |

If present, this attribute shall contain the list of ML Analytics Filter information per Analytics ID(s) requested to be supported by the Nnwdaf_ModelProvision Service. The NRF shall return NWDAF profiles that support at least one of the MIAnalyticsInfo in this list.

| Query-eNA-PH2 | +| nsacf-capability | NsacfCapability | O | 0..1 |

When present, this IE indicates the service capability that the target NSACF needs to support.

| NSAC | +| mbs-session-id-list | array(MbsSessionId) | O | 1..N |

This IE may be present if the target NF type is "MB-SMF". When present, it shall contain the list of MBS Session ID(s) for which MB-SMF(s) are to be discovered.

| Query-MBS | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | |

When present, for each mbs-session-id in the list, the NRF shall determine whether an MB-SMF supporting the mbs-session-id and complying with the other query parameters (if any) exists. An MB-SMF shall be considered to support the mbs-session-id if:

  • - the mbs-session-id contains a TMGI that is part of a TMGI range (see tmgiRangeList attribute in clause 6.1.6.2.85) registered by the MB-SMF and, if the tai query parameter is present:
    • - if the TAI indicated in the tai query parameter can be served by the MB-SMF (see taiList and taiRangeList attributes in clause 6.1.6.2.85);

or

  • - the mbs-session-id contains a TMGI or an SSM address, that is part of the list of MBS sessions currently served by the MB-SMF (see mbsSessionList attribute in clause 6.1.6.2.85) and, if the tai query parameter is present and the MBS session is registered with an MBS Service Area (see mbsServiceArea in clause 6.1.6.2.90):
    • - if the TAI indicated in the tai query parameter is supported by the MBS Service Area of the MBS session.

If so, the NRF shall return the profile of this MB-SMF. If no MB-SMF supporting the mbs-session-id and complying with the other query parameters exists, the NRF shall return an empty response.

See clause 7.1.2 of 3GPP TS 23.247 [43].

| | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------------------|---------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| area-session-id | AreaSessionId | O | 0..1 | This IE may be present if the target NF type is "MB-SMF", the mbs-session-id-list IE is present and contains only one MBS Session ID.
When present, the IE shall contain the Area Session ID, for the MBS session indicated in the mbs-session-id-list IE, for which an MB-SMF is to be discovered.
When this IE is present, the NRF shall return an MB-SMF profile that currently serves the MBS Session ID and Area Session ID (see mbsSessionList attribute in clause 6.1.6.2.85).
If no MB-SMF supports the MBS Session ID and Area Session ID, the NRF shall return an empty response.
See clause 7.1.2 of 3GPP TS 23.247 [43]. | Query-MBS | +| gmlc-number | string | O | 0..1 | If included, this IE shall contain the GMLC Number of which should supported by the target GMLC. It may be included if the target NF type is "GMLC".

Pattern: "^[0-9]{5,15}\$" | Query-eLCS | +| upf-n6-ip | lpAddr | O | 0..1 | If included, this IE shall contain the N6 IP address of PSA UPF.

It may be included if the target NF type is "EASDF". | Query-eEDGE-5GC | +| tai-list | array(Tai) | O | 1..N | If included, this IE shall contain the Tracking Area Identities requested to be supported by the NFs being discovered. The NRF shall return NFs which support all the TAs in the list. It may be included if the target NF type is "NEF", "MB-SMF" or "AMF".
(NOTE 28) | Query-eEDGE-5GC | +| nf-tai-list-ind | boolean | O | 0..1 | This query parameter may be present with the value true if the tai-list query parameter is present and the NF service consumer supports receiving from the NRF a list of NFs supporting only a subset of the TAs included in the tai-list. (NOTE 28)

Presence of this IE with false value shall be prohibited. | Query-SBIProtoc18 | +| preferences-precedence | array(string) | O | 2..N | This IE may be present when multiple query parameters expressing a preference are included in the discovery request.

When present, this IE shall indicate the relative precedence of these query parameters (from higher precedence to lower precedence). The NRF shall use the indicated precedence to prioritize the candidate NFs in the search result, among the candidate NFs partially matching the different preference query parameters, candidate matching the higher precedence preference query parameter should have higher priority.

This IE may include any query parameter named "preferred-xxx" or "ext-preferred-xxx" (e.g. preferred-locality, preferred-tai).

Example:

preferences-precedence=[preferred-tai, preferred-vendor-specific-features]

The above value indicates that the "preferred-tai" parameter has higher precedence than the "preferred-vendor-specific-features" parameter. | Query-SBIProtoc17 | +| support-onboarding-capability | boolean | O | 0..1 | If present, this attribute indicates the target AMF or SMF instances support SNPN Onboarding. If the target is an SMF, this indicates the SMF also supports User Plane Remote Provisioning. This is used for the case of Onboarding of UEs for SNPNs (see 3GPP TS 23.501 [2], clauses 5.30.2.10 and 6.2.6.2).

  • - true: An NF supporting SNPN Onboarding is requested to be discovered;
  • - false: Shall be handled the same way as when this optional query parameter is not received.
| Query-ENPN | +| uas-nf- | boolean | O | 0..1 | This IE may be included when the target NF type is "NEF". | Query- | + +| | | | | | | +|------------------------------------|--------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| functionality-ind | | | |
  • - true: An NF supporting UAS NF functionality is requested to be discovered;
  • - false: Shall be handled the same way as when this optional query parameter is not received.
| ID_UAS | +| multi-member-af-session-qos-ind | boolean | O | 0..1 |

This IE may be included when the target NF type is "NEF".

  • - true: An NF supporting Multi-member AF session with required QoS functionality is requested to be discovered.

Presence of this IE with false value shall be prohibited.

| Query-AIMLsys | +| member-ue-selection-assistance-ind | boolean | O | 0..1 |

This IE may be included when the target NF type is "NEF".

  • - true: An NF supporting member UE selection assistance functionality is requested to be discovered;

Presence of this IE with false value shall be prohibited.

| Query-AIMLsys | +| v2x-capability | V2xCapability | O | 0..1 |

When present, this IE indicates the V2X capability that the target PCF needs to support.

When the v2x-capability is provided as the query parameter, NRF shall return the PCF instances which support all the V2X capabilities requested.

| Query-SBIProtoc17 | +| prose-capability | ProSeCapability | O | 0..1 |

When present, this IE indicates the ProSe capability that the target PCF needs to support.

When the prose-capability is provided as the query parameter, NRF shall return the PCF instances which support all the ProSe capabilities requested.

| Query-5G-ProSe | +| shared-data-id | SharedDataId | O | 0..1 | Identifies the shared data that is stored in the NF (UDR) to be discovered. May be included if the target NF type is "UDR" | Query-SBIProtoc17 | +| target-hni | Fqdn | O | 0..1 |

If included, this IE shall contain the Home Network Identifier. If CH/DCS is using AAA Server or AUSF and UDM for primary authentication and authorization (see clauses 5.30.2.9.2, 5.30.2.9.3 and 5.30.2.10.2.2 in 3GPP TS 23.501 [2]), the sender (AMF or AUSF) populates this IE with CH/DCS ID. See also clauses 4.17.4a and 4.17.5a in TS 23.502 [3].

If the target NF is AUSF or NSSAAF and the HNI belongs to a CH/DCS with AAA Server in another domain, i.e. not in this SNPN, the NRF returns back the AUSF or NSSAAF in the same SNPN, based on the NF profile as specified in clause 6.2.6.2 in 3GPP TS 23.501 [2].

| Query-ENPN | +| target-nw-resolution | boolean | O | 0..1 |

If included and set to true, the NRF shall determine the identity of the target PLMN to which the NFDiscovery request shall be directed, based on the MSISDN of the UE included in the "gpsi" query parameter, as described in 3GPP TS 23.540 [48].

If included and set to false, this IE shall be ignored.

| Query-Nw-Resolution | +| exclude-nfinst-list | array(NfInstanceId) | O | 1..N |

If included, this IE shall indicate the list of NF instances that should not be returned in the NF Discovery response. (NOTE 23)

| Query-SBIProtoc17-Ext1 | +| exclude-nfservinst-list | array(NfServiceInstance) | O | 1..N |

If included, this IE shall indicate the list of NF service instances that should not be returned in the NF Discovery response. (NOTE 23)

| Query-SBIProtoc17-Ext1 | +| exclude-nfserviceset-list | array(NfServiceSetId) | O | 1..N |

If included, this IE shall indicate the list of NF service sets of NF service instances that should not be returned in the NF Discovery response. (NOTE 23)

| Query-SBIProtoc17-Ext1 | +| exclude-nfset-list | array(NfSetId) | O | 1..N |

If included, this IE shall indicate the list of NF sets of NF instances that should not be returned in the NF Discovery response. (NOTE 23)

| Query-SBIProtoc17-Ext1 | +| preferred- | map(DurationS | O | 1..N | If included, this IE shall contain the preferred Analytics Delay. | Query- | + +| | | | | | | +|------------------------|------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| analytics-delays | ec) | | |

The key of the map is the EventId or Nwdafevent (as defined in 3GPP TS 29.520 [33]) for which the preferred Analytics Delay is related to. Each element carries the preferred Analytics Delay for the Analytics ID indicated by the key.

The NRF shall return the NWDAFs supports the Analytics ID with a supported Analytics Delay that is less than or equal to the preferred Analytics Delay, as described in clause 6.3.13 of 3GPP TS 23.501 [2]. The NRF may return NWDAFs in the response not matching the preferred Analytics Delay, e.g. if no NWDAF profile is found matching the preferred Analytics Delay.

| eNA-PH2-Ext1 | +| high-latency-com | boolean | O | 0..1 |

If present and set to true, this attribute indicates target AMF(s) instances supporting High Latency communication (e.g. for NR RedCap UE) are required. This is used by CP NF to discover AMF supporting High Latency communication (see 3GPP TS 23.501 [2], clause 6.3.5).

Presence of this IE with false value shall be prohibited.

| Query-HLC | +| nsac-sai | NsacSai | O | 0..1 |

If included, it shall indicate the NSAC service area which shall be supported by the target NSACF. It may be included if the target NF type is "NSACF".

For NSAC hierarchical or centralized architecture, if this IE is set to "ENTIRE_PLMN", this indicates the NF service consumer wants to discover a primary NSACF for the entire PLMN. This IE shall be set to "ENTIRE_PLMN" also in roaming scenarios to discover the HPLMN NSACF as clarified in clause 6.3.22 of 3GPP TS 23.501 [2].

| Query-eNS-PH2 | +| complete-profile | boolean | O | 0..1 |

This IE may be included by an SCP with the value true to request to discover the complete profile of NF Instances (including authorization attributes such as the "allowedXXX" attributes of NFProfile and NFService data types) matching the query parameters. See clause 5.3.2.2.2.

Presence of this IE with false value shall be prohibited.

| Complete-Profile-Discovery | +| n32-purposes | array(N32Purpose) | O | 1..N |

This IE may be included when the target NF type is "SEPP". When present, this IE shall indicate the requested N32 purposes to be supported by the SEPP. The NRF shall return SEPP profiles that support at least one requested N32 purpose.

| Query-SBIProtoc18 | +| preferred-features | map(SupportedFeatures) | O | 1..N |

List of features preferred to be supported by the target Network Function, as defined by the supportedFeatures attribute in NFService (see clauses 6.1.6.2.3 and 6.2.6.2.4).

The key of the map is the Service Name as specified in clause 6.1.6.3.11. Each element carries the preferred feature(s) to be supported by the target Network Function for the indicated service.

The NRF shall prioritize the NF candidates supporting the preferred features in the search result.

(NOTE 24)

| Query-SBIProtoc18 | +| remote-plmn-id-roaming | PlmnId | O | 0..1 |

If included, this IE shall indicate the remote PLMN that the target NF service producer can serve, i.e. the NF service producer can serve the roaming UEs which belong to the indicated remote PLMN. This IE may be included when the target NF type is "SMSF".

The NRF shall return the candidate NF service producer(s) in discovery result with the following order of preference:

  • - NF profiles explicitly indicated the support of roaming UE for the requested remote PLMN; then
  • - NF profiles indicated the support of roaming UE for any
| Query-SBIProtoc18 | + +| | | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | remote PLMN; then
  • - if none of above are available, NF profiles without indication of roaming UE support.
| | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|------------------------------------------|------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| pru-tai | Tai | O | 0..1 | This may be included if the target NF type is "LMF".

When present, this IE indicates whether LMF(s) serving a TAI with PRU(s) existence needs to be discovered. | Query-eLCS-PH3 | +| pru-support-ind | boolean | O | 0..1 | This IE may be included when the target NF type is "LMF".

When present, this IE indicates whether the LMF(s) supporting PRU function need(s) to be discovered.

true: target LMF(s) supporting PRU function are requested to be discovered;
false: target LMF(s) not supporting PRU function are requested to be discovered. | Query-eLCS-PH3 | +| preferred-up-positioning-ind | boolean | O | 0..1 | This IE may be included when the target NF type is "LMF".

When present, this IE indicates whether the LMF(s) supporting user plane positioning capability are desired to be discovered.

true: target LMF(s) supporting user plane positioning capability are desired to be discovered;

Presence of this IE with false value shall be prohibited. | Query-eLCS-PH3 | +| af-data | AfData | O | 0..1 | When present, this IE shall contain the event that is supported by the "AF" for trusted AF discovery. | Query-eLCS-PH3 | +| ml-accuracy-checking-ind | boolean | O | 0..1 | If present and set to true, this attribute indicates target NWDAF(s) instances containing MTLF with ML Model accuracy checking capability are required.

Presence of this IE with false value shall be prohibited. | Query-eNA-PH3 | +| analytics-accuracy-checking-ind | boolean | O | 0..1 | If present and set to true, this attribute indicates target NWDAF(s) instances containing AnLF with Analytics accuracy checking capability are required.

Presence of this IE with false value shall be prohibited. | Query-eNA-PH3 | +| ml-model-storage-ind | boolean | O | 0..1 | If present and set to true, this attribute indicates target ADRF(s) instances with ML model storage and retrieval capability are required.

Presence of this IE with false value shall be prohibited. | Query-eNA-PH3 | +| data-storage-ind | boolean | O | 0..1 | If present and set to true, this attribute indicates target ADRF(s) instances with data and analytics storage and retrieval capability are required.

Presence of this IE with false value shall be prohibited. | Query-eNA-PH3 | +| data-subscription-relocation-support-ind | boolean | O | 0..1 | If present and set to true, this attribute indicates target DCCF(s) instances with relocation of data subscription support are required.

Presence of this IE with false value shall be prohibited. | Query-eNA-PH3 | +| roaming-exchange-ind | boolean | O | 0..1 | This IE may be included when the target NF type is "NWDAF".

- true: An NF supporting roaming exchange capability is requested to be discovered.

Presence of this IE with false value shall be prohibited. | Query-eNA-PH3 | +| media-capability-list | array(MediaCapability) | O | 1..N | If present, this attribute shall contain the list of media capability that can be served by the NF instances to be discovered. The NRF shall return NF profiles of NFs which can serve all the media capabilities requested in this query parameter. | Query-NG-RTC | +| a2x-support-ind | boolean | O | 0..1 | When present, this IE indicates whether a PCF supporting A2X Policy/Parameter provisioning needs to be discovered.

true: a PCF supporting A2X Policy/Parameter provisioning is requested to be discovered;
false: a PCF not supporting A2X Policy/Parameter provisioning is requested to be discovered. | Query-A2X | + +| | | | | | | +|----------------------------|---------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| a2x-capability | A2xCapability | O | 0..1 | When present, this IE indicates the A2X capability that the target PCF needs to support.

When the a2x-capability is provided as the query parameter, NRF shall return the PCF instances which support all the A2X capabilities requested. | Query-A2X | +| ranging-sl-pos-support-ind | boolean | O | 0..1 | When present, this IE indicates whether supporting ranging and sidelink positioning capability by PCF/LMF needs to be discovered.

- true: a PCF/LMF supporting ranging and sidelink positioning capability is requested to be discovered

Presence of this IE with false value shall be prohibited. | Query-5G-Ranging SIPos | +| complete-search-result | boolean | O | 0..1 | This IE may be present with the value true to indicate that all the NF profiles or NF Instance IDs matching the query parameters are requested to be returned.
The presence of this IE with the value false shall be prohibited. (NOTE 29) | Query-SBIProtoc18 | + +- NOTE 1: If this parameter is present and no AMF supporting the requested GUAMI is available due to AMF Failure or planned AMF removal, the NRF shall return in the response AMF instances acting as a backup for AMF failure or planned AMF removal respectively for this GUAMI (see clause 6.1.6.2.11). The NRF can detect if an AMF has failed, using the Heartbeat procedure. The NRF will receive a de-registration request from an AMF performing a planned removal. +- NOTE 2: If the combined SMF/PGW-C is requested to be discovered, the NRF shall return in the response the SMF instances registered with the SmfInfo containing pgwFqdn. +- NOTE 3: If a UPF supporting interworking with EPS is requested to be discovered, the NRF shall return in the response the UPF instances registered with the upfInfo containing iwkEpsInd set to true. +- NOTE 4: This attribute has a different semantic than what is defined in clause 6.6.2 of 3GPP TS 29.500 [4], i.e. it is not used to signal optional features of the Nnrf\_NFDiscovery Service API supported by the requester NF. +- NOTE 5: The AMF may perform the SMF discovery based on the dnn, snssais and preferred-tai during a PDU session establishment procedure, and the NRF shall return the SMF profiles matching all if possible, or the SMF profiles only matching dnn and snssais. If the SMF profiles only matching dnn and snssais are returned, the AMF shall insert an I-SMF. An SMF may also perform a UPF discovery using this parameter. +- NOTE 6: The SMF may select the P-CSCF close to the UPF by setting the preferred-locality to the value of the locality of the UPF. +- NOTE 7: During EPS to 5GS idle mobility procedure, the Requester NF (i.e. SMF) discovers the anchor NEF for NIDD using the SCEF ID received from EPS as the value of the NEF ID, as specified in clause 4.11.1.3.3 of 3GPP TS 23.502 [3]. +- NOTE 8: The service consumer may include a list of preferred-nf-instance-ids in the query. If so, the NRF shall first check if the NF profiles of the preferred NF instances match the other query parameters, and if so, then the NRF shall return the corresponding NF profiles; otherwise, the NRF shall return a list of candidate NF profiles matching the query parameters other than the preferred-nf-instance-ids. For example, the target AMF may set this query parameter to the SMF Instance ID and I-SMF Instance ID during an inter AMF mobility procedure to select an I-SMF. +- NOTE 9: This parameter may be used by the SCP (with other query parameters) to discover and select a NF service consumer with a default notification subscription supporting the notification type of a notification request (see clause 6.10.3.3 of 3GPP TS 29.500 [4]). +- NOTE 10: An S-NSSAI value used in discovery request query parameters shall be considered as matching the S-NSSAI value in the NF Profile or NF Service of a given NF Instance if both the SST and SD components are identical (i.e. an S-NSSAI value where SD is absent, shall not be considered as matching an S-NSSAI where SD is present, regardless if SST is equal in both). +- NOTE 11: The dnn query parameter shall be considered as matching a DNN attribute in the NF Profile of a given NF Instance if: +- both contain the same Network Identifier and Operator Identifier; + - both contain the same Network Identifier and none contains an Operator Identifier; + - the dnn query parameter contains the Network Identifier only, the DNN value in the NF Profile contains both the Network Identifier and Operator Identifier, and both contain the same Network Identifier; or + - the dnn query parameter contains both the Network Identifier and Operator Identifier, the DNN value in the NF Profile contains the Network Identifier only, both contain the same Network Identifier and the Operator Identifier matches one PLMN of the NF (i.e. plmnList of the NF Profile). +- NOTE 12: Based on operator's policies, a discovery request not including the requester's information necessary to validate the authorization parameters in NF Profiles may be rejected or accepted but with only returning in the discovery response NF Instances whose authorization parameters allow any NF Service Consumer to access their services. The authorization parameters in NF Profile are those used by NRF to determine whether a given NF Instance / NF Service Instance can be discovered by an NF Service Consumer in order to consume its offered services (e.g. "allowedNfTypes", "allowedNfDomains", etc.). +- NOTE 13: Different UPF instances for data forwarding may be configured in the network e.g. for different serving areas. + +The SMF may use this query parameter together with others (like SMF Serving Area or TAI) in discovery to select the UPF candidate for data forwarding. + +- NOTE 14: For HR roaming, if the V-PLMN requires Deployments Topologies with specific SMF Service Areas (DTSSA) but no H-SMF can be selected supporting V-SMF change, AMF may use this query parameter to select a V-SMF serving the full VPLMN if available. +- NOTE 15: The AMF may perform discovery with this parameter to find V-SMF(s)/I-SMF(s), and the NRF shall return the SMF profiles that explicitly indicated support of V-SMF/I-SMF(s) capability. When performing discovery, the AMF shall use other query parameters together with this IE to ensure the required configurations and/or features are supported by the V-SMF/I-SMF(s), e.g. required Slice for the PDU session, support of DTSSA feature if V-SMF change is required for PDU Session, etc. If no SMF instances that explicitly indicated support of V-SMF/I-SMF(s) capability can be matched for the discovery, the NRF shall return matched SMF instances not indicating support of V-SMF/I-SMF(s) capability explicitly, i.e. the SMF instances not registered vsmfSupportInd/ismfSupportInd IE in the NF profile but matched to the rest query parameters, if available. +- NOTE 16: When required-pfcp-features is used as query parameter, the NRF shall return a list of candidate UPFs supporting all the required PFCP features. The NRF may also return UPF profiles not including the "SupportedPfcpFeatures" attribute (e.g. pre-Rel-17 UPFs) but matching the other query parameters. The NF Service Consumer, e.g. a SMF, when using required-pfcp-features as query parameter, shall also include the query parameter corresponding to the UPF features (atssss-capability, upf-ue-ip-addr-ind, redundant-gtpu) which correspond to the PFCP feature flags MPTCP and ATSSS\_LL, UEIP, and RTTL respectively, if the corresponding PFCP feature is required. For example an SMF, that wishes to select a UPF supporting UE IP Address Allocation by the UP function, shall set the UEIP flag to "1" in the required-pfcp-features and also include the upf-ue-ip-addr-ind parameter set to "true". +- NOTE 17: In this release, the usage of Home Network Public Key identifier for AUSF/UDM discovery is limited to the scenario where the AUSF/UDM NF consumers belong to the same PLMN as AUSF/UDM. +- NOTE 18: The NF service consumer may derive the serving scope from e.g. the TAI of the UE, using local configuration. This parameter may be used to discover any NF that registers to the NRF, e.g. a 5GC NF or a P-CSCF. +- NOTE 19: If the NRF supports the "Collocated-NF-Selection" feature and the NF service consumer has included the "preferred-collocated-nf-types" attribute, the NRF shall return a list of candidates NFs (for the target-nf-type) matching the discovery query parameters and preferentially supporting CollocatedNFType(s) as indicated in the preferred-collocated-nf-types. +- NOTE 20: If the NRF supports this IE and the NF service consumer has included this IE with the value "true" in discovery request, the NRF shall look up and return PGW-C+SMF instances matching the other query parameters. If no matching is found, the NRF shall return a list of standalone SMF instances matching the other query parameters. If the NRF supports this IE and the NF service consumer has included this IE with the value "false" in discovery request, the NRF shall look up and return standalone SMF instances matching the other query parameters. If no matching is found, the NRF shall return a list of PGW-C+SMF instances matching the other query parameters. +- NOTE 21: Either pgw-ind IE or preferred-pgw-ind IE may be included in the discovery request. +- NOTE 22: MB-SMF may use an NRF to discover the AMF(s) serving an MBS service area (see clause 7.3.1 in 3GPP TS 23.247 [43]). For this purpose, the MB-SMF may use query parameters specified in this table, e.g. 'tai' and 'service-names', or 'snssais', or any other parameters. +- NOTE 23: This parameter may be set by an NF service consumer or SCP to filter-out specific NF (service) instances or NF (service) sets from the NF Discovery response, e.g. when the NFc knows that an NF service producer is not responsive or overloaded. See the 3gpp-Sbi-Selection-Info header in clause 5.2.3.3.10 of 3GPP TS 29.500 [4]. +- NOTE 24: A feature shall not be included in both required-features IE and preferred-features IE in the same discovery request. +- NOTE 25: When Locality is configured in NSACF(s), an NSACF consumer, e.g. AMF or SMF, may use a locally configured NSACF Locality to discover the candidate NSACF, or otherwise may use its own Locality to discover the candidate NSACF. When Locality is configured in MRF(s) or MRFP(s), an MRF/MRFP consumer, e.g. IMS entity, may use a locally configured MRF/MRFP Locality to discover the candidate MRF/MRFP, or otherwise may use its own Locality to discover the candidate MRF/MRFP. When Locality is configured in MF, an MF consumer, e.g. IMS AS, may use a locally configured MF Locality to discover the candidate MF, or otherwise may use its own Locality to discover the candidate MF. +- NOTE 26: Only one of the target-nf-instance-id and target-nf-instance-id-list query parameters may be present in an NF Discovery Request. +- NOTE 27: When the query parameter "ue-ipv4-address" or "ue-ipv6-prefix" is used to discover a UPF as specified in clause 4.15.10 of 3GPP TS 23.502 [3], the NRF shall find a match by looking into either natedIpv4AddressRanges or natedIpv6PrefixRanges in the DnnUpfInfoItem. +- NOTE 28: If the NF service consumer includes a "tai-list" query parameter and the "nf-tai-list-ind" query parameter set to true, and if the NRF supports the same and the NRF is not able to find any NF supporting all TAs included in the tai-list, the NRF may return a list of NFs in the SearchResult where each NF supports at least one TA in the tai-list; in this case, the NRF should attempt to return a list of NFs that altogether support as many TAs from the tai-list as possible, and it should indicate in the SearchResultInfo attribute the list of TAs from the tai-list which are not supported by these NFs. +- NOTE 29: The NRF should return as many matching NF profiles and/or NF Instance IDs as possible in the NF Discovery Response. If all the NF profiles matching the query parameters cannot be returned in the NF + +Discovery response (e.g. due to the maximum payload size), the NRF may decide to store the complete search result for subsequent retrieval by the NRF consumer (see clause 6.2.3.4). Alternatively, the NRF may include all the NF instance IDs rather than NF profiles in the NF Discovery response (using the Enh-NF-Discovery feature, see clause 5.3.2.2.2). + +When certain query parameters in the discovery request are not supported by the NRF, the NRF shall ignore the unsupported query parameters and continue processing the request with the supported query parameters. The default logical relationship among the supported query parameters is logical "AND", i.e. all the provided query parameters shall be matched, with the exception of the "preferred-locality", "ext-preferred-locality", "preferred-nf-instances", "preferred-tai", "preferred-api-versions", "preferred-full-plmn", "preferred-collocated-nf-types", "preferred-pgw-ind", "preferred-analytics-delays", "preferred-features" and "mbs-session-id" query parameters (see Table 6.2.3.2.3.1-1). + +The NRF may support the Complex query expression as defined in 3GPP TS 29.501 [5] for the NF Discovery service. If the "complexQuery" query parameter is included, then the logical relationship among the query parameters contained in "complexQuery" query parameter is as defined in 3GPP TS 29.571 [7]. + +A NRF not supporting Complex query expression shall reject a NF service discovery request including a complexQuery parameter, with a ProblemDetails IE including the cause attribute set to INVALID\_QUERY\_PARAM and the invalidParams attribute indicating the complexQuery parameter. + +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.2.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.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SearchResult | M | 1 | 200 OK | The response body contains the result of the search over the list of registered NF Instances. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The response shall be used when the intermediate NRF redirects the service discovery request.
The NRF shall include in this response a Location header field containing a URI pointing to the resource located on the redirect target NRF. If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| ProblemDetails | O | 0..1 | 400 Bad Request | The response body contains the error reason of the request message.

If the query parameter used to match the authorization parameter is required but not provided in the NF discovery request, the "cause" attribute shall be set to "MANDATORY_QUERY_PARAM_MISSING", and the missing query parameter shall be indicated. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This response shall be returned if the Requester NF is not allowed to discover the NF Service(s) being queried. | +| ProblemDetails | O | 0..1 | 404 Not Found | This response shall be returned if the requested resource URI as defined in clause 6.2.3.2.2 (query parameter not considered) is not found in the server.

It may also be sent in hierarchical NRF deployments when the NRF needs to forward/redirect the request to another NRF but lacks information in the request to do so; similarly, the NRF shall return this response code when it is received from the upstream NRF. | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | The response body contains the error reason of the request message. | + +**Table 6.2.3.2.3.1-4: Headers supported by the GET method on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|---------------------------------------------------------------------------------------| +| If-None-Match | string | C | 0..1 | Validator for conditional requests, as described in IETF RFC 9110 [40], clause 13.1.2 | + +**Table 6.2.3.2.3.1-5: Headers supported by the 200 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|-----------------------------------------------------------------------------------------| +| Cache-Control | string | C | 0..1 | Cache-Control containing max-age, described in IETF RFC 9111 [20], clause 5.2 | +| ETag | string | C | 0..1 | Entity Tag containing a strong validator, described in IETF RFC 9110 [40], clause 8.8.3 | + +**Table 6.2.3.2.3.1-6: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|---------------------------------------------------------------------| +| Location | string | M | 1 | The URI pointing to the resource located on the redirect target NRF | + +**Table 6.2.3.2.3.1-7: Links supported by the 200 Response Code on this endpoint** + +| Name | Resource name | HTTP method or custom operation | Parameters table | Description | +|----------------|-----------------------------------|---------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| search | Stored Search (Document) | GET | 6.2.3.2.3.1-8 | The 'searchId' parameter returned in the response can be used as the 'searchId' parameter in the GET request to '/searches/{searchId}' | +| completeSearch | Complete Stored Search (Document) | GET | 6.2.3.2.3.1-9 | The 'searchId' parameter returned in the response can be used as the 'searchId' parameter in the GET request to '/searches/{searchId}/complete' | + +## 6.2.3.2.4 Resource Custom Operations + +There are no resource custom operations for the Nnrf\_NFDiscovery service in this release of the specification. + +## 6.2.3.3 Resource: Stored Search (Document) + +### 6.2.3.3.1 Description + +This resource represents a search result (i.e. a number of discovered NF Instances), stored by NRF as a consequence of a prior search result. + +This resource is modelled as the Document resource archetype (see clause C.3 of 3GPP TS 29.501 [5]). + +### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-disc/v1/searches/{searchId} + +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.1.1 | +| searchId | string | Identifier of a stored search result, returned by NRF to the NF Consumer in the original response to the NF Discovery GET operation (see clause 6.2.6.2.2). | + +### 6.2.3.3.2.1 GET + +This method retrieves the NF Instances corresponding to a given stored search result. + +This method shall support the URI query parameters specified in table 6.2.3.3.2.1-1. + +**Table 6.2.3.3.2.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 6.2.3.3.2.1-2 and the response data structures and response codes specified in table 6.2.3.3.2.1-3. + +**Table 6.2.3.3.2.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.2.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|----------------|--------------------------------------------------------------------------------------------| +| StoredSearchResult | M | 1 | 200 OK | The response body contains the NF Instances corresponding to a given stored search result. | +| NOTE: | 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]). | | | | + +## 6.2.3.4 Resource: Complete Stored Search (Document) + +### 6.2.3.4.1 Description + +This resource represents a complete search result (i.e. a number of discovered NF Instances), stored by NRF as a consequence of a prior search result, but without applying any client restrictions in terms of the number of instances to be returned (i.e. "limit" or "max-payload-size" query parameters). + +This resource is modelled as the Document resource archetype (see clause C.3 of 3GPP TS 29.501 [5]). + +### 6.2.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-disc/v1/searches/{searchId}/complete + +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.1.1 | +| searchId | string | Identifier of a stored search result, returned by NRF to the NF Consumer in the original response to the NF Discovery GET operation (see clause 6.2.6.2.2). | + +#### 6.2.3.4.2.1 GET + +This method retrieves the NF Instances corresponding to a given stored search result. + +This method shall support the URI query parameters specified in table 6.2.3.4.2.1-1. + +**Table 6.2.3.4.2.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 6.2.3.4.2.1-2 and the response data structures and response codes specified in table 6.2.3.4.3.1-3. + +**Table 6.2.3.4.2.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.4.2.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| StoredSearchResult | M | 1 | 200 OK | The response body contains the NF Instances corresponding to a given stored search result, but without applying any client restrictions in terms of the number of instances to be returned (i.e. "limit" or "max-payload-size" query parameters). | +| NOTE: 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]). | | | | | + +## 6.2.3.5 Resource: SCP Domain Routing Information (Document) + +### 6.2.3.5.1 Description + +This resource represents (local) SCP Domain Routing Information, calculated by NRF based on SCPs registered in the network (or in the producer NRF for local SCP Domain Routing Information). + +This resource is modelled as the Document resource archetype (see clause C.3 of 3GPP TS 29.501 [5]). + +### 6.2.3.5.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-disc/v1/scp-domain-routing-info + +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.2.1 GET + +This method retrieves the (local) SCP Domain Routing Information. + +This method shall support the URI query parameters specified in table 6.2.3.5.2.1-1. + +**Table 6.2.3.5.2.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| local | boolean | O | 0..1 | When present, this IE shall indicate whether local SCP Domain Routing Information is to be fetched:
- true: local SCP Domain Routing Information to be fetched.
- false (default): SCP Domain Routing Information to be fetched | + +This method shall support the request data structures specified in table 6.2.3.5.2.1-2 and the response data structure and response codes specified in table 6.2.3.5.2.1-3. + +**Table 6.2.3.5.2.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.5.2.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------| +| ScpDomainRoutingInfo | M | 1 | 200 OK | The response body contains SCP Domain Routing Information. | +| NOTE: 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]). | | | | | + +## 6.2.3.6 Resource: SCP Domain Routing Information Subscriptions (Collection) + +### 6.2.3.6.1 Description + +This resource represents a collection of subscriptions of (local) SCP Domain Routing Information. + +### 6.2.3.6.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-disc/v1/scp-domain-routing-info-subs + +This resource shall support the resource URI variables defined in table 6.2.3.6.2-1. + +**Table 6.1.3.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 6.2.1 | + +### 6.2.3.6.3 Resource Standard Methods + +#### 6.2.3.6.3.1 POST + +This method creates a new subscription. This method shall support the URI query parameters specified in table 6.2.3.6.3.1-1. + +**Table 6.2.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.2.3.6.3.1-2 and the response data structure and response codes specified in table 6.2.3.6.3.1-3. + +**Table 6.2.3.6.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------------|---|-------------|----------------------------------------------------------------------| +| ScpDomainRoutingInfoSubscription | M | 1 | The request body contains the input parameters for the subscription. | + +**Table 6.2.3.6.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ScpDomainRoutingInfoSubscription | M | 1 | 201 Created | This case represents the successful creation of a subscription.

Upon success, the HTTP response shall include a "Location" HTTP header that contains the resource URI of the created 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 [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]). | | | | | + +**Table 6.2.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}/nnrf-disc/v1/scp-domain-routing-info-subs/{subscriptionId} | + +## 6.2.3.7 Resource: Individual SCP Domain Routing Information Subscription (Document) + +### 6.2.3.7.1 Description + +This resource represents an individual subscription of (local) SCP Domain Routing Information. + +### 6.2.3.7.2 Resource Definition + +Resource URI: {apiRoot}/nnrf-disc/v1/scp-domain-routing-info-subs/{subscriptionID} + +This resource shall support the resource URI variables defined in table 6.2.3.7.2-1. + +**Table 6.2.3.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------| +| apiRoot | string | See clause 6.2.1 | +| subscriptionID | string | Represents a specific subscription | + +### 6.2.3.7.3 Resource Standard Methods + +#### 6.2.3.7.3.1 DELETE + +This method terminates an existing subscription. This method shall support the URI query parameters specified in table 6.2.3.7.3.1-1. + +**Table 6.2.3.7.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 6.2.3.7.3.1-2 and the response data structure and response codes specified in table 6.2.3.7.3.1-3. + +**Table 6.2.3.7.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.7.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 | | +| NOTE: | 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]). | | | | + +## 6.2.4 Custom Operations without associated resources + +There are no custom operations defined without any associated resources for the Nnrf\_NFDiscovery service in this release of this specification. + +## 6.2.5 Notifications + +### 6.2.5.1 General + +This clause specifies the notifications provided by the Nnrf\_NFDiscovery service. + +The delivery of notifications shall be supported as specified in clause 6.2 of 3GPP TS 29.500 [4] for Server-initiated communication. + +**Table 6.2.5.1-1: Notifications overview** + +| Notification | Resource URI | HTTP method or custom operation | Description (service operation) | +|----------------------------------------------------|--------------------------------------------------------------------|---------------------------------|-------------------------------------------------------| +| SCP Domain Routing Information Change Notification | {callbackUri}
(NF Service Consumer provided callback reference) | POST | Notify about change of SCP Domain Routing Information | + +### 6.2.5.2 SCP Domain Routing Information Change Notification + +#### 6.2.5.2.1 Description + +The NF Service Consumer provides a callback URI for getting notified about change of (local) SCP Domain Routing Information, the NRF shall notify the NF Service Consumer, when the (local) SCP Domain Routing Information is updated. + +#### 6.2.5.2.2 Notification Definition + +The POST method shall be used for SCP Domain Routing Information Change Notification and the URI shall be the callback reference provided by the NF Service Consumer during the subscription to this notification. + +Resource URI: {callbackUri} + +Support of URI query parameters are specified in table 6.2.5.2.2-1. + +**Table 6.2.5.2.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 6.2.5.2.2-2, and support of response data structures and response codes is specified in table 6.2.5.2-3. + +**Table 6.2.5.2.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------------------------|---|-------------|---------------------------------------------------------------------------| +| ScpDomainRoutingInfoNotification | M | 1 | Representation of the SCP Domain Routing Information Change Notification. | + +**Table 6.2.5.2.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|----------------|------------------------------------------------------------------------------------------| +| N/A | | | 204 No Content | This case represents a successful notification of SCP Domain Routing Information Change. | +| 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]). | | | | + +## 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 Nnrf service based interface protocol. + +**Table 6.2.6.1-1: Nnrf\_NFDiscovery specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------| +| SearchResult | 6.2.6.2.2 | Contains the list of NF Profiles returned in a Discovery response. | +| NFProfile | 6.2.6.2.3 | Information of an NF Instance discovered by the NRF. | +| NFService | 6.2.6.2.4 | Information of a given NF Service Instance; it is part of the NFProfile of an NF Instance discovered by the NRF. | +| StoredSearchResult | 6.2.6.2.5 | Contains a complete search result (i.e. a number of discovered NF Instances), stored by NRF as a consequence of a prior search result. | +| PreferredSearch | 6.2.6.2.6 | Contains information on whether the returned NFProfiles match the preferred query parameters. | +| NFInstanceInfo | 6.2.6.2.7 | Contains information on an NF profile matching a discovery request. | +| ScpDomainRoutingInfo | 6.2.6.2.8 | SCP Domain Routing Information | +| ScpDomainConnectivity | 6.2.6.2.9 | SCP Domain Routing Information | +| ScpDomainRoutingInfoSubscription | 6.2.6.2.10 | SCP Domain Routing Information Subscription | +| ScpDomainRoutingInfoNotification | 6.2.6.2.11 | Notification for SCP Domain Routing Information Update | +| NFServiceInstance | 6.2.6.2.12 | NF service instance | +| NoProfileMatchInfo | 6.2.6.2.13 | No Profile Matching information | +| QueryParamCombination | 6.2.6.2.14 | Contains a list of query parameters | +| QueryParameter | 6.2.6.2.15 | Contains name and value of a query parameter | +| AfData | 6.2.6.2.16 | Contains information supported by the trusted AF. | +| SearchResultInfo | 6.2.6.2.17 | Contains additional information related to the SearchResult. | + +Table 6.2.6.1-2 specifies data types re-used by the Nnrf\_NFDiscovery 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 Nnrf\_NFDiscovery service-based interface. + +**Table 6.2.6.1-2: Nnrf\_NFDiscovery re-used Data Types** + +| Data type | Reference | Comments | +|---------------------------------|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Sns sai | 3GPP TS 29.571 [7] | | +| PimnId | 3GPP TS 29.571 [7] | | +| Dnn | 3GPP TS 29.571 [7] | | +| Tai | 3GPP TS 29.571 [7] | | +| SupportedFeatures | 3GPP TS 29.571 [7] | | +| NfInstanceId | 3GPP TS 29.571 [7] | Identifier (UUID) of the NF Instance. The hexadecimal letters of the UUID should be formatted by the sender as lower-case characters and shall be handled as case-insensitive by the receiver. | +| Uri | 3GPP TS 29.571 [7] | | +| Gpsi | 3GPP TS 29.571 [7] | | +| GroupId | 3GPP TS 29.571 [7] | | +| Guami | 3GPP TS 29.571 [7] | | +| IPv4Addr | 3GPP TS 29.571 [7] | | +| IPv6Addr | 3GPP TS 29.571 [7] | | +| UriScheme | 3GPP TS 29.571 [7] | | +| Dnai | 3GPP TS 29.571 [7] | | +| NfGroupId | 3GPP TS 29.571 [7] | Identifier of a NF Group | +| PduSessionType | 3GPP TS 29.571 [7] | | +| AtsssCapability | 3GPP TS 29.571 [7] | | +| PimnIdNid | 3GPP TS 29.571 [7] | | +| NfSetId | 3GPP TS 29.571 [7] | | +| NfServiceSetId | 3GPP TS 29.571 [7] | | +| ExtSns sai | 3GPP TS 29.571 [7] | | +| DurationSec | 3GPP TS 29.571 [7] | | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of the redirect response message. | +| MbsSessionId | 3GPP TS 29.571 [7] | MBS Session Identifier | +| IpAddr | 3GPP TS 29.571 [7] | IP Address | +| AreaSessionId | 3GPP TS 29.571 [7] | Area Session Identifier used for an MBS session with location dependent content | +| Fqdn | 3GPP TS 29.571 [7] | Fully Qualified Domain Name | +| EventId | 3GPP TS 29.520 [32] | Defined in Nnwdaf_AnalyticsInfo API. | +| NwdafEvent | 3GPP TS 29.520 [32] | Defined in Nnwdaf_EventsSubscription API. | +| ExtGroupId | 3GPP TS 29.503 [36] | | +| SharedDataId | 3GPP TS 29.503 [36] | | +| ExternalClientType | 3GPP TS 29.572 [33] | | +| SupportedGADShapes | 3GPP TS 29.572 [33] | Supported GAD Shapes | +| EventType | 3GPP TS 29.564 [49] | Event type supported by the UPF Event Exposure service | +| DefaultNotificationSubscription | 3GPP TS 29.510 | See clause 6.1.6.2.4 | +| IPEndPoint | 3GPP TS 29.510 | See clause 6.1.6.2.5 | +| NFType | 3GPP TS 29.510 | See clause 6.1.6.3.3 | +| UdrInfo | 3GPP TS 29.510 | See clause 6.1.6.2.6 | +| UdmInfo | 3GPP TS 29.510 | See clause 6.1.6.2.7 | +| AusfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.8 | +| SupiRange | 3GPP TS 29.510 | See clause 6.1.6.2.9 | +| AmfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.11 | +| SmfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.12 | +| UpfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.13 | +| PcfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.20 | +| BsfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.21 | +| ChfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.32 | +| NFServiceVersion | 3GPP TS 29.510 | See clause 6.1.6.2.19 | +| PimnSns sai | 3GPP TS 29.510 | See clause 6.1.6.2.44 | +| NwdafInfo | 3GPP TS 29.510 | See clause 6.1.6.2.45 | +| NFStatus | 3GPP TS 29.510 | See clause 6.1.6.3.7 | +| DataSetId | 3GPP TS 29.510 | See clause 6.1.6.3.8 | +| ServiceName | 3GPP TS 29.510 | See clause 6.1.6.3.11 | +| NFServiceStatus | 3GPP TS 29.510 | See clause 6.1.6.3.12 | +| LmfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.46 | +| GmlcInfo | 3GPP TS 29.510 | See clause 6.1.6.2.47 | +| NefInfo | 3GPP TS 29.510 | See clause 6.1.6.2.48 | +| PfdData | 3GPP TS 29.510 | See clause 6.1.6.2.49 | +| AfEventExposureData | 3GPP TS 29.510 | See clause 6.1.6.2.50 | +| PscsfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.53 | + +| | | | +|-------------------------|----------------|------------------------| +| HssInfo | 3GPP TS 29.510 | See clause 6.1.6.2.57 | +| ImsiRange | 3GPP TS 29.510 | See clause 6.1.6.2.58 | +| VendorSpecificFeature | 3GPP TS 29.510 | See clause 6.1.6.2.62 | +| ScpInfo | 3GPP TS 29.510 | See clause 6.1.6.2.65 | +| NefId | 3GPP TS 29.510 | See clause 6.1.6.3.2 | +| VendorId | 3GPP TS 29.510 | See clause 6.1.6.3.2 | +| AnNodeType | 3GPP TS 29.510 | See clause 6.1.6.3.13 | +| SuciInfo | 3GPP TS 29.510 | See clause 6.1.6.2.71 | +| SeppInfo | 3GPP TS 29.510 | See clause 6.1.6.2.72 | +| NsacfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.81 | +| NsacfCapability | 3GPP TS 29.510 | See clause 6.1.6.2.82 | +| MIAnalyticsInfo | 3GPP TS 29.510 | See clause 6.1.6.2.84 | +| MbSmfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.85 | +| TsctsInfo | 3GPP TS 29.510 | See clause 6.1.6.2.91 | +| MbUpfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.94 | +| TrustAfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.96 | +| CollocatedNfInstance | 3GPP TS 29.510 | See clause 6.1.6.2.99 | +| NssaaInfo | 3GPP TS 29.510 | See clause 6.1.6.2.104 | +| IwmscInfo | 3GPP TS 29.510 | See clause 6.1.6.2.108 | +| MnpfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.109 | +| LocalityDescriptionItem | 3GPP TS 29.510 | See clause 6.1.6.2.111 | +| LocalityDescription | 3GPP TS 29.510 | See clause 6.1.6.2.112 | +| DcsfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.114 | +| MrfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.117 | +| MrfpInfo | 3GPP TS 29.510 | See clause 6.1.6.2.118 | +| MfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.119 | +| LocalityType | 3GPP TS 29.510 | See clause 6.1.6.3.18 | +| AdrfInfo | 3GPP TS 29.510 | See clause 6.1.6.2.122 | +| SelectionConditions | 3GPP TS 29.510 | See clause 6.1.6.2.123 | +| CallbackUriPrefixItem | 3GPP TS 29.510 | See clause 6.1.6.2.127 | + +## 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: SearchResult + +**Table 6.2.6.2.2-1: Definition of type SearchResult** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| validityPeriod | integer | M | 1 | It shall contain the time in seconds during which the discovery result is considered valid and can be cached by the NF Service Consumer. This value shall be the same as the value contained in the "max-age" parameter of the "Cache-Control" header field sent in the HTTP response. | | +| nflnstances | array(NFProfile) | M | 0..N | It shall contain an array of NF Instance profiles, matching the search criteria indicated by the query parameters of the discovery request. If the nflnstancesList IE is absent, an empty array means there is no NF instance that can match the search criteria.
NF instance profiles included in this IE shall not contain authorization attributes (such as the "allowedXXX" attributes of the NFProfile or NFService data types). | | +| completeNflnstances | array(NFProfile) | C | 1..N | When present, it shall contain an array of complete NF Instance profiles (including authorization attributes such as the "allowedXXX" attributes of the NFProfile or NFService data types), matching the search criteria indicated by the query parameters of the discovery request.

This IE shall only be present if the NRF supports the "Complete-Profile-Discovery" feature, the "complete-profile" query parameter is present and set to true in the request (see clause 6.2.3.2.3.1) and if the requesting entity is authorized to discover the complete profile of NF instances. | | +| searchId | string | O | 0..1 | This IE may be present if the NRF stores the result of the current service discovery response in a given URL (server-side caching), to make it available in the future to NF Service Consumers without having to compute the whole search process again. | | +| numNflnstComplete | Uint32 | O | 0..1 | This IE may be present when the total number of NF Instances found by NRF, as the result of the service discovery process, is higher than the actual number of NF Instances included in the attribute nflnstances of the SearchResult object. This may happen due to the NF Service Consumer including in the discovery request parameters such as "limit" or "max-payload-size". | | +| preferredSearch | PreferredSearch | C | 0..1 | This IE shall be present to indicate whether all the returned NFProfiles match the preferred query parameters, if the discovery request contains any of the query parameter defined in the PreferredSearch data type. | | +| nrfSupportedFeatures | SupportedFeatures | C | 0..1 | Features supported by the NRF for the NFDiscovery service (see clause 6.2.9). This IE should be present if the NRF supports at least one feature. | | +| nflnstanceList | map(NflnstanceInfo) | O | 1..N | This IE may be present if the NF Discovery request indicated support of the Enh-NF-Discovery feature.
When present, this IE shall contain a map of NflnstanceInfo of NF instance profiles matching the search criteria indicated by the query parameters of the discovery request. The key of the map shall be the NF instance ID.
(NOTE 2) | | +| searchResultInfo | SearchResultInfo | C | 0..1 | This IE should be present if the NF Discovery Request includes a tai-list query parameter and the "nf-tai-list-ind" query parameter set to true, | Query-SBIProtoc18 | + +| | | | | | | +|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | when the NFs included in the nfinstances or nfinstanceList altogether support only a subset of TAs included in the tai-list. | | +| alteredPriorityInd | boolean | O | 0..1 |

This IE shall indicate whether the NRF altered the priority values returned in the search result or not. (NOTE 1, NOTE 3)

When present, this IE shall be set as following:
- true: NF instances with NRF altered priority are returned in the search result.
- false: the NRF has not altered priority values in any NF instance returned in the search result

| | +| noProfileMatchInfo | NoProfileMatchInfo | O | 0..1 |

This IE may be present if an empty array of nfinstances is conveyed and the nfinstancesList IE is absent; otherwise it shall be absent. If present, it shall indicate the specific reason for not finding any NF instance that can match the search criteria.

| | +| ignoredQueryParams | array(string) | O | 1..N |

This IE may be present when the NRF has ignored unsupported query parameters when processing the discovery request.

When present, this IE shall list the ignored unsupported query parameters for this discovery. Each array item shall uniquely indicate one ignored query parameter, with the query parameter name as specified in Table 6.2.3.2.3.1-1.

| | +| NOTE 1: | If NRF altered priority values are returned in the search result, when the NF consumer receives a different priority value in a subsequent NF Profile change notification for NF instance(s) returned in the search result, the NF consumer should not overwrite the NRF altered priority in the cached search result. | | | | | +| NOTE 2: | If the alteredPriorityInd IE is present and set to true and the nrfAlteredPriorities IE is not included for a certain NF instance of the nfinstanceList, the NF consumer shall apply the priorities retrieved in the corresponding NF profile for this NF instance when selecting a NF service producer for the corresponding NF Discovery request. | | | | | +| NOTE 3: | This IE shall be set if the NRF altered the priority values of one or more NF instances returned in the search result, regardless of whether the NF instances are returned in the nfinstances IE and/or nfinstanceList IE. | | | | | + +## 6.2.6.2.3 Type: NFProfile + +**Table 6.2.6.2.3-1: Definition of type NFProfile** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nflInstanceId | NflInstanceId | M | 1 | Unique identity of the NF Instance. | +| nfType | NFType | M | 1 | Type of Network Function | +| nfStatus | NFStatus | M | 1 | Status of the NF Instance | +| collocatedNfInstances | array(CollocatedNfInstance) | O | 1..N | Information related collocated NF type(s) and corresponding NF Instance(s) when the NF is collocated with NFs supporting other NF types | +| nflInstanceName | string | O | 0..1 | Human readable name of the NF Instance | +| plmnList | array(PlmnId) | C | 1..N | PLMN(s) of the Network Function (NOTE 5). This IE shall be present if this information is available for the NF. If neither the plmnList IE nor the snpnList IE were provided by the NF during registration, the NRF should return the list of PLMN ID(s) of the PLMN of the NRF. If both the plmnList IE and the snpnList IE are absent in the response, PLMN ID(s) of the PLMN of the NRF are assumed for the NF. | +| sNssais | array(ExtSnssai) | O | 1..N | S-NSSAIs of the Network Function.
If not provided, and if the perPlmnSnssaiList attribute is not present, the NF can serve any S-NSSAI.
If the sNssais attribute is provided in at least one NF Service, the sNssais attribute in the NF Profile shall be present and be the set or a superset of the sNssais of the NFService(s). | +| perPlmnSnssaiList | array(PlmnSnssai) | O | 1..N | The per-PLMN list of S-NSSAI(s) supported by the Network Function.
If the perPlmnSnssaiList attribute is provided in at least one NF Service, the perPlmnSnssaiList attribute in the NF Profile shall be present and be the set or a superset of the perPlmnSnssaiList of the NFService(s). | +| nsiList | array(string) | O | 1..N | List of NSIs of the Network Function.
If not provided, the NF can serve any NSI. | +| fqdn | Fqdn | C | 0..1 | FQDN of the Network Function (NOTE 1, NOTE 3, NOTE 11) | +| interPlmnFqdn | Fqdn | C | 0..1 | If the requester-plmn-list query parameter is absent in the NF Discovery request, or if is present and the requester's PLMN is the same as the PLMN of the discovered NF, then this attribute shall be included by the NRF and it shall contain the interPlmnFqdn value registered by the NF during NF registration (see clause 6.1.6.2.2), if the interPlmnFqdn attribute was registered in the NF profile.
This attribute shall be absent if the requester-plmn in the query parameter is different from the PLMN of the discovered NF.
(NOTE 3, NOTE 14) | +| ipv4Addresses | array(Ipv4Addr) | C | 1..N | IPv4 address(es) of the Network Function (NOTE 1, NOTE 11) | +| ipv6Addresses | array(Ipv6Addr) | C | 1..N | IPv6 address(es) of the Network Function (NOTE 1, NOTE 11) | +| allowedPlmns | array(PlmnId) | C | 1..N | PLMNs allowed to access the NF instance.

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

If not provided, any PLMN is allowed to access the NF. | +| allowedSnpns | array(PlmnIdNid) | C | 1..N | SNPNs allowed to access the NF instance.

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall | + +| | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

prevail.

The absence of this attribute in both the NFService and in the NF profile indicates that no SNPN, other than the SNPN(s) registered in the snpnList attribute of the NF Profile (if the NF pertains to an SNPN), is allowed to access the service instance.

| +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|------------------|------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedNfTypes | array(NFType) | C | 1..N |

Type of the NFs allowed to access the NF instance.

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

If not provided, any NF type is allowed to access the NF.

| +| allowedNfDomains | array(string) | C | 1..N |

Pattern (regular expression according to the ECMA-262 dialect [8]) representing the NF domain names within the PLMN of the NRF allowed to access the NF instance.

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

If not provided, any NF domain is allowed to access the NF.

| +| allowedNssais | array(ExtSnssai) | C | 1..N |

S-NSSAI of the allowed slices to access the NF instance.

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

If not provided, any slice is allowed to access the NF.

| +| allowedRuleSet | map(RuleSet) | O | 1..N |

Map of rules specifying NF-Consumers allowed or denied to access NF-Producer. 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.

This IE may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types) if the NF-Consumer supports Allowed-ruleset feature as specified in Clause 6.2.9. It shall not be present otherwise.

| +| capacity | integer | O | 0..1 |

Static capacity information within the range 0 to 65535, expressed as a weight relative to other NF instances of the same type; if capacity is also present in the nfServiceList parameters, those will have precedence over this value. (See NOTE 2)

| +| load | integer | O | 0..1 |

Latest known load information of the NF within the range 0 to 100 in percentage (See NOTE 4)

| +| loadTimeStamp | DateTime | O | 0..1 |

It indicates the point in time in which the latest load information of the NF Instance was sent from the NF to the NRF.

| +| locality | string | O | 0..1 |

Operator defined information about the location of the NF instance (e.g. geographic location, data center)

| +| extLocality | map(string) | O | 1..N |

Operator defined information about the location of the NF instance. (NOTE 3)

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, representing a type of locality as defined in clause 6.1.6.3.18.

Example:
{
  "DATA_CENTER": "dc-123",
  "CITY": "Los Angeles",
  "STATE": "California"
}

| + +| | | | | | +|--|--|--|--|--| +| | | | | | +|--|--|--|--|--| + +| | | | | | +|--------------|---------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| priority | integer | O | 0..1 |

Priority (relative to other NFs of the same type) within the range 0 to 65535, to be used for NF selection; lower values indicate a higher priority. Priority may or may not be present in the nfServiceList parameters, xxxInfo parameters and in this attribute. Priority in the nfServiceList has precedence over the priority in this attribute. (NOTE 2)

Priority in xxxInfo parameter shall only be used to determine the relative priority among NF instances with the same priority at NFPProfile/NFService.

| +| udrInfo | UdrInfo | O | 0..1 | Specific data for the UDR (ranges of SUPI, ...) | +| udrInfoList | map(UdrInfo) | O | 1..N |

Multiple entries of UdrInfo. This attribute provides additional information to the udrInfo. udrInfoList may be present even if the udrInfo is absent. 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.

| +| udmInfo | UdmInfo | O | 0..1 | Specific data for the UDM | +| udmInfoList | map(UdmInfo) | O | 1..N |

Multiple entries of UdmInfo. This attribute provides additional information to the udmInfo. udmInfoList may be present even if the udmInfo is absent. 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.

| +| ausfInfo | AusfInfo | O | 0..1 | Specific data for the AUSF | +| ausfInfoList | map(AusfInfo) | O | 1..N |

Multiple entries of AusfInfo. This attribute provides additional information to the ausfInfo. ausfInfoList may be present even if the ausfInfo is absent. 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.

| +| amfInfo | AmfInfo | O | 0..1 | Specific data for the AMF (AMF Set ID, ...) | +| amfInfoList | map(AmfInfo) | O | 1..N |

Multiple entries of AmfInfo. This attribute provides additional information to the amfInfo. amfInfoList may be present even if the amfInfo is absent. 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.

| +| smfInfo | SmfInfo | O | 0..1 | Specific data for the SMF (DNN's, ...). (NOTE 8) | +| smfInfoList | map(SmfInfo) | O | 1..N |

Multiple entries of SmfInfo. This attribute provides additional information to the smfInfo. smfInfoList may be present even if the smfInfo is absent. 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. (NOTE 8)

| +| upfInfo | UpfInfo | O | 0..1 | Specific data for the UPF (S-NSSAI, DNN, SMF serving area, ...) | +| upfInfoList | map(UpfInfo) | O | 1..N |

Multiple entries of UpfInfo. This attribute provides additional information to the upfInfo. upfInfoList may be present even if the upfInfo is absent. 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.

| +| pcfInfo | PcfInfo | O | 0..1 | Specific data for the PCF | +| pcfInfoList | map(PcfInfo) | O | 1..N |

Multiple entries of PcfInfo. This attribute provides additional information to the pcfInfo. pcfInfoList may be present even if the pcfInfo is absent. 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.

| +| bsfInfo | BsfInfo | O | 0..1 | Specific data for the BSF | +| bsfInfoList | map(BsfInfo) | O | 1..N |

Multiple entries of BsfInfo. This attribute provides additional information to the bsfInfo. bsfInfoList may be present even if the bsfInfo is absent.

| + +| | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------| +| | | | | 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. | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|----------------------------------|----------------------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| chfInfo | ChfInfo | O | 0..1 | Specific data for the CHF | +| chfInfoList | map(ChfInfo) | O | 1..N | Multiple entries of ChfInfo. This attribute provides additional information to the chfInfo. chfInfoList may be present even if the chfInfo is absent.
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. | +| udsInfo | UdsInfo | O | 0..1 | Specific data for the UDSF | +| udsInfoList | map(UdsInfo) | O | 1..N | Multiple entries of udsInfo. This attribute provides additional information to the udsInfo. udsInfoList may be present even if the udsInfo is absent.
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. | +| nefInfo | NefInfo | O | 0..1 | Specific data for the NEF | +| nwdaInfo | NwdaInfo | O | 0..1 | Specific data for the NWDAF | +| nwdaInfoList | map(NwdaInfo) | O | 1..N | Multiple entries of nwdaInfo. This attribute provides additional information to the nwdaInfo. nwdaInfoList may be present even if the nwdaInfo is absent.
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. | +| pcscfInfoList | map(PcscfInfo) | O | 1..N | Specific data for the P-CSCF.
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.
(NOTE 7) | +| hssInfoList | map(HssInfo) | O | 1..N | Specific data for the HSS.
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. | +| customInfo | object | O | 0..1 | Specific data for custom Network Functions | +| recoveryTime | DateTime | O | 0..1 | Timestamp when the NF was (re)started | +| nfServicePersistence | boolean | O | 0..1 | - true: If present, and set to true, it indicates that the different service instances of a same NF Service in the NF instance, supporting a same API version, are capable to persist their resource state in shared storage and therefore these resources are available after a new NF service instance supporting the same API version is selected by a NF Service Consumer (see 3GPP TS 23.527 [27]).

- false (default): Otherwise, it indicates that the NF Service Instances of a same NF Service are not capable to share resource state inside the NF Instance. | +| nfServices | array(NFService) | O | 1..N | List of NF Service Instances.
(NOTE 10)

This attribute is deprecated; the attribute "nfServiceList" should be used instead. | +| nfServiceList | map(NFService) | O | 1..N | Map of NF Service Instances, where the "serviceInstanceId" attribute of the NFService object shall be used as the key of the map.
(NOTE 10) | +| defaultNotificationSubscriptions | array(DefaultNotificationSubscription) | O | 1..N | Notification endpoints for different notification types.
(NOTE 6)
(See also NOTE 10 in clause 6.1.6.2.2) | +| lmfInfo | LmfInfo | O | 0..1 | Specific data for the LMF | +| gmlcInfo | GmlcInfo | O | 0..1 | Specific data for the GMLC | +| snpnList | array(PlmnIdNid) | C | 1..N | SNPN(s) of the Network Function.
This IE shall be present if the NF pertains to one or more SNPNs. | +| nfSetIdList | array(NfSetId) | C | 1..N | NF Set ID defined in clause 28.12 of 3GPP TS 23.003 [12].
At most one NF Set ID shall be indicated per PLMN-ID or SNPN of the NF. At most one combination of an AMF region and an AMF Set ID shall be indicated | + +| | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------| +| | | | | per PLMN-ID or SNPN in an AMF profile.
This information shall be present if available. | +|--|--|--|--|-------------------------------------------------------------------------------------------| + +| | | | | | +|---------------------------------|-----------------------------------|---|------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| servingScope | array(string) | O | 1..N | The served area(s) of the NF instance.
The absence of this attribute does not imply the NF instance can serve every area. | +| lchSupportInd | boolean | O | 0..1 | This IE indicates whether the NF supports Load Control based on LCI Header (see clause 6.3 of 3GPP TS 29.500 [4]).
- true: the NF supports the feature.
- false (default): the NF does not support the feature. | +| olchSupportInd | boolean | O | 0..1 | This IE indicates whether the NF supports Overload Control based on OCI Header (see clause 6.4 of 3GPP TS 29.500 [4]).
- true: the NF supports the feature.
- false (default): the NF does not support the feature. | +| nfSetRecoveryTimeList | map(DateTime) | O | 1..N | Map of recovery time, where the key of the map is the NfSetId of NF Set(s) that the NF instance belongs to.

When present, the value of each entry of the map shall be the recovery time of the NF Set indicated by the key. | +| serviceSetRecoveryTimeList | map(DateTime) | O | 1..N | Map of recovery time, where the key of the map is the NfServiceSetId of the NF Service Set(s) configured in the NF instance.

When present, the value of each entry of the map shall be the recovery time of the NF Service Set indicated by the key. | +| scpDomains | array(string) | O | 1..N | When present, this IE shall carry the list of SCP domains the SCP belongs to, or the SCP domain the NF (other than SCP) or the SEPP belongs to. (NOTE 9) | +| scpInfo | ScpInfo | O | 0..1 | Specific data for the SCP. | +| seppInfo | SeppInfo | O | 0..1 | Specific data for the SEPP. | +| vendorId | VendorId | O | 0..1 | Vendor ID of the NF instance, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. | +| supportedVendorSpecificFeatures | map(array(VendorSpecificFeature)) | O | 1..N(1..M) | Map of Vendor-Specific features, where the key of the map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The string used as key of the map shall contain 6 decimal digits; if the SMI code has less than 6 digits, it shall be padded with leading digits "0" to complete a 6-digit string value.
The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects. (NOTE 12) | +| aanfInfoList | map(AanfInfo) | O | 1..N | Specific data for the AAnF.
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. | +| mfaInfo | MfaInfo | O | 0..1 | Specific data for the MFAF. | +| eadfInfoList | map(EadfInfo) | O | 1..N | Specific data for the EASDF.
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. (NOTE 13) | +| dcnfInfo | DcnfInfo | O | 0..1 | Specific data for the DCCF. | +| nsacfInfoList | map(NsacfInfo) | O | 1..N | Specific data for the NSACF.
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. | +| mbSmfInfoList | map(MbSmfInfo) | O | 1..N | MB-SMF specific data.
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. | +| tsctsInfoList | map(TsctsInfo) | O | 1..N | Specific data for the TSCTSF. | + +| | | | | | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------| +| | | | | 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. | +|--|--|--|--|-------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbUpfInfoList | map(MbUpfInfo) | O | 1..N | MB-UPF specific data.

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. | +| trustAflnfo | TrustAflnfo | O | 0..1 | Specific data for the trusted AF. | +| nssaaflnfo | Nssaaflnfo | O | 0..1 | Specific data for the NSSAAF. | +| hniList | array(Fqdn) | C | 1..N | Identifications of Credentials Holder or Default Credentials Server.
This IE shall be present if the NFs are available for the case of access to an SNPN using credentials owned by a Credentials Holder or for the case of SNPN Onboarding using a DCS. | +| iwmscInfo | IwmscInfo | O | 0..1 | Specific data for the SMS-IWMSC. | +| mnpfInfo | MnpfInfo | O | 0..1 | Specific data for the MNPF. | +| smsfInfo | SmsfInfo | O | 0..1 | Specific data for the SMSF. | +| dcspfInfoList | map(DcsfInfo) | O | 1..N | DCSF specific data.
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. | +| mrfInfoList | map(MrfInfo) | O | 1..N | MRF specific data.
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. | +| mrfpInfoList | map(MrfpInfo) | O | 1..N | MRFP specific data.
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. | +| mflnfoList | map(MfInfo) | O | 1..N | MF specific data.
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. | +| adrfInfoList | map(AdrfInfo) | O | 1..N | ADRF specific data.
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. | +| selectionConditions | SelectionConditions | O | 0..1 | This IE is only applicable if the NFStatus is set to "CANARY_RELEASE".

If present, it includes the conditions under which an NF Instance with an NFStatus value set to "CANARY_RELEASE" shall be selected by an NF Service Consumer (e.g. if the UE belongs to a range of SUPIs) | +| NOTE 1: At least one of the addressing parameters (fqdn, ipv4address or ipv6address) shall be included in the NF Profile. See NOTE 1 of Table 6.2.6.2.4-1 for the use of these parameters. If multiple ipv4 addresses and/or ipv6 addresses are included in the NF Profile, the NF Service Consumer shall select one of these addresses randomly, unless operator defined local policy of IP address selection, in order to avoid overload for a specific ipv4 address and/or ipv6 address. | | | | | +| NOTE 2: The capacity and priority parameters, if present, are used for NF selection and load balancing. The priority and capacity attributes shall be used for NF selection in the same way that priority and weight are used for server selection as defined in IETF RFC 2782 [23]. | | | | | +| NOTE 3: If the requester-plmn in the query parameter is different from the PLMN of the discovered NF, then the fqdn attribute value shall contain the interPlmnFqdn value registered by the NF during NF registration (see clause 6.1.6.2.2). The requester-plmn is different from the PLMN of the discovered NF if it belongs to none of the PLMN ID(s) configured for the PLMN of the NRF. | | | | | +| NOTE 4: The usage of the load parameter by the NF service consumer is implementation specific, e.g. be used for NF selection and load balancing, together with other parameters. | | | | | +| NOTE 5: An NF may register multiple PLMN IDs in its profile within a PLMN comprising multiple PLMN IDs. If so, all the attributes of the NF Profile shall apply to each PLMN ID registered in the plmnList. As an exception, attributes including a PLMN ID, e.g. IMSI-based SUPI ranges, TAls and GUAMIs, are specific to one PLMN ID and the NF may register in its profile multiple occurrences of such attributes for different PLMN IDs (e.g. the UDM may register in its profile SUPI ranges for different PLMN IDs). | | | | | +| NOTE 6: For notification types that may be associated with a specific service of the NF Instance receiving the notification (see clause 6.1.6.3.4), if notification endpoints are present both in the profile of the NF instance (NFProfile) and in some of its NF Services (NFService) for a same notification type, the notification endpoint(s) of the NF Services shall be used for this notification type. | | | | | +| NOTE 7: The absence of the pcsfInfoList attribute in a P-CSCF profile indicates that the P-CSCF can be selected | | | | | + +for any DNN and Access Type, and that the P-CSCF Gm addressing information is the same as the addressing information registered in the fqdn, ipv4Addresses and ipv4Addresses attributes of the NF profile. + +- NOTE 8: The absence of both the smfInfo and smfInfoList attributes in an SMF profile indicates that the SMF can be selected for any S-NSSAI listed in the sNSSais and perPlmnSnssaiList IEs, or for any S-NSSAI if neither the sNSSais IE nor the perPlmnSnssaiList IE are present, and for any DNN, TAI and access type. +- NOTE 9: If an NF (other than a SCP or SEPP) includes this information in its profile, this indicates that the services produced by this NF should be accessed preferably via an SCP from the SCP domain the NF belongs to. +- NOTE 10: If the NF Service Consumer that issued the discovery request indicated support for the "Service-Map" feature, the NRF shall return in the discovery response the list of NF Service Instances in the "nfServiceList" map attribute. Otherwise, the NRF shall return the list of NF Service Instances in the "nfServices" array attribute. +- NOTE 11: For API URIs constructed with an FQDN, the NF Service Consumer may use the FQDN of the target URI to do a DNS query and obtain the IP address(es) to setup the TCP connection, and ignore the IP addresses that may be present in the NFProfile; alternatively, the NF Service Consumer may use those IP addresses to setup the TCP connection, if no service-specific FQDN or IP address is provided in the NFService data and if the NF Service Consumer supports to indicate specific IP address(es) to establish an HTTP/2 connection with an FQDN in the target URI. +- NOTE 12: When present, this attribute allows an NF requesting NF Discovery (e.g. an NF Service Consumer) to determine which vendor-specific extensions are supported in a given NF (e.g. an NF Service Producer), so as to select an appropriate NF with specific capability, or to include or not the vendor-specific attributes (see 3GPP TS 29.500 [4] clause 6.6.3) required for a given feature in subsequent messages towards a certain NF. One given vendor-specific feature shall not appear in both NF Profile and NF Service Profile. If one vendor-specific feature is service related, it shall only be included in the NF Service Profile. +- NOTE 13: The absence of the easdfnfoList attributes in an EASDF profile indicates that the EASDF can be selected for any S-NSSAI, DNN, DNAI or PSA UPF N6 IP address. +- NOTE 14: This attribute may be used by the requester NF or SCP e.g. to build the authority of the Location header in 3xx response or to set the 3gpp-Sbi-apiRoot header in a response message (see clause 6.10.4 of 3GPP TS 29.500 [4]), when the NF redirects a request issued by a consumer from a different PLMN towards the discovered NF, or when the SCP has reselected the discovered NF for such a request. + +#### 6.2.6.2.4 Type: NFService + +**Table 6.2.6.2.4-1: Definition of type NFService** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------|----------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| serviceInstanceId | string | M | 1 | Unique ID of the service instance within a given NF Instance | +| serviceName | ServiceName | M | 1 | Name of the service instance (e.g. "udm-sdm") | +| versions | array(NFServiceVersion) | M | 1..N | The API versions supported by the NF Service and if available, the corresponding retirement date of the NF Service.
The different array elements shall have distinct unique values for "apiVersionInUri", and consequently, the values of "apiFullVersion" shall have a unique first digit version number. | +| scheme | UriScheme | M | 1 | URI scheme (e.g. "http", "https") | +| nfServiceStatus | NFServiceStatus | M | 1 | Status of the NF Service Instance | +| fqdn | Fqdn | O | 0..1 | FQDN of the NF Service Instance (see NOTE 1, NOTE 3, NOTE 9).
The FQDN provided as part of the NFService information has precedence over the FQDN and IP addresses provided as part of the NFProfile information (see clause 6.1.6.2.2). | +| interPlmnFqdn | Fqdn | C | 0..1 | If the requester-plmn-list query parameter is absent in the NF Discovery request, or if is present and the requester's PLMN is the same as the PLMN of the discovered NF Service, then this attribute shall be included by the NRF and it shall contain the interPlmnFqdn value registered for the NF Service during NF registration (see clause 6.1.6.2.3), if the interPlmnFqdn attribute was registered for the NF Service in the NF profile.
This attribute shall be absent if the requester-plmn in the query parameter is different from the PLMN of the discovered NF Service.
(NOTE 3, NOTE 10) | +| ipEndPoints | array(IpEndPoint) | O | 1..N | IP address(es) and port information of the Network Function (including IPv4 and/or IPv6 address) where the service is listening for incoming service requests (see NOTE 1, NOTE 5, NOTE 6, NOTE 9).
IP addresses provided in ipEndPoints have precedence over IP addresses provided as part of the NFProfile information and, when using the HTTP scheme, over FQDN provided as part of the NFProfile information (see clause 6.2.6.2.3). | +| apiPrefix | string | O | 0..1 | Optional path segment(s) used to construct the {apiRoot} variable of the different API URIs, as described in 3GPP TS 29.501 [5], clause 4.4.1 (optional deployment-specific string that starts with a "/" character) | +| callbackUriPrefixList | array(CallbackUriPrefixItem) | O | 1..N | Optional path segment(s) used to construct the prefix of the Callback URIs during the reselection of an NF service consumer, as described in 3GPP TS 29.501 [5], clause 4.4.3.
When present, this IE shall contain callback URI prefix values to be used for specific notification types. | +| defaultNotificationSubscriptions | array(DefaultNotificationSubscription) | O | 1..N | Notification endpoints for different notification types. (See also NOTE 10 in clause 6.1.6.2.2) | +| allowedPlmns | array(PlmnId) | C | 1..N | PLMNs allowed to access the service instance (NOTE 12).

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

The absence of this attribute indicates that any PLMN is allowed to access the service instance.

When included, the allowedPlmns attribute needs not include the PLMN ID(s) registered in the | + +| | | | | | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | plmnList attribute of the NF Profile, i.e. the PLMN ID(s) registered in the NF Profile shall be considered to be allowed to access the service instance. | +|--|--|--|--|----------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|--------------------|-----------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedSnpons | array(PlmnIdNid) | C | 1..N |

SNPNs allowed to access the service instance.

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall prevail.

The absence of this attribute in both the NFService and in the NF profile indicates that no SNPN, other than the SNPN(s) registered in the snpnList attribute of the NF Profile (if the NF pertains to an SNPN), is allowed to access the service instance.

When included, the allowedSnpons attribute needs not include the PLMN ID/NID(s) registered in the snpnList attribute of the NF Profile (if the NF pertains to an SNPN), i.e. the SNPNs registered in the NF Profile (if any) shall be considered to be allowed to access the service instance.

| +| allowedNfTypes | array(NFType) | C | 1..N |

Type of the NFs allowed to access the service instance (NOTE 12).

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

| +| allowedNfDomains | array(string) | C | 1..N |

Pattern (regular expression according to the ECMA-262 dialect [8]) representing the NF domain names within the PLMN of the NRF allowed to access the service instance (NOTE 12).

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

The absence of this attribute indicates that any NF domain is allowed to access the service instance.

| +| allowedNssais | array(ExtSnssai) | C | 1..N |

S-NSSAI of the allowed slices to access the service instance (NOTE 12).

This attribute may be present in a complete NF profile (i.e. in the completeNfInstances IE in the SearchResult or StoredSearchResult data types). It shall not be present otherwise.

The absence of this attribute indicates that any slice is allowed to access the service instance.

| +| capacity | integer | O | 0..1 | Static capacity information within the range 0 to 65535, expressed as a weight relative to other services of the same type. (See NOTE 2) | +| load | integer | O | 0..1 | Latest known load information of the NF Service, within the range 0 to 100 in percentage. (See NOTE 4) | +| loadTimeStamp | DateTime | O | 0..1 | It indicates the point in time in which the latest load information of the NF Service Instance was sent from the NF to the NRF. | +| priority | integer | O | 0..1 | Priority (relative to other services of the same type) within the range 0 to 65535, to be used for NF Service selection; lower values indicate a higher priority. (See NOTE 2) | +| recoveryTime | DateTime | O | 0..1 | Timestamp when the NF service was (re)started | +| supportedFeatures | SupportedFeatures | O | 0..1 | Supported Features of the NF Service instance | +| nfServiceSetIdList | array(NfServiceSetId) | C | 1..N | NF Service Set ID (see clause 28.13 of | + +| | | | | | +|--|----|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | d) | | | 3GPP TS 23.003 [12])
At most one NF Service Set ID shall be indicated per
PLMN-ID or SNPN of the NF.
This information shall be present if available. | +|--|----|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|---------------------------------|-----------------------------------|---|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| sNssais | array(ExtSnssai) | O | 1..N | S-NSSAIs of the NF Service. This may be a subset of the S-NSSAIs supported by the NF (see sNssais attribute in NFProfile).
When present, this IE represents the list of S-NSSAIs supported by the NF Service in all the PLMNs listed in the plmnList IE and all the SNPNs listed in the snpnList. | +| perPlmnSnssaiList | array(PlmnSnssai) | O | 1..N | S-NSSAIs of the NF Service per PLMN. This may be a subset of the S-NSSAIs supported per PLMN by the NF (see perPlmnSnssaiList attribute in NFProfile).

This IE may be included when the list of S-NSSAIs supported by the NF Service for each PLMN it is supporting is different. When present, this IE shall include the S-NSSAIs supported by the NF Service for each PLMN. When present, this IE shall override the sNssais IE. | +| vendorId | VendorId | O | 0..1 | Vendor ID of the NF Service instance, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. | +| supportedVendorSpecificFeatures | map(array(VendorSpecificFeature)) | O | 1..N(1..M) | Map of Vendor-Specific features, where the key of the map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The string used as key of the map shall contain 6 decimal digits; if the SMI code has less than 6 digits, it shall be padded with leading digits "0" to complete a 6-digit string value.
The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects.
(NOTE 7) | +| oauth2Required | boolean | O | 0..1 | It indicates whether the NF Instance requires Oauth2-based authorization.
Absence of this IE means that the NF Service Producer has not provided any indication about its usage of Oauth2 for authorization.
(See NOTE 11) | +| allowedOperationsPerNfType | map(array(string)) | C | 1..N(1..M) | Map of allowed operations on resources for each type of NF; the key of the map is the NF Type, and the value is an array of scopes.

The scopes shall be any of those defined in the API that defines the current service (identified by the "serviceName" attribute).

This IE should be present, if it is present in the registered NF service instance and if the map contains a key matching the requester's NF type. When present, this IE should only contain the key-value pair of the map matching the requester's NF type.

(NOTE 8) | +| allowedOperationsPerNfInstance | map(array(string)) | C | 1..N(1..M) | Map of allowed operations on resources for a given NF Instance; the key of the map is the NF Instance Id, and the value is an array of scopes.

The scopes shall be any of those defined in the API that defines the current service (identified by the "serviceName" attribute).

This IE should be present, if it is present in the registered NF service instance and if the map contains a key matching the requester's NF instance ID. When present, this IE should only contain the key-value pair of the map matching the requester's NF Instance ID. | + +| | | | | | +|--|--|--|--|----------| +| | | | | (NOTE 8) | +|--|--|--|--|----------| + +| | | | | | +|-----------------------------------------|---------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| allowedOperationsPerNfInstanceOverrides | boolean | O | 0..1 |

This IE, when present and set to true, indicates that the scopes defined in attribute "allowedOperationsPerNfInstance" for a given NF Instance ID take precedence over the scopes defined in attribute "allowedOperationsPerNfType" for the corresponding NF type of the NF Instance associated to such NF Instance ID.

If the IE is not present, or set to false (default), it indicates that the allowed scopes are any of the scopes present either in "allowedOperationsPerNfType" or in "allowedOperationsPerNfInstance".

| +| allowedScopesRuleSet | map(RuleSet) | O | 1..N |

Map of rules specifying scopes allowed or denied for NF-Consumers. 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.

This IE may be present when the NF-Consumer supports Allowed-ruleset feature as specified in clause 6.2.9.

When present, the IE should only contain the highest priority RuleSet matching the requester's NF Instance ID, nfType, PLMN-ID, SNPn-ID, NfDomain and S-NSSAI if any (see Annex C).

If the requesting entity included "complete-profile" query parameter in the request message, and the NRF authorized such a request (see clause 5.3.2.2.2), the complete IE shall be present in the discovery response.

| +| selectionConditions | SelectionConditions | O | 0..1 |

This IE is only applicable if the NFServiceStatus is set to "CANARY_RELEASE".

If present, it includes the conditions under which an NF Service Instance with an NFServiceStatus value set to "CANARY_RELEASE" shall be selected by an NF Service Consumer (e.g. if the UE belongs to a range of SUPIs)

| + +NOTE 1: The NF Service Consumer shall construct the API URLs of the service using: +- For intra-PLMN signalling: If TLS is used, the FQDN present in the NF Service Profile, if any; otherwise, the FQDN present in the NF Profile. If TLS is not used, the FQDN should be used if the NF Service Consumer uses Indirect Communication via an SCP; the FQDN or the IP address in the ipEndPoints attribute may be used if the NF Service Consumer uses Direct Communication. +- For inter-PLMN signalling: the FQDN present in the NF Service Profile, if any; otherwise, the FQDN present in the NF Profile (see NOTE 3). + +NOTE 2: The capacity and priority parameters, if present, are used for service selection and load balancing. The priority and capacity attributes shall be used for NF selection in the same way that priority and weight are used for server selection as defined in IETF RFC 2782 [23]. + +NOTE 3: If the requester-plmn in the query parameter is different from the PLMN of the discovered NF Service, then the fqdn attribute value, if included shall contain the interPlmnFqdn value registered by the NF Service during NF registration (see clause 6.1.6.2.3). The requester-plmn is different from the PLMN of the discovered NF Service if it belongs to none of the PLMN ID(s) configured for the PLMN of the NRF. + +NOTE 4: The usage of the load parameter by the NF service consumer is implementation specific, e.g. be used for NF service selection and load balancing, together with other parameters. + +NOTE 5: If the NF Service Consumer, based on the FQDN and IP address related attributes of the NFProfile and NFService, determines that it needs to use an FQDN to establish the HTTP connection with the NF Service Producer, it shall use such FQDN for DNS query and, in absence of any port information in the ipEndPoints attribute of the NF Service, it shall use the default HTTP port number, i.e. TCP port 80 for "http" URIs or TCP port 443 for "https" URIs as specified in IETF RFC 9113 [9] when invoking the service. + +NOTE 6: If multiple ipv4 addresses and/or ipv6 addresses are included in the NF Service, the NF Service Consumer shall select one of these addresses randomly, unless operator defined local policy of IP address selection, in order to avoid overload for a specific ipv4 address and/or ipv6 address. + +NOTE 7: When present, this attribute allows the NF requesting NF discovery (e.g. an NF Service Consumer) to determine which vendor-specific extensions are supported in a given NF (e.g. an Service Producer) in order to select an appropriate NF, or to include or not include the vendor-specific attributes (see + +3GPP TS 29.500 [4] clause 6.6.3) required for a given feature in subsequent service requests towards a certain service instance of the NF Service Producer. One given vendor-specific feature shall not appear in both NF Profile and NF Service Profile. If one vendor-specific feature is service related, it shall only be included in the NF Service Profile. + +- NOTE 8: These attributes are used by the NF Service Consumer in order to discover the additional scopes (resource/operation-level scopes) that might be required to invoke a certain service operation, based on the authorization information registered in NRF by the NF Service Producer in its NF profile. See also NOTE 11 of Table 6.1.6.2.3-1. +- NOTE 9: For API URIs constructed with an FQDN, the NF Service Consumer may use the FQDN in the target URI to do a DNS query and obtain the IP address(es) to setup the TCP connection, and ignore the IP addresses that may be present in the ipEndPoints attribute; alternatively, the NF Service Consumer may use those IP addresses to setup the TCP connection, if the NF Service Consumer supports to indicate specific IP address(es) to establish an HTTP/2 connection with an FQDN in the target URI. +- NOTE 10: This attribute may be used by the requester NF or SCP e.g. to build the authority of the Location header in 3xx response or to set the 3gpp-Sbi-apiRoot header in a response message (see clause 6.10.4 of 3GPP TS 29.500 [4]), when the NF redirects a request issued by a consumer from a different PLMN towards the discovered NF service, or when the SCP has reselected the discovered NF service for such a request. +- NOTE 11: If PLMN specific value is registered for the PLMN ID of the requester NF, the NRF shall set the oauth2Required attribute with the PLMN specific values (see description of perPlmnOauth2ReqList in clause 6.1.6.2.3). +- NOTE 12: If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall prevail. The absence of this attribute in the NFService and in the NFProfile indicates that there is no corresponding restriction to access the service instance. If this attribute is absent in the NF Service, but it is present in the NF Profile, the attribute from the NF Profile shall be applied. + +#### 6.2.6.2.5 Type: StoredSearchResult + +**Table 6.2.6.2.5-1: Definition of type StoredSearchResult** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nflInstances | array(NFProfile) | M | 0..N | An array of NF Instances corresponding to a given stored search result.
NF instance profiles included in this IE shall not contain authorization attributes (such as the "allowedXXX" attributes of the NFProfile or NFService data types). | +| completeNflInstances | array(NFProfile) | C | 1..N | When present, it shall contain an array of complete NF Instance profiles (including authorization attributes such as the "allowedXXX" attributes of the NFProfile or NFService data types), matching the search criteria indicated by the query parameters of the discovery request.
.
This IE shall only be present if the NRF supports the "Complete-Profile-Discovery" feature, the "complete-profile" query parameter is present and set to true in the request (see clause 6.2.3.2.3.1), and if the requesting entity is authorized to discover the complete profile of NF instances. | + +6.2.6.2.6 Type: PreferredSearch + +**Table 6.2.6.2.6-1: Definition of type PreferredSearch** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| preferredTaiMatchInd | boolean | C | 0..1 | Indicates whether all the returned NFProfiles match or do not match the query parameter preferred-tai.
true: Match
false (default): Not Match | +| preferredFullPlmnMatchInd | boolean | O | 0..1 | Indicates whether all the returned NFProfiles match or do not match the query parameter preferred-full-plmn.
true: Match
false (default): Not Match | +| preferredApiVersionsMatchInd | boolean | O | 0..1 | Indicates whether the search result includes at least one NF Profile that matches all the preferred API versions indicated in the query parameter preferred-api-versions.

true: Match
false: Not Match | +| otherApiVersionsInd | boolean | O | 0..1 | This IE may be present if the preferred-api-versions query parameter is provided in the discovery request.

When present, this IE indicates whether there is at least one NF Profile with other API versions, i.e. that does not match all the preferred API versions indicated in the preferred-api-versions, returned in the response or not.

true: Returned
false: Not returned | +| preferredLocalityMatchInd | boolean | O | 0..1 | Indicates whether the search result includes at least one NFProfile that match the query parameter preferred-locality or ext-preferred-locality.

true: Match
false (default): Not Match | +| otherLocalityInd | boolean | O | 0..1 | This IE may be present if the preferred-locality or ext-preferred-locality query parameter is provided in the discovery request.

When present, this IE indicates whether there is at least one NFProfile with another locality, i.e. not matching the preferred-locality or ext-preferred-locality, returned in the response or not.

true: Returned
false (default): Not returned | +| preferredVendorSpecificFeaturesInd | boolean | O | 0..1 | Indicates whether all the returned NFProfiles match (or do not match) the query parameter preferred-vendor-specific-features (i.e. whether they support all the preferred vendor-specific-features).
true: Match
false (default): Not Match | +| preferredCollocatedNfTypeInd | boolean | O | 0..1 | Indicates whether all the returned NFProfiles match (or do not match) the query parameter preferred-collocated-nf-types.
true: Match
false (default): Not Match | +| preferredPgwMatchInd | boolean | O | 0..1 | This IE may be present if preferred-pgw-ind query parameter is provided in the discovery request.

When present, this IE shall indicate whether all the returned NFProfiles match or do not match the query parameter preferred-pgw-ind.
true: Match
false: Not Match | +| preferredAnalyticsDelaysInd | boolean | C | 0..1 | This IE shall be present if preferred-analytics-delays query parameter is provided in the discovery request. | + +| | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | When present, this IE shall indicate whether all the returned NFProfiles match or do not match the query parameter preferred-analytics-delays.
true: Match
false: Not Match | +| preferredFeaturesMatchInd | boolean | O | 0..1 | Indicates whether the search result includes at least one NFProfile that supports all the preferred feature(s) indicated by the query parameter preferred-features.

true: Supported
false: Not supported | +| noPreferredFeaturesInd | boolean | O | 0..1 | Indicates whether the search result includes at least one NFProfile not supporting all the preferred feature(s) indicated by the query parameter preferred-features.

true: Returned
false: Not returned | +| NOTE: The PreferredSearch data type is used to encode the preferredSearch IE in SearchResult (see clause 6.2.6.2.2) and the preferredSearch IE in the NfInstanceInfo data type (see clause 6.2.6.2.7). The description of the IEs in the PreferredSearch data type is provided for the first case. For the latter case, these IEs shall be interpreted as indicating whether the NF profile of the NF instance ID returned in the nfInstanceList IE of SearchResult matches the preference parameters, and the otherApiVersionsInd IE and the otherLocalityInd IE shall be absent. | | | | | + +#### 6.2.6.2.7 Type: NfInstanceInfo + +**Table 6.2.6.2.7-1: Definition of type NfInstanceInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nrfDiscApiUri | Uri | C | 0..1 | This IE shall be present if the NRF holding the NF profile is not the NRF that received the NFDiscover request. It may be present otherwise.
When present, this IE shall contain the API URI of the Nnrf_NFDiscovery service of the NRF holding the NF profile. The API URI shall be formatted as specified in clause 6.2.1 | +| preferredSearch | PreferredSearch | O | 0..1 | This IE may be present to indicate whether the NF Profile matches the preferred query parameters, if the discovery request contains any of the query parameter defined in the PreferredSearch data type. This IE shall take precedence over the preferredSearch IE in the SearchResult, if any. | +| nrfAlteredPriorities | map(integer) | O | 1..N | This IE may be present if the NRF wishes to signal modified priorities for the NF instance.
The key of the map shall be the JSON Pointer (as specified in IETF RFC 6901 [14]) of the corresponding priority IE in the NFProfile data type defined in clause 6.2.6.2.3.
(NOTE) | +| nrfSupportedFeatures | SupportedFeatures | C | 0..1 | Features supported by the NRF for the NFDiscovery service (see clause 6.2.9).
This IE should be present if the nrfDiscApiUri IE is present and if the NRF holding the NF profile supports at least one feature.
When present, this IE shall indicate the features supported by the NRF holding the NF profile. | +| NOTE: If this IE is present, the requester NF should apply the NRF altered priorities when selecting a NF service producer for the corresponding NF Discovery request, instead of the priorities retrieved in the corresponding NF profile. | | | | | + +EXAMPLE: The following JSON object would represent an NfInstanceInfo where the NRF signals modified priorities for the NF instance, two NF service instances and two smfInfo instances. + +``` +{ + "nrfAlteredPriorities": { + "/priority": 1000, + "/nfServiceList/serviceinstance1/priority": 3000, + "/nfServiceList/serviceinstance2/priority": 5000, + "/smfInfo/priority": 20000, + "/smfInfoList/abcd/priority": 15000 + } +} +``` + +#### 6.2.6.2.8 Type: ScpDomainRoutingInformation + +**Table 6.1.6.2.8-1: Definition of type ScpDomainRoutingInformation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| scpDomainList | map(ScpDomainConnectivity) | M | 0..N | This IE shall contain map of SCP domain interconnection information, where the key of the map is a SCP domain. The value of each entry shall be the interconnectivity information of the SCP domain indicated by the key.

An empty map indicates that there is no SCP domain currently registered in the NRF. | + +EXAMPLE: The SCP Domain Routing Information is derived from the SCP domains registered by SCPs, e.g. if SCP x, SCP y and SCP z have registered in NRF with following SCP domains: + +SCP x Profile includes: { "scpDomains": [ "SCP\_Domain\_1", "SCP\_Domain\_2" ] } + +SCP y Profile includes: { "scpDomains": [ "SCP\_Domain\_2", "SCP\_Domain\_3" ] } + +SCP z Profile includes: { "scpDomains": [ "SCP\_Domain\_4" ] } + +then the SCP Domain Routing Information should be as following: + +``` +{ + "scpDomainList": { + "SCP_Domain_1": { "connectedScpDomainList": [ "SCP_Domain_2" ] }, + "SCP_Domain_2": { "connectedScpDomainList": [ "SCP_Domain_1", "SCP_Domain_3" ] }, + "SCP_Domain_3": { "connectedScpDomainList": [ "SCP_Domain_2" ] }, + "SCP_Domain_4": { "connectedScpDomainList": [ ] } + } +} +``` + +#### 6.2.6.2.9 Type: ScpDomainConnectivity + +**Table 6.2.6.2.9-1: Definition of type ScpDomainConnectivity** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| connectedScpDomainList | array(string) | M | 0..N | This IE shall contain the list of interconnected SCP domains.

An empty array indicates there is no SCP Domain currently interconnected. | + +## 6.2.6.2.10 Type: ScpDomainRoutingInfoSubscription + +Table 6.2.6.2.10-1: Definition of type ScpDomainRoutingInfoSubscription + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| callbackUri | Uri | M | 1 | Callback URI where the Service Consumer will receive the notifications from NRF. | +| validityTime | DateTime | C | 0..1 | Time instant after which the subscription becomes invalid. This parameter may be sent by the client, as a hint to the server, but it shall be always sent back by the server (regardless of the presence of the attribute in the request) in the response to the subscription creation request. | +| reqInstanceId | NfInstanceId | O | 0..1 | If present, this IE shall contain the NF instance id of the Service consumer. | +| localInd | boolean | O | 0..1 | When present, this IE shall indicate whether changes of local SCP Domain Routing Information to be notified:
- true: changes of local SCP Domain Routing Information to be notified.
- false (default): changes of SCP Domain Routing Information to be notified | + +## 6.2.6.2.11 Type: ScpDomainRoutingInfoNotification + +Table 6.2.6.2.11-1: Definition of type ScpDomainRoutingInfoNotification + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| routingInfo | ScpDomainRoutingInformation | M | 1 | This IE shall contain the SCP Domain Routing Information after the change. | +| localInd | boolean | O | 0..1 | When present, this IE shall indicate whether changes of local SCP Domain Routing Information is carried in the notification:
- true: changes of local SCP Domain Routing Information in the notification.
- false (default): changes of SCP Domain Routing Information in the notification. | + +## 6.2.6.2.12 Type: NfServiceInstance + +Table 6.2.6.2.12-1: Definition of type NfServiceInstance + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------|----------------|---|-------------|--------------------------------------------------------------| +| serviceInstanceId | string | M | 1 | Unique ID of the service instance within a given NF Instance | +| nflInstanceId | NfInstanceId | C | 0..1 | NF Instance ID of the NF service instance (NOTE) | +| nfServiceSetId | NfServiceSetId | C | 0..1 | NF Service Set ID of the NF Service instance (NOTE) | +| NOTE: Either the nflInstanceId IE or the nfServiceSetId IE shall be present. | | | | | + +## 6.2.6.2.13 Type: NoProfileMatchInfo + +**Table 6.2.6.2.13-1: Definition of type NoProfileMatchInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------|------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reason | NoProfileMatchReason | M | 1 | This IE shall indicate the specific reason for not finding any NF instance that can match the search criteria. | +| queryParamCombinationList | array(QueryParamCombination) | O | 1..N | This IE may be present if the reason IE is set to "QUERY_PARAMS_COMBINATION_NO_MATCH". If present each QueryParamCombination indicates that no NF Instance matching the QueryParamCombination has registered. | + +## 6.2.6.2.14 Type: QueryParamCombination + +**Table 6.2.6.2.14-1: Definition of type QueryParamCombination** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------------|---|-------------|---------------------------------------------------| +| queryParams | array(QueryParameter) | M | 1..N | This IE shall contain a list of query parameters. | + +## 6.2.6.2.15 Type: QueryParameter + +**Table 6.2.6.2.15-1: Definition of type QueryParameter** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------| +| name | string | M | 1 | name of the query parameter | +| value | string | M | 1 | value of the query parameter | + +## 6.2.6.2.16 Type: AfData + +**Table 6.2.6.2.16-1: Definition of type AfData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| afEvents | array(AfEvent) | M | 1..N | AF Event(s) supported by the trusted AF. | +| tailList | array(Tai) | O | 1..N | This IE may be present if the AfEvent is set to "GNSS_ASSISTANCE_DATA". When present, this IE shall contain the list of TAIs the trusted AF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the trusted AF can be selected for any TAI in the serving network. | +| taiRangeList | array(TaiRange) | O | 1..N | This IE may be present if the AfEvent is set to "GNSS_ASSISTANCE_DATA". When present, this IE shall contain the range of TAIs the trusted AF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the tailList attribute indicate that the trusted AF can be selected for any TAI in the serving network. | + +### 6.2.6.2.17 Type: SearchResultInfo + +**Table 6.2.6.2.17-1: Definition of type SearchResultInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| unsatisfiedTailList | array(Tai) | C | 1..N | This IE should be present if the NF Discovery Request includes a tai-list query parameter and the "nf-ta-list-ind" query parameter set to true, when the NFs included in the nfInstances or nfInstanceList altogether support only a subset of TAs included in the tai-list. When present, this IE shall include a list of TAs which are unsatisfied, i.e. the NFs included in the nfInstances or nfInstanceList do not support these TAs. | + +## 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: NoProfileMatchReason + +The enumeration NoProfileMatchReason indicates the specific reason for not finding any NF instance that can match the search criteria. + +**Table 6.2.6.3.3-1: Enumeration NoProfileMatchReason** + +| Enumeration value | Description | +|-------------------------------------|------------------------------------------------------------------------| +| "REQUESTER_PLMN_NOT_ALLOWED" | NF profiles are not allowed to be discovered by the requester's PLMN | +| "TARGET_NF_SUSPENDED" | Target NF exists with NFStatus or NFServiceStatus "SUSPENDED" | +| "TARGET_NF_UNDISCOVERABLE" | Target NF exists with NFStatus or NFServiceStatus "UNDISCOVERABLE" | +| "QUERY_PARAMS_COMBINATION_NO_MATCH" | No NF instance matching the Query Parameter Combination has registered | +| "UNSPECIFIED" | Other reasons | + +## 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 errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.2.7.3 Application Errors + +The application errors defined for the Nnrf\_NFDiscovery service are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 6.2.8 Security + +As indicated in clause 13.3 of 3GPP TS 33.501 [15], when static authorization is not used, the access to the Nnrf\_NFDiscovery API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [16]), using the "Client Credentials" authorization grant, where the NRF plays the role of the authorization server. + +If OAuth2 authorization is used on the Nnrf\_NFDiscovery API, an NF Service Consumer, prior to consuming services offered by the Nnrf\_NFDiscovery API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 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 Nnrf\_NFDiscovery service is invoked by the NF Service Consumer. + +The Nnrf\_NFDiscovery API defines the following scopes for OAuth2 authorization: + +**Table 6.2.8-1: OAuth2 scopes defined in Nnrf\_NFDiscovery API** + +| Scope | Description | +|------------------------------------------------|---------------------------------------------------------------------------------------------------| +| "nnrf-disc" | Access to the Nnrf_NFDiscovery API | +| "nnrf-disc:scp-domain:read" | Access to read the scp-domain-routing-info resource | +| "nnrf-disc:scp-domain-subs:write" | Access to create/delete a scp-domain subscription resource | +| "nnrf-disc:nf-instances:read-complete-profile" | Access to the Nnrf_NFDiscovery API enabling the discovery of the complete profile of NF instances | + +## 6.2.9 Features supported by the NFDiscovery service + +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 Nnrf\_NFDiscovery service. + +**Table 6.2.9-1: Features of supportedFeatures attribute used by Nnrf\_NFDiscovery service** + +| Feature Number | Feature | M/O | Description | +|----------------|-----------------------------|-----|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | Complex-Query | O | Support of Complex Query expression (see clause 6.2.3.2.3.1) | +| 2 | Query-Params-Ext1 | O | Support of the following query parameters:
- limit
- max-payload-size
- required-features
- pdu-session-types | +| 3 | Query-Param-Analytics | O | Support of the query parameters for Analytics identifier:
- event-id-list
- nwdaf-event-list | +| 4 | MAPDU | O | This feature indicates whether the NRF supports selection of UPF with ATSSS capability. | +| 5 | Query-Params-Ext2 | O | Support of the following query parameters:
- requester-nf-instance-id
- upf-ue-ip-addr-ind
- pfd-data
- target-snpn
- af-ee-data
- w-agf-info
- tngf-info
- twif-info
- target-nf-set-id
- target-nf-service-set-id
- preferred-tai
- nef-id
- preferred-nf-instances
- notification-type
- serving-scope
- internal-group-identity
- preferred-api-versions
- v2x-support-ind
- redundant-gtpu
- redundant-transport
- lmf-id
- an-node-type
- rat-type
- ipups
- scp-domain-list
- address-domain
- ipv4-addr
- ipv6-prefix
- served-nf-set-id
- remote-plmn-id
- data-forwarding
- preferred-full-plmn
- requester-snpn-list
- max-payload-size-ext
- client-type | +| 6 | Service-Map | M | This feature indicates whether it is supported to identify the list of NF Service Instances as a map (i.e. the "nfServiceList" attribute of NFProfile is supported). | +| 7 | Query-Params-Ext3 | O | Support of the following query parameters:
- ims-private-identity
- ims-public-identity
- msisdn
- requester-plmn-specific-snssai-list
- n1-msg-class
- n2-info-class | +| 8 | Query-Params-Ext4 | O | Support of the following query parameters:
- realm-id
- storage-id | +| 9 | Query-Param-vSmf-Capability | O | Support of the query parameters for V-SMF Capability:
- vsmf-support-ind | +| 10 | Enh-NF-Discovery | O | Enhanced NF Discovery
This feature indicates whether it is supported to return the nfInstanceList IE in the NF Discovery response. | + +| | | | | +|----|-------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 11 | Query-SBIProtoc17 | O | Support of the following query parameters, for Service Based Interface Protocol Improvements defined in 3GPP Rel-17:
- preferred-vendor-specific-features
- preferred-vendor-specific-nf-features
- home-pub-key-id
- pgw-ip
- preferences-precedence
- preferred-pgw-ind
- v2x-capability
- shared-data-id | +| 12 | SCPDR | O | SCP Domain Routing Information

An NRF supporting this feature shall allow a service consumer (i.e. a SCP) to get the SCP Domain Routing Information and subscribe/unsubscribe to the change of SCP Domain Routing Information with following service operations:
- SCPDomainRoutingInfoGet (see clause 5.3.2.3)
- SCPDomainRoutingInfoSubscribe (see clause 5.3.2.4)
- SCPDomainRoutingInfoUnsubscribe (see clause 5.3.2.6)

A service consumer (i.e. a SCP) supporting this feature shall be able to handle SCPDomainRoutingInfoNotify as specified in clause 5.3.2.5, if subscribed to the change of SCP Domain Routing Information in the NRF. | +| 13 | Query-Upf-Pfcp | O | This feature indicates whether the NRF supports selection of UPF with required UP function features as defined in 3GPP TS 29.244 [21]. | +| 14 | Query-5G-ProSe | O | Support of the following query parameters, for Proximity based Services in 5GS defined in 3GPP Rel-17:
- prose-support-ind
- prose-capability | +| 15 | NSAC | O | This feature indicates the NSACF service capability.
Support of the following query parameters:
- nsacf-capability | +| 16 | Query-MBS | O | Support of the following query parameters, for Multicast and Broadcast Services defined in 3GPP Rel-17:
- mbs-session-id-list
- mbsmf-serving-area
- area-session-id | +| 17 | Query-eNA-PH2 | O | Support of the following query parameters, for Enhanced Network Automation Phase 2 defined in 3GPP Rel-17:
- analytics-aggregation-ind
- serving-nf-set-id
- serving-nf-type
- ml-analytics-info-list
- analytics-metadata-prov-ind | +| 18 | Query-eLCS | O | Support of the following query parameters, for 5G LCS service:
- gmlc-number | +| 19 | Query-eEDGE-5GC | O | Support of the following query parameters, for enhancement of support for Edge Computing in 5GC defined in 3GPP Rel-17:
- upf-n6-ip
- tai-list | +| 20 | Collocated-NF-Selection | O | Support of selecting a collocated NF supporting multiple NF types. | +| 21 | Query-ENPN | O | Support of the following query parameter for the enhanced support of Non-Public Networks defined in 3GPP Rel-17:
- support-onboarding-capability
- target-hni
- remote-snnpn-id | +| 22 | Query-ID_UAS | O | Support of the following query parameters, for remote Identification of Unmanned Aerial Systems defined in 3GPP Rel-17:
- uas-nf-functionality-ind | + +| | | | | +|----|-----------------------------|---|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 23 | NRFSET | O | NRF Set feature

An NRF supporting this feature shall allow a NF Service Consumer to get the NRF Set Information and subscribe/unsubscribe to the change of NRF Set Information:

A NF Service Consumer supporting this feature shall be able to handle Notify of the NRF status change, if subscribed to the change of NRF set information. | +| 24 | Query-Nw-Resolution | O | Support for the following query parameters:
- target-nw-resolution | +| 25 | Query-Param-iSmf-Capability | O | Support of the query parameters for I-SMF Capability:
- ismf-support-ind | +| 26 | Query-SBIProtoc17-Ext1 | O | Support of the following query parameters, for Service Based Interface Protocol Improvements defined in 3GPP Rel-17:
- exclude-nfinst-list
- exclude-nfservinst-list
- exclude-nfserviceset-list
- exclude-nfset-list | +| 27 | Query-Upf-IpIndex | O | Support of the query parameters for UPF selection with IpIndex:
- ipv4-index
- ipv6-index | +| 28 | Query-eNA-PH2-Ext1 | O | Support of the following query parameters, for extension of Enhanced Network Automation Phase 2 defined in 3GPP Rel-17:
- preferred-analytics-delays | +| 29 | Query-HLC | O | Support of the query parameters for AMF selection with High Latency Communication capability:
- high-latency-com | +| 30 | Query-SBIProtoc18 | O | Support of the following query parameters, for Service Based Interface Protocol Improvements defined in 3GPP Rel-18:
- ext-preferred-locality
- n32-purposes
- preferred-features
- sxa-ind
- remote-plmn-id-roaming
- nf-tai-list-ind
- complete-search-result
- additional-snssais | +| 31 | Complete-Profile-Discovery | O | Support discovery of complete NF profiles (including authorization attributes such as the "allowedXXX" attributes of NFProfile and NFService data types) of NF instances matching the query parameters. | +| 32 | Query-UPEAS | O | Support of the following query parameter, for UPF enhancement for Exposure and SBA defined in 3GPP Rel-18:
- upf-event-list | +| 33 | Enh-NF-Discovery-Ext1 | O | Support of the following query parameter defined in 3GPP Rel-18:
- target-nf-instance-id-list | +| 34 | Query-NG-RTC | O | Support of the following query parameters for NG_RTC defined in 3GPP Rel-18:
- ims-domain-name
- media-capability-list | +| 35 | Query-eLCS-PH3 | O | Support of the following query parameters, for 5G LCS Phase 3 service defined in 3GPP Rel-18:
- pru-tai
- af-data
- pru-support-ind
- preferred-up-positioning-ind | +| 36 | Query-eNA-PH3 | O | Support of the following query parameters, for Enhanced Network Automation Phase 3 defined in 3GPP Rel-18:
- ml-accuracy-checking-ind
- analytics-accuracy-checking-ind
- ml-model-storage-ind
- data-storage-ind
- data-subscription-relocation-support-ind
- roaming-exchange-ind | + +| | | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|---|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 37 | Query-A2X | O | Support of the following query parameters, for A2X in 5GS defined in 3GPP Rel-18:
- a2x-support-ind
- a2x-capability | +| 38 | Allowed-ruleset | O | Support receiving ruleSets in NF (Service) profile | +| 39 | Query-AIMLsys | O | Support for the following query parameters, for System Support for AI/ML-based Services defined in 3GPP Rel-18:
- multi-mem-af-sess-qos-ind
- member-ue-sel-assist-ind | +| 40 | Canary-Release | O | Support of "CANARY_RELEASE" value for NFStatus and NFServiceStatus, used for canary testing.

The NRF shall not return, in the discovery response, NF Instances, or NF Service Instances, whose NFStatus or NFService status respectively is set to value "CANARY_RELEASE", unless the consumer of the discovery service has indicated support of the "Canary-Release" feature. | +| 41 | Query-UPF-Selection-N3GPP | O | Support of the following query parameters, for selection of preferred UPF for PDU sessions via non-3GPP access:
- upf-select-epdg-info

An NRF supporting this feature shall also support discovery of the preferred UPF(s) for a W-AGF/TNGF/TWIF using the following query parameters:
- w-agf-info
- tngf-info
- twif-info | +| 42 | Query-5G-RangingSIPos | O | Support of the following query parameter, for Ranging and Sidelink positioning in 5GS defined in 3GPP Rel-18:
- ranging-sl-pos-support-ind | +| 43 | Query-eNS-PH2 | O | Support of the following query parameters, for Enhanced Network Slice Phase 2 defined in 3GPP Rel-17 onwards:
- nsac-sai | +| 44 | RID-NfGroupId-Mapping | O | Support the capability of mapping between Routing Indicator and NF Group ID by the NRF.

If the consumer of the discovery service has not indicated support of the "RID-NfGroupId-Mapping" feature, the NRF shall not return in the discovery response NF instances (of UDMs and AUSFs) containing (in "UdmInfo" and "AusfInfo" respectively) an NF Group ID and no Routing Indicators to indicate that the mapping between both will be done by the NRF (see clauses 6.1.6.2.7 and 6.1.6.2.8). | +| 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.
NOTE 1: An NRF that advertises support of a given feature shall support all the query parameters associated with the feature. An NRF may support none or a subset of the query parameters of features that it does not advertise as supported.
NOTE 2: For a release under development, it is recommended to define new features for new query parameters by grouping them per 3GPP work item. Any definition of new query parameters in a frozen release requires a new feature definition. | | | | + +## 6.3 Nnrf\_AccessToken Service API + +### 6.3.1 General + +This API reuses the API endpoints and input / output parameters specified in IETF RFC 6749 [16] as a custom operation without resources. Hence this clause does not follow the 3GPP API specification guidelines described in 3GPP TS 29.501 [5]. + +## 6.3.2 API URI + +URIs of this API shall have the following root: + +{nrfApiRoot}/oauth2 + +where {nrfApiRoot} represents the concatenation of the "scheme" and "authority" components of the NRF, as defined in IETF RFC 3986 [17]. + +## 6.3.3 Usage of HTTP + +### 6.3.3.1 General + +HTTP/2, as defined in IETF RFC 9113 [9], 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 this API shall comply with the OpenAPI [10] specification contained in Annex A. + +### 6.3.3.2 HTTP standard headers + +#### 6.3.3.2.1 General + +The HTTP headers as specified in clause 4.4 of IETF RFC 6749 [16] shall be supported, with the exception that there shall not be "Authorization" HTTP request header in the access token request. + +#### 6.3.3.2.2 Content type + +The following content types shall be supported: + +- The x-www-form-urlencoded format (see clause 17.13.4 of W3C HTML 4.01 Specification [26]). The use of the x-www-form-urlencoded format shall be signalled by the content type "application/x-www-form-urlencoded". +- The JSON format (IETF RFC 8259 [22]). 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]. + +### 6.3.3.3 HTTP custom headers + +#### 6.3.3.3.1 General + +In this release of this specification, no custom headers specific to the OAuth2.0 Authorization Service API 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.3.4 Custom Operations without associated resources + +### 6.3.4.1 Overview + +The /token endpoint as specified in IETF RFC 6749 [16] shall be supported. The "token endpoint" URI shall be: + +{nrfApiRoot}/oauth2/token + +where {nrfApiRoot} is defined in clause 6.3.2. + +Table 6.3.4.1-1 provides an overview of the endpoints and applicable HTTP methods. + +**Table 6.3.4.1-1: Custom operations without associated resources** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|----------------------------|----------------------|--------------------|--------------------------------------------------------------------------------------------------------------------------| +| Get (Access Token Request) | /oauth2/token | POST | Access token request for obtaining OAuth2.0 access token. This operation maps to Nnrf_AccessToken_Get service operation. | + +### 6.3.4.2 Operation: Get (Access Token Request) + +#### 6.3.4.2.1 Description + +This custom operation represents the process for issuing the OAuth2.0 access token. + +#### 6.3.4.2.2 Operation Definition + +This operation returns an OAuth 2.0 access token based on the input parameters provided. This custom operation shall use the HTTP POST method. + +This method shall support the request data structures specified in table 6.3.4.2.2-1 and the response data structures and response codes specified in table 6.3.4.2.2-2. The data structure used for the POST request body shall be using x-www-form-urlencoded format as specified in clause 17.13.4 of W3C HTML 4.01 Specification [26]. + +**Table 6.3.4.2.2-1: Data structures supported by the POST Request Body on this endpoint** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------| +| AccessTokenReq | M | 1 | This IE shall contain the request information for the access token request.
Content-Type: "application/x-www-form-urlencoded" | + +**Table 6.3.4.2.2-2: Data structures supported by the POST Response Body on this endpoint** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AccessTokenRsp | M | 1 | 200 OK | This IE shall contain the access token response information. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | The NRF shall generate a Location header field containing a URI pointing to the endpoint of another NRF service instance to which the request should be sent.
If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service producer to which the request should be sent. | +| AccessTokenErr | M | 1 | 400 Bad Request,
401 Unauthorized | See IETF RFC 6749 [16] 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 | +| ProblemDetails | O | 0..1 | 400 Bad Request | This error shall only be returned by an SCP or SEPP for errors they originate. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This response shall be returned if the requester NF is not allowed to request token for the NF being requested, and the "cause" attribute shall be set to:
- "MISSING_PARAMETER" to indicate the missing requester's information.
The missing parameter shall be indicated in "invalidParams" attribute of ProblemDetails. | + +**Table 6.3.4.2.2-3: Headers supported by the 200 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|------------------| +| Cache-Control | string | M | 1 | Enum: "no-store" | +| Pragma | string | M | 1 | Enum: "no-cache" | + +**Table 6.3.4.2.2-4: Headers supported by the 400 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|---------------|-----------|---|-------------|------------------| +| Cache-Control | string | M | 1 | Enum: "no-store" | +| Pragma | string | M | 1 | Enum: "no-cache" | + +**Table 6.3.4.2.2-5: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +**Table 6.3.4.2.2-6: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | A URI pointing to the endpoint of the NRF service instance to which the request should be sent | + +## 6.3.5 Data Model + +### 6.3.5.1 General + +This clause specifies the application data model supported by the API. + +Table 6.3.5.1-1 specifies the data types defined for the OAuth 2.0 Authorization Service API. The AccessTokenReq data structure shall be converted to the content type "application/x-www-form-urlencoded" when the OAuth 2.0 Access Token Request is invoked. + +**Table 6.3.5.1-1: OAuth 2.0 Authorization service specific Data Types** + +| Data type | Clause defined | Description | +|-------------------|----------------|-------------------------------------------------------------------| +| AccessTokenReq | 6.3.5.2.2 | Contains information related to the access token request. | +| AccessTokenRsp | 6.3.5.2.3 | Contains information related to the access token response. | +| AccessTokenClaims | 6.3.5.2.4 | The claims data structure for the access token. | +| AccessTokenErr | 6.3.5.2.5 | Contains error information returned in the access token response. | +| Audience | 6.3.5.4.1 | Contains the audience claim of the access token. | + +Table 6.3.5.1-2 specifies data types re-used by the OAuth 2.0 Authorization service from other specifications, including a reference to their respective specifications and when needed, a short description of their use. + +**Table 6.3.5.1-2: OAuth 2.0 Authorization service re-used Data Types** + +| Data type | Reference | Comments | +|------------------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NfInstanceId | 3GPP TS 29.571 [7] | Identifier (UUID) of the NF Instance. The hexadecimal letters of the UUID should be formatted by the sender as lower-case characters and shall be handled as case-insensitive by the receiver. | +| PlmnId | 3GPP TS 29.571 [7] | PLMN ID | +| NFType | 3GPP TS 29.510 | See clause 6.1.6.3.3 | +| Snssai | 3GPP TS 29.571 [7] | | +| NfSetId | 3GPP TS 29.571 [7] | NF Set ID (see clause 28.12 of 3GPP TS 23.003 [12]) | +| Uri | 3GPP TS 29.571 [7] | | +| RedirectResponse | 3GPP TS 29.571 [7] | Response body of the redirect response message. | +| Fqdn | 3GPP TS 29.571 [7] | Fully Qualified Domain Name | + +### 6.3.5.2 Structured data types + +#### 6.3.5.2.1 Introduction + +This clause defines the structures to be used in the APIs. + +### 6.3.5.2.2 Type: AccessTokenReq + +**Table 6.3.5.2.2-1: Definition of type AccessTokenReq** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| grant_type | string | M | 1 | This IE shall contain the grant type as "client_credentials".
Enum: "client_credentials" | +| nfInstanceId | NfInstanceId | M | 1 | This IE shall contain the NF instance id of the NF service consumer. | +| nfType | NfType | C | 0..1 | This IE shall be included when the access token request is for an NF type and not for a specific NF / NF service instance. When present, this IE shall contain the NF type of the NF service consumer. (NOTE 3) | +| targetNfType | NfType | C | 0..1 | This IE shall be included when the access token request is for an NF type and not for a specific NF / NF service instance. When present, this IE shall contain the NF type of the NF service producer. | +| scope | string | M | 1 | This IE shall contain the scopes requested by the NF service consumer.

The scopes shall consist of a list of NF service name(s) of the NF service producer(s) or resource/operation-level scopes defined by each service API, separated by whitespaces, as described in IETF RFC 6749 [16], clause 3.3.

The service name(s) included in this attribute shall be any of the services defined in the ServiceName enumerated type (see clause 6.1.6.3.11).

The resource/operation-level scopes shall be any of those defined in the "securitySchemes" clause of each service API.

pattern: '^[a-zA-Z0-9_-:]+( [a-zA-Z0-9_-:]+)*\$'

See NOTE 2. | +| targetNfInstanceId | NfInstanceId | C | 0..1 | This IE shall be included, if available and if it is an access token request for a specific NF Service Producer. When present this IE shall contain the NF Instance ID of the specific NF Service Producer for which the access token is requested. | +| requesterPlmn | PlmnId | C | 0..1 | This IE shall be included when the NF service consumer in one PLMN requests a service access authorization for an NF service producer from a different PLMN. It may be present when a service access authorization in the same PLMN need to be requested.
When present, this IE shall contain the PLMN ID of the requester NF service consumer. (NOTE 3) (NOTE 4) | +| requesterPlmnList | array(PlmnId) | C | 2..N | This IE shall be included when the NF service consumer serving a PLMN, with more than one PLMN ID, requests a service access authorization for an NF service producer from a different PLMN. It may be present when a service access authorization in the same PLMN, with more than one PLMN ID, need to be requested.
When present, this IE shall contain the PLMN IDs of the requester NF service consumer. (NOTE 4) | +| requesterSnssaiList | array(Snssai) | O | 1..N | When present, this IE shall contain the list of S-NSSAIs of the requester NF service consumer. If this IE is included in an Access Token Request sent towards a different PLMN, the requester NF shall provide S-NSSAI values of the target PLMN, that correspond to the S-NSSAI values of the requester NF.
This may be used by the NRF to validate that the requester NF service consumer is allowed to access | + +| | | | | | +|--|--|--|--|------------------------------------------| +| | | | | the target NF Service Producer. (NOTE 3) | +|--|--|--|--|------------------------------------------| + +| | | | | | +|----------------------|------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| requesterFqdn | Fqdn | O | 0..1 | When present, this IE shall contain the FQDN of the requester NF Service Consumer.
This may be used by the NRF to validate that the requester NF service consumer is allowed to access the target NF Service Producer. (NOTE 3) | +| requesterSnpnList | array(PlmnIdNid) | O | 1..N | When present, this IE shall contain the list of SNPNS the requester NF service consumer belongs to.
This may be used by the NRF to validate that the requester NF service consumer is allowed to access the target NF Service Producer. (NOTE 3) | +| targetPlmn | PlmnId | C | 0..1 | This IE shall be included when the NF service consumer in one PLMN or SNPN requests a service access authorization for an NF service producer from a different PLMN.
When present, this IE shall contain the PLMN ID of the target PLMN (i.e., PLMN ID of the NF service producer). | +| targetSnpn | PlmnIdNid | C | 0..1 | This IE shall be included when the NF service consumer in one PLMN or SNPN requests a service access authorization for an NF service producer from a different SNPN.
When present, this IE shall contain the SNPN ID of the target SNPN (i.e., SNPN ID of the NF service producer). | +| targetSnssaiList | array(SNSSAI) | O | 1..N | This IE may be included during an access token request for an NF type and not for a specific NF / NF service instance. When present, this IE shall contain the list of S-NSSAIs of the NF Service Producer. | +| targetNsiList | array(string) | O | 1..N | This IE may be included during an access token request for an NF type and not for a specific NF / NF service instance. When present, this IE shall contain the list of NSIs of the NF Service Producer. | +| targetNfSetId | NfSetId | O | 0..1 | This IE may be included during an access token request for an NF type and not for a specific NF / NF service instance. When present, this IE shall contain the NF Set ID of the NF Service Producer. | +| targetNfServiceSetId | NfServiceSetId | O | 0..1 | This IE may be included during an access token request for a specific NF / NF service instance. When present, this IE shall contain the NF Service Set ID of the NF Service Producer.
This may be used by the NRF to validate that the requester NF service consumer is allowed to access the target NF service instance. (NOTE 3) | +| hnrfAccessTokenUri | Uri | C | 0..1 | If included, this IE shall contain the API URI of the Access Token Service (see clause 6.3.2) of the NRF in home PLMN.

It shall be included during an access token request for an hSMF in the home routed roaming scenario, if it is returned from the NSSF in the home PLMN (see clause 6.1.6.2.11 of 3GPP TS 29.531 [42]). | +| sourceNfInstanceId | NfInstanceId | C | 0..1 | This IE shall be included, if available and if it is an access token request from the DCCF as NF Service Consumer request data from NF Service Producers on behalf of the source NF.
When present this IE shall contain the NF Instance ID of the source NF which intend to collect data from NF Service Producer. | + +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-form-urlencoded format as specified in clause 17.13.4 of W3C HTML 4.01 Specification [26]. + +NOTE 2: Though scope attribute is optional as per IETF RFC 6749 [16], it is mandatory for 3GPP as per 3GPP TS 33.501 [15]. + +NOTE 3: An access token request should be rejected if the requester NF is not allowed to access the target NF based on the authorization parameters in the NF profile of the target NF. The authorization parameters in NF Profile are those used by NRF to determine whether a given NF Instance / NF Service Instance can be discovered by an NF Service Consumer in order to consume its offered services (e.g. "allowedNfTypes", "allowedNfDomains", etc.). Based on operator's policies, an access token request not including the + +requester's information necessary to validate the authorization parameters in the target NF Profile may be rejected. + +NOTE 4: When the NF service consumer is serving a PLMN consisting of one PLMN ID, the attribute "requesterPlmn" shall be used; otherwise, if the NF service consumer is serving a PLMN consisting of more than one PLMN ID, the attribute "requesterPlmnList" shall be used. + +#### EXAMPLE: + +The following is an example of an Access Token Request message, with a request body encoded as x-www-form-urlencoded, with following input parameters: + +- NF Instance Id of the NF Service Consumer: 4e0b2760-0356-42c4-b739-8d6aaa491b63 +- NF Type of the NF Service Consumer: AMF +- NF Type of the NF Service Producer: UDM +- Requested scopes: "nudm-sdm", "nudm-uecm" and "nudm-ueau" +- PLMN ID of the NF Service Consumer: MCC=123, MNC=456 +- PLMN ID of the NF Service Producer: MCC=321, MNC=654 +- S-NSSAIs of the NF Service Producer: (SST=1, SD=A08923) and (SST=2) +- NSIs of the NF Service Producer: "Slice A, instance 1" and "Slice B, instance 2" + +Note that the URL-encoding of the request body requires to percent-encode the reserved characters ( [ ] { } " : , ) that appear in JSON-encoded structured input parameters (such as "requesterPlmn"), and in string input parameters (such as "scope", or "targetNsiList" array elements). Spaces are percent-encoded as '+'. + +The request body, *before URL-encoding*, and displayed in multiples lines only for illustration purposes, would be: + +``` +grant_type=client_credentials +&nfInstanceId=4e0b2760-0356-42c4-b739-8d6aaa491b63 +&nfType=AMF +&targetNfType=UDM +&scope=nudm-sdm nudm-uecm nudm-ueau +&requesterPlmn={"mcc":"123","mnc":"456"} +&targetPlmn={"mcc":"321","mnc":"654"} +&targetSnssaiList=[{"sst":1,"sd":"A08923"}, {"sst":2}] +&targetNsiList=Slice A, instance 1 +&targetNsiList=Slice B, instance 2 +``` + +The actual request message, *after URL-encoding*, and where all input parameters are contained into one single line in the request body, would be: + +``` +POST /oauth2/token +Content-Type: application/x-www-form-urlencoded +Accept: application/json + +grant_type=client_credentials&nfInstanceId=4e0b2760-0356-42c4-b739-8d6aaa491b63&nfType=AMF&targetNfType=UDM&scope=nudm-sdm+nudm-uecm+nudm-ueau&requesterPlmn=%7B%22mcc%22%3A%22123%22%2C%22mnc%22%3A%22456%22%7D&targetPlmn=%7B%22mcc%22%3A%22321%22%2C%22mnc%22%3A%22654%22%7D&targetSnssaiList=%5B%7B%22sst%22%3A%221%2C%22sd%22%3A%22A08923%22%7D%2C%7B%22sst%22%3A%222%7D%5D&targetNsiList=Slice+A%2C+instance+1&targetNsiList=Slice+B%2C+instance+2 +``` + +## 6.3.5.2.3 Type: AccessTokenRsp + +**Table 6.3.5.2.3-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 6.3.5.2.4). | +| token_type | string | M | 1 | This IE shall contain the token type, set to value "Bearer".
Enum: "Bearer" | +| expires_in | integer | C | 0..1 | This IE when present shall contain the number of seconds after which the access token is considered to be expired.
As indicated in IETF RFC 6749 [16], this attribute should be included, unless the expiration time of the token is made available by other means (e.g. deployment-specific documentation). | +| scope | string | C | 0..1 | This IE when present shall contain the scopes granted to the NF service consumer.

The scopes shall consist of a list of NF service name(s) of the NF service producer(s) or resource/operation-level scopes defined by each service API, separated by whitespaces, as described in IETF RFC 6749 [16], clause 3.3.

The service name(s) included in this attribute shall be any of the services defined in the ServiceName enumerated type (see clause 6.1.6.3.11).

The resource/operation-level scopes shall be any of those defined in the "securitySchemes" clause of each service API.

As indicated in IETF RFC 6749 [16], this attribute shall be present if it is different than the scope included in the access token request; if it is the same as the requested scope, this attribute may be absent.

pattern: '^[a-zA-Z0-9_-:]+( [a-zA-Z0-9_-:]+)*\$' | + +#### 6.3.5.2.4 Type: AccessTokenClaims + +**Table 6.3.5.2.4-1: Definition of type AccessTokenClaims** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| iss | NfInstanceId | M | 1 | This IE shall contain NF instance id of the NRF. , corresponding to the standard "Issuer" claim described in IETF RFC 7519 [25], clause 4.1.1 | +| sub | NfInstanceId | M | 1 | This IE shall contain the NF instance ID of the NF service consumer, corresponding to the standard "Subject" claim described in IETF RFC 7519 [25], clause 4.1.2. | +| aud | Audience | M | 1 | This IE shall contain the NF service producer's NF instance ID(s) (if the exact NF instance(s) of the NF service producer is known) or the NF type of NF service producers for which the claim is applicable, corresponding to the standard "Audience" claim described in IETF RFC 7519 [25], clause 4.1.3. | +| scope | string | M | 1 | This IE shall contain the name of the NF services and the resource/operation-level scopes for which the access_token is authorized for use; this claim corresponds to a private claim, as described in IETF RFC 7519 [25], clause 4.3.

pattern: '^[a-zA-Z0-9_-:]+( [a-zA-Z0-9_-:]+)*\$' | +| exp | integer | M | 1 | This IE shall contain the expiration time after which the access_token is considered to be expired, corresponding to the standard "Expiration Time" claim described in IETF RFC 7519 [25], clause 4.1.4. | +| consumerPlmnId | PlmnId | C | 0..1 | This IE shall be included if the NRF supports providing PLMN ID of the NF service consumer in the access token claims, to be interpreted for subject (sub IE), as specified in clause 13.4.1.2 of 3GPP TS 33.501 [15]. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| consumerSnpnId | PlmnIdNid | C | 0..1 | This IE shall be included if the NRF supports providing SNPN ID of the NF service consumer in the access token claims, to be interpreted for subject (sub IE), as specified in clause 13.4.1.2 of 3GPP TS 33.501[15]. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| producerPlmnId | PlmnId | C | 0..1 | This IE shall be included if the access token is granted for an NF service producer belonging to an PLMN and the NRF supports providing PLMN ID of the NF service producer in the access token claims, to be interpreted for audience (aud IE), as specified in clause 13.4.1.2 of 3GPP TS 33.501 [15]. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| producerSnpnId | PlmnIdNid | C | 0..1 | This IE shall be included if the access token is granted for an NF service producer belonging to an SNPN and the NRF supports providing SNPN ID of the NF service producer in the access token claims, to be interpreted for audience (aud IE), as specified in clause 13.4.1.2 of 3GPP TS 33.501 [15]. When present, it shall contain the SNPN ID of the SNPN the target NF service producer belongs to. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| producerSnssaiList | array(SNSSAI) | O | 1..N | This IE may be included if the NRF supports providing list of S-NSSAIs of the NF service producer in the access token claims. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| producerNsiList | array(string) | O | 1..N | This IE may be included if the NRF supports | + +| | | | | | +|------------------------|----------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | providing list of NSIs of the NF service producer in the access token claims. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| producerNfSetId | NfSetId | O | 0..1 | This IE may be included if the NRF supports providing NF Set ID of the NF service producer in the access token claims and if the audience contains an NF type. When present, it shall indicate the NF Set ID of the NF service producer instances for which the claim is applicable. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| producerNfServiceSetId | NfServiceSetId | O | 0..1 | This IE may be included during an access token request for a specific NF / NF service instance, if the targetNfServiceSetId IE is present in the Access Token Request. When present, this IE shall contain the NF Service Set ID of the NF Service Producer for which the access token is applicable. If an NF service producer that receives this IE in the token included in the authorization header does not understand this IE, it shall be ignored. | +| sourceNfInstanceId | NfInstanceId | C | 0..1 | This IE shall be included if the NRF supports providing NF Instance ID of the source NF in the access token claims (if it is an access token request from the DCCF as NF Service Consumer request data from NF Service Producers on behalf of the source NF), to be interpreted for subject (sub IE), as specified in Annex X of 3GPP TS 33.501 [15]. | + +### 6.3.5.2.5 Type: AccessTokenErr + +**Table 6.3.5.2.5-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 [16], clause 5.2.
Enum:
"invalid_request"
"invalid_client"
"invalid_grant"
"unauthorized_client"
"unsupported_grant_type"
"invalid_scope" | +| 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 [16], clause 5.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 [16], clause 5.2. | + +### 6.3.5.3 Simple data types and enumerations + +#### 6.3.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.3.5.3.2 Simple data types + +There are no specific simple data types defined in this version of this API. For the re-used data types from other specifications see clause 6.3.5.1 + +### 6.3.5.3.3 Void + +### 6.3.5.4 Data types describing alternative data types or combinations of data types + +#### 6.3.5.4.1 Type: Audience + +**Table 6.3.5.4.1-1: Definition of type Audience as a list of "non-exclusive alternatives"** + +| Data type | Cardinality | Description | Applicability | +|---------------------|-------------|--------------------------|---------------| +| NFType | 1 | NF type | | +| array(NfInstanceId) | 1..N | Array of NF Instance Ids | | + +## 6.3.6 Error Handling + +### 6.3.6.1 General + +HTTP error handling shall be supported as specified in IETF RFC 6749 [16] for errors returned by NRF as Oauth 2.0 authorization server, and also as specified in clause 5.2.7.4 of 3GPP TS 29.500 [4] for errors returned by SCP or SEPP. + +### 6.3.6.2 Protocol Errors + +Protocol errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.3.6.3 Application Errors + +The application errors defined for the Nnrf\_AccessToken service are listed in Table 6.3.6.3-1 and correspond to the values of the "error" attribute (see clause 6.3.5.2.5). + +**Table 6.3.6.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|------------------------|--------------------------------------|------------------------| +| invalid_request | 400 Bad Request | See IETF RFC 6749 [16] | +| invalid_client | 400 Bad Request,
401 Unauthorized | See IETF RFC 6749 [16] | +| invalid_grant | 400 Bad Request | See IETF RFC 6749 [16] | +| unauthorized_client | 400 Bad Request | See IETF RFC 6749 [16] | +| unsupported_grant_type | 400 Bad Request | See IETF RFC 6749 [16] | +| invalid_scope | 400 Bad Request | See IETF RFC 6749 [16] | + +## 6.4 Nnrf\_Bootstrapping Service API + +### 6.4.1 API URI + +URIs of this API shall have the following root: + +{nrfApiRoot} + +where {nrfApiRoot} represents the concatenation of the "scheme" and "authority" components of the NRF, as defined in IETF RFC 3986 [17]. + +## 6.4.2 Usage of HTTP + +### 6.4.2.1 General + +HTTP/2, as defined in IETF RFC 9113 [9], 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 this API shall comply with the OpenAPI [10] specification contained in Annex A. + +### 6.4.2.2 HTTP standard headers + +#### 6.4.2.2.1 General + +The mandatory standard HTTP headers as specified in clause 5.2.2.2 of 3GPP TS 29.500 [4] shall be supported. + +#### 6.4.2.2.2 Content type + +The following content types shall be supported: + +- The JSON format (IETF RFC 8259 [22]). 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 [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.4.2.2.3 Cache-Control + +A "Cache-Control" header should be included in HTTP responses, as described in IETF RFC 9111 [20], clause 5.2. It shall contain a "max-age" value, indicating the amount of time in seconds after which the received response is considered stale. + +#### 6.4.2.2.4 ETag + +An "ETag" (entity-tag) header should be included in HTTP responses, as described in IETF RFC 9110 [40], clause 8.8.3. 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.4.2.2.5 If-None-Match + +An NF Service Consumer should issue conditional GET requests towards the Nnrf\_Bootstrapping service, by including an If-None-Match header in HTTP requests, as described in IETF RFC 9110 [40], clause 13.1.2, containing one or several entity tags received in previous responses for the same resource. + +### 6.4.2.3 HTTP custom headers + +#### 6.4.2.3.1 General + +In this release of this specification, no custom headers specific to the Nnrf\_Bootstrapping Service API 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.4.3 Resources + +### 6.4.3.1 Overview + +The structure of the Resource URIs of the Nnrf\_Bootstrapping service is shown in figure 6.4.3.1-1. + +![Diagram showing the resource URI structure for the Nnrf_Bootstrapping API. It consists of a root node '{nrfApiRoot}' connected to a child node '/bootstrapping'.](5a0427b4033881484e387d85b8d8fa77_img.jpg) + +``` + +graph TD + nrfApiRoot["{nrfApiRoot}"] --- bootstrapping["/bootstrapping"] + +``` + +Diagram showing the resource URI structure for the Nnrf\_Bootstrapping API. It consists of a root node '{nrfApiRoot}' connected to a child node '/bootstrapping'. + +**Figure 6.4.3.1-1: Resource URI structure of the Nnrf\_Bootstrapping API** + +Table 6.4.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.4.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------|----------------------------|---------------------------------|---------------------------------------------------------------------------| +| Bootstrapping (Document) | {nrfApiRoot}/bootstrapping | GET | Retrieve a collection of links pointing to other services exposed by NRF. | + +## 6.4.3.2 Resource: Bootstrapping (Document) + +### 6.4.3.2.1 Description + +This resource represents a collection of links pointing to other services exposed by NRF. + +This resource is modelled as the Document resource archetype (see clause C.3 of 3GPP TS 29.501 [5]). + +### 6.4.3.2.2 Resource Definition + +Resource URI: **{nrfApiRoot}/bootstrapping** + +This resource shall support the resource URI variables defined in table 6.4.3.2.2-1. + +**Table 6.4.3.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|------------|------------------| +| nrfApiRoot | See clause 6.4.1 | + +### 6.4.3.2.3 Resource Standard Methods + +#### 6.4.3.2.3.1 GET + +This method retrieves a list of links pointing to other services exposed by NRF. This method shall support the URI query parameters specified in table 6.4.3.2.3.1-1. + +**Table 6.4.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | n/a | | | | + +This method shall support the request data structures specified in table 6.4.3.2.3.1-2 and the response data structures and response codes specified in table 6.4.3.2.3.1-3. + +**Table 6.4.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.4.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BootstrappingInfo | M | 1 | 200 OK | The response body contains a "_links" object containing the URI of each service exposed by the NRF. The response may also contain the status of the NRF and the features supported by each NRF service. | +| NOTE: 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]). | | | | | + +## 6.4.4 Custom Operations without associated resources + +There are no custom operations defined without any associated resources for the Nnrf\_Bootstrapping service in this release of the specification. + +## 6.4.5 Notifications + +There are no notifications defined for the Nnrf\_Bootstrapping service in this release of the specification. + +## 6.4.6 Data Model + +### 6.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.6.1-1 specifies the data types defined for the Nnrf\_Bootstrapping service-based interface protocol. + +**Table 6.4.6.1-1: Nnrf\_Bootstrapping specific Data Types** + +| Data type | Clause defined | Description | +|-------------------|----------------|--------------------------------------------------------------------| +| BootstrappingInfo | 6.4.6.2.2 | Information returned by NRF in the bootstrapping response message. | +| Status | 6.4.6.3.2 | Overall status of the NRF. | + +Table 6.4.6.1-2 specifies data types re-used by the Nnrf\_Bootstrapping 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 Nnrf service-based interface. + +**Table 6.4.6.1-2: Nnrf\_Bootstrapping re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LinksValueSchema | 3GPP TS 29.571 [7] | 3GPP Hypermedia link | +| NfInstanceId | 3GPP TS 29.571 [7] | Identifier (UUID) of the NF Instance. The hexadecimal letters of the UUID should be formatted by the sender as lower-case characters and shall be handled as case-insensitive by the receiver. | +| ProblemDetails | 3GPP TS 29.571 [7] | | +| SupportedFeatures | 3GPP TS 29.571 [7] | | + +## 6.4.6.2 Structured data types + +### 6.4.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 6.4.6.2.2 Type: BootstrappingInfo + +**Table 6.4.6.2.2-1: Definition of type BootstrappingInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| status | Status | O | 0..1 | Status of the NRF (operative, non-operative, ...)
The NRF shall be considered as operative if this attribute is absent. | +| _links | map(LinksValueSchema) | M | 1..N | Map of LinksValueSchema objects, where the keys are the link relations, as described in Table 6.4.6.3.3.1-1, and the values are objects containing an "href" attribute, whose value is an absolute URI corresponding to each link relation. | +| nrfFeatures | map(SupportedFeatures) | O | 1..N | Map of features supported by the NRF, where the keys of the map are the NRF services (as defined in clause 6.1.6.3.11), and where the value indicates the features supported by the corresponding NRF services.
When present, the NRF shall indicate all the features of all the services it supports.
(NOTE) | +| oauth2Required | map(boolean) | O | 1..N | 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. | +| nrfSetId | NfSetId | O | 0..1 | NRF Set Id | +| nrfInstanceId | NfInstanceId | O | 0..1 | NRF Instance Id | +| NOTE: The absence of the nrfFeatures attribute in the BootstrappingInfo shall not be interpreted as if the NRF does not support any feature. | | | | | + +## 6.4.6.3 Simple data types and enumerations + +### 6.4.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.4.6.3.2 Enumeration: Status + +**Table 6.4.6.3.2-1: Enumeration Status** + +| Enumeration value | Description | +|-------------------|--------------------------| +| "OPERATIVE" | The NRF is operative | +| "NON_OPERATIVE" | The NRF is not operative | + +### 6.4.6.3.3 Relation Types + +#### 6.4.6.3.3.1 General + +This clause describes the possible relation types defined within NRF API. See clause 4.7.5.2 of 3GPP TS 29.501 [5] for the description of the relation types. + +**Table 6.4.6.3.3.1-1: supported registered relation types** + +| Relation Name | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| self | The "href" attribute of the object associated to this relation type contains the URI of the same resource returned in the response body (i.e. the "bootstrapping" resource). | +| manage | The "href" attribute of the object associated to this relation type contains the URI of the resource used in the Nnrf_NFManagement API to register/deregister/update NF Instances profiles in the NRF (i.e. the "nf-instances" store resource).
(NOTE) | +| subscribe | The "href" attribute of the object associated to this relation type contains the URI of the resource used in the Nnrf_NFManagement API to manage subscriptions to the NRF (i.e. the "subscriptions" collection resource).
(NOTE) | +| discover | The "href" attribute of the object associated to this relation type contains the URI of the resource used in the Nnrf_NFDiscovery API (i.e. the "nf-instances" collection resource). | +| authorize | The "href" attribute of the object associated to this relation type contains the URI of the Oauth2 Access Token Request endpoint, used to request authorization to other APIs in the 5G Core Network. | +| NOTE: The URIs of the "manage" and "subscribe" "href" attributes shall have the same apiRoot (i.e. authority and prefix) since these service operations belong to the same service. | | + +--- + +# Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex specifies the formal definition of the Nnrf Service API(s). 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 [31] clause 5B). + +--- + +## A.2 Nnrf\_NFManagement API + +``` +openapi: 3.0.0 + +info: + version: '1.3.0-alpha.6' + title: 'NRF NFManagement Service' + description: | + NRF NFManagement Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.510 V18.5.0; 5G System; Network Function Repository Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' + +servers: + - url: '{apiRoot}/nnrf-nfm/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + +paths: + /nf-instances: + get: + summary: Retrieves a collection of NF Instances + operationId: GetNFInstances + tags: + - NF Instances (Store) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instances:read + parameters: + - name: nf-type +``` + +``` +in: query +description: Type of NF +required: false +schema: + $ref: '#/components/schemas/NFType' +- name: limit +in: query +description: How many items to return at one time +required: false +schema: + type: integer + minimum: 1 +- name: page-number +in: query +description: Page number where the response shall start +required: false +schema: + type: integer + minimum: 1 +- name: page-size +in: query +description: Maximum number of items in each returned page +schema: + type: integer + minimum: 1 +responses: + '200': + description: Expected response to a valid request + content: + application/3gppHal+json: + schema: + $ref: '#/components/schemas/UriList' + headers: + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + 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 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' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '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' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +options: + summary: Discover communication options supported by NRF for NF Instances + operationId: OptionsNFInstances + tags: + - NF Instances (Store) + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/OptionsResponse' + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + '204': + description: No Content + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + 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 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' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +``` +/nf-instances/{nfInstanceID}: + get: + summary: Read the profile of a given NF Instance + operationId: GetNFInstance + tags: + - NF Instance ID (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instances:read + parameters: + - name: nfInstanceID + in: path + description: Unique ID of the NF Instance + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + - name: requester-features + in: query + description: Features supported by the NF Service Consumer + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Expected response to a valid request + headers: + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + '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' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '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' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Register a new NF Instance + operationId: RegisterNFInstance + tags: + - NF Instance ID (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instance:write + parameters: + - name: nfInstanceID + in: path + required: true + description: Unique ID of the NF Instance to register + 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: + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + required: true + responses: + '200': + description: OK (Profile Replacement) + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + 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 + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/NFProfile' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nnrf-nfm/v1/nf-instances/{nfInstanceId} +``` + +``` + required: true + schema: + type: string + 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 + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + 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 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' +'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' +patch: + summary: Update NF Instance profile + operationId: UpdateNFInstance + tags: + - NF Instance ID (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instance:write + parameters: + - name: nfInstanceID +``` + +``` +in: path +required: true +description: Unique ID of the NF Instance to update +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 +- name: If-Match +in: header +description: Validator for conditional requests, as described in IETF RFC 9110, 13.1.1 +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/NFProfile' + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string +'204': + description: Expected response with empty body + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + 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 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' + '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: Deregisters a given NF Instance + operationId: DeregisterNFInstance + tags: + - NF Instance ID (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:nf-instance:write + parameters: + - name: nfInstanceID + in: path + required: true + description: Unique ID of the NF Instance to deregister + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + responses: + '204': + description: Expected response to a successful deregistration + '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' + +/subscriptions: + post: + summary: Create a new subscription + operationId: CreateSubscription + tags: + - Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-nfm + - oAuth2ClientCredentials: + - nnrf-nfm + - nnrf-nfm:subscriptions:subs-complete-profile + parameters: + - 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: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nnrf-nfm/v1/subscriptions/{subscriptionId} + required: true + schema: + type: string + 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 + '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' +'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' +callbacks: + onNFStatusEvent: + "{ $request.body#/nfStatusNotificationUri }": + post: + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + description: Notification content + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationData' + responses: + '204': + description: Expected response to a successful callback processing + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + 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 another NF service + consumer instance + 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 another NF service + consumer instance + 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' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/subscriptions/{subscriptionID}: + patch: + summary: Updates a subscription + operationId: UpdateSubscription + tags: + - Subscription ID (Document) + parameters: + - name: subscriptionID + in: path + required: true + description: Unique ID of the subscription to update + schema: + type: string + pattern: '^(?:[0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?)?[^\-]+\+$' + - 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: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + +``` + +``` + + $ref: '#/components/schemas/SubscriptionData' +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 + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + 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 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' +'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' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Deletes a subscription + operationId: RemoveSubscription + tags: + - Subscription ID (Document) + parameters: + - name: subscriptionID + in: path + required: true + description: Unique ID of the subscription to remove + schema: + type: string + pattern: '^[0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?[^-]+\+$' + responses: + '204': + +``` + +``` + + description: Expected response to a successful subscription removal + '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' + '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' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '/oauth2/token' + scopes: + nnrf-nfm: Access to the Nnrf_NFManagement API + nnrf-nfm:nf-instances:read: > + Access to read the nf-instances resource, or an individual NF Instance ID resource + nnrf-nfm:subscriptions:subs-complete-profile: > + Access to subscribe to the complete profile of NF instances + nnrf-nfm:nf-instance:write: > + Access to write (create, update, delete) an individual NF Instance ID resource + +schemas: + + NFProfile: + description: Information of an NF Instance registered in the NRF + type: object + required: + - nfInstanceId + - nfType + - nfStatus + anyOf: + - required: [ fqdn ] + +``` + +``` +- required: [ ipv4Addresses ] +- required: [ ipv6Addresses ] +properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfInstanceName: + type: string + nfType: + $ref: '#/components/schemas/NFType' + nfStatus: + $ref: '#/components/schemas/NFStatus' + collocatedNfInstances: + type: array + items: + $ref: '#/components/schemas/CollocatedNfInstance' + minItems: 1 + heartBeatTimer: + type: integer + minimum: 1 + plmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + snpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + sNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnsai' + minItems: 1 + perPlmnSnsaiList: + type: array + items: + $ref: '#/components/schemas/PlmnSnsai' + minItems: 1 + nsiList: + type: array + items: + type: string + minItems: 1 + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + ipv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + allowedPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + allowedSnpns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + allowedNfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + allowedNfDomains: + type: array + items: + type: string + minItems: 1 +``` + +``` +allowedNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +allowedRuleSet: + description: A map (list of key-value pairs) where a valid JSON pointer Id serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/RuleSet' + minProperties: 1 +priority: + type: integer + minimum: 0 + maximum: 65535 +capacity: + type: integer + minimum: 0 + maximum: 65535 +load: + type: integer + minimum: 0 + maximum: 100 +loadTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +locality: + type: string +extLocality: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string serves + as key representing a type of locality + type: object + additionalProperties: + type: string + minProperties: 1 +udrInfo: + $ref: '#/components/schemas/UdrInfo' +udrInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdrInfo + type: object + additionalProperties: + $ref: '#/components/schemas/UdrInfo' + minProperties: 1 +udmInfo: + $ref: '#/components/schemas/UdmInfo' +udmInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdmInfo + type: object + additionalProperties: + $ref: '#/components/schemas/UdmInfo' + minProperties: 1 +ausfInfo: + $ref: '#/components/schemas/AusfInfo' +ausfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AusfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/AusfInfo' + minProperties: 1 +amfInfo: + $ref: '#/components/schemas/AmfInfo' +amfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AmfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/AmfInfo' + minProperties: 1 +smfInfo: + $ref: '#/components/schemas/SmfInfo' +smfInfoList: +``` + +``` +description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of SmfInfo +type: object +additionalProperties: + $ref: '#/components/schemas/SmfInfo' +minProperties: 1 +upfInfo: + $ref: '#/components/schemas/UpfInfo' +upfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UpfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/UpfInfo' + minProperties: 1 +pcfInfo: + $ref: '#/components/schemas/PcfInfo' +pcfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of PcfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/PcfInfo' + minProperties: 1 +bsfInfo: + $ref: '#/components/schemas/BsfInfo' +bsfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of BsfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/BsfInfo' + minProperties: 1 +chfInfo: + $ref: '#/components/schemas/ChfInfo' +chfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of ChfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/ChfInfo' + minProperties: 1 +nefInfo: + $ref: '#/components/schemas/NefInfo' +nrfInfo: + $ref: '#/components/schemas/NrfInfo' +udsfInfo: + $ref: '#/components/schemas/UdsfInfo' +udsfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdsfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/UdsfInfo' + minProperties: 1 +nwdafInfo: + $ref: '#/components/schemas/NwdafInfo' +nwdafInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of NwdafInfo + additionalProperties: + $ref: '#/components/schemas/NwdafInfo' + minProperties: 1 +pcscfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of PcscfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/PcscfInfo' +``` + +``` + minProperties: 1 + hssInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of HssInfo + type: object + additionalProperties: + $ref: '#/components/schemas/HssInfo' + minProperties: 1 + customInfo: + type: object + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + nfServicePersistence: + type: boolean + default: false + nfServices: + deprecated: true + type: array + items: + $ref: '#/components/schemas/NFService' + minItems: 1 + nfServiceList: + description: > + A map (list of key-value pairs) where serviceInstanceId serves as key of NFService + type: object + additionalProperties: + $ref: '#/components/schemas/NFService' + minProperties: 1 + nfProfileChangesSupportInd: + type: boolean + default: false + writeOnly: true + nfProfilePartialUpdateChangesSupportInd: + type: boolean + default: false + writeOnly: true + nfProfileChangesInd: + type: boolean + default: false + readOnly: true + defaultNotificationSubscriptions: + type: array + items: + $ref: '#/components/schemas/DefaultNotificationSubscription' + lmfInfo: + $ref: '#/components/schemas/LmfInfo' + gmlcInfo: + $ref: '#/components/schemas/GmlcInfo' + nfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + servingScope: + type: array + items: + type: string + minItems: 1 + lchSupportInd: + type: boolean + default: false + olchSupportInd: + type: boolean + default: false + nfSetRecoveryTimeList: + description: A map (list of key-value pairs) where NfSetId serves as key of DateTime + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minProperties: 1 + serviceSetRecoveryTimeList: + description: > + A map (list of key-value pairs) where NfServiceSetId serves as key of DateTime + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minProperties: 1 +``` + +``` +scpDomains: + type: array + items: + type: string + minItems: 1 +scpInfo: + $ref: '#/components/schemas/ScpInfo' +seppInfo: + $ref: '#/components/schemas/SeppInfo' +vendorId: + $ref: '#/components/schemas/VendorId' +supportedVendorSpecificFeatures: + description: > + The key of the map is the IANA-assigned SMI Network Management Private Enterprise Codes + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 +aanfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AanfInfo + additionalProperties: + $ref: '#/components/schemas/AanfInfo' + minProperties: 1 +5gDdnmfInfo: + $ref: '#/components/schemas/5GDdnmfInfo' +mfafInfo: + $ref: '#/components/schemas/MfafInfo' +easdfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of EasdfInfo + additionalProperties: + $ref: '#/components/schemas/EasdfInfo' + minProperties: 1 +dccfInfo: + $ref: '#/components/schemas/DccfInfo' +nsacfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of NsacfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/NsacfInfo' + minProperties: 1 +mbSmfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MbSmfInfo + type: object + additionalProperties: + $ref: '#/components/schemas/MbSmfInfo' + minProperties: 1 +tsctsInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of TsctsInfo + additionalProperties: + $ref: '#/components/schemas/TsctsInfo' + minProperties: 1 +mbUpfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MbUpfInfo + additionalProperties: + $ref: '#/components/schemas/MbUpfInfo' + minProperties: 1 +trustAfInfo: + $ref: '#/components/schemas/TrustAfInfo' +nssaafInfo: +``` + +``` + $ref: '#/components/schemas/NssaafInfo' + hniList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + iwmscInfo: + $ref: '#/components/schemas/IwmscInfo' + mnpfInfo: + $ref: '#/components/schemas/MnpfInfo' + smsfInfo: + $ref: '#/components/schemas/SmsfInfo' + dcsfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of DcsfInfo + additionalProperties: + $ref: '#/components/schemas/DcsfInfo' + minProperties: 1 + mrfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MrfInfo + additionalProperties: + $ref: '#/components/schemas/MrfInfo' + minProperties: 1 + mrfpInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MrfpInfo + additionalProperties: + $ref: '#/components/schemas/MrfpInfo' + minProperties: 1 + mfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MfInfo + additionalProperties: + $ref: '#/components/schemas/MfInfo' + minProperties: 1 + adrfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AdrfInfo + additionalProperties: + $ref: '#/components/schemas/AdrfInfo' + minProperties: 1 + selectionConditions: + $ref: '#/components/schemas/SelectionConditions' + +NFService: + description: > + Information of a given NF Service Instance; it is part of the NFProfile of an NF Instance + type: object + required: + - serviceInstanceId + - serviceName + - versions + - scheme + - nfServiceStatus + properties: + serviceInstanceId: + type: string + serviceName: + $ref: '#/components/schemas/ServiceName' + versions: + type: array + items: + $ref: '#/components/schemas/NFServiceVersion' + minItems: 1 + scheme: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UriScheme' +``` + +``` +nfServiceStatus: + $ref: '#/components/schemas/NFServiceStatus' +fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +interPlmnFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +ipEndPoints: + type: array + items: + $ref: '#/components/schemas/IpEndPoint' + minItems: 1 +apiPrefix: + type: string +callbackUriPrefixList: + type: array + items: + $ref: '#/components/schemas/CallbackUriPrefixItem' + minItems: 1 +defaultNotificationSubscriptions: + type: array + items: + $ref: '#/components/schemas/DefaultNotificationSubscription' + minItems: 1 +allowedPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 +allowedSnpons: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 +allowedNfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 +allowedNfDomains: + type: array + items: + type: string + minItems: 1 +allowedNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +allowedOperationsPerNfType: + description: A map (list of key-value pairs) where NF Type serves as key + type: object + additionalProperties: + type: array + items: + type: string + minItems: 1 + minProperties: 1 +allowedOperationsPerNfInstance: + description: A map (list of key-value pairs) where NF Instance Id serves as key + type: object + additionalProperties: + type: array + items: + type: string + minItems: 1 + minProperties: 1 +allowedOperationsPerNfInstanceOverrides: + type: boolean + default: false +allowedScopesRuleSet: + description: A map (list of key-value pairs) where a valid JSON pointer Id serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/RuleSet' + minProperties: 1 +priority: + type: integer + minimum: 0 +``` + +``` + maximum: 65535 + capacity: + type: integer + minimum: 0 + maximum: 65535 + load: + type: integer + minimum: 0 + maximum: 100 + loadTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + nfServiceSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + minItems: 1 + sNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + perPlmnSnssaiList: + type: array + items: + $ref: '#/components/schemas/PlmnSnssai' + minItems: 1 + vendorId: + $ref: '#/components/schemas/VendorId' + supportedVendorSpecificFeatures: + description: > + A map (list of key-value pairs) where IANA-assigned SMI Network Management + Private Enterprise Codes serves as key + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 + oauth2Required: + type: boolean + perPlmnOAuth2ReqList: + $ref: '#/components/schemas/PlmnOAuth2' + selectionConditions: + $ref: '#/components/schemas/SelectionConditions' + +NFType: + description: NF types known to NRF + anyOf: + - type: string + enum: + - NRF + - UDM + - AMF + - SMF + - AUSF + - NEF + - PCF + - SMSF + - NSSF + - UDR + - LMF + - GMLC + - 5G_EIR + - SEPP + - UPF + - N3IWF + - AF + - UDSF + - BSF + - CHF + - NWDAF + - PCSCF + - CBCF +``` + +- HSS +- UCMF +- SOR\_AF +- SPAF +- MME +- SCSAS +- SCEF +- SCP +- NSSAAF +- ICSCF +- SCSF +- DRA +- IMS\_AS +- AANF +- 5G\_DDNMF +- NSACF +- MFAF +- EASDF +- DCCF +- MB\_SMF +- TSCTSF +- ADRF +- GBA\_BSF +- CEF +- MB\_UPF +- NSWOF +- PKMF +- MNPF +- SMS\_GMSC +- SMS\_IWMSC +- MBSF +- MBSTF +- PANF +- DCSF +- MRF +- MRFP +- MF +- SLPKMF +- type: string + +NefId: +description: Identity of the NEF +type: string + +IpEndPoint: +description: > +IP addressing information of a given NFService; +it consists on, e.g. IP address, TCP port, transport protocol... +type: object +not: +required: [ ipv4Address, ipv6Address ] +properties: +ipv4Address: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv4Addr' +ipv6Address: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv6Addr' +transport: +\$ref: '#/components/schemas/TransportProtocol' +port: +type: integer +minimum: 0 +maximum: 65535 + +SubscriptionData: +description: > +Information of a subscription to notifications to NRF events, +included in subscription requests and responses +type: object +required: +- nfStatusNotificationUri +- subscriptionId +properties: +nfStatusNotificationUri: +type: string +reqNfInstanceId: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/NfInstanceId' +subscrCond: +\$ref: '#/components/schemas/SubscrCond' + +``` + +subscriptionId: + type: string + pattern: '^(?:[0-9]{5,6}-(x3Lf57A:nid=[A-Fa-f0-9]{11}:)?)[^-]+$' + readOnly: true +validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +reqNotifEvents: + type: array + items: + $ref: '#/components/schemas/NotificationEventType' + minItems: 1 +plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' +notifCondition: + $ref: '#/components/schemas/NotifCondition' +reqNfType: + $ref: '#/components/schemas/NFType' +reqNfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +reqSnssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +reqPerPlmnSnssais: + type: array + items: + $ref: '#/components/schemas/PlmnSnssai' + minItems: 1 +reqPlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 +reqSnpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 +servingScope: + type: array + items: + type: string + minItems: 1 +requesterFeatures: + writeOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +nrfSupportedFeatures: + readOnly: true + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +hnrfUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +onboardingCapability: + type: boolean + default: false +targetHni: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +preferredLocality: + type: string +extPreferredLocality: + description: > + A map (list of key-value pairs) where the key of the map represents the relative + priority, for the requester, of each locality description among the list of locality + descriptions in this query parameter, encoded as "1" (highest priority), "2", "3", ..., + "n" (lowest priority) + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/LocalityDescription' + minItems: 1 + minProperties: 1 +completeProfileSubscription: + type: boolean + +``` + +``` + default: false + writeOnly: true + +SubscrCond: + description: > + Condition to determine the set of NFs to monitor under a certain subscription in NRF + oneOf: + - $ref: '#/components/schemas/NfInstanceIdCond' + - $ref: '#/components/schemas/NfInstanceIdListCond' + - $ref: '#/components/schemas/NfTypeCond' + - $ref: '#/components/schemas/ServiceNameCond' + - $ref: '#/components/schemas/ServiceNameListCond' + - $ref: '#/components/schemas/AmfCond' + - $ref: '#/components/schemas/GuamiListCond' + - $ref: '#/components/schemas/NetworkSliceCond' + - $ref: '#/components/schemas/NfGroupCond' + - $ref: '#/components/schemas/NfGroupListCond' + - $ref: '#/components/schemas/NfSetCond' + - $ref: '#/components/schemas/NfServiceSetCond' + - $ref: '#/components/schemas/UpfCond' + - $ref: '#/components/schemas/ScpDomainCond' + - $ref: '#/components/schemas/NwdafCond' + - $ref: '#/components/schemas/NefCond' + - $ref: '#/components/schemas/DccfCond' + +NfInstanceIdCond: + description: Subscription to a given NF Instance Id + type: object + required: + - nfInstanceId + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +NfInstanceIdListCond: + description: Subscription to a list of NF Instances + type: object + required: + - nfInstanceIdList + properties: + nfInstanceIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + +NfTypeCond: + description: Subscription to a set of NFs based on their NF Type + type: object + required: + - nfType + not: + required: [ nfGroupId ] + properties: + nfType: + $ref: '#/components/schemas/NFType' + +ServiceNameCond: + description: Subscription to a set of NFs based on their support for a given Service Name + type: object + required: + - serviceName + properties: + serviceName: + $ref: '#/components/schemas/ServiceName' + +ServiceNameListCond: + description: > + Subscription to a set of NFs based on their support for a Service Name + in the Service Name list + type: object + required: + - conditionType + - serviceNameList + properties: + conditionType: + type: string + enum: [ SERVICE_NAME_LIST_COND ] +``` + +``` + serviceNameList: + type: array + items: + $ref: '#/components/schemas/ServiceName' + minItems: 1 + +AmfCond: + description: Subscription to a set of AMFs, based on AMF Set Id and/or AMF Region Id + type: object + anyOf: + - required: [ amfSetId ] + - required: [ amfRegionId ] + properties: + amfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfSetId' + amfRegionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId' + +GuamiListCond: + description: Subscription to a set of AMFs, based on their GUAMIs + type: object + required: + - guamiList + properties: + guamiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + +NetworkSliceCond: + description: Subscription to a set of NFs, based on the slices (S-NSSAI and NSI) they support + type: object + required: + - snssaiList + properties: + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + nsiList: + type: array + items: + type: string + +NfGroupCond: + description: Subscription to a set of NFs based on their Group Id + type: object + required: + - nfType + - nfGroupId + properties: + nfType: + type: string + enum: + - UDM + - AUSF + - UDR + - PCF + - CHF + - HSS + nfGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + +NfGroupListCond: + description: Subscription to a set of NFs based on their Group Ids + type: object + required: + - conditionType + - nfType + - nfGroupIdList + properties: + conditionType: + type: string + enum: [ NF_GROUP_LIST_COND ] + nfType: + type: string + enum: + - UDM +``` + +``` + - AUSF + - UDR + - PCF + - CHF + - HSS + nfGroupIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + minItems: 1 + +NotifCondition: + description: > + Condition (list of attributes in the NF Profile) to determine whether a notification + must be sent by NRF + type: object + not: + required: [ monitoredAttributes, unmonitoredAttributes ] + properties: + monitoredAttributes: + type: array + items: + type: string + minItems: 1 + unmonitoredAttributes: + type: array + items: + type: string + minItems: 1 + +UdrInfo: + description: Information of an UDR NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + supportedDataSets: + type: array + items: + $ref: '#/components/schemas/DataSetId' + minItems: 1 + sharedDataIdRanges: + type: array + items: + $ref: '#/components/schemas/SharedDataIdRange' + minItems: 1 + +SharedDataIdRange: + description: A range of SharedDataIds based on regular-expression matching + type: object + properties: + pattern: + type: string + +SupiRange: + description: > + A range of SUPIs (subscriber identities), either based on a numeric range, + or based on regular-expression matching + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: +``` + +``` +start: + type: string + pattern: '^[0-9]+$' +end: + type: string + pattern: '^[0-9]+$' +pattern: + type: string + +IdentityRange: + description: > + A range of GPSIs (subscriber identities), either based on a numeric range, + or based on regular-expression matching + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^[0-9]+$' + end: + type: string + pattern: '^[0-9]+$' + pattern: + type: string + +InternalGroupIdRange: + description: > + A range of Group IDs (internal group identities), either based on a numeric range, + or based on regular-expression matching + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + end: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + pattern: + type: string + +DataSetId: + description: Types of data sets and subsets stored in UDR + anyOf: + - type: string + enum: + - SUBSCRIPTION + - POLICY + - EXPOSURE + - APPLICATION + - A_PFD + - A_AFTI + - A_AFQOS + - A_IPTV + - A_BDT + - A_SPD + - A_EASD + - A_AMI + - P_UE + - P_SCD + - P_BDT + - P_PLMNUE + - P_NSSCD + - P_PDTQ + - P_MBSCD + - P_GROUP + - type: string + +UdmInfo: + description: Information of an UDM NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array +``` + +``` + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + internalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/InternalGroupIdRange' + minItems: 1 + suciInfos: + type: array + items: + $ref: '#/components/schemas/SuciInfo' + minItems: 1 + +AusfInfo: + description: Information of an AUSF NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + suciInfos: + type: array + items: + $ref: '#/components/schemas/SuciInfo' + minItems: 1 + +AmfInfo: + description: Information of an AMF NF Instance + type: object + required: + - amfSetId + - amfRegionId + - guamiList + properties: + amfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfSetId' + amfRegionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId' + guamiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: +``` + +``` + $ref: '#/components/schemas/TaiRange' + minItems: 1 + backupInfoAmfFailure: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + backupInfoAmfRemoval: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + minItems: 1 + n2InterfaceAmfInfo: + $ref: '#/components/schemas/N2InterfaceAmfInfo' + amfOnboardingCapability: + type: boolean + default: false + highLatencyCom: + type: boolean + +SmfInfo: + description: Information of an SMF NF Instance + type: object + required: + - sNssaiSmfInfoList + properties: + sNssaiSmfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiSmfInfoItem' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + pgwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pgwIpAddrList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + accessType: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + priority: + type: integer + minimum: 0 + maximum: 65535 + vsmfSupportInd: + type: boolean + pgwFqdnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 + smfOnboardingCapability: + type: boolean + default: false + deprecated: true + ismfSupportInd: + type: boolean + smfUPRPCapability: + type: boolean + default: false + +SnssaiSmfInfoItem: + description: Set of parameters supported by SMF for a given S-NSSAI + type: object + required: +``` + +``` +- sNSSAI +- dnnSmfInfoList +properties: + sNSSAI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtS NSSAI' + dnnSmfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnSmfInfoItem' + minItems: 1 + +DnnSmfInfoItem: + description: Set of parameters supported by SMF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + dnaiList: + type: array + items: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + - $ref: '#/components/schemas/WildcardDnai' + minItems: 1 + +UpfInfo: + description: Information of an UPF NF Instance + type: object + required: + - sNSSAIUpfInfoList + properties: + sNSSAIUpfInfoList: + type: array + items: + $ref: '#/components/schemas/SNSSAIUpfInfoItem' + minItems: 1 + smfServingArea: + type: array + items: + type: string + minItems: 1 + interfaceUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + iwkEpsInd: + type: boolean + default: false + sxaInd: + type: boolean + pduSessionTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + atsssCapability: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AtsssCapability' + ueIpAddrInd: + type: boolean + default: false + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + wAgfInfo: + $ref: '#/components/schemas/WAgfInfo' + tngfInfo: +``` + +``` +$ref: '#/components/schemas/TngfInfo' +twifInfo: + $ref: '#/components/schemas/TwifInfo' +preferredEpdgInfoList: + type: array + items: + $ref: '#/components/schemas/EpdgInfo' + minItems: 1 +preferredWAgfInfoList: + type: array + items: + $ref: '#/components/schemas/WAgfInfo' + minItems: 1 +preferredTngfInfoList: + type: array + items: + $ref: '#/components/schemas/TngfInfo' + minItems: 1 +preferredTwifInfoList: + type: array + items: + $ref: '#/components/schemas/TwifInfo' + minItems: 1 +priority: + type: integer + minimum: 0 + maximum: 65535 +redundantGtpu: + type: boolean + default: false +ipups: + type: boolean + default: false +dataForwarding: + type: boolean + default: false +supportedPfcpFeatures: + type: string +upfEvents: + type: array + items: + $ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/EventType' + minItems: 1 + +SnssaiUpfInfoItem: + description: Set of parameters supported by UPF for a given S-NSSAI + type: object + required: + - sNssai + - dnnUpfInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnUpfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnUpfInfoItem' + minItems: 1 + redundantTransport: + type: boolean + default: false + interfaceUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + +DnnUpfInfoItem: + description: Set of parameters supported by UPF for a given DNN + type: object + required: + - dnn + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + dnaIList: + type: array + items: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + pduSessionTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + ipv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + natedIpv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + natedIpv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + ipv4IndexList: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex' + minItems: 1 + ipv6IndexList: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex' + minItems: 1 + networkInstance: + description: > + The N6 Network Instance associated with the S-NSSAI and DNN. + type: string + dnaiNwInstanceList: + description: > + Map of network instance per DNAI for the DNN, where the key of the map is the DNAI. + When present, the value of each entry of the map shall contain a N6 network instance + that is configured for the DNAI indicated by the key. + type: object + additionalProperties: + type: string + minProperties: 1 + interfaceUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + not: + required: [ networkInstance, dnaiNwInstanceList ] + +InterfaceUpfInfoItem: + description: Information of a given IP interface of an UPF + type: object + required: + - interfaceType + anyOf: + - required: [ endpointFqdn ] + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + interfaceType: + $ref: '#/components/schemas/UPInterfaceType' + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + endpointFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + networkInstance: + type: string + +UPInterfaceType: + description: Types of User-Plane interfaces of the UPF + anyOf: + - type: string + enum: + - N3 + - N6 + - N9 + - DATA_FORWARDING + - N3MB + - N6MB + - N19MB + - NMB9 + - S1U + - S5U + - S8U + - S11U + - S12 + - S2AU + - S2BU + - N3TRUSTEDN3GPP + - N3UNTRUSTEDN3GPP + - N9ROAMING + - SGI + - N19 + - SXAU + - SXBU + - N4U + - type: string + +WAgfInfo: + description: Information of the W-AGF end-points + type: object + anyOf: + - required: [ endpointFqdn ] + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + endpointFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + +TngfInfo: + description: Information of the TNGF endpoints + type: object + anyOf: + - required: [ endpointFqdn ] + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + endpointFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +``` + +``` +PcfInfo: + description: Information of a PCF NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + rxDiamHost: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + rxDiamRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + v2xSupportInd: + type: boolean + default: false + proseSupportInd: + type: boolean + default: false + proseCapability: + $ref: '#/components/schemas/ProSeCapability' + v2xCapability: + $ref: '#/components/schemas/V2xCapability' + a2xSupportInd: + type: boolean + default: false + a2xCapability: + $ref: '#/components/schemas/A2xCapability' + rangingSlPosSupportInd: + type: boolean + default: false + upPositioningInd: + description: user plane positioning capability is supported by the LMF + type: boolean + default: false + +BsfInfo: + description: Information of a BSF NF Instance + type: object + properties: + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + ipDomainList: + type: array + items: + type: string + minItems: 1 + ipv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + rxDiamHost: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + rxDiamRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + groupId: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + +ChfInfo: + description: Information of a CHF NF Instance + type: object + not: + required: [ primaryChfInstance, secondaryChfInstance ] + properties: + supiRangeList: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + plmnRangeList: + type: array + items: + $ref: '#/components/schemas/PlmnRange' + minItems: 1 + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + primaryChfInstance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + secondaryChfInstance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +Ipv4AddressRange: + description: Range of IPv4 addresses + type: object + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + end: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + +Ipv6PrefixRange: + description: Range of IPv6 prefixes + type: object + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + end: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + +DefaultNotificationSubscription: + description: > + Data structure for specifying the notifications the NF service subscribes by default, + along with callback URI + type: object + required: + - notificationType + - callbackUri + properties: + notificationType: + $ref: '#/components/schemas/NotificationType' + callbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + interPlmnCallbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + n1MessageClass: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N1MessageClass' + n2InformationClass: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InformationClass' + versions: + +``` + +``` + type: array + items: + type: string + minItems: 1 + binding: + type: string + acceptedEncoding: + type: string + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + serviceInfoList: + description: > + A map of service specific information. The name of the corresponding service (as + specified in ServiceName data type) is the key. + type: object + additionalProperties: + $ref: '#/components/schemas/DefSubServiceInfo' + minProperties: 1 + callbackUriPrefix: + type: string + +NfSetCond: + description: Subscription to a set of NFs based on their Set Id + type: object + required: + - nfSetId + properties: + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + +NfServiceSetCond: + description: Subscription to a set of NFs based on their Service Set Id + type: object + required: + - nfServiceSetId + properties: + nfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + +UpfCond: + description: > + Subscription to a set of NF Instances (UPFs), able to serve a certain service area + (i.e. SMF serving area or TAI list) + type: object + required: + - conditionType + properties: + conditionType: + type: string + enum: [ UPF_COND ] + smfServingArea: + type: array + items: + type: string + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + +NwdafCond: + description: > + Subscription to a set of NF Instances (NWDAFs), identified by Analytics ID(s), + S-NSSAI(s) or NWDAF Serving Area information, i.e. list of TAIs for which the NWDAF + can provide analytics. + type: object + required: + - conditionType + properties: + conditionType: + type: string + enum: [ NWDAF_COND ] + analyticsIds: + type: array + items: +``` + +``` + + type: string + 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: '#/components/schemas/TaiRange' + minItems: 1 + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + mlAnalyticsList: + type: array + items: + $ref: '#/components/schemas/MlAnalyticsInfo' + minItems: 1 + +NefCond: + description: > + Subscription to a set of NF Instances (NEFs), identified by Event ID(s) provided by AF, + S-NSSAI(s), AF Instance ID, Application Identifier, External Identifier, + External Group Identifier, or domain name. + type: object + required: + - conditionType + properties: + conditionType: + type: string + enum: [ NEF_COND ] + afEvents: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent' + minItems: 1 + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + pfdData: + $ref: '#/components/schemas/PfdData' + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + servedFqdnList: + type: array + items: + type: string + minItems: 1 + +NotificationType: + description: > + Types of notifications used in Default Notification URIs in the NF Profile of an NF Instance + anyOf: + - type: string + +``` + +``` + +enum: + - N1_MESSAGES + - N2_INFORMATION + - LOCATION_NOTIFICATION + - DATA_REMOVAL_NOTIFICATION + - DATA_CHANGE_NOTIFICATION + - LOCATION_UPDATE_NOTIFICATION + - NSSAA_REAUTH_NOTIFICATION + - NSSAA_REVOC_NOTIFICATION + - MATCH_INFO_NOTIFICATION + - DATA_RESTORATION_NOTIFICATION + - TSCTS_NOTIFICATION + - LCS_KEY_DELIVERY_NOTIFICATION + - UUAA_MM_AUTH_NOTIFICATION +- type: string + +TransportProtocol: + description: Types of transport protocol used in a given IP endpoint of an NF Service Instance + anyOf: + - type: string + enum: + - TCP + - type: string + +NotificationEventType: + description: Types of events sent in notifications from NRF to subscribed NF Instances + anyOf: + - type: string + enum: + - NF_REGISTERED + - NF_DEREGISTERED + - NF_PROFILE_CHANGED + - type: string + +NotificationData: + description: Data sent in notifications from NRF to subscribed NF Instances + type: object + required: + - event + - nfInstanceUri + allOf: + # + # Condition: If 'event' takes value 'NF_PROFILE_CHANGED', + # then one of 'nfProfile', 'profileChanges' or 'completeNfProfile' must be present + # + - anyOf: + - not: + properties: + event: + type: string + enum: + - NF_PROFILE_CHANGED + - oneOf: + - required: [ nfProfile ] + - required: [ profileChanges ] + - required: [ completeNfProfile ] + # + # Condition: If 'event' takes value 'NF_REGISTERED', + # then one of 'nfProfile' or 'completeNfProfile' must be present + # + - anyOf: + - not: + properties: + event: + type: string + enum: + - NF_REGISTERED + - oneOf: + - required: [ nfProfile ] + - required: [ completeNfProfile ] + properties: + event: + $ref: '#/components/schemas/NotificationEventType' + nfInstanceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nfProfile: + allOf: + - $ref: '#/components/schemas/NFProfile' + +``` + +``` + +- not: + required: [ allowedPlmns ] +- not: + required: [ allowedSnpns ] +- not: + required: [ allowedNfTypes ] +- not: + required: [ allowedNfDomains ] +- not: + required: [ allowedNssais ] +- properties: + nfServices: + type: array + items: + allOf: + - $ref: '#/components/schemas/NFService' + - not: + required: [ allowedPlmns ] + - not: + required: [ allowedSnpns ] + - not: + required: [ allowedNfTypes ] + - not: + required: [ allowedNfDomains ] + - not: + required: [ allowedNssais ] + nfServiceList: + type: object + additionalProperties: + allOf: + - $ref: '#/components/schemas/NFService' + - not: + required: [ allowedPlmns ] + - not: + required: [ allowedSnpns ] + - not: + required: [ allowedNfTypes ] + - not: + required: [ allowedNfDomains ] + - not: + required: [ allowedNssais ] +profileChanges: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChangeItem' + minItems: 1 +conditionEvent: + $ref: '#/components/schemas/ConditionEventType' +subscriptionContext: + $ref: '#/components/schemas/SubscriptionContext' +completeNfProfile: + $ref: '#/components/schemas/NFProfile' + +NFStatus: + description: Status of a given NF Instance stored in NRF + anyOf: + - type: string + enum: + - REGISTERED + - SUSPENDED + - UNDISCOVERABLE + - CANARY_RELEASE + - type: string + +NFServiceVersion: + description: Contains the version details of an NF service + type: object + required: + - apiVersionInUri + - apiFullVersion + properties: + apiVersionInUri: + type: string + apiFullVersion: + type: string + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +``` + +ServiceName: +description: Service names known to NRF +anyOf: +- type: string +enum: +- nnrf-nfm +- nnrf-disc +- nnrf-oauth2 +- nudm-sdm +- nudm-uecm +- nudm-ueau +- nudm-ee +- nudm-pp +- nudm-niddau +- nudm-mt +- nudm-ssau +- nudm-rsds +- nudm-ueid +- namf-comm +- namf-evts +- namf-mt +- namf-loc +- namf-mbs-comm +- namf-mbs-bc +- nsmf-pdusession +- nsmf-event-exposure +- nsmf-nidd +- nausf-auth +- nausf-sorprotection +- nausf-upuprotection +- nnef-pfdmanagement +- nnef-smcontext +- nnef-eventexposure +- nnef-eas-deployment-info +- nnef-dnai-mapping +- nnef-traffic-influence-data +- nnef-ecs-addr-cfg-info +- 3gpp-cp-parameter-provisioning +- 3gpp-device-triggering +- 3gpp-bdt +- 3gpp-traffic-influence +- 3gpp-chargeable-party +- 3gpp-as-session-with-qos +- 3gpp-msisdn-less-mo-sms +- 3gpp-service-parameter +- 3gpp-monitoring-event +- 3gpp-nidd-configuration-trigger +- 3gpp-nidd +- 3gpp-analyticsexposure +- 3gpp-racs-parameter-provisioning +- 3gpp-ecr-control +- 3gpp-applying-bdt-policy +- 3gpp-mo-lcs-notify +- 3gpp-time-sync +- 3gpp-am-influence +- 3gpp-am-policyauthorization +- 3gpp-akma +- 3gpp-eas-deployment +- 3gpp-iptvconfiguration +- 3gpp-mbs-tmgi +- 3gpp-mbs-session +- 3gpp-authentication +- 3gpp-asti +- 3gpp-pdtq-policy-negotiation +- 3gpp-musa +- npcf-am-policy-control +- npcf-smpolicycontrol +- npcf-policyauthorization +- npcf-bdtpolicycontrol +- npcf-eventexposure +- npcf-ue-policy-control +- npcf-am-policyauthorization +- npcf-pdtq-policy-control +- npcf-mbspolicycontrol +- npcf-mbspolicyauth +- nsmsf-sms +- nnssf-nsselection +- nnssf-nssaiavailability + +``` + + - nudr-dr + - nudr-group-id-map + - nlmf-loc + - n5g-eir-eic + - nbsf-management + - nchf-spendinglimitcontrol + - nchf-convergedcharging + - nchf-offlineonlycharging + - nnwdaf-eventssubscription + - nnwdaf-analyticsinfo + - nnwdaf-datamanagement + - nnwdaf-mlmodelprovision + - nnwdaf-mlmodeltraining + - nnwdaf-mlmodelmonitor + - ngmlc-loc + - nucmf-provisioning + - nucmf-uecapabilitymanagement + - nhss-sdm + - nhss-uecm + - nhss-ueau + - nhss-ee + - nhss-ims-sdm + - nhss-ims-uecm + - nhss-ims-ueau + - nhss-gba-sdm + - nhss-gba-ueau + - nsepp-telescopic + - nsoraf-sor + - nspaf-secured-packet + - nudsf-dr + - nudsf-timer + - nnssaa-nssaa + - nnssaa-aiw + - naanf-akma + - n5gddnmf-discovery + - nmfaf-3dadm + - nmfaf-3cdm + - neasdf-dnscontext + - neasdf-baselinednspattern + - ndccf-dm + - ndccf-cm + - nnsacf-nsac + - nnsacf-slice-ee + - nmbsmf-tmgi + - nmbsmf-mbsession + - nadrf-dm + - nadrf-mlmodelmanagement + - nbsp-gba + - ntsctsf-time-sync + - ntsctsf-qos-tscai + - ntsctsf-asti + - npkmf-keyreq + - npkmf-userid + - npkmf-discovery + - nmnpf-npstatus + - niwmsc-smsservice + - nmbsf-mbs-us + - nmbsf-mbs-ud-ingest + - nmbstf-distsession + - npanf-prosekey + - npanf-userid + - nupf-ee + - nupf-gueip + - naf-prose + - naf-eventexposure + - type: string + +N2InterfaceAmfInfo: + description: AMF N2 interface information + type: object + anyOf: + - required: [ ipv4EndPointAddress ] + - required: [ ipv6EndPointAddress ] + properties: + ipv4EndPointAddress: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + +``` + +``` + + minItems: 1 + ipv6EndpointAddress: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + amfName: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfName' + +NFServiceStatus: + description: Status of a given NF Service Instance of an NF Instance stored in NRF + anyOf: + - type: string + enum: + - REGISTERED + - SUSPENDED + - UNDISCOVERABLE + - CANARY_RELEASE + - type: string + +TaiRange: + description: Range of TAIs (Tracking Area Identities) + type: object + required: + - plmnId + - tacRangeList + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + tacRangeList: + type: array + items: + $ref: '#/components/schemas/TacRange' + minItems: 1 + nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' + +TacRange: + description: Range of TACs (Tracking Area Codes) + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^([A-Fa-f0-9]{4}|[A-Fa-f0-9]{6})$' + end: + type: string + pattern: '^([A-Fa-f0-9]{4}|[A-Fa-f0-9]{6})$' + pattern: + type: string + +PlmnRange: + description: Range of PLMN IDs + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}$' + end: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}$' + pattern: + type: string + +NrfInfo: + description: Information of an NRF NF Instance, used in hierarchical NRF deployments + type: object + properties: + servedUdrInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + +``` + +``` + - $ref: '#/components/schemas/UdrInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedUdrInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdrInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedUdmInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdmInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedUdmInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdmInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedAusfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AusfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedAusfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AusfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedAmfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + servedAmfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedSmfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object +``` + +``` +additionalProperties: + anyOf: + - $ref: '#/components/schemas/SmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' +minProperties: 1 +servedSmfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/SmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedUpfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UpfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedUpfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UpfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedPcfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/PcfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedPcfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/PcfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedBsfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/BsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedBsfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/BsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedChfInfo: +``` + +``` +description: A map (list of key-value pairs) where nfInstanceId serves as key +type: object +additionalProperties: + anyOf: + - $ref: '#/components/schemas/ChfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' +minProperties: 1 +servedChfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/ChfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedNefInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/NefInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedNwdaInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/NwdaInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedNwdaInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/NwdaInfo' + minProperties: 1 + minProperties: 1 +servedPscfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/PscfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedGmlcInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/GmlcInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedLmfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/LmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedNfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + $ref: '#/components/schemas/NfInfo' +``` + +``` +minProperties: 1 +servedHssInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/HssInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedUdsfInfo: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedUdsfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/UdsfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 +servedScpInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/ScpInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedSeppInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/SeppInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +servedAanfInfoList: + description: A map (list of key-value pairs) where NF Instance Id serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/AanfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 +served5gDdnmfInfo: + type: object + additionalProperties: + $ref: '#/components/schemas/5GDdnmfInfo' + minProperties: 1 +servedMfafInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/MfafInfo' + minProperties: 1 +servedEasdfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: +``` + +``` + $ref: '#/components/schemas/EasdInfo' + minProperties: 1 + servedDccfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/DccfInfo' + minProperties: 1 + servedMbSmfInfoList: + description: A map (list of key-value pairs) where nfInstanceId serves as key + type: object + additionalProperties: + description: A map (list of key-value pairs) where a valid JSON string serves as key + type: object + additionalProperties: + anyOf: + - $ref: '#/components/schemas/MbSmfInfo' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/EmptyObject' + minProperties: 1 + minProperties: 1 + servedTsctsInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/TsctsInfo' + minProperties: 1 + minProperties: 1 + servedMbUpfInfoList: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + type: object + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/MbUpfInfo' + minProperties: 1 + minProperties: 1 + servedTrustAfInfo: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/TrustAfInfo' + minProperties: 1 + servedNssaafInfo: + type: object + description: A map (list of key-value pairs) where NF Instance Id serves as key + additionalProperties: + $ref: '#/components/schemas/NssaafInfo' + minProperties: 1 + +PlmnSnssai: + description: List of network slices (S-NSSAIs) for a given PLMN ID + type: object + required: + - plmnId + - sNssaiList + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + sNssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' + +NefInfo: + description: Information of an NEF NF Instance + type: object + properties: + nefId: + $ref: '#/components/schemas/NefId' + pfdData: + $ref: '#/components/schemas/PfdData' +``` + +``` +afEeData: + $ref: '#/components/schemas/AfEventExposureData' +gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 +externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 +servedFqdnList: + type: array + items: + type: string + minItems: 1 +taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 +taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 +dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 +unTrustAfInfoList: + type: array + items: + $ref: '#/components/schemas/UnTrustAfInfo' + minItems: 1 +uasNfFunctionalityInd: + type: boolean + default: false +multiMemAfSessQosInd: + type: boolean + default: false +memberUESelAssistInd: + type: boolean + default: false + +PfdData: + description: List of Application IDs and/or AF IDs managed by a given NEF Instance + type: object + properties: + appIds: + type: array + items: + type: string + minItems: 1 + afIds: + type: array + items: + type: string + minItems: 1 + +NwdafInfo: + description: Information of a NWDAF NF Instance + type: object + properties: + eventIds: + type: array + items: + $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventId' + minItems: 1 + nwdafEvents: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + minItems: 1 + taiList: + type: array +``` + +``` + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + nwdafCapability: + $ref: '#/components/schemas/NwdafCapability' + analyticsDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + mlAnalyticsList: + type: array + items: + $ref: '#/components/schemas/MlAnalyticsInfo' + minItems: 1 + +LmfInfo: + description: Information of an LMF NF Instance + type: object + properties: + servingClientTypes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType' + minItems: 1 + lmfId: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' + servingAccessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + servingAnNodeTypes: + type: array + items: + $ref: '#/components/schemas/AnNodeType' + minItems: 1 + servingRatTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + supportedGADShapes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/SupportedGADShapes' + minItems: 1 + pruExistenceInfo: + $ref: '#/components/schemas/PruExistenceInfo' + pruSupportInd: + type: boolean + default: false + rangingslposSupportInd: + type: boolean + default: false +``` + +``` +GmlcInfo: + description: Information of a GMLC NF Instance + type: object + properties: + servingClientTypes: + type: array + items: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType' + minItems: 1 + gmlcNumbers: + type: array + items: + type: string + pattern: '^[0-9]{5,15}$' + minItems: 1 + +AfEventExposureData: + description: AF Event Exposure data managed by a given NEF Instance + type: object + required: + - afEvents + properties: + afEvents: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent' + minItems: 1 + afIds: + type: array + items: + type: string + minItems: 1 + appIds: + type: array + items: + type: string + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + +PscfInfo: + description: Information of a P-CSCF NF Instance + type: object + properties: + accessType: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + gmFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + gmIpv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + gmIpv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + mwFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + mwIpv4Addresses: + type: array +``` + +``` + + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + mwIpv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + servedIpv4AddressRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + servedIpv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + +NfInfo: + description: Information of a generic NF Instance + type: object + properties: + nfType: + $ref: '#/components/schemas/NFType' + +HssInfo: + description: Information of an HSS NF Instance + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + imsiRanges: + type: array + items: + $ref: '#/components/schemas/ImsiRange' + minItems: 1 + imsPrivateIdentityRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + imsPublicIdentityRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + msisdnRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + hssDiameterAddress: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/NetworkNodeDiameterAddress' + additionalDiamAddresses: + type: array + items: + $ref: 'TS29503_Nudm_UECM.yaml#/components/schemas/NetworkNodeDiameterAddress' + minItems: 1 + +ImsiRange: + description: > + A range of IMSIs (subscriber identities), either based on a numeric range, + or based on regular-expression matching + type: object + oneOf: + - required: [ start, end ] + - required: [ pattern ] + properties: + start: + type: string + pattern: '^[0-9]+$' + end: + +``` + +``` + type: string + pattern: '[0-9]+$' + pattern: + type: string + + TwifInfo: + description: Addressing information (IP addresses, FQDN) of the TWIF + type: object + anyOf: + - required: [ endpointFqdn ] + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + endpointFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + + VendorId: + description: Vendor ID of the NF Service instance (Private Enterprise Number assigned by IANA) + type: string + pattern: '[0-9]{6}$' + + VendorSpecificFeature: + description: Information about a vendor-specific feature + type: object + required: + - featureName + - featureVersion + properties: + featureName: + type: string + featureVersion: + type: string + + AnNodeType: + description: Access Network Node Type (gNB, ng-eNB...) + anyOf: + - type: string + enum: + - GNB + - NG_ENB + - type: string + + UdsfInfo: + description: Information related to UDSF + type: object + properties: + groupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + storageIdRanges: + description: > + A map (list of key-value pairs) where realmId serves as key and each value in the map + is an array of IdentityRanges. Each IdentityRange is a range of storageIds. + type: object + additionalProperties: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + minProperties: 1 + + ScpInfo: + description: Information of an SCP Instance + type: object +``` + +``` +properties: + scpDomainInfoList: + description: > + A map (list of key-value pairs) where the key of the map shall be the string + identifying an SCP domain + type: object + additionalProperties: + $ref: '#/components/schemas/ScpDomainInfo' + minProperties: 1 + scpPrefix: + type: string + scpPorts: + description: > + Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https". + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 + minProperties: 1 + addressDomains: + type: array + items: + type: string + minItems: 1 + ipv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + ipv4AddrRanges: + type: array + items: + $ref: '#/components/schemas/Ipv4AddressRange' + minItems: 1 + ipv6PrefixRanges: + type: array + items: + $ref: '#/components/schemas/Ipv6PrefixRange' + minItems: 1 + servedNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + remotePlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + remoteSnpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + ipReachability: + $ref: '#/components/schemas/IpReachability' + scpCapabilities: + type: array + items: + $ref: '#/components/schemas/ScpCapability' + +ScpDomainInfo: + description: SCP Domain specific information + type: object + properties: + scpFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + scpIpEndPoints: + type: array + items: + $ref: '#/components/schemas/IpEndPoint' + minItems: 1 +``` + +``` + scpPrefix: + type: string + scpPorts: + description: > + Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https". + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 + minProperties: 1 + + ScpDomainCond: + description: > + Subscription to a set of NF or SCP or SEPP instances belonging to certain SCP domains + type: object + required: + - scpDomains + properties: + scpDomains: + type: array + items: + type: string + minItems: 1 + nfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + + OptionsResponse: + description: Communication options of the NRF sent in response content of OPTIONS method + type: object + properties: + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + ConditionEventType: + description: > + Indicates whether a notification is due to the NF Instance to start or stop + being part of a condition for a subscription to a set of NFs + anyOf: + - type: string + enum: + - NF_ADDED + - NF_REMOVED + - type: string + + SuciInfo: + description: SUCI information containing Routing Indicator and Home Network Public Key ID + type: object + properties: + routingInds: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + hNwPubKeyIds: + type: array + items: + type: integer + minItems: 1 + + SeppInfo: + description: Information of a SEPP Instance + type: object + properties: + seppPrefix: + type: string + seppPorts: + description: > + Port numbers for HTTP and HTTPS. The key of the map shall be "http" or "https". + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 +``` + +``` + + minProperties: 1 + remotePlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + remoteSnpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + n32Purposes: + description: N32 purposes supported by the SEPP + type: array + items: + $ref: 'TS29573_N32_Handshake.yaml#/components/schemas/N32Purpose' + minItems: 1 + + IpReachability: + description: Indicates the type(s) of IP addresses reachable via an SCP + anyOf: + - type: string + enum: + - IPV4 + - IPV6 + - IPV4V6 + - type: string + + UriList: + description: > + Represents a set of URIs following the 3GPP hypermedia format + (containing a "_links" attribute). + type: object + properties: + _links: + type: object + description: > + List of the URI of NF instances. It has two members whose names are item and self. + The item attribute contains an array of URIs. + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' + minProperties: 1 + totalItemCount: + type: integer + + AanfInfo: + description: Represents the information relative to an AAnF NF Instance. + type: object + properties: + routingIndicators: + type: array + items: + type: string + pattern: '^[0-9]{1,4}$' + minItems: 1 + + 5GDdnmfInfo: + description: Information of an 5G DDNMF NF Instance + type: object + required: + - plmnId + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + + WildcardDnai: + description: Wildcard DNAI + type: string + pattern: '^[*]$' + + MfafInfo: + description: Information of a MFAF NF Instance + type: object + properties: + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + +``` + +``` + minItems: 1 + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + tailList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + +NwdafCapability: + description: Indicates the capability supported by the NWDAF + type: object + properties: + analyticsAggregation: + type: boolean + default: false + analyticsMetadataProvisioning: + type: boolean + default: false + mlModelAccuracyChecking: + type: boolean + default: false + analyticsAccuracyChecking: + type: boolean + default: false + roamingExchange: + type: boolean + default: false + +EasdfInfo: + description: Information of an EASDF NF Instance + type: object + properties: + sNssaiEasdfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiEasdfInfoItem' + minItems: 1 + easdfN6IpAddressList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + upfN6IpAddressList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + minItems: 1 + +SnssaiEasdfInfoItem: + description: Set of parameters supported by EASDF for a given S-NSSAI + type: object + required: + - sNssai + - dnnEasdfInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnEasdfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnEasdfInfoItem' + minItems: 1 + +DnnEasdfInfoItem: + description: Set of parameters supported by EASDF for a given DNN + type: object + required: + - dnn + properties: +``` + +``` +dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' +dnaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + +DccfInfo: + description: Information of a DCCF NF Instance + type: object + properties: + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + tailList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + dataSubsRelocInd: + type: boolean + default: false + +ScpCapability: + description: Indicates the capabilities supported by an SCP + anyOf: + - type: string + enum: + - INDIRECT_COM_WITH_DELEG_DISC + - type: string + +NsacfInfo: + description: Information of a NSACF NF Instance + type: object + required: + - nsacfCapability + properties: + nsacfCapability: + $ref: '#/components/schemas/NsacfCapability' + snssaiListForEntirePlmn: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + tailList: + deprecated: true + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + deprecated: true + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + nsacSaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsacSai' + minItems: 1 + +NsacfCapability: +``` + +``` +description: > + NSACF service capabilities (e.g. to monitor and control the number of registered UEs + or established PDU sessions per network slice) +type: object +properties: + supportUeSAC: + description: | + Indicates the service capability of the NSACF to monitor and control the number of + registered UEs per network slice for the network slice that is subject to NSAC + true: Supported + false (default): Not Supported + type: boolean + default: false + supportPduSAC: + description: | + Indicates the service capability of the NSACF to monitor and control the number of + established PDU sessions per network slice for the network slice that is subject to NSAC + true: Supported + false (default): Not Supported + type: boolean + default: false + supportUeWithPduSAC: + description: | + Indicates the service capability of the NSACF to control the number of registered UEs + with at least one PDU session / PDN connection per network slice for the network slice + that is subject to NSAC, if EPS counting is supported by the NSACF. + true: Supported + false (default): Not Supported + type: boolean + default: false + +DccfCond: + description: > + Subscription to a set of NF Instances (DCCFs), identified by NF types, NF Set Id(s) + or DCCF Serving Area information, i.e. list of TAIs served by the DCCF + type: object + required: + - conditionType + properties: + conditionType: + type: string + enum: [ DCCF_COND ] + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + servingNfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + servingNfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + +MIAnalyticsInfo: + description: ML Analytics Filter information supported by the Nnwdaf_MLModelProvision service + type: object + properties: + mlAnalyticsIds: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEvent' + minItems: 1 + snssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + trackingAreaList: +``` + +``` +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' +minItems: 1 +mlModelInterInfo: + $ref: '#/components/schemas/MlModelInterInfo' +flCapabilityType: + $ref: '#/components/schemas/FlCapabilityType' +flTimeInterval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +nfTypeList: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 +nfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + +MbSmfInfo: + description: Information of an MB-SMF NF Instance + type: object + properties: + sNssaiInfoList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/SnssaiMbSmfInfoItem' + minProperties: 1 + tmgiRangeList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/TmgiRange' + minProperties: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + mbsSessionList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/MbsSession' + minProperties: 1 + +TmgiRange: + description: Range of TMGIs + type: object + required: + - mbsServiceIdStart + - mbsServiceIdEnd + - plmnId + properties: + mbsServiceIdStart: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + mbsServiceIdEnd: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + nid: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Nid' + +MbsSession: + description: MBS Session currently served by an MB-SMF + type: object + required: + - mbsSessionId + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' +``` + +``` +mbsAreaSessions: + description: A map (list of key-value pairs) where the key identifies an areaSessionId + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsServiceAreaInfo' + minProperties: 1 + +SnssaiMbSmfInfoItem: + description: Parameters supported by an MB-SMF for a given S-NSSAI + type: object + required: + - sNssai + - dnnInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnInfoList: + type: array + items: + $ref: '#/components/schemas/DnnMbSmfInfoItem' + minItems: 1 + +DnnMbSmfInfoItem: + description: Parameters supported by an MB-SMF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + +TsctsFInfo: + description: Information of a TSCTSF NF Instance + type: object + properties: + sNssaiInfoList: + description: A map (list of key-value pairs) where a valid JSON string serves as key + additionalProperties: + $ref: '#/components/schemas/SNSSAI_TsctsFInfoItem' + minProperties: 1 + externalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + internalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/InternalGroupIdRange' + minItems: 1 + +SnssaiTsctsFInfoItem: + description: Set of parameters supported by TSCTSF for a given S-NSSAI + type: object + required: + - sNssai + - dnnInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnInfoList: + type: array + items: + $ref: '#/components/schemas/DnnTsctsFInfoItem' + minItems: 1 + +DnnTsctsFInfoItem: +``` + +``` +description: Parameters supported by an TSCTSF for a given DNN +type: object +required: +- dnn +properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + +MbUpfInfo: +description: Information of an MB-UPF NF Instance +type: object +required: +- sNssaiMbUpfInfoList +properties: + sNssaiMbUpfInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiUpfInfoItem' + minItems: 1 + mbSmfServingArea: + type: array + items: + type: string + minItems: 1 + interfaceMbUpfInfoList: + type: array + items: + $ref: '#/components/schemas/InterfaceUpfInfoItem' + minItems: 1 + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + priority: + type: integer + minimum: 0 + maximum: 65535 + supportedPfcpFeatures: + type: string + +UnTrustAfInfo: +description: Information of a untrusted AF Instance +type: object +required: +- afId +properties: + afId: + type: string + sNssaiInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiInfoItem' + minItems: 1 + mappingInd: + type: boolean + default: false + +TrustAfInfo: +description: Information of a trusted AF Instance +type: object +properties: + sNssaiInfoList: + type: array + items: + $ref: '#/components/schemas/SnssaiInfoItem' + minItems: 1 + afEvents: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent' +``` + +``` + minItems: 1 + appIds: + type: array + items: + type: string + minItems: 1 + internalGroupId: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + mappingInd: + type: boolean + default: false + tailList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + +SnssaiInfoItem: + description: > + Parameters supported by an NF for a given S-NSSAI Set of parameters supported by NF + for a given S-NSSAI + type: object + required: + - sNssai + - dnnInfoList + properties: + sNssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + dnnInfoList: + type: array + items: + $ref: '#/components/schemas/DnnInfoItem' + minItems: 1 + +DnnInfoItem: + description: Set of parameters supported by NF for a given DNN + type: object + required: + - dnn + properties: + dnn: + anyOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/WildcardDnn' + +CollocatedNfInstance: + description: Information of an collocated NF Instance registered in the NRF + type: object + required: + - nfInstanceId + - nfType + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfType: + $ref: '#/components/schemas/CollocatedNfType' + +CollocatedNfType: + description: NF types for a collocated NF + anyOf: + - type: string + enum: + - UPF + - SMF + - MB_UPF + - MB_SMF + - type: string + +PlmnOAuth2: + description: OAuth2.0 required indication for a given PLMN ID +``` + +``` +type: object +properties: + oauth2RequiredPlmnIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + oauth2NotRequiredPlmnIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + +V2xCapability: + description: Indicate the supported V2X Capability by the PCF. + type: object + properties: + lteV2x: + type: boolean + default: false + nrV2x: + type: boolean + default: false + +NssaaInfo: + description: Information of a NSSAAF Instance + type: object + properties: + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + internalGroupIdentifiersRanges: + type: array + items: + $ref: '#/components/schemas/InternalGroupIdRange' + minItems: 1 + +ProSeCapability: + description: Indicate the supported ProSe Capability by the PCF. + type: object + properties: + proseDirectDiscover: + type: boolean + default: false + proseDirectCommunication: + type: boolean + default: false + proseL2UetoNetworkRelay: + type: boolean + default: false + proseL3UetoNetworkRelay: + type: boolean + default: false + proseL2RemoteUe: + type: boolean + default: false + proseL3RemoteUe: + type: boolean + default: false + proseL2UetoUeRelay: + type: boolean + default: false + proseL3UetoUeRelay: + type: boolean + default: false + proseL2EndUe: + type: boolean + default: false + proseL3EndUe: + type: boolean + default: false + +SubscriptionContext: + description: > + Context data related to a created subscription, to be included in notifications sent by NRF + type: object +``` + +``` + required: + - subscriptionId + properties: + subscriptionId: + type: string + subscrCond: + $ref: '#/components/schemas/SubscrCond' + + IwmscInfo: + description: Information of an SMS-IWMSC NF Instance + type: object + properties: + msisdnRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + supiRanges: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + scNumber: + type: string + pattern: '^[0-9]{5,15}$' + + MnpfInfo: + description: Information of an MNPF Instance + type: object + properties: + msisdnRanges: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + required: + - msisdnRanges + + DefSubServiceInfo: + description: Service Specific information for Default Notification Subscription. + type: object + properties: + versions: + type: array + items: + type: string + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + LocalityDescriptionItem: + description: Locality description item + type: object + properties: + localityType: + $ref: '#/components/schemas/LocalityType' + localityValue: + type: string + required: + - localityType + - localityValue + + LocalityDescription: + description: Locality description + type: object + properties: + localityType: + $ref: '#/components/schemas/LocalityType' + localityValue: + type: string + addlLocDescItems: + type: array + items: +``` + +``` +$ref: '#/components/schemas/LocalityDescriptionItem' +minItems: 1 +required: +- localityType +- localityValue + +LocalityType: +description: > +Type of locality description. An operator may define custom locality type values other +than those listed in this enumeration. +anyOf: +- type: string +enum: +- DATA_CENTER +- CITY +- COUNTY +- DISTRICT +- STATE +- CANTON +- REGION +- PROVINCE +- PREFECTURE +- COUNTRY +- type: string + +SmsfInfo: +description: Specific Data for SMSF +type: object +properties: +roamingUeInd: +type: boolean +remotePlmnRangeList: +type: array +items: +$ref: '#/components/schemas/PlmnRange' +minItems: 1 + +DcsfInfo: +description: Information of a DCSF NF Instance +type: object +properties: +imsDomainNameList: +type: array +items: +$ref: '#/components/schemas/ImsDomainName' +imsiRanges: +type: array +items: +$ref: '#/components/schemas/ImsiRange' +minItems: 1 +imsPrivateIdentityRanges: +type: array +items: +$ref: '#/components/schemas/IdentityRange' +minItems: 1 +imsPublicIdentityRanges: +type: array +items: +$ref: '#/components/schemas/IdentityRange' +minItems: 1 +msisdnRanges: +type: array +items: +$ref: '#/components/schemas/IdentityRange' +minItems: 1 + +ImsDomainName: +description: IMS Domain Name +type: string + +MLModelInterInfo: +description: ML Model Interoperability Information +type: object +properties: +vendorList: +type: array +items: +$ref: '#/components/schemas/VendorId' +``` + +``` +minItems: 1 + +PruExistenceInfo: + description: PRU Existence Information + type: object + properties: + tailList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + +FlCapabilityType: + description: > + Type of Federated Learning Capability. + anyOf: + - type: string + enum: + - FL_SERVER + - FL_CLIENT + - FL_SERVER_AND_CLIENT + - type: string + +MrfInfo: + description: Information of a Mrf NF Instance + type: object + properties: + mediaCapabilityList: + type: array + items: + $ref: '#/components/schemas/MediaCapability' + minItems: 1 + +MrfpInfo: + description: Information of a Mrfp NF Instance + type: object + properties: + mediaCapabilityList: + type: array + items: + $ref: '#/components/schemas/MediaCapability' + minItems: 1 + +MfInfo: + description: Information of a MF NF Instance + type: object + properties: + mediaCapabilityList: + type: array + items: + $ref: '#/components/schemas/MediaCapability' + minItems: 1 + +EpdgInfo: + description: Information of the ePDG end-points + type: object + anyOf: + - required: [ ipv4EndpointAddresses ] + - required: [ ipv6EndpointAddresses ] + properties: + ipv4EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6EndpointAddresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + +MediaCapability: + description: media capability offered by NF instance +``` + +``` +type: string +pattern: '^[a-zA-Z0-9_-]+$' + +A2xCapability: + description: Indicate the supported A2X Capability by the PCF. + type: object + properties: + lteA2x: + type: boolean + default: false + nrA2x: + type: boolean + default: false + +RuleSet: + type: object + required: + - priority + - action + properties: + priority: + type: integer + minimum: 0 + maximum: 65535 + plmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + snpns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + nfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + nfDomains: + type: array + items: + type: string + minItems: 1 + nssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + nfInstances: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + scopes: + type: array + items: + type: string + minItems: 1 + action: + $ref: '#/components/schemas/RuleSetAction' + +RuleSetAction: + anyOf: + - type: string + enum: + - ALLOW + - DENY + - type: string + +AdrfInfo: + description: Information of an ADRF NF Instance + type: object + properties: + mlModelStorageInd: + type: boolean + default: false + dataStorageInd: + type: boolean +``` + +``` +default: false + +SelectionConditions: + description: > + It contains the set of conditions that shall be evaluated to determine whether a consumer + shall select a given producer. The producer shall only be selected if the evaluation of + the conditions is . The set of conditions can be represented by a single + ConditionItem or by a ConditionGroup, where the latter contains a (recursive) list of + conditions joined by the "and" or "or" logical relationships. + oneOf: + - $ref: '#/components/schemas/ConditionItem' + - $ref: '#/components/schemas/ConditionGroup' + +ConditionGroup: + description: > + List (array) of conditions (joined by the "and" or "or" logical relationship), + under which an NF Instance with an NFStatus or NFServiceStatus value set to "CANARY_RELEASE" + shall be selected by an NF Service Consumer. + type: object + oneOf: + - required: [ and ] + - required: [ or ] + properties: + and: + type: array + items: + $ref: '#/components/schemas/SelectionConditions' + minItems: 1 + or: + type: array + items: + $ref: '#/components/schemas/SelectionConditions' + minItems: 1 + +ConditionItem: + description: > + A ConditionItem consists of a number of attributes representing individual conditions + (e.g. a SUPI range, or a TAI list). If several attributes/conditions are present, + the evaluation of the ConditionItem is if all attributes/conditions are evaluated + as (i.e., it follows the AND logical relationship). + type: object + properties: + consumerNfTypes: + type: array + items: + $ref: '#/components/schemas/NFType' + minItems: 1 + serviceFeature: + type: integer + minimum: 1 + vsServiceFeature: + type: integer + minimum: 1 + supiRangeList: + type: array + items: + $ref: '#/components/schemas/SupiRange' + minItems: 1 + gpsiRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + impuRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + impiRangeList: + type: array + items: + $ref: '#/components/schemas/IdentityRange' + minItems: 1 + peiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + minItems: 1 +``` + +``` + + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + minItems: 1 + dnnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + +CallbackUriPrefixItem: + description: callback URI prefix value to be used for specific notification types + type: object + properties: + callbackUriPrefix: + type: string + notificationTypes: + type: array + items: + type: string + required: + - callbackUriPrefix + - notificationTypes + +``` + +## A.3 Nnrf\_NFDiscovery API + +openapi: 3.0.0 + +``` + +info: + version: '1.3.0-alpha.6' + title: 'NRF NFDiscovery Service' + description: | + NRF NFDiscovery Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.510 V18.5.0; 5G System; Network Function Repository Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' + +servers: + - url: '{apiRoot}/nnrf-disc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnrf-disc + - oAuth2ClientCredentials: + - nnrf-disc + - nnrf-disc:nf-instances:read-complete-profile + +paths: + /nf-instances: + get: + summary: Search a collection of NF Instances + operationId: SearchNFInstances + tags: + - NF Instances (Store) + parameters: + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + - name: target-nf-type + in: query + description: Type of the target NF + required: true + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + +``` + +- name: requester-nf-type +in: query +description: Type of the requester NF +required: true +schema: +\$ref: 'TS29510\_Nnrf\_NFManagement.yaml#/components/schemas/NFType' +- name: preferred-collocated-nf-types +in: query +description: collocated NF types that candidate NFs should preferentially support +schema: +type: array +items: +\$ref: 'TS29510\_Nnrf\_NFManagement.yaml#/components/schemas/CollocatedNFType' +minItems: 1 +style: form +explode: false +- name: requester-nf-instance-id +in: query +description: NfInstanceId of the requester NF +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/NfInstanceId' +- name: service-names +in: query +description: Names of the services offered by the NF +schema: +type: array +items: +\$ref: 'TS29510\_Nnrf\_NFManagement.yaml#/components/schemas/ServiceName' +minItems: 1 +uniqueItems: true +style: form +explode: false +- name: requester-nf-instance-fqdn +in: query +description: FQDN of the requester NF +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Fqdn' +- name: target-plmn-list +in: query +description: > +Id of the PLMN of either the target NF, or in SNPN scenario the Credentials Holder +in the PLMN +content: +application/json: +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnId' +minItems: 1 +- name: requester-plmn-list +in: query +description: Id of the PLMN where the NF issuing the Discovery request is located +content: +application/json: +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnId' +minItems: 1 +- name: target-nf-instance-id +in: query +description: Identity of the NF instance being discovered +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/NfInstanceId' +- name: target-nf-instance-id-list +in: query +description: Identities of the NF instances being discovered +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/NfInstanceId' +minItems: 2 +style: form +explode: false +- name: target-nf-fqdn +in: query +description: FQDN of the NF instance being discovered +schema: + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +- name: hnrf-uri + in: query + description: Uri of the home NRF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +- name: snssais + in: query + description: Slice info of the target NF + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + minItems: 1 +- name: additional-snssais + in: query + description: Additional Slices supported by the target NF (Service) instances + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +- name: requester-snssais + in: query + description: Slice info of the requester NF + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +- name: plmn-specific-snssai-list + in: query + description: PLMN specific Slice info of the target NF + content: + application/json: + schema: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai' + minItems: 1 +- name: requester-plmn-specific-snssai-list + in: query + description: PLMN-specific slice info of the NF issuing the Discovery request + content: + application/json: + schema: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai' + minItems: 1 +- name: dnn + in: query + description: Dnn supported by the BSF, SMF or UPF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +- name: ipv4-index + in: query + description: The IPv4 Index supported by the candidate UPF. + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex' +- name: ipv6-index + in: query + description: The IPv6 Index supported by the candidate UPF. + content: + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/IpIndex' +- name: nsi-list + in: query + description: NSI IDs that are served by the services being discovered +``` + +``` +schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false +- name: smf-serving-area + in: query + schema: + type: string +- name: mbsmf-serving-area + in: query + schema: + type: string +- name: tai + in: query + description: Tracking Area Identity + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' +- name: amf-region-id + in: query + description: AMF Region Identity + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfRegionId' +- name: amf-set-id + in: query + description: AMF Set Identity + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AmfSetId' +- name: guami + in: query + description: Guami used to search for an appropriate AMF + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' +- name: supi + in: query + description: SUPI of the user + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +- name: ue-ipv4-address + in: query + description: IPv4 address of the UE + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' +- name: ip-domain + in: query + description: IP domain of the UE, which supported by BSF + schema: + type: string +- name: ue-ipv6-prefix + in: query + description: IPv6 prefix of the UE + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' +- name: pgw-ind + in: query + description: Combined PGW-C and SMF or a standalone SMF + schema: + type: boolean +- name: preferred-pgw-ind + in: query + description: Indicates combined PGW-C+SMF or standalone SMF are preferred + schema: + type: boolean +- name: pgw + in: query + description: PGW FQDN of a combined PGW-C and SMF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +- name: pgw-ip + in: query + description: PGW IP Address of a combined PGW-C and SMF + content: +``` + +``` + + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddress' +- name: gpsi + in: query + description: GPSI of the user + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' +- name: external-group-identity + in: query + description: external group identifier of the user + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' +- name: internal-group-identity + in: query + description: internal group identifier of the user + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' +- name: pfd-data + in: query + description: PFD data + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PfdData' +- name: data-set + in: query + description: data set supported by the NF + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DataSetId' +- name: routing-indicator + in: query + description: routing indicator in SUCI + schema: + type: string + pattern: '^[0-9]{1,4}$' +- name: group-id-list + in: query + description: Group IDs of the NFs being discovered + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfGroupId' + minItems: 1 + style: form + explode: false +- name: dnai-list + in: query + description: Data network access identifiers of the NFs being discovered + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + style: form + explode: false +- name: pdu-session-types + in: query + description: list of PDU Session Type required to be supported by the target NF + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + style: form + explode: false +- name: event-id-list + in: query + description: > + Analytics event(s) requested to be supported by the Nnwdaf_AnalyticsInfo service + schema: + type: array + items: + $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventId' + minItems: 1 + style: form + explode: false +- name: nwdaf-event-list + +``` + +``` +in: query +description: > + Analytics event(s) requested to be supported by the Nnwdaf_EventsSubscription service. +schema: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + minItems: 1 + style: form + explode: false +- name: upf-event-list + in: query + description: > + Event(s) requested to be supported by the Nupf_EventExposure service. + schema: + type: array + items: + $ref: 'TS29564_Nupf_EventExposure.yaml#/components/schemas/EventType' + minItems: 1 + style: form + explode: false +- name: supported-features + in: query + description: Features required to be supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: upf-iwk-eps-ind + in: query + description: UPF supporting interworking with EPS or not + schema: + type: boolean +- name: chf-supported-plmn + in: query + description: PLMN ID supported by a CHF + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +- name: preferred-locality + in: query + description: preferred target NF location + schema: + type: string +- name: ext-preferred-locality + in: query + description: > + preferred target NF location + A map (list of key-value pairs) where the key of the map represents the relative + priority, for the requester, of each locality description among the list of locality + descriptions in this query parameter, encoded as "1" (highest priority), "2", "3", ..., + "n" (lowest priority) + content: + application/json: + schema: + type: object + additionalProperties: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/LocalityDescription' + minItems: 1 + minProperties: 1 +- name: access-type + in: query + description: AccessType supported by the target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' +- name: limit + in: query + description: Maximum number of NFProfiles to return in the response + required: false + schema: + type: integer + minimum: 1 +- name: required-features + in: query + description: Features required to be supported by the target NF + schema: + type: array +``` + +``` +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +minItems: 1 +style: form +explode: false +- name: complex-query + in: query + description: the complex query condition expression + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ComplexQuery' +- name: max-payload-size + in: query + description: Maximum content size of the response expressed in kilo octets + required: false + schema: + type: integer + maximum: 2000 + default: 124 +- name: max-payload-size-ext + in: query + description: > + Extended query for maximum content size of the response expressed in kilo octets + required: false + schema: + type: integer + default: 124 +- name: atsss-capability + in: query + description: ATSSS Capability + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AtsssCapability' +- name: upf-ue-ip-addr-ind + in: query + description: UPF supporting allocating UE IP addresses/prefixes + schema: + type: boolean +- name: client-type + in: query + description: Requested client type served by the NF + content: + application/json: + schema: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType' +- name: lmf-id + in: query + description: LMF identification to be discovered + content: + application/json: + schema: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification' +- name: an-node-type + in: query + description: Requested AN node type served by the NF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AnNodeType' +- name: rat-type + in: query + description: Requested RAT type served by the NF + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +- name: preferred-tai + in: query + description: preferred Tracking Area Identity + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' +- name: preferred-nf-instances + in: query + description: preferred NF Instances +``` + +``` +schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + style: form + explode: false +- name: If-None-Match + in: header + description: Validator for conditional requests, as described in IETF RFC 9110, 13.1.2 + schema: + type: string +- name: target-snpn + in: query + description: Target SNPN Identity, or the Credentials Holder in the SNPN + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' +- name: requester-snpn-list + in: query + description: SNPN ID(s) of the NF instance issuing the Discovery request + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 +- name: af-ee-data + in: query + description: NEF exposured by the AF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AfEventExposureData' +- name: w-agf-info + in: query + description: UPF collocated with W-AGF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/WAgfInfo' +- name: tngf-info + in: query + description: UPF collocated with TNGF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TngfInfo' +- name: twif-info + in: query + description: UPF collocated with TWIF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TwifInfo' +- name: upf-select-epdg-info + in: query + description: The ePDG information to find a preferred UPF + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/EpdgInfo' +- name: target-nf-set-id + in: query + description: Target NF Set ID + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +- name: target-nf-service-set-id + in: query + description: Target NF Service Set ID + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' +- name: nef-id + in: query + description: NEF ID + schema: +``` + +``` + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NefId' +- name: notification-type + in: query + description: Notification Type + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NotificationType' +- name: n1-msg-class + in: query + description: N1 Message Class + schema: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N1MessageClass' +- name: n2-info-class + in: query + description: N2 Information Class + schema: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/N2InformationClass' +- name: serving-scope + in: query + description: areas that can be served by the target NF + schema: + type: array + items: + type: string + minItems: 1 + style: form + explode: false +- name: imsi + in: query + description: IMSI of the requester UE to search for an appropriate NF (e.g. HSS, DCSF) + schema: + type: string + pattern: '^[0-9]{5,15}$' +- name: ims-private-identity + in: query + description: IMPI of the requester UE to search for a target HSS or DCSF + schema: + type: string +- name: ims-public-identity + in: query + description: IMS Public Identity of the requester UE to search for a target HSS or DCSF + schema: + type: string +- name: msisdn + in: query + description: MSISDN of the requester UE to search for a target HSS or DCSF + schema: + type: string +- name: preferred-api-versions + in: query + description: Preferred API version of the services to be discovered + content: + application/json: + schema: + description: A map (list of key-value pairs) where ServiceName serves as key + type: object + additionalProperties: + type: string + minProperties: 1 +- name: v2x-support-ind + in: query + description: PCF supports V2X + schema: + type: boolean +- name: redundant-gtpu + in: query + description: UPF supports redundant gtp-u to be discovered + schema: + type: boolean +- name: redundant-transport + in: query + description: UPF supports redundant transport path to be discovered + schema: + type: boolean +- name: ipups + in: query + description: UPF which is configured for IPUPS functionality to be discovered + schema: + type: boolean +``` + +- name: sxa-ind +in: query +description: UPF which is configured to support sxa interface +schema: +type: boolean +- name: scp-domain-list +in: query +description: SCP domains the target SCP or SEPP belongs to +schema: +type: array +items: +type: string +minItems: 1 +style: form +explode: false +- name: address-domain +in: query +description: Address domain reachable through the SCP +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Fqdn' +- name: ipv4-addr +in: query +description: IPv4 address reachable through the SCP +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv4Addr' +- name: ipv6-prefix +in: query +description: IPv6 prefix reachable through the SCP +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv6Prefix' +- name: served-nf-set-id +in: query +description: NF Set ID served by the SCP +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/NfSetId' +- name: remote-plmn-id +in: query +description: Id of the PLMN reachable through the SCP or SEPP +content: +application/json: +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnId' +- name: remote-snpn-id +in: query +description: Id of the SNPN reachable through the SCP or SEPP +content: +application/json: +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/PlmnIdNid' +- name: data-forwarding +in: query +description: UPF Instance(s) configured for data forwarding are requested +schema: +type: boolean +- name: preferred-full-plmn +in: query +description: NF Instance(s) serving the full PLMN are preferred +schema: +type: boolean +- name: requester-features +in: query +description: > +Features supported by the NF Service Consumer that is invoking +the Nnrf\_NFDiscovery service +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: realm-id +in: query +description: realm-id to search for an appropriate UDSF +schema: +type: string +- name: storage-id +in: query +description: storage-id to search for an appropriate UDSF +schema: +type: string +- name: vsmf-support-ind +in: query + +``` + +description: V-SMF capability supported by the target NF instance(s) +schema: + type: boolean +- name: ismf-support-ind + in: query + description: I-SMF capability supported by the target NF instance(s) + schema: + type: boolean +- name: nrf-disc-uri + in: query + description: Uri of the NRF holding the NF profile of a target NF Instance + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +- name: preferred-vendor-specific-features + in: query + description: Preferred vendor specific features of the services to be discovered + content: + application/json: + schema: + description: A map (list of key-value pairs) where ServiceName serves as key + type: object + additionalProperties: + description: > + A map (list of key-value pairs) where IANA-assigned SMI Network Management + Private Enterprise Codes serves as key + type: object + additionalProperties: + type: array + items: + $ref: + 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 + maxProperties: 1 +- name: preferred-vendor-specific-nf-features + in: query + description: Preferred vendor specific features of the network function to be discovered + content: + application/json: + schema: + description: > + A map (list of key-value pairs) where IANA-assigned SMI Network Management Private + Enterprise Codes serves as key + type: object + additionalProperties: + type: array + items: + $ref: + 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 + maxProperties: 1 +- name: required-pfcp-features + in: query + description: PFCP features required to be supported by the target UPF + schema: + type: string +- name: home-pub-key-id + in: query + description: > + Indicates the Home Network Public Key ID which shall be able to be served + by the NF instance + schema: + type: integer +- name: prose-support-ind + in: query + description: PCF supports ProSe Capability + schema: + type: boolean +- name: analytics-aggregation-ind + in: query + description: analytics aggregation is supported by NWDAF or not + schema: + type: boolean +- name: serving-nf-set-id + in: query + description: NF Set Id served by target NF + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + +``` + +- name: serving-nf-type +in: query +description: NF type served by the target NF +schema: +\$ref: 'TS29510\_Nnrf\_NFManagement.yaml#/components/schemas/NFType' +- name: ml-analytics-info-list +in: query +description: List of ML Analytics Filter information of Nnwdaf\_ModelProvision service +content: +application/json: +schema: +type: array +items: +\$ref: 'TS29510\_Nnrf\_NFManagement.yaml#/components/schemas/MLAnalyticsInfo' +minItems: 1 +- name: analytics-metadata-prov-ind +in: query +description: analytics metadata provisioning is supported by NWDAF or not +schema: +type: boolean +- name: nsacf-capability +in: query +description: the service capability supported by the target NSACF +schema: +\$ref: 'TS29510\_Nnrf\_NFManagement.yaml#/components/schemas/NsacfCapability' +- name: mbs-session-id-list +in: query +description: List of MBS Session ID(s) +content: +application/json: +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/MbsSessionId' +minItems: 1 +- name: area-session-id +in: query +description: Area Session ID +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/AreaSessionId' +- name: gmlc-number +in: query +description: The GMLC Number supported by the GMLC +schema: +type: string +pattern: '^[0-9]{5,15}\$' +- name: upf-n6-ip +in: query +description: N6 IP address of PSA UPF supported by the EASDF +content: +application/json: +schema: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/IpAddress' +- name: tai-list +in: query +description: Tracking Area Identifiers of the NFs being discovered +content: +application/json: +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Tai' +minItems: 1 +- name: nf-tai-list-ind +in: query +description: the NF service consumer supports candidate nfs supporting a subset of TAIs +schema: +type: boolean +enum: +- true +- name: preferences-precedence +in: query +description: > +Indicates the precedence of the preference query parameters (from higher to lower) +schema: +type: array +items: +type: string + +``` + minItems: 2 + style: form + explode: false +- name: support-onboarding-capability + in: query + description: Indicating the support for onboarding. + schema: + type: boolean + default: false +- name: uas-nf-functionality-ind + in: query + description: UAS NF functionality is supported by NEF or not + schema: + type: boolean +- name: multi-mem-af-sess-qos-ind + in: query + description: Multi-member AF session with required QoS is supported by NEF or not + schema: + type: boolean + enum: + - true +- name: member-ue-sel-assist-ind + in: query + description: member UE selection assistance functionality is supported by NEF or not + schema: + type: boolean + enum: + - true +- name: v2x-capability + in: query + description: indicates the V2X capability that the target PCF needs to support. + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/V2xCapability' +- name: prose-capability + in: query + description: indicates the ProSe capability that the target PCF needs to support. + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ProSeCapability' +- name: shared-data-id + in: query + description: Identifier of shared data stored in the NF being discovered + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SharedDataId' +- name: target-hni + in: query + description: Home Network Identifier query. + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +- name: target-nw-resolution + in: query + description: Resolution of the identity of the target PLMN based on the GPSI of the UE + schema: + type: boolean +- name: exclude-nfinst-list + in: query + description: NF Instance IDs to be excluded from the NF Discovery procedure + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + style: form + explode: false +- name: exclude-nfservinst-list + in: query + description: NF service instance IDs to be excluded from the NF Discovery procedure + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NfServiceInstance' + minItems: 1 +- name: exclude-nfserviceset-list +``` + +``` +in: query +description: NF Service Set IDs to be excluded from the NF Discovery procedure +schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + minItems: 1 + style: form + explode: false +- name: exclude-nfset-list + in: query + description: NF Set IDs to be excluded from the NF Discovery procedure + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + style: form + explode: false +- name: preferred-analytics-delays + in: query + description: Preferred analytics delays supported by the NWDAF to be discovered + content: + application/json: + schema: + description: > + A map (list of key-value pairs) where EventId or NwdafEvent serves as key + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + minProperties: 1 +- name: high-latency-com + in: query + description: Indicating the support for High Latency communication. + schema: + type: boolean + enum: + - true +- name: nsac-sai + in: query + description: NSAC Service Area Identifier + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NsacSai' +- name: complete-profile + in: query + description: request to discover the complete profile of NF instances + schema: + type: boolean + enum: + - true +- name: n32-purposes + in: query + description: N32 purposes to be supported by the SEPP + schema: + type: array + items: + $ref: 'TS29573_N32_Handshake.yaml#/components/schemas/N32Purpose' + minItems: 1 + style: form + explode: false +- name: preferred-features + in: query + description: Preferred features to be supported by the target Network Function. + content: + application/json: + schema: + description: > + A map (list of key-value pairs) where Service Name serves as the key. + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + minProperties: 1 +- name: remote-plmn-id-roaming + in: query + description: Id of the remote PLMN served by the target NF service producer + content: + application/json: + schema: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +- name: pru-tai + in: query + description: LMF(s) serving the TAI with PRU(s) existence + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' +- name: pru-support-ind + in: query + description: Indicating the support of PRU function + schema: + type: boolean +- name: af-data + in: query + description: events supported by the trusted AFs being discovered + content: + application/json: + schema: + $ref: '#/components/schemas/AfData' +- name: ml-accuracy-checking-ind + in: query + description: Indicating the support for ML Model Accuracy checking. + schema: + type: boolean + enum: + - true +- name: analytics-accuracy-checking-ind + in: query + description: Indicating the support for Analytics Accuracy checking. + schema: + type: boolean + enum: + - true +- name: a2x-support-ind + in: query + description: PCF supports A2X + schema: + type: boolean +- name: a2x-capability + in: query + description: indicates the A2X capability that the target PCF needs to support. + content: + application/json: + schema: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/A2xCapability' +- name: ml-model-storage-ind + in: query + description: Indicating the support for ML model storage and retrieval capability. + schema: + type: boolean + enum: + - true +- name: data-storage-ind + in: query + description: > + Indicating the support for data and analytics storage and retrieval capability. + schema: + type: boolean + enum: + - true +- name: data-subscription-relocation-support-ind + in: query + description: Indicating the support for relocation of data subscription. + schema: + type: boolean + enum: + - true +- name: ims-domain-name + in: query + description: Indicating the IMS domain name to search for a target DCSF. + schema: + type: string +- name: media-capability-list + in: query + description: Indicating the media capability list to search for a target MF, MRF or MRFP. + schema: + type: array +``` + +``` + + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MediaCapability' + minItems: 1 + style: form + explode: false +- name: roaming-exchange-ind + in: query + description: Indicating the support for roaming exchange. + schema: + type: boolean + enum: + - true +- name: ranging-sl-pos-support-ind + in: query + description: PCF or LMF supports ranging and sidelink positioning Capability + schema: + type: boolean + enum: + - true +- name: preferred-up-positioning-ind + in: query + description: LMF supporting user plane positioning capability + schema: + type: boolean + enum: + - true +- name: complete-search-result + in: query + description: > + Indicates that all the NF profiles or NF Instance IDs matching the query parameters + are requested to be returned + schema: + type: boolean + enum: + - true + +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SearchResult' + links: + search: + operationId: RetrieveStoredSearch + parameters: + searchId: $response.body#/searchId + description: > + The 'searchId' parameter returned in the response can be used as the + 'searchId' parameter in the GET request to '/searches/{searchId}' + completeSearch: + operationId: RetrieveCompleteSearch + parameters: + searchId: $response.body#/searchId + description: > + The 'searchId' parameter returned in the response can be used as the + 'searchId' parameter in the GET request to '/searches/{searchId}/complete' + headers: + Cache-Control: + description: Cache-Control containing max-age, described in IETF RFC 9111, 5.2 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + 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 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' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'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' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/searches/{searchId}: + get: + operationId: RetrieveStoredSearch + tags: + - Stored Search (Document) + parameters: + - $ref: '#/components/parameters/searchId' + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + responses: + '200': + $ref: '#/components/responses/200' + '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 + +/searches/{searchId}/complete: +get: + operationId: RetrieveCompleteSearch + tags: + - Complete Stored Search (Document) + parameters: + - $ref: '#/components/parameters/searchId' + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + responses: + '200': + $ref: '#/components/responses/200' + '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 + +/scp-domain-routing-info: +get: + operationId: SCPDomainRoutingInfoGet + tags: + - SCP Domain Routing Information (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-disc + - oAuth2ClientCredentials: + - nnrf-disc + - nnrf-disc:scp-domain:read + parameters: + - name: local + in: query + description: Indication of local SCP Domain Routing Information + required: false + schema: + type: boolean + default: false + - name: Accept-Encoding + in: header + description: Accept-Encoding, described in IETF RFC 9110 + schema: + type: string + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + +``` + +``` + + $ref: '#/components/schemas/ScpDomainRoutingInformation' +headers: + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string +'307': + description: Temporary Redirect + 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' +'406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' +'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' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/scp-domain-routing-info-subs: + post: + summary: Create a new subscription + operationId: ScpDomainRoutingInfoSubscribe + tags: + - SCP Domain Routing Information Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-disc + - oAuth2ClientCredentials: + - nnrf-disc + - nnrf-disc:scp-domain-subs:write + parameters: + - 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: + content: + application/json: + schema: + $ref: '#/components/schemas/ScpDomainRoutingInfoSubscription' + required: true + responses: + '201': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/ScpDomainRoutingInfoSubscription' + +``` + +``` + +headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nnrf-disc/v1/scp-domain-routing-info-subs/{subscriptionID} + required: true + schema: + type: string + 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 +'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' +'503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + onScpDomainRoutingInformationChange: + '{ $request.body#/callbackUri }': + post: + parameters: + - name: Content-Encoding + in: header + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + requestBody: + description: Notification content + content: + application/json: + schema: + $ref: '#/components/schemas/ScpDomainRoutingInfoNotification' +responses: + '204': + description: Expected response to a successful callback processing + headers: + Accept-Encoding: + description: Accept-Encoding, described in IETF RFC 9110 + 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' + '501': + $ref: 'TS29571_CommonData.yaml#/components/responses/501' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/scp-domain-routing-info-subs/{subscriptionID}: + delete: + summary: Deletes a subscription + operationId: ScpDomainRoutingInfoUnsubscribe + tags: + - Individual SCP Domain Routing Information Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnrf-disc + - oAuth2ClientCredentials: + - nnrf-disc + - nnrf-disc:scp-domain-subs:write + parameters: + - name: subscriptionID + in: path + required: true + description: Unique ID of the subscription to remove + schema: + type: string + responses: + '204': + description: Expected response to a successful subscription removal + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '/oauth2/token' + scopes: + nnrf-disc: Access to the Nnrf_NFDiscovery API + nnrf-disc:scp-domain:read: Access to read the scp-domain-routing-info resource + nnrf-disc:scp-domain-subs:write: Access to create/delete a scp-domain subscription + +resource: + + nnrf-disc:nf-instances:read-complete-profile: > + Access to the Nnrf_NFDiscovery API enabling the discovery of the complete profile + of NF instances + +parameters: + searchId: + +``` + +``` +name: searchId +in: path +description: Id of a stored search +required: true +schema: + type: string + +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/StoredSearchResult' + headers: + Cache-Control: + description: Cache-Control containing max-age, described in IETF RFC 9111, 5.2 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + schema: + type: string + Content-Encoding: + description: Content-Encoding, described in IETF RFC 9110 + schema: + type: string + +schemas: + + SearchResult: + description: Contains the list of NF Profiles returned in a Discovery response + type: object + required: + - validityPeriod + - nfInstances + properties: + validityPeriod: + type: integer + nfInstances: + type: array + items: + $ref: '#/components/schemas/NFProfile' + completeNfInstances: + type: array + items: + $ref: '#/components/schemas/NFProfile' + minItems: 1 + searchId: + type: string + numNfInstComplete: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + preferredSearch: + $ref: '#/components/schemas/PreferredSearch' + nrfSupportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + nfInstanceList: + description: List of matching NF instances. The key of the map is the NF instance ID. + type: object + additionalProperties: + $ref: '#/components/schemas/NfInstanceInfo' + minProperties: 1 + searchResultInfo: + $ref: '#/components/schemas/SearchResultInfo' + alteredPriorityInd: + type: boolean + noProfileMatchInfo: + $ref: '#/components/schemas/NoProfileMatchInfo' + ignoredQueryParams: + type: array + items: + type: string + minItems: 1 + + StoredSearchResult: + description: > + Contains a complete search result (i.e. a number of discovered NF Instances), +``` + +``` + stored by NRF as a consequence of a prior search result +type: object +required: +- nfInstances +properties: + nfInstances: + type: array + items: + $ref: '#/components/schemas/NFProfile' + completeNfInstances: + type: array + items: + $ref: '#/components/schemas/NFProfile' + minItems: 1 + +NFProfile: + description: Information of an NF Instance discovered by the NRF + type: object + required: + - nfInstanceId + - nfType + - nfStatus + properties: + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfInstanceName: + type: string + nfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + nfStatus: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFStatus' + collocatedNfInstances: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/CollocatedNfInstance' + minItems: 1 + plmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + sNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 + perPlmnSnssaiList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai' + minItems: 1 + nsiList: + type: array + items: + type: string + minItems: 1 + fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + ipv4Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ipv6Addresses: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + allowedPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + allowedSnpns: + type: array + items: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' +minItems: 1 +allowedNfTypes: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' +minItems: 1 +allowedNfDomains: + type: array + items: + type: string +minItems: 1 +allowedNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' +minItems: 1 +allowedRuleSet: + description: A map (list of key-value pairs) where a valid JSON pointer Id serves as key + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/RuleSet' + minProperties: 1 +capacity: + type: integer + minimum: 0 + maximum: 65535 +load: + type: integer + minimum: 0 + maximum: 100 +loadTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +locality: + type: string +extLocality: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string serves + as key representing a type of locality + type: object + additionalProperties: + type: string + minProperties: 1 +priority: + type: integer + minimum: 0 + maximum: 65535 +udrInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdrInfo' +udrInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdrInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdrInfo' + minProperties: 1 +udmInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdmInfo' +udmInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdmInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdmInfo' + minProperties: 1 +ausfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AusfInfo' +ausfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AusfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AusfInfo' + minProperties: 1 +amfInfo: +``` + +``` +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AmfInfo' +amfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AmfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AmfInfo' + minProperties: 1 +smfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SmfInfo' +smfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of SmfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SmfInfo' + minProperties: 1 +upfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UpfInfo' +upfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UpfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UpfInfo' + minProperties: 1 +pcfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PcfInfo' +pcfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of PcfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PcfInfo' + minProperties: 1 +bsfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/BsfInfo' +bsfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of BsfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/BsfInfo' + minProperties: 1 +chfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ChfInfo' +chfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of ChfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ChfInfo' + minProperties: 1 +udsfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdsfInfo' +udsfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of UdsfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/UdsfInfo' + minProperties: 1 +nwdafInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NwdafInfo' +nwdafInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of NwdafInfo + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NwdafInfo' +``` + +``` + minProperties: 1 + nefInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NefInfo' + pcscfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of PscsfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PscsfInfo' + minProperties: 1 + hssInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of HssInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/HssInfo' + minProperties: 1 + customInfo: + type: object + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + nfServicePersistence: + type: boolean + default: false + nfServices: + deprecated: true + type: array + items: + $ref: '#/components/schemas/NFService' + minItems: 1 + nfServiceList: + description: > + A map (list of key-value pairs) where serviceInstanceId serves as key of NFService + type: object + additionalProperties: + $ref: '#/components/schemas/NFService' + minProperties: 1 + defaultNotificationSubscriptions: + type: array + items: + $ref: +'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DefaultNotificationSubscription' + lmfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/LmfInfo' + gmlcInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/GmlcInfo' + snpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + nfSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + servingScope: + type: array + items: + type: string + minItems: 1 + lcHSupportInd: + type: boolean + default: false + olcHSupportInd: + type: boolean + default: false + nfSetRecoveryTimeList: + description: A map (list of key-value pairs) where NfSetId serves as key of DateTime + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minProperties: 1 + serviceSetRecoveryTimeList: + description: > + A map (list of key-value pairs) where NfServiceSetId serves as key of DateTime +``` + +``` +type: object +additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +minProperties: 1 +scpDomains: +type: array +items: +type: string +minItems: 1 +scpInfo: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ScpInfo' +seppInfo: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SeppInfo' +vendorId: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorId' +supportedVendorSpecificFeatures: +description: > + The key of the map is the IANA-assigned SMI Network Management Private Enterprise Codes +type: object +additionalProperties: +type: array +items: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature' +minItems: 1 +minProperties: 1 +aanfInfoList: +type: object +description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AanfInfo +additionalProperties: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AanfInfo' +minProperties: 1 +mfafInfo: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MfafInfo' +easdfInfoList: +type: object +description: > + A map(list of key-value pairs) where a (unique) valid JSON string + serves as key of EasdfInfo +additionalProperties: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/EasdfInfo' +minProperties: 1 +dccfInfo: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DccfInfo' +nsacfInfoList: +description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of NsacfInfo +type: object +additionalProperties: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NsacfInfo' +minProperties: 1 +mbSmfInfoList: +description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MbSmfInfo +type: object +additionalProperties: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MbSmfInfo' +minProperties: 1 +tsctsfInfoList: +type: object +description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of TsctsfInfo +additionalProperties: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TsctsfInfo' +minProperties: 1 +mbUpfInfoList: +description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MbUpfInfo +type: object +additionalProperties: +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MbUpfInfo' +minProperties: 1 +trustAfInfo: +``` + +``` +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/TrustAfInfo' +nssaafInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NssaafInfo' +hniList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + minItems: 1 +iwmscInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IwmscInfo' +mnpfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MnpfInfo' +smssfInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SmsfInfo' +dcssfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of DcsfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DcsfInfo' +mrfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MrfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MrfInfo' +mrfpInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MrfpInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MrfpInfo' +mfInfoList: + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of MfInfo + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/MfInfo' +adrfInfoList: + type: object + description: > + A map (list of key-value pairs) where a (unique) valid JSON string + serves as key of AdrfInfo + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/AdrfInfo' + minProperties: 1 + selectionConditions: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SelectionConditions' + +NFService: + description: > + Information of a given NF Service Instance; it is part of the NFProfile + of an NF Instance discovered by the NRF + type: object + required: + - serviceInstanceId + - serviceName + - versions + - scheme + - nfServiceStatus + properties: + serviceInstanceId: + type: string + serviceName: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/ServiceName' + versions: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFServiceVersion' + minItems: 1 + scheme: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UriScheme' + nfServiceStatus: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFServiceStatus' +``` + +``` +fqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +interPlmnFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' +ipEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 +apiPrefix: + type: string +callbackUriPrefixList: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/CallbackUriPrefixItem' + minItems: 1 +defaultNotificationSubscriptions: + type: array + items: + $ref: + 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/DefaultNotificationSubscription' + minItems: 1 +allowedPlmns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 +allowedSnpns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 +allowedNfTypes: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + minItems: 1 +allowedNfDomains: + type: array + items: + type: string + minItems: 1 +allowedNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +capacity: + type: integer + minimum: 0 + maximum: 65535 +load: + type: integer + minimum: 0 + maximum: 100 +loadTimeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +priority: + type: integer + minimum: 0 + maximum: 65535 +recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +nfServiceSetIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + minItems: 1 +sNssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtSnssai' + minItems: 1 +perPlmnSnssaiList: + type: array + items: +``` + +``` +$ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/PlmnSnssai' +minItems: 1 +vendorId: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorId' +supportedVendorSpecificFeatures: + description: > + The key of the map is the IANA-assigned SMI Network Management Private Enterprise Codes + type: object + additionalProperties: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorSpecificFeature' + minItems: 1 + minProperties: 1 +oauth2Required: + type: boolean +allowedOperationsPerNfType: + description: A map (list of key-value pairs) where NF Type serves as key + type: object + additionalProperties: + type: array + items: + type: string + minItems: 1 + minProperties: 1 +allowedOperationsPerNfInstance: + description: A map (list of key-value pairs) where NF Instance Id serves as key + type: object + additionalProperties: + type: array + items: + type: string + minItems: 1 + minProperties: 1 +allowedOperationsPerNfInstanceOverrides: + type: boolean + default: false +allowedScopesRuleSet: + description: A map (list of key-value pairs) where a valid JSON pointer Id serves as key + type: object + additionalProperties: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/RuleSet' + minProperties: 1 +selectionConditions: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/SelectionConditions' + +PreferredSearch: + description: > + Contains information on whether the returned NFProfiles match the preferred query parameters + type: object + properties: + preferredTaiMatchInd: + type: boolean + default: false + preferredFullPlmnMatchInd: + type: boolean + default: false + preferredApiVersionsMatchInd: + type: boolean + otherApiVersionsInd: + type: boolean + preferredLocalityMatchInd: + type: boolean + default: false + otherLocalityInd: + type: boolean + default: false + preferredVendorSpecificFeaturesInd: + type: boolean + default: false + preferredCollocatedNfTypeInd: + type: boolean + default: false + preferredPgwMatchInd: + type: boolean + preferredAnalyticsDelaysInd: + type: boolean + preferredFeaturesMatchInd: +``` + +``` + type: boolean + noPreferredFeaturesInd: + type: boolean + +NfInstanceInfo: + description: Contains information on an NF profile matching a discovery request + type: object + properties: + nrfDiscApiUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + preferredSearch: + $ref: '#/components/schemas/PreferredSearch' + nrfAlteredPriorities: + description: > + The key of the map is the JSON Pointer of the priority IE in the NFProfile data type + that is altered by the NRF + type: object + additionalProperties: + type: integer + minimum: 0 + maximum: 65535 + minProperties: 1 + nrfSupportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +ScpDomainRoutingInformation: + description: SCP Domain Routing Information + type: object + required: + - scpDomainList + properties: + scpDomainList: + description: | + This IE shall contain a map of SCP domain interconnection information, where + the key of the map is a SCP domain. The value of each entry shall be the + interconnectivity information of the the SCP domain indicated by the key. + An empty map indicates that there is no SCP domain currently registered in + the NRF. + type: object + additionalProperties: + $ref: '#/components/schemas/ScpDomainConnectivity' + +ScpDomainConnectivity: + description: SCP Domain Connectivity Information + type: object + required: + - connectedScpDomainList + properties: + connectedScpDomainList: + type: array + items: + type: string + +ScpDomainRoutingInfoSubscription: + description: SCP Domain Routing Information Subscription + type: object + required: + - callbackUri + properties: + callbackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + validityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reqInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + localInd: + type: boolean + default: false + +ScpDomainRoutingInfoNotification: + description: SCP Domain Routing Information Notification + type: object + required: + - routingInfo + properties: + routingInfo: + $ref: '#/components/schemas/ScpDomainRoutingInformation' + localInd: +``` + +``` + type: boolean + default: false + +NfServiceInstance: + description: NF service instance + type: object + oneOf: + - required: [ nfInstanceId ] + - required: [ nfServiceSetId ] + properties: + serviceInstanceId: + type: string + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + +NoProfileMatchInfo: + description: Provides the reason for not finding NF matching the search criteria + type: object + required: + - reason + properties: + reason: + $ref: '#/components/schemas/NoProfileMatchReason' + queryParamCombinationList: + type: array + items: + $ref: '#/components/schemas/QueryParamCombination' + minItems: 1 + +QueryParamCombination: + description: Contains a list of Query Parameters + type: object + required: + - queryParams + properties: + queryParams: + type: array + items: + $ref: '#/components/schemas/QueryParam' + minItems: 1 + +QueryParam: + description: Contains the name and value of a query parameter + type: object + required: + - name + - value + properties: + name: + type: string + value: + type: string + +NoProfileMatchReason: + description: No Profile Match Reason + anyOf: + - type: string + enum: + - REQUESTER_PLMN_NOT_ALLOWED + - TARGET_NF_SUSPENDED + - TARGET_NF_UNDISCOVERABLE + - QUERY_PARAMS_COMBINATION_NO_MATCH + - UNSPECIFIED + - type: string + +AfData: + description: Contains information supported by the trusted AF + type: object + properties: + afEvents: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AfEvent' + minItems: 1 + tailList: + 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 + required: + - afEvents + +SearchResultInfo: + description: Contains additional information to the search result + type: object + properties: + unsatisfiedTaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + +``` + +## A.4 Nnrf\_AccessToken API (NRF OAuth2 Authorization) + +openapi: 3.0.0 + +``` + +info: + version: '1.3.0-alpha.1' + title: 'NRF OAuth2' + description: | + NRF OAuth2 Authorization. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` + +externalDocs: + description: 3GPP TS 29.510 V18.5.0; 5G System; Network Function Repository Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' + +``` + +``` + +paths: + /oauth2/token: + post: + summary: Access Token Request + operationId: AccessTokenRequest + tags: + - Access Token Request + parameters: + - 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: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/AccessTokenReq' + encoding: + requesterPlmn: + contentType: application/json + requesterPlmnList: + contentType: application/json + requesterSnssaiList: + contentType: application/json + requesterSnpnList: + contentType: application/json + targetPlmn: + contentType: application/json + targetSnpn: + contentType: application/json + targetSnssaiList: + contentType: application/json + +``` + +``` + targetNsList: + style: form + explode: true + required: true + responses: + '200': + description: Successful Access Token Request + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTokenRsp' + headers: + Cache-Control: + $ref: '#/components/headers/cache-control' + Pragma: + $ref: '#/components/headers/pragma' + 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 + '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': + description: Error in the Access Token Request + content: + application/json: + schema: + $ref: '#/components/schemas/AccessTokenErr' + application/problem+json: # error originated by an SCP or SEPP + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + headers: + Cache-Control: + $ref: '#/components/headers/cache-control' + Pragma: + $ref: '#/components/headers/pragma' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + headers: + cache-control: + required: true + schema: + type: string + enum: + - no-store + pragma: + required: true + schema: + type: string + enum: + - no-cache + + schemas: + AccessTokenReq: + description: Contains information related to the access token request + type: object + required: + - grant_type + - nfInstanceId + - scope + properties: + grant_type: + type: string + enum: + - client_credentials + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + targetNFType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + scope: + type: string + pattern: '^([a-zA-Z0-9_-:]+)( [a-zA-Z0-9_-:]+)*$' + targetNfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + requesterPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + requesterPlmnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 2 + requesterSnssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + requesterFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + requesterSnpnList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + minItems: 1 + targetPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + targetSnpn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + targetSnssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + targetNsiList: + type: array + items: + type: string + +``` + +``` + + minItems: 1 + targetNfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + targetNfServiceSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + hnrfAccessTokenUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + sourceNfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +AccessTokenRsp: + description: Contains information related to the access token response + type: object + required: + - access_token + - token_type + properties: + access_token: + type: string + description: > + JWS Compact Serialized representation of JWS signed JSON object (AccessTokenClaims) + token_type: + type: string + enum: + - Bearer + expires_in: + type: integer + scope: + type: string + pattern: '^([a-zA-Z0-9_-:]+)( [a-zA-Z0-9_-:]+)*$' + +AccessTokenClaims: + description: The claims data structure for the access token + type: object + required: + - iss + - sub + - aud + - scope + - exp + properties: + iss: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + sub: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + aud: + anyOf: + - $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + - type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + scope: + type: string + pattern: '^([a-zA-Z0-9_-:]+)( [a-zA-Z0-9_-:]+)*$' + exp: + type: integer + consumerPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + consumerSnpnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + producerPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + producerSnpnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + producerSnssaiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + producerNsiList: + type: array + items: + type: string + minItems: 1 + producerNfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + producerNfServiceSetId: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfServiceSetId' + sourceNfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +AccessTokenErr: + description: Error returned in the access token response message + type: object + required: + - error + 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 + +``` + +## A.5 Nnrf\_Bootstrapping API + +openapi: 3.0.0 + +``` + +info: + version: '1.2.0-alpha.1' + title: 'NRF Bootstrapping' + description: | + NRF Bootstrapping. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.510 V18.5.0; 5G System; Network Function Repository Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.510/' + +paths: + /bootstrapping: + get: + summary: Bootstrapping Info Request + operationId: BootstrappingInfoRequest + tags: + - Bootstrapping Request + parameters: + - name: If-None-Match + in: header + description: Validator for conditional requests, as described in IETF RFC 9110, 13.1.2 + schema: + type: string + responses: + '200': + description: Successful Bootstrapping Request + content: + application/3gppHal+json: + schema: + $ref: '#/components/schemas/BootstrappingInfo' + headers: + Cache-Control: + description: Cache-Control containing max-age, described in IETF RFC 9111, 5.2 + schema: + type: string + ETag: + description: > + Entity Tag containing a strong validator, described in IETF RFC 9110, 8.8.3 + 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 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' +'500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + schemas: + BootstrappingInfo: + description: Information returned by NRF in the bootstrapping response message + type: object + required: + - _links + properties: + status: + $ref: '#/components/schemas/Status' + _links: + type: object + description: > + Map of link objects where the keys are the link relations defined in + 3GPP TS 29.510 clause 6.4.6.3.3 + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/LinksValueSchema' + minProperties: 1 + nrfFeatures: + type: object + description: > + Map of features supported by the NRF, where the keys are the NRF services + as defined in 3GPP TS 29.510 clause 6.1.6.3.11 + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + minProperties: 1 + oauth2Required: + 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 + nrfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + nrfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + + Status: + description: Overall status of the NRF + anyOf: + - type: string + enum: + - OPERATIVE + - NON_OPERATIVE + - type: string + +``` + +--- + +## Annex B (normative): NF Profile changes in NFRegister and NFUpdate responses + +### B.1 General + +In the NFRegister and NFUpdate (NF Profile Complete Replacement and NF Profile Partial Update) service operations, a NF Service Consumer may indicate to the NRF that it supports receiving NF Profile changes in the response from the NRF, by including the `nfProfileChangesSupportInd` and/or the `nfProfilePartialUpdateChangesSupportInd` attributes set to "true" in the NFProfile it registers to or replaces in the NRF. + +NOTE 1: For NFRegister and NFUpdate (NF Profile Complete Replacement), the NF Service Consumer can indicate its support of the corresponding capability during the initial NFRegister operation or during the NF Profile Complete Replacement. + +NOTE 2: For NF Profile Partial Update (which uses the HTTP PATCH operation), the NF Service Consumer can indicate its support of the corresponding capability during the initial NFRegister operation, or during an NF Profile Complete Replacement (i.e., in the content of the corresponding HTTP PUT request), and can also indicate support of this capability after the initial registration, in a PATCH request, by setting to true the `nfProfilePartialUpdateChangesSupportInd` attribute. + +The NRF may return NF Profile changes, instead of the complete NF Profile, in NFRegister or NFUpdate responses, if the NF Service Consumer has indicated corresponding support in its NFProfile data. When doing so, the NRF shall include in the NF Profile returned in the response: + +- attributes that are mandatory to include in the NF Profile; if an optional IE is included (e.g. `nfServices`), attributes that are mandatory to include in this optional IE (e.g. `serviceInstanceId`) shall also be included; +- optional or conditional IEs that have been changed or added by the NRF; and +- the `nfProfileChangesInd` IE set to "true", indicating that the returned profile contains NF profile changes. + +EXAMPLE 1: The NRF does not change the NF Profile received in the request. + +The NRF response contains a NFProfile with just the following IEs: + +- `nfInstanceId`, `nfType`, `nfStatus`; and +- `nfProfileChangesInd` IE set to "true". + +EXAMPLE 2: The NRF modifies or adds the `heartbeatTimer` attribute to the NF Profile received in the request. + +The NRF response contains a NFProfile with just the following IEs: + +- `nfInstanceId`, `nfType`, `nfStatus`; +- `heartbeatTimer` with NRF chosen value; +- `nfProfileChangesInd` IE set to "true". + +--- + +## Annex C (normative): Enhanced Authorization Policy using RuleSets in NF (Service) Profile + +### C.1 General + +When scope of authorizations allowed to NF-Service-Consumers of different PLMNs, S-NSSAIs, SNPNS, NF-Domains etc. are different, it is not always possible for an NF (Service) Producer to register an authorization profile into NRF using allowedXXX parameters alone. The Allowed-ruleset feature addresses such requirements by extending the authorization policy with a prioritized list of RuleSets in the NF (Service) profile. + +This clause provides configuration examples and guidance on handling backward compatibility when the Allowed-ruleset feature is deployed. + +--- + +### C.2 Examples of NF-Producer profile only using RuleSets (i.e. without AllowedXXX parameters) in NF (Service) Profile + +This clause provides configuration examples of allowedScopesRuleSet parameter in the NF-Service profile (Clause 6.1.6.2.3). + +Following is an example of rules formed by para-phrasing the individual RuleSets registered by an NF-Service-Producer: + +*priority 1 plmns <> nfTypes <> nfInstances <> scopes <> allow* + +*priority 2 plmns <> nfTypes <> scopes <> allow* + +*priority 3 plmns <> nfTypes <> allow* + +*priority 100 deny* + +When a NF-Service-Consumer requests an access-token from NRF, the NRF matches the properties of the NF-Service-Consumer (PLMN, SNPNS, nfType, NfDomain, S-NSSAIs, NF-Instance Id etc.) against these rules in decreasing order of priority (1 being the highest). If a match is found, search stops, and the matching rule is applied to determine the scope to be granted. + +Consider 3 NF-Service Producers **p1**, **p2** and **p3** who need to register their NF-Service Profile into NRF. Each of these producers define operation level scopes Op1, Op2 and Op3 and the service-level scope. + +- NF-Service-Producer **p1** allows all NF-Service-Consumers with nfType=A to access its resources unrestricted. However NF-Service-Consumers with nfType=B are limited to Op1 and Op2. It may register, in the NF-Service-Profile: + +*priority 2 nfType {B} scopes {Op1, Op2, service level scope} allow* + +*priority 5 nfType {A} allow* + +*priority 100 deny* + +- NF-Service-Producer **p2** allows all NF-Service-Consumers with nfType=A to access its resources unrestricted. NF-Service-Consumers with nfType=B are limited to Op1 and Op2. It additionally wants to allow NF-Service-Consumer with NF-Instance-ID=X to Op3 only. It may register, in the NF-Service-Profile: + +*priority 2 nfInstance-id {X} scopes {Op3, service level scope} allow* + +``` + +priority 5 nfType {B} scopes {Op1, Op2, service level scope} allow +priority 10 nfType {A} allow +priority 100 deny + +``` + +- NF-Service-Producer **p3** allows all NF-Service-Consumers of PLMN1 of nfType=A or nfType=B to access its resources unrestricted. However, for the NFs of PLMN2, NF-Service-Consumers of nfType=A are allowed to access its resources unrestricted, but the NF-Service-Consumers of nfType=B are limited to Op1 and Op2. It may register, in the NF-Service-Profile: + +``` + +priority 2 plmn {plmn1} nfType {A,B} allow +priority 5 plmn {plmn2} nfType {A} allow +priority 10 plmn {plmn2} nfType {B} scopes {Op1, Op2, service level scope} allow +priority 100 deny + +``` + +Absence of scopes in a rule indicates that all service operations/all scopes are allowed. + +Rule with no identification of NF-Consumer (e.g. priority 100 rule in example above) indicates the rule applies to all. + +Similar examples apply to allowedRuleSet parameter in NF-Profile (Clause 6.1.6.2.2), however without the scopes parameter, as in the case of NF-Profile, the allowedRuleSet parameter is used to determine whether an NF-Consumer is allowed or not allowed to access the NF-Producer. + +### C.3 Example of NF-Producer profile using RuleSets and AllowedXXX parameters in NF (Service) Profile + +When a NF (Service) producer registers both the AllowedXXX parameters and the allowedScopesRuleSet parameter in the NF-Service Profile, the authorization scopes assigned to an NF-Consumer are determined by performing a logical OR operation of the two sets of parameters. This helps implementations to use Allowed-ruleset feature only when the authorization policy cannot be configured using the AllowedXXX parameters alone. + +This clause provides configuration examples with allowedScopesRuleSet parameter in the NF-Service profile (Clause 6.1.6.2.3) along with allowedXXX parameters. + +Consider the example of NF-Service-Producer **p3** in Annex C.2, which allows all NF-Service-Consumers of PLMN1 of nfType=A or nfType=B to access its resources unrestricted. However, for the NFs of PLMN2, NF-Service-Consumers of nfType=A are allowed to access its resources unrestricted, but the NF-Service-Consumers of nfType=B are limited to Op1 and Op2. This can be achieved by configuring the rules as: + +``` + +{ + allowedPLMNs = plmn1 + allowedNfTypes = A,B +} +OR +{ + priority 5 plmn {plmn2} nfType {A} allow + priority 10 plmn {plmn2} nfType {B} scopes {Op1, Op2, service level scope} allow +} + +``` + +Similar examples apply with allowedRuleSet parameter in NF-Profile (Clause 6.1.6.2.2), however without the scopes parameter, as in the case of NF-Profile, the allowedRuleSet parameter is used to determine whether an NF-Consumer is allowed or not allowed to access the NF-Producer. + +## C.4 Backward Compatibility + +This clause provides examples for addressing backward compatibility issues with the Allowed-ruleset feature. + +Consider an NF-Producer *p1* supporting Allowed-ruleset feature which registers its following NF-Service profile into NRF utilizing the new allowedScopesRuleSet parameter: + +``` +priority 2 nfInstance-id {X} scopes {Op3, service level scope} allow +priority 5 nfType {B} scopes {Op1, Op2, service level scope} allow +priority 10 nfType {A} allow +priority 15 nssais {1,2} scopes {Op1, service level scope} allow +priority 100 deny +``` + +Consider an NF-Consumer *c1* which does **not** support the Allowed-ruleset feature and discovers NF-Producer *p1* using Nnrf\_NFDiscovery service. + +- If the highest priority rule matching NF-Consumer *c1* is priority 2, the NRF may include, in the Nnrf\_NFDiscovery\_Get response, parameter *allowedOperationsPerNfInstance*, containing applicable scopes. +- If the highest priority rule matching NF-Consumer *c1* is priority 5, the NRF may include, in the Nnrf\_NFDiscovery\_Get response, parameter *allowedOperationsPerNfType*, containing applicable scopes. +- If the highest priority rule matching NF-Consumer *c1* is priority 10, the NRF may not include, in the Nnrf\_NFDiscovery\_Get response, the parameters *allowedOperationsPerNfInstance* and *allowedOperationsPerNfType*. +- If the highest priority rule matching NF-Consumer *c1* is priority 15, the NRF may include, in the Nnrf\_NFDiscovery\_Get response, any of the parameters *allowedOperationsPerNfInstance* or *allowedOperationsPerNfType*, containing applicable scopes. + +If entities (e.g. SCP) of a network are configured to use Complete Profile Subscription or Complete Profile Discovery feature, the Allowed-ruleset feature shall only be deployed if all these entities in the network have been upgraded to support and use the Allowed-ruleset feature. + +NF-Producers shall only be configured to use the Allowed-ruleset feature after NRFs in the network are upgraded and configured to use the Allowed-ruleset feature, as otherwise NF-Producers would need to translate RuleSets to existing service access control parameters (i.e. allowedPlmns, allowedSnpmns, allowedNfTypes etc.) which may not always be possible. + +## Annex D (normative): Support of "Canary Release" testing in the NRF + +This feature allows a network operator to deploy new software features in a Network Function (NF) in a controlled manner, by isolating the NF (Service) Instances that implement the new features, and steering solely a part of the traffic that, otherwise, would be sent towards such NF (Service) Instance producer. + +This is achieved by means of the following mechanisms: + +- Setting the NFStatus, or NFServiceStatus, of the NF service producer, to the value "CANARY\_RELEASE" +- Defining in the NFProfile or NFService of the NF service producer a set of selection conditions, that will be evaluated by an NF service consumer when attempting to select a candidate producer + +The set of conditions may include, e.g.: + +- The NF type of the consumer +- A feature number that is required by the consumer to select (and send traffic to) a producer +- A set of specific UEs (e.g. based on SUPI ranges, GPSI ranges, IMPU/IMPI ranges, list of PEIs) + +- Any UE camping on a TAI within a set of TAI ranges +- A list of DNNs + +In order to allow flexibility in the definition of the selection conditions, the above conditions can be combined by means of "and" / "or" logical operators. + +EXAMPLE: An SMF is deployed with a new software feature, and the operator wishes to test it by carrying traffic to it with the following conditions: + +- The SMF shall only be selected by an AMF, a NEF, or an NWDAF +- The SMF shall only be selected by the AMF when: + - its selection requires the support of the "ATSSS" feature (which corresponds with feature number #2 in the "nsmf-pdusession" service) + - the UE belongs to a certain range of SUPIs + - the UE is camping on a TAI belonging to a range of TAIs +- When the SMF is selected by the NEF, it shall only do it for a certain DNN +- When the SMF is selected by the NWDAF, it shall only do it when the UE is camping on a TAI belonging to a range of TAIs + +An example of the "selectionConditions" attribute could be as follows (note that there might be different logical expressions to encode the same logic): + +``` +"selectionConditions": { + "or": [ + { + "and": [ + { "consumerNfType": [ "AMF" ] }, + { "serviceFeature": 2 }, + { "supiRange": { "start": "1234511111", "end": "1234599999" } }, + { "taiRange": { + "plmnId": { "mcc": "123", "mnc": "45" }, + "tacRangeList": [ + { "start": "000011", "end": "0000ff" } + ] + } + } + ] + }, + { + "and": [ + { "consumerNfType": [ "NEF" ] }, + { "dnnList": [ "internet.operator.com" ] } + ] + }, + { + "and": [ + { "consumerNfType": [ "NWDAF" ] }, + { "taiRange": { + "plmnId": { "mcc": "123", "mnc": "45" }, + "tacRangeList": [ + { "start": "000011", "end": "000022" } + ] + } + } + ] + } + ] +} +``` + +or, alternatively, with a more simplified encoding, based on the fact that the individual conditions (attributes) inside ConditionItem (see clause 6.1.6.2.124) are evaluated following the "AND" logical operator: + +``` +"selectionConditions": { + "or": [ +``` + +``` + + { + "consumerNfType": [ "AMF" ], + "serviceFeature": 2, + "supiRange": { "start": "1234511111", "end": "1234599999" }, + "taiRange": { + "plmnId": { "mcc": "123", "mnc": "45" }, + "tacRangeList": [ + { "start": "000011", "end": "0000ff" } + ] + } + }, + { + "consumerNfType": [ "NEF" ], + "dnnList": [ "internet.operator.com" ] + }, + { + "consumerNfType": [ "NWDAF" ], + "taiRange": { + "plmnId": { "mcc": "123", "mnc": "45" }, + "tacRangeList": [ + { "start": "000011", "end": "000022" } + ] + } + } + ] +} + +``` + +Once the producer has defined the selection conditions in its NFProfile, registered at the NRF, the sequence of steps for selection an NF after it is deployed with a "canary" software release, would be as follows: + +1. NF Service Instance to be software-upgraded changes its status to "UNDISCOVERABLE", and potential consumers are notified +2. NF Service Instance gets progressively emptied of existing sessions, until no sessions remain +3. NF Service Instance may optionally change its status to "SUSPENDED", to ensure that no residual traffic is sent to the NF Service Instance, and potential consumers are notified +4. NF Service Instance is software-upgraded +5. NF Service Instance with new software registers in NRF with status "CANARY\_RELEASE" and includes the set of conditions for selection (e.g. a SUPI range) +6. Consumer NF sends discovery to NRF with usual discovery parameters and gets matching NF Instances containing NF Services with status "REGISTERED" or "CANARY\_RELEASE" +7. Consumer performs selection from the list of candidate NFs and, if the status of the producer NF is "CANARY\_RELEASE", such NF shall only be selected if the selection conditions match (e.g. it shall only be selected if the SUPI matches the SUPI range indicated by the producer NF). + +The selection of the candidate producers shall take into account the attributes of the discovered NFProfiles, and in addition, the consumer shall evaluate the attributes in the selection conditions, which shall take precedence over the attributes of the NFProfile of the producer, for those NF (Service) Instances in "CANARY\_RELEASE" status. + +If multiple candidate producers are available with NF (Service) status set to "REGISTERED" or "CANARY\_RELEASE", the consumer shall preferably select a producer in "CANARY\_RELEASE" status. + +For the case of Indirect Communication, the selection of a candidate producer may be done by the SCP. In that case, the SCP needs to be able to evaluate the selection conditions for those producers in "CANARY\_RELEASE" status. Since the SCP does not count with this information at its disposal (e.g. the different identities of the UE for which a service request is invoked via the SCP), it shall be provided by the consumer, e.g. by including the "3gpp-Sbi-Correlation-Info" HTTP header or by including the corresponding discovery headers ("3gpp-Sbi-Discovery") containing the UE identities involved in the specific traffic case. + +In certain cases, the operator may want to maintain the NF Instance fully operative (so it keeps serving traffic to any consumer), at the same time as testing the new software features; in such case, the operator may deploy distinct service instances, some of which may keep the old software version and keep the "REGISTERED" NFServiceStatus, while other service instances may be deployed with the new software version, and set the NFServiceStatus to "CANARY\_RELEASE", to ensure that it is only selected by consumers when the desired conditions are met. + +**Editor's Note:** It is FFS to consider if a more detailed description is needed of the scenario where an NF Instance is intended to be fully operational and, at the same time, be able to "canary test" some of its services. + +An SCP or SEPP Network Entities may set their NFStatus to "CANARY\_RELEASE" and define a set of selection conditions at NFProfile level to indicate to potential consumers that such Network Entity (SCP or SEPP) should only be selected if the selection conditions match. + +Given that there are no services defined for an SCP, it is not possible to have an SCP "operative" (i.e. to be able to serve traffic to any consumer) when the status is set to "CANARY\_RELEASE" and the consumers might not support the "CANARY\_RELEASE" feature. + +For a SEPP, the same considerations as with SCP apply, since there are no SEPP services per-se, in relation to the selection of SEPP instances, and the invocation of its N32-related message transfer capabilities. + +However, a SEPP Network Entity may set the NFServiceStatus of a "nsepp-telescopic" service instance (while keeping the NFStatus of the SEPP set to "REGISTERED"). In this case, it is possible to have several instances of this service deployed, where some of them have the NFServiceStatus set to "REGISTERED" (and any consumer may select them) and others set to "CANARY\_RELEASE", so consumers should only select such service instance when the selection conditions match. + +--- + +## Annex E (informative): Change history + +| Date | Meeting | TDoc. | CR | Rev | Cat | Subject/Comment | New | +|---------|---------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| 2017-10 | CT4#80 | C4-175271 | | | | Initial draft | 0.1.0 | +| 2017-10 | CT4#80 | C4-175395 | | | | Incorporation of agreed pCRs from CT4#80: C4-175109, C4-175272, C4-175274, C4-175363 | 0.2.0 | +| 2017-12 | CT4#81 | C4-176438 | | | | Incorporation of agreed pCRs from CT4#81: C4-176184, C4-176278, C4-176280, C4-176281, C4-176282 | 0.3.0 | +| 2018-01 | CT4#82 | C4-181392 | | | | Incorporation of agreed pCRs from CT4#82: C4-181348, C4-181351 | 0.4.0 | +| 2018-03 | CT4#83 | C4-182435 | | | | Incorporation of agreed pCRs from CT4#83: C4-182098, C4-182327, C4-182328, C4-182365, C4-182413 | 0.5.0 | +| 2018-04 | CT4#84 | C4-183517 | | | | Incorporation of agreed pCRs from CT4#84: C4-183450, C4-183451, C4-183452, C4-183487, C4-183488, C4-183490, C4-183491 | 0.6.0 | +| 2018-05 | CT4#85 | C4-184625 | | | | Incorporation of agreed pCRs from CT4#85: C4-184207, C4-184208, C4-184280, C4-184466, C4-184469, C4-184478, C4-184517, C4-184519, C4-184545, C4-184595, C4-184596, C4-184597, C4-184600, C4-184615, C4-184616, C4-184626 | 0.7.0 | +| 2018-06 | CT#80 | CP-181105 | | | | Presented for information and approval | 1.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80. | 15.0.0 | +| 2018-09 | CT#81 | CP-182012 | 0001 | 2 | F | Implementing the Indirect Delivery method for the GET method to retrieve NF instances | 15.1.0 | +| 2018-09 | CT#81 | CP-182093 | 0003 | 3 | F | Defining the range of the priority and capacity attributes and aligning their usage with SRV RFC 2782 | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0004 | - | F | Corrections to descriptions, references and SUPI parameter in Discovery Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182047 | 0006 | 2 | F | SubscriptionData | 15.1.0 | +| 2018-09 | CT#81 | CP-182045 | 0008 | 2 | F | Error Cases | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0009 | 2 | F | Heart Beat Procedure | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0010 | 1 | B | Vendor-Specific NF Types | 15.1.0 | +| 2018-09 | CT#81 | CP-182044 | 0011 | 3 | F | Presence condition of service discovery query parameters | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0012 | 4 | F | Description of Inter-PLMN scenarios | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0013 | 1 | F | NF Service Versions | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0014 | 1 | B | Custom Headers | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0015 | 1 | F | Overall Clean-up | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0016 | - | F | Formatting of query parameters | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0017 | - | F | Editorial corrections | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0018 | 2 | F | Backup AMF | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0020 | 1 | B | NF Service Names | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0023 | - | F | CHF as service consumer | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0024 | 3 | B | Hierarchical NF discovery in recursion mode | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0025 | 2 | B | Hierarchical NF discovery in iteration mode | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0026 | - | F | Correction of Allowed NF Domains | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0027 | - | F | Correction of BsnInfo data type | 15.1.0 | +| 2018-09 | CT#81 | CP-182161 | 0028 | 1 | F | IPv6 Prefix for NF / NF Service Address | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0030 | 1 | B | NF Set Id | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0031 | 1 | F | URI Scheme | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0032 | 2 | B | NRF service registration | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0034 | 2 | F | Discovery of combined SMF and PGW-C | 15.1.0 | +| 2018-09 | CT#81 | CP-182163 | 0035 | 3 | F | Support TAI Range for AMF/SMF and SUPI Range for PCF | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0036 | 1 | F | SUPI Range for PCF | 15.1.0 | +| 2018-09 | CT#81 | CP-182164 | 0037 | 3 | F | Scope for OAuth 2.0 Access Token Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0039 | 1 | F | Corrections to NotificationData and "supi" parameter in Discovery Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0040 | 1 | F | Group ID in Discovery Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0041 | 1 | F | Registering multiple Routing Indicators | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0045 | - | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0046 | 1 | F | Service names in Discovery Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0047 | 1 | F | Resource structure presentation | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0048 | - | B | Default Notifications for UDM | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0049 | - | F | Cell ID in Discovery Request | 15.1.0 | +| 2018-09 | CT#81 | CP-182046 | 0050 | 2 | F | NRF Subscription Data | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0051 | 1 | F | AMF Discovery by 5G-AN | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0052 | 1 | F | Detecting NF Failure and Restart using the NRF | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0053 | 2 | B | NRF Subscription Lifespan | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0054 | 1 | F | NRF servers clause in OpenAPI | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0056 | 2 | F | Default port number | 15.1.0 | +| 2018-09 | CT#81 | CP-182162 | 0057 | 1 | F | AMF Discovery Based on AMF Name | 15.1.0 | +| 2018-09 | CT#81 | CP-182060 | 0058 | - | F | API Version Update | 15.1.0 | +| 2018-12 | CT#82 | CP-183018 | 0060 | 4 | F | Heartbeat Timer | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0061 | 1 | F | Location Header | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0062 | 2 | F | NF Profile Addressing Parameters | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0063 | 1 | F | NRF Notifications | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0064 | - | F | Oauth2 Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0065 | 1 | F | Regular Expression Patterns | 15.2.0 | +| 2018-12 | CT#82 | CP-183183 | 0066 | 5 | F | Subscription Data | 15.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-------------------------------------------------------------------------------|--------| +| 2018-12 | CT#82 | CP-183147 | 0067 | 2 | F | UPF selection based on DNAI | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0068 | 5 | F | CHF registration and selection | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0069 | 1 | F | Clarify the NRF management functionality in the case of hierarchical NRFs | 15.2.0 | +| 2018-12 | CT#82 | CP-183149 | 0070 | 5 | F | OAuth2.0 Service Alignments and Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183150 | 0071 | 1 | F | HTTP Basic Authentication For OAuth2.0 Access Token Request | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0072 | 1 | F | Multiple PLMNs support | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0075 | 2 | F | NFService attribute in NFProfile | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0076 | 1 | F | Corrections of ServiceName enumeration | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0077 | 4 | F | Indicating support of EPS interworking in UPF Profile | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0079 | 2 | F | Cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0081 | - | F | APIRoot Clarification | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0082 | 2 | F | Clarification on the reuse of the previous search results | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0083 | 1 | F | NF profile detail for hierarchical NRF | 15.2.0 | +| 2018-12 | CT#82 | CP-183235 | 0084 | 3 | F | Complex query | 15.2.0 | +| 2018-12 | CT#82 | CP-183152 | 0087 | 1 | F | SMF discovery based on S-NSSAI and DNN | 15.2.0 | +| 2018-12 | CT#82 | CP-183153 | 0088 | 2 | F | CHF discovery based on GPSI and SUPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183146 | 0089 | 3 | F | Add access type in SMF selection | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0090 | 2 | F | Hierarchical subscription with intermediate forwarding NRF | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0091 | 2 | F | Hierarchical subscription with intermediate redirecting NRF | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0093 | 1 | F | Notifications for subscriptions via intermediate NRF | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0096 | 1 | F | DNN and IP Domain in BSF Info | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0097 | 1 | F | PCF Information | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0100 | - | F | NF Service FQDN | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0101 | - | F | NRF Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0102 | 1 | F | Notification Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183181 | 0103 | 2 | F | NRF OAuth Scopes | 15.2.0 | +| 2018-12 | CT#82 | CP-183182 | 0104 | 1 | F | NRF Subscription Handling | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0105 | - | F | NF Profile Change Notification | 15.2.0 | +| 2018-12 | CT#82 | CP-183171 | 0107 | - | F | UDM Group ID | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0108 | 2 | F | Preferred target NF Location in Discovery Request | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0109 | 1 | F | Telescopic FQDN for HNRF | 15.2.0 | +| 2018-12 | CT#82 | CP-183184 | 0112 | 1 | F | Description of NF instances/NF profile retrieval | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0113 | - | F | Content of the Subscription to notification response | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0115 | - | F | Adding new services in ServiceName enumeration | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0116 | - | F | NF Profile Service Instances | 15.2.0 | +| 2018-12 | CT#82 | CP-183018 | 0117 | - | F | API Version | 15.2.0 | +| 2018-12 | CT#82 | CP-183180 | 0118 | 1 | F | ExternalDocs Update | 15.2.0 | +| 2019-03 | CT#83 | CP-190023 | 0119 | 1 | F | AmfRegionId and AmfSetId | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0120 | 1 | F | Interpretation of absence of IEs in NF Profile | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0121 | 1 | F | Usage of FQDN and IP address related attributes from NF / NF Service profiles | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0122 | 1 | F | AMF Region and AMF Set in PLMNs supporting multiple PLMN Ids | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0123 | 1 | F | Encoding of GUAMI query parameter in NFDiscover Request | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0124 | 1 | F | Status for operative NF (service) not discoverable by other NFs | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0126 | 1 | F | Limiting the number of NFProfiles returned in NFDiscover response | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0127 | 2 | F | Maximum payload size of NFDiscover Response | 15.3.0 | +| 2019-03 | CT#83 | CP-190155 | 0128 | 2 | F | NF Profile Changes in NF Register / NFUpdate Response | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0129 | 1 | F | supported-features query parameter of NFDiscover Request | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0130 | 1 | F | OpenAPI Corrections | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0132 | 1 | F | OAuth2 Token Claims | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0133 | 1 | F | OAuth2 Token Type | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0134 | 1 | F | Authorization Attributes of NF Profile | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0135 | 2 | F | Features of NF Discovery service | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0136 | - | F | Subscription Authorization for Sets of NFs | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0137 | 1 | F | S-NSSAI per PLMN | 15.3.0 | +| 2019-03 | CT#83 | CP-190059 | 0138 | 4 | F | UPF selection based on PDUSessionType | 15.3.0 | +| 2019-03 | CT#83 | CP-190163 | 0139 | 2 | F | Service Names in URI Query Parameters | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0140 | 1 | F | GMLC URI for Namf_Location EventNotify | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0141 | 1 | F | Corrections on complex query | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0142 | 1 | F | NRF Notifications | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0143 | 1 | F | NRF Heart-Beat | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0144 | - | F | Addition of new Service Name | 15.3.0 | +| 2019-03 | CT#83 | CP-190023 | 0145 | - | F | API version update | 15.3.0 | +| 2019-06 | CT#84 | CP-191034 | 0146 | 3 | F | PLMN ID in Access Token Claims | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0147 | 1 | F | Content encodings supported in HTTP requests | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0156 | 3 | F | Correct the condition of the FQDN parameter of NFProfile and NFService | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0159 | 1 | F | NRF Service Description | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0161 | 1 | F | Slice Info in NRF | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0162 | 1 | F | Subscription Conditions | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0163 | 1 | F | Vendor-Specific IEs in NF Profile | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0165 | 2 | F | Target PLMN List in Inter-PLMN Service Discovery | 15.4.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|--------------------------------------------------------------------------------------------|--------| +| 2019-06 | CT#84 | CP-191034 | 0167 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0170 | - | F | Corrections on NFStatusUnSubscribe operation to take into account multiple NRFs | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0171 | 1 | F | Corrections on UpdateSubscription operation to take into account multiple NRFs | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0174 | 4 | F | Corrections on Nnrf_AccessToken Service for multiple NRFs | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0176 | - | F | LowerCamel Correction in Data Structures | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0177 | - | F | Removal of Basic Authentication | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0178 | 1 | F | Location header in redirect response | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0185 | 2 | F | Add HTTP error codes in 29.510 | 15.4.0 | +| 2019-09 | CT#85 | CP-192108 | 0192 | 4 | F | Add selection mechanism for multiple IP addresses in NFProfile | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0194 | 2 | F | Add retrieval of the NF profile using the URI | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0195 | 1 | F | Add the update of subscription in a different PLMN | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0198 | 1 | F | PLMN-IDs in Discovery Response | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0202 | - | F | Copyright Note in YAML files | 15.4.0 | +| 2019-06 | CT#84 | CP-191034 | 0206 | - | F | 3GPP TS 29.510 API version update | 15.4.0 | +| 2019-06 | CT#84 | CP-191052 | 0148 | 7 | B | NWDAF Discovery and Selection | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0149 | 4 | B | Multiple entries of pcfInfo | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0150 | 3 | B | Multiple entries of bsfInfo | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0151 | 3 | B | Multiple entries of smfInfo | 16.0.0 | +| 2019-06 | CT#84 | CP-191051 | 0154 | 5 | B | ATSSS Capability for UPF Selection | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0175 | 1 | B | GPSI range in pcfInfo | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0180 | 2 | B | Multiple entries of xxxInfo (generalized) | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0186 | 2 | F | Add the name of NF Instance | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0187 | 3 | B | Add requester nfnstanceId parameter in NFStatusSubscribe and NFDiscovery operations | 16.0.0 | +| 2019-06 | CT#84 | CP-191034 | 0196 | 2 | F | Correct The subscription notification procedure under the exception case | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0199 | 1 | B | PCF Group ID | 16.0.0 | +| 2019-06 | CT#84 | CP-191057 | 0200 | 1 | B | Number of NF Instances | 16.0.0 | +| 2019-06 | CT#84 | CP-191050 | 0201 | 1 | B | NIDDAAU Service Name | 16.0.0 | +| 2019-06 | CT#84 | CP-191054 | 0204 | 1 | B | UE IP address allocation by UPF | 16.0.0 | +| 2019-06 | CT#84 | CP-191048 | 0205 | - | B | 3GPP TS 29.510 API version update | 16.0.0 | +| 2019-09 | CT#85 | CP-192033 | 0207 | 3 | C | CBCF as Network Function | 16.1.0 | +| 2019-09 | CT#85 | CP-192127 | 0208 | 1 | F | callbackUri the same as nfStatusNotificationUri | 16.1.0 | +| 2019-09 | CT#85 | CP-192193 | 0210 | 1 | B | Extensions for I-SMF and I-UPF selection | 16.1.0 | +| 2019-09 | CT#85 | CP-192194 | 0211 | 2 | B | NF Set and NF Service Set | 16.1.0 | +| 2019-09 | CT#85 | CP-192034 | 0212 | 2 | B | Update NRF descriptions to support AF Available Data Registration as described in TS23.288 | 16.1.0 | +| 2019-09 | CT#85 | CP-192035 | 0213 | 3 | B | SMF Selection | 16.1.0 | +| 2019-09 | CT#85 | CP-192107 | 0215 | - | A | Expiration Time of AccessTokenClaims | 16.1.0 | +| 2019-09 | CT#85 | CP-192109 | 0217 | 1 | F | Requester PLMN ID in SubscriptionData | 16.1.0 | +| 2019-09 | CT#85 | CP-192127 | 0218 | - | F | Correct the conditions of the information included in the access token request | 16.1.0 | +| 2019-09 | CT#85 | CP-192107 | 0222 | - | A | Slice Information in Access Token Claims | 16.1.0 | +| 2019-09 | CT#85 | CP-192130 | 0223 | 1 | B | UPF collocated with W-AGF | 16.1.0 | +| 2019-09 | CT#85 | CP-192127 | 0224 | 2 | F | URI in Location header for subscription to NF Instances in a different PLMN | 16.1.0 | +| 2019-09 | CT#85 | CP-192249 | 0226 | 5 | A | Support of Static IP Address | 16.1.0 | +| 2019-09 | CT#85 | CP-192133 | 0228 | 1 | B | Network Identifier for Stand-alone Non-Public Networks | 16.1.0 | +| 2019-09 | CT#85 | CP-192127 | 0229 | 1 | F | SMF profile without the smfInfo attribute | 16.1.0 | +| 2019-09 | CT#85 | CP-192107 | 0231 | - | A | Authorization Attributes in NF Service | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0232 | - | B | Handling of authorization parameters | 16.1.0 | +| 2019-09 | CT#85 | CP-192136 | 0233 | 1 | B | P-CSCF Discovery | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0235 | - | B | GPSI support for PCF Query | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0236 | - | B | LMF and GMLC Info | 16.1.0 | +| 2019-09 | CT#85 | CP-192123 | 0238 | 1 | B | NEF discovery information for PFD | 16.1.0 | +| 2019-09 | CT#85 | CP-192135 | 0239 | - | B | Services invoked by NWDAF | 16.1.0 | +| 2019-09 | CT#85 | CP-192127 | 0240 | 1 | F | Regulation of load update notifications | 16.1.0 | +| 2019-09 | CT#85 | CP-192120 | 0242 | - | F | 3GPP TS 29.510 API version update | 16.1.0 | +| 2019-10 | | | | | | Corrupted references fixed | 16.1.1 | +| 2019-12 | CT#86 | CP-193063 | 0244 | - | B | Missing NFs information in NrfInfo | 16.2.0 | +| 2019-12 | CT#86 | CP-193059 | 0245 | 2 | B | P-CSCF Discovery based on preferred-locality | 16.2.0 | +| 2019-12 | CT#86 | CP-193049 | 0247 | 2 | B | NEF ID | 16.2.0 | +| 2019-12 | CT#86 | CP-193042 | 0248 | - | F | ExternalDocs Clause | 16.2.0 | +| 2019-12 | CT#86 | CP-193036 | 0250 | 3 | F | Support of Static IP Address | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0251 | 3 | B | NRF Bootstrapping | 16.2.0 | +| 2019-12 | CT#86 | CP-193056 | 0252 | 3 | B | I-SMF selection in a mobility procedure | 16.2.0 | +| 2019-12 | CT#86 | CP-193283 | 0253 | 3 | B | UCMF Registration in NRF | 16.2.0 | +| 2019-12 | CT#86 | CP-193057 | 0254 | 1 | B | Handling of default notification subscriptions with Delegated Discovery | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0255 | 1 | B | Support of different priorities in SMF/UPF profiles for different TAs | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0256 | 1 | A | External Group ID | 16.2.0 | +| 2019-12 | CT#86 | CP-193053 | 0257 | 2 | B | Internal Group Identifier in UdmInfo | 16.2.0 | +| 2019-12 | CT#86 | CP-193054 | 0258 | 1 | B | HSS Service Discovery | 16.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-------------------------------------------------------------------------|--------| +| 2019-12 | CT#86 | CP-193063 | 0259 | 1 | B | NF serving scope | 16.2.0 | +| 2019-12 | CT#86 | CP-193031 | 0260 | 1 | A | S-NSSAI Discovery Parameter | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0261 | 1 | F | NF discovery based on DNN | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0262 | 1 | F | S-NSSAI for SMF or UPF selection | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0264 | 2 | B | GMLC Location service | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0265 | - | F | Error code 404 for Hierarchical NRFs | 16.2.0 | +| 2019-12 | CT#86 | CP-193063 | 0266 | 3 | B | Preferred API Version | 16.2.0 | +| 2019-12 | CT#86 | CP-193042 | 0267 | 3 | F | Clarification on Backup AMF Info | 16.2.0 | +| 2019-12 | CT#86 | CP-193055 | 0269 | - | B | Location Update Notification Default Subscription | 16.2.0 | +| 2019-12 | CT#86 | CP-193044 | 0273 | - | F | 3GPP TS 29.510 API version update | 16.2.0 | +| 2020-03 | CT#87 | CP-200025 | 0274 | 1 | B | 3GPP Rel-16 LOLC implications on Nnrf service | 16.3.0 | +| 2020-03 | CT#87 | CP-200039 | 0275 | 2 | F | Add Corresponding API descriptions in clause 5.1 | 16.3.0 | +| 2020-03 | CT#87 | CP-200016 | 0277 | 3 | F | Service Discovery in a different PLMN using 3gpp-Sbi-Target-apiRoot | 16.3.0 | +| 2020-03 | CT#87 | CP-200134 | 0278 | 3 | B | Data Type Descriptions | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0279 | 1 | D | Editorial corrections in clause headings | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0280 | 2 | B | Service Names | 16.3.0 | +| 2020-03 | CT#87 | CP-200029 | 0281 | 1 | B | SoR Application Function | 16.3.0 | +| 2020-03 | CT#87 | CP-200035 | 0282 | 3 | B | N3 terminations of TWIF for UPF selection | 16.3.0 | +| 2020-03 | CT#87 | CP-200044 | 0283 | 1 | F | Correcting relevant typing errors | 16.3.0 | +| 2020-03 | CT#87 | CP-200016 | 0284 | 3 | B | CHF Group ID | 16.3.0 | +| 2020-03 | CT#87 | CP-200101 | 0285 | 4 | B | S-NSSAIs of an NF Service | 16.3.0 | +| 2020-03 | CT#87 | CP-200021 | 0286 | 2 | F | NFtype enumeration values for MME, SCEF and SCS/AS | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0287 | 3 | F | DNN encoding in NRF APIs | 16.3.0 | +| 2020-03 | CT#87 | CP-200047 | 0288 | 2 | F | Content type of Access Token Request | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0289 | 2 | F | Registering the AccessToken service in another NRF | 16.3.0 | +| 2020-03 | CT#87 | CP-200039 | 0290 | 3 | D | Editorial corrections | 16.3.0 | +| 2020-03 | CT#87 | CP-200039 | 0291 | 2 | F | Correction - formatting consistency | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0293 | 1 | B | 29510 CR optionality of ProblemDetails | 16.3.0 | +| 2020-03 | CT#87 | CP-200016 | 0294 | 1 | F | Wrong reference | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0295 | 1 | B | Subscription Condition for UPF | 16.3.0 | +| 2020-03 | CT#87 | CP-200026 | 0297 | 1 | B | OTAF | 16.3.0 | +| 2020-03 | CT#87 | CP-200017 | 0298 | 1 | B | Supported DNN of the I-SMF | 16.3.0 | +| 2020-03 | CT#87 | CP-200036 | 0299 | - | B | PCF selection for V2X | 16.3.0 | +| 2020-03 | CT#87 | CP-200023 | 0300 | 2 | B | UPF selection for redundant transmission | 16.3.0 | +| 2020-03 | CT#87 | CP-200016 | 0302 | 1 | B | Service access authorization of a NF Set | 16.3.0 | +| 2020-03 | CT#87 | CP-200028 | 0307 | 3 | B | UDSF registration with NRF | 16.3.0 | +| 2020-03 | CT#87 | CP-200016 | 0308 | - | F | API versions supported for default notification subscriptions | 16.3.0 | +| 2020-03 | CT#87 | CP-200044 | 0309 | - | F | NF Discovery with intermediate forwarding NRF | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0310 | - | F | Modifications in the NRF service APIs for the support of compression | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0311 | 1 | B | Vendor ID in NF Profile | 16.3.0 | +| 2020-03 | CT#87 | CP-200177 | 0312 | 3 | B | LMF selection | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0313 | 1 | B | Load Time Stamp | 16.3.0 | +| 2020-03 | CT#87 | CP-200020 | 0314 | 1 | B | Security Settings | 16.3.0 | +| 2020-03 | CT#87 | CP-200016 | 0315 | 1 | B | NFType for SCP | 16.3.0 | +| 2020-03 | CT#87 | CP-200092 | 0316 | - | F | 3GPP TS 29.510 API Version Update | 16.3.0 | +| 2020-07 | CT#88 | CP-201050 | 0317 | 1 | B | Support of IPUPS Functionality | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0318 | 1 | F | Authorization parameters in roaming scenarios | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0319 | 1 | F | Missing attributes in NrfInfo data type | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0320 | - | F | Slice Differentiator Ranges and Wildcard | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0321 | 1 | F | Undiscoverable NF service | 16.4.0 | +| 2020-07 | CT#88 | CP-201057 | 0322 | 2 | F | Supported Headers and Links Tables | 16.4.0 | +| 2020-07 | CT#88 | CP-201030 | 0323 | 1 | B | Recovery Time for NF Service Set and NF Set | 16.4.0 | +| 2020-07 | CT#88 | CP-201022 | 0324 | 1 | A | Requester-snsais | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0325 | 2 | B | Resource-Level Authorization | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0326 | - | B | Data type descriptions | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0327 | - | B | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0331 | 1 | B | Subscription Condition for a List of NF Instances | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0334 | - | B | Serving Scope for NF Subscriptions | 16.4.0 | +| 2020-07 | CT#88 | CP-201046 | 0335 | 1 | B | SMF NIDD Service | 16.4.0 | +| 2020-07 | CT#88 | CP-201057 | 0336 | 1 | F | Datatype column in Resource URI variables Table | 16.4.0 | +| 2020-07 | CT#88 | CP-201041 | 0338 | 2 | F | ServiceName nudsf-dr missing from yaml | 16.4.0 | +| 2020-07 | CT#88 | CP-201030 | 0341 | 1 | F | Presence condition of Set IDs | 16.4.0 | +| 2020-07 | CT#88 | CP-201047 | 0342 | 1 | B | AMF Callback URIs for NSSAA | 16.4.0 | +| 2020-07 | CT#88 | CP-201047 | 0343 | 1 | B | Introduce NSSAAF | 16.4.0 | +| 2020-07 | CT#88 | CP-201201 | 0345 | 2 | F | SCP profile registration and discovery | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0347 | 1 | F | Bootstrapping API | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0348 | 1 | F | Defining xxxInfoExt data types as maps | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0349 | - | F | Requester's information in Access Token Request | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0350 | - | F | Discovery or subscription requests with missing requester's information | 16.4.0 | +| 2020-07 | CT#88 | CP-201030 | 0354 | 1 | F | Supplement to NefInfo | 16.4.0 | +| 2020-07 | CT#88 | CP-201070 | 0355 | 1 | B | UPF for Data Forwarding | 16.4.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------------|--------| +| 2020-07 | CT#88 | CP-201031 | 0356 | 1 | B | V-SMF Selection for Serving Full PLMN | 16.4.0 | +| 2020-07 | CT#88 | CP-201045 | 0357 | - | F | NRF Additional Authorization Parameters | 16.4.0 | +| 2020-07 | CT#88 | CP-201183 | 0359 | 2 | F | NRF Notifications | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0360 | - | F | NF Services Map | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0361 | 1 | B | NRF Notification Data | 16.4.0 | +| 2020-07 | CT#88 | CP-201033 | 0364 | - | B | Service Name for Nhss_EE | 16.4.0 | +| 2020-07 | CT#88 | CP-201034 | 0365 | 1 | F | Maximum payload size | 16.4.0 | +| 2020-07 | CT#88 | CP-201073 | 0368 | - | F | 3GPP TS 29.510 API Version Update | 16.4.0 | +| 2020-09 | CT#89 | CP-202118 | 0370 | - | F | HSS NF Profile Update | 16.5.0 | +| 2020-09 | CT#89 | CP-202043 | 0371 | 1 | F | NF Group ID | 16.5.0 | +| 2020-09 | CT#89 | CP-202110 | 0372 | - | F | Handling of S-NSSAI per PLMN | 16.5.0 | +| 2020-09 | CT#89 | CP-202119 | 0375 | 1 | F | scpPrefix attribute in SCP profile | 16.5.0 | +| 2020-09 | CT#89 | CP-202119 | 0376 | 1 | F | Resolving Editor's notes on SCP profile registration and discovery | 16.5.0 | +| 2020-09 | CT#89 | CP-202110 | 0377 | - | F | NF Profile Retrieval procedure with NF Services Map | 16.5.0 | +| 2020-09 | CT#89 | CP-202118 | 0378 | - | F | Missing NF types for SBA interactions between IMS and 5GC | 16.5.0 | +| 2020-09 | CT#89 | CP-202088 | 0380 | - | F | supported-features query parameter | 16.5.0 | +| 2020-09 | CT#89 | CP-202088 | 0381 | 1 | F | Making reqNfType as Conditional IE in SubscriptionData | 16.5.0 | +| 2020-09 | CT#89 | CP-202119 | 0383 | 3 | F | Corrections on attributes for SCP | 16.5.0 | +| 2020-09 | CT#89 | CP-202119 | 0384 | 1 | F | Notification Binding for Default Subscription | 16.5.0 | +| 2020-09 | CT#89 | CP-202022 | 0385 | 2 | F | Message and Information class for Default Subscription | 16.5.0 | +| 2020-09 | CT#89 | CP-202110 | 0386 | 1 | F | Default TCP Port | 16.5.0 | +| 2020-09 | CT#89 | CP-202112 | 0387 | 1 | F | Corrections on definition of NotificationType | 16.5.0 | +| 2020-09 | CT#89 | CP-202096 | 0390 | - | F | 29.510 Rel-16 API version and External doc update | 16.5.0 | +| 2020-12 | CT#90 | CP-203034 | 0395 | 2 | F | Subscription Authorization parameters for NRF | 16.6.0 | +| 2020-12 | CT#90 | CP-203034 | 0396 | 2 | F | Add a condition to trigger NF_PROFILE_CHANGE notification from NRF for any change in allowedxxx parameter | 16.6.0 | +| 2020-12 | CT#90 | CP-203034 | 0397 | 2 | F | Replace the NFInstanceID with nfInstanceUri in Notification from NRF | 16.6.0 | +| 2020-12 | CT#90 | CP-203081 | 0398 | 4 | F | Supplement to SubscrCond | 16.6.0 | +| 2020-12 | CT#90 | CP-203070 | 0402 | 2 | F | SCP port information | 16.6.0 | +| 2020-12 | CT#90 | CP-203048 | 0404 | 1 | F | preferred-api-versions query parameter | 16.6.0 | +| 2020-12 | CT#90 | CP-203053 | 0405 | - | F | P-CSCF addresses | 16.6.0 | +| 2020-12 | CT#90 | CP-203054 | 0406 | 4 | F | Amendments for stateless NF support | 16.6.0 | +| 2020-12 | CT#90 | CP-203048 | 0408 | - | F | Storage of YAML files in GitLab | 16.6.0 | +| 2020-12 | CT#90 | CP-203048 | 0410 | - | F | Correction in NRF Bootstrapping | 16.6.0 | +| 2020-12 | CT#90 | CP-203052 | 0413 | - | F | UDSF Info | 16.6.0 | +| 2020-12 | CT#90 | CP-203054 | 0414 | 1 | F | SCP subscription | 16.6.0 | +| 2020-12 | CT#90 | CP-203034 | 0415 | 1 | F | NF Profile for NF as Service Consumer | 16.6.0 | +| 2020-12 | CT#90 | CP-203048 | 0416 | 1 | F | Preferred Locality Search Result | 16.6.0 | +| 2020-12 | CT#90 | CP-203034 | 0418 | 2 | F | V-SMF Capability | 16.6.0 | +| 2020-12 | CT#90 | CP-203048 | 0419 | - | F | Data Type Descriptions | 16.6.0 | +| 2020-12 | CT#90 | CP-203036 | 0420 | - | F | 29.510 Rel16 API version and External doc update | 16.6.0 | +| 2020-12 | CT#90 | CP-203064 | 0374 | 2 | B | NF Discovery procedure enhancements | 17.0.0 | +| 2020-12 | CT#90 | CP-203059 | 0392 | 1 | F | Discovery answer for no match of query parameter | 17.0.0 | +| 2020-12 | CT#90 | CP-203064 | 0399 | 1 | F | Issues with definition of heartBeatTimer attribute and limit Query-parameter in Open API specification | 17.0.0 | +| 2020-12 | CT#90 | CP-203071 | 0400 | 2 | B | Query parameter for preferred vendor-specific features | 17.0.0 | +| 2020-12 | CT#90 | CP-203064 | 0401 | 1 | F | Support of Wildcard DNN in SmfInfo | 17.0.0 | +| 2020-12 | CT#90 | CP-203064 | 0407 | 3 | B | Select a UP function to setup PFCP Association | 17.0.0 | +| 2020-12 | CT#90 | CP-203061 | 0409 | - | D | TS References | 17.0.0 | +| 2020-12 | CT#90 | CP-203064 | 0411 | - | F | IP addressing | 17.0.0 | +| 2020-12 | CT#90 | CP-203064 | 0412 | 2 | F | Default Notifications | 17.0.0 | +| 2020-12 | CT#90 | CP-203069 | 0417 | 4 | B | SCP Domain Routing Information | 17.0.0 | +| 2020-12 | CT#90 | CP-203055 | 0421 | - | F | 29.510 Rel17 API version and External doc update | 17.0.0 | +| 2021-03 | CT#91 | CP-210021 | 0369 | 3 | B | NF discovery based on SUCI information | 17.1.0 | +| 2021-03 | CT#91 | CP-210037 | 0423 | 1 | A | Add snssaiList, pfdData, gpsiRanges, externalGroupIdentifiersRanges, servedFqdnList to NefCond | 17.1.0 | +| 2021-03 | CT#91 | CP-210037 | 0425 | 1 | A | Add snssaiList, tailList and tailRangeList to NwdaFCond | 17.1.0 | +| 2021-03 | CT#91 | CP-210043 | 0428 | 1 | A | Encoding of Monitored and Unmonitored Attributes | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0429 | 2 | F | Vendor Specific Features at NF Level | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0430 | 1 | B | SEPP profile | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0431 | - | B | NRF supported features in Bootstrapping response | 17.1.0 | +| 2021-03 | CT#91 | CP-210043 | 0433 | - | A | Query parameters indicating a preference | 17.1.0 | +| 2021-03 | CT#91 | CP-210043 | 0435 | - | A | NFType value for DRA | 17.1.0 | +| 2021-03 | CT#91 | CP-210043 | 0438 | 2 | A | P-CSCF discovery based on UE IP address R17 | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0439 | 1 | F | P-CSCF discovery based on UE location | 17.1.0 | +| 2021-03 | CT#91 | CP-210053 | 0443 | - | A | Primary / Secondary CHF Instances | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0444 | 1 | B | Enhancements to BSF Info | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0445 | 2 | B | UPF TAI Ranges | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0446 | 1 | F | Editorial Corrections | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0447 | 2 | B | Enhancements to NFListRetrieval service operation | 17.1.0 | +| 2021-03 | CT#91 | CP-210022 | 0450 | - | F | Clarification of NF Set ID List | 17.1.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------------------------------|--------| +| 2021-03 | CT#91 | CP-210021 | 0451 | - | F | IMSI Pattern | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0452 | - | F | Correction to Bootstrapping service description | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0453 | 2 | F | Discovery and Subscribe Operation on NF Service Set | 17.1.0 | +| 2021-03 | CT#91 | CP-210034 | 0454 | 1 | D | Correcting Figure 5.2.2.5.4-1 | 17.1.0 | +| 2021-03 | CT#91 | CP-210034 | 0455 | 1 | D | Correcting Figure 5.2.2.5.5-1 | 17.1.0 | +| 2021-03 | CT#91 | CP-210034 | 0456 | - | D | Correcting Figure 5.2.2.6.4-1 | 17.1.0 | +| 2021-03 | CT#91 | CP-210043 | 0458 | 1 | A | Essential correction to Subscription Condition data types | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0459 | - | F | Supported Vendor-Specific Features | 17.1.0 | +| 2021-03 | CT#91 | CP-210055 | 0461 | 1 | A | Conditional PATCH | 17.1.0 | +| 2021-03 | CT#91 | CP-210021 | 0464 | 1 | B | SCP Domain Routing Info Aggregation | 17.1.0 | +| 2021-03 | CT#91 | CP-210037 | 0466 | 4 | A | SCP Information | 17.1.0 | +| 2021-03 | CT#91 | CP-210055 | 0471 | 1 | A | SubscrCond for PCF and CHF | 17.1.0 | +| 2021-03 | CT#91 | CP-210026 | 0472 | 1 | B | AAnF discovery | 17.1.0 | +| 2021-03 | CT#91 | CP-210025 | 0473 | 1 | F | hNRF from NSSF in home PLMN | 17.1.0 | +| 2021-03 | CT#91 | CP-210029 | 0474 | - | F | 29.510 Rel-17 API version and External doc update | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0477 | - | B | UDSF Timer service | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0478 | 2 | B | Communication options information | 17.2.0 | +| 2021-06 | CT#92 | CP-211027 | 0479 | - | B | Non-3GPP TAI | 17.2.0 | +| 2021-06 | CT#92 | CP-211030 | 0480 | 1 | B | New NSACF NFtype added | 17.2.0 | +| 2021-06 | CT#92 | CP-211065 | 0483 | 1 | F | Usage of IPv6PrefixRange | 17.2.0 | +| 2021-06 | CT#92 | CP-211065 | 0485 | - | A | Smf Info Priority | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0486 | - | F | OpenAPI Reference | 17.2.0 | +| 2021-06 | CT#92 | CP-211065 | 0488 | 1 | A | Corrections to PFD Data attribute and query parameter | 17.2.0 | +| 2021-06 | CT#92 | CP-211039 | 0489 | 1 | B | Add 5G DDNMF | 17.2.0 | +| 2021-06 | CT#92 | CP-211071 | 0491 | 1 | A | Essential correction on UPF Info | 17.2.0 | +| 2021-06 | CT#92 | CP-211031 | 0492 | 2 | B | (I-)SMF discovery based on DNAI | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0493 | 1 | B | New services provided by NWDAF | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0494 | 2 | B | Analytics IDs per Service | 17.2.0 | +| 2021-06 | CT#92 | CP-211057 | 0496 | 1 | F | Description field for map data types | 17.2.0 | +| 2021-06 | CT#92 | CP-211059 | 0498 | 1 | A | Error Responses for Indirect Communication | 17.2.0 | +| 2021-06 | CT#92 | CP-211066 | 0500 | - | A | Event IDs supported by AF | 17.2.0 | +| 2021-06 | CT#92 | CP-211039 | 0501 | - | B | Add 5G DDNMF service | 17.2.0 | +| 2021-06 | CT#92 | CP-211039 | 0502 | 1 | B | PCF discovery with ProSe capability indication | 17.2.0 | +| 2021-06 | CT#92 | CP-211065 | 0504 | 1 | A | R17-Access token request verification | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0505 | 2 | B | NWDAF aggregation capability registration in the NRF | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0506 | 3 | B | New DCCF NF Registration and Discovery | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0507 | 2 | B | New MFAF NF Registration and Discovery | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0508 | 2 | B | NWDAF Registration and Discovery enhancement | 17.2.0 | +| 2021-06 | CT#92 | CP-211026 | 0509 | 1 | B | LMF discovery via TAI | 17.2.0 | +| 2021-06 | CT#92 | CP-211065 | 0512 | 3 | A | Remove unused GrantType | 17.2.0 | +| 2021-06 | CT#92 | CP-211034 | 0513 | 3 | B | NSI based SUPI/SUCI | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0514 | - | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the Nnrf_NFManagement API | 17.2.0 | +| 2021-06 | CT#92 | CP-211059 | 0515 | 1 | A | Redirect Responses | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0517 | 1 | F | Nested cardinality R17 | 17.2.0 | +| 2021-06 | CT#92 | CP-211057 | 0518 | 2 | B | NRF Content Encoding Information | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0519 | 2 | B | SCP capabilities | 17.2.0 | +| 2021-06 | CT#92 | CP-211031 | 0520 | - | B | EASDF Registration and Discovery | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0521 | - | F | Client-type query parameter alignment | 17.2.0 | +| 2021-06 | CT#92 | CP-211036 | 0522 | 1 | B | Analytics ID of Nnwdaf_MLModelProvision service | 17.2.0 | +| 2021-06 | CT#92 | CP-211057 | 0525 | 1 | F | Add ConditionEventType in Table 6.1.6.1-1 | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0528 | 1 | F | Supported Features for Default Subscription | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0529 | 1 | F | NRF Info | 17.2.0 | +| 2021-06 | CT#92 | CP-211028 | 0530 | - | F | Clarification of service-names query parameter | 17.2.0 | +| 2021-06 | CT#92 | CP-211026 | 0535 | 1 | B | LMF discovery via Supported GAD shapes | 17.2.0 | +| 2021-06 | CT#92 | CP-211039 | 0536 | - | B | Match Information Default Notification | 17.2.0 | +| 2021-06 | CT#92 | CP-211050 | 0537 | - | F | 29.510 Rel-17 API version and External doc update | 17.2.0 | +| 2021-09 | CT#93 | CP-212050 | 0539 | 1 | F | Multiple PGW FQDNs | 17.3.0 | +| 2021-09 | CT#93 | CP-212083 | 0541 | 2 | B | NSACF Profile | 17.3.0 | +| 2021-09 | CT#93 | CP-212030 | 0542 | 1 | B | NSACF discovery | 17.3.0 | +| 2021-09 | CT#93 | CP-212050 | 0543 | 1 | D | Editorial Corrections | 17.3.0 | +| 2021-09 | CT#93 | CP-212030 | 0544 | 1 | B | NSACF service name | 17.3.0 | +| 2021-09 | CT#93 | CP-212031 | 0547 | - | B | Local NEF discovery | 17.3.0 | +| 2021-09 | CT#93 | CP-212041 | 0548 | - | B | NFStatusSubscribe for DCCF | 17.3.0 | +| 2021-09 | CT#93 | CP-212041 | 0549 | 1 | B | NFStatusSubscribe for NWDAF | 17.3.0 | +| 2021-09 | CT#93 | CP-212026 | 0551 | 1 | F | Returning the interPlmnFqdn attribute in NFProfile in NF Discovery response | 17.3.0 | +| 2021-09 | CT#93 | CP-212094 | 0552 | 2 | B | MB-SMF registration and discovery | 17.3.0 | +| 2021-09 | CT#93 | CP-212095 | 0553 | 1 | B | TSCTSF NF registration and discovery | 17.3.0 | +| 2021-09 | CT#93 | CP-212031 | 0554 | - | F | Cardinality of servedEasdfInfoList in NrfInfo | 17.3.0 | +| 2021-09 | CT#93 | CP-212043 | 0556 | 1 | F | Clarification on primaryChfInstance and secondaryChfInstance | 17.3.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|---------------------------------------------------------------------------------|--------| +| 2021-09 | CT#93 | CP-212066 | 0558 | - | A | NFType enumeration value for IMS-AS | 17.3.0 | +| 2021-09 | CT#93 | CP-212060 | 0560 | - | A | 3xx description correction for SCP | 17.3.0 | +| 2021-09 | CT#93 | CP-212026 | 0561 | 1 | F | Rel-17 NFDiscovery features | 17.3.0 | +| 2021-09 | CT#93 | CP-212041 | 0562 | - | B | New ADRF NF Registration and Discovery | 17.3.0 | +| 2021-09 | CT#93 | CP-212041 | 0563 | - | B | NWDAF capability enhancement | 17.3.0 | +| 2021-09 | CT#93 | CP-212064 | 0565 | 1 | A | ScpInfo Data Type Definition | 17.3.0 | +| 2021-09 | CT#93 | CP-212029 | 0567 | - | B | GBA BSF NF Type and Service Name | 17.3.0 | +| 2021-09 | CT#93 | CP-212064 | 0569 | - | A | ScpDomainCond data type definition | 17.3.0 | +| 2021-09 | CT#93 | CP-212050 | 0570 | 1 | F | PGW IP Address | 17.3.0 | +| 2021-09 | CT#93 | CP-212036 | 0571 | - | F | Correct incorrect data type name of 5GDdnmflnfo | 17.3.0 | +| 2021-09 | CT#93 | CP-212026 | 0573 | 1 | F | Corrections to the API URI | 17.3.0 | +| 2021-09 | CT#93 | CP-212059 | 0575 | - | F | 29.510 Rel-17 API version and External doc update | 17.3.0 | +| 2021-12 | CT#94 | CP-213097 | 0577 | 2 | B | MB-SMF registration and discovery - Updates | 17.4.0 | +| 2021-12 | CT#94 | CP-213086 | 0579 | 2 | F | Correction on service operation description | 17.4.0 | +| 2021-12 | CT#94 | CP-213085 | 0581 | 1 | B | Discovering whether Oauth2 authorization is required for accessing NRF services | 17.4.0 | +| 2021-12 | CT#94 | CP-213108 | 0584 | 1 | B | BSF NF Profile definition for DCAMP | 17.4.0 | +| 2021-12 | CT#94 | CP-213108 | 0585 | 1 | B | New PCF Service Name for PCF AM Policy Authorization | 17.4.0 | +| 2021-12 | CT#94 | CP-213097 | 0586 | 1 | B | MB-UPF registration and discovery | 17.4.0 | +| 2021-12 | CT#94 | CP-213093 | 0587 | 1 | B | Support for Service Specific Authorization | 17.4.0 | +| 2021-12 | CT#94 | CP-213102 | 0588 | 3 | B | AF Slice and DNN registration via NEF | 17.4.0 | +| 2021-12 | CT#94 | CP-213096 | 0590 | - | B | LMFInfo update for SAT access | 17.4.0 | +| 2021-12 | CT#94 | CP-213093 | 0591 | 1 | B | EASDF discovery based on UPF N6 address | 17.4.0 | +| 2021-12 | CT#94 | CP-213093 | 0592 | 1 | B | Local NEF discovery based on list of TAs | 17.4.0 | +| 2021-12 | CT#94 | CP-213102 | 0593 | 1 | B | Trusted AF registration and discovery | 17.4.0 | +| 2021-12 | CT#94 | CP-213092 | 0595 | 1 | F | Correction of NSACF discovery | 17.4.0 | +| 2021-12 | CT#94 | CP-213085 | 0596 | - | F | Correction on ScpDomainInfo | 17.4.0 | +| 2021-12 | CT#94 | CP-213101 | 0597 | 2 | B | ServiceName data type extension to cover the missing TSCTSF and NEF services | 17.4.0 | +| 2021-12 | CT#94 | CP-213086 | 0599 | 1 | B | Precedence of Preferred Parameters | 17.4.0 | +| 2021-12 | CT#94 | CP-213193 | 0603 | 2 | A | GMLC-Number in GmlcInfo | 17.4.0 | +| 2021-12 | CT#94 | CP-213097 | 0606 | 1 | B | Selection of collocated MB-SMF/SMF and MB-UPF/UPF | 17.4.0 | +| 2021-12 | CT#94 | CP-213091 | 0608 | - | B | New Service Names for HSS GBA Services | 17.4.0 | +| 2021-12 | CT#94 | CP-213087 | 0609 | 1 | B | Group ranges in HSS Info | 17.4.0 | +| 2021-12 | CT#94 | CP-213093 | 0610 | - | B | EASDF Baseline DNS Pattern service | 17.4.0 | +| 2021-12 | CT#94 | CP-213097 | 0611 | - | B | New services for MBS | 17.4.0 | +| 2021-12 | CT#94 | CP-213116 | 0612 | - | F | Incorrect reference to NF Service Set ID definition in TS 23.003 | 17.4.0 | +| 2021-12 | CT#94 | CP-213116 | 0613 | - | F | requester-plmn-list query parameter | 17.4.0 | +| 2021-12 | CT#94 | CP-213088 | 0615 | 1 | F | NRF Hierarchy | 17.4.0 | +| 2021-12 | CT#94 | CP-213087 | 0617 | 1 | B | Discovery Result Change Notification | 17.4.0 | +| 2021-12 | CT#94 | CP-213131 | 0619 | 1 | F | NF Service Redundancy Level | 17.4.0 | +| 2021-12 | CT#94 | CP-213201 | 0623 | 2 | B | hNRF URI | 17.4.0 | +| 2021-12 | CT#94 | CP-213088 | 0625 | - | A | NFType value for CEF | 17.4.0 | +| 2021-12 | CT#94 | CP-213087 | 0626 | 1 | F | Subscription on SCP domain | 17.4.0 | +| 2021-12 | CT#94 | CP-213087 | 0627 | 1 | B | PLMN Specific attributes in NF profile | 17.4.0 | +| 2021-12 | CT#94 | CP-213121 | 0628 | - | F | 29.510 Rel-17 API version and External doc update | 17.4.0 | +| 2022-03 | CT#95 | CP-220047 | 0630 | 6 | B | SNPN impacts on NRF - DCS/CH identification | 17.5.0 | +| 2022-03 | CT#95 | CP-220047 | 0632 | - | F | SNPN impacts on NRF services - R17 | 17.5.0 | +| 2022-03 | CT#95 | CP-220267 | 0633 | 2 | F | SNPN impacts on NRF - OnboardingCapability | 17.5.0 | +| 2022-03 | CT#95 | CP-220023 | 0634 | 1 | F | Static Authorization | 17.5.0 | +| 2022-03 | CT#95 | CP-220035 | 0636 | 1 | B | MB-SMF discovery by AMF using MBS Session ID and Area Session ID | 17.5.0 | +| 2022-03 | CT#95 | CP-220088 | 0637 | - | F | AMF name in N2InterfaceAmfInfo | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0638 | 1 | B | Returning NRF altered priorities when using the Enhanced NF Discovery feature | 17.5.0 | +| 2022-03 | CT#95 | CP-220044 | 0639 | 1 | B | UAS Capability Indication for NEF | 17.5.0 | +| 2022-03 | CT#95 | CP-220044 | 0640 | - | B | UAS Service Name | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0642 | 2 | F | SUCI information corrections | 17.5.0 | +| 2022-03 | CT#95 | CP-220043 | 0643 | 3 | B | Add ProSe Capability in Pcflnfo | 17.5.0 | +| 2022-03 | CT#95 | CP-220056 | 0645 | 2 | B | Add V2X Capability | 17.5.0 | +| 2022-03 | CT#95 | CP-220057 | 0646 | 2 | B | NSSAAF registration and discovery | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0648 | 2 | F | Handling of PLMN ID in Subscription to NF Profile Change | 17.5.0 | +| 2022-03 | CT#95 | CP-220036 | 0649 | 1 | B | Data Restoration Default Notification | 17.5.0 | +| 2022-03 | CT#95 | CP-220023 | 0651 | - | F | NSACF Information | 17.5.0 | +| 2022-03 | CT#95 | CP-220047 | 0652 | - | B | NSSAAF AIW Service Name | 17.5.0 | +| 2022-03 | CT#95 | CP-220148 | 0653 | 4 | B | Subscription Context in Notifications | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0654 | 1 | B | Resource-based authorization on the NRF APIs | 17.5.0 | +| 2022-03 | CT#95 | CP-220092 | 0655 | - | F | NF (Service) Set Status Change | 17.5.0 | +| 2022-03 | CT#95 | CP-220023 | 0657 | 1 | B | Preferred PGW Query Parameter | 17.5.0 | +| 2022-03 | CT#95 | CP-220048 | 0658 | 1 | B | TSCTSF Discovery | 17.5.0 | +| 2022-03 | CT#95 | CP-220049 | 0659 | 1 | B | AF registration with support of mapping between UE IP address and UE ID | 17.5.0 | +| 2022-03 | CT#95 | CP-220092 | 0667 | - | F | ServiceName data type extension to cover the missing NEF services | 17.5.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-----------------------------------------------------------------------------------|--------| +| 2022-03 | CT#95 | CP-220053 | 0669 | 1 | B | NSWO NF | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0670 | 1 | F | UDR storing of non-subscriber related data | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0671 | - | B | UDR storing data sub-sets | 17.5.0 | +| 2022-03 | CT#95 | CP-220088 | 0672 | - | F | Subscription with GuamiListCond | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0673 | - | F | Bootstrapping headers | 17.5.0 | +| 2022-03 | CT#95 | CP-220084 | 0676 | - | A | Encoding of Access Token Request | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0677 | 1 | B | P-CSCF Restoration Enhancements | 17.5.0 | +| 2022-03 | CT#95 | CP-220024 | 0678 | - | F | HSS Type is missing for NfGroupCond | 17.5.0 | +| 2022-03 | CT#95 | CP-220049 | 0685 | 1 | B | Corrections to Authorization procedure for eNA scenario | 17.5.0 | +| 2022-03 | CT#95 | CP-220032 | 0686 | 1 | F | Subscription Id in message body | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0687 | 1 | F | Error responses to NRF OAuth 2.0 Access Token Request | 17.5.0 | +| 2022-03 | CT#95 | CP-220025 | 0688 | 1 | B | NRF Set support | 17.5.0 | +| 2022-03 | CT#95 | CP-220066 | 0689 | - | F | 29.510 Rel-17 API version and External doc update | 17.5.0 | +| 2022-06 | CT#96 | CP-221049 | 0692 | 6 | F | Adding ismfSupportInd to the SmfInfo | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0694 | 2 | F | Correction and clarification on NotificationType | 17.6.0 | +| 2022-06 | CT#96 | CP-221049 | 0698 | 1 | F | Supported PLMN for CHF Discovery | 17.6.0 | +| 2022-06 | CT#96 | CP-221043 | 0699 | - | B | PKMF Function and Service | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0700 | - | F | MBS Service Area Information for Location dependent MBS session | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0701 | 1 | A | SMF profile without smfInfo and smfInfoList attributes | 17.6.0 | +| 2022-06 | CT#96 | CP-221023 | 0702 | - | F | MBS NF types | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0703 | 1 | F | Description Fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221029 | 0704 | 2 | F | Fqdn Data Type Definition | 17.6.0 | +| 2022-06 | CT#96 | CP-221031 | 0705 | - | B | Target Network Resolution | 17.6.0 | +| 2022-06 | CT#96 | CP-221031 | 0708 | 3 | B | Support of MNP | 17.6.0 | +| 2022-06 | CT#96 | CP-221027 | 0709 | - | F | Oauth2 scopes | 17.6.0 | +| 2022-06 | CT#96 | CP-221038 | 0710 | 1 | F | NWDAF Discovery | 17.6.0 | +| 2022-06 | CT#96 | CP-221036 | 0712 | - | B | Remote SNPNs reachable through an SCP or SEPP | 17.6.0 | +| 2022-06 | CT#96 | CP-221049 | 0714 | - | F | Delete the default value of vsmfSupportInd in A.2 | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0715 | 1 | B | MBSF/MB-STF profiles in NRF | 17.6.0 | +| 2022-06 | CT#96 | CP-221036 | 0716 | - | F | SMF UP remote provisioning capability | 17.6.0 | +| 2022-06 | CT#96 | CP-221024 | 0717 | 1 | F | MB-SMF discovering AMF(s) | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0718 | - | F | HSS Diameter Address | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0719 | - | F | Locality Based Priority | 17.6.0 | +| 2022-06 | CT#96 | CP-221028 | 0720 | - | F | Application Data Subsets | 17.6.0 | +| 2022-06 | CT#96 | CP-221038 | 0721 | - | F | Clarification of DCCF Info and NWDAF Info | 17.6.0 | +| 2022-06 | CT#96 | CP-221029 | 0722 | 1 | F | Encoding of Query Parameters | 17.6.0 | +| 2022-06 | CT#96 | CP-221037 | 0723 | - | F | New Service Names | 17.6.0 | +| 2022-06 | CT#96 | CP-221031 | 0724 | - | B | NF registration and discovery of SMS-IWMSC | 17.6.0 | +| 2022-06 | CT#96 | CP-221037 | 0725 | 1 | F | TSCTS Default Notification | 17.6.0 | +| 2022-06 | CT#96 | CP-221029 | 0726 | - | F | NRF Bootstrapping Headers | 17.6.0 | +| 2022-06 | CT#96 | CP-221051 | 0728 | - | F | 29.510 Rel-17 API version and External doc update | 17.6.0 | +| 2022-09 | CT#97 | CP-222026 | 0729 | - | F | Add seppPrefix attribute in SEPP profile | 17.7.0 | +| 2022-09 | CT#97 | CP-222037 | 0730 | - | F | CH/DCS using AAA-S vs AUSF/UDM | 17.7.0 | +| 2022-09 | CT#97 | CP-222027 | 0732 | 1 | F | nudm-rsds Service | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0734 | 1 | F | Removing an editor's note | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0738 | - | F | Clarifications to the definition of the PreferredSearch data type | 17.7.0 | +| 2022-09 | CT#97 | CP-222050 | 0739 | - | F | allowedOperationsPerNfType IE and allowedOperationsPerNfInstance IE in NFService | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0740 | - | F | Excluding NF (service) instances or NF (service) sets from NF Discovery procedure | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0741 | - | F | SD ranges and wildcard SD | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0742 | 1 | F | Clarification on Home Network Public Key used for Routing | 17.7.0 | +| 2022-09 | CT#97 | CP-222050 | 0744 | - | F | Extend AccessTokenClaim to include producerNfServiceSetId | 17.7.0 | +| 2022-09 | CT#97 | CP-222037 | 0745 | - | F | Extend AccessTokenReq and AccessTokenclaims to include SNPN-ID | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0746 | 2 | F | No Profile Match information | 17.7.0 | +| 2022-09 | CT#97 | CP-222037 | 0747 | 1 | F | SMF UPRP capability | 17.7.0 | +| 2022-09 | CT#97 | CP-222035 | 0748 | - | F | ProSe Anchor Function Support | 17.7.0 | +| 2022-09 | CT#97 | CP-222050 | 0749 | 1 | F | IP Index in UPF Information | 17.7.0 | +| 2022-09 | CT#97 | CP-222050 | 0750 | 1 | F | NRF Altered Priority for Enhanced NF Discovery | 17.7.0 | +| 2022-09 | CT#97 | CP-222050 | 0752 | 1 | F | Service Specific Info for Default Notification Subscription | 17.7.0 | +| 2022-09 | CT#97 | CP-222038 | 0753 | 2 | F | NWDAF discovery based on Analytics Delay | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0754 | 1 | F | Unknown NF Instance Id in subscription | 17.7.0 | +| 2022-09 | CT#97 | CP-222026 | 0755 | - | F | Clarification of NF Discovery Service Description | 17.7.0 | +| 2022-09 | CT#97 | CP-222058 | 0759 | - | F | 29.510 Rel-17 API version and External doc update | 17.7.0 | +| 2022-09 | CT#97 | CP-222021 | 0733 | - | B | Additional HSS Diameter Addresses in HssInfo | 18.0.0 | +| 2022-09 | CT#97 | CP-222021 | 0735 | 2 | B | Locality based NF Discovery enhancements | 18.0.0 | +| 2022-09 | CT#97 | CP-222021 | 0756 | 1 | B | Allowed Operations per NF Type or NF Instance | 18.0.0 | +| 2022-09 | CT#97 | CP-222025 | 0761 | - | F | 29.510 Rel-18 API version and External doc update | 18.0.0 | +| 2022-12 | CT#98 | CP-223029 | 0737 | 2 | B | SEPP registration and discovery with N32 purpose | 18.1.0 | +| 2022-12 | CT#98 | CP-223067 | 0765 | 1 | A | Notification Type for Delivery of Ciphering Key Information | 18.1.0 | +| 2022-12 | CT#98 | CP-223029 | 0766 | 3 | F | IP Ranges and IP Index | 18.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------------|--------| +| 2022-12 | CT#98 | CP-223027 | 0767 | 1 | F | Default network instance for a S-NSSAI and DNN | 18.1.0 | +| 2022-12 | CT#98 | CP-223029 | 0768 | 2 | B | UPF Selection | 18.1.0 | +| 2022-12 | CT#98 | CP-223088 | 0769 | 2 | B | Discovery by SCP of complete NF Profile | 18.1.0 | +| 2022-12 | CT#98 | CP-223044 | 0772 | 2 | A | NSACF Discovery with Locality | 18.1.0 | +| 2022-12 | CT#98 | CP-223090 | 0773 | 2 | B | Preferred Features | 18.1.0 | +| 2022-12 | CT#98 | CP-223029 | 0774 | 3 | B | SMSF For Roaming UEs | 18.1.0 | +| 2022-12 | CT#98 | CP-223027 | 0775 | - | F | Additional HSS Diameter Addresses in HssInfo | 18.1.0 | +| 2022-12 | CT#98 | CP-223027 | 0782 | 1 | F | OpenApi Semantic Checks | 18.1.0 | +| 2022-12 | CT#98 | CP-223027 | 0783 | - | F | Clarification of IpEndPoint | 18.1.0 | +| 2022-12 | CT#98 | CP-223029 | 0784 | 2 | F | Optimization of NF service discovery for avoiding duplicated signaling overhead | 18.1.0 | +| 2022-12 | CT#98 | CP-223033 | 0785 | - | F | 29.510 Rel-18 API version and External doc update | 18.1.0 | +| 2023-03 | CT#99 | CP-230077 | 0789 | 2 | F | Reusing tai-list URI query parameter for 5MBS | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0791 | 1 | F | Interpretation of False Value in Query Parameters | 18.2.0 | +| 2023-03 | CT#99 | CP-230085 | 0793 | 3 | A | AMF Support for High Latency Communication | 18.2.0 | +| 2023-03 | CT#99 | CP-230034 | 0794 | - | B | Registration and Discovery of UPF Event Exposure service | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0795 | 1 | B | Retrieving NF profiles of a list of target NF Instance IDs | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0796 | - | F | nfServiceList in NotificationData | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0797 | 1 | F | nfSetId in AMF profile | 18.2.0 | +| 2023-03 | CT#99 | CP-230057 | 0798 | - | F | allowedSnpons in NF profile and requester-snpon-list in NF Discovery Request | 18.2.0 | +| 2023-03 | CT#99 | CP-230057 | 0799 | - | F | plmnList IE in NF profile of an NF pertaining to an SNPN | 18.2.0 | +| 2023-03 | CT#99 | CP-230059 | 0800 | - | F | requesterSnssaiList IE in Access Token Request | 18.2.0 | +| 2023-03 | CT#99 | CP-230077 | 0802 | - | A | Errors in the definition of the collocatedNfInstances IE | 18.2.0 | +| 2023-03 | CT#99 | CP-230034 | 0805 | 1 | B | Discovery of the serving UPF for a PDU session using NATed IP address | 18.2.0 | +| 2023-03 | CT#99 | CP-230081 | 0807 | - | A | Nudm UE Identifier Service | 18.2.0 | +| 2023-03 | CT#99 | CP-230094 | 0810 | - | A | Essential Correction for Requester-Features Query Parameter | 18.2.0 | +| 2023-03 | CT#99 | CP-230029 | 0812 | - | F | Lower case of UUIDs in URIs | 18.2.0 | +| 2023-03 | CT#99 | CP-230064 | 0816 | 2 | F | URI scheme used for inter-PLMN signalling | 18.2.0 | +| 2023-03 | CT#99 | CP-230071 | 0817 | - | F | 29.510 Rel-18 API version and External doc update | 18.2.0 | +| 2023-06 | CT#100 | CP-231025 | 0819 | - | F | allowedNfTypes contradiction correction | 18.3.0 | +| 2023-06 | CT#100 | CP-231031 | 0820 | 1 | B | PRU serving LMF(s) discovery | 18.3.0 | +| 2023-06 | CT#100 | CP-231122 | 0821 | 2 | B | GNSS assistance data collection from AF | 18.3.0 | +| 2023-06 | CT#100 | CP-231047 | 0823 | 1 | B | NWDAF selection on support ML model sharing | 18.3.0 | +| 2023-06 | CT#100 | CP-231084 | 0827 | 1 | A | Align the description of Requester PLMN List IEs | 18.3.0 | +| 2023-06 | CT#100 | CP-231123 | 0828 | 1 | B | Enhancement of NRF services to support DCSF registration and discovery | 18.3.0 | +| 2023-06 | CT#100 | CP-231079 | 0832 | - | A | Handling of NRF Subscriptions in SNPN scenarios | 18.3.0 | +| 2023-06 | CT#100 | CP-231028 | 0833 | 1 | F | Content of Profile Update response messages | 18.3.0 | +| 2023-06 | CT#100 | CP-231035 | 0835 | 2 | F | Clarification for NATed IP Address | 18.3.0 | +| 2023-06 | CT#100 | CP-231035 | 0836 | 1 | B | Registration and Discovery of Nupf_GetPrivateUEIPaddr service | 18.3.0 | +| 2023-06 | CT#100 | CP-231050 | 0837 | 3 | B | NRF service enhancement to support MRF registration and discovery | 18.3.0 | +| 2023-06 | CT#100 | CP-231078 | 0840 | 1 | A | Add service Npanf_ResolveRemoteUserId | 18.3.0 | +| 2023-06 | CT#100 | CP-231078 | 0842 | 1 | A | Add service Npkmf_ResolveRemoteUserId | 18.3.0 | +| 2023-06 | CT#100 | CP-231042 | 0843 | - | B | Add PCF capability of supporting 5G ProSe UE-to-UE relay | 18.3.0 | +| 2023-06 | CT#100 | CP-231050 | 0844 | 3 | B | NRF service enhancement to support DCMF registration and discovery | 18.3.0 | +| 2023-06 | CT#100 | CP-231073 | 0846 | - | A | Default Notification for Inter-Plmn Access | 18.3.0 | +| 2023-06 | CT#100 | CP-231028 | 0847 | 1 | B | Indication of Ignored Query Parameters | 18.3.0 | +| 2023-06 | CT#100 | CP-231084 | 0849 | 1 | A | Unsupported Query Parameter Handling | 18.3.0 | +| 2023-06 | CT#100 | CP-231047 | 0850 | - | B | Accuracy checking capability in NWDAF | 18.3.0 | +| 2023-06 | CT#100 | CP-231047 | 0851 | 2 | B | NWDAF containing MTLF selection | 18.3.0 | +| 2023-06 | CT#100 | CP-231071 | 0854 | 2 | A | Removal of OpenAPI constraint for interPlmnFqdn in NotificationData | 18.3.0 | +| 2023-06 | CT#100 | CP-231028 | 0855 | - | D | Typo correction | 18.3.0 | +| 2023-06 | CT#100 | CP-231070 | 0856 | - | F | 29.510 Rel-18 API version and External doc update | 18.3.0 | +| 2023-09 | CT#101 | CP-232033 | 0770 | 5 | B | Enhancements to Authorization Policy in NF-Service Profile | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0852 | 4 | B | Support for Canary Testing via NRF | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0858 | - | F | NefInfo clarification | 18.4.0 | +| 2023-09 | CT#101 | CP-232050 | 0859 | 1 | B | NEF Registration and Discovery for Multi-member AF session capability | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0863 | 1 | B | Additional OAuth2 scope for the NRF Management API | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0864 | 1 | B | Prefix in Callback URIs | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0865 | - | F | Array cardinality correction | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0867 | 2 | B | NF Instances supporting at least one TA in the ta-list | 18.4.0 | +| 2023-09 | CT#101 | CP-232042 | 0868 | 2 | B | Extension of NWDAF registration information to reflect roaming exchange capability | 18.4.0 | +| 2023-09 | CT#101 | CP-232050 | 0869 | 1 | B | New PCF and NEF services | 18.4.0 | +| 2023-09 | CT#101 | CP-232050 | 0870 | - | B | New PDTQ related UDR PolicyData subset | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0871 | - | F | Removal of OpenAPI constraint for interPlmnFqdn in NotificationData | 18.4.0 | +| 2023-09 | CT#101 | CP-232046 | 0872 | - | B | PCF selection for A2X | 18.4.0 | +| 2023-09 | CT#101 | CP-232045 | 0873 | 1 | B | Missing ims-domain-name and media-capability-list in the OpenAPI of Nnrf_NFDiscovery Service API | 18.4.0 | +| 2023-09 | CT#101 | CP-232035 | 0874 | 1 | B | Support PRU function of LMF profile | 18.4.0 | +| 2023-09 | CT#101 | CP-232047 | 0876 | 1 | A | Default Notification Type for UUAA-MM | 18.4.0 | +| 2023-09 | CT#101 | CP-232033 | 0877 | 2 | B | Preferred UPF Selection for Non-3GPP PDU Session | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232078 | 0881 | 1 | A | Essential Correction on Notification Data for NF Instance Removed from NF Set | 18.4.0 | +| 2023-09 | CT#101 | CP-232042 | 0883 | 1 | B | ADRF registration and discovery | 18.4.0 | +| 2023-09 | CT#101 | CP-232042 | 0885 | 1 | B | Support for relocation of data subscription as a new capability of DCCF | 18.4.0 | +| 2023-09 | CT#101 | CP-232045 | 0886 | 3 | F | Change DCMF to MF | 18.4.0 | +| 2023-09 | CT#101 | CP-232049 | 0887 | 1 | B | Update on LMF selection for Ranging_SL | 18.4.0 | +| 2023-09 | CT#101 | CP-232049 | 0888 | 2 | B | Update on PCF selection for Ranging_SL | 18.4.0 | +| 2023-09 | CT#101 | CP-232060 | 0890 | - | F | 29.510 Rel-18 API version and External doc update | 18.4.0 | +| 2023-12 | CT#102 | CP-233046 | 0893 | 4 | B | NSACF Role Definition | 18.5.0 | +| 2023-12 | CT#102 | CP-233039 | 0895 | 1 | B | NSACF Capability for counting the number of UEs with at least one PDU session / PDN connection | 18.5.0 | +| 2023-12 | CT#102 | CP-233027 | 0896 | - | F | PGW IP addresses in SmfInfo | 18.5.0 | +| 2023-12 | CT#102 | CP-233028 | 0897 | 1 | B | Callback URI prefix | 18.5.0 | +| 2023-12 | CT#102 | CP-233027 | 0898 | - | F | Corrections of the service-names and validityPeriod IEs | 18.5.0 | +| 2023-12 | CT#102 | CP-233059 | 0900 | 1 | B | Mapping between Routing Indicator and NF Group ID | 18.5.0 | +| 2023-12 | CT#102 | CP-233027 | 0901 | - | B | Resolution of Editor's Note on Canary Release tests | 18.5.0 | +| 2023-12 | CT#102 | CP-233028 | 0902 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.5.0 | +| 2023-12 | CT#102 | CP-233030 | 0903 | 2 | F | Clarification of lpEndpoint data structure | 18.5.0 | +| 2023-12 | CT#102 | CP-233029 | 0904 | 1 | B | ProblemDetails RFC 7807 obsoleted by 9457 | 18.5.0 | +| 2023-12 | CT#102 | CP-233048 | 0906 | - | B | Remove EN for IP address and IP range used for MF registration and discovery | 18.5.0 | +| 2023-12 | CT#102 | CP-233045 | 0909 | - | F | Completing the description of roaming-exchange-ind | 18.5.0 | +| 2023-12 | CT#102 | CP-233045 | 0910 | 1 | B | Completion and alignment of ADRF information for registration and discovery | 18.5.0 | +| 2023-12 | CT#102 | CP-233037 | 0911 | 1 | B | User plane positioning capability of LMF | 18.5.0 | +| 2023-12 | CT#102 | CP-233031 | 0914 | 6 | B | Indication in NF registration for authorization based on sufficient slice information | 18.5.0 | +| 2023-12 | CT#102 | CP-233050 | 0915 | - | B | Update to support SLPKMF | 18.5.0 | +| 2023-12 | CT#102 | CP-233064 | 0918 | 6 | B | NSAC service area support for hplmn and vplmn NF consumers | 18.5.0 | +| 2023-12 | CT#102 | CP-233047 | 0919 | - | F | Missing DataSetIds in UdrInfo | 18.5.0 | +| 2023-12 | CT#102 | CP-233069 | 0921 | - | A | Service Name for Npkmf_Discovery Service | 18.5.0 | +| 2023-12 | CT#102 | CP-233031 | 0923 | 3 | B | S-NSSAIs in NF Discovery Result | 18.5.0 | +| 2023-12 | CT#102 | CP-233041 | 0925 | 1 | B | Discovering all the NF profiles or NF Instance IDs matching the query parameters | 18.5.0 | +| 2023-12 | CT#102 | CP-233032 | 0926 | - | B | Nnef_DNAIMapping service | 18.5.0 | +| 2023-12 | CT#102 | CP-233038 | 0927 | - | B | Nnef_TrafficInfluenceData and Nnef_ECSAddress services | 18.5.0 | +| 2023-12 | CT#102 | CP-233044 | 0928 | - | F | Naf_ProSe and Naf_EventExposure services | 18.5.0 | +| 2023-12 | CT#102 | CP-233044 | 0929 | - | F | Incorrect cardinality of the mbs-session-id-list query parameter | 18.5.0 | +| 2023-12 | CT#102 | CP-233063 | 0931 | - | A | MBS services and data set | 18.5.0 | +| 2023-12 | CT#102 | CP-233075 | 0932 | 1 | B | Additional User Plane Interfaces | 18.5.0 | +| 2023-12 | CT#102 | CP-233031 | 0933 | 2 | B | Traffic Separation at User Plane Interfaces | 18.5.0 | +| 2023-12 | CT#102 | CP-233048 | 0935 | 1 | B | Update the MediaCapability data type to string | 18.5.0 | +| 2023-12 | CT#102 | CP-233045 | 0936 | 3 | F | Corrections of the input parameters for discovery of NWDAF with FL capability | 18.5.0 | +| 2023-12 | CT#102 | CP-233050 | 0937 | - | F | Correction of query parameter Ranging-SI-Pos-Indication | 18.5.0 | +| 2023-12 | CT#102 | CP-233059 | 0938 | 4 | B | Simplifying the NF service discovery response of inter-PLMN | 18.5.0 | +| 2023-12 | CT#102 | CP-233046 | 0942 | 1 | B | Extending the description of sNSSAIs to SNPn | 18.5.0 | +| 2023-12 | CT#102 | CP-233032 | 0943 | 1 | B | Aligning the service name with stage-2 specification | 18.5.0 | +| 2023-12 | CT#102 | CP-233045 | 0945 | 1 | B | Adding new data analytics services in enumeration table | 18.5.0 | +| 2023-12 | CT#102 | CP-233060 | 0947 | - | F | 29.510 Rel-18 API version and External doc update | 18.5.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29517/raw.md b/marked/Rel-18/29_series/29517/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..50a202fd31488b7bfe869bc5e4ee1d02576afa40 --- /dev/null +++ b/marked/Rel-18/29_series/29517/raw.md @@ -0,0 +1,3022 @@ + + +# 3GPP TS 29.517 V18.4.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Application Function 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, 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** + +## --- 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 +Intpp.org + +## --- **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..... | 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 Naf_EventExposure Service ..... | 9 | +| 4.1 Service Description ..... | 9 | +| 4.1.1 Overview ..... | 9 | +| 4.1.2 Service Architecture ..... | 10 | +| 4.1.3 Network Functions ..... | 10 | +| 4.1.3.1 Application Function (AF)..... | 10 | +| 4.1.3.2 NF Service Consumers ..... | 10 | +| 4.2 Service Operations ..... | 11 | +| 4.2.1 Introduction ..... | 11 | +| 4.2.2 Naf_EventExposure_Subscribe service operation..... | 11 | +| 4.2.2.1 General..... | 11 | +| 4.2.2.2 Creating a new subscription..... | 12 | +| 4.2.2.3 Modifying an existing subscription ..... | 16 | +| 4.2.3 Naf_EventExposure_Unsubscribe service operation ..... | 17 | +| 4.2.3.1 General..... | 17 | +| 4.2.3.2 Unsubscription from event notifications..... | 17 | +| 4.2.4 Naf_EventExposure_Notify service operation..... | 18 | +| 4.2.4.1 General..... | 18 | +| 4.2.4.2 Notification about subscribed events ..... | 18 | +| 5 Naf_EventExposure Service API..... | 20 | +| 5.1 Introduction ..... | 20 | +| 5.2 Usage of HTTP..... | 20 | +| 5.2.1 General ..... | 20 | +| 5.2.2 HTTP standard headers ..... | 21 | +| 5.2.2.1 General..... | 21 | +| 5.2.2.2 Content type..... | 21 | +| 5.2.3 HTTP custom headers ..... | 21 | +| 5.2.3.1 General..... | 21 | +| 5.3 Resources ..... | 21 | +| 5.3.1 Resource Structure..... | 21 | +| 5.3.2 Resource: Application Event Subscriptions ..... | 22 | +| 5.3.2.1 Description..... | 22 | +| 5.3.2.2 Resource definition..... | 22 | +| 5.3.2.3 Resource Standard Methods ..... | 22 | +| 5.3.2.3.1 POST ..... | 22 | +| 5.3.3 Resource: Individual Application Event Subscription ..... | 23 | +| 5.3.3.1 Description..... | 23 | +| 5.3.3.2 Resource definition..... | 23 | +| 5.3.3.3 Resource Standard Methods ..... | 23 | +| 5.3.3.3.1 GET ..... | 23 | +| 5.3.3.3.2 PUT ..... | 24 | +| 5.3.3.3.3 DELETE..... | 25 | +| 5.4 Custom Operations without associated resources ..... | 27 | +| 5.5 Notifications ..... | 27 | +| 5.5.1 General ..... | 27 | +| 5.5.2 Application Event Notification..... | 27 | +| 5.5.2.1 Description..... | 27 | + +| | | | +|--------------------------------------------------------|-------------------------------------------------|-----------| +| 5.5.2.2 | Target URI ..... | 27 | +| 5.5.2.3 | Standard Methods ..... | 27 | +| 5.5.2.3.1 | POST ..... | 27 | +| 5.6 | Data Model..... | 28 | +| 5.6.1 | General ..... | 28 | +| 5.6.2 | Structured data types ..... | 32 | +| 5.6.2.1 | Introduction..... | 32 | +| 5.6.2.2 | Type AfEventExposureSubsc ..... | 32 | +| 5.6.2.3 | Type AfEventExposureNotif ..... | 32 | +| 5.6.2.4 | Type EventsSubs..... | 33 | +| 5.6.2.5 | Type EventFilter ..... | 34 | +| 5.6.2.6 | Type AfEventNotification ..... | 36 | +| 5.6.2.7 | Type ServiceExperienceInfoPerApp ..... | 38 | +| 5.6.2.8 | Type ServiceExperienceInfoPerFlow ..... | 39 | +| 5.6.2.9 | Type SvcExperience ..... | 39 | +| 5.6.2.10 | Type UeMobilityCollection..... | 39 | +| 5.6.2.11 | Type UeCommunicationCollection ..... | 40 | +| 5.6.2.12 | Type UeTrajectoryCollection ..... | 40 | +| 5.6.2.13 | Type CommunicationCollection..... | 40 | +| 5.6.2.14 | Type ExceptionInfo ..... | 41 | +| 5.6.2.15 | Type UserDataCongestionCollection ..... | 41 | +| 5.6.2.16 | Type PerformanceDataCollection..... | 41 | +| 5.6.2.17 | Type PerformanceData ..... | 42 | +| 5.6.2.18 | Type AddrFqdn..... | 42 | +| 5.6.2.19 | Type CollectiveBehaviourFilter ..... | 43 | +| 5.6.2.20 | Type CollectiveBehaviourInfo ..... | 43 | +| 5.6.2.21 | Type DispersionCollection ..... | 44 | +| 5.6.2.22 | Type PerUeAttribute..... | 44 | +| 5.6.2.23 | Type MsQoeMetricsCollection..... | 44 | +| 5.6.2.24 | Type MsConsumptionCollection..... | 45 | +| 5.6.2.25 | Type MsNetAssInvocationCollection..... | 45 | +| 5.6.2.26 | Type MsDynPolicyInvocationCollection ..... | 45 | +| 5.6.2.27 | Type MSAccessActivityCollection ..... | 45 | +| 5.6.2.28 | Type DatVolTransTimeCollection ..... | 46 | +| 5.6.3 | Simple data types and enumerations ..... | 46 | +| 5.6.3.1 | Introduction..... | 46 | +| 5.6.3.2 | Simple data types..... | 46 | +| 5.6.3.3 | Enumeration: AfEvent ..... | 46 | +| 5.6.3.4 | Enumeration: CollectiveBehaviourFilterType..... | 47 | +| 5.7 | Error handling ..... | 48 | +| 5.7.1 | General ..... | 48 | +| 5.7.2 | Protocol Errors..... | 48 | +| 5.7.3 | Application Errors ..... | 48 | +| 5.8 | Feature negotiation..... | 48 | +| 5.9 | Security..... | 50 | +| Annex A (normative): OpenAPI specification..... | | 51 | +| A.1 | General..... | 51 | +| A.2 | Naf_EventExposure API..... | 51 | +| Annex B (informative): Change history ..... | | 67 | + +# 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 stage 3 protocol and data model for the Application Function Event Exposure Service of the 5G System. It provides stage 3 protocol definitions, message flows and specifies the API for the Naf\_EventExposure 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.288 [4]. + +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 Application Function Event Exposure Service is provided by the Application Function (AF). This service exposes service experience events observed at 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 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". +- [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] IETF RFC 9113: "HTTP/2". +- [8] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] IETF RFC 9457: "Problem Details for HTTP APIs". +- [11] 3GPP TR 21.900: "Technical Specification Group working methods". +- [12] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [13] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [14] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [15] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [16] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". + +- [17] 3GPP TS 29.122: "T8 reference point for northbound Application Programming Interfaces (APIs)". +- [18] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [19] 3GPP TS 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [20] Void. +- [21] IETF RFC 9112: "HTTP/1.1". +- [22] IETF RFC 9110: "HTTP Semantics". +- [23] Void. +- [24] Void. +- [25] IETF RFC 9111: "HTTP Caching". +- [26] Void. +- [27] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [28] 3GPP TS 26.531: "Data Collection and Reporting; General Description and Architecture". +- [29] 3GPP TS 26.501: "5G Media Streaming (5GMS); General description and architecture". +- [30] 3GPP TS 26.512: "5G Media Streaming (5GMS); Protocols". +- [31] 3GPP TS 29.591: "5G System; Network Exposure Function Southbound Services; Stage 3". +- [32] 3GPP TS 23.273: "5G System (5GS) Location Services (LCS); 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]. + +(None) + +## 3.2 Symbols + +For the purposes of the present document, the following symbols apply: + +(None) + +## 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]. + +| | | +|------|----------------------------------------| +| 5GMS | 5G Media Streaming | +| AF | Application Function | +| ASP | Application Service Provider | +| DCCF | Data Collection Coordination Function | +| DNAI | DN Access Identifier | +| GPSI | Generic Public Subscription Identifier | +| LCS | LoCation Services | + +| | | +|-------|--------------------------------------| +| LMF | Location Management Function | +| MFAF | Messaging Framework Adaptor Function | +| NEF | Network Exposure Function | +| NF | Network Function | +| NWDAF | Network Data Analytics Function | +| SUPI | Subscription Permanent Identifier | +| URI | Uniform Resource Identifier | + +# --- 4 Naf\_EventExposure Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The Application Function Exposure Service, as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.288 [4], is provided by the Application Function (AF). When the UE Application data is collected via the Data Collection AF, the Application Function Exposure Service, as defined in 3GPP TS 26.531 [28], 3GPP TS 26.501 [29], and 3GPP TS 26.512 [30], is provided by the Data Collection AF instantiated in 5GMS AF for the Event Consumer AF instantiated in 5GMS ASP. + +This service: + +- allows NF service consumers to subscribe, modify and unsubscribe for application events; and +- notifies NF service consumers with a corresponding subscription about observed events on the AF. + +The types of observed events include: + +AF application events exposed by AF: + +- Service Experience information for an application; +- UE mobility information; +- UE communication information; +- Exceptions information; +- User Data Congestion information; +- Collective Behaviour information; +- Dispersion information; and +- Performance Data information; +- GNSS Assistance Data information + +UE application events exposed via Data Collection AF: + +- Media Streaming QoE metrics; +- Media Streaming Consumption reports; +- Media Streaming Network Assistance invocation; +- Media Streaming Dynamic Policy invocation; and +- Media Streaming access activity. + +When the event to which the NF service consumer has subscribed occurs, the AF 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]). + +### 4.1.2 Service Architecture + +The Data Analytics Architecture is defined in 3GPP TS 23.288 [4]. The Media Streaming UE application data collection via the Data Collection AF is defined in 3GPP TS 26.531 [28]. The architecture for GNSS Assistance Data Collection for LCS is defined in 3GPP TS 23.273 [27]. + +The Application Function Exposure Service (Naf\_EventExposure) is part of the Naf service-based interface exhibited by the Application Function (AF). + +The known NF service consumers of the Naf\_EventExposure service are the Network Exposure Function (NEF), the Network Data Analytics Function (NWDAF), the Location Management Function (LMF), the Data Collection Coordination Function (DCCF), the Messaging Framework Adaptor Function (MFAF), or the Event Consumer AF in the 5GMS ASP. + +The Naf\_EventExposure service is provided by the AF and consumed by NF service consumers (e.g. NEF, NWDAF, DCCF, MFAF, Event Consumer 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: Naf_EventExposure service Architecture, SBI representation. This diagram shows the Service Based Interface (SBI) representation. At the top, a box labeled 'AF' contains an oval labeled 'Naf'. Below this, a vertical line descends to a horizontal line labeled 'Naf_EventExposure'. From this horizontal line, six vertical lines descend to a row of six boxes: 'Event Consumer AF', 'NWDAF', 'DCCF', 'MFAF', 'NEF', and 'LMF'.](54fabc351eda5228d2fa28cd9ba07971_img.jpg) + +Figure 4.1.2-1: Naf\_EventExposure service Architecture, SBI representation. This diagram shows the Service Based Interface (SBI) representation. At the top, a box labeled 'AF' contains an oval labeled 'Naf'. Below this, a vertical line descends to a horizontal line labeled 'Naf\_EventExposure'. From this horizontal line, six vertical lines descend to a row of six boxes: 'Event Consumer AF', 'NWDAF', 'DCCF', 'MFAF', 'NEF', and 'LMF'. + +Figure 4.1.2-1: Naf\_EventExposure service Architecture, SBI representation + +![Figure 4.1.2-2: Naf_EventExposure service Architecture, reference point representation. This diagram shows the reference point representation. At the top, a box labeled 'AF' has six lines radiating downwards to a row of six boxes: 'Event Consumer AF', 'NWDAF', 'DCCF', 'MFAF', 'NEF', and 'LMF'. Each line has a small horizontal tick mark near the top box.](b0211cee4b20034939d883ac0d70f696_img.jpg) + +Figure 4.1.2-2: Naf\_EventExposure service Architecture, reference point representation. This diagram shows the reference point representation. At the top, a box labeled 'AF' has six lines radiating downwards to a row of six boxes: 'Event Consumer AF', 'NWDAF', 'DCCF', 'MFAF', 'NEF', and 'LMF'. Each line has a small horizontal tick mark near the top box. + +Figure 4.1.2-2: Naf\_EventExposure service Architecture, reference point representation + +### 4.1.3 Network Functions + +#### 4.1.3.1 Application Function (AF) + +The AF is a functional element that provides service or application related information to NF service consumers. + +The AF allows NF service consumers to subscribe to and unsubscribe from periodic notifications and/or notifications related to the detection of subscribed event. + +#### 4.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF), the Data Collection Coordination Function (DCCF), and the Messaging Framework Adaptor Function (MFAF): + +- supports (un)subscribing to notifications of event(s) as described in clause 4.2.2.1; +- supports receiving the notifications of subscribed event(s) from the AF. + +The Network Exposure Function (NEF): + +- supports (un)subscribing to notifications of event(s) as described in clause 4.2.2.1; +- supports receiving the notifications of subscribed event(s) from the AF. + +The Event Consumer Application Function (Event Consumer AF): + +- supports (un)subscribing to notifications of event(s) as described in clause 4.2.2.1; +- supports receiving the notifications of subscribed event(s) from the Data Collection AF. + +The Location Management Function (LMF): + +- supports (un)subscribing to notifications of event(s) as described in clause 4.2.2.1; +- supports receiving the notifications of subscribed event(s) from the AF. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +Service operations defined for the Naf\_EventExposure Service are shown in table 4.2.1-1. + +**Table 4.2.1-1: Naf\_EventExposure Service Operations** + +| Service Operation Name | Description | Initiated by | +|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------| +| Naf_EventExposure_Subscribe | This service operation is used by an NF service consumer to subscribe to, or modify a subscription in the AF for event notifications on a specified application related event for one or more UE(s) or any UE. | NF Consumer (NWDAF, NEF, Event Consumer AF) | +| Naf_EventExposure_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe from event notifications. | NF Consumer (NWDAF, NEF, Event Consumer AF) | +| Naf_EventExposure_Notify | This service operation is used by the AF to report application related event(s) to the NF service consumer which has subscribed to the event report service. | AF/Data Collection AF | + +### 4.2.2 Naf\_EventExposure\_Subscribe service operation + +#### 4.2.2.1 General + +This service operation is used by an NF service consumer to subscribe for event notifications on specific event(s), or to modify an existing subscription. + +The following are the types of events for which a subscription can be made by the NWDAF, DCCF, MFAF, or NEF as the NF service consumer: + +- Service Experience information for an application; +- UE mobility information; +- UE communication information; +- Exceptions information; + +- User Data Congestion information; +- Collective Behaviour information; +- Dispersion information; and +- Performance Data information. +- End-to-end data volume transfer time information. + +The following are the types of events for which a subscription can be made by the NWDAF, DCCF, MFAF, Event Consumer AF, or NEF as the NF service consumer: + +- Media Streaming QoE metrics. + +The following are the types of events for which a subscription can be made by the Event Consumer AF or NEF as the NF service consumer: + +- Media Streaming Consumption reports; +- Media Streaming Network Assistance invocation; +- Media Streaming Dynamic Policy invocation; and +- Media Streaming access activity. + +The following are the types of events for which a subscription can be made by the LMF or NEF as the NF service consumer: + +- GNSS Assistance Data information + +The following procedures using the Naf\_EventExposure\_Subscribe service operation are supported: + +- creating a new subscription; +- modifying an existing subscription. + +#### 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 an AF, and the AF responds with a 201 Created status.](426efb7efdc753a13f2fa16f7bff9429_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant AF + Note right of NF service consumer: 1. POST .../subscriptions + NF service consumer->>AF: Request + Note left of AF: 2. "201 Created" + AF-->>NF service consumer: Response +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to an AF, and the AF 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 to the AF with: "{apiRoot}/naf-eventexposure//subscriptions" as request URI as shown in step 1 of figure 4.2.2.2-1, and the "AfEventExposureSubsc" data structure as request body. + +The "AfEventExposureSubsc" data structure shall include: + +- description of subscribed event information as "eventsSubs" attribute by using one or more "EventsSubs" data; + +- description of the event reporting information as "eventsRepInfo" attribute; +- a URI where to receive the requested notifications as "notifUri" attribute; +- a Notification Correlation Identifier assigned by the NF service consumer for the requested notifications as "notifId" attribute. + +The "AfEventExposureSubsc" data may include: + +- a specific Authorization AS provisioned Data Access Profile Identifier as "dataAccProfId" attribute, if the feature "DataAccProfileId" is supported and the subscribed events including "MS\_QOE\_METRICS", "MS\_CONSUMPTION", "MS\_NET\_ASSIST\_INVOCATION", "MS\_DYN\_POLICY\_INVOCATION", and/or "MS\_ACCESS\_ACTIVITY". + +NOTE 1: The optional Data Access Profile Identifier provisioned by the Authorization AS procedures are specified in clause 5.8 of 3GPP TS 26.531 [28]. + +The "EventsSubs" data shall include: + +- a event to subscribe as a "event" attribute; and +- event filter information as "eventFilter" attribute associated with the event. + +The "eventsRepInfo" attribute may include: + +- event notification method (periodic, one time, on event detection) as "notifMethod" attribute; +- Maximum Number of Reports as "maxReportNbr" attribute; +- Monitoring Duration as "monDur" attribute; +- repetition period for periodic reporting as "repPeriod" attribute; +- immediate reporting indication as "immRep" attribute; +- sampling ratio as "sampRatio" attribute; +- partitioning criteria for partitioning the UEs before performing sampling as "partitionCriteria" attribute if the EneNA feature is supported; +- group reporting guard time as "grpRepTime" attribute; +- a notification flag as "notifFlag" attribute if the EneNA feature is supported; and/or +- notification muting exception instructions within the "notifFlagInstruc" attribute, if the EnhDataMgmt feature is supported and the "notifFlag" attribute is provided and set to "DEACTIVATE". + +The "eventFilter" shall include: + +- identification of target UE(s) to which the subscription applies via : + - 1) identification of individual UE(s) via "gpsi" attribute or "supi" attribute; or + - 2) identification of group(s) of UE(s) via "exterGroupIds" attribute or "interGroupIds" attribute; or + - 3) identification of any UE via "anyUeInd" attribute; or + - 4) identification of a UE with a specific IP address via the "uelpAddr" attribute; + +NOTE 2: It is assumed that the AF is provisioned with the list of UE IDs (GPSIs or SUPIs) belonging to an External or Internal Group ID. + +Depending on the event type: + +- if the feature "ServiceExperience" is supported and the event is "SVC\_EXPERIENCE", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + +- 2) an area of interest via "locArea" attribute. +- if the feature "Exceptions" is supported and the event is "EXCEPTIONS", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute; +- if the feature "UeCommunication" is supported and the event is "UE\_COMM", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "UeMobility" is supported and the event is "UE\_MOBILITY", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "UserDataCongestion" is supported and the event is "USER\_DATA\_CONGESTION", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "PerformanceData" is supported and the event is "PERF\_DATA", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "CollectiveBehaviour" is supported and the event is "COLLECTIVE\_BEHAVIOUR", the "eventFilter" attribute may provide: + - 1) collective attributes information via "collAttrs" attribute; + - 2) an area of interest via "locArea" attribute + - 3) identification of application to which the subscription applies via "appIds" attribute. +- if the feature "Dispersion" is supported and the event is "DISPERSION", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "MSQoeMetrics" is supported and the event is "MS\_QOE\_METRICS", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "MSConsumption" is supported and the event is "MS\_CONSUMPTION", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "MSNetAssInvocation" is supported and the event is "MS\_NET\_ASSIST\_INVOCATION", the "eventFilter" attribute may provide: + +- 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. +- if the feature "MSDynPolicyInvocation" is supported and the event is "MS\_DYN\_POLICY\_INVOCATION", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. + - if the feature "MSAccessActivity" is supported and the event is "MS\_ACCESS\_ACTIVITY", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. + - if the feature "DataVolTransferTime" is supported and the event is "E2E\_DATA\_VOL\_TRANS\_TIME", the "eventFilter" attribute may provide: + - 1) identification of application to which the subscription applies via "appIds" attribute; + - 2) an area of interest via "locArea" attribute. + +If the AF cannot successfully fulfil the received HTTP POST request due to an internal error or an error in the HTTP POST request, the AF shall send the HTTP error response as specified in clause 5.7. + +Upon successful reception of the HTTP POST request with "{apiRoot}/naf-eventexposure//subscriptions" as request URI and "AfEventExposureSubsc" data structure as request body, the AF shall create a new "Individual Application Event Subscription" resource, store the subscription and send an HTTP "201 Created" response as shown in step 2 of figure 4.2.2.2-1, containing: + +- a Location header field; and +- an "AfEventExposureSubsc" data type in the content. + +The Location header field shall contain the URI of the created individual application session context resource i.e. "{apiRoot}/naf-eventexposure//subscriptions/{subscriptionId}". + +The "AfEventExposureSubsc" data type content shall contain the representation of the created "Individual Application Event Subscription". + +When the "monDur" attribute is included in the response by the AF, it represents AF selected expiry time that is equal or less than the expiry time received in the request. + +When the "immRep" attribute is included and sets to "true" in the subscription and the subscribed events are available, the AF shall include the reports of the events subscribed, if available, in the HTTP POST response. + +When the sampling ratio as, "sampRatio" attribute, is included in the subscription without a "partitionCriteria" attribute, the AF 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 AF 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 AF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then the AF shall notify the NF service consumer using the Naf\_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 AF 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). When a muting exception occurs, the AF may consider the contents of the "notifFlagInstruct" attribute (if provided) and/or local configuration to determine its actions. + +If the EnhDataMgmt feature is supported and the AF accepts the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it may indicate the applied muting notification settings within the "mutingSetting" attribute in the response. If the AF does not accept the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". + +#### 4.2.2.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. The NF service consumer sends a PUT request to the AF. The AF responds with either a 200 OK or a 204 No Content.](41a438d7e4adc17c3a4005e7c9500091_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant AF as AF + Note right of NF: 1. PUT .../subscriptions/{subscriptionId} + NF->>AF: Request + Note left of AF: 2a. 200 OK +2b. 204 No Content + AF-->>NF: Response + +``` + +Sequence diagram showing the modification of an existing subscription. The NF service consumer sends a PUT request to the AF. The AF 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}/naf-eventexposure//subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.2.2.3-1, where "{subscriptionId}" is the subscription correlation ID of the existing subscription. The "AfEventExposureSubsc" 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 request. + +NOTE 2: The "notifUri" attribute within the AfEventExposureSubsc data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +NOTE 3: The "monDur" attribute within the AfEventExposureSubsc data structure can be modified to extend the expiry time to keep receiving notifications. + +If the AF cannot successfully fulfil the received HTTP PUT request due to an internal error or an error in the HTTP PUT request, the AF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the AF determines the received HTTP PUT request needs to be redirected, the AF 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}/naf-eventexposure//subscriptions/{subscriptionId}" as request URI and "AfEventExposureSubsc" data structure as request body, the AF shall update the subscription and send either a HTTP "200 OK" response with the "AfEventExposureSubsc" data structure as response body containing the representation of the modified "Individual Application Event Subscription", or an HTTP "204 No Content" response, as shown in step 2 of figure 4.2.2.3-1. + +When the "monDur" attribute is included in the response by the AF, it represents AF selected expiry time that is equal or less than the expiry time received in the request. + +When the "immRep" attribute is included and sets to "true" in the subscription and the subscribed events are available, the AF shall include the reports of the events subscribed, if available, in the HTTP PUT response. + +When the sampling ratio, as "sampRatio" attribute, is included in the subscription without a "partitionCriteria" attribute, the AF 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 AF 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 "grpRepTime" attribute, is included in the subscription, the AF shall accumulate all the event reports for the target UEs until the group reporting guard time expires. Then, the AF shall notify the NF service consumer using the Naf\_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 AF 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). When a muting exception occurs, the AF may consider the contents of the "notifFlagInstruct" attribute (if provided) and/or local configuration to determine its actions; if the "notifFlag" attribute is set to "RETRIEVAL" in the request, the AF shall send the stored events to the NF service consumer, and 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 AF shall unmute the event notification, i.e. start sending again notifications for available events. + +If the EnhDataMgmt feature is supported and the AF accepts the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it may indicate the applied muting notification settings within the "mutingSetting" attribute in the response. If the AF does not accept the muting instructions provided in the "notifFlag" and/or the "notifFlagInstruct" attributes, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". + +### 4.2.3 Naf\_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 Naf\_EventExposure\_Unsubscribe service operation is supported: + +- unsubscribe 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 unsubscription process between an NF service consumer and an AF.](4aa740e8119817a3f9b9f72d06eaa53d_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant AF + Note right of NF service consumer: 1. DELETE .../subscriptions/{subscriptionId} + NF service consumer->>AF: 1. DELETE .../subscriptions/{subscriptionId} + Note left of AF: 2. "204 No Content" + AF-->>NF service consumer: 2. "204 No Content" +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and an AF. The first message, labeled '1. DELETE .../subscriptions/{subscriptionId}', is sent from the NF service consumer to the AF. The second message, labeled '2. "204 No Content"', is sent from the AF back to the NF service consumer. + +Sequence diagram showing the unsubscription process between an NF service consumer and an AF. + +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}/naf-eventexposure//subscriptions/{subscriptionId}" as request URI, as shown in step 1 of figure 4.2.3.2-1, where "{subscriptionId}" is the subscription correlation identifier of the existing resource subscription that is to be deleted. + +If the AF cannot successfully fulfil the received HTTP DELETE request due to an internal error or an error in the HTTP DELETE request, the AF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the AF determines the received HTTP DELETE request needs to be redirected, the AF 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}/naf-eventexposure//subscriptions/{subscriptionId}" as request URI, the AF shall remove the corresponding subscription and send an HTTP "204 No Content" response as shown in step 2 of figure 4.2.3.2-1. + +### 4.2.4 Naf\_EventExposure\_Notify service operation + +#### 4.2.4.1 General + +The Naf\_EventExposure\_Notify service operation enables the AF to notify to the NF service consumer(s) that the previously subscribed application related event occurred. + +The following procedure using the Naf\_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 an AF and an NF service consumer.](aa9441a5971655a79987d70fc551b26a_img.jpg) + +``` +sequenceDiagram + participant AF + participant NF as NF service consumer + Note right of AF: 1. POST {notifUri} + AF->>NF: + Note left of NF: 2. "204 No Content" + NF->>AF: +``` + +The diagram illustrates a sequence of two messages between an AF (Application Function) and an NF service consumer. The AF sends a POST request to the NF service consumer, labeled "1. POST {notifUri}". The NF service consumer responds with a "204 No Content" message, labeled "2. '204 No Content'". + +Sequence diagram showing the notification process between an AF and an NF service consumer. + +Figure 4.2.4.2-1: Notification about subscribed events + +If the AF observes application related event(s) for which an NF service consumer has subscribed, the AF shall send an HTTP POST request as shown in step 1 of figure 4.2.4.2-1, with the "{notifUri}" as request URI containing the value previously provided by the NF service consumer within the corresponding subscription, and the "AfEventExposureNotif" data structure. + +The "AfEventExposureNotif" data structure shall include: + +- the notification correlation ID provided by the NF service consumer during the subscription as "notifId" attribute; and +- information about the observed event(s) within the "eventNotifs" attribute that shall contain for each observed event an "AfEventNotification" data structure that shall include: + - the application related event as "event" attribute; + - the time at which the event was observed encoded as "timeStamp" attribute; + - if the "event" attribute is "SVC\_EXPERIENCE": + - service experience information about the application involved in the reported event in the "svcExprcInfos" attribute; + - if the "event" attribute is "UE\_MOBILITY": + +- UE mobility information associated with the application as "ueMobilityInfos" attribute; +- 5) if the "event" attribute is "UE\_COMM": + - application communication information associated with the application as "ueCommInfos" attribute; +- 6) if the "event" attribute is "EXCEPTIONS": + - exceptions information associated with a service flow as "excepInfos" attribute; +- 7) if the "event" attribute is "COLLECTIVE\_BEHAVIOUR": + - collective behaviour information associated with the UEs and its applications as "collBhvrInfos" attribute; +- 8) if the "event" attribute is "PERF\_DATA": + - performance data information associated with the application as "perfDataInfos" attribute; +- 9) if the "event" attribute is "USER\_DATA\_CONGESTION": + - user data congestion information collected for an AF application as "congestionInfos" attribute; and +- 10) if the "event" attribute is "DISPERSION": + - UE dispersion information collected for an AF application as "dispersionInfos" attribute. +- 11) if the "event" attribute is "MS\_QOE\_METRICS": + - Media Streaming QoE metrics information collected for an UE application via the Data Collection AF as "msQoeMetrInfos" attribute. This attribute is deprecated; the attribute "msQoeMetrics" should be used instead. + - if the "MSEventExposure" feature is supported, the Media Streaming QoE metrics information collected for an UE application via the Data Collection AF as "msQoeMetrics" attribute. +- 12) if the "event" attribute is "MS\_CONSUMPTION": + - Media Streaming Consumption reports collected for an UE application via the Data Collection AF as "msConsumpInfos" attribute. This attribute is deprecated; the attribute "msConsumpRpts" should be used instead. + - if the "MSEventExposure" feature is supported, the Media Streaming Consumption reports collected for an UE application via the Data Collection AF as "msConsumpRpts" attribute. +- 13) if the "event" attribute is "MS\_NET\_ASSIST\_INVOCATION": + - Media Streaming Network Assistance invocation collected for an UE application via the Data Collection AF as "msNetAssInvInfos" attribute. This attribute is deprecated; the attribute "msNetAssistInvs" should be used instead. + - if the "MSEventExposure" feature is supported, the Media Streaming Network Assistance invocation collected for an UE application via the Data Collection AF as "msNetAssistInvs" attribute. +- 14) if the "event" attribute is "MS\_DYN\_POLICY\_INVOCATION": + - Media Streaming Dynamic Policy invocation collected for an UE application via the Data Collection AF as "msDynPlyInvInfos" attribute. This attribute is deprecated; the attribute "msDynPlyInvs" should be used instead. + - if the "MSEventExposure" feature is supported, the Media Streaming Dynamic Policy invocation collected for an UE application via the Data Collection AF as "msDynPlyInvs" attribute. +- 15) if the "event" attribute is "MS\_ACCESS\_ACTIVITY": + - Media Streaming access activity collected for an UE application via the Data Collection AF as "msAccActInfos" attribute. This attribute is deprecated; the attribute "msAccesses" should be used instead. + +- if the "MSEventExposure" feature is supported, the Media Streaming access activity collected for an UE application via the Data Collection AF as "msAccesses" attribute. + +16) if the "event" attribute is "GNSS\_ASSISTANCE\_DATA": + +- GNSS Assistance Data information within the "gnssAssistDataInfo" attribute; + +17) if the "event" attribute is "E2E\_DATA\_VOL\_TRANS\_TIME": + +- data volume transfer information associated with the application as "datVolTransTimeInfos" 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 "{notifiUri}" as request URI and "AfEventExposureNotif" data structure as request body, the NF service consumer shall send a "204 No Content" HTTP response, as shown in step 2 of figure 4.2.4.2-1. + +# --- 5 Naf\_EventExposure Service API + +## 5.1 Introduction + +The Naf\_EventExposure Service shall use the Naf\_EventExposure API. + +The API URI of the Naf\_EventExposure API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the AF 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 "naf-eventexposure". +- The shall be "v1". +- The shall be set as described in clause 5.3. + +## 5.2 Usage of HTTP + +### 5.2.1 General + +If the AF is untrusted, support of HTTP/1.1 (IETF RFC 9112 [21], IETF RFC 9110 [22] and IETF RFC 9111[25] over TLS is mandatory and support of HTTP/2 (IETF RFC 9113 [7]) over TLS is recommended. TLS shall be used as specified in clause 12.3 and clause 13.1 of 3GPP TS 33.501 [14]. + +If the AF is trusted, HTTP/2, IETF RFC 9113 [7], 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 [8] specification of HTTP messages and content bodies for the Naf\_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 [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 [10]. + +### 5.2.3 HTTP custom headers + +#### 5.2.3.1 General + +The Naf\_EventExposure API shall support mandatory 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 [4]. + +In this Release of the specification, no specific custom headers are defined for the Naf\_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 Naf\_EventExposure API. + +![Diagram showing the resource URI structure for the Naf_EventExposure API. The root URI is {apiRoot}/naf-eventexposure/. It branches to /subscriptions, which in turn branches to /{subscriptionId}.](c42e926097d01653b793c04b49e764b2_img.jpg) + +``` +graph TD; Root["{apiRoot}/naf-eventexposure/"] --- Subscriptions["/subscriptions"]; Subscriptions --- SubscriptionId["/{subscriptionId}"]; +``` + +Diagram showing the resource URI structure for the Naf\_EventExposure API. The root URI is {apiRoot}/naf-eventexposure/. It branches to /subscriptions, which in turn branches to /{subscriptionId}. + +**Figure 5.3.1-1: Resource URI structure of the Naf\_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 | +|-------------------------------------------|---------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------------------| +| Application Event Subscriptions | /subscriptions | POST | Subscription to the notification of application events and creation of an Individual Application Event Subscription resource. | +| Individual Application Event Subscription | /subscriptions/{subscriptionId} | GET | Reads an Individual Application Event Subscription resource. | +| | | PUT | Modifies an Individual Application Event Subscription. | +| | | DELETE | Cancels an individual subscription to notifications of application event. | + +### 5.3.2 Resource: Application Event Subscriptions + +#### 5.3.2.1 Description + +The Application Event Subscriptions resource represents all subscriptions of the Naf\_EventExposure service at a given AF. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/naf-eventexposure//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 | +|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| AfEventExposure Subsc | M | 1 | Contains the information required for the creation of a new individual application event 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 | +|-----------------------|---|-------------|----------------|----------------------------------------------------------------------------------------| +| AfEventExposure Subsc | M | 1 | 201 Created | Contains the representation of the Individual Application Event Subscription resource. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (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}/naf-eventexposure//subscriptions/{subscriptionId} | + +### 5.3.3 Resource: Individual Application Event Subscription + +#### 5.3.3.1 Description + +The Individual Application Event Subscription resource represents a single subscription of the Naf\_EventExposure service at a given AF. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/naf-eventexposure//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 AF 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 | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +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 | +|----------------------|----------|--------------------|------------------------|---------------------------------------------------------------------------------------------------------------------------| +| AfEventExposureSubsc | M | 1 | 200 OK | Contains the representation of the Individual Application Event Subscription resource. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval. Applicable if the feature "ES3XX" is supported.
(NOTE 2, NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval. Applicable if the feature "ES3XX" is supported.
(NOTE 2, NOTE 3) | + +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: If the AF is untrusted, the Redirection handling described in clause 5.2.10 of 3GPP TS 29.122 [17] should apply. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. 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 AF (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 AF (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 AF (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 AF (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 | +|----------------------|---|-------------|---------------------------------------------------------------------------| +| AfEventExposureSubsc | M | 1 | Modifies the existing Individual Application Event 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 | +|----------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------| +| AfEventExposureSubsc | M | 1 | 200 OK | Successful case.
The Individual Application Event Subscription resource was modified and a representation is returned. | +| n/a | | | 204 No Content | Successful case.
The Individual Application Event Subscription resource was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription modification.
Applicable if the feature "ES3XX" is supported.

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

(NOTE 2, NOTE 4) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 3) | + +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: If the AF is untrusted, the Redirection handling described in clause 5.2.10 of 3GPP TS 29.122 [17] should apply. +NOTE 3: Failure cases are described in clause 5.7. +NOTE 4: The RedirectResponse data structure may be provided by an SCP (cf. 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 AF (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 AF (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 AF (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 AF (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 Application Event 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, NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription termination. Applicable if the feature "ES3XX" is supported.
(NOTE 2, NOTE 3) | + +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: If the AF is untrusted, the Redirection handling described in clause 5.2.10 of 3GPP TS 29.122 [17] should apply. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. 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 AF (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 AF (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 AF (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 AF (service) instance towards which the request is redirected. | + +## 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 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) | +|--------------------------------|--------------|---------------------------------|------------------------------------------------------| +| Application Event Notification | {notifUri} | POST | Notification of application related event reporting. | + +### 5.5.2 Application Event Notification + +#### 5.5.2.1 Description + +The Application Event Notification is used by the AF to report one or several observed application related events to the NF service consumer that has subscribed to such notifications. + +#### 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 during the subscription service operation and described within the AfEventExposureSubsc data type (see table 5.6.2.2-1). | + +#### 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 | +|----------------------|---|-------------|-----------------------------------------------------------------| +| AfEventExposureNotif | M | 1 | Provides Information about observed application related 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, NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during event notification
Applicable if the feature "ES3XX" is supported.

(NOTE 2, NOTE 3) | + +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: If the AF is untrusted, the Redirection handling described in clause 5.2.10 of 3GPP TS 29.122 [17] should apply. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. 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 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 [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.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 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 [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 Naf\_EventExposure service based interface protocol. + +Table 5.6.1-1: Naf\_EventExposure specific Data Types + +| Data type | Section defined | Description | Applicability | +|---------------------------------|-----------------|-------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------| +| AddrFqdn | 5.6.2.18 | IP address and/or FQDN. | PerformanceData
ServiceExperienceExt
DataVolTransferTime | +| AfEvent | 5.6.3.3 | Represents Application Events. | | +| AfEventExposureSubsc | 5.6.2.2 | Represents an Individual Application Event Subscription resource. | | +| AfEventExposureNotif | 5.6.2.3 | Describes notifications about application event that occurred in an Individual Application Event Subscription resource. | | +| AfEventNotification | 5.6.2.6 | Represents information related to an event to be reported. | | +| CollectiveBehaviourFilter | 5.6.2.19 | Contains the parameter type and value pair to express the collective behaviour event filters. | CollectiveBehaviour | +| CollectiveBehaviourFilterType | 5.6.3.4 | | CollectiveBehaviour | +| CollectiveBehaviourInfo | 5.6.2.20 | Contains the collective behaviour analytics information. | CollectiveBehaviour | +| CommunicationCollection | 5.6.2.13 | Contains communication information. | UeCommunication | +| DataProcessingType | 5.6.3.5 | Represents a type of data processing. | ExtEventFilters | +| DatVolTransTimeCollection | 5.6.2.28 | Contains data volume transfer time information. | DataVolTransferTime | +| DispersionCollection | 5.6.2.21 | Contains Dispersion information collected. | Dispersion | +| EventFilter | 5.6.2.5 | Represents event filter information. | | +| EventsSubs | 5.6.2.4 | Represents an event to be subscribed and the related event filter information. | | +| ExceptionInfo | 5.6.2.14 | Describes the exceptions information provided by AF. | Exceptions | +| MSAccessActivityCollection | 5.6.2.27 | Represents the Media Streaming access activities of UE Application collected via Data Collection AF. | MSAccessActivity | +| MsConsumptionCollection | 5.6.2.24 | Represents the Media Streaming Consumption reports of UE Application collected via Data Collection AF. | MSConsumption | +| MsDynPolicyInvocationCollection | 5.6.2.26 | Represents the Media Streaming Dynamic Policy invocation of UE Application collected via Data Collection AF. | MSDynPolicyInvocation | +| MsQoeMetricsCollection | 5.6.2.23 | Represents the Media Streaming QoE Metrics of UE Application collected via Data Collection AF. | MSQoeMetrics | +| MsNetAssInvocationCollection | 5.6.2.25 | Represents the Media Streaming Network Assistance invocation of UE Application collected via Data Collection AF. | MSNetAssInvocation | +| PerformanceData | 5.6.2.17 | Indicates the performance data. | PerformanceData | +| PerformanceDataCollection | 5.6.2.16 | Represents the performance data information collected for an AF application. | PerformanceData | +| PerUeAttribute | 5.6.2.22 | UE application data collected per UE. | CollectiveBehaviour | +| ServiceExperienceInfoPerApp | 5.6.2.7 | Contains service experience associated with the application. | ServiceExperience | +| ServiceExperienceInfoPerFlow | 5.6.2.8 | Contains service experience associated with the service flow. | ServiceExperience | +| SvcExperience | 5.6.2.9 | Contains a mean opinion score with the customized range. | ServiceExperience | +| UeCommunicationCollection | 5.6.2.11 | Contains UE communication information associated with the application. | UeCommunication | +| UeMobilityCollection | 5.6.2.10 | Contains UE mobility information associated with the application. | UeMobility | +| UeTrajectoryCollection | 5.6.2.12 | Contains UE trajectory information associated with the application. | UeMobility | +| UserDataCongestionCollection | 5.6.2.15 | Contains User Data Congestion Analytics related | UserDataCong | + +| | | | | +|---|--|------------------------|--------| +| n | | information collected. | estion | +|---|--|------------------------|--------| + +Table 5.6.1-2 specifies data types re-used by the Naf\_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 Naf\_EventExposure service based interface. + +Table 5.6.1-2: Naf\_EventExposure re-used Data Types + +| Data type | Reference | Comments | Applicability | +|----------------------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------| +| ApplicationId | 3GPP TS 29.571 [13] | Application Identifier. | | +| BitRate | 3GPP TS 29.571 [13] | 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". | UserDataCongestion
CollectiveBehaviour | +| ConsumptionReportingUnitsCollection | 3GPP TS 26.512 [30] | Represents the collection of Media Streaming Consumption event records. | MSEventExposure | +| CpParameterSet | 3GPP TS 29.122 [17] | The Expected UE Behaviour parameters. | UeCommunicationExt eNA | +| DateTime | 3GPP TS 29.571 [13] | Contains a date and a time. | | +| Dnai | 3GPP TS 29.571 [13] | Identifies a DNAI. | | +| DurationSec | 3GPP TS 29.571 [13] | Indicates a period of time in units of seconds. | Dispersion | +| DynamicPolicy | 3GPP TS 26.512 [30] | Represents the Media Streaming Dynamic Policy. | MSDynPolicyInvocation | +| DynamicPolicyInvocationsCollection | 3GPP TS 26.512 [30] | Represents the collection of Media Streaming Dynamic Policy invocation event records. | MSEventExposure | +| EthFlowDescription | 3GPP TS 29.514 [18] | Defines a packet filter for an Ethernet flow. | | +| Exception | 3GPP TS 29.520 [19] | Describes the Exception information. | | +| ExtGroupId | 3GPP TS 29.503 [27] | External Group Identifier for a user group. | | +| Float | 3GPP TS 29.571 [13] | Number with format "float" as defined in OpenAPI Specification [8]. | | +| FlowDescription | 3GPP TS 29.514 [18] | Only IP 5-tuple (protocol, source and destination IP address, Source and destination port) is applicable. | Dispersion | +| FlowInfo | 3GPP TS 29.122 [17] | Represents flow information. | | +| GNSSAssistDataInfo | 3GPP TS 29.591 [31] | Represents GNSS Assistance Data information. | GNSSAssistData | +| Gpsi | 3GPP TS 29.571 [13] | Identifies a GPSI. | | +| GroupId | 3GPP TS 29.571 [13] | Contains a Group identifier. | | +| IpAddr | 3GPP TS 29.571 [13] | Identifies IP address. | Dispersion
EnPerformanceData | +| LocationArea5G | 3GPP TS 29.122 [17] | Represents a user location area when the UE is attached to 5G. | | +| MediaStreamingAccessesCollection | 3GPP TS 26.512 [30] | Represents the collection of Media Streaming access event records. | MSEventExposure | +| MediaStreamingAccessRecord | 3GPP TS 26.512 [30] | Represents the Media Streaming Access activity record. | MSAccessActivity | +| NetworkAssistanceInvocationsCollection | 3GPP TS 26.512 [30] | Represents the collection of Media Streaming Network Assistance invocation event records. | MSEventExposure | +| NetworkAssistanceSession | 3GPP TS 26.512 [30] | Represents the Media Streaming Network Assistance Session Recommendation. | MSNetAssInvocation | +| PacketDelBudget | 3GPP TS 29.571 [13] | Indicates average Packet Delay. | PerformanceData | +| PacketLossRate | 3GPP TS 29.571 [13] | Indicates average Loss Rate. | PerformanceData | +| QoEMetricsCollection | 3GPP TS 26.512 [30] | Represents the collection of Media Streaming QoE metrics event records. | MSEventExposure | +| RedirectResponse | 3GPP TS 29.571 [13] | Contains redirection related information. | ES3XX | +| ReportingInformation | 3GPP TS 29.523 [12] | Represents the requirements of reporting the subscription. | | +| Supi | 3GPP TS 29.571 [13] | Contains a SUPI. | | +| SupportedFeatures | 3GPP TS 29.571 [13] | Indicates the features supported. | | +| TimeWindow | 3GPP TS 29.122 [17] | Represents a time window identified by a start time and a stop time. | | +| UInteger | 3GPP TS 29.571 [13] | Unsigned integer. | ServiceExperienceExt2_eNA | +| Uri | 3GPP TS 29.571 [13] | Contains a URI. | | +| UsageThreshold | 3GPP TS 29.122 [17] | data volume during the period | Dispersion | +| Volume | 3GPP TS 29.122 [17] | Unsigned integer identifying a volume in units | | + +| | | | | +|--|--|-----------|--| +| | | of bytes. | | +|--|--|-----------|--| + +### 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 AfEventExposureSubsc + +**Table 5.6.2.2-1: Definition of type AfEventExposureSubsc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| dataAccProfileId | string | O | 0..1 | Represents a unique identifier for the Data Access Profile. | DataAccProfileId | +| eventsSubs | array(EventsSubs) | M | 1..N | Subscribed events and the related event filters. | | +| eventsRepInfo | ReportingInformation | M | 1 | Represents the reporting requirements of the subscription. (NOTE 2) | | +| notifUri | Uri | M | 1 | Notification URI for event reporting. | | +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| eventNotifs | array(AfEventNotification) | C | 1..N | Represents the Events to be reported.
Shall only be present if the immediate reporting indication in the "immRep" attribute within the "eventsRepInfo" attribute sets to true in the event subscription, and the reports are available. | | +| 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; or in the HTTP GET response if the "suppFeat" attribute query parameter is included in the HTTP GET request. (NOTE 1) | | + +NOTE 1: In the HTTP POST request it represents the set of NF service consumer supported features. In the HTTP POST and GET responses it represents the set of features supported by both the NF service consumer and the AF. + +NOTE 2: The "eventsRepInfo" attribute may include muting instructions within the "notifFlagInstruct" attribute and/or muting notifications settings within the "mutingSetting" attribute only if the EnhDataMgmt feature is supported. + +#### 5.6.2.3 Type AfEventExposureNotif + +**Table 5.6.2.3-1: Definition of type AfEventExposureNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------|---------------| +| notifId | string | M | 1 | Notification Correlation ID assigned by the NF service consumer. | | +| eventNotifs | array(AfEventNotification) | M | 1..N | Represents the Events to be reported according to the subscription corresponding to the Notification Correlation ID. | | + +#### 5.6.2.4 Type EventsSubs + +**Table 5.6.2.4-1: Definition of type EventsSubs** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|---------------------------------------------------------------------|---------------| +| event | AfEvent | M | 1 | Subscribed event. | | +| eventFilter | EventFilter | M | 1 | Represents the event filter information associated with each event. | | + +#### 5.6.2.5 Type EventFilter + +Table 5.6.2.5-1: Definition of type EventFilter + +| Attribute name | Data type | P | Cardinality | Description | Applicability
(NOTE 4) | +|----------------|----------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| gpsi | array(Gpsi) | O | 1..N | Each element represents external UE identifier.
(NOTE 1, NOTE 2) | | +| supi | array(Supi) | O | 1..N | Each element represents a SUPI identifying a UE (NOTE 1, NOTE 2) | | +| exterGroupIds | array(ExtGroupId) | O | 1..N | Each element represents a group of UEs identified by an External Group Identifier.
(NOTE 1, NOTE 2) | | +| interGroupIds | array(GroupId) | O | 1..N | Each element represents a group of UEs identified by an Internal Group Identifier.
(NOTE 1, NOTE 2) | | +| anyUeInd | boolean | O | 0..1 | Identifies whether the request applies to any UE.
This attribute shall set to "true" if applicable for any UE, otherwise, set to "false".
May only be present and sets to "true" if "AfEvent" sets to "SVC_EXPERIENCE", "EXCEPTIONS" or "USER_DATA_CONGESTION".
(NOTE 2) | ServiceExperience
Exceptions
UserDataCongestion | +| ueIpAddr | IpAddr | O | 0..1 | Identifies the UE IP address.
(NOTE 2) | EnPerformanceData | +| appIds | array(ApplicationId) | O | 1..N | Each element indicates an application identifier.
If absent, the EventFilter data applies to any application (i.e. all applications).
(NOTE 3) | ServiceExperience
UeMobility
UeCommunication
Exceptions
UserDataCongestion
PerformanceData
Dispersion
CollectiveBehaviour
MSQoeMetrics
MSConsumption
MSNetAssInvocation
MSDynPolicyInvocation
MSAccessActivity
DataVoITransferTime | +| locArea | LocationArea5G | O | 0..1 | Represents area of interest.
(NOTE 5) | ServiceExperience
UeMobility
UeCommunication
Exceptions
UserDataCongestion
PerformanceData
Dispersion
CollectiveBehaviour
MSQoeMetrics
MSConsumption
MSNetAssInvocation
MSDynPolicyInvocation
MSAccessActivity
DataVoITransferTime | +| collAttrs | array(CollectiveBehaviourFilter) | O | 1..N | Each element indicates a collective attribute parameter type and value.
This attribute may be included when the subscribed event is | CollectiveBehaviour | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| | | | | "COLLECTIVE_BEHAVIOUR". | | +| exceptionReqs | array(Exception) | O | 1..N | Each element indicates an Exception Id with associated threshold. This attribute may be included when the subscribed event is "EXCEPTIONS".
(NOTE 6) | EnPerformanceData | +| NOTE 1: For untrusted AF, only gpsi and exterGroupIds are applicable. For trusted AF, only supis and interGroupIds are applicable.
NOTE 2: For an applicable feature, only one attribute identifying the target UE shall be provided.
NOTE 3: For event "UE_COMM", "UE_MOBILITY", "EXCEPTIONS" and "PERF_DATA", the "applds" attribute, if present, shall include only one element.
NOTE 4: Properties marked with a feature as defined in clause 5.8 are applicable as described in clause 6.6 of 3GPP TS 29.500 [5]. If no features are indicated, the related property applies for all the features.
NOTE 5: The NetworkAreaInfo data within the LocationArea5G data is only applicable for trusted AF. In addition, for event "SVC_EXPERIENCE", only the "tais" attribute within the NetworkAreaInfo data is applicable for the trusted AF.
NOTE 6: Only "excepId" and "excepLevel" attributes within the Exception data type are applicable to this attribute. | | | | | | + +Editor's note: Futher event filter information is FFS. + +#### 5.6.2.6 Type AfEventNotification + +Table 5.6.2.6-1: Definition of type AfEventNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| event | AfEvent | M | 1 | Represents the reported application related event. | | +| timeStamp | DateTime | M | 1 | Time at which the event is observed. | | +| svcExprcInfos | array(ServiceExperienceInfoPerApp) | C | 1..N | Contains the service experience information.
Shall be present if the "event" attribute sets to "SVC_EXPERIENCE". | ServiceExperience | +| ueMobilityInfos | array(UeMobilityCollection) | C | 1..N | Contains the UE mobility information.
Shall be present if the "event" attribute sets to "UE_MOBILITY". | UeMobility | +| ueCommInfos | array(UeCommunicationCollection) | C | 1..N | Contains the application communication information.
Shall be present if the "event" attribute sets to "UE_COMM". | UeCommunication | +| excepInfos | array(ExceptionInfo) | C | 1..N | Each element represents the exception information for a service flow.
Shall be present if the "event" attribute sets to "EXCEPTIONS". | Exceptions | +| congestionInfos | array(UserDataCongestionCollection) | C | 1..N | Each element represents the user data congestion information collected for an AF application.
Shall be present if the "event" attribute sets to "USER_DATA_CONGESTION". | UserDataCongestion | +| perfDataInfos | array(PerformanceDataCollection) | C | 1..N | Each element represents the performance data information collected for an AF application.
Shall be present if the "event" attribute sets to "PERF_DATA". | PerformanceData | +| collBhvrInfos | array(CollectiveBehaviourInfo) | C | 1..N | Each element represents the collective behaviour information related to a set of UEs, applications. Shall be present if the "event" attribute sets to "COLLECTIVE_BEHAVIOUR". | CollectiveBehaviour | +| dispersionInfos | array(DispersionCollection) | C | 1..N | Each element represents the UE dispersion information collected for an AF application.
Shall be present if the "event" attribute sets to "DISPERSION". | Dispersion | +| msQoeMetrInfos | array(MsQoeMetricsCollection) | C | 1..N | Each element represents the Media Streaming QoE metrics information collected for an UE application via the Data Collection AF.
Shall be present if the "event" attribute sets to "MS_QOE_METRICS".

This attribute is deprecated; the attribute "msQoeMetrics" should be used instead. | MSQoeMetrics | +| msQoeMetrics | array(QoEMetricsCollection) | C | 1..N | Each element represents the Media Streaming QoE metrics event record.
Shall be present if the "event" attribute sets to "MS_QOE_METRICS". | MSEventExposure | + +| | | | | | | +|------------------|-----------------------------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| | | | | This attribute deprecates "msQoeMetrInfos" attribute. | | +| msConsumpInfos | array(MsConsumptionCollection) | C | 1..N | Each element represents the Media Streaming Consumption information collected for an UE application via the Data Collection AF.
Shall be present if the "event" attribute sets to "MS_CONSUMPTION".

This attribute is deprecated; the attribute "msConsumpRpts" should be used instead. | MSConsumption | +| msConsumpRpts | array(ConsumptionReportingUnits Collection) | C | 1..N | Each element represents the Media Streaming Consumption event record.
Shall be present if the "event" attribute sets to "MS_CONSUMPTION".

This attribute deprecates "msConsumpInfos" attribute. | MSEventExposure | +| msNetAssInvInfos | array(MsNetAssInvocationCollection) | C | 1..N | Each element represents the Media Streaming Network Assistance invocation information collected for an UE application via the Data Collection AF.
Shall be present if the "event" attribute sets to "NET_ASSIST_INVOCATION".

This attribute is deprecated; the attribute "msNetAssistInvs" should be used instead. | MSNetAssInvocation | +| msNetAssistInvs | array(NetworkAssistanceInvocationsCollection) | C | 1..N | Each element represents the Media Streaming Network Assistance invocation event record.
Shall be present if the "event" attribute sets to "NET_ASSIST_INVOCATION".

This attribute deprecates "msNetAssInvInfos" attribute. | MSEventExposure | +| msDynPlyInvInfos | array(MsDynPolicyInvocationCollection) | C | 1..N | Each element represents the Media Streaming Dynamic Policy invocation information collected for an UE application via the Data Collection AF.
Shall be present if the "event" attribute sets to "MS_DYN_POLICY_INVOCATION".

This attribute is deprecated; the attribute "msDynPlyInvs" should be used instead. | MSDynPolicyInvocation | +| msDynPlyInvs | array(DynamicPolicyInvocationsCollection) | C | 1..N | Each element represents the Media Streaming Dynamic Policy invocation event record.
Shall be present if the "event" attribute sets to "MS_DYN_POLICY_INVOCATION".

This attribute deprecates | MSEventExposure | + +| | | | | | | +|----------------------|-----------------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| | | | | "msDynPlyInvInfos" attribute. | | +| msAccActInfos | array(MSAccessActivityCollection) | C | 1..N | Each element represents the Media Streaming access activity collected for an UE application via the Data Collection AF. Shall be present if the "event" attribute sets to "MS_ACCESS_ACTIVITY".

This attribute is deprecated; the attribute "msAccesses" should be used instead. | MSAccessActivity | +| msAccesses | array(MediaStreamingAccessesCollection) | C | 1..N | Each element represents the Media Streaming access eventrecord. Shall be present if the "event" attribute sets to "MS_ACCESS_ACTIVITY".

This attribute deprecates "msAccActInfos" attribute. | MSEventExposure | +| gnssAssistDataInfo | GNSSAssistDataInfo | C | 0..1 | Represents the GNSS Assistance data information.

This attribute shall be present only if the "event" attribute is set to "GNSS_ASSISTANCE_DATA". | GNSSAssistData | +| datVolTransTimeInfos | array(DatVolTransTimeCollection) | C | 1..N | Each element represents the data volume transfer time information related to a UE. Shall be present if the "event" attribute sets to "DATA_VOLUME_TRANSFER_TIME". | DataVolTransferTime | + +#### 5.6.2.7 Type ServiceExperienceInfoPerApp + +**Table 5.6.2.7-1: Definition of type ServiceExperienceInfoPerApp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| appId | ApplicationId | C | 0..1 | Indicates an application identifier. Shall be present if the AF event exposure service request applies to more than one application. | | +| appServerIns | AddrFqdn | O | 0..1 | Represents the Application Server Instance (IP address or FQDN of the Application Server). | ServiceExperienceExt | +| svcExpPerFlows | array(ServiceExperienceInfoPerFlow) | M | 1..N | Each element represents service experience for each service flow. | | +| gpsi | array(Gpsi) | O | 1..N | Each element represents external UE identifier. (NOTE) | | +| supi | array(Supi) | O | 1..N | SUPI identifying a UE. (NOTE) | | +| contrWeights | array(UInteger) | C | 1..N | Indicates the Service Experience Contribution Weights of a list of UEs in the same sequence as in the presented gpsi or supi list of UEs. The weights indicate the relative importance among the elements of this array. The higher the number, the higher the importance. | ServiceExperienceExt2_eNA | +| NOTE: Either "gpsi" or "supi" shall be present. For untrusted AF, only "gpsi" is applicable. For trusted AF, only "supi" is applicable. | | | | | | + +#### 5.6.2.8 Type ServiceExperienceInfoPerFlow + +**Table 5.6.2.8-1: Definition of type ServiceExperienceInfoPerFlow** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------------|---|-------------|-------------------------------------------------------------------------------------------|---------------| +| svcExprc | SvcExperience | M | 1 | Service experience. | | +| timeIntev | TimeWindow | M | 1 | Represents a start and stop time of the measurement period for the AF service experience. | | +| dnai | Dnai | O | 0..1 | Indicates the DN Access Identifiers representing location of the service flow. | | +| ipTrafficFilter | FlowInfo | O | 0..1 | Identifies IP packet filter.(NOTE) | | +| ethTrafficFilter | EthFlowDescription | O | 0..1 | Identifies Ethernet packet filter.(NOTE) | | + +NOTE: Either "ipTrafficFilter" or "ethTrafficFilter" shall be provided. + +#### 5.6.2.9 Type SvcExperience + +**Table 5.6.2.9-1: Definition of type SvcExperience** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------------|---------------| +| mos | Float | M | 1 | Mean opinion score. | | +| upperRange | Float | M | 1 | The upper value within the rating scale range. | | +| lowerRange | Float | M | 1 | The lower value within the rating scale range. | | + +#### 5.6.2.10 Type UeMobilityCollection + +**Table 5.6.2.10-1: Definition of type UeMobilityCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| gpsi | Gpsi | O | 0..1 | Identifies a UE. (NOTE 1) | | +| supi | Supi | O | 0..1 | SUPI identifying a UE. (NOTE 1) | | +| appld | ApplicationId | M | 1 | Identifies an application identifier. | | +| allAppInd | boolean | O | 0..1 | Indicates applicable to all applications if set to "true", otherwise set to "false". Default value is "false" if omitted. (NOTE 2) | AllApplications | +| ueTrajs | array(UeTrajectory Collection) | M | 1..N | Identifies a list of UE moving trajectories. | | +| areas | array(LocationArea 5G) | O | 1..N | Indicates a list of areas used by the AF for the application service. | UeMobilityExt_AIML | + +NOTE 1: Either gpsi or supi shall be present. For untrusted AF, only gpsi is applicable. For trusted AF, only supi is applicable. + +NOTE 2: If the "allAppInd" attribute is present and set to "true", then the value in the "appld" shall be ignored, which indicates the collected UE mobility information is applicable to all the applications for the UE. + +#### 5.6.2.11 Type UeCommunicationCollection + +Table 5.6.2.11-1: Definition of type UeCommunicationCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|--------------------------------|---|-------------|--------------------------------------------------------------|------------------------| +| gpsi | Gpsi | O | 0..1 | Identifies a UE. (NOTE 1) | | +| supi | Supi | O | 0..1 | SUPI identifying a UE. (NOTE 1) | | +| exterGroupId | ExtGroupId | O | 0..1 | Identifies an external group of UEs. (NOTE 2) | | +| interGroupId | GroupId | O | 0..1 | Identifies an internal group of UEs. (NOTE 2) | | +| appId | ApplicationId | M | 1 | Identifies an application identifier. | | +| expectedUeBehavePara | CpParameterSet | O | 0..1 | Indicates the Expected UE Behaviour parameters. (NOTE 3) | UeCommunicationExt_eNA | +| comms | array(CommunicationCollection) | M | 1..N | This attribute contains a list of communication information. | | + +NOTE 1: Either "gpsi" or "supi" shall be present. For untrusted AF, only "gpsi" is applicable. For trusted AF, only "supi" is applicable. +NOTE 2: "interGroupId" attribute only applies to trusted AF and "exterGroupId" only applies to untrusted AF. +NOTE 3: The "setId", "self" and "validityTime" attributes included in CpParameterSet data type are not applicable to this attribute. + +#### 5.6.2.12 Type UeTrajectoryCollection + +Table 5.6.2.12-1: Definition of type UeTrajectoryCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|--------------------------------------------------------------------------|---------------| +| ts | DateTime | M | 1 | This attribute identifies the timestamp when the UE enters the location. | | +| locArea | LocationArea5G | M | 1 | This attribute includes the location information of the UE. | | + +#### 5.6.2.13 Type CommunicationCollection + +Table 5.6.2.13-1: Definition of type CommunicationCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------|---------------| +| startTime | DateTime | M | 1 | Identifies the timestamp this communication starts. | | +| endTime | DateTime | M | 1 | Identifies the timestamp this communication stops. | | +| ulVol | Volume | O | 0..1 | Identifies the uplink traffic volume. (NOTE) | | +| dlVol | Volume | O | 0..1 | Identifies the downlink traffic volume. (NOTE) | | + +NOTE: At least one of "ulVol" or "dlVol" shall be provided. + +#### 5.6.2.14 Type ExceptionInfo + +Table 5.6.2.14-1: Definition of type ExceptionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------------|---|-------------|-------------------------------------------------------------------------|---------------| +| ipTrafficFilter | FlowInfo | C | 0..1 | Identifies IP flow. (NOTE 1) | | +| ethTrafficFilter | EthFlowDescription | C | 0..1 | Identifies Ethernet flow. (NOTE 1) | | +| excepts | array(Exception) | M | 1..N | Contains the description of one or more exception information. (NOTE 2) | | + +NOTE 1: Either "ipTrafficFilter" or "ethTrafficFilter" shall be provided. +NOTE 2: Only "excepId", "excepLevel" and "excepTrend" within the Exception data type as defined in 3GPP TS 29.520 [19] apply to the ExceptionInfo data type. + +#### 5.6.2.15 Type UserDataCongestionCollection + +Table 5.6.2.15-1: Definition of type UserDataCongestionCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------|---------------| +| appld | ApplicationId | C | 0..1 | Indicates an application identifier. (NOTE) | | +| ipTrafficFilter | FlowInfo | C | 0..1 | Identifies IP packet filter. (NOTE) | | +| timeInterv | TimeWindow | O | 0..1 | Represents a start and stop time interval of the measurement period for the AF application. | | +| thrputUl | BitRate | O | 0..1 | Indicates the average uplink throughput over the measurement period. | | +| thrputDl | BitRate | O | 0..1 | Indicates the average downlink throughput over the measurement period. | | +| thrputPkUl | BitRate | O | 0..1 | Indicates the peak uplink throughput over the measurement period. | | +| thrputPkDl | BitRate | O | 0..1 | Indicates the peak uplink throughput over the measurement period. | | + +NOTE: Either "appld" or "ipTrafficFilter" shall be provided. + +#### 5.6.2.16 Type PerformanceDataCollection + +Table 5.6.2.16-1: Definition of type PerformanceDataCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|-----------------------------------------------------------------------|---------------| +| appld | ApplicationId | O | 0..1 | Indicates an application identifier. | | +| uelpAddr | IpAddr | O | 0..1 | Identifies the IP address of an UE. | | +| ipTrafficFilter | FlowInfo | O | 0..1 | Identifies IP packet filter. | | +| ueLoc | LocationArea5G | O | 0..1 | Represents the UE location. | | +| appLocs | array(Dnai) | O | 1..N | Represents the application locations. | | +| asAddr | AddrFqdn | O | 0..1 | Represents the IP address or FQDN of the Application Server. (NOTE 1) | | +| perfData | PerformanceData | M | 1 | Indicates the performance data. (NOTE 2) | | +| timeStamp | DateTime | M | 1 | It defines the timestamp when the provided data is generated. | | + +NOTE 1: If the "asAddr" attribute is included, either the "ipAddr" attribute or the "fqdn" attribute in the AddrFqdn data type shall be provided. +NOTE 2: If the feature "PerformanceDataExt\_AIML" is supported, the attribute "perfData" indicates the UL/DL performance data. + +#### 5.6.2.17 Type PerformanceData + +Table 5.6.2.17-1: Definition of type PerformanceData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|--------------------------------------------|--------------------------| +| pdb | PacketDelBudget | O | 0..1 | Indicates average Packet Delay. | | +| pdbDI | PacketDelBudget | O | 0..1 | Indicates average downlink Packet Delay. | PerformanceData Ext_AIML | +| maxPdbUI | PacketDelBudget | O | 0..1 | Indicates Maximum uplink Packet Delay. | PerformanceData Ext_AIML | +| maxPdbDI | PacketDelBudget | O | 0..1 | Indicates Maximum downlink Packet Delay. | PerformanceData Ext_AIML | +| plr | PacketLossRate | O | 0..1 | Indicates average Loss Rate. | | +| plrDI | PacketLossRate | O | 0..1 | Indicates average downlink Loss Rate. | PerformanceData Ext_AIML | +| maxPlrUI | PacketLossRate | O | 0..1 | Indicates Maximum uplink Loss Rate. | PerformanceData Ext_AIML | +| maxPlrDI | PacketLossRate | O | 0..1 | Indicates Maximum downlink Loss Rate. | PerformanceData Ext_AIML | +| thrputUI | BitRate | O | 0..1 | Indicates the average uplink throughput. | | +| maxThrputUI | BitRate | O | 0..1 | Indicates the Maximum uplink throughput. | PerformanceData Ext_AIML | +| minThrputUI | BitRate | O | 0..1 | Indicates the Minimum uplink throughput. | PerformanceData Ext_AIML | +| thrputDI | BitRate | O | 0..1 | Indicates the average downlink throughput. | | +| maxThrputDI | BitRate | O | 0..1 | Indicates the Maximum downlink throughput. | PerformanceData Ext_AIML | +| minThrputDI | BitRate | O | 0..1 | Indicates the Minimum downlink throughput. | PerformanceData Ext_AIML | + +#### 5.6.2.18 Type AddrFqdn + +Table 5.6.2.18-1: Definition of type AddrFqdn + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------|---------------| +| ipAddr | IpAddr | O | 0..1 | Indicates an IP address. | | +| fqdn | string | O | 0..1 | Indicates an FQDN. | | + +#### 5.6.2.19 Type CollectiveBehaviourFilter + +Table 5.6.2.19-1: Definition of type CollectiveBehaviourFilter + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| type | CollectiveBehaviourFilterType | M | 1 | Parameter type for collective behaviour information event filter. | | +| value | string | M | 1 | Value of the parameter type as in "type" attribute. | | +| collBehAttr | array(PerUeAttribute) | O | 1..N | Contains values of collective behaviour attributes, at least one of which shall match for an AF event to be sent. If provided, the attributes "type" and "value" may be ignored. | ExtEventFilters | +| dataProcType | DataProcessingType | O | 0..1 | Contains the type of processing that shall have been performed on the data for an AF event to be sent. If provided, the attributes "type" and "value" may be ignored. | ExtEventFilters | +| listOfUeInd | boolean | O | 0..1 | Indicates whether request list of UE IDs that fulfil a collective behaviour within the area of interest.
This attribute shall set to "true" if request the list of UE IDs, otherwise, set to "false". | | + +#### 5.6.2.20 Type CollectiveBehaviourInfo + +Table 5.6.2.20-1: Definition of type CollectiveBehaviourInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| colAttrib | array(PerUeAttribute) | M | 1..N | The list of collective attribute values. If the "colAttrib" attribute contains multiple entries, then a UE is considered to fulfil the behaviour if it fulfils the behaviour described by at least one of the elements of the array. | | +| noOfUes | integer | O | 0..1 | Identifies the total number of UEs that fulfil a collective behaviour within the area of interest. | | +| appIds | array(ApplicationId) | O | 1..N | Indicates the identifiers of the applications providing this information. | | +| extUeIds | array(Gpsi) | C | 1..N | Gpsi information of the UEs that fulfil the collective behaviour with in the area of the interest. May only be present if the "listOfUe" attribute is subscribed and sets to "true".
(NOTE) | | +| ueIds | array(Supi) | C | 1..N | Supis of UEs that fulfil the collective behaviour with in the area of the interest. May only be present if the "listOfUe" attribute is subscribed and sets to "true".
(NOTE) | | + +NOTE: Only one of "extUeIds" or "ueIds" shall be provided. "ueIds" attribute may only be provided by trusted AF. + +#### 5.6.2.21 Type DispersionCollection + +**Table 5.6.2.21-1: Definition of type DispersionCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | C | 0..1 | Indicates external UE identifier. (NOTE 1) | | +| supi | Supi | C | 0..1 | Indicates internal UE identifier, represents a SUPI identifying a UE. (NOTE 1) | | +| ueAddr | IpAddr | C | 0..1 | Indicates UE IP address. (NOTE 1) | | +| timeStamp | DateTime | C | 0..1 | It defines the time stamp when the data volume information is generated.
Shall be present if available. | EnhDataMgmt | +| dataUsage | UsageThreshold | M | 1 | Data volume exchanged for the UE. (NOTE 3) | | +| flowDesc | FlowDescription | C | 0..1 | Represents IP 5-tuple with protocol, IP address and port for UL/DL application traffic. (NOTE 2) | | +| appId | ApplicationId | C | 0..1 | Indicates an Application Identifier. (NOTE 2) | | +| dnais | array(Dnai) | O | 1..N | Indicates the DN Access Identifiers representing location of the service flow.
May only be provided if the "ueAddr" attribute is provided. | | +| appDur | DurationSec | O | 0..1 | Indicates the duration for the application. | | + +NOTE 1: One of the "supi", "gpsi" or "ueAddr" attribute shall be provided. + +NOTE 2: If the "ueAddr" attribute is provided, either the "appId" or "flowDesc" attribute shall be provided. + +NOTE 3: The "duration" attribute within the UsageThreshold data type is not applicable. + +#### 5.6.2.22 Type PerUeAttribute + +**Table 5.6.2.22-1: Definition of type PerUeAttribute** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------------|---------------| +| ueDest | LocationArea5G | M | 1 | Expected final location of UE based on the route planned. | | +| route | string | O | 0..1 | Planned path of movement by a UE application (e.g. a navigation app).
The format is based on the SLA. | | +| avgSpeed | BitRate | O | 0..1 | Expected speed over the route planned by a UE application. | | +| timeOfArrival | DateTime | O | 0..1 | Expected Time of arrival to destination based on the route planned. | | + +#### 5.6.2.23 Type MsQoeMetricsCollection + +**Table 5.6.2.23-1: Definition of type MsQoeMetricsCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| msQoeMetrics | array(string) | M | 1..N | Represents the Media Streaming Quality of Experience metrics with formatting as specified in clause 11.4.3 of 3GPP TS 26.512 [30], if required for the QoE metrics for Media Streaming UE Application. | | + +#### 5.6.2.24 Type MsConsumptionCollection + +Table 5.6.2.24-1: Definition of type MsConsumptionCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| msConsumps | array(string) | M | 1..N | Represents the Media Streaming Consumption reports with formatting as specified in clause 11.3.3 of 3GPP TS 26.512 [30], if required for Media Streaming UE Application. | | + +#### 5.6.2.25 Type MsNetAssInvocationCollection + +Table 5.6.2.25-1: Definition of type MsNetAssInvocationCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------|---------------| +| msNetAssInvocs | array(NetworkAssistanceSession) | M | 1..N | Indicate Media Streaming Network Assistance invocation information as specified in clause 11.6.3.1 of 3GPP TS 26.512 [30]. | | + +#### 5.6.2.26 Type MsDynPolicyInvocationCollection + +Table 5.6.2.26-1: Definition of type MsDynPolicyInvocationCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------|---------------| +| msDynPlyInvocs | array(DynamicPolicy) | M | 1..N | Represent the Media Streaming Dynamic Policy invocation as specified in clause 11.5.3.1 of 3GPP TS 26.512 [30]. | | + +#### 5.6.2.27 Type MSAccessActivityCollection + +Table 5.6.2.27-1: Definition of type MSAccessActivityCollection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------|---------------| +| msAccActs | array(MediaStreamingAccessRecord) | M | 1..N | Indicate Media Streaming access activities information as specified in clause 17.2 of 3GPP TS 26.512 [30]. | | + +#### 5.6.2.28 Type DatVolTransTimeCollection + +**Table 5.6.2.28-1: Definition of type DatVolTransTimeCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | O | 0..1 | Identifier of the application at the AF. | | +| appServerInst | AddrFqdn | O | 0..1 | Represents the Application Server Instance (IP address/FQDN of the Application Server). | | +| gpsi | Gpsi | O | 0..1 | Each element represents a GPSI for a UE. | | +| supi | Supi | O | 0..1 | Each element represents a SUPI for a UE. | | +| ulTransVol | Volume | O | 0..1 | The volume of the uplink transmitted data. (NOTE 1) | | +| dlTransVol | Volume | O | 0..1 | The volume of the downlink transmitted data. (NOTE 1) | | +| ulTransTimeDur | TimeWindow | O | 0..1 | Indicates the start and end time for sending the volume of uplink data. (NOTE 2) | | +| dlTransTimeDur | TimeWindow | O | 0..1 | Indicates the start and end time for sending the volume of downlink data. (NOTE 2) | | + +NOTE 1: At least one of "ulTransVol" or "dlTransVol" shall be provided. +NOTE 2: At least one of "ulTransTimeDur" or "dlTransTimeDur" shall be provided. + +### 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: AfEvent + +The enumeration AfEvent represents the application events that can be subscribed/notified. It shall comply with the provisions defined in table 5.6.3.3-1. + +**Table 5.6.3.3-1: Enumeration AfEvent** + +| Enumeration value | Description | Applicability | +|---------------------------|-----------------------------------------------------------------------------------------------------|-----------------------| +| SVC_EXPERIENCE | Indicates that the event subscribed/notified is service experience information for an application. | ServiceExperience | +| UE_MOBILITY | Indicates that the event subscribed/notified is UE mobility information. | UeMobility | +| UE_COMM | Indicates that the event subscribed/notified is UE communication information. | UeCommunication | +| EXCEPTIONS | Indicates that the event subscribed/notified is exceptions information. | Exceptions | +| USER_DATA_CONGESTION | Indicates that the event subscribed/notified is user data congestion analytics related information. | UserDataCongestion | +| PERF_DATA | Indicates that the event subscribed/notified is performance data information. | PerformanceData | +| COLLECTIVE_BEHAVIOUR | Indicates that the event subscribed/notified is collective behaviour information. | CollectiveBehaviour | +| DISPERSION | Indicates that the event subscribed/notified is dispersion information. | Dispersion | +| MS_QOE_METRICS | Indicates that the event subscribed/notified is Media Streaming QoE metrics. | MSQoeMetrics | +| MS_CONSUMPTION | Indicates that the event subscribed/notified is Media Streaming Consumption reports. | MSConsumption | +| MS_NET_ASSIST_INVOCATION | Indicates that the event subscribed/notified is Media Streaming Network Assistance invocation. | MSNetAssInvocation | +| MS_DYN_POLICY_INVOCATION | Indicates that the event subscribed/notified is Media Streaming Dynamic Policy invocation. | MSDynPolicyInvocation | +| MS_ACCESS_ACTIVITY | Indicates that the event subscribed/notified is Media Streaming access activity. | MSAccessActivity | +| GNSS_ASSISTANCE_DATA | Indicates that the subscribed/notified event is GNSS Assistance Data Collection. | GNSSAssistData | +| DATA_VOLUME_TRANSFER_TIME | Indicates that the event subscribed is data volume transfer time information. | DataVolTransferTime | + +#### 5.6.3.4 Enumeration: CollectiveBehaviourFilterType + +The enumeration CollectiveBehaviourFilterType represents the parameter type for collective behaviour information filtering. It shall comply with the provisions defined in table 5.6.3.4-1. + +**Table 5.6.3.4-1: Enumeration CollectiveBehaviourFilterType** + +| Enumeration value | Description | Applicability | +|----------------------|-------------------------------------------------------------|---------------| +| COLLECTIVE_ATTRIBUTE | Indicates that the parameter type is collective attributes. | | +| DATA_PROCESSING | Indicates that the parameter type is data processing. | | + +#### 5.6.3.5 Enumeration: DataProcessingType + +The enumeration DataProcessingType represents the type of data processing performed by the AF during UE data collection. It shall comply with the provisions defined in table 5.6.3.5-1. + +**Table 5.6.3.5-1: Enumeration DataProcessingType** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------|---------------| +| AGGREGATION | Used for aggregated data. | | +| NORMALIZATION | Used for normalized data. | | +| ANONYMIZATION | Used for anonymized data. | | + +## 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 Naf\_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 Naf\_EventExposure API. + +### 5.7.2 Protocol Errors + +In this Release of the specification, there are no service specific protocol errors applicable for the Naf\_EventExposure API. + +### 5.7.3 Application Errors + +The application errors defined for the Naf\_EventExposure service are listed in table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|---------------------------|------------------|------------------------------------------------------------------------------------------------| +| MUTING_INSTR_NOT_ACCEPTED | 403 Forbidden | Indicates that the muting instructions received by the NF service consumer cannot be accepted. | + +## 5.8 Feature negotiation + +The optional features in table 5.8-1 are defined for the Naf\_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 | ServiceExperience | This feature indicates support for the event related to service experience. | +| 2 | UeMobility | This feature indicates support for the event related to UE mobility. | +| 3 | UeCommunication | This feature indicates support for the event related to UE communication information. | +| 4 | Exceptions | This feature indicates support for the event related to exception information. | +| 5 | 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]. | +| 6 | EneNA | This feature indicates support for the enhancements of network data analytics requirements. | +| 7 | UserDataCongestion | This feature indicates support for the event related to User Data Congestion Analytics related information. | +| 8 | PerformanceData | This feature indicates support for the event related to performance data information. | +| 9 | Dispersion | This feature indicates support for the event related to Dispersion Analytics related information. | +| 10 | CollectiveBehaviour | This feature indicates support for the event related to collective behaviour information. | +| 11 | ServiceExperienceExt | This feature indicates support for the extensions to the event related to service experience, including reporting Application Server Instance. Supporting this feature also requires the support of feature ServiceExperience. | +| 12 | MSQoeMetrics | This feature indicates support for the event related to Media Streaming QoE metrics for UE Application collected via the Data Collection AF. | +| 13 | MSConsumption | This feature indicates support for the event related to Media Streaming Consumption reports for UE Application collected via the Data Collection AF. | +| 14 | MSNetAssInvocation | This feature indicates support for the event related to Media Streaming Network Assistance invocation for UE Application collected via the Data Collection AF. | +| 15 | MSDynPolicyInvocation | This feature indicates support for the event related to Media Streaming Dynamic Policy invocation for UE Application collected via the Data Collection AF. | +| 16 | MSAccessActivity | This feature indicates support for the event related to Media Streaming access activity for UE Application collected via the Data Collection AF. | +| 17 | DataAccProfileId | This feature indicates support for Data Access Profile Identifier. | +| 18 | AllApplications | This feature indicates applicable to all the applications. | +| 19 | GNSSAssistData | This feature indicates the support of the GNSS Assistance Data Collection functionality as part of the enhancements to the 5G LCS functionality.

The following functionalities are supported:
- GNSS Assistance Data Collection. | +| 20 | PerformanceDataExt_AIML | This feature indicates the support for the extensions of the analytics related to DN performance supporting AIML, including support of Max/Min UL/DL data collection on packet delay, pack loss and throughput. Supporting this feature also requires the support of feature PerformanceData. | +| 21 | UeMobilityExt_AIML | This feature indicates support for further extensions to the event related to UE mobility supporting AIML including support of list of application service area collection. Supporting this feature also requires the support of feature UeMobility. | +| 22 | EnPerformanceData | This feature indicates support for the enhancements of performance data. This feature requires the support of the PerformanceData feature. | +| 23 | UeCommunicationExt_eNA | This feature indicates support for the enhancements of UE Communication, including support of ordering criterion. Supporting | + +| | | | +|----|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | this feature also requires the support of UeCommunication feature. | +| 24 | ServiceExperienceExt2_eNA | This feature indicates support for the extensions to the event related to service experience supporting eNA, including Service Experience Contribution Weights. Supporting this feature also requires the support of feature ServiceExperience. | +| 25 | EnhDataMgmt | Indicates the support of enhanced data management mechanisms. Supporting this feature also requires the support of feature EneNA. | +| 26 | ExtEventFilters | Indicates support of extended AF event filters. | +| 27 | DataVolTransferTime | This feature indicates support for the event related to data volume transfer time. | +| 28 | MSEventExposure | This feature indicates the support for Media Streaming event exposure.

This feature is recommended to be implemented to avoid the usage of the deprecated attributes. | + +## 5.9 Security + +TLS shall be used to support the security communication between the NF Service Consumer and the AF as defined in clause 12.3 and clause 13.1 of 3GPP TS 33.501 [14]. + +If the AF is trusted, as indicated in 3GPP TS 33.501 [14] and 3GPP TS 29.500 [5], the access to the Naf\_EventExposure API may be authorized by means of the OAuth 2.0 protocol (see IETF RFC 6749 [15]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [16]) plays the role of the authorization server. + +If OAuth 2.0 is used, an NF Service Consumer, prior to consuming services offered by the Naf\_EventExposure API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [16], 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 Naf\_EventExposure service. + +The Naf\_EventExposure API defines a single scope "naf-eventexposure" for the entire service, and it does not define any additional scopes at resource or operation level. + +If the AF is untrusted, the access to Naf\_EventExposure API shall be authorized by means of OAuth2 protocol (see IETF RFC 6749 [15]), based on local configuration, using the "Client Credentials" authorization grant. If OAuth2 is used, a NF Service Consumer (e.g. NEF), prior to consuming services offered by the Naf\_EventExposure API, shall obtain a "token" from the authorization server. + +# --- Annex A (normative): OpenAPI specification + +## A.1 General + +This Annex is based on the OpenAPI Specification [8] 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 [11] and clause 5.3.1 of the 3GPP TS 29.501 [6] for further information). + +The security scheme defined below for the Naf\_EventExposure API shows the case when the AF is in untrusted domain and the "scopes" and "tokenUrl" are undefined. For the trusted AF, the "scopes" definition shall use "naf-eventexposure" and the "tokenUrl" definition shall use "{nrfApiRoot}/oauth2/token". + +## --- A.2 Naf\_EventExposure API + +``` +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.5 + title: Naf_EventExposure + description: | + AF Event Exposure Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.517 V18.4.0; 5G System; Application Function Event Exposure Service; Stage 3. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.517/ + +servers: + - url: '{apiRoot}/naf-eventexposure/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: [] + +paths: + /subscriptions: + post: + summary: Creates a new Individual Application Event Exposure Subscription resource + operationId: PostAfEventExposureSubsc + tags: + - Application Event Subscription (Collection) + requestBody: +``` + +``` + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureSubsc' +responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureSubsc' + headers: + Location: + description: > + Contains the URI of the created individual application event subscription resource + 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: + AfEventExposureNotif: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureNotif' + 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' + +/subscriptions/{subscriptionId}: + get: + summary: "Reads an existing Individual Application Event Subscription" + operationId: GetAfEventExposureSubsc + tags: + - Individual Application Event Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Application Event Subscription ID + required: true + schema: + type: string + - name: supp-feat + in: query + description: Features supported by the NF service consumer + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureSubsc' + '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 Application Event Subscription " + operationId: PutAfEventExposureSubsc + tags: + - Individual Application Event Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AfEventExposureSubsc' + parameters: + - name: subscriptionId + in: path + description: Application 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/AfEventExposureSubsc' + '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 Application Event Subscription " + operationId: DeleteAfEventExposureSubsc + tags: + - Individual Application Event Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Application 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: '{tokenUri}' + scopes: {} +description: > + For trusted AF, the 'naf-eventexposure' shall be used as 'scopes' and + '{nrfApiRoot}/oauth2/token' shall be used as 'tokenUri'. + +schemas: + AfEventExposureNotif: + description: > + Represents notifications on application event(s) that occurred for an Individual Application + Event Subscription resource. + type: object + properties: + notifId: + type: string + eventNotifs: + type: array + items: + $ref: '#/components/schemas/AfEventNotification' + minItems: 1 + required: + - notifId + - eventNotifs + + AfEventExposureSubsc: + description: Represents an Individual Application Event Subscription resource. + type: object + properties: + dataAccProfId: + type: string + eventsSubs: + type: array + items: + $ref: '#/components/schemas/EventsSubs' + minItems: 1 + eventsRepInfo: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifId: + type: string + eventNotifs: + type: array + items: + $ref: '#/components/schemas/AfEventNotification' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - eventsSubs + - eventsRepInfo + - notifId + - notifUri + + AfEventNotification: + description: Represents information related to an event to be reported. + type: object + properties: + event: + $ref: '#/components/schemas/AfEvent' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + svcExprcInfos: + type: array + items: + $ref: '#/components/schemas/ServiceExperienceInfoPerApp' + minItems: 1 + ueMobilityInfos: + type: array + items: + $ref: '#/components/schemas/UeMobilityCollection' + minItems: 1 + ueCommInfos: + type: array + items: + $ref: '#/components/schemas/UeCommunicationCollection' +``` + +``` + minItems: 1 + excepInfos: + type: array + items: + $ref: '#/components/schemas/ExceptionInfo' + minItems: 1 + congestionInfos: + type: array + items: + $ref: '#/components/schemas/UserDataCongestionCollection' + minItems: 1 + perfDataInfos: + type: array + items: + $ref: '#/components/schemas/PerformanceDataCollection' + minItems: 1 + dispersionInfos: + type: array + items: + $ref: '#/components/schemas/DispersionCollection' + minItems: 1 + collBhvrInfos: + type: array + items: + $ref: '#/components/schemas/CollectiveBehaviourInfo' + minItems: 1 + msQoeMetrInfos: + type: array + items: + $ref: '#/components/schemas/MsQoeMetricsCollection' + minItems: 1 + deprecated: true + msQoeMetrics: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/QoEMetricsCollection' + minItems: 1 + description: Represents the Media Streaming QoE metrics event records. + msConsumpInfos: + type: array + items: + $ref: '#/components/schemas/MsConsumptionCollection' + minItems: 1 + deprecated: true + msConsumpRpts: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/ConsumptionReportingUnitsCollection' + minItems: 1 + description: Represents the Media Streaming Consumption event records. + msNetAssInvInfos: + type: array + items: + $ref: '#/components/schemas/MsNetAssInvocationCollection' + minItems: 1 + deprecated: true + msNetAssistInvs: + type: array + items: + $ref: + 'TS26512_EventExposure.yaml#/components/schemas/NetworkAssistanceInvocationsCollection' + minItems: 1 + description: > + Represents the Media Streaming Network Assistance Invocations event records. + msDynPlyInvInfos: + type: array + items: + $ref: '#/components/schemas/MsDynPolicyInvocationCollection' + minItems: 1 + deprecated: true + msDynPlyInvs: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/DynamicPolicyInvocationsCollection' + minItems: 1 + description: Represents the Media Streaming Dynamic Policy Invocations event records. + msAccActInfos: + type: array +``` + +``` + items: + $ref: '#/components/schemas/MSAccessActivityCollection' + minItems: 1 + deprecated: true + msAccesses: + type: array + items: + $ref: 'TS26512_EventExposure.yaml#/components/schemas/MediaStreamingAccessesCollection' + minItems: 1 + description: Represents the Media Streaming access event records. + gnssAssistDataInfo: + $ref: 'TS29591_Nnef_EventExposure.yaml#/components/schemas/GNSSAssistDataInfo' + datVolTransTimeInfos: + type: array + items: + $ref: '#/components/schemas/DatVolTransTimeCollection' + minItems: 1 + required: + - event + - timeStamp + +EventsSubs: + description: Represents an event to be subscribed and the related event filter information. + type: object + properties: + event: + $ref: '#/components/schemas/AfEvent' + eventFilter: + $ref: '#/components/schemas/EventFilter' + required: + - event + - eventFilter + +EventFilter: + description: Represents event filter information for an event. + type: object + properties: + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + exterGroupIds: + type: array + items: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + minItems: 1 + interGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + anyUeInd: + type: boolean + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + locArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + collAttrs: + type: array + items: + $ref: '#/components/schemas/CollectiveBehaviourFilter' + minItems: 1 + exceptionReqs: + type: array + items: + $ref: 'TS29520_Nnwdf_EventsSubscription.yaml#/components/schemas/Exception' + minItems: 1 + oneOf: +``` + +- required: [gpsis] +- required: [supis] +- required: [exterGroupIds] +- required: [interGroupIds] +- required: [anyUeInd] +- required: [ueIpAddr] + +### **ServiceExperienceInfoPerApp:** + +description: Contains service experience information associated with an application. + +type: object + +#### properties: + +appId: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/ApplicationId' +appServerIns: +\$ref: '#/components/schemas/AddrFqdn' +svcExpPerFlows: +type: array +items: +\$ref: '#/components/schemas/ServiceExperienceInfoPerFlow' +minItems: 1 +gpsis: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Gpsi' +minItems: 1 +supis: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Supi' +minItems: 1 +contrWeights: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/UInteger' +minItems: 1 +required: +- svcExpPerFlows + +### **ServiceExperienceInfoPerFlow:** + +description: Contains service experience information associated with a service flow. + +type: object + +#### properties: + +svcExprc: +\$ref: '#/components/schemas/SvcExperience' +timeIntev: +\$ref: 'TS29122\_CommonData.yaml#/components/schemas/TimeWindow' +dnai: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Dnai' +ipTrafficFilter: +\$ref: 'TS29122\_CommonData.yaml#/components/schemas/FlowInfo' +ethTrafficFilter: +\$ref: 'TS29514\_Npcf\_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + +### **SvcExperience:** + +description: Contains a mean opinion score with the customized range. + +type: object + +#### properties: + +mos: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Float' +upperRange: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Float' +lowerRange: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Float' + +### **UeMobilityCollection:** + +description: > + +Contains UE mobility information associated with an application. If the allAppInd attribute is present and set to true, then the value in the appId shall be ignored, which indicates the collected UE mobility information is applicable to all the applications for the UE. + +type: object + +#### properties: + +gpsi: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Gpsi' +supi: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Supi' +appId: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/ApplicationId' +allAppInd: + +``` +type: boolean +description: > + Indicates applicable to all applications if set to true, otherwise set to false. + Default value is false if omitted. +ueTrajs: + type: array + items: + $ref: '#/components/schemas/UeTrajectoryCollection' + minItems: 1 +areas: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + minItems: 1 +required: +- appId +- ueTrajs + +UeCommunicationCollection: +description: Contains UE communication information associated with an application. +type: object +properties: + gpsI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupI' + exterGroupId: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExtGroupId' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + expectedUeBehavePara: + $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/CpParameterSet' + comms: + type: array + items: + $ref: '#/components/schemas/CommunicationCollection' + minItems: 1 +required: +- appId +- comms + +UeTrajectoryCollection: +description: Contains UE trajectory information associated with an application. +type: object +properties: + ts: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + locArea: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' +required: +- ts +- locArea + +CommunicationCollection: +description: Contains communication information. +type: object +properties: + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ulVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + dlVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' +required: +- startTime +- endTime +- ulVol +- dlVol + +ExceptionInfo: +description: Represents the exceptions information provided by the AF. +type: object +properties: + ipTrafficFilter: +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + ethTrafficFilter: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + excepts: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/Exception' + minItems: 1 + required: + - excepts + oneOf: + - required: [ipTrafficFilter] + - required: [ethTrafficFilter] + +UserDataCongestionCollection: + description: Contains User Data Congestion Analytics related information collection. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ipTrafficFilter: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + timeInterv: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + thrputUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + thrputDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + thrputPkUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + thrputPkDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + oneOf: + - required: [appId] + - required: [ipTrafficFilter] + +PerformanceDataCollection: + description: Contains Performance Data Analytics related information collection. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ueIpAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + ipTrafficFilter: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + ueLoc: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + appLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + asAddr: + $ref: '#/components/schemas/AddrFqdn' + perfData: + $ref: '#/components/schemas/PerformanceData' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - perfData + - timeStamp + +PerformanceData: + description: Contains Performance Data. + type: object + properties: + pdb: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + pdbDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + maxPdbUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + maxPdbDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + plr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + plrDl: + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + maxPlrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + maxPlrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + thrputUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxThrputUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minThrputUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + thrputDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxThrputDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minThrputDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + +AddrFqdn: + description: IP address and/or FQDN. + type: object + properties: + ipAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + fqdn: + type: string + description: Indicates an FQDN. + +DispersionCollection: + description: Contains the dispersion information collected for an AF. + type: object + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + ueAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddr' + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + dataUsage: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + flowDesc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + appDur: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + required: + - dataUsage + oneOf: + - required: [gpsi] + - required: [supi] + - required: [ueAddr] + +CollectiveBehaviourFilter: + description: Contains the collective behaviour filter information to be collected from UE. + type: object + properties: + type: + $ref: '#/components/schemas/CollectiveBehaviourFilterType' + value: + type: string + description: Value of the parameter type as in the type attribute. + collBehAttr: + type: array + items: + $ref: '#/components/schemas/PerUeAttribute' + minItems: 1 + description: > + Contains the values of collective behaviour attributes at least one of which shall + match for an AF event to be sent. + dataProcType: +``` + +``` +$ref: '#/components/schemas/DataProcessingType' +listOfUeInd: + type: boolean + description: > + Indicates whether request list of UE IDs that fulfill a collective behaviour within the + area of interest. This attribute shall set to "true" if request the list of UE IDs, + otherwise, set to "false". May only be present and sets to "true" if "AfEvent" sets to + "COLLECTIVE_BEHAVIOUR". +required: +- type +- value + +CollectiveBehaviourInfo: + description: Contains the collective behaviour information to be reported to the subscriber. + type: object + properties: + colAttrib: + type: array + items: + $ref: '#/components/schemas/PerUeAttribute' + minItems: 1 + noOfUes: + type: integer + description: Total number of UEs that fulfil a collective within the area of interest. + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + extUeIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + ueIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + required: + - colAttrib + oneOf: + - required: [extUeIds] + - required: [ueIds] + +PerUeAttribute: + description: UE application data collected per UE. + type: object + properties: + ueDest: + $ref: 'TS29122_CommonData.yaml#/components/schemas/LocationArea5G' + route: + type: string + avgSpeed: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + timeOfArrival: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +MsQoeMetricsCollection: + description: > + Contains the Media Streaming QoE metrics information collected for an UE Application via AF. + type: object + properties: + msQoeMetrics: + type: array + items: + type: string + minItems: 1 + required: + - msQoeMetrics + +MsConsumptionCollection: + description: > + Contains the Media Streaming Consumption information collected for an UE Application via AF. + type: object + properties: + msConsumps: + type: array +``` + +``` + items: + type: string + description: > + Represents the Media Streaming Consumption reports with formatting as specified in + clause 11.3.3 of 3GPP TS 26.512 [30], if required for Media Streaming UE Application. + minItems: 1 + required: + - msConsumps + +MsNetAssInvocationCollection: + description: > + Contains the Media Streaming Network Assistance invocation collected for an UE Application + via AF. + type: object + properties: + msNetAssInvocs: + type: array + items: + $ref: 'TS26512_M5_NetworkAssistance.yaml#/components/schemas/NetworkAssistanceSession' + minItems: 1 + required: + - msNetAssInvocs + +MsDynPolicyInvocationCollection: + description: > + Contains the Media Streaming Dynamic Policy invocation collected for an UE + Application via AF. + type: object + properties: + msDynPlyInvocs: + type: array + items: + $ref: 'TS26512_M5_DynamicPolicies.yaml#/components/schemas/DynamicPolicy' + minItems: 1 + required: + - msDynPlyInvocs + +MSAccessActivityCollection: + description: Contains Media Streaming access activity collected for an UE Application via AF. + type: object + properties: + msAccActs: + type: array + items: + $ref: 'TS26512_R4_DataReporting.yaml#/components/schemas/MediaStreamingAccessRecord' + minItems: 1 + required: + - msAccActs + +DatVolTransTimeCollection: + description: Contains the collective data volume transfer time information to be reported to +the subscriber. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + appServerInst: + $ref: '#/components/schemas/AddrFqdn' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + ulTransVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + dlTransVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + ulTransTimeDur: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dlTransTimeDur: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + anyOf: + - anyOf: + - required: [ulTransVol] + - required: [dlTransVol] + - anyOf: + - required: [ulTransTimeDur] + - required: [dlTransTimeDur] +``` + +# Simple data types and Enumerations + +``` +AfEvent: + anyOf: + - type: string + enum: + - SVC_EXPERIENCE + - UE_MOBILITY + - UE_COMM + - EXCEPTIONS + - USER_DATA_CONGESTION + - PERF_DATA + - DISPERSION + - COLLECTIVE_BEHAVIOUR + - MS_QOE_METRICS + - MS_CONSUMPTION + - MS_NET_ASSIST_INVOCATION + - MS_DYN_POLICY_INVOCATION + - MS_ACCESS_ACTIVITY + - GNSS_ASSISTANCE_DATA + - DATA_VOLUME_TRANSFER_TIME + - 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 application's event. + Possible values are: + - SVC_EXPERIENCE: Indicates that the subscribed/notified event is service experience + information for an application. + - UE_MOBILITY: Indicates that the subscribed/notified event is UE mobility information. + - UE_COMM: Indicates that the subscribed/notified event is UE communication information. + - EXCEPTIONS: Indicates that the subscribed/notified event is exceptions information. + - USER_DATA_CONGESTION: Indicates that the subscribed/notified event is user data congestion + analytics related information. + - PERF_DATA: Indicates that the subscribed/notified event is performance data information. + - DISPERSION: Indicates that the subscribed/notified event is dispersion information. + - COLLECTIVE_BEHAVIOUR: Indicates that the subscribed/notified event is collective behaviour + information. + - MS_QOE_METRICS: Indicates that the subscribed/notified event is Media Streaming QoE + metrics. + - MS_CONSUMPTION: Indicates that the subscribed/notified event is Media Streaming + consumption reports. + - MS_NET_ASSIST_INVOCATION: Indicates that the subscribed/notified event is Media Streaming + network assistance invocation. + - MS_DYN_POLICY_INVOCATION: Indicates that the subscribed/notified event is Media Streaming + dynamic policy invocation. + - MS_ACCESS_ACTIVITY: Indicates that the subscribed/notified event is Media Streaming access + activity. + - GNSS_ASSISTANCE_DATA: Indicates that the subscribed/notified event is GNSS Assistance Data + Collection. + +CollectiveBehaviourFilterType: + anyOf: + - type: string + enum: + - COLLECTIVE_ATTRIBUTE + - DATA_PROCESSING + - 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 parameter type for collective behaviour information filtering. + Possible values are: + - COLLECTIVE_ATTRIBUTE: Indicates that the parameter type is collective attributes. + - DATA_PROCESSING: Indicates that the parameter type is data processing. + +DataProcessingType: + description: Represents a type of data processing. + anyOf: + - type: string + enum: + - AGGREGATION + - NORMALIZATION + - ANONYMIZATION + - 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. + + + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|----------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-03 | | | | | | TS skeleton of Application Function Event Exposure Service | 0.0.0 | +| 2019-04 | CT3#102 | | | | | Inclusion of C3-191230, C3-191374 and editorial change from Rapporteur. | 0.1.0 | +| 2019-05 | CT3#103 | | | | | Inclusion of C3-192194, C3-192393, C3-192260 and C3-192261. | 0.2.0 | +| 2019-08 | CT3#105 | | | | | Inclusion of C3-193373, C3-193440, C3-193441 and C3-193446. | 0.3.0 | +| 2019-10 | CT3#106 | | | | | Inclusion of C3-194263, C3-194264, C3-194393 and C3-194439. | 0.4.0 | +| 2019-11 | CT3#107 | | | | | Inclusion of C3-195068, C3-195226, C3-195238. | 0.5.0 | +| 2019-12 | CT#86 | CP-193178 | | | | Presented for information | 1.0.0 | +| 2019-12 | CT#86 | CP-193295 | | | | A title corrected | 1.0.1 | +| 2020-02 | CT3#108e | | | | | Inclusion of C3-201297, C3-201369, C3-201385, C3-201399, C3-201440 and C3-201466. | 1.1.0 | +| 2020-03 | CT#87e | CP-200188 | | | | TS sent to plenary for approval | 2.0.0 | +| 2020-03 | CT#87e | CP-200188 | | | | TS approved by plenary | 16.0.0 | +| 2020-06 | CT#88e | CP-201234 | 0001 | | F | Update service operation for Ue Communication | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0002 | | F | Corrections in TS 29.517 | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0003 | | F | Definition of AfEventExposureSubsc in OpenAPI | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0004 | 1 | D | Unsubscribe service operation | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0005 | 1 | F | Correction to event description | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0006 | 1 | F | Correction to target UE description | 16.1.0 | +| 2020-06 | CT#88e | CP-201244 | 0007 | 1 | F | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0008 | | F | Service operation description for UE mobility | 16.1.0 | +| 2020-06 | CT#88e | CP-201256 | 0009 | 1 | F | URI of the Naf_EventExposure service | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0010 | | F | Support of immediate reporting | 16.1.0 | +| 2020-06 | CT#88e | CP-201077 | 0012 | 1 | F | Supported features definition | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0013 | 1 | F | Target UE information | 16.1.0 | +| 2020-06 | CT#88e | CP-201234 | 0014 | 1 | F | Supported headers, Resource Data type and yaml mapping | 16.1.0 | +| 2020-06 | CT#88e | CP-201255 | 0015 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.1.0 | +| 2020-09 | CT#89e | CP-202066 | 0017 | 1 | F | Missed data type definition | 16.2.0 | +| 2020-09 | CT#89e | CP-202066 | 0018 | | F | Corrections on UE Mobility | 16.2.0 | +| 2020-09 | CT#89e | CP-202066 | 0019 | | F | Missed response code | 16.2.0 | +| 2020-09 | CT#89e | CP-202066 | 0020 | 1 | F | Any UE indication applies to EXCEPTIONS | 16.2.0 | +| 2020-12 | CT#90e | CP-203139 | 0021 | 1 | F | Essential Corrections and alignments | 16.3.0 | +| 2020-12 | CT#90e | CP-203139 | 0022 | | F | Storage of YAML files in 3GPP Forge | 16.3.0 | +| 2020-12 | CT#90e | CP-203129 | 0023 | 1 | F | Removal of trailing forward slash in resource URI | 16.3.0 | +| 2020-12 | CT#90e | CP-203139 | 0024 | 1 | F | Callback URI correction | 16.3.0 | +| 2020-12 | CT#90e | CP-203152 | 0027 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-12 | CT#90e | CP-203130 | 0025 | 1 | F | Corrections to location area usage | 17.0.0 | +| 2021-03 | CT#91e | CP-210206 | 0029 | | A | Correction to anyUeInd attribute | 17.1.0 | +| 2021-03 | CT#91e | CP-210191 | 0031 | 1 | A | Support Stateless NFs | 17.1.0 | +| 2021-03 | CT#91e | CP-210218 | 0032 | | F | OpenAPI reference | 17.1.0 | +| 2021-03 | CT#91e | CP-210219 | 0033 | | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.1.0 | +| 2021-03 | CT#91e | CP-210220 | 0034 | | F | Optional header clarification | 17.1.0 | +| 2021-03 | CT#91e | CP-210206 | 0036 | | F | Resource URI correction | 17.1.0 | +| 2021-03 | CT#91e | CP-210240 | 0038 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-06 | CT#92e | CP-211221 | 0039 | 1 | B | Partitioning criteria for applying sampling in specific UE partitions in AF exposure | 17.2.0 | +| 2021-06 | CT#92e | CP-211221 | 0040 | | B | Support of Mute reporting | 17.2.0 | +| 2021-06 | CT#92e | CP-211200 | 0041 | 1 | A | Redirection responses | 17.2.0 | +| 2021-06 | CT#92e | CP-211221 | 0043 | 1 | B | Extensions to User Data Congestion Analytics | 17.2.0 | +| 2021-06 | CT#92e | CP-211265 | 0045 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-09 | CT#93e | CP-212203 | 0046 | 2 | B | Support of Performance Data event | 17.3.0 | +| 2021-09 | CT#93e | CP-212220 | 0047 | | F | Resource URI correction on Naf_EventExposure API | 17.3.0 | +| 2021-09 | CT#93e | CP-212203 | 0048 | 1 | B | Collective Behaviour analytics | 17.3.0 | +| 2021-09 | CT#93e | CP-212203 | 0049 | 2 | B | Support UE data volume dispersion collection | 17.3.0 | +| 2021-09 | CT#93e | CP-212223 | 0050 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2021-12 | CT#94e | CP-213227 | 0052 | 1 | B | Updates to UE data volume dispersion collection | 17.4.0 | +| 2021-12 | CT#94e | CP-213256 | 0055 | | B | Collective Behaviour Analytics update | 17.4.0 | +| 2021-12 | CT#94e | CP-213227 | 0051 | 1 | F | Updates to User Data Congestion | 17.4.0 | +| 2021-12 | CT#94e | CP-213227 | 0053 | | F | Adding collective behaviour analytics feature | 17.4.0 | +| 2021-12 | CT#94e | CP-213227 | 0054 | 2 | F | Update of notification procedure with description of USER_DATA_CONGESTION and DISPERSION events | 17.4.0 | +| 2021-12 | CT#94e | CP-213220 | 0056 | | B | Alignment with SA3 supported TLS profiles | 17.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------------|--------| +| 2021-12 | CT#94e | CP-213246 | 0057 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.4.0 | +| 2022-03 | CT#95e | CP-220190 | 0058 | 1 | B | Update UE Application collective behaviour for NF Load analytics | 17.5.0 | +| 2022-03 | CT#95e | CP-220190 | 0059 | 1 | F | type attribute in CollectiveBehaviourFilter data type | 17.5.0 | +| 2022-03 | CT#95e | CP-220190 | 0060 | 1 | F | Miscellaneous corrections | 17.5.0 | +| 2022-03 | CT#95e | CP-220191 | 0062 | 1 | F | Formatting of description fields | 17.5.0 | +| 2022-03 | CT#95e | CP-220201 | 0061 | 1 | F | Corrections to Data Model of AF Event Exposure service | 17.5.0 | +| 2022-03 | CT#95e | CP-220194 | 0063 | | F | Update of info and externalDocs field | 17.5.0 | +| 2022-06 | CT#96 | CP-221131 | 0064 | 1 | B | Add Application duration for Dispersion | 17.6.0 | +| 2022-06 | CT#96 | CP-221131 | 0065 | 1 | B | Add Application Server Instance for Service Experience | 17.6.0 | +| 2022-06 | CT#96 | CP-221155 | 0068 | 1 | F | Remove the apiVersion placeholder from the resource URI variables table | 17.6.0 | +| 2022-06 | CT#96 | CP-221133 | 0066 | - | F | Muting notifications correction | 17.6.0 | +| 2022-06 | CT#96 | CP-221134 | 0067 | - | F | Presence condition on the data types of Naf_EventExposure service | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0069 | 1 | B | Support UE Application event exposure via Data Collection AF | 17.6.0 | +| 2022-06 | CT#96 | CP-221296 | 0070 | 1 | B | Support QoE metrics in AF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0071 | 1 | B | Support Consumption reports in AF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0072 | 1 | B | Support Network Assistance invocations in AF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0073 | 1 | B | Support Charging and Policy invocations in AF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221142 | 0074 | 1 | B | Support Media Streaming access activity in AF Event Exposure | 17.6.0 | +| 2022-06 | CT#96 | CP-221151 | 0075 | - | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-09 | CT#97e | CP-222101 | 0083 | - | F | clarification on dataUsage in DispersionCollection | 17.7.0 | +| 2022-09 | CT#97e | CP-222103 | 0084 | 1 | F | Add NOTE for 3xx response codes | 17.7.0 | +| 2022-09 | CT#97e | CP-222102 | 0085 | 1 | F | Missing description field for enumeration data types | 17.7.0 | +| 2022-09 | CT#97e | CP-222103 | 0082 | 1 | F | Correcting the events to which certain event consumers can subscribe | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0076 | 1 | B | Updates to Media Streaming QoE metrics Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0077 | 1 | F | Updates to Media Streaming Consumption Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0078 | 1 | F | Updates to Media Streaming Network Assistance Invocation Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0079 | 1 | F | Updates to Media Streaming Dynamic Policy Invocation Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222110 | 0080 | 1 | F | Updates to Media Streaming Access Event | 17.7.0 | +| 2022-09 | CT#97e | CP-222121 | 0086 | - | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-12 | CT#98e | C3-225534 | 0088 | 1 | F | Corrections to procedures of MS Event Exposure | 17.8.0 | +| 2022-12 | CT#98e | CP-223191 | 0087 | - | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0089 | 1 | F | Corrections to UE Mobility event | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0090 | 1 | F | Correct the name of the data structure | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0091 | - | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230145 | 0093 | 1 | A | Adding DCCF and MFAF to the NF service consumers | 18.1.0 | +| 2023-03 | CT#99 | CP-230134 | 0094 | 1 | B | Update to Data Type PerformanceData for DN Performance | 18.1.0 | +| 2023-03 | CT#99 | CP-230134 | 0095 | 1 | B | Updates to Data Type UeMobilityCollection for UE Mobility | 18.1.0 | +| 2023-03 | CT#99 | CP-230134 | 0096 | 1 | B | Enhance the performance data collection for DN performance | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0097 | 1 | B | Enhance the filter for performance data collection | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0098 | 1 | B | Support of collecting expected UE behaviour parameters from AF | 18.1.0 | +| 2023-03 | CT#99 | CP-230125 | 0100 | 1 | B | Updates to support GNSS assistance data collection from AF via NEF | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0101 | - | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231124 | 0099 | 2 | B | Improving the Correctness of Service Experience Analytics with Contribution Weights | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0102 | 1 | B | Adding UE address to the target UE information | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0103 | - | F | Missing feature dependency for performance data | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0104 | 1 | B | Event muting enhancements for AF event exposure | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0105 | 1 | B | Implementing required AF event filters | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0107 | 1 | F | Corrections to the description fields of the Naf_EventExposure API enumerations | 18.2.0 | +| 2023-06 | CT#100 | CP-231166 | 0109 | 1 | F | Changing the feature name for the GNSS Assistance Data Collection functionality | 18.2.0 | +| 2023-06 | CT#100 | CP-231166 | 0110 | - | B | Continuing the definition of the content of the GNSS Assistance Data Collection information | 18.2.0 | +| 2023-06 | CT#100 | CP-231249 | 0112 | 1 | B | Update to Naf_EventExposure API for E2E Data Volume Transfer Time Analytics | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0114 | - | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0115 | - | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232097 | 0116 | 1 | B | Support of providing the time stamp for the data volume dispersion information | 18.3.0 | +| 2023-09 | CT#101 | CP-232109 | 0117 | | F | Corrections to GNSS Assistance Data Collection | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0118 | 1 | F | Adding missing feature for appIds and locArea attributes | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0119 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-12 | CT#102 | CP-233262 | 0120 | 1 | B | Complete the definition of the content of the GNSS Assistance Data Collection information | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0121 | 1 | B | HTTP RFC uplifting | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0122 | - | F | corrections to CollectiveBehaviour | 18.4.0 | +| 2023-12 | CT#102 | CP-233229 | 0124 | 1 | B | Updating the obsoleted IETF HTTP RFCs | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------|--------| +| 2023-12 | CT#102 | CP-233247 | 0125 | 1 | B | Update the data types of the Media Steaming attributes | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0126 | - | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29519/raw.md b/marked/Rel-18/29_series/29519/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..aaa812c81b143c5729d2a26eca44f09ff42e80e8 --- /dev/null +++ b/marked/Rel-18/29_series/29519/raw.md @@ -0,0 +1,15645 @@ + + +# 3GPP TS 29.519 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Usage of the Unified Data Repository service for Policy Data, Application Data and Structured Data for Exposure; 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 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 + +## **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..... | 10 | +| 1 Scope..... | 11 | +| 2 References..... | 11 | +| 3 Definitions and abbreviations..... | 12 | +| 3.1 Definitions..... | 12 | +| 3.2 Abbreviations..... | 12 | +| 4 Overview..... | 13 | +| 5 Usage of Nudr_DataRepository Service API for Policy Data..... | 13 | +| 5.1 Introduction..... | 13 | +| 5.2 Resources..... | 13 | +| 5.2.1 Overview..... | 13 | +| 5.2.2 Resource Structure..... | 13 | +| 5.2.3 Resource: AccessAndMobilityPolicyData..... | 18 | +| 5.2.3.1 Description..... | 18 | +| 5.2.3.2 Resource definition..... | 18 | +| 5.2.3.3 Resource Standard Methods..... | 19 | +| 5.2.3.3.1 GET..... | 19 | +| 5.2.4 Resource: UEPolicySet..... | 19 | +| 5.2.4.1 Description..... | 19 | +| 5.2.4.2 Resource definition..... | 19 | +| 5.2.4.3 Resource Standard Methods..... | 19 | +| 5.2.4.3.1 PUT..... | 19 | +| 5.2.4.3.2 PATCH..... | 20 | +| 5.2.4.3.3 GET..... | 21 | +| 5.2.5 Resource: SessionManagementPolicyData..... | 21 | +| 5.2.5.1 Description..... | 21 | +| 5.2.5.2 Resource definition..... | 21 | +| 5.2.5.3 Resource Standard Methods..... | 22 | +| 5.2.5.3.1 GET..... | 22 | +| 5.2.5.3.2 PATCH..... | 22 | +| 5.2.6 Resource: UsageMonitoringInformation..... | 23 | +| 5.2.6.1 Description..... | 23 | +| 5.2.6.2 Resource definition..... | 23 | +| 5.2.6.3 Resource Standard Methods..... | 23 | +| 5.2.6.3.1 PUT..... | 23 | +| 5.2.6.3.2 DELETE..... | 24 | +| 5.2.6.3.3 GET..... | 25 | +| 5.2.7 Resource: SponsorConnectivityData..... | 25 | +| 5.2.7.1 Description..... | 25 | +| 5.2.7.2 Resource definition..... | 25 | +| 5.2.7.3 Resource Standard Methods..... | 26 | + +## 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.2.7.3.1 | GET..... | 26 | +| 5.2.8 | Resource: BdtData..... | 26 | +| 5.2.8.1 | Description..... | 26 | +| 5.2.8.2 | Resource definition..... | 26 | +| 5.2.8.3 | Resource Standard Methods..... | 26 | +| 5.2.8.3.1 | GET..... | 26 | +| 5.2.9 | Resource: IndividualBdtData..... | 27 | +| 5.2.9.1 | Description..... | 27 | +| 5.2.9.2 | Resource definition..... | 27 | +| 5.2.9.3 | Resource Standard Methods..... | 27 | +| 5.2.9.3.1 | GET..... | 27 | +| 5.2.9.3.2 | PUT..... | 28 | +| 5.2.9.3.3 | DELETE..... | 28 | +| 5.2.9.3.4 | PATCH..... | 29 | +| 5.2.10 | Resource: PolicyDataSubscriptions..... | 29 | +| 5.2.10.1 | Description..... | 29 | +| 5.2.10.2 | Resource definition..... | 30 | +| 5.2.10.3 | Resource Standard Methods..... | 30 | +| 5.2.10.3.1 | POST..... | 30 | +| 5.2.10.3.2 | GET..... | 30 | +| 5.2.11 | Resource: IndividualPolicyDataSubscription..... | 31 | +| 5.2.11.1 | Description..... | 31 | +| 5.2.11.2 | Resource definition..... | 31 | +| 5.2.11.3 | Resource Standard Methods..... | 32 | +| 5.2.11.3.1 | PUT..... | 32 | +| 5.2.11.3.2 | DELETE..... | 32 | +| 5.2.11.3.3 | GET..... | 33 | +| 5.2.12 | Resource: OperatorSpecificData..... | 33 | +| 5.2.12.1 | Description..... | 33 | +| 5.2.12.2 | Resource Definition..... | 33 | +| 5.2.12.3 | Resource Standard Methods..... | 34 | +| 5.2.12.3.1 | GET..... | 34 | +| 5.2.12.3.2 | PATCH..... | 34 | +| 5.2.12.3.3 | PUT..... | 35 | +| 5.2.12.3.4 | DELETE..... | 36 | +| 5.2.13 | Resource: PlmnUePolicySet..... | 36 | +| 5.2.13.1 | Description..... | 36 | +| 5.2.13.2 | Resource definition..... | 36 | +| 5.2.13.3 | Resource Standard Methods..... | 37 | +| 5.2.13.3.1 | GET..... | 37 | +| 5.2.14 | Resource: PolicyDataForIndividualUe..... | 37 | +| 5.2.14.1 | Description..... | 37 | +| 5.2.14.2 | Resource definition..... | 37 | +| 5.2.14.3 | Resource Standard Methods..... | 37 | +| 5.2.14.3.1 | GET..... | 37 | +| 5.2.15 | Resource: SlicePolicyControlData..... | 38 | +| 5.2.15.1 | Description..... | 38 | +| 5.2.15.2 | Resource definition..... | 38 | +| 5.2.15.3 | Resource Standard Methods..... | 38 | +| 5.2.15.3.1 | GET..... | 38 | +| 5.2.15.3.2 | PATCH..... | 39 | +| 5.2.16 | Resource: MBSSessionPolicyControlData..... | 40 | +| 5.2.16.1 | Description..... | 40 | +| 5.2.16.2 | Resource definition..... | 40 | +| 5.2.16.3 | Resource Standard Methods..... | 40 | +| 5.2.16.3.1 | GET..... | 40 | +| 5.2.17 | Resource: PdtqData..... | 40 | +| 5.2.17.1 | Description..... | 40 | +| 5.2.17.2 | Resource definition..... | 40 | +| 5.2.17.3 | Resource Standard Methods..... | 41 | +| 5.2.17.3.1 | GET..... | 41 | + +| | | | +|------------|------------------------------------------|----| +| 5.2.18 | Resource: IndividualPdtqData..... | 41 | +| 5.2.18.1 | Description..... | 41 | +| 5.2.18.2 | Resource definition..... | 41 | +| 5.2.18.3 | Resource Standard Methods..... | 42 | +| 5.2.18.3.1 | GET..... | 42 | +| 5.2.18.3.2 | PUT..... | 42 | +| 5.2.18.3.3 | DELETE..... | 43 | +| 5.2.18.3.4 | PATCH..... | 43 | +| 5.2.19 | Resource: GroupPolicyControlData..... | 44 | +| 5.2.19.1 | Description..... | 44 | +| 5.2.19.2 | Resource definition..... | 44 | +| 5.2.19.3 | Resource Standard Methods..... | 44 | +| 5.2.19.3.1 | GET..... | 44 | +| 5.2.19.3.2 | PATCH..... | 45 | +| 5.3 | Notifications..... | 45 | +| 5.3.1 | General..... | 45 | +| 5.3.2 | Policy Data Change Notification..... | 46 | +| 5.4 | Data Model..... | 46 | +| 5.4.1 | General..... | 46 | +| 5.4.2 | Structured data types..... | 50 | +| 5.4.2.1 | Introduction..... | 50 | +| 5.4.2.2 | Type AmPolicyData..... | 50 | +| 5.4.2.3 | Type UePolicySection..... | 50 | +| 5.4.2.4 | Type UePolicySet..... | 51 | +| 5.4.2.5 | Type SmPolicyData..... | 52 | +| 5.4.2.6 | Type UsageMonDataLimit..... | 53 | +| 5.4.2.7 | Type UsageMonData..... | 54 | +| 5.4.2.8 | Type SponsorConnectivityData..... | 54 | +| 5.4.2.9 | Type BdtData..... | 55 | +| 5.4.2.10 | Type PolicyDataSubscription..... | 56 | +| 5.4.2.11 | Type PolicyDataChangeNotification..... | 58 | +| 5.4.2.12 | Type TimePeriod..... | 60 | +| 5.4.2.13 | Type UsageMonDataScope..... | 60 | +| 5.4.2.14 | Type SmPolicySnssaiData..... | 60 | +| 5.4.2.15 | Type SmPolicyDnnData..... | 61 | +| 5.4.2.16 | Type LimitIdToMonitoringKey..... | 63 | +| 5.4.2.17 | Type UePolicySetPatch..... | 63 | +| 5.4.2.18 | Type PlmnRouteSelectionDescriptor..... | 63 | +| 5.4.2.19 | Type SnssaiRouteSelectionDescriptor..... | 63 | +| 5.4.2.20 | Type DnnRouteSelectionDescriptor..... | 64 | +| 5.4.2.21 | Type SmPolicyDataPatch..... | 64 | +| 5.4.2.22 | Type SmPolicySnssaiDataPatch..... | 64 | +| 5.4.2.23 | Type SmPolicyDnnDataPatch..... | 65 | +| 5.4.2.24 | Type ResourceItem..... | 65 | +| 5.4.2.25 | Type NotificationItem..... | 65 | +| 5.4.2.26 | Type UpdatedItem..... | 65 | +| 5.4.2.27 | Type BdtDataPatch..... | 66 | +| 5.4.2.28 | Type PolicyDataForIndividualUe..... | 66 | +| 5.4.2.29 | Type SlicePolicyData..... | 67 | +| 5.4.2.31 | Type MbsSessPolCtrlData..... | 68 | +| 5.4.2.32 | Type MbsSessPolDataId..... | 68 | +| 5.4.2.33 | Type PdtqData..... | 69 | +| 5.4.2.34 | Type PdtqDataPatch..... | 70 | +| 5.4.2.35 | Type GroupPolicyData..... | 70 | +| 5.4.3 | Simple data types and enumerations..... | 71 | +| 5.4.3.1 | Introduction..... | 71 | +| 5.4.3.2 | Simple data types..... | 71 | +| 5.4.3.3 | Enumeration: UsageMonLevel..... | 71 | +| 5.4.3.4 | Enumeration: Periodicity..... | 71 | +| 5.4.3.5 | Enumeration: BdtPolicyStatus..... | 72 | +| 5.4.3.7 | void..... | 72 | + +| | | | +|------------|--------------------------------------------------------------------|----| +| 5.5 | Error handling..... | 72 | +| 5.5.1 | General..... | 72 | +| 5.5.2 | Protocol Errors..... | 72 | +| 5.5.3 | Application Errors..... | 73 | +| 5.6 | Feature negotiation..... | 73 | +| 6 | Usage of Nudr_DataRepository Service API for Application Data..... | 73 | +| 6.1 | Introduction..... | 73 | +| 6.2 | Resources..... | 73 | +| 6.2.1 | Overview..... | 73 | +| 6.2.2 | Resource Structure..... | 73 | +| 6.2.3 | Resource: PFD Data..... | 78 | +| 6.2.3.1 | Description..... | 78 | +| 6.2.3.2 | Resource definition..... | 78 | +| 6.2.3.3 | Resource Standard Methods..... | 78 | +| 6.2.3.3.1 | GET..... | 78 | +| 6.2.4 | Resource: Individual PFD Data..... | 79 | +| 6.2.4.1 | Description..... | 79 | +| 6.2.4.2 | Resource definition..... | 79 | +| 6.2.4.3 | Resource Standard Methods..... | 79 | +| 6.2.4.3.1 | GET..... | 79 | +| 6.2.4.3.2 | DELETE..... | 80 | +| 6.2.4.3.3 | PUT..... | 80 | +| 6.2.5 | Resource: Influence Data..... | 81 | +| 6.2.5.1 | Description..... | 81 | +| 6.2.5.2 | Resource definition..... | 81 | +| 6.2.5.3 | Resource Standard Methods..... | 81 | +| 6.2.5.3.1 | GET..... | 81 | +| 6.2.6 | Resource: Individual Influence Data..... | 83 | +| 6.2.6.1 | Description..... | 83 | +| 6.2.6.2 | Resource definition..... | 83 | +| 6.2.6.3 | Resource Standard Methods..... | 83 | +| 6.2.6.3.1 | PUT..... | 83 | +| 6.2.6.3.2 | PATCH..... | 84 | +| 6.2.6.3.3 | DELETE..... | 84 | +| 6.2.7 | Resource: Influence Data Subscription..... | 85 | +| 6.2.7.1 | Description..... | 85 | +| 6.2.7.2 | Resource definition..... | 85 | +| 6.2.7.3 | Resource Standard Methods..... | 85 | +| 6.2.7.3.1 | POST..... | 85 | +| 6.2.7.3.2 | GET..... | 86 | +| 6.2.8 | Resource: Individual Influence Data Subscription..... | 87 | +| 6.2.8.1 | Description..... | 87 | +| 6.2.8.2 | Resource definition..... | 87 | +| 6.2.8.3 | Resource Standard Methods..... | 87 | +| 6.2.8.3.1 | GET..... | 87 | +| 6.2.8.3.2 | PUT..... | 87 | +| 6.2.8.3.3 | DELETE..... | 88 | +| 6.2.9 | Resource: Applied BDT Policy Data..... | 88 | +| 6.2.9.1 | Description..... | 88 | +| 6.2.9.2 | Resource definition..... | 88 | +| 6.2.9.3 | Resource Standard Methods..... | 89 | +| 6.2.9.3.1 | GET..... | 89 | +| 6.2.10 | Resource: Individual Applied BDT Policy Data..... | 90 | +| 6.2.10.1 | Description..... | 90 | +| 6.2.10.2 | Resource definition..... | 90 | +| 6.2.10.3 | Resource Standard Methods..... | 90 | +| 6.2.10.3.1 | PUT..... | 90 | +| 6.2.10.3.2 | PATCH..... | 91 | +| 6.2.10.3.3 | DELETE..... | 91 | +| 6.2.11 | Resource: IPTV Configurations..... | 92 | +| 6.2.11.1 | Description..... | 92 | + +| | | | +|------------|-----------------------------------------------------------|-----| +| 6.2.11.2 | Resource definition..... | 92 | +| 6.2.11.3 | Resource Standard Methods..... | 92 | +| 6.2.11.3.1 | GET..... | 92 | +| 6.2.12 | Resource: Individual IPTV Configuration..... | 93 | +| 6.2.12.1 | Description..... | 93 | +| 6.2.12.2 | Resource definition..... | 93 | +| 6.2.12.3 | Resource Standard Methods..... | 93 | +| 6.2.12.3.1 | PUT..... | 93 | +| 6.2.12.3.2 | DELETE..... | 94 | +| 6.2.12.3.3 | PATCH..... | 94 | +| 6.2.13 | Resource: ApplicationDataSubscriptions..... | 95 | +| 6.2.13.1 | Description..... | 95 | +| 6.2.13.2 | Resource definition..... | 95 | +| 6.2.13.3 | Resource Standard Methods..... | 95 | +| 6.2.13.3.1 | POST..... | 95 | +| 6.2.13.3.2 | GET..... | 96 | +| 6.2.14 | Resource: IndividualApplicationDataSubscription..... | 97 | +| 6.2.14.1 | Description..... | 97 | +| 6.2.14.2 | Resource definition..... | 97 | +| 6.2.14.3 | Resource Standard Methods..... | 97 | +| 6.2.14.3.1 | PUT..... | 97 | +| 6.2.14.3.2 | DELETE..... | 97 | +| 6.2.14.3.3 | GET..... | 98 | +| 6.2.15 | Resource: Service Parameter Data..... | 98 | +| 6.2.15.1 | Description..... | 98 | +| 6.2.15.2 | Resource definition..... | 98 | +| 6.2.15.3 | Resource Standard Methods..... | 99 | +| 6.2.15.3.1 | GET..... | 99 | +| 6.2.16 | Resource: Individual Service Parameter Data..... | 101 | +| 6.2.16.1 | Description..... | 101 | +| 6.2.16.2 | Resource definition..... | 101 | +| 6.2.16.3 | Resource Standard Methods..... | 102 | +| 6.2.16.3.1 | PUT..... | 102 | +| 6.2.16.3.2 | PATCH..... | 102 | +| 6.2.16.3.3 | DELETE..... | 103 | +| 6.2.17 | Resource: AM Influence Data..... | 103 | +| 6.2.17.1 | Description..... | 103 | +| 6.2.17.2 | Resource definition..... | 103 | +| 6.2.17.3 | Resource Standard Methods..... | 104 | +| 6.2.17.3.1 | GET..... | 104 | +| 6.2.18 | Resource: Individual AM Influence Data..... | 105 | +| 6.2.18.1 | Description..... | 105 | +| 6.2.18.2 | Resource definition..... | 105 | +| 6.2.18.3 | Resource Standard Methods..... | 106 | +| 6.2.18.3.1 | PUT..... | 106 | +| 6.2.18.3.2 | PATCH..... | 106 | +| 6.2.18.3.3 | DELETE..... | 107 | +| 6.2.19 | Resource: EAS Deployment Information Data..... | 107 | +| 6.2.19.1 | Description..... | 107 | +| 6.2.19.2 | Resource definition..... | 107 | +| 6.2.19.3 | Resource Standard Methods..... | 108 | +| 6.2.19.3.1 | GET..... | 108 | +| 6.2.20 | Resource: Individual EAS Deployment Information Data..... | 108 | +| 6.2.20.1 | Description..... | 108 | +| 6.2.20.2 | Resource definition..... | 108 | +| 6.2.20.3 | Resource Standard Methods..... | 109 | +| 6.2.20.3.1 | GET..... | 109 | +| 6.2.20.3.2 | PUT..... | 109 | +| 6.2.20.3.3 | DELETE..... | 110 | +| 6.2.21 | Resource: AF Requested QoS Data Sets..... | 110 | +| 6.2.21.1 | Description..... | 110 | + +| | | | +|------------|-----------------------------------------------------|-----| +| 6.2.21.2 | Resource definition..... | 110 | +| 6.2.21.3 | Resource Standard Methods..... | 111 | +| 6.2.21.3.1 | GET..... | 111 | +| 6.2.22 | Resource: Individual AF Requested QoS Data Set..... | 112 | +| 6.2.22.1 | Description..... | 112 | +| 6.2.22.2 | Resource definition..... | 112 | +| 6.2.22.3 | Resource Standard Methods..... | 112 | +| 6.2.22.3.1 | PUT..... | 112 | +| 6.2.22.3.2 | PATCH..... | 113 | +| 6.2.22.3.3 | DELETE..... | 113 | +| 6.2.23 | Resource: Individual DNAI EAS Mapping..... | 114 | +| 6.2.23.1 | Description..... | 114 | +| 6.2.23.2 | Resource definition..... | 114 | +| 6.2.23.3 | Resource Standard Methods..... | 114 | +| 6.2.23.3.1 | GET..... | 114 | +| 6.2.24 | Resource: ECS Address Roaming Data..... | 115 | +| 6.2.24.1 | Description..... | 115 | +| 6.2.24.2 | Resource definition..... | 115 | +| 6.2.24.3 | Resource Standard Methods..... | 115 | +| 6.2.24.3.1 | GET..... | 115 | +| 6.2.25 | Resource: Individual ECS Address Roaming Data..... | 116 | +| 6.2.25.1 | Description..... | 116 | +| 6.2.25.2 | Resource definition..... | 116 | +| 6.2.25.3 | Resource Standard Methods..... | 116 | +| 6.2.25.3.1 | GET..... | 116 | +| 6.2.25.3.2 | PUT..... | 116 | +| 6.2.25.3.3 | DELETE..... | 117 | +| 6.3 | Notifications..... | 118 | +| 6.3.1 | General..... | 118 | +| 6.3.2 | Void..... | 118 | +| 6.3.3 | Influence Data Update Notification..... | 118 | +| 6.3.3.1 | Description..... | 118 | +| 6.3.3.2 | Operation Definition..... | 118 | +| 6.3.4 | Application Data Change Notification..... | 119 | +| 6.4 | Data Model..... | 119 | +| 6.4.1 | General..... | 119 | +| 6.4.2 | Structured data types..... | 123 | +| 6.4.2.1 | Introduction..... | 123 | +| 6.4.2.2 | Type TrafficInfluData..... | 124 | +| 6.4.2.5 | Void..... | 130 | +| 6.4.2.6 | Type: PfdDataForAppExt..... | 130 | +| 6.4.2.7 | Type BdtPolicyData..... | 130 | +| 6.4.2.9 | Type IptvConfigData..... | 131 | +| 6.4.2.10 | Type ApplicationDataSubs..... | 132 | +| 6.4.2.11 | Type ApplicationDataChangeNotif..... | 133 | +| 6.4.2.12 | Type DataFilter..... | 134 | +| 6.4.2.13 | Void..... | 136 | +| 6.4.2.14 | Type TrafficInfluDataNotif..... | 136 | +| 6.4.2.15 | Type ServiceParameterData..... | 137 | +| 6.4.2.15A | Type ServiceParameterDataPatch..... | 139 | +| 6.4.2.16 | Type AmInfluData..... | 141 | +| 6.4.2.17 | Type AmInfluDataPatch..... | 142 | +| 6.4.2.18 | Type AfRequestedQosData..... | 143 | +| 6.4.2.19 | Type AfRequestedQosDataPatch..... | 144 | +| 6.4.2.20 | Type TrafficCorrelationInfo..... | 145 | +| 6.4.2.21 | Type DnaiEasMapping..... | 145 | +| 6.4.2.22 | Type DnaiEasInfo..... | 145 | +| 6.4.2.23 | Type EcsAddrData..... | 146 | +| 6.4.3 | Simple data types and enumerations..... | 146 | +| 6.4.3.1 | Introduction..... | 146 | +| 6.4.3.2 | Simple data types..... | 146 | + +| | | | +|-----------|--------------------------------------------------------------------------------|-----| +| 6.4.3.3 | Enumeration: DataInd..... | 146 | +| 6.4.3.4 | Enumeration: CorrelationType..... | 147 | +| 6.5 | Error handling..... | 147 | +| 6.5.1 | General..... | 147 | +| 6.5.2 | Protocol Errors..... | 147 | +| 6.5.3 | Application Errors..... | 147 | +| 6.6 | Feature negotiation..... | 147 | +| 7 | Usage of Nudr_DataRepository Service API for Structured Data for Exposure..... | 147 | +| 7.1 | Introduction..... | 147 | +| 7.2 | Resources..... | 148 | +| 7.2.1 | Overview..... | 148 | +| 7.2.2 | Resource Structure..... | 148 | +| 7.2.3 | Resource: AccessAndMobilityData..... | 149 | +| 7.2.3.1 | Description..... | 149 | +| 7.2.3.2 | Resource definition..... | 149 | +| 7.2.3.3 | Resource Standard Methods..... | 149 | +| 7.2.3.3.1 | PUT..... | 149 | +| 7.2.3.3.2 | GET..... | 150 | +| 7.2.3.3.3 | DELETE..... | 151 | +| 7.2.3.3.4 | PATCH..... | 151 | +| 7.2.4 | Resource: PduSessionManagementData..... | 151 | +| 7.2.4.1 | Description..... | 151 | +| 7.2.4.2 | Resource definition..... | 152 | +| 7.2.4.3 | Resource Standard Methods..... | 152 | +| 7.2.4.3.1 | PUT..... | 152 | +| 7.2.4.3.2 | GET..... | 153 | +| 7.2.4.3.3 | DELETE..... | 153 | +| 7.2.5 | Resource: ExposureDataSubscriptions..... | 154 | +| 7.2.5.1 | Description..... | 154 | +| 7.2.5.2 | Resource Definition..... | 154 | +| 7.2.5.3 | Resource Standard Methods..... | 154 | +| 7.2.5.3.1 | POST..... | 154 | +| 7.2.6 | Resource: IndividualExposureDataSubscription..... | 155 | +| 7.2.6.1 | Description..... | 155 | +| 7.2.6.2 | Resource Definition..... | 155 | +| 7.2.6.3 | Resource Standard Methods..... | 155 | +| 7.2.6.3.1 | PUT..... | 155 | +| 7.2.6.3.2 | DELETE..... | 155 | +| 7.3 | Data Model..... | 156 | +| 7.3.1 | General..... | 156 | +| 7.3.2 | Structured data types..... | 157 | +| 7.3.2.1 | Introduction..... | 157 | +| 7.3.2.2 | Type AccessAndMobilityData..... | 158 | +| 7.3.2.3 | Type PduSessionManagementData..... | 159 | +| 7.3.2.4 | Type ExposureDataSubscription..... | 160 | +| 7.3.2.5 | Type ExposureDataChangeNotification..... | 161 | +| 7.3.3 | Simple data types and enumerations..... | 161 | +| 7.3.3.1 | Introduction..... | 161 | +| 7.3.3.2 | Simple data types..... | 161 | +| 7.3.3.3 | Enumeration: PduSessionStatus..... | 161 | +| 7.4 | Error handling..... | 161 | +| 7.4.1 | General..... | 161 | +| 7.4.2 | Protocol Errors..... | 162 | +| 7.4.3 | Application Errors..... | 162 | +| 7.5 | Feature negotiation..... | 162 | +| 7.6 | Notifications..... | 162 | +| 7.6.1 | General..... | 162 | +| 7.6.2 | Exposure Data Change Notification..... | 162 | + +**Annex A (normative): OpenAPI specification..... 163** + +A.1 General..... 163 + +A.2 Nudr\_DataRepository API for Policy Data..... 163 + +A.3 Nudr\_DataRepository API for Application Data..... 205 + +A.4 Nudr\_DataRepository API for Exposure Data..... 261 + +**Annex B (informative): Change history..... 274** + +--- + +## 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 for the usage of the Unified Data Repository service (Nudr\_DataRepository) of 5G System for Policy Data, Application Data and Structured Data for Exposure. + +The Unified Data Repository (UDR) provides the Unified Data Repository service. This service provides a repository for policy data, application data and exposure data. + +The stage 3 protocol definition for Nudr Service Based Interface which is common for subscription data, policy data, application data and exposure data is specified in 3GPP TS 29.504 [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] Void. +- [3] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [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.504: "5G System; Unified Data Repository Services; Stage 3". +- [7] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [8] 3GPP TS 29.551: "5G System; Packet Flow Description Management Service; Stage 3". +- [9] 3GPP TS 29.122: "T8 reference point for Northbound APIs". +- [10] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [11] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [12] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; Stage 3". +- [13] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". +- [14] Void. +- [15] 3GPP TS 29.505: "5G System; Usage of the Unified Data Repository services for Subscription Data; Stage 3". +- [16] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [17] IETF RFC 4122: "A Universally Unique Identifier (UUID) URN Namespace". +- [18] 3GPP TR 21.900: "Technical Specification Group working methods". +- [19] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". + +- [20] IETF RFC 6901: "JavaScript Object Notation (JSON) Pointer". +- [21] IETF RFC 9110: "HTTP Semantics". +- [22] 3GPP TS 29.534: "5G System; Access and Mobility Policy Authorization Service; Stage 3". +- [23] 3GPP TS 29.591: "5G System; Network Exposure Function Southbound Services; Stage 3". +- [24] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [25] 3GPP TS 29.543: "5G System; Data Transfer Policy Control Services; Stage 3". +- [26] 3GPP TS 32.421: "Telecommunication management; Subscriber and equipment trace; Trace concepts and requirements". +- [27] 3GPP TS 29.565: "5G System; Time Sensitive Communication and Time Synchronization Function 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]. + +### 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]. + +| | | +|---------|-------------------------------------------------------| +| A2X | Aircraft-to-Everything | +| AM | Access and Mobility Management | +| ATSSS | Access Traffic Steering, Switching, Splitting | +| BDT | Background Data Transfer | +| DNAI | DN Access Identifier | +| DNN | Data Network Name | +| EAS | Edge Application Server | +| ECS | Edge Configuration Server | +| GPSI | Generic Public Subscription Identifier | +| JSON | JavaScript Object Notation | +| MA | Multi Access | +| NEF | Network Exposure Function | +| NR | New Radio | +| NRF | Network Repository Function | +| PCF | Policy Control Function | +| PDTQ | Planned Data Transfer with QoS requirements | +| PFD | Packet Flow Description | +| PSA | PDU Session Anchor | +| SFC | Service Function Chain | +| SM | Session Management | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SUPI | Subscription Permanent Identifier | +| TNAP | Trusted Network Access Point | +| UDR | Unified Data Repository | +| UPF | User Plane Function | +| UPSI | UE Policy Section Identifier | +| URSP | UE Route Selection Policy | + +--- + +## 4 Overview + +The resources, data model and usage defined in the present document are used by the 5GC NFs (e.g. PCF, NEF) to access the policy data, application data or exposure data via the Unified Data Repository services as specified in 3GPP TS 29.504 [6]. + +--- + +## 5 Usage of Nudr\_DataRepository Service API for Policy Data + +### 5.1 Introduction + +The following clauses specify the usage of Nudr\_DataRepository service for policy data. The principles specified in 3GPP TS 29.504 [6] are followed unless explicitly specified otherwise in the following clauses. + +### 5.2 Resources + +#### 5.2.1 Overview + +This clause specifies the resources for the usage of the Unified Data Repository service for Policy Data. + +#### 5.2.2 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.2.2-1 depicts the resource URIs structure for the Nudr\_DataRepository API for policy data. + + + +![A hierarchical tree diagram showing the structure of API paths under {apiRoot}/nudr-dr/. The root path is /policy-data. Sub-paths include /ues, /sponsor-connectivity-data, /bdt-data, /subs-to-notify, /plmns, /slice-control-data, /mbs-session-pol-data, and /pdtq-data. Each sub-path has associated resource identifiers in curly braces, such as {ueId}, {sponsorId}, {bdtReferenceId}, {subsId}, {plmnId}, {snssai}, {polSessionId}, and {pdtqReferenceId}. Further sub-resources like /am-data, /ue-policy-set, /sm-data, and /operator-specific-data are shown under /ues/{ueId}. /sm-data has a {usageMonId} sub-resource. /ue-policy-set is also shown under /plmns/{plmnId}.](1a827b10290f33d4fec04d0e8ef7a897_img.jpg) + +``` +graph TD; Root["{apiRoot}/nudr-dr/"] --> PolicyData["/policy-data"]; PolicyData --> Ues["/ues"]; PolicyData --> SponsorData["/sponsor-connectivity-data"]; PolicyData --> BdtData["/bdt-data"]; PolicyData --> SubsNotify["/subs-to-notify"]; PolicyData --> Plmns["/plmns"]; PolicyData --> SliceControlData["/slice-control-data"]; PolicyData --> MbsSessionPolData["/mbs-session-pol-data"]; PolicyData --> PdtqData["/pdtq-data"]; Ues --> UeId["/{ueId}"]; UeId --> AmData["/am-data"]; UeId --> UePolicySet1["/ue-policy-set"]; UeId --> SmData["/sm-data"]; UeId --> OperatorSpecificData["/operator-specific-data"]; SmData --> UsageMonId["/{usageMonId}"]; SponsorData --> SponsorId["/{sponsorId}"]; BdtData --> BdtReferenceId["/{bdtReferenceId}"]; SubsNotify --> SubsId["/{subsId}"]; Plmns --> PlmnId["/{plmnId}"]; PlmnId --> UePolicySet2["/ue-policy-set"]; SliceControlData --> Snssai["/{snssai}"]; MbsSessionPolData --> PolSessionId["/{polSessionId}"]; PdtqData --> PdtqReferenceId["/{pdtqReferenceId}"]; +``` + +A hierarchical tree diagram showing the structure of API paths under {apiRoot}/nudr-dr/. The root path is /policy-data. Sub-paths include /ues, /sponsor-connectivity-data, /bdt-data, /subs-to-notify, /plmns, /slice-control-data, /mbs-session-pol-data, and /pdtq-data. Each sub-path has associated resource identifiers in curly braces, such as {ueId}, {sponsorId}, {bdtReferenceId}, {subsId}, {plmnId}, {snssai}, {polSessionId}, and {pdtqReferenceId}. Further sub-resources like /am-data, /ue-policy-set, /sm-data, and /operator-specific-data are shown under /ues/{ueId}. /sm-data has a {usageMonId} sub-resource. /ue-policy-set is also shown under /plmns/{plmnId}. + +**Figure 5.2.2-1: Resource URI structure of the Nudr\_DataRepository API for policy data** + +Table 5.2.2-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.2.2-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------|----------------------------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PolicyDataForIndividualUe | /policy-data/ues/{ueId} | GET | Retrieve multiple policy data sets (access and mobility policy data, UE policy set data, session management policy data, usage monitoring data, operator specific policy data) for a subscriber. | +| AccessAndMobilityPolicyData | /policy-data/ues/{ueId}/am-data | GET | Retrieve the access and mobility policy data for a subscriber. | +| UEPolicySet | /policy-data/ues/{ueId}/ue-policy-set | GET | Retrieve the UE policy set data for a subscriber. | +| | | PUT | Create or modify the UE policy set data for a subscriber. | +| | | PATCH | Modify the UE policy set data for a subscriber. | +| SessionManagementPolicyData | /policy-data/ues/{ueId}/sm-data | GET | Retrieve the session management policy data for a subscriber. | +| | | PATCH | When the feature "SessionManagementPolicyDataPatch" is supported, modify the session management policy data for a subscriber. | +| UsageMonitoringInformation | /policy-data/ues/{ueId}/sm-data/{usageMonId} | GET | Retrieve a usage monitoring resource. | +| | | PUT | Create a usage monitoring resource. | +| | | DELETE | Delete a usage monitoring resource. | +| OperatorSpecificData | /policy-data/ues/{ueId}/operator-specific-data | GET | Retrieve the operator specific policy data of a UE | +| | | PATCH | Modify the operator specific policy data of a UE. | +| | | PUT | Create or modify the operator specific policy data of a UE. | +| | | DELETE | Delete the operator specific policy data for a UE. | +| SponsorConnectivityData | /policy-data/sponsor-connectivity-data/{sponsorId} | GET | Retrieve the sponsored connectivity information for a given sponsorId. | +| BdtData | /policy-data/bdt-data | GET | Retrieve the BDT data collection. | +| IndividualBdtData | /policy-data/bdt-data/{bdtReferenceId} | GET | Retrieve the BDT data information associated with a BDT reference Id. | +| | | PUT | Create a BDT data resource associated with a BDT reference Id. | +| | | PATCH | Modifies an BDT data resource associated with an BDT reference Id. | +| | | DELETE | Delete a BDT data resource associated with a BDT reference Id. | +| PolicyDataSubscriptions | /policy-data/subs-to-notify | GET | Retrieve Individual Policy Data Subscriptions from the Policy Data Subscriptions collection. | +| | | POST | Create a subscription to receive notifications of policy data changes. | +| IndividualPolicyDataSubscription | /policy-data/subs-to-notify/{subsId} | GET | Retrieve a subscription identified by {subsId}. | +| | | PUT | Modify a subscription to receive | + +| | | | | +|----------------------------|--------------------------------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------| +| | | | notifications of policy data changes. | +| | | DELETE | Delete a subscription identified by {subsId}. | +| PlmnUePolicySet | /policy-data/plmns/{plmnId}/ue-policy-set | GET | Retrieve the UE policy set data for an H-PLMN. | +| SlicePolicyControlData | /policy-data/slice-control-data/{snssai} | GET | Retrieve network slice specific policy control data for a given S-NSSAI. | +| | | PATCH | Modify network slice specific policy control data for a given S-NSSAI. | +| MBSessionPolicyControlData | /policy-data/mbs-session-pol-data/{polSessionId} | GET | Retrieve MBS Session Policy Control Data for an MBS Session based on the MBS Session Identifier or an AF Application Identifier. | +| PdtqData | /policy-data/pdtq-data | GET | Retrieve the PDTQ data collection. | +| IndividualPdtqData | /policy-data/pdtq-data/{pdtqReferenceId} | GET | Retrieve the PDTQ data information associated with a PDTQ reference Id. | +| | | PUT | Create a PDTQ data resource associated with a PDTQ reference Id. | +| | | PATCH | Modifies a PDTQ data resource associated with an PDTQ reference Id. | +| | | DELETE | Delete a PDTQ data resource associated with a PDTQ reference Id. | +| GroupPolicyControlData | /policy-data/group-control-data/{intGroupId} | GET | Retrieve group specific policy control data for a 5G VN group. | +| | | PATCH | Modify group specific policy control data for a 5G VN group. | + +## 5.2.3 Resource: AccessAndMobilityPolicyData + +### 5.2.3.1 Description + +The resource represents all UE related mobility and access policies attributes in the UDR for a given "ueId". + +### 5.2.3.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/ues/{ueId}/am-data + +This resource shall support the resource URI variables defined in table 5.2.3.2-1. + +**Table 5.2.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7]. | + +### 5.2.3.3 Resource Standard Methods + +#### 5.2.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.3.3.1-1. + +**Table 5.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.2.3.3.1-2 and the response data structures and response codes specified in table 5.2.3.3.1-3. + +**Table 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 5.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------| +| AmPolicyData | M | 1 | 200 OK | Upon success, a response body containing access and mobility policies shall be returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 5.2.4 Resource: UEPolicySet + +#### 5.2.4.1 Description + +The resource represents UE policy set for a given "ueId" stored in the UDR of the H-PLMN. + +#### 5.2.4.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/ues/{ueId}/ue-policy-set + +This resource shall support the resource URI variables defined in table 5.2.4.2-1. + +**Table 5.2.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1 | +| ueId | VarUeld | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeld is defined in 3GPP TS 29.571 [7]. | + +#### 5.2.4.3 Resource Standard Methods + +##### 5.2.4.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.4.3.1-1. + +**Table 5.2.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.2.4.3.1-2 and the response data structures and response codes specified in table 5.2.4.3.1-3. + +**Table 5.2.4.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|---------------------------------------------------------------------| +| UePolicySet | M | 1 | Create or modify the UE policy set resource for a given subscriber. | + +**Table 5.2.4.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UePolicySet | M | 1 | 201 Created | Successful case.
The resource has been successfully created and a response body containing a representation of the created UePolicySet resource shall be returned. | +| UePolicySet | M | 1 | 200 OK | Successful case.
The resource has been successfully updated and a response body containing UE policies shall be returned. | +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. | + +NOTE: 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. + +**Table 5.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}/nudr-dr//policy-data/ues/{ueId}/ue-policy-set | + +## 5.2.4.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.2.4.3.2-1. + +**Table 5.2.4.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.2.4.3.2-2 and the response data structures and response codes specified in table 5.2.4.3.2-3. + +**Table 5.2.4.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------------| +| UePolicySetPatch | M | 1 | Modify the UE policy set resource for a given subscriber. | + +**Table 5.2.4.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 5.2.4.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.4.3.3-1. + +**Table 5.2.4.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.2.4.3.3-2 and the response data structures and response codes specified in table 5.2.4.3.3-3. + +**Table 5.2.4.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.4.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------| +| UePolicySet | M | 1 | 200 OK | Upon success, a response body containing the UE policies shall be returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.5 Resource: SessionManagementPolicyData + +### 5.2.5.1 Description + +The resource represents all PDU session related subscription attributes in the UDR for a given ueId. + +### 5.2.5.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/ues/{ueId}/sm-data + +This resource shall support the resource URI variables defined in table 5.2.5.2-1. + +**Table 5.2.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7]. | + +### 5.2.5.3 Resource Standard Methods + +#### 5.2.5.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.5.3.1-1. + +**Table 5.2.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| snssai | Snssai | O | 0..1 | Identifies a Single Network Slice Selection Assistance Information. | +| dnn | Dnn | O | 0..1 | Identifies a Data Network Name. | +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supp-feat | SupportedFeatures | O | 0..1 | Identifies the features supported by the NF service consumer. | + +When an optional query parameter is not included, the UDR shall return session management policy data per DNN matching the value of the included query parameter(s) for all the possible values of the omitted query parameter. E.g. if "snssai" is not included, and "dnn" is included, UDR shall return the session management policy data per DNN for the DNN identified by "dnn" for all network slices where such DNN is available. + +This method shall support the request data structures specified in table 5.2.5.3.1-2 and the response data structures and response codes specified in table 5.2.5.3.1-3. + +**Table 5.2.5.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.5.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------| +| SmPolicyData | M | 1 | 200 OK | Upon success, a response body containing SmPolicyData shall be returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +NOTE: This release supports that only one PCF can access to the UDR to retrieve the SM Policy Data under one S-NSSAI and DNN association. + +#### 5.2.5.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.2.5.3.2-1. + +**Table 5.2.5.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 5.2.5.3.2-2 and the response data structures and response codes specified in table 5.2.5.3.2-3. + +**Table 5.2.5.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| SmPolicyDataPatch | M | 1 | When the "SessionManagementPolicyDataPatch" feature is supported, it requests the modification of the session management policy data for a subscriber. | + +**Table 5.2.5.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------| +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. (NOTE 2)(NOTE 3) | +| SmPolicyData | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) (NOTE 3) | + +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] also apply. + +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer supported the "PatchReport" feature, the UDR shall respond with SmPolicyData. + +NOTE 3: When the resource is successfully updated, if the SmPolicyDataPatch in the request requires the creation, removal, or update of an entry of the "umData" attribute, the UDR shall create, remove or update the corresponding UsageMonitoringInformation resource for the indicated limit identifier. + +## 5.2.6 Resource: UsageMonitoringInformation + +### 5.2.6.1 Description + +The resource represents an individual usage monitoring resource created in the UDR and associated with a ueId and a usageMonId. + +### 5.2.6.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/ues/{ueId}/sm-data/{usageMonId} + +This resource shall support the resource URI variables defined in table 5.2.6.2-1. + +**Table 5.2.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7]. | +| usageMonId | string | Unique identifier of the individual SM Policy usage monitoring resource. It contains the identity of the corresponding limit as defined in the "limitId" attribute of the UsageMonDataLimit data type (see clause 5.4.2.6). | + +### 5.2.6.3 Resource Standard Methods + +#### 5.2.6.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.6.3.1-1. + +**Table 5.2.6.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.2.6.3.1-2 and the response data structures and response codes specified in table 5.2.6.3.1-3. + +**Table 5.2.6.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|---------------------------------------| +| UsageMonData | M | 1 | Create the usage monitoring resource. | + +**Table 5.2.6.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| UsageMonData | M | 1 | 201 Created | Successful case.
The resource has been successfully created and a response body is returned containing a representation of the resource.
(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 [4] also apply. +NOTE 2: When the resource is successfully created, the UDR shall create a new entry within the "umData" attribute of the SessionManagementPolicyData resource for the corresponding "limitId" accordingly. + +**Table 5.2.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}/nudr-dr//policy-data/ues/{ueId}/sm-data/{usageMonId} | + +## 5.2.6.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.6.3.2-1. + +**Table 5.2.6.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.2.6.3.2-2 and the response data structures and response codes specified in table 5.2.6.3.2-3. + +**Table 5.2.6.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.6.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 resource has been successfully deleted.
(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] also apply. +NOTE 2: When the resource is successfully deleted, the UDR shall delete within the "umData" attribute of the SessionManagementPolicyData resource the corresponding "limitId" entry accordingly. + +### 5.2.6.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.6.3.3-1. + +**Table 5.2.6.3.3-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.2.6.3.3-2 and the response data structures and response codes specified in table 5.2.6.3.3-3. + +**Table 5.2.6.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.6.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------| +| UsageMonData | M | 1 | 200 OK | Successful case.
The usage monitoring data is returned. | +| n/a | | | 204 No Content | The resource was found but no usage monitoring data is available. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.7 Resource: SponsorConnectivityData + +### 5.2.7.1 Description + +The resource represents sponsored data connectivity related information stored in the UDR for a given sponsorId. + +### 5.2.7.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/policy-data/sponsor-connectivity-data/{sponsorId} + +This resource shall support the resource URI variables defined in table 5.2.7.2-1. + +**Table 5.2.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| sponsorId | string | Represents the sponsor identity. | + +### 5.2.7.3 Resource Standard Methods + +#### 5.2.7.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.7.3.1-1. + +**Table 5.2.7.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.2.7.3.1-2 and the response data structures and response codes specified in table 5.2.7.3.1-3. + +**Table 5.2.7.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.7.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------| +| SponsorConnectivityData | M | 1 | 200 OK | Upon success, a response body containing Sponsor Connectivity Data shall be returned. | +| n/a | | | 204 No Content | The resource was found but no Sponsor Connectivity Data is available. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.8 Resource: BdtData + +### 5.2.8.1 Description + +The resource represents background data transfer data stored in the UDR. + +### 5.2.8.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/bdt-data + +This resource shall support the resource URI variables defined in table 5.2.8.2-1. + +**Table 5.2.8.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 5.2.8.3 Resource Standard Methods + +#### 5.2.8.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.8.3.1-1. + +**Table 5.2.8.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| bdt-ref-ids | array(BdtReferenceId) | O | 1..N | If included, this IE shall contain a list of the BDT reference identifiers.
Each member of the array is an individual BDT reference identifier. | +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.2.8.3.1-2 and the response data structures and response codes specified in table 5.2.8.3.1-3. + +**Table 5.2.8.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.8.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------| +| array(BdtData) | M | 0..N | 200 OK | Upon success, a response body containing the BDT data shall be returned.
Each member of the array is an individual BDT data. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.9 Resource: IndividualBdtData + +### 5.2.9.1 Description + +The resource represents individual background data transfer data stored in the UDR for a given "bdtReferenceId". + +### 5.2.9.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/bdt-data/{bdtReferenceId} + +This resource shall support the resource URI variables defined in table 5.2.9.2-1. + +**Table 5.2.9.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| bdtReferenceId | BdtReferenceId | Represents the transfer policy of background data transfer for provided ASP. Data type BdtReferenceId is defined in 3GPP TS 29.122 [9]. | + +### 5.2.9.3 Resource Standard Methods + +#### 5.2.9.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.9.3.1-1. + +**Table 5.2.9.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.2.9.3.1-2 and the response data structures and response codes specified in table 5.2.9.3.1-3. + +**Table 5.2.9.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.2.9.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------| +| BdtData | M | 1 | 200 OK | Upon success, a response body containing the BDT data shall be returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 5.2.9.3.2 PUT + +This method shall support the URI query parameters specified in table 5.2.9.3.2-1. + +**Table 5.2.9.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.2.9.3.2-2 and the response data structures and response codes specified in table 5.2.9.3.2-3. + +**Table 5.2.9.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------------------------------------------|--| +| BdtData | M | 1 | Create the BDT data for a given bdtReferenceId. | | + +**Table 5.2.9.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------| +| BdtData | M | 1 | 201 Created | Successful case.
The resource has been successfully created. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The resource is not allowed to be updated.
(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 [4] also apply. | | | | | +| NOTE 2: The "cause" attribute within the "ProblemDetails" data structure may be set to "MODIFICATION_NOT_ALLOWED" as defined in table 5.2.7.2-1 of 3GPP TS 29.500 [4]. | | | | | + +**Table 5.2.9.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}/nudr-dr//policy-data/bdt-data/{bdtReferenceId} | + +### 5.2.9.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.2.9.3.3-1. + +**Table 5.2.9.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.2.9.3.3-2 and the response data structures and response codes specified in table 5.2.9.3.3-3. + +**Table 5.2.9.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.9.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 resource has been successfully deleted. | +| NOTE: 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. | | | | | + +## 5.2.9.3.4 PATCH + +This method shall support the URI query parameters specified in table 5.2.9.3.4-1. + +**Table 5.2.9.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 5.2.9.3.4-2 and the response data structures and response codes specified in table 5.2.9.3.4-3. + +**Table 5.2.9.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|-------------------------------------------------| +| BdtDataPatch | M | 1 | Modify the BDT data for a given bdtReferenceId. | + +**Table 5.2.9.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------| +| BdtData | M | 1 | 200 OK | The resource has been successfully updated and a response body containing BDT data shall be returned. | +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.10 Resource: PolicyDataSubscriptions + +### 5.2.10.1 Description + +This resource is used to represent subscriptions to notification of policy data modification. + +## 5.2.10.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/subs-to-notify + +This resource shall support the resource URI variables defined in table 5.2.10.2-1. + +**Table 5.2.10.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +## 5.2.10.3 Resource Standard Methods + +### 5.2.10.3.1 POST + +This method shall support the URI query parameters specified in table 5.2.10.3.1-1. + +**Table 5.2.10.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.2.10.3.1-2 and the response data structures and response codes specified in table 5.2.10.3.1-3. + +**Table 5.2.10.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|--------------------------------------------------------------------------| +| PolicyDataSubscription | M | 1 | Identifies the subscription to notification of policy data modification. | + +**Table 5.2.10.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PolicyDataSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of each Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created 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 [4] also apply. | | | | | + +**Table 5.2.10.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}/nudr-dr//policy-data/subs-to-notify/{subId} | + +### 5.2.10.3.2 GET + +This method shall support the URI query parameters specified in table 5.2.10.3.2-1. + +**Table 5.2.10.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------------------------------------------------------------------------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mon-resources | array(string) | C | 1..N | Indicate the resources for which it is requested to return the existing subscriptions to notifications on data changes. It contains the of a monitored resource.
When present, the UDR shall return the IndividualPolicyDataSubscription resource(s) for which one or more of the indicated resources in the "mon-resources" query parameter matches with the of one or more entries of the "monitoredResourceUris" property of the resource (i.e. within the resource representation in the PolicyDataSubscription data structure). | +| ue-id | VarUeld | C | 0..1 | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeld is defined in 3GPP TS 29.571 [7]. When present, the UDR shall return the IndividualPolicyDataSubscription resource(s) for the indicated UE. | +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer, as per clause 6.6 of 3GPP TS 29.500 [4]. | +| NOTE: Either the "mon-resources" or "ue-id" query parameters shall be present in the request. | | | | | + +This method shall support the request data structures specified in table 5.2.10.3.2-2 and the response data structures and response codes specified in table 5.2.10.3.2-3. + +**Table 5.2.10.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.10.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------| +| array(PolicyDataSubscription) | M | 0..N | 200 OK | Upon success, a response body containing the the requested Individual Policy Data Subscription(s) shall be returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.11 Resource: IndividualPolicyDataSubscription + +### 5.2.11.1 Description + +This resource is used to represent an individual subscription to notification of policy data modification. + +### 5.2.11.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/subs-to-notify/{subsId} + +This resource shall support the resource URI variables defined in table 5.2.11.2-1. + +**Table 5.2.11.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| subsId | string | The subsId identifies an individual policy data subscription to notifications. The value is allocated by the UDR during creation of the PolicyDataSubscriptions resource. | + +## 5.2.11.3 Resource Standard Methods + +### 5.2.11.3.1 PUT + +This method shall support the URI query parameters specified in table 5.2.11.3.1-1. + +**Table 5.2.11.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.2.11.3.1-2 and the response data structures and response codes specified in table 5.2.11.3.1-3. + +**Table 5.2.11.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-----------------------------------------------------------------------| +| PolicyDataSubscription | M | 1 | Updates the subscription to notification of policy data modification. | + +**Table 5.2.11.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| PolicyDataSubscription | M | 1 | 200 OK | The individual subscription resource was updated successfully. | +| n/a | | | 204 No Content | The individual subscription resource was updated successfully and no additional content is to be sent in the response message. | +| NOTE: 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. | | | | | + +### 5.2.11.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.2.11.3.2-1. + +**Table 5.2.11.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.2.11.3.2-2 and the response data structures and response codes specified in table 5.2.11.3.2-3. + +**Table 5.2.11.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 5.2.11.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 | Upon success, an empty response body shall be returned. | +| NOTE: 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. | | | | | + +### 5.2.11.3.3 GET + +This method shall support the URI query parameters specified in table 5.2.11.3.3-1. + +**Table 5.2.11.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 5.2.11.3.3-2 and the response data structures and response codes specified in table 5.2.11.3.3-3. + +**Table 5.2.11.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.11.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------| +| PolicyDataSubscription | M | 1 | 200 OK | Upon success, a response body containing the resource representation of the requested Individual Policy Data Subscription. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.12 Resource: OperatorSpecificData + +### 5.2.12.1 Description + +This resource represents the UE's operator specific data. + +NOTE: This resource can be used for operator specific data that is related to any policy data (e.g., AM policy data). + +This resource is modelled with the Document resource archetype (see clause C.1 of 3GPP TS 29.501 [5]). + +### 5.2.12.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/ues/{ueId}/operator-specific-data + +This resource shall support the resource URI variables defined in table 5.2.12.2-1. + +**Table 5.2.12.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| ueId | VarUeld | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeld is defined in 3GPP TS 29.571 [7]. | + +## 5.2.12.3 Resource Standard Methods + +### 5.2.12.3.1 GET + +This method is used to retrieve operator specific data from the UDR. + +This method shall support the URI query parameters specified in table 5.2.12.3.1-1. + +**Table 5.2.12.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supp-feat | SupportedFeatures | O | 0..1 | Identifies the features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.2.12.3.1-2 and the response data structures and response codes specified in table 5.2.12.3.1-3. + +**Table 5.2.12.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.12.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| map(OperatorSpecificDataContainer) | M | 0..N | 200 OK | Upon success, a response body containing a map shall be returned. The key of the map is an operator specific data element name and the value is the operator specific data of such data element, for the current UE (identified by the {ueId} variable in the resource path).
If the resource does not contain any keys, the response consists of an empty JSON object (empty map). | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 5.2.12.3.2 PATCH + +This method is used to modify operator specific data in the UDR. + +This method shall support the URI query parameters specified in table 5.2.12.3.2-1. + +**Table 5.2.12.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.2.12.3.2-2 and the response data structures and response codes specified in table 5.2.12.3.2-3. + +**Table 5.2.12.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-------------------------------------------------------| +| array(PatchItem) | M | 1..N | Contains the delta data to the operator specific data | + +**Table 5.2.12.3.2-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 successful modification there is no body in the response message.(NOTE 2) | +| PatchResult | M | 1 | 200 OK | Upon success, the execution report is returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The resource is not allowed to be updated. (NOTE 3) | + +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] also apply. + +NOTE 2: If all the modification instructions in the PATCH request have been implemented, the UDR shall respond with 204 No Content response; if some of the modification instructions in the PATCH request have been discarded, and the NF service consumer supported the "PatchReport" feature, the UDR shall respond with PatchResult. + +NOTE 3: The "cause" attribute within the "ProblemDetails" data structure may be set to "MODIFICATION\_NOT\_ALLOWED" as defined in table 5.2.7.2-1 of 3GPP TS 29.500 [4]. + +### 5.2.12.3.3 PUT + +This method is used to create or modify operator specific data in the UDR. + +This method shall support the URI query parameters specified in table 5.2.12.3.3-1. + +**Table 5.2.12.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 5.2.12.3.3-2 and the response data structures and response codes specified in table 5.2.12.3.3-3. + +**Table 5.2.12.3.3-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| map(OperatorSpecificData Container) | M | 1..N | A map containing the new representation of the operator specific data. The key of the map is operator specific data element name and the value is the operator specific data of the UE. | + +**Table 5.2.12.3.3-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| map(OperatorSpecificDataContainer) | M | 1 | 200 OK | Upon successful modification a response body containing a map shall be returned. The key of the map is operator specific data element name and the value is the operator specific data of the UE. | +| map(OperatorSpecificDataContainer) | M | 1 | 201 Created | If the "OSDResource_Create_Delete" feature is supported and the resource has been successfully created, a response body is returned. The key of the map is operator specific data element name and the value is the operator specific data of the UE. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The resource is not allowed to be updated. (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 [4] also apply. + +NOTE 2: The "cause" attribute within the "ProblemDetails" data structure may be set to "MODIFICATION\_NOT\_ALLOWED" as defined in table 5.2.7.2-1 of 3GPP TS 29.500 [4]. + +**Table 5.2.12.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}/nudr-dr//policy-data/ues/{ueId}/operator-specific-data. | + +### 5.2.12.3.4 DELETE + +This method shall support the URI query parameters specified in table 5.2.12.3.4-1. + +**Table 5.2.12.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 5.2.12.3.4-2 and the response data structures and response codes specified in table 5.2.12.3.4-3. + +**Table 5.2.12.3.4-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.12.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, applicable when the "OSDResource_Create_Delete" feature is supported.
The resource has been successfully deleted. | +| NOTE: 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. | | | | | + +## 5.2.13 Resource: PlmnUePolicySet + +### 5.2.13.1 Description + +The resource represents the UE policy set for a given "plmnId" representing an H-PLMN stored in the UDR of a V-PLMN. + +### 5.2.13.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/plmns/{plmnId}/ue-policy-set + +This resource shall support the resource URI variables defined in table 5.2.13.2-1. + +**Table 5.2.13.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| plmnId | string | Concatenating a Mcc and Mnc as defined in 3GPP TS 29.505 [15]. | + +## 5.2.13.3 Resource Standard Methods + +### 5.2.13.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.13.3.1-1. + +**Table 5.2.13.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.2.13.3.1-2 and the response data structures and response codes specified in table 5.2.13.3.1-3. + +**Table 5.2.13.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.13.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------| +| UePolicySet | M | 1 | 200 OK | Upon success, a response body containing the UE policies shall be returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.14 Resource: PolicyDataForIndividualUe + +### 5.2.14.1 Description + +The resource represents all UE related policy data sets in the UDR for a given "ueId". + +### 5.2.14.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/ues/{ueId} + +This resource shall support the resource URI variables defined in table 5.2.14.2-1. + +**Table 5.2.14.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1 | +| ueId | VarUeId | Represents the Subscription Identifier SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7]. | + +### 5.2.14.3 Resource Standard Methods + +#### 5.2.14.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.14.3.1-1. + +**Table 5.2.14.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------------------------------------------------------------------------------------------------------------------------|--------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer, as per clause 6.6 of 3GPP TS 29.500 [4]. | +| data-subset-names | array(PolicyDataSubsets) | O | 2..N | The policy data subsets (e.g. AM policies, SM policies, etc.) requested by the NF service consumer.
If this query parameter is not provided by the NF service consumer, this means that all the available policy data subsets shall be returned. | +| NOTE: When two or more policy data subsets shall be retrieved, it is recommended to use a single GET request with query parameters. | | | | | + +This method shall support the request data structures specified in table 5.2.14.3.1-2 and the response data structures and response codes specified in table 5.2.14.3.1-3. + +**Table 5.2.14.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.14.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------| +| PolicyDataForIndividual UE | M | 1 | 200 OK | Upon success, a response body containing the policy data subsets requested by the NF service consumer or all the policy data subsets shall be returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.15 Resource: SlicePolicyControlData + +### 5.2.15.1 Description + +The resource represents the network slice specific policy control subscription data stored in the UDR for a given S-NSSAI. + +### 5.2.15.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/slice-control-data/{snssai} + +This resource shall support the resource URI variables defined in table 5.2.15.2-1. + +**Table 5.2.15.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| snssai | Snssai | The S-NSSAI value used in the last segment of the resource URI is encoded as a string as defined in 3GPP TS 29.571 [7], clause 5.4.4.2. | + +### 5.2.15.3 Resource Standard Methods + +#### 5.2.15.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.15.3.1-1. + +**Table 5.2.15.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.2.15.3.1-2 and the response data structures and response codes specified in table 5.2.15.3.1-3. + +**Table 5.2.15.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.15.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------| +| SlicePolicyData | M | 1 | 200 OK | Upon success, a response body containing network slice specific policy control data shall be returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.15.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.2.15.3.2-1. + +**Table 5.2.15.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 5.2.15.3.2-2 and the response data structures and response codes specified in table 5.2.15.3.2-3. + +**Table 5.2.15.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------------------------------| +| SlicePolicyDataPatch | M | 1 | Modify a network slice specific policy control data resource for a given S-NSSAI. | + +**Table 5.2.15.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| SlicePolicyData | M | 1 | 200 OK | The resource has been successfully updated and a response body containing network slice specific policy control data shall be returned. | +| n/a | | | 204 No Content | The resource has been successfully updated and no additional content is to be sent in the response message. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.16 Resource: MBSSessionPolicyControlData + +### 5.2.16.1 Description + +The resource represents the MBS Session Policy Control Data for an MBS Session. + +### 5.2.16.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/mbs-session-pol-data/{polSessionId} + +This resource shall support the resource URI variables defined in table 5.2.16.2-1. + +**Table 5.2.16.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|------------------|-------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| polSessionId | MbsSessPolDataId | Represents the identifier of the MBS Session Policy Control Data. | + +### 5.2.16.3 Resource Standard Methods + +#### 5.2.16.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.16.3.1-1. + +**Table 5.2.16.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +**Table 5.2.16.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.16.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------| +| MbsSessPolCtrlData | M | 1 | 200 OK | Successful case. The requested MBS Session Policy Control Data is successfully returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.2.17 Resource: PdtqData + +### 5.2.17.1 Description + +The resource represents planned data transfer with QoS requirements data stored in the UDR. + +### 5.2.17.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/pdtq-data + +This resource shall support the resource URI variables defined in table 5.2.17.2-1. + +**Table 5.2.17.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +## 5.2.17.3 Resource Standard Methods + +### 5.2.17.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.8.3.1-1. + +**Table 5.2.17.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------| +| pdtq-ref-ids | array(PdtqReferenceId) | O | 1..N | If included, this IE shall contain a list of the PDTQ reference identifiers.
Each member of the array is an individual PDTQ reference identifier. | +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.2.17.3.1-2 and the response data structures and response codes specified in table 5.2.17.3.1-3. + +**Table 5.2.17.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.17.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------| +| array(PdtqData) | M | 0..N | 200 OK | Upon success, a response body containing the PDTQ data shall be returned.
Each member of the array is an individual PDTQ data. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +## 5.2.18 Resource: IndividualPdtqData + +### 5.2.18.1 Description + +The resource represents individual planned data transfer with QoS requirements data stored in the UDR for a given "pdtqReferenceId". + +### 5.2.18.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/pdtq-data/{pdtqReferenceId} + +This resource shall support the resource URI variables defined in table 5.2.18.2-1. + +**Table 5.2.18.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| pdtqReferenceId | PdtqReferenceId | Represents the PDTQ policy of planned data transfer with QoS requirements for provided ASP. Data type PdtqReferenceId is defined in 3GPP TS 29.543 [25]. | + +## 5.2.18.3 Resource Standard Methods + +### 5.2.18.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.18.3.1-1. + +**Table 5.2.18.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.2.18.3.1-2 and the response data structures and response codes specified in table 5.2.9.3.1-3. + +**Table 5.2.18.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.18.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|---------------------------------------------------------------------------| +| PdtqData | M | 1 | 200 OK | Upon success, a response body containing the PDTQ data shall be returned. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +### 5.2.18.3.2 PUT + +This method shall support the URI query parameters specified in table 5.2.18.3.2-1. + +**Table 5.2.18.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.2.18.3.2-2 and the response data structures and response codes specified in table 5.2.18.3.2-3. + +**Table 5.2.18.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|---------------------------------------------------| +| PdtqData | M | 1 | Create the PDTQ data for a given pdtqReferenceId. | + +**Table 5.2.18.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|----------------|-----------------------------------------------------------------| +| PdtqData | M | 1 | 201 Created | Successful case.
The resource has been successfully created. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The resource is not allowed to be updated.
(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 [4] also apply. +NOTE 2: The "cause" attribute within the "ProblemDetails" data structure may be set to "MODIFICATION\_NOT\_ALLOWED" as defined in table 5.2.7.2-1 of 3GPP TS 29.500 [4]. + +**Table 5.2.18.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}/nudr-dr//policy-data/pdtq-data/{pdtqReferenceId} | + +### 5.2.18.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.2.18.3.3-1. + +**Table 5.2.18.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.2.18.3.3-2 and the response data structures and response codes specified in table 5.2.18.3.3-3. + +**Table 5.2.18.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.18.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 resource has been successfully deleted. | + +NOTE: 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. + +### 5.2.18.3.4 PATCH + +This method shall support the URI query parameters specified in table 5.2.18.3.4-1. + +**Table 5.2.18.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 5.2.18.3.4-2 and the response data structures and response codes specified in table 5.2.18.3.4-3. + +**Table 5.2.18.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|---------------------------------------------------| +| PdtqDataPatch | M | 1 | Modify the PDTQ data for a given pdtqReferenceId. | + +**Table 5.2.18.3.4-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------| +| PdtqData | M | 1 | 200 OK | The resource has been successfully updated and a response body containing PDTQ data shall be returned. | +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. | + +NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +## 5.2.19 Resource: GroupPolicyControlData + +### 5.2.19.1 Description + +The resource represents the group specific policy control subscription data stored in the UDR for a 5G VN group. + +### 5.2.19.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//policy-data/group-control-data/{intGroupId} + +This resource shall support the resource URI variables defined in table 5.2.19.2-1. + +**Table 5.2.19.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|----------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| intGroupId | GroupId | Identifies a 5G VN group as defined in clause 5.3.2 of 3GPP TS 29.571 [7]. | + +### 5.2.19.3 Resource Standard Methods + +#### 5.2.19.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.19.3.1-1. + +**Table 5.2.19.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 5.2.19.3.1-2 and the response data structures and response codes specified in table 5.2.19.3.1-3. + +**Table 5.2.19.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.19.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------| +| GroupPolicyData | M | 1 | 200 OK | Upon success, a response body containing group specific policy control data for a 5G VN group shall be returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 5.2.19.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.2.19.3.2-1. + +**Table 5.2.19.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| | | | | | + +This method shall support the request data structures specified in table 5.2.19.3.2-2 and the response data structures and response codes specified in table 5.2.19.3.2-3. + +**Table 5.2.19.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-------------------------------------------------------------------------| +| GroupPolicyDataPatch | M | 1 | Modify a group specific policy control data resource for a 5G VN group. | + +**Table 5.2.19.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| GroupPolicyData | M | 1 | 200 OK | The resource has been successfully modified and a response body containing the updated group specific policy control data for the targeted 5G VN group shall be returned. | +| n/a | | | 204 No Content | The resource has been successfully modified and no additional content is to be sent in the response body. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 5.3 Notifications + +### 5.3.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +This clause describes the resources to provide notification to NF service consumers which have subscribed to be notified when policy data is changed. + +**Table 5.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|---------------------------------|-------------------|---------------------------------|------------------------------------------| +| Policy Data Change Notification | {notificationUri} | POST | Used for policy data change notification | + +## 5.3.2 Policy Data Change Notification + +The POST method shall be used for policy data change notification and the URI shall be provided during the subscription procedure. + +Callback URI: {notificationUri} + +This method shall support the URI query parameters specified in table 5.3.2-1. + +**Table 5.3.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 5.3.2-2 and the response data structures and response codes specified in table 5.3.2-3. + +**Table 5.3.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-------------------------------------|---|-------------|--------------------------------------| +| array(PolicyDataChangeNotification) | M | 1..N | Notification of policy data changes. | + +**Table 5.3.2-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------| +| n/a | | | 204 No Content | The reception of the notification is acknowledged. | +| 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. | | | | | + +## 5.4 Data Model + +### 5.4.1 General + +This clause specifies the application data model supported by the API. + +Table 5.4.1-1 specifies the data types defined for the Nudr\_DataRepository for Policy Data service based interface protocol. + +**Table 5.4.1-1: Nudr\_DataRepository specific Data Types for Policy Data** + +| Data type | Section defined | Description | Applicability | +|--------------------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| +| AmPolicyData | 5.4.2.2 | Contains the AM policy data for a given subscriber. | | +| BdtData | 5.4.2.9 | Contains the background data transfer data. | | +| BdtDataPatch | 5.4.2.27 | Contains the modifiable background data transfer data | | +| BdtPolicyStatus | 5.4.3.5 | Contains the validation status for a negotiated BDT policy. | | +| DnnRouteSelectionDescriptor | 5.4.2.20 | Contains the route selector parameters per DNN. | | +| UpdatedItem | 5.4.2.26 | An updated resource fragment, represented by its location in a resource and its data type. | ConditionalSubscriptionwithPartialNotification | +| LimitIdToMonitoringKey | 5.4.2.16 | Contains the limit identifier and the corresponding monitoring key for a given S-NSSAI and DNN. | | +| MbsSessPolCtrlData | 5.4.2.31 | Contains MBS Session Policy Control Data. | | +| MbsSessPolDataId | 5.4.2.32 | Represents the identifier used to access the MBS Session Policy Control Data. | | +| NotificationItem | 5.4.2.25 | Contains the list of resource fragments included in the notification triggered by the modification of a given resource fragment. | ConditionalSubscriptionwithPartialNotification | +| OsId | 5.4.3.2 | Operating System supported by the UE. | | +| PdtqData | 5.4.2.33 | Contains the planned data transfer with QoS requirements data. | | +| PdtqDataPatch | 5.4.2.34 | Contains the modifiable planned data transfer with QoS requirements data | | +| Periodicity | 5.4.3.4 | Indicates a type of time period. | | +| PlmnRouteSelectionDescriptor | 5.4.2.18 | Contains the route selectors for a serving PLMN. | | +| PolicyDataChangeNotification | 5.4.2.11 | Contains changed policy data for which notification was requested. | | +| PolicyDataForIndividualUe | 5.4.2.28 | Contains policy data sets for a given subscriber. | | +| PolicyDataSubscription | 5.4.2.10 | Identifies a subscription to policy data change notification. | | +| PolicyDataSubset | 5.4.3.6 | Indicates a policy data subset (e.g. AM policy data, SM policy data). | | +| SlicePolicyData | 5.4.2.29 | Contains network slice specific policy control information for an S-NSSAI. | | +| SlicePolicyDataPatch | 5.4.2.30 | Contains modifiable network slice specific policy control information for an S-NSSAI. | | +| SmPolicyData | 5.4.2.5 | Contains SM policy data for a subscriber. | | +| SmPolicyDataPatch | 5.4.2.21 | Contains modifiable SM policy data for a subscriber. | SessionManagementPolicyDataPatch | +| SmPolicyDnnData | 5.4.2.15 | Contains SM policy data for a DNN and S-NSSAI. | | +| SmPolicyDnnDataPatch | 5.4.2.23 | Contains modifiable SM policy data for a DNN and S-NSSAI. | SessionManagementPolicyDataPatch | +| SmPolicySnssaiData | 5.4.2.14 | Contains SM policy data for an S-NSSAI. | | +| SmPolicySnssaiDataPatch | 5.4.2.22 | Contains modifiable SM policy data for an S-NSSAI. | SessionManagementPolicyDataPatch | +| SnssaiRouteSelectionDescriptor | 5.4.2.19 | Contains the route selector parameters per SNSSAI. | | +| SponsorConnectivityData | 5.4.2.8 | Contains the sponsored data connectivity related information for a sponsor identifier. | | +| ResourceItem | 5.4.2.24 | Represents list of fragments of a resource, i.e. a list of subsets of resource data monitored for notification of data changes. | ConditionalSubscriptionwithPartialNotification | +| ItemPath | 5.4.3.2 | Represents a fragment of a resource, i.e. a subset of resource data. | ConditionalSubscriptionwithPartialNotification | +| TimePeriod | 5.4.2.12 | Contains the periodicity for the defined usage | | + +| | | | | +|-------------------|----------|-----------------------------------------------------------------------------------------|--| +| | | monitoring data limits. | | +| UePolicySetPatch | 5.4.2.17 | Contains the UE policy data that can be modified by the PCF. | | +| UePolicySection | 5.4.2.3 | Contains the UE policy section. | | +| UePolicySet | 5.4.2.4 | Contains the UE policy set for a given subscriber. | | +| UsageMonLevel | 5.4.3.3 | Indicates the level of the usage monitoring instance (PDU Session level or per Service) | | +| UsageMonData | 5.4.2.7 | Contains remain allowed usage data for a subscriber. | | +| UsageMonDataLimit | 5.4.2.6 | Contains usage monitoring control data for a subscriber. | | +| UsageMonDataScope | 5.4.2.13 | Contains SNSSAI and DNN combinations to which the UsageMonData instance belongs to. | | + +Table 5.4.1-2 specifies data types re-used by the Nudr\_DataRepository for Policy Data 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 Nudr\_DataRepository for Policy Data service based interface. + +**Table 5.4.1-2: Nudr\_DataRepository re-used Data Types for Policy Data** + +| Data type | Reference | Comments | Applicability | +|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| 5Qi | 3GPP TS 29.571 [7] | Indicates the 5G QoS Identifier. | | +| ApplicationId | 3GPP TS 29.571 [7] | Contains the application identifier. | | +| ArpPriorityLevel | 3GPP TS 29.571 [7] | Indicates the allocation and retention priority level. | | +| BdtReferenceId | 3GPP TS 29.122 [9] | Indicates the background data transfer reference ID for the transfer policy. | | +| BitRate | 3GPP TS 29.571 [7] | 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". | | +| Bytes | 3GPP TS 29.571 [7] | String with format "byte" as defined in OpenAPI Specification [3], i.e., base64-encoded characters. | | +| ChargingInformation | 3GPP TS 29.512 [12] | The address(es), and if available, the instance ID and the set ID of the Charging Function. | | +| DateTime | 3GPP TS 29.571 [7] | String with format "date-time" as defined in OpenAPI Specification [3]. | | +| Dnn | 3GPP TS 29.571 [7] | Data Network Name. (NOTE) | | +| MbsSessionId | 3GPP TS 29.571 [7] | Contains the MBS Session Identifier. | | +| Metadata | 3GPP TS 29.571 [7] | Contains opaque information for the service functions in the N6-LAN that is provided by AF and transparently sent to UPF. | SFC | +| NetworkAreaInfo | 3GPP TS 29.554 [13] | Represents a network area information. | | +| OperatorSpecificDataContainer | 3GPP TS 29.505 [15] | Container for operator specific data | | +| PatchResult | 3GPP TS 29.571 [7] | | | +| PatchItem | 3GPP TS 29.571 [7] | Data structure used for JSON patch. | | +| PdtqPolicy | 3GPP TS 29.543 [25] | Represents a PDTQ policy. | | +| PdtqReferenceId | 3GPP TS 29.543 [25] | Indicates the planned data transfer with QoS requirements reference ID for the PDTQ policy. | | +| PduSessionType | 3GPP TS 29.571 [7] | PDU Session Type. | | +| Pei | 3GPP TS 29.571 [7] | Personal Equipment Identifier. | | +| PlmnId | 3GPP TS 29.571 [7] | PLMN Identity. | | +| PresenceInfo | 3GPP TS 29.571 [7] | Presence Reporting Area Information. | | +| ProblemDetails | 3GPP TS 29.571 [7] | Used in error responses to provide more detailed information about an error. | | +| SliceMbr | 3GPP TS 29.571 [7] | Contains the slice Maximum Bit Rate including UL and DL. | NSAC | +| Snssai | 3GPP TS 29.571 [7] | Identifies the S-NSSAI. | | +| SscMode | 3GPP TS 29.571 [7] | SSC mode. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features | | +| TnapId | 3GPP TS 29.571 [7] | Trusted Network Access Point identifier. | AfGuideTNAPs | +| TrafficDescriptor | 3GPP TS 29.122 [9] | Identifies the traffic descriptor of the background data. | | +| TransferPolicy | 3GPP TS 29.554 [13] | Represents a transfer policy. | | +| Uinteger | 3GPP TS 29.571 [7] | Unsigned Integer, i.e. only value 0 and integers greater than 0 are allowed. | | +| Uri | 3GPP TS 29.571 [7] | String providing an URI. | | +| UsageThreshold | 3GPP TS 29.122 [9] | Usage Thresholds (a data volume expected to be transferred per UE and/or time duration in seconds). | | +| VarUeId | 3GPP TS 29.571 [7] | String represents the SUPI or GPSI. | | +| NOTE: | The UDR uses the DNN as received from the NF service consumer 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. | | | + +## 5.4.2 Structured data types + +### 5.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 5.4.2.2 Type AmPolicyData + +**Table 5.4.2.2-1: Definition of type AmPolicyData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| pralInfos | map(PresenceInfo) | O | 1..N | Presence reporting area information. Each PresenceInfo element shall include the Presence Reporting Area Identifier within the "prald" attribute and, for a UE-dedicated presence reporting area, shall also include the list of elements composing the presence reporting area.
A "prald" may indicate a Presence Reporting Area Set.
The "prald" attribute within the PresenceInfo data type shall also be the key of the map.
The attribute "presenceState" shall not be present. | | +| subscCats | array(string) | O | 1..N | List of categories associated with the subscriber | | +| chfInfo | ChargingInformation | O | 0..1 | The address(es) and, if available, the CHF instance ID and the CHF set ID of the Charging Function.
(NOTE) | CHFInformation | +| subscSpendingLimits | boolean | O | 0..1 | Indicates whether the PCF must enforce Access and Mobility management related policies based on subscriber spending limits.
True: Spending limit control is enabled;
False: Spending limit control is not enabled.
The absence of this attribute means that spending limit control is not provisioned for the UE. | SLAMUP | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.
This parameter shall be provided if the NF service consumer has provided a list of supported features in its request. | | + +NOTE: When the feature "CHFInformation" is supported, the "secondaryChfAddress" may be omitted. + +### 5.4.2.3 Type UePolicySection + +**Table 5.4.2.3-1: Definition of type UePolicySection** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------| +| uePolicySectionInfo | Bytes | M | 1 | Contains the UE Policy Section Information for the given UPSI as specified in clause D.6.2 of 3GPP TS 24.501 [11]. | +| upsi | string | M | 1 | Identifier for UE Policy Section. The format is represented in 3GPP TS 24.501 [11] clause D.6.2. | + +## 5.4.2.4 Type UePolicySet + +**Table 5.4.2.4-1: Definition of type UePolicySet** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-----------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| pralnfos | map(PresenceInfo) | O | 1..N | Presence reporting area information. Each PresenceInfo element shall include the Presence Reporting Area Identifier within the "prald" attribute and, for a UE-dedicated presence reporting area, shall also include the list of elements composing the presence reporting area.
A "prald" may indicate a Presence Reporting Area Set.
The "prald" attribute within the PresenceInfo data type shall also be the key of the map.

The attribute "presenceState" shall not be present. | | +| subscCats | array(string) | O | 1..N | List of categories associated with the subscriber | | +| uePolicySections | map(UePolicySection) | O | 1..N | Contains the UE Policy Sections. The UPSI (UE Policy Section Identifier) is used as the key in the map. | | +| upsis | array(string) | O | 1..N | List of identifiers for the "uePolicySections". The format of the UPSI is represented in 3GPP TS 24.501 [11] clause D.6.2 | | +| allowedRouteSelDescs | map(PlmnRouteSelectionDescriptor) | O | 1..N | Contains allowed route selection descriptors per serving PLMN for a UE. The serving PLMN identifier is the key of the map. | | +| andspInd | boolean | O | 0..1 | Indication of UE supporting ANDSP.
True: The UE supports ANDSP;
False: The UE does not support ANDSP. | | +| epsUrspInd | boolean | O | 0..1 | Indication of UE supporting URSP provisioning in EPS.
True: The UE supports URSP provisioning in EPS;
False: The UE does not support URSP provisioning in EPS. | EpsUrsp | +| vpsUrspInd | boolean | O | 0..1 | Indication of UE supporting VPLMN-specific URSP.
True: The UE supports VPLMN-specific URSP;
False: The UE does not support VPLMN-specific URSP. | VPLMNSpecificURSP | +| urspEnfInd | boolean | O | 0..1 | Indication of UE supporting URSP enforcement report.
True: The UE supports URSP enforcement report;
False: The UE does not support URSP enforcement report. | URSPEnforcement | +| pei | Pei | O | 0..1 | Personal Equipment Identifier. | | +| oslds | array(OsId) | O | 1..N | Identification of the UE Operating System(s). | | +| chfInfo | ChargingInformation | O | 0..1 | The address(es) and, if available, the CHF instance ID and the CHF set ID of the Charging Function.
(NOTE 2) | CHFInformation | +| subscSpendingLimits | boolean | O | 0..1 | Indicates whether the PCF must enforce UE policies based on subscriber spending limits.
True: Spending limit control is enabled;
False: Spending limit control is not enabled.
The absence of this attribute means that spending limit control is not provisioned for the UE. | SLAMUP | +| tracingReq | array(string) | O | 1..N | Tracing requirements as defined in TS 32.421 [26] | EnhancedUePolicy | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.6.
This attribute shall be provided in the PUT request and in the response of successful resource creation, and in the HTTP GET | | + +| | | | | | | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | response if the "supp-feat" attribute query parameter is included in the HTTP GET request.
(NOTE 1). | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | +| NOTE 1: 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 UDR. | | | | | | +| NOTE 2: When the feature "CHFInformation" is supported, the "secondaryChfAddress" may be omitted. | | | | | | + +#### 5.4.2.5 Type SmPolicyData + +**Table 5.4.2.5-1: Definition of type SmPolicyData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------------------------------------------------------------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| smPolicySnssaiData | map(SmPolicySnssaiData) | M | 1..N | Session Management Policy data per S-NSSAI for all the SNSSAIs of the subscriber.
The key of the map is the S-NSSAI.
(NOTE 2) | | +| umDataLimits | map(UsageMonDataLimit) | O | 1..N | Contains a list of usage monitoring profiles associated with the subscriber. The limit identifier is used as the key of the map. | | +| umData | map(UsageMonData) | O | 1..N | Contains the remaining allowed usage data associated with the subscriber.
The limit identifier is used as the key in the map. | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.
This parameter shall be supplied by the UDR in the response to the GET request when the GET request includes the "supp-feat" query parameter and the UDR supports feature negotiation for Session Management Policy Data. | | +| NOTE 1: In this Release of the specification the "limitId" corresponds to the Monitoring Key. | | | | | | +| NOTE 2: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[7], clause 5.4.4.2. | | | | | | + +## 5.4.2.6 Type UsageMonDataLimit + +**Table 5.4.2.6-1: Definition of type UsageMonDataLimit** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| limitId | string | M | 1 | Identifies the limit, i.e. the usage monitoring control instance | +| scopes | map(UsageMonDataScope) | O | 1..N | Identifies the SNSSAI and DNN combinations to which the usage monitoring data limit applies.
The S-NSSAI is the key of the map. (NOTE 2)
If the "scopes" attribute is omitted, the limit applies to every S-NSSAI and DNN. | +| umLevel | UsageMonLevel | O | 0..1 | Indicates the level of the usage monitoring instance (PDU Session level or per Service). | +| startDate | DateTime | C | 0..1 | Start date and time when the usage monitoring instance applies. It shall be provided when the resetPeriod attribute is provided. | +| endDate | DateTime | O | 0..1 | End date and time when the usage monitoring instance applies. | +| usageLimit | UsageThreshold | O | 0..1 | Maximum allowed traffic volume/time usage for a usage monitoring instance. If a resetPeriod is specified, this limit applies to every period separately and not for the entire time between the start and end dates. So for example, if the resetPeriod is daily, the usageLimit is applicable for each day until the end date is specified. | +| resetPeriod | TimePeriod | O | 0..1 | Time period to reset the remaining allowed usage for a periodic usage monitoring instance (postpaid subscriptions). This attribute along with the startDate determine the actual absolute time at which usage needs to be reset. | + +NOTE 1: In this Release of the specification the "limitId" attribute is the Monitoring Key, and the "scopes" attribute shall always be present including one distinct SNSSAI and DNN pair. + +NOTE 2: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[7], clause 5.4.4.2. + +## 5.4.2.7 Type UsageMonData + +**Table 5.4.2.7-1: Definition of type UsageMonData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| limitId | string | M | 1 | Identifies the limit as defined in the "limitId" attribute of the UsageMonDataLimit data type (see clause 5.4.2.6). | | +| scopes | map(UsageMonDataScope) | O | 1..N | Identifies the SNSSAI and DNN combinations to which the remaining usage monitoring data applies. The S-NSSAI is the key of the map. (NOTE 3) | | +| umLevel | UsageMonLevel | O | 0..1 | Indicates the level of the usage monitoring instance (PDU Session level or per Service). | | +| allowedUsage | UsageThreshold | O | 0..1 | Remaining allowed traffic volume usage and/or resource time usage. | | +| resetTime | DateTime | O | 0..1 | Time to reset the allowed usage back to the usageLimit of the corresponding UsageMonDataLimit. This is computed based on the corresponding startDate, resetPeriod and endDate of the corresponding UsageMonDataLimit. The allowedUsage is only applicable if the resetTime is in the future relative to the current time. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.6. This attribute shall be provided in the PUT request and in the response of successful resource creation, and in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE 2). | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource. This attribute may be provided in the response of successful resource creation. | | + +NOTE 1: In this Release of the specification the "limitId" attribute is the Monitoring Key, and the "scopes" attribute shall always be present including one distinct SNSSAI and DNN pair. + +NOTE 2: 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 UDR. + +NOTE 3: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571 [7], clause 5.4.4.2. + +## 5.4.2.8 Type SponsorConnectivityData + +**Table 5.4.2.8-1: Definition of type SponsorConnectivityData** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aspIds | array(string) | M | 1..N | Identifies a list of Application Service Provider Identifiers associated with the sponsor identity. | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features. This parameter shall be provided if the NF service consumer has provided a list of supported features in its request. | + +## 5.4.2.9 Type BdtData + +**Table 5.4.2.9-1: Definition of type BdtData** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aspld | string | M | 1 | This IE contains an identity of an application service provider. | +| transPolicy | TransferPolicy | M | 1 | This IE contains the transfer policy. | +| bdtRefId | BdtReferenceId | O | 0..1 | This IE indicates the background data transfer reference ID for the transfer policy. | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | This IE represents a network area information. | +| numOfUes | UInteger | O | 0..1 | This IE contains the number of UEs using the indicated transfer policy. It shall be present when available. | +| volPerUe | UsageThreshold | O | 0..1 | This IE contains a data volume expected to be transferred per UE for the indicated transfer policy. It shall be present when available. | +| dnn | Dnn | O | 0..1 | This IE identifies a DNN. | +| snssai | Snssai | O | 0..1 | This IE identifies a slice. | +| trafficDes | TrafficDescriptor | O | 0..1 | Contains the traffic descriptor of the background data. | +| bdtPStatus | BdtPolicyStatus | O | 0..1 | Contains the validation status for a negotiated BDT policy. It shall be included when available. Default value is "VALID" if omitted. | +| warnNotifEnabled | boolean | O | 0..1 | This IE indicates whether the BDT warning notification is enabled or disabled.
true: enabled;
false: disabled (default value). | +| notifUri | Uri | O | 0..1 | This IE contains an URI of the recipient of the BDT warning notification. | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.6.
This attribute shall be provided in the PUT request and in the response of successful resource creation, and in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE). | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | + +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 UDR. + +## 5.4.2.10 Type PolicyDataSubscription + +**Table 5.4.2.10-1: Definition of type PolicyDataSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------| +| notificationUri | Uri | M | 1 | URI provided by the NF service consumer indicating where to receive the subscribed notifications from the UDR. | | +| notifId | string | C | 0..1 | Notification Correlation ID assigned by the NF service consumer.
It shall be included when the "ConditionalSubscriptionWithPartialNotification" or the "ConditionalSubscriptionWithExcludeNotification" feature is supported. | ConditionalSubscriptionWithPartialNotification
ConditionalSubscriptionWithExcludeNotification | +| monitoredResourceUris | array(Uri) | M | 1..N | A set of URIs provided by the NF service consumer that identify the resources as defined in table 5.2.2-1 for which a modification triggers a notification.
(NOTE 1) | | +| monResItems | array(ResourceItem) | O | 1..N | A set of monitored resource fragments provided by the NF service consumer. When present, this IE indicates the trigger of the notification is conditioned to the data change occurs in one or more of the attributes contained in a resource fragment as defined by the ResourceItem data type, and that the triggered notification shall only include the resource fragment as defined by the ResourceItem data type.
(NOTE 2) | ConditionalSubscriptionWithPartialNotification | +| excludedResItems | array(ResourceItem) | O | 1..N | A set of resource fragments provided by the NF service consumer that are excluded from data change monitoring. When present, this IE indicates the trigger of the notification is conditioned to the data change occurs in any attribute contained in the resource(s) identified by "monitoredResourceUris", except when the changed data is in one or more of the attributes contained in a resource fragment as defined by the ResourceItem data type.
(NOTE 2) (NOTE 3) (NOTE 4) | ConditionalSubscriptionWithExcludeNotification | +| immRep | boolean | O | 0..1 | If provided by the NF service consumer and set to "true", it indicates to the UDR that existing entries that match this subscription shall be immediately reported within the "immReports" attribute in the response. The default value is false. | ImmediateReportPcc | +| immReports | array(PolicyDataChangeNotification) | C | 1..N | Contains entries stored in the UDR that match this subscription.
It shall be included in the POST response body of a subscription creation if the request included the "immRep" attribute set to true and the UDR needs to include an immediate report in the response.
It shall be included in the PUT response body of a subscription modification if the UDR needs to include an immediate report in the response and:
- if the modification request included the "immRep" attribute set to true and it was previously set to false or not provided;
- if the modification request added the monitoring of new resources within the "monitoredResourceUris" attribute and/or new monitored resource fragments within the "monResItems" attribute, and the "immRep" attribute was previously set to true; and/or
- if the modification request updated the set of excluded resources within the | ImmediateReportPcc | + +| | | | | | | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| | | | | "excludedResItems" attribute and the "immRep" attribute was previously set to true. | | +| expiry | DateTime | C | 0..1 | This IE shall be included in a subscription response if, based on operator policy and taking into account the expiry time included in the request, the UDR needs to include an expiry time.
This IE may be included in a subscription request. When present, this IE shall represent the time after which the subscription becomes invalid.
The absence of this attribute in the subscription response means the subscription to be valid without an expiry time. | | +| subsId | string | C | 0..1 | It represents the variable part of the IndividualPolicyDataSubscription resource URI, as specified in clause 5.2.11.2-1.
This attribute shall be present if the PolicyDataSubscription is sent in a GET response message to the PolicyDataSubscriptions collection resource.

This is a Read Only attribute and shall not be provided by the NF service consumer in any request. | PolSubscRetrieval | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of the optional features.
This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided by the UDR in the response of successful resource creation. | | +| NOTE 1: | Neither the resource URI of the IndividualPolicyDataSubscription resource nor the resource URI of the PolicyDataSubscriptions resource shall be included in the "monitoredResourceUris" attribute. | | | | | +| NOTE 2: | If both ConditionalSubscriptionwithPartialNotification and ConditionalSubscriptionWithExcludeNotification are supported, the fragments defined in "monResItems" attribute and in "excludedResItems" attribute shall refer to different resources defined in "monitoredResourceUris". | | | | | +| NOTE 3: | When "excludedResItems" attribute is included, and a change is detected in the monitored part of a resource (i.e., in those properties not included in the "excludedResItems" attribute), the triggered notification shall include the complete resource representation. | | | | | +| NOTE 4: | The "excludedResItems" attribute may only be used with the OperatorSpecificData resource. E.g. if the OperatorSpecificData resource contains a map with two elements, one with key "operatorSpecificData1" and the other one with key "operatorSpecificData2", to exclude the notification of changes in the "operatorSpecificData1" element the "excludedResItems" attribute will contain the value "/operatorSpecificData1" within the "items" array. | | | | | + +### 5.4.2.11 Type PolicyDataChangeNotification + +**Table 5.4.2.11-1: Definition of type PolicyDataChangeNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------------------|------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| amPolicyData | AmPolicyData | O | 0..1 | Access and Mobility Policy Data, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| uePolicySet | UePolicySet | O | 0..1 | UE Policy Set, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| plmnUePolicySet | UePolicySet | O | 0..1 | PLMN UE Policy Set, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| smPolicyData | SmPolicyData | O | 0..1 | Session Management Policy Data, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| usageMonData | UsageMonData | O | 0..1 | Usage Monitoring Data, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| SponsorConnectivityData

(NOTE 4) | SponsorConnectivityData | O | 0..1 | Sponsor data connectivity profile information, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| bdtdData | BdtData | O | 0..1 | Background Data Transfer Data, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| opSpecData | OperatorSpecificDataContainer | O | 0..1 | Operator Specific Data, if changed and notification was requested, or if it existed and immediate reporting was requested. It may only be used when the receiver of the notification is able to univocally identify the changed operator specific data. (NOTE 3) | | +| opSpecDataMap | map(OperatorSpecificDataContainer) | O | 1..N | Operator Specific Data resource data, if changed and notification was requested, or if it existed and immediate reporting was requested. The key of the map is operator specific data element name and the value is the operator specific data of the UE. | OpSpecDataMap Notification | +| ueId | VarUeId | C | 0..1 | Represents the UE subscription identifier SUPI or GPSI. It shall only be present when the "amPolicyData", "uePolicySet", "smPolicyData", "opSpecData" and/or "usageMonData" attribute is present. | | +| sponsorId | string | C | 0..1 | Represents the sponsor identity. It shall only be present when the "sponsorConnectivityData" attribute is present. | | +| bdtdRefId | BdtReferenceId | C | 0..1 | Represents the BDT reference identifier. It shall only be present when the "bdtdData" attribute is present. | | +| usageMonId | string | C | 0..1 | Represents the unique identifier of the individual SM Policy usage monitoring resource. It shall only be present when the "usageMonData" attribute is present. | | +| plmnId | PlmnId | C | 0..1 | Represents the PLMN identifier. It | | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------|--| +| | | | | shall only be present when the "plmnUePolicySet" attribute is present. | | +|--|--|--|--|------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------|-------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| +| delResources | array(Uri) | O | 1..N | The resources, as defined in table 5.2.2-1, if removed from UDR and notification on resource data change was requested. Not applicable for immediate reports. (NOTE 2) | ResourceRemovalNotificationPolicyData | +| notifId | string | C | 0..1 | Notification Correlation ID assigned by the NF service consumer. (NOTE 5) | ConditionalSubscriptionwithPartialNotification | +| reportedFragments | array(NotificationItem) | C | 1..N | This attribute contains the resource fragments indicated in the "monResItems" attribute of the PolicyDataSubscription data type. (NOTE 5) | ConditionalSubscriptionwithPartialNotification | +| slicePolicyData | SlicePolicyData | O | 0..1 | Network slice specific policy control data for an S-NSSAI, if changed and notification was requested, or if it existed and immediate reporting was requested. | | +| snssai | Snssai | C | 0..1 | Represents the S-NSSAI identifier, the unique identifier of the SlicePolicyControlData resource. It shall only be present when the "slicePolicyData" attribute is present. | | +| pdtqData | PdtqData | O | 0..1 | Planned Data Transfer with QoS requirements Data, if changed and notification was requested, or if it existed and immediate reporting was requested. | PDTQ | +| pdtqRefId | pdtqReferenceId | C | 0..1 | Represents the PDTQ reference identifier. It shall only be present when the "pdtqData" attribute is present. | PDTQ | +| groupPolicyData | GroupPolicyData | O | 0..1 | Contains group specific policy control data for a 5G VN group, if changed and notification was requested, or if it existed and immediate reporting was requested. | GMEC | +| intGroupId | GroupId | C | 0..1 | Represents the group identifier of a 5G VN group, the unique identifier of the GroupPolicyControlData resource.

It shall only be present when the "groupPolicyData" attribute is present. | GMEC | + +NOTE 1: When the "ResourceRemovalNotificationPolicyData" feature and/or + +"ConditionalSubscriptionwithPartialNotification" feature is not supported or supported but the applicable attribute(s) are not provided, at least one of the "amPolicyData", "uePolicySet", "smPolicyData", "usageMonData", "SponsorConnectivityData", "bdtData", "opSpecData", "plmnUePolicySet" or "slicePolicyData" or "groupPolicyData" shall be present. + +NOTE 2: When the "ResourceRemovalNotificationPolicyData" feature is supported, and the "delResources" attribute is present, the attributes that correspond with the values included in the "delResources" attribute shall be omitted. E.g., when the "delResources" attribute includes the value "../policy-data/ues/{ueId}/am-data" the attribute "amPolicyData" shall be omitted. + +NOTE 3: This attribute should not be used if the receiver of the notification is not able to univocally identify the changed operator specific data, and "opSpecDataMap" should be used instead. + +NOTE 4: The attribute does not follow the related naming convention (i.e. "lowerCamel") defined in clause 5.1.4 of 3GPP TS 29.501 [7]. This attribute is however kept as currently defined in this specification for backward compatibility considerations. + +NOTE 5: When the "ConditionalSubscriptionwithPartialNotification" feature is supported, the "notifId" and "reportedFragments" attributes shall be included in notification requests when a data change occurred in the resource fragments indicated in the "monResItems" attribute of the PolicyDataSubscription data type. When the feature "ImmediateReportPcc" is also supported, the "notifId" and "reportedFragments" attributes shall be included in subscription responses when the resource fragments existed when the immediate reporting was requested. + +#### 5.4.2.12 Type TimePeriod + +**Table 5.4.2.12-1: Definition of type TimePeriod** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| period | Periodicity | M | 1 | Indicates whether the periodicity is "YEARLY", "MONTHLY", "WEEKLY", "DAILY" or "HOURLY". | | +| maxNumPeriod | UInteger | O | 0..1 | Indicates the maximum number of periods after which the usage monitoring instance does not apply. If omitted, there is no limit in the number of periods. | | + +#### 5.4.2.13 Type UsageMonDataScope + +**Table 5.4.2.13-1: Definition of type UsageMonDataScope** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|-------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Represents the SNSSAI. | | +| dnn | array(Dnn) | O | 1..N | Represents the Dnn. If omitted, the usage monitoring scope applies to all the DNNs. | | + +NOTE: In this Release of the specification the "dnn" attribute shall always be present with one and only one entry. + +#### 5.4.2.14 Type SmPolicySnssaiData + +**Table 5.4.2.14-1: Definition of type SmPolicySnssaiData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | S-NSSAI associated with the data. | | +| smPolicyDnnData | map(SmPolicyDnnData) | O | 1..N | Session Management Policy data per DNN for all the DNNs of the indicated S-NSSAI. The key of the map is the DNN. | | +| ueSliceMbr | SliceMbr | O | 0..1 | Subscribed UE-Slice-MBR for the indicated S-NSSAI. | NSAC | + +## 5.4.2.15 Type SmPolicyDnnData + +**Table 5.4.2.15-1: Definition of type SmPolicyDnnData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dnn | Dnn | M | 1 | DNN associated with the data | | +| allowedServices | array(string) | O | 1..N | List of subscriber's allowed service identifiers | | +| subscCats | array(string) | O | 1..N | List of categories associated with the subscriber | | +| gbrUl | BitRate | O | 0..1 | Maximum aggregate UL bitrate that can be provided across all GBR QoS Flows in the DNN | | +| gbrDl | BitRate | O | 0..1 | Maximum aggregate DL bitrate that can be provided across all GBR QoS Flows in the DNN | | +| adcSupport | boolean | O | 0..1 | Indicates whether application detection and control is enabled for the PDU session.
True: Application detection and control is enabled for the PDU session;
False: Application detection and control is not enabled for the PDU session.
The absence of this attribute means that ADC support is not provisioned for the UE and PDU session. | | +| subscSpendingLimits | boolean | O | 0..1 | Indicates whether the PCF must enforce session management related policies based on subscriber spending limits.
True: Spending limit control is enabled;
False: Spending limit control is not enabled.
The absence of this attribute means that spending limit control is not provisioned for the UE and PDU session. | | +| ipv4Index | IpIndex | O | 0..1 | Information that identifies which IP pool or external server is used to allocate the IPv4 address. | | +| ipv6Index | IpIndex | O | 0..1 | Information that identifies which IP pool or external server is used to allocate the IPv6 address. | | +| offline | boolean | O | 0..1 | Indicates whether the offline charging is applicable to the PDU session.
True: Offline charging is applicable to the PDU session;
False: Offline charging is not applicable to the PDU session.
The absence of this attribute means that the charging method is not provisioned for the UE and PDU session. | | +| online | boolean | O | 0..1 | Indicates whether the online charging is applicable to the PDU session.
True: Online charging is applicable to the PDU session;
False: Online charging is not applicable to the PDU session.

The absence of this attribute means that the charging method is not provisioned for the UE and PDU session. | | +| chfInfo | ChargingInformation | O | 0..1 | The address(es) and, if available, the CHF instance ID and the CHF set ID of the Charging Function. (NOTE) | | +| refUmDataLimitIds | map(LimitIdToMonitoringKey) | O | 1..N | A reference to the "UsageMonDataLimit" or "UsageMonData" instances for this DNN and SNSAI that may also include the related monitoring key(s). The key of the map is the limit identifier. | | +| mpsPriority | boolean | O | 0..1 | True: Indicates subscription to the MPS priority service; priority applies to all traffic on the PDU Session.
False: MPS priority service is not subscribed.
The absence of this attribute means that MPS | | + +| | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------|-----------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------| +| | | | | priority is not provisioned for the UE and PDU session. | | +| mcsPriority | boolean | O | 0..1 | True: Indicates subscription to the MCS priority service; priority applies to all traffic on the PDU Session.
False: IMS signalling priority service is not subscribed.
The absence of this attribute means that IMS signalling priority is not provisioned for the UE and PDU session. | | +| imsSignallingPrio | boolean | O | 0..1 | True: Indicates subscription to the IMS signalling priority service; priority only applies to IMS signalling traffic.
False: IMS signalling priority service is not subscribed.
The absence of this attribute means that IMS signalling priority is not provisioned for the UE and PDU session. | | +| mpsPriorityLevel | integer | O | 0..1 | Relative priority level for the multimedia priority services | | +| mcsPriorityLevel | integer | O | 0..1 | Relative priority level for the mission critical services | | +| pralInfos | map(PresenceInfo) | O | 1..N | Presence reporting area information. Each PresenceInfo element shall include the Presence Reporting Area Identifier within the "prald" attribute and, for a UE-dedicated presence reporting area, shall also include the list of elements composing the presence reporting area.
A "prald" may indicate a Presence Reporting Area Set.
The "prald" attribute within the PresenceInfo data type shall also be the key of the map.
The attribute "presenceState" shall not be present. | | +| bdtdRefls | map(BdtReferenceIdRm) | O | 1..N | Identifies transfer policies of background data transfer.
Any string value can be used as a key of the map. | EnhancedBackgroundData Transfer | +| locRoutNotAllowed | boolean | O | 0..1 | Identifies whether AF influence on traffic routing is allowed or not.
True: if no local routing is allowed;
False: local routing is allowed.
The absence of this attribute means that AF influence on traffic routing is not provisioned for the UE and PDU session. | | +| sfcNotAllowed | boolean | O | 0..1 | Identifies whether AF influence on Service Function Chaining is allowed or not.
True: if no AF influence on Service Function Chaining is allowed;
False: AF influence on Service Function Chaining allowed.
The absence of this attribute means that AF influence on Service Function Chaining is not provisioned for the UE and PDU session. | SFC | +| tnaps | array(TnapId) | O | 1..N | Contains the TNAP ID(s) collocated with the 5G-RG(s) of a specific user. | AfGuideTNAPs | +| NOTE: When the feature "CHFsetSupport" is supported, the "secondaryChfAddress" may be omitted (see 3GPP TS 29.512 [12], clause 4.2.2.3.1). | | | | | | + +### 5.4.2.16 Type LimitIdToMonitoringKey + +**Table 5.4.2.16-1: Definition of type LimitIdToMonitoringKey** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------|---------------| +| limitId | string | M | 1 | Limit Identifier. | | +| monkey | array(string) | O | 1..N | Monitoring Keys. | | + +NOTE: In this Release of the specification there is only one Monitoring Key per Limit Identifier + +### 5.4.2.17 Type UePolicySetPatch + +**Table 5.4.2.17-1: Definition of type UePolicySetPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| uePolicySections | map(UePolicySection) | O | 1..N | Contains the UE Policy Sections.
The UPSI (UE Policy Section Identifier) is used as the key in the map. | | +| upsis | array(string) | O | 1..N | List of identifiers for the "uePolicySections". The format of the UPSI is represented in 3GPP TS 24.501 [11] clause D.6.2. | | +| andsplnd | boolean | O | 0..1 | Indication of UE supporting ANDSP. | | +| epsUrsplnd | boolean | O | 0..1 | Indication of UE supporting URSP provisioning in EPS.
True: The UE supports URSP provisioning in EPS;
False: The UE does not support URSP provisioning in EPS. | EpsUrsp | +| vpsUrsplnd | boolean | O | 0..1 | Indication of UE supporting VPLMN-specific URSP.
True: The UE supports VPLMN-specific URSP;
False: The UE does not support VPLMN-specific URSP. | VPLMNSpecificURSP | +| urspenflnd | boolean | O | 0..1 | Indication of UE supporting URSP enforcement report.
True: The UE supports URSP enforcement report;
False: The UE does not support URSP enforcement report. | URSPEnforcement | +| pei | Pei | O | 0..1 | Personal Equipment Identifier. | | +| oslds | array(Osld) | O | 1..N | Identification of the UE Operating System(s). | | + +### 5.4.2.18 Type PlmnRouteSelectionDescriptor + +**Table 5.4.2.18-1: Definition of type PlmnRouteSelectionDescriptor** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------|---------------------------------------|---|-------------|----------------------------------------------------------------| +| servingPlmn | PlmnId | M | 1 | Identity of the serving PLMN. | +| snssaiRouteSelectionDescriptors | array(SNSSAIRouteSelectionDescriptor) | O | 1..N | Contains the route selection descriptor parameters per SNSSAI. | + +### 5.4.2.19 Type SnssaiRouteSelectionDescriptor + +**Table 5.4.2.19-1: Definition of type SnssaiRouteSelectionDescriptor** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|------------------------------------|---|-------------|-------------------------------------------------------------| +| snssai | Snssai | M | 1 | SNSSAI. | +| dnnRouteSelDescs | array(DnnRouteSelectionDescriptor) | O | 1..N | Contains the route selection descriptor parameters per DNN. | + +### 5.4.2.20 Type DnnRouteSelectionDescriptor + +**Table 5.4.2.20-1: Definition of type DnnRouteSelectionDescriptor** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| dnn | Dnn | M | 1 | DNN. | | +| sscModes | array(SscMode) | O | 1..N | Contains the allowed SSC modes for the traffic to this DNN. | | +| pduSessTypes | array(PduSessionType) | O | 1..N | Contains the allowed PDU Session types for the traffic to this DNN. | | +| atsssInfo | boolean | O | 0..1 | Indicates whether MA PDU session establishment is allowed for this DNN.
True: MA PDU session establishment is allowed for this DNN.
False: MA PDU session establishment is not allowed for this DNN.
The absence of this attribute means that the ATSSS information is not provisioned for the UE and PDU session. | | +| 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. | VPLMNSpecificURSP | + +### 5.4.2.21 Type SmPolicyDataPatch + +**Table 5.4.2.21-1: Definition of type SmPolicyDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| umData | map(UsageMonData) | O | 1..N | Contains the remaining allowed usage data associated with the subscriber.
The value of the limit identifier is used as the key in the map. | | +| smPolicySnssaiData | map(SmPolicySnssaiDataPatch) | O | 1..N | Modifiable Session Management Policy data per S-NSSAI for all the SNSSAIs of the subscriber.
The key of the map is the S-NSSAI. (NOTE 2) | | + +NOTE 1: In this Release of the specification the "limitId" corresponds to the Monitoring Key. + +NOTE 2: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[7], clause 5.4.4.2. + +### 5.4.2.22 Type SmPolicySnssaiDataPatch + +**Table 5.4.2.22-1: Definition of type SmPolicySnssaiDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | S-NSSAI associated with the data. | | +| smPolicyDnnData | map(SmPolicyDnnDataPatch) | O | 1..N | Modifiable Session Management Policy data per DNN for all the DNNs of the indicated S-NSSAI. The key of the map is the DNN. | | + +### 5.4.2.23 Type SmPolicyDnnDataPatch + +**Table 5.4.2.23-1: Definition of type SmPolicyDnnDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------|----------------------------------------| +| dnn | Dnn | M | 1 | DNN associated with the data | | +| bdtRefls | map(BdtRefere
nceldRm) | O | 1..N | Updated transfer policies of background data transfer.
Any string value can be used as a key of the map. | EnhancedBac
kgroundData
Transfer | + +### 5.4.2.24 Type ResourceItem + +**Table 5.4.2.24-1: Definition of type ResourceItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| monResourceUri | Uri | M | 1 | Represents the URI that identifies the monitored resource as defined in table 5.2.2-1.
(NOTE) | | +| items | array(ItemPath) | M | 1..N | Represents fragments of the resource identified by the "monResourceUri" attribute, i.e. a subset of resource data, for which a modification triggers a notification. | | + +NOTE: The resource URI included in the "monResourceUri" attribute shall be one of the resource URIs included in the "monitoredResourceUris" attribute of the PolicyDataSubscription data type. + +### 5.4.2.25 Type NotificationItem + +**Table 5.4.2.25-1: Definition of type NotificationItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| resourceId | Uri | M | 1 | This IE contains the URI of the resource which has been changed. | | +| notifItems | array(UpdatedItem) | M | 1..N | This IE contains the fragments of the resource identified by the "resourceId" attribute which have been updated or requested to be notified. | | + +### 5.4.2.26 Type UpdatedItem + +**Table 5.4.2.26-1: Definition of type UpdatedItem** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| item | ItemPath | M | 1 | This IE contains a JSON pointer value (as defined in IETF RFC 6901 [20]) that references a target location within the resource that identifies the resource fragment. | | +| value | Any type | M | 1 | This IE indicates the value of the resource fragment located at the target location within the resource specified in the "item" attribute.
The data type of this attribute shall be the same as the type of the attribute or element located in the path.
The null value shall be allowed. | | + +### 5.4.2.27 Type BdtDataPatch + +**Table 5.4.2.27-1: Definition of type BdtDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------| +| bdtStatus | BdtPolicyStatus | O | 0..1 | Contains the validation status for a negotiated BDT policy. It shall be included when the BDT policy is re-negotiated. | +| transPolicy | TransferPolicy | O | 0..1 | This IE contains the transfer policy. | +| warnNotifEnabled | boolean | O | 0..1 | This IE indicates whether the BDT warning notification is enabled or disabled.
true: enabled;
false: disabled. | + +### 5.4.2.28 Type PolicyDataForIndividualUe + +**Table 5.4.2.28-1: Definition of type PolicyDataForIndividualUe** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------|------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| uePolicyDataSet | UePolicySet | O | 0..1 | The IE contains UE policies. | | +| smPolicyDataSet | SmPolicyData | O | 0..1 | The IE contains SM policies. | | +| amPolicyDataSet | AmPolicyData | O | 0..1 | The IE contains AM policies. | | +| umData | map(UsageMonData) | C | 1..N | The IE contains UM policies.
The value of the limit identifier is used as the key of the map.
(NOTE) | | +| operatorSpecificDataSet | map(OperatorSpecificDataContainer) | O | 1..N | The IE contains operator specific data.
The key of the map is operator specific data element name and the value is the operator specific data of the UE. | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.
This parameter shall be provided if the NF service consumer has provided a list of supported features in its request. | | + +NOTE: The "umData" attribute shall be absent when the smPolicyDataSet attribute is present and includes the "umData" attribute. + +### 5.4.2.29 Type SlicePolicyData + +**Table 5.4.2.29-1: Definition of type SlicePolicyData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbrUI | BitRate | O | 0..1 | Maximum aggregate UL data rate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. (NOTE 1) | | +| mbrDI | BitRate | O | 0..1 | Maximum aggregate DL data rate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. (NOTE 1) | | +| remainMbrUI | BitRate | O | 0..1 | The remaining maximum aggregate UL data rate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. (NOTE 2)
It is set to the maximum allowed aggregate UL data rate across all GBR and Non-GBR QoS Flows in the S-NSSAI when the system is initially configured based on operator policies. | | +| remainMbrDI | BitRate | O | 0..1 | The remaining maximum aggregate DL data rate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. (NOTE 2)
It is set to the maximum allowed aggregate DL data rate across all GBR and Non-GBR QoS Flows in the S-NSSAI when the system is initially configured based on operator policies. | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.
It shall be provided in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. | | + +NOTE 1: The "mbrUI" and "mbrDI" attributes are only used for limiting data rate per network slice with assistance of the NWDAF. + +NOTE 2: The "remainMbrUI" and "remainMbrDI" attributes are only used for limiting data rate per network slice with PCF based monitoring. + +### 5.4.2.30 Type SlicePolicyDataPatch + +**Table 5.4.2.30-1: Definition of type SlicePolicyDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------|---------------| +| remainMbrUI | BitRate | O | 0..1 | The remaining maximum aggregate UL bitrate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. | | +| remainMbrDI | BitRate | O | 0..1 | The remaining maximum aggregate DL bitrate that can be provided across all GBR and Non-GBR QoS Flows in the S-NSSAI. | | +| NOTE: At least one of the attributes shall be included. | | | | | | + +### 5.4.2.31 Type MbsSessPolCtrlData + +**Table 5.4.2.31-1: Definition of type MbsSessPolCtrlData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------|---------------| +| 5qis | array(5Qi) | O | 1..N | Contains the list of allowed 5QI(s) for an MBS PCC rule of the MBS Session. | | +| maxMbsArpLevel | ArpPriorityLevel | O | 0..1 | Contains the highest ARP level value allowed for any MBS PCC rule of the MBS Session. | | +| maxMbsSessionAmbr | BitRate | O | 0..1 | Contains the maximum MBS Session-AMBR for all non-GBR QoS flows of an MBS session in the downlink. | | +| maxGbr | BitRate | O | 0..1 | Contains the maximum aggregated bitrate that can be provided across all the GBR QoS Flows for an MBS session in the downlink. | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.
This parameter shall be provided if feature negotiation needs to take place. | | + +### 5.4.2.32 Type MbsSessPolDataId + +**Table 5.4.2.32-1: Definition of type MbsSessPolDataId** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|------------------------------------------------------------------------------------------|---------------| +| mbsSessionId | MbsSessionId | C | 0..1 | Contains the source specific multicast address used as MBS session identifier.
(NOTE) | | +| afAppId | string | C | 0..1 | Contains the AF application identifier.
(NOTE) | | + +NOTE: Either the "mbsSessionId" attribute or the "afAppId" attribute shall be provided. + +## 5.4.2.33 Type PdtqData + +Table 5.4.2.33-1: Definition of type PdtqData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| aspld | string | M | 1 | This IE contains an identity of an application service provider. | +| pdtqPolicy | PdtqPolicy | M | 1 | This IE contains the PDTQ policy. | +| appld | ApplicationId | O | 0..1 | This IE contains an application identifier. | +| pdtqReflId | PdtqReferenceId | O | 0..1 | This IE indicates the PDTQ reference ID for the PDTQ policy. | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | This IE represents a network area information. | +| numOfUes | UInteger | O | 0..1 | This IE contains the number of UEs using the indicated PDTQ policy. It shall be present when available. | +| desTimeInts | array(TimeWindow) | O | 1..N | This IE contains a list of desired time windows for PDTQ. | +| dnn | Dnn | O | 0..1 | This IE identifies a DNN. | +| snssai | Snssai | O | 0..1 | This IE identifies a slice. | +| qosParamSet | QosParameterSet | O | 0..1 | Contains the requested QoS requirements expressed as one or more individual QoS parameters.
(NOTE 3) | +| qosReference | string | O | 0..1 | Contains the requested QoS requirements expressed as the QoS Reference which represents a pre-defined QoS information.
(NOTE 2) | +| altQosParamSets | array(AltQosParamSet) | O | 1..N | Contains the alternative QoS requirements expressed as the list of individual QoS parameter sets in a prioritized order. The lower the index of the array for a given entry, the higher the priority.
(NOTE 3) | +| altQosRefs | array(string) | O | 1..N | Contains the alternative QoS requirements expressed as the list of QoS References in a prioritized order. The lower the index of the array for a given entry, the higher the priority.
(NOTE 2) | +| notifUri | Uri | O | 0..1 | This IE contains an URI of the recipient of the PDTQ warning notification. | +| warnNotifEnabled | boolean | O | 0..1 | This IE indicates whether the PDTQ warning notification is enabled or disabled.

true: enabled;
false: disabled (default). | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 5.6.
This attribute shall be provided in the PUT request and in the response of successful resource creation, and in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE). | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | + +NOTE 1: 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 UDR. + +NOTE 2: The "altQosRefs" attribute may be included only if the "qosReference" attribute is included. + +NOTE 3: The "altQosParamSets" attribute may be included only if the "qosParamSet" attribute is included. + +### 5.4.2.34 Type PdtqDataPatch + +**Table 5.4.2.34-1: Definition of type PdtqDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------| +| pdtqPolicy | PdtqPolicy | O | 0..1 | This IE contains the PDTQ policy. | +| warnNotifEnabled | boolean | O | 0..1 | This IE indicates whether the PDTQ warning notification is enabled or disabled.

true: enabled;
false: disabled | +| notifUri | Uri | O | 0..1 | This IE contains an URI of the recipient of the PDTQ warning notification. | + +### 5.4.2.35 Type GroupPolicyData + +**Table 5.4.2.35-1: Definition of type GroupPolicyData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| remainGroupMbrUl | BitRate | O | 0..1 | The remaining maximum aggregate UL data rate that can be provided across all GBR and Non-GBR QoS Flows in the 5G VN group.

(NOTE) | | +| remainGroupMbrDl | BitRate | O | 0..1 | The remaining maximum aggregate DL data rate that can be provided across all GBR and Non-GBR QoS Flows in the 5G VN group.

(NOTE) | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.

It shall be provided only when feature negotiation needs to take place. | | + +NOTE: The initial value of these attributes shall be set based on the Maximum Group Data Rate information and/or operator policies. + +### 5.4.2.36 Type GroupPolicyDataPatch + +**Table 5.4.2.36-1: Definition of type GroupPolicyDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------|---------------| +| remainGroupMbrUl | BitRate | O | 0..1 | The remaining maximum aggregate UL bitrate that can be provided across all GBR and Non-GBR QoS Flows of the 5G VN group.

(NOTE) | | +| remainGroupMbrDl | BitRate | O | 0..1 | The remaining maximum aggregate DL bitrate that can be provided across all GBR and Non-GBR QoS Flows of the 5G VN group.

(NOTE) | | + +NOTE: At least one of these attributes shall be included. + +## 5.4.3 Simple data types and enumerations + +### 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. + +### 5.4.3.2 Simple data types + +The simple data types defined in table 5.4.3.2-1 shall be supported. + +**Table 5.4.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------| +| BdtReferenceIdRm | string | This data type is defined in the same way as the "BdtReferenceId" data type defined in 3GPP TS 29.122 [9], but with the "nullable: true" property. | EnhancedBackgroundDataTransfer | +| IpIndex | integer | Information that identifies which IP pool or external server is used to allocate the IP address. | | +| ItemPath | string | It contains one JSON pointer value (as defined in IETF RFC 6901 [20]) that references a target location within the resource.
E.g. "/smPolicySnssaiData/" represents the subscription to data changes in the SmPolicyData data document, in particular to the element of the "smPolicySnssaiData" map whose key is identified by the value.
E.g. 2
"/smPolicySnssaiData//smPolicyDnnData/" represents the subscription to data changes in the SmPolicyData data document, in particular to the element of the "smPolicySnssaiData" map whose key is identified by the value and, within this one, to the element of the "smPolicyDnnData" map whose key is identified by the value.
(NOTE) | ConditionalSubscriptionwithPartialNotification | +| OsId | string | Operating System of the served UE. It contains a Universally Unique Identifier (UUID) as specified in IETF RFC 4122 [17]. The format of the OS Id is represented in 3GPP TS 24.501 [11]. | | + +NOTE: The S-NSSAI value used as key of the map is encoded as a string as defined in 3GPP TS 29.571[7], clause 5.4.4.2. + +### 5.4.3.3 Enumeration: UsageMonLevel + +The enumeration represents the usage monitoring level. It shall comply with the provisions defined in table 5.4.3.3-1. + +**Table 5.4.3.3-1: Enumeration UsageMonLevel** + +| Enumeration value | Description | +|-------------------|-----------------------------------------------------------| +| SESSION_LEVEL | The usage monitoring is applicable for PDU session level. | +| SERVICE_LEVEL | The usage monitoring is applicable for service level. | + +### 5.4.3.4 Enumeration: Periodicity + +The enumeration represents the time period. It shall comply with the provisions defined in table 5.4.3.4-1. + +**Table 5.4.3.4-1: Enumeration Periodicity** + +| Enumeration value | Description | +|-------------------|------------------------| +| YEARLY | Time period is yearly | +| MONTHLY | Time period is monthly | +| WEEKLY | Time period is weekly | +| DAILY | Time period is daily | +| HOURLY | Time period is hourly | + +#### 5.4.3.5 Enumeration: BdtPolicyStatus + +The enumeration represents the validation status of the BDT policy. It shall comply with the provisions defined in table 5.4.3.5-1. + +**Table 5.4.3.5-1: Enumeration BdtPolicyStatus** + +| Enumeration value | Description | +|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| +| INVALID | This value is used to indicate that the BDT policy is invalid while the BDT policy re-negotiation is ongoing because the network performance has degraded. | +| VALID | This value is used to indicate that the BDT policy is valid. | + +#### 5.4.3.6 Enumeration: PolicyDataSubset + +This enumeration indicates the policy data subsets (e.g. AM policy data, SM policy data, etc.). It shall comply with the provisions of table 5.4.3.6-1. + +**Table 5.4.3.6-1: Enumeration PolicyDataSubset** + +| Enumeration value | Description | +|------------------------|-------------------------| +| AM_POLICY_DATA | AM policy data. | +| SM_POLICY_DATA | SM policy data. | +| UE_POLICY_DATA | UE policy data. | +| UM_DATA | Usage Monitoring data. | +| OPERATOR_SPECIFIC_DATA | Operator specific data. | + +#### 5.4.3.7 void + +### 5.5 Error handling + +#### 5.5.1 General + +For the Nudr\_DataRepository service API for Policy Data, 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 Nudr\_DataRepository service API for Policy Data. + +#### 5.5.2 Protocol Errors + +No specific procedures for the Nudr\_DataRepository service API for Policy Data are specified. + +### 5.5.3 Application Errors + +The application errors defined for the Nudr\_DataRepository service API for Policy Data are listed in table 5.5.3-1. + +**Table 5.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------| +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated by other clauses in this document. | | | + +The application error handling shall follow 3GPP TS 29.504 [6] clause 6.1.6 unless explicitly specified in this document. + +## 5.6 Feature negotiation + +The optional features in table 6.1.8-1 of 3GPP TS 29.504 [6] are defined for the Nudr\_DataRepository API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +--- + +# 6 Usage of Nudr\_DataRepository Service API for Application Data + +## 6.1 Introduction + +The following clauses specify the usage of Nudr\_DataRepository service for application data. The principles specified in 3GPP TS 29.504 [6] are followed unless explicitly specified otherwise in the following clauses. + +## 6.2 Resources + +### 6.2.1 Overview + +This clause specifies the resources for the usage of the Unified Data Repository service for Application Data. + +### 6.2.2 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 6.2.2-1 depicts the resource URIs structure for the Nudr\_DataRepository API for application data + +![A hierarchical tree diagram showing the structure of {apiRoot}/nudr-dr//application-data. The root branches into several categories: /pfd, /influenceData, /bdtPolicyData, /iptvConfigData, /serviceParamData, /am-influence-data, /subs-to-notify, /eas-deploy-data, and /af-qos-data-sets. Each category has its own sub-elements, some with placeholder variables like {appId} or {influenceId}.](e7010c66da16316c2935dfbbef5056b3_img.jpg) + +``` +graph TD; Root["{apiRoot}/nudr-dr/"] --- AppData["/application-data"]; AppData --- Pfd["/pfd"]; AppData --- InfluenceData["/influenceData"]; AppData --- BdtPolicyData["/bdtPolicyData"]; AppData --- IptvConfigData["/iptvConfigData"]; AppData --- ServiceParamData["/serviceParamData"]; AppData --- AmInfluenceData["/am-influence-data"]; AppData --- SubsToNotify1["/subs-to-notify"]; AppData --- EasDeployData["/eas-deploy-data"]; AppData --- AfQosDataSets["/af-qos-data-sets"]; Pfd --- AppId["/{appId}"]; InfluenceData --- InfluenceId["/{influenceId}"]; InfluenceData --- SubsToNotify2["/subs-to-notify"]; SubsToNotify2 --- SubscriptionId["/{subscriptionId}"]; BdtPolicyData --- BdtPolicyId["/{bdtPolicyId}"]; IptvConfigData --- ConfigurationId["/{configurationId}"]; ServiceParamData --- ServiceParamId["/{serviceParamId}"]; AmInfluenceData --- AmInfluenceId["/{amInfluenceId}"]; SubsToNotify1 --- SubId["/{subId}"]; EasDeployData --- EasDeployInfoId["/{easDeployInfoId}"]; AfQosDataSets --- AfReqQosId["/{afReqQosId}"]; +``` + +A hierarchical tree diagram showing the structure of {apiRoot}/nudr-dr//application-data. The root branches into several categories: /pfd, /influenceData, /bdtPolicyData, /iptvConfigData, /serviceParamData, /am-influence-data, /subs-to-notify, /eas-deploy-data, and /af-qos-data-sets. Each category has its own sub-elements, some with placeholder variables like {appId} or {influenceId}. + +**Figure 6.2.2-1: Resource URI structure of the Nudr\_DataRepository API for application data** + +Table 6.2.2-1 provides an overview of the resources and applicable HTTP methods. + +**Table 6.2.2-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|----------------------------------------|------------------------------------------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PFD Data | /application-data/pfds | GET | Retrieve PFDs for application identifier(s) identified by query parameter(s).
Retrieve PFDs for all application identifier(s) if no query parameter is included in the Request URI. | +| Individual PFD Data | /application-data/pfds/{appId} | GET | Retrieve the corresponding PFDs of the specified application identifier. | +| | | DELETE | Delete the corresponding PFDs of the specified application identifier. | +| | | PUT | Create or update the corresponding PFDs for the specified application identifier. | +| Influence Data | /application-data/influenceData (NOTE) | GET | Retrieve the Session Influence Data of given services, S-NSSAIs and DNNs or Internal Group Identifier(s) or Subscriber Category(ies) or SUPIs. | +| Individual Influence Data | /application-data/influenceData/{influenceId} (NOTE) | PUT | Create an individual Influence Data resource identified by {influenceId}, or modify all of the properties of an individual Influence Data resource identified by {influenceId}. | +| | | PATCH | Modify part of the properties of an individual Influence Data resource identified by {influenceId}. | +| | | DELETE | Delete an individual Influence Data resource identified by {influenceId}. | +| Influence Data Subscription | /application-data/influenceData/subs-to-notify (NOTE) | POST | Create a new Individual Influence Data Subscription resource. | +| | | GET | Read subscriptions for a given S-NSSAI and DNN or Internal Group Identifier(s) or Subscriber Category(ies) or SUPI. | +| Individual Influence Data Subscription | /application-data/influenceData/subs-to-notify/{subscriptionId} (NOTE) | GET | Get an existing individual Influence Data Subscription resource identified by {subscriptionId}. | +| | | PUT | Modify an existing individual Influence Data Subscription resource identified by {subscriptionId}. | +| | | DELETE | Delete an individual Influence Data Subscription resource identified by {subscriptionId}. | +| Applied BDT Policy Data | /application-data/bdtPolicyData (NOTE) | GET | Retrieve the applied BDT policy data. | +| Individual Applied BDT Policy Data | /application-data/bdtPolicyData/{bdtPolicyId} (NOTE) | PUT | Create an individual applied BDT Policy Data resource identified by {bdtPolicyId}. | +| | | PATCH | Modify BDT Reference Id of an individual applied BDT Policy Data resource identified by {bdtPolicyId}. | +| | | DELETE | Delete an individual applied BDT Policy Data resource identified by {bdtPolicyId}. | +| IPTV Configurations | /application-data/iptvConfigData (NOTE) | GET | Retrieve IPTV configurations for configuration identifier(s), given S-NSSAI(s) and DNN(s), or SUPIs or Internal Group Identifiers | +| Individual IPTV Configuration | /application-data/iptvConfigData/{configurationId} (NOTE) | PUT | Create an Individual IPTV Configuration resource identified by {configurationId}, or modify all the properties of an Individual IPTV Configuration resource identified by {configurationId}. | +| | | PATCH | Modify some properties of an Individual IPTV Configuration resource | + +| | | | | +|--------------------------------------------|------------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | identified by {configurationId}. | +| | | DELETE | Delete an Individual IPTV Configuration resource identified by {configurationId} | +| Service Parameter Data | /application-data/serviceParamData (NOTE) | GET | Retrieve the Service Parameter Data of given services, S-NSSAIs and DNNs or Internal Group Identifiers or SUPIs. | +| Individual Service Parameter Data | /application-data/serviceParamData/{serviceParamId} (NOTE) | PUT | Create an individual Service Parameter Data resource identified by {serviceParamId}, or modify all of the properties of an individual Service Parameter Data resource identified by {serviceParamId}. | +| | | PATCH | Modify part of the properties of an individual Service Parameter Data resource identified by {serviceParamId}. | +| | | DELETE | Delete an individual Service Parameter Data resource identified by {serviceParamId}. | +| AM Influence Data | /application-data/am-influence-data | GET | Retrieve the AM Influence Data of given S-NSSAIs and DNNs and/or Internal Group Identifiers or SUPIs or for LBO roaming scenarios, any inbound roaming UEs identified by their home PLMN ID(s). | +| Individual AM Influence Data | /application-data/am-influence-data/{amInfluenceId} | PUT | Create an individual AM Influence Data resource identified by {amInfluenceId}, or modify all of the properties of an individual AM Influence Data resource identified by {amInfluenceId}. | +| | | PATCH | Modify part of the properties of an individual AM Influence Data resource identified by {amInfluenceId}. | +| | | DELETE | Delete an individual AM Influence Data resource identified by {amInfluenceId}. | +| ApplicationDataSubscriptions | /application-data/subs-to-notify | POST | Create a subscription to receive notification of application data changes. | +| | | GET | Read all the subscriptions, or subscriptions for given S-NSSAI and DNN or Internal Group Identifier or SUPI. | +| IndividualApplicationDataSubscription | /application-data/subs-to-notify/{subsId} | PUT | Modify a subscription to receive notification of application data changes identified by {subsId}. | +| | | DELETE | Delete a subscription identified by {subsId}. | +| | | GET | Read an existing individual Subscription resource identified by {subsId}. | +| EAS Deployment Information Data | /application-data/eas-deploy-data | GET | Retrieve the EAS Deployment Information Data, given DNN(s), S-NSSAI(s), Application ID or Internal Group Identifiers. | +| Individual EAS Deployment Information Data | /application-data/eas-deploy-data/{easDeployInfoId} | GET | Read an existing individual EAS Deployment Data identified by {easDeployInfoId}. | + +| | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | PUT | Create an individual EAS deployment information Data resource identified by {easDeployInfoId} or Update an individual EAS Deployment Data resource identified by {easDeployInfoId}. | +| | | DELETE | Delete an individual EAS Deployment Data resource identified by {easDeployInfoId}. | +| AF Requested QoS Data Sets | /application-data/af-qos-data-sets | GET | Retrieve one or several existing AF Requested QoS Data Set(s). | +| Individual AF Requested QoS Data Set | /application-data/af-qos-datasets/{afReqQosId} | PUT | Create an Individual AF Requested QoS Data Set or update an existing Individual AF Requested QoS Data Set. | +| | | PATCH | Modify an existing Individual AF Requested QoS Data Set. | +| | | DELETE | Delete an existing Individual AF Requested QoS Data Set. | +| Individual DNAI EAS Mapping | /application-data/dnai-eas-mappings/{dnai} | GET | Retrieve the EAS address information for a DNAI. | +| ECS Address Roaming Data | /application-data/ecs-address-roaming | GET | Retrieve all existing ECS Address Configuration Information for roaming UEs. | +| Individual ECS Address Roaming Data | /application-data/ecs-address-roaming/{ecsAddrInfoId} | GET | Retrieve an existing ECS Address Configuration Information entry for roaming UEs. | +| | | PUT | Create or Update an ECS Address Configuration Information entry for roaming UEs. | +| | | DELETE | Delete an existing ECS Address Configuration Information entry for roaming UEs. | +| NOTE: The path segment does not follow the related naming convention defined in 3GPP TS 29.501 [5]. The path segment is kept though as defined in the current specification for backward compatibility considerations. | | | | + +## 6.2.3 Resource: PFD Data + +### 6.2.3.1 Description + +The PFD Data resource represents all the PFD Datas to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.3.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/pfds + +**Table 6.2.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.3.3 Resource Standard Methods + +#### 6.2.3.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.3.3.1-1. + +**Table 6.2.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| appId
(NOTE) | array(ApplicationId) | O | 1..N | Contains the information of the application identifier(s) for the querying PFD Data resource.
If the appId query parameter is not included in the URI, the query applies to all application identifier(s) for the querying PFD Data resource.
If the appId array contains one or more ApplicationId entries, the UDR returns an Individual PFD Data resource representation for each matched ApplicationId. | +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +NOTE: The query parameter does not follow the related naming convention (i.e. "lower-with-hyphen") defined in clause 5.1.3.3 of 3GPP TS 29.501 [7]. This query parameter is however kept as currently defined in this specification for backward compatibility considerations. + +This method shall support the request data structures specified in table 6.2.3.3.1-2 and the response data structures and response codes specified in table 6.2.3.3.1-3. + +**Table 6.2.3.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(PfdDataForAppExt) | M | 0..N | 200 OK | A representation of PFDs for request applications is returned.
NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | + +## 6.2.4 Resource: Individual PFD Data + +### 6.2.4.1 Description + +The Individual PFD Data resource represents Individual PFD Datas to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.4.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/pfds/{appId} + +This resource shall support the resource URI variables defined in table 6.2.4.2-1. + +**Table 6.2.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|---------------|---------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| appId | ApplicationId | Indicates the application identifier for the request pfd(s).
Data type ApplicationId is defined in 3GPP TS 29.571 [7]. | + +### 6.2.4.3 Resource Standard Methods + +#### 6.2.4.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.4.3.1-1. + +**Table 6.2.4.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 6.2.4.3.1-2 and the response data structures and response codes specified in table 6.2.4.3.1-3. + +**Table 6.2.4.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.4.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------| +| PfdDataForAppExt | M | 1 | 200 OK | A representation of PFDs for the request application identified by the application identifier is returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.4.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.4.3.2-1. + +**Table 6.2.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.2.4.3.2-2 and the response data structures and response codes specified in table 6.2.4.3.2-3. + +**Table 6.2.4.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.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 Individual PFD Data resource related to the application identifier was deleted. | +| NOTE: 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. | | | | | + +## 6.2.4.3.3 PUT + +This method shall support the URI query parameters specified in table 6.2.4.3.3-1. + +**Table 6.2.4.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 6.2.4.3.3-2 and the response data structures and response codes specified in table 6.2.4.3.3-3. + +**Table 6.2.4.3.3-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------------------------------------------------| +| PfdDataForAppEx
t | M | 1 | Contains the information for the creation or modification of an individual PFD Data resource. | + +**Table 6.2.4.3.3-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| PfdDataForAppEx
t | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| PfdDataForAppEx
t | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | + +NOTE: 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. + +**Table 6.2.4.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}/nudr-dr//application-data/pfds/{appId} | + +## 6.2.5 Resource: Influence Data + +### 6.2.5.1 Description + +The Influence Data resource represents a Traffic Influence Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.5.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/influenceData + +This resource shall support the resource URI variables defined in table 6.2.5.2-1. + +**Table 6.2.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.5.3 Resource Standard Methods + +#### 6.2.5.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.5.3.1-1. + +**Table 6.2.5.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| influence-Ids
(NOTE 2) | array(string) | O | 1..N | Each element identifies a influenceId, i.e. an Individual Influence Data resource.
(NOTE 1) | +| dnns | array(Dnn) | O | 1..N | Each element identifies a DNN. The UDR shall return only Individual Influence Data resource(s) that match one of the provided DNNs.
(NOTE 1) | +| snssais | array(SNSSAI) | O | 1..N | Each element identifies a slice. The UDR shall return only Individual Influence Data resource(s) that match one of the provided S-NSSAIs.
(NOTE 1) | +| internal-Group-Ids
(NOTE 2) | array(GroupId) | O | 1..N | Each element identifies a group of users. The UDR shall return only Individual Influence Data resource(s) that match one of the provided internal group IDs within the "interGroupId" attribute.
(NOTE 1) | +| internal-group-ids-add | array(GroupId) | O | 1..N | Each element identifies an internal group id. The UDR shall return only Individual Influence Data resource(s) that match all the provided internal group IDs within the "interGroupIdList" attribute. | +| subscriber-categories | array(string) | O | 1..N | Each element identifies a subscriber category. The UDR shall return only Individual Influence Data resource(s) that match all the provided subscriber category(ies). | +| supis | array(Supi) | O | 1..N | Each element identifies a user. The UDR shall return only Individual Influence Data resource(s) that match one of the provided SUPIs.
(NOTE 1) | +| supp-feat | SupportedFeatures | O | 0..1 | Identifies the features supported by the NF service consumer. | + +NOTE 1: At least one of the "influence-Ids", "dnns", "snssais", "internal-Group-Ids", "internal-group-ids-add" (may be included when FinerGranUEs feature is supported) or "supis" query parameters shall be provided. + +NOTE 2: The query parameter does not follow the related naming convention (i.e. "lower-with-hyphen") defined in clause 5.1.3.3 of 3GPP TS 29.501 [7]. This query parameter is however kept as currently defined in this specification for backward compatibility considerations. + +NOTE: The combination of a. "internal-Group-Ids" and the "supis", b. "internal-group-ids-add" and the "supis", c. "subscriber-categories" and the "supis" and d. "internal-Group-Ids" and the "internal-group-ids-add" query parameter represent mutually exclusive resource properties, i.e., if both query parameters are simultaneously present in the same request, the search will not match any resource. + +When the request query contains more than one optional query parameters defined as an array, the UDR shall return the Individual Influence Data resources for each matching combination of the values of the elements of the array of the provided query parameters. + +EXAMPLE: If "snssais" query parameter is included with two S-NSSAI entries (S-NSSAI\_1 and S-NSSAI\_2) and "dnns" is included with two DNN entries (e.g. DNN\_A and DNN\_B), and the other optional query parameters are not included, the UDR shall return the Individual Influence Data resources for each matching S-NSSAI and DNN combination (for all the possible values for supi and groupId), i.e., the resource(s) matching SNSSAI\_1 and DNN\_A, the resource(s) matching SNSSAI\_1 and DNN\_B, the resource(s) matching SNSSAI\_2 and DNN\_A, and the resource(s) matching SNSSAI\_2 and DNN\_B. + +To query for the Individual Influence Data resource(s) that apply to any UE, an entry of the "internal-Group-Ids" shall be set to "AnyUE". + +This method shall support the request data structures specified in table 6.2.5.3.1-2 and the response data structures and response codes specified in table 6.2.5.3.1-3. + +**Table 6.2.5.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.5.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------| +| array(TrafficInfluData) | M | 0..N | 200 OK | The Traffic Influence Data stored in the UDR are returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.6 Resource: Individual Influence Data + +### 6.2.6.1 Description + +The Individual Influence Data resource represents an Individual Traffic Influence Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.6.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/influenceData/{influenceId} + +This resource shall support the resource URI variables defined in table 6.2.6.2-1. + +**Table 6.2.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| influenceId | string | The Identifier of an Individual Influence Data to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. | + +### 6.2.6.3 Resource Standard Methods + +#### 6.2.6.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.6.3.1-1. + +**Table 6.2.6.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.6.3.1-2 and the response data structures and response codes specified in table 6.2.6.3.1-3. + +**Table 6.2.6.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-----------------------------------------------------| +| TrafficInfluData | M | 1 | The Traffic Influence Data to be stored in the UDR. | + +**Table 6.2.6.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| TrafficInfluData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| TrafficInfluData | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| NOTE: 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. | | | | | + +**Table 6.2.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}/nudr-dr//application-data/influenceData/{influenceId} | + +## 6.2.6.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.6.3.2-1. + +**Table 6.2.6.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.6.3.2-2 and the response data structures and response codes specified in table 6.2.6.3.2-3. + +**Table 6.2.6.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------------------------------------| +| TrafficInfluDataPatch | M | 1 | The Traffic Influence Data to be updated in the UDR. | + +**Table 6.2.6.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| TrafficInfluData | M | 1 | 200 OK | The update of an Individual Traffic Influence Data resource is confirmed and a response body containing Traffic Influence Data shall be returned. | +| n/a | | | 204 No Content | The Individual Traffic Influence Data resource has been successfully updated. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.6.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.6.3.3-1. + +**Table 6.2.6.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.6.3.3-2 and the response data structures and response codes specified in table 6.2.6.3.3-3. + +**Table 6.2.6.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 6.2.6.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 Influence Data was deleted successfully. | +| NOTE: 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. | | | | | + +## 6.2.7 Resource: Influence Data Subscription + +### 6.2.7.1 Description + +The Influence Data Subscription resource represents all Influence Data subscriptions to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.7.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/influenceData/subs-to-notify + +This resource shall support the resource URI variables defined in table 6.2.7.2-1. + +**Table 6.2.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.7.3 Resource Standard Methods + +#### 6.2.7.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.7.3.1-1. + +**Table 6.2.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.2.7.3.1-2 and the response data structures and response codes specified in table 6.2.7.3.1-3. + +**Table 6.2.7.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|------------------------------------------------------------------| +| TrafficInfluSub | M | 1 | Parameters to register a subscription to Traffic Influence Data. | + +**Table 6.2.7.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------| +| TrafficInfluSub | M | 1 | 201 Created | The subscription was created successfully. | +| 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. | | | | | + +**Table 6.2.7.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}/nudr-dr//application-data/influenceData/subs-to-notify/{subscriptionId} | + +### 6.2.7.3.2 GET + +This method shall support the URI query parameters specified in table 6.2.7.3.2-1. + +**Table 6.2.7.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|---|-------------|----------------------------------------------------------------------------------------------| +| dnn | Dnn | O | 0..1 | Identifies a DNN. (NOTE 1) | +| snssai | Snssai | O | 0..1 | Identifies a slice. (NOTE 1) | +| internal-Group-Id (NOTE 3) | GroupId | O | 0..1 | Identifies a group of users. (NOTE 1) (NOTE 2) (NOTE 4) | +| internal-group-ids | array(GroupId) | O | 1..N | Identifies a group of users that belong to all the listed internal groups. (NOTE 1) (NOTE 4) | +| subscriber-categories | array(string) | O | 1..N | Identifies a list of subscriber category. | +| supi | Supi | O | 0..1 | Identifies a user. | +| NOTE 1: At least one of "dnn", "snssai" or "internal-Group-Id" or "internal-group-ids"(may be included when FinerGranUEs feature is supported) shall be provided. | | | | | +| NOTE 2: For the Traffic Influence Data applies to any UE, the "internal-Group-Id" sets to "AnyUE". | | | | | +| NOTE 3: The query parameter does not follow the related naming convention (i.e. "lower-with-hyphen") defined in clause 5.1.3.3 of 3GPP TS 29.501 [7]. This query parameter is however kept as currently defined in this specification for backward compatibility considerations. | | | | | +| NOTE 3: Attributes "internal-Group-Id" and "internal-group-ids" are mutually exclusive attributes. | | | | | + +This method shall support the request data structures specified in table 6.2.7.3.2-2 and the response data structures and response codes specified in table 6.2.7.3.2-3. + +**Table 6.2.7.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.7.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------| +| array(TrafficInfluSub) | M | 0..N | 200 OK | The subscription information as request in the request URI query parameter(s) are returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.8 Resource: Individual Influence Data Subscription + +### 6.2.8.1 Description + +The Individual Influence Data Subscription resource represents a single Influence Data subscription to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.8.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/influenceData/subs-to-notify/{subscriptionId} + +This resource shall support the resource URI variables defined in table 6.2.8.2-1. + +**Table 6.2.8.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| subscriptionId | string | Identifies an Individual Influence Data Subscription resource. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. | + +### 6.2.8.3 Resource Standard Methods + +#### 6.2.8.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.8.3.1-1. + +**Table 6.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 6.2.8.3.1-2 and the response data structures and response codes specified in table 6.2.8.3.1-3. + +**Table 6.2.8.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.8.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|---|-------------|----------------|-------------------------------------------| +| TrafficInfluSub | M | 1 | 200 OK | The subscription information is returned. | + +#### 6.2.8.3.2 PUT + +This method shall support the URI query parameters specified in table 6.2.8.3.2-1. + +**Table 6.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 6.2.8.3.2-2 and the response data structures and response codes specified in table 6.2.8.3.2-3. + +**Table 6.2.8.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|------------------------------------------------------------| +| TrafficInfluSub | M | 1 | Modify an existing subscription to Traffic Influence Data. | + +**Table 6.2.8.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------|----------------------------------------------------------------------------------------------------------------------|-------------|----------------|-------------------------------------------------| +| TrafficInfluSub | M | 1 | 200 OK | The subscription was updated successfully. | +| n/a | | | 204 No Content | The subscription has been successfully updated. | +| NOTE: | 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. | | | | + +### 6.2.8.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.8.3.3-1. + +**Table 6.2.8.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.8.3.3-2 and the response data structures and response codes specified in table 6.2.8.3.3-3. + +**Table 6.2.8.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.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 | The subscription was terminated successfully. | +| NOTE: | 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. | | | | + +## 6.2.9 Resource: Applied BDT Policy Data + +### 6.2.9.1 Description + +The Applied BDT Policy Data resource represents an applied BDT Policy Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.9.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/bdtPolicyData + +This resource shall support the resource URI variables defined in table 6.2.9.2-1. + +**Table 6.2.9.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +## 6.2.9.3 Resource Standard Methods + +### 6.2.9.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.9.3.1-1. + +**Table 6.2.9.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| bdtpolicy-ids | array(string) | O | 1..N | Each element identifies a bdtPolicyId, i.e., an identifier of an Individual BDT Policy Data resource. The UDR shall return an Individual Applied BDT Policy Data resource for each matched bdtPolicyId. | +| internal-group-ids | array(GroupId) | O | 1..N | Each element identifies a group of users. The UDR shall return only Individual Applied BDT Policy Data resource(s) that match one of the provided internal group ID(s). | +| supis | array(Supi) | O | 1..N | Each element identifies a user. The UDR shall return only Individual Applied BDT Policy Data resource(s) that match one of the provided SUPI(s). | + +NOTE: The "internal-group-ids" and the "supis" query parameters represent mutually exclusive resource properties, i.e., if both query parameters are simultaneously present in the same request, the search will not match any resource. + +When the request contains the "bdtpolicy-ids" and the "internal-group-ids" or "supis" query parameters, the UDR shall return the resource(s) that match any combination of the values of the "bdtpolicy-ids" and the "internal-group-ids" or "supis" arrays. + +EXAMPLE: If "bdtpolicy-ids" query parameter is included with two bdtPolicyId entries (bdtPolicyId\_1 and bdtPolicyId\_2) and "supis" is included with two SUPI entries (e.g. SUPI\_A and SUPI\_B), the UDR shall return the Individual BDT Policy Data resource(s) for each matching bdtPolicyId and SUPI combination i.e., the resource(s) matching bdtPolicyId\_1 and SUPI\_A or SUPI\_B, and the resource(s) matching bdtPolicyId\_2 and SUPI\_A or SUPI\_B (note that other combinations are not possible). + +This method shall support the request data structures specified in table 6.2.9.3.1-2 and the response data structures and response codes specified in table 6.2.9.3.1-3. + +**Table 6.2.9.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.9.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------| +| array(BdtPolicyData) | M | 0..N | 200 OK | The applied BDT Policy Data stored in the UDR are returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.10 Resource: Individual Applied BDT Policy Data + +### 6.2.10.1 Description + +The Individual Applied BDT Policy Data resource represents an Individual Applied BDT Policy Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.10.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/bdtPolicyData/{bdtPolicyId} + +This resource shall support the resource URI variables defined in table 6.2.10.2-1. + +**Table 6.2.10.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| bdtPolicyId | string | The Identifier of an Individual BDT Policy Data to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. | + +### 6.2.10.3 Resource Standard Methods + +#### 6.2.10.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.10.3.1-1. + +**Table 6.2.10.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.10.3.1-2 and the response data structures and response codes specified in table 6.2.10.3.1-3. + +**Table 6.2.10.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|------------------------------------------------------| +| BdtPolicyData | M | 1 | The applied BDT Policy Data to be stored in the UDR. | + +**Table 6.2.10.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| BdtPolicyData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| NOTE: 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. | | | | | + +**Table 6.2.10.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}/nudr-dr//application-data/bdtPolicyData/{bdtPolicyId} | + +### 6.2.10.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.10.3.2-1. + +**Table 6.2.10.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.10.3.2-2 and the response data structures and response codes specified in table 6.2.10.3.2-3. + +**Table 6.2.10.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-------------------------------------------------------| +| BdtPolicyDataPatch | M | 1 | The applied BDT Policy Data to be updated in the UDR. | + +**Table 6.2.10.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------| +| BdtPolicyData | M | 1 | 200 OK | The update of an applied BDT Policy Data resource is confirmed and a response body containing applied BDT Policy Data shall be returned. | +| n/a | | | 204 No Content | The update of an applied BDT Policy Data resource is confirmed. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 6.2.10.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.10.3.3-1. + +**Table 6.2.10.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.10.3.3-2 and the response data structures and response codes specified in table 6.2.10.3.3-3. + +**Table 6.2.10.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.10.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 Applied BDT Policy Data was deleted successfully. | +| NOTE: 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. | | | | | + +## 6.2.11 Resource: IPTV Configurations + +### 6.2.11.1 Description + +This resource allows the NF service consumer to read all active IPTV Configurations applicable for given configuration identifier(s), DNN(s) and/or S-NSSAI(s), SUPI(s) or Internal Group Identifier(s) stored at the UDR. + +### 6.2.11.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/iptvConfigData + +This resource shall support the resource URI variables defined in table 6.2.11.2-1. + +**Table 6.2.11.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.11.3 Resource Standard Methods + +#### 6.2.11.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.11.3.1-1. + +**Table 6.2.11.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------------|----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| config-ids | array(string) | O | 1..N | Each element identifies a configurationId, i.e. an Individual IPTV Configuration resource. The UDR shall return an Individual IPTV Configuration resource for each matched configurationId. | +| dnns | array(Dnn) | O | 1..N | Each element identifies a DNN. The UDR shall return only Individual IPTV Configuration resource(s) that match one of the provided DNN(s). | +| snssais | array(SNSSAI) | O | 1..N | Each element identifies a slice. The UDR shall return only Individual IPTV Configuration resource(s) that match one of the provided S-NSSAI(s). | +| supis | array(SUPI) | O | 1..N | Each element identifies a SUPI. The UDR shall return only Individual IPTV Configuration resource(s) that match one of the provided SUPI(s). | +| inter-group-ids | array(GroupId) | O | 1..N | Each element identifies a group of users. The UDR shall return only Individual IPTV Configuration resource(s) that match one of the provided internal group ID(s). | + +NOTE: At least one of the above attributes shall be provided. + +NOTE: The "inter-group-ids" and the "supis" query parameters represent mutually exclusive resource properties, i.e., if both query parameters are simultaneously present in the same request, the search will not match any resource. + +When the request query contains more than one optional query parameters defined as an array, the UDR shall return the Individual IPTV Configuration resources for each matching combination of the values of the provided query parameters. + +EXAMPLE: If "snssais" query parameter is included with two S-NSSAI entries (S-NSSAI\_1 and S-NSSAI\_2) and "dnns" is included with two DNN entries (e.g. DNN\_A and DNN\_B), and the other optional query parameters are not included, the UDR shall return IPTV Configuration resources for each matching (for all the possible values for supi, and groupId), i.e. the resource(s) matching SNSSAI\_1 and DNN\_A, the resource(s) matching SNSSAI\_1 and DNN\_B, the resource(s) matching SNSSAI\_2 and DNN\_A, and the resources matching SNSSAI\_2 and DNN\_B. + +This method shall support the request data structures specified in table 6.2.11.3.1-2 and the response data structures and response codes specified in table 6.2.11.3.1-3. + +**Table 6.2.11.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.11.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|----------------|-------------------------------------------------------------| +| array(IptvConfigData) | M | 0..N | 200 OK | The IPTV configuration data stored in the UDR are returned. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +## 6.2.12 Resource: Individual IPTV Configuration + +### 6.2.12.1 Description + +The resource allows the NF service consumer to create an Individual IPTV configuration Data, modify or delete an existing Individual IPTV configuration Data. + +### 6.2.12.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/iptvConfigData/{configurationId} + +This resource shall support the resource URI variables defined in table 6.2.12.2-1. + +**Table 6.2.12.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| configurationId | string | The Identifier of an Individual IPTV Configuration to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. | + +### 6.2.12.3 Resource Standard Methods + +#### 6.2.12.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.12.3.1-1. + +**Table 6.2.12.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.12.3.1-2 and the response data structures and response codes specified in table 6.2.12.3.1-3. + +**Table 6.2.12.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|------------------------------------------------------| +| IptvConfigData | M | 1 | The IPTV configuration data to be stored in the UDR. | + +**Table 6.2.12.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| IptvConfigData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| IptvConfigData | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| NOTE: 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. | | | | | + +**Table 6.2.12.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}/nudr-dr//application-data/iptvConfigData/{configurationId} | + +### 6.2.12.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.12.3.2-1. + +**Table 6.2.12.3.2-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.12.3.2-2 and the response data structures and response codes specified in table 6.2.12.3.2-3. + +**Table 6.2.12.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.12.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 resource was deleted successfully. | +| NOTE: 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. | | | | | + +### 6.2.12.3.3 PATCH + +This method shall support the URI query parameters specified in table 6.2.12.3.3-1. + +**Table 6.2.12.3.3-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.12.3.3-2 and the response data structures and response codes specified in table 6.2.12.3.3-3. + +**Table 6.2.12.3.3-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|---------------------------------------------------------------| +| iptvConfigDataPatch | M | 1 | The IPTV configuration related data to be updated in the UDR. | + +**Table 6.2.12.3.3-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------| +| iptvConfigData | M | 1 | 200 OK | The resource has been successfully updated. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.13 Resource: ApplicationDataSubscriptions + +### 6.2.13.1 Description + +This resource is used to represent subscriptions to notification of application data modification, e.g. PFD data change, IPTV configuration data change, BDT policy data change, but not for Traffic Influence Data. + +### 6.2.13.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/subs-to-notify + +This resource shall support the resource URI variables defined in table 6.2.13.2-1. + +**Table 6.2.13.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.13.3 Resource Standard Methods + +#### 6.2.13.3.1 POST + +This method shall support the URI query parameters specified in table 6.2.13.3.1-1. + +**Table 6.2.13.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.13.3.1-2 and the response data structures and response codes specified in table 6.2.13.3.1-3. + +**Table 6.2.13.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-------------------------------------------------------------------------------| +| ApplicationDataSubs | M | 1 | Identifies the subscription to notification of application data modification. | + +**Table 6.2.13.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ApplicationDataSubs | M | 1 | 201 Created | Upon success, a response body containing a representation of each Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created 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 [4] also apply. | | | | | + +**Table 6.2.13.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}/nudr-dr//application-data/subs-to-notify/{subsId} | + +### 6.2.13.3.2 GET + +This method shall support the URI query parameters specified in table 6.2.13.3.2-1. + +**Table 6.2.13.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| data-filter | DataFilter | O | 0..1 | Indicate the data filter (e.g. dnn) for the query. When present, the UDR shall return the IndividualApplicationDataSubscription resource(s) for which the indicated information in the "data-filter" query parameter matches an entry of the "dataFilters" property of the resource (i.e. within the resource representation in the ApplicationDataSubs data structure). If the values of the "dataFilters" entry match the values provided in the "data-filter" query parameter, then the entry is considered to be a match even if it contains further attributes, for which no value was provided in the "data-filter" query parameter. | + +This method shall support the request data structures specified in table 6.2.13.3.2-2 and the response data structures and response codes specified in table 6.2.13.3.2-3. + +**Table 6.2.13.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.13.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------| +| array(ApplicationDataSubs) | M | 0..N | 200 OK | The subscription information as requested in the request URI query parameter(s) are returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.14 Resource: IndividualApplicationDataSubscription + +### 6.2.14.1 Description + +This resource is used to represent an individual subscription to notification of application data modification. + +### 6.2.14.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/application-data/subs-to-notify/{subsId} + +This resource shall support the resource URI variables defined in table 6.2.14.2-1. + +**Table 6.2.14.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| subsId | string | The subsId identifies an individual application data subscription to notifications. The value is allocated by the UDR during creation of the ApplicationDataSubscriptions resource. | + +### 6.2.14.3 Resource Standard Methods + +#### 6.2.14.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.14.3.1-1. + +**Table 6.2.14.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.2.14.3.1-2 and the response data structures and response codes specified in table 6.2.14.3.1-3. + +**Table 6.2.14.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|----------------------------------------------------------------------------| +| ApplicationDataSubs | M | 1 | Updates the subscription to notification of application data modification. | + +**Table 6.2.14.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------------------------------------| +| ApplicationDataSubs | M | 1 | 200 OK | The individual subscription resource was updated successfully. | +| n/a | | | 204 No Content | The individual subscription resource was updated successfully and no additional content is to be sent in the response message. | +| NOTE: 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. | | | | | + +#### 6.2.14.3.2 DELETE + +This method shall support the URI query parameters specified in table 6.2.14.3.2-1. + +**Table 6.2.14.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.2.14.3.2-2 and the response data structures and response codes specified in table 6.2.14.3.2-3. + +**Table 6.2.14.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 6.2.14.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 | Upon success, an empty response body shall be returned. | +| NOTE: 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. | | | | | + +### 6.2.14.3.3 GET + +This method shall support the URI query parameters specified in table 6.2.14.3.3-1. + +**Table 6.2.14.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 6.2.14.3.3-2 and the response data structures and response codes specified in table 6.2.14.3.3-3. + +**Table 6.2.14.3.3-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.14.3.3-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|----------------|-------------------------------------------| +| ApplicationDataSubs | M | 1 | 200 OK | The subscription information is returned. | + +## 6.2.15 Resource: Service Parameter Data + +### 6.2.15.1 Description + +The Service Parameter Data resource represents a Service Parameter Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.15.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr/{apiVersion}/application-data/serviceParamData + +This resource shall support the resource URI variables defined in table 6.2.15.2-1. + +**Table 6.2.15.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.15.3 Resource Standard Methods + +#### 6.2.15.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.15.3.1-1. + +**Table 6.2.15.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|--------------------|---------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| service-param-ids | array(string) | O | 1..N | Each element identifies a serviceParamId, i.e., an Individual Service Parameter Data. The UDR shall return an Individual Service Parameter Data resource for each matched serviceParamId. | | +| dnns | array(Dnn) | O | 1..N | Each element identifies a DNN. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided DNNs. | | +| snssais | array(Snssai) | O | 1..N | Each element identifies a slice. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided S-NSSAIs. | | +| internal-group-ids | array(GroupId) | O | 1..N | Each element identifies a group of users. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided internal group IDs. | | +| supis | array(Supi) | O | 1..N | Each element identifies a user. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided SUPIs. | | +| ue-ipv4s | array(Ipv4Addr) | O | 1..N | Each element identifies a user. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided IPv4 addresses. | | +| ue-ipv6s | array(Ipv6Addr) | O | 1..N | Each element identifies a user. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided IPv6 addresses. | | +| ue-macs | array(MacAddr48) | O | 1..N | Each element identifies a user. The UDR shall return only Individual Service Parameter Data resource(s) that match one of the provided UE MAC addresses. | | +| any-ue | boolean | O | 0..1 | Indicates whether the request is for any UE:
- "true": the request is for any UE;
- "false"(default): the request is not for any UE.
The UDR shall return only Individual Service Parameter Data resource(s) that match the any UE indication. | FilterAnyUE | +| roam-ue-net-descs | array(NetworkDescription) | O | 1..N | Each element identifies one or more PLMNs for the roaming UE. The UDR shall return only Service Parameter Data resource(s) that match at least one of the provided PLMN as described in the NetworkDescription data type. | VPLMNSpecificURSP | +| supp-feat | SupportedFeatures | O | 0..1 | Identifies the features supported by the NF service consumer. | | + +NOTE 1: At least one of the "service-param-ids", "dnns", "snssais", "internal-group-ids", "supis", "ue-ipv4s", "ue-ipv6s" or "ue-macs", and if the feature FilterAnyUE is supported, or "any-ue", and if the feature VPLMNSpecificURSP is supported, or "roam-ue-net-descs" query parameters shall be provided. + +NOTE: The "any-ue" query parameter is commonly related to the search of the service parameter data resource(s) that relate to any UE using the service identified by a combination of DNN and S-NSSAI, and thus, it is commonly present together with the "dnns" and "snssais" query parameters. Note that, if the "any-ue" query parameter is present together with the "internal-group-ids", "supis", "ue-ipv4s", "ue-ipv6s" and/or "ue-macs" query parameters the search will not match any resource, since according to clause 6.4.2.15 only one of the the "supi", "anyUeInd", "interGroupId", "ueIpv4", "ueIpv6" or "ueMac" properties are simultaneously present in the resource. + +When the request query contains more than one optional query parameters defined as an array, the UDR shall return the Service Parameter Data resources for each matching combination of the values of the elements of the array of the provided query parameters. + +EXAMPLE: If "snssais" query parameter is included with two S-NSSAI entries (S-NSSAI\_1 and S-NSSAI\_2) and "dnns" is included with two DNN entries (e.g. DNN\_A and DNN\_B), and the other optional query parameters are not included, the UDR shall return the Individual Service Parameter Data resources for each matching S-NSSAI and DNN, i.e., the resource(s) matching SNSSAI\_1 and DNN\_A, the resource(s) matching SNSSAI\_1 and DNN\_B, the resource(s) matching SNSSAI\_2 and DNN\_A, and the resources matching SNSSAI\_2 and DNN\_B. + +This method shall support the request data structures specified in table 6.2.15.3.1-2 and the response data structures and response codes specified in table 6.2.15.3.1-3. + +**Table 6.2.15.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.15.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------| +| array(ServiceParameterData) | M | 0..N | 200 OK | The Service Parameter Data stored in the UDR are returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.16 Resource: Individual Service Parameter Data + +### 6.2.16.1 Description + +The Individual Service Parameter Data resource represents an Individual Service Parameter Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.16.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/serviceParamData/{serviceParamId} + +This resource shall support the resource URI variables defined in table 6.2.16.2-1. + +**Table 6.2.16.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| serviceParamId | string | The Identifier of an Individual Service Parameter Data to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. | + +## 6.2.16.3 Resource Standard Methods + +### 6.2.16.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.16.3.1-1. + +**Table 6.2.16.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.16.3.1-2 and the response data structures and response codes specified in table 6.2.16.3.1-3. + +**Table 6.2.16.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|-----------------------------------------------------| +| ServiceParameterData | M | 1 | The Service Parameter Data to be stored in the UDR. | + +**Table 6.2.16.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| ServiceParameterData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| ServiceParameterData | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | + +NOTE: 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. + +**Table 6.2.16.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}/nudr-dr//application-data/serviceParamData/{serviceParamId} | + +### 6.2.16.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.16.3.2-1. + +**Table 6.2.16.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.6.3.2-2 and the response data structures and response codes specified in table 6.2.6.3.2-3. + +**Table 6.2.16.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|------------------------------------------------------| +| ServiceParameterData Patch | M | 1 | The Service Parameter Data to be updated in the UDR. | + +**Table 6.2.16.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| ServiceParameter Data | M | 1 | 200 OK | The update of an Individual Service Parameter Data resource is confirmed and a response body containing Service Parameter Data shall be returned. | +| n/a | | | 204 No Content | The Individual Service Parameter Data resource has been successfully updated. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 6.2.16.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.16.3.3-1. + +**Table 6.2.16.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.16.3.3-2 and the response data structures and response codes specified in table 6.2.16.3.3-3. + +**Table 6.2.16.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.16.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 Service Parameter Data was deleted successfully. | +| NOTE: 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. | | | | | + +## 6.2.17 Resource: AM Influence Data + +### 6.2.17.1 Description + +The AM Influence Data resource represents an AM Influence Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.17.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/am-influence-data + +This resource shall support the resource URI variables defined in table 6.2.17.2-1. + +**Table 6.2.17.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +## 6.2.17.3 Resource Standard Methods + +### 6.2.17.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.17.3.1-1. + +**Table 6.2.17.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| am-influence-ids | array(string) | O | 1..N | Each element identifies a amInfluenceId, i.e., an identifier of an Individual AM Influence Data resource. The UDR shall return an Individual AM Influence Data resource that matches one of provided amInfluenceId(s). | | +| dnns | array(Dnn) | O | 1..N | Each element identifies a DNN. The UDR shall return only AM Influence Data resource(s) that match at least one of the DNN(s) of the array. (NOTE 2) | | +| snssais | array(Snssai) | O | 1..N | Each element identifies a slice. The UDR shall return only AM Influence Data resource(s) that match at least one of the S-NSSAI(s) of the array. (NOTE 2) | | +| dnn-snssai-infos | array(DnnSnssaiInformation) | O | 1..N | Each element identifies a combination of (DNN, S-NSSAI). The UDR shall return only AM Influence Data resource(s) that match at least one of the SNSSAI and DNN combination(s) of the array. (NOTE 2) | | +| internal-group-ids | array(GroupId) | O | 1..N | Each element identifies a group of users. The UDR shall return only AM Influence Data resource(s) that match one of the provided GroupId(s). | | +| supis | array(Supi) | O | 1..N | Each element identifies a user. The UDR shall return only AM Influence Data resource(s) that match one of the provided SUPI(s). | | +| any-ue | boolean | O | 0..1 | Indicates whether the request is for any non-roaming UE:
- "true": the request is for any non-roaming UE;
- "false"(default): the request is not for any non-roaming UE.
The UDR shall return only AM Influence Data resource(s) that contain the Any UE indication. | | +| roam-ue-plmn-ids | array(PlmnId) | O | 1..N | Each element identifies a PLMN ID for the roaming UE in LBO roaming scenario. The UDR shall return only AM Influence Data resource(s) that match at least one of the provided PLMN ID. | DCAMP_Roaming_LBO | +| supp-feat | SupportedFeatures | O | 0..1 | Identifies the features supported by the NF service consumer. | | +| NOTE 1: At least one of the query parameters other than the "supp-feat" query parameter shall be provided. | | | | | | +| NOTE 2: Only one of the "dnns", "snssais" or "dnn-snssai-infos" attributes may be simultaneously provided. | | | | | | + +NOTE: The "any-ue" query parameter is commonly related to the search of the AM influence data resource(s) that relate to any non-roaming UE using the service(s) identified by a combination of DNN and S-NSSAI, and thus, it is commonly present together with the "dnn-snssai-infos" query parameters. Note also that, if the "any-ue" query parameter is present together with the "internal-group-ids", and/or "supis" query parameters the search will not match any resource, since according to clause 6.4.2.16 only one of the the "supi", "anyUeInd" and "interGroupId" properties are simultaneously present in the resource. + +When the request query contains more than one optional query parameters defined as an array, the UDR shall return the Individual AM Influence Data resources for each matching combination of the values of the elements of the array of the provided query parameters. + +EXAMPLE 1: If the "dnn-snssai-infos" query parameter is included with two DNN and S-NSSAI combinations (comb\_1 and comb\_2) and the "supis" query parameter is included with two SUPI entries (e.g. SUPI\_A and SUPI\_B), and all of them are matching entries, the UDR shall return the Individual AM Influence Data resources for each matching S-NSSAI and DNN and SUPI combination, i.e. the resource(s) matching comb\_1 and SUPI\_A, comb\_2 and SUPI\_A, comb\_1 and SUPI\_B, and comb2 and SUPI\_B. + +EXAMPLE 2: If the "dnn-snssai-infos" query parameter is included with two DNN and S-NSSAI combination (comb\_1 and comb\_2) and the "supis" query parameter is included with two SUPI entries (e.g. SUPI\_A and SUPI\_B), and there are no matching entries for comb\_1, the UDR shall return the Individual AM Influence Data resources for the matching S-NSSAI and DNN and SUPI combination, i.e., the resource(s) matching comb\_2 and SUPI\_A, and comb2 and SUPI\_B. + +This method shall support the request data structures specified in table 6.2.17.3.1-2 and the response data structures and response codes specified in table 6.2.17.3.1-3. + +**Table 6.2.17.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.17.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|----------------------------------------------------------------------------------------------------------------------|-------------|----------------|-------------------------------------------------------| +| array(AmInfluData) | M | 0..N | 200 OK | The AM Influence Data stored in the UDR are returned. | +| NOTE: | The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | + +## 6.2.18 Resource: Individual AM Influence Data + +### 6.2.18.1 Description + +The Individual AM Influence Data resource represents an Individual AM Influence Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.18.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/am-influence-data/{amInfluenceId} + +This resource shall support the resource URI variables defined in table 6.2.18.2-1. + +**Table 6.2.18.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| amInfluenceId | string | The identifier of an Individual AM Influence Data to be created or updated. To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5]. | + +## 6.2.18.3 Resource Standard Methods + +### 6.2.18.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.18.3.1-1. + +**Table 6.2.18.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.18.3.1-2 and the response data structures and response codes specified in table 6.2.18.3.1-3. + +**Table 6.2.18.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|------------------------------------------------| +| AmInfluData | M | 1 | The AM Influence Data to be stored in the UDR. | + +**Table 6.2.18.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| AmInfluData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| AmInfluData | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| NOTE: 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. | | | | | + +**Table 6.2.18.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}/nudr-dr//application-data/am-influence-data/{amInfluenceId} | + +### 6.2.18.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.18.3.2-1. + +**Table 6.2.18.3.2-1: URI query parameters supported by the PATCH method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.18.3.2-2 and the response data structures and response codes specified in table 6.2.18.3.2-3. + +**Table 6.2.18.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|-------------------------------------------------| +| AmInfluDataPatch | M | 1 | The AM Influence Data to be updated in the UDR. | + +**Table 6.2.18.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| AmInfluData | M | 1 | 200 OK | The update of an Individual AM Influence Data resource is confirmed and a response body containing the AM Influence Data shall be returned. | +| n/a | | | 204 No Content | The Individual AM Influence Data resource has been successfully updated. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 6.2.18.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.18.3.3-1. + +**Table 6.2.18.3.3-1: URI query parameters supported by the DELETE method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.18.3.3-2 and the response data structures and response codes specified in table 6.2.18.3.3-3. + +**Table 6.2.18.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.18.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 AM Influence Data was deleted successfully. | +| NOTE: 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. | | | | | + +## 6.2.19 Resource: EAS Deployment Information Data + +### 6.2.19.1 Description + +The EAS Deployment Information Data resource represents all EAS Deployment Information Data to the Nudr\_DataRepository Service at a given UDR. + +### 6.2.19.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/eas-deploy-data + +This resource shall support the resource URI variables defined in table 6.2.19.2-1. + +**Table 6.2.19.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +## 6.2.19.3 Resource Standard Methods + +### 6.2.19.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.19.3.1-1. + +**Table 6.2.19.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------------|-----------|---|-------------|------------------------------| +| dnn | Dnn | O | 0..1 | Identifies a DNN. | +| snssai | Snssai | O | 0..1 | Identifies a slice. | +| internal-group-id | GroupId | O | 0..1 | Identifies a group of users. | +| appId
(NOTE 2) | string | O | 0..1 | Identifies an application. | + +NOTE 1: At least one of the above attributes shall be provided. +NOTE 2: The query parameter does not follow the related naming convention (i.e. "lower-with-hyphen") defined in clause 5.1.3.3 of 3GPP TS 29.501 [7]. This query parameter is however kept as currently defined in this specification for backward compatibility considerations. + +This method shall support the request data structures specified in table 6.2.19.3.1-2 and the response data structures and response codes specified in table 6.2.19.3.1-3. + +**Table 6.2.19.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.19.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------| +| array(EasDeployInfoData) | M | 1..N | 200 OK | The subscribed EAS Deployment information as request in the request URI query parameter(s) are returned. | + +NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +## 6.2.20 Resource: Individual EAS Deployment Information Data + +### 6.2.20.1 Description + +The Individual EAS Deployment Information Data resource represents a single EAS Deployment Information data resource in the Nudr\_DataRepository Service at a given UDR. + +### 6.2.20.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/eas-deploy-data/{easDeployInfoId} + +This resource shall support the resource URI variables defined in table 6.2.20.2-1. + +**Table 6.2.20.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| easDeployInfoId | string | Identifies an Individual EAS Deployment Information Data resource. | + +## 6.2.20.3 Resource Standard Methods + +### 6.2.20.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.20.3.1-1. + +**Table 6.2.20.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 6.2.20.3.1-2 and the response data structures and response codes specified in table 6.2.20.3.1-3. + +**Table 6.2.20.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.20.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|----------------|--------------------------------------| +| EasDeployInfoData | M | 1 | 200 OK | The EAS Deployment Data is returned. | + +### 6.2.20.3.2 PUT + +This method shall support the URI query parameters specified in table 6.2.20.3.1-1. + +**Table 6.2.20.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.20.3.1-2 and the response data structures and response codes specified in table 6.2.20.3.1-3. + +**Table 6.2.20.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------------------------| +| EasDeployInfoData | M | 1 | The EAS Deployment Information Data to be stored in the UDR. | + +**Table 6.2.20.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| EasDeployInfoData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| EasDeployInfoData | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| NOTE: 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. | | | | | + +**Table 6.2.20.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}/nudr-dr//application-data/eas-deploy-data/{easDeployInfoId} | + +### 6.2.20.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.20.3.3-1. + +**Table 6.2.20.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.20.3.3-2 and the response data structures and response codes specified in table 6.2.20.3.3-3. + +**Table 6.2.20.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.20.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 EAS Deployment Data was successfully deleted. | +| NOTE: 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. | | | | | + +## 6.2.21 Resource: AF Requested QoS Data Sets + +### 6.2.21.1 Description + +The AF Requested QoS Data Sets collection resource represents all AF Requested QoS Data Set(s) managed by the UDR. + +### 6.2.21.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/af-qos-data-sets + +This resource shall support the resource URI variables defined in table 6.2.21.2-1. + +**Table 6.2.21.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-----------------------------------------| +| apiRoot | string | See clause 6.1.1 of 3GPP TS 29.504 [6]. | + +## 6.2.21.3 Resource Standard Methods + +### 6.2.21.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.21.3.1-1. + +**Table 6.2.21.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| dnns | array(Dnn) | O | 1..N | Identifies the targeted DNN(s).

When this query parameter is provided, the UDR shall return only the resource(s) that match at least one of the provided DNN(s).

(NOTE 3) | +| snssais | array(Snssai) | O | 1..N | Identifies the targeted network slice(s).

When this query parameter is provided, the UDR shall return only the resource(s) that match at least one of the provided network slice(s).

(NOTE 3) | +| internal-group-ids | array(GroupId) | O | 1..N | Contains the targeted group(s) of UE(s).

When this query parameter is provided, the UDR shall return only the resource(s) that match at least one of the provided internal group ID(s).

(NOTE 2) | +| supis | array(Supi) | O | 1..N | Contains the identifier(s) of the targeted UE(s).

When this query parameter is provided, the UDR shall return only the resource(s) that match at least one of the provided SUPI(s).

(NOTE 2) | +| data-set-ids | array(string) | O | 1..N | Contains the identifier(s) of the requested Individual AF Requested QoS Data Set resource(s).

(NOTE 4) | +| supp-feat | SupportedFeatures | O | 0..1 | Identifies the features supported by the NF service consumer. | + +NOTE 1: At least one of the above query parameters, other than the "supp-feat" query parameter, shall be provided. +NOTE 2: These query parameters are mutually exclusive. Either one of them may be present. +NOTE 3: These query parameters are mutually exclusive. Either one of them may be present. +NOTE 4: When this query parameter is present, all the other query parameters shall not be present, except the "supp-feat" query parameter when needed. + +This method shall support the request data structures specified in table 6.2.21.3.1-2 and the response data structures and response codes specified in table 6.2.21.3.1-3. + +**Table 6.2.21.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.21.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------| +| array(AfRequestedQoS Data) | M | 0..N | 200 OK | Successful case. The requested Individual AF Requested QoS Data Set resource(s) are returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.22 Resource: Individual AF Requested QoS Data Set + +### 6.2.22.1 Description + +The Individual AF Requested QoS Data Set resource represents a single AF Requested QoS data Set managed by the UDR. + +### 6.2.22.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/af-qos-data-sets/{afReqQoSId} + +This resource shall support the resource URI variables defined in table 6.2.22.2-1. + +**Table 6.2.22.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|----------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| afReqQoSId | string | Identifies an "Individual AF Requested QoS Data Set" resource. | + +### 6.2.22.3 Resource Standard Methods + +#### 6.2.22.3.1 PUT + +This method shall support the URI query parameters specified in table 6.2.22.3.1-1. + +**Table 6.2.22.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.22.3.1-2 and the response data structures and response codes specified in table 6.2.22.3.1-3. + +**Table 6.2.22.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|----------------------------------------------------------------| +| AfRequestedQoSData | M | 1 | Represents the AF Requested QoS Data to be created or updated. | + +**Table 6.2.22.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AfRequestedQoS Data | M | 1 | 201 Created | Successful case. The resource is successfully created and a response body is returned containing a representation of the created "Individual AF Requested QoS Data Set" resource. | +| AfRequestedQoS Data | M | 1 | 200 OK | Successful case. The resource is successfully updated and a response body is returned containing a representation of the updated "Individual AF Requested QoS Data Set" resource. | +| n/a | | | 204 No Content | Successful case. The resource has been successfully updated and no content is returned in the response body. | +| NOTE: 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. | | | | | + +**Table 6.2.22.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}/nudr-dr//application-data/af-qos-data-sets/{afReqQoSId} | + +## 6.2.22.3.2 PATCH + +This method shall support the URI query parameters specified in table 6.2.22.3.2-1. + +**Table 6.2.22.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.22.3.2-2 and the response data structures and response codes specified in table 6.2.22.3.2-3. + +**Table 6.2.22.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|-------------------------------------------------------------------------------------------| +| AfRequestedQoS DataPatch | M | 1 | Represents the requested modification to the targeted existing AF Requested QoS Data Set. | + +**Table 6.2.22.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AfRequestedQoS Data | M | 1 | 200 OK | Successful case. The "Individual AF Requested QoS Data Set" 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 "Individual AF Requested QoS Data" resource is successfully modified and no content is returned in the response body. | +| NOTE: The mandatory HTTP error status codes for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.22.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.22.3.3-1. + +**Table 6.2.22.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.22.3.3-2 and the response data structures and response codes specified in table 6.2.22.3.3-3. + +**Table 6.2.22.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.22.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 targeted "Individual AF Requested QoS Data Set" resource is successfully deleted. | +| NOTE: 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. | | | | | + +## 6.2.23 Resource: Individual DNAI EAS Mapping + +### 6.2.23.1 Description + +The resource represents the EAS address information for a DNAI. + +NOTE: This information is configured by the OAM. + +### 6.2.23.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/dnai-eas-mappings/{dnai} + +This resource shall support the resource URI variables defined in table 6.2.23.2-1. + +**Table 6.2.23.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|-------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1 | +| dnai | Dnai | The DNAI. | + +### 6.2.23.3 Resource Standard Methods + +#### 6.2.23.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.23.3.1-1. + +**Table 6.2.23.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|----------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer. | + +This method shall support the request data structures specified in table 6.2.23.3.1-2 and the response data structures and response codes specified in table 6.2.23.3.1-3. + +**Table 6.2.23.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.23.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------| +| DnaiEasMapping | M | 1 | 200 OK | Upon success, a response body containing the EAS information for the DNAI shall be returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.24 Resource: ECS Address Roaming Data + +### 6.2.24.1 Description + +The ECS Address Roaming Data resource represents all ECS Address Roaming Data in the Nudr\_DataRepository Service at a given UDR. + +### 6.2.24.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/ecs-address-roaming + +This resource shall support the resource URI variables defined in table 6.2.24.2-1. + +**Table 6.2.24.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 6.2.24.3 Resource Standard Methods + +#### 6.2.24.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.24.3.1-1. + +**Table 6.2.24.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|---------------------------------------------------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------| +| internal-group-id | GroupId | O | 0..1 | Identifies a group of users. | +| any-ue | boolean | O | 0..1 | Indicates that all UEs are targeted when included and set to "true", otherwise set to "false". Default value is "false" if omitted. | +| NOTE: At least one of the above attributes shall be provided. | | | | | + +This method shall support the request data structures specified in table 6.2.24.3.1-2 and the response data structures and response codes specified in table 6.2.24.3.1-3. + +**Table 6.2.24.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.24.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------| +| array(EcsAddrData) | M | 1..N | 200 OK | The ECS Address Data requested in the request URI query parameter(s) are returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 6.2.25 Resource: Individual ECS Address Roaming Data + +### 6.2.25.1 Description + +The Individual ECS Address Roaming Data resource represents a single ECS Address Roaming Data entry at the Nudr\_DataRepository Service at a given UDR. + +### 6.2.25.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//application-data/ecs-address-roaming/{ecsAddrInfoId} + +This resource shall support the resource URI variables defined in table 6.2.25.2-1. + +**Table 6.2.25.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------------|-----------|-------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| ecsAddrInfoId | string | Identifies an Individual ECS Address Roaming Data resource. | + +### 6.2.25.3 Resource Standard Methods + +#### 6.2.25.3.1 GET + +This method shall support the URI query parameters specified in table 6.2.25.3.1-1. + +**Table 6.2.25.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 6.2.25.3.1-2 and the response data structures and response codes specified in table 6.2.25.3.1-3. + +**Table 6.2.25.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.25.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------|---|-------------|----------------|----------------------------------------| +| EcsAddrData | M | 1 | 200 OK | The requested information is returned. | + +#### 6.2.25.3.2 PUT + +This method shall support the URI query parameters specified in table 6.2.25.3.1-1. + +**Table 6.2.25.3.1-1: URI query parameters supported by the PUT method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | n/a | + +This method shall support the request data structures specified in table 6.2.25.3.1-2 and the response data structures and response codes specified in table 6.2.25.3.1-3. + +**Table 6.2.25.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------|---|-------------|-------------------------------------------------------| +| EcsAddrData | M | 1 | The ECS Address Roaming Data to be stored in the UDR. | + +**Table 6.2.25.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------| +| EcsAddrData | M | 1 | 201 Created | The resource has been successfully created and a response body is returned containing a representation of the resource. | +| EcsAddrData | M | 1 | 200 OK | The resource has been successfully updated and a response body is returned containing a representation of the resource. | +| n/a | | | 204 No Content | The resource has been successfully updated. | +| NOTE: 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. | | | | | + +**Table 6.2.25.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}/nudr-dr//application-data/ecs-address-roaming/{ecsAddrInfoId} | + +### 6.2.25.3.3 DELETE + +This method shall support the URI query parameters specified in table 6.2.25.3.3-1. + +**Table 6.2.25.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.25.3.3-2 and the response data structures and response codes specified in table 6.2.25.3.3-3. + +**Table 6.2.25.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.2.25.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 data was successfully deleted. | +| NOTE: 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. | | | | | + +## 6.3 Notifications + +### 6.3.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +**Table 6.3.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------------|-------------------|---------------------------------|------------------------------------------------------------------------------------------------------------------| +| Influence Data Update Notification | {notificationUri} | POST | One of notification reference provided by the service consumer during the subscription of the AF Influence Data. | +| Application Data Change Notification | {notificationUri} | POST | Application Data Change Notification | + +### 6.3.2 Void + +### 6.3.3 Influence Data Update Notification + +#### 6.3.3.1 Description + +The Influence Update Notification is used by the UDR to report one or several observed Influence Data(s) to a NF service consumer that has subscribed to such Notifications. + +#### 6.3.3.2 Operation Definition + +The POST method shall be used for traffic influence data change notification and the URI shall be provided during the subscription procedure. + +Callback URI: {notificationUri} + +This method shall support the URI query parameters specified in table 6.3.3.2-1. + +**Table 6.3.3.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.3.3.2-2 and the response data structures and response codes specified in table 6.3.3.2-3. + +**Table 6.3.3.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| array(TrafficInfluData or TrafficInfluDataNotif) | M | 1..N | Provides Information about observed Influence Data. If the EnhancedInfluDataNotification feature is supported, the TrafficInfluDataNotif data type shall be sent. | + +**Table 6.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. | +| 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.3.4 Application Data Change Notification + +The POST method shall be used for application data change notification and the URI shall be provided during the subscription procedure. + +Callback URI: {notificationUri} + +This method shall support the URI query parameters specified in table 6.3.4-1. + +**Table 6.3.4-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +This method shall support the request data structures specified in table 6.3.4-2 and the response data structures and response codes specified in table 6.3.4-3. + +**Table 6.3.4-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|-----------------------------------|---|-------------|-------------------------------------------| +| array(ApplicationDataChangeNotif) | M | 1..N | Notification of application data changes. | + +**Table 6.3.4-3: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------| +| n/a | | | 204 No Content | The reception of the notification is acknowledged. | +| 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.4 Data Model + +### 6.4.1 General + +This clause specifies the application data model supported by the API. + +Table 6.4.1-1 specifies the data types defined for the Nudr\_DataRepository Service API for Application Data service based interface protocol. + +**Table 6.4.1-1: Nudr\_DataRepository specific Data Types for Application Data** + +| Data type | Section defined | Description | Applicability | +|----------------------------|------------------------|--------------------------------------------------------------------------------------------|--------------------------------| +| AfRequestedQoSData | 6.4.2.18 | Represents an AF Requested QoS Data Set. | GMEC | +| AfRequestedQoSDataPatch | 6.4.2.19 | Represents the requested modifications to an AF Requested QoS Data Set. | GMEC | +| AmInfluData | 6.4.2.16 | Contains AM influence data. | DCAMP | +| AmInfluDataPatch | 6.4.2.17 | Contains AM influence data that can be updated. | DCAMP | +| ApplicationDataSubs | 6.4.2.10 | Contains application data subscription data. | | +| ApplicationDataChangeNotif | 6.4.2.11 | Contains the new or updated application data or removed indication. | | +| BdtPolicyData | 6.4.2.7 | Contains applied BDT policy data. | EnhancedBackgroundDataTransfer | +| BdtPolicyDataPatch | 6.4.2.8 | Contains modification instructions to be performed on the applied BDT policy data. | EnhancedBackgroundDataTransfer | +| CorrelationType | 6.4.3.4 | Indicates that the EAS(es) corresponding to a common DNAI or common EAS should be selected | CommonEASDNAI | +| DataInd | 6.4.3.3 | Indicates the type of data. | | +| DataFilter | 6.4.2.12 | Indicates an application data filter. | | +| DnaiEasInfo | 6.4.2.22 | Contains EAS information for a DNAI. | DnaiEasMappings | +| DnaiEasMapping | 6.4.2.21 | Contains DNAI(s) to EAS mapping. | DnaiEasMappings | +| EcsAddrData | 6.4.2.23 | Represents ECS Address Configuration Data. | | +| IptvConfigData | 6.4.2.9 | Represents IPTV configuration data information. | | +| PfdDataForAppExt | 6.4.2.6 | The PFDs and related data for the application | | +| ServiceParameterData | 6.4.2.15 | Contains the service parameter data. | | +| TrafficCorrelationInfo | 6.4.2.18 | Contains the information for traffic correlation. | CommonEASDNAI | +| ServiceParameterDataPatch | 6.4.2.15A | Contains the service parameter data that can be updated. | | +| TrafficInfluData | 6.4.2.2 | Contains traffic influence data. | | +| TrafficInfluDataPatch | 6.4.2.3 | Contains modification instructions to be performed on the traffic influence data. | | +| TrafficInfluDataNotif | 6.4.2.14 | Contains traffic influence data for notification. | EnhancedInfluDataNotification | +| TrafficInfluSub | 6.4.2.4 | Contains traffic influence subscription data. | | + +**Editor's Note:** The feature to be used for EcsAddrData is FFS. + +Table 6.4.1-2 specifies data types re-used by the Nudr\_DataRepository Service API for Application Data 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 Nudr\_DataRepository Service API for Application Data service based interface. + +**Table 6.4.1-2: Nudr\_DataRepository re-used Data Types for Application Data** + +| Data type | Reference | Comments | Applicability | +|------------------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| A2xParamsPc5 | 3GPP TS 29.522 [19] | Contains the A2X service parameters data provisioned over PC5. | A2X | +| A2xParamsPc5Rm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the A2xParamsPc5 data type, but with the OpenAPI nullable property set to true. | A2X | +| AmInfluEvent | 3GPP TS 29.522 [19] | Identifies the type of AM related events of which the AF requests to be notified. | | +| AlternativeServiceRequirementsData | 3GPP TS 29.514 [52] | Contains alternative QoS related parameters and a reference to them. | GMEC | +| ApplicationId | 3GPP TS 29.571 [7] | Indicates an application identifier. | | +| BdtReferenceId | 3GPP TS 29.122 [9] | Identifies a selected policy of background data transfer. | EnhancedBackgroundDataTransfer | +| DateTime | 3GPP TS 29.571 [7] | Indicates a date and time. | | +| DateTimeRm | 3GPP TS 29.571 [7] | Indicates a date and time that can be updated. | | +| Dnai | 3GPP TS 29.571 [7] | Represents a DNAI. | DnaiEasMappings | +| DnaiChangeType | 3GPP TS 29.571 [7] | Describes the types of DNAI change. | | +| Dnn | 3GPP TS 29.571 [7] | Identifies a Data Network Name. (NOTE 2) | | +| DnnSnssaiInformation | 3GPP TS 29.522 [19] | Represents a DNN, S-NSSAI combination. | DCAMP | +| DurationSec | 3GPP TS 29.571 [7] | Represents a duration in seconds. | DCAMP | +| DurationSecRm | 3GPP TS 29.571 [7] | Represents a removable duration in seconds. | DCAMP | +| EasDeployInfoData | 3GPP TS 29.591 [23] | Represents the EAS Deployment Information. | EasDeployment | +| EcsServerAddr | 3GPP TS 29.571 [7] | Represents the Edge Configuration Server (ECS) address configuration information. | | +| EthFlowDescription | 3GPP TS 29.514 [16] | Contains the Ethernet data flow information. (NOTE) | | +| Event | 3GPP TS 29.522 [19] | Contains the outcome of the UE Policy Delivery related to the invocation of AF provisioned service parameters. | DeliveryOutcome | +| EventsSubscReqData | 3GPP TS 29.514 [16] | Identifies the events the application subscribes to. | GMEC | +| EventsSubscReqDataRm | 3GPP TS 29.514 [16] | This data type is defined in the same way as the EventsSubscReqData data type, but with the OpenAPI nullable property set to true. | GMEC | +| FlowInfo | 3GPP TS 29.122 [9] | Contains the flow information. | | +| FqdnPatternMatchingRule | 3GPP TS 29.571 [7] | Identifies an FQDN pattern matching rule. | DnaiEasMappings | +| GroupId | 3GPP TS 29.571 [7] | Identifies a group of users. | EasDeployment | +| IpAddr | 3GPP TS 29.571 [7] | IP address and/or prefix. | DnaiEasMappings | +| IptvConfigDataPatch | 3GPP TS 29.522 [19] | Contains the IPTV configuration data used for PATCH. | | +| Ipv4Addr | 3GPP TS 29.571 [7] | Identifies an IPv4 address. | | +| Ipv6Addr | 3GPP TS 29.571 [7] | Identifies an IPv6 address. | | +| Link | 3GPP TS 29.122 [9] | Identifies a referenced resource. | | +| MacAddr48 | 3GPP TS 29.571 [7] | MAC Address. | | +| MulticastAccessControl | 3GPP TS 29.522 [19] | Represents the multicast access control information. | | +| NetworkAreaInfo | 3GPP TS 29.554 [13] | Describes a network area information. | | +| NetworkDescription | 3GPP TS 29.522 [19] | Represents the description of a PLMN in terms of the PLMN ID, the MCC (and optionally, applicable MNCs) or the indication of any PLMN | VPLMNSpecificURSP | +| ParameterOverPc5 | 3GPP TS 29.522 [19] | Contains the V2X service parameters data provisioned over PC5. | | +| ParameterOverPc5Rm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParameterOverPc5 data type, but with the OpenAPI nullable property set to true. | | +| ParameterOverUu | 3GPP TS 29.522 [19] | Contains the V2X service parameters data provisioned over Uu. | | +| ParameterOverUuRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParameterOverUu data type, but with the OpenAPI nullable property set to true. | | +| ParamForProSeDc | 3GPP TS 29.522 [19] | Contains the service parameters for 5G ProSe direct communications. | ProSe | +| ParamForProSeDcRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParamForProSeDc data type, but with the | | + +| | | | | +|--|--|----------------------------------------|--| +| | | OpenAPI nullable property set to true. | | +|--|--|----------------------------------------|--| + +| | | | | +|-------------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| ParamForProSeDd | 3GPP TS 29.522 [19] | Contains the service parameters for 5G ProSe direct discovery. | ProSe | +| ParamForProSeDdRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParamForProSeDd data type, but with the OpenAPI nullable property set to true. | | +| ParamForProSeEndUe | 3GPP TS 29.522 [19] | Contains the service parameters for 5G ProSe End UE. | ProSe_Ph2 | +| ParamForProSeEndUeRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParamForProSeEndUe data type, but with the OpenAPI nullable property set to true. | ProSe_Ph2 | +| ParamForProSeRemUe | 3GPP TS 29.522 [19] | Contains the service parameters for 5G ProSe remote UE. | ProSe | +| ParamForProSeRemUeRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParamForProSeRemUe data type, but with the OpenAPI nullable property set to true. | | +| ParamForProSeU2NRelUe | 3GPP TS 29.522 [19] | Contains the service parameters for 5G ProSe UE-to-network relay UE. | ProSe | +| ParamForProSeU2NRelUeRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParamForProSeU2NRelUe data type, but with the OpenAPI nullable property set to true. | | +| ParamForProSeU2URelUe | 3GPP TS 29.522 [19] | Contains the service parameters for 5G ProSe UE-to-UE Relay UE. | ProSe_Ph2 | +| ParamForProSeU2URelUeRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the ParamForProSeU2URelUe data type, but with the OpenAPI nullable property set to true. | ProSe_Ph2 | +| PfdChangeNotification | 3GPP TS 29.551 [8] | Describes the PFD change. | | +| PfdContent | 3GPP TS 29.551 [8] | Represents the content of a PFD for an application identifier. | | +| PlmnId | 3GPP TS 29.571 [7] | Identifies a PLMN. | DCAMP_Roaming_LBO | +| RouteToLocation | 3GPP TS 29.571 [7] | Identifies the N6 traffic routing requirement. | | +| ServiceAreaCoverageInfo | 3GPP TS 29.534 [22] | Contains service area coverage information. | DCAMP | +| Snssai | 3GPP TS 29.571 [7] | Identifies a Single Network Slice Selection Assistance Information. | | +| SpatialValidityCond | 3GPP TS 29.571 [7] | Indicates the spatial validity condition. | | +| SubscribedEvent | 3GPP TS 29.522 [19] | Identified the type of UP path management events of which the AF requests to be notified. | | +| Supi | 3GPP TS 29.571 [7] | Identifies a SUPI that shall contain either an IMSI or an NAI. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features. | | +| TemporalInValidity | 3GPP TS 29.565 [27] | Indicates the time interval during which the NF service consumer request shall not to be applied | GMEC | +| TemporalValidity | 3GPP TS 29.514 [16] | Indicates the time interval during which the AF request is to be applied. | MultiTemporalCondition | +| TnapId | 3GPP TS 29.571 [7] | Trusted Network Access Point identifier. | AfGuideTNAPs | +| Uinteger | 3GPP TS 29.571 [7] | Unsigned Integer, i.e. only value 0 and integers greater than 0 are allowed. | | +| UintegerRm | 3GPP TS 29.571 [7] | This data type is defined in the same way as the "Uinteger" data type, but with the OpenAPI "nullable: true" property. | | +| Uri | 3GPP TS 29.571 [7] | Identifies a URI. | | +| UriRm | 3GPP TS 29.571 [7] | Identifies a removable URI. | DCAMP | +| UrspRuleRequest | 3GPP TS 29.522 [19] | Contains service parameter data used to guide the URSP. | AfGuideURSP | +| ParamForRangingSIPos | 3GPP TS 29.522 [19] | Contains the service parameters for ranging and sidelink positioning. | Ranging_SL | +| ParamForRangingSIPosRm | 3GPP TS 29.522 [19] | This data type is defined in the same way as the "ParamForRangingSIPos" data type, but | Ranging_SL | + +| | | | | +|---------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------|--| +| | | with the OpenAPI "nullable: true" property. | | +| NOTE 1: | In order to support a set of MAC addresses with a specific range in the traffic filter, feature MacAddressRange as specified in clause 6.1.8 of TS 29.504 [6] shall be supported. | | | +| NOTE 2: | The UDR uses the DNN as received from the NF service consumer 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. | | | + +**Editor's Note:** The feature to be used for EccServerAddr, Link, and SpatialValidityCondition is FFS. + +## 6.4.2 Structured data types + +### 6.4.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 6.4.2.2 Type TrafficInfluData + +**Table 6.4.2.2-1: Definition of type TrafficInfluData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| upPathChgNotifCorrId | string | C | 0..1 | Contains the Notification Correlation Id allocated by the NEF for the UP path change notification. It shall be included when the NEF requests the UP path change notification. | | +| appReloInd | boolean | O | 0..1 | Identifies whether an application can be relocated once a location of the application has been selected.
True: the application cannot be relocated;
False (default): the application can be relocated. | | +| afAppId | string | O | 0..1 | Identifies an application. (NOTE 1) (NOTE 3) | | +| dnn | Dnn | O | 0..1 | Identifies a DNN | | +| ethTrafficFilters | array(EthFlowDescription) | O | 1..N | Identifies Ethernet packet filters. (NOTE 1) (NOTE 3) | | +| snssai | Snssai | O | 0..1 | The identification of slice. | | +| interGroupId | GroupId | O | 0..1 | Identifies a group of users. (NOTE 2) (NOTE 3)(NOTE 5) | | +| interGroupIdList | array(GroupId) | O | 2..N | Identifies the list of Internal Groups. (NOTE 2) (NOTE 9) (NOTE 10) (NOTE 11) | FinerGranUEs | +| subscriberCatList | array(string) | O | 1..N | Identifies the list of subscriber category(ies). (NOTE 10) | FinerGranUEs | +| supi | Supi | O | 0..1 | Identifies a user. (NOTE 2) (NOTE 3) | | +| trafficFilters | array(FlowInfo) | O | 1..N | Identifies IP packet filters. (NOTE 1) (NOTE 3) | | +| trafficRoutes | array(RouteToLocation) | O | 1..N | Identifies the N6 traffic routing requirement. | | +| sfcdIdI (NOTE 11) | string | O | 0..1 | Reference to a pre-configured service function chain for downlink traffic. | SFC | +| sfcdIdUI (NOTE 11) | string | O | 0..1 | Reference to a pre-configured service function chain for uplink traffic. | SFC | +| 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. It may only be provided when sfcdIdI and/or sfcdIdUI are provided. | SFC | +| traffCorrInd | boolean | O | 0..1 | Indication of traffic correlation. May only be included when "interGroupId" attribute is included and not set to "AnyUE". It is used to indicate that for the group of UEs, the targeted PDU sessions should be correlated by a common DNAI. Set to "true" if it should be correlated; otherwise set to "false". Default value is "false" if omitted. (NOTE 7) | | +| tfcCorrInfo | TrafficCorrelationInfo | O | 0..1 | Contains the information for traffic correlation. | CommonEAS DNAI | +| validStartTime | DateTime | O | 0..1 | Identifies when the traffic routings start to be applicable. (NOTE 4) | | +| validEndTime | DateTime | O | 0..1 | Identifies when the traffic routings are not applicable. (NOTE 4) | | +| tempValidities | array(TemporalValidity) | O | 1..N | Indicates the time interval(s) during which the AF request is to be applied. (NOTE 4) | MultiTemporal ICondition | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | Identifies a network area information that the request applies only to the traffic of UE(s) located in this specific zone. | | +| upPathChgNotifUri | Uri | C | 0..1 | Contains the URI where the NEF receives the UP path change notification. It shall be included when the NEF requests the UP path change notification. | | + +| | | | | | | +|-------------------|------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| headers | array(string) | O | 1..N | Headers provisioned by the NEF to be used by other NFs to interact with the NEF. E.g. 3gpp-Sbi-Binding header with the binding indication for the URI where the NEF receives UP path change notification and whose information is used by the SMF.
The encoding of the header shall comply with clause 6.3 of IETF RFC 9110 [21].
(NOTE 6) | | +| subscribedEvents | array(SubscribedEvent) | O | 1..N | Identifies the requirement to be notified of the event(s). | | +| dnaiChgType | DnaiChangeType | O | 0..1 | Identifies a type of notification regarding UP path management event. | | +| 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 | +| 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 | +| maxAllowedUpLat | UInteger | 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 | +| simConnInd | boolean | O | 0..1 | Indication of simultaneous connectivity temporarily maintained for the source and target PSA.
It is used to indicate whether the simultaneous connectivity should be temporarily maintained for the source and target PSA.
It is set to "true" if the temporary simultaneous connectivity should be temporarily maintained; otherwise, it is set to "false". Default value is "false" if omitted. | 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 before removing the source PSA.
It may be included when the "simConnInd" attribute is set to true. | SimultConnectivity | +| supportedFeatures | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.

This attribute shall be supplied by the UDR in the response to the PUT request when it was present in the PUT request and the UDR supports feature negotiation for Influence Data.

This attribute shall be supplied by the UDR in the response to the GET request when the GET request includes the "supp-feat" query parameter and the UDR supports feature negotiation for Influence Data. | | +| resUri | Uri | C | 0..1 | Represents the URI of Individual Influence Data.
It shall only be included in the HTTP | EnhancedInfluuDataNotification | + +| | | | | | | +|--------------|------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| | | | | GET response. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | +| nscSuppFeats | map(SupportedFeatures) | O | 1..N | A map of Network Function Service Consumer features supported per service. The key used in this map for each entry is the ServiceName value as defined in 3GPP TS 29.510[24] (e.g. for Nsmf_EventExposure API, the key shall be set to nsmf-event-exposure). | NscSupportedFeatures | + +NOTE 1: One of "afAppId", "trafficFilters" or "ethTrafficFilters" shall be included. + +NOTE 2: One of the "supi" or "interGroupId" or "interGroupIdList" (may be included when FinerGranUEs feature is supported) shall be included. + +NOTE 3: If the EnhancedInfluDataNotification feature is not supported, to indicate the deletion of a Traffic Individual Influence Data resource, only the appropriate combination of "supi" or "interGroupId", and "afAppId", "trafficFilters" or "ethTrafficFilters" that identify the resource shall be included. The rest of attributes shall be omitted. + +NOTE 4: Properties "validStartTime" and "validEndTime" shall only be included for single temporal validity condition. Property "tempValidities" shall only be included for multiple temporal validity conditions when the feature MultiTemporalCondition is supported. + +NOTE 5: If the Traffic Influence Data applies to any UE, then the "interGroupId" sets to "AnyUE". + +NOTE 6: In this release of the specification, the property "headers" only includes the 3gpp-Sbi-Binding header with the binding indication for the URI included in the property "upPathChgNotifUri". + +NOTE 7: The indication of traffic correlation shall be provided only when the AF indicated that 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 29.522 [19]. + +NOTE 8: When FinerGranUEs feature is supported, the Traffic Influence Data applies to the UE(s) that belong to all the Internal Group Identifiers included within the attribute "interGroupIdList", if present. + +NOTE 9: When FinerGranUEs feature is supported, the Traffic Influence Data applies to the UE(s) that belong to all the subscriber categories included within the attribute "subscriberCatList", which is included only if either "interGroupIdList" is included or "interGroupId" is included. + +NOTE 10: Attributes "interGroupId" and "interGroupIdList" are mutually exclusive attributes. + +NOTE 11: When the SFC feature is supported, for the purpose of influencing Service Function Chaining, at least one of the "sfCldId" and "sfCldUri" attribute shall be present. + +### 6.4.2.3 Type TrafficInfluDataPatch + +**Table 6.4.2.3-1: Definition of type TrafficInfluDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| upPathChgNotifCorrId | string | O | 0..1 | Contains the Notification Correlation Id allocated by the NEF for the UP path change notification. | | +| appReloInd | boolean | O | 0..1 | Identifies whether an application can be relocated once a location of the application has been selected. | | +| ethTrafficFilters | array(EthFlowDescription) | O | 1..N | Identifies Ethernet packet filters. | | +| trafficFilters | array(FlowInfo) | O | 1..N | Identifies IP packet filters | | +| trafficRoutes | array(RouteToLocation) | O | 1..N | Identifies the N6 traffic routing requirement. | | +| sfcdId | string | O | 0..1 | Reference to a pre-configured service function chain for downlink traffic. | SFC | +| sfcdId | string | O | 0..1 | Reference to a pre-configured service function chain for uplink traffic. | SFC | +| 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. | SFC | +| traffCorrInd | boolean | O | 0..1 | Indication of traffic correlation. May only be included when "interGroupId" attribute was previously included in the "TrafficInfluData" data type and not set to "AnyUE". It is used to indicate that for the group of UEs, the targeted PDU sessions should be correlated by a common DNAI. | | +| tfcCorrInfo | TrafficCorrelationInfo | O | 0..1 | Contains the information for traffic correlation. | CommonEASD
NAI | +| validStartTime | DateTime | O | 0..1 | Identifies when the traffic routings start to be applicable. | | +| validEndTime | DateTime | O | 0..1 | Identifies when the traffic routings are not applicable. | | +| tempValidities | array(TemporalValidity) | O | 1..N | Indicates the time interval(s) during which the AF request is to be applied. | MultiTemporalCondition | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | Identifies a network area information that the request applies only to the traffic of UE(s) located in this specific zone. | | +| upPathChgNotifUri | Uri | O | 0..1 | Contains the URI where the NEF receives the UP path change notification. | | +| headers | array(string) | O | 1..N | Headers provisioned by the NEF. E.g. 3gpp-Sbi-Binding header with the binding indication for the URI where the NEF receives UP path change notification. The encoding of the header shall comply with clause 6.3 of IETF RFC 9110 [21]. | | +| afAckInd | boolean | O | 0..1 | Identifies whether the AF acknowledgement of UP path event notification is expected. | URLLC | +| addrPreserInd | boolean | O | 0..1 | Indicates UE IP address should be preserved. | URLLC | +| maxAllowedUpLat | UInteger | 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 | +| simConnInd | boolean | O | 0..1 | Indication of simultaneous connectivity | SimultConnecti | + +| | | | | | | +|-------------|---------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| 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 before removing the source PSA. | SimultConnectivity | +|-------------|---------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| + +## 6.4.2.4 Type TrafficInfluSub + +**Table 6.4.2.4-1: Definition of type TrafficInfluSub** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| dnns | array(Dnn) | O | 1..N | Each element identifies a DNN.
(NOTE 1) | | +| snssais | array(Snssai) | O | 1..N | Each element identifies an internal slice. | | +| internalGroupIds | array(GroupId) | O | 1..N | Each element identifies a group of users.
(NOTE 1) (NOTE 2) (NOTE 3) (NOTE 5) | | +| internalGroupIdsAdd | array(GroupId) | O | 1..N | Each element identifies an internal group of users.
(NOTE 1) (NOTE 2) (NOTE 4) (NOTE 5) | | +| subscriberCatList | array(string) | O | 1..N | Each element identifies a subscriber category.
(NOTE 6) | | +| supis | array(Supi) | O | 1..N | Each element identifies the user.
(NOTE 5) | | +| notificationUri | Uri | M | 1 | URI provided by the NF service consumer indicating where to receive the subscribed notifications from the UDR. | | +| expiry | DateTime | C | 0..1 | This IE shall be included in a subscription response if, based on operator policy and taking into account the expiry time included in the request, the UDR needs to include an expiry time.
This IE may be included in a subscription request. When present, this IE shall represent the time after which the subscription becomes invalid.
The absence of this attribute in the subscription response means the subscription to be valid without an expiry time. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of the optional features. This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | +| immRep | boolean | O | 0..1 | If provided and set to "true", it indicates that existing entries that match this subscription shall be immediately reported within the "immReports" attribute in the response. The default value is false. | ImmediateReportPcc | +| immReports | array(TrafficInfluDataNotif) | O | 1..N | Contains entries stored in the UDR that match this subscription.
It may be included only in the POST (or PUT) response body of a subscription creation (or modification), and only if the request included the "immRep" attribute set to true. | ImmediateReportPcc | +| NOTE 1: At least one of "dnns", "snssais", "internalGroupIds", "internalGroupIdsAdd" (may be included when FinerGranUEs feature is supported) or "supis" shall be provided. | | | | | | +| NOTE 2: For the Traffic Influence Data applies to any UE, the "internalGroupIds" needs to have an entry set to "AnyUE". | | | | | | +| NOTE 3: The "internalGroupIds" attribute shall be compared only with the "interGroupId" of the TrafficInfluData data type and there is a match only if they both exist and "interGroupId" is contained in "internalGroupIds". | | | | | | +| NOTE 4: The "internalGroupIdsAdd" attribute shall be compared only with the "interGroupIdList" of the TrafficInfluData data type and there is a match only if they both exist and are identical. | | | | | | +| NOTE 5: Attributes "internalGroupIds" and "internalGroupIdsAdd" are mutually exclusive attributes. | | | | | | +| NOTE 6: The "subscriberCatList" attribute of the TrafficInfluSub data type shall be compared with the "subscriberCatList" of the TrafficInfluData data type and there is a match only if they both exist and are identical. | | | | | | + +## 6.4.2.5 Void + +## 6.4.2.6 Type: PfdDataForAppExt + +Table 6.4.2.6-1: Definition of type PfdDataForAppExt + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| suppFeat | SupportedFeatures | O | 0..1 | Used to negotiate the applicability of the optional features.

This attribute shall be provided in the PUT request and in the response of successful resource creation.
This attribute shall be provided in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. | | +| applicationId | ApplicationId | M | 1 | Identifier of an application. | | +| pfds | array(PfdContent) | M | 1..N | PFDs for the application identifier. | | +| cachingTime | DateTime | O | 0..1 | Caching time for an application identifier. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | +| allowedDelay | DurationSec | O | 0..1 | Indicates that the list of PFDs in this request should be deployed within the time interval indicated by the Allowed Delay. | | + +## 6.4.2.7 Type BdtPolicyData + +Table 6.4.2.7-1: Definition of type BdtPolicyData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| interGroupId | GroupId | O | 0..1 | Identifies a group of users. (NOTE) | | +| supi | Supi | O | 0..1 | Identifies a user. (NOTE) | | +| bdtRefId | BdtReferenceId | M | 1 | Identifies a selected policy of background data transfer. | | +| dnn | Dnn | O | 0..1 | Identifies a DNN | | +| snssai | Snssai | O | 0..1 | The identification of slice. | | +| resUri | Uri | C | 0..1 | Represents the URI of Individual Applied BDT Policy Data.
It shall only be included in the HTTP GET response. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | + +NOTE: Either "supi" or "interGroupId" shall be included. + +#### 6.4.2.8 Type BdtPolicyDataPatch + +**Table 6.4.2.8-1: Definition of type BdtPolicyDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-----------------------------------------------------------|---------------| +| bdRefId | BdtReferenceId | M | 1 | Identifies a selected policy of background data transfer. | | + +#### 6.4.2.9 Type IptvConfigData + +**Table 6.4.2.9-1: Definition of type IptvConfigData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies a user. (NOTE) | | +| interGroupId | GroupId | C | 0..1 | Identifies a group of users. (NOTE) | | +| dnn | Dnn | O | 0..1 | Identifies a DNN | | +| snssai | Snssai | O | 0..1 | The identification of slice. | | +| afAppId | string | M | 1 | Identifies an application. | | +| multiAccCtrls | map(MulticastAccessControl) | M | 1..N | Identifies a list of multicast address access control information.
Any string value can be used as a key of the map. | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the negotiated supported features. This attribute shall be provided in the PUT request and in the response of successful resource creation. | | +| resUri | Uri | C | 0..1 | Represents the URI of Individual IPTV Configuration.
It shall only be included in the HTTP GET response. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | + +NOTE: Either "supi" or "interGroupId" shall be included. + +## 6.4.2.10 Type ApplicationDataSubs + +**Table 6.4.2.10-1: Definition of type ApplicationDataSubs** + +| Attribute name | Data type | P | Cardinality | Description | | +|-------------------|-----------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| notificationUri | Uri | M | 1 | URI provided by the NF service consumer indicating where to receive the subscribed notifications from the UDR. | Applicability | +| dataFilters | array(DataFilter) | O | 1..N | Each element identifies a data filter for subscription to data change.notification. If absent, the subscription applies to all data change notification except traffic influence data. | | +| expiry | DateTime | C | 0..1 | This IE shall be included in a subscription response if, based on operator policy and taking into account the expiry time included in the request, the UDR needs to include an expiry time. This IE may be included in a subscription request. When present, this IE shall represent the time after which the subscription becomes invalid. The absence of this attribute in the subscription response means the subscription to be valid without an expiry time. | | +| immRep | boolean | O | 0..1 | If the feature "ImmediateReportPcc" is not supported, this attribute is applicable only if the "dataFilters" attribute of the request includes an element with the "dataInd" attribute set to "AM". If provided and set to "true", it indicates that existing matching entries shall be immediately reported within the "amInfluEntries" attribute, or, if the feature "ImmediateReportPcc" is supported, within the "immReports" attribute in the response. The default value is "false" | DCAMP
ImmediateReportPcc | +| amInfluEntries | array(AmInfluData) | O | 1..N | The AM Influence Data stored in the UDR that match this subscription. It may be included only in the POST response body of a subscription creation or modification, and only if the request included the "immRep" attribute set to true and a "dataFilters" attribute that contained an element with the "dataInd" attribute set to "AM". | DCAMP | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of the optional features. This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource. This attribute may be provided in the response of successful resource creation. | | +| immReports | array(ApplicationDataChangeNotif) | O | 1..N | Contains entries stored in the UDR that match this subscription. It may be included only in the POST (or PUT) response body of a subscription creation (or modification), and only if the request included the "immRep" attribute set to true. | ImmediateReportPcc | + +When multiple attributes defined as an array are included within an entry of the "dataFilters" attribute, the UDR shall determine that the subscription is for all application data of type "dataInd" that contain a matching combination of the values of the elements of the array of the provided attributes. + +EXAMPLE: For a subscription to notification on changes of Service Parameter Data resources ("dataInd" is set to "SVC\_PARAM"), if "snssais" attribute is included with two S-NSSAI entries (S-NSSAI\_1 and S-NSSAI\_2) and "dnns" is included with two DNN entries (e.g. DNN\_A and DNN\_B), and the other optional attributes are not included, the UDR shall notify about changes of Service Parameter Data resources that contain a matching S-NSSAI and DNN combination, i.e. the resource(s) matching SNSSAI\_1 and DNN\_A, the resource(s) matching SNSSAI\_1 and DNN\_B, the resource(s) matching SNSSAI\_2 and DNN\_A, and the resources matching SNSSAI\_2 and DNN\_B. + +#### 6.4.2.11 Type ApplicationDataChangeNotif + +**Table 6.4.2.11-1: Definition of type ApplicationDataChangeNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| iptvConfigData | IptvConfigData | O | 0..1 | IPTV Configuration Data. (NOTE) | | +| pfdData | PfdChangeNotification | O | 0..1 | PFD Data. (NOTE) | | +| bdtPolicyData | BdtPolicyData | O | 0..1 | BDT Policy Data. (NOTE) | | +| serParamData | ServiceParameterData | O | 0..1 | Service Parameter Data, if changed and notification was requested. (NOTE) | | +| amlInfluData | AmlInfluData | O | 0..1 | AM Influence Data (NOTE) | DCAMP | +| dnaiEasData | DnaiEasMapping | O | 0..1 | DNAI EAS Mapping (NOTE) | DnaiEasMappings | +| afReqQosData | AfRequestedQosData | O | 0..1 | AF requested QoS data for a UE or Group of UE(s) not identified by UE address(es). (NOTE) | GMEC | +| ecsAddrData | EcsAddrData | O | 0..1 | ECS Address Roaming Data (NOTE) | | +| resUri | Uri | M | 1 | Identifies the resource in the corresponding data change. For notifying deletion, only resUri shall be provided in the ApplicationDataChangeNotif data type. | | + +NOTE: Only one among those attributes shall be provided in notifying data creation or update and in immediate reports. + +Editor's Note: The feature to be used for EcsAddrData is FFS. + +## 6.4.2.12 Type DataFilter + +**Table 6.4.2.12-1: Definition of type DataFilter** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dataInd | DataInd | M | 1 | Indicate the type of application data.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd", and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +| dnns | array(Dnn) | O | 1..N | Each element identifies a DNN.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the DNNs included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any).
(NOTE 3) | | +| snssais | array(Snssai) | O | 1..N | Each element identifies a slice.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the S-NSSAIs included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any).
(NOTE 3) | | +| internalGroupIds | array(GroupId) | O | 1..N | Each element identifies a group of users.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the Group IDs included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +| supis | array(Supi) | O | 1..N | Each element identifies the user.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the SUPIs included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +| appIds | array(ApplicationId) | O | 1..N | Each element identifies an application.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the ApplicationIds included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +| uelpv4s | array(Ipv4Addr) | O | 1..N | Each element identifies the user.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the IPv4 address(es) included in the array, | | + +| | | | | | +|--|--|--|--------------------------------------------------------------------------------------------|--| +| | | | and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +|--|--|--|--------------------------------------------------------------------------------------------|--| + +| | | | | | | +|----------------|------------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| uelpv6s | array(Ipv6Addr) | O | 1..N | Each element identifies the user. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the IPv6 addresses included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +| ueMacs | array(MacAddr48) | O | 1..N | Each element identifies the user. When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain at least one of the UE MAC address(es) included in the array, and match also the filters indicated in the rest of the attributes of DataFilter (if any). | | +| anyUeInd | boolean | O | | Indicates whether the request is for any UE:
- "true": the request is for any UE;
- "false"(default): the request is not for any UE.
When used in subscription procedures, the UDR shall notify only about changes of application data of type "dataInd" that contain an any UE indication, and match also the filters indicated in the rest of the attributes of DataFilter (if any). | FilterAnyUE | +| dnnSnssaiInfos | array(DnnSnssaiInformation ) | O | 1..N | Each element identifies a combination of (DNN, S-NSSAI). When used in subscription procedures, the UDR shall only notify about changes in resource(s) with "dataInd" value AM that contain at least one DNN and S-NSSAI combination indicated in the array, and match also the rest of the filters (if any). (NOTE 3) | DCAMP | +| dnais | array(Dnai) | O | 1..N | Each element identifies a DNAI. When used in subscription procedures, the UDR shall only notify about changes of application data of type "dataInd" that contain at least one of the DNais included in the array, and match also the rest of the filters (if any). | DnaiEasMappings | + +NOTE 1: The "dnns" and "snssais" attributes are applicable to the BDT Policy Data, IPTV Configuration Data, Service Parameter Data, AM Influence Data, and DNAI EAS Mappings, the "internalGroupIds" and "supis" attributes are applicable to the BDT Policy Data, IPTV Configuration Data, Service Parameter Data, and AM Influence Data, the "uelpv4s" "uelpv6s" and "ueMacs" attributes are applicable to the Service Parameter Data, the "appls" attribute is applicable to the PFD Data, Service Parameter Data and IPTV Configuration Data, the "anyUeInd" attribute is applicable to Service Parameter Data and AM Influence Data, the "dnnSnssaiInfos" is applicable to AM Influence Data, and the "dnais" attribute is applicable to DNAI EAS Mappings. The "internalGroupIds" and "anyUeInd" attributes are also applicable to ECS Address Roaming Data. + +NOTE 2: At application data changes, subscriptions to changes based on attributes of this table are considered to be matched, and the corresponding notifications are sent, no matter if the matching application data matches the provided values before the change, after the change, or both before and after the change. + +NOTE 3: For AM Influence Data, only one of the "dnns", "snssais", or "dnn-snssai-infos" attributes may be simultaneously provided. + +NOTE: When the "anyUeInd" attribute is related to the subscription to notification of changes of the service parameter data resource(s), and it refers to any UE using the service identified by a combination of DNN and S-NSSAI, the "anyUeInd" attribute is present together with the "dnns" and "snssais" properties. Note also that, if the "anyUeInd" attribute is present together with the "internalGroupIds", "supis", "uelpv4s", "uelpv6s" and/or "ueMacs" attributes the subscription will not match any resource, since according to clause 6.4.2.15 only one of the the "supi", "anyUeInd", "interGroupId", "uelpv4", "uelpv6" or "ueMac" properties are simultaneously present in the resource. + +When the "anyUeInd" attribute is related to the subscription to notification of changes of the AM Influence data resource(s), and it refers to any UE using the service(s) identified by the corresponding DNN and S-NSSAI, the "anyUeInd" attribute is present together with the "dnnSnssaiInfos" property. Note also that, if the "anyUeInd" attribute is present together with the "internalGroupIds" and/or "supis" attributes the subscription will not match any resource, since according to clause 6.4.2.16 only one of the the "supi", "anyUeInd", or "interGroupId" properties are simultaneously present in the resource. + +#### 6.4.2.13 Void + +#### 6.4.2.14 Type TrafficInfluDataNotif + +**Table 6.4.2.14-1: Definition of type TrafficInfluDataNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| resUri | Uri | M | 1 | Represents the URI of Individual Influence Data. For notifying deletion, only resUri shall be provided in the TrafficInfluDataNotif data type. | | +| trafficInfluData | TrafficInfluData | C | 0..1 | Traffic Influence Data. It shall be present for notifying Individual Influence Data creation or update and, if the feature "ImmediateReportPcc" is supported, also for providing immediate reports. | | + +## 6.4.2.15 Type ServiceParameterData + +**Table 6.4.2.15-1: Definition of type ServiceParameterData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| dnn | Dnn | O | 0..1 | Identifies a DNN. (NOTE 2) | | +| snssai | Snssai | O | 0..1 | Identifies an S-NSSAI. (NOTE 2) | | +| appld | string | O | 0..1 | Identifies an application identifier. (NOTE 2) | | +| supi | Supi | O | 0..1 | Identifies a user. (NOTE1) | | +| uelpv4 | Ipv4Addr | O | 0..1 | The IPv4 address of the served UE. (NOTE1) | | +| uelpv6 | Ipv6Addr | O | 0..1 | The IPv6 address of the served UE. (NOTE1) | | +| ueMac | MacAddr48 | O | 0..1 | The MAC address of the served UE. (NOTE1) | | +| interGroupId | GroupId | O | 0..1 | Identifies a group of users. (NOTE1) | | +| anyUeInd | boolean | O | 0..1 | Identifies whether the service parameters applies to any non-roaming UE. This attribute shall set to "true" if applicable for any UE, otherwise, set to "false". (NOTE1) | | +| roamUeNetDescs | array(NetworkDescription) | O | 1..N | Each element identifies one (e.g., combination of MCC and MNC) or more (e.g. a MCC only) PLMN ID(s).

It indicates the PLMN(s) of inbound roamers to which the provided AF guidance on VPLMN-specific URSP rules apply. (NOTE 1) | VPLMNSpecificURSP | +| paramOverPc5 | ParameterOverPc5 | O | 0..1 | Contains the V2X service parameters used over PC5 | | +| paramOverUu | ParameterOverUu | O | 0..1 | Contains the V2X service parameters used over Uu | | +| a2xParamsPc5 | A2xParamsPc5 | O | 0..1 | Contains the A2X service parameters used over PC5 | A2X | +| urspGuidance | array(UrspRuleRequest) | O | 1..N | Contains the service parameter used to guide the URSP and/or, when the VPLMNSpecificURSP feature is supported, to guide the VPLMN-specific URSP. | AfGuideURSP | +| paramForProSeDd | ParamForProSeDd | O | 0..1 | Contains the service parameters for 5G ProSe direct discovery. | ProSe | +| paramForProSeDc | ParamForProSeDc | O | 0..1 | Contains the service parameters for 5G ProSe direct communications. | ProSe | +| paramForProSeU2NRelUe | ParamForProSeU2NRelUe | O | 0..1 | Contains the service parameters for 5G ProSe UE-to-network relay UE. | ProSe | +| paramForProSeRemUe | ParamForProSeRemUe | O | 0..1 | Contains the service parameters for 5G ProSe remote UE. | ProSe | +| paramForProSeU2UReUe | ParamForProSeU2UReUe | O | 0..1 | Contains the service parameters for 5G ProSe UE-to-UE Relay UE. | ProSe_Ph2 | +| paramForProSeEndUe | ParamForProSeEndUe | O | 0..1 | Contains the service parameters for 5G ProSe End UE. | ProSe_Ph2 | +| tnaps | array(TnapId) | O | 1..N | Contains the TNAP ID(s) collocated with the 5G-RG(s) of a specific user. | AfGuideTNAPs | +| deliveryEvents | array(Event) | O | 1..N | Contains the events related to the outcome of UE policy | DeliveryOutcome | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| | | | | delivery. | | +| policDelivNotifCorrelId | string | C | 0..1 | Contains the Notification Correlation Id allocated by the NEF for the notification of UE Policy delivery outcome. It shall be included when the NEF requests the notification of UE Policy delivery outcome. | DeliveryOutcome | +| policDelivNotifUri | Uri | C | 0..1 | Contains the URI where the NEF receives the notification of UE Policy delivery outcome. It shall be included when the NEF requests the notification of UE policy delivery outcome. | DeliveryOutcome | +| headers | array(string) | O | 1..N | Headers provisioned by the NEF.
E.g. 3gpp-Sbi-Binding header (as specified in 3GPP TS 29.500 [4]) with the binding indication for the URI included in the policDelivNotifUri attribute. The encoding of the header shall comply with clause 6.3 of IETF RFC 9110 [21]. | DeliveryOutcome | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the list of Supported features used as described in clause 5.8.
This parameter shall be supplied in the PUT request that requested the creation of an individual Service parameter resource, and in the PUT response. | | +| resUri | Uri | C | 0..1 | Represents the URI of Individual Service Parameter Data.
It shall only be included in the HTTP GET response. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | +| paramForRangingSIPos | ParamForRangingSIPos | O | 0..1 | Contains the service parameters for ranging and sidelink positioning. | Ranging_SL | +| NOTE 1: Only one of the "supi", "anyUeInd", "interGroupId", "uelpv4", "uelpv6" or "ueMac" attribute, and when the feature "VPLMNSpecificURSP" is supported, or "roamUeNetDescs" attribute, shall be provided. When the "AfGuidance" feature is supported, and the attribute "tnaps" is included, only the "supi" attribute shall be provided. When the "VPLMNSpecificURSP" feature is supported, the "roamUeNetDescs" attribute only applies to URSP service parameter provisioning and shall be included when the "urspGuidance" attribute contains VPLMN(s) description. | | | | | | +| NOTE 2: Only the combination of "dnn" and "snssai" or "appld" attribute shall be provided. | | | | | | + +## 6.4.2.15A Type ServiceParameterDataPatch + +**Table 6.4.2.15A-1: Definition of type ServiceParameterDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| paramOverPc5 | ParameterOverPc5Rm | O | 0..1 | Contains the V2X service parameters used over PC5. When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | | +| paramOverUu | ParameterOverUuRm | O | 0..1 | Contains the V2X service parameters used over Uu. When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | | +| a2xParamsPc5 | A2xParamsPc5Rm | O | 0..1 | Contains the A2X service parameters used over PC5. | A2X | +| urspInfluence | array(UrspRuleRequest) | O | 1..N | Contains the service parameter used to influence the URSP. This attribute is deprecated by the "urspGuidance" attribute that should be used instead. | AfGuideURSP | +| urspGuidance | array(UrspRuleRequest) | O | 1..N | Contains the service parameter used to guide the URSP and/or, when the VPLMNSpecificURSP feature is supported, to guide the VPLMN-specific URSP. | AfGuideURSP
PatchCorrection | +| paramForProSeDd | ParamForProSeDdRm | O | 0..1 | Contains the service parameters for 5G ProSe direct discovery. When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | ProSe | +| paramForProSeDc | ParamForProSeDcRm | O | 0..1 | Contains the service parameters for 5G ProSe direct communications. When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | ProSe | +| paramForProSeU2NRelUe | ParamForProSeU2NRelUeRm | O | 0..1 | Contains the service parameters for 5G ProSe UE-to-network relay UE. When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | ProSe | +| paramForProSeRemUe | ParamForProSeRemUeRm | O | 0..1 | Contains the service parameters for 5G ProSe remote UE. When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | ProSe | +| paramForProSeU2URe | ParamForProSe | O | 0..1 | Contains the service | ProSe_Ph2 | + +| | | | | | | +|----------------------|------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| lUE | U2URElUeRm | | | parameters for 5G ProSe UE-to-UE Relay UE. | | +| paramForProSeEndUe | ParamForProSeEndUeRm | O | 0..1 | Contains the service parameters for 5G ProSe End UE. | ProSe_Ph2 | +| tnaps | array(TnapId) | O | 1..N | Contains the TNAP ID(s) collocated with the 5G-RG(s) of a specific user. | AfGuideTNAPs | +| deliveryEvents | array(Event) | O | 1..N | Contains the events related to the outcome of UE policy delivery.
When the "NullableSupport" feature is supported, this attribute is nullable. When the "NullableSupport" feature is not supported, this attribute is not nullable. | DeliveryOutcome | +| policDelivNotifUri | Uri | C | 0..1 | Contains the URI where the NEF receives the notification of UE Policy delivery outcome. It shall be included when the NEF requests the notification of UE policy delivery outcome. | DeliveryOutcome | +| headers | array(string) | O | 1..N | Headers provisioned by the NEF.
E.g. 3gpp-Sbi-Binding header (as specified in 3GPP TS 29.500 [4]) with the binding indication for the URI included in the policDelivNotifUri IE.
The encoding of the header shall comply with clause 6.3 of IETF RFC 9110 [21]. | DeliveryOutcome | +| paramForRangingSIPos | ParamForRangingSIPosRm | O | 0..1 | Contains the service parameters for ranging and sidelink positioning. | Ranging_SL | + +## 6.4.2.16 Type AmInfluData + +**Table 6.4.2.16-1: Definition of type AmInfluData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| appIds | array(string) | O | 1..N | Identifies one or more applications. | | +| dnnSnssaiInfos | array(DnnSnssaiInformation) | O | 1..N | Each element identifies a combination of (DNN, S-NSSAI). | | +| interGroupId | GroupId | O | 0..1 | Identifies a group of users. (NOTE 1) | | +| supi | Supi | O | 0..1 | Identifies a user. (NOTE 1) | | +| anyUeInd | boolean | O | 0..1 | Indicates whether the data applies to any non-roaming UE. If present and set to "true" the data is applicable for any non-roaming UE. Otherwise set to "false". Default value is "false" if omitted. (NOTE 1) | | +| roamUePlmnIds | array(PlmnId) | O | 1..N | Each element identifies a home PLMN Id for the inbound roaming UEs in LBO roaming scenario. (NOTE 1) (NOTE 3) | DCAMP_Roaming_LBO | +| policyDuration | DurationSec | O | 0..1 | Indicates the time duration that the policy shall last. | | +| evSubs | array(AmInfluEvent) | O | 1..N | List of AM related events for which a subscription is required. | | +| headers | array(string) | O | 1..N | Headers provisioned by the NEF. E.g. 3gpp-Sbi-Binding header (as specified in 3GPP TS 29.500 [4]) with the binding indication for the URI included in the notifUri IE. The encoding of the header shall comply with clause 6.3 of IETF RFC 9110 [21]. | | +| notifUri | Uri | C | 0..1 | Contains the Callback URI to receive notifications. It shall be present if the "evSubs" attribute is present. | | +| notifCorrId | string | O | 0..1 | Notification correlation identifier. | | +| thruReq | boolean | O | 0..1 | If present and set to "true", it indicates that high throughput is desired for the indicated UE traffic. Otherwise set to "false". Default value is "false" if omitted. (NOTE 2) | | +| covReq | array(ServiceAreaCoverageInfo) | O | 1..N | Identifies service area coverage requirements. (NOTE 2) | | +| supportedFeatures | SupportedFeatures | C | 0..1 | Indicates the list of negotiated supported features.

This attribute shall be supplied by the UDR in the response to the PUT request when it was present in the PUT request and the UDR supports feature negotiation for AM Influence Data.

This attribute shall be supplied by the UDR in the response to the GET request when the GET request includes the "supp-feat" query parameter and the UDR supports feature negotiation for AM Influence Data. | | +| resUri | Uri | C | 0..1 | Represents the URI of Individual AM Influence Data. It shall only be included in the HTTP GET response. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource. This attribute may be provided in the response of successful resource creation. | | + +NOTE 1: One of "supi", "interGroupId", "anyUeInd" and "roamUePlmnIds" shall be included. + +NOTE 2: At least one of these attributes shall be included. + +NOTE 3: "roamUePlmnIds" attribute applies only to LBO roaming scenarios and is associated with the inbound roaming + +| | +|----------------------------------------------------------------------------------------| +| UEs and applicable when "applds" attribute or "dnnSnssailInfos" attribute is provided. | +|----------------------------------------------------------------------------------------| + +## 6.4.2.17 Type AmInfluDataPatch + +**Table 6.4.2.17-1: Definition of type AmInfluDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| applds | array(string) | O | 1..N | Identifies one or more applications. | | +| dnnSnssailInfos | array(DnnSnssailInformation) | O | 1..N | Each element identifies a combination of (DNN, S-NSSAI). | | +| policyDuration | DurationSecRm | O | 0..1 | Indicates the time duration that the policy shall last. | | +| evSubs | array(AmInfluEvent) | O | 1..N | List of AM related events for which a subscription is required. | | +| headers | array(string) | O | 1..N | Headers provisioned by the NEF.
E.g. 3gpp-Sbi-Binding header (as specified in 3GPP TS 29.500 [4]) with the binding indication for the URI included in the notifUri IE.
The encoding of the header shall comply with clause 6.3 of IETF RFC 9110 [21]. | | +| notifUri | UriRm | C | 0..1 | Contains the Callback URL to receive notifications. | | +| notifCorrId | string | O | 0..1 | Notification correlation identifier. | | +| thruReq | boolean | O | 0..1 | Indicates whether high throughput is desired for the indicated UE traffic:
- "true": high throughput is desired for the indicated UE traffic;
- "false": high throughput is not desired for the indicated UE traffic. | | +| covReq | string | O | 0..1 | Identifies service area coverage requirements. | | + +## 6.4.2.18 Type AfRequestedQosData + +**Table 6.4.2.18-1: Definition of type AfRequestedQosData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies a UE.

(NOTE 1) | | +| interGroupId | GroupId | C | 0..1 | Identifies a group of UE(s).

(NOTE 1) | | +| afAppId | string | O | 0..1 | Identifies an AF Application. | | +| dnn | Dnn | O | 0..1 | Represents a DNN.
(NOTE 2) | | +| sliceInfo | Snssai | O | 0..1 | Represents the identifier of a network slice. | | +| flowInfos | array(FlowInfo) | O | 1..N | Describe the IP data flow(s) which requires QoS. | | +| evSubsc | EventsSubscReqData | O | 0..1 | Contains the requested event(s) subscription related information. | | +| qosReference | string | O | 0..1 | Identifies a pre-defined QoS information. | | +| 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. | | +| altSerReqsData | array(AlternativeServiceRequirementsData) | O | 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. | | +| disUeNotif | boolean | O | 0..1 | Indicates to disable QoS flow parameters signalling to the UE when it is included and set to "true".
The default value "false" shall apply, if the attribute is not present and has not been supplied previously. | | +| marBwUI | BitRate | O | 0..1 | Maximum requested bandwidth for the Uplink. | | +| marBwDI | BitRate | O | 0..1 | Maximum requested bandwidth for the Downlink. | | +| mirBwUI | BitRate | O | 0..1 | Minimum requested bandwidth for the Uplink. | | +| mirBwDI | BitRate | O | 0..1 | Minimum requested bandwidth for the Downlink. | | +| tempInValidity | TemporalInValidity | O | 0..1 | Indicates the time interval during which the AF request is not to be applied. | | +| suppFeat | SupportedFeatures | M | 1 | This IE represents a list of Supported features used as described in clause 6.1.8 of 3GPP TS 29.504. | | + +NOTE 1: Either "supi" or "interGroupId" shall be included. + +NOTE 2: Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. The PCF uses the DNN as obtained from UDR without applying any transformation (e.g. during SM Policy Association matching). 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. + +**Editor's Note: Whether all the parameters of the AF Request for QoS are covered is FFS (e.g., missing the representation of other individual QoS parameters and/or the indication of the applicable events).** + +## 6.4.2.19 Type AfRequestedQosDataPatch + +**Table 6.4.2.19-1: Definition of type AfRequestedQosDataPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| afAppId | string | O | 0..1 | Identifies the application Identifier. | | +| evSubsc | EventsSubscReqDataRm | O | 0..1 | Contains the requested event(s) subscription related information. | | +| flowInfos | array(FlowInfo) | O | 1..N | Describe the data flow(s) which requires QoS. | | +| qosReference | string | O | 0..1 | Pre-defined QoS reference. | | +| altSerReqs | array(string) | O | 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. | | +| altSerReqsData | array(AlternativeServiceRequirementsData) | O | 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. | | +| disUeNotif | boolean | O | 0..1 | Indicates to disable QoS flow parameters signalling to the UE when it is included and set to "true".
The default value "false" shall apply, if the attribute is not present and has not been supplied previously. | | +| marBwUl | BitRateRm | O | 0..1 | Maximum requested bandwidth for the Uplink. | | +| marBwDl | BitRateRm | O | 0..1 | Maximum requested bandwidth for the Downlink. | | +| mirBwUl | BitRateRm | O | 0..1 | Minimum requested bandwidth for the Uplink. | | +| mirBwDl | BitRateRm | O | 0..1 | Minimum requested bandwidth for the Downlink. | | +| tempInValidity | TemporalInValidity | O | 0..1 | Indicates the time interval during which the AF request is not to be applied. | | + +## 6.4.2.20 Type TrafficCorrelationInfo + +**Table 6.4.2.20-1: Definition of type TrafficCorrelationInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| corrType | CorrelationType | C | 0..1 | Indicates selecting a common DNAI or EAS for the application identified by the Application Identifier or traffic filtering information. It shall be provided when the traffic correlation information is provisioned for the first time. | | +| tfcCorrId | string | C | 0..1 | Identification of a set of UEs accessing the application identified by the Application Identifier or traffic filtering information. It shall be provided when the traffic correlation information is provisioned for the first time. | | +| comEasIpv4Addr | Ipv4AddrRm | C | 0..1 | IPv4 address of common EAS for the application identified by the Application Identifier or traffic filtering information for the UEs the AF request aims at. It may be provided when the "corrType" attribute includes "COMMON_EAS". | | +| comEasIpv6Addr | Ipv6AddrRm | C | 0..1 | IPv6 address of common EAS for the application identified by the Application Identifier or traffic filtering information for the UEs the AF request aims at. It may be provided when the "corrType" attribute includes "COMMON_EAS". | | +| fqdnRange | array(FqdnPatternMatchingRule) | C | 1..N | FQDN(s) used for influencing EASDF-based DNS query procedure. It may be provided when the "corrType" attribute includes "COMMON_EAS". | | +| notifUri | UriRm | O | 0..1 | Contains the Callback URL to receive notifications. | | +| notifCorrId | string | O | 0..1 | Notification correlation identifier. | | + +## 6.4.2.21 Type DnaiEasMapping + +**Table 6.4.2.21-1: Definition of type DnaiEasMapping** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|----------------------------------------------------------------------|---------------| +| dnaiEasInfos | array(DnaiEasInfo) | M | 1..N | Each element contains EAS information for the DNAI of a DNN/S-NSSAI. | | + +## 6.4.2.22 Type DnaiEasInfo + +**Table 6.4.2.22-1: Definition of type DnaiEasInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------|---------------| +| dnn | Dnn | C | 0..1 | DNN. (NOTE 1) | | +| snssai | Snssai | C | 0..1 | S-NSSAI. (NOTE 1) | | +| easIpAddrs | array(IpAddr) | C | 1..N | IP address(es) or IP address ranges (IPv4 subnetwork(s) and/or IPv6 prefix(es)) of the EAS of the DNAI. (NOTE 2) | | +| fqdns | array(FqdnPatternMatchingRule) | C | 1..N | FQDN(s) where the EAS is/are deployed. (NOTE 2) | | + +NOTE 1: At least one of "dnn" and "snssai" shall be provided. +NOTE 2: Exactly one of "easIpAddrs" and "fqdns" shall be provided. + +## 6.4.2.23 Type EcsAddrData + +**Table 6.4.2.23-1: Definition of type EcsAddrData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| self | Link | C | 0..1 | Identifies the individual resource. It shall be present in the HTTP GET response when reading multiples entries. | | +| ecsServerAddr | EcsServerAddr | M | 1 | Represents the ECS address(es). | | +| spatialValidityCond | SpatialValidityCond | O | 0..1 | Indicates the spatial validity condition. | | +| anyUeInd | boolean | C | 0..1 | If provided and set to "true" it indicates that any UE is targetted, while "false" indicates that not all UEs are targetted. The default value is "false" if omitted. (NOTE) | | +| internalGroupId | GroupId | C | 0..1 | Indicates the internal group identifier. (NOTE) | | +| suppFeat | SupportedFeatures | C | 0..1 | Indicates the negotiated supported features. It shall be provided in an HTTP POST response if it was provided in the HTTP POST request. | | + +NOTE: One of the "internalGroupId" attribute or the "anyUeInd" attribute set to "true" shall be provided. + +## 6.4.3 Simple data types and enumerations + +### 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. + +### 6.4.3.2 Simple data types + +The simple data types defined in table 6.4.3.2-1 shall be supported. + +**Table 6.4.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +### 6.4.3.3 Enumeration: DataInd + +**Table 6.4.3.3-1: Enumeration DataInd** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------------------------------------------------|-----------------| +| PFD | PFD data | | +| IPTV | IPTV configuration data | | +| BDT | BDT data | | +| SVC_PARAM | Service parameter data | | +| AM | AM influence data | DCAMP | +| DNAI_EAS | DNAI EAS mapping data | DnaiEasMappings | +| REQ_QOS | AF Requested QoS data for a UE or group of UE(s) not identified by UE address(es). | GMEC | +| ECS | ECS Address Roaming Data | | + +Editor's Note: The feature to be used for ECS is FFS. + +#### 6.4.3.4 Enumeration: CorrelationType + +**Table 6.4.3.4-1: Enumeration CorrelationType** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------------|---------------| +| COMMON_DNAI | Indicates that the EAS(es) corresponding to a common DNAI should be selected. | | +| COMMON_EAS | Indicates that the common EAS should be selected | | + +### 6.5 Error handling + +#### 6.5.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [4]. + +For the Nudr\_DataRepository Service API for Application Data, 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. + +#### 6.5.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nudr\_DataRepository Service API for Application Data. + +#### 6.5.3 Application Errors + +The application errors defined for the Nudr\_DataRepository Service API for Application Data are listed in table 6.5.3-1. + +**Table 6.5.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------| +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated by other clauses in this document. | | | + +The application error handling shall follow 3GPP TS 29.504 [6] clause 6.1.6 unless explicitly specified in this document. + +### 6.6 Feature negotiation + +The optional features in table 6.1.8-1 of 3GPP TS 29.504 [6] are defined for the Nudr\_DataRepository API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +--- + +## 7 Usage of Nudr\_DataRepository Service API for Structured Data for Exposure + +### 7.1 Introduction + +The following clauses specify the usage of Nudr\_DataRepository service for exposure data. The principles specified in 3GPP TS 29.504 [6] are followed unless explicitly specified otherwise in the following clauses. + +## 7.2 Resources + +### 7.2.1 Overview + +This clause specifies the resources for the usage of the Unified Data Repository service for Structured Data for Exposure. + +### 7.2.2 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 7.2.2-1 depicts the resource URIs structure for the Nudr\_DataRepository API for exposure data data. + +![Resource URI structure diagram for Nudr_DataRepository API](ec838a9b247a8176f8dec125c9d198ab_img.jpg) + +``` +graph TD; Root["{apiRoot}/nudr-dr/"] --- ED["/exposure-data"]; ED --- UEID["/{ueId}"]; ED --- STN["/subs-to-notify"]; UEID --- AM["/access-and-mobility-data"]; UEID --- SMD["/session-management-data"]; SMD --- PDU["/{pduSessionId}"]; STN --- SUBID["/{subId}"]; +``` + +The diagram illustrates the hierarchical structure of Resource URIs for the Nudr\_DataRepository API. It starts with a root path `{apiRoot}/nudr-dr/` which leads to `/exposure-data`. From `/exposure-data`, two main branches emerge: `/{ueId}` and `/subs-to-notify`. The `/{ueId}` branch further splits into `/access-and-mobility-data` and `/session-management-data`. The `/session-management-data` path then leads to `/{pduSessionId}`. The `/subs-to-notify` branch leads to `/{subId}`. + +Resource URI structure diagram for Nudr\_DataRepository API + +**Figure 7.2.2-1: Resource URI structure of the Nudr\_DataRepository API for exposure data** + +Table 7.2.2-1 provides an overview of the resources and applicable HTTP methods. + +**Table 7.2.2-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method | Description | +|------------------------------------|--------------------------------------------------------------|-------------|------------------------------------------------------------------------------------------| +| AccessAndMobilityData | /exposure-data/{ueId}/access-and-mobility-data | PUT | Create and update the access and mobility exposure data for a UE | +| | | PATCH | Update the access and mobility exposure data for a UE. | +| | | GET | Retrieve the access and mobility exposure data for a UE | +| | | DELETE | Delete the access and mobility exposure data for a UE | +| PduSessionManagementData | /exposure-data/{ueId}/session-management-data/{pduSessionId} | PUT | Create and update the session management data for a UE and for an individual PDU session | +| | | GET | Retrieve the session management data for a UE and for an individual PDU session | +| | | DELETE | Delete the session management data for a UE and for an individual PDU session | +| ExposureDataSubscriptions | /exposure-data/subs-to-notify | POST | Create a subscription to receive notifications on exposure data changes. | +| IndividualExposureDataSubscription | /exposure-data/subs-to-notify/{subId} | PUT | Modify a subscription to receive notifications on exposure data changes. | +| | | DELETE | Delete a subscription identified by {subId}. | + +## 7.2.3 Resource: AccessAndMobilityData + +### 7.2.3.1 Description + +This resource represents the exposure data related to access and mobility. + +### 7.2.3.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//exposure-data/{ueId}/access-and-mobility-data + +This resource shall support the resource URI variables defined in table 7.2.3.2-1. + +**Table 7.2.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| ueId | VarUeId | Represents the SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7]. | + +### 7.2.3.3 Resource Standard Methods + +#### 7.2.3.3.1 PUT + +This method shall support the URI query parameters specified in table 7.2.3.3.1-1. + +**Table 7.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 table 7.2.3.3.1-2 and the response data structures and response codes specified in table 7.2.3.3.1-3. + +**Table 7.2.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------------------------------------------| +| AccessAndMobilityData | M | 1 | Access and mobility data for the UE is created or updated. | + +**Table 7.2.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AccessAndMobilityData | M | 1 | 201 Created | Successful case.
The resource has been successfully created and a response body containing a representation of the access and mobility data shall be returned. | +| AccessAndMobilityData | M | 1 | 200 OK | Successful case.
The resource has been successfully updated and a response body containing a representation of the access and mobility data shall be returned. | +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. | + +NOTE: The HTTP status code for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 7.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}/nudr-dr//exposure-data/{ueId}/access-and-mobility-data | + +### 7.2.3.3.2 GET + +This method shall support the URI query parameters specified in table 7.2.3.3.2-1. + +**Table 7.2.3.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------| +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer.
See 3GPP TS 29.500 [4] clause 6.6.2 and 3GPP TS 29.571 [7]. | + +This method shall support the request data structures specified in table 7.2.3.3.2-2 and the response data structures and response codes specified in table 7.2.3.3.2-3. + +**Table 7.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.2.3.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|----------------|----------------------------------------------------------| +| AccessAndMobilityData | M | 1 | 200 OK | The response body contains the access and mobility data. | + +NOTE: The HTTP status code for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +### 7.2.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 7.2.3.3.3-1. + +**Table 7.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.3.3.3-2 and the response data structures and response codes specified in table 7.2.3.3.3-3. + +**Table 7.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.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. | + +NOTE: The HTTP status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +### 7.2.3.3.4 PATCH + +This method shall support the URI query parameters specified in table 7.2.3.3.4-1. + +**Table 7.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.3.3.4-2 and the response data structures and response codes specified in table 7.2.3.3.4-3. + +**Table 7.2.3.3.4-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|--------------------------------------| +| AccessAndMobilityData | M | 1 | Access and mobility data for the UE. | + +**Table 7.2.3.3.4-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 successful modification there is no body in the response message. | + +NOTE: The HTTP status code for the PATCH method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +## 7.2.4 Resource: PduSessionManagementData + +### 7.2.4.1 Description + +This resource represents the exposure data related to session and management data for a given subscriber and a given PDU session. + +## 7.2.4.2 Resource definition + +Resource URI: {apiRoot}/nudr-dr//exposure-data/{ueId}/session-management-data/{pduSessionId} + +This resource shall support the resource URI variables defined in table 7.2.4.2-1. + +**Table 7.2.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|--------------|--------------|------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| ueId | VarUeId | Represents the SUPI or GPSI. Data type VarUeId is defined in 3GPP TS 29.571 [7]. | +| pduSessionId | PduSessionId | Identifies an individual PDU session. Data type PduSessionId is defined in 3GPP TS 29.571 [7]. | + +## 7.2.4.3 Resource Standard Methods + +### 7.2.4.3.1 PUT + +This method shall support the URI query parameters specified in table 7.2.4.3.1-1. + +**Table 7.2.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 7.2.4.3.1-2 and the response data structures and response codes specified in table 7.2.4.3.1-3. + +**Table 7.2.4.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|---------------------------------------------------------------------------| +| PduSessionManagementData | M | 1 | Session management data for a UE and a PDU session is created or updated. | + +**Table 7.2.4.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|--------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PduSessionManagementData | M | 1 | 201 Created | Successful case.
The resource has been successfully created and a response body containing a representation of the session management data shall be returned. | +| PduSessionManagementData | M | 1 | 200 OK | Successful case.
The resource has been successfully updated and a response body containing a representation of the session management data shall be returned. | +| n/a | | | 204 No Content | Successful case.
The resource has been successfully updated and no additional content is to be sent in the response message. | + +NOTE: The HTTP status code for the PUT method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. + +**Table 7.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}/nudr-dr//exposure-data/{ueId}/session-management-data/{pduSessionId} | + +### 7.2.4.3.2 GET + +This method shall support the URI query parameters specified in table 7.2.4.3.2-1. + +**Table 7.2.4.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipv4-addr | Ipv4Addr | O | 0..1 | UE IPv4 address. | +| ipv6-prefix | Ipv6Prefix | O | 0..1 | UE IPv6 prefix. | +| dnn | Dnn | O | 0..1 | Identifies a DNN. | +| fields | array(string) | C | 1..N | When the NF consumer only retrieves a subset of the resource, the "fields" query parameter shall be included. The "fields" query parameter contains the pointers of the attribute(s) to be retrieved. | +| supp-feat | SupportedFeatures | O | 0..1 | The features supported by the NF service consumer.
See 3GPP TS 29.500 [4] clause 6.6.2 and 3GPP TS 29.571 [7]. | + +This method shall support the request data structures specified in table 7.2.4.3.2-2 and the response data structures and response codes specified in table 7.2.4.3.2-3. + +**Table 7.2.4.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.2.4.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response Codes | Description | +|-----------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------| +| PduSessionManagement Data | M | 1 | 200 OK | The response body contains the session management data. | +| NOTE: The HTTP status code for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +### 7.2.4.3.3 DELETE + +This method shall support the URI query parameters specified in table 7.2.4.3.3-1. + +**Table 7.2.4.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.4.3.3-2 and the response data structures and response codes specified in table 7.2.4.3.3-3. + +**Table 7.2.4.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 7.2.4.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. | +| NOTE: The HTTP status code for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply. | | | | | + +## 7.2.5 Resource: ExposureDataSubscriptions + +### 7.2.5.1 Description + +This resource is used to represent subscriptions to notifications of exposure data modifications. + +### 7.2.5.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//exposure-data/subs-to-notify + +This resource shall support the resource URI variables defined in table 7.2.5.2-1. + +**Table 7.2.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | + +### 7.2.5.3 Resource Standard Methods + +#### 7.2.5.3.1 POST + +This method shall support the URI query parameters specified in table 7.2.5.3.1-1. + +**Table 7.2.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 7.2.5.3.1-2 and the response data structures and response codes specified in table 7.2.5.3.1-3. + +**Table 7.2.5.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|----------------------------------------------------------------------------------------| +| ExposureDataSubscription | M | 1 | Identifies an individual subscription to notifications of exposure data modifications. | + +**Table 7.2.5.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ExposureDataSubscription | M | 1 | 201 Created | Upon success, a response body containing a representation of the Individual subscription resource shall be returned.

The HTTP response shall include a "Location" HTTP header that contains the resource URI of the created 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 [4] also apply. | | | | | + +**Table 7.2.5.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}/nudr-dr//exposure-data/subs-to-notify/{subId} | + +## 7.2.6 Resource: IndividualExposureDataSubscription + +### 7.2.6.1 Description + +This resource represents an individual subscription to notifications of exposure data modifications. + +### 7.2.6.2 Resource Definition + +Resource URI: {apiRoot}/nudr-dr//exposure-data/subs-to-notify/{subId} + +This resource shall support the resource URI variables defined in table 7.2.6.2-1. + +**Table 7.2.6.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See 3GPP TS 29.504 [6] clause 6.1.1. | +| subId | string | Identifies an individual subscription to notifications. The value is allocated by the UDR during creation of the IndividualExposureDataSubscription resource. | + +### 7.2.6.3 Resource Standard Methods + +#### 7.2.6.3.1 PUT + +This method shall support the URI query parameters specified in table 7.2.6.3.1-1. + +**Table 7.2.6.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 7.2.6.3.1-2 and the response data structures and response codes specified in table 7.2.6.3.1-3. + +**Table 7.2.6.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|----------------------------------------------------------------------------------------| +| ExposureDataSubscription | M | 1 | Identifies an individual subscription to notifications of exposure data modifications. | + +**Table 7.2.6.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| +| ExposureDataSubscription | M | 1 | 200 OK | The individual subscription resource was updated successfully and a body with the modified subscription to notifications about exposure data is returned. | +| n/a | | | 204 No Content | The individual subscription resource was successfully modified. | +| NOTE: 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. | | | | | + +#### 7.2.6.3.2 DELETE + +This method shall support the URI query parameters specified in table 7.2.6.3.2-1. + +**Table 7.2.6.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.2.6.3.2-2 and the response data structures and response codes specified in table 7.2.6.3.2-3. + +**Table 7.2.6.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------| +| n/a | | | The request body shall be empty. | + +**Table 7.2.6.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 | Upon success, an empty response body shall be returned. | +| NOTE: 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. | | | | | + +## 7.3 Data Model + +### 7.3.1 General + +This clause specifies the application data model supported by the API. + +Table 7.3.1-1 specifies the data types defined for the Nudr\_DataRepository for Exposure Data service based interface protocol. + +**Table 7.3.1-1: Nudr\_DataRepository specific Data Types for Exposure Data** + +| Data type | Section defined | Description | Applicability | +|--------------------------------|-----------------|---------------------------------------------------------------------------------|---------------| +| AccessAndMobilityData | 7.3.2.2 | | | +| ExposureDataChangeNotification | 7.3.2.5 | Contains changed exposure data for one UE for which Notification was requested. | | +| ExposureDataSubscription | 7.3.2.4 | Subscription to Notifications about Exposure Data. | | +| PduSessionManagementData | 7.3.2.3 | | | +| PduSessionStatus | 7.3.3.3 | Represents the state of the PDU session, i.e. active or released. | | + +Table 7.3.1-2 specifies data types re-used by the Nudr\_DataRepository for Exposure Data 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 Nudr\_DataRepository for Exposure Data service based interface. + +**Table 7.3.1-2: Nudr\_DataRepository re-used Data Types for Exposure Data** + +| Data type | Reference | Comments | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|------------------------------------------------------------------|----------------------| +| AccessType | 3GPP TS 29.571 [7] | Identifies the access type, i.e. 3GPP access or Non-3GPP access. | | +| CmlInfo | 3GPP TS 29.518 [10] | Describes the connectivity management state of a UE. | | +| DateTime | 3GPP TS 29.571 [7] | | | +| Dnai | 3GPP TS 29.571 [7] | Identifies a Data network access identifier. | | +| Dnn | 3GPP TS 29.571 [7] | Identifies a Data Network Name. (NOTE) | | +| Ipv4Addr | 3GPP TS 29.571 [7] | The IPv4 Address. | | +| Ipv6Addr | 3GPP TS 29.571 [7] | The Ipv6 Address. | | +| Ipv6Prefix | 3GPP TS 29.571 [7] | The Ipv6 Address Prefix. | | +| PduSessionId | 3GPP TS 29.571 [7] | PDU Session Identifier | | +| PduSessionType | 3GPP TS 29.571 [7] | PDU Session type. | | +| PlmnId | 3GPP TS 29.571 [7] | Identifies a PLMN. | | +| RatType | 3GPP TS 29.571 [7] | Identifies a RAT type. | | +| RmlInfo | 3GPP TS 29.518 [10] | Describes the registration management state of a UE. | | +| RouteToLocation | 3GPP TS 29.571 [7] | A traffic route to/from a DNAI. | | +| TimeZone | 3GPP TS 29.571 [7] | Identifies a time zone. | | +| SmsSupport | 3GPP TS 29.518 [10] | Indicates the supported SMS delivery of a UE. | | +| SupportedFeatures | 3GPP TS 29.571 [7] | Used to negotiate the applicability of the optional features. | | +| UeReachability | 3GPP TS 29.518 [10] | Describes the reachability of the UE. | | +| Uri | 3GPP TS 29.571 [7] | | | +| UserLocation | 3GPP TS 29.571 [7] | Identifies the user location. | | +| VarUeld | 3GPP TS 29.571 [7] | String represents the SUPI or GPSI. | | +| NOTE: The UDR uses the DNN as received from the NF service consumer without applying any transformation. To successfully perform DNN matching, 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. | | | | + +## 7.3.2 Structured data types + +### 7.3.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 7.3.2.2 Type AccessAndMobilityData + +**Table 7.3.2.2-1: Definition of type AccessAndMobilityData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| location | UserLocation | O | 0..1 | Current location for the UE, which can be a combination of E-UTRA, NR and non-3GPP access location. | | +| locationTs | DateTime | O | 0..1 | Indicates when the location was last updated. | | +| timeZone | TimeZone | O | 0..1 | Current time zone for the UE. | | +| timeZoneTs | DateTime | O | 0..1 | Indicates when the timeZone was last updated. | | +| accessType | AccessType | O | 0..1 | Current access type for the UE (3GPP access or non-3GPP access). | | +| accessTypeTs | DateTime | O | 0..1 | Indicates when the accessType was last updated. | | +| regStates | array(RmlInfo) | O | 1..N | Describes the registration management state of the UE. | | +| regStatesTs | DateTime | O | 0..1 | Indicates when the regStates were last updated. | | +| connStates | array(CmlInfo) | O | 1..N | Describes the connectivity management state of the UE. | | +| connStatesTs | DateTime | O | 0..1 | Indicates when the connStates were last updated. | | +| reachabilityStatus | UeReachability | O | 0..1 | Describes the reachability of the UE. | | +| reachabilityStatusTs | DateTime | O | 0..1 | Indicates when the reachabilityStatus was last updated. | | +| smsOverNasStatus | SmsSupport | O | 0..1 | Indicates the supported SMS delivery of the UE. | | +| smsOverNasStatusTs | DateTime | O | 0..1 | Indicates when the smsOverNasStatus was last updated. | | +| roamingStatus | boolean | O | 0..1 | True: The serving PLMN of the UE is different from the HPLMN of the UE;
False: The serving PLMN of the UE is the HPLMN of the UE. | | +| roamingStatusTs | DateTime | O | 0..1 | Indicates when the roamingStatus was last updated. | | +| currentPlmn | PlmnId | O | 0..1 | The identity of the PLMN serving the UE. | | +| currentPlmnTs | DateTime | O | 0..1 | Indicates when the currentPlmn was last updated. | | +| ratTypes | array(RatType) | O | 1..N | RAT type(s) | | +| ratTypesTs | DateTime | O | 0..1 | Indicates when the ratTypes was last updated. | | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 7.5.
Shall be present in the HTTP PUT request/response; or in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE) | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | + +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 UDR. + +### 7.3.2.3 Type PduSessionManagementData + +**Table 7.3.2.3-1: Definition of type PduSessionManagementData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------|------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------| +| pduSessionStatus | PduSessionStatus | O | 0..1 | Status of the PDU session. | | +| pduSessionStatusTs | DateTime | O | 0..1 | Indicates when the pduSessionStatus was last updated. | | +| dnai | Dnai | O | 0..1 | DNAI | | +| dnaiTs | DateTime | O | 0..1 | Indicates when the dnai was last updated. | | +| n6TrafficRoutingInfo | array(RouteToLocation) | O | 1..N | N6 traffic routing information. | | +| n6TrafficRoutingInfoTs | DateTime | O | 0..1 | Indicates when the n6TrafficRoutingInfo was last updated. | | +| ipv4Addr | Ipv4Addr | O | 0..1 | UE IPv4 address. | | +| ipv6Prefix | array(Ipv6Prefix) | O | 1..N | UE IPv6 prefix. | | +| ipv6Addrs | array(Ipv6Addr) | O | 1..N | IPv6 addresses. | | +| pduSessType | PduSessionType | O | 0..1 | PDU session type. | | +| ipAddrTs | DateTime | O | 0..1 | Indicates when the ipv4Addr and Ipv6Prefix were last updated. | | +| dnn | Dnn | O | 0..1 | DNN | | +| pduSessionId | PduSessionId | O | 0..1 | The identifier of a PduSessionManagement resource. (NOTE 1). | ResourceNotificationExposureDataFix | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features used as described in clause 7.5.
Shall be present in the HTTP PUT request/response; or in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. (NOTE 2) | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | + +NOTE 1: The "pduSessionId" attribute shall be present when the ResourceNotificationExposureDataFix is supported. + +NOTE 2: 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 UDR. + +### 7.3.2.4 Type ExposureDataSubscription + +**Table 7.3.2.4-1: Definition of type ExposureDataSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|---------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| notificationUri | Uri | M | 1 | URI provided by the NF service consumer indicating where to receive to subscribed notifications from the UDR. | | +| monitoredResourceUris | array(Uri) | M | 1..N | A set of URIs that identify the resources for which a modification triggers a notification. | | +| expiry | DateTime | C | 0..1 | This IE shall be included in a subscription response if, based on operator policy and taking into account the expiry time included in the request, the UDR needs to include an expiry time.
This IE may be included in a subscription request. When present, this IE shall represent the time after which the subscription becomes invalid.
The absence of this attribute in the subscription response means the subscription to be valid without an expiry time. | | +| supportedFeatures | SupportedFeatures | C | 0..1 | Used to negotiate the applicability of the optional features.
This attribute shall be provided in the POST request and in the response of successful resource creation. | | +| resetIds | array(string) | O | 1..N | This IE uniquely identifies a part of temporary data in UDR that contains the created resource.
This attribute may be provided in the response of successful resource creation. | | +| immRep | boolean | O | 0..1 | If provided and set to "true", it indicates that existing entries that match this subscription shall be immediately reported within the "immReports" attribute in the response. The default value is false. | ImmediateReportPcc | +| immReports | array(ExposureDataChangeNotification) | O | 1..N | Contains entries stored in the UDR that match this subscription.
It may be included only in the POST (or PUT) response body of a subscription creation (or modification), and only if the request included the "immRep" attribute set to true. | ImmediateReportPcc | + +### 7.3.2.5 Type ExposureDataChangeNotification + +**Table 7.3.2.5-1: Definition of type ExposureDataChangeNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|---------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueId | VarUeId | O | 0..1 | User identity of modified data. | | +| accessAndMobilityData | AccessAndMobilityData | O | 0..1 | Access and Mobility Data for the UE. | | +| pduSessionManagementData | array(PduSessionManagementData) | O | 1..N | PDU Session Management Data for one or several PDU sessions of the UE. | | +| delResources | array(Uri) | O | 1..N | The resources, as defined in table 7.2.2-1, if removed from UDR and notification on resource data change was requested. It may be present when the ResourceNotificationExposureDataFix is supported (NOTE). | | + +NOTE: When the "delResources" attribute is present, the attributes that correspond with the values included in the "delResources" attribute shall be omitted. I.e., when the "delResources" attribute includes the value "../{ueId}/access-and-mobility-data" the attribute "accessAndMobilityData" shall be omitted, and when the "delResources" attribute includes all the existing "../{ueId}/session-management-data/{pduSessionId}" resource URIs, the attribute "pduSessionManagementData" shall be omitted. + +## 7.3.3 Simple data types and enumerations + +### 7.3.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.3.2 Simple data types + +The simple data types defined in table 7.3.3.2-1 shall be supported. + +**Table 7.3.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +### 7.3.3.3 Enumeration: PduSessionStatus + +**Table 7.3.3.3-1: Enumeration PduSessionStatus** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------|---------------| +| "ACTIVE" | The PDU session is active. | | +| "RELEASED" | The PDU session is released. | | + +## 7.4 Error handling + +### 7.4.1 General + +For the Nudr\_DataRepository service API for Exposure Data, 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 Nudr\_DataRepository service API for Exposure Data. + +## 7.4.2 Protocol Errors + +No specific procedures for the Nudr\_DataRepository service API for Exposure Data are specified. + +## 7.4.3 Application Errors + +The application errors defined for the Nudr\_DataRepository service API for Exposure Data are listed in table 7.4.3-1. + +**Table 7.4.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +The application error handling shall follow 3GPP TS 29.504 [6] clause 6.1.6 unless explicitly specified in this document. + +## 7.5 Feature negotiation + +The optional features in table 6.1.8-1 of 3GPP TS 29.504 [6] are defined for the Nudr\_DataRepository API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [4]. + +## 7.6 Notifications + +### 7.6.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [4] and clause 4.6.2.3 of 3GPP TS 29.501 [5]. + +This clause describes the resources to provide Notification to NF service consumers which have subscribed to be notified when exposure data is changed. + +**Table 7.6.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|-----------------------------------|-------------------|---------------------------------|-----------------------------------| +| Exposure Data Change Notification | {notificationUri} | POST | Exposure Data Change Notification | + +### 7.6.2 Exposure Data Change Notification + +The POST method shall be used for Data Change Notifications and the URI shall be as provided during the subscription procedure. + +Callback URI: {notificationUri} + +Support of URI query parameters is specified in table 7.6.2-1. + +**Table 7.6.2-1: URI query parameters supported by the POST method** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Support of request data structures is specified in table 7.6.2-2 and of response data structures and response codes is specified in table 7.6.2-3. + +**Table 7.6.2-2: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|----------------------------------------|---|-------------|----------------------------------------------------------------------------| +| array(ExposureDataChange Notification) | M | 1..N | Each element in the array provides the changed exposure data for one user. | + +**Table 7.6.2-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. | +| 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. | | | | | + +## Annex A (normative): OpenAPI specification + +### A.1 General + +The present Annex contains an OpenAPI [3] specification of HTTP messages and content bodies used by the Nudr\_DataRepository service for Policy Data, Application Data and Exposure Data. + +This Annex shall take precedence when being discrepant to other parts of the specification with respect to the encoding of information elements and methods. + +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 clause 5B of the 3GPP TR 21.900 [18] and clause 5.3.1 of the 3GPP TS 29.501 [5] for further information). + +### A.2 Nudr\_DataRepository API for Policy Data + +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 "TS29519\_Policy\_Data.yaml". + +``` +openapi: 3.0.0 + +info: + version: '-' + title: Unified Data Repository Service API file for policy data + description: | + The API version is defined in 3GPP TS 29.504 + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.519 V18.4.0; 5G System; Usage of the Unified Data Repository Service for Policy Data, + Application Data and Structured Data for Exposure. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.519/' + +paths: + /policy-data/ues/{ueId}: +``` + +``` + +parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +get: + summary: Retrieve the policy data for a subscriber + operationId: ReadPolicyData + tags: + - PolicyDataForIndividualUe (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + - name: data-subset-names + in: query + style: form + explode: false + description: List of policy data subset names + required: false + schema: + type: array + items: + $ref: '#/components/schemas/PolicyDataSubset' + minItems: 2 + responses: + '200': + description: Upon success, a response body containing policy data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataForIndividualUe' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/ues/{ueId}/am-data: + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + get: + summary: Retrieves the access and mobility policy data for a subscriber + operationId: ReadAccessAndMobilityPolicyData + tags: + - AccessAndMobilityPolicyData (Document) + +``` + +``` + +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:am-data:read +parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: > + Upon success, a response body containing access and mobility policies shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AmPolicyData' + '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' + +/policy-data/ues/{ueId}/ue-policy-set: + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + get: + summary: Retrieves the UE policy set data for a subscriber + operationId: ReadUEPolicySet + tags: + - UEPolicySet (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:ue-policy-set:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + +``` + +``` + +'200': + description: Upon success, a response body containing UE policies shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' +'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: Create or modify the UE policy set data for a subscriber + operationId: CreateOrReplaceUEPolicySet + tags: + - UEPolicySet (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:ue-policy-set:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' + responses: + '201': + description: > + Successful case. The resource has been successfully created and a response body + containing a representation of the created UEPolicySet resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '200': + description: > + Successful case. The resource has been successfully created and a response body + containing UE policies shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' + '204': + description: > + Successful case. The resource has been successfully updated and no additional content + is to be sent in the response message. + '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' +patch: +summary: Modify the UE policy set data for a subscriber +operationId: UpdateUEPolicySet +tags: +- UEPolicySet (Document) +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- nudr-dr:policy-data:ues:ue-policy-set:modify +requestBody: +required: true +content: +application/merge-patch+json: +schema: +$ref: '#/components/schemas/UePolicySetPatch' +responses: +'204': +description: > +Successful case. The resource has been successfully updated and no additional content is +to be sent in the response message. +'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' + +/policy-data/ues/{ueId}/sm-data: +get: +summary: Retrieves the session management policy data for a subscriber +operationId: ReadSessionManagementPolicyData +tags: +``` + +``` + + - SessionManagementPolicyData (Document) +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- nudr-dr:policy-data:ues:sm-data:read +parameters: +- name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: snssai + in: query + required: false + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' +- name: dnn + in: query + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +- name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 +- name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: +'200': + description: Upon success, a response body containing SmPolicyData shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyData' +'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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +patch: +summary: Modify the session management policy data for a subscriber +operationId: UpdateSessionManagementPolicyData +tags: + +``` + +``` + + - SessionManagementPolicyData (Document) +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- nudr-dr:policy-data:ues:sm-data:modify +parameters: +- name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SmPolicyDataPatch' +responses: + '204': + description: > + Successful case. The resource has been successfully updated and no + additional content is to be sent in the response message. + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyData' + '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' + +/policy-data/ues/{ueId}/sm-data/{usageMonId}: + get: + summary: Retrieve a usage monitoring resource + operationId: ReadUsageMonitoringInformation + tags: + - UsageMonitoringInformation (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:sm-data:read + parameters: + +``` + +``` +- name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +- name: usageMonId + in: path + required: true + schema: + type: string +- name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Successful case. The usage monitoring data is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UsageMonData' + '204': + description: The resource was found but no usage monitoring data is available. + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Create a usage monitoring resource + operationId: CreateUsageMonitoringResource + tags: + - UsageMonitoringInformation (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:sm-data:create + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: usageMonId + in: path + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: +``` + +``` + schema: + $ref: '#/components/schemas/UsageMonData' +responses: + '201': + description: > + Successful case. The resource has been successfully created and a response body is + returned containing a representation of the resource. + content: + application/json: + schema: + $ref: '#/components/schemas/UsageMonData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + 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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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: Delete a usage monitoring resource + operationId: DeleteUsageMonitoringInformation + tags: + - UsageMonitoringInformation (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:sm-data:modify + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: usageMonId + in: path + required: true + schema: + type: string + responses: + '204': + description: Successful case. The resource has been successfully deleted. + '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' + +/policy-data/sponsor-connectivity-data/{sponsorId}: + parameters: + - name: sponsorId + in: path + required: true + schema: + type: string + get: + summary: Retrieves the sponsored connectivity information for a given sponsorId + operationId: ReadSponsorConnectivityData + tags: + - SponsorConnectivityData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:sponsor-connectivity-data:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + Upon success, a response body containing Sponsor Connectivity Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SponsorConnectivityData' + '204': + description: The resource was found but no Sponsor Connectivity Data is available. + '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' + +/policy-data/bdt-data: + get: + summary: Retrieves the BDT data collection +``` + +``` + +operationId: ReadBdtData +tags: + - BdtData (Store) +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdtd-data:read +parameters: + - name: bdt-ref-ids + in: query + description: List of the BDT reference identifiers. + required: false + schema: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + minItems: 1 + style: form + explode: false + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Upon success, a response body containing the BDT data shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BdtData' + '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' + +/policy-data/bdt-data/{bdtReferenceId}: + parameters: + - name: bdtReferenceId + in: path + required: true + schema: + type: string + get: + summary: Retrieves the BDT data information associated with a BDT reference Id + operationId: ReadIndividualBdtData + tags: + - IndividualBdtData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + +``` + +``` + + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdtd-data:read +parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: Upon success, a response body containing the BDT data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtData' + '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: Creates an BDT data resource associated with an BDT reference Id + operationId: CreateIndividualBdtData + tags: + - IndividualBdtData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdtd-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BdtData' + responses: + '201': + description: Successful case. The resource has been successfully created. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + 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' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'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' +patch: + summary: Modifies an BDT data resource associated with an BDT reference Id + operationId: UpdateIndividualBdtData + tags: + - IndividualBdtData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdtd-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/BdtDataPatch' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/BdtData' + '204': + description: > + Successful case. The resource has been successfully updated and no additional content + is to be sent in the response message. + '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 an BDT data resource associated with an BDT reference Id + operationId: DeleteIndividualBdtData + tags: + - IndividualBdtData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:bdtd-data:modify + responses: + '204': + description: Successful case. The resource has been successfully deleted. + '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' + +/policy-data/subs-to-notify: + get: + summary: Retrieves the list of Individual Policy Data Subscription resources + operationId: ReadPolicyDataSubscriptions + tags: + - PolicyDataSubscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:subs-to-notify:read + parameters: + - name: mon-resources + in: query + style: form + explode: false + description: List of monitored resources whose subscriptions are requested. + required: false + schema: + type: array + items: + type: string + description: Contains the apiSpecificResourceUriPart of the resource URI. + minItems: 1 + - name: ue-id + in: query + description: Represents the Subscription Identifier SUPI or GPSI. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supp-feat + +``` + +``` + +in: query +description: Supported Features +required: false +schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: > + Upon success, a response body containing a list of Individual Policy Data + Subscription resources shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PolicyDataSubscription' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +post: + summary: Create a subscription to receive notification of policy data changes + operationId: CreateIndividualPolicyDataSubscription + tags: + - PolicyDataSubscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data:subs-to-notify + - nudr-dr:policy-data:subs-to-notify:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + responses: + '201': + description: > + Upon success, a response body containing a representation of each Individual + subscription resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource' + 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: + policyDataChangeNotification: + '{ $request.body#/notificationUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PolicyDataChangeNotification' + minItems: 1 + responses: + '204': + description: No Content, Notification was successful + '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' + +/policy-data/subs-to-notify/{subsId}: + parameters: + - name: subsId + in: path + required: true + schema: + type: string + get: + summary: Retrieves Individual Policy Subscription data + operationId: ReadIndividualPolicySubscriptionData + tags: + - IndividualPolicySubscriptionData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + +``` + +``` + + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:subs-to-notify:read +responses: + '200': + description: > + Upon success, a response body containing Policy Data Subscription shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Modify a subscription to receive notification of policy data changes + operationId: ReplaceIndividualPolicyDataSubscription + tags: + - IndividualPolicyDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:subs-to-notify:modify + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + responses: + '200': + description: The individual subscription resource was updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/PolicyDataSubscription' + '204': + description: > + The individual subscription resource was updated successfully and no + additional content is to be sent in the response message. + '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: Delete the individual Policy Data subscription + operationId: DeleteIndividualPolicyDataSubscription + tags: + - IndividualPolicyDataSubscription (Document) + responses: + '204': + description: Upon success, an empty response body shall be returned. + '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' + +/policy-data/ues/{ueId}/operator-specific-data: + get: + summary: Retrieve the operator specific policy data of an UE + operationId: ReadOperatorSpecificData + tags: + - OperatorSpecificData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:operator-specific-data:read + parameters: + - name: ueId + in: path + description: UE Id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +``` + +``` +responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + type: object + additionalProperties: + $ref: + 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify the operator specific policy data of a UE + operationId: UpdateOperatorSpecificData + tags: + - OperatorSpecificData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:operator-specific-data:modify + parameters: + - name: ueId + in: path + description: UE Id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + content: + application/json-patch+json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchItem' + required: true + responses: + '204': + description: No content. Response to successful modification. + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PatchResult' + '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' +put: + summary: Create or modify the operator specific policy data of a UE + operationId: ReplaceOperatorSpecificData + tags: + - OperatorSpecificData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:operator-specific-data:create + parameters: + - name: ueId + in: path + description: UE Id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + required: true + content: + application/json: + schema: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + '201': + description: > + Successful case. When the feature OSResource_Create_Delete is supported + and the resource has been successfully created, a response body containing a + representation of the created OperatorSpecificData resource shall be returned. + content: + application/json: + schema: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + headers: + - Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + +``` + +``` + + type: string + '204': + description: The resource has been successfully updated. + '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: When the feature OSResource_Create_Delete is supported, delete OperatorSpecificData +resource + operationId: DeleteOperatorSpecificData + tags: + - OperatorSpecificData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:ues:operator-specific-data:modify + parameters: + - name: ueId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + responses: + '204': + description: Successful case. The resource has been successfully deleted. + '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' + +/policy-data/plmns/{plmnId}/ue-policy-set: + parameters: + - name: plmnId + in: path + required: true + schema: + +``` + +``` + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/VarPlmnId' +get: + summary: Retrieve the UE policy set data for an H-PLMN + operationId: ReadPlmnUePolicySet + tags: + - PlmnUePolicySet (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:plmns:ue-policy-set:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: Upon success, a response body containing UE policies shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/UePolicySet' + '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' + '412': + $ref: 'TS29571_CommonData.yaml#/components/responses/412' + '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' + +/policy-data/slice-control-data/{snssai}: + parameters: + - name: snssai + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + get: + summary: Retrieves a network Slice specific policy control data resource + operationId: ReadSlicePolicyControlData + tags: + - SlicePolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:slice-control-data:read + parameters: +``` + +``` + +- name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: > + Successful case. The network slice specific policy control data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SlicePolicyData' + '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: Modify a network Slice specific policy control data resource + operationId: UpdateSlicePolicyControlData + tags: + - SlicePolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:slice-control-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/SlicePolicyDataPatch' + responses: + '200': + description: > + The resource has been successfully updated and a response body containing network + slice specific policy control data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/SlicePolicyData' + '204': + description: > + The resource has been successfully updated and no additional content is + to be sent in the response message. + '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' + +/policy-data/mbs-session-pol-data/{polSessionId}: + parameters: + - name: polSessionId + description: > + Represents the identifier of the MBS Session Policy Control Data. + in: path + required: true + schema: + $ref: '#/components/schemas/MbsSessPolDataId' + + get: + summary: Retrieve MBS Session Policy Control Data for an MBS Session. + operationId: GetMBSSessPolCtrlData + tags: + - MBSSessionPolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:mbs-session-pol-data:read + responses: + '200': + description: > + OK. The requested MBS Session Policy Control Data is successfully returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MbsSessPolCtrlData' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/policy-data/pdtq-data: + get: + summary: Retrieves the PDTQ data collection + operationId: ReadPdtqData + tags: + +``` + +``` + + - PdtqData (Store) +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:policy-data +- nudr-dr:policy-data:pdtq-data:read +parameters: +- name: pdtq-ref-ids + in: query + description: List of the PDTQ reference identifiers. + required: false + schema: + type: array + items: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqReferenceId' + minItems: 1 + style: form + explode: false +- name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: +'200': + description: Upon success, a response body containing the PDTQ data shall be returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PdtqData' +'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' + +/policy-data/pdtq-data/{pdtqReferenceId}: +parameters: +- name: pdtqReferenceId + in: path + required: true + schema: + type: string +get: + summary: Retrieves the PDTQ data information associated with a PDTQ reference Id + operationId: ReadIndividualPdtqData + tags: + - IndividualPdtqData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + +``` + +``` +- nudr-dr:policy-data +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:pdtq-data:read +parameters: +- name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: +'200': + description: Upon success, a response body containing the PDTQ data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqData' +'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: Creates a PDTQ data resource associated with a PDTQ reference Id + operationId: CreateIndividualPdtqData + tags: + - IndividualPdtqData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:pdtq-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqData' + responses: +'201': + description: Successful case. The resource has been successfully created. + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + 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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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' +patch: + summary: Modifies a PDTQ data resource associated with a PDTQ reference Id + operationId: UpdateIndividualPdtqData + tags: + - IndividualPdtqData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:pdqt-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PdtqDataPatch' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqData' + '204': + description: > + Successful case. The resource has been successfully updated and no additional content + is to be sent in the response message. + '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 a PDTQ data resource associated with a PDTQ reference Id + operationId: DeleteIndividualPdtqData + tags: + - IndividualPdtqData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:pdtq-data:modify + responses: + '204': + description: Successful case. The resource has been successfully deleted. + '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' + +/policy-data/group-control-data/{intGroupId}: + parameters: + - name: intGroupId + in: path + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + + get: + summary: Retrieves a group specific policy control subscription data resource + operationId: ReadGroupPolCtrlData + tags: + - GroupPolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:group-control-data:read + parameters: + - name: supp-feat + in: query + description: Represents the supported features. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + Successful case. The requested group specific policy control subscription data shall be + returned. + content: + application/json: + schema: +``` + +``` + + $ref: '#/components/schemas/GroupPolicyData' + '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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +patch: + summary: Modify an existing group specific policy control subscription data resource. + operationId: ModifyGroupPolCtrlData + tags: + - GroupPolicyControlData (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:policy-data + - nudr-dr:policy-data:group-control-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/GroupPolicyDataPatch' + responses: + '200': + description: > + The resource has been successfully modified and a response body containing the updated + group specific policy control subscription data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/GroupPolicyData' + '204': + description: > + The resource has been successfully modified and no additional content is to be sent in + the response body. + '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' + +``` + +components: + +schemas: + +PolicyDataForIndividualUe: + +description: Contains policy data for a given subscriber. + +type: object + +properties: + +uePolicyDataSet: + +\$ref: '#/components/schemas/UePolicySet' + +smPolicyDataSet: + +\$ref: '#/components/schemas/SmPolicyData' + +amPolicyDataSet: + +\$ref: '#/components/schemas/AmPolicyData' + +umData: + +type: object + +additionalProperties: + +\$ref: '#/components/schemas/UsageMonData' + +minProperties: 1 + +description: > + +Contains UM policies. The value of the limit identifier is used as the key of the map. + +operatorSpecificDataSet: + +type: object + +additionalProperties: + +\$ref: 'TS29505\_Subscription\_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + +minProperties: 1 + +description: > + +Contains Operator Specific Data resource data. The key of the map is operator specific data element name and the value is the operator specific data of the UE. + +suppFeat: + +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/SupportedFeatures' + +AmPolicyData: + +description: Contains the AM policy data for a given subscriber. + +type: object + +properties: + +praInfos: + +type: object + +additionalProperties: + +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/PresenceInfo' + +minProperties: 1 + +description: > + +Contains Presence reporting area information. The praId attribute within the PresenceInfo data type is the key of the map. + +subscCats: + +type: array + +items: + +type: string + +minItems: 1 + +chfInfo: + +\$ref: 'TS29512\_Npcf\_SMPolicyControl.yaml#/components/schemas/ChargingInformation' + +subscSpendingLimits: + +type: boolean + +description: > + +Indicates whether the PCF must enforce Access and Mobility management related policies based on subscriber spending limits. + +suppFeat: + +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/SupportedFeatures' + +UePolicySet: + +description: Contains the UE policy data for a given subscriber. + +type: object + +properties: + +praInfos: + +type: object + +additionalProperties: + +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/PresenceInfo' + +minProperties: 1 + +description: > + +Contains Presence reporting area information. The praId attribute within the PresenceInfo data type is the key of the map. + +subscCats: + +type: array + +items: + +type: string + +minItems: 1 + +uePolicySections: + +type: object + +``` + additionalProperties: + $ref: '#/components/schemas/UePolicySection' + minProperties: 1 + description: > + Contains the UE Policy Sections. The UE Policy Section Identifier is used as + the key of the map. + upsis: + type: array + items: + type: string + minItems: 1 + allowedRouteSelDescs: + type: object + additionalProperties: + $ref: '#/components/schemas/PlmnRouteSelectionDescriptor' + minProperties: 1 + description: > + Contains allowed route selection descriptors per serving PLMN for a UE. + The serving PLMN identifier is the key of the map. + andspInd: + type: boolean + epsUrspInd: + type: boolean + description: Indication of UE supporting URSP provisioning in EPS. + vpsUrspInd: + type: boolean + description: Indication of UE supporting VPLMN-specific URSP. + urspEnfind: + type: boolean + description: Indication of UE supporting URSP enforcement report. + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + osIds: + type: array + items: + $ref: '#/components/schemas/OsId' + minItems: 1 + chfInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ChargingInformation' + subscSpendingLimits: + type: boolean + description: > + Indicates whether the PCF must enforce UE policies based on subscriber spending limits. + tracingReq: + type: array + items: + type: string + minItems: 1 + description: > + Tracing requirements as defined in TS 32.421 [26] + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + +UePolicySetPatch: + description: Contains the UE policy set for a given subscriber. + type: object + properties: + uePolicySections: + type: object + additionalProperties: + $ref: '#/components/schemas/UePolicySection' + minProperties: 1 + description: > + Contains the UE Policy Sections. The UE Policy Section Identifier is used + as the key of the map. + upsis: + type: array + items: + type: string + minItems: 1 + andspInd: + type: boolean + epsUrspInd: +``` + +``` + type: boolean + description: Indication of UE supporting URSP provisioning in EPS. + vpsUrspInd: + type: boolean + description: Indication of UE supporting VPLMN-specific URSP. + urspEnfInd: + type: boolean + description: Indication of UE supporting URSP enforcement report. + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + osIds: + type: array + items: + $ref: '#/components/schemas/OsId' + minItems: 1 + + UePolicySection: + description: Contains the UE policy section. + type: object + properties: + uePolicySectionInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + upsi: + type: string + required: + - uePolicySectionInfo + - upsi + + SmPolicyData: + description: Contains the SM policy data for a given subscriber. + type: object + properties: + smPolicySnssaiData: + type: object + additionalProperties: + $ref: '#/components/schemas/SmPolicySnssaiData' + minProperties: 1 + description: > + Contains Session Management Policy data per S-NSSAI for all the SNSSAIs + of the subscriber. The key of the map is the S-NSSAI. + umDataLimits: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonDataLimit' + minProperties: 1 + description: > + Contains a list of usage monitoring profiles associated with the subscriber. + The limit identifier is used as the key of the map. + umData: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonData' + minProperties: 1 + description: > + Contains the remaining allowed usage data associated with the subscriber. + The limit identifier is used as the key of the map. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - smPolicySnssaiData + + SmPolicySnssaiData: + description: Contains the SM policy data for a given subscriber and S-NSSAI. + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + smPolicyDnnData: + type: object + additionalProperties: + $ref: '#/components/schemas/SmPolicyDnnData' + minProperties: 1 + description: > + Session Management Policy data per DNN for all the DNNs of the indicated S-NSSAI. + The key of the map is the DNN. + ueSliceMbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SliceMbr' + required: +``` + +``` + +- snssai + +SmPolicyDnnData: + description: Contains the SM policy data for a given DNN (and S-NSSAI). + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + allowedServices: + type: array + items: + type: string + minItems: 1 + subscCats: + type: array + items: + type: string + minItems: 1 + gbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + gbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + adcSupport: + type: boolean + subscSpendingLimits: + type: boolean + description: > + Indicates whether the PCF must enforce session management related policies based + on subscriber spending limits. + ipv4Index: + $ref: '#/components/schemas/IpIndex' + ipv6Index: + $ref: '#/components/schemas/IpIndex' + offline: + type: boolean + online: + type: boolean + chfInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ChargingInformation' + refUmDataLimitIds: + type: object + additionalProperties: + $ref: '#/components/schemas/LimitIdToMonitoringKey' + minProperties: 1 + description: > + A reference to the UsageMonDataLimit or UsageMonData instances for this DNN and SNSSAI + that may also include the related monitoring key(s). + The key of the map is the limit identifier. + mpsPriority: + type: boolean + mcsPriority: + type: boolean + imsSignallingPrio: + type: boolean + mpsPriorityLevel: + type: integer + mcsPriorityLevel: + type: integer + praInfos: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: > + Contains Presence reporting area information. The praId attribute within the + PresenceInfo data type is the key of the map. + bdtRefIds: + type: object + additionalProperties: + $ref: '#/components/schemas/BdtReferenceIdRm' + minProperties: 1 + description: > + Identifies transfer policies of background data transfer. Any string value can + be used as a key of the map. + nullable: true + locRoutNotAllowed: + type: boolean + sfcNotAllowed: + +``` + +``` + type: boolean + tnaps: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TnapId' + minItems: 1 + description: Contains the TNAP IDs collocated with the 5G-RG(s) of a specific user. + required: + - dnn + +UsageMonDataLimit: + description: Contains usage monitoring control data for a subscriber. + type: object + properties: + limitId: + type: string + scopes: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonDataScope' + minProperties: 1 + description: > + Identifies the SNSSAI and DNN combinations to which the usage monitoring data + limit applies. The S-NSSAI is the key of the map. + umLevel: + $ref: '#/components/schemas/UsageMonLevel' + startDate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endDate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + usageLimit: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + resetPeriod: + $ref: '#/components/schemas/TimePeriod' + required: + - limitId + +UsageMonData: + description: Contains remain allowed usage data for a subscriber. + type: object + properties: + limitId: + type: string + scopes: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonDataScope' + minProperties: 1 + description: > + Identifies the SNSSAI and DNN combinations for remain allowed usage data + for a subscriber. The S-NSSAI is the key of the map. + umLevel: + $ref: '#/components/schemas/UsageMonLevel' + allowedUsage: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + resetTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + required: + - limitId + +LimitIdToMonitoringKey: + description: > + Contains the limit identifier and the corresponding monitoring key for a given + S-NSSAI and DNN. + type: object + properties: + limitId: + type: string + monkey: + type: array + items: +``` + +``` + type: string + minItems: 1 + required: + - limitId + nullable: true + +UsageMonDataScope: + description: > + Contains a SNSSAI and DNN combinations to which the UsageMonData instance belongs to. + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + dnn: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + required: + - snssai + +TimePeriod: + description: Contains the periodicity for the defined usage monitoring data limits. + type: object + properties: + period: + $ref: '#/components/schemas/Periodicity' + maxNumPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + required: + - period + +SponsorConnectivityData: + description: > + Contains the sponsored data connectivity related information for a sponsor identifier. + type: object + properties: + aspIds: + type: array + items: + type: string + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - aspIds + +BdtData: + description: Contains the background data transfer data. + type: object + properties: + aspId: + type: string + transPolicy: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/TransferPolicy' + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + nwAreaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + numOfUes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + volPerUe: + $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + trafficDes: + $ref: 'TS29122_ResourceManagementOfBdt.yaml#/components/schemas/TrafficDescriptor' + bdtpStatus: + $ref: '#/components/schemas/BdtPolicyStatus' + warnNotifEnabled: + type: boolean + description: > + Indicates whether the BDT warning notification is enabled (true) or not (false). + Default value is false. + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + suppFeat: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +resetIds: + type: array + items: + type: string + minItems: 1 +required: +- aspId +- transPolicy + +PolicyDataSubscription: + description: Identifies a subscription to policy data change notification. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifId: + type: string + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monResItems: + type: array + items: + $ref: '#/components/schemas/ResourceItem' + minItems: 1 + excludedResItems: + type: array + items: + $ref: '#/components/schemas/ResourceItem' + minItems: 1 + immRep: + type: boolean + description: > + If provided and set to true, it indicates that existing entries that + match this subscription shall be immediately reported in the response. + immReports: + type: array + items: + $ref: '#/components/schemas/PolicyDataChangeNotification' + minItems: 1 + description: Immediate report with existing UDR entries. + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + subsId: + type: string + required: + - notificationUri + - monitoredResourceUris + +PolicyDataChangeNotification: + description: Contains changed policy data for which notification was requested. + type: object + properties: + amPolicyData: + $ref: '#/components/schemas/AmPolicyData' + uePolicySet: + $ref: '#/components/schemas/UePolicySet' + plmnUePolicySet: + $ref: '#/components/schemas/UePolicySet' + smPolicyData: + $ref: '#/components/schemas/SmPolicyData' + usageMonData: + $ref: '#/components/schemas/UsageMonData' + SponsorConnectivityData: + $ref: '#/components/schemas/SponsorConnectivityData' + bdtData: + $ref: '#/components/schemas/BdtData' + opSpecData: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' +``` + +``` + +opSpecDataMap: + type: object + additionalProperties: + $ref: 'TS29505_Subscription_Data.yaml#/components/schemas/OperatorSpecificDataContainer' + minProperties: 1 + description: > + Operator Specific Data resource data, if changed and notification was requested. + The key of the map is operator specific data element name and the value is the + operator specific data of the UE. + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + sponsorId: + type: string + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + usageMonId: + type: string + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + delResources: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + notifId: + type: string + reportedFragments: + type: array + items: + $ref: '#/components/schemas/NotificationItem' + minItems: 1 + slicePolicyData: + $ref: '#/components/schemas/SlicePolicyData' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + pdtqData: + $ref: '#/components/schemas/PdtqData' + pdtqRefId: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqReferenceId' + groupPolicyData: + $ref: '#/components/schemas/GroupPolicyData' + intGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + +PlmnRouteSelectionDescriptor: + description: > + Contains the route selection descriptors (combinations of SNSSAI, DNNs, PDU session types, + SSC modes and ATSSS information) allowed by subscription to the UE for a serving PLMN + type: object + properties: + servingPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + snssaiRouteSelDescs: + type: array + items: + $ref: '#/components/schemas/SnssaiRouteSelectionDescriptor' + minItems: 1 + required: + - servingPlmn + +SnssaiRouteSelectionDescriptor: + description: > + Contains the route selector parameters (DNNs, PDU session types, SSC modes and ATSSS + information) per SNSSAI + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnnRouteSelDescs: + type: array + items: + $ref: '#/components/schemas/DnnRouteSelectionDescriptor' + minItems: 1 + required: + - snssai + +DnnRouteSelectionDescriptor: + description: > + +``` + +``` +Contains the route selector parameters (PDU session types, SSC modes and ATSSS +information) per DNN +type: object +properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sscModes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScMode' + minItems: 1 + pduSessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + minItems: 1 + atsssInfo: + description: > + Indicates whether MA PDU session establishment is allowed for this DNN. + When set to value true MA PDU session establishment is allowed for this DNN. + type: boolean + default: false + lboRoamAllowed: + type: boolean + description: > + Indicates whether LBO for the DNN and S-NSSAI is allowed when roaming. +required: +- dnn + +SmPolicyDataPatch: + description: Contains the SM policy data for a given subscriber. + type: object + properties: + umData: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonData' + minProperties: 1 + description: > + Contains the remaining allowed usage data associated with the subscriber. + The value of the limit identifier is used as the key of the map. + nullable: true + smPolicySnssaiData: + type: object + additionalProperties: + $ref: '#/components/schemas/SmPolicySnssaiDataPatch' + minProperties: 1 + description: > + Modifiable Session Management Policy data per S-NSSAI for all the SNSSAIs + of the subscriber. The key of the map is the S-NSSAI. + +SmPolicySnssaiDataPatch: + description: Contains the SM policy data for a given subscriber and S-NSSAI. + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + smPolicyDnnData: + type: object + additionalProperties: + $ref: '#/components/schemas/SmPolicyDnnDataPatch' + minProperties: 1 + description: > + Modifiable Session Management Policy data per DNN for all the DNNs of the + indicated S-NSSAI. The key of the map is the DNN. +required: +- snssai + +SmPolicyDnnDataPatch: + description: Contains the SM policy data for a given DNN (and S-NSSAI). + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + bdtRefIds: + type: object + additionalProperties: + $ref: '#/components/schemas/BdtReferenceIdRm' + minProperties: 1 +``` + +``` + description: > + Contains updated transfer policies of background data transfer. + Any string value can be used as a key of the map. + nullable: true + required: + - dnn + +ResourceItem: + description: > + Identifies a subscription to policy data change notification when the change occurs + in a fragment (subset of resource data) of a given resource. + type: object + properties: + monResourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + items: + type: array + items: + $ref: '#/components/schemas/ItemPath' + minItems: 1 + required: + - monResourceUri + - items + +NotificationItem: + description: > + Identifies a data change notification when the change occurs in a fragment + (subset of resource data) of a given resource. + type: object + properties: + resourceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifItems: + type: array + items: + $ref: '#/components/schemas/UpdatedItem' + minItems: 1 + required: + - resourceId + - notifItems + +UpdatedItem: + description: Identifies a fragment of a resource. + type: object + properties: + item: + $ref: '#/components/schemas/ItemPath' + value: {} + required: + - item + - value + +BdtDataPatch: + description: Contains the modified background data transfer data. + type: object + properties: + transPolicy: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/TransferPolicy' + bdtpStatus: + $ref: '#/components/schemas/BdtPolicyStatus' + warnNotifEnabled: + type: boolean + description: > + Indicates whether the BDT warning notification is enabled (true) or not (false). + +SlicePolicyData: + description: Contains the network slice specific policy control information. + type: object + properties: + mbrUL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mbrDL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainMbrUL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainMbrDL: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + suppFeat: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +SlicePolicyDataPatch: + description: Contains the modified network slice specific policy control information. + type: object + properties: + remainMbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainMbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + oneOf: + - required: [remainMbrUl] + - required: [remainMbrDl] + +MbsSessPolCtrlData: + description: Represents MBS Session Policy Control Data. + type: object + properties: + 5qis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + minItems: 1 + maxMbsArpLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ArpPriorityLevel' + maxMbsSessionAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxGbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +MbsSessPolDataId: + description: Represents the identifier used to access the MBS Session Policy Control Data. + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + afAppId: + type: string + oneOf: + - required: [mbsSessionId] + - required: [afAppId] + +PdtqData: + description: Contains the planned data transfer data with QoS requirements. + type: object + properties: + aspId: + type: string + pdtqPolicy: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqPolicy' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + pdtqRefId: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqReferenceId' + nwAreaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + numOfUes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + desTimeInts: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + minItems: 1 + description: Identifies the time interval(s). + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + altQosParamSets: + type: array + items: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/AltQosParamSet' + minItems: 1 + description: > + Contains the alternative QoS requirements as a list of individual QoS parameter + sets in a prioritized order. +``` + +``` + +altQosRefs: + type: array + items: + type: string + minItems: 1 + description: > + Contains the alternative QoS requirements as the list of QoS references in a + prioritized order. +qosParamSet: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/QosParameterSet' +qosReference: + type: string + description: > + Requested QoS requirements expressed as the QoS Reference which represents + a pre-defined QoS information. +notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +warnNotifEnabled: + type: boolean + description: > + Indicates whether the PDTQ warning notification is enabled (true) or not (false). + Default value is false. +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +resetIds: + type: array + items: + type: string + minItems: 1 +required: +- aspId +- pdtqPolicy + +PdtqDataPatch: + description: Contains the modified planned data transfer data with QoS requirements. + type: object + properties: + pdtqPolicy: + $ref: 'TS29543_Npcf_PDTQPolicyControl.yaml#/components/schemas/PdtqPolicy' + + warnNotifEnabled: + type: boolean + description: > + Indicates whether the PDTQ warning notification is enabled (true) or not (false). +notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + +GroupPolicyData: + description: Contains the group specific policy control subscription information. + type: object + properties: + remainGroupMbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainGroupMbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +GroupPolicyDataPatch: + description: > + Contains the requested modification to the group specific policy control subscription + data. + type: object + properties: + remainGroupMbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + remainGroupMbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + anyOf: + - required: [remainGroupMbrUl] + - required: [remainGroupMbrDl] + +# SIMPLE TYPES: + +IpIndex: + description: > + Represents information that identifies which IP pool or external server + is used to allocate the IP address. + +``` + +type: integer + +OsId: + +description: Represents the Operating System of the served UE. + +type: string + +format: uuid + +ItemPath: + +description: Identifies a fragment (subset of resource data) of a given resource. + +type: string + +BdtReferenceIdRm: + +type: string + +description: > + +This data type is defined in the same way as the BdtReferenceId data type defined in 3GPP TS 29.122, but with the nullable property set to true. + +nullable: true + +# ENUMS: + +UsageMonLevel: + +description: Represents the usage monitoring level. + +anyOf: + +- type: string + +enum: + +- SESSION\_LEVEL + +- SERVICE\_LEVEL + +- 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. + +Periodicity: + +description: Represents the time period. + +anyOf: + +- type: string + +enum: + +- YEARLY + +- MONTHLY + +- WEEKLY + +- DAILY + +- HOURLY + +- 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. + +BdtPolicyStatus: + +description: Indicates the validation status of a negotiated BDT policy. + +anyOf: + +- type: string + +enum: + +- INVALID + +- VALID + +- 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. + +PolicyDataSubset: + +description: Indicates a policy data subset. + +anyOf: + +- type: string + +enum: + +- AM\_POLICY\_DATA + +- SM\_POLICY\_DATA + +- UE\_POLICY\_DATA + +- UM\_DATA + +- OPERATOR\_SPECIFIC\_DATA + +- 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. + +## A.3 Nudr\_DataRepository API for Application Data + +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 "TS29519\_Application\_Data.yaml". + +``` + +openapi: 3.0.0 + +info: + version: '-' + title: Unified Data Repository Service API file for Application Data + description: | + The API version is defined in 3GPP TS 29.504 + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: > + 3GPP TS 29.519 V18.4.0; 5G System; Usage of the Unified Data Repository Service for Policy Data, + Application Data and Structured Data for Exposure. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.519/' + +paths: + /application-data/pfds: + get: + summary: Retrieve PFDs for application identifier(s) + operationId: ReadPFDData + tags: + - PFD Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:pfds:read + parameters: + - name: appId + in: query + description: > + Contains the information of the application identifier(s) for the querying PFD + Data resource. If none appId is included in the URI, it applies to all application + identifier(s) for the querying PFD Data resource. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: A representation of PFDs for request applications is returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PfdDataForAppExt' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/pfds/{appId}: + get: + summary: Retrieve the corresponding PFDs of the specified application identifier + operationId: ReadIndividualPFDData + tags: + - Individual PFD Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:pfds:read + parameters: + - name: appId + in: path + description: > + Indicate the application identifier for the request pfd(s). It shall apply the + format of Data type ApplicationId. + required: true + schema: + type: string + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + A representation of PFDs for the request application identified by the application + identifier is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdDataForAppExt' + '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: + summary: Delete the corresponding PFDs of the specified application identifier + operationId: DeleteIndividualPFDData + +``` + +``` + +tags: + - Individual PFD Data (Document) +security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:pfds:modify +parameters: + - name: appId + in: path + description: > + Indicate the application identifier for the request pfd(s). It shall apply the + format of Data type ApplicationId. + required: true + schema: + type: string +responses: + '204': + description: > + Successful case. The Individual PFD Data resource related to the application + identifier was deleted. + '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' +put: + summary: Create or update the corresponding PFDs for the specified application identifier + operationId: CreateOrReplaceIndividualPFDData + tags: + - Individual PFD Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:pfds:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PfdDataForAppExt' + parameters: + - name: appId + in: path + description: > + Indicate the application identifier for the request pfd(s). It shall apply the format + of Data type ApplicationId. + required: true + schema: + type: string + responses: + '201': + +``` + +``` + +description: > + The creation of an Individual PFD Data resource related to the application-identifier + is confirmed and a representation of that resource is returned. +content: + application/json: + schema: + $ref: '#/components/schemas/PfdDataForAppExt' +headers: + Location: + description: > + 'Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/pfds/{appId}' + required: true + schema: + type: string +'200': + description: > + Successful case. The upgrade of an Individual PFD Data resource related to the + application identifier is confirmed and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PfdDataForAppExt' +'204': + description: No content +'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' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'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' + +/application-data/influenceData: + get: + summary: Retrieve Traffic Influence Data + operationId: ReadInfluenceData + tags: + - Influence Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:read + parameters: + - name: influence-Ids + in: query + description: Each element identifies a service. + required: false + schema: + type: array + items: + type: string + +``` + +``` + minItems: 1 +- name: dnns + in: query + description: Each element identifies a DNN. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 +- name: snssais + in: query + description: Each element identifies a slice. + required: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 +- name: internal-Group-Ids + in: query + description: Each element identifies a group of users. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 +- name: internal-group-ids-Add + in: query + description: Each element identifies an internal Group. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 +- name: subscriber-categories + in: query + description: > + Each element identifies a subscriber category. + required: false + schema: + type: array + items: + type: string + minItems: 1 +- name: supis + in: query + description: Each element identifies the user. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 +- name: supp-feat + in: query + required: false + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: The Traffic Influence Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrafficInfluData' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/influenceData/{influenceId}: + put: + summary: Create or update an individual Influence Data resource + operationId: CreateOrReplaceIndividualInfluenceData + tags: + - Individual Influence Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluData' + parameters: + - name: influenceId + in: path + description: > + The Identifier of an Individual Influence Data to be created or updated. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual Traffic Influence Data resource is confirmed + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluData' + headers: + Location: + description: > + 'Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/influenceData/{influenceId}' + required: true + schema: + type: string + '200': + description: > + The update of an Individual Traffic Influence Data resource is confirmed and a + response body containing Traffic Influence Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluData' + '204': + description: No content + '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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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' +patch: + summary: Modify part of the properties of an individual Influence Data resource + operationId: UpdateIndividualInfluenceData + tags: + - Individual Influence Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/TrafficInfluDataPatch' + parameters: + - name: influenceId + in: path + description: > + The Identifier of an Individual Influence Data to be updated. It shall apply + the format of Data type string. + required: true + schema: + type: string + responses: + '200': + description: > + The update of an Individual Traffic Influence Data resource is confirmed and + a response body containing Traffic Influence Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluData' + '204': + description: No content + '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: Delete an individual Influence Data resource + operationId: DeleteIndividualInfluenceData + tags: + - Individual Influence Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:modify + parameters: + - name: influenceId + in: path + description: > + The Identifier of an Individual Influence Data to be deleted. It shall apply + the format of Data type string. + required: true + schema: + type: string + responses: + '204': + description: The Individual Influence Data was deleted successfully. + '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' + +/application-data/influenceData/subs-to-notify: + post: + summary: Create a new Individual Influence Data Subscription resource + operationId: CreateIndividualInfluenceDataSubscription + tags: + - Influence Data Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:subscriptions:create + requestBody: + +``` + +``` + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluSub' +responses: + '201': + description: The subscription was created successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluSub' + headers: + Location: + description: 'Contains the URI of the newly created resource' + 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: + trafficInfluenceDataChangeNotification: + '{ $request.body#/notificationUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + oneOf: + - $ref: '#/components/schemas/TrafficInfluData' + - $ref: '#/components/schemas/TrafficInfluDataNotif' + minItems: 1 +responses: + '204': + description: No Content, Notification was successful + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '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' +get: + summary: Read Influence Data Subscriptions + operationId: ReadInfluenceDataSubscriptions + tags: + - Influence Data Subscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:subscriptions:read + parameters: + - name: dnn + in: query + description: Identifies a DNN. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: snssai + in: query + description: Identifies a slice. + required: false + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + - name: internal-Group-Id + in: query + description: Identifies a group of users. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + - name: supi + in: query + description: Identifies a user. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: internal-group-ids + in: query + description: > + Each element identifies an internal group. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + - name: subscriber-categories + in: query + description: > + Each element identifies a subscriber category. + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: roam-ue-plmn-ids + in: query + description: > + Each element identifies a PLMN. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + responses: +``` + +``` + +'200': + description: > + The subscription information as request in the request URI query parameter(s) + are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TrafficInfluSub' + minItems: 0 +'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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/influenceData/subs-to-notify/{subscriptionId}: + get: + summary: Get an existing individual Influence Data Subscription resource + operationId: ReadIndividualInfluenceDataSubscription + tags: + - Individual Influence Data Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:subscriptions:read + parameters: + - name: subscriptionId + in: path + description: > + String identifying a subscription to the Individual Influence Data Subscription + required: true + schema: + type: string + responses: + '200': + description: The subscription information is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluSub' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +put: + summary: Modify an existing individual Influence Data Subscription resource + operationId: ReplaceIndividualInfluenceDataSubscription + tags: + - Individual Influence Data Subscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:influence-data:subscriptions:modify + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluSub' + parameters: + - name: subscriptionId + in: path + description: > + String identifying a subscription to the Individual Influence Data Subscription. + required: true + schema: + type: string + responses: + '200': + description: The subscription was updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/TrafficInfluSub' + '204': + description: No content + '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: Delete an individual Influence Data Subscription resource + operationId: DeleteIndividualInfluenceDataSubscription + tags: + - Individual Influence Data Subscription (Document) + +``` + +``` + +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:application-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:application-data +- nudr-dr:application-data:influence-data:subscriptions:modify +parameters: +- name: subscriptionId + in: path + description: > + String identifying a subscription to the Individual Influence Data Subscription. + required: true + schema: + type: string +responses: +'204': + description: The subscription was terminated successfully. +'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' + +/application-data/bdtPolicyData: +get: + summary: Retrieve applied BDT Policy Data + operationId: ReadBdtPolicyData + tags: + - BdtPolicy Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:bdtpolicy-data:read + parameters: + - name: bdt-policy-ids + in: query + description: Each element identifies a service. + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: internal-group-ids + in: query + description: Each element identifies a group of users. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + - name: supis + +``` + +``` + +in: query +description: Each element identifies the user. +required: false +schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 +responses: + '200': + description: The applied BDT policy Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/BdtPolicyData' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/bdtPolicyData/{bdtPolicyId}: + put: + summary: Create an individual applied BDT Policy Data resource + operationId: CreateIndividualAppliedBdtPolicyData + tags: + - Individual Applied BDT Policy Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:bdt-policy-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolicyData' + parameters: + - name: bdtPolicyId + in: path + description: > + The Identifier of an Individual Applied BDT Policy Data to be created or updated. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual Applied BDT Policy Data resource is confirmed and a + representation of that resource is returned. + content: + +``` + +``` + + application/json: + schema: + $ref: '#/components/schemas/BdtPolicyData' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/bdtPolicyData/{bdtPolicyId} + 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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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' +patch: + summary: Modify part of the properties of an individual Applied BDT Policy Data resource + operationId: UpdateIndividualAppliedBdtPolicyData + tags: + - Individual Applied BDT Policy Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:bdt-policy-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/BdtPolicyDataPatch' + parameters: + - name: bdtPolicyId + in: path + description: > + The Identifier of an Individual Applied BDT Policy Data to be updated. It shall + apply the format of Data type string. + required: true + schema: + type: string + responses: + '200': + description: > + The update of an Individual Applied BDT Policy Data resource is confirmed and + a response body containing Applied BDT Policy Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/BdtPolicyData' + '204': + +``` + +``` + + description: No content + '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: Delete an individual Applied BDT Policy Data resource + operationId: DeleteIndividualAppliedBdtPolicyData + tags: + - Individual Applied BDT Policy Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:bdtpolicy-data:modify + parameters: + - name: bdtPolicyId + in: path + description: > + The Identifier of an Individual Applied BDT Policy Data to be deleted. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '204': + description: The Individual Applied BDT Policy Data was deleted successfully. + '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' + +/application-data/iptvConfigData: + get: + summary: Retrieve IPTV configuration Data + operationId: ReadIPTVConfigurationData + tags: + - IPTV Configuration Data (Store) + +``` + +``` +security: +- {} +- oAuth2ClientCredentials: +- nudr-dr +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:application-data +- oAuth2ClientCredentials: +- nudr-dr +- nudr-dr:application-data +- nudr-dr:application-data:iptv-config-data:read +parameters: +- name: config-ids + in: query + description: Each element identifies a configuration. + required: false + schema: + type: array + items: + type: string + minItems: 1 +- name: dnns + in: query + description: Each element identifies a DNN. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 +- name: snssais + in: query + description: Each element identifies a slice. + required: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 +- name: supis + in: query + description: Each element identifies the user. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 +- name: inter-group-ids + in: query + description: Each element identifies a group of users. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 +responses: +'200': + description: The IPTV configuration data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/IptvConfigData' +'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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/iptvConfigData/{configurationId}: + put: + summary: Create or update an individual IPTV configuration resource + operationId: CreateOrReplaceIndividualIPTVConfigurationData + tags: + - Individual IPTV Configuration Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:iptv-config-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/IptvConfigData' + parameters: + - name: configurationId + in: path + description: > + The Identifier of an Individual IPTV Configuration Data to be created or updated. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual IPTV Configuration Data resource is confirmed and a + representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/IptvConfigData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '200': + description: The update of an Individual IPTV configuration resource. + content: + application/json: + schema: + $ref: '#/components/schemas/IptvConfigData' + '204': + description: No content + '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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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' +patch: + summary: Partial update an individual IPTV configuration resource + operationId: PartialReplaceIndividualIPTVConfigurationData + tags: + - Individual IPTV Configuration Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:iptv-config-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: 'TS29522_IPTVConfiguration.yaml#/components/schemas/IptvConfigDataPatch' + parameters: + - name: configurationId + in: path + description: > + The Identifier of an Individual IPTV Configuration Data to be updated. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '200': + description: The update of an Individual IPTV configuration resource. + content: + application/json: + schema: + $ref: '#/components/schemas/IptvConfigData' + '204': + description: No content + '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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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: Delete an individual IPTV configuration resource + operationId: DeleteIndividualIPTVConfigurationData + tags: + - Individual IPTV Configuration Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:iptv-config-data:modify + parameters: + - name: configurationId + in: path + description: > + The Identifier of an Individual IPTV Configuration to be deleted. It shall + apply the format of Data type string. + required: true + schema: + type: string + responses: + '204': + description: The resource was deleted successfully. + '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' + +/application-data/serviceParamData: + get: + summary: Retrieve Service Parameter Data + operationId: ReadServiceParameterData + tags: + - Service Parameter Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:service-param-data:read + parameters: + - name: service-param-ids + in: query + description: Each element identifies a service. + required: false + schema: + type: array + items: + type: string + minItems: 1 + +``` + +- name: dnns +in: query +description: Each element identifies a DNN. +required: false +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Dnn' +minItems: 1 +- name: snssais +in: query +description: Each element identifies a slice. +required: false +content: +application/json: +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Snssai' +minItems: 1 +- name: internal-group-ids +in: query +description: Each element identifies a group of users. +required: false +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/GroupId' +minItems: 1 +- name: supis +in: query +description: Each element identifies the user. +required: false +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Supi' +minItems: 1 +- name: ue-ipv4s +in: query +description: Each element identifies the user. +required: false +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv4Addr' +minItems: 1 +- name: ue-ipv6s +in: query +description: Each element identifies the user. +required: false +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/Ipv6Addr' +minItems: 1 +- name: ue-macs +in: query +description: Each element identifies the user. +required: false +schema: +type: array +items: +\$ref: 'TS29571\_CommonData.yaml#/components/schemas/MacAddr48' +minItems: 1 +- name: any-ue +in: query +description: Indicates whether the request is for any UE. +required: false +schema: +type: boolean +- name: roam-ue-net-descs +in: query +description: > +Each element identifies one or more PLMNs for a roaming UE. +required: false +schema: +type: array + +``` + + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/NetworkDescription' + minItems: 1 + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: The Service Parameter Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceParameterData' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/serviceParamData/{serviceParamId}: + put: + summary: Create or update an individual Service Parameter Data resource + operationId: CreateOrReplaceServiceParameterData + tags: + - Individual Service Parameter Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:service-param-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceParameterData' + parameters: + - name: serviceParamId + in: path + description: > + The Identifier of an Individual Service Parameter Data to be created or updated. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual Service Parameter Data resource is confirmed + and a representation of that resource is returned. + +``` + +``` + +content: + application/json: + schema: + $ref: '#/components/schemas/ServiceParameterData' +headers: + Location: + description: > + 'Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/serviceParamData/{serviceParamId}' + required: true + schema: + type: string +'200': + description: > + The update of an Individual Service Parameter Data resource is confirmed and + a response body containing Service Parameter Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceParameterData' +'204': + description: No content +'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' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'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' +patch: + summary: Modify part of the properties of an individual Service Parameter Data resource + operationId: UpdateIndividualServiceParameterData + tags: + - Individual Service Parameter Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:service-parameter-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/ServiceParameterDataPatch' + parameters: + - name: serviceParamId + in: path + description: > + The Identifier of an Individual Service Parameter Data to be updated. + It shall apply the format of Data type string. + required: true + schema: + +``` + +``` + + type: string +responses: + '200': + description: > + The update of an Individual Service Parameter Data resource is confirmed + and a response body containing Service Parameter Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ServiceParameterData' + '204': + description: No content + '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: Delete an individual Service Parameter Data resource + operationId: DeleteIndividualServiceParameterData + tags: + - Individual Service Parameter Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:service-parameter-data:modify + parameters: + - name: serviceParamId + in: path + description: > + The Identifier of an Individual Service Parameter Data to be deleted. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '204': + description: The Individual Service Parameter Data was deleted successfully. + '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' + +/application-data/am-influence-data: + get: + summary: Retrieve AM Influence Data + operationId: ReadAmInfluenceData + tags: + - AM Influence Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:am-influence-data:read + parameters: + - name: am-influence-ids + in: query + description: Each element identifies a service. + required: false + schema: + type: array + items: + type: string + minItems: 1 + - name: dnns + in: query + description: Each element identifies a DNN. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + - name: snssais + in: query + description: Each element identifies a slice. + required: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + - name: dnn-snssai-infos + in: query + description: Each element identifies a combination of (DNN, S-NSSAI). + required: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29522_AMInfluence.yaml#/components/schemas/DnnSnssaiInformation' + minItems: 1 + - name: internal-group-ids + in: query + description: Each element identifies a group of users. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + - name: supis + in: query + description: Each element identifies the user. + required: false + schema: + type: array +``` + +``` + + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + - name: any-ue + in: query + description: Indicates whether the request is for any UE. + required: false + schema: + type: boolean + - name: supp-feat + in: query + required: false + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: The AM Influence Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AmInfluData' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/am-influence-data/{amInfluenceId}: + put: + summary: Create or update an individual AM Influence Data resource + operationId: CreateOrReplaceIndividualAmInfluenceData + tags: + - Individual AM Influence Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:am-influence-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AmInfluData' + parameters: + - name: amInfluenceId + in: path + description: > + The Identifier of an Individual AM Influence Data to be created or updated. + It shall apply the format of Data type string. + required: true + schema: + +``` + +``` + + type: string +responses: + '201': + description: > + The creation of an Individual AM Influence Data resource is confirmed and + a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AmInfluData' + headers: + Location: + description: > + 'Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/am-influence-data/{amInfluenceId}' + required: true + schema: + type: string + '200': + description: > + The update of an Individual AM Influence Data resource is confirmed and a response + body containing AM Influence Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AmInfluData' + '204': + description: No content + '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' + '414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' + '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' +patch: + summary: Modify part of the properties of an individual AM Influence Data resource + operationId: UpdateIndividualAmInfluenceData + tags: + - Individual AM Influence Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:am-influence-data:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AmInfluDataPatch' + parameters: + - name: amInfluenceId + +``` + +``` + +in: path +description: > + The Identifier of an Individual AM Influence Data to be updated. It shall + apply the format of Data type string. +required: true +schema: + type: string +responses: + '200': + description: > + The update of an Individual AM Influence Data resource is confirmed and a + response body containing AM Influence Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AmInfluData' + '204': + description: No content + '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: Delete an individual AM Influence Data resource + operationId: DeleteIndividualAmInfluenceData + tags: + - Individual AM Influence Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:am-influence-data:modify + parameters: + - name: amInfluenceId + in: path + description: > + The Identifier of an Individual AM Influence Data to be deleted. It shall + apply the format of Data type string. + required: true + schema: + type: string + responses: + '204': + description: The Individual AM Influence Data was deleted successfully. + '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' + +/application-data/subs-to-notify: + post: + summary: Create a subscription to receive notification of application data changes + operationId: CreateIndividualApplicationDataSubscription + tags: + - ApplicationDataSubscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:subs-to-notify:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationDataSubs' + responses: + '201': + description: > + Upon success, a response body containing a representation of each + Individual subscription resource shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationDataSubs' + headers: + Location: + description: 'Contains the URI of the newly created resource' + 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: + applicationDataChangeNotif: + '{ $request.body#/notificationUri }': + post: + requestBody: + +``` + +``` + + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ApplicationDataChangeNotif' + minItems: 1 + responses: + '204': + description: No Content, Notification was successful + '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' +get: + summary: Read Application Data change Subscriptions + operationId: ReadApplicationDataChangeSubscriptions + tags: + - ApplicationDataSubscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:subs-to-notify:read + parameters: + - name: data-filter + in: query + description: The data filter for the query. + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/DataFilter' + responses: + '200': + description: > + The subscription information as request in the request URI query parameter(s) + are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ApplicationDataSubs' + minItems: 0 + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/af-qos-data-sets: + get: + summary: Retrieve AF Requested QoS Data + operationId: ReadAFReqQoSData + tags: + - AF Requested QoS Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:af-qos-data-sets:read + parameters: + - name: dnns + in: query + description: Each element identifies a DNN + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + - name: snssais + in: query + description: Each element identifies a slice. + required: false + content: + application/json: + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + - name: internal-group-ids + in: query + description: Each element identifies a group of users. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + - name: supis + in: query + description: Each element identifies the user. + required: false + schema: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + - name: data-set-ids + in: query + description: Each element identifies an Individual AF requested QoS resource. + required: false + schema: + +``` + +``` + + type: array + items: + type: string + minItems: 1 +- name: supp-feat + in: query + required: false + description: Supported Features + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: The AF requested QoS Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AfRequestedQosData' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/af-qos-data-sets/{afReqQosId}: + put: + summary: Create or update an Individual AF Requested QoS Data resource. + operationId: CreateIndividualAFReqQoSData + tags: + - Individual AF Requested QoS Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:af-qos-data-sets:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AfRequestedQosData' + parameters: + - name: afReqQosId + in: path + description: > + The Identifier of an Individual AF Requested QoS Data to be created or updated. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual AF Requested QoS Data resource is confirmed and a + representation of that resource is returned. + +``` + +``` + +content: + application/json: + schema: + $ref: '#/components/schemas/AfRequestedQoSData' +headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/af-qos-data-sets/{afReqQoSId} + 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' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'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' +patch: + summary: Modify part of the properties of an individual AF requested QoS Data resource + operationId: UpdateIndividualAFRequestedQoSData + tags: + - Individual AF requested QoS Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:af-qos-data-sets:modify + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AfRequestedQoSDataPatch' + parameters: + - name: afReqQoSId + in: path + description: > + The Identifier of an Individual AF Requested QoS Data to be updated. + required: true + schema: + type: string + responses: + '200': + description: > + The update of an Individual AF Requested QoS Data resource is confirmed and + a response body containing AF Requested QoS Data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AfRequestedQoSData' + '204': + +``` + +``` + + description: No content + '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: Delete an individual AF requested QoS Data resource + operationId: DeleteIndividualAFRequestedQosData + tags: + - Individual AF requested QoS Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:af-qos-data-sets:modify + parameters: + - name: afReqQosId + in: path + description: > + The Identifier of an Individual AF Requested QoS Data to be deleted. + required: true + schema: + type: string + responses: + '204': + description: The Individual AF requested QoS Data was deleted successfully. + '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' + +/application-data/subs-to-notify/{subsId}: + parameters: + - name: subsId + in: path + required: true + schema: + type: string + +``` + +``` + +put: + summary: Modify a subscription to receive notification of application data changes + operationId: ReplaceIndividualApplicationDataSubscription + tags: + - IndividualApplicationDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:subs-to-notify:modify + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationDataSubs' + responses: + '200': + description: The individual subscription resource was updated successfully. + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationDataSubs' + '204': + description: > + The individual subscription resource was updated successfully and no + additional content is to be sent in the response message. + '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: Delete the individual Application Data subscription + operationId: DeleteIndividualApplicationDataSubscription + tags: + - IndividualApplicationDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:subs-to-notify:modify + responses: + '204': + description: Upon success, an empty response body shall be returned. + '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' +get: + summary: Get an existing individual Application Data Subscription resource + operationId: ReadIndividualApplicationDataSubscription + tags: + - IndividualApplicationDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:subs-to-notify:read + parameters: + - name: subsId + in: path + description: > + String identifying a subscription to the Individual Application Data Subscription + required: true + schema: + type: string + responses: + '200': + description: The subscription information is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/ApplicationDataSubs' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/eas-deploy-data: + get: + summary: Retrieve EAS Deployment Information Data + operationId: ReadEasDeployData + tags: + - EAS Deployment Data (Store) + security: + - {} + +``` + +``` +- oAuth2ClientCredentials: + - nudr-dr +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data +- oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:eas-deploy-data:read +parameters: +- name: dnn + in: query + description: Identifies a DNN. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +- name: snssai + in: query + description: Identifies an S-NSSAI. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' +- name: internal-group-id + in: query + description: Identifies a group of users. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' +- name: appId + in: query + description: Identifies an application. + required: false + schema: + type: string +responses: +'200': + description: The EAS Deployment Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + minItems: 1 +'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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +/application-data/eas-deploy-data/{easDeployInfoId}: +get: + summary: Retrieve an individual EAS Deployment Data resource + operationId: ReadIndividualEasDeployData + tags: + - Individual EAS Deployment Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr +``` + +``` + + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:eas-deploy-data:read +parameters: + - name: easDeployInfoId + description: > + String identifying an Individual EAS Deployment Information Data resource. + in: path + required: true + schema: + type: string +responses: + '200': + description: > + The EAS Deployment Data stored in the UDR for an Individual EAS Deployment + Information Data resource is returned. + content: + application/json: + schema: + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + '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: Create or update an individual EAS Deployment Data resource + operationId: CreateOrReplaceIndividualEasDeployData + tags: + - Individual EAS Deployment Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:eas-deploy-data:create + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' + parameters: + - name: easDeployInfoId + in: path + description: > + The Identifier of an Individual EAS Deployment Data to be created or updated. + It shall apply the format of Data type string. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual EAS Deployment Data resource is confirmed and a + representation of that resource is returned. + +``` + +``` + +content: + application/json: + schema: + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' +headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure: + {apiRoot}/nudr-dr//application-data/eas-deploy-data/{easDeployInfoId} + required: true + schema: + type: string +'200': + description: > + The update of an Individual EAS Deployment Data resource is confirmed and a response + body containing EAS Deployment Data shall be returned. + content: + application/json: + schema: + $ref: 'TS29591_Nnef_EASDeployment.yaml#/components/schemas/EasDeployInfoData' +'204': + description: No content +'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' +'414': + $ref: 'TS29571_CommonData.yaml#/components/responses/414' +'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: Delete an individual EAS Deployment Data resource + operationId: DeleteIndividualEasDeployData + tags: + - Individual EasDeployment Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:eas-deploy-data:modify +parameters: + - name: easDeployInfoId + in: path + description: > + The Identifier of an Individual EAS Deployment Data to be deleted. + It shall apply the format of Data type string. + required: true + schema: + type: string +responses: +'204': + description: The Individual EAS Deployment Data was deleted successfully. +'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' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/dnai-eas-mappings/{dnai}: + parameters: + - name: dnai + in: path + required: true + schema: + type: string + get: + summary: Retrieves the EAS address information for a DNAI. + operationId: ReadDnaiEasMapping + tags: + - DnaiEasMapping (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:dnai-eas:read + parameters: + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + Upon success, a response body containing EAS address information for a DNAI + is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/DnaiEasMapping' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/ecs-address-roaming: + +``` + +``` + +get: + summary: Retrieve ECS Address Roaming Data + operationId: ReadEcsRoamingData + tags: + - ECS Address Roaming Data (Store) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:ecs-address-roaming:read + parameters: + - name: internal-group-id + in: query + description: Identifies a group of users. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + - name: any-ue + in: query + description: > + Indicates that any UE is targetted if included and set to true, otherwise set to false. + Default value is false if omitted. + required: false + schema: + type: boolean + responses: + '200': + description: The ECS Address Roaming Data stored in the UDR are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/EcsAddrData' + minItems: 1 + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/application-data/ecs-address-roaming/{ecsAddrInfoId}: +get: + summary: Retrieve an individual ECS Address Roaming Data resource + operationId: ReadIndividualEcsAddr + tags: + - Individual ECS Address Roaming Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + +``` + +``` + + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:ecs-address-roaming:read +parameters: + - name: ecsAddrInfoId + description: > + String identifying an Individual ECS Address Roaming Data resource. + in: path + required: true + schema: + type: string +responses: + '200': + description: > + The ECS Address Roaming Data stored in the UDR for an Individual ECS Address Roaming + Data resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrData' + '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: Create or update an individual ECS Address Roaming Data resource + operationId: CreateOrReplaceIndividualEcsAddressData + tags: + - Individual ECS Address Roaming Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:ecs-address-roaming:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrData' + parameters: + - name: ecsAddrInfoId + in: path + description: > + The Identifier of an Individual ECS Address Roaming Data to be created or updated. + required: true + schema: + type: string + responses: + '201': + description: > + The creation of an Individual EECS Address Roaming Data resource is confirmed + and a representation of that resource is returned. + content: + application/json: + schema: + +``` + +``` + + $ref: '#/components/schemas/EcsAddrData' +headers: + Location: + description: > + Contains the URI of the newly created resource. + required: true + schema: + type: string +'200': + description: > + The update of an Individual ECS Address Roaming Data resource is confirmed + and a response body containing ECS Address Roaming Data is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EcsAddrData' +'204': + description: No content +'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: Delete an individual ECS Address Roaming Data resource + operationId: DeleteIndividualEcsAddrData + tags: + - Individual ECS Address Roaming Data (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:application-data + - nudr-dr:application-data:ecs-address-roaming:modify + parameters: + - name: ecsAddrInfoId + in: path + description: > + The Identifier of an Individual ECS Address Roaming Data to be updated. + required: true + schema: + type: string + responses: + '204': + description: The Individual ECS Address Roaming Data was deleted successfully. + '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' +'503': +$ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: +$ref: 'TS29571_CommonData.yaml#/components/responses/default' +``` + +## components: + +## schemas: + +``` +TrafficInfluData: +description: Represents the Traffic Influence Data. +type: object +properties: + upPathChgNotifCorreId: + type: string + description: > + Contains the Notification Correlation Id allocated by the NEF for the UP + path change notification. + appReloInd: + type: boolean + description: > + Identifies whether an application can be relocated once a location of the + application has been selected. + afAppId: + type: string + description: Identifies an application. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + ethTrafficFilters: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + description: > + Identifies Ethernet packet filters. Either "trafficFilters" or + "ethTrafficFilters" shall be included if applicable. + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + interGroupIdList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 2 + description: > + Identifies a list of Internal Groups. + subscriberCatList: + type: array + items: + type: string + minItems: 1 + description: > + Identifies a list of Subscriber Category(s). + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + trafficFilters: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + description: > + Identifies IP packet filters. Either "trafficFilters" or "ethTrafficFilters" + shall be included if applicable. + trafficRoutes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + minItems: 1 + description: Identifies the N6 traffic routing requirement. + sfcIdDl: + type: string + description: Reference to a pre-configured service function chain for DL traffic + sfcIdUl: + type: string +``` + +``` + + description: Reference to a pre-configured service function chain for UL traffic + metadata: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Metadata' + traffCorreInd: + type: boolean + tfcCorreInfo: + $ref: '#/components/schemas/TrafficCorrelationInfo' + validStartTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + validEndTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tempValidities: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + minItems: 1 + description: Identifies the temporal validities for the N6 traffic routing requirement. + nwAreaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + upPathChgNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + headers: + description: Contains the headers provisioned by the NEF. + type: array + items: + type: string + minItems: 1 + subscribedEvents: + type: array + items: + $ref: 'TS29522_TrafficInfluence.yaml#/components/schemas/SubscribedEvent' + minItems: 1 + dnaiChgType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType' + afAckInd: + type: boolean + addrPreserInd: + type: boolean + maxAllowedUpLat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + 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' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + resetIds: + type: array + items: + type: string + minItems: 1 + 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[24]. + allOf: + - oneOf: + - required: [afAppId] + - required: [trafficFilters] + - required: [ethTrafficFilters] + - oneOf: + - required: [supi] + - required: [interGroupId] + - required: [interGroupIdList] + +TrafficInfluDataPatch: + description: Represents the Traffic Influence Data to be updated in the UDR. + type: object + +``` + +``` +properties: + upPathChgNotifCorreId: + type: string + description: > + Contains the Notification Correlation Id allocated by the NEF for the + UP path change notification. + appReloInd: + type: boolean + description: > + Identifies whether an application can be relocated once a location of the application + has been selected. + ethTrafficFilters: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + minItems: 1 + description: > + Identifies Ethernet packet filters. Either "trafficFilters" or "ethTrafficFilters" + shall be included if applicable. + trafficFilters: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + description: > + Identifies IP packet filters. Either "trafficFilters" or "ethTrafficFilters" + shall be included if applicable. + trafficRoutes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + minItems: 1 + description: Identifies the N6 traffic routing requirement. + sfcIdDL: + type: string + description: Reference to a pre-configured service function chain for DL traffic + nullable: true + sfcIdUL: + type: string + description: Reference to a pre-configured service function chain for UL traffic + nullable: true + metadata: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Metadata' + traffCorreInd: + type: boolean + tfcCorreInfo: + $ref: '#/components/schemas/TrafficCorrelationInfo' + validStartTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + validEndTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tempValidities: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TemporalValidity' + minItems: 1 + nullable: true + description: Identifies the temporal validities for the N6 traffic routing requirement. + nwAreaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + upPathChgNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + headers: + description: Contains the headers provisioned by the NEF. + type: array + items: + type: string + minItems: 1 + afAckInd: + type: boolean + addrPreserInd: + type: boolean + maxAllowedUpLat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UIntegerRm' + 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/DurationSecRm' + +TrafficInfluSub: + description: Represents traffic influence subscription data. + type: object + properties: + dnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + description: Each element identifies a DNN. + snssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + description: Each element identifies a slice. + internalGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + description: Each element identifies a group of users. + internalGroupIdsAdd: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + description: > + Each element identifies an internal group. + subscriberCatList: + type: array + items: + type: string + minItems: 1 + description: > + Each element identifies a subscriber category. + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + description: Each element identifies the user. + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + immRep: + type: boolean + description: > + If provided and set to true, it indicates that existing entries that + match this subscription shall be immediately reported in the response. + immReports: + type: array + items: + $ref: '#/components/schemas/TrafficInfluDataNotif' + minItems: 1 + description: Immediate report with existing UDR entries. + required: + - notificationUri + oneOf: + - required: [dnns] + - required: [snssais] + - required: [internalGroupIds] + - required: [internalGroupIdsAdd] + - required: [supis] + +TrafficInfluDataNotif: +``` + +``` +description: Represents traffic influence data for notification. +type: object +properties: + resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + trafficInfluData: + $ref: '#/components/schemas/TrafficInfluData' +required: +- resUri + +PfdDataForAppExt: +description: Represents the PFDs and related data for the application. +type: object +properties: + applicationId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + pfd: + type: array + items: + $ref: 'TS29551_Nnef_PFDmanagement.yaml#/components/schemas/PfdContent' + minItems: 1 + cachingTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + allowedDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +required: +- applicationId +- pfd + +BdtPolicyData: +description: Represents applied BDT policy data. +type: object +properties: + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + resetIds: + type: array + items: + type: string + minItems: 1 +required: +- bdtRefId + +BdtPolicyDataPatch: +description: > + Represents modification instructions to be performed on the applied BDT policy data. +type: object +properties: + bdtRefId: + $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' +required: +- bdtRefId + +IptvConfigData: +description: Represents IPTV configuration data information. +type: object +properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + interGroupId: + description: Identifies a group of users. +``` + +``` + +dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +afAppId: + type: string +multiAccCtrls: + type: object + additionalProperties: + $ref: 'TS29522_IPTVConfiguration.yaml#/components/schemas/MulticastAccessControl' + minProperties: 1 + description: > + Identifies a list of multicast address access control information. Any string + value can be used as a key of the map. +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +resetIds: + type: array + items: + type: string + minItems: 1 +required: +- afAppId +- multiAccCtrls +oneOf: +- required: [interGroupId] +- required: [supi] + +ServiceParameterData: + description: Represents the service parameter data. + type: object + properties: + appId: + type: string + description: Identifies an application. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + ueIpv4: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Ipv6Addr' + ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + anyUeInd: + type: boolean + description: > + Identifies whether the service parameters applies to any non roaming UE. + roamUeNetDescs: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/NetworkDescription' + minItems: 1 + description: Each element identifies one or more PLMN IDs of inbound roamers. + paramOverPc5: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParameterOverPc5' + paramOverUu: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParameterOverUu' + a2xParamsPc5: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/A2xParamsPc5' + paramForProSeDd: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeDd' + paramForProSeDc: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeDc' + paramForProSeU2NRelUe: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeU2NRelUe' + paramForProSeRemUe: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeRemUe' + paramForProSeU2URelUe: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeU2URelUe' + paramForProSeEndUe: + +``` + +``` +$ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeEndUe' +urspGuidance: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/UrspRuleRequest' + minItems: 1 + description: > + Contains the service parameter used to guide the URSP and/or VPLMN specific URSP. +tnaps: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TnapId' + minItems: 1 + description: Contains the TNAP IDs collocated with the 5G-RG(s) of a specific user. +deliveryEvents: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/Event' + minItems: 1 + description: Contains the outcome of the UE Policy Delivery. +policDelivNotifCorreId: + type: string + description: > + Contains the Notification Correlation Id allocated by the NEF for the notification + of UE Policy delivery outcome. +policDelivNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +headers: + description: Contains the headers provisioned by the NEF. + type: array + items: + type: string + minItems: 1 +resetIds: + type: array + items: + type: string + minItems: 1 +paramForRangingSlPos: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForRangingSlPos' + +ServiceParameterDataPatch: + description: Represents the service parameter data that can be updated. + type: object + properties: + paramOverPc5: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParameterOverPc5Rm' + paramOverUu: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParameterOverUuRm' + a2xParamsPc5: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/A2xParamsPc5Rm' + paramForProSeDd: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeDdRm' + paramForProSeDc: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeDcRm' + paramForProSeU2NRelUe: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeU2NRelUeRm' + paramForProSeRemUe: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeRemUeRm' + paramForProSeU2URelUE: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeU2URelUeRm' + paramForProSeEndUe: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForProSeEndUeRm' + urspInfluence: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/UrspRuleRequest' + minItems: 1 + deprecated: true + description: Contains the service parameter used to influence the URSP. This attribute is + deprecated by the urspGuidance attribute. + urspGuidance: + type: array + items: +``` + +``` +$ref: 'TS29522_ServiceParameter.yaml#/components/schemas/UrspRuleRequest' +minItems: 1 +nullable: true +description: > + Contains the service parameter used to influence the URSP and/or VPLMN specific URSP. +tnaps: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TnapId' + minItems: 1 + description: Contains the TNAP IDs collocated with the 5G-RG(s) of a specific user. + nullable: true +deliveryEvents: + type: array + items: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/Event' + minItems: 1 + nullable: true + description: Contains the outcome of the UE Policy Delivery. +policDelivNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' +headers: + description: Contains the headers provisioned by the NEF. + type: array + items: + type: string + minItems: 1 +paramForRangingSlPos: + $ref: 'TS29522_ServiceParameter.yaml#/components/schemas/ParamForRangingSlPosRm' + +AmInfluData: + description: Represents the AM Influence Data. + type: object + properties: + appIds: + type: array + items: + type: string + minItems: 1 + description: Identifies one or more applications. + dnnSnssaiInfos: + type: array + items: + $ref: 'TS29522_AMInfluence.yaml#/components/schemas/DnnSnssaiInformation' + minItems: 1 + description: Identifies one or more DNN, S-NSSAI combinations. + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + anyUeInd: + type: boolean + description: > + When set to true, it indicates whether the data is applicable for any UE. Otherwise set + to "false". Default value is "false" if omitted. + roamUePlmnIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + minItems: 1 + description: > + Indicates a list of PLMNs representing the home PLMN for the inbound roaming + UEs in LBO roaming scenario. + policyDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + evSubs: + type: array + items: + $ref: 'TS29522_AMInfluence.yaml#/components/schemas/AmInfluEvent' + minItems: 1 + description: List of AM related events for which a subscription is required. + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + headers: + type: array +``` + +``` + description: Contains the headers provisioned by the NEF. + items: + type: string + minItems: 1 + thruReq: + type: boolean + description: > + When set to true, it indicates whether high throughput is desired for the + indicated UE traffic. Otherwise set to "false". Default value is "false" if omitted. + covReq: + type: array + items: + $ref: + 'TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/ServiceAreaCoverageInfo' + minItems: 1 + description: Indicates the service area coverage requirement. + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + resetIds: + type: array + items: + type: string + minItems: 1 + allOf: + - anyOf: + - required: [thruReq] + - required: [covReq] + - oneOf: + - required: [supi] + - required: [interGroupId] + - required: [anyUeInd] + - required: [roamUePlmnIds] + +AmInfluDataPatch: + description: Represents the AM Influence Data that can be updated. + type: object + properties: + appIds: + type: array + items: + type: string + minItems: 1 + description: Identifies one or more applications. + nullable: true + dnnSnssaiInfos: + type: array + items: + $ref: 'TS29522_AMInfluence.yaml#/components/schemas/DnnSnssaiInformation' + minItems: 1 + description: Identifies one or more DNN, S-NSSAI combinations. + nullable: true + evSubs: + type: array + items: + $ref: 'TS29522_AMInfluence.yaml#/components/schemas/AmInfluEvent' + minItems: 1 + description: List of AM related events for which a subscription is required. + nullable: true + headers: + type: array + description: Contains the headers provisioned by the NEF. + items: + type: string + minItems: 1 + thruReq: + type: boolean + description: Indicates whether high throughput is desired for the indicated UE traffic. + nullable: true + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UriRm' + notifCorrId: + type: string + description: Notification correlation identifier. + nullable: true + covReq: + type: array +``` + +``` + items: + $ref: + 'TS29534_Npcf_AMPolicyAuthorization.yaml#/components/schemas/ServiceAreaCoverageInfo' + minItems: 1 + description: Indicates the service area coverage requirement. + nullable: true + +ApplicationDataSubs: + description: Identifies a subscription to application data change notification. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + dataFilters: + type: array + items: + $ref: '#/components/schemas/DataFilter' + minItems: 1 + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + immRep: + type: boolean + description: Immediate reporting indication. + amInfluEntries: + type: array + items: + $ref: '#/components/schemas/AmInfluData' + minItems: 1 + description: The AM Influence Data entries stored in the UDR that match a subscription. + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + immReports: + type: array + items: + $ref: '#/components/schemas/ApplicationDataChangeNotif' + minItems: 1 + description: Immediate report with existing UDR entries. + required: + - notificationUri + +ApplicationDataChangeNotif: + description: Contains changed application data for which notification was requested. + type: object + properties: + iptvConfigData: + $ref: '#/components/schemas/IptvConfigData' + pfdData: + $ref: 'TS29551_Nnef_PFDmanagement.yaml#/components/schemas/PfdChangeNotification' + bdtPolicyData: + $ref: '#/components/schemas/BdtPolicyData' + resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + serParamData: + $ref: '#/components/schemas/ServiceParameterData' + amInfluData: + $ref: '#/components/schemas/AmInfluData' + dnaiEasData: + $ref: '#/components/schemas/DnaiEasMapping' + afReqQosData: + $ref: '#/components/schemas/AfRequestedQosData' + ecsAddrData: + $ref: '#/components/schemas/EcsAddrData' + required: + - resUri + +DataFilter: + description: Identifies a data filter. + type: object + properties: + dataInd: + $ref: '#/components/schemas/DataInd' + dnns: + type: array +``` + +``` + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + snssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + internalGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + ueIpv4s: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + minItems: 1 + ueIpv6s: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + ueMacs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + minItems: 1 + anyUeInd: + type: boolean + description: Indicates the request is for any UE. + dnnSnssaiInfos: + description: > + Indicates the request is for any DNN and S-NSSAI combination present in the array. + type: array + items: + $ref: 'TS29522_AMInfluence.yaml#/components/schemas/DnnSnssaiInformation' + minItems: 1 + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + required: + - dataInd + +TrafficCorrelationInfo: + description: > + Contains the information for traffic correlation. + type: object + properties: + corrType: + $ref: '#/components/schemas/CorrelationType' + tfcCorrId: + type: string + description: > + Identification of a set of UEs accessing the application identified by the + Application Identifier or traffic filtering information. + comEasIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrRm' + comEasIpv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6AddrRm' + fqdnRange: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FqdnPatternMatchingRule' + minItems: 1 + nullable: true +``` + +``` + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UriRm' + notifCorrId: + type: string + nullable: true + description: Notification correlation identifier. + nullable: true + +AfRequestedQosData: + description: Represents AF Requested QoS data. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + interGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + afAppId: + type: string + description: Identifies an AF application. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + sliceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + evSubsc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EventsSubscReqData' + flowInfos: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + qosReference: + type: string + 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. + disUeNotif: + type: boolean + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + tempInvalidity: + $ref: 'TS29565_Ntsctsf_QoSAndTSCAssistance.yaml#/components/schemas/TemporalInvalidity' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - suppFeat + oneOf: + - required: [supi] + - required: [interGroupId] + +AfRequestedQosDataPatch: + description: Represents modification of Individual AF Requested QoS data. + type: object + properties: + afAppId: + type: string + description: Identifies an AF application. + nullable: true + evSubsc: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EventsSubscReqDataRm' + flowInfos: + type: array + items: +``` + +``` + + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + minItems: 1 + nullable: true + 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' + mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + tempInvalidity: + $ref: 'TS29565_Ntsctsf_QoSandTSCAssistance.yaml#/components/schemas/TemporalInvalidity' + +DnaiEasMapping: + description: Contains DNAI to EAS mapping information. + type: object + properties: + dnaiEasInfos: + type: array + items: + $ref: '#/components/schemas/DnaiEasInfo' + minItems: 1 + description: Each element contains EAS address information for a DNAI. + required: + - dnaiEasInfos + +DnaiEasInfo: + description: Contains EAS information for a DNAI. + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + easIpAddrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/IpAddress' + minItems: 1 + description: Each element contains EAS addresses, address ranges, and/or prefixes. + fqdns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FqdnPatternMatchingRule' + minItems: 1 + description: Each element contains FQDN matching rules for the EAS(s) of a DNAI. + anyOf: + - required: [dnn] + - required: [snssai] + oneOf: + - required: [easIpAddrs] + - required: [fqdns] + +EcsAddrData: + description: Represents ECS Address Data. + type: object + +``` + +``` + +properties: + self: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Link' + ecsServerAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/EcsServerAddr' + spatialValidityCond: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SpatialValidityCond' + anyUeInd: + type: boolean + description: > + If provided and set to true it indicates that all the UEs are targetted, + otherwise set to false. The default value is false if omitted. + internalGroupId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - ecsServerAddr + +DataInd: + anyOf: + - type: string + enum: + - PFD + - IPTV + - BDT + - SVC_PARAM + - AM + - DNAI_EAS + - REQ_QOS + - ECS + - 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 type of data. + Possible values are + - PFD: PFD data. + - IPTV: IPTV configuration data. + - BDT: BDT data. + - SVC_PARAM: Service parameter data. + - AM: AM influence data. + - DNAI_EAS: DNAI EAS mapping data. + - REQ_QOS: AF Requested QoS data for a UE or group of UE(s) not identified by UE +address(es). + - ECS: ECS Address data. + +CorrelationType: + description: Indicates that a common DNAI or common EAS should be selected. + anyOf: + - type: string + enum: + - COMMON_DNAI + - COMMON_EAS + - 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. + +``` + +## A.4 Nudr\_DataRepository API for Exposure Data + +For the purpose of referencing entities defined in the Open API file defined in this Annex, it shall be assumed that this Open API file is contained in a physical file termed "TS29519\_Exposure\_Data.yaml". + +``` + +openapi: 3.0.0 + +info: + version: '-' + title: Unified Data Repository Service API file for structured data for exposure + description: | + The API version is defined in 3GPP TS 29.504 + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` +externalDocs: + description: > + 3GPP TS 29.519 V18.1.0; 5G System; Usage of the Unified Data Repository Service for Policy Data, + Application Data and Structured Data for Exposure. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.519/' + +paths: + /exposure-data/{ueId}/access-and-mobility-data: + put: + summary: Creates and updates the access and mobility exposure data for a UE + operationId: CreateOrReplaceAccessAndMobilityData + tags: + - AccessAndMobilityData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:access-and-mobility-data:create + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUEId' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AccessAndMobilityData' + responses: + '201': + description: > + Successful case. The resource has been successfully created and a response + body containing a representation of the access and mobility data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AccessAndMobilityData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '200': + description: > + Successful case. The resource has been successfully updated and a response + body containing a representation of the access and mobility data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AccessAndMobilityData' + '204': + description: > + Successful case. The resource has been successfully updated and no additional content + is to be sent in the response message. + '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' +get: + summary: Retrieves the access and mobility exposure data for a UE + operationId: QueryAccessAndMobilityData + tags: + - AccessAndMobilityData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:access-and-mobility-data:read + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: The response body contains the access and mobility data + content: + application/json: + schema: + $ref: '#/components/schemas/AccessAndMobilityData' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Deletes the access and mobility exposure data for a UE + operationId: DeleteAccessAndMobilityData + tags: + - AccessAndMobilityData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr +``` + +``` + + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:access-and-mobility-data:modify +parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' +responses: + '204': + description: Upon success, an empty response body shall be returned + '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' +patch: + summary: Updates the access and mobility exposure data for a UE + operationId: UpdateAccessAndMobilityData + tags: + - AccessAndMobilityData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:access-and-mobility-data:modify + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AccessAndMobilityData' + responses: + '204': + description: > + Successful case. The resource has been successfully updated and no additional + content is to be sent in the response message. + '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' +/exposure-data/{ueId}/session-management-data/{pduSessionId}: + put: + summary: Creates and updates the session management data for a UE and for an individual PDU +session + operationId: CreateOrReplaceSessionManagementData + tags: + - PduSessionManagementData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:session-management-data:create + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: pduSessionId + in: path + description: PDU session id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionManagementData' + responses: + '201': + description: > + Successful case. The resource has been successfully created and a response + body containing a representation of the session management data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionManagementData' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '200': + description: > + Successful case. The resource has been successfully updated and a response body + containing a representation of the session management data shall be returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionManagementData' + '204': + description: > + Successful case. The resource has been successfully updated and no additional + +``` + +``` + content is to be sent in the response message. + '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' +get: + summary: Retrieves the session management data for a UE and for an individual PDU session + operationId: QuerySessionManagementData + tags: + - PduSessionManagementData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:session-management-data:read + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: pduSessionId + in: path + description: PDU session id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + - name: ipv4-addr + in: query + description: IPv4 Address of the UE + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + - name: ipv6-prefix + in: query + description: IPv6 Address Prefix of the UE + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + - name: dnn + in: query + description: DNN of the UE + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: fields + in: query + description: attributes to be retrieved + required: false + schema: + type: array +``` + +``` + items: + type: string + minItems: 1 + - name: supp-feat + in: query + description: Supported Features + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: The response body contains the session management data + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionManagementData' + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +delete: + summary: Deletes the session management data for a UE and for an individual PDU session + operationId: DeleteSessionManagementData + tags: + - PduSessionManagementData + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:session-management-data:modify + parameters: + - name: ueId + in: path + description: UE id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + - name: pduSessionId + in: path + description: PDU session id + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + responses: + '204': + description: Upon success, an empty response body shall be returned + '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' + +/exposure-data/subs-to-notify: + post: + summary: Create a subscription to receive notification of exposure data changes + operationId: CreateIndividualExposureDataSubscription + tags: + - ExposureDataSubscriptions (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:subs-to-notify:create + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ExposureDataSubscription' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/ExposureDataSubscription' + headers: + Location: + description: 'Contains the URI of the newly created resource' + 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: + exposureDataChangeNotification: + '{ $request.body#/notificationUri }': + post: + requestBody: + required: true + content: + +``` + +``` + + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ExposureDataChangeNotification' + minItems: 1 + responses: + '204': + description: No Content, Notification was successful + '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' + +/exposure-data/subs-to-notify/{subId}: + put: + summary: updates a subscription to receive notifications of exposure data changes + operationId: ReplaceIndividualExposureDataSubscription + tags: + - IndividualExposureDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:subs-to-notify:modify + parameters: + - name: subId + in: path + description: Subscription id + required: true + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ExposureDataSubscription' + responses: + '200': + description: > + Resource was successfully modified and a body with the modified subscription + to notifications about exposure data is returned.. + content: + application/json: + schema: + $ref: '#/components/schemas/ExposureDataSubscription' + '204': + description: The individual subscription resource was successfully modified. + '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 individual Exposure Data subscription + operationId: DeleteIndividualExposureDataSubscription + tags: + - IndividualExposureDataSubscription (Document) + security: + - {} + - oAuth2ClientCredentials: + - nudr-dr + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - oAuth2ClientCredentials: + - nudr-dr + - nudr-dr:exposure-data + - nudr-dr:exposure-data:subs-to-notify:modify + parameters: + - name: subId + in: path + description: Subscription id + required: true + schema: + type: string + responses: + '204': + description: Resource was successfully deleted. + '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: + schemas: + AccessAndMobilityData: + description: Represents Access and Mobility data for a UE. + type: object + properties: + location: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + locationTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + +``` + +``` + +timeZoneTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' +regStates: + type: array + items: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/RmInfo' +regStatesTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +connStates: + type: array + items: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmInfo' +connStatesTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +reachabilityStatus: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/UeReachability' +reachabilityStatusTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +smsOverNasStatus: + $ref: 'TS29518_Namf_Communication.yaml#/components/schemas/SmsSupport' +smsOverNasStatusTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +roamingStatus: + type: boolean + description: > + True The serving PLMN of the UE is different from the HPLMN of the UE; False + The serving PLMN of the UE is the HPLMN of the UE. +roamingStatusTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +currentPlmn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' +currentPlmnTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +ratType: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' +ratTypesTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +resetIds: + type: array + items: + type: string + minItems: 1 + +PduSessionManagementData: + description: Represents Session management data for a UE and a PDU session. + type: object + properties: + pduSessionStatus: + $ref: '#/components/schemas/PduSessionStatus' + pduSessionStatusTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + dnaiTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + n6TrafficRoutingInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + n6TrafficRoutingInfoTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Prefix: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + description: UE IPv6 prefix. + ipv6Addrs: + type: array + items: + +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + minItems: 1 + pduSessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + ipAddrTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + +ExposureDataSubscription: + description: Represents a Subscription to Notifications about Exposure Data. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + monitoredResourceUris: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + resetIds: + type: array + items: + type: string + minItems: 1 + immRep: + type: boolean + description: > + If provided and set to true, it indicates that existing entries that + match this subscription shall be immediately reported in the response. + immReports: + type: array + items: + $ref: '#/components/schemas/ExposureDataChangeNotification' + minItems: 1 + description: Immediate report with existing UDR entries. + required: + - notificationUri + - monitoredResourceUris + +ExposureDataChangeNotification: + description: Represents changed exposure data for one UE for which Notification was requested. + type: object + properties: + ueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/VarUeId' + accessAndMobilityData: + $ref: '#/components/schemas/AccessAndMobilityData' + pduSessionManagementData: + type: array + items: + $ref: '#/components/schemas/PduSessionManagementData' + minItems: 1 + delResources: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + minItems: 1 + +PduSessionStatus: + anyOf: + - type: string + enum: + - "ACTIVE" + - "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 state of the PDU session. + Possible values are + - "ACTIVE": the PDU session is active. + - "RELEASED": the PDU session released. +``` + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|-----------|-----------|------|-----|-----|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------| +| Date | Meeting # | TSG Doc. | CR | Rev | Cat | Subject/Comment | New | +| 2018-01 | CT3#94 | | | | | TS skeleton of Usage of the Unified Data Repository service for Policy Data and Structured Data for exposure | 0.0.0 | +| 2018-01 | CT3#94 | | | | | Inclusion of C3-180352, C3-180326, C3-180327 | 0.1.0 | +| 2018-03 | CT3#95 | | | | | Inclusion of C3-181145, C3-181288, C3-181289, C3-181313 | 0.2.0 | +| 2018-04 | CT3#96 | | | | | Inclusion of C3-182402, C3-182476, C3-182456, C3-182404, C3-182457, C3-182458 | 0.3.0 | +| 2018-05 | CT3#97 | | | | | Inclusion of C3-183872, C3-183705, C3-183704, C3-183873, C3-183732, C3-183706 C3-183874, C3-183709, C3-183876, C3-183263, C3-183877, C3-183712, C3-183715 and editorial changes by Rapporteur | 0.4.0 | +| 2018-06 | CT#80 | CP-181033 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181033 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0006 | | F | Scope and Overview | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0007 | | F | Introduction subclauses 5.1, 6.1 and 7.1 | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0008 | | F | Resource overview subclauses 5.2.1, 6.2.1 and 7.2.1 | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0009 | 3 | F | Nudr reused data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0010 | 6 | B | AM policy data resource definition | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0011 | 8 | B | SM policy data resource definition | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0012 | 3 | B | Sponsored data connectivity profiles | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0014 | 5 | B | Background Data Transfer data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0015 | 4 | B | Policy data change subscription | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0016 | 5 | B | Data change notification | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0017 | 2 | F | Error handling subclauses | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0018 | 1 | F | Feature negotiation | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0019 | 1 | F | Resource PFD Datas and Data types definition | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0020 | 1 | F | OpenAPI schema for Policy Data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0021 | 3 | F | Stage 2 Alligments for Structured Data for Exposure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0022 | 4 | B | Subscription for Structured Data for Exposure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0023 | 3 | F | Get query parameters for structured data for exposure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0024 | 5 | F | HTTP error responses for structured data for exposure | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0025 | 1 | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182032 | 0026 | 3 | B | Resource Structure for policy data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0027 | | F | n6 Traffic Routing Information encoding | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0028 | 1 | F | Removal of ExternalDocs section in OpenApi file for Exposure Data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0029 | 1 | F | VarUeld used in TS 29.519 | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0034 | 1 | F | OpenAPI schema for PolicyData | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0035 | 3 | F | External information stored in UDR for Application Data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0036 | | F | Clean up the Editor Note in applicatoion data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0037 | 4 | F | Correction the data type of application data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0038 | 3 | B | Introduce the operator policy data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0039 | 2 | B | OpenAPI of Application data | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0040 | 1 | F | Update of resource structure of application data 29.519 | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0041 | 1 | F | Ethernet packet filter for traffic influence data of applicatoion data 29.519 | 15.1.0 | +| 2018-12 | CP#82 | CP-183205 | 0042 | 1 | F | DNAI reused data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0043 | 1 | F | ExternalDocs field | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0044 | | F | PduSessionStatus | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0045 | 1 | F | Query parameters correction on application data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0046 | 1 | F | PUT operation for Individual Influence Data Subscription | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0047 | 3 | F | Background Data Transfer Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0048 | 1 | F | Cardinality for array and map | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0049 | 1 | F | Resource URI for ExposureData | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0050 | | F | Ueld definition | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0052 | 1 | F | Error status codes for HTTP responses | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0053 | | F | Service name | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0054 | 1 | F | Reference to the yaml file of Npcf_BDTPolicyControl API | 15.2.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|-------------------------------------------------------------------------------------------|--------| +| 2018-12 | CP#82 | CP-183205 | 0055 | | F | Missed GET method on UEPolicySetResource | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0055 | 2 | F | Missed GET method on UEPolicySetResource | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0056 | 4 | F | Corrections on AM Policy and UE Policy data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0057 | 6 | F | Corrections on SM Policy Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0058 | 1 | F | Correct TrafficRoute data type | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0060 | 4 | F | Correct subscription for application data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0062 | 3 | F | Correction to the AF Influence on traffic steering control | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0063 | 3 | F | PLMN ID as key for UE data sets | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0066 | 1 | F | Supported features | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0067 | 1 | F | Add AF application ID for traffic influence | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0068 | | F | Correct referenced file in openAPI for application data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0069 | | F | Correct referenced file in openAPI for exposure data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0070 | 1 | F | Use correct naming convention | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0071 | 1 | F | Correct subscription for Application Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0072 | 1 | F | Status code update for Application Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0073 | 1 | F | Correction on UsageThreshold | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0075 | 2 | F | Status code update for Exposure Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0076 | 2 | F | Status code update for Policy Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0077 | 2 | F | Incorrect response code of PUT method for individual PFD Data creation | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0078 | 1 | F | corrections on individual Influence Data | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0079 | 2 | F | Adding timestamp for allowed usage storage | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0080 | | F | Missing 201 response body for /policy-data/subs-to-notify | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0081 | 1 | F | Location header | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0083 | 4 | F | Corrections on Usage Monitoring information | 15.2.0 | +| 2018-12 | CP#82 | CP-183205 | 0087 | | F | Correction on PduSessionManagementData | 15.2.0 | +| 2019-03 | CP#83 | CP-190115 | 0090 | 1 | F | Correction on ChargingInformation data type reference in the OpenAPI file | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0091 | 1 | F | Formatting of structured data types in query parameters | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0092 | 1 | F | Correcting resource definitions | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0093 | | F | References to data types | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0095 | 2 | F | Correction on Policy Data change notification | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0096 | 1 | F | Correction on BDT data | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0098 | 1 | F | Support of allowed Route Selection data | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0099 | 1 | F | Support of PEI, OSid and ANDSP support indication in UE Policy Set | 15.3.0 | +| 2019-03 | CP#83 | CP-190115 | 0100 | | F | Support of PRA information | 15.3.0 | +| 2019-06 | CP#84 | CP-191077 | 0101 | | F | Correction of OpenAPI file and main body misalignments for Notification messages | 15.4.0 | +| 2019-06 | CP#84 | CP-191077 | 0102 | 2 | F | Corrections in PolicyDataSubscription and PolicyDataChangeNotification types | 15.4.0 | +| 2019-06 | CP#84 | CP-191077 | 0106 | 1 | F | Precedence of OpenAPI file | 15.4.0 | +| 2019-06 | CP#84 | CP-191077 | 0113 | | F | Correcting the name of URI to receive notifications | 15.4.0 | +| 2019-06 | CP#84 | CP-191077 | 0103 | 4 | F | "201 Created" response without body and other HTTP response errors | 15.4.0 | +| 2019-06 | CP#84 | CP-191077 | 0116 | 1 | F | Expiry time in subscription data types | 15.4.0 | +| 2019-06 | CP#84 | CP-191184 | 0117 | 3 | F | Notification of resource deletion | 15.4.0 | +| 2019-06 | CP#84 | CP-191208 | 0118 | 3 | F | Copyright Note in YAML file | 15.4.0 | +| 2019-06 | CP#84 | CP-191077 | 0119 | 1 | F | Missed Traffic Influence information | 15.4.0 | +| 2019-06 | CP#84 | CP-191183 | 0120 | 4 | F | Notification of resource deletion for Application and Exposure data sets | 15.4.0 | +| 2019-06 | CP#84 | CP-191089 | 0105 | 2 | B | PFD extension for domain name protocol | 16.0.0 | +| 2019-06 | CP#84 | CP-191071 | 0109 | 3 | B | AF acknowledgement to be expected | 16.0.0 | +| 2019-06 | CP#84 | CP-191071 | 0110 | 2 | B | UE IP address preservation indication | 16.0.0 | +| 2019-06 | CP#84 | CP-191100 | 0114 | 1 | B | NEF stored exposure data | 16.0.0 | +| 2019-09 | CT#85 | CP-192169 | 0125 | 2 | F | UDR Application Errors | 16.1.0 | +| 2019-09 | CT#85 | CP-192145 | 0127 | 2 | A | Missed any UE traffic influence data | 16.1.0 | +| 2019-09 | CT#85 | CP-192169 | 0128 | 1 | B | Multiple temporal validity conditions for AF traffic influence | 16.1.0 | +| 2019-09 | CT#85 | CP-192244 | 0130 | 2 | A | Remove PFD change notification | 16.1.0 | +| 2019-09 | CT#85 | CP-192156 | 0131 | 1 | B | Support a set of MAC addresses in traffic filter | 16.1.0 | +| 2019-09 | CT#85 | CP-192196 | 0138 | 4 | B | Application Data update to support xBDT | 16.1.0 | +| 2019-09 | CT#85 | CP-192152 | 0140 | 3 | B | Subscription and Notification of IPTV configuration data change | 16.1.0 | +| 2019-09 | CT#85 | CP-192152 | 0141 | 2 | B | Resource structure of Nudr API for Application Data | 16.1.0 | +| 2019-09 | CT#85 | CP-192152 | 0142 | 2 | B | Storage of IPTV configuration data | 16.1.0 | +| 2019-09 | CT#85 | CP-192156 | 0143 | 2 | F | Subscription/unsubscription for PFDs update notifications and related callback correction | 16.1.0 | +| 2019-10 | CT#85 | - | - | - | - | Addition of missing yaml files | 16.1.1 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------|--------| +| 2019-12 | CT#86 | CP-193223 | 0144 | 2 | B | Retrieval of BDT policy data for a set of BDT reference identifiers | 16.2.0 | +| 2019-12 | CT#86 | CP-193181 | 0145 | 1 | F | Open issue for AddrPreservation feature | 16.2.0 | +| 2019-12 | CT#86 | CP-193223 | 0149 | 3 | B | Support of BDT reference Id within Session Management data | 16.2.0 | +| 2019-12 | CT#86 | CP-193191 | 0151 | 3 | B | Partial update of IPTVConfiguration API | 16.2.0 | +| 2019-12 | CT#86 | CP-193210 | 0152 | 2 | B | Patch Report to Nudr_DataRepository API for Policy data | 16.2.0 | +| 2019-12 | CT#86 | CP-193223 | 0153 | | F | Reference correction to BdtReferenceId | 16.2.0 | +| 2019-12 | CT#86 | CP-193212 | 0155 | 1 | F | Update of TS version Rel-16 | 16.2.0 | +| 2019-12 | CT#86 | CP-193197 | 0156 | 2 | B | MCS Priority Indication | 16.2.0 | +| 2019-12 | CT#86 | CP-193187 | 0158 | - | A | Definition of BdtData in OpenAPI | 16.2.0 | +| 2019-12 | CT#86 | CP-193197 | 0159 | - | F | Usage of BdtReferenceId data type | 16.2.0 | +| 2019-12 | CT#86 | CP-193223 | 0161 | 1 | B | include S-NSSAI and DNN in Application Data for xBDT | 16.2.0 | +| 2019-12 | CT#86 | CP-193223 | 0162 | | F | remove 204 response on PUT request for AppliedBDTPolicyData | 16.2.0 | +| 2019-12 | CT#86 | CP-193210 | 0164 | | B | Feature Negotiation for OperatorSpecificData resource | 16.2.0 | +| 2019-12 | CT#86 | CP-193210 | 0165 | | B | Feature Negotiation for Influence Data resource | 16.2.0 | +| 2019-12 | CT#86 | CP-193126 | 0166 | | B | URI correction on resource Individual Applied BDT Policy Data | 16.2.0 | +| 2020-03 | CT#87e | CP-200141 | 0167 | 2 | B | Application data change notification | 16.3.0 | +| 2020-03 | CT#87e | CP-200203 | 0168 | 1 | B | Complete the IPTV configuration | 16.3.0 | +| 2020-03 | CT#87e | CP-200263 | 0169 | 2 | B | Nudr_DataRepository API update for Service Parameter provisioning | 16.3.0 | +| 2020-03 | CT#87e | CP-200218 | 0170 | 1 | B | Indication of traffic correlation | 16.3.0 | +| 2020-03 | CT#87e | CP-200136 | 0171 | 2 | B | Include influenceId into TrafficInfluData for Notification | 16.3.0 | +| 2020-03 | CT#87e | CP-200219 | 0172 | 2 | B | Correct the mapping of ASPid for xBDT | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0173 | 1 | B | Subscription and notification to data changes related to a subset of resource data, Policy Data set | 16.3.0 | +| 2020-03 | CT#87e | CP-200203 | 0174 | | F | Correct content type in PATCHing IPTV application data | 16.3.0 | +| 2020-03 | CT#87e | CP-200198 | 0175 | | B | Additional PDU session status data | 16.3.0 | +| 2020-03 | CT#87e | CP-200219 | 0176 | | F | Correct content type in PATCHing BDT application data | 16.3.0 | +| 2020-03 | CT#87e | CP-200219 | 0177 | | F | Removal of the BDT policy from the "bdtRefIds" object | 16.3.0 | +| 2020-06 | CT#88e | CP-201220 | 0179 | 2 | A | internalGroupId in Influence Data | 16.4.0 | +| 2020-06 | CT#88e | CP-201238 | 0180 | 2 | F | Definition of ServiceParameterData in openAPI | 16.4.0 | +| 2020-06 | CT#88e | CP-201246 | 0181 | 3 | F | Data Types for Application Data | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0183 | 1 | F | Correction to IPTV Configuration | 16.4.0 | +| 2020-06 | CT#88e | CP-201253 | 0184 | 1 | F | Correction to BDT Policy | 16.4.0 | +| 2020-06 | CT#88e | CP-201220 | 0185 | 1 | A | Correction to notifications of Operator Specific Data changes | 16.4.0 | +| 2020-06 | CT#88e | CP-201220 | 0188 | | A | Correct content type in PATCHing traffic influence application data | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0189 | | F | Correct DataFilter presence condition | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0190 | | F | Correct resourceId in required field | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0191 | 1 | B | Support local traffic routing in session subscription | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0192 | 1 | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201276 | 0194 | 1 | F | Traffic descriptor for xBDT | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0195 | 1 | F | URI of the Nudr_DataRepository service for Policy, Application and Exposure data | 16.4.0 | +| 2020-06 | CT#88e | CP-201313 | 0197 | | F | Data type of internalGroupId attribute | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0199 | | F | Data model correction for IPTV | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0200 | | F | Remove feature for IPTV data configuration | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0201 | | F | Optionality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0202 | 2 | F | Corrections on supported features definition | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0203 | | F | required field in OpenAPI file | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0204 | 1 | F | Supported headers, Resource Data type | 16.4.0 | +| 2020-06 | CT#88e | CP-201255 | 0206 | | F | Update in TS version in externalDocs field | 16.4.0 | +| 2020-09 | CT#89e | CP-202059 | 0207 | | F | Include resouceURI in IptvConfigData for change notification association | 16.5.0 | +| 2020-09 | CT#89e | CP-202069 | 0208 | | F | Include resouceURI in ServiceParameterData for change notification association | 16.5.0 | +| 2020-09 | CT#89e | CP-202209 | 0209 | | F | Include resouceURI in TrafficInfluData for change notification association | 16.5.0 | +| 2020-09 | CT#89e | CP-202082 | 0210 | | F | Include resouceURI in BdtPolicyData for change notification association | 16.5.0 | +| 2020-09 | CT#89e | CP-202073 | 0211 | | F | Removal of sibling elements | 17.0.0 | +| 2020-09 | CT#89e | CP-202073 | 0212 | | B | Resource Level Authorization for Policy Data, Application Data, and Exposure Data | 17.0.0 | +| 2020-09 | CT#89e | CP-202085 | 0214 | | F | Update of TS version in externalDocs field | 17.0.0 | +| 2020-12 | CT#90e | CP-203139 | 0216 | | A | TS 29.519 Essential Corrections and alignments | 17.1.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------------------------------------|--------| +| 2020-12 | CT#90e | CP-203110 | 0218 | 1 | A | Correction to support NEF binding indication | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0220 | 1 | A | Correction to the BDT policy re-negotiation | 17.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0222 | | A | Storage of YAML files in 3GPP Forge | 17.1.0 | +| 2020-12 | CT#90e | CP-203147 | 0223 | 2 | B | Data retrieval of multiple policy data sets | 17.1.0 | +| 2020-12 | CT#90e | CP-203154 | 0225 | | A | MA Support indication within UE Context policy control subscription information | 17.1.0 | +| 2020-12 | CT#90e | CP-203139 | 0227 | 1 | A | Callback URI correction | 17.1.0 | +| 2020-12 | CT#90e | CP-203153 | 0229 | | F | Update of TS version in externalDocs field | 17.1.0 | +| 2021-03 | CT#91e | CP-210226 | 0230 | 1 | B | Allow the retrieval of a set of policy data subsets for a UE | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0231 | | F | Adding "description" field for map data types | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0232 | | F | OpenAPI reference | 17.2.0 | +| 2021-03 | CT#91e | CP-210226 | 0233 | | F | Encoding of Snssai as key of a map | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0235 | | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.2.0 | +| 2021-03 | CT#91e | CP-210198 | 0238 | 1 | A | UsageMonData: definition of "scopes" attribute | 17.2.0 | +| 2021-03 | CT#91e | CP-210198 | 0242 | 1 | A | PUT method for Exposure Data modification | 17.2.0 | +| 2021-03 | CT#91e | CP-210206 | 0244 | 1 | A | extend bdtpStatus to include VALID | 17.2.0 | +| 2021-03 | CT#91e | CP-210240 | 0248 | | F | Update of TS version in externalDocs field | 17.2.0 | +| 2021-06 | CT#92e | CP-211242 | 0250 | 1 | F | Correction to Charging Information | 17.3.0 | +| 2021-06 | CT#92e | CP-211211 | 0252 | 3 | B | Correction to OSD handling | 17.3.0 | +| 2021-06 | CT#92e | CP-211121 | 0253 | 4 | B | 5G ProSe related updates to Nudr | 17.3.0 | +| 2021-06 | CT#92e | CP-211218 | 0254 | 2 | B | Support of User Plane Latency requirement | 17.3.0 | +| 2021-06 | CT#92e | CP-211218 | 0257 | 1 | B | UDR application data update to support AF influence on URSP | 17.3.0 | +| 2021-06 | CT#92e | CP-211265 | 0259 | | F | Update of TS version in externalDocs field | 17.3.0 | +| 2021-09 | CT#93e | CP-212242 | 0260 | 1 | B | AM Influence UDR models for DCAMP | 17.4.0 | +| 2021-09 | CT#93e | CP-212206 | 0261 | 1 | B | PDU session policy data extension for UE-Slice-MBR | 17.4.0 | +| 2021-09 | CT#93e | CP-212206 | 0263 | 1 | B | Policy Data extension for Slice-MBR | 17.4.0 | +| 2021-09 | CT#93e | CP-212224 | 0264 | 1 | F | Corrections to IPTV configuration data | 17.4.0 | +| 2021-09 | CT#93e | CP-212229 | 0266 | 1 | F | Correction of cardinality for xBDT | 17.4.0 | +| 2021-09 | CT#93e | CP-212190 | 0269 | | F | Correction of data types of resetPeriod and resetTime in openAPI file | 17.4.0 | +| 2021-09 | CT#93e | CP-212188 | 0271 | | B | Removal of some 5G ProSe related Ens | 17.4.0 | +| 2021-09 | CT#93e | CP-211223 | 0272 | | F | Update of externalDocs field | 17.4.0 | +| 2021-12 | CT#94e | CP-213230 | 0275 | 1 | B | Correction on Network Slice Policy Control Subscription information | 17.5.0 | +| 2021-12 | CT#94e | CP-213230 | 0276 | | B | Correction on PolicyDataChangeNotification | 17.5.0 | +| 2021-12 | CT#94e | CP-213222 | 0277 | 1 | B | Nudr impacts for the notification on the outcome of UE Policies delivery due to service specific parameter provisioning | 17.5.0 | +| 2021-12 | CT#94e | CP-213194 | 0278 | | F | AM Influence Data: alignment with naming convention | 17.5.0 | +| 2021-12 | CT#94e | CP-213230 | 0279 | 1 | F | Presence conditions for attributes in SlicePolicyData | 17.5.0 | +| 2021-12 | CT#94e | CP-213234 | 0280 | 1 | B | Time Synch data in UDR | 17.5.0 | +| 2021-12 | CT#94e | CP-213239 | 0281 | 1 | F | Clarification about the data type used for UE policy section information | 17.5.0 | +| 2021-12 | CT#94e | CP-213194 | 0282 | 1 | B | AM Influence data model updates | 17.5.0 | +| 2021-12 | CT#94e | CP-213213 | 0283 | 1 | B | Updates to the 5G ProSe service parameters | 17.5.0 | +| 2021-12 | CT#94e | CP-213223 | 0286 | 1 | B | Clarification of AF preference for the user plane latency | 17.5.0 | +| 2021-12 | CT#94e | CP-213168 | 0288 | 2 | F | Feature negotiation at PFD data retrieval | 17.5.0 | +| 2021-12 | CT#94e | CP-213170 | 0290 | 2 | F | Reference PfdDataForApp data type | 17.5.0 | +| 2021-12 | CT#94e | CP-213223 | 0291 | 1 | B | AF Request for Simultaneous Connectivity over Source and Target PSA at Edge Relocation | 17.5.0 | +| 2021-12 | CT#94e | CP-213239 | 0293 | 1 | F | Naming Convention | 17.5.0 | +| 2021-12 | CT#94e | CP-213246 | 0294 | | F | Update of externalDocs field | 17.5.0 | +| 2022-03 | CT#95e | CP-220198 | 0296 | 2 | B | Resolution of DCAMP open issues such as applicable filters and immediate reporting | 17.6.0 | +| 2022-03 | CT#95e | CP-220201 | 0297 | | B | Support of Operator-Specific Data with no keys | 17.6.0 | +| 2022-03 | CT#95e | CP-220176 | 0298 | 2 | A | Alignment of "Application Errors" clauses with SBI TS template | 17.6.0 | +| 2022-03 | CT#95e | CP-220185 | 0299 | 1 | B | Updates to support AF Guidance on URSP for Application Data | 17.6.0 | +| 2022-03 | CT#95e | CP-220327 | 0300 | 2 | B | resetId assignment to UDR consumers (PCF, NEF) | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0301 | 1 | D | Clause Correction | 17.6.0 | +| 2022-03 | CT#95e | CP-220186 | 0302 | 1 | B | API definition for EAS Deployment Information Data | 17.6.0 | +| 2022-03 | CT#95e | CP-220330 | 0303 | 2 | B | OpenAPI to support EAS Deployment Information Data | 17.6.0 | +| 2022-03 | CT#95e | CP-220183 | 0304 | 1 | B | Time Synch data updates | 17.6.0 | +| 2022-03 | CT#95e | CP-220176 | 0306 | | A | Correction of query parameter content type | 17.6.0 | +| 2022-03 | CT#95e | CP-220215 | 0308 | 2 | F | Introduction of ServiceParameterDataPatch | 17.6.0 | +| 2022-03 | CT#95e | CP-220185 | 0309 | | F | Removal of Editor's Notes for URSP encoding and DeliveryOutcome feature | 17.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|---------------------------------------------------------------------------------------|--------| +| 2022-03 | CT#95e | CP-220186 | 0310 | 1 | B | Support of binding principles for UE Policy Delivery outcome | 17.6.0 | +| 2022-03 | CT#95e | CP-220198 | 0312 | 1 | F | Updates of AM Influence Data resource | 17.6.0 | +| 2022-03 | CT#95e | CP-220198 | 0313 | 1 | F | Query for AM Influence data for Any UE | 17.6.0 | +| 2022-03 | CT#95e | CP-220197 | 0314 | 1 | B | Support of service area coverage notifications | 17.6.0 | +| 2022-03 | CT#95e | CP-220198 | 0315 | 1 | F | Solving Editor's Note on query parameters | 17.6.0 | +| 2022-03 | CT#95e | CP-220201 | 0316 | 1 | F | Formatting of description fields | 17.6.0 | +| 2022-03 | CT#95e | CP-220334 | 0318 | 2 | F | Query for Service Parameter Data for Any UE | 17.6.0 | +| 2022-03 | CT#95e | CP-220196 | 0320 | 1 | F | Subscription to notifications for Any UE | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0321 | 1 | F | Updates of Traffic Influence resource | 17.6.0 | +| 2022-03 | CT#95e | CP-220195 | 0322 | 2 | F | Correction to default values | 17.6.0 | +| 2022-03 | CT#95e | CP-220194 | 0324 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221157 | 0326 | | F | Removal of allowEmptyValue parameter | 17.7.0 | +| 2022-06 | CT#96 | CP-221153 | 0327 | 2 | F | Support of allowedDelay for PFD data | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0328 | | F | Correction of supported features for Edge Computing functionality | 17.7.0 | +| 2022-06 | CT#96 | CP-221159 | 0329 | 2 | F | Handling of query parameters for AM Influence Data resource | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0330 | 1 | B | Policy Data Subscription enhancements | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0331 | 1 | F | Handling of combinations of attributes of DataFilter data type | 17.7.0 | +| 2022-06 | CT#96 | CP-221158 | 0332 | 2 | F | Handling of query parameters in Applied BDT Data | 17.7.0 | +| 2022-06 | CT#96 | CP-221158 | 0333 | 2 | F | Handling of query parameters in IPTV Configuration resource | 17.7.0 | +| 2022-06 | CT#96 | CP-221157 | 0334 | 1 | F | Handling of query parameters for PFD Data | 17.7.0 | +| 2022-06 | CT#96 | CP-221158 | 0335 | 2 | F | Handling of query parameters in Traffic Influence Data | 17.7.0 | +| 2022-06 | CT#96 | CP-221158 | 0336 | 2 | F | Handling of query parameters in Service Parameter Data resource | 17.7.0 | +| 2022-06 | CT#96 | CP-221155 | 0337 | 1 | B | Nudr_DataRepository Application data Access Scope update for API, resource, operation | 17.7.0 | +| 2022-06 | CT#96 | CP-221155 | 0338 | 1 | B | Nudr_DataRepository Exposure Data Access Scope update for API, resource, operation | 17.7.0 | +| 2022-06 | CT#96 | CP-221155 | 0339 | 1 | B | Nudr_DataRepository Policy data Access Scope update for API, resource, operation | 17.7.0 | +| 2022-06 | CT#96 | CP-221126 | 0340 | 1 | F | Update on EAS Deployment Information Data | 17.7.0 | +| 2022-06 | CT#96 | CP-221159 | 0341 | 1 | F | Clarification about subscription to cha | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0342 | 1 | F | Removing the apiVersion placeholder from the Resource URI variables tables | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0343 | | F | Nudr_DataRepository Policy data description field update | 17.7.0 | +| 2022-06 | CT#96 | CP-221158 | 0344 | 1 | F | Dependencies between UM resource(s) and SM resource | 17.7.0 | +| 2022-06 | CT#96 | CP-221151 | 0345 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-09 | CT#97e | CP-222123 | 0346 | 2 | F | Correction in the handling of individual AM Influence Data resource | 17.8.0 | +| 2022-09 | CT#97e | CP-222123 | 0347 | 2 | F | Correction in the handling of individual Applied BDT Policy Data resource | 17.8.0 | +| 2022-09 | CT#97e | CP-222123 | 0348 | 2 | F | Correction in the handling of individual Influence Data resource | 17.8.0 | +| 2022-09 | CT#97e | CP-222123 | 0349 | 2 | F | Correction in the handling of individual IPTV configuration resource | 17.8.0 | +| 2022-09 | CT#97e | CP-222123 | 0350 | 2 | F | Correction in the handling of individual Service Parameter Data resource | 17.8.0 | +| 2022-09 | CT#97e | CP-222123 | 0351 | | F | OpenAPI file for policy data: tabs removal and "description" field adding | 17.8.0 | +| 2022-09 | CT#97e | CP-222123 | 0352 | 1 | F | Application data API: definitions of 403 and 404 responses | 17.8.0 | +| 2022-09 | CT#97e | CP-222099 | 0353 | | F | Support of GET for Individual EAS Deployment Information Data resource | 17.8.0 | +| 2022-09 | CT#97e | CP-222099 | 0354 | | F | Incomplete implementation of CR #0308 | 17.8.0 | +| 2022-09 | CT#97e | CP-222093 | 0357 | | A | Correction to UE Dedicated PRAs | 17.8.0 | +| 2022-09 | CT#97e | CP-222099 | 0358 | | F | Corrections to Group Id | 17.8.0 | +| 2022-09 | CT#97e | CP-222095 | 0359 | 1 | B | Supporting MBS policy control | 17.8.0 | +| 2022-09 | CT#97e | CP-222121 | 0360 | | F | Update of info and externalDocs fields | 17.8.0 | +| 2022-12 | CT#98e | CP-223196 | 0366 | 1 | F | Correction related to applicability of traffic correlation indicator | 17.9.0 | +| 2022-12 | CT#98e | CP-223166 | 0367 | | F | Correction to MbsSessPolCtrlData data type | 17.9.0 | +| 2022-12 | CT#98e | CP-223191 | 0361 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0362 | 1 | B | Immediate reporting for policy data | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0363 | 1 | F | Nudr_DataRepository API for policy data: enumeration definitions | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0365 | 1 | F | Corrections to the resource EAS Deployment Information Data | 18.0.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------|--------| +| 2022-12 | CT#98e | CP-223192 | 0369 | | F | Corrections on Resource URI structures | 18.0.0 | +| 2022-12 | CT#98e | CP-223198 | 0370 | | F | Correction to DNN encoding | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0371 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230170 | 0372 | 1 | B | Service Function Chaining support in Nudr_DataRepository | 18.1.0 | +| 2023-03 | CT#99 | CP-230165 | 0375 | 1 | A | Partial subscriptions corrections | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0377 | 1 | B | Immediate reporting for application data | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0378 | 1 | B | Immediate reporting for exposure data | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0380 | 1 | B | Addressing inconsistencies in the supported features negotiation | 18.1.0 | +| 2023-03 | CT#99 | CP-230137 | 0381 | | | Support External Subscriber Category | 18.1.0 | +| 2023-03 | CT#99 | CP-230163 | 0383 | | A | Correction to allowedDelay for PFD data | 18.1.0 | +| 2023-03 | CT#99 | CP-230164 | 0386 | | A | nternal-Group-Ids attribute correction | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0387 | | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230137 | 0389 | 1 | B | Support for AF traffic influence for common EAS, DNAI selection | 18.1.0 | +| 2023-03 | CT#99 | CP-230175 | 0390 | 1 | F | Support of indirect feature negotiation | 18.1.0 | +| 2023-03 | CT#99 | CP-230152 | 0391 | 1 | B | New Indication of URSP provisioning support in EPS | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0392 | 1 | B | Solving Editor's Notes for Immediate Report of Policy Data | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0393 | 1 | B | Retrieval of Policy Data Subscriptions | 18.1.0 | +| 2023-03 | CT#99 | CP-230129 | 0397 | 1 | A | Correction of a misalignment in an attribute's name | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0398 | | F | Corrections to query parameters not respecting the naming convention | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0399 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231156 | 0400 | 1 | B | Support for A2X service parameters provisioning | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0401 | | B | Introduction of PDTQ impacts in Nudr service | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0402 | | F | Missing implementation for immediate reporting functionality | 18.2.0 | +| 2023-06 | CT#100 | CP-231149 | 0405 | 3 | B | Resource for Group-MBR in Nudr_DataRepository service for Policy Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231149 | 0406 | 3 | B | Data Model for Group-MBR in Nudr_DataRepository service for Policy Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231158 | 0407 | 1 | B | Correction to AF influence on Service Function Chaining | 18.2.0 | +| 2023-06 | CT#100 | CP-231135 | 0408 | | B | Complete common DNAI and EAS selection | 18.2.0 | +| 2023-06 | CT#100 | CP-231171 | 0410 | 1 | B | Adding list of PLMN ID(s) for inbound roaming UEs in AM Influence Data. | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 0411 | 1 | B | Add applicability information for URSP provisioning in EPS | 18.2.0 | +| 2023-06 | CT#100 | CP-231149 | 0412 | 1 | B | OpenAPI for Group-MBR in Nudr_DataRepository service for Policy Data | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0414 | | F | Update of externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232090 | 0416 | 1 | F | Corrections to the definition of Group related Policy Control Data | 18.3.0 | +| 2023-09 | CT#101 | CP-232114 | 0417 | 1 | A | Correction in ServiceParameterDataPatch data type | 18.3.0 | +| 2023-09 | CT#101 | CP-232099 | 0418 | 1 | B | CHF address(es) for policy decision | 18.3.0 | +| 2023-09 | CT#101 | CP-232099 | 0419 | 1 | B | Spending limits control for policy decision | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0420 | 1 | B | Support of the tracing requirements for UE policy | 18.3.0 | +| 2023-09 | CT#101 | CP-232119 | 0421 | 1 | B | Service parameter provisioning for 5G ProSe UE-to-UE relay | 18.3.0 | +| 2023-09 | CT#101 | CP-232101 | 0422 | 1 | B | Adding TNAP IDs to Service Parameter data | 18.3.0 | +| 2023-09 | CT#101 | CP-232101 | 0423 | 1 | B | Adding subscribed TNAP IDs to Policy data | 18.3.0 | +| 2023-09 | CT#101 | CP-232090 | 0424 | 1 | B | Resource and data model for the AF Requested QoS for a UE or a group of UEs | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0425 | 1 | B | Support for AM policy data in the operator specific data resource | 18.3.0 | +| 2023-09 | CT#101 | CP-232090 | 0427 | 1 | B | Removal of ENs on Group-MBR | 18.3.0 | +| 2023-09 | CT#101 | CP-232102 | 0429 | 1 | F | Correction on SFC terminology and editorial issues | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0430 | 1 | B | Update the storage of the PDTQ policy data | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0431 | | B | PdtqData: support of Application Identifier parameter | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0432 | | F | Correction of resource URI for resource IndividualPdtqData | 18.3.0 | +| 2023-09 | CT#101 | CP-232106 | 0434 | | A | Correction on headers attribute | 18.3.0 | +| 2023-09 | CT#101 | CP-232183 | 0435 | 2 | B | Common EAS/DNAI determination for a set of UEs | 18.3.0 | +| 2023-09 | CT#101 | CP-232092 | 0436 | 1 | B | Completion of eUEPO impacts | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0438 | 1 | F | Correction to Service Parameter Data query | 18.3.0 | +| 2023-09 | CT#101 | CP-232103 | 0439 | 3 | B | Add ParmForRangingSI | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0442 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-09 | CT#101 | CP-232086 | 0443 | | F | defining BdtReferenceIdRm data type | 18.3.0 | +| 2023-12 | CT#102 | CP-233254 | 0448 | 1 | A | Corrections on attribute names of SM Policy Data | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 0450 | 2 | B | Resolving the remaining EN on group data rate control | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0451 | | F | HTTP RFCs obsoleted by IETF RFC 9110 | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------|--------| +| 2023-12 | CT#102 | CP-233239 | 0452 | 1 | F | Data model corrections for TrafficCorrelationInfo | 18.4.0 | +| 2023-12 | CT#102 | CP-233240 | 0453 | 3 | B | DNAI-EAS Mappings data subset in the UDR | 18.4.0 | +| 2023-12 | CT#102 | CP-233247 | 0454 | 1 | F | Handling of the warning notification enabled flag. | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0456 | | F | Correction in data type for AmInfluData | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0457 | 1 | F | Handling of the warning notification enabled flag. | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 0460 | 3 | B | AF Requested QoS for a UE or Group of UEs | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 0461 | 1 | B | Subscription to notification of changes of AF Requested QoS | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0462 | | F | Correction to presence conditions in the OpenAPI file | 18.4.0 | +| 2023-12 | CT#102 | CP-233247 | 0464 | 1 | F | Correction to subscription to notification of changes of AF influence on AM Policies | 18.4.0 | +| 2023-12 | CT#102 | CP-233228 | 0465 | | F | Removing the unnecessary resetIds attributes | 18.4.0 | +| 2023-12 | CT#102 | CP-233239 | 0466 | 1 | B | ECS Address Information in Roaming | 18.4.0 | +| 2023-12 | CT#102 | CP-233245 | 0467 | 1 | F | Security scopes are missing in OpenAPI definition for GroupPolicyControlData. | 18.4.0 | +| 2023-12 | CT#102 | CP-233267 | 0468 | | F | Correcting the presence indicator of metadata attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233270 | 0469 | 1 | F | Incorrect feature name | 18.4.0 | +| 2023-12 | CT#102 | CP-233147 | 0470 | 2 | A | Correction of anyUeInd attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233247 | 0472 | 1 | F | EAS Deployment Data corrections | 18.4.0 | +| 2023-12 | CT#102 | CP-233244 | 0474 | 1 | B | Completion of LBO roaming information | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0475 | | F | Update of externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29520/raw.md b/marked/Rel-18/29_series/29520/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..a5f0ee8f1e7a3bf001239af06670c8d77854a3d1 --- /dev/null +++ b/marked/Rel-18/29_series/29520/raw.md @@ -0,0 +1,20188 @@ + + +# 3GPP TS 29.520 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Network Data Analytics 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 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 + +# 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..... | 16 | +| 1 Scope..... | 17 | +| 2 References..... | 17 | +| 3 Definitions and abbreviations..... | 18 | +| 3.1 Definitions..... | 18 | +| 3.2 Abbreviations..... | 18 | +| 4 Services offered by the NWDAF..... | 19 | +| 4.1 Introduction..... | 19 | +| 4.2 Nnwdaf_EventsSubscription Service..... | 22 | +| 4.2.1 Service Description..... | 22 | +| 4.2.1.1 Overview..... | 22 | +| 4.2.1.2 Service Architecture..... | 23 | +| 4.2.1.3 Network Functions..... | 24 | +| 4.2.1.3.1 Network Data Analytics Function (NWDAF)..... | 24 | +| 4.2.1.3.2 NF Service Consumers..... | 24 | +| 4.2.2 Service Operations..... | 26 | +| 4.2.2.1 Introduction..... | 26 | +| 4.2.2.2 Nnwdaf_EventsSubscription_Subscribe service operation..... | 26 | +| 4.2.2.2.1 General..... | 26 | +| 4.2.2.2.2 Subscription for event notifications..... | 27 | +| 4.2.2.2.3 Update subscription for event notifications..... | 36 | +| 4.2.2.3 Nnwdaf_EventsSubscription_Unsubscribe service operation..... | 37 | +| 4.2.2.3.1 General..... | 37 | +| 4.2.2.3.2 Unsubscribe from event notifications..... | 37 | +| 4.2.2.4 Nnwdaf_EventsSubscription_Notify service operation..... | 38 | +| 4.2.2.4.1 General..... | 38 | + +# 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.4.2 | Notification about subscribed event..... | 38 | +| 4.2.2.5 | Nnwdaf_EventsSubscription_Transfer service operation..... | 40 | +| 4.2.2.5.1 | General..... | 40 | +| 4.2.2.5.2 | Creation of request for analytics subscription transfer..... | 41 | +| 4.2.2.5.3 | Update a request for analytics subscription transfer..... | 42 | +| 4.2.2.5.4 | Cancel a request for analytics subscription transfer..... | 43 | +| 4.3 | Nnwdaf_AnalyticsInfo Service..... | 44 | +| 4.3.1 | Service Description..... | 44 | +| 4.3.1.1 | Overview..... | 44 | +| 4.3.1.2 | Service Architecture..... | 44 | +| 4.3.1.3 | Network Functions..... | 45 | +| 4.3.1.3.1 | Network Data Analytics Function (NWDAF)..... | 45 | +| 4.3.1.3.2 | NF Service Consumers..... | 45 | +| 4.3.2 | Service Operations..... | 47 | +| 4.3.2.1 | Introduction..... | 47 | +| 4.3.2.2 | Nnwdaf_AnalyticsInfo_Request service operation..... | 47 | +| 4.3.2.2.1 | General..... | 47 | +| 4.3.2.2.2 | Request and get from NWDAF Analytics information..... | 47 | +| 4.3.2.3 | Nnwdaf_AnalyticsInfo_ContextTransfer service operation..... | 56 | +| 4.3.2.3.1 | General..... | 56 | +| 4.3.2.3.2 | Request and get from NWDAF context of a subscription..... | 57 | +| 4.4 | Nnwdaf_DataManagement Service..... | 58 | +| 4.4.1 | Service Description..... | 58 | +| 4.4.1.1 | Overview..... | 58 | +| 4.4.1.2 | Service Architecture..... | 58 | +| 4.4.1.3 | Network Functions..... | 59 | +| 4.4.1.3.1 | Network Data Analytics Function (NWDAF)..... | 59 | +| 4.4.1.3.2 | NF Service Consumers..... | 59 | +| 4.4.2 | Service Operations..... | 59 | +| 4.4.2.1 | Introduction..... | 59 | +| 4.4.2.2 | Nnwdaf_DataManagement_Subscribe service operation..... | 59 | +| 4.4.2.2.1 | General..... | 59 | +| 4.4.2.2.2 | Subscription for data notifications..... | 59 | +| 4.4.2.2.3 | Update subscription for data notifications..... | 61 | +| 4.4.2.3 | Nnwdaf_DataManagement_Unsubscribe service operation..... | 63 | + +| | | | +|-----------|------------------------------------------------------------|----| +| 4.4.2.3.1 | General..... | 63 | +| 4.4.2.3.2 | Unsubscribe from data notifications..... | 63 | +| 4.4.2.4 | Nnwdaf_DataManagement_Notify service operation..... | 64 | +| 4.4.2.4.1 | General..... | 64 | +| 4.4.2.4.2 | Notification about subscribed data..... | 64 | +| 4.4.2.5 | Nnwdaf_DataManagement_Fetch service operation..... | 65 | +| 4.4.2.5.1 | General..... | 65 | +| 4.4.2.5.2 | Retrieve data from the NWDAF..... | 65 | +| 4.5 | Nnwdaf_MLModelProvision Service..... | 66 | +| 4.5.1 | Service Description..... | 66 | +| 4.5.1.1 | Overview..... | 66 | +| 4.5.1.2 | Service Architecture..... | 66 | +| 4.5.1.3 | Network Functions..... | 67 | +| 4.5.1.3.1 | Network Data Analytics Function (NWDAF)..... | 67 | +| 4.5.1.3.2 | NF Service Consumers..... | 67 | +| 4.5.2 | Service Operations..... | 67 | +| 4.5.2.1 | Introduction..... | 67 | +| 4.5.2.2 | Nnwdaf_MLModelProvision_Subscribe service operation..... | 68 | +| 4.5.2.2.1 | General..... | 68 | +| 4.5.2.2.2 | Subscription for event notifications..... | 68 | +| 4.5.2.2.3 | Update subscription for event notifications..... | 69 | +| 4.5.2.3 | Nnwdaf_MLModelProvision_Unsubscribe service operation..... | 70 | +| 4.5.2.3.1 | General..... | 70 | +| 4.5.2.3.2 | Unsubscribe from event notifications..... | 70 | +| 4.5.2.4 | Nnwdaf_MLModelProvision_Notify service operation..... | 71 | +| 4.5.2.4.1 | General..... | 71 | +| 4.5.2.4.2 | Notification about subscribed event..... | 71 | +| 4.6 | Nnwdaf_MLModelTraining Service..... | 72 | +| 4.6.1 | Service Description..... | 72 | +| 4.6.1.1 | Overview..... | 72 | +| 4.6.1.2 | Service Architecture..... | 72 | +| 4.6.1.3 | Network Functions..... | 73 | +| 4.6.1.3.1 | Network Data Analytics Function (NWDAF)..... | 73 | +| 4.6.1.3.2 | NF Service Consumers..... | 73 | +| 4.6.2 | Service Operations..... | 73 | + +| | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|----| +| 4.6.2.1 | Introduction..... | 73 | +| 4.6.2.2 | Nnwdaf_MLModelTraining_Subscribe service operation..... | 74 | +| 4.6.2.2.1 | General..... | 74 | +| 4.6.2.2.2 | Subscription for event notifications..... | 74 | +| 4.6.2.2.3 | Update subscription for event notifications..... | 75 | +| 4.6.2.2.4 | Partial update subscription for event notifications..... | 76 | +| 4.6.2.3 | Nnwdaf_MLModelTraining_Unsubscribe service operation..... | 77 | +| 4.6.2.3.1 | General..... | 77 | +| 4.6.2.3.2 | Unsubscribe from event notifications..... | 77 | +| 4.6.2.4 | Nnwdaf_MLModelTraining_Notify service operation..... | 78 | +| 4.6.2.4.1 | General..... | 78 | +| 4.6.2.4.2 | Notification about subscribed event..... | 78 | +| Figure 4.6.2.4.2-1 shows a scenario where the NWDAF sends a request to the NF Service Consumer to notify for event notifications (see also 3GPP TS 23.288 [17])..... | | 78 | +| 4.7 | Nnwdaf_MLModelMonitor Service..... | 79 | +| 4.7.1 | Service Description..... | 79 | +| 4.7.1.1 | Overview..... | 79 | +| 4.7.1.2 | Service Architecture..... | 79 | +| 4.7.1.3 | Network Functions..... | 80 | +| 4.7.1.3.1 | Network Data Analytics Function (NWDAF)..... | 80 | +| 4.7.1.3.2 | NF Service Consumers..... | 80 | +| 4.7.2 | Service Operations..... | 80 | +| 4.7.2.1 | Introduction..... | 80 | +| 4.7.2.2 | Nnwdaf_MLModelMonitor_Register service operation..... | 80 | +| 4.7.2.2.1 | General..... | 80 | +| 4.7.2.2.2 | Registering the monitoring of the analytics accuracy of an ML Model..... | 80 | +| 4.7.2.3 | Nnwdaf_MLModelMonitor_Deregister service operation..... | 81 | +| 4.7.2.3.1 | General..... | 81 | +| 4.7.2.3.2 | Deregistering the monitoring of the analytics accuracy of an ML Model..... | 82 | +| 4.7.2.4 | Nnwdaf_MLModelMonitor_Subscribe service operation..... | 82 | +| 4.7.2.4.1 | General..... | 82 | +| 4.7.2.4.2 | Subscription for monitoring notifications..... | 82 | +| 4.7.2.4.3 | Update of subscription for monitoring notifications..... | 83 | +| 4.7.2.5 | Nnwdaf_MLModelMonitor_Unsubscribe service operation..... | 84 | +| 4.7.2.5.1 | General..... | 84 | + +| | | | +|-----------|----------------------------------------------------------|----| +| 4.7.2.5.2 | Unsubscribe from monitoring notifications..... | 84 | +| 4.7.2.6 | Nnwdaf_MLModelMonitor_Notify service operation..... | 85 | +| 4.7.2.6.1 | General..... | 85 | +| 4.7.2.6.2 | Notification about subscribed event..... | 85 | +| 4.8 | Nnwdaf_RoamingData Service..... | 86 | +| 4.8.1 | Service Description..... | 86 | +| 4.8.1.1 | Overview..... | 86 | +| 4.8.1.2 | Service Architecture..... | 86 | +| 4.8.1.3 | Network Functions..... | 87 | +| 4.8.1.3.1 | Network Data Analytics Function (NWDAF)..... | 87 | +| 4.8.1.3.2 | NF Service Consumers..... | 87 | +| 4.8.2 | Service Operations..... | 87 | +| 4.8.2.1 | Introduction..... | 87 | +| 4.8.2.2 | Nnwdaf_RoamingData_Subscribe service operation..... | 88 | +| 4.8.2.2.1 | General..... | 88 | +| 4.8.2.2.2 | Subscription for event notifications..... | 88 | +| 4.8.2.2.3 | Update of subscription for event notifications..... | 89 | +| 4.8.2.3 | Nnwdaf_RoamingData_Unsubscribe service operation..... | 89 | +| 4.8.2.3.1 | General..... | 89 | +| 4.8.2.3.2 | Unsubscribe from event notifications..... | 90 | +| 4.8.2.4 | Nnwdaf_RoamingData_Notify service operation..... | 90 | +| 4.8.2.4.1 | General..... | 90 | +| 4.8.2.4.2 | Notification about subscribed event..... | 90 | +| 4.9.1.2 | Service Architecture..... | 91 | +| 4.9.1.3 | Network Functions..... | 92 | +| 4.9.1.3.1 | Network Data Analytics Function (NWDAF)..... | 92 | +| 4.9.1.3.2 | NF Service Consumers..... | 92 | +| 4.9.2 | Service Operations..... | 93 | +| 4.9.2.1 | Introduction..... | 93 | +| 4.9.2.2 | Nnwdaf_RoamingAnalytics_Subscribe service operation..... | 93 | +| 4.9.2.2.1 | General..... | 93 | +| 4.9.2.2.2 | Subscription for event notifications..... | 93 | +| 4.9.2.4 | Nnwdaf_RoamingAnalytics_Notify service operation..... | 96 | +| 4.9.2.4.1 | General..... | 96 | +| 4.9.2.4.2 | Notification about subscribed event..... | 97 | + +| | | | +|-------------|-------------------------------------------------------------|-----| +| 5 | API Definitions..... | 98 | +| 5.1 | Nnwdaf_EventsSubscription Service API..... | 98 | +| 5.1.1 | Introduction..... | 98 | +| 5.1.2 | Usage of HTTP..... | 98 | +| 5.1.2.1 | General..... | 98 | +| 5.1.2.2 | HTTP standard headers..... | 98 | +| 5.1.2.2.1 | General..... | 98 | +| 5.1.2.2.2 | Content type..... | 98 | +| 5.1.2.3 | HTTP custom headers..... | 98 | +| 5.1.3 | Resources..... | 99 | +| 5.1.3.1 | Resource Structure..... | 99 | +| 5.1.3.2 | Resource: NWDAF Events Subscriptions..... | 99 | +| 5.1.3.2.1 | Description..... | 99 | +| 5.1.3.2.2 | Resource definition..... | 100 | +| 5.1.3.2.3 | Resource Standard Methods..... | 100 | +| 5.1.3.2.3.1 | POST..... | 100 | +| 5.1.3.2.4 | Resource Custom Operations..... | 101 | +| 5.1.3.3 | Resource: Individual NWDAF Event Subscription..... | 101 | +| 5.1.3.3.1 | Description..... | 101 | +| 5.1.3.3.2 | Resource definition..... | 101 | +| 5.1.3.3.3 | Resource Standard Methods..... | 101 | +| 5.1.3.3.3.1 | DELETE..... | 101 | +| 5.1.3.3.3.2 | PUT..... | 102 | +| 5.1.3.3.4 | Resource Custom Operations..... | 104 | +| 5.1.3.4 | Resource: NWDAF Event Subscription Transfers..... | 104 | +| 5.1.3.4.1 | Description..... | 104 | +| 5.1.3.4.2 | Resource definition..... | 104 | +| 5.1.3.4.3 | Resource Standard Methods..... | 104 | +| 5.1.3.4.3.1 | POST..... | 104 | +| 5.1.3.4.4 | Resource Custom Operations..... | 105 | +| 5.1.3.5 | Resource: Individual NWDAF Event Subscription Transfer..... | 105 | +| 5.1.3.5.1 | Description..... | 105 | +| 5.1.3.5.2 | Resource definition..... | 105 | +| 5.1.3.5.3 | Resource Standard Methods..... | 105 | +| 5.1.3.5.3.1 | DELETE..... | 105 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 5.1.3.5.3.2 | PUT..... | 107 | +| 5.1.3.5.4 | Resource Custom Operations..... | 108 | +| 5.1.4 | Custom Operations without associated resources..... | 108 | +| 5.1.5 | Notifications..... | 108 | +| 5.1.5.1 | General..... | 108 | +| 5.1.5.2 | Event Notification..... | 108 | +| 5.1.5.2.1 | Description..... | 108 | +| 5.1.5.2.2 | Operation Definition..... | 108 | +| 5.1.6 | Data Model..... | 109 | +| 5.1.6.1 | General..... | 109 | +| 5.1.6.2 | Structured data types..... | 119 | +| 5.1.6.2.1 | Introduction..... | 119 | +| 5.1.6.2.2 | Type NnwdafEventsSubscription..... | 120 | +| 5.1.6.2.3 | Type EventSubscription..... | 122 | +| 5.1.6.2.4 | Type NnwdafEventsSubscriptionNotification..... | 129 | +| 5.1.6.2.5 | Type EventNotification..... | 130 | +| 5.1.6.2.6 | Type SliceLoadLevelInformation..... | 133 | +| 5.1.6.2.7 | Type EventReportingRequirement..... | 134 | +| 5.1.6.2.8 | Type TargetUeInformation..... | 136 | +| 5.1.6.2.9 | Void..... | 137 | +| 5.1.6.2.10 | Type UeMobility..... | 137 | +| 5.1.6.2.11 | Type LocationInfo..... | 138 | +| 5.1.6.2.12 | Void..... | 139 | +| 5.1.6.2.13 | Type UeCommunication..... | 139 | +| 5.1.6.2.14 | Type TrafficCharacterization..... | 141 | +| 5.1.6.2.15 | Type AbnormalBehaviour..... | 142 | +| 5.1.6.2.16 | Type Exception..... | 142 | +| 5.1.6.2.17 | Type UserDataCongestionInfo..... | 143 | +| 5.1.6.2.18 | Type CongestionInfo..... | 143 | +| 5.1.6.2.19 | Type QosSustainabilityInfo..... | 144 | +| 5.1.6.2.20 | Type QosRequirement..... | 145 | +| 5.1.6.2.21 | Type RetainabilityThreshold..... | 145 | +| 5.1.6.2.22 | Type NetworkPerfRequirement..... | 146 | +| 5.1.6.2.23 | Type NetworkPerfInfo..... | 147 | +| 5.1.6.2.24 | Type ServiceExperienceInfo..... | 148 | + +| | | | +|------------|------------------------------------------|-----| +| 5.1.6.2.25 | Type BwRequirement..... | 150 | +| 5.1.6.2.26 | Type AdditionalMeasurement..... | 151 | +| 5.1.6.2.27 | Type IpEthFlowDescription..... | 151 | +| 5.1.6.2.28 | Type AddressList..... | 152 | +| 5.1.6.2.29 | Type CircumstanceDescription..... | 152 | +| 5.1.6.2.30 | Type ThresholdLevel..... | 153 | +| 5.1.6.2.31 | Type NfLoadLevelInformation..... | 155 | +| 5.1.6.2.32 | Type NfStatus..... | 155 | +| 5.1.6.2.33 | Type NsiIdInfo..... | 156 | +| 5.1.6.2.34 | Type NsiLoadLevelInfo..... | 157 | +| 5.1.6.2.35 | Type FailureEventInfo..... | 158 | +| 5.1.6.2.36 | Type AnalyticsMetadataIndication..... | 158 | +| 5.1.6.2.37 | Type AnalyticsMetadataInfo..... | 159 | +| 5.1.6.2.38 | Type NumberAverage..... | 159 | +| 5.1.6.2.39 | Type TopApplication..... | 159 | +| 5.1.6.2.40 | Type AnalyticsSubscriptionsTransfer..... | 159 | +| 5.1.6.2.41 | Type SubscriptionTransferInfo..... | 160 | +| 5.1.6.2.42 | Type ModelInfo..... | 160 | +| 5.1.6.2.43 | Type AnalyticsContextIdentifier..... | 160 | +| 5.1.6.2.44 | Type UeAnalyticsContextDescriptor..... | 161 | +| 5.1.6.2.45 | Type DnPerfInfo..... | 161 | +| 5.1.6.2.46 | Type DnPerf..... | 162 | +| 5.1.6.2.47 | Type PerfData..... | 163 | +| 5.1.6.2.48 | Type ResourceUsage..... | 164 | +| 5.1.6.2.49 | Type ConsumerNfInformation..... | 164 | +| 5.1.6.2.50 | Type DispersionRequirement..... | 164 | +| 5.1.6.2.51 | Type ClassCriterion..... | 165 | +| 5.1.6.2.52 | Type RankingCriterion..... | 165 | +| 5.1.6.2.53 | Type DispersionInfo..... | 165 | +| 5.1.6.2.54 | Type DispersionCollection..... | 166 | +| 5.1.6.2.55 | Type ApplicationVolume..... | 167 | +| 5.1.6.2.56 | Type RedundantTransmissionExpReq..... | 167 | +| 5.1.6.2.57 | Type RedundantTransmissionExpInfo..... | 168 | +| 5.1.6.2.58 | Type RedundantTransmissionExpPerTS..... | 168 | +| 5.1.6.2.59 | Type WlanPerformanceReq..... | 169 | + +| | | | +|------------|--------------------------------------|-----| +| 5.1.6.2.60 | Type WlanPerformanceInfo..... | 169 | +| 5.1.6.2.61 | Type WlanPerSsIdPerformanceInfo..... | 169 | +| 5.1.6.2.62 | Type WlanPerTsPerformanceInfo..... | 170 | +| 5.1.6.2.63 | Type TrafficInformation..... | 170 | +| 5.1.6.2.64 | Type AppListForUeComm..... | 171 | +| 5.1.6.2.65 | Type SessInactTimerForUeComm..... | 171 | +| 5.1.6.2.66 | Type DnPerformanceReq..... | 171 | +| 5.1.6.2.67 | Type: RatFreqInformation..... | 172 | +| 5.1.6.2.68 | Type PrevSubInfo..... | 172 | +| 5.1.6.2.69 | Type MLModelInfo..... | 173 | +| 5.1.6.2.70 | Type ObservedRedundantTransExp..... | 174 | +| 5.1.6.2.71 | Type UeMobilityReq..... | 176 | +| 5.1.6.2.72 | Type UeCommReq..... | 176 | +| 5.1.6.2.73 | Type PfdDeterminationInfo..... | 177 | +| 5.1.6.2.74 | Type PduSessionInfo..... | 177 | +| 5.1.6.2.75 | Type DirectionInfo..... | 178 | +| 5.1.6.2.76 | Type GeoDistributionInfo..... | 178 | +| 5.1.6.2.77 | Type PduSesTrafficInfo..... | 179 | +| 5.1.6.2.78 | Type TdTraffic..... | 179 | +| 5.1.6.2.79 | Type PduSesTrafficReq..... | 180 | +| 5.1.6.2.80 | Type WlanPerUeIdPerformanceInfo..... | 180 | +| 5.1.6.2.81 | Type ResourceUsageRequirement..... | 180 | +| 5.1.6.2.82 | Type E2eDataVolTransTimeReq..... | 181 | +| 5.1.6.2.83 | Type E2eDataVolTransTimeInfo..... | 182 | +| 5.1.6.2.84 | Type E2eDataVolTransTimePerTS..... | 182 | +| 5.1.6.2.85 | Type DataVolume..... | 182 | +| 5.1.6.2.86 | Type E2eDataVolTransTimePerUe..... | 183 | +| 5.1.6.2.87 | Type E2eDataVolTransTimeUeList..... | 184 | +| 5.1.6.2.88 | Type AccuracyReq..... | 185 | +| 5.1.6.2.89 | Type AccuracyInfo..... | 185 | +| 5.1.6.2.90 | Type DataVolumeTransferTime..... | 186 | +| 5.1.6.2.91 | Type MovBehavReq..... | 186 | +| 5.1.6.2.92 | Type MovBehavInfo..... | 186 | +| 5.1.6.2.93 | Type MovBehav..... | 187 | +| 5.1.6.2.94 | Type SpeedThresholdInfo..... | 187 | + +| | | | +|-------------|------------------------------------------------|-----| +| 5.1.6.2.95 | Type GeoLocation..... | 188 | +| 5.1.6.2.96 | Type LocAccuracyReq..... | 189 | +| 5.1.6.2.97 | Type LocAccuracyInfo..... | 190 | +| 5.1.6.2.98 | Type LocAccuracyPerMethod..... | 190 | +| 5.1.6.2.99 | Type RelProxReq..... | 191 | +| 5.1.6.2.100 | Type RelProxInfo..... | 191 | +| 5.1.6.2.101 | Type UeProximity..... | 192 | +| 5.1.6.2.102 | Type UeTrajectory..... | 192 | +| 5.1.6.2.103 | Type TimestampedLocation..... | 192 | +| 5.1.6.2.104 | Type TimeToCollisionInfo..... | 193 | +| 5.1.6.2.105 | Type AnalyticsFeedbackInfo..... | 193 | +| 5.1.6.2.106 | Type RoamingInfo..... | 194 | +| 5.1.6.3 | Simple data types and enumerations..... | 194 | +| 5.1.6.3.1 | Introduction..... | 194 | +| 5.1.6.3.2 | Simple data types..... | 194 | +| 5.1.6.3.3 | Enumeration: NotificationMethod..... | 195 | +| 5.1.6.3.4 | Enumeration: Nwdafevent..... | 196 | +| 5.1.6.3.5 | Enumeration: Accuracy..... | 196 | +| 5.1.6.3.6 | Enumeration: ExceptionId..... | 197 | +| 5.1.6.3.7 | Enumeration: ExceptionTrend..... | 197 | +| 5.1.6.3.8 | Enumeration: CongestionType..... | 197 | +| 5.1.6.3.9 | Enumeration: TimeUnit..... | 197 | +| 5.1.6.3.10 | Enumeration: NetworkPerfType..... | 198 | +| 5.1.6.3.11 | Enumeration: ExpectedAnalyticsType..... | 198 | +| 5.1.6.3.12 | Enumeration: MatchingDirection..... | 198 | +| 5.1.6.3.13 | Enumeration: NwdafeventFailureCode..... | 199 | +| 5.1.6.3.14 | Enumeration: AnalyticsMetadata..... | 199 | +| 5.1.6.3.15 | Enumeration: DatasetStatisticalProperty..... | 199 | +| 5.1.6.3.16 | Enumeration: OutputStrategy..... | 199 | +| 5.1.6.3.17 | Enumeration: TransferRequestType..... | 200 | +| 5.1.6.3.18 | Enumeration: AnalyticsSubset..... | 201 | +| 5.1.6.3.19 | Enumeration: DispersionType..... | 203 | +| 5.1.6.3.20 | Enumeration: DispersionClass..... | 203 | +| 5.1.6.3.21 | Enumeration: DispersionOrderingCriterion..... | 204 | +| 5.1.6.3.22 | Enumeration: RedTransExpOrderingCriterion..... | 204 | + +| | | | +|------------|------------------------------------------------|-----| +| 5.1.6.3.23 | Enumeration: WlanOrderingCriterion..... | 204 | +| 5.1.6.3.24 | Enumeration: ServiceExperienceType..... | 204 | +| 5.1.6.3.25 | Enumeration: DnPerfOrderingCriterion..... | 204 | +| 5.1.6.3.26 | Enumeration: TermCause..... | 205 | +| 5.1.6.3.27 | Enumeration: UserDataConOrderCrit..... | 205 | +| 5.1.6.3.28 | Enumeration: UeMobilityOrderCriterion..... | 205 | +| 5.1.6.3.29 | Enumeration: UeCommOrderCriterion..... | 205 | +| 5.1.6.3.30 | Enumeration: NetworkPerfOrderCriterion..... | 205 | +| 5.1.6.3.31 | Enumeration: DeviceType..... | 206 | +| 5.1.6.3.32 | Enumeration: LocInfoGranularity..... | 206 | +| 5.1.6.3.33 | Enumeration: TrafficDirection..... | 206 | +| 5.1.6.3.34 | Enumeration: ValueExpression..... | 206 | +| 5.1.6.3.35 | Enumeration: E2eDataVolTransTimeCriterion..... | 206 | +| 5.1.6.3.36 | Void..... | 207 | +| 5.1.6.3.37 | Enumeration: AnalyticsAccuracyIndication..... | 207 | +| 5.1.6.3.38 | Enumeration: LocationOrientation..... | 207 | +| 5.1.6.3.39 | Enumeration: Direction..... | 207 | +| 5.1.6.3.40 | Enumeration: ProximityCriterion..... | 207 | +| 5.1.7 | Error handling..... | 207 | +| 5.1.7.1 | General..... | 207 | +| 5.1.7.2 | Protocol Errors..... | 208 | +| 5.1.7.3 | Application Errors..... | 208 | +| 5.1.8 | Feature negotiation..... | 208 | +| 5.1.9 | Security..... | 211 | +| 5.2 | Nnwdaf_AnalyticsInfo Service API..... | 212 | +| 5.2.1 | Introduction..... | 212 | +| 5.2.2 | Usage of HTTP..... | 212 | +| 5.2.2.1 | General..... | 212 | +| 5.2.2.2 | HTTP standard headers..... | 212 | +| 5.2.2.2.1 | General..... | 212 | +| 5.2.2.2.2 | Content type..... | 212 | +| 5.2.2.3 | HTTP custom headers..... | 213 | +| 5.2.3 | Resources..... | 213 | +| 5.2.3.1 | Resource Structure..... | 213 | +| 5.2.3.2 | Resource: NWDAF Analytics..... | 213 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 5.2.3.2.1 | Description..... | 213 | +| 5.2.3.2.2 | Resource definition..... | 213 | +| 5.2.3.2.3 | Resource Standard Methods..... | 214 | +| 5.2.3.2.3.1 | GET..... | 214 | +| 5.2.3.2.4 | Resource Custom Operations..... | 214 | +| 5.2.3.3 | Resource: NWDAF Context..... | 215 | +| 5.2.3.3.1 | Description..... | 215 | +| 5.2.3.3.2 | Resource definition..... | 215 | +| 5.2.3.3.3 | Resource Standard Methods..... | 215 | +| 5.2.3.3.3.1 | GET..... | 215 | +| 5.2.4 | Custom Operations without associated resources..... | 215 | +| 5.2.5 | Notifications..... | 216 | +| 5.2.6 | Data Model..... | 216 | +| 5.2.6.1 | General..... | 216 | +| 5.2.6.2 | Structured data types..... | 222 | +| 5.2.6.2.1 | Introduction..... | 222 | +| 5.2.6.2.2 | Type AnalyticsData..... | 223 | +| 5.2.6.2.3 | Type EventFilter..... | 226 | +| 5.2.6.2.4 | Void..... | 231 | +| 5.2.6.2.5 | Type AdditionInfoAnalyticsInfoRequest..... | 231 | +| 5.2.6.2.6 | Type ContextData..... | 232 | +| 5.2.6.2.7 | Type ContextElement..... | 232 | +| 5.2.6.2.8 | Type ContextIdList..... | 233 | +| 5.2.6.2.9 | Type HistoricalData..... | 233 | +| 5.2.6.2.10 | Type SpecificAnalyticsSubscription..... | 234 | +| 5.2.6.2.11 | Type RequestedContext..... | 234 | +| 5.2.6.2.12 | Type SmcceInfo..... | 234 | +| 5.2.6.2.13 | Type SmcceUeList..... | 235 | +| 5.2.6.2.14 | Type SpecificDataSubscription..... | 235 | +| 5.2.6.2.15 | Type UserDataCongestReq..... | 236 | +| 5.2.6.2.16 | Type NetworkPerfReq..... | 236 | +| 5.2.6.2.17 | Type ResourceUsageRequPerNwPerfType..... | 236 | +| 5.2.6.3 | Simple data types and enumerations..... | 236 | +| 5.2.6.3.1 | Introduction..... | 236 | +| 5.2.6.3.2 | Simple data types..... | 236 | + +| | | | +|-------------|---------------------------------------------------------------------------------|-----| +| 5.2.6.3.3 | Enumeration: EventId..... | 237 | +| 5.2.6.3.4 | Enumeration: ContextType..... | 238 | +| 5.2.6.3.5 | Enumeration: AdrfDataType..... | 238 | +| 5.2.6.4 | Data types describing alternative data types or combinations of data types..... | 238 | +| 5.2.6.4.1 | Type ProblemDetailsAnalyticsInfoRequest..... | 238 | +| 5.2.7 | Error handling..... | 238 | +| 5.2.7.1 | General..... | 238 | +| 5.2.7.2 | Protocol Errors..... | 238 | +| 5.2.7.3 | Application Errors..... | 239 | +| 5.2.8 | Feature negotiation..... | 239 | +| 5.2.9 | Security..... | 242 | +| 5.3 | Nnwdaf_DataManagement Service API..... | 242 | +| 5.3.1 | Introduction..... | 242 | +| 5.3.2 | Usage of HTTP..... | 243 | +| 5.3.2.1 | General..... | 243 | +| 5.3.2.2 | HTTP standard headers..... | 243 | +| 5.3.2.2.1 | General..... | 243 | +| 5.3.2.2.2 | Content type..... | 243 | +| 5.3.2.3 | HTTP custom headers..... | 243 | +| 5.3.3 | Resources..... | 243 | +| 5.3.3.1 | Resource Structure..... | 243 | +| 5.3.3.2 | Resource: NWDAF Data Management Subscriptions..... | 244 | +| 5.3.3.2.1 | Description..... | 244 | +| 5.3.3.2.2 | Resource Definition..... | 244 | +| 5.3.3.2.3 | Resource Standard Methods..... | 245 | +| 5.3.3.2.3.1 | POST..... | 245 | +| 5.3.3.2.4 | Resource Custom Operations..... | 245 | +| 5.3.3.3 | Resource: Individual NWDAF Data Management Subscription..... | 245 | +| 5.3.3.3.1 | Description..... | 245 | +| 5.3.3.3.2 | Resource definition..... | 245 | +| 5.3.3.3.3 | Resource Standard Methods..... | 246 | +| 5.3.3.3.3.1 | PUT..... | 246 | +| 5.3.3.3.3.2 | DELETE..... | 247 | +| 5.3.3.3.4 | Resource Custom Operations..... | 248 | +| 5.3.4 | Custom Operations without associated resources..... | 248 | + +| | | | +|-------------|--------------------------------------------|-----| +| 5.3.5 | Notifications..... | 249 | +| 5.3.5.1 | General..... | 249 | +| 5.3.5.2 | Event Notification..... | 249 | +| 5.3.5.2.1 | Description..... | 249 | +| 5.3.5.2.2 | Operation Definition..... | 249 | +| 5.3.5.3 | Fetch Notification..... | 250 | +| 5.3.5.3.1 | Description..... | 250 | +| 5.3.5.3.2 | Target URI..... | 250 | +| 5.3.5.3.3 | Standard Methods..... | 250 | +| 5.3.5.3.3.1 | POST..... | 250 | +| 5.3.6 | Data Model..... | 251 | +| 5.3.6.1 | General..... | 251 | +| 5.3.6.2 | Structured data types..... | 253 | +| 5.3.6.2.1 | Introduction..... | 253 | +| 5.3.6.2.2 | Type NnwdafDataManagementSubsc..... | 254 | +| 5.3.6.2.3 | Type NnwdafDataManagementNotif..... | 257 | +| 5.3.6.3 | Simple data types and enumerations..... | 257 | +| 5.3.6.3.1 | Introduction..... | 257 | +| 5.3.6.3.2 | Simple data types..... | 258 | +| 5.3.6.3.3 | Enumeration: PendingNotificationCause..... | 258 | +| 5.3.7 | Error handling..... | 258 | +| 5.3.7.1 | General..... | 258 | +| 5.3.7.2 | Protocol Errors..... | 258 | +| 5.3.7.3 | Application Errors..... | 258 | +| 5.3.8 | Feature negotiation..... | 259 | +| 5.3.9 | Security..... | 259 | +| 5.4 | Nnwdaf_MLModelProvision Service API..... | 259 | +| 5.4.1 | Introduction..... | 259 | +| 5.4.2 | Usage of HTTP..... | 260 | +| 5.4.2.1 | General..... | 260 | +| 5.4.2.2 | HTTP standard headers..... | 260 | +| 5.4.2.2.1 | General..... | 260 | +| 5.4.2.2.2 | Content type..... | 260 | +| 5.4.2.3 | HTTP custom headers..... | 260 | +| 5.4.3 | Resources..... | 260 | + +| | | | +|-------------|-----------------------------------------------------------------|-----| +| 5.4.3.1 | Resource Structure..... | 260 | +| 5.4.3.2 | Resource: NWDAF ML Model Provision Subscriptions..... | 261 | +| 5.4.3.2.1 | Description..... | 261 | +| 5.4.3.2.2 | Resource definition..... | 261 | +| 5.4.3.2.3 | Resource Standard Methods..... | 261 | +| 5.4.3.2.3.1 | POST..... | 261 | +| 5.4.3.2.4 | Resource Custom Operations..... | 262 | +| 5.4.3.3 | Resource: Individual NWDAF ML Model Provision Subscription..... | 262 | +| 5.4.3.3.1 | Description..... | 262 | +| 5.4.3.3.2 | Resource definition..... | 262 | +| 5.4.3.3.3 | Resource Standard Methods..... | 262 | +| 5.4.3.3.3.1 | PUT..... | 262 | +| 5.4.3.3.3.2 | DELETE..... | 264 | +| 5.4.3.3.4 | Resource Custom Operations..... | 265 | +| 5.4.4 | Custom Operations without associated resources..... | 265 | +| 5.4.5 | Notifications..... | 265 | +| 5.4.5.1 | General..... | 265 | +| 5.4.5.2 | Event Notification..... | 265 | +| 5.4.5.2.1 | Description..... | 265 | +| 5.4.5.2.2 | Operation Definition..... | 266 | +| 5.4.6 | Data Model..... | 267 | +| 5.4.6.1 | General..... | 267 | +| 5.4.6.2 | Structured data types..... | 268 | +| 5.4.6.2.1 | Introduction..... | 268 | +| 5.4.6.2.2 | Type NwdafMLModelProvSubsc..... | 269 | +| 5.4.6.2.3 | Type MLEventSubscription..... | 270 | +| 5.4.6.2.4 | Void..... | 271 | +| 5.4.6.2.5 | Type NwdafMLModelProvNotif..... | 271 | +| 5.4.6.2.6 | Type MLEventNotif..... | 271 | +| 5.4.6.2.7 | Type FailureEventInfoForMLModel..... | 272 | +| 5.4.6.2.8 | Type MLModelAddr..... | 272 | +| 5.4.6.2.9 | Void..... | 272 | +| 5.4.6.2.10 | Void..... | 272 | +| 5.4.6.2.11 | Type MLRepEventCondition..... | 272 | +| 5.4.6.2.12 | Type InputDataInfo..... | 273 | + +| | | | +|-------------|----------------------------------------------------------------|-----| +| 5.4.6.2.13 | Type ModelProvisionParamsExt..... | 274 | +| 5.4.6.2.14 | Type AdditionalMLModelInformation..... | 275 | +| 5.4.6.2.15 | Type MLModelAdrf..... | 275 | +| 5.4.6.2.16 | Type TrainInputDataInfo..... | 276 | +| 5.4.6.2.17 | Type InferenceDataForModelTrain..... | 276 | +| 5.4.6.3 | Simple data types and enumerations..... | 276 | +| 5.4.6.3.1 | Introduction..... | 276 | +| 5.4.6.3.2 | Simple data types..... | 276 | +| 5.4.6.3.3 | Enumeration: FailureCode..... | 277 | +| 5.4.6.3.4 | Enumeration: MLModelMetric..... | 277 | +| 5.4.7 | Error handling..... | 277 | +| 5.4.7.1 | General..... | 277 | +| 5.4.7.2 | Protocol Errors..... | 277 | +| 5.4.7.3 | Application Errors..... | 277 | +| 5.4.8 | Feature negotiation..... | 278 | +| 5.4.9 | Security..... | 278 | +| 5.5 | Nnwdaf_MLModelTraining Service API..... | 278 | +| 5.5.1 | Introduction..... | 278 | +| 5.5.2 | Usage of HTTP..... | 279 | +| 5.5.2.1 | General..... | 279 | +| 5.5.2.2 | HTTP standard headers..... | 279 | +| 5.5.2.2.1 | General..... | 279 | +| 5.5.2.2.2 | Content type..... | 279 | +| 5.5.2.3 | HTTP custom headers..... | 279 | +| 5.5.3 | Resources..... | 279 | +| 5.5.3.1 | Resource Structure..... | 279 | +| 5.5.3.2 | Resource: NWDAF ML Model Training Subscriptions..... | 280 | +| 5.5.3.2.1 | Description..... | 280 | +| 5.5.3.2.2 | Resource definition..... | 280 | +| 5.5.3.2.3 | Resource Standard Methods..... | 280 | +| 5.5.3.2.3.1 | POST..... | 280 | +| 5.5.3.2.4 | Resource Custom Operations..... | 281 | +| 5.5.3.3 | Resource: Individual NWDAF ML Model Training Subscription..... | 281 | +| 5.5.3.3.1 | Description..... | 281 | +| 5.5.3.3.2 | Resource definition..... | 281 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 5.5.3.3.3 | Resource Standard Methods..... | 281 | +| 5.5.3.3.3.1 | PUT..... | 281 | +| 5.5.3.3.3.2 | PATCH..... | 282 | +| 5.5.3.3.3.3 | DELETE..... | 283 | +| 5.5.3.3.4 | Resource Custom Operations..... | 284 | +| 5.5.4 | Custom Operations without associated resources..... | 284 | +| 5.5.5 | Notifications..... | 285 | +| 5.5.5.1 | General..... | 285 | +| 5.5.5.2 | Event Notification..... | 285 | +| 5.5.5.2.1 | Description..... | 285 | +| 5.5.5.2.2 | Operation Definition..... | 285 | +| 5.5.6 | Data Model..... | 286 | +| 5.5.6.1 | General..... | 286 | +| 5.5.6.2 | Structured data types..... | 288 | +| 5.5.6.2.1 | Introduction..... | 288 | +| 5.5.6.2.2 | Type NwdafMLModelTrainSubsc..... | 289 | +| 5.5.6.2.3 | Type NwdafMLModelTrainSubscPatch..... | 291 | +| 5.5.6.2.5 | Type MLModelTrainInfo..... | 292 | +| 5.5.6.2.6 | Type MLTrainReportInfo..... | 292 | +| 5.5.6.2.7 | Type FailureEventInfoForMLModelTrain..... | 292 | +| 5.5.6.2.8 | Type NwdafMLModelTrainNotif..... | 293 | +| 5.5.6.2.9 | Void..... | 294 | +| 5.5.6.2.10 | Type DataAvReq..... | 294 | +| 5.5.6.2.11 | Type DelayEventNotif..... | 294 | +| 5.5.6.2.12 | Type StatusReportInfo..... | 294 | +| 5.5.6.2.13 | Type TrainDataInfo..... | 295 | +| 5.5.6.3 | Simple data types and enumerations..... | 295 | +| 5.5.6.3.1 | Introduction..... | 295 | +| 5.5.6.3.2 | Simple data types..... | 295 | +| 5.5.6.3.3 | Enumeration: FailureCodeTrain..... | 295 | +| 5.5.6.3.4 | Enumeration: TermTrainCause..... | 296 | +| 5.5.6.3.5 | Enumeration: DelayCause..... | 296 | +| 5.5.7 | Error handling..... | 296 | +| 5.5.7.1 | General..... | 296 | +| 5.5.7.2 | Protocol Errors..... | 296 | + +| | | | +|-------------|------------------------------------------------------------------|-----| +| 5.5.7.3 | Application Errors..... | 296 | +| 5.5.8 | Feature negotiation..... | 297 | +| 5.5.9 | Security..... | 297 | +| 5.6 | Nnwdaf_MLModelMonitor Service API..... | 297 | +| 5.6.1 | Introduction..... | 297 | +| 5.6.2 | Usage of HTTP..... | 298 | +| 5.6.2.1 | General..... | 298 | +| 5.6.2.2 | HTTP standard headers..... | 298 | +| 5.6.2.2.1 | General..... | 298 | +| 5.6.2.2.2 | Content type..... | 298 | +| 5.6.2.3 | HTTP custom headers..... | 298 | +| 5.6.3 | Resources..... | 298 | +| 5.6.3.1 | Resource Structure..... | 298 | +| 5.6.3.2 | Resource: NWDAF ML model monitoring registrations..... | 299 | +| 5.6.3.2.1 | Description..... | 299 | +| 5.6.3.2.2 | Resource Definition..... | 299 | +| 5.6.3.2.3 | Resource Standard Methods..... | 300 | +| 5.6.3.2.3.1 | POST..... | 300 | +| 5.6.3.2.4 | Resource Custom Operations..... | 300 | +| 5.6.3.3 | Resource: Individual NWDAF ML model monitoring registration..... | 300 | +| 5.6.3.3.1 | Description..... | 300 | +| 5.6.3.3.2 | Resource definition..... | 301 | +| 5.6.3.3.3 | Resource Standard Methods..... | 301 | +| 5.6.3.3.3.1 | DELETE..... | 301 | +| 5.6.3.3.4 | Resource Custom Operations..... | 302 | +| 5.6.3.4 | Resource: NWDAF ML model monitoring Subscriptions..... | 302 | +| 5.6.3.4.1 | Description..... | 302 | +| 5.6.3.4.2 | Resource Definition..... | 302 | +| 5.6.3.4.3 | Resource Standard Methods..... | 302 | +| 5.6.3.4.3.1 | POST..... | 302 | +| 5.6.3.4.4 | Resource Custom Operations..... | 303 | +| 5.6.3.5 | Resource: Individual NWDAF ML model monitoring Subscription..... | 303 | +| 5.6.3.5.1 | Description..... | 303 | +| 5.6.3.5.2 | Resource definition..... | 303 | +| 5.6.3.5.3 | Resource Standard Methods..... | 304 | + +| | | | +|-------------|-----------------------------------------------------|-----| +| 5.6.3.5.3.1 | PUT..... | 304 | +| 5.6.3.5.3.2 | DELETE..... | 305 | +| 5.6.3.5.4 | Resource Custom Operations..... | 306 | +| 5.6.4 | Custom Operations without associated resources..... | 306 | +| 5.6.5 | Notifications..... | 306 | +| 5.6.5.1 | General..... | 306 | +| 5.6.5.2 | Event Notification..... | 306 | +| 5.6.5.2.1 | Description..... | 306 | +| 5.6.5.2.2 | Operation Definition..... | 306 | +| 5.6.6 | Data Model..... | 308 | +| 5.6.6.1 | General..... | 308 | +| 5.6.6.2 | Structured data types..... | 308 | +| 5.6.6.2.1 | Introduction..... | 308 | +| 5.6.6.2.2 | Type MLModelMonitorReg..... | 309 | +| 5.6.6.2.3 | Type MLModelMonitorSub..... | 310 | +| 5.6.6.2.4 | Type MLModelMonitorNotify..... | 311 | +| 5.6.6.2.5 | Type MLModelAccuracyInfo..... | 311 | +| 5.6.6.2.6 | Type AnalyticsFeedback..... | 312 | +| 5.6.7 | Error handling..... | 312 | +| 5.6.7.1 | General..... | 312 | +| 5.6.7.2 | Protocol Errors..... | 312 | +| 5.6.7.3 | Application Errors..... | 312 | +| 5.6.8 | Feature negotiation..... | 312 | +| 5.6.9 | Security..... | 313 | +| 5.7 | Nnwdaf_RoamingData Service API..... | 313 | +| 5.7.1 | Introduction..... | 313 | +| 5.7.2 | Usage of HTTP..... | 313 | +| 5.7.2.1 | General..... | 313 | +| 5.7.2.2 | HTTP standard headers..... | 313 | +| 5.7.2.2.1 | General..... | 313 | +| 5.7.2.2.2 | Content type..... | 313 | +| 5.7.2.3 | HTTP custom headers..... | 314 | +| 5.7.3 | Resources..... | 314 | +| 5.7.3.1 | Resource Structure..... | 314 | +| 5.7.3.2 | Resource: NWDAF Roaming Data Subscriptions..... | 314 | + +| | | | +|-------------|-----------------------------------------------------------|-----| +| 5.7.3.2.1 | Description..... | 314 | +| 5.7.3.2.2 | Resource Definition..... | 315 | +| 5.7.3.2.3 | Resource Standard Methods..... | 315 | +| 5.7.3.2.3.1 | POST..... | 315 | +| 5.7.3.2.4 | Resource Custom Operations..... | 315 | +| 5.7.3.3 | Resource: Individual NWDAF Roaming Data Subscription..... | 316 | +| 5.7.3.3.1 | Description..... | 316 | +| 5.7.3.3.2 | Resource definition..... | 316 | +| 5.7.3.3.3 | Resource Standard Methods..... | 316 | +| 5.7.3.3.3.1 | PUT..... | 316 | +| 5.7.3.3.3.2 | DELETE..... | 317 | +| 5.7.3.3.4 | Resource Custom Operations..... | 318 | +| 5.7.4 | Custom Operations without associated resources..... | 318 | +| 5.7.5 | Notifications..... | 319 | +| 5.7.5.1 | General..... | 319 | +| 5.7.5.2 | Event Notification..... | 319 | +| 5.7.5.2.1 | Description..... | 319 | +| 5.7.5.2.2 | Operation Definition..... | 319 | +| 5.7.6 | Data Model..... | 320 | +| 5.7.6.1 | General..... | 320 | +| 5.7.6.2 | Structured data types..... | 321 | +| 5.7.6.2.1 | Introduction..... | 321 | +| 5.7.6.2.2 | Type RoamingDataSub..... | 322 | +| 5.7.7 | Error handling..... | 323 | +| 5.7.7.1 | General..... | 323 | +| 5.7.7.2 | Protocol Errors..... | 323 | +| 5.7.7.3 | Application Errors..... | 323 | +| 5.7.8 | Feature negotiation..... | 323 | +| 5.7.9 | Security..... | 323 | +| 5.8 | Nnwdaf_RoamingAnalytics Service API..... | 324 | +| 5.8.1 | Introduction..... | 324 | +| 5.8.2 | Usage of HTTP..... | 324 | +| 5.8.2.1 | General..... | 324 | +| 5.8.2.2 | HTTP standard headers..... | 324 | +| 5.8.2.2.1 | General..... | 324 | + +| | | | +|-----------|----------------------------------------------------------------|-----| +| 5.8.2.2.2 | Content type..... | 324 | +| 5.8.2.3 | HTTP custom headers..... | 324 | +| 5.8.3 | Resources..... | 325 | +| 5.8.3.1 | Resource Structure..... | 325 | +| 5.8.3.2 | Resource: NWDAF Roaming Analytics Subscriptions..... | 325 | +| 5.8.3.2.1 | Description..... | 325 | +| 5.8.3.2.2 | Resource Definition..... | 325 | +| 5.8.3.2.3 | Resource Standard Methods..... | 326 | +| 5.8.3.2.4 | Resource Custom Operations..... | 326 | +| 5.8.3.3 | Resource: Individual NWDAF Roaming Analytics Subscription..... | 327 | +| 5.8.3.3.1 | Description..... | 327 | +| 5.8.3.3.2 | Resource definition..... | 327 | +| 5.8.3.3.3 | Resource Standard Methods..... | 327 | +| 5.8.3.3.4 | Resource Custom Operations..... | 330 | +| 5.8.4 | Custom Operations without associated resources..... | 330 | +| 5.8.5 | Notifications..... | 330 | +| 5.8.5.1 | General..... | 330 | +| 5.8.5.2 | Roaming Analytics Notification..... | 330 | +| 5.8.5.2.1 | Description..... | 330 | +| 5.8.5.2.2 | Operation Definition..... | 330 | +| 5.8.6 | Data Model..... | 331 | +| 5.8.6.1 | General..... | 331 | +| 5.8.6.2 | Structured data types..... | 332 | +| 5.8.6.2.1 | Introduction..... | 332 | +| 5.8.6.2.2 | Type RoamingAnalyticsSubscription..... | 333 | +| 5.8.6.2.3 | Type RoamingAnalyticsNotification..... | 334 | +| 5.8.7 | Error handling..... | 334 | +| 5.8.7.1 | General..... | 334 | +| 5.8.7.2 | Protocol Errors..... | 334 | +| 5.8.7.3 | Application Errors..... | 334 | +| 5.8.8 | Feature negotiation..... | 334 | +| 5.8.9 | Security..... | 335 | + +| | | +|--------------------------------------------------------|------------| +| Annex A (normative): OpenAPI specification..... | 336 | +| A.1 General..... | 336 | +| A.2 Nnwdaf_EventsSubscription API..... | 336 | +| A.3 Nnwdaf_AnalyticsInfo API..... | 388 | +| A.4 Nnwdaf_DataManagement API..... | 400 | +| A.5 Nnwdaf_MLModelProvision API..... | 405 | +| A.6 Nnwdaf_MLModelTraining API..... | 412 | +| A.7 Nnwdaf_MLModelMonitor API..... | 420 | +| A.8 Nnwdaf_RoamingData API..... | 426 | +| Annex B (informative): Change history..... | 434 | + +--- + +## 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 Network Data Analytics Function Services of the 5G System. + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The stage 2 definition and related procedures for Network Data Analytics Function Services are specified in 3GPP TS 23.288 [17] and 3GPP TS 23.503 [4]. + +The 5G System stage 3 call flows are provided in 3GPP TS 29.552 [25] and 3GPP TS 29.513 [5]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [6] and 3GPP TS 29.501 [7]. + +The Network Data Analytics Function Services are provided by the Network Data Analytics Function (NWDAF). + +# 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] Void. +- [4] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [5] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [6] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [7] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [8] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; 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.510: "5G System; Network Function Repository Services; Stage 3". +- [13] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [14] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [15] IETF RFC 9457: "Problem Details for HTTP APIs". +- [16] 3GPP TR 21.900: "Technical Specification Group working methods". +- [17] 3GPP TS 23.288: "Architecture enhancements for 5G System (5GS) to support network data analytics services". + +- [18] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". +- [19] 3GPP TS 29.122: "T8 reference point for Northbound APIs". +- [20] 3GPP TS 29.523: "5G System; Policy Control Event Exposure Service; Stage 3". +- [21] 3GPP TS 29.514: "5G System; Policy Authorization Service; Stage 3". +- [22] 3GPP TS 29.517: "5G System; Application Function (AF) event exposure service". +- [23] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [24] 3GPP TS 29.531: "5G System; Network Slice Selection Services; Stage 3". +- [25] 3GPP TS 29.552: "5G System; Network Data Analytics signalling flows; Stage 3". +- [26] 3GPP TS 29.574: "5G System; Data Collection Coordination Services; Stage 3". +- [27] 3GPP TS 29.575: "5G System; Analytics Data Repository Services; Stage 3". +- [28] 3GPP TS 29.576: "5G System; Messaging Framework Adaptor Services; Stage 3". +- [29] 3GPP TS 29.508: "5G System; Session Management Event Exposure Service; Stage 3". +- [30] 3GPP TS 29.572: "5G System; Location Management Services; Stage 3". +- [31] IANA: "SMI Network Management Private Enterprise Codes", . +- [32] 3GPP TS 29.522: "5G System; Network Exposure Function Northbound APIs; Stage 3". +- [33] IETF RFC 6733: "Diameter Base Protocol". + +--- + +## 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]. + +| | | +|-------|------------------------------------------| +| 5QI | 5G QoS Identifier | +| ADRF | Analytics Data Repository Function | +| AF | Application Function | +| AI/ML | Artificial Intelligence/Machine Learning | +| AMF | Access and Mobility Management Function | +| AOI | Area of Interest | +| API | Application Programming Interface | +| CEF | Charging Enablement Function | +| DCCF | Data Collection Coordination Function | +| DNN | Data Network Name | +| FL | Federated Learning | +| GFBR | Guaranteed Flow Bit Rate | +| GMLC | Gateway Mobile Location Centre | +| HTTP | Hypertext Transfer Protocol | + +| | | +|---------|-------------------------------------------------------| +| JSON | JavaScript Object Notation | +| LADN | Local Area Data Network | +| LMF | Location Management Function | +| MFAF | Messaging Framework Adaptor Function | +| ML | Machine Learning | +| MTLF | Model Training Logical Function | +| NEF | Network Exposure Function | +| NF | Network Function | +| NLOS | Non Line Of Sight | +| NRF | Network Repository Function | +| NSSF | Network Slice Selection Function | +| NWDAF | Network Data Analytics Function | +| OAM | Operation, Administration, and Maintenance | +| PCF | Policy Control Function | +| PFD | Packet Flow Description | +| PFDf | Packet Flow Description Function | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SMCC | Session Management Congestion Control | +| SMCCE | Session Management Congestion Control Experience | +| SMF | Session Management Function | +| SSC | Session and Service Continuity | +| SUPI | Subscription Permanent Identifier | +| UDM | Unified Data Management | +| UPF | User Plane Function | +| URI | Uniform Resource Identifier | +| URSP | UE Route Selection Policy | +| UTC | Universal Time Coordinated | + +## 4 Services offered by the NWDAF + +### 4.1 Introduction + +The Nnwdaf services are used by the NWDAF to provide specific analytics information and ML models. + +Analytics information is either statistical information of past events, or predictive information. + +The following services are specified for the NWDAF: + +**Table 4.1-1: Services provided by NWDAF** + +| Service Name | Description | Service Operations | Operation Semantics | Example Consumer(s) | +|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|---------------------|----------------------------------------------------------| +| Nnwdaf_EventsSubscription (NOTE 1) | This service enables the NF service consumers to subscribe to/unsubscribe from notifications for different analytics information from the NWDAF. It also enables the transfer of subscriptions between NWDAFs | Subscribe | Subscribe / Notify | PCF, NSSF, AMF, SMF, NEF, AF, LMF, OAM, CEF, NWDAF, DCCF | +| | | Unsubscribe | | | +| | | Notify | | | +| | | Transfer | Request / Response | NWDAF | +| Nnwdaf_AnalyticsInfo | This service enables the NF service consumers to request and get specific analytics or context information related to analytics | Request | Request / Response | PCF, NSSF, AMF, SMF, NEF, AF, LMF, OAM, NWDAF, DCCF | +| | | ContextTransfer | Request / Response | NWDAF | + +| | | | | | | +|----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|--------------------|------------------------|--| +| | subscriptions from the | | | | | +| Nnwdaf_DataManagement | This service enables the NF service consumers to subscribe to/unsubscribe from notifications when subscribed event(s) are detected or retrieve the subscribed data from the NWDAF. | Subscribe | Subscribe / Notify | NWDAF, DCCF, MFAF | | +| | | Unsubscribe | | | | +| | | Notify | | | | +| | | Fetch | Request / Response | NWDAF, DCCF, MFAF | | +| Nnwdaf_MLModelProvision (NOTE 2) | This service enables the NF service consumers to subscribe to/unsubscribe from notifications when a ML model matching the subscription parameters becomes available. | Subscribe | Subscribe / Notify | NWDAF | | +| | | Unsubscribe | | | | +| | | Notify | | | | +| Nnwdaf_MLModelTraining (NOTE 3) | This service enables the NF service consumers to subscribe to/unsubscribe/modify from notifications for a ML model training. | Subscribe | Subscribe / Notify | NWDAF | | +| | | Unsubscribe | | | | +| | | Notify | | | | +| Nnwdaf_MLModelMonitor | This service enables the NF service consumer to subscribe/unsubscribe for ML model accuracy, provide Analytics feedback information for the analytics generated by an NWDAF and enable the NWDAF containing AnLF registers the use and monitoring capability for an ML model into the model provider NWDAF | Subscribe | Subscribe / Notify | NWDAF | | +| | | Unsubscribe | | | | +| | | Notify | | | | +| | | Register | Request / Response | | | +| | | Deregister | | | | +| Nnwdaf_RoamingData | This service enables the consumer to subscribe/unsubscribe for input data related to roaming UE(s) for NWDAF analytics. | Subscribe | Subscribe / Notify | H-RE-NWDAF, V-RE-NWDAF | | +| | | Unsubscribe | | | | +| | | Notify | | | | +| Nnwdaf_RoamingAnalytics | This service enables the NF service | Subscribe (NOTE 4) | Subscribe / Notify | H-RE-NWDAF, V-RE-NWDAF | | + +| | | | +|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|--| +| consumers to subscribe (or modify subscriptions) to and unsubscribe from notifications for network data analytics related to roaming UE(s). | Unsubscribe | | +| | Notify | | +| NOTE 1: This service corresponds to the Nnwdaf_AnalyticsSubscription service defined in 3GPP TS 23.288 [17].
NOTE 2: This service implements also the Nnwdaf_MLModelInfo service as specified in 3GPP TS 23.288 [17] by using immediate and one-time reporting requirement.
NOTE 3: This service implements also the Nnwdaf_MLModelTrainingInfo service as specified in 3GPP TS 23.288 [17] by using immediate and one-time reporting requirement.
NOTE 4: The Nnwdaf_RoamingAnalytics_Subscribe service operation implements also the Nnwdaf_RoamingAnalytics_Request service operation specified in 3GPP TS 23.288 [17] by using immediate and one-time reporting requirement. | | | + +Table 4.1-2 summarizes the corresponding APIs defined in this specification. + +**Table 4.1-2: API Descriptions** + +| Service Name | Clause | Description | OpenAPI Specification File | apiName | Annex | +|---------------------------|--------|--------------------------------------|----------------------------------------|---------------------------|-------| +| Nnwdaf_EventsSubscription | 5.1 | Nnwdaf Events Subscription Service. | TS29520_Nnwdaf_EventsSubscription.yaml | nnwdaf-eventssubscription | A.2 | +| Nnwdaf_AnalyticsInfo | 5.2 | Nnwdaf Analytics Information Service | TS29520_Nnwdaf_AnalyticsInfo.yaml | nnwdaf-analyticsinfo | A.3 | +| Nnwdaf_DataManagement | 5.3 | NWDAF Data Management Service | TS29520_Nnwdaf_DataManagement.yaml | nnwdaf-datamanagement | A.4 | +| Nnwdaf_MLModelProvision | 5.4 | NWDAF ML Model Provision Service | TS29520_Nnwdaf_MLModelProvision.yaml | nnwdaf-mlmodelprovision | A.5 | +| Nnwdaf_MLModelTraining | 5.5 | NWDAF ML Model Training Service | TS29520_Nnwdaf_MLModelTraining.yaml | nnwdaf-mlmodeltraining | A.6 | +| Nnwdaf_MLModelMonitor | 5.6 | NWDAF ML model monitoring Service | TS29520_Nnwdaf_MLModelMonitoring.yaml | nnwdaf-mlmodelmonitor | A.7 | +| Nnwdaf_RoamingData | 5.7 | NWDAF Roaming Data Service | TS29520_Nnwdaf_RoamingData.yaml | nnwdaf-roamingdata | A.8 | +| Nnwdaf_RoamingAnalytics | 5.8 | NWDAF Roaming Analytics service | TS29520_Nnwdaf_RoamingAnalytics.yaml | nnwdaf-roaminganalytics | A.9 | + +## 4.2 Nnwdaf\_EventsSubscription Service + +### 4.2.1 Service Description + +#### 4.2.1.1 Overview + +The Nnwdaf\_EventsSubscription service corresponding to Nnwdaf\_AnalyticsSubscription service as defined in 3GPP TS 23.501 [2], 3GPP TS 23.288 [17] and 3GPP TS 23.503 [4], is provided by the Network Data Analytics Function (NWDAF). + +This service: + +- allows NF service consumers to subscribe to and unsubscribe from different analytics events; +- notifies NF service consumers with a corresponding subscription about observed events. and +- allows NF service consumers to request the transfer of subscriptions for analytics events. + +The types of observed events include: + +- Slice load level information; +- Network slice instance load level information; +- Service experience; +- NF load; +- Network performance; +- Abnormal behaviour; +- UE mobility; +- UE communication; +- User data congestion; +- QoS sustainability; +- Dispersion; +- Redundant transmission experience; +- SM congestion control experience; +- WLAN performance; +- DN performance; +- PFD determination; +- PDU Session traffic. +- Movement Behaviour; +- Location Accuracy; +- Relative Proximity. + +#### 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 [17]. The Network Data Analytics signalling flows are defined in 3GPP TS 29.552 [25], the Policy and Charging related 5G architecture is also described in 3GPP TS 23.503 [4] and 3GPP TS 29.513 [5]. + +The Nnwdaf\_EventsSubscription service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF). + +Known consumers of the Nnwdaf\_EventsSubscription service are: + +- 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) +- Location Management Function (LMF) +- Operation, Administration, and Maintenance (OAM) +- Charging Enablement Function (CEF) +- Network Data Analytics Function (NWDAF) +- Data Collection Coordination Function (DCCF) + +The PCF accesses the Nnwdaf\_EventsSubscription service at the NWDAF via the N23 Reference point. The NSSF accesses the Nnwdaf\_EventsSubscription service at the NWDAF via the N34 Reference point. + +![Reference Architecture for the Nnwdaf_EventsSubscription Service; SBI representation diagram](ca5dc5fde2061d0ca2051ef7840fc842_img.jpg) + +The diagram illustrates the Service Based Interface (SBI) representation for the Nnwdaf\_EventsSubscription service. At the top, a box labeled 'NWDAF' contains an oval labeled 'Nnwdaf'. A vertical line descends from this oval to a horizontal bus line. Above the bus line, the text 'Nnwdaf\_EventsSubscription' is displayed. Below the bus line, eleven rectangular boxes are arranged horizontally, representing various network functions that consume the service. From left to right, they are: PCF, NSSF, AMF, SMF, NEF, DCCF, AF, OAM, CEF, LMF, and NWDAF. Each of these boxes is connected to the horizontal bus line by a vertical line. + +Reference Architecture for the Nnwdaf\_EventsSubscription Service; SBI representation diagram + +**Figure 4.2.1.2-1: Reference Architecture for the Nnwdaf\_EventsSubscription Service; SBI representation** + +![Figure 4.2.1.2-2: Reference Architecture for the Nnwdaf_EventsSubscription Service: reference point representation. The diagram shows a central NWDAF box at the top connected to eleven boxes below it. The boxes below are PCF, NSSF, AMF, SMF, NEF, DCCF, AF, OAM, CEF, LMF, and NWDAF. Lines connect the top NWDAF to each of these boxes. The first two lines are labeled N23 and N34 respectively.](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +``` + +graph TD + NWDAF_top[NWDAF] -- N23 --> PCF[PCF] + NWDAF_top -- N34 --> NSSF[NSSF] + NWDAF_top --> AMF[AMF] + NWDAF_top --> SMF[SMF] + NWDAF_top --> NEF[NEF] + NWDAF_top --> DCCF[DCCF] + NWDAF_top --> AF[AF] + NWDAF_top --> OAM[OAM] + NWDAF_top --> CEF[CEF] + NWDAF_top --> LMF[LMF] + NWDAF_top --> NWDAF_bottom[NWDAF] + +``` + +Figure 4.2.1.2-2: Reference Architecture for the Nnwdaf\_EventsSubscription Service: reference point representation. The diagram shows a central NWDAF box at the top connected to eleven boxes below it. The boxes below are PCF, NSSF, AMF, SMF, NEF, DCCF, AF, OAM, CEF, LMF, and NWDAF. Lines connect the top NWDAF to each of these boxes. The first two lines are labeled N23 and N34 respectively. + +**Figure 4.2.1.2-2: Reference Architecture for the Nnwdaf\_EventsSubscription Service: reference point representation** + +NOTE: When the NEF subscribes the PFD Determination Analytics to the NWDAF, the NEF needs to support PFD function as NEF (PFD). + +#### 4.2.1.3 Network Functions + +##### 4.2.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF) provides analytics information for different analytics events to NF service consumers. + +The Network Data Analytics Function (NWDAF) allows NF service consumers to subscribe to and unsubscribe from one-time, periodic notification or notification when an event is detected. + +The Network Data Analytics Function (NWDAF) allows NF service consumers to request the transfer of subscriptions for analytics events. + +##### 4.2.1.3.2 NF Service Consumers + +The Policy Control Function (PCF): + +- supports (un)subscription to the notification of analytics information for slice load level information from the NWDAF; +- supports (un)subscription to the notification of analytics information for service experience related network data from the NWDAF; +- supports (un)subscription to the notification of analytics information for network performance from the NWDAF; +- supports (un)subscription to the notification of analytics information for abnormal UE behaviour from the NWDAF; +- supports (un)subscription to the notification of analytics information for UE mobility from the NWDAF; +- supports (un)subscription to the notification of analytics information for UE communication from the NWDAF; +- supports (un)subscription to the notification of analytics information for user data congestion from the NWDAF; +- supports (un)subscription to the notification of analytics information for dispersion from the NWDAF; +- supports (un)subscription to the notification of analytics information for session management congestion control experience from the NWDAF; +- supports (un)subscription to the notification of analytics information for redundant transmission experience from the NWDAF; +- supports (un)subscription to the notification of analytics information for DN performance from the NWDAF; +- supports (un)subscription to the notification of analytics information for WLAN performance from the NWDAF; +- supports (un)subscription to the notification of analytics information for PDU Session traffic from the NWDAF; and +- supports taking one or more above input from the NWDAF into consideration for policies on assignment of network resources and/or for traffic steering policies. + +NOTE: How this information is used by the PCF is not standardized in this specification. + +The Network Slice Selection Function (NSSF): + +- supports (un)subscription to the notification of analytics information for slice load level information or network slice instance load level information from the NWDAF to determine slice selection; + +- supports (un)subscription to the notification of analytics information for service experience related network data from the NWDAF; and +- supports (un)subscription to the notification of analytics information for dispersion at the slice from the NWDAF. + +The Access and Mobility Management Function (AMF): + +- supports (un)subscription to the notification of analytics information for slice load level information from the NWDAF; +- supports (un)subscription to the notification of analytics information for service experience related network data from the NWDAF; +- supports (un)subscription to the notification of analytics information for SMF load information from the NWDAF to determine SMF selection;-supports (un)subscription to the notification of analytics information for expected UE behavioural information (UE mobility and/or UE communication) from the NWDAF to monitor UE behaviour; +- supports (un)subscription to the notification of analytics information for abnormal UE behaviour information from the NWDAF to determine adjustment of UE mobility related network parameters to solve the abnormal risk; and +- supports (un)subscription to the notification of analytics information for dispersion at the slice from the NWDAF. + +The Session Management Function (SMF): + +- supports (un)subscription to the notification of analytics information for UPF load information from the NWDAF to determine UPF selection; +- supports (un)subscription to the notification of analytics information for UE mobility information from the NWDAF to determine UPF selection; +- supports (un)subscription to the notification of analytics information for Session Management Congestion Control Experience from the NWDAF;- supports (un)subscription to the notification of analytics information for expected UE behavioural information (UE mobility and/or UE communication) from the NWDAF to monitor UE behaviour; +- supports (un)subscription to the notification of analytics information for abnormal UE behaviour information from the NWDAF to determine adjustment of UE communication related network parameters to solve the abnormal risk; +- supports (un)subscription to the notification of analytics information for slice load level information or network slice instance load level information from the NWDAF to determine slice selection. +- supports (un)subscription to the notification of analytics information for service experience related network data from the NWDAF; +- supports (un)subscription to the notification of analytics information for redundant transmission experience from the NWDAF to consider whether redundant transmission shall be performed, or (if it had been activated) shall be stopped; and +- supports (un)subscription to the notification of analytics information for DN performance from the NWDAF. + +The Network Exposure Function (NEF): + +- supports (un)subscription to the notification of analytics information for UE mobility from the NWDAF; +- supports (un)subscription to the notification of analytics information for UE communication from the NWDAF; +- supports (un)subscription to the notification of analytics information for expected UE behavioural (UE mobility and/or UE communication) from the NWDAF; +- supports (un)subscription to the notification of analytics information for abnormal behaviour from the NWDAF; +- supports (un)subscription to the notification of analytics information for user data congestion from the NWDAF; +- supports (un)subscription to the notification of analytics information for network performance from the NWDAF; +- supports (un)subscription to the notification of analytics information for QoS Sustainability from the NWDAF; +- supports (un)subscription to the notification of analytics information for Dispersion from the NWDAF; +- supports (un)subscription to the notification of analytics information for DN performance from NWDAF; +- supports (un)subscription to the notification of analytics information for Observed Service Experience from NWDAF; +- with PFDF function supports (un)subscription to the notification of analytics information for NWDAF assisted PFD Determination from the NWDAF; +- supports (un)subscription to the notification of analytics information for E2E data volume transfer time from NWDAF; +- supports (un)subscription to the notification of analytics information for Relative Proximity from NWDAF; and + +- supports (un)subscription to the notification of analytics information for movement behaviour from NWDAF. + +The Application Function (AF): + +- supports receiving UE mobility information from NWDAF or via the NEF; +- supports receiving UE communication information from NWDAF or via the NEF; +- supports receiving expected UE behavioural information (UE mobility and/or UE communication) from NWDAF or via the NEF; +- supports receiving abnormal behaviour information from the NWDAF or via the NEF; +- supports receiving user data congestion information from the NWDAF or via the NEF; +- supports receiving network performance information from the NWDAF or via the NEF; +- supports receiving QoS Sustainability information from the NWDAF or via the NEF; +- supports receiving Dispersion information from the NWDAF or via the NEF; +- supports receiving Observed Service Experience information from NWDAF or via the NEF; +- supports receiving E2E data volume transfer time from NWDAF or via the NEF; +- supports receiving Movement Behaviour information from NWDAF or via the NEF; and +- supports receiving Relative Proximity information from NWDAF or via the NEF. + +The Operation, Administration, and Maintenance (OAM): + +- supports receiving slice load level information from the NWDAF; +- supports receiving observed service experience from the NWDAF; +- supports receiving NF load information from the NWDAF; +- supports receiving network performance information from the NWDAF; +- supports receiving UE mobility information from the NWDAF; +- supports receiving UE communication information from the NWDAF; +- supports receiving expected UE behaviour information (UE mobility and/or UE communication) from the NWDAF; and +- supports receiving abnormal UE behaviour information from the NWDAF. + +The Charging Enablement Function (CEF): + +- supports (un)subscription to the notification of analytics information for slice load level information from the NWDAF; and +- supports (un)subscription to the notification of analytics information for service experience statistics information from the NWDAF. + +The Location Management Function (LMF): + +- supports (un)subscription to the notification of analytics information for location accuracy analytics from the NWDAF. + +The Network Data Analytics Function (NWDAF): + +- supports (un)subscription to the notification of analytics information for all types of network analytics from the NWDAF; and +- supports requesting the transfer of subscriptions to another NWDAF. + +The Data Collection Coordination Function (DCCF): + +- supports (un)subscription to the notification of analytics information for all types of network analytics from the NWDAF. + +## 4.2.2 Service Operations + +### 4.2.2.1 Introduction + +**Table 4.2.2.1-1: Operations of the Nnwdaf\_EventsSubscription Service** + +| Service operation name | Description | Initiated by | +|---------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------| +| Nnwdaf_EventsSubscription_Subscribe | This service operation is used by an NF to subscribe or update subscription for event notifications of the analytics information. One-time, periodic notification or notification upon event detected can be subscribed. | NF service consumer (PCF, NSSF, AMF, SMF, NEF, AF, LMF, OAM, CEF, NWDAF, DCCF) | +| Nnwdaf_EventsSubscription_Unsubscribe | This service operation is used by an NF to unsubscribe from event notifications. | NF service consumer (PCF, NSSF, AMF, SMF, NEF, AF, LMF, OAM, CEF, NWDAF, DCCF) | +| Nnwdaf_EventsSubscription_Notify | This service operation is used by an NWDAF to notify NF service consumers about subscribed events. | NWDAF | +| Nnwdaf_EventsSubscription_Transfer | This service operation is used by an NWDAF to request the transfer of subscription(s) for analytics events. | NWDAF | + +### 4.2.2.2 Nnwdaf\_EventsSubscription\_Subscribe service operation + +#### 4.2.2.2.1 General + +The Nnwdaf\_EventsSubscription\_Subscribe service operation is used by an NF service consumer to subscribe or update subscription for event notifications from the NWDAF. + +#### 4.2.2.2.2 Subscription for event notifications + +Figure 4.2.2.2.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to subscribe for event notification(s) (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The consumer sends a POST request to /subscriptions, and the NWDAF responds with a 201 Created status.](4b587081b669e7c6695b0e5db5ea7f6d_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + NF service consumer->>NWDAF: 1. POST « /subscriptions + Note right of NWDAF: + NWDAF-->>NF service consumer: 2. 201 Created + +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The consumer sends a POST request to /subscriptions, and the NWDAF responds with a 201 Created status. + +**Figure 4.2.2.2.2-1: NF service consumer subscribes to notifications** + +The NF service consumer shall invoke the Nnwdaf\_EventsSubscription\_Subscribe service operation to subscribe to event notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwdaf-eventssubscription//subscriptions" as Resource URI representing the "NWDAF Events Subscriptions", as shown in figure 4.2.2.2.2-1, step 1, to create a subscription for an "Individual NWDAF Event Subscription" according to the information in message body. The NnwdafEventsSubscription data structure provided in the request body shall include: + +- an URI where to receive the requested notifications as "notificationURI" attribute; and +- a description of the subscribed events as "eventSubscriptions" attribute that, for each event, the EventSubscription data type shall include: + - 1) an event identifier as "event" attribute; and + +- 2) if the event notification method "PERIODIC" is selected via the "notificationMethod" attribute, repetition period as "repetitionPeriod" attribute; +- and the EventSubscription data type may include the "extraReportReq" attribute with the following attributes: +- 1) maximum number of objects in the "maxObjectNbr" attribute; + - 2) maximum number of SUPIs expected for an analytics report in the "maxSupiNbr" attribute; + - 3) identification of time window to which the subscription applies via identification of date-time(s) in the "startTs" and "endTs" attributes; + - 4) preferred level of accuracy of the analytics in the "accuracy" attribute; + - 5) identification of time when analytics information is needed in the "timeAnaNeeded" attribute if the feature "EneNA" is supported; + - 6) indication of which analytics metadata is requested to be delivered with the notification in the "anaMeta" attribute if the feature "Aggregation" is supported; + - 7) requested values for analytics metadata information to be used for the generation of the analytics in the "anaMetaInd" attribute if the feature "Aggregation" is supported; + - 8) offset period to the periodic reporting in the "offsetPeriod" attribute if the feature "EneNA" is supported. It may be present if the "repPeriod" attribute within the "evtReq" attribute or the "repetitionPeriod" attribute within the EventSubscription data type is included; + - 9) preferred accuracy level per analytics subset in the "accPerSubset" attribute if the "listOfAnaSubsets" attribute is present and the "EneNA" feature is supported; and/or + - 10) the time period of historical analytics in the "histAnaTimePeriod" attribute, if the "EneNA" feature is supported. + +The NnwdafeventsSubscription data structure provided in the request body may include: + +- event reporting information as the "evtReq" attribute, which applies for each event and may contain the following attributes: + - 1) event notification method (periodic, one time, on event detection) in the "notifMethod" attribute; + - 2) maximum Number of Reports in the "maxReportNbr" attribute; + - 3) monitoring duration in the "monDur" attribute; + - 4) repetition period for periodic reporting in the "repPeriod" attribute; + - 5) immediate reporting indication in the "immRep" attribute; + - 6) percentage of sampling among impacted UEs in the "sampRatio" attribute; + - 7) partitioning criteria for partitioning the impacted UEs before performing sampling as "partitionCriteria" attribute if the "EneNA" feature is supported; + - 8) group reporting guard time for aggregating the reports for a group of UEs in the "grpRepTime" attribute; and/or + - 9) a notification flag (used for muting and retrieving notifications) as "notifFlag" attribute if the "EneNA" feature is supported + +NOTE 1: The notification method indicated as the "notifMethod" attribute and the periodic reporting time indicated as the "repPeriod" attributes within the event reporting information as the "evtReq" attribute provided in NnwdafeventsSubscription data type, if present, supersedes the event notification method as the "notificationMethod" attribute and repetition period as the "repetitionPeriod" attribute respectively in the EventSubscription data type. + +EventSubscription data type. + +- information of previous analytics subscription in the "prevSub" attribute if the "AnaCtxTransfer" feature is supported; +- the notification correlation identifier in the "notifCorrId" attribute, if the "EneNA" feature is supported; and/or +- analytics consumer information as "consNfInfo" attribute, if the "AnaSubTransfer" feature is supported; + +NOTE 2: The "consNfInfo" attribute enables the NWDAF to determine whether an analytics subscription transfer procedure is applicable. Otherwise, if the "consNfInfo" attribute is not provided in a subscription and the NWDAF cannot serve anymore or transfer this subscription, the NWDAF can notify the analytics consumer with a Termination Request so that the analytics consumer can select a new target NWDAF. + +For all the event types, the "eventSubscriptions" attribute may include: + +- the analytics accuracy requirement information in "accuReq" attribute as indication to the NWDAF to activate checking the analytics accuracy information of the subscribed event, if the "AnalyticsAccuracy" feature is + +supported and the NF service consumer discovered or local configured the NWDAF containing an AnLF supporting accuracy checking capability. + +- the pause analytics consumption flag in "pauseFlg" attribute if the "AnalyticsAccuracy" feature is supported. +- the resume analytics consumption flag in "resumeFlg" attribute if the "AnalyticsAccuracy" feature is supported. +- use case context as "useCaseCxt" attribute, if the "ENAExt" feature is supported. + +NOTE 3: The NWDAF can use the parameter "Use case context" to select the most relevant ML model, when several ML models are available for the requested Analytics ID(s). The NWDAF containing AnLF can additionally provide the parameter "Use case context" when requesting an ML model from an NWDAF containing MTLF. The values of this parameter are not standardized. + +NOTE 4: The subscription for analytics accuracy information independently from subscription of the analytics event output is not supported in this release. + +- information related to roaming within the "roamingInfo" attribute if the "RoamingAnalytics" feature is supported; + +For different event types, the "eventSubscriptions" attribute: + +- if the event is "SLICE\_LOAD\_LEVEL", shall provide: + - 1) network slice level load level threshold in the "loadLevelThreshold" attribute if the "notifMethod" attribute in "evtReq" attribute is set to "ON\_EVENT\_DETECTION" or the "notificationMethod" attribute in "eventSubscriptions" attribute is set to "THRESHOLD" or omitted; and + - 2) identification of network slice(s) to which the subscription applies via identification of network slice(s) in the "snssais" attribute or any slices indication in the "anySlice" attribute; +- if the feature "NsiLoad" is supported and the event is "NSI\_LOAD\_LEVEL", shall provide: + - 1) identification of network slice and the optionally associated network slice instance(s) if available, via the "nsiIdInfos" attribute or any slices indication in the "anySlice" attribute; and + +NOTE 5: The network slice instance of a PDU session is not available in the PCF. + +- 2) the network slice or network slice instance load level thresholds in the "nsiLevelThrds" attribute if the "notifMethod" attribute in "evtReq" attribute is set to "ON\_EVENT\_DETECTION" or the "notificationMethod" attribute in "eventSubscriptions" attribute is set to "THRESHOLD" or omitted; + +and may include: + +- 1) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "NSI\_LOAD\_LEVEL" event, if the "EneNA" feature is supported; +- 2) identification of network area to which the subscription applies via identification of network area(s) by "networkArea" attribute, if the "NsiLoadExt" feature is supported; +- 3) a matching direction in the "matchingDir" attribute if the "nsiLevelThrds" attribute is provided and the "NsiLoadExt" feature is supported; and/or +- 4) list of NF instance types in the "nfTypes" attribute, if the "NsiLoadExt" feature is supported. + +- if the feature "NfLoad" is supported and the event is "NF\_LOAD", shall provide: + - 1) identification of target UE(s) to which the subscription applies by "supis" or "anyUe" in the "tgtUe" attribute; and + +NOTE 6: Only NF instances of type AMF and SMF which are serving the UE can be determined using a SUPI in "supis" attribute. + +NOTE 7: If a list of the NF Instance IDs (or respectively of NF Set IDs) is provided, the NWDAF needs to provide the analytics for each designated NF instance (or respectively for each NF instance belonging to each designated NF Set). In such case the target UE(s) of the Analytics Reporting need be ignored. + +- 2) NF load level thresholds in the "nfLoadLvlThrds" attribute if the "notifMethod" attribute in "evtReq" attribute is set to "ON\_EVENT\_DETECTION" or the "notificationMethod" attribute in "eventSubscriptions" attribute is set to "THRESHOLD" or omitted; + +and may include: + +- 1) either list of NF instance IDs in the "nfInstanceIds" attribute or list of NF set IDs in the "nfSetIds" attribute if the identification of target UE(s) applies to all UEs; + - 2) list of NF instance types in the "nfTypes" attribute; + - 3) identification of network slice(s) by "snssais" attribute; + - 4) a matching direction in the "matchingDir" attribute if the "nfLoadLvlThds" attribute is provided; + - 5) optional area of interest by "networkArea" attribute, if the "NfLoadExt" feature is supported; and/or + - 6) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to NF\_LOAD event, if the "EneNA" feature is supported; +- if the feature "NetworkPerformance" is supported and the event is "NETWORK\_PERFORMANCE", it shall provide: +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute; and + - 2) the network performance requirements via "nwPerfRequs" attribute; +- and may provide: +- 1) identification of network area to which the subscription applies via identification of network area(s) by "networkArea" attribute (mandatory if "anyUe" attribute is set to true); + - 2) a matching direction in the "matchingDir" attribute if the "nwPerfRequs" attribute is provided; + - 3) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "NetworkPerformanceExt\_eNA" feature is supported; + - 4) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "NetworkPerformanceExt\_eNA" feature is supported; and/or + - 5) the temporal granularity size in the "temporalGranSize" attribute if the "NetworkPerformanceExt\_eNA" feature is supported. +- if the feature "ServiceExperience" is supported and the event is "SERVICE\_EXPERIENCE", shall provide: +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute; and + - 2) any slices indication in the "anySlice" attribute or identification of network slice(s) together with the optionally associated network slice instance(s) if available, via the "nsiIdInfos" attribute; + +NOTE 8: The network slice instance of a PDU session is not available in the PCF. + +and may provide: + +- 1) identification of application to which the subscription applies via identification of application(s) by "appIds" attribute; +- 2) identification of network area to which the subscription applies via identification of network area(s) by "networkArea" attribute (mandatory if "anyUe" attribute is set to true); +- 3) identification of DNN to which the subscription applies via identification of application(s) by "dnns" attribute; +- 4) identification of user plane access to DN(s) which the subscription applies as the "dnais" attribute; +- 5) identification of a user plane access to one or more DN(s) where applications are deployed by "dnais" attribute; +- 6) if "appIds" attribute is provided, the bandwidth requirement of each application by "bwRequs" attribute; +- 7) indication of all the RAT types and/or all the frequencies that the NWDAF received for the application or specific RAT type(s) and/or frequency(ies) and the service experience threshold value(s) for the RAT Type(s) and/or Frequency value(s) where the UE camps on by "ratFreqs" attribute if the feature "ServiceExperienceExt" is also supported; +- 8) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "SERVICE\_EXPERIENCE" event, if the "EneNA" feature is supported; +- 9) the identification of the UPF as the "upfInfo" attribute if the feature "ServiceExperienceExt" is also supported; +- 10) IP address(s)/FQDN(s) of the Application Server(s) as the "appServerAddrs" attribute if the feature "ServiceExperienceExt" is also supported; +- 11) combination of PDU Session parameters as the "pduSesInfos" attribute if the feature "ServiceExperienceExt2\_eNA" is also supported; and/or +- 12) preferred granularity of location information as the "locGranularity" attribute if the feature "ServiceExperienceExt2\_eNA" is supported; and/or + +- 13) the fine granularity areas as the "fineGranAreas" attribute if the feature "ServiceExperienceExt2\_eNA" is supported. +- if the feature "UeMobility" is supported and the event is "UE\_MOBILITY", shall provide: + - 1) identification of target UE(s) to which the subscription applies by "supis" or "intGroupIds" attribute in the "tgtUe" attribute; + +NOTE 9: For LADN service, the consumer (e.g. SMF) provides the LADN DNN to refer the LADN service area as the AOI. + +and may provide: + +- 1) identification of network area to which the subscription applies via identification of network area(s) by "networkArea" attribute; + - 2) preferred granularity of location information as the "locGranularity" attribute if the feature "UeMobilityExt2\_eNA" is supported. + - 3) identification of the preferred orientation of location information by "locOrientation" attribute if the feature "UeMobilityExt2\_eNA" is supported. + - 4) if the feature "UeMobilityExt" is supported, + - i) identification of LADN DNN in the "ladnDnns" attribute; + - ii) Visited Area(s) of Interest as the "visitedAreas" attribute; + - 5) other UE mobility analytics requirements in "ueMobilityReqs" attribute, which may include ordering criterion and ordering direction, if the "UeMobilityExt2\_eNA" feature is supported; + - 6) an optional list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "UE\_MOBILITY" event, if the "UeMobilityExt2\_eNA" and "EneNA" features are supported; + - 7) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "UeMobilityExt2\_eNA" feature is supported; + - 8) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "UeMobilityExt2\_eNA" feature is supported; + - 9) the fine granularity areas as the "fineGranAreas" attribute if the feature "UeMobilityExt2\_eNA" is supported. +- if the feature "UeCommunication" is supported and the event is "UE\_COMM", shall provide: + - 1) identification of target UE(s) to which the subscription applies by "supis" or "intGroupIds" attribute in the "tgtUe" attribute; + +and may include: + +- 1) identification of the application in the "appIds" attribute; + - 2) identification of network area to which the subscription applies via identification of network area(s) by "networkArea" attribute; + - 3) an identification of DNN in the "dnns" attribute; + - 4) identification of network slice in the "snsaas" attribute; + - 5) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "UE\_COMM" event, if the "EneNA" feature is supported; + - 6) other UE communication analytics requirements in "ueCommReqs" attribute, which may include ordering criterion and ordering direction, if the "EnUeCommunication" feature is supported; + - 7) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "UeCommunicationExt\_eNA" feature is supported; + - 8) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "UeCommunicationExt\_eNA" feature is supported. +- if the feature "QoSustainability" is supported and the event is "QOS\_SUSTAINABILITY", shall provide: + - 1) identification of network area to which the subscription applies via identification of network area by "networkArea" attribute; + - 2) the QoS requirements via "qosRequ" attribute; + - 3) QoS flow retainability threshold(s) by the "qosFlowRetThds" attribute for the 5QI of GBR resource type or RAN UE throughout threshold(s) by the "ranUeThrouThds" attribute for the 5QI of non-GBR resource type, if the "notifMethod" attribute in "evtReq" attribute is set to "ON\_EVENT\_DETECTION" or the "notificationMethod" attribute in "eventSubscriptions" attribute is set to "THRESHOLD" or omitted; and + - 4) identification of target UE(s) to which the subscription applies by "anyUe" in the "tgtUe" attribute; + +and may include: + +- 1) identification of network slice(s) by "snssais" attribute; +- 2) a matching direction in the "matchingDir" attribute if the "qosFlowRetThds" attribute or the "ranUeThrouThds" attribute is provided; +- 3) acceptable deviations from the threshold levels in the "deviations" attribute, if the "EnQoSustainability" feature is supported; +- 4) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "QoSustainabilityExt\_eNA" feature is supported; +- 5) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "QoSustainabilityExt\_eNA" feature is supported; +- 6) the temporal granularity size in the "temporalGranSize" attribute if the "QoSustainabilityExt\_eNA" feature is supported; and/or +- 7) the fine granularity areas as the "fineGranAreas" attribute if the feature "QoSustainabilityExt\_eNA" is supported. + +- if the feature "AbnormalBehaviour" is supported and the event is "ABNORMAL\_BEHAVIOUR", shall provide: + +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute; and +- 2) either the expected analytics type via "exptAnaType" attribute or a list of exception Ids with the associated thresholds via "excepRequs" attribute. If the expected analytics type via "exptAnaType" attribute is provided, the NWDAF shall derive the corresponding Exception Ids from the received expected analytics type as follows: + - a) if "exptAnaType" attribute sets to "MOBILITY", the corresponding list of Exception Ids are "UNEXPECTED\_UE\_LOCATION", "PING\_PONG\_ACROSS\_CELLS", "UNEXPECTED\_WAKEUP" and "UNEXPECTED\_RADIO\_LINK\_FAILURES"; + - b) if "exptAnaType" attribute sets to "COMMUN", the corresponding list of Exception Ids are "UNEXPECTED\_LONG\_LIVE\_FLOW", "UNEXPECTED\_LARGE\_RATE\_FLOW", "SUSPICION\_OF\_DDOS\_ATTACK", "WRONG\_DESTINATION\_ADDRESS" and "TOO\_FREQUENT\_SERVICE\_ACCESS"; and + - c) if "exptAnaType" attribute sets to "MOBILITY\_AND\_COMMUN", the corresponding list of Exception Ids includes all above derived exception Ids. + +The derived list of Exception Ids is used by the NWDAF to notify the NF service consumer when UE's behaviour is exceptional based on one or more Exception Ids within the list. + +If the "anyUe" attribute in the "tgtUe" attribute sets to "true": + +- a) the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepRequs" attribute shall not be requested for both mobility and communication related analytics at the same time; +- b) if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepRequs" attribute is mobility related, at least one of identification of network area(s) by "networkArea" attribute and identification of network slice(s) by "snssais" attribute should be provided; and +- c) if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepRequs" attribute is communication related, at least one of identification of network area(s) by "networkArea" attribute, identification of application(s) by "appIds" attribute, identification of DNN(s) in the "dnns" attribute and identification of network slice(s) by "snssais" attribute should be provided; + +and may provide: + +- 1) expected UE behaviour via "exptUeBehav" attribute. + +- if the feature "UserDataCongestion" is supported and the event is "USER\_DATA\_CONGESTION", shall provide: + +- 1) identification of target UE(s) to which the subscription applies by "supis", "gpsis" (if feature "UserDataCongestionExt" is supported) or "anyUe" attribute; + +and may include: + +- 1) congestion threshold by the "congThresholds" attribute if the "notifMethod" attribute in "evtReq" attribute is set to "ON\_EVENT\_DETECTION" or the "notificationMethod" attribute in "eventSubscriptions" attribute is set to "THRESHOLD" or omitted; + +- 2) identification of network area to which the subscription applies via identification of network area(s) by "networkArea" attribute (mandatory if "anyUe" attribute is set to true); + - 3) identification of network slice(s) by "snssais" attribute; + - 4) a matching direction in the "matchingDir" attribute if the "congThresholds" attribute is provided; + - 5) if the feature "UserDataCongestionExt" is also supported, request a list of top applications with maximum number that contribute the most to the traffic in uplink and/or downlink directions by the "maxTopAppUINbr" attribute and/or the "maxTopAppDINbr" attribute; + - 6) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "USER\_DATA\_CONGESTION" event, if the "EneNA" feature is supported; and/or + - 7) the ordering criterion for the list of User Data Congestion analytics in "userDataConOrderCri" attribute, if the "UserDataCongestionExt2\_eNA" feature is supported; + - 8) the temporal granularity size in the "temporalGranSize" attribute if the "UserDataCongestionExt2\_eNA" feature is supported. +- if the feature "Dispersion" is supported and the event is "DISPERSION", shall provide: +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute, "anyUe" attribute is only supported in combination with "snssais" attribute, "networkArea" attribute and/or "disperClass" attribute; + +and may include: + +- 1) identification of network area to which the subscription applies via identification of network area by "networkArea" attribute, if the "supis" attribute or "intGroupIds" attribute is included in the "tgtUe" attribute; + - 2) identification of network slice(s) by "snssais" attribute; + - 3) application identifier(s) in "appIds" attribute; + - 4) dispersion analytics requirements in "disperReqs" attribute, which for the requested dispersion type may include dispersion class, preferred ordering requirements; + - 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to DISPERSION event, if the "EneNA" feature is supported; and/or + - 6) preferred granularity of location information as the "locGranularity" attribute if the feature "DispersionExt\_eNA" is supported; + - 7) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "DispersionExt\_eNA" feature is supported; + - 8) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "DispersionExt\_eNA" feature is supported; and/or + - 9) the temporal granularity size in the "temporalGranSize" attribute if the "DispersionExt\_eNA" feature is supported. +- if the feature "RedundantTransmissionExp" is supported and the event is "RED\_TRANS\_EXP", shall provide: +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute; +- and may include: +- 1) identification of network area to which the subscription applies via identification of network area by "networkArea" attribute; + - 2) identification of network slice(s) by "snssais" attribute; + - 3) identification of DNN in the "dnns" attribute; + - 4) other redundant transmission experience analysis requirements in "redTransReqs" attribute, which may include preferred order of results for the list of Redundant Transmission Experience; and/or + - 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to RED\_TRANS\_EXP event, if the "EneNA" feature is supported; + - 6) the temporal granularity size in the "temporalGranSize" attribute if the "RedundantTransExpExt\_eNA" feature is supported. +- if the feature "WlanPerformance" is supported and the event is "WLAN\_PERFORMANCE", shall provide: +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute. If "anyUe" attribute is included in the "tgtUe" attribute, then any of "networkArea" attribute, "ssIds" or "bssIds" attribute within "wlanReqs" attribute shall be present; + +and may include: + +- 1) identification of network area to which the subscription applies via identification of network area by "networkArea" attribute; + - 2) other WLAN performance analytics requirements in "wlanReqs" attribute, which may include SSID(s), BSSID(s), preferred order of results for the list of WLAN performance information and/or accuracy per analytics subset; and/or + - 3) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to WLAN\_PERFORMANCE event, if the "EneNA" feature is supported; + - 4) the temporal granularity size in the "temporalGranSize" attribute if the "WlanPerfExt\_eNA" feature is supported. +- if the feature "DnPerformance" is supported and the event is "DN\_PERFORMANCE", shall provide: +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute; + +and may include: + +- 1) identification of network area to which the subscription applies via identification of network area by "networkArea" attribute; + - 2) identification of network slice(s) in the "snssais" attribute; + - 3) identification of network slice and the optionally associated network slice instance(s) if available, via the "nsiIdInfos" attribute or any slices indication in the "anySlice" attribute; + - 4) application identifier(s) in "appIds" attribute; + - 5) an identification of DNN in the "dnns" attribute; + - 6) identification of a user plane access to one or more DN(s) where applications are deployed by "dnais" attribute; + - 7) the identification of the UPF as the "upfInfo" attribute; + - 8) IP address(s)/FQDN(s) of the Application Server(s) as the "appServerAddrs" attribute; + - 9) other DN performance analytics requirements in "dnPerfReqs" attribute, which may include the preferred order of results for the list of DN performance information and/or the reporting threshold of each applicable analytics subset; and/or + - 10) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "DN\_PERFORMANCE" event, if the "EneNA" feature is supported and may include the attribute with value(s) only applicable to "DN\_PERFORMANCE" event and the "DnPerformanceExt\_AIML" feature if supported; + - 11) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "DnPerformanceExt\_eNA" feature is supported; + - 12) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "DnPerformanceExt\_eNA" feature is supported; and/or + - 13) the temporal granularity size in the "temporalGranSize" attribute if the "DnPerformanceExt\_eNA" feature is supported. +- if the feature "SMCCE" is supported and the event is "SM\_CONGESTION", shall provide: +- 1) an identification of DNN in the "dnns" attribute; + - 2) identification of network slice in the "snssais" attribute; and/or + - 3) identification of target UE(s) via "supis" attribute in the "tgtUe" attribute where the target UE(s) are one have the PDU Session for the DNN and/or S-NSSAI; + +and may include: + +- 1) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "SM\_CONGESTION" event, if the "EneNA" feature is supported. + +NOTE 10: The predictions are not applicable for Session Management Congestion Control Experience analytics. + +- if the feature "PfdDetermination" is supported and the event is "PFD\_DETERMINATION", it shall provide: + +- 1) a list of application identifier(s) in the "appIds" attribute. + +and may provide: + +- 1) identification of DNN in the "dnns" attribute; and/or +- 2) identification of network slice in the "snssais" attribute. + +NOTE 11: PFD Determination analytics do not have a target UE, they are always for any UE. The predictions are not applicable for PFD Determination analytics. + +- if the feature "E2eDataVolTransTime" is supported and the event is "E2E\_DATA\_VOL\_TRANS\_TIME", shall provide: + +- 1) identification of target UE(s) to which the subscription applies by "supis" or "gpsi" attribute in the "tgtUe" attribute. + +and may include: + +- 1) an identification of DNN in the "dnns" attribute; +- 2) identification of network slice in the "snssais" attribute; +- 3) application identifier(s) in "appIds" attribute; +- 4) area of interest of the UEs by "networkArea" attribute; restricts the scope of the E2E data volume transfer time analytics to the provided area; +- 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "E2E\_DATA\_VOL\_TRANS\_TIME" event, if the "EneNA" feature is supported; +- 6) the QoS requirements via "qosRequ" attribute; and/or +- 7) E2E data volume transfer time requirements in the "dataVITrnsTmRqs" attribute; + +- if the feature "PduSesTraffic" is supported and the event is "PDU\_SESSION\_TRAFFIC", shall provide: + +- 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgtUe" attribute; +- 2) PDU Session traffic analytics requirements in "pduSesTrafReqs" attribute, which includes the known Application Identifier, IP Descriptions or Domain Descriptors; and +- 3) DNN and/or S-NSSAI for the PDU Session(s) in the "dnns" and/or "snssais" attributes. + +and may include: + +- 1) identification of network area to which the subscription applies by "networkArea" attribute and/or +- 2) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "PDU\_SESSION\_TRAFFIC" event, if the "EneNA" features is supported. + +NOTE 12: The predictions are not applicable for PDU Session traffic analytics. + +- if the feature "MovementBehaviour" is supported and the event is "MOVEMENT\_BEHAVIOUR", shall provide: + +- 1) identification of network area to which the subscription applies by "networkArea" attribute; + +- and may include: + +- 1) identification of the preferred orientation of location information by "locOrientation" attribute; +- 2) Movement Behaviour analytics requirements in "movBehavReqs" attribute, which includes preferred granularity of location information or preferred orientation of location information; and/or +- 3) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "MOVEMENT\_BEHAVIOUR" event, if the "EneNA" features is supported. + +- if the feature "LocAccuracy" is supported and the event is "LOC\_ACCURACY", it shall provide: + +- 1) either a network area to which the subscription applies within the "networkArea" attribute or an exact location to which the subscription applies within the "location" attribute; + +- and may include: + +- 1) Location accuracy analytics requirements within the "locAccReqs" attribute; and/or +- 2) an optional list of analytics subsets within the "listOfAnaSubsets" attribute with value(s) only applicable to the "LOC\_ACCURACY" event, if the "EneNA" features is supported. + +NOTE 13: Location accuracy analytics do not have a target UE, they are always for any UE. + +- if the feature "RelativeProximity" is supported and the event is "RELATIVE\_PROXIMITY", shall provide: + +- 1) identification of target UE(s) to which the subscription applies by "supis" or "intGroupIds" attribute in the "tgtUe" attribute; +- and may include: + - 1) identification of DNN in the "dnns" attribute; + - 2) identification of network slice in the "snssais" attribute; + - 3) identification of network area to which the subscription applies by "networkArea" attribute; + - 4) Relative Proximity analytics requirements in "relProxReqs" attribute; and/or + - 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "RELATIVE\_PROXIMITY" event prediction, if the "EneNA" features is supported. + +Upon the reception of an HTTP POST request with: + +"{apiRoot}/nnwdafeventssubscription/{apiVersion}/subscriptions" as Resource URI and NnwdafeventsSubscription data structure as request body, if no errors occur, the NWDAF shall: + +- create a new subscription; +- assign an event subscriptionId; and +- store the subscription. + +If the NWDAF created an "Individual NWDAF Event Subscription" resource, the NWDAF shall respond with "201 Created" status code with the message body containing a representation of the created subscription, as shown in figure 4.2.2.2.2-1, step 2. If not all the requested analytics events in the subscription are accepted, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. "{apiRoot}/nnwdafeventssubscription/{apiVersion}/subscriptions/{subscriptionId}". If the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute sets to true in the event subscription, the NWDAF shall include the reports of the events subscribed, if available, in the HTTP POST response. + +**When the "notifFlag" attribute is included and set to "DEACTIVATE" in the request, the NWDAF 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.** + +If the analytics target period provided in the body of the HTTP POST request includes the start time in the past and the end time in the future, the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "BOTH\_STAT\_PRED\_NOT\_ALLOWED". + +When the "PredictionError" feature is supported, if the analytics target period provided in the body of the HTTP POST request includes the prediction time period in the future and the event is "SM\_CONGESTION", "PFD\_DETERMINATION" and/or "PDU\_SESSION\_TRAFFIC", the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "PREDICTION\_NOT\_ALLOWED". + +If the statistics in the past are requested but the necessary data to perform the service is unavailable, the NWDAF shall reject the request with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "UNAVAILABLE\_DATA". + +If the user consent has not been checked by the NF service consumer and is required for the requested analytics collection depending on local policy and regulations, then the NWDAF shall check user consent for the targeted UE(s) by retrieving the user consent subscription data via the Nudm\_SDM service API of the UDM as described in clause 5.2.2 of 3GPP TS 29.503 [23]. If the NWDAF receive the response from the UDM that it is not granted for the impacted user(s), then the NWDAF shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "USER\_CONSENT\_NOT\_GRANTED". + +**NOTE 14: When the target of reporting is a SUPI or a GPSI then the subscription can be rejected, e.g. because user consent is not granted, and the error is sent to the consumer. When the target of reporting is an Internal Group Id, or a list of SUPIs/GPSI(s) or any UE, and the user consent is not granted for a subset of the impacted users, then no error is sent, but a subset of the SUPIs/GPSIs is skipped if user consent is not granted.** + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.1.7. + +#### 4.2.2.2.3 Update subscription for event notifications + +Figure 4.2.2.2.3-1 shows a scenario where the NF service consumer sends a request to the NWDAF to update the subscription for event notifications (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF to update a subscription. Step 1: The consumer sends a PUT request to the NWDAF. Step 2a: The NWDAF responds with '200 OK' or '204 No Content'.](67d03c9e89620d73e3786c869e559752_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. PUT « subscriptions/{subscriptionId} » + NF service consumer->>NWDAF: Request + Note left of NWDAF: 2a. "200 OK" or + Note left of NWDAF: 2b. "204 No Content" + NWDAF-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF to update a subscription. Step 1: The consumer sends a PUT request to the NWDAF. Step 2a: The NWDAF responds with '200 OK' or '204 No Content'. + +**Figure 4.2.2.2.3-1: NF service consumer updates subscription to notifications** + +The NF service consumer shall invoke the Nnwdaf\_EventsSubscription\_Subscribe service operation to update subscription to event notifications. The NF service consumer shall send an HTTP PUT request with "{apiRoot}/nnwdaf-eventssubscription//subscriptions/{subscriptionId}" as Resource URI representing the "Individual NWDAF Event Subscription", as shown in figure 4.2.2.2.3-1, step 1, to update the subscription for an "Individual NWDAF Event Subscription" resource identified by the {subscriptionId}. The NnwdafEventsSubscription data structure provided in the request body shall include the same contents as described in clause 4.2.2.2.2. In addition, each element of the "eventSubscriptions" may contain the following: + +- Analytics feedback information within the "feedback" attribute, if the "AnalyticsAccuracy" feature is supported and the subscription is for a prediction. + +Upon the reception of an HTTP PUT request with: + +"{apiRoot}/nnwdaf-eventssubscription//subscriptions/{subscriptionId}" as Resource URI and NnwdafEventsSubscription data structure as request body, the NWDAF shall: + +- update the subscription of corresponding subscriptionId; and +- store the subscription. + +NOTE: The "notificationURI" attribute within the NnwdafEventsSubscription data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +If the NWDAF successfully processed and accepted the received HTTP PUT request, the NWDAF shall update an "Individual NWDAF Event Subscription" resource, and shall respond with: + +- a) HTTP "200 OK" status code with the message body containing a representation of the updated subscription, as shown in figure 4.2.2.2.3-1, step 2a. If not all the requested analytics events in the subscription are modified successfully, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the modification failed and the associated reason(s); or +- b) HTTP "204 No Content" status code, as shown in figure 4.2.2.2.3-1, step 2b. + +If errors occur when processing the HTTP PUT request, the NWDAF shall send an HTTP error response as specified in clause 5.1.7. + +If the analytics target period provided in the body of the HTTP PUT request includes the start time in the past and the end time in the future, the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "BOTH\_STAT\_PRED\_NOT\_ALLOWED". + +When the "PredictionError" feature is supported, if the analytics target period provided in the body of the HTTP PUT request includes the prediction time period in the future and the event is "SM\_CONGESTION", "PFD\_DETERMINATION" and/or "PDU\_SESSION\_TRAFFIC", the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "PREDICTION\_NOT\_ALLOWED". + +If the statistics in the past are requested but the necessary data to perform the service is unavailable, the NWDAF shall reject the request with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "UNAVAILABLE\_DATA". + +If the feature "ES3XX" is supported, and the NWDAF determines the received HTTP PUT request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +When the "notifFlag" attribute is included in the request with the value "DEACTIVATE", the NWDAF 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 the value "RETRIEVAL", the NWDAF 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 the value "ACTIVATE" and the event notifications are muted (due to a previously received "DEACTIVATE" value), the NWDAF 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. + +#### 4.2.2.3 Nnwdaf\_EventsSubscription\_Unsubscribe service operation + +##### 4.2.2.3.1 General + +The Nnwdaf\_EventsSubscription\_Unsubscribe service operation is used by an NF service consumer to unsubscribe from event notifications. + +##### 4.2.2.3.2 Unsubscribe from event notifications + +Figure 4.2.2.3.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to unsubscribe from event notifications (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the unsubscribe process between an NF service consumer and the NWDAF.](4767b6e106f34fe8b63a6838810bf913_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + Note right of NWDAF: + NF service consumer->>NWDAF: 1. DELETE« /subscriptions/{subscriptionId} + NWDAF-->>NF service consumer: 2. 204 No Content +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and the NWDAF. The NF service consumer sends a DELETE request to the NWDAF, and the NWDAF responds with a 204 No Content status code. + +Sequence diagram showing the unsubscribe process between an NF service consumer and the NWDAF. + +**Figure 4.2.2.3.2-1: NF service consumer unsubscribes from notifications** + +The NF service consumer shall invoke the Nnwdaf\_EventsSubscription\_Unsubscribe service operation to unsubscribe to event notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nnwdaf-eventssubscription//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request with: + +"{apiRoot}/nnwdaf-eventssubscription//subscriptions/{subscriptionId}" as Resource URI, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- remove the corresponding subscription; and +- respond with HTTP "204 No Content" status code. + +If errors occur when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.1.7. + +If the feature "ES3XX" is supported, and the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.2.2.4 Nnwdaf\_EventsSubscription\_Notify service operation + +##### 4.2.2.4.1 General + +The Nnwdaf\_EventsSubscription\_Notify service operation is used by an NWDAF to notify NF consumers about subscribed events or by the target NWDAF to notify the consumer of the successful analytics subscription transfer. + +##### 4.2.2.4.2 Notification about subscribed event + +Figure 4.2.2.4.2-1 shows a scenario where the NWDAF sends a request to the NF service consumer to notify for event notifications or notify for the successful analytics subscription transfer (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The NWDAF sends a POST request to the NF service consumer, and the NF service consumer responds with a 204 No Content.](a3083eec2a883ee8327b3c24174df6a9_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NWDAF: 1. POST {notificationURI} + NWDAF->>NF service consumer: 1. POST {notificationURI} + Note left of NF service consumer: 2. 204 No Content + NF service consumer-->>NWDAF: 2. 204 No Content + +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The NWDAF sends a POST request to the NF service consumer, and the NF service consumer responds with a 204 No Content. + +**Figure 4.2.2.4.2-1: NWDAF notifies the subscribed event** + +The NWDAF shall invoke the Nnwdaf\_EventsSubscription\_Notify service operation to notify the subscribed event or the successful analytics subscription transfer. The NWDAF shall send an HTTP POST request with "{notificationURI}" received in the Nnwdaf\_EventsSubscription\_Subscribe service operation as Resource URI, as shown in figure 4.2.2.4.2-1, step 1. + +If both the repetition period ("repPeriod" or "repetitionPeriod") attribute and the "offsetPeriod" attribute are present in the subscription request for periodical notification, the NWDAF shall produce a notification in every repetition period seconds, including the statistics in the past offset period if the "offsetPeriod" attribute value is negative, or including the prediction for the future offset period if the "offsetPeriod" attribute value is positive. + +The NnwdafEventsSubscriptionNotification data structure provided in the request body shall include: + +- If the notification is for notifying about subscribed events, a description of the notified event as "eventNotifications" attribute that for each event shall include: + - a) an event identifier as "event" attribute; + - b) network slice load level information in the "sliceLoadLevelInfo" attribute when subscribed event is "SLICE\_LOAD\_LEVEL"; + - c) service experience information as "svcExps" attribute when subscribed event is "SERVICE\_EXPERIENCE"; + - d) UE mobility information in the "ueMobs" attribute when subscribed event is "UE\_MOBILITY"; + - e) UE communication information in the "ueComms" attribute when subscribed event is "UE\_COMM"; + - f) abnormal behaviour information in the "abnorBehavrs" attribute when subscribed event is "ABNORMAL\_BEHAVIOUR"; + - g) user data congestion information in the "userDataCongInfos" attribute when subscribed event is "USER\_DATA\_CONGESTION"; + - h) QoS sustainability information in the "qosSustainInfos" attribute when subscribed event is "QOS\_SUSTAINABILITY"; + - i) NF load information in "nfLoadLevelInfos" attribute when subscribed event is "NF\_LOAD"; + - j) network performance information in the "nwPerfs" attribute when subscribed event is "NETWORK\_PERFORMANCE"; + - k) Load level information for the network slice(s) and the optionally associated network slice instance(s) in "nsiLoadLevelInfos" attribute when subscribed event is "NSI\_LOAD\_LEVEL"; + - l) Dispersion information in the "disperInfos" attribute when subscribed event is "DISPERSION"; + - m) Redundant transmission experience information in the "redTransInfos" attribute when subscribed event is "RED\_TRANS\_EXP"; + +- n) WLAN performance information in the "wlanInfos" attribute when subscribed event is "WLAN\_PERFORMANCE"; + - o) DN performance information in the "dnPerfInfos" attribute when subscribed event is "DN\_PERFORMANCE"; + - p) SMCC performance information in the "smccExps" attribute when subscribed event is "SM\_CONGESTION"; + - q) PFD Determination information for known application identifier(s) in the "pfdDetermInfos" attribute when subscribed event is "PFD\_DETERMINATION"; + - r) PDU Session traffic information in the "pduSesTrafInfos" attribute when subscribed event is "PDU\_SESSION\_TRAFFIC"; + - s) E2E data volume transfer time in the "dataVITrnsTmInfos" attribute when subscribed event is "E2E\_DATA\_VOL\_TRANS\_TIME"; + - t) Movement Behaviour information in the "movBehavInfos" attribute when subscribed event is "MOVEMENT\_BEHAVIOUR"; + - u) Location Accuracy information in the "locAccInfos" attribute when the subscribed event is "LOC\_ACCURACY"; and + - v) Relative Proximity information in the "relProxInfos" attribute when subscribed event is "RELATIVE\_PROXIMITY"; +- and may include: +- a) information about analytics metadata required for aggregation of the analytics in the "anaMetaInfo" attribute if the feature "Aggregation" is supported; + - b) the start time of which the analytics information will become valid in the "start" attribute, if the "EneNA" feature is supported; + - c) the expiration time after which the analytics information will become invalid in the "expiry" attribute. + - d) the analytics accuracy information in "accuInfo" attribute, if the feature "AnalyticsAccuracy" is supported and the analytics accuracy requirement was subscribed in the "accuReq" attribute. + - e) the pause analytics consumption indication in "pauseInd" attribute, if the feature "AnalyticsAccuracy" is supported. + - f) the resume analytics consumption indication in "resumeInd" attribute, if the feature "AnalyticsAccuracy" is supported. + +NOTE 1: In this version of the specification, the NWDAF containing AnLF can provide the accuracy information to an NF consumer that subscribes to the analytics. + +NOTE 2: When receiving a subscription from an NF service consumer that includes the request for accuracy information, the analytics and/or the accuracy information can be provided by NWDAF containing AnLF in one notification or via different notifications. + +NOTE 3: In this version of the specification, only subscribing or requesting accuracy information without requesting analytics is not supported. + +- If the "EneNA" feature is supported and the target NWDAF notifies a successful analytics subscription transfer, the old subscription ID which had been allocated by the source NWDAF within the "oldSubscriptionId" attribute and the resource URI of the Individual NWDAF Event Subscription resource created by the target NWDAF within "resourceUri" attribute, and if the "PartialAnalyticsSubTransfer" feature is supported and not all the analytics events in the subscription transfer are accepted, the successful transferred subscription event(s) within the "transEvents" attribute; and + - an event subscription Id as "subscriptionId" attribute; +- and may include: +- a) the notification correlation identifier in the "notifCorrId" attribute, if the "EneNA" feature is supported. + - b) a cause for termination in the "termCause" attribute, if the "TermRequest" feature is supported and the NWDAF wants to request the termination of this subscription, i.e. to indicate that it will send no further notifications for it. + +If the feature "EneNA" is supported and the time when analytics information is needed has been provided (via the "timeAnaNeeded" attribute within the "extraReportReq" attribute) during the subscription for an event (via the "event" attribute within the EventSubscription data type), if the time when analytics information is needed is reached but the subscribed analytics information is not ready, the consumer does not need to wait for the analytics information any longer. In this case, the NWDAF may send an HTTP POST request as shown in step 1 of figure 4.2.2.4.2-1, which shall only provide (within the EventNotification data type in the NnwdafeventsSubscriptionNotification data type) an indication of the failure event via the "event" attribute and the corresponding failure reason via a "failNotifyCode" attribute, and may also provide a minimum time interval recommended by the NWDAF for the event via a + +"rvWaitTime" attribute which will be used by the NF service consumer to determine the time when analytics information is needed in similar future analytics subscriptions. + +Upon the reception of an HTTP POST request with: "{notificationURI}" as Resource URI and NnwdafEventsSubscriptionNotification 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; and +- 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.1.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 [6]. + +#### 4.2.2.5 Nnwdaf\_EventsSubscription\_Transfer service operation + +##### 4.2.2.5.1 General + +The Nnwdaf\_EventsSubscription\_Transfer service operation is used by an NWDAF instance to request the transfer of analytics subscription(s) to another NWDAF instance. If the source NWDAF discovers that the analytics consumer may change concurrently to this procedure, the source NWDAF should not perform the procedure. In such a case, the source NWDAF may send a message to indicate to the analytics consumer that it will not serve this subscription anymore. + +NOTE 1: To discover the possible change of analytics consumer, if the Analytics ID is UE related, the source NWDAF takes actions responding to external trigger (such as UE mobility), for example, checking if the Target of Analytics Reporting is still within the serving area of the analytics consumer, if the serving area information of the consumer is available. + +NOTE 2: Handling of overload situation or preparation for a graceful shutdown are preferably executed inside an NWDAF Set, when available, therefore, not requiring an analytics subscription transfer as described in this clause. + +##### 4.2.2.5.2 Creation of request for analytics subscription transfer + +Figure 4.2.2.5.2-1 shows a scenario where the NF Service Consumer (e.g. NWDAF) sends a request to the NWDAF to request the transfer of analytics subscription(s) from the NF Service Consumer to the NF Service Producer (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the NF service consumer sending a POST request to the NWDAF for analytics subscription transfer.](1878426572e3fcbc4483578a685d7c7d_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant NWDAF as NWDAF + Note right of NF: 1. POST « transfers + NF->>NWDAF: Request + Note left of NWDAF: 2a. "201 Created" OR +2b. "204 No Content" + NWDAF-->>NF: Response +``` + +The diagram illustrates a sequence of interactions between an 'NF service consumer' and an 'NWDAF'. The 'NF service consumer' sends a message labeled '1. POST « transfers' to the 'NWDAF'. The 'NWDAF' responds with two possible options: '2a. "201 Created" OR' and '2b. "204 No Content"'. The arrows indicate the direction of the messages: a solid arrow from the consumer to the NWDAF, and a dashed arrow from the NWDAF back to the consumer. + +Sequence diagram showing the NF service consumer sending a POST request to the NWDAF for analytics subscription transfer. + +**Figure 4.2.2.5.2-1: NF service consumer requests an analytics subscription transfer** + +The NF service consumer shall invoke the Nnwdaf\_EventsSubscription\_Transfer service operation to request the transfer of analytics subscription(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwdaf-eventssubscription//transfers" as Resource URI representing the "NWDAF Event Subscription Transfers", as shown in figure 4.2.2.5.2-1, step 1, to create a request for an "Individual NWDAF Event + +Subscription Transfer" according to the information in the message body. The AnalyticsSubscriptionsTransfer data structure provided in the request body shall include: + +- information about the subscription(s) transfer request as "subsTransInfos" attribute, which, for each subscription that is requested to be transferred, shall include: + - a) the type of the transfer request (i.e. if it is a request for transfer preparation or transfer execution) in the "transReqType" attribute; + - b) information about the analytics subscription in the "nwdaEvSub" attribute, its contents being as defined for the NnwdaEventsSubscription data structure in clause 4.2.2.2.2; and + - c) the NF instance identifier of the consumer of the analytics subscription in the "consumerId" attribute; and may include: + - a) analytics context identifier information about the context that is available at the NF service consumer in the "contextId" attribute; + - b) NF instance identifier(s) of active data source(s) the NF service consumer is currently using for the analytics of this analytics subscription in the "sourceNfIds" attribute; + - c) NF set identifier(s) of active data source(s) the NF service consumer is currently using for the analytics of this analytics subscription in the "sourceSetIds" attribute; + - d) information identifying the ML model(s) that the NF service consumer is currently using for the analytics in the "modelInfos" attribute. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nnwdaf-eventssubscription//transfers" as Resource URI and AnalyticsSubscriptionsTransfer data structure as request body, in the successful case the NWDAF shall: + +- if the "transReqType" attribute has the value PREPARE, perform the steps required for the preparation of an analytics subscription transfer as described in clause 5.4.3 of TS 29.552 [25], create a new Individual NWDAF Event Subscription Transfer resource and send an HTTP "201 Created" response with the URI for the created resource in the "Location" header field, as shown in figure 4.2.2.5.2-1, step 2a; If the "PartialAnalyticsSubTransfer" feature is supported and not all the analytics events in the subscription transfer are accepted, then the NWDAF includes the "failTransEventReports" attribute indicating the failure event(s). +- if the "transReqType" attribute has the value TRANSFER, perform the steps required for the execution of an analytics subscription transfer as described in clause 5.4.2 of TS 29.552 [25], + - a) if the "PartialAnalyticsSubTransfer" feature is not supported, or if the "PartialAnalyticsSubTransfer" feature is supported and all the analytics events in the subscription transfer are accepted, send an HTTP "204 No Content" response, as shown in figure 4.2.2.5.2-1, step 2b; + - b) if the "PartialAnalyticsSubTransfer" feature is supported and not all the analytics events in the subscription transfer are accepted, the NWDAF creates a new Individual NWDAF Event Subscription Transfer resource and sends an HTTP "201 Created" response with the URI for the created resource in the "Location" header field, as shown in figure 4.2.2.5.2-1, step 2a. The NWDAF includes the "failTransEventReports" attribute indicating the failure event(s), and then removes the Individual NWDAF Event Subscription Transfer resource. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.1.7. + +#### 4.2.2.5.3 Update a request for analytics subscription transfer + +Figure 4.2.2.5.3-1 shows a scenario where the NF Service Consumer (e.g. NWDAF) sends a request to the NWDAF to update a request for the transfer of analytics subscription(s) from the NF Service Consumer to the NF Service Producer (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The consumer sends a PUT request to /transfers/{transferId} (step 1). The NWDAF responds with either a 204 No Content (step 2a) or a 200 OK (step 2b).](187d05bf7ead21e1394b61320d8b3632_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. PUT « /transfers/{transferId} » + NF service consumer->>NWDAF: Request + Note left of NWDAF: 2a. "204 No Content" or +2b. "200 OK" + NWDAF-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The consumer sends a PUT request to /transfers/{transferId} (step 1). The NWDAF responds with either a 204 No Content (step 2a) or a 200 OK (step 2b). + +**Figure 4.2.2.5.3-1: NF service consumer updates a request for an analytics subscription transfer** + +The NF service consumer shall invoke the Nnwdaf\_EventsSubscription\_Transfer service operation to update a request for the transfer of analytics subscription(s). The NF service consumer shall send an HTTP PUT request with "{apiRoot}/nnwdaf-eventssubscription//transfers/{transferId}" as Resource URI representing the "Individual NWDAF Event Subscription Transfer", as shown in figure 4.2.2.5.3-1, step 1, to update the "Individual NWDAF Event Subscription Transfer" resource identified by the {transferId}. The AnalyticsSubscriptionsTransfer data structure provided in the request body shall include the same contents as described in clause 4.2.2.5.2. + +Upon the reception of an HTTP PUT request with: + +"{apiRoot}/nnwdaf-eventssubscription//transfers/{transferId}" as Resource URI and AnalyticsSubscriptionsTransfer data structure as request body, the NWDAF shall: + +- if the "transReqType" attribute has the value PREPARE, perform the steps required for the preparation of an analytics subscription transfer as described in clause 5.4.3 of TS 29.552 [25], update the Individual NWDAF Event Subscription Transfer resource identified by "transferId", + - a) if the "PartialAnalyticsSubTransfer" feature is not supported, or if the "PartialAnalyticsSubTransfer" feature is supported and all the analytics events in the subscription transfer are accepted, send an HTTP "204 No Content" response, as shown in figure 4.2.2.5.3-1, step 2a; + - b) if the "PartialAnalyticsSubTransfer" feature is supported and and not all the analytics events in the subscription transfer are accepted, send an HTTP "200 OK" response with the message body containing a representation of the updated subscription transfer, as shown in figure 4.2.2.5.3-1, step 2b, and the NWDAF includes the "failTransEventReports" attribute indicating the failure event(s). +- if the "transReqType" attribute has the value TRANSFER, perform the steps required for the execution of an analytics subscription transfer as described in clause 5.4.3 of TS 29.552 [25], + - a) if the "PartialAnalyticsSubTransfer" feature is not supported, or if the "PartialAnalyticsSubTransfer" feature is supported and all the analytics events in the subscription transfer are accepted, remove the Individual NWDAF Event Subscription Transfer resource identified by "transferId", and send an HTTP "204 No Content" response, as shown in figure 4.2.2.5.3-1, step 2a; + - b) if the "PartialAnalyticsSubTransfer" feature is supported and and not all the analytics events in the subscription transfer are accepted, update the Individual NWDAF Event Subscription Transfer resource identified by "transferId", and send an HTTP "200 OK" response with the message body containing a representation of the updated subscription transfer, as shown in figure 4.2.2.5.3-1, step 2b. The NWDAF includes the "failTransEventReports" attribute indicating the failure event(s), and then removes the Individual NWDAF Event Subscription Transfer resource. + +If errors occur when processing the HTTP PUT request, the NWDAF shall send an HTTP error response as specified in clause 5.1.7. + +If the NWDAF determines the received HTTP PUT request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.2.2.5.4 Cancel a request for analytics subscription transfer + +Figure 4.2.2.5.4-1 shows a scenario where the NF service consumer (e.g. NWDAF) sends a request to the NWDAF to cancel a request for the transfer of analytics subscription(s) from the NF service consumer to the NF Service Producer (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the cancellation of an analytics subscription transfer. The NF service consumer sends a DELETE request for transfers/{transferId} to the NWDAF, which responds with 204 No Content.](aeb2a26a07219661191294dba528067a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. DELETE « transfers/{transferId} » + NF service consumer->>NWDAF: 1. DELETE « transfers/{transferId} » + Note left of NWDAF: 2. "204 No Content" + NWDAF-->>NF service consumer: 2. "204 No Content" +``` + +Sequence diagram showing the cancellation of an analytics subscription transfer. The NF service consumer sends a DELETE request for transfers/{transferId} to the NWDAF, which responds with 204 No Content. + +**Figure 4.2.2.5.4-1: NF service consumer cancels a request for an analytics subscription transfer** + +The NF service consumer shall invoke the Nnwdaf\_EventsSubscription\_Transfer service operation to cancel a request for the transfer of analytics subscription(s). The NF service consumer shall send an HTTP DELETE request with "{apiRoot}/nnwdaf-eventssubscription//transfers/{transferId}" as Resource URI representing the "Individual NWDAF Event Subscription Transfer", as shown in figure 4.2.2.5.4-1, step 1, to cancel the "Individual NWDAF Event Subscription Transfer" resource identified by the {transferId}. + +Upon the reception of an HTTP DELETE request with: + +"{apiRoot}/nnwdaf-eventssubscription//transfers/{transferId}" as Resource URI, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- if applicable, delete any analytics data that is no longer needed and unsubscribe to entities for data collection or ML model acquisition, if the subscriptions are not needed for other active analytics subscriptions; +- remove the corresponding Individual NWDAF Event Subscription Transfer resource; and +- respond with HTTP "204 No Content" status code, as shown in figure 4.2.2.5.4-1, step 2. + +If errors occur when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.1.7. + +If the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +### 4.3 Nnwdaf\_AnalyticsInfo Service + +#### 4.3.1 Service Description + +##### 4.3.1.1 Overview + +The Nnwdaf\_AnalyticsInfo service as defined in 3GPP TS 23.501 [2], 3GPP TS 23.288 [17] and 3GPP TS 23.503 [4], is provided by the Network Data Analytics Function (NWDAF). + +This service: + +- allows NF service consumers to request and get different type of analytic event information; and +- allows NF service consumers to request and get context information related to analytics subscriptions. + +The types of observed events include: + +- Slice load level information; + +- Network slice instance load level information; +- Service experience; +- NF load; +- Network performance; +- Abnormal behaviour; +- UE mobility; +- UE communication; +- User data congestion; +- QoS sustainability; +- SM congestion control experience; +- Dispersion; +- Redundant transmission experience; +- WLAN performance; +- DN performance; +- PFD determination; +- PDU Session traffic; +- Movement Behaviour; +- Location Accuracy; and +- Relative Proximity. + +#### 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 [17]. The Network Data Analytics signalling flows are defined in 3GPP TS 29.552 [25], the Policy and Charging related 5G architecture is also described in 3GPP TS 23.503 [4] and 3GPP TS 29.513 [5]. + +The Nnwdaf\_AnalyticsInfo service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF). + +Known consumers of the Nnwdaf\_AnalyticsInfo service are: + +- Policy Control Function (PCF) +- Network Slice Selection Function (NSSF) +- Access and Mobility Management Function (AMF) +- Session Management Function (SMF) +- Network Exposure Function (NEF) or Network Exposure Function (Packet Flow Description Function) (NEF (PFDF)) +- Application Function (AF) +- Location Management Function (LMF) +- Operation, Administration, and Maintenance (OAM) +- Network Data Analytics Function (NWDAF) +- Data Collection Coordination Function (DCCF) + +The PCF accesses the Nnwdaf\_AnalyticsInfo service at the NWDAF via the N23 Reference point. The NSSF accesses the Nnwdaf\_AnalyticsInfo service at the NWDAF via the N34 Reference point. + +![Reference Architecture for the Nnwdaf_AnalyticsInfo Service; SBI representation diagram](c3e8a7fe2e4f51806e05b9b1aae20d57_img.jpg) + +The diagram illustrates the Service Based Interface (SBI) representation for the Nnwdaf\_AnalyticsInfo service. At the top, a box labeled 'NWDAF' contains an oval labeled 'Nnwdaf'. Below this, a horizontal line represents the service interface, with the label 'Nnwdaf\_AnalyticsInfo' positioned above it. Below the interface line, ten boxes are arranged horizontally, representing the network functions that consume the service: PCF, NSSF, AMF, SMF, NEF, DCCF, AF, OAM, LMF, and NWDAF. Each of these boxes is connected to the horizontal interface line by a vertical line. + +Reference Architecture for the Nnwdaf\_AnalyticsInfo Service; SBI representation diagram + +**Figure 4.3.1.2-1: Reference Architecture for the Nnwdaf\_AnalyticsInfo Service; SBI representation** + +![Figure 4.3.1.2-2: Reference Architecture for the Nnwdaf_AnalyticsInfo Service: reference point representation. The diagram shows a central NWDAF box at the top connected to ten boxes below it. The connections are labeled N23 (to PCF) and N34 (to NSSF). The other connections are to AMF, SMF, NEF, DCCF, AF, OAM, LMF, and NWDAF.](0a73b03fba21af142d619a9a662e6490_img.jpg) + +``` + +graph TD + NWDAF_top[NWDAF] -- N23 --> PCF[PCF] + NWDAF_top -- N34 --> NSSF[NSSF] + NWDAF_top --> AMF[AMF] + NWDAF_top --> SMF[SMF] + NWDAF_top --> NEF[NEF] + NWDAF_top --> DCCF[DCCF] + NWDAF_top --> AF[AF] + NWDAF_top --> OAM[OAM] + NWDAF_top --> LMF[LMF] + NWDAF_top --> NWDAF_bottom[NWDAF] + +``` + +Figure 4.3.1.2-2: Reference Architecture for the Nnwdaf\_AnalyticsInfo Service: reference point representation. The diagram shows a central NWDAF box at the top connected to ten boxes below it. The connections are labeled N23 (to PCF) and N34 (to NSSF). The other connections are to AMF, SMF, NEF, DCCF, AF, OAM, LMF, and NWDAF. + +**Figure 4.3.1.2-2: Reference Architecture for the Nnwdaf\_AnalyticsInfo Service: reference point representation** + +NOTE: When the NEF subscribes the PFD Determination Analytics to the NWDAF, the NEF needs to support PFDF function as NEF (PFDF). + +### 4.3.1.3 Network Functions + +#### 4.3.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF) provides specific analytics information for different analytic events and, if the "AnaCtxTransfer" feature is supported, context information related to analytics subscriptions to NF service consumers. + +#### 4.3.1.3.2 NF Service Consumers + +The Policy Control Function (PCF): + +- supports taking analytics information for slice load level information from the NWDAF; +- supports taking analytics information for service experience related network data from the NWDAF; +- supports taking analytics information for network performance from the NWDAF; +- supports taking analytics information for abnormal UE behaviour from the NWDAF; +- supports taking analytics information for UE mobility from the NWDAF; +- supports taking analytics information for UE communication from the NWDAF; +- supports taking analytics information for user data congestion from the NWDAF. +- supports taking analytics information for dispersion from the NWDAF; +- supports taking analytics information for session management congestion control experience from the NWDAF; +- supports taking analytics information for redundant transmission experience from the NWDAF; +- supports taking analytics information for DN performance from the NWDAF; +- supports taking analytics information for WLAN performance from the NWDAF; +- supports taking one or more above input from NWDAF into consideration for policies on assignment of network resources and/or for traffic steering policies; and +- supports taking analytics information for PDU Session traffic from the NWDAF. + +NOTE: How this information is used by the PCF is not standardized in this specification. + +The Network Slice Selection Function (NSSF): + +- supports taking slice load level information or network slice instance load level information from the NWDAF into consideration for slice selection; +- supports taking analytics information for service experience related network data from the NWDAF; and +- supports taking analytics information for dispersion at the slice from the NWDAF. + +The Access and Mobility Management Function (AMF): + +- supports taking SMF load information from the NWDAF into consideration for SMF selection; +- supports taking expected UE behaviour information (UE mobility and/or UE communication) from the NWDAF into consideration for monitoring UE behaviour; +- supports taking abnormal UE behaviour information from the NWDAF into consideration for adjustment of UE mobility related network parameters to solve the abnormal risk; +- supports taking slice load level information or network slice instance load level information from NWDAF into consideration for slice selection; +- supports taking analytics information for service experience related network data from the NWDAF; and + +- supports taking analytics information for dispersion at the slice from the NWDAF. + +The Session Management Function (SMF): + +- supports taking UPF load information from the NWDAF into consideration for UPF selection; +- supports taking expected UE behaviour information (UE mobility and/or UE communication) from the NWDAF into consideration for monitoring UE behaviour; +- supports taking UE mobility information from the NWDAF into consideration for UPF selection; +- supports taking abnormal UE behaviour information from the NWDAF into consideration for adjustment of UE mobility related network parameters to solve the abnormal risk; +- supports taking analytics information for SM congestion control experience from the NWDAF into consideration for determining back-off timer provided to UE; +- supports taking analytics information for slice load level or network slice instance load level from the NWDAF into consideration to determine slice selection; +- supports taking analytics information for service experience from the NWDAF into consideration to (re)select UP paths; +- supports taking analytics information for redundant transmission experience from the NWDAF to consider whether redundant transmission shall be performed, or (if it had been activated) shall be stopped; and +- supports taking analytics information for DN performance from the NWDAF into consideration for user plane performance. + +The Network Exposure Function (NEF): + +- supports taking analytics information for UE mobility from the NWDAF; +- supports taking analytics information for UE communication from the NWDAF; +- supports taking analytics information for expected UE behavioural (UE mobility and/or UE communication) from the NWDAF; +- supports taking analytics information for abnormal behaviour from the NWDAF; +- supports taking analytics information for user data congestion from the NWDAF; +- supports taking analytics information for network performance from the NWDAF; +- supports taking analytics information for QoS Sustainability from the NWDAF; +- supports taking analytics information for Dispersion from the NWDAF; +- supports taking analytics information for DN performance from the NWDAF; +- supports taking analytics information for Observed Service Experience from NWDAF; +- supports taking the analytics information for NWDAF assisted PFD Determination from the NWDAF when support PFDF function as the Network Exposure Function (Packet Flow Description Function) (NEF (PFDF)); +- supports taking analytics information for E2E data volume transfer time from NWDAF; +- supports taking analytics information for Relative Proximity from NWDAF; and +- supports taking analytics information for movement behaviour from NWDAF. + +The Application Function (AF): + +- supports receiving UE mobility information from the NWDAF or via the NEF; +- supports receiving UE communication information from the NWDAF or via the NEF; +- supports receiving expected UE behavioural information (UE mobility and/or UE communication) from the NWDAF or via the NEF; +- supports receiving abnormal behaviour information from the NWDAF or via the NEF; +- supports receiving user data congestion information from the NWDAF or via the NEF; +- supports receiving network performance information from the NWDAF or via the NEF; +- supports receiving QoS Sustainability information from the NWDAF or via the NEF; +- supports receiving Dispersion information from the NWDAF or via the NEF; +- supports receiving DN performance information from NWDAF or via the NEF; +- supports receiving Observed Service Experience information from NWDAF or via the NEF; +- supports receiving E2E data volume transfer time from NWDAF or via the NEF. +- supports receiving Movement Behaviour information from NWDAF or via the NEF. and +- supports receiving Relative Proximity information from NWDAF or via the NEF. + +The Location Management Function (LMF): + +- supports taking Location Accuracy analytics from the NWDAF into consideration as assistance for location services. + +The Operation, Administration, and Maintenance (OAM): + +- supports receiving slice load level information from the NWDAF; +- supports receiving observed service experience from the NWDAF; +- supports receiving NF load information from the NWDAF; +- supports receiving network performance information from the NWDAF; +- supports receiving UE mobility information from the NWDAF; +- supports receiving UE communication information from the NWDAF; +- supports receiving expected UE behaviour information (UE mobility and/or UE communication) from the NWDAF; and +- supports receiving abnormal UE behaviour information from the NWDAF. + +The Network Data Analytics Function (NWDAF): + +- supports receiving information for all types of network data analytics from the NWDAF; and +- supports receiving context information related to analytics subscriptions from the NWDAF. + +The Data Collection Coordination Function (DCCF): + +- supports receiving information for all types of network data analytics from the NWDAF. + +## 4.3.2 Service Operations + +### 4.3.2.1 Introduction + +**Table 4.3.2.1-1: Operations of the Nnwdaf\_AnalyticsInfo Service** + +| Service operation name | Description | Initiated by | +|--------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------| +| Nnwdaf_AnalyticsInfo_Request | This service operation is used by an NF to request and get specific analytics from NWDAF. | NF consumer (PCF, NSSF, AMF, SMF, NEF or NEF (PFDF), AF, LMF, OAM, NWDAF, DCCF) | +| Nnwdaf_AnalyticsInfo_ContextTransfer | This service operation is used by an NF to request and get context information related to analytics subscriptions from NWDAF. | NF consumer (NWDAF) | + +### 4.3.2.2 Nnwdaf\_AnalyticsInfo\_Request service operation + +#### 4.3.2.2.1 General + +The Nnwdaf\_AnalyticsInfo\_Request service operation is used by an NF service consumer to request and get specific analytics information from the NWDAF. + +#### 4.3.2.2.2 Request and get from NWDAF Analytics information + +Figure 4.3.2.2.2-1 shows a scenario where the NF service consumer (e.g. PCF) sends a request to the NWDAF to request and get from the NWDAF analytics information (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and the NWDAF. The consumer sends a GET request with analytics query parameters. The NWDAF responds with either a 200 OK or No Content.](b816e7bb064d3bfa02761aa679eb3726_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: Request analytics information + NF service consumer->>NWDAF: 1. GET « analytics?query_parameters » + Note right of NWDAF: Processing request + NWDAF-->>NF service consumer: 2a. 200 OK or 2b. No Content + +``` + +Sequence diagram showing the interaction between an NF service consumer and the NWDAF. The consumer sends a GET request with analytics query parameters. The NWDAF responds with either a 200 OK or No Content. + +**Figure 4.3.2.2.2-1: Requesting a NWDAF Analytics information** + +The NF service consumer (e.g. PCF) shall invoke the Nnwdaf\_AnalyticsInfo\_Request service operation when requesting the NWDAF analytics information. The NF service consumer shall send an HTTP GET request on the resource URI "{apiRoot}/nnwdaf-analyticsinfo//analytics" representing the "NWDAF Analytics" (as shown in figure 4.3.2.2.2-1, step 1), to request analytics data according to the query parameter value of the "event-id" attribute. In addition, the following information may be provided: + +- common reporting requirement in the "ana-req" attribute as follows: + - 1) identification of time window for the requested analytics data applies via identification of date-time(s) in the "startTs" and "endTs" attributes; + - 2) preferred level of accuracy of the analytics in "accuracy" attribute; + - 3) percentage of sampling among impacted UEs in the "sampRatio" attribute; + - 4) maximum number of objects in the "maxObjectNbr" attribute; + - 5) maximum number of SUPIs expected for an analytics report in the "maxSupiNbr" attribute; + - 6) identification of time when analytics information is needed in the "timeAnaNeeded" attribute if the feature "EneNA" is supported; + - 7) indication of which analytics metadata is requested to be delivered with the response in the "anaMeta" attribute if the feature "Aggregation" is supported; + - 8) requested values for the analytics metadata information to be used for the generation of the analytics in the "anaMetaInd" attribute if the feature "Aggregation" is supported; + - 9) preferred accuracy level per analytics subset in the "accPerSubset" attribute if the "listOfAnaSubsets" attribute is present and the EneNA feature is supported; and/or + - 10) the time period of historical analytics in the "histAnaTimePeriod" attribute if the "EneNA" feature is supported; + +NOTE 1: The NWDAF can use the use case context to select the most relevant ML model, when several ML models are available for the requested Analytics ID(s). The NWDAF containing AnLF can additionally provide the use case context when requesting an ML model from an NWDAF containing MTLF. The values of this parameter are not standardized. + +For all the event types, the "event-filter" attribute may include: + +- the analytics accuracy requirement information in "accuReq" attribute as indication to the NWDAF to activate checking the analytics accuracy information of the requested event, if the "AnalyticsAccuracy" feature is supported and the NF service consumer discovered or local configured the NWDAF containing an AnLF supporting the accuracy checking capability. +- use case context as "useCaseCxt" attribute, if the "ENAEExt" feature is supported. +- information related to roaming within the "roamingInfo" attribute if the "RoamingAnalytics" feature is supported; + +NOTE 2: The request for analytics accuracy information independently from request of the analytics event output is not supported in this release. + +For different event types: + +- if the event is "LOAD\_LEVEL\_INFORMATION", it shall provide the event specific filter information within "event-filter" attribute including identification(s) of the network slice via: + - 1) identification of network slice(s) in the "snssais" attribute; or + - 2) any slices indication in the "anySlice" attribute; +- if the feature "NsiLoad" is supported and the event is "NSI\_LOAD\_LEVEL", it shall provide the event specific filter information within "event-filter" attribute including identification(s) of the network slice via: + - 1) identification of network slice(s) and the optionally associated instance(s) if available, in the "nsiIdInfos" attribute; or + +NOTE 3: The network slice instance of a PDU session is not available in the PCF. + +- 2) any slices indication in the "anySlice" attribute; + +and may include: + +- 1) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "NSI\_LOAD\_LEVEL" event, if the "EneNA" feature is supported; + - 2) event specific filter information in the "event-filter" attribute: + - a) list of NF instance types in the "nfTypes" attribute, if the "NsiLoadExt" feature is supported; and/or + - b) identification of network area to which the request applies via identification of network area by "networkArea" attribute, if the "NsiLoadExt" feature is supported. +- if the feature "NfLoad" is supported and the event is "NF\_LOAD", it shall provide: +- 1) identification of target UE(s) to which the request applies by "supis" or "anyUe" in the "tgt-ue" attribute; and +- NOTE 4: Only NF instances of type AMF and SMF which are serving the UE can be determined using a SUPI in "supis" attribute. +- NOTE 5: If a list of the NF Instance IDs (or respectively of NF Set IDs) is provided, the NWDAF needs to provide the analytics for each designated NF instance (or respectively for each NF instance belonging to each designated NF Set). In such case the target UE(s) of the Analytics Reporting need be ignored. +- the "event-filter" attribute may provide: +- a) either list of NF instance IDs in the "nfInstanceIds" attribute or list of NF set IDs in the "nfSetIds" attribute if the identification of target UE(s) applies to all UEs; + - b) list of NF instance types in the "nfTypes" attribute; + - c) identification of network slice(s) in the "snssais" attribute; + - d) optional area of interest by "networkArea" attribute; and/or + - e) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to NF\_LOAD event, if the "EneNA" feature is supported; +- if the feature "UeMobility" is supported and the event is "UE\_MOBILITY", it shall provide: +- 1) identification of target UE(s) to which the request applies by "supis" or "intGroupIds" attribute in the "tgt-ue" attribute; +- and may include: +- a) identification of network area to which the request applies via identification of network area by "networkArea" attribute; + - b) if the feature "UeMobilityExt" is supported, + - i) identification of LADN DNN in the "ladnDnns" attribute; + - ii) visited Area(s) of Interest as the "visitedAreas" attribute; + - c) other UE mobility requirements in "ueMobilityReqs" attribute, if the "UeMobilityExt2\_eNA" feature is supported; + - d) preferred granularity of location information as the "locGranularity" attribute if the feature "UeMobilityExt2\_eNA" is also supported; + - e) identification of the preferred orientation of location information by "locOrientation" attribute if the feature "UeMobilityExt2\_eNA" is supported + - f) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "UE\_MOBILITY" event, if the "UeMobilityExt2\_eNA" and "EneNA" features are supported; + - g) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "UeMobilityExt2\_eNA" feature is supported; + - h) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "UeMobilityExt2\_eNA" feature is supported; + - i) the temporal granularity size in the "temporalGranSize" attribute if the "UeMobilityExt2\_eNA" feature is supported; and/or + - j) the fine granularity areas as the "fineGranAreas" attribute if the feature "UeMobilityExt2\_eNA" is supported. +- NOTE 6: For LADN service, the consumer (e.g. SMF) provides the LADN DNN to refer the LADN service area as the AOI. +- if the feature "UeCommunication" is supported and the event is "UE\_COMM", it shall provide: + +- 1) identification of target UE(s) to which the request applies by "supis" or "intGroupIds" attribute in the "tgt-ue" attribute; + +and may include: + +- 1) event specific filter information in the "event-filter" attribute: + - a) identification of the application as "appIds" attribute; + - b) identification of network area to which the request applies via identification of network area by "networkArea" attribute; + - c) identification of DNN in the "dnns" attribute; + - d) identification of network slice(s) in the "snssais" attribute; + - e) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "UE\_COMM" event, if the "EneNA" feature is supported; + - f) other UE communication requirements in "ueCommReqs" attribute, if the "UeCommunicationExt\_eNA" feature is supported; and/or + - g) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "UeCommunicationExt\_eNA" feature is supported. + - h) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "UeCommunicationExt\_eNA" feature is supported. +- if the feature "NetworkPerformance" is supported and the event is "NETWORK\_PERFORMANCE", it shall provide: + - 1) identification of target UE(s) to which the request applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgt-ue" attribute; + - 2) event specific filter information in the "event-filter" attribute which shall provide: + - a) the network performance types via "nwPerfTypes" attribute; + - b) the network performance requirements via "nwPerfReqs" attribute, if the feature "NetworkPerformanceExt\_eNA" is supported; + +the "event-filter" attribute may provide: + +- a) identification of network area to which the request applies via identification of network area(s) by "networkArea" attribute (mandatory if "anyUe" attribute is set to true); + - b) for each network performance type identified by "nwPerfTypes" attribute, the additional requirement by "addNwPerfReqs" attribute if the "NetworkPerformanceExt\_AIML" feature is supported; and/or + - c) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "DnPerfExt\_eNA" feature is supported; + - d) the spatial granularity size of TA in the "spatialGranSizeCell" attribute if the "DnPerfExt\_eNA" feature is supported; and/or +- e) the temporal granularity size of cell in the "temporalGranSize" attribute if the "DnPerfExt\_eNA" feature is supported.- if the feature "ServiceExperience" is supported and the event is "SERVICE\_EXPERIENCE", it shall provide: + - 1) identification of target UE(s) to which the request applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgt-ue" attribute; + - 2) event specific filter information in the "event-filter" attribute which shall provide: + - a) any slices indication in the "anySlice" attribute or identification of network slice(s) together with the optionally associated network slice instance(s) if available, via the "nsiIdInfos" attribute; and + +NOTE 7: The network slice instance of a PDU session is not available in the PCF. + +the "event-filter" attribute may provide: + +- a) identification of application(s) to which the request applies via "appIds" attribute; +- b) identification of DNN via identification of Dnn(s) by "dnns" attribute; +- c) identification of user plane accesses to one or more DN(s) where applications are deployed via "dnais" attribute; +- d) identification of network area to which the request applies via identification of network area(s) by "networkArea" attribute (mandatory if "anyUe" attribute is set to true); + +- e) if "appIds" attribute is provided, the bandwidth requirement of each application by "bwRequs" attribute; + - f) identification of all the RAT types and/or all the frequencies that the NWDAF received for the application or specific RAT type(s) and/or frequency(ies) by "ratFreqs" attribute if the feature "ServiceExperienceExt" is also supported; + - g) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "SERVICE\_EXPERIENCE" event, if the "EneNA" feature is supported; + - h) the identification of the UPF as the "upfInfo" attribute if the feature "ServiceExperienceExt" is also supported; + - i) IP address(s)/FQDN(s) of the Application Server(s) as the "appServerAddrs" attribute if the feature "ServiceExperienceExt" is also supported; + - j) combination of PDU Session parameters as the "pduSesInfos" attribute if the feature "ServiceExperienceExt2\_eNA" is also supported; + - k) preferred granularity of location information as the "locGranularity" attribute if the feature "ServiceExperienceExt2\_eNA" is supported; and/or + - l) the fine granularity areas as the "fineGranAreas" attribute if the feature "ServiceExperienceExt2\_eNA" is supported. +- if the feature "QoSustainability" is supported and the event is "QOS\_SUSTAINABILITY", it shall provide: +- 1) event specific filter information in the "event-filter" attribute which shall provide: + - a) identification of network area to which the request applies via identification of network area by "networkArea" attribute; and + - b) QoS requirements via "qosRequ" attribute; + - 2) identification of target UE(s) to which the request applies by "anyUe" in the "tgt-ue" attribute; +- the "event-filter" attribute may provide: +- a) identification of network slice(s) by "snssais" attribute; + - b) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "QoSustainExt\_eNA" feature is supported; + - c) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "QoSustainExt\_eNA" feature is supported; + - d) the temporal granularity size in the "temporalGranSize" attribute if the "QoSustainExt\_eNA" feature is supported; + - e) the fine granularity areas as the "fineGranAreas" attribute if the feature "QoSustainExt\_eNA" is supported. +- if the feature "AbnormalBehaviour" is supported and the event is "ABNORMAL\_BEHAVIOUR", it shall provide: +- 1) identification of target UE(s) to which the request applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgt-ue" attribute; and + - 2) event specific filter information in the "event-filter" attribute which shall provide + - a) either the expected analytics type via "exptAnaType" attribute or a list of exception Ids via "excepIds" attribute. If the expected analytics type via "exptAnaType" attribute is provided, the NWDAF shall derive the corresponding Exception Ids from the received expected analytics type as follows: + - if "exptAnaType" attribute sets to "MOBILITY", the corresponding list of Exception Ids are "UNEXPECTED\_UE\_LOCATION", "PING\_PONG\_ACROSS\_CELLS", "UNEXPECTED\_WAKEUP" and "UNEXPECTED\_RADIO\_LINK\_FAILURES"; + - if "exptAnaType" attribute sets to "COMMUN", the corresponding list of Exception Ids are "UNEXPECTED\_LONG\_LIVE\_FLOW", "UNEXPECTED\_LARGE\_RATE\_FLOW", "SUSPICION\_OF\_DDOS\_ATTACK", "WRONG\_DESTINATION\_ADDRESS" and "TOO\_FREQUENT\_SERVICE\_ACCESS"; + - if "exptAnaType" attribute sets to "MOBILITY\_AND\_COMMUN", the corresponding list of Exception Ids includes all above derived exception Ids. + +The derived list of Exception Ids are used by the NWDAF to notify the NF service consumer when UE's behaviour is exceptional based on one or more Exception Ids within the list. + +If the "anyUe" attribute in the "tgt-ue" attribute sets to "true": + +- a) the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepIds" attribute shall not be requested for both mobility and communication related analytics at the same time; +- b) if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepIds" attribute is mobility related, at least one of identification of network area by "networkArea" attribute and identification of network slice(s) by "snssais" attribute should be provided; and +- c) if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepIds" attribute is communication related, at least one of identification of network area by "networkArea" attribute, identification of application(s) by "appIds" attribute, identification of DNN(s) in the "dnns" attribute and identification of network slice(s) by "snssais" attribute should be provided; + +the "event-filter" attribute may provide: + +- a) expected UE behaviour via "exptUeBehav" attribute; +- if the feature "UserDataCongestion" is supported and the event is "USER\_DATA\_CONGESTION", it shall provide one of the following attributes: +- 1) identification of target UE(s) via "supis" "gpsi" (if feature "UserDataCongestionExt" is supported) or "anyUe" attribute within "tgt-ue" attribute; + - 2) event specific filter information in the "event-filter" attribute which shall provide: + - a) the user data congestion requirements via "userDataConReqs" attribute, if the feature "UserDataCongestionExt2\_eNA" is supported; + +and may provide: + +- 1) event specific filter information in the "event-filter" attribute which may provide: + - a) identification of network slice(s) by "snssais" attribute; + - b) identification of network area to which the request applies via identification of network area by "networkArea" attribute (mandatory if "anyUe" attribute is set to true); + - c) if the feature "UserDataCongestionExt" is also supported, request a list of top applications with maximum number that contribute the most to the traffic in uplink and/or downlink directions by the "maxTopAppUINbr" attribute and/or the "maxTopAppDINbr" attribute; and/or + - d) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "USER\_DATA\_CONGESTION" event, if the "EneNA" feature is supported; + - e) the temporal granularity size in the "temporalGranSize" attribute if the "UserDataCongestionExt2\_eNA" feature is supported. +- if the feature "SMCCE" is supported and the event is "SM\_CONGESTION", it shall provide: +- 1) event specific filter information in the "event-filter" attribute which shall provide: + - a) identification of DNN in the "dnns" attribute; and/or + - b) identification of network slice(s) in the "snssais" attribute; and + - 2) identification of target UE(s) via "supis" attribute in the "tgt-ue" attribute where the target UE(s) are one have the PDU Session for the DNN and/or S-NSSAI indicated by the event specific filter information; + +and may include: + +- 1) a list of analytics subsets carried by "listOfAnaSubsets" attribute with value(s) only applicable to "SM\_CONGESTION" event, if the "EneNA" feature is supported; + +NOTE 8: The predictions are not applicable for Session Management Congestion Control Experience analytics. + +- if the feature "Dispersion" is supported and the event is "DISPERSION", shall provide: + +- 1) identification of target UE(s) applies by "supis", "intGroupIds" or "anyUe" attribute within "tgt-ue" attribute, "anyUe" attribute is only supported in combination with "snssais" attribute, "networkArea" attribute and/or "disperClass" attribute; + +and may include: + +- 1) identification of network area applies via identification of network area by "networkArea" attribute; +- 2) identification of network slice(s) by "snssais" attribute; +- 3) application identifier(s) in "appIds" attribute; +- 4) dispersion analytics requirements in "disperReqs" attribute, which for the requested dispersion type may include dispersion class, ranking, ordering and/or accuracy requirements; +- 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "DISPERSION" event; +- 6) preferred granularity of location information as the "locGranularity" attribute if the feature "DispersionExt\_eNA" is supported; +- 7) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "DispersionExt\_eNA" feature is supported; +- 7) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "DispersionExt\_eNA" feature is supported; and/or +- 8) the temporal granularity size in the "temporalGranSize" attribute if the "DispersionExt\_eNA" feature is supported. + +- if the feature "RedundantTransmissionExp" is supported and the event is "RED\_TRANS\_EXP", shall provide: + +- 1) identification of target UE(s) applies by "supis", "intGroupIds" or "anyUe" attribute within "tgt-ue" attribute; + +and may include: + +- 1) identification of network area applies via identification of network area by "networkArea" attribute, if the "supis" attribute or "intGroupIds" attribute is included in the "tgt-ue" attribute; +- 2) identification of network slice(s) by "snssais" attribute; +- 3) identification of DNN in the "dnns" attribute; +- 4) other redundant transmission experience analysis requirements in "redTransReqs" attribute, which may include preferred order of results for the list of Redundant Transmission Experience; +- 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to RED\_TRANS\_EXP event, if the "EneNA" feature is supported; and/or +- 6) the temporal granularity size in the "temporalGranSize" attribute if the "RedundantTransExpExt\_eNA" feature is supported. + +- if the feature "WlanPerformance" is supported and the event is "WLAN\_PERFORMANCE", shall provide: + +- 1) identification of target UE(s) by "supis", "intGroupIds" or "anyUe" attribute in the "tgt-ue" attribute. If "anyUe" attribute is included in the "tgt-ue" attribute, then any of "networkArea" attribute, "ssIds" or "bssIds" attribute shall be present in the "wlanReqs" attribute; + +and may include: + +- 1) identification of network area to which the request applies via identification of network area by "networkArea" attribute; +- 2) other WLAN performance analytics requirements in "wlanReqs" attribute, which may include SSID(s), BSSID(s), preferred order of results for the list of WLAN performance information and/or accuracy per analytics subset; +- 3) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to WLAN\_PERFORMANCE event, if the "EneNA" feature is supported; and/or +- 4) the temporal granularity size in the "temporalGranSize" attribute if the "WlanPerfExt\_eNA" feature is supported. + +- if the feature "DnPerformance" is supported and the event is "DN\_PERFORMANCE", shall provide: + +- 1) identification of target UE(s) to which the request applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgt-ue" attribute; + +and may include: + +- 1) identification of network area to which the request applies via identification of network area by "networkArea" attribute; + +- 2) identification of network slice(s) in the "snssais" attribute; + - 3) identification of network slice and the optionally associated network slice instance(s) if available, via the "nsiIdInfos" attribute or any slices indication in the "anySlice" attribute; + - 4) application identifier(s) in "appIds" attribute; + - 5) an identification of DNN in the "dnns" attribute; + - 6) identification of a user plane access to one or more DN(s) where applications are deployed by "dnais" attribute; + - 7) the identification of the UPF as the "upfInfo" attribute; + - 8) IP address(s)/FQDN(s) of the Application Server(s) as the "appServerAddrs" attribute; + - 9) DN performance analytics requirements in "dnPerfReqs" attribute, which may include the preferred order of results for the list of DN performance information and/or the reporting threshold of each applicable analytics subset; and/or + - 10) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "DN\_PERFORMANCE" event, if the "EneNA" feature is supported and may include the attribute with value(s) only applicable to "DN\_PERFORMANCE" event and "DnPerformanceExt\_AIML" feature if supported. + - 11) the spatial granularity size of TA in the "spatialGranSizeTa" attribute if the "DnPerfExt\_eNA" feature is supported. + - 11) the spatial granularity size of cell in the "spatialGranSizeCell" attribute if the "DnPerfExt\_eNA" feature is supported. + - 12) the temporal granularity size in the "temporalGranSize" attribute if the "DnPerfExt\_eNA" feature is supported. +- if the feature "PfdDetermination" is supported and the event is "PFD\_DETERMINATION", shall provide: + - 1) a list of application identifier(s) in the "appIds" attribute. + +and may include: + + - 1) an identification of DNN in the "dnns" attribute; + - 2) identification of network slice(s) in the "snssais" attribute; + +NOTE 9: PFD Determination analytics do not have a target UE, they are always for any UE. The predictions are not applicable for PFD Determination analytics. + +- if the feature "E2eDataVolTransTime" is supported and the event is "E2E\_DATA\_VOL\_TRANS\_TIME", shall provide: + - 1) identification of target UE(s) to which the subscription applies by "supis" or "gpsi" attribute in the "tgt-ue" attribute. + +and may include: + + - 1) an identification of DNN in the "dnns" attribute; + - 2) identification of network slice in the "snssais" attribute; + - 3) application identifier(s) in "appIds" attribute; + - 4) area of interest of the UEs by "networkArea" attribute; restricts the scope of the E2E data volume transfer time analytics to the provided area; + - 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "E2E\_DATA\_VOL\_TRANS\_TIME" event, if the "EneNA" feature is supported; + - 6) the QoS requirements via "qosRequ" attribute; + - 7) E2E data volume transfer time requirements in the "dataVITrmsTmRqs" attribute; and + - 8) either a target number of repeating data transmissions by "repeatDataTrans" attribute or a target time interval between data transmissions within by "tsIntervalDataTrans" attribute the Analytics target period; +- if the feature "PduSesTraffic" is supported and the event is "PDU\_SESSION\_TRAFFIC", shall provide: + - 1) identification of target UE(s) to which the subscription applies by "supis", "intGroupIds" or "anyUe" attribute in the "tgt-ue" attribute; + - 2) PDU Session traffic analytics requirements in "pduSesTrafReqs" attribute, which includes the known Application Identifier, IP Descriptions or Domain Descriptors. + - 3) DNN and/or S-NSSAI for the PDU Session(s) in the "dnns" and/or "snssais" attributes. + +and may include: + +- 1) identification of network area to which the request applies via identification of network area by "networkArea" attribute; and/or +- 2) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "PDU\_SESSION\_TRAFFIC" event, if the "EneNA" feature is supported. + +NOTE 10: The predictions are not applicable for PDU Session traffic analytics. + +- if the feature "MovementBehaviour" is supported and the event is "MOVEMENT\_BEHAVIOUR", shall provide: + - 1) identification of network area to which the request applies via identification of network area by "networkArea" attribute; +- and may include: + - 1) identification of the preferred orientation of location information by "locOrientation" attribute; + - 2) Movement Behaviour analytics requirements in "movBehavReqs" attribute, which includes preferred granularity of location information or preferred orientation of location information; and/or + - 3) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "MOVEMENT\_BEHAVIOUR" event, if the "EneNA" features is supported. +- if the feature "LocAccuracy" is supported and the event is "LOC\_ACCURACY", the "event-filter" attribute shall include: + - 1) either a network area to which the request applies within the "networkArea" attribute or an exact location to which the request applies within the "location" attribute; +- and the "event-filter" attribute may include: + - 1) Location accuracy analytics requirements within the "locAccReqs" attribute; and/or + - 2) an optional list of analytics subsets within the "listOfAnaSubsets" attribute with value(s) only applicable to the "LOC\_ACCURACY" event, if the "EneNA" features is supported. + +NOTE 11: Location accuracy analytics do not have a target UE, they are always for any UE. + +- if the feature "RelativeProximity" is supported and the event is "RELATIVE\_PROXIMITY", shall provide: + - 1) identification of target UE(s) to which the request applies by "supis" or "intGroupIds" attribute in the "tgt-ue" attribute; +- and may include in the "event-filter" attribute: + - 1) identification of DNN in the "dnns" attribute; + - 2) identification of network slice in the "snssais" attribute; + - 3) identification of network area to which the request applies via identification of network area by "networkArea" attribute; + - 4) Relative Proximity analytics requirements in "relProxReqs" attribute; and/or + - 5) an optional list of analytics subsets by "listOfAnaSubsets" attribute with value(s) only applicable to "RELATIVE\_PROXIMITY" event prediction, if the "EneNA" features is supported. + +Upon the reception of the HTTP GET request, the NWDAF shall: + +- analyse the requested analytic data according to the requested event. + +If the HTTP request message from the NF service consumer is accepted, the NWDAF shall respond with "200 OK" status code with the message body containing the analytics with parameters as relevant for the requesting NF service consumer. The AnalyticsData data structure in the response body shall include: + +- analytics with the corresponding information as described in clause 4.2.2.4.2. +- the analytics accuracy information in the "accuInfo" attribute, if the feature "AnalyticsAccuracy" is supported and the analytics accuracy requirement was requested in the "accuReq" attribute. + +NOTE 12: In this version of the specification, NWDAF containing AnLF can provide accuracy information to an NF consumer that requests both the analytics and the accuracy information. + +NOTE 13: When receiving a request from an NF consumer that includes a request for accuracy information, the analytics and the accuracy information can be provided by NWDAF containing AnLF within the single response. + +If the requested NWDAF Analytics data does not exist, the NWDAF shall respond with "204 No Content" status code. + +If the "timeAnaNeeded" attribute within EventReportingRequirement is provided during the request, if the time is reached but the requested analytics information is not ready, the consumer does not need to wait for the analytics information any longer, the NWDAF may send a "500 Internal Server Error" status code to the NF service consumer. In addition, if the EneNA feature is supported, the NWDAF may provide, within the ProblemDetailsAnalyticsInfoRequestdata in the response, the corresponding failure reason via a "problemDetails" attribute with the "cause" attribute set to "UNSATISFIED\_REQUESTED\_ANALYTICS\_TIME" and a minimum time interval recommended by the NWDAF via a "rvWaitTime" attribute which is used by the NF service consumer to determine the time when analytics information is needed in similar future analytics requests. + +If the analytics target period provided in the body of the HTTP GET request includes the start time in the past and the end time in the future, the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "BOTH\_STAT\_PRED\_NOT\_ALLOWED". + +When the "PredictionError" feature is supported, if the analytics target period provided in the body of the HTTP GET request includes the prediction time period in the future and the event is "SM\_CONGESTION", "PFD\_DETERMINATION" and/or "PDU\_SESSION\_TRAFFIC", the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "PREDICTION\_NOT\_ALLOWED". + +If the statistics in the past are requested but the necessary data to perform the service is unavailable, the NWDAF shall reject the request with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "UNAVAILABLE\_DATA". + +If the user consent has not been checked by the NF service consumer and is required for the requested analytics collection depending on local policy and regulations, then the NWDAF shall check user consent for the targeted UE(s) by retrieving the user consent subscription data via the Nudm\_SDM service API of the UDM as described in clause 5.2.2 of 3GPP TS 29.503 [23]. If the NWDAF receive the response from the UDM that it is not granted for the impacted user(s), then the NWDAF shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "USER\_CONSENT\_NOT\_GRANTED". + +NOTE 13: When the target of reporting is a SUPI or a GPSI then the subscription can be rejected, e.g. because user consent is not granted, and the error is sent to the consumer. When the target of reporting is an Internal Group Id, or a list of SUPIs/GPSI(s) or any UE, and the user consent is not granted for a subset of the impacted users, then no error is sent, but a subset of the SUPIs/GPSIs is skipped if user consent is not granted. + +If an error occurs when processing the HTTP GET request, the NWDAF shall send an HTTP error response as specified in clause 5.2.7. + +### 4.3.2.3 Nnwdaf\_AnalyticsInfo\_ContextTransfer service operation + +#### 4.3.2.3.1 General + +The Nnwdaf\_AnalyticsInfo\_ContextTransfer service operation is used by an NF service consumer to request and get context information related to analytics subscriptions from the NWDAF. + +#### 4.3.2.3.2 Request and get from NWDAF context of a subscription + +Figure 4.3.2.3.2-1 shows a scenario where the NF service consumer (e.g. NWDAF) sends a request to the NWDAF to request and get from NWDAF context information related to analytics subscriptions (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the request and response for NWDAF context information. The NF service consumer sends a GET request to the NWDAF, and the NWDAF responds with either a 200 OK or No Content.](fcc757566216206ceddbd6c775e8db02_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + Note right of NWDAF: + NF service consumer->>NWDAF: 1. GET « context?query_parameters + NWDAF-->>NF service consumer: 2a. 200 OK or 2b. No Content + +``` + +Sequence diagram showing the request and response for NWDAF context information. The NF service consumer sends a GET request to the NWDAF, and the NWDAF responds with either a 200 OK or No Content. + +**Figure 4.3.2.3.2-1: Requesting NWDAF context information related to analytics subscriptions** + +The NF service consumer (e.g. NWDAF) shall invoke the Nnwdaf\_AnalyticsInfo\_ContextTransfer service operation when requesting context information related to analytics subscriptions. The NF service consumer shall send an HTTP GET request on the resource URI "{apiRoot}/nnwdaf-analyticsinfo//context" representing the "NWDAF Context" (as shown in figure 4.3.2.3.2-1, step 1), to request context information related to analytics subscriptions according to the query parameter values of the attributes "context-ids" and "req-context". + +Upon the reception of the HTTP GET request, the NWDAF shall retrieve the context information for the requested context identifiers. + +If the HTTP request message from the NF service consumer is accepted, the NWDAF shall respond with "200 OK" status code with the message body containing the retrieved context information. The ContextData data structure in the response body shall include for each of the context elements contained in the "contextElem" attribute: + +- the context identifier that this context element refers to in the "contextId" attribute, which indicates among others the analytics subscription that this context element is associated with. +- the pending output analytics for the indicated analytics subscription in the "pendAnalytics" attribute if such analytics are available and the NF service consumer has indicated the "PENDING\_ANALYTICS" context type in the "req-context" attribute of the request. +- the historical output analytics for the indicated analytics subscription in the "histAnalytics" attribute if such analytics are available and the NF service consumer has indicated the "HISTORICAL\_ANALYTICS" context type in the "req-context" attribute of the request. +- a timestamp of the last provided output analytics in the "lastOutputTime" if the NF service consumer has indicated the "PENDING\_ANALYTICS" and/or "HISTORICAL\_ANALYTICS" context type in the "req-context" attribute of the request and output analytics had been provided to the analytics consumer. +- information about aggregation related analytics subscriptions that the NWDAF has with other NWDAFs in the "aggrSubs" attribute if such subscriptions exist and the NF service consumer has indicated the "AGGR\_SUBS" context type in the "req-context" attribute of the request. +- historical data related to the indicated analytics subscription in the "histData" attribute if such data exists and the NF service consumer has indicated the "DATA" context type in the "req-context" attribute of the request. +- identifier of ADRF instance in the "adrId" attribute if the NWDAF stores data in the ADRF. +- the types of data stored in the ADRF in the "adrDataTypes" attribute if the "adrId" attribute is provided. +- identifiers of NWDAF instances used when aggregating multiple analytics subscriptions in the "aggrNwdaIds" if such information is available and the NF service consumer has indicated the "AGGR\_INFO" context type in the "req-context" attribute of the request. +- information about used ML models in the "modelInfos" attribute if such information is available and the NF service consumer has indicated the "ML\_MODELS" context type in the "req-context" attribute of the request. + +If the requested context information does not exist, the NWDAF shall respond with "204 No Content" status code. + +## 4.4 Nnwdaf\_DataManagement Service + +### 4.4.1 Service Description + +#### 4.4.1.1 Overview + +The Nnwdaf\_DataManagement Service as defined in 3GPP TS 23.288 [17] is provided by the Network Data Analytics Function (NWDAF). + +This service: + +- allows the NF service consumers to subscribe to and unsubscribe from data management related events; +- notifies the NF service consumers with the subscribed events which are detected by the NWDAF; and +- allows the NF service consumers to retrieve the subscribed data from the NWDAF. + +#### 4.4.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 [17]. The Network Data Analytics signalling flows are defined in 3GPP TS 29.552 [25]. + +The Nnwdaf\_DataManagement service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF). + +Known consumers of the Nnwdaf\_DataManagement service are: + +- Network Data Analytics Function (NWDAF) +- Data Collection Coordination Function (DCCF) +- Messaging Framework Adaptor Function (MFAF) +- Analytics Data Repository Function (ADRF) + +![Reference Architecture for the Nnwdaf_DataManagement Service; SBI representation](a3c1310e720178d2450a3748c7c75422_img.jpg) + +This diagram illustrates the Service Based Interface (SBI) representation of the Nnwdaf\_DataManagement service. At the top, a rectangular box labeled 'NWDAF' contains an oval labeled 'Nnwdaf'. A vertical line descends from this oval to a horizontal bus line. To the right of the bus line is the label 'Nnwdaf\_DataManagement'. Below the bus line, four rectangular boxes are connected in parallel, labeled from left to right: 'NWDAF', 'DCCF', 'MFAF', and 'ADRF'. + +Reference Architecture for the Nnwdaf\_DataManagement Service; SBI representation + +**Figure 4.4.1.2-1: Reference Architecture for the Nnwdaf\_DataManagement Service; SBI representation** + +![Reference Architecture for the Nnwdaf_DataManagement Service: reference point representation](bdb44cc8120caccddc2adf0c3db54261_img.jpg) + +This diagram illustrates the reference point representation of the Nnwdaf\_DataManagement service. At the top, a rectangular box labeled 'NWDAF' has four lines radiating downwards to four separate rectangular boxes at the bottom. These boxes are labeled from left to right: 'NWDAF', 'DCCF', 'MFAF', and 'ADRF'. + +Reference Architecture for the Nnwdaf\_DataManagement Service: reference point representation + +**Figure 4.4.1.2-2: Reference Architecture for the Nnwdaf\_DataManagement Service: reference point representation** + +#### 4.4.1.3 Network Functions + +##### 4.4.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF) provides requested data to NF consumers. + +The Network Data Analytics Function (NWDAF) allows NF consumers to subscribe to and unsubscribe from the notification of detected event(s). + +The Network Data Analytics Function (NWDAF) allows NF consumers to retrieve data that was collected based on their subscriptions. + +##### 4.4.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF): + +- supports (un)subscription to the notification of data exposed by the NWDAF; +- supports retrieving data from the NWDAF. + +The Data Collection Coordination Function (DCCF): + +- supports (un)subscription to the notification of data exposed by the NWDAF; +- supports retrieving data from the NWDAF. + +The Messaging Framework Adaptor Function (MFAF): + +- supports receiving notifications of data provided by the NWDAF; +- supports retrieving data from the NWDAF. + +The Analytics Data Repository Function (ADRF): + +- supports receiving notifications of data provided by the NWDAF. +- supports retrieving data from the NWDAF. + +#### 4.4.2 Service Operations + +##### 4.4.2.1 Introduction + +**Table 4.4.2.1-1: Operations of the Nnwdaf\_DataManagement Service** + +| Service operation name | Description | Initiated by | +|-----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| +| Nnwdaf_DataManagement_Subscribe | This service operation is used by an NF service consumer to subscribe to data management related event(s) from NWDAF. | NF service consumer (NWDAF, DCCF, MFAF, ADRF) | +| Nnwdaf_DataManagement_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe to data management related event(s). | NF service consumer (NWDAF, DCCF, MFAF, ADRF) | +| Nnwdaf_DataManagement_Notify | This service operation is used by the NWDAF to notify the detected event(s) to the NF service consumer instance which has subscribed to. | NWDAF | +| Nnwdaf_DataManagement_Fetch | This service operation is used by an NF service consumer to retrieve the subscribed data. | NF service consumer (NWDAF, DCCF, MFAF) | + +##### 4.4.2.2 Nnwdaf\_DataManagement\_Subscribe service operation + +###### 4.4.2.2.1 General + +The Nnwdaf\_DataManagement\_Subscribe service operation is used by an NF service consumer to create or update a subscription for data notifications from the NWDAF. + +###### 4.4.2.2.2 Subscription for data notifications + +Figure 4.4.2.2.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to subscribe for data notification(s). + +![Sequence diagram showing the NF service consumer subscribing to data notifications from the NWDAF. Step 1: POST.../subscriptions from NF service consumer to NWDAF. Step 2: 201 Created response from NWDAF to NF service consumer.](e2c120be98ede6deb60dd341f5a9803b_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. POST.../subscriptions + NF service consumer->>NWDAF: Request + Note left of NWDAF: 2. "201 Created" + NWDAF-->>NF service consumer: Response + +``` + +Sequence diagram showing the NF service consumer subscribing to data notifications from the NWDAF. Step 1: POST.../subscriptions from NF service consumer to NWDAF. Step 2: 201 Created response from NWDAF to NF service consumer. + +**Figure 4.4.2.2.2-1: NF service consumer subscribes to data notifications** + +The NF service consumer shall invoke the Nnwdaf\_DataManagement\_Subscribe service operation to subscribe to data notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwdaf-datamanagement//subscriptions" as Resource URI representing the "NWDAF Data Management Subscriptions", as shown in figure 4.4.2.2.2-1, step 1, to create a subscription for an "Individual NWDAF Data Management Subscription" according to the information in message body. + +The NnwdafDataManagementSubsc data structure provided in the request body shall include: + +- an URI where to receive the requested notifications as "notificURI" attribute; +- notification correlation identifier within the "notifCorrId" attribute; and +- one of the following: + - analytics subscription information to be used to determine which data shall be collected and reported within the "anaSub" attribute; + - data subscription information within the "dataSub" attribute; + +The NnwdafDataManagementSubsc data structure provided in the request body may include: + +- the notification endpoints within the "notifEndpoints" attribute if the "DataAnaCollect" feature is supported; +- formatting instructions within the "formatInstruct" attribute; +- processing instructions within the "procInstruct" attribute or the "multiProcInstructs" attribute if the "MultiProcessingInstruction" feature is supported; +- one of the following identifiers related to the ADRF: + - ADRF instance identifier within the "adrflId" attribute; + - ADRF set identifier within the "adrSetId" attribute; +- one of the following target identifiers: + - NF instance identifier within the "targetNfId" attribute; + - NF set identifier within the "targetNfSetId" attribute; +- time window of the occurrence of the requested data collection within the "timePeriod" attribute; +- the purpose of data collection within the "dataCollectPurposes" attribute. +- the indication that the NF service consumer has already checked the user consent within the "checkedConsentInd" attribute. +- storage handling information within the "storeHandl" attribute, if the "EnhDataMgmt" feature is supported. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nnwdaf-datamanagement//subscriptions" as Resource URI and NnwdafDataManagementSubsc data structure as request body, the NWDAF shall use the contents of the request to determine whether the subscription can already be served or interactions with the ADRF and/or data sources are required. If the NWDAF cannot use the contents of the request to determine this, the NWDAF shall send an HTTP "400 Bad Request" error response including the "cause" attribute set to "SUBSCRIPTION\_CANNOT\_BE\_SERVED". + +NOTE 1: The "SUBSCRIPTION\_CANNOT\_BE\_SERVED" error can occur, for example, in the case where the "dataSub" or "anaSub" attributes are provided, when the request is syntactically valid and there is no NWDAF internal error, but the NWDAF can neither find an existing subscription to a data source nor construct one based on the received subscription contents. + +If the user consent has not been checked by the NF service consumer and is required for the requested data collection depending on local policy and regulations, then the NWDAF shall check user consent for the targeted UE(s) by retrieving the user consent subscription data via the Nudm\_SDM service API of the UDM as described in clause 5.2.2 + +of 3GPP TS 29.503 [23]. If the NWDAF receives the response from the UDM that it is not granted for the impacted user(s), then the NWDAF shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "USER\_CONSENT\_NOT\_GRANTED". + +NOTE 2: When the target of reporting is a SUPI or a GPSI then the subscription can be rejected, e.g. because user consent is not granted, and the error is sent to the consumer. When the target of reporting is an Internal Group Id, or a list of SUPIs/GPSI(s) or any UE, and the user consent is not granted for a subset of the impacted users, then no error is sent, but a subset of the SUPIs/GPSIs is skipped if user consent is not granted. + +If the NWDAF determines that the subscription can already be served (without requiring further interactions with ADRF and/or data sources) or a successful response from the ADRF and/or data sources is received for the creation or modification of subscription(s) to serve this subscription, the NWDAF shall: + +- create a new subscription; +- assign a subscriptionId; +- store the subscription. + +If the NWDAF created an "Individual NWDAF Data Management Subscription" resource, the NWDAF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.4.2.2.2-1, step 2. The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. + +"{apiRoot}/nnwdaf-datamanagement/{apiVersion}/subscriptions/{subscriptionId}". If an immediate reporting indication is provided in the subscription, the NWDAF shall include the reports of the events subscribed, if available, in the HTTP POST response within the "dataSub" attribute, or, if the DataAnaCollect feature is supported, potentially within the "immReport" attribute. + +If the NWDAF receives storage handling information in the request but determines (e.g. based on local policy) that a different storage approach shall be followed, it indicates the determined storage approach to the consumer by setting accordingly the "storeHandl" attribute (e.g. providing a different lifetime, or setting the indication about deletion alerts to "false") in the message body of the response. When more than one consumer has requested storage lifetime for the same analytics, the storage approach should be based on the longest requested storage lifetime. + +NOTE 3: The default operator policy for how long analytics is to be stored can be longer or shorter than the lifetime requested by the consumer. A default operator policy can for example accept only consumer requested lifetimes that are shorter or longer than the default policy. + +When the notification flag of the "dataSub" attribute (e.g. the "notifFlag" attribute within the "eventsRepInfo" attribute in the case of AF events) is included and set to "DEACTIVATE" in the request, the NWDAF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the notification flag to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). When a muting exception occurs, if the EnhDataMgmt feature is supported, the NWDAF may consider the contents of the muting instructions of the "dataSub" attribute (if provided; e.g. the "notifFlagInstruct" attribute within the "eventsRepInfo" attribute in the case of AF events) and/or local configuration to determine its actions. + +If the EnhDataMgmt feature is supported and the NWDAF accepts the provided notification flag and muting instructions, it may indicate the applied muting notification settings in the response (e.g. within the "mutingSetting" attribute in the case of AF events). If the NWDAF does not accept the provided notification flag and muting instructions, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.3.7. + +#### 4.4.2.2.3 Update subscription for data notifications + +Figure 4.4.2.2.3-1 shows a scenario where the NF service consumer sends a request to the NWDAF to update the subscription for data notifications. + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF to update a subscription. The consumer sends a PUT request to /subscriptions/{subscriptionId} and the NWDAF responds with either 200 OK or 204 No Content.](5e9af8986a5845504f251d3079da8078_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NWDAF: 1. PUT.../subscriptions/{subscriptionId} + NWDAF-->>NF service consumer: 2a. "200 OK" or +2b. "204 No Content" + +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF to update a subscription. The consumer sends a PUT request to /subscriptions/{subscriptionId} and the NWDAF responds with either 200 OK or 204 No Content. + +**Figure 4.4.2.2.3-1: NF service consumer updates subscription to data notifications** + +The NF service consumer shall invoke the Nnwdaf\_DataManagement\_Subscribe service operation to update subscription to data notifications. The NF service consumer shall send an HTTP PUT request with "{apiRoot}/nnwdaf-datamanagement//subscriptions/{subscriptionId}" as Resource URI representing the "Individual NWDAF Data Management Subscription", as shown in figure 4.4.2.2.3-1, step 1, to update the subscription for an "Individual NWDAF Data Management Subscription" resource identified by the {subscriptionId}. The NnwdafDataManagementSubsc data structure provided in the request body shall include the same contents as described in clause 4.4.2.2.2. + +Upon the reception of an HTTP PUT request with: + +"{apiRoot}/nnwdaf-datamanagement//subscriptions/{subscriptionId}" as Resource URI and NnwdafDataManagementSubsc data structure as request body, the NWDAF shall use the contents of the request to determine whether the updated subscription can already be served or interactions with the ADRF and/or data sources are required. If the NWDAF cannot use the contents of the request to determine this, the NWDAF shall send an HTTP "400 Bad Request" error response including the "cause" attribute set to "SUBSCRIPTION\_CANNOT\_BE\_SERVED". + +NOTE 1: The "SUBSCRIPTION\_CANNOT\_BE\_SERVED" error can occur, for example, in the case when the "dataSub" or "anaSub" attributes are provided, when the request is syntactically valid and there is no NWDAF internal error, but the NWDAF can neither find an existing subscription to a data source nor construct one based on the received subscription contents. + +If the NWDAF determines that the updated subscription can already be served (without requiring further interactions with the ADRF and/or data sources) or a successful response from the ADRF and/or data sources is received for the creation or modification of subscription(s) to serve this subscription, the NWDAF shall: + +- update the subscription of corresponding subscriptionId; and +- store the subscription. + +If the NWDAF successfully processed and accepted the received HTTP PUT request, the NWDAF shall update an "Individual NWDAF Data Management Subscription" resource, and shall respond with: + +- a) HTTP "200 OK" status code with the message body containing a representation of the updated subscription, as shown in figure 4.4.2.2.3-1, step 2a; If an immediate reporting indication is provided in the request, the NWDAF shall include the reports of the events subscribed, if available, in the HTTP PUT response within the "dataSub" attribute, or, if the DataAnaCollect feature is supported, potentially within the "immReport" attribute; or +- b) HTTP "204 No Content" status code, as shown in figure 4.4.2.2.3-1, step 2b. + +If the NWDAF receives storage handling information in the request but determines (e.g. based on local policy) that a different storage approach shall be followed, it indicates the determined storage approach to the consumer by setting accordingly the "storeHandl" attribute (e.g. providing a different lifetime, or setting the indication about deletion alerts to "false") in the message body of the response. When more than one consumer has requested storage lifetime for the same analytics, the storage approach should be based on the longest requested storage lifetime. + +NOTE 2: The default operator policy for how long analytics is to be stored can be longer or shorter than the lifetime requested by the consumer. A default operator policy can for example accept only consumer requested lifetimes that are shorter or longer than the default policy. + +When the notification flag of the "dataSub" attribute (e.g. the "notifFlag" attribute within the "eventsRepInfo" attribute in the case of AF events) is included in the request with the value "DEACTIVATE", the NWDAF shall mute the event notification and store the available events until the NF service consumer requests to retrieve them by setting the + +notification flag attribute to "RETRIEVAL" or until a muting exception occurs (e.g. full buffer). When a muting exception occurs, if the EnhDataMgmt feature is supported, the NWDAF may consider the contents of the muting instructions of the "dataSub" attribute (if provided; e.g. the "notifFlagInstruct" attribute within the "eventsRepInfo" attribute in the case of AF events) and/or local configuration to determine its actions; if the notification flag is set to the value "RETRIEVAL", the NWDAF shall send the stored events to the NF service consumer, mute the event notification again and store available events; if the notification flag is set to the value "ACTIVATE" and the event notifications are muted (due to a previously received "DEACTIVATE" value), the NWDAF shall unmute the event notification, i.e. start sending again notifications for available events. + +If the EnhDataMgmt feature is supported and the NWDAF accepts the provided notification flag and muting instructions, it may indicate the applied muting notification settings in the response (e.g. within the "mutingSetting" attribute in the case of AF events). If the NWDAF does not accept the provided notification flag and muting instructions, it shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "MUTING\_INSTR\_NOT\_ACCEPTED". If errors occur when processing the HTTP PUT request, the NWDAF shall send an HTTP error response as specified in clause 5.3.7. + +If the NWDAF determines the received HTTP PUT request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.4.2.3 Nnwdaf\_DataManagement\_Unsubscribe service operation + +##### 4.4.2.3.1 General + +The Nnwdaf\_DataManagement\_Unsubscribe service operation is used by an NF service consumer to remove a subscription for data notifications from the NWDAF. + +##### 4.4.2.3.2 Unsubscribe from data notifications + +Figure 4.4.2.3.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to unsubscribe from data notifications. + +![Sequence diagram showing the unsubscribe process between an NF service consumer and the NWDAF.](cc468dcda006ef315536400517a09ad3_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. DELETE.../subscriptions/{subscriptionId} + NF service consumer->>NWDAF: 1. DELETE.../subscriptions/{subscriptionId} + Note left of NWDAF: 2. "204 No Content" + NWDAF-->>NF service consumer: 2. "204 No Content" +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and the NWDAF. The first message, labeled '1. DELETE.../subscriptions/{subscriptionId}', is sent from the NF service consumer to the NWDAF. The second message, labeled '2. "204 No Content"', is sent from the NWDAF back to the NF service consumer. + +Sequence diagram showing the unsubscribe process between an NF service consumer and the NWDAF. + +**Figure 4.4.2.3.2-1: NF service consumer unsubscribes from data notifications** + +The NF service consumer shall invoke the Nnwdaf\_DataManagement\_Unsubscribe service operation to unsubscribe from data notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nnwdaf-datamanagement//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the identifier of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- remove the corresponding subscription; +- respond to the NF service consumer: + - respond with HTTP "204 No Content" status code if the "EnhDataMgmt" feature is not supported or no stored unsent events to be included in the response; or + +- respond with HTTP "200 OK" status code if the "EnhDataMgmt" feature is supported and including the stored unsent events in the NnwdafDataManagementNotif data type in the response. + +If errors occur when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.3.7. + +If the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.4.2.4 Nnwdaf\_DataManagement\_Notify service operation + +##### 4.4.2.4.1 General + +The Nnwdaf\_DataManagement\_Notify service operation is used by the NWDAF to notify NF service consumers about subscribed events related to data. + +##### 4.4.2.4.2 Notification about subscribed data + +Figure 4.4.2.4.2-1 shows a scenario where the NWDAF sends a request to the NF service consumer to notify for event notifications (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and the NWDAF. The NF service consumer sends a POST request with {notificURI} to the NWDAF. The NWDAF responds with a 204 No Content or 200 OK status code.](1ae16a393229b439c7b3f8b2e63d8d6c_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. POST {notificURI} + NF service consumer->>NWDAF: 1. POST {notificURI} + Note left of NWDAF: 2. 204 No Content or 200 OK + NWDAF-->>NF service consumer: 2. 204 No Content or 200 OK +``` + +Sequence diagram showing the interaction between an NF service consumer and the NWDAF. The NF service consumer sends a POST request with {notificURI} to the NWDAF. The NWDAF responds with a 204 No Content or 200 OK status code. + +**Figure 4.4.2.4.2-1: NWDAF notifies the subscribed event** + +The NWDAF shall invoke the Nnwdaf\_DataManagement\_Notify service operation to notify the subscribed event. The NWDAF shall send an HTTP POST request with "{notificURI}" received in the Nnwdaf\_DataManagement\_Subscribe service operation as Resource URI, as shown in figure 4.4.2.4.2-1, step 1. + +The NnwdafDataManagementNotif data structure provided in the request body that shall include: + +- the notification correlation identifier within the "notifCorrId" attribute; +- the timestamp of the notification within the "notifTimestamp" attribute; +- one of the following: + - data collected from data sources (e.g. SMF, NEF) in the "dataNotification" attribute; + - summarized data derived from events that occurred based on processing and formatting instructions in the "dataReports" attribute; + - information for fetching the contents of the notification in the "fetchInstruct" attribute. + - a deletion alert in the "delAlert" attribute, if the "EnhDataMgmt" feature is supported. + +The NnwdafDataManagementNotif data structure provided in the request body may include: + +- an indication that the NWDAF has requested a termination of the subscription within the "terminationReq" attribute; and/or +- a pending notification cause for the stored unsent data in the "pendNotifCause" attribute if the "EnhDataMgmt" feature is supported. + +Upon the reception of an HTTP POST request, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall store the notification and respond with HTTP "204 No + +Content" status code, or with HTTP "200 OK" status code and the NotifResponse data structure in the response body if the "EnhDataMgmt" feature is supported. + +After the successful processing of the HTTP POST request: + +- if the NWDAF requests the NF service consumer with the "fetchInstruct" attribute to retrieve the data, the NF service consumer may invoke the Nnwdaf\_DataManagement\_Fetch service operation to retrieve the notified data as defined in clause 4.4.2.5. +- if the NWDAF provided a deletion alert to the NF service consumer, the NF service consumer may invoke the Nadrf\_DataManagement\_RetrievalRequest service operation as defined in 3GPP TS 29.575 [27] clause 4.2.2.5, using the storage transaction identifier received within the "alertStorTransId" attribute of the "delAlert" attribute, in order to retrieve the data that are about to be deleted. + +NOTE: The "alertStorTransId" attribute, which is used for retrieving data prior to deletion, does not have to be the same with or related to the storage transaction identifier that is assigned and returned during the storage of the data in the ADRF. + +If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.3.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 [6]. + +#### 4.4.2.5 Nnwdaf\_DataManagement\_Fetch service operation + +##### 4.4.2.5.1 General + +The Nnwdaf\_DataManagement\_Fetch service operation is used by an NF service consumer to retrieve data notifications indicated by fetch instructions from the NWDAF. + +##### 4.4.2.5.2 Retrieve data from the NWDAF + +Figure 4.4.2.5.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to retrieve notified data. + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF to retrieve notified data. The NF service consumer sends a POST {fetchUri} request to the NWDAF, and the NWDAF responds with a 200 OK.](b97737027bd1b2effd7ca4dba8914877_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: Requesting to retrieve notified data + NF service consumer->>NWDAF: 1. POST {fetchUri} + NWDAF-->>NF service consumer: 2. 200 OK +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF to retrieve notified data. The NF service consumer sends a POST {fetchUri} request to the NWDAF, and the NWDAF responds with a 200 OK. + +**Figure 4.4.2.5.2-1: Requesting to retrieve notified data** + +The NF service consumer shall invoke the Nnwdaf\_DataManagement\_Fetch service operation to retrieve notified data. The NF service consumer shall send an HTTP POST request with "{fetchUri}" URI previously provided by the NWDAF in "fetchInstruct" attribute within NnwdafDataManagementNotif data type, as shown in figure 4.4.2.5.2-1, step 1, to fetch NWDAF data. The request body shall include fetch correlation identifiers, which was previously provided by the NWDAF in the "fetchCorrIds" attribute within fetchInstruction in the NWDAF notification. + +Upon the reception of the HTTP POST request, the NWDAF shall: + +- find the data according to the requested parameters. + +If the requested data is found, the NWDAF shall respond with "200 OK" status code with the message body containing the NnwdafDataManagementNotif data structure. The NnwdafDataManagementNotif data structure in the response body shall include the data collected from data sources (e.g. SMF, NEF) in the "dataNotification" attribute. + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.3.7. + +If the NWDAF determines that the received HTTP POST request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +## 4.5 Nnwdaf\_ MLModelProvision Service + +### 4.5.1 Service Description + +#### 4.5.1.1 Overview + +The Nnwdaf\_ MLModelProvision service as defined in 3GPP TS 23.501 [2] and 3GPP TS 23.288 [17], is provided by the Network Data Analytics Function (NWDAF) containing Model Training Logical Function (MTLF). + +This service: + +- allows the NF service consumers to subscribe to and unsubscribe from different ML model analytics events; +- allows MTLF-based ML Model Accuracy monitoring procedure between the AnLF and MTLF. and +- notifies the NF service consumers with a corresponding subscription about ML model information. + +The types of analytics events include: + +- Slice load level information; +- Network slice instance load level information; +- Service experience; +- NF load; +- Network performance; +- Abnormal behaviour; +- UE mobility; +- UE communication; +- Abnormal behaviour; +- User data congestion; +- QoS sustainability; +- Dispersion; +- SM congestion control experience; +- Redundant transmission experience; +- WLAN performance; +- DN performance; and +- E2E data volume transfer time. + +NOTE: ML model provisioning is limited to a single vendor environment in this release of current specification. + +#### 4.5.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 [17]. The ML Model provisioning signalling flows are defined in 3GPP TS 29.552 [25]. + +The Nnwdaf\_ MLModelProvision service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF) containing Model Training Logical Function (MTLF). + +Known consumers of the Nnwdaf\_ MLModelProvision service are: + +- Network Data Analytics Function (NWDAF) containing Analytics logical function (AnLF) + +![Figure 4.5.1.2-1: Reference Architecture for the Nnwdaf_MLModelProvision Service; SBI representation. The diagram shows a top box labeled 'NWDAF (MTLF)' containing a circle labeled 'Nnwdaf'. A vertical line labeled 'Nnwdaf_MLModelProvision' connects this to a bottom box labeled 'NWDAF (AnLF)'.](0931f3e098bd4539041de11c50cec2d2_img.jpg) + +Figure 4.5.1.2-1: Reference Architecture for the Nnwdaf\_MLModelProvision Service; SBI representation. The diagram shows a top box labeled 'NWDAF (MTLF)' containing a circle labeled 'Nnwdaf'. A vertical line labeled 'Nnwdaf\_MLModelProvision' connects this to a bottom box labeled 'NWDAF (AnLF)'. + +**Figure 4.5.1.2-1: Reference Architecture for the Nnwdaf\_MLModelProvision Service; SBI representation** + +![Figure 4.5.1.2-2: Reference Architecture for the Nnwdaf_MLModelProvision Service: reference point representation. The diagram shows a top box labeled 'NWDAF (MTLF)' connected by a vertical line to a bottom box labeled 'NWDAF (AnLF)'. There is a small horizontal tick mark on the vertical line between the two boxes.](57939c16065211317c5442cf2a4009e0_img.jpg) + +Figure 4.5.1.2-2: Reference Architecture for the Nnwdaf\_MLModelProvision Service: reference point representation. The diagram shows a top box labeled 'NWDAF (MTLF)' connected by a vertical line to a bottom box labeled 'NWDAF (AnLF)'. There is a small horizontal tick mark on the vertical line between the two boxes. + +**Figure 4.5.1.2-2: Reference Architecture for the Nnwdaf\_MLModelProvision Service: reference point representation** + +#### 4.5.1.3 Network Functions + +##### 4.5.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF), containing Model Training Logical Function (MTLF), provides ML model information for different analytic events to NF service consumers. + +The Network Data Analytics Function (NWDAF) allows NF service consumers to subscribe to and unsubscribe from one-time, periodic notification or notification when an event is detected. + +##### 4.5.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF) supports (un)subscription to the notification of different ML model information from the NWDAF which contains Model Training Logical Function (MTLF). + +#### 4.5.2 Service Operations + +##### 4.5.2.1 Introduction + +**Table 4.5.2.1-1: Operations of the Nnwdaf\_MLModelProvision Service** + +| Service operation name | Description | Initiated by | +|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| Nnwdaf_MLModelProvision_Subscribe | This service operation is used by an NF service consumer to subscribe to ML model provision from NWDAF. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelProvision_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe to ML model provision. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelProvision_Notify | This service operation is used by the NWDAF to notify the ML model information to the NF service consumer instance which has subscribed to. | NWDAF | + +## 4.5.2.2 Nnwdaf\_MLModelProvision\_Subscribe service operation + +### 4.5.2.2.1 General + +The Nnwdaf\_MLModelProvision\_Subscribe service operation is used by an NF service consumer to subscribe or update subscription for event notifications from the NWDAF which contains Model Training Logical Function (MTLF). + +### 4.5.2.2.2 Subscription for event notifications + +Figure 4.5.2.2.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to subscribe for event notification(s) (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the NF service consumer sending a POST request to the NWDAF to subscribe for event notifications. Step 1: POST /subscriptions from NF service consumer to NWDAF. Step 2: 201 Created response from NWDAF to NF service consumer.](7f663b2f8632236c6e40ca16272d62df_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: NF service consumer + Note right of NWDAF: NWDAF + NF service consumer->>NWDAF: 1. POST « /subscriptions + NWDAF-->>NF service consumer: 2. 201 Created + +``` + +Sequence diagram showing the NF service consumer sending a POST request to the NWDAF to subscribe for event notifications. Step 1: POST /subscriptions from NF service consumer to NWDAF. Step 2: 201 Created response from NWDAF to NF service consumer. + +**Figure 4.5.2.2.2-1: NF service consumer subscribes to notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelProvision\_Subscribe service operation to subscribe to event notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwdaf-mlmodelprovision//subscriptions" as Resource URI representing the "NWDAF ML Model Provision Subscriptions", as shown in figure 4.5.2.2.2-1, step 1, to create a subscription for an "Individual NWDAF ML Model Provision Subscription" according to the information in message body. + +The NnwdafMLModelProvSubsc data structure provided in the request body shall include: + +- an URI where to receive the requested notifications as the "notifiUri" attribute; and +- a description of the subscribed events as the "mLEventSubscs" attribute that, for each event, the MLEventSubscription data type shall include: + - 1) an event identifier as the "mLEvent" attribute; and + - 2) event filter information as the "mLEventFilter" attribute; + +and may include: + +- 1) an identification of target UE information as the "tgtUe" attribute; +- 2) a time interval for which the ML model for the analytics is requested as the "mLTargetPeriod" attribute; +- 3) the time when the subscription expired as the "expiryTime" attribute; +- 4) the ML model metric as the "modelMetric" attribute if the "FederatedLearning" feature or the "ModelProvisionExt" feature is supported; +- 5) a pre-determined status for the ML model or training as the "preDetStatus" attribute if the "FederatedLearning" feature is supported; and +- 6) the ML event reporting condition as the "mLEvRepCon" if the "FederatedLearning" feature or the "ModelProvisionExt" feature is supported. +- 7) the ML Model Interoperability Information as the "modelInterInfo" attribute if the "ModelSharing" feature is supported; and +- 8) NF consumer information as the "nfConsumerInfo" attributed if the "ModelSharing" feature is supported. +- 9) use case context as "useCaseCxt" attribute, if the "ENAExt" feature is supported. + +NOTE 1: The NWDAF containing MTLF can use the "useCaseCxt" attribute to select the most relevant ML model, when several ML models are available for the requested Analytics ID(s). The values of this parameter are not standardized. + +- 10) extended parameters for ML model provisioning as the "modelProvExt" attribute, if the feature "ModelProvisionExt" is supported; +- 11) UTC time indicating the time when the ML model is needed as the "timeModelNeeded" attribute. +- 12) the inference data stored in ADRF which can be used by MTLF as the "inferDataForModel" attribute, if the feature "ModelProvisionExt" is supported. + +The NwdafMLModelProvSubsc data structure provided in the request body may include: + +- a notification correlation identifier assigned by the NF service consumer for the requested notifications as "notifCorreId" attribute; and +- the reporting requirement information of the subscription as the "eventReq" attribute. + +For different event types, the filter information in "mLEventFilter" attribute within the MLEventSubscription data type is the same as described in clause 4.3.2.2.2 for the filter information contained in "event-filter" attribute. + +NOTE 2: The features described in clause 4.3.2.2.2 has no impact on this service. + +**Editor's Note:** The type EventFilter includes attributes (and/or attributes within attributes) that have been introduced in Rel-18. For these attributes, the present API shall either define new features to indicate that the attributes are supported based on these features or it shall indicate that they are not applicable. This feature handling is FFS. + +Upon the reception of an HTTP POST request with: + +"{apiRoot}/nnwdaf-mlmodelprovision//subscriptions" as Resource URI and NwdafMLModelProvSubsc data structure as request body, the NWDAF shall create a new subscription and store the subscription. + +If the NWDAF created an "Individual NWDAF ML Model Provision Subscription" resource, the NWDAF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.5.2.2.2-1, step 2. The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. + +"{apiRoot}/nnwdaf-mlmodelprovision//subscriptions/{subscriptionId}". + +If the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute sets to true during the event subscription, the NWDAF shall include the reports of the subscribed events, if available, as the "mLEventNotifs" attribute in the HTTP POST response. + +If not all the requested events in the subscription are accepted, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). + +If there is no associated ML model available for all the listed "mLEvent" attribute, the NWDAF which contains MTLF shall send a "500 Internal Server Error" status code to the NF service consumer. Also, the corresponding failure reason via a "problemDetails" attribute with the "cause" attribute set to "UNAVAILABLE\_ML\_MODEL\_FOR\_ALLEVENTS". + +If other errors occur when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.4.7. + +#### 4.5.2.2.3 Update subscription for event notifications + +Figure 4.5.2.2.3-1 shows a scenario that the NF service consumer sends an HTTP PUT request to the NWDAF to modify an existing subscription (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the NWDAF. The NWDAF responds with either a 204 No Content or a 200 OK status.](3198cdf0dbe501c46fe0e4073c7d8451_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NWDAF: 1. PUT.../subscriptions/{subscriptionId} + NWDAF-->>NF service consumer: 2a. "204 No Content" +2b. "200 OK" + +``` + +Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the NWDAF. The NWDAF responds with either a 204 No Content or a 200 OK status. + +**Figure 4.5.2.2.3-1: Modification of events subscription information using HTTP PUT** + +The NF service consumer shall invoke the Nnwdaf\_MLModelProvision\_Subscribe service operation to modify an existing ML Model subscription. The NF service consumer shall send an HTTP PUT request with: "{apiRoot}/nnwda-mlmodelprovision//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription to be modified, to update an "Individual NWDAF ML Model Provision Subscription" according to the information in the message body. The NwdafMLModelProvSubsc data structure provided in the request body shall include the same contents as described in clause 4.5.2.2.2. + +Upon receipt of an HTTP PUT request with: "{apiRoot}/nnwda-mlmodelprovision//subscriptions/{subscriptionId}" as Resource URI and NwdafMLModelProvSubsc data type as request body, if the request is successfully processed and accepted, the NWDAF shall: + +- modify the concerned subscription; and +- store the subscription. + +NOTE: The "notifUri" attribute within the NwdafMLModelProvSubsc data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +If the NWDAF successfully processed and accepted the received HTTP PUT request, the NWDAF shall update an "Individual NWDAF ML Model Provision Subscription" resource, and shall respond with: + +- HTTP "204 No Content" response (as shown in figure 4.5.2.2.3-1, step 2a); or +- HTTP "200 OK" response (as shown in figure 4.5.2.2.3-1, step 2b) with a response body containing a representation of the updated subscription in the NwdafMLModelProvSubsc data type. + +If not all the requested events in the subscription are modified successfully, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). + +If other errors occur when processing the HTTP PUT request, the NWDAF shall send an HTTP error response as specified in clause 5.4.7. + +If the NWDAF determines that the received HTTP PUT request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +## 4.5.2.3 Nnwdaf\_MLModelProvision\_Unsubscribe service operation + +### 4.5.2.3.1 General + +The Nnwdaf\_MLModelProvision\_Unsubscribe service operation is used by an NF service consumer to unsubscribe from event notifications. + +### 4.5.2.3.2 Unsubscribe from event notifications + +Figure 4.5.2.3.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to unsubscribe from event notifications (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the NF service consumer unsubscribing from notifications. The NF service consumer sends a DELETE request to the NWDAF, and the NWDAF responds with a 204 No Content.](18bb06865e2dada3656ea3d57f290f7f_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + Note right of NWDAF: + NF service consumer->>NWDAF: 1. DELETE« /subscriptions/{subscriptionId} + NWDAF-->>NF service consumer: 2. 204 No Content + +``` + +Sequence diagram showing the NF service consumer unsubscribing from notifications. The NF service consumer sends a DELETE request to the NWDAF, and the NWDAF responds with a 204 No Content. + +**Figure 4.5.2.3.2-1: NF service consumer unsubscribes from notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelProvision\_Unsubscribe service operation to unsubscribe to event notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nnwdaf-mlmodelprovision//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- remove the corresponding subscription; and +- respond with HTTP "204 No Content" status code. + +If the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If errors occur when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.4.7. + +#### 4.5.2.4 Nnwdaf\_MLModelProvision\_Notify service operation + +##### 4.5.2.4.1 General + +The Nnwdaf\_MLModelProvision\_Notify service operation is used by an NWDAF to notify NF consumers about subscribed events. + +##### 4.5.2.4.2 Notification about subscribed event + +Figure 4.5.2.4.2-1 shows a scenario where the NWDAF sends a request to the NF Service Consumer to notify for event notifications (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the NWDAF notifying the subscribed event. The NWDAF sends a request to the NF Service Consumer, and the NF Service Consumer responds with a response.](bbe5fb08522c43eab0afefcac30e719b_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + Note right of NWDAF: + NWDAF->>NF service consumer: 1. POST /subscriptions/{subscriptionId} + NF service consumer-->>NWDAF: 2. Response + +``` + +Sequence diagram showing the NWDAF notifying the subscribed event. The NWDAF sends a request to the NF Service Consumer, and the NF Service Consumer responds with a response. + +**Figure 4.5.2.4.2-1: NWDAF notifies the subscribed event** + +The NWDAF shall invoke the Nnwdaf\_MLModelProvision\_Notify service operation to notify the subscribed event. The NWDAF shall send an HTTP POST request with "{notifUri}" received in the Nnwdaf\_MLModelProvision\_Subscribe service operation as Resource URI, as shown in figure 4.2.2.4.2-1, step 1. The NnwdafMLModelProvNotif data structure provided in the request body that shall include: + +- an event subscriptionId as "subscriptionId" attribute; and + +- description of the notified event as "eventNotifs" attribute, that for each event, the MLEventNotif data type shall include an event identifier as the "event" attribute, an address (e.g. a URL or an FQDN) of the ML model file as the "mlFileAddr" attribute or (if the "ModelProvisionExt" feature is supported) ADRF ID as the "adrId" attribute or ADRF Set ID as the "adrSetId" attribute, and may include a notification correlation identifier as "notifCorrId" attribute and a time period when the provided ML model applies as the "validityPeriod" attribute and an area where the provided ML model applies as the "spatialValidity" attribute and (if the "ModelProvisionExt" feature is supported) Storage Transaction ID when the ADRF (Set) ID (i.e. "adrId" or "adrSetId" attribute) is provided as the "storTransId" attribute. If the feature "ModelProvisionExt" is supported, may also include additional ML model information as "addModelInfo" attribute. + +Upon the reception of an HTTP POST request, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall store the notification and respond with HTTP "204 No Content" status code. + +If the NF service consumer receives the ADRF ID as the "adrId" attribute or the ADRF Set ID as the "adrSetId" attribute in the NwdafMLModelProvNotif data structure of the HTTP POST request, it may invoke Nadrf\_MLModelManagement\_RetrievalRequest service operation to retrieve ML Model from the ADRF (Set) as specified in 3GPP TS 29.575 [27]. + +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 [6]. + +If errors occur when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.4.7. + +## 4.6 Nnwdaf\_MLModelTraining Service + +### 4.6.1 Service Description + +#### 4.6.1.1 Overview + +The Nnwdaf\_MLModelTraining service as defined in 3GPP TS 23.288 [17], is provided by the Network Data Analytics Function (NWDAF) containing Model Training Logical Function (MTLF). + +This service: + +- allows the NF service consumers to subscribe to and unsubscribe from different ML model training events; +- allows the NF service consumers to modify different ML model training events; and +- notifies the NF service consumers with a corresponding subscription about ML model information. + +#### 4.6.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 [17]. The ML Model training signalling flows are defined in 3GPP TS 29.552 [25]. + +The Nnwdaf\_MLModelTraining service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF) containing Model Training Logical Function (MTLF). + +Known consumers of the Nnwdaf\_MLModelTraining service are: + +- Network Data Analytics Function (NWDAF) containing Model Training Logical Function (MTLF) + +![Figure 4.6.1.2-1: Reference Architecture for the Nnwdaf_MLModelTraining Service; SBI representation. The diagram shows two rectangular boxes labeled 'NWDAF (MTLF)'. Between them is an oval labeled 'Nnwdaf'. An arrow points from the bottom box to the oval, and another arrow points from the oval to the top box. The label 'Nnwdaf_MLModelTraining' is placed next to the top arrow.](e7010c66da16316c2935dfbbef5056b3_img.jpg) + +Figure 4.6.1.2-1: Reference Architecture for the Nnwdaf\_MLModelTraining Service; SBI representation. The diagram shows two rectangular boxes labeled 'NWDAF (MTLF)'. Between them is an oval labeled 'Nnwdaf'. An arrow points from the bottom box to the oval, and another arrow points from the oval to the top box. The label 'Nnwdaf\_MLModelTraining' is placed next to the top arrow. + +**Figure 4.6.1.2-1: Reference Architecture for the Nnwdaf\_MLModelTraining Service; SBI representation** + +![Figure 4.6.1.2-2: Reference Architecture for the Nnwdaf_MLModelTraining Service: reference point representation. The diagram shows two rectangular boxes labeled 'NWDAF (MTLF)'. A vertical line connects the top box to the bottom box, with a horizontal crossbar in the middle, representing a reference point.](20cb2d2cc18d663dc1b82453c67250bb_img.jpg) + +Figure 4.6.1.2-2: Reference Architecture for the Nnwdaf\_MLModelTraining Service: reference point representation. The diagram shows two rectangular boxes labeled 'NWDAF (MTLF)'. A vertical line connects the top box to the bottom box, with a horizontal crossbar in the middle, representing a reference point. + +**Figure 4.6.1.2-2: Reference Architecture for the Nnwdaf\_MLModelTraining Service: reference point representation** + +#### 4.6.1.3 Network Functions + +##### 4.6.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF), containing Model Training Logical Function (MTLF), provides ML model information for different analytic events to NF service consumers. + +The Network Data Analytics Function (NWDAF) allows NF service consumers to subscribe to and unsubscribe from one-time, periodic notification or notification when an event is detected. + +##### 4.6.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF) supports (un)subscription to the notification of different ML model information from the NWDAF which contains Model Training Logical Function (MTLF). + +#### 4.6.2 Service Operations + +##### 4.6.2.1 Introduction + +**Table 4.6.2.1-1: Operations of the Nnwdaf\_MLModelTraining Service** + +| Service operation name | Description | Initiated by | +|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| Nnwdaf_MLModelTraining_Subscribe | This service operation is used by an NF service consumer to subscribe to ML model training from NWDAF. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelTraining_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe to ML model training. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelTraining_Notify | This service operation is used by the NWDAF to notify the ML model information to the NF service consumer instance which has subscribed to. | NWDAF | + +## 4.6.2.2 Nnwdaf\_MLModelTraining\_Subscribe service operation + +### 4.6.2.2.1 General + +The Nnwdaf\_MLModelTraining\_Subscribe service operation is used by an NF service consumer to subscribe or update subscription for event notifications from the NWDAF which contains Model Training Logical Function (MTLF). + +### 4.6.2.2.2 Subscription for event notifications + +Figure 4.6.2.2.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to subscribe for event notification(s) (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The consumer sends a POST request to /subscriptions, and the NWDAF responds with a 201 Created status.](8a94796989f4fcba2688c4faa7991538_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + NF service consumer->>NWDAF: 1. POST « /subscriptions + Note right of NWDAF: + NWDAF-->>NF service consumer: 2. 201 Created + +``` + +Sequence diagram showing the interaction between an NF service consumer and an NWDAF. The consumer sends a POST request to /subscriptions, and the NWDAF responds with a 201 Created status. + +**Figure 4.6.2.2.2-1: NF service consumer subscribes to notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelTraining\_Subscribe service operation to subscribe to event notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwdaf-mlmodeltraining//subscriptions" as Resource URI representing the "NWDAF ML Model Training Subscriptions", as shown in figure 4.6.2.2.2-1, step 1, to create a subscription for an "Individual NWDAF ML Model Training Subscription" according to the information in message body. + +The NwdafMLModelTrainSubsc data structure provided in the request body shall include: + +- an URI where to receive the requested notifications as the "notifUri" attribute; + - a description of the subscribed events as the "mLEventSubscs" attribute that, for each event, the MLEventSubscription data type shall include: + - 1) an event identifier as the "mLEvent" attribute; + - 2) event filter information as the "mLEventFilter" attribute; and + - 3) the ML Model Interoperability Information as the "modelInterInfo" attribute; + - a notification correlation identifier assigned by the NF service consumer for the requested notifications as "notifCorreId" attribute; +- and may include: +- an identification of UE information for which data for ML model training is requested as the "tgtRepUe" attribute; + - the ML model information as the "mLModelInfos" attribute; + - the ML model training information as the "mLModelTrainInfos" attribute; + - identification of the ML procedure for training the ML model as the "mlCorreId" attribute; + - an indication of preparation request for ML model training as the "mLPreFlag" attribute; + - an indication of request using the local training data as the testing dataset to calculate the Model Accuracy of the global ML model provided by the consumer as the "mLAccChkFlg" attribute; + - the ML model training reporting information as the "mLTrainRepInfo" attribute; + - the round number of the training in a multi-round training process as the "roundInd" attribute; + - the use case context of the ML model as the "uCaseCont" attribute; and + - the reporting requirement information of the subscription as the "eventReq" attribute. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nnwdaf-mlmodeltraining//subscriptions" as Resource URI and NwdafMLModelTrainSubsc data structure as request body, the NWDAF shall create a new subscription and store the subscription. + +If the NWDAF created an "Individual NWDAF ML Model Training Subscription" resource, the NWDAF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.6.2.2.2-1, step 2. The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. "{apiRoot}/nnwdaf-mlmodeltraining//subscriptions/{subscriptionId}". + +If the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute sets to "true" during the event subscription, the NWDAF shall include the reports of the subscribed events, if available, as the "immReports" attribute in the HTTP POST response. + +NOTE: Immediate and one-time reporting can be used in order to implement the Nnwdaf\_MLModelTrainingInfo service, which is defined in 3GPP TS 23.288 [17]. + +If not all the requested events in the subscription are accepted, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). + +If there is no associated ML model training available for all provided "mLEvent" attributes, the NWDAF shall send a "500 Internal Server Error" status code to the NF service consumer, including the "cause" attribute set to "UNAVAILABLE\_ML\_MODEL\_TRAINING\_FOR\_ALLEVENTS". + +If there is no ML model training satisfying the requirements listed in "mLModelTrainInfos" attribute or the ML model cannot be downloaded successfully, the NWDAF which contains MTTF shall send a "403 Forbidden" status code to the NF service consumer, and it may send together with the corresponding failure reason via a "problemDetails" attribute with the "cause" attribute set to "ML\_MODEL\_TRAINING\_REQS\_NOT\_MET", "ML\_TRAINING\_NOT\_COMPLETE", "OVERLOAD", or "NOT\_AVAILABLE\_FOR\_FL\_PROCESS\_ANYMORE". + +If other errors occur when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.5.7. + +#### 4.6.2.2.3 Update subscription for event notifications + +Figure 4.6.2.2.3-1 shows a scenario that the NF service consumer sends an HTTP PUT request to the NWDAF to modify an existing subscription (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the NWDAF, and the NWDAF responds with either a 204 No Content or a 200 OK status code.](f40480872b021d2ac7c29202c199b695_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. PUT.../subscriptions/{subscriptionId} + NF service consumer->>NWDAF: 1. PUT.../subscriptions/{subscriptionId} + Note right of NWDAF: 2a. "204 No Content" +2b. "200 OK" + NWDAF-->>NF service consumer: 2a. "204 No Content" +2b. "200 OK" + +``` + +Sequence diagram showing the modification of events subscription information using HTTP PUT. The NF service consumer sends a PUT request to the NWDAF, and the NWDAF responds with either a 204 No Content or a 200 OK status code. + +**Figure 4.6.2.2.3-1: Modification of events subscription information using HTTP PUT** + +The NF service consumer shall invoke the Nnwdaf\_MLModelTraining\_Subscribe service operation to modify an existing ML Model Training subscription. The NF service consumer shall send an HTTP PUT request with: "{apiRoot}/nnwdaf-mlmodeltraining//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription to be modified, to update an "Individual NWDAF ML Model Training Subscription" according to the information in the message body. The NwdafMLModelTrainSubsc data structure provided in the request body shall include the same contents as described in clause 4.6.2.2.2. + +Upon receipt of an HTTP PUT request with: "{apiRoot}/nnwdaf-mlmodeltraining//subscriptions/{subscriptionId}" as Resource URI and NwdafMLModelTrainSubsc data type as request body, if the request is successfully processed and accepted, the NWDAF shall: + +- modify the concerned subscription; and + +- store the subscription. + +If the NWDAF successfully processed and accepted the received HTTP PUT request, the NWDAF shall update an "Individual NWDAF ML Model Training Subscription" resource, and shall respond with: + +- HTTP "204 No Content" response (as shown in figure 4.6.2.2.3-1, step 2a); or +- HTTP "200 OK" response (as shown in figure 4.6.2.2.3-1, step 2b) with a response body containing a representation of the updated subscription in the NwdafMLModelTrainSubsc data type. + +If not all the requested events in the subscription are modified successfully, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). + +If the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute sets to "true" during the event subscription update, the NWDAF shall include the reports of the subscribed events, if available, as the "immReports" attribute in the HTTP PUT response. + +NOTE: Immediate and one-time reporting can be used in order to implement the Nnwdaf\_MLModelTrainingInfo service, which is defined in 3GPP TS 23.288 [17]. + +If there is no associated ML model training available for all provided "mLEvent" attributes, the NWDAF shall send a "500 Internal Server Error" status code to the NF service consumer, including the "cause" attribute set to "UNAVAILABLE\_ML\_MODEL\_TRAINING\_FOR\_ALLEVENTS". + +If other errors occur when processing the HTTP PUT request, the NWDAF shall send an HTTP error response as specified in clause 5.5.7. + +If the NWDAF determines that the received HTTP PUT request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.6.2.2.4 Partial update subscription for event notifications + +Figure 4.6.2.2.4-1 shows a scenario that the NF service consumer sends an HTTP PATCH request to the NWDAF to partial modify an existing subscription (as shown in 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and the NWDAF for partial modification of an event subscription. The consumer sends a PATCH request to a subscription ID, and the NWDAF responds with either a 204 No Content or a 200 OK status.](05da2a3257316bbf6f448a830dc0380a_img.jpg) + +``` + +sequenceDiagram + participant NF as NF service consumer + participant NWDAF as NWDAF + Note right of NWDAF: 1. PATCH.../subscriptions/{subscriptionId} + NWDAF->>NF: 2a. "204 No Content" +2b. "200 OK" + +``` + +Sequence diagram showing the interaction between an NF service consumer and the NWDAF for partial modification of an event subscription. The consumer sends a PATCH request to a subscription ID, and the NWDAF responds with either a 204 No Content or a 200 OK status. + +**Figure 4.6.2.2.4-1: Partial modification of events subscription information using HTTP PATCH** + +The NF service consumer shall invoke the Nnwdaf\_MLModelTraining\_Subscribe service operation to partial modify an existing ML Model Training subscription. The NF service consumer shall send an HTTP PATCH request with: "{apiRoot}/nnwda-mlmodeltraining//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription to be modified, to update an "Individual NWDAF ML Model Training Subscription" according to the information in the message body. + +Upon receipt of an HTTP PATCH request with: "{apiRoot}/nnwda-mlmodeltraining//subscriptions/{subscriptionId}" as Resource URI and NwdafMLModelTrainSubscPatch data type as request body, if the request is successfully processed and accepted, the NWDAF shall: + +- partial modify the concerned subscription; and +- store the subscription. + +If the NWDAF successfully processed and accepted the received HTTP PATCH request, the NWDAF shall partial update an "Individual NWDAF ML Model Training Subscription" resource, and shall respond with: + +- HTTP "204 No Content" response (as shown in figure 4.6.2.2.4-1, step 2a); or +- HTTP "200 OK" response (as shown in figure 4.6.2.2.4-1, step 2b) with a response body containing a representation of the updated subscription in the NwdafMLModelTrainSubsc data type. + +If not all the requested events in the subscription are modified successfully, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). + +If the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute sets to "true" during the event subscription update, the NWDAF shall include the reports of the subscribed events, if available, as the "immReports" attribute in the HTTP PUT response. + +NOTE: Immediate and one-time reporting can be used in order to implement the Nnwdaf\_MLModelTrainingInfo service, which is defined in 3GPP TS 23.288 [17]. + +If there is no associated ML model training available for all provided "mLEvent" attributes, the NWDAF shall send a "500 Internal Server Error" status code to the NF service consumer, including the "cause" attribute set to "UNAVAILABLE\_ML\_MODEL\_TRAINING\_FOR\_ALLEVENTS". + +If other errors occur when processing the HTTP PATCH request, the NWDAF shall send an HTTP error response as specified in clause 5.5.7. + +If the NWDAF determines that the received HTTP PATCH request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.6.2.3 Nnwdaf\_MLModelTraining\_Unsubscribe service operation + +##### 4.6.2.3.1 General + +The Nnwdaf\_MLModelTraining\_Unsubscribe service operation is used by an NF service consumer to unsubscribe from event notifications. + +##### 4.6.2.3.2 Unsubscribe from event notifications + +Figure 4.6.2.3.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to unsubscribe from event notifications (see also 3GPP TS 23.288 [17]). + +![Sequence diagram showing the interaction between an NF service consumer and the NWDAF for unsubscribing from notifications. The consumer sends a DELETE request to the NWDAF, and the NWDAF responds with a 204 No Content status.](f59ced6eaab3181501fc23fdfb52297e_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant NWDAF + Note left of NF service consumer: + Note right of NWDAF: + NF service consumer->>NWDAF: 1. DELETE« /subscriptions/{subscriptionId} + NWDAF-->>NF service consumer: 2. 204 No Content +``` + +Sequence diagram showing the interaction between an NF service consumer and the NWDAF for unsubscribing from notifications. The consumer sends a DELETE request to the NWDAF, and the NWDAF responds with a 204 No Content status. + +**Figure 4.6.2.3.2-1: NF service consumer unsubscribes from notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelTraining\_Unsubscribe service operation to unsubscribe to event notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nnwdaf-mlmodeltraining//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- remove the corresponding subscription; and +- respond with HTTP "204 No Content" status code. + +If the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If errors occur when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.5.7. + +#### 4.6.2.4 Nnwdaf\_MLModelTraining\_Notify service operation + +##### 4.6.2.4.1 General + +The Nnwdaf\_MLModelTraining\_Notify service operation is used by an NWDAF to notify NF consumers about subscribed events. + +##### 4.6.2.4.2 Notification about subscribed event + +Figure 4.6.2.4.2-1 shows a scenario where the NWDAF sends a request to the NF Service Consumer to notify for event notifications (see also 3GPP TS 23.288 [17]). + +![Diagram showing a box labeled 'Nnwdaf_MLModelTraining_Notify' with a redacted area.](f92e919c70b7adda2d0e778889f44fae_img.jpg) + +The diagram shows a rectangular box with a black border. Inside the box, the text "Nnwdaf\_MLModelTraining\_Notify" is partially visible, with a black rectangle obscuring the beginning of the text. To the right of the box, there is a small vertical line and a square box, likely representing a sequence diagram element or a placeholder for a figure. + +Diagram showing a box labeled 'Nnwdaf\_MLModelTraining\_Notify' with a redacted area. + +**Figure 4.6.2.4.2-1: NWDAF notifies the subscribed event** + +The NWDAF shall invoke the Nnwdaf\_MLModelTraining\_Notify service operation to notify the subscribed event. The NWDAF shall send an HTTP POST request with "{notifUri}" received in the Nnwdaf\_MLModelTraining\_Subscribe service operation as Resource URI, as shown in figure 4.6.2.4.2-1, step 1. The NwdafMLModelTrainNotif data structure provided in the request body that shall include: + +- a notification correlation identifier as "notifCorreId" attribute; +- at least one of the notification detailed information: + - description of the notified event as "mLModelInfos" attribute; + - a delay event notification for training the ML model as "delayEventNotif" attribute when the service is for Federated Learning; + - an indication that the subscription is requested to be terminated, i.e. no further notifications related to this subscription will be provided, as "termTrainReq"; + +and may include: + +- an identification of the Machine Learning procedure for training the ML model as "mlCorreId" attribute when the service is for Federated Learning; +- an identification of the round number of the training in a multi-round training process as "roundInd" attribute; +- the status report for the ML model training as "statusReport" attribute when the service is for Federated Learning; and/or +- an indication of the use case context of the ML model as "uCaseCont". + +Upon the reception of an HTTP POST request, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall store the notification and respond with HTTP "204 No Content" status code. + +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 [6]. + +If errors occur when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.5.7. + +## 4.7 Nnwdaf\_ MLModelMonitor Service + +### 4.7.1 Service Description + +#### 4.7.1.1 Overview + +The Nnwdaf\_ MLModelMonitor service as defined in 3GPP TS 23.288 [17], is provided by the Network Data Analytics Function (NWDAF). + +This service: + +- allows the NWDAF containing AnLF to register the use and monitoring capability of the analytics accuracy of an ML Model at the NWDAF containing MTLF; +- allows the NWDAF containing AnLF to deregister a previous registration of the monitoring capability of the analytics accuracy of an ML Model at the NWDAF containing MTLF; +- allows the NF service consumer (i.e. NWDAF containing MTLF) to subscribe to and unsubscribe from the analytics accuracy monitoring event of an ML Model and analytics feedback information from the NWDAF containing AnLF; +- allows the NF service consumer (i.e. NWDAF containing MTLF) to modify an analytics accuracy monitoring event of an ML Model and analytics feedback information from the NWDAF containing AnLF; and +- allow the NWDAF containing AnLF notifies the NF service consumer (i.e. NWDAF containing MTLF) about the monitored analytics accuracy information of an ML Model and/or analytics feedback information. + +#### 4.7.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 [17]. + +The Nnwdaf\_ MLModelMonitor service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF). + +Known consumers of the Nnwdaf\_ MLModelMonitor service are: + +- Network Data Analytics Function (NWDAF) + +![Reference Architecture for the Nnwdaf_ MLModelMonitor Service; SBI representation](b327d9f0565f7e032fc82b4322c844dc_img.jpg) + +The diagram illustrates the Service Based Interface (SBI) representation of the service architecture. At the top is a rectangular box labeled 'NWDAF(AnLF)'. Below it is an oval labeled 'Nnwdaf', which represents the service interface. A vertical line connects the 'Nnwdaf' oval to a rectangular box at the bottom labeled 'NWDAF(MTLF)'. This vertical line is labeled 'Nnwdaf\_ MLModelMonitor', indicating the specific service provided. + +Reference Architecture for the Nnwdaf\_ MLModelMonitor Service; SBI representation + +**Figure 4.7.1.2-1: Reference Architecture for the Nnwdaf\_ MLModelMonitor Service; SBI representation** + +![Reference Architecture for the Nnwdaf_ MLModelMonitor Service: reference point representation](5ba26df60eea8e9b4688559e47cd9c0f_img.jpg) + +The diagram illustrates the reference point representation of the service architecture. It consists of two rectangular boxes. The top box is labeled 'NWDAF(AnLF)' and the bottom box is labeled 'NWDAF(MTLF)'. A vertical line connects the two boxes, with a small horizontal tick mark in the middle, representing a reference point between the two network functions. + +Reference Architecture for the Nnwdaf\_ MLModelMonitor Service: reference point representation + +**Figure 4.7.1.2-2: Reference Architecture for the Nnwdaf\_ MLModelMonitor Service: reference point representation** + +### 4.7.1.3 Network Functions + +#### 4.7.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF) containing MTLF allows NWDAF containing AnLF to register the use and monitoring capability of the analytics accuracy of an ML Model. + +The Network Data Analytics Function (NWDAF) containing AnLF allows NF service consumer (i.e. NWDAF containing MTLF) to subscribe to and unsubscribe from notification of monitored analytics accuracy information of an ML Model and analytics feedback information. + +#### 4.7.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF) containing MTLF supports (un)subscription to the notification of analytics accuracy monitoring of an ML Model and analytics feedback information. + +### 4.7.2 Service Operations + +#### 4.7.2.1 Introduction + +**Table 4.7.2.1-1: Operations of the Nnwdaf\_MLModelMonitor Service** + +| Service operation name | Description | Initiated by | +|-----------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| Nnwdaf_MLModelMonitor_Register | This service operation is used by an NF service consumer to register the monitoring capability of the analytics accuracy of an ML Model at an NWDAF containing MTLF. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelMonitor_Deregister | This service operation is used by an NF service consumer to deregister a previous registration from an NWDAF containing MTLF. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelMonitor_Subscribe | This service operation is used by an NF service consumer to subscribe to the analytics accuracy monitoring event of an ML Model. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelMonitor_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe from the analytics accuracy monitoring event of an ML Model. | NF service consumer (NWDAF) | +| Nnwdaf_MLModelMonitor_Notify | This service operation is used by the NWDAF to notify the monitored analytics accuracy information of an ML Model. | NWDAF | + +#### 4.7.2.2 Nnwdaf\_MLModelMonitor\_Register service operation + +##### 4.7.2.2.1 General + +The Nnwdaf\_MLModelMonitor\_Register service operation is used by an NF service consumer (i.e. NWDAF containing AnLF) to register the monitoring capability of the analytics accuracy of an ML Model and analytics feedback information. + +##### 4.7.2.2.2 Registering the monitoring of the analytics accuracy of an ML Model + +Figure 4.7.2.2.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF containing MTLF to register the use and monitoring capability of the analytics accuracy of an ML Model. + +![Sequence diagram showing the registration of an ML model. The NF Service Consumer sends a POST request to the NWDAF, and the NWDAF responds with a 201 Created status.](f61d0925551545b5938b3a4d1bbf63c3_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NWDAF + Note right of NF Service Consumer: 1. POST « registrations » + NF Service Consumer->>NWDAF: 1. POST « registrations » + Note left of NWDAF: 2. "201 Created" + NWDAF-->>NF Service Consumer: 2. "201 Created" + +``` + +Sequence diagram showing the registration of an ML model. The NF Service Consumer sends a POST request to the NWDAF, and the NWDAF responds with a 201 Created status. + +**Figure 4.7.2.2.2-1: NF service consumer registers the use and monitoring capability of the analytics accuracy of an ML Model** + +The NF service consumer shall invoke the Nnwdaf\_MLModelMonitor\_Register service operation to register the use and indicate the monitoring capability of the analytics accuracy of an ML Model and analytics feedback information. The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwda-mlmodelmonitor//registrations" as Resource URI representing the "NWDAF ML model monitoring registrations", as shown in figure 4.7.2.2.2-1, step 1, to create an "Individual NWDAF ML model monitoring registration" according to the information in the message body. The MLModelMonitorReg data structure provided in the request body shall include: + +- the ML model ID within the "modelId" attribute; and +- one of the following identifiers related to the NF service consumer: + - the NF instance ID of the consumer within the "consumerId" attribute; + - NF set ID of the consumer within the "consumerSetId" attribute. + +and may include: + +- ML Model accuracy transfer indication within the "modelAccuInd" attribute. + +Upon the reception of an HTTP POST request with "{apiRoot}/nnwda-mlmodelmonitor//registrations" as Resource URI and MLModelMonitorReg data structure as request body, the NWDAF shall: + +- create a new registration; +- assign a registrationId; +- store the registration information. + +If the NWDAF created an "Individual NWDAF ML model monitoring registration" resource, the NWDAF shall respond with "201 Created" with the message body containing a representation of the created registration, as shown in figure 4.7.2.2.2-1, step 2. The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created profile, i.e. "{apiRoot}/nnwda-mlmodelmonitor//registrations/{registrationId}". + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +#### 4.7.2.3 Nnwdaf\_MLModelMonitor\_Deregister service operation + +##### 4.7.2.3.1 General + +The Nnwdaf\_MLModelMonitor\_Deregister service operation is used by an NF service consumer (i.e. NWDAF containing AnLF) to deregister a previous registration from an NWDAF containing MTLF. + +##### 4.7.2.3.2 Deregistering the monitoring of the analytics accuracy of an ML Model + +Figure 4.7.2.3.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF containing MTLF to deregister the use or monitoring capability of the analytics accuracy of an ML Model. + +![Sequence diagram showing the deregistration of an ML model monitoring capability. The NF Service Consumer sends a DELETE request for a specific registration ID to the NWDAF, which responds with a 204 No Content status.](3750b0149a6380885998ab3ca6a8787c_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant NWDAF + Note right of NF Service Consumer: 1. DELETE « registrations/registrationId » + NF Service Consumer->>NWDAF: 1. DELETE « registrations/registrationId » + Note left of NWDAF: 2. "204 No Content" + NWDAF-->>NF Service Consumer: 2. "204 No Content" +``` + +Sequence diagram showing the deregistration of an ML model monitoring capability. The NF Service Consumer sends a DELETE request for a specific registration ID to the NWDAF, which responds with a 204 No Content status. + +**Figure 4.7.2.3.2-1: NF service consumer deregisters the use or monitoring capability of the analytics accuracy of an ML Model** + +The NF service consumer shall invoke the Nnwdaf\_MLModelMonitor\_Deregister service operation to delete a registration of the use or monitoring capability of the analytics accuracy of an ML Model. The NF service consumer shall send an HTTP DELETE request with + +"`{apiRoot}/nnwda-mlmodelmonitor//registrations/{registrationId}`" as Resource URI representing an "Individual NWDAF ML model monitoring registration" resource, as shown in figure 4.7.2.3.2-1, step 1, where "`{registrationId}`" is the identifier of the existing registration that is to be deleted. + +Upon the reception of an HTTP DELETE request with + +"`{apiRoot}/nnwda-mlmodelmonitor//registrations/{registrationId}`" as Resource URI, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- remove the corresponding registration; +- respond with HTTP "204 No Content" status. + +If the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4]. + +If errors occur when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +#### 4.7.2.4 Nnwdaf\_MLModelMonitor\_Subscribe service operation + +##### 4.7.2.4.1 General + +The Nnwdaf\_MLModelMonitor\_Subscribe service operation is used by an NF service consumer (i.e NWDAF containing MTLF) to subscribe or update subscription for analytics accuracy monitoring event of an ML Model and analytics feedback information. + +##### 4.7.2.4.2 Subscription for monitoring notifications + +Figure 4.7.2.4.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF containing AnLF to subscribe for event notification(s) and analytics feedback information. + +![Sequence diagram showing the NF service consumer subscribing to notifications from the NWDAF. Step 1: POST « subscriptions » from NF Service Consumer to NWDAF. Step 2: 201 Created response from NWDAF to NF Service Consumer.](38d82ffe820e339811b396206f40a201_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NWDAF + Note right of NF Service Consumer: 1. POST « subscriptions » + NF Service Consumer->>NWDAF: 1. POST « subscriptions » + Note left of NWDAF: 2. "201 Created" + NWDAF-->>NF Service Consumer: 2. "201 Created" + +``` + +Sequence diagram showing the NF service consumer subscribing to notifications from the NWDAF. Step 1: POST « subscriptions » from NF Service Consumer to NWDAF. Step 2: 201 Created response from NWDAF to NF Service Consumer. + +**Figure 4.7.2.4.2-1: NF service consumer subscribes to notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelMonitor\_Subscribe service operation to subscribe to event notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwda-mlmodelmonitor//subscriptions" as Resource URI representing the "NWDAF ML model monitoring Subscriptions", as shown in figure 4.7.2.4.2-1, step 1, to create a subscription for an "Individual NWDAF ML model monitoring Subscription" according to the information in message body. The MLModelMonitorSub data structure provided in the request body shall include: + +- the ML model IDs within "modelIds" attribute; +- the notification URI within "notificationUri" attribute; +- the notification correlation identifier within "notifCorrId" attribute; + +and may include: + +- the ML model metrics within "modelMetric" attribute; +- the accuracy reporting threshold within "accuThreshold" attribute; +- the reporting requirements of the event subscription within "eventReportReq" attribute +- the ML model metrics within "modelMetric" attribute; + +Upon the reception of an HTTP POST request with "{apiRoot}/nnwda-mlmodelmonitor//subscriptions" as Resource URI and MLModelMonitorSub data structure as request body, the NWDAF containing AnLF shall: + +- create a new new subscription; +- assign a subscriptionId; +- store the subscription. + +If the NWDAF created an "Individual NWDAF ML model monitoring Subscription" resource, the NWDAF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.7.2.4.2-1, step 2. The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created profile, i.e. + +"{apiRoot}/nnwda-mlmodelmonitor//subscriptions/{subscriptionId}" + +If the immediate reporting indication in the "immRep" attribute within the "eventReportReq" attribute sets to true in the event subscription, the NWDAF shall include the reports of the events subscribed within "immReports" attribute, if available, in the HTTP POST response. + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +#### 4.7.2.4.3 Update of subscription for monitoring notifications + +Figure 4.7.2.4.3-1 shows a scenario where the NF service consumer (i.e. NWDAF containing MTLF) sends a request to the NWDAF containing AnLF to update a subscription for event notification(s). + +![Sequence diagram showing the NF service consumer sending a PUT request to the NWDAF to update a subscription. Step 1: PUT « subscriptions/{subscriptionId} from NF service consumer to NWDAF. Step 2a: 200 OK or Step 2b: 204 No Content from NWDAF back to NF service consumer.](11f18bf0233d812ad2604f88f3385d60_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NF service consumer: 1. PUT « subscriptions/{subscriptionId} + NF service consumer->>NWDAF: Request + Note left of NWDAF: 2a. "200 OK" or +2b. "204 No Content" + NWDAF-->>NF service consumer: Response + +``` + +Sequence diagram showing the NF service consumer sending a PUT request to the NWDAF to update a subscription. Step 1: PUT « subscriptions/{subscriptionId} from NF service consumer to NWDAF. Step 2a: 200 OK or Step 2b: 204 No Content from NWDAF back to NF service consumer. + +**Figure 4.7.2.4.3-1: NF service consumer updates subscription to notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelMonitor\_Subscribe service operation to update a subscription to event notification(s) by sending an HTTP PUT request with "{apiRoot}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId}" as Resource URI representing the "Individual NWDAF ML model monitoring subscription", as shown in figure 4.7.2.4.3-1, step 1, to update this "Individual NWDAF ML model monitoring subscription" according to the information in message body. The MLModelMonitorSub data structure provided in the request body shall include the same contents as in clause 4.7.2.4.2. + +Upon the reception of an HTTP PUT request with "{apiRoot}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId}" as Resource URI and MLModelMonitorSub data structure as request body, the NWDAF shall: + +- update the subscription of corresponding subscriptionId; and +- store the subscription. + +If the NWDAF successfully update the "Individual NWDAF ML model monitoring Subscription" resource, the NWDAF shall respond with "200 OK" with the message body containing a representation of the created subscription, as shown in figure 4.7.2.4.3-1, step 2a, or with "204 No Content" as shown in figure 4.7.2.4.3-1, step 2b. + +If the immediate reporting indication in the "immRep" attribute within the "eventReportReq" attribute sets to true in the request, the NWDAF shall include the reports of the events subscribed within "immReports" attribute, if available, in the HTTP PUT response. + +If an error occurs when processing the HTTP PUT request, the NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +## 4.7.2.5 Nnwdaf\_MLModelMonitor\_Unsubscribe service operation + +### 4.7.2.5.1 General + +The Nnwdaf\_MLModelMonitor\_Unsubscribe service operation is used by an NF service consumer (i.e. NWDAF containing MTTF) to unsubscribe from analytics accuracy monitoring event of an ML Model. + +### 4.7.2.5.2 Unsubscribe from monitoring notifications + +Figure 4.7.2.5.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF containing AnLF to unsubscribe from notifications. + +![Sequence diagram showing the NF service consumer unsubscribing from notifications. The NF Service Consumer sends a DELETE request for subscriptions/subscriptionId to the NWDAF, which responds with 204 No Content.](1e5a58dcaf0936bf18dc3dd0d9cd43ff_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NWDAF + Note right of NF Service Consumer: 1. DELETE « subscriptions/subscriptionId » + NF Service Consumer->>NWDAF: 1. DELETE « subscriptions/subscriptionId » + Note left of NWDAF: 2. "204 No Content" + NWDAF-->>NF Service Consumer: 2. "204 No Content" + +``` + +Sequence diagram showing the NF service consumer unsubscribing from notifications. The NF Service Consumer sends a DELETE request for subscriptions/subscriptionId to the NWDAF, which responds with 204 No Content. + +**Figure 4.7.2.5.2-1: NF service consumer unsubscribes from notifications** + +The NF service consumer shall invoke the Nnwdaf\_MLModelMonitor\_Unsubscribe service operation to unsubscribe to event notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscription ID of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request with: + +"{apiRoot}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId}" as Resource URI, if the NWDAF successfully processed and accepted the received HTTP DELETE request, the NWDAF shall: + +- remove the corresponding subscription; and +- respond with HTTP "204 No Content" status code. + +If the NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If an error occurs when processing the HTTP DELETE request, the NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +#### 4.7.2.6 Nnwdaf\_MLModelMonitor\_Notify service operation + +##### 4.7.2.6.1 General + +The Nnwdaf\_MLModelMonitor\_Notify service operation is used by an NWDAF containing AnLF to notify NF service consumer (i.e. NWDAF containing MTLF) about the subscribed analytics accuracy monitoring event of an ML Model. + +##### 4.7.2.6.2 Notification about subscribed event + +Figure 4.7.2.6.2-1 shows a scenario where the NWDAF containing AnLF sends a request to notify for event notifications. + +![Sequence diagram showing the NWDAF notifying the subscribed event. The NWDAF sends a POST request with notificationUri to the NF service consumer, which responds with 204 No Content.](688031e51a9a74ed869aa8405aab4e74_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant NWDAF + Note right of NWDAF: 1. POST{notificationUri} + NWDAF->>NF service consumer: 1. POST{notificationUri} + Note left of NF service consumer: 2. "204 No Content" + NF service consumer-->>NWDAF: 2. "204 No Content" + +``` + +Sequence diagram showing the NWDAF notifying the subscribed event. The NWDAF sends a POST request with notificationUri to the NF service consumer, which responds with 204 No Content. + +**Figure 4.7.2.6.2-1: NWDAF notifies the subscribed event** + +The NWDAF shall invoke the Nnwdaf\_MLModelMonitor\_Notify service operation to notify the subscribed event. The NWDAF shall send an HTTP POST request with "{notificationUri}" received in the + +Nnwdaf\_MLModelMonitor\_Notify service operation as Resource URI, as shown in figure 4.7.2.6.2-1, step 1. The MLModelMonitorNotify data structure provided in the request body that shall include: + +- a notification correlation identifier as "notifCorrId" attribute; +- at least one of: + - the accuracy related information of the ML model within "modelAccuInfos" attribute; + - the analytics feedback information within "anaFeedbacks" attribute; + +and may include: + +- the valid period within "validPeriod" attribute; + +Upon the reception of an HTTP POST request, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall store the notification and respond with HTTP "204 No Content" status code. + +If the NWDAF determines the received HTTP POST request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +## 4.8 Nnwdaf\_RoamingData Service + +### 4.8.1 Service Description + +#### 4.8.1.1 Overview + +The Nnwdaf\_RoamingData service as defined in 3GPP TS 23.288 [17], is provided by the Network Data Analytics Function (NWDAF) with roaming exchange capability, which is called Roaming Exchange NWDAF (RE-NWDAF). + +This service: + +- allows the NF service consumers to subscribe to and unsubscribe from the data of roaming UEs exposed by an RE-NWDAF; +- allows the NF service consumers to modify the subscription to the data of roaming UEs exposed by an RE-NWDAF; and +- notifies the NF service consumers about the data of roaming UEs exposed by an RE-NWDAF. + +#### 4.8.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 [17]. + +The Nnwdaf\_RoamingData service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF). + +Known consumers of the Nnwdaf\_RoamingData service are: + +- Network Data Analytics Function with Roaming Exchange capability in HPLMN(H-RE-NWDAF), collecting data from V-RE-NWDAF for outbound roaming user(s); +- Network Data Analytics Function with Roaming Exchange capability in VPLMN(V-RE-NWDAF), collecting data from H-RE-NWDAF for inbound roaming user(s); + +![Figure 4.8.1.2-1: Reference Architecture for the Nnwdaf_RoamingData Service; SBI representation. The diagram shows two vertical stacks. The left stack has a box 'V-RE-NWDAF' at the top, an oval 'Nnwdaf' inside it, and a box 'H-RE-NWDAF' at the bottom, connected by a line labeled 'Nnwdaf_RoamingData'. The right stack has a box 'H-RE-NWDAF' at the top, an oval 'Nnwdaf' inside it, and a box 'V-RE-NWDAF' at the bottom, also connected by a line labeled 'Nnwdaf_RoamingData'.](18003425d0e8638dde4acc9c5c468c5c_img.jpg) + +Figure 4.8.1.2-1: Reference Architecture for the Nnwdaf\_RoamingData Service; SBI representation. The diagram shows two vertical stacks. The left stack has a box 'V-RE-NWDAF' at the top, an oval 'Nnwdaf' inside it, and a box 'H-RE-NWDAF' at the bottom, connected by a line labeled 'Nnwdaf\_RoamingData'. The right stack has a box 'H-RE-NWDAF' at the top, an oval 'Nnwdaf' inside it, and a box 'V-RE-NWDAF' at the bottom, also connected by a line labeled 'Nnwdaf\_RoamingData'. + +**Figure 4.8.1.2-1: Reference Architecture for the Nnwdaf\_RoamingData Service; SBI representation** + +![Figure 4.8.1.2-2: Reference Architecture for the Nnwdaf_RoamingData Service: reference point representation. The diagram shows a box 'H-RE-NWDAF' at the top and a box 'V-RE-NWDAF' at the bottom, connected by a vertical line with a small horizontal tick mark in the middle.](a4eb9fe011f0e6dc8405f777c5f3f766_img.jpg) + +Figure 4.8.1.2-2: Reference Architecture for the Nnwdaf\_RoamingData Service: reference point representation. The diagram shows a box 'H-RE-NWDAF' at the top and a box 'V-RE-NWDAF' at the bottom, connected by a vertical line with a small horizontal tick mark in the middle. + +**Figure 4.8.1.2-2: Reference Architecture for the Nnwdaf\_RoamingData Service: reference point representation** + +#### 4.8.1.3 Network Functions + +##### 4.8.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF) with roaming exchange capability, i.e. the V-RE-NWDAF or H-RE-NWDAF, provides data information related to roaming UE(s) to NF service consumers. + +The Network Data Analytics Function (NWDAF) allows NF service consumers to subscribe to and unsubscribe from one-time, periodic notification or notification when an event is detected. + +##### 4.8.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF) with roaming exchange capability, i.e. the H-RE-NWDAF or V-RE-NWDAF, supports (un)subscription to the notification of the data of roaming UEs exposed by an NWDAF. + +### 4.8.2 Service Operations + +#### 4.8.2.1 Introduction + +**Table 4.8.2.1-1: Operations of the Nnwdaf\_RoamingData Service** + +| Service operation name | Description | Initiated by | +|--------------------------------|------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| Nnwdaf_RoamingData_Subscribe | This service operation is used by an NF service consumer to subscribe to the data of roaming UEs exposed by an RE-NWDAF. | NF service consumer (RE-NWDAF) | +| Nnwdaf_RoamingData_Unsubscribe | This service operation is used by an NF service consumer to unsubscribe from the data of roaming UEs exposed by an RE-NWDAF. | NF service consumer (RE-NWDAF) | +| Nnwdaf_RoamingData_Notify | This service operation is used by the NWDAF to notify the data of roaming UEs exposed by an RE-NWDAF. | RE-NWDAF | + +## 4.8.2.2 Nnwdaf\_RoamingData\_Subscribe service operation + +### 4.8.2.2.1 General + +The Nnwdaf\_RoamingData\_Subscribe service operation is used by an NF service consumer to subscribe or update subscription for the data of roaming UEs exposed by an RE-NWDAF. + +### 4.8.2.2.2 Subscription for event notifications + +Figure 4.8.2.2.2-1 shows a scenario where the NF service consumer sends a request to the RE-NWDAF to subscribe for event notification(s). + +![Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF. The consumer sends a POST request to the subscriptions resource, and the RE-NWDAF responds with a 201 Created status.](02dfdcd208dbdc8fa4f645885e59dd17_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant RE-NWDAF + Note right of NF Service Consumer: 1. POST « subscriptions » + NF Service Consumer->>RE-NWDAF: 1. POST « subscriptions » + Note left of RE-NWDAF: 2. "201 Created" + RE-NWDAF-->>NF Service Consumer: 2. "201 Created" + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF. The consumer sends a POST request to the subscriptions resource, and the RE-NWDAF responds with a 201 Created status. + +**Figure 4.8.2.2.2-1: NF service consumer subscribes to notifications** + +The NF service consumer shall invoke the Nnwdaf\_RoamingData\_Subscribe service operation to subscribe to event notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/nnwda-roamingdata//subscriptions" as Resource URI representing the "NWDAF Roaming Data Subscriptions", as shown in figure 4.8.2.2.2-1, step 1, to create a subscription for an "Individual NWDAF Roaming Data Subscription" according to the information in message body. The RoamingDataSub data structure provided in the request body shall include: + +- the notification URI within "notificationUri" attribute; +- the notification correlation identifier within "notifCorrId" attribute; +- the PLMN ID of the consumer within "plmnId" attribute; +- either the analytics subscription information to be used by the NWDAF to determine the data that can be used to generate these analytics within the "anaSub" attribute or subscribed data events within the "dataSub" attribute; + +and may include: + +- formatting instructions within the "formatInstruct" attribute; +- processing instructions within the "procInstructs" attribute; +- time window of the occurrence of the requested data collection within the "timePeriod" attribute; and +- either a target NF identifier within the "targetNfId" attribute" or a target NF set identifier within the "targetNfSetId" attribute". + +Upon the reception of an HTTP POST request with "{apiRoot}/nnwda-roamingdata//subscriptions" as Resource URI and RoamingDataSub data structure as request body, the RE-NWDAF shall: + +- create a new new subscription; +- assign a subscriptionId; +- store the subscription. + +If the RE-NWDAF created an "Individual NWDAF Roaming Data Subscription" resource, the RE-NWDAF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.8.2.2.2-1, step 2. The RE-NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created profile, i.e. + +"{apiRoot}/nnwda-roamingdata//subscriptions/{subscriptionId}" + +If the immediate reporting indication in the "immRep" attribute within the "eventReportReq" attribute sets to true in the event subscription, the NWDAF shall include the reports of the events subscribed within "immReport" attribute, if available, in the HTTP POST response. + +If an error occurs when processing the HTTP POST request, the RE-NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +#### 4.8.2.2.3 Update of subscription for event notifications + +Figure 4.8.2.2.3-1 shows a scenario where the NF service consumer sends a request to the RE-NWDAF to update a subscription for event notification(s). + +![Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF to update a subscription. The consumer sends a PUT request to 'subscriptions/{subscriptionId}' and the RE-NWDAF responds with either a 200 OK or a 204 No Content.](4390b89fdb95cba102ee1f88e218b07b_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant RE-NWDAF + Note right of RE-NWDAF: 2a."200 OK" or +2b."204 No Content" + NF Service Consumer->>RE-NWDAF: 1. PUT « subscriptions/{subscriptionId} » + RE-NWDAF-->>NF Service Consumer: 2a."200 OK" or +2b."204 No Content" + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF to update a subscription. The consumer sends a PUT request to 'subscriptions/{subscriptionId}' and the RE-NWDAF responds with either a 200 OK or a 204 No Content. + +**Figure 4.8.2.2.3-1: NF service consumer updates subscription to notifications** + +The NF service consumer shall invoke the Nnwdaf\_RoamingData\_Subscribe service operation to update a subscription to event notification(s) by sending an HTTP PUT request with "{apiRoot}/nnwdaf-roamingdata//subscriptions/{subscriptionId}" as Resource URI representing the "Individual NWDAF Roaming Data Subscription", as shown in figure 4.8.2.2.3-1, step 1, to update this "Individual NWDAF Roaming Data Subscription" according to the information in message body. The RoamingDataSub data structure provided in the request body shall include the same contents as in clause 4.8.2.2.2. + +Upon the reception of an HTTP PUT request with "{apiRoot}/nnwdaf-roamingdata//subscriptions/{subscriptionId}" as Resource URI and RoamingDataSub data structure as request body, the RE-NWDAF shall: + +- update the subscription of corresponding subscriptionId; and +- store the subscription. + +If the RE-NWDAF successfully update the "Individual NWDAF Roaming Data Subscription" resource, the RE-NWDAF shall respond with "200 OK" with the message body containing a representation of the created subscription, as shown in figure 4.8.2.2.3-1-1, step 2a, or with "204 No Content" as shown in figure 4.8.2.2.3-1-1, step 2b. + +If the immediate reporting indication in the "immRep" attribute within the "eventReportReq" attribute sets to "true" in the request, the RE-NWDAF shall include the reports of the events subscribed within "immReport" attribute, if available, in the HTTP PUT response. + +If an error occurs when processing the HTTP PUT request, the RE-NWDAF shall send an HTTP error response as specified in clause 5.7.7. + +#### 4.8.2.3 Nnwdaf\_RoamingData\_Unsubscribe service operation + +##### 4.8.2.3.1 General + +The Nnwdaf\_RoamingData\_Unsubscribe service operation is used by an NF service consumer to unsubscribe from the data of roaming UEs exposed by an RE-NWDAF. + +#### 4.8.2.3.2 Unsubscribe from event notifications + +Figure 4.8.2.3.2-1 shows a scenario where the NF service consumer sends a request to the RE-NWDAF to unsubscribe from notifications. + +![Sequence diagram showing the unsubscribe process between an NF Service Consumer and an RE-NWDAF.](67c5b121b58d497a6de5addf4e7bd555_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant RE-NWDAF + Note left of NF Service Consumer: + Note right of RE-NWDAF: + NF Service Consumer->>RE-NWDAF: 1. DELETE « subscriptions/{subscriptionId} + RE-NWDAF-->>NF Service Consumer: 2. "204 No Content" +``` + +The diagram illustrates a sequence of interactions between an NF Service Consumer and an RE-NWDAF. The NF Service Consumer sends a DELETE request for a specific subscription (step 1), and the RE-NWDAF responds with a 204 No Content status code (step 2). + +Sequence diagram showing the unsubscribe process between an NF Service Consumer and an RE-NWDAF. + +**Figure 4.8.2.3.2-1: NF service consumer unsubscribes from notifications** + +The NF service consumer shall invoke the Nnwdaf\_RoamingData\_Unsubscribe service operation to unsubscribe to event notifications. The NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nnwdaf-roamingdata//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscription ID of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request with: + +"{apiRoot}/nnwdaf-roamingdata//subscriptions/{subscriptionId}" as Resource URI, if the RE-NWDAF successfully processed and accepted the received HTTP DELETE request, the RE-NWDAF shall: + +- remove the corresponding subscription; and +- respond with HTTP "204 No Content" status code. + +If the RE-NWDAF determines the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If an error occurs when processing the HTTP DELETE request, the RE-NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +#### 4.8.2.4 Nnwdaf\_RoamingData\_Notify service operation + +##### 4.8.2.4.1 General + +The Nnwdaf\_RoamingData\_Notify service operation is used by an RE-NWDAF to notify NF service consumer about the subscribed data of roaming UEs exposed by an RE-NWDAF. + +##### 4.8.2.4.2 Notification about subscribed event + +Figure 4.8.2.4.2-1 shows a scenario where the NF service consumer sends a request to notify for event notifications. + +![Sequence diagram showing RE-NWDAF notifying the subscribed event. The diagram consists of two lifelines: 'NF service consumer' on the left and 'RE-NWDAF' on the right. Step 1: A solid arrow points from RE-NWDAF to NF service consumer with the label '1. POST{notificationUri}'. Step 2: A solid arrow points from NF service consumer to RE-NWDAF with the label '2. "204 No Content"'.](de63e4b6d8b0aa76b85e1fe3236eac27_img.jpg) + +``` +sequenceDiagram + participant RE-NWDAF + participant NF_service_consumer as NF service consumer + Note right of RE-NWDAF: 1. POST{notificationUri} + RE-NWDAF->>NF_service_consumer: 1. POST{notificationUri} + Note left of NF_service_consumer: 2. "204 No Content" + NF_service_consumer-->>RE-NWDAF: 2. "204 No Content" +``` + +Sequence diagram showing RE-NWDAF notifying the subscribed event. The diagram consists of two lifelines: 'NF service consumer' on the left and 'RE-NWDAF' on the right. Step 1: A solid arrow points from RE-NWDAF to NF service consumer with the label '1. POST{notificationUri}'. Step 2: A solid arrow points from NF service consumer to RE-NWDAF with the label '2. "204 No Content"'. + +**Figure 4.8.2.4.2-1: RE-NWDAF notifies the subscribed event** + +The RE-NWDAF shall invoke the Nnwdaf\_RoamingData\_Notify service operation to notify the subscribed event. The RE-NWDAF shall send an HTTP POST request with "{notificationUri}" received in the Nnwdaf\_RoamingData\_Notify service operation as Resource URI, as shown in figure 4.8.2.4.2-1, step 1. The HTTP POST message shall include NnwdafDataManagementNotif data structure as described in clause 5.3.6.2.2. + +Upon the reception of an HTTP POST request, if the NF service consumer successfully processed and accepted the received HTTP POST request, the NF Service Consumer shall store the notification and respond with HTTP "204 No Content" status code. + +If the RE-NWDAF determines the received HTTP POST request needs to be redirected, the RE-NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If an error occurs when processing the HTTP POST request, the RE-NWDAF shall send an HTTP error response as specified in clause 5.6.7. + +## 4.9 Nnwdaf\_RoamingAnalytics Service + +### 4.9.1 Service Description + +#### 4.9.1.1 Overview + +The Nnwdaf\_RoamingAnalytics service is provided by the Network Data Analytics Function (NWDAF) with roaming exchange capability, which is called Roaming Exchange NWDAF (RE-NWDAF). + +This service: + +- allows NF service consumers to subscribe to and unsubscribe from different analytics events related to roaming UE(s); and +- notifies NF service consumers with a corresponding subscription about observed events related to roaming UE(s). + +#### 4.9.1.2 Service Architecture + +The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture, including the case of roaming, is defined in 3GPP TS 23.288 [17]. The Network Data Analytics signalling flows are defined in 3GPP TS 29.552 [25], the Policy and Charging related 5G architecture is also described in 3GPP TS 23.503 [4] and 3GPP TS 29.513 [5]. + +The Nnwdaf\_RoamingAnalytics service is part of the Nnwdaf service-based interface exhibited by the Network Data Analytics Function (NWDAF), but it can be provided only by an NWDAF with the roaming exchange capability, which is called Roaming Exchange NWDAF (RE-NWDAF). + +The only known consumer of the Nnwdaf\_RoamingAnalytics service is the Roaming Exchange NWDAF (RE-NWDAF). + +Both the RE-NWDAF that provides the Nnwdaf\_RoamingAnalytics service and the RE-NWDAF that consumes the Nnwdaf\_RoamingAnalytics service may be in the HPLMN (in which case it is denoted as H-RE-NWDAF) or in the + +VPLMN (in which case it is denoted as H-RE-NWDAF). If the NF service producer is the H-RE-NWDAF then the NF service consumer is the V-RE-NWDAF and vice versa. + +![Two diagrams showing the SBI representation of the Nnwdaf_RoamingAnalytics service. The left diagram shows H-RE-NWDAF (Nnwdaf) as the producer and V-RE-NWDAF as the consumer. The right diagram shows V-RE-NWDAF (Nnwdaf) as the producer and H-RE-NWDAF as the consumer.](c063ca3181a644e8ae4aebfd4cb1a2c3_img.jpg) + +The diagram consists of two separate vertical connections. The left connection shows a box labeled 'H-RE-NWDAF' containing an oval labeled 'Nnwdaf' connected by a vertical line to a box labeled 'V-RE-NWDAF'. The line is labeled 'Nnwdaf\_RoamingAnalytics'. The right connection shows a box labeled 'V-RE-NWDAF' containing an oval labeled 'Nnwdaf' connected by a vertical line to a box labeled 'H-RE-NWDAF'. This line is also labeled 'Nnwdaf\_RoamingAnalytics'. + +Two diagrams showing the SBI representation of the Nnwdaf\_RoamingAnalytics service. The left diagram shows H-RE-NWDAF (Nnwdaf) as the producer and V-RE-NWDAF as the consumer. The right diagram shows V-RE-NWDAF (Nnwdaf) as the producer and H-RE-NWDAF as the consumer. + +**Figure 4.9.1.2-1: Reference Architecture for the Nnwdaf\_RoamingAnalytics Service; SBI representation** + +![Diagram showing the reference point representation of the Nnwdaf_RoamingAnalytics service. It shows H-RE-NWDAF connected to V-RE-NWDAF via a reference point symbol (a vertical line with a horizontal crossbar).](691626a7032a642bb74793336c37e274_img.jpg) + +The diagram shows a box labeled 'H-RE-NWDAF' at the top connected by a vertical line to a box labeled 'V-RE-NWDAF' at the bottom. In the middle of the vertical line is a reference point symbol, which is a horizontal line with a vertical crossbar. + +Diagram showing the reference point representation of the Nnwdaf\_RoamingAnalytics service. It shows H-RE-NWDAF connected to V-RE-NWDAF via a reference point symbol (a vertical line with a horizontal crossbar). + +**Figure 4.9.1.2-2: Reference Architecture for the Nnwdaf\_RoamingAnalytics Service: reference point representation** + +#### 4.9.1.3 Network Functions + +##### 4.9.1.3.1 Network Data Analytics Function (NWDAF) + +The Network Data Analytics Function (NWDAF) with roaming exchange capability, i.e. the RE-NWDAF, provides analytics information for different analytics events related to roaming UE(s) to NF service consumers. + +The Network Data Analytics Function (NWDAF) allows NF service consumers to subscribe to and unsubscribe from one-time, periodic notification or notification when an event is detected. + +##### 4.9.1.3.2 NF Service Consumers + +The Network Data Analytics Function (NWDAF) with roaming exchange capability, i.e. the RE-NWDAF, supports (un)subscription to the notification of analytics information for all types of network analytics related to roaming UE(s) from the NWDAF. + +## 4.9.2 Service Operations + +### 4.9.2.1 Introduction + +**Table 4.9.2.1-1: Operations of the Nnwdaf\_RoamingAnalytics Service** + +| Service operation name | Description | Initiated by | +|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------| +| Nnwdaf_RoamingAnalytics_Subscribe | This service operation is used by an NF to subscribe or update subscription for event notifications of the analytics information related to roaming UE(s).
One-time, periodic notification or notification upon event detection can be subscribed. | NF service consumer (RE-NWDAF) | +| Nnwdaf_RoamingAnalytics_Unsubscribe | This service operation is used by an NF to unsubscribe from event notifications. | NF service consumer (RE-NWDAF) | +| Nnwdaf_RoamingAnalytics_Notify | This service operation is used by an RE-NWDAF to notify NF service consumers about subscribed events. | RE-NWDAF | + +### 4.9.2.2 Nnwdaf\_RoamingAnalytics\_Subscribe service operation + +#### 4.9.2.2.1 General + +The Nnwdaf\_RoamingAnalytics\_Subscribe service operation is used by an NF service consumer to subscribe or update subscription for event notifications related to roaming UE(s) from the NWDAF. + +#### 4.9.2.2.2 Subscription for event notifications + +Figure 4.9.2.2.2-1 shows a scenario where the NF service consumer sends a request to the RE-NWDAF to subscribe for event notification(s). + +![Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF. The NF Service Consumer sends a POST request for subscriptions to the RE-NWDAF, and the RE-NWDAF responds with a 201 Created status.](d3f0eb93239fde2cb96b2baf46d62d6c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant RE-NWDAF + Note left of NF Service Consumer: NF Service Consumer + Note right of RE-NWDAF: RE-NWDAF + NF Service Consumer->>RE-NWDAF: 1. POST « subscriptions + RE-NWDAF-->>NF Service Consumer: 2. "201 Created" + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF. The NF Service Consumer sends a POST request for subscriptions to the RE-NWDAF, and the RE-NWDAF responds with a 201 Created status. + +**Figure 4.9.2.2.2-1: NF service consumer subscribes to notifications** + +The NF service consumer shall invoke the Nnwdaf\_RoamingAnalytics\_Subscribe service operation to subscribe to event notification(s) related to roaming UE(s) by sending an HTTP POST request with "{apiRoot}/nnwdaf-roaminganalytics//subscriptions" as Resource URI representing the "NWDAF Roaming Analytics Subscriptions" resource, as shown in figure 4.9.2.2.2-1, step 1, to create an "Individual NWDAF Roaming Analytics Subscription" resource according to the information in message body. The RoamingAnalyticsSubscription data structure provided in the request body shall include: + +- a URI where to receive the requested notifications as "notifUri" attribute; +- a notification correlation identifier as "notifCorrId" attribute; +- the PLMN ID of the NF service consumer as "consPlmnId" attribute; + +- a description of the subscribed events as "roamEventSubs" attribute with the same contents as specified for the "eventSubscriptions" attribute in clause 4.2.2.2.2 but excluding the attributes that are indicated as non applicable in Table 5.7.6.2.2-1. + +NOTE: The features mentioned in clause 4.2.2.2.2 are not relevant here. + +and may include: + +- event reporting information as the "evtReq" attribute with the same contents as specified for the "evtReq" attribute in clause 4.2.2.2.2. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nnwda-roaminganalytics//subscriptions" as Resource URI and RoamingAnalyticsSubscription data structure as request body, if no errors occur, the RE-NWDAF shall: + +- create a new subscription; +- assign an event subscriptionId; and +- store the subscription. + +If the RE-NWDAF created an "Individual NWDAF Roaming Analytics Subscription" resource, the RE-NWDAF shall respond with "201 Created" status code with the message body containing a representation of the created subscription, as shown in figure 4.9.2.2.2-1, step 2. If not all the requested analytics events in the subscription are accepted, then the NWDAF may include the "failEventReports" attribute indicating the event(s) for which the subscription failed and the associated reason(s). The NWDAF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. + +"{apiRoot}/nnwda-roaminganalytics//subscriptions/{subscriptionId}". If the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute was set to true in the event subscription, the RE-NWDAF shall include the reports of the events subscribed, if available, in the HTTP POST response within the "roamEventNotifs" attribute. + +When the "notifFlag" attribute is included and set to "DEACTIVATE" in the request, the RE-NWDAF 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 analytics target period provided in the body of the HTTP POST request includes the start time in the past and the end time in the future, the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "BOTH\_STAT\_PRED\_NOT\_ALLOWED". + +If the statistics in the past are requested but the necessary data to perform the service is unavailable, the RE-NWDAF shall reject the request with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "UNAVAILABLE\_DATA". + +**Editor's Note: The applicability and the handling of user consent is FFS and depends on stage 2 updates.** + +If an error occurs when processing the HTTP POST request, the NWDAF shall send an HTTP error response as specified in clause 5.7.7. + +#### 4.9.2.2.3 Update subscription for event notifications + +Figure 4.9.2.2.3-1 shows a scenario where the NF service consumer sends a request to the RE-NWDAF to update the subscription for event notifications. + +![Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF. The consumer sends a PUT request to subscriptions/{subscriptionId} (step 1). The RE-NWDAF responds with either a 200 OK (step 2a) or a 204 No Content (step 2b).](6a993bfdf2e00cfad01c4d2188a75d86_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant RE-NWDAF + Note left of RE-NWDAF: 1. PUT « subscriptions/{subscriptionId} » + RE-NWDAF->>NF Service Consumer: 2a. "200 OK" or 2b. "204 No Content" + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and an RE-NWDAF. The consumer sends a PUT request to subscriptions/{subscriptionId} (step 1). The RE-NWDAF responds with either a 200 OK (step 2a) or a 204 No Content (step 2b). + +**Figure 4.9.2.2.3-1: NF service consumer updates subscription to notifications** + +The NF service consumer shall invoke the Nnwdaf\_RoamingAnalytics\_Subscribe service operation to update subscription to event notifications related to roaming UE(s) by sending an HTTP PUT request with "{apiRoot}/nnwdaf-roaminganalytics//subscriptions/{subscriptionId}" as Resource URI representing the "Individual NWDAF Roaming Analytics Subscription", as shown in figure 4.9.2.2.3-1, step 1, to update the subscription for an "Individual NWDAF Roaming Analytics Subscription" resource identified by the {subscriptionId}. The RoamingAnalyticsSubscription data structure provided in the request body shall include the same contents as described in clause 4.9.2.2.2. + +Upon the reception of an HTTP PUT request with: "{apiRoot}/nnwdaf-roaminganalytics//subscriptions/{subscriptionId}" as Resource URI and RoamingAnalyticsSubscription data structure as request body, the NWDAF shall: + +- update the subscription of corresponding subscriptionId; and +- store the subscription. + +If the RE-NWDAF successfully processed and accepted the received HTTP PUT request, the RE-NWDAF shall update an "Individual NWDAF Roaming Analytics Subscription" resource, and shall respond with: + +- a) HTTP "200 OK" status code with the message body containing a representation of the updated subscription, as shown in figure 4.9.2.2.3-1, step 2a. If not all the requested analytics events in the subscription are modified successfully, then the RE-NWDAF may include the "failEventReports" attribute indicating the event(s) for which the modification failed and the associated reason(s). If the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute was set to true in the request, the RE-NWDAF shall include the reports of the events subscribed, if available, in the HTTP PUT response within the "roamEventNotifs" attribute; or +- b) HTTP "204 No Content" status code, as shown in figure 4.9.2.2.3-1, step 2b. + +If errors occur when processing the HTTP PUT request, the RE-NWDAF shall send an HTTP error response as specified in clause 5.7.7. + +If the analytics target period provided in the body of the HTTP PUT request includes the start time in the past and the end time in the future, the NWDAF shall reject the request with an HTTP "400 Bad Request" response including the "cause" attribute set to "BOTH\_STAT\_PRED\_NOT\_ALLOWED". + +If the statistics in the past are requested but the necessary data to perform the service is unavailable, the RE-NWDAF shall reject the request with an HTTP "500 Internal Server Error" response including the "cause" attribute set to "UNAVAILABLE\_DATA". + +If the RE-NWDAF determines that the received HTTP PUT request needs to be redirected, the RE-NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +When the "notifFlag" attribute is included in the request with the value "DEACTIVATE", the RE-NWDAF 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 the value "RETRIEVAL", the NWDAF 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 the value "ACTIVATE" and + +the event notifications are muted (due to a previously received "DEACTIVATE" value), the NWDAF shall unmute the event notification, i.e. start sending again notifications for available events. + +#### 4.9.2.3 Nnwdaf\_RoamingAnalytics\_Unsubscribe service operation + +##### 4.9.2.3.1 General + +The Nnwdaf\_RoamingAnalytics\_Unsubscribe service operation is used by an NF service consumer to unsubscribe from event notifications related to roaming UE(s). + +##### 4.9.2.3.2 Unsubscribe from event notifications + +Figure 4.9.2.3.2-1 shows a scenario where the NF service consumer sends a request to the NWDAF to unsubscribe from event notifications related to roaming UE(s). + +![Sequence diagram showing the unsubscribe process between an NF Service Consumer and RE-NWDAF.](2a52834ffb60a618738d21bcc3ace1e3_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant RE-NWDAF + Note left of NF Service Consumer: 1. DELETE « subscriptions/{subscriptionId} » + NF Service Consumer->>RE-NWDAF: Request + Note right of RE-NWDAF: 2. "204 No Content" + RE-NWDAF-->>NF Service Consumer: Response +``` + +The diagram illustrates a sequence of interactions between an NF Service Consumer and an RE-NWDAF. The NF Service Consumer sends a DELETE request to the RE-NWDAF, specifically to the resource 'subscriptions/{subscriptionId}'. The RE-NWDAF responds with a '204 No Content' status code. The sequence is numbered 1 and 2, with arrows indicating the direction of the messages. + +Sequence diagram showing the unsubscribe process between an NF Service Consumer and RE-NWDAF. + +**Figure 4.9.2.3.2-1: NF service consumer unsubscribes from notifications** + +The NF service consumer shall invoke the Nnwdaf\_RoamingAnalytics\_Unsubscribe service operation to unsubscribe to event notifications related to roaming UE(s) by sending an HTTP DELETE request with: "{apiRoot}/nnwdaf-roaminganalytics//subscriptions/{subscriptionId}" as Resource URI, where "{subscriptionId}" is the event subscriptionId of the existing subscription that is to be deleted. + +Upon the reception of an HTTP DELETE request with: + +"{apiRoot}/nnwdaf-roaminganalytics//subscriptions/{subscriptionId}" as Resource URI, if the RE-NWDAF successfully processed and accepted the received HTTP DELETE request, the RE-NWDAF shall: + +- remove the corresponding subscription; and +- respond with HTTP "204 No Content" status code. + +If errors occur when processing the HTTP DELETE request, the RE-NWDAF shall send an HTTP error response as specified in clause 5.7.7. + +If the RE-NWDAF determines that the received HTTP DELETE request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.9.2.4 Nnwdaf\_RoamingAnalytics\_Notify service operation + +##### 4.9.2.4.1 General + +The Nnwdaf\_RoamingAnalytics\_Notify service operation is used by an RE-NWDAF to notify NF consumers about subscribed events related to roaming UE(s). + +##### 4.9.2.4.2 Notification about subscribed event + +Figure 4.9.2.4.2-1 shows a scenario where the RE-NWDAF sends a request to the NF service consumer to notify for event notifications related to roaming UE(s). + +![Sequence diagram showing RE-NWDAF notifying the subscribed event. The diagram consists of two lifelines: 'NF service consumer' on the left and 'RE-NWDAF' on the right. Step 1: A solid arrow points from the NF service consumer to the RE-NWDAF with the label '1. POST{notificationUri}'. Step 2: A solid arrow points from the RE-NWDAF back to the NF service consumer with the label '2. "204 No Content"'.](e18841eb4a995df8354a793459e12fd0_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant RE-NWDAF + Note left of NF service consumer: 1. POST{notificationUri} + NF service consumer->>RE-NWDAF: 1. POST{notificationUri} + Note right of RE-NWDAF: 2. "204 No Content" + RE-NWDAF-->>NF service consumer: 2. "204 No Content" + +``` + +Sequence diagram showing RE-NWDAF notifying the subscribed event. The diagram consists of two lifelines: 'NF service consumer' on the left and 'RE-NWDAF' on the right. Step 1: A solid arrow points from the NF service consumer to the RE-NWDAF with the label '1. POST{notificationUri}'. Step 2: A solid arrow points from the RE-NWDAF back to the NF service consumer with the label '2. "204 No Content"'. + +**Figure 4.9.2.4.2-1: RE-NWDAF notifies the subscribed event** + +The NWDAF shall invoke the Nnwdaf\_RoamingAnalytics\_Notify service operation to notify the subscribed event related to roaming UE(s) by sending an HTTP POST request with the "{notifUri}" that was received in the Nnwdaf\_RoamingAnalytics\_Subscribe service operation as Resource URI, as shown in figure 4.9.2.4.2-1, step 1. + +If both the repetition period ("repPeriod" or "repetitionPeriod") attribute and the "offsetPeriod" attribute were present in the subscription request for periodical notification, the NWDAF shall produce a notification in every repetition period seconds, including the statistics in the past offset period if the "offsetPeriod" attribute value is negative, or including the prediction for the future offset period if the "offsetPeriod" attribute value is positive. + +The RoamingAnalyticsNotification data structure provided in the request body shall include: + +- the notification correlation identifier as "notifCorrId" attribute; +- a description of the notified event(s) as "roamEventNotifs" attribute with the same contents as specified for the "eventNotifications" attribute in clause 4.2.2.4.2 but excluding the attributes that are indicated as non applicable in Table 5.7.6.2.3-1. + +NOTE: The features mentioned in clause 4.2.2.4.2 are not relevant here. + +and may include: + +- a cause for termination in the "termCause" attribute if the NWDAF wants to request the termination of this subscription, i.e. to indicate that it will send no further notifications for it. + +If the time when analytics information is needed has been provided (via the "timeAnaNeeded" attribute within the "extraReportReq" attribute) during the subscription for an event (via the "event" attribute within the EventSubscription data type), if the time when analytics information is needed is reached but the subscribed analytics information is not ready, the consumer does not need to wait for the analytics information any longer. In this case, the RE-NWDAF may send an HTTP POST request as shown in step 1 of figure 4.9.2.4.2-1, which shall only provide (within the EventNotification data type in the RoamingAnalyticsNotification data type) an indication of the failure event via the "event" attribute and the corresponding failure reason via a "failNotifyCode" attribute, and may also provide a minimum time interval recommended by the NWDAF for the event via a "rvWaitTime" attribute which will be used by the NF service consumer to determine the time when analytics information is needed in similar future analytics subscriptions. + +Upon the reception of an HTTP POST request with: "{notifUri}" as Resource URI and RoamingAnalyticsNotification 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; and +- 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.7.7. + +If 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 [6]. + +## 5 API Definitions + +### 5.1 Nnwdaf\_EventsSubscription Service API + +#### 5.1.1 Introduction + +The Nnwdaf\_EventsSubscription service shall use the Nnwdaf\_EventsSubscription API. + +The API URI of the Nnwdaf\_EventsSubscription API shall be: + +{apiRoot}/ + +The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-eventssubscription". +- 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 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_EventsSubscription is contained in Annex A. + +##### 5.1.2.2 HTTP standard headers + +###### 5.1.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +###### 5.1.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 [6]. 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 [15]. + +##### 5.1.2.3 HTTP custom headers + +The Nnwdaf\_EventsSubscription service API shall support the mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_EventsSubscription service API. + +## 5.1.3 Resources + +### 5.1.3.1 Resource Structure + +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 Nnwdaf\_EventsSubscription API. + +![Diagram showing the resource URI structure for the Nnwdaf_EventsSubscription API. The root is {apiRoot}/nnwdafeventssubscription/. It branches into /subscriptions and /transfers. /subscriptions further branches into /{subscriptionId}. /transfers further branches into /{transferId}.](b49477e8f148b5ef044a2fd5a43528f6_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnwdafeventssubscription/"] --> Subscriptions["/subscriptions"] + Root --> Transfers["/transfers"] + Subscriptions --> SubId["/{subscriptionId}"] + Transfers --> TransferId["/{transferId}"] + +``` + +Diagram showing the resource URI structure for the Nnwdaf\_EventsSubscription API. The root is {apiRoot}/nnwdafeventssubscription/. It branches into /subscriptions and /transfers. /subscriptions further branches into /{subscriptionId}. /transfers further branches into /{transferId}. + +**Figure 5.1.3.1-1: Resource URI structure of the Nnwdaf\_EventsSubscription 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 | +|----------------------------------------------|---------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NWDAF Events Subscriptions | /subscriptions | POST | Creates a new Individual NWDAF Event Subscription resource. | +| Individual NWDAF Event Subscription | /subscriptions/{subscriptionId} | DELETE | Deletes an Individual NWDAF Event Subscription identified by subresource {subscriptionId}. | +| | | PUT | Modifies an existing Individual Event Subscription subresource. | +| NWDAF Event Subscription Transfers | /transfers | POST | Provides information about the requested analytics subscription transfer(s), potentially creating a new Individual NWDAF Event Subscription Transfer resource. | +| Individual NWDAF Event Subscription Transfer | /transfers/{transferId} | DELETE | Deletes an Individual NWDAF Event Subscription Transfer resource identified by subresource {transferId}. | +| | | PUT | Modifies an existing Individual NWDAF Event Subscription Transfer resource. | + +### 5.1.3.2 Resource: NWDAF Events Subscriptions + +#### 5.1.3.2.1 Description + +The NWDAF Events Subscriptions resource represents all subscriptions to the Nnwdaf\_EventsSubscription service at a given NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF Event Subscription resource. + +### 5.1.3.2.2 Resource definition + +Resource URI: {apiRoot}/nnwdafeventssubscription//subscriptions + +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 | +|------|-----------|---|-------------|-------------| +| 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 | +|--------------------------|---|-------------|-------------------------------------------------------------| +| NnwdafeventsSubscription | M | 1 | Creates a new Individual NWDAF Event Subscription 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 | +|--------------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| NnwdafeventsSubscription | M | 1 | 201 Created | The creation of an Individual NWDAF Event Subscription resource is confirmed and a representation of that resource is returned. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetails | O | 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.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure cases are described in clause 5.1.7. + +**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}/nnwdafeventssubscription//subscriptions/{subscriptionId}. | + +#### 5.1.3.2.4 Resource Custom Operations + +None in this release of the specification. + +#### 5.1.3.3 Resource: Individual NWDAF Event Subscription + +##### 5.1.3.3.1 Description + +The Individual NWDAF Event Subscription resource represents a single subscription to the Nnwdaf\_EventsSubscription service at a given NWDAF. + +##### 5.1.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-eventssubscription//subscriptions/{subscriptionId} + +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. | +| subscriptionId | string | Identifies a subscription to the Nnwdaf_EventsSubscription service. | + +##### 5.1.3.3.3 Resource Standard Methods + +###### 5.1.3.3.3.1 DELETE + +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 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.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 DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.1.3.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 | Successful case: The Individual NWDAF Event Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Event Subscription deletion.
Applicable if the feature "ES3XX" is supported.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Event Subscription 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 [6] 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 [6]). + +**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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.1.3.3.3.2 PUT + +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 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.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 PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|----------------------------------------------------------------------------| +| NnwdafEventsSubscription | M | 1 | Parameters to replace a subscription to NWDAF Event Subscription resource. | + +**Table 5.1.3.3.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------| +| NnwdafEventsSubscription | M | 1 | 200 OK | The Individual NWDAF Event Subscription resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF Event Subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Event Subscription modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Event Subscription 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 | 500 Internal Server Error | (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 [6] also apply. +NOTE 2: Failure cases are described in clause 5.1.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.1.3.3.4 Resource Custom Operations + +None in this release of the specification. + +#### 5.1.3.4 Resource: NWDAF Event Subscription Transfers + +##### 5.1.3.4.1 Description + +The NWDAF Event Subscription Transfers resource represents all requests to transfer subscription(s) of the Nnwdaf\_EventsSubscription service at a given NWDAF. The resource allows an NF service consumer to provide information about analytics subscriptions that are requested to be: + +- prepared for transfer, leading to the creation of a new Individual NWDAF Event Subscription Transfer resource, which can be later modified, removed, or requested to be transferred; and +- transferred, leading to the execution of the necessary steps for transferring the analytics subscription. + +##### 5.1.3.4.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-eventssubscription//transfers + +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.4.2-1. + +**Table 5.1.3.4.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.1.1 | + +##### 5.1.3.4.3 Resource Standard Methods + +###### 5.1.3.4.3.1 POST + +This method shall support the URI query parameters specified in table 5.1.3.4.3.1-1. + +**Table 5.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 5.1.3.4.3.1-2 and the response data structures and response codes specified in table 5.1.3.4.3.1-3. + +**Table 5.1.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------| +| AnalyticsSubscriptionsTransfer | M | 1 | Information about analytics subscription(s) that are requested to be transferred or prepared for transfer. | + +**Table 5.1.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AnalyticsSubscriptionsTransfer | M | 1 | 201 Created | The creation of an Individual NWDAF Event Subscription Transfer resource is confirmed and a representation of that resource is returned. | +| n/a | | | 204 No Content | The receipt of the information about analytics subscription(s) that are requested to be transferred and the ability to handle this information (e.g. execute the steps required to transfer an analytics subscription directly) is confirmed. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +**Table 5.1.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}/nnwdafeventssubscription//transfers/{transferId}. | + +#### 5.1.3.4.4 Resource Custom Operations + +None in this release of the specification. + +#### 5.1.3.5 Resource: Individual NWDAF Event Subscription Transfer + +##### 5.1.3.5.1 Description + +The Individual NWDAF Event Subscription Transfer resource represents a single request to transfer subscription(s) of the Nnwdafeventssubscription service at a given NWDAF. + +##### 5.1.3.5.2 Resource definition + +Resource URI: {apiRoot}/nnwdafeventssubscription//transfers/{transferId} + +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.5.2-1. + +**Table 5.1.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|------------|-----------|-------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.1.1. | +| transferId | string | Identifies a request to transfer subscription(s) of the Nnwdafeventssubscription service. | + +##### 5.1.3.5.3 Resource Standard Methods + +###### 5.1.3.5.3.1 DELETE + +This method shall support the URI query parameters specified in table 5.1.3.5.3.1-1. + +**Table 5.1.3.5.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 5.1.3.5.3.1-2 and the response data structures and response codes specified in table 5.1.3.5.3.1-3. + +**Table 5.1.3.5.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.1.3.5.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 | Successful case: The Individual NWDAF Event Subscription Transfer resource matching the transferId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Event Subscription Transfer deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Event Subscription Transfer deletion.
(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 [6] 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 [6]). + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.1.3.5.3.2 PUT + +This method shall support the URI query parameters specified in table 5.1.3.5.3.2-1. + +**Table 5.1.3.5.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.1.3.5.3.2-2 and the response data structures and response codes specified in table 5.1.3.5.3.2-3. + +**Table 5.1.3.5.3.2-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------------|---|-------------|------------------------------------------------------------------------------------| +| AnalyticsSubscriptionsTransfer | M | 1 | Parameters to replace in an Individual NWDAF Event Subscription Transfer resource. | + +**Table 5.1.3.5.3.2-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------| +| AnalyticsSubscriptionsTransfer | M | 1 | 200 OK | The Individual NWDAF Event Subscription Transfer resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF Event Subscription Transfer resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Event Subscription Transfer modification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Event Subscription Transfer modification.
(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 [6] 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 [6]). + +**Table 5.1.3.5.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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.1.3.5.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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.1.3.5.4 Resource Custom Operations + +None in this release of the specification. + +### 5.1.4 Custom Operations without associated resources + +None in this release of the specification. + +### 5.1.5 Notifications + +#### 5.1.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.3.3.4.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|-------------------|---------------------------------|-----------------------------------------| +| Event Notification | {notificationURI} | POST | Reports one or several observed Events. | + +#### 5.1.5.2 Event Notification + +##### 5.1.5.2.1 Description + +The Event Notification is used by the NWDAF to report one or several observed Events to an NF service consumer that has subscribed to such Notifications or used by the target NWDAF to report the successful analytics subscription transfer via the Individual NWDAF Event Subscription Resource. + +##### 5.1.5.2.2 Operation Definition + +Callback URI: {notificationURI} + +The operation shall support the callback URI variables defined in table 5.1.5.2.2-1, the request data structures specified in table 5.1.5.2.2-2 and the response data structure and response codes specified in table 5.1.5.2.2-3. + +**Table 5.1.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationURI | Uri | The Notification Uri as assigned within the Individual NWDAF Event Subscription and described within the NnwdafEventsSubscription type (see table 5.1.6.2.2-1). | + +**Table 5.1.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------| +| array(NnwdafEventsSubscriptionNotification) | M | 1..N | Provides Information about observed Events or the successful analytics subscription transfer. | + +**Table 5.1.5.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. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during the event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent. Applicable if the feature "ES3XX" is supported. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent. Applicable if the feature "ES3XX" is supported. | + +NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +**Table 5.1.5.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 NF consumer (service) instance towards which the notification should be redirected. | +| 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.1.5.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 NF consumer (service) instance towards which the notification should be redirected. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 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 Nnwdaf\_EventsSubscription service based interface protocol. + +**Table 5.1.6.1-1: Nnwdaf\_EventsSubscription specific Data Types** + +| Data type | Section defined | Description | Applicability | +|--------------------------------|-----------------|--------------------------------------------------------------------------------------|--------------------| +| AbnormalBehaviour | 5.1.6.2.15 | Represents the abnormal behaviour information. | AbnormalBehaviour | +| Accuracy | 5.1.6.3.5 | Represents the preferred level of accuracy of the analytics. | | +| AccuracyInfo | 5.1.6.2.89 | The analytics accuracy information. | AnalyticsAccuracy | +| AccuracyReq | 5.1.6.3.88 | Represents the analytics accuracy requirement information. | AnalyticsAccuracy | +| AdditionalMeasurement | 5.1.6.2.26 | Represents additional measurement information. | AbnormalBehaviour | +| AddressList | 5.1.6.2.28 | Represents a list of IPv4 and/or IPv6 addresses. | AbnormalBehaviour | +| AnalyticsContextIdentifier | 5.1.6.2.43 | Contains information about available analytics contexts. | AnaSubTransfer | +| AnalyticsAccuracyIndication | 5.1.6.3.37 | Represents the analytics accuracy indication. | AnalyticsAccuracy | +| AnalyticsFeedbackInfo | 5.1.6.2.105 | Contains analytics feedback information. | AnalyticsAccuracy | +| AnalyticsMetadata | 5.1.6.3.14 | Represents the types of analytics metadata information that can be requested. | Aggregation | +| AnalyticsMetadataIndication | 5.1.6.2.36 | Contains analytics metadata values indicated to be used during analytics generation. | Aggregation | +| AnalyticsMetadataInfo | 5.1.6.2.37 | Contains analytics metadata information required for analytics aggregation. | Aggregation | +| AnalyticsSubscriptionsTransfer | 5.1.6.2.40 | Contains information about a request to transfer analytics subscriptions. | AnaSubTransfer | +| AnalyticsSubset | 5.1.6.3.18 | Analytics subset used to indicate the content of the analytics. | EneNA | +| AnySlice | 5.1.6.3.2 | Represents the any slices. | | +| ApplicationVolume | 5.1.6.2.55 | Application data volume per application Id. | Dispersion | +| AppListForUeComm | 5.1.6.2.64 | Represents the analytics of the application list used by UE. | UeCommunicationExt | +| BwRequirement | 5.1.6.2.25 | Represents bandwidth requirement. | ServiceExperience | +| ClassCriterion | 5.1.6.2.51 | Disperion class criterion. | Dispersion | +| CircumstanceDescription | 5.1.6.2.29 | Contains the description of a circumstance. | AbnormalBehaviour | +| CongestionInfo | 5.1.6.2.18 | Represents the congestion information | UserDataCongestion | +| CongestionType | 5.1.6.3.8 | Identification congestion analytics type. | UserDataCongestion | +| ConsumerNfInformation | 5.1.6.2.49 | Represents the analytics consumer NF Information. | AnaSubTransfer | +| DatasetStatisticalProperty | 5.1.6.3.15 | Dataset statistical properties of the data | Aggregation | + +| | | | | +|--|--|---------------------------------|--| +| | | used to generate the analytics. | | +|--|--|---------------------------------|--| + +| | | | | +|------------------------------|------------|---------------------------------------------------------------------------------------------------|-----------------------------------------| +| DataVolume | 5.1.6.2.85 | Indicates a specific data volume transmitted once from UE to AF and/or from AF to UE | E2eDataVolTransTime | +| DataVolumeTransferTime | 5.1.6.2.90 | Indicates the E2E data volume transfer time and the data volume used to derive the transfer time. | E2eDataVolTransTime | +| DeviceType | 5.1.6.3.31 | The type of device. | QoSustainabilityExt_eNA | +| Direction | 5.1.6.3.39 | Heading directions of the UE flow in the target area. | MovementBehaviour | +| DirectionInfo | 5.1.6.2.75 | Represents the UE direction information. | UeMobilityExt2_eNA
MovementBehaviour | +| DispersionClass | 5.1.6.3.20 | Dispersion class. | Dispersion | +| DispersionCollection | 5.1.6.2.54 | Dispersion collections per UE location or per slice. | Dispersion | +| DispersionCollection | 5.1.6.2.54 | Dispersion collections per UE location or or per slice. | Dispersion | +| DispersionInfo | 5.1.6.2.53 | Dispersion analytics information. | Dispersion | +| DispersionRequirement | 5.1.6.2.50 | Dispersion analytics requirement. | Dispersion | +| DispersionType | 5.1.6.3.19 | Dispersion type. | Dispersion | +| DispersionOrderingCriterion | 5.1.6.3.21 | Ordering criterion for the list of Dispersion. | Dispersion | +| DnPerf | 5.1.6.2.46 | Represents DN performance information. | DnPerformance | +| DnPerfInfo | 5.1.6.2.45 | Represents DN performances for the application. | DnPerformance | +| DnPerfOrderingCriterion | 5.1.6.3.25 | Ordering criterion for the list of DN performance analytics. | DnPerformance | +| DnPerformanceReq | 5.1.6.2.66 | Represents DN performance analytics requirement. | DnPerformance | +| E2eDataVolTransTimeCriterion | 5.1.6.3.35 | Ordering criterion for the list of E2E data volume transfer time. | E2eDataVolTransTime | +| E2eDataVolTransTimeInfo | 5.1.6.2.83 | Represents the E2E data volume transfer time Information. | E2eDataVolTransTime | +| E2eDataVolTransTimeReq | 5.1.6.2.82 | Represents the E2E data volume transfer time requirement. | E2eDataVolTransTime | +| E2eDataVolTransTimePerTS | 5.1.6.2.84 | Represents the E2E data volume transfer time requirement per Time slot. | E2eDataVolTransTime | +| E2eDataVolTransTimePerUe | 5.1.6.2.86 | Represents the E2E data volume transfer time per UE. | E2eDataVolTransTime | +| E2eDataVolTransTimeUeList | 5.1.6.2.87 | Represents the E2E data volume transfer time per UE list. | E2eDataVolTransTime | +| EventNotification | 5.1.6.2.5 | Describes Notifications about events that occurred. | | +| EventReportingRequirement | 5.1.6.2.7 | Represents the type of reporting the subscription requires. | | +| EventSubscription | 5.1.6.2.3 | Represents the subscription to a single event. | | + +| | | | | +|-----------------------|------------|---------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Exception | 5.1.6.2.16 | Describes the Exception information. | AbnormalBehaviour | +| ExceptionId | 5.1.6.3.6 | Describes the Exception Id. | AbnormalBehaviour | +| ExceptionTrend | 5.1.6.3.7 | Describes the Exception Trend. | AbnormalBehaviour | +| ExpectedAnalyticsType | 5.1.6.3.11 | Represents expected UE analytics type. | AbnormalBehaviour | +| FailureEventInfo | 5.1.6.2.35 | Contains information on the event for which the subscription is not successful. | | +| GeoDistributionInfo | 5.1.6.2.76 | Represents the geographical distribution of the UEs. | UeMobilityExt_AIML | +| GeoLocation | 5.1.6.2.95 | Represents a geographic location, using either standard or local coordinates and optionally including the altitude. | LocAccuracy | +| IpEthFlowDescription | 5.1.6.2.27 | Contains the description of an Uplink and/or Downlink Ethernet flow. | AbnormalBehaviour | +| LoadLevelInformation | 5.1.6.3.2 | Represents load level information of the network slice and the optionally associated network slice instance. | | +| LocAccuracyInfo | 5.1.6.2.97 | Contains Location Accuracy information. | LocAccuracy | +| LocAccuracyPerMethod | 5.1.6.2.98 | Contains Location Accuracy information per Positioning Method. | LocAccuracy | +| LocAccuracyReq | 5.1.6.2.96 | Contains Location Accuracy analytics requirements. | LocAccuracy | +| LocationInfo | 5.1.6.2.11 | Represents UE location information. | UeMobility | +| LocInfoGranularity | 5.1.6.3.32 | Represents the preferred granularity of location information. | ServiceExperienceExt2_eNA
UeMobilityExt2_eNA
DispersionExt_eNA
MovementBehaviour | +| LocationOrientation | 5.1.6.3.38 | Represents preferred orientation of location information. | MovementBehaviour | +| MatchingDirection | 5.1.6.3.12 | Defines the matching direction when crossing a threshold. | NfLoad, QoSustainability,
UserDataCongestion,
NetworkPerformance
Dispersion
RedundantTransmissionExp
WlanPerformance
ServiceExperienceExt
NsiLoadExt
LocAccuracy | +| MLModelInfo | 5.1.6.2.69 | The information of the ML model. | AnaSubTransfer | +| ModelInfo | 5.1.6.2.42 | Contains information about an ML model. | AnaSubTransfer | +| MovBehav | 5.1.6.2.93 | Represents the Movement Behaviour information per time slot. | MovementBehaviour | +| MovBehavInfo | 5.1.6.2.92 | Represents the Movement Behaviour information. | MovementBehaviour | +| MovBehavReq | 5.1.6.2.91 | Represents the Movement Behaviour | MovementBehaviour | + +| | | | | +|--|--|-------------------------|--| +| | | analytics requirements. | | +|--|--|-------------------------|--| + +| | | | | +|--------------------------------------|------------|------------------------------------------------------------------------------------------------------------|-----------------------------------------------| +| NetworkPerfInfo | 5.1.6.2.23 | Represents the network performance information. | NetworkPerformance | +| NetworkPerfOrderCriterion | 5.1.6.3.30 | The ordering criterion for the list of network performance analytics. | NetworkPerformanceExt_eNA | +| NetworkPerfRequirement | 5.1.6.2.22 | Represents a network performance requirement. | NetworkPerformance | +| NetworkPerfType | 5.1.6.3.10 | Represents the network performance types. | NetworkPerformance | +| NfLoadLevelInformation | 5.1.6.2.31 | Represents load level information of a given NF instance. | NfLoad | +| NfStatus | 5.1.6.2.32 | Provides the percentage of time spent on various NF states. | NfLoad | +| NnwdafEventsSubscription | 5.1.6.2.2 | Represents an Individual NWDAF Event Subscription resource. | | +| NnwdafEventsSubscriptionNotification | 5.1.6.2.4 | Represents an Individual NWDAF Event Subscription Notification resource. | | +| NumberAverage | 5.1.6.2.38 | Represents average and variance information. | NsiLoadExt | +| NwdafEvent | 5.1.6.3.4 | Describes the NWDAF Events. | | +| NwdafFailureCode | 5.1.6.3.13 | Identifies the failure reason. | | +| NotificationMethod | 5.1.6.3.3 | Represents the notification methods that can be subscribed. | | +| NsiIdInfo | 5.1.6.2.33 | Represents the S-NSSAI and the optionally associated Network Slice Instance Identifier(s). | ServiceExperience
NsiLoad
DnPerformance | +| NsiLoadLevelInfo | 5.1.6.2.34 | Represents the load level information for an S-NSSAI and the optionally associated network slice instance. | NsiLoad | +| ObservedRedundantTransExp | 5.1.6.2.70 | Represents the observed Redundant Transmission Experience. | RedundantTransmissionExp | +| OutputStrategy | 5.1.6.3.16 | Represents the output strategy used for the reporting of the analytics. | Aggregation | +| PerfData | 5.1.6.2.47 | Represents DN performance information. | DnPerformance | +| PfdDeterminationInfo | 5.1.6.2.73 | Represents the PFD Determination information. | PfdDetermination | +| PrevSubInfo | 5.1.6.2.68 | Information of the previous subscription. | AnaCtxTransfer | +| QosRequirement | 5.1.6.2.20 | Represents the QoS requirements. | QoSSustainability | +| QosSustainabilityInfo | 5.1.6.2.19 | Represents the QoS Sustainability information. | QoSSustainability | +| RankingCriterion | 5.1.6.2.52 | Ranking criterion. | Dispersion | +| RatFreqInformation | 5.1.6.2.67 | Represents the RAT type and/or Frequency information. | ServiceExperienceExt | +| RedTransExpOrderingCriterion | 5.1.6.3.22 | Ordering criterion for the | RedundantTransmissionExp | + +| | | | | +|--|--|--------------------------------------------------|--| +| | | list of Redundant
Transmission
Experience. | | +|--|--|--------------------------------------------------|--| + +| | | | | +|-------------------------------|-------------|---------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RedundantTransmissionExpInfo | 5.1.6.2.57 | Redundant transmission experience analytics information. | RedundantTransmissionExp | +| RedundantTransmissionExpPerTS | 5.1.6.2.58 | Redundant Transmission Experience per Time Slot. | RedundantTransmissionExp | +| RedundantTransmissionExpReq | 5.1.6.2.56 | Redundant transmission experience analytics requirement. | RedundantTransmissionExp | +| RelProxInfo | 5.1.6.2.100 | Relative Proximity analytics information. | RelativeProximity | +| RelProxReq | 5.1.6.2.99 | Relative Proximity analytics requirements. | RelativeProximity | +| ResourceUsage | 5.1.6.2.48 | The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance. | NsiLoadExt | +| ResourceUsageRequirement | 5.1.6.2.81 | Indicates more requirements when providing resource usage information for network performance. | NetworkPerformanceExt_AIML | +| RetainabilityThreshold | 5.1.6.2.21 | Represents a QoS flow retainability threshold. | QoSSustainability | +| RoamingInfo | 5.1.6.2.106 | Contains information related to roaming analytics. | RoamingAnalytics | +| PduSessionInfo | 5.1.6.2.74 | Represents combination of PDU Session parameters. | ServiceExperienceExt2_eNA | +| ServiceExperienceInfo | 5.1.6.2.24 | Represents the service experience information. | ServiceExperience | +| ServiceExperienceType | 5.1.6.3.24 | Represents the type of Service Experience Analytics. | ServiceExperienceExt | +| SessInactTimerForUeComm | 5.1.6.2.65 | Represents the N4 Session inactivity timer. | UeCommunicationExt | +| SliceLoadLevelInformation | 5.1.6.2.6 | Represents the slices and their load level information. | | +| SpeedThresholdInfo | 5.1.6.2.94 | UEs information whose speed is faster than the speed threshold. | MovementBehaviour | +| SubscriptionTransferInfo | 5.1.6.2.41 | Contains information about subscriptions that are requested to be transferred. | AnaSubTransfer | +| TargetUeInformation | 5.1.6.2.8 | Identifies the target UE information. | ServiceExperience
NfLoad
NetworkPerformance
UserDataCongestion
UeMobility
UeCommunication
AbnormalBehaviour
QoSSustainability
Dispersion
RedundantTransmissionExp
WlanPerformance
DnPerformance
PduSesTraffic
E2eDataVolTransTime | +| TdTraffic | 5.1.6.2.78 | Represents traffic that matches or unmatches Traffic Descriptor over | PduSesTraffic | + +| | | | | +|--|--|---------------------------------|--| +| | | the established PDU Session(s). | | +|--|--|---------------------------------|--| + +| | | | | +|------------------------------|-------------|---------------------------------------------------------------------------|--------------------------------------------------------------------------------------------| +| TermCause | 5.1.6.3.26 | Represents a cause for requesting to terminate an analytics subscription. | TermRequest | +| ThresholdLevel | 5.1.6.2.30 | Describes a threshold level. | UserDataCongestion
NfLoad
DnPerformance
ServiceExperienceExt
MovementBehaviour | +| TimestampedLocation | 5.1.6.2.103 | The timestamped locations of the trajectory of the UE. | RelativeProximity | +| TimeToCollisionInfo | 5.1.6.2.104 | Time To Collision (TTC) information. | RelativeProximity | +| TimeUnit | 5.1.6.3.9 | Represents the unit for the session active time. | QoSSustainability | +| TopApplication | 5.1.6.2.39 | Top application that contributes the most to the traffic. | UserDataCongestionExt | +| TrafficCharacterization | 5.1.6.2.14 | Identifies the detailed traffic characterization. | UeCommunication | +| TrafficDirection | 5.1.6.3.33 | The traffic direction for the resource usage information. | NetworkPerformanceExt_AIML | +| TrafficInformation | 5.1.6.2.63 | Traffic information including UL/DL data rate and/or Traffic volume. | WlanPerformance | +| TransferRequestType | 5.1.6.3.17 | Represents the type of a request for analytics subscription transfer. | AnaSubTransfer | +| UeAnalyticsContextDescriptor | 5.1.6.2.44 | Contains information about available UE related analytics contexts. | AnaSubTransfer | +| UeCommunication | 5.1.6.2.13 | Represents UE communication information. | UeCommunication | +| UeCommOrderCriterion | 5.1.6.3.29 | The ordering criterion for the list of UE communication analytics. | UeCommunicationExt_eNA | +| UeCommReq | 5.1.6.2.72 | UE communication analytics requirement. | UeCommunicationExt_eNA | +| UeMobilityOrderCriterion | 5.1.6.3.28 | The ordering criterion for the list of UE mobility analytics. | UeMobilityExt2_eNA | +| UeMobilityReq | 5.1.6.2.71 | UE mobility analytics requirement. | UeMobilityExt2_eNA | +| UeMobility | 5.1.6.2.10 | Represents UE mobility information. | UeMobility | +| UeProximity | 5.1.6.2.101 | Observed or Predicted proximity information. | RelativeProximity | +| UeTrajectory | 5.1.6.2.102 | Relative timestamped UE positions. | RelativeProximity | +| PduSesTrafficInfo | 5.1.6.2.77 | Represents PDU Session traffic analytics information. | PduSesTraffic | +| PduSesTrafficReq | 5.1.6.2.79 | Represents PDU Session traffic analytics requirement. | PduSesTraffic | +| UserDataConOrderCrit | 5.1.6.3.27 | The ordering criterion for the list of User Data Congestion analytics. | UserDataCongestionExt2_eNA | +| UserDataCongestionInfo | 5.1.6.2.17 | Represents the user data congestion information. | UserDataCongestion | + +| | | | | +|----------------------------|------------|------------------------------------------------------------------------------------------------|----------------------------| +| ValueExpression | 5.1.6.3.34 | Indicates average or peak value of the resource usage for the network performance type | NetworkPerformanceExt_AIML | +| WlanOrderingCriterion | 5.1.6.3.23 | Ordering criterion for the list of WLAN performance information. | WlanPerformance | +| WlanPerformanceReq | 5.1.6.2.59 | WLAN performance analytics requirement. | WlanPerformance | +| WlanPerformanceInfo | 5.1.6.2.60 | WLAN performance analytics information. | WlanPerformance | +| WlanPerSsIdPerformanceInfo | 5.1.6.2.61 | WLAN performance information per SSID of WLAN access points deployed in the Area of Interest. | WlanPerformance | +| WlanPerTsPerformanceInfo | 5.1.6.2.62 | WLAN performance information per Time Slot during the analytics target period. | WlanPerformance | +| WlanPerUeIdPerformanceInfo | 5.1.6.2.80 | WLAN performance information per UE ID of WLAN access points deployed in the Area of Interest. | WlanPerformanceExt_AIML | + +Table 5.1.6.1-2 specifies data types re-used by the Nnwdaf\_EventsSubscription 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 Nnwdaf service based interface. + +**Table 5.1.6.1-2: Nnwdaf\_EventsSubscription re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|-------------------------|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 5Qi | 3GPP TS 29.571 [8] | Identifies the 5G QoS identifier | QoSSustainability
E2eDataVolTransTime | +| AccessType | 3GPP TS 29.571 [8] | Identifies the access type. | ServiceExperienceExt2_eNA | +| AddrFqdn | 3GPP TS 29.517 [22] | Represents the IP address or FQDN of the Application Server. | DnPerformance
ServiceExperienceExt | +| ApplicationId | 3GPP TS 29.571 [8] | Identifies the application identifier. | ServiceExperience
UeCommunication
AbnormalBehaviour
Dispersion
DnPerformance
PduSesTraffic | +| ArfcnValueNR | 3GPP TS 29.571 [8] | Integer value indicating the ARFCN applicable for a downlink, uplink or bi-directional (TDD) NR global frequency raster.

Minimum = 0. Maximum = 3279165. | ServiceExperienceExt | +| BitRate | 3GPP TS 29.571 [8] | 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". | ServiceExperience
QoSSustainability
WlanPerformance
DnPerformance
E2eDataVolTransTime | +| DateTime | 3GPP TS 29.571 [8] | Identifies the time. | | +| Dnai | 3GPP TS 29.571 [8] | Identifies a user plane access to one or more DN(s). | ServiceExperience
DnPerformance | +| Dnn | 3GPP TS 29.571 [8] | Identifies the DNN. | ServiceExperience
AbnormalBehaviour
UeCommunication
DnPerformance
SMCCE
PduSesTraffic
E2eDataVolTransTime | +| DomainNameProtocol | 3GPP TS 29.122 [19] | Indicates the additional protocol and protocol field for domain names to be matched. | PfdDetermination | +| DurationSec | 3GPP TS 29.571 [8] | | | +| EthFlowDescription | 3GPP TS 29.514 [21] | | UeCommunication
AbnormalBehaviour | +| ExpectedUeBehaviourData | 3GPP TS 29.503 [23] | | AbnormalBehaviour | +| Float | 3GPP TS 29.571 [8] | | | +| FlowDescription | 3GPP TS 29.514 [21] | | UeCommunication
AbnormalBehaviour
PduSesTraffic | +| FlowInfo | 3GPP TS 29.122 [19] | | UserDataCongestionExt | +| GeographicalArea | 3GPP TS 29.522 [32] | Identifies the geographical location (longitude and latitude level). | UeMobilityExt2_eNA
ServiceExperienceExt2_eNA
QoSSustainabilityExt_eNA
MovementBehaviour | +| Gpsi | 3GPP TS 29.571 [8] | The GPSI for an UE. | UserDataCongestionExt
UeMobilityExt_AIML | +| GroupId | 3GPP TS 29.571 [8] | Identifies a group of UEs. | UeMobility
UeCommunication
NetworkPerformance
AbnormalBehaviour
ServiceExperience
Dispersion
RedundantTransmissionExp
WlanPerformance
PduSesTraffic | + +| | | | | +|----------------------------|---------------------|-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Ipv4Addr | 3GPP TS 29.571 [8] | | | +| Ipv6Addr | 3GPP TS 29.571 [8] | | | +| LocalOrigin | 3GPP TS 29.572 [30] | Represents a reference point for modelling locations in relation to it. | LocAccuracy | +| NetworkAreaInfo | 3GPP TS 29.554 [18] | Identifies the network area. | ServiceExperience
QoSSustainability
AbnormalBehaviour
UeMobility
UserDataCongestion
NetworkPerformance
NsiLoadExt
NfLoadExt
Dispersion
RedundantTransmissionExp
WlanPerformance
UeCommunication
DnPerformance
PduSesTraffic
E2eDataVolTransTime
MovementBehaviour | +| NfInstanceId | 3GPP TS 29.571 [8] | Identifies an NF instance. | NfLoad | +| NfSetId | 3GPP TS 29.571 [8] | Identifies an NF Set instance. | NfLoad | +| NFType | 3GPP TS 29.510 [12] | Identifies a type of NF. | NfLoad | +| NsiId | 3GPP TS 29.531 [24] | Identifies a Network Slice Instance. | ServiceExperience
NsiLoad
DnPerformance | +| PacketDelBudget | 3GPP TS 29.571 [8] | | QoSSustainability
DnPerformance
RedundantTransExpExt_eNA | +| PacketErrRate | 3GPP TS 29.571 [8] | | QoSSustainability | +| PacketLossRate | 3GPP TS 29.517 [22] | Indicates Packet Loss Rate. | DnPerformance
RedundantTransExpExt_eNA | +| PduSessionId | 3GPP TS 29.571 [8] | Identifies PDU Session | | +| PduSessionType | 3GPP TS 29.571 [8] | Identifies the PDU Session Type. | ServiceExperienceExt2_eNA | +| PlmnIdNid | 3GPP TS 29.571 [8] | PLMN identifier. | RoamingAnalytics | +| Point | 3GPP TS 29.572 [30] | Represents a location in geographical co-ordinates. | LocAccuracy | +| PointAltitude | 3GPP TS 29.572 [30] | Represents a location including an altitude in geographical co-ordinates. | LocAccuracy | +| PositioningMethod | 3GPP TS 29.572 [30] | Represents a positioning method. | LocAccuracy | +| ProblemDetails | 3GPP TS 29.571 [8] | Used in error responses to provide more detailed information about an error. | | +| QosResourceType | 3GPP TS 29.571 [8] | Identifies the resource type in QoS characteristics. | QoSSustainability | +| RatType | 3GPP TS 29.571 [8] | Identifies the RAT type. | ServiceExperienceExt | +| RedirectResponse | 3GPP TS 29.571 [8] | Contains redirection related information. | ES3XX | +| RelativeCartesianLocation | 3GPP TS 29.572 [30] | Represents distances from a reference point. | LocAccuracy | +| ReportingInformation | 3GPP TS 29.523 [20] | Represents the type of reporting the subscription requires. | | +| SamplingRatio | 3GPP TS 29.571 [8] | | | +| ScheduledCommunicationTime | 3GPP TS 29.122 [19] | | UeMobility
UeCommunication | +| SmcceInfo | 5.2.6.2.12 | Represents the analytics of Session Management Congestion Control Experience information. | SMCCE | +| Snssai | 3GPP TS 29.571 [8] | Identifies the S-NSSAI (Single Network Slice Selection | | + +| | | | | +|-------------------|---------------------|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Assistance Information). | | +| SscMode | 3GPP TS 29.571 [8] | Identifies the SSC Mode of the PDU Session. | ServiceExperienceExt2_eNA | +| Supi | 3GPP TS 29.571 [8] | The SUPI for an UE. | ServiceExperience,
NflLoad
NetworkPerformance,
UserDataCongestion
UeMobility
UeCommunication
AbnormalBehaviour
Dispersion
RedundantTransmissionExp
WlanPerformance
PduSesTraffic | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of the optional features defined in table 5.1.8-1. | | +| SvcExperience | 3GPP TS 29.517 [22] | | ServiceExperience | +| Tai | 3GPP TS 29.571 [8] | Tracking Area Information. | AnaSubTransfer | +| TimeWindow | 3GPP TS 29.122 [19] | | | +| Uinteger | 3GPP TS 29.571 [8] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. | | +| UpfInformation | 3GPP TS 29.508 [29] | The information of the UPF serving the UE. | ServiceExperienceExt
DnPerformance | +| Uri | 3GPP TS 29.571 [8] | | | +| UserLocation | 3GPP TS 29.571 [8] | | UeMobility
Dispersion | +| VelocityEstimate | 3GPP TS 29.572 [30] | Velocity estimate | QoSSustainabilityExt_eNA | +| Volume | 3GPP TS 29.122 [19] | | UeCommunication
AbnormalBehaviour
Dispersion
WlanPerformance
PduSesTraffic | + +## 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 NnwdafEventsSubscription + +**Table 5.1.6.2.2-1: Definition of type NnwdafEventsSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------| +| eventSubscriptions | array(EventSubscription) | M | 1..N | Subscribed events. | | +| evtReq | ReportingInformation | O | 0..1 | Represents the reporting requirements of the event subscription. (NOTE 1, NOTE 2, NOTE 4)
If omitted, the default values within the ReportingInformation data type apply. | | +| notificationURI | Uri | C | 0..1 | Identifies the recipient of Notifications sent by the NWDAF.
This parameter shall be supplied by the NF service consumer in the HTTP POST requests that create the subscriptions for event notifications and in the HTTP PUT requests that update the subscriptions for event notifications. | | +| notifCorrId | string | O | 0..1 | Notification correlation identifier. | EneNA | +| eventNotifications | array(EventNotification) | C | 1..N | Notifications about Individual Events.
Shall only be present if the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute sets to true in the event subscription, and the reports are available. | | +| failEventReports | array(FailureEventInfo) | O | 1..N | Supplied by the NWDAF. When available, shall contain the event(s) for which the subscription is not successful including the failure reason(s). | | +| consNfInfo | ConsumerNfInformation | O | 0..1 | Represents the analytics consumer NF Information. | AnaSubTransfer | +| prevSub | PrevSubInfo | O | 0..1 | Contains information about the previous analytics subscription that the NF service consumer had with the source NWDAF. (NOTE 3) | AnaCtxTransfer | +| supportedFeatures | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.1.8.
This parameter shall be supplied by NF service consumer in the POST request that request the creation of an NWDAF Event Subscriptions resource, and shall be supplied | | + +| | | | | | | +|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|-----------------------------------------------------|--| +| | | | | by the NWDAF in the reply of corresponding request. | | +| NOTE 1: | If the "evtReq" attribute (of data type ReportingInformation) is provided and contains the "notifMethod" attribute, the notification method indicated by the "notifMethod" attribute within the ReportingInformation data type takes preference over the notification method indicated by the "notificationMethod" attribute within the EventSubscription data type.
NOTE 2: If the "evtReq" attribute (of data type ReportingInformation) is provided and contains the "repPeriod" attribute, the periodic reporting time indicated by the "repPeriod" attribute in the ReportingInformation data type takes preference over the periodic reporting time indicated by the "repetitionPeriod" attribute in the EventSubscription data type.
NOTE 3: The "prevSub" attribute may be used by the NWDAF to derive analytics context identifier(s), which may be used in the Nnwdaf_AnalyticsInfo_ContextTransfer service operation invoked by the NWDAF.
NOTE 4: Void. | | | | | + +### 5.1.6.2.3 Type EventSubscription + +**Table 5.1.6.2.3-1: Definition of type EventSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| anySlice | AnySlice | C | 0..1 | Default is "false". (NOTE 1) | | +| appIds | array(ApplicationId) | C | 1..N | Represents the Application Identifier(s) to which the subscription applies.
The absence of appIds means subscription to all applications. (NOTE 8) (NOTE 15) (NOTE 16) | ServiceExperience
UeCommunication
AbnormalBehaviour
Dispersion
DnPerformance
PfdDetermination
E2eDataVolTransTime | +| deviations | array(Uinteger) | O | 1..N | Each element indicates an acceptable deviation from the threshold level included in "ranUeThrouThds" attribute or "qosFlowRetThds" attribute.
This attribute may only be present if either the "ranUeThrouThds" attribute or "qosFlowRetThds" attribute is provided. | EnQoSustainability | +| dnns | array(Dnn) | C | 1..N | Represents the DNN(s) to which the subscription applies. Each DNN is a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.
The absence of dnns means subscription to all DNNs. (NOTE 8) (NOTE 17) | ServiceExperience,
AbnormalBehaviour
UeCommunication
RedundantTransmissionExp
DnPerformance
SMCCE
PfdDetermination
PduSesTraffic
E2eDataVolTransTime
RelativeProximity | +| dnais | array(Dnai) | O | 1..N | Represents the Data Network Access Identifier(s) of user plane access to DN(s) which the subscription applies. | ServiceExperience
DnPerformance
E2eDataVolTransTime | +| dataVITrnsTmRqs | array(E2eDataVolTransTimeReq) | O | 1..N | Represents the E2E data volume transfer time requirements | E2eDataVolTransTime | +| event | Nwdafevent | M | 1 | Event that is subscribed. | | +| extraReportReq | EventReportingRequirement | O | 0..1 | The extra event reporting requirement information. | | +| ladnDnns | array(Dnn) | O | 1..N | LADN DNN(s) to indicate the LADN service area(s) as the AoI(s). | UeMobilityExt | +| loadLevelThreshold | integer | C | 0..1 | Indicates that the NWDAF shall report the corresponding network slice load level to the NF service consumer where the load level of the network slice identified by snssais is reached. (NOTE 4)

May be included when subscribed event is "SLICE_LOAD_LEVEL".
Minimum = 0. Maximum = 100. | | + +| | | | | | | +|-----------------------|-----------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| matchingDir | MatchingDirection | O | 0..1 | A matching direction may be provided alongside a threshold. If omitted, the default value is CROSSED. | NfLoad,
QoSustainability,
UserDataCongestion,
NetworkPerformance,
NsiLoadExt | +| nfLoadLvlThds | array(ThresholdLevel) | C | 1..N | Shall be supplied in order to start reporting when an average load level is reached. (NOTE 4) | NfLoad | +| networkArea | NetworkAreaInfo | C | 0..1 | Identification of network area to which the subscription applies. The absence of "networkArea" and "fineGranAreas" means subscription to all network areas. (NOTE 7, NOTE 8, NOTE 20 , NOTE 22) | ServiceExperience
UeMobility
UeCommunication
QoSustainability
AbnormalBehaviour
UserDataCongestion
NetworkPerformance
NsiLoadExt
NfLoadExt
Dispersion
RedundantTransmissionExp
WlanPerformance
DnPerformance
PduSesTraffic
E2eDataVolTransTime
MovementBehaviour
LocAccuracy
RelativeProximity | +| location | GeoLocation | C | 0..1 | A location (i.e. geographical location or location in local coordinates) to which the subscription applies. (NOTE 22) | LocAccuracy | +| temporalGranSize | DurationSec | O | 0..1 | Indicates the minimum duration of each time slot for which the analytics are provided. (NOTE 18) | NetworkPerformanceExt_eNA
UeMobilityExt2_eNA
UserDataCongestionExt2_eNA
QoSustainabilityExt_eNA
DispersionExt_eNA
WlanPerfExt_eNA
RedundantTransExpExt_eNA
DnPerformanceExt_eNA | +| spatialGranSizeT
a | Uinteger | O | 0..1 | Indicates the maximum number of TAs used to define an area for which the analytics are provided. May be included when the "networkArea" attribute in the EventSubscription data type is provided. | NetworkPerformanceExt_eNA
UeMobilityExt2_eNA
UeCommunicationExt_eNA
QoSustainabilityExt_eNA | + +| | | | | | | +|--|--|--|--|-----------|---------------------------------------------------| +| | | | | (NOTE 19) | DispersionExt_e
NA
DnPerformance
Ext_eNA | +|--|--|--|--|-----------|---------------------------------------------------| + +| | | | | | | +|---------------------|-------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| spatialGranSizeCell | UInteger | O | 0..1 | Indicates the maximum number of cells used to define an area for which the analytics are provided.
May be included when the "networkArea" attribute in the EventSubscription data type is provided.
(NOTE 19) | NetworkPerformanceExt_eNA
UeMobilityExt2_eNA
UeCommunicationExt_eNA
QoSustainabilityExt_eNA
DispersionExt_eNA
DnPerformanceExt_eNA | +| fineGranAreas | array(GeographicalArea) | O | 1..N | Indicates the fine granularity areas to which the subscription applies. (i.e. with a finer granularity than cell).
(NOTE 7, NOTE 20) | ServiceExperienceExt2_eNA
UeMobilityExt2_eNA
QoSustainabilityExt_eNA | +| visitedAreas | array(NetworkAreaInfo) | O | 1..N | Indicates the visited network area(s) which the UEs had previously been in at least one of the Visited Area(s) of Interest.
(NOTE 10) | UeMobilityExt | +| maxTopAppUINbr | UInteger | O | 0..1 | Indicates the requested maximum number of top applications that contribute the most to the traffic in Uplink direction. Minimum = 1.
May be included when one of the elements in the "listOfAnaSubsets" attribute is set to LIST_OF_TOP_APP_UL. | UserDataCongestionExt | +| maxTopAppDINbr | UInteger | O | 0..1 | Indicates the requested maximum number of top applications that contribute the most to the traffic in Downlink direction. Minimum = 1.
May be included when one of the elements in the "listOfAnaSubsets" attribute is set to LIST_OF_TOP_APP_DL. | UserDataCongestionExt | +| nfInstanceIds | array(NfInstanceId) | O | 1..N | Identification(s) of NF instance(s). | NfLoad | +| nfSetIds | array(NfSetId) | O | 1..N | Identification(s) of NF instance set(s). | NfLoad | +| nfTypes | array(NFType) | O | 1..N | Identification(s) of NF type(s).
(NOTE 13) | NfLoad
NsiLoadExt | +| notificationMethod | NotificationMethod | O | 0..1 | Indicate the notification method.
(NOTE 2) | | +| nsiIdInfos | array(NsiIdInfo) | O | 1..N | Each element identifies the S-NSSAI and the optionally associated network slice instance(s).
May be included when subscribed event is "NSI_LOAD_LEVEL", "SERVICE_EXPERIENCE" or "DN_PERFORMANCE".
(NOTE 1) | ServiceExperience
NsiLoad
DnPerformance | +| nsiLevelThrds | array(UInteger) | O | 1..N | Identifies the load threshold for each S-NSSAI or S-NSSAI and the optionally associated network slice instance identified by the "nsiIds" attribute within the "nsiIdInfos" attribute.
(NOTE 4)
Minimum = 0. Maximum = 100. | NsiLoad | +| qosRequ | QosRequirement | C | 0..1 | Indicates the QoS requirements. | QoSustainability | + +| | | | | | | +|--|--|--|--|--------------------------------------------------------------------------------------------------|---------------------------| +| | | | | It shall be included when subscribed event is "QOS_SUSTAINABILITY" or "E2E_DATA_VOL_TRANS_TIME". | ty
E2eDataVolTransTime | +|--|--|--|--|--------------------------------------------------------------------------------------------------|---------------------------| + +| | | | | | | +|------------------|------------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------| +| qosFlowRetThds | array(RetainabilityThreshold) | C | 1..N | Represents the QoS flow retainability thresholds. Shall be supplied for the 5QI ("5qi" in "qosRequ") or resource type ("resType" in "qosRequ") of GBR resource type. (NOTE 4) | QoSSustainability
E2eDataVolTransTime | +| ranUeThrouThds | array(BitRate) | C | 1..N | Represents the RAN UE throughput thresholds. Shall be supplied for the 5QI ("5qi" in "qosRequ") or resource type ("resType" in "qosRequ") of non-GBR resource type. (NOTE 4) | QoSSustainability | +| repetitionPeriod | DurationSec | C | 0..1 | Shall be supplied for notification method "PERIODIC" by the "notificationMethod" attribute. | | +| snssais | array(Snssai) | C | 1..N | Identification(s) of network slice(s) to which the subscription applies. (NOTE 1, NOTE 8) (NOTE 17) | | +| tgtUe | TargetUeInformation | O | 0..1 | Identifies target UE information. (NOTE 3) | | +| roamingInfo | RoamingInfo | O | 0..1 | Information about roaming analytics. When this attribute is provided, the request should contain only attributes that are applicable also in the Nnwdaf_RoamingAnalytics service. | RoamingAnalytics | +| congThresholds | array(ThresholdLevel) | C | 1..N | Represents the congestion threshold levels. (NOTE 4) | UserDataCongestion | +| nwPerfReqs | array(NetworkPerfRequirement) | C | 1..N | Represents the network performance requirements. This attribute shall be included when subscribed event is "NETWORK_PERFORMANCE". | NetworkPerformance | +| bwReqs | array(BwRequirement) | O | 1..N | Represents the bandwidth requirement for each application. It may only be present if "appIds" attribute is provided. | ServiceExperience | +| excepReqs | array(Exception) | C | 1..N | Represents a list of ExceptionIds with associated thresholds. May only be present when subscribed event is "ABNORMAL_BEHAVIOUR". (NOTE 5, NOTE 6, NOTE 8) | AbnormalBehaviour | +| exptAnaType | ExpectedAnalyticsType | C | 0..1 | Represents expected UE analytics type. It shall not be present if the "excepReqs" attribute is provided. (NOTE 6, NOTE 8) | AbnormalBehaviour | +| exptUeBehav | ExpectedUeBehaviourData | O | 0..1 | Represents expected UE behaviour. | AbnormalBehaviour | +| ratFreqs | array(RatFreqInformation) | O | 1..N | Identification(s) of the RAT type(s) and/or frequency(ies) of UE's serving cell(s) which the subscription applies. (NOTE 9) | ServiceExperienceExt | +| listOfAnaSubsets | array(AnalyticsSubset) | O | 1..N | The list of analytics subsets can be used to indicate the content of the analytics. | EneNA | +| disperReqs | array(DispersionRequirement) | O | 1..N | Represents the dispersion analytics requirements. | Dispersion | +| redTransReqs | array(RedundantTransmissionExpReq) | O | 1..N | Represents the redundant transmission experience | RedundantTransmissionExp | + +| | | | | | | +|--|--|--|--|-------------------------|--| +| | | | | analytics requirements. | | +|--|--|--|--|-------------------------|--| + +| | | | | | | +|---------------------|---------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| +| wlanReqs | array(WlanPerformanceReq) | O | 1..N | Represents other WLAN performance analytics requirements. If the attribute contains no content, may take default handling action. | WlanPerformance | +| ueCommReqs | array(UeCommReq) | O | 1..N | Represents the UE communication requirements. This attribute may be included when the subscribed event is "UE_COMM". | UeCommunicationExt_eNA | +| ueMobilityReqs | array(UeMobilityReq) | O | 1..N | Represents the UE mobility requirements. This attribute may be included when the subscribed event is "UE_MOBILITY". | UeMobilityExt2_eNA | +| upfInfo | UpfInformation | O | 0..1 | Identifies the UPF. (NOTE 12) | ServiceExperienceExtDnPerformance | +| userDataConOrderCri | UserDataConOrderCrit | O | 0..1 | The ordering criterion for the list of User Data Congestion analytics. (NOTE 14) | userDataConOrderCri | +| appServerAddrs | array(AddrFqdn) | C | 1..N | Each element represents the Application Server Instance (IP address/FQDN of the Application Server). (NOTE 11) | ServiceExperienceExtDnPerformance | +| dnPerfReqs | array(DnPerformanceReq) | O | 1..N | Represents the DN performance analytics requirements. | DnPerformance | +| pduSesInfos | array(PduSessionInfo) | C | 1..N | Represents combination of PDU Session parameter(s). (NOTE 15) | ServiceExperienceExt2_eNA | +| useCaseCxt | string | O | 0..1 | Indicates the context of usage of the analytics. The value and format of this parameter are not standardized. | ENAExt | +| pduSesTrafReqs | array(PduSesTrafficReq) | C | 1..N | Represents the PDU Session traffic analytics requirements. This attribute shall be included when subscribed event is "PDU_SESSION_TRAFFIC". | PduSesTraffic | +| locAccReqs | array(LocAccuracyReq) | O | 1..N | Represents the Location Accuracy analytics requirements. This attribute may only be included when the subscribed event is "LOC_ACCURACY". | LocAccuracy | +| locGranularity | LocInfoGranularity | O | 0..1 | The preferred granularity of UE location information. (NOTE 21) | ServiceExperienceExt2_eNA
UeMobilityExt2_eNA
DispersionExt_eNA
MovementBehaviour | +| locOrientation | LocationOrientation | O | 0..1 | Indicates the preferred orientation of location information. | MovementBehaviour
UeMobilityExt2_eNA | +| accuReq | AccuracyReq | O | 0..1 | Represents the analytics accuracy requirement information. May be included as indication to the NWDAF (containing an AnLF supporting Accuracy checking capability) to activate checking the analytics accuracy information of the event. | AnalyticsAccuracy | + +| | | | | | | +|--------------|-----------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| movBehavReqs | array(MovBehavReq) | O | 1..N | Represents the Movement Behaviour analytics requirements. | MovementBehaviour | +| relProxReqs | array(RelProxReq) | O | 1..N | Represents the Relative Proximity analytics requirements. | RelativeProximity | +| pauseFlg | boolean | O | 0..1 | Pause analytics consumption flag applicable on analytics ID level. Set to "true" to indicate the NWDAF to stop including analytics of this event type in its notifications (without cancelling the subscription), because the accuracy level needs to be increased.
Default value is "false" if omitted.

This attribute may be present in a update request message if the "pauseInd" attribute was provided in the notification. | AnalyticsAccuracy | +| resumeFlg | boolean | O | 0..1 | Resume analytics consumption flag applicable on analytics ID level. Set to "true" to indicate the NWDAF to resume sending the notifications of analytics because the accuracy has been improved.
Default value is "false" if omitted.

This attribute may be present in a update request message if the "resumeInd" attribute was provided in the notification. | AnalyticsAccuracy | +| feedback | AnalyticsFeedbackInfo | O | 0..1 | Analytics feedback information. It may only be provided in requests to update an existing analytics subscription for predictions. | AnalyticsAccuracy | + +NOTE 1: The "anySlice" attribute is not applicable to features "UeMobility" and "NetworkPerformance". The "snssais" attribute is not applicable to features "ServiceExperience", "NsiLoad", "UeMobility" and "NetworkPerformance". When subscribed event is "SLICE\_LOAD\_LEVEL", the identifications of network slices, either information about slice(s) identified by "snssais", or "anySlice" set to "true" shall be included. When subscribed event is "QOS\_SUSTAINABILITY", "NF\_LOAD", "UE\_COMM", "ABNORMAL\_BEHAVIOUR", "USER\_DATA\_CONGESTION", "DISPERSION", "RED\_TRANS\_EXP", "PDU\_SESSION\_TRAFFIC", "PFD\_DETERMINATION" or "RELATIVE\_PROXIMITY", the identifications of network slices identified by "snssais" is optional. When subscribed event is "NSI\_LOAD\_LEVEL", "SERVICE\_EXPERIENCE" or "DN\_PERFORMANCE", either the "nsidInfos" attribute or "anySlice" set to "true" shall be included. + +NOTE 2: When notificationMethod is not supplied, the default value is "THRESHOLD". + +NOTE 3: Applicability is further described in the corresponding data type. All target UE(s) indicated by this attribute shall belong to the same PLMN. When the RoamingAnalytics feature is supported and the target UE(s) indicated by this attribute belong to a PLMN different than the PLMN of the NF service consumer, the request should contain only attributes that are applicable also in the Nnwdaf\_RoamingAnalytics service. + +NOTE 4: This property shall be provided if the "notifMethod" in "evtReq" is set to "ON\_EVENT\_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted. + +NOTE 5: Only "excepId" and "excepLevel" within the Exception data type apply to the "excepReqs" attribute within EventSubscription data type. + +NOTE 6: Either "excepReqs" or "exptAnaType" shall be provided if subscribed event is "ABNORMAL\_BEHAVIOUR". + +NOTE 7: For different events, the following rules apply: + +- For "NETWORK\_PERFORMANCE", "USER\_DATA\_CONGESTION" or "DN\_PERFORMANCE" event, the "networkArea" attribute shall be provided if the event applied for all UEs (i.e. "anyUe" attribute set to true within the "tgtUe" attribute). +- For "QOS\_SUSTAINABILITY", at least one of "networkArea" and "fineGranAreas" attributes shall + +| | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|

be provided.

  • - For "E2E_DATA_VOL_TRANS_TIME" event, this attribute shall be provided if the event applied for single UE or group of UEs.
  • - For "SERVICE_EXPERIENCE" event, if the event applied for all UEs (i.e. "anyUe" attribute set to true within the "tgtUe" attribute): at least one of "networkArea" or "fineGranAreas" attributes shall be provided.
  • - For "MOVEMENT_BEHAVIOUR" event, at least one of "networkArea" or "fineGranAreas" attributes shall be provided.

NOTE 8: For "ABNORMAL_BEHAVIOUR" event with "anyUe" attribute in "tgtUe" attribute sets to true,

  • - at least one of the "networkArea" and the "snssais" attribute should be included, if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via the "excepRequs" attribute is mobility related;
  • - at least one of the "networkArea", "applds", "dnns" and "snssais" attribute should be included, if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via the "excepRequs" attribute is communication related;
  • - the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepRequs" attribute shall not be requested for both mobility and communication related analytics at the same time.

NOTE 9: If both the "allFreq" attribute and the "allRat" attribute are present within the RatFreqInformation data type, then only one instance of the RatFreqInformation data type shall be present to indicate for all the RAT type and all the Frequency values the NWDAF has received for the application.

NOTE 10: If this attribute is provided, the analytics target period shall be a past time period (i.e. only statistics is supported).

NOTE 11: For service experience analytics, this parameter shall be provided when a consumer requires analytics for an edge application over a UP path.

NOTE 12: For service experience analytics, this parameter may be provided when a consumer requires analytics for an edge application over a UP path, and it is only needed when the target of the service experience analytics is a specific UPF included in this UP path.

NOTE 13: When subscribed event is "NSI_LOAD_LEVEL" and the NsiLoadExt feature is supported, and the NF service consumer provides the "nftypes" attribute, then the NWDAF accounts only for the resource usage of the NF types included in "nftypes" to derive the output analytics. If the "nftypes" attribute is not provided, then NWDAF accounts for the resource usage of all NF types.

NOTE 14: If the value of "userDataConOrderCri" attribute is "APPLICABLE_TIME_WINDOW", the "ASCENDING" direction indicates that the list of User Data Congestion analytics are in chronological order and the "DESCENDING" direction indicates that the list of User Data Congestion analytics are in reverse chronological order.

NOTE 15: When the "pduSesInfos" attribute is provided, the associated "applds" attribute shall also be provided for the NWDAF to be able to compute the service experience per application.

NOTE 16: When subscribed event is "PFD_DETERMINATION" and the PfdDetermination feature is supported, the "applds" attribute shall be included.

NOTE 17: When the subscribed event is "PDU_SESSION_TRAFFIC" and the PduSesTraffic feature is supported, at least one of the "dnns" and/or "snssais" attributes as the route selection descriptor(s) for the URSP rule shall be included.

NOTE 18: When this attribute is provided, the NWDAF shall provide the analytics per elementary time slot accordingly.

NOTE 19: When this attribute is provided, the NWDAF shall provide the analytics per group of TAs or cells accordingly.

NOTE 20: If both "networkArea" and "fineGranAreas" attributes are provided, the Area of Interest is interpreted as the intersection area indicated by these two attributes.

NOTE 21: The "LON_AND_LAT_LEVEL" value of "locGranularity" attribute is not applicable to features "DispersionExt_eNA". The "TA_LEVEL" or "CELL_LEVEL" value of "locGranularity" attribute is not applicable to features "MovementBehaviour".

NOTE 22: When the subscribed event is "LOC_ACCURACY", only one of the "networkArea" attribute or "location" attribute shall be included.

| +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +NOTE: Care needs to be taken to avoid excessive signalling. + +## 5.1.6.2.4 Type NnwdafEventsSubscriptionNotification + +Table 5.1.6.2.4-1: Definition of type NnwdafEventsSubscriptionNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|--------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| eventNotifications | array(EventNotification) | C | 1..N | Notifications about Individual Events. (NOTE 1) | | +| subscriptionId | string | M | 1 | String identifying a subscription to the Nnwdaf_EventsSubscription service. (NOTE 2) | | +| notifCorrId | string | O | 0..1 | Notification correlation identifier. | EneNA | +| oldSubscriptionId | string | C | 0..1 | Subscription ID which was allocated by the source NWDAF. This parameter shall be present if the notification is for informing the assignment of a new Subscription Id by the target NWDAF in the analytics transfer procedure. (NOTE 1) | EneNA | +| resourceUri | Uri | C | 0..1 | The resource URI of the Individual NWDAF Event Subscription resource created by the target NWDAF. Shall be present when the target NWDAF notifies a successful analytics subscription transfer. (NOTE 1) (NOTE 2) | EneNA | +| termCause | TermCause | O | 0..1 | A cause for which the NWDAF will send no further notifications for this subscription. Its presence indicates that the NWDAF requests the termination of the subscription. | TermRequest | +| transEvents | array(NnwdafEvent) | C | 1..N | Indicates the successful transferred subscription event(s) for a partial successful analytics subscription transfer. It shall be supplied by the Target NWDAF if not all the analytics events in the subscription transfer are accepted. | PartialAnalyticsSubTransfer | + +NOTE 1: Either "eventNotifications" attribute, or "resourceUri" and "oldSubscriptionId" attributes shall be provided. +NOTE 2: It shall be the same as the last segment of the "resourceUri" attribute when the target NWDAF notifies the consumer of the successful analytics subscription transfer. + +### 5.1.6.2.5 Type EventNotification + +**Table 5.1.6.2.5-1: Definition of type EventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| event | Nwdafevent | M | 1 | Event that is notified. | | +| start | DateTime | O | 0..1 | It defines the start time of which the statistics analytics information is applicable or predictions analytics information is valid. (NOTE 1) (NOTE 4) | | +| dataVITrnsTmInfos | array(E2eDataVolTransTimeInfo) | C | 1..N | E2E data volume transfer time information. Shall be present if the subscribed event is "E2E_DATA_VOL_TRANS_TIME". | E2eDataVolTransTime | +| expiry | DateTime | O | 0..1 | It defines the expiration time after which the statistics analytics information is not applicable or predictions analytics information is invalid. (NOTE 1) (NOTE 4) | | +| timeStampGen | DateTime | C | 0..1 | It defines the timestamp of analytics generation. (NOTE 3) | | +| failNotifyCode | NwdaFailureCode | C | 0..1 | Identifies the failure reason for the event notification. It shall only be included if the event notification is failed or the analytics information is not ready. (NOTE 2) | EneNA | +| rvWaitTime | DurationSec | O | 0..1 | Indicate a recommended time interval (in seconds) which is used to determine the time when analytics information is needed in similar future event subscriptions. It may only be included if the "failNotifyCode" attribute sets to "UNSATISFIED_REQUESTED_ANALYTICS_TIME". | EneNA | +| anaMetaInfo | AnalyticsMetadataInfo | C | 0..1 | Contains information about analytics metadata required to aggregate the analytics. It shall be present if the "anaMeta" attribute was included in the subscription, containing the information indicated by the "anaMeta" attribute. | Aggregation | +| nwPerfs | array(NetworkPerfInfo) | C | 1..N | The network performance information. Shall be present when subscribed even is "NETWORK_PERFORMANCE". | NetworkPerformance | +| nflLoadLevelInfos | array(NfLoadLevelInformation) | C | 1..N | The NF load level information. When subscribed event is "NF_LOAD", the nflLoadLevelInfos shall be included. | NfLoad | +| nsiLoadLevelInfos | array(NsiLoadLevelInfo) | C | 1..N | Each element identifies the load level information for each S-NSSAI and the optionally associated network slice instance. Shall be included when subscribed event is "NSI_LOAD_LEVEL". | NsiLoad | +| pfdDetermInfos | array(PfdDeterminationInfo) | C | 1..N | Represents the PFD Determination information for a known application identifier. Shall be included when subscribed event is "PFD_DETERMINATION". | PfdDetermination | + +| | | | | | | +|--------------------|-------------------------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| qoSustainInfos | array(QoSustainabilityInfo) | C | 1..N | The QoS sustainability information.
When subscribed event is "QOS_SUSTAINABILITY", the qoSustainInfos shall be included. | QoSSustainability | +| sliceLoadLevelInfo | SliceLoadLevelInformation | C | 0..1 | The slices and the load level information.
When subscribed event is "SLICE_LOAD_LEVEL", the sliceLoadLevelInfo shall be included. | | +| svcExps | array(ServiceExperienceInfo) | C | 1..N | The service experience information.
When subscribed event is "SERVICE_EXPERIENCE", the svcExps shall be included. | ServiceExperience | +| ueComms | array(UeCommunication) | C | 1..N | The UE communication information.
When subscribed event is "UE_COMM", the ueComms shall be included. | UeCommunication | +| ueMobs | array(UeMobility) | C | 1..N | The UE mobility information.
When subscribed event is "UE_MOBILITY", the ueMobs shall be included. | UeMobility | +| abnorBehavrs | array(AbnormalBehaviour) | C | 1..N | The Abnormal Behaviour information.
When subscribed event is "ABNORMAL_BEHAVIOUR", the abnorBehavrs shall be included. | AbnormalBehaviour | +| userDataCongInfos | array(UserDataCongestionInfo) | C | 1..N | The location and user data congestion information.
Shall be present if the subscribed event is "USER_DATA_CONGESTION". | UserDataCongestion | +| dnPerfInfos | array(DnPerfInfo) | C | 1..N | The DN performance information.
Shall be present if the subscribed event is "DN_PERFORMANCE". | DnPerformance | +| dispersInfos | array(DispersionInfo) | C | 1..N | The Dispersion information.
When subscribed event is "DISPERSION", the "dispersInfos" attribute shall be included. | Dispersion | +| redTransInfos | array(RedundantTransmissionExpInfo) | C | 1..N | The redundant transmission experience related information.
When subscribed event is "RED_TRANS_EXP", the "redTransInfos" attribute shall be included. | RedundantTransmissionExp | +| wlanInfos | array(WlanPerformanceInfo) | C | 1..N | The WLAN performance related information.
When subscribed event is "WLAN_PERFORMANCE", the "wlanInfos" attribute shall be included. | WlanPerformance | +| smccExps | array(SmccInfo) | C | 1..N | The Session Management Congestion Control Experience information.
Shall be present when the requested event is "SM_CONGESTION". | SMCCE | +| pduSesTrafInfos | array(PduSesTrafficInfo) | C | 1..N | The PDU Session traffic related information.
When subscribed event is "PDU_SESSION_TRAFFIC", the "pduSesTrafInfos" attribute shall be included. | PduSesTraffic | + +| | | | | | | +|---------------|-------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| accuInfo | AccuracyInfo | C | 0..1 | The analytics accuracy information.
Shall be provided if the analytics accuracy requirement was subscribed in the "accuReq" attribute and the "cancelAccuInd" attribute is set to "false" or omitted. | AnalyticsAccuracy | +| cancelAccuInd | boolean | O | 0..1 | Indicates cancelled subscription of the analytics accuracy information.
Set to "true" indicates the NWDAF cancelled subscription of analytics accuracy information as the NWDAF does not support the accuracy checking capability.
Otherwise set to "false". Default value is "false" if omitted. | AnalyticsAccuracy | +| pauseInd | boolean | O | 0..1 | Pause analytics consumption indication applicable on analytics ID level. Set to "true" to indicate the consumer to stop the consumption of the analytics because the accuracy level needs to be increased.

Default value is "false" if omitted. | AnalyticsAccuracy | +| resumeInd | boolean | O | 0..1 | Resume analytics consumption indication applicable on analytics ID level. Set to "true" to indicate the consumer to resume the consumption of the analytics because the accuracy has been improved.

Default value is "false" if omitted. | AnalyticsAccuracy | +| movBehavInfos | array(MovBehavInfo) | C | 1..N | The Movement Behaviour information.
When subscribed event is "MOVEMENT_BEHAVIOUR", the "movBehavInfo" attribute shall be included. | MovementBehaviour | +| relProxInfos | array(RelProximityInfo) | C | 1..N | The Relative Proximity information.
When subscribed event is "RELATIVE_PROXIMITY", the "relProxInfos" attribute shall be included. | RelativeProximity | + +NOTE 1: If the "start" attribute and the "expiry" attribute are both provided, the DateTime of the "expiry" attribute shall not be earlier than the DateTime of the "start" attribute. + +NOTE 2: The value of "PREDICTION\_NOT\_ALLOWED" and "BOTH\_STAT\_PRED\_NOT\_ALLOWED" of the NwdaFailureCode data type is not applicable for the "failNotifyCode" attribute. The value of "UNAVAILABLE\_DATA" of the NwdaFailureCode data type is applicable for the the "failNotifyCode" attribute only when the "StatisticsFailure" feature is supported. + +NOTE 3: This attribute shall be included when ADRF is deployed. + +NOTE 4: The validity period specified by "start" and "expiry" attributes is determined by NWDAF internal logic, and is a subset of the analytics target period indicated by "startTs" and "endTs", or "offsetPeriod" attributes contained in "extraReportReq" attribute of the subscription. If the analytics target period refers to the past, the period specified by these two attributes indicate the time period over which the statistics are applicable. If the analytics target period refers to the future, the period specified by these two attributes indicate the time period over which the predictions are valid. + +## 5.1.6.2.6 Type SliceLoadLevelInformation + +**Table 5.1.6.2.6-1: Definition of type SliceLoadLevelInformation** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|----------------------|---|-------------|------------------------------------------------------------------------------------|---------------| +| loadLevelInformation | LoadLevelInformation | M | 1 | Load level information which applies for each network slice identified by snssais. | | +| snssais | array(SNSSAI) | M | 1..N | Identification(s) of network slice to which the subscription applies. | | + +NOTE: The functionality of the Slice Load Level Information is a subset of the functionality of the NSI Load Level Information, does not need to be used if the NsiLoadExt feature is supported, and is maintained only for backwards compatibility purposes. + +### 5.1.6.2.7 Type EventReportingRequirement + +**Table 5.1.6.2.7-1: Definition of type EventReportingRequirement** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| accuracy | Accuracy | O | 0..1 | Preferred level of accuracy of the analytics. (NOTE 5) | | +| accPerSubset | array(Accuracy) | O | 1..N | Each element indicates the preferred accuracy level per analytics subset. It may be present if the "listOfAnaSubsets" attribute is present in the subscription request (NOTE 4, NOTE 5) | EneNA | +| startTs | DateTime | O | 0..1 | UTC time indicating the start time of the observation period. The absence of this attribute means subscription at the present time unless the "offsetPeriod" attribute is included. (NOTE 3) | | +| endTs | DateTime | O | 0..1 | UTC time indicating the end time of the observation period. If the start time is in the past, then the absence of this attribute means that the end time of the subscription is at the present time, unless the "offsetPeriod" attribute is included. If provided, it shall not be less than the start time. (NOTE 3) | | +| offsetPeriod | integer | O | 0..1 | Offset period in units of seconds to the reporting time, if the value is negative means statistics in the past offset period, otherwise a positive value means prediction in the future offset period. May be present if the "repPeriod" attribute is included within the "evtReq" attribute or the "repetitionPeriod" attribute is included within the EventSubscription type. (NOTE 3) | EneNA | +| sampRatio | SamplingRatio | O | 0..1 | Percentage of sampling (1%...100%) among impacted UEs. Applicable to event targeting a group of UEs or any UE. (NOTE 1) | | +| maxSupiNbr | UInteger | O | 0..1 | Represents the maximum number of SUPIs expected in an object. Applicable for the event(s) providing a list of SUPIs during the analytics response. | | +| maxObjectNbr | UInteger | O | 0..1 | Maximum number of objects expected for an analytics report. It's only applicable for the event(s) which may provide more than one entries or objects during event notification. | | +| timeAnaNeeded | DateTime | O | 0..1 | UTC time indicating the time when analytics information is needed. | EneNA | +| anaMeta | array(AnalyticsMetadata) | O | 1..N | List of analytics metadata that are requested to be included. | Aggregation | +| anaMetaInd | AnalyticsMetadataIndication | O | 0..1 | Contains values for the analytics metadata that the NF service consumer wants to be used for generating the analytics. | Aggregation | +| histAnaTimePeriod | TimeWindow | O | 0..1 | The time period of historical analytics indicates the start time and end time during which the historical analytics was generated. If this attribute is | EneNA | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--|--|--|----------------------------------------------------------------------------------------------------------------|--| +| | | | | included, the NWDAF only needs to provide the existing analytics, and does not need to generate new analytics. | | +|

NOTE 1: The "sampRatio" attribute within EventReportingRequirement data type is not applicable for the Nnwdaf_EventsSubscription API.

NOTE 2: Void.

NOTE 3: When the "offsetPeriod" attribute is included, the "startTs" and "endTs" attributes shall not be included. If the analytics target period is indicated either by providing a "startTs" attribute and an "endTs" attribute that are equal, or by providing an "offsetPeriod" attribute equal to zero (which means there is no offset to the periodic reporting time indicated by the "repPeriod" attribute or "repetitionPeriod" attribute), then this is a request for analytics for a specific time of the same "startTs" attribute and "endTs" attribute or each specific time periodically indicated by the "repPeriod" attribute , rather than for a time interval. If none of the attributes "startTs", "endTs" and "offsetPeriod" is provided, the analytics target period starts at the present time and there is no specified end time.

NOTE 4: If multiple accuracy entries are included, the order of the entries of the "accPerSubset" attribute corresponds with the order of the entries of the "listOfAnaSubsets" attribute, i.e. the first entry of the "accPerSubset" attribute holds the requested accuracy for the analytics subset that is indicated by the first entry of the "listOfAnaSubsets" attribute, and so on.

NOTE 5: If both the "accuracy" attribute and "accPerSubset" attribute were provided in the request, the "accPerSubset" attribute takes precedence over the "accuracy" attribute.

| | | | | | + +## 5.1.6.2.8 Type TargetUeInformation + +Table 5.1.6.2.8-1: Definition of type TargetUeInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| anyUe | boolean | O | 0..1 | Identifies any UE when setting to "true".
Default value is "false" if omitted.
(NOTE 3) | ServiceExperience
NetworkPerformance
NfLoad
UserDataCongestion
AbnormalBehaviour
QoSustainability
Dispersion
RedundantTransmissionExp
WlanPerformance
DnPerformance
PduSesTraffic | +| supis | array(Supi) | O | 1..N | Each element represents a SUPI for a UE.
(NOTE 2) | UeMobility
UeCommunication
NetworkPerformance
AbnormalBehaviour
UserDataCongestion
NfLoad
ServiceExperience
Dispersion
RedundantTransmissionExp
WlanPerformance
SMCCE
DnPerformance
PduSesTraffic
RelativeProximity | +| gpsi | array(Gpsi) | O | 1..N | Each element represents a GPSI for a UE.
(NOTE 2) | UserDataCongestion
Ext
DnPerformance | +| intGroupIds | array(GroupId) | O | 1..N | Each element represents an internal group identifier and identifies a group of UEs.
(NOTE 2) | UeMobility
UeCommunication
NetworkPerformance
AbnormalBehaviour
ServiceExperience
Dispersion
RedundantTransmissionExp
WlanPerformance
DnPerformance
PduSesTraffic
RelativeProximity | + +NOTE 1: For an applicable feature or UserDataCongestion and UserDataCongestionExt features are both applicable, only one attribute identifying the target UE shall be provided. + +NOTE 2: Only one element in the attribute shall be provided for the applicable events except the "SERVICE\_EXPERIENCE" event, the "DISPERSION" event and/or the "SMCCE" event. + +NOTE 3: For feature "Dispersion", any UE is only supported in combination with S-NSSAI, Area of Interest and/or Dispersion Class. + +## 5.1.6.2.9 Void + +## 5.1.6.2.10 Type UeMobility + +Table 5.1.6.2.10-1: Definition of type UeMobility + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| ts | DateTime | C | 0..1 | This attribute identifies the timestamp when the UE arrives the location. (NOTE 1) | | +| recurringTime | ScheduledCommunicationTime | C | 0..1 | Identifies time of the day and day of the week which are valid within the observation period when the UE moves. (NOTE 1, NOTE 2) | | +| duration | DurationSec | M | 1 | This attribute identifies the time duration the UE stays in the location.
If the analytics result applies for a group of UEs, it indicates the average duration for the group of UEs.
(NOTE 3) | | +| durationVariance | Float | C | 0..1 | This attribute indicates the variance of the analysed durations for the group of UEs. It shall be provided if the analytics result applies for a group of UEs. | | +| locInfos | array(LocationInfo) | M | 1..N | This attribute includes a list of UE location information during the time duration.
(NOTE 4) | | +| directionInfos | array(DirectionInfo) | C | 1..N | This attribute includes a list of UE direction information. Shall be present if one of the elements in the "listOfAnaSubsets" attribute in the request was set to "UE_DIRECTION". | UeMobilityExt_AIML | + +NOTE 1: Either "ts" or "recurringTime" shall be provided. +NOTE 2: If this attribute is present, it indicates the UE movement is periodic. This attribute is suitable to be present for a recurring mobility in a long observation time. +NOTE 3: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "duration" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. +NOTE 4: If the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes are provided in the request, the number of TAs or cells contained in "areaInfo" attribute shall be smaller than or equal to the values of the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes. + +## 5.1.6.2.11 Type LocationInfo + +Table 5.1.6.2.11-1: Definition of type LocationInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------| +| loc | UserLocation | M | 1 | This attribute contains the detailed location, the ueLocationTimestamp attribute in the 3GPP access type of UserLocation data type shall not be provided.
(NOTE 3) | | +| geoLoc | GeographicalArea | C | 0..1 | This attribute contains the geographical location in a fine granularity (e.g. smaller than a cell).
Shall be present if one of the elements in the "listOfAnaSubsets" attribute in the request was set to "USER_LOCATION".
(NOTE 2) (NOTE 3) | UeMobilityExt2_eNA
ServiceExperienceExt2_eNA
DispersionExt_eNA | +| ratio | SamplingRatio | C | 0..1 | This attribute contains the percentage of UEs with same analytics result in the group.
Shall be present if the analytics result applies for a group of UEs. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 1)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +| geoDistrInfos | array(GeoDistributionInfo) | C | 1..N | Indicates the geographical distribution of the UEs that may be selected by the AF for application service. Shall be present if one of the elements in the "listOfAnaSubsets" attribute in the request was set to "UE_GEO_DIST". | UeMobilityExt_AIML | +| distThreshold | UInteger | O | 0..1 | Indicates the linear distance threshold which has been reached. This attribute will be provided only if more than one thresholds were provided in "distThresholds" attribute contained in UeMobilityReq data type and the target is a single UE. | UeMobilityExt2_eNA | + +NOTE 1: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +NOTE 2: When possible and applicable to the access type, the UE location is provided according to the preferred granularity subscribed or requested in the "locGranularity" attribute. + +NOTE 3: When the "geoLoc" attribute is present, the "loc" attribute shall be ignored. + +5.1.6.2.12 Void + +5.1.6.2.13 Type UeCommunication + +**Table 5.1.6.2.13-1: Definition of type UeCommunication** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| commDur | DurationSec | M | 1 | Identifies the duration of the communication.
If the analytics result applies for a group of UEs, it indicates the average duration for the subset of UEs indicated by a given ratio in the group. | | +| commDurVariance | Float | C | 0..1 | This attribute indicates the variance of the analysed durations for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs. | | +| periodTime | DurationSec | O | 0..1 | Identifies interval time of periodic communication, e.g. every 10 minutes or 1 hour. (NOTE 2)
If the analytics result applies for a group of UEs, it indicates the average interval time of periodic communication for the subset of UEs indicated by a given ratio in the group. | | +| periodTimeVariance | Float | C | 0..1 | This attribute indicates the variance of the analysed intervals of periodic communication for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs. | | +| ts | DateTime | C | 0..1 | Identifies the start time of the communication. (NOTE 1) | | +| tsVariance | Float | O | 0..1 | This attribute indicates the variance of the analysed start time for the subset of UEs indicated by a given ratio in the group. It may only be provided if the ts attribute is provided. | | +| recurringTime | ScheduledCommunicationTime | C | 0..1 | Identifies time of the day and day of the week which are valid within the observation period when the UE has communication.
Providing the end time in ScheduledCommunicationTime data type is not required. (NOTE 1, NOTE 3) | | +| trafChar | TrafficCharacterization | M | 1 | Identifies the detailed traffic characterization. | | +| ratio | SamplingRatio | C | 0..1 | This attribute contains the percentage of UEs with same analytics result in the group. Shall be present if the analytics result applies for a group of UEs. | | +| periodCommInd | boolean | O | 0..1 | This attribute indicates whether the UE communicates periodically or not.
Set to "true" to indicate the UE communicates periodically, set to "false" to indicate the UE does not communicate periodically.
Default value is "false" if omitted. | UeCommunicationExt | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 4)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +| anaOfAppList | AppListForUeCo | C | 0..1 | Represents the analytics of the | UeCommunicationE | + +| | | | | | | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| | mm | | | application list used by UE.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to APP_LIST_FOR_UE_COMM. | xt | +| sessInactTimer | SessInactTimerForUeComm | C | 0..1 | Represents the N4 Session inactivity timer.
Shall be present only if one of the elements in the "listOfAnaSubsets" attribute was set to N4_SESS_INACT_TIMER_FOR_UE_COMM and the identified NF service consumer is an SMF.
(NOTE 5) | UeCommunicationExt | +| NOTE 1: Either "ts" or "recurringTime" shall be provided.
NOTE 2: If this attribute is present, it indicates the communication is periodic and its value shall be larger than the commDur value. If this attribute is present with the ts attribute, it indicates the periodic communication time valid within the observation period; if it is present with the recurringTime attribute, it indicates the periodic communication time valid within the day(s).
NOTE 3: If this attribute is present, it indicates the communication is periodic. This attribute is suitable to be present for a recurring communication in a long observation time.
NOTE 4: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence.
NOTE 5: This attribute shall not be provided if the NWDAF does not know the NF service consumer type or if the NWDAF knows that the NF service consumer is not an SMF. | | | | | | + +## 5.1.6.2.14 Type TrafficCharacterization + +Table 5.1.6.2.14-1: Definition of type TrafficCharacterization + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | O | 0..1 | Contains the application identifier. | | +| dnn | Dnn | O | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. Shall be present if the "dnns" was provided within EventSubscription during the subscription for event notification procedure. | | +| snssai | Snssai | C | 0..1 | Identifies the network slice. Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure. | | +| fDescs | array(IpEthFlowDescription) | O | 1..2 | Contains the flow description for the Uplink and/or Downlink flows. | | +| ulVol | Volume | C | 0..1 | Identifies the uplink traffic volume. (NOTE)
If the analytics result applies for a group of UEs, it indicates the average uplink traffic volume for the subset of UEs indicated by a given ratio in the group. | | +| ulVolVariance | Float | C | 0..1 | This attribute indicates the variance of the uplink traffic volumes for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs. | | +| dlVol | Volume | C | 0..1 | Identifies the downlink traffic volume. (NOTE)
If the analytics result applies for a group of UEs, it indicates the average downlink traffic volume for the subset of UEs indicated by a given ratio in the group. | | +| dlVolVariance | Float | C | 0..1 | This attribute indicates the variance of the downlink traffic volumes for the subset of UEs indicated by a given ratio in the group. It shall be provided if the analytics result applies for a group of UEs. | | + +NOTE: At least one of "ulVol" or "dlVol" shall be provided. + +## 5.1.6.2.15 Type AbnormalBehaviour + +Table 5.1.6.2.15-1: Definition of type AbnormalBehaviour + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supis | array(Supi) | C | 1..N | Each element identifies a UE which is affected with the Exception.
Shall be present if the subscription request applies to more than one UE. | | +| dnn | Dnn | C | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.
Shall be present if the "dnns" was provided within EventSubscription during the subscription for event notification procedure. | | +| excep | Exception | M | 1 | Contains the exception information. | | +| snssai | Snssai | C | 0..1 | Identifies the network slice information.
Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure. | | +| ratio | SamplingRatio | C | 0..1 | Contains the percentage of UEs with same analytics result in the group or among all UEs.
Shall be present if the analytics result applies for a group of UEs or any UE. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +| addtMeasInfo | AdditionalMeasurement | O | 0..1 | Additional measurement. | | + +NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +## 5.1.6.2.16 Type Exception + +Table 5.1.6.2.16-1: Definition of type Exception + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-------------------------------------------|---------------| +| exceptionId | ExceptionId | M | 1 | Indicating the Exception ID. | | +| exceptionLevel | integer | O | 0..1 | Measured level, compared to the threshold | | +| exceptionTrend | ExceptionTrend | O | 0..1 | Measured trend | | + +## 5.1.6.2.17 Type UserDataCongestionInfo + +Table 5.1.6.2.17-1: Definition of type UserDataCongestionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| networkArea | NetworkAreaInfo | M | 1 | Identification of network area to which the subscription applies. | | +| congestionInfo | CongestionInfo | M | 1 | The congestion information of the specific location. | | +| snssai | Snssai | C | 0..1 | Identifies an S-NSSAI. Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure. | | + +## 5.1.6.2.18 Type CongestionInfo + +Table 5.1.6.2.18-1: Definition of type CongestionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| +| congType | CongestionType | M | 1 | Identification congestion analytics type. | | +| timeIntev | TimeWindow | M | 1 | Represents the start time and the stop time to which requested for the congestion information applies. (NOTE 2) | | +| nsi | ThresholdLevel | M | 1 | Network Status Indication. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 1)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +| topAppListUl | array(TopApplication) | C | 1..N | List of top applications in Uplink. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to LIST_OF_TOP_APP_UL. | UserDataCongestion Ext | +| topAppListDl | array(TopApplication) | C | 1..N | List of top applications in Downlink. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to LIST_OF_TOP_APP_DL. | UserDataCongestion Ext | + +NOTE 1: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +NOTE 2: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "timeIntev" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +## 5.1.6.2.19 Type QoSustainabilityInfo + +Table 5.1.6.2.19-1: Definition of type QoSustainabilityInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| areaInfo | NetworkAreaInfo | M | 1 | Identification(s) of applicable location areas to which the subscription.
(NOTE 4) | | +| fineAreaInfos | array(GeographicArea) | O | 1..N | This attribute contains the geographical locations in a fine granularity (e.g. smaller than a cell). May be provided when the "fineGranAreas" attribute is provided in the request. | QoSustainabilityExt_eNA | +| startTs | DateTime | M | 1 | Represents the start time of the applicable observing period.
(NOTE 3) | | +| endTs | DateTime | M | 1 | Represents the end time of the applicable observing period.
(NOTE 3) | | +| qosFlowRetThd | RetainabilityThreshold | C | 0..1 | The reporting QoS Flow Retainability Threshold that are met or crossed for 5QI of GBR resource type.
(NOTE 1) | | +| ranUeThrouThd | BitRate | C | 0..1 | The reporting RAN UE Throughput Threshold that are met or crossed for 5QI of non-GBR resource type.
(NOTE 1) | | +| snssai | Snssai | C | 0..1 | Identifies an S-NSSAI. Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 2)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE 1: Either "qosFlowRetThd" or "ranUeThrouThd" attribute shall be provided. +NOTE 2: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. +NOTE 3: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "startTs" and "endTs" attributes shall be greater than or equal to the value of the "temporalGranSize" attribute. +NOTE 4: If the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes are provided in the request, the number of TAs or cells contained in "areaInfo" attribute shall be smaller than or equal to the values of the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes. + +## 5.1.6.2.20 Type QosRequirement + +Table 5.1.6.2.20-1: Definition of type QosRequirement + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------------|------------------|---|-------------|-------------------------------------------------------------------------------------------------------------|------------------------------| +| 5qi | 5Qi | C | 0..1 | Represents a 5G QoS Identifier. It shall be included for standardized or preconfigured 5QIs. (NOTE) | | +| gfbrUl | BitRate | C | 0..1 | Indicates GFBR in the uplink. It shall be included for GBR 5QIs. | | +| gfbrDl | BitRate | C | 0..1 | Indicates GFBR in the downlink. It shall be included for GBR 5QIs. | | +| resType | QosResourceType | C | 0..1 | Resource type. Shall be provided for the non-standardized and non-preconfigured QoS characteristics. (NOTE) | | +| pdb | PacketDelBudget | O | 0..1 | Packet Delay Budget. May be supplied for the non-standardized and non-pre-configured QoS characteristics. | | +| per | PacketErrRate | O | 0..1 | Packet Error Rate. May be supplied for the non-standardized and non-pre-configured QoS characteristics. | | +| deviceSpeed | VelocityEstimate | O | 0..1 | Velocity Estimate. | QoSSustainabilityExt_eN
A | +| deviceType | DeviceType | O | 0..1 | The device type. | QoSSustainabilityExt_eN
A | +| NOTE: Either 5QI within "5qi" attribute or the resource type within "resType" attribute shall be provided. | | | | | | + +## 5.1.6.2.21 Type RetainabilityThreshold + +Table 5.1.6.2.21-1: Definition of type RetainabilityThreshold + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| relFlowNum | UInteger | C | 0..1 | Represents the number of abnormally released QoS flows. (NOTE) | | +| relTimeUnit | TimeUnit | C | 0..1 | Represents the unit for the session active time, shall be present if relFlowNum is present. (NOTE) | | +| relFlowRatio | SamplingRatio | C | 0..1 | Represents the ratio of abnormally released QoS flows to the total released QoS flows, expressed in percentage. (NOTE) | | +| NOTE: Either "relFlowNum" and its associated "relTimeUnit" attributes or "relFlowRatio" attributes shall be provided. The "relFlowNum" and "relTimeUnit" attributes together represents the number of abnormally released QoS flows (i.e. relFlowNum) within the time unit (i.e. relTimeUnit). | | | | | | + +## 5.1.6.2.22 Type NetworkPerfRequirement + +Table 5.1.6.2.22-1: Definition of type NetworkPerfRequirement + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| nwPerfType | NetworkPerfType | M | 1 | The type of the network performance. | | +| relativeRatio | SamplingRatio | C | 0..1 | The relative ratio expressed in percentage. (NOTE 1) | | +| absoluteNum | UInteger | C | 0..1 | The absolute number (NOTE 1) | | +| orderCriterion | NetworkPerfOrderCriterion | O | 0..1 | The ordering criterion for the list of network performance analytics. (NOTE 2) | NetworkPerformanceExt_eNA | +| rscUsgReq | ResourceUsageRequirement | O | 0..1 | Indicates more requirements when providing resource usage information for the network performance type indicated by the "nwPerfType" attribute. (NOTE 3) | NetworkPerformanceExt_AIML | + +NOTE 1: Either "relativeRatio" or "absoluteNum" shall be provided if the "notifMethod" in "evtReq" is set to "ON\_EVENT\_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted. + +NOTE 2: The "CROSSED" value in "MatchingDirection" data type is not applicable for this attribute. + +NOTE 3: The "rscUsgReq" value is only applicable when the "nwPerfType" attribute is set to "GNB\_RSC\_USAGE\_OVERALL\_TRAFFIC", "GNB\_RSC\_USAGE\_GBR\_TRAFFIC" or "GNB\_RSC\_USAGE\_DELAY\_CRIT\_GBR\_TRAFFIC". + +## 5.1.6.2.23 Type NetworkPerfInfo + +Table 5.1.6.2.23-1: Definition of type NetworkPerfInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| networkArea | NetworkAreaInfo | M | 1 | Identification of network area to which the subscription applies. (NOTE 5) | | +| nwPerfType | NetworkPerfType | M | 1 | The type of the network performance | | +| anaPeriod | TimeWindow | O | 0..1 | Indicates the analytics target period subset within the requested analytics target period. (NOTE 4) | NetworkPerformanceExt_eNA | +| relativeRatio | SamplingRatio | C | 0..1 | The reported relative ratio expressed in percentage. (NOTE 1) | | +| absoluteNum | UInteger | C | 0..1 | The reported absolute number (NOTE 1) | | +| rscUsgReq | ResourceUsageRequirement | O | 0..1 | Indicates more information when providing resource usage information for the network performance type indicated by the "nwPerfType" attribute. (NOTE 3) | NetworkPerformanceExt_AIML | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 2)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE 1: Either "relativeRatio" or "absoluteNum" shall be provided. + +NOTE 2: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +NOTE 3: The "rscUsgReq" value is only applicable when the "nwPerfType" attribute is set to "GNB\_RSC\_USAGE\_OVERALL\_TRAFFIC", "GNB\_RSC\_USAGE\_GBR\_TRAFFIC" or "GNB\_RSC\_USAGE\_DELAY\_CRIT\_GBR\_TRAFFIC". + +NOTE 4: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "anaPeriod" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +NOTE 5: If the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes are provided in the request, the number of TAs or cells contained in "networkArea" attribute shall be smaller than or equal to the values of the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes. + +## 5.1.6.2.24 Type ServiceExperienceInfo + +**Table 5.1.6.2.24-1: Definition of type ServiceExperienceInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| svcExprc | SvcExperience | M | 1 | Service experience | | +| svcExprcVariance | Float | O | 0..1 | This attribute indicates the variance . | | +| supis | array(Supi) | O | 1..N | Each element identifies a UE.
May only be present if the subscription request applies to more than one UE. (NOTE 3) | | +| snssai | Snssai | C | 0..1 | Identifies an S-NSSAI. Shall be presented if the "snssais" was provided within EventSubscription during the subscription for event notification procedure. | | +| appId | ApplicationId | C | 0..1 | Identifies an application. Shall be present if the "appIds" was provided within EventSubscription during the subscription for event notification procedure. | | +| srvExprcType | ServiceExperienceType | O | 0..1 | Indicates the type of Service Experience analytics. | ServiceExperienceExt | +| ueLocs | array(LocationInfo) | C | 1..N | This attribute includes a list of UE location information during the time duration.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to UE_LOCATION. (NOTE 2) | ServiceExperienceExt | +| upflInfo | UpflInformation | C | 0..1 | Represents the information of the UPF serving the UE.
Shall be present only if the "upflInfo" attribute was provided in the request or subscription and the NF service consumer is identified as not an AF or a NEF. (NOTE 4) | ServiceExperienceExt | +| dnai | Dnai | C | 0..1 | Indicates the DN Access Identifier representing location of the service flow. Shall be present if the "dnais" attribute was provided in the request or subscription. | ServiceExperienceExt | +| appServerInst | AddrFqdn | C | 0..1 | Represents the Application Server Instance (IP address or FQDN of the Application Server).
Shall be present if the "appServerAddrs" attribute was provided in the request or subscription. | ServiceExperienceExt | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 1)
Shall be present if the | | + +| | | | | | +|--|--|--|------------------------------------------------------------------|--| +| | | | analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +|--|--|--|------------------------------------------------------------------|--| + +| | | | | | | +|-------------|--------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------| +| dnn | Dnn | C | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. Shall be present if the "dnns" was provided within EventSubscription during the subscription for event notification procedure. | | +| networkArea | NetworkAreaInfo | C | 0..1 | Identifies the network area where the service experience applies. Shall be presented if the "networkArea" was provided within EventSubscription during the subscription for event notification procedure. | | +| nsild | Nsild | C | 0..1 | Identifies a network slice instance which is associated with the S-NSSAI identified by the "snssai" attribute. Shall be presented if the "nsilds" was provided within the NsildInfo data in the EventSubscription data during the subscription. | | +| ratio | SamplingRatio | C | 0..1 | Contains the percentage of UEs with same analytics result in the group or among all UEs. Shall be present if the analytics result applies for a group of UEs or any UE. (NOTE 3) | | +| ratFreq | RatFreqInformation | C | 0..1 | Identification of the RAT type(s) and/or frequency(ies) of UE's serving cell(s) which the service experience applies. Shall be present if the "ratFreqs" was provided in the EventSubscription data during the subscription.

When "allRat" and/or "allFreq" are included in the subscription, the NWDAF provides an instance of the Application service experience per combination of RAT Type(s) and/or Frequency value(s) having the same Service Experience. | ServiceExperienceExt | +| pduSesInfo | PduSessionInfo | C | 0..1 | Represents the PDU Session parameters. Shall be present if the "pduSesInfos" attribute was provided in the EventSubscription data type during the subscription. | ServiceExperienceExt2_eN
A | + +| | | +|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: | If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. | +| NOTE 2: | The "ueLocs" attribute shall only be included if the consumer analytics request is for a single UE or a list of UEs. Inclusion of such UE location requires user consent during the UE location data collection. | +| NOTE 3: | The SUPI list and Ratio in the service experience information for an application may be omitted if the reported service experience information is provided and is assigned with the same value(s) for the slice instance which the application belongs to. Otherwise, the SUPI list and Ratio shall be provided for an application service experience. | +| NOTE 4: | This attribute shall not be provided if the NWDAF does not know the NF service consumer type or if the NWDAF knows that the NF service consumer is an AF or a NEF. | + +#### 5.1.6.2.25 Type BwRequirement + +**Table 5.1.6.2.25-1: Definition of type BwRequirement** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------------------------------------------------------------------------------------------------------------|---|-------------|-----------------------------------------------|---------------| +| appId | ApplicationId | M | 1 | Represents an application.
(NOTE) | | +| marBwUI | BitRate | O | 0..1 | Maximum requested bandwidth for the Uplink. | | +| marBwDI | BitRate | O | 0..1 | Maximum requested bandwidth for the Downlink. | | +| mirBwUI | BitRate | O | 0..1 | Minimum requested bandwidth for the Uplink. | | +| mirBwDI | BitRate | O | 0..1 | Minimum requested bandwidth for the Downlink. | | +| NOTE: | If the "appId" attribute is provided within EventSubscription data, this attribute shall be indicated by the "appId" attribute. | | | | | + +## 5.1.6.2.26 Type AdditionalMeasurement + +Table 5.1.6.2.26-1: Definition of type AdditionalMeasurement + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| unexpLoc | NetworkAreaInfo | C | 0..1 | The unexpected locations which the UE stays.
It may only be present when the "exceptionId" within the Exception data sets to "UNEXPECTED_UE_LOCATION" | | +| unexpFlowTeps | array(IpEthFlowDescription) | C | 1..N | Unexpected IP or Ethernet flow templates.
It may only be present when the "exceptionId" within the Exception data sets to "UNEXPECTED_LONG_LIVE_FLOW" or "UNEXPECTED_LARGE_RATE_FLOW". | | +| unexpWakes | array(DateTime) | C | 1..N | Unexpected wake up times.
It may only be present when the "exceptionId" within the Exception data sets to "UNEXPECTED_WAKEUP". | | +| ddosAttack | AddressList | C | 0..1 | Victim's address list.
It may only be present when the "exceptionId" within the Exception data sets to "SUSPICION_OF_DDOS_ATTACK". | | +| wrgDest | AddressList | C | 0..1 | Wrong destination address list.
It may only be present when the "exceptionId" within the Exception data sets to "WRONG_DESTINATION_ADDRESSES". | | +| circums | array(CircumstanceDescription) | C | 1..N | The description of circumstances.
It may only be present when the "exceptionId" within the Exception data sets to "TOO_FREQUENT_SERVICE_ACCESS", "UNEXPECTED_RADIO_LINK_FAILURES" or "PING_PONG_ACROSS_CELLS". | | + +## 5.1.6.2.27 Type IpEthFlowDescription + +Table 5.1.6.2.27-1: Definition of type FlowDescription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------|--------------------|---|-------------|------------------------------------------|---------------| +| ipTrafficFilter | FlowDescription | C | 0..1 | Identifies IP packet filter.(NOTE) | | +| ethTrafficFilter | EthFlowDescription | C | 0..1 | Identifies Ethernet packet filter.(NOTE) | | +| NOTE: Either "ipTrafficFilter" or "ethTrafficFilter" shall be provided. | | | | | | + +## 5.1.6.2.28 Type AddressList + +Table 5.1.6.2.28-1: Definition of type AddressList + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------------------|-----------------|---|-------------|------------------------------------------|---------------| +| ipv4Addrs | array(Ipv4Addr) | O | 1..N | Each element identifies an IPv4 address. | | +| ipv6Addrs | array(Ipv6Addr) | O | 1..N | Each element identifies an IPv6 address. | | +| NOTE: At least one of "ipv4Addrs" or "ipv6Addrs" shall be provided. | | | | | | + +## 5.1.6.2.29 Type CircumstanceDescription + +Table 5.1.6.2.29-1: Definition of type CircumstanceDescription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| freq | Float | O | 0..1 | Communication frequency of the UE in units of MHz. | | +| tm | DateTime | O | 0..1 | Time when UE enters the location. | | +| locArea | NetworkAreaInfo | C | 0..1 | The location of the UE.
It shall be present when the "exceptId" within the Exception data sets to "UNEXPECTED_RADIO_LINK_FAILURES" or "PING_PONG_ACROSS_CELLS". | | +| vol | Volume | C | 0..1 | The traffic volume.
It shall be present when the "exceptId" within the Exception data sets to "TOO_FREQUENT_SERVICE_ACCESS" or "UNEXPECTED_LARGE_RATE_FLOW". | | + +### 5.1.6.2.30 Type ThresholdLevel + +**Table 5.1.6.2.30 -1: Definition of type ThresholdLevel** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| congLevel | integer | C | 0..1 | Value of Congestion that triggers notification. (NOTE 1) | UserDataCongestion | +| nfLoadLevel | integer | C | 0..1 | Value of NF Load that triggers notification. (NOTE 2)
Minimum = 0. Maximum = 100. | NfLoad | +| nfCpuUsage | integer | C | 0..1 | Value of NF CPU Usage that triggers notification. (NOTE 2)
Minimum = 0. Maximum = 100. | NfLoad | +| nfMemoryUsage | integer | C | 0..1 | Average usage of memory (NOTE 2)
Minimum = 0. Maximum = 100. | NfLoad | +| nfStorageUsage | integer | C | 0..1 | Average usage of storage. (NOTE 2)
Minimum = 0. Maximum = 100. | NfLoad | +| avgTrafficRate | BitRate | C | 0..1 | Threshold level of average traffic rate.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to AVG_TRAFFIC_RATE. (NOTE 3) | DnPerformance | +| maxTrafficRate | BitRate | C | 0..1 | Threshold level of maximum traffic rate.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to MAX_TRAFFIC_RATE. (NOTE 3) | DnPerformance | +| minTrafficRate | BitRate | C | 0..1 | Threshold level of minimum traffic rate.

The minimum traffic rate measurements are only derived from active traffic. (NOTE 4) | DnPerformanceExt_AIML | +| aggTrafficRate | BitRate | C | 0..1 | Threshold level of aggregated traffic rate.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to AGG_TRAFFIC_RATE. (NOTE 4) | DnPerformanceExt_AIML | +| varTrafficRate | Float | C | 0..1 | Threshold level of variance of traffic rate.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to VAR_TRAFFIC_RATE. (NOTE 4) | DnPerformanceExt_AIML | +| avgPacketDelay | PacketDelBudget | C | 0..1 | Threshold level of average Packet Delay.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to AVG_PACKET_DELAY. (NOTE 3) | DnPerformance | +| maxPacketDelay | PacketDelBudget | C | 0..1 | Threshold level of maximum Packet Delay.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute | DnPerformance | + +| | | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------|----------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| | | | | was set to MAX_PACKET_DELAY. (NOTE 3) | | +| varPacketDelay | Float | C | 0..1 | Threshold level of variance of Packet Delay. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to VAR_PACKET_DELAY. (NOTE 4) | DnPerformanceExt_AIML | +| avgPacketLossRate | PacketLossRate | C | 0..1 | Threshold level of average Loss Rate. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to AVG_PACKET_LOSS_RATE. (NOTE 3) | DnPerformance | +| maxPacketLossRate | PacketLossRate | C | 0..1 | Threshold level of maximum Loss Rate. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to MAX_PACKET_LOSS_RATE. (NOTE 4) | DnPerformanceExt_AIML | +| varPacketLossRate | Float | C | 0..1 | Threshold level of variance of Loss Rate. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to VAR_PACKET_LOSS_RATE. (NOTE 4) | DnPerformanceExt_AIML | +| svcExpLevel | Float | C | 0..1 | Service Experience MOS value. Shall be present when subscribed event is "SERVICE_EXPERIENCE". | ServiceExperienceExt | +| speed | Float | C | 0..1 | Speed threshold utilized to filter the UEs, expressed in kilometres per hour. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to "SPEED_THRESHOLD". | MovementBehaviour | +| NOTE 1: This attribute shall be provided when subscribed event is "USER_DATA_CONGESTION". | | | | | | +| NOTE 2: At least one attribute should be provided when subscribed event is "NF_LOAD". | | | | | | +| NOTE 3: At least one attribute should be provided when subscribed event is "DN_PERFORMANCE". | | | | | | +| NOTE 4: This attribute may only be provided if the "DnPerformanceExt_AIML" feature is supported and the subscribed event is "DN_PERFORMANCE". | | | | | | + +## 5.1.6.2.31 Type NfLoadLevelInformation + +Table 5.1.6.2.31-1: Definition of type NfLoadLevelInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| nfType | NFType | M | 1 | Type of the NF instance | | +| nfInstanceId | NfInstanceId | M | 1 | Identification of the NF instance | | +| nfSetId | NfSetId | O | 0..1 | Identification of the NF instance set | | +| nfStatus | NfStatus | C | 0..1 | Availability status of the NF (NOTE 1) | | +| nfCpuUsage | integer | C | 0..1 | Average usage CPU (NOTE 1, NOTE 2)
Minimum = 0. Maximum = 100. | | +| nfMemoryUsage | integer | C | 0..1 | Average usage of memory (NOTE 1, NOTE 2)
Minimum = 0. Maximum = 100. | | +| nfStorageUsage | integer | C | 0..1 | Average usage of storage (NOTE 1, NOTE 2)
Minimum = 0. Maximum = 100. | | +| nfLoadLevelAverage | integer | C | 0..1 | Average load information (NOTE 1, NOTE 2)
Minimum = 0. Maximum = 100. | | +| nfLoadLevelPeak | integer | C | 0..1 | Peak load information (NOTE 1, NOTE 2)
Minimum = 0. Maximum = 100. | | +| nfLoadAvgInAoi | integer | C | 0..1 | The average load of the NF instances over the area of interest. (NOTE 1, NOTE 2, NOTE 4)
Minimum = 0. Maximum = 100. | NfLoadExt | +| snssai | Snssai | C | 0..1 | Identifies an S-NSSAI.
Shall be present if the "snssais" was provided within EventSubscription during the subscription for event notification procedure. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 3)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +| NOTE 1: At least one value shall be provided. If the "listOfAnaSubsets" attribute with value only applicable to NF_LOAD event is present in the subscription request, then only the corresponding attribute(s) shall be present. | | | | | | +| NOTE 2: The values are percentages which are provided as estimated over a given period. | | | | | | +| NOTE 3: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. | | | | | | +| NOTE 4: Applicable only to AMF load If the "networkArea" attribute is present in the subscription request. | | | | | | + +## 5.1.6.2.32 Type NfStatus + +Table 5.1.6.2.32-1: Definition of type NfStatus + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---|-------------|--------------------------------------------------------|---------------| +| statusRegistered | SamplingRatio | C | 0..1 | Percentage of time with status "registered" (NOTE) | | +| statusUnregistered | SamplingRatio | C | 0..1 | Percentage of time with status "unregistered" (NOTE) | | +| statusUndiscoverable | SamplingRatio | C | 0..1 | Percentage of time with status "undiscoverable" (NOTE) | | +| NOTE: The availability statuses of the NF on the Analytics target period are expressed as a percentage of time. The total of status values should be equal or lower than 100%. At least one value shall be provided. | | | | | | + +## 5.1.6.2.33 Type NsildInfo + +**Table 5.1.6.2.33-1: Definition of type NsildInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | Identification of network slice to which the subscription for event notification procedure applies. | | +| nsilds | array(Nsild) | O | 1..N | Identification of network slice instance(s) associated with the subscribed S-NSSAI identified by the "snssai" attribute.
May be included when subscribed event is "NSI_LOAD_LEVEL" or "SERVICE_EXPERIENCE".
(NOTE) | | + +NOTE: This attribute is not applicable when the NF service consumer is CEF or PCF. + +## 5.1.6.2.34 Type NsiLoadLevelInfo + +**Table 5.1.6.2.34-1: Definition of type NsiLoadLevelInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|----------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| loadLevelInformation | LoadLevelInformation | M | 1 | Load level information of the network slice identified by the "snssai" attribute and if provided, the associated NSI ID identified by the "nsild" attribute. | | +| snssai | Snssai | M | 1 | Identification of network slice to which the subscription applies. | | +| nsild | Nsild | C | 0..1 | Identification of network slice instance associated with the S-NSSAI identified by the "snssai" attribute.
Shall be presented if the "nsilds" attribute was provided within the NsildInfo data in the EventSubscription data during the subscription. | | +| resUsage | ResourceUsage | C | 0..1 | The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance.
Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to RES_USAGE. | NsiLoadExt | +| numOfExceedLoadLevelThr | integer | C | 0..1 | Indicates the number of times the resource usage threshold of the network slice instance is reached or exceeded if a threshold value is provided by the consumer.
Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to NUM_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR. | NsiLoadExt | +| exceedLoadLevelThrInd | boolean | C | 0..1 | Indicates whether the Load Level Threshold is met or exceeded by the statistics value. Set to "true" if the Load Level Threshold is met or exceeded, set to "false" to indicate the Load Level Threshold is not met by the statistics value. Default value is "false" if omitted.
Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to EXCEED_LOAD_LEVEL_THR_IN D. | NsiLoadExt | +| networkArea | NetworkAreaInfo | O | 0..1 | Identification of network area to which the subscription or analytics request applies. | NsiLoadExt | +| timePeriod | TimeWindow | O | 0..1 | Indicates a start time and a stop time of the load level information identified by the "loadLevelInformation" attribute. | NsiLoadExt | +| resUsgThrCrossTimePeriod | array(TimeWindow) | O | 1..N | Each element indicates the time elapsed between times each threshold is met or exceeded or crossed. The start time and end time are the exact time stamps of the resource usage threshold is reached or exceeded. May be present if the "listOfAnaSubsets" attribute is provided and the maximum number of instances shall not exceed the value provided in the "numOfExceedLoadLevelThr" attribute. | NsiLoadExt | + +| | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| numOfUes | NumberAverage | C | 0..1 | Indicates the average and variance number of UE registered at the S-NSSAI and the optionally associated network slice instance. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to NUM_OF_UE_REG. | NsiLoadExt | +| numOfPduSess | NumberAverage | C | 0..1 | Indicates the average and variance number of PDU session established at the S-NSSAI and the optionally associated network slice instance. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to NUM_OF_PDU_SESS_ESTBL. | NsiLoadExt | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | NsiLoadExt | +| NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. | | | | | | + +#### 5.1.6.2.35 Type FailureEventInfo + +**Table 5.1.6.2.35-1: Definition of type FailureEventInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|-------------------------------|---------------| +| event | NwdafEvent | M | 1 | Event that is subscribed. | | +| failureCode | NwdafFailureCode | M | 1 | Identifies the failure reason | | + +#### 5.1.6.2.36 Type AnalyticsMetadataIndication + +**Table 5.1.6.2.36-1: Definition of type AnalyticsMetadataIndication** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------|---------------| +| dataWindow | TimeWindow | O | 0..1 | Data time window of the data samples. | | +| dataStatProps | array(DatasetStatisticalProperty) | O | 1..N | List of dataset statistical properties of the data to be used to generate the analytics. | | +| strategy | OutputStrategy | O | 0..1 | Output strategy to be used for the reporting of the analytics. | | +| aggrNwdafls | array(NfInstanceId) | O | 1..N | NWDAF identifiers of NWDAF instances used by the NWDAF service consumer when aggregating multiple analytics subscriptions. | | + +## 5.1.6.2.37 Type AnalyticsMetadataInfo + +Table 5.1.6.2.37-1: Definition of type AnalyticsMetadataInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------------|---|-------------|------------------------------------------------------------------------------------|---------------| +| numSamples | UInteger | O | 0..1 | Number of data samples used for the generation of the output analytics. | | +| dataWindow | TimeWindow | O | 0..1 | Data time window of the data samples. | | +| dataStatProps | array(DatasetStatisticalProperty) | O | 1..N | List of dataset statistical properties of the data used to generate the analytics. | | +| strategy | OutputStrategy | O | 0..1 | Output strategy used for the reporting of the analytics. | | +| accuracy | Accuracy | O | 0..1 | Level of accuracy reached for the analytics. | | + +## 5.1.6.2.38 Type NumberAverage + +Table 5.1.6.2.38-1: Definition of type NumberAverage + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|--------------------------|---------------| +| number | Float | M | 1 | The average number. | | +| variance | Float | M | 1 | Identifies the variance. | | +| skewness | Float | O | 0..1 | Contains the skewness. | | + +## 5.1.6.2.39 Type TopApplication + +Table 5.1.6.2.39-1: Definition of type TopApplication + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | C | 0..1 | Indicates an application identifier. (NOTE) | | +| ipTrafficFilter | FlowInfo | C | 0..1 | Identifies IP packet filter. (NOTE) | | +| ratio | SamplingRatio | O | 0..1 | The application's throughput as a percentage of the total throughput in the Area of Interest. | | + +NOTE: Either "appId" or "ipTrafficFilter" shall be provided. + +## 5.1.6.2.40 Type AnalyticsSubscriptionsTransfer + +Table 5.1.6.2.40-1: Definition of type AnalyticsSubscriptionsTransfer + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|---------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------| +| subsTransInfos | array(SubscriptionTransferInfo) | M | 1..N | Contains information about the subscription(s) that are requested to be transferred. | | +| failTransEventReports | array(NwdaEvent) | C | 1..N | It contains the event(s) for which the subscription transfer is not successful.
It shall be supplied by the Target NWDAF if not all the analytics events in the subscription transfer are accepted. | PartialAnalyticsSubTransfer | + +## 5.1.6.2.4.1 Type SubscriptionTransferInfo + +Table 5.1.6.2.4.1-1: Definition of type SubscriptionTransferInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| transReqType | TransferRequestType | M | 1 | Indicates the type of the transfer request (i.e. if it is a request for transfer preparation or transfer execution) | | +| nwdafEvSub | NnwdafEventsSubscription | M | 1 | Contains information about the analytics subscription that is to be transferred. (NOTE) | | +| consumerId | NfInstanceId | M | 1 | NF instance identifier of the consumer of the analytics subscription that is to be transferred. | | +| contextId | AnalyticsContextIdentifier | O | 0..1 | Identifier of analytics context information available at the NF service consumer. | | +| sourceNfIds | array(NfInstanceId) | O | 1..N | NF instance identifier(s) of active data source(s) the NF service consumer is currently using for the analytics of the subscription that is to be transferred. | | +| sourceSetIds | array(NfSetId) | O | 1..N | NF set identifier(s) of active data source(s) the NF service consumer is currently using for the analytics of the subscription that is to be transferred. | | +| modelInfos | array(ModellInfo) | O | 1..N | Contains information identifying the ML model(s) that the NF service consumer is currently using for the analytics. | | + +NOTE: The "nwdafEvSub" attribute shall contain the "notificationURI" attribute. + +## 5.1.6.2.4.2 Type ModellInfo + +Table 5.1.6.2.4.2-1: Definition of type ModellInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------|---------------| +| analyticsId | NwdafEvent | M | 1 | Type of analytics for which this ML model is used. | | +| mlModellInfos | array(MLModellInfo) | M | 1..N | The information of the ML models which are applicable to the event indicated by "analyticsId" attribute. | | + +## 5.1.6.2.4.3 Type AnalyticsContextIdentifier + +Table 5.1.6.2.4.3-1: Definition of type AnalyticsContextIdentifier + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------|---------------| +| subscriptionId | string | M | 1 | Identifies a subscription to the Nnwdaf_EventsSubscription Service. | | +| nfAnaCtxts | array(NwdafEvent) | O | 1..N | List of analytics types for which NF related analytics contexts can be retrieved. (NOTE) | | +| ueAnaCtxts | array(UeAnalyticsContextDescriptor) | O | 1..N | List of objects that indicate for which SUPI and analytics types combinations analytics context can be retrieved. (NOTE) | | + +NOTE: At least one of "nfAnaCtxts" and "ueAnaCtxts" shall be provided. + +## 5.1.6.2.44 Type UeAnalyticsContextDescriptor + +Table 5.1.6.2.44-1: Definition of type UeAnalyticsContextDescriptor + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | SUPI of the UE for which analytics context can be retrieved. | | +| anaTypes | array(NwdaEvent) | M | 1..N | List of analytics types for which UE related analytics contexts can be retrieved. | | + +## 5.1.6.2.45 Type DnPerfInfo + +Table 5.1.6.2.45-1: Definition of type DnPerfInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | C | 0..1 | Indicates an application identifier. Shall be present if the "appIds" attribute was provided in the request or subscription. | | +| dnn | Dnn | C | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. Shall be present if the "dnns" was provided in the request or subscription. | | +| snssai | Snssai | C | 0..1 | Identifies the network slice information. Shall be present if the "snssais" was provided in the request or subscription. | | +| dnPerf | array(DnPerf) | M | 1..N | List of DN performances for the application. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 1)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE 1: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +## 5.1.6.2.46 Type DnPerf + +Table 5.1.6.2.46-1: Definition of type DnPerf + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appServerInsAddr | AddrFqdn | C | 0..1 | Represents the Application Server Instance (IP address/FQDN of the Application Server). Shall be present if the "appServerAddrs" attribute was provided in the request or subscription. | | +| upfInfo | UpfInformation | C | 0..1 | Identifies the UPF. Shall be present only if the "upfInfo" attribute was provided in the request or subscription and the identified NF service consumer is not an AF or a NEF. (NOTE 1) | | +| dnai | Dnai | C | 0..1 | Indicates the DN Access Identifier representing location of the service flow. Shall be present if the "dnais" attribute was provided in the request or subscription. | | +| perfData | PerfData | M | 1 | Represents the performance data. | | +| spatialValidCon | NetworkAreaInfo | C | 0..1 | Represents the area where the DN performance analytics applies. Shall be present if "networkArea" attribute was provided in the request or subscription. (NOTE 3) | | +| temporalValidCon | TimeWindow | O | 0..1 | Represents the valid period for the DN performance analytics. (NOTE2) | | + +NOTE 1: This attribute shall not be provided if the NWDAF does not know the NF service consumer type or if the NWDAF knows that the NF service consumer is an AF or a NEF. + +NOTE 2: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "temporalValidCon" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +NOTE 3: If the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes are provided in the request, the number of TAs or cells contained in "spatialValidCon" attribute shall be smaller than or equal to the values of the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes. + +## 5.1.6.2.47 Type PerfData + +Table 5.1.6.2.47-1: Definition of type PerfData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| avgTrafficRate | BitRate | O | 0..1 | Indicates average traffic rate observed for UEs communicating with the application. | | +| maxTrafficRate | BitRate | O | 0..1 | Indicates maximum traffic rate observed for UEs communicating with the application. | | +| minTrafficRate | BitRate | O | 0..1 | Indicates minimum traffic rate observed for UEs communicating with the application.
The minimum traffic rate measurements are only derived from active traffic. | DnPerformanceEx
t_AIML | +| aggTrafficRate | BitRate | O | 0..1 | Indicates aggregated traffic rate. (NOTE) | DnPerformanceEx
t_AIML | +| varTrafficRate | Float | O | 0..1 | Indicates variance of traffic rate. (NOTE) | DnPerformanceEx
t_AIML | +| trafRateUelds | array(Supi) | O | 1..N | Identifies a UE or a list of UEs whose traffic rate is higher or lower than the threshold. Each element identifies a SUPI of an UE. The maximum number of SUPI(s) shall not exceed the subscribed "maxSupiNbr" attribute value if provided. (NOTE) | DnPerformanceEx
t_AIML | +| avePacketDelay | PacketDelBudget | O | 0..1 | Indicates average Packet Delay. | | +| maxPacketDelay | PacketDelBudget | O | 0..1 | Indicates maximum Packet Delay. | | +| varPacketDelay | Float | O | 0..1 | Indicates variance of Packet Delay. (NOTE) | DnPerformanceEx
t_AIML | +| packDelayUelds | array(Supi) | O | 1..N | Identifies a UE or a list of UEs whose packet delay is higher or lower than the threshold. Each element identifies a SUPI of an UE. The maximum number of SUPI(s) shall not exceed the subscribed "maxSupiNbr" attribute value if provided. (NOTE) | DnPerformanceEx
t_AIML | +| avgPacketLossRate | PacketLossRate | O | 0..1 | Indicates average Packet Loss Rate. | | +| maxPacketLossRate | PacketLossRate | O | 0..1 | Indicates maximum Packet Loss Rate. | DnPerformanceEx
t_AIML | +| varPacketLossRate | Float | O | 0..1 | Indicates variance of Packet Loss Rate. (NOTE) | DnPerformanceEx
t_AIML | +| packLossUelds | array(Supi) | O | 1..N | Identifies a UE or a list of UEs whose packet loss rate is higher than the threshold. Each element identifies a SUPI of an UE. The maximum number of SUPI(s) shall not exceed the subscribed "maxSupiNbr" attribute value if provided. (NOTE) | DnPerformanceEx
t_AIML | +| numOfUe | UInteger | O | 0..1 | The number of UEs for the UE group or all UEs (i.e. any UE) communicating with the application in the DNAI. | DnPerformanceEx
t_eNA | + +NOTE: If these attribute(s) is provided, the analytics target period shall be a past time period (i.e. only statistics is applicable). + +Editor's note: It is FFS whether the prediction is applicable to all the performance defined in above table. + +## 5.1.6.2.48 Type ResourceUsage + +Table 5.1.6.2.48-1: Definition of type ResourceUsage + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-----------------------------------------------------------------|---------------| +| cpuUsage | UInteger | O | 0..1 | Average usage of virtual CPU. (NOTE)
Minimum=0. Maximum=100. | | +| memoryUsage | UInteger | O | 0..1 | Average usage of memory. (NOTE)
Minimum=0. Maximum=100. | | +| storageUsage | UInteger | O | 0..1 | Average usage of storage. (NOTE)
Minimum=0. Maximum=100. | | + +NOTE: The values are percentages which are provided as estimated over a given period. + +## 5.1.6.2.49 Type ConsumerNfInformation + +Table 5.1.6.2.49-1: Definition of type ConsumerNfInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|--------------------------------------------------------------|---------------| +| nfId | NfInstanceId | C | 0..1 | Identifies the analytics consumer NF instance. (NOTE) | | +| nfSetId | NfSetId | C | 0..1 | Identifies the analytics consumer NF set. (NOTE) | | +| tailList | array(Tai) | C | 1..N | The list of TAls the analytics consumer NF can serve. (NOTE) | | + +NOTE: Either "tailList" or one of "nfId", "nfSetId" shall be provided. + +## 5.1.6.2.50 Type DispersionRequirement + +Table 5.1.6.2.50-1: Definition of type DispersionRequirement + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| disperType | DispersionType | M | 1 | Indicates the required dispersion analytics type. | | +| classCrits | array(ClassCriterion) | O | 1..N | Indicates the dispersion mobility class criterion for fixed, camper and/or traveller UE, and/or the top-heavy UE dispersion class criterion. | | +| rankCrits | array(RankingCriterion) | O | 1..N | Indicates the usage ranking criterion between the high, medium and low usage UE. | | +| dispOrderCriter | DispersionOrderingCriterion | O | 0..1 | Indicates the ordering criterion for the list of UE Dispersion Analytics information. | | +| order | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "dispOrderCriter" attribute is included. (NOTE) | | + +NOTE: "CROSSED" value in data type "MatchingDirection" is not applicable for the "order" attribute. + +## 5.1.6.2.51 Type ClassCriterion + +**Table 5.1.6.2.51-1: Definition of type ClassCriterion** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------------|---------------| +| disperClass | DispersionClass | M | 1 | Indicates the dispersion class. | | +| classThreshold | SamplingRatio | M | 1 | Indicates the dispersion class threshold. | | +| thresMatch | MatchingDirection | M | 1 | Indicates the dispersion class threshold matching direction.
(NOTE) | | + +NOTE: "CROSSED" value in data type "MatchingDirection" is not applicable for the "thresMatch" attribute. + +## 5.1.6.2.52 Type RankingCriterion + +**Table 5.1.6.2.52-1: Definition of type RankingCriterion** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|----------------------------------------------------------|---------------| +| highBase | SamplingRatio | M | 1 | Indicates the "high" ranking bottom baseline percentage. | | +| lowBase | SamplingRatio | M | 1 | Indicates the "low" ranking top baseline percentage. | | + +NOTE: UE is ranked high (i.e. value 1), medium (2) or low (3) when its data/transactions dispersed during the period of observation at the location/slice, is higher than "highBase" attribute value, within the range between the "highBase" attribute to "lowBase" attribute value or less than "lowBase" value, respectively. + +## 5.1.6.2.53 Type DispersionInfo + +**Table 5.1.6.2.53-1: Definition of type DispersionInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|---------------------------------------------------------------------------------------|---------------| +| tsStart | DateTime | M | 1 | Indicates the timestamp when the time slot starts during the Analytics target period. | | +| tsDuration | DurationSec | M | 1 | Indicates the time slot duration.
(NOTE) | | +| disperCollects | array(DispersionCollection) | M | 1..N | Dispersion collections on UE location(s) and/or slice(s). | | +| disperType | DispersionType | M | 1 | Indicates the dispersion type.
Only applicable to DVDA or TDA value. | | + +NOTE: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "tsDuration" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +5.1.6.2.54 Type DispersionCollection + +**Table 5.1.6.2.54-1: Definition of type DispersionCollection** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueLoc | UserLocation | C | 0..1 | TA or cells where the UE or group of UEs dispersed its transactions and/or data. Shall be present if "networkArea" attribute is included in the event subscription or analytics request. (NOTE 1) | | +| snssai | Snssai | C | 0..1 | Slice where the UE or group of UEs disperse its transactions and/or data. Shall be present if "snssais" attribute is included in the event subscription or analytics request. (NOTE 1) | | +| supis | array(Supi) | C | 1..N | Each element identifies a SUPI of an UE. May only be present if reporting inside 5GC and the event subscription or analytics request applies to more than one UE. (NOTE 2) | | +| gpsi | array(Gpsi) | C | 1..N | Each element identifies a GPSI of an UE. May only be present if reused by the Nnef_AnalyticsExposure service reporting to external AF and the event subscription or analytics request applies to more than one UE. (NOTE 2) | | +| appVolumes | array(Application Volume) | O | 1..N | Application data volumes. May be present if "appls" attribute is included in the event subscription or analytics request (NOTE 6). | | +| disperAmount | UInteger | C | 0..1 | Indicates the dispersion amount of the reported data volume or transaction dispersion type. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to DISPER_AMOUNT. (NOTE 3) | | +| disperClass | DispersionClass | C | 0..1 | Indicates the UE dispersion mobility class: fixed, camper, traveller, and/or the top-heavy dispersion class. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to DISPER_CLASS. (NOTE 3, NOTE 5). | | +| usageRank | integer | C | 0..1 | Usage ranked high (i.e. value 1), medium (2) or low (3). Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to RANKING. (NOTE 3, NOTE 6). | | +| percentileRank | SamplingRatio | C | 0..1 | Percentile ranking of the target UE in the Cumulative Distribution Function of data usage for the population of all UEs. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to PERCENTILE_RANKING. (NOTE 3, NOTE 6). | | +| ueRatio | SamplingRatio | C | 0..1 | Contains the percentage of UEs with same analytics result in the group or among all UEs. Shall be present if the analytics | | + +| | | | | | | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | result applies for a group of UEs or any UE. | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 4)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | +| NOTE 1: One of "ueLoc" attribute or "snssai" attribute shall be provided. | | | | | | +| NOTE 2: When Target of Analytics Reporting is a UE group ID, or "Any UE" and a filter for Top-Heavy UEs, fixed, camper or traveller is included in the subscription, the NWDAF shall include the list of UEs matching the filter. This information element shall not be present when Target of Analytic Reporting is "Any UE" and no filter for Top-Heavy UEs, fixed, camper or traveller is included. | | | | | | +| NOTE 3: At least one value shall be provided. If the "listOfAnaSubsets" attribute with value only applicable to "DISPERSION" event is present in the subscription request, then only the corresponding attribute(s) shall be present. | | | | | | +| NOTE 4: If the requested period identified by the "startTs" and "endTs" attributes in the EventReportingRequirement type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. | | | | | | +| NOTE 5: This parameter may only be provided when the Target of Analytics Reporting contains the "supis" attribute or the "gpsi" attribute in the "tgtUe" attribute. | | | | | | +| NOTE 6: This parameter shall not be provided when the "anyUe" attribute in the "tgtUe" attribute for the Target of Analytics Reporting was set to true. | | | | | | +| NOTE 7: If the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes are provided in the request, the number of TAs or cells contained in "ueLoc" attribute shall be smaller than or equal to the values of the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes. | | | | | | + +#### 5.1.6.2.55 Type ApplicationVolume + +**Table 5.1.6.2.55-1: Definition of type ApplicationVolume** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | M | 1 | Application where the UE or group of UEs disperse its transactions and/or data. May be present if "appId" attribute is included in the event subscription or analytics request. | | +| appVolume | Volume | M | 1 | Indicates the dispersion data volume per application in units of bytes. | | + +#### 5.1.6.2.56 Type RedundantTransmissionExpReq + +**Table 5.1.6.2.56-1: Definition of type RedundantTransmissionExpReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------------------------|------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------|---------------| +| redTOrderCriter | RedTransExpOrderingCriterion | O | 0..1 | Indicates the ordering criterion for the list of UE Redundant Transmission Experience Analytics information. (NOTE 1) | | +| order | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "redTOrderCriter" attribute is included. (NOTE 1)
(NOTE 2) | | +| NOTE 1: If no attribute or no value is provided, default ordering may be applied. | | | | | | +| NOTE 2: "CROSSED" value in data type "MatchingDirection" is not applicable for the "order" attribute. | | | | | | + +## 5.1.6.2.57 Type RedundantTransmissionExpInfo + +Table 5.1.6.2.57-1: Definition of type RedundantTransmissionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| spatialValidCon | NetworkAreaInfo | C | 0..1 | Area where the Redundant Transmission Experience applies. If "networkArea" attribute was provided in the request or subscription, shall be the requested network area. | | +| dnn | Dnn | C | 0..1 | Data Network Name associated for URLLC service. Shall be present if the "dnns" attribute was provided in the request or subscription. | | +| redTransExps | array(Redundant TransmissionExp PerTS) | M | 1..N | Redundant Transmission Experiences. | | + +## 5.1.6.2.58 Type RedundantTransmissionExpPerTS + +Table 5.1.6.2.58-1: Definition of type RedundantTransmissionExpPerTS + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tsStart | DateTime | M | 1 | Indicates the timestamp when the time slot starts during the Analytics target period. | | +| tsDuration | DurationSec | M | 1 | Indicates the time slot duration. (NOTE 2) | | +| obsvRedTransExp | ObservedRedundantTransExp | M | 1 | Represents the observed Redundant Transmission Experience. | | +| redTransStatus | boolean | O | 0..1 | Redundant Transmission Status. Set to "true" if redundant transmission was activated, otherwise set to "false". Default value is "false" if omitted. | | +| ueRatio | SamplingRatio | O | 0..1 | Percentage on which UE, any UE, or UE group efficiently use the PDU session with redundant transmission. | | +| confidence | Uinteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 1)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE 1: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +NOTE 2: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "tsDuration" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +## 5.1.6.2.59 Type WlanPerformanceReq + +Table 5.1.6.2.59-1: Definition of type WlanPerformanceReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------|---------------| +| ssids | array(string) | O | 1..N | SSIDs of WLAN access points. | | +| bssids | array(string) | O | 1..N | BSSIDs of WLAN access points. | | +| wlanOrderCriter | WlanOrderingCriterion | O | 0..1 | Indicates the ordering criterion for the list of WLAN performance information. | | +| order | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "wlanOrderCriter" attribute is included. (NOTE 1) | | + +NOTE 1: "CROSSED" value in data type "MatchingDirection" is not applicable for the "order" attribute. + +## 5.1.6.2.60 Type WlanPerformanceInfo + +Table 5.1.6.2.60-1: Definition of type WlanPerformanceInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| +| networkArea | NetworkAreaInfo | C | 0..1 | A list of TAIIs or Cell Ids as the Area of Interest where the WLAN performance analytics applies. Shall be present if the "networkArea" attribute is included in the event subscription or analytics request. | | +| wlanPerSsidInfos | array(WlanPerSsidPerformanceInfo) | M | 1..N | WLAN performance information for SSID(s) of WLAN access points deployed in the Area of Interest. | | +| wlanPerUeIdInfos | array(WlanPerUeIdPerformanceInfo) | O | 1..N | WLAN performance information for UE Id(s) of WLAN access points deployed in the Area of Interest. | WlanPerformanceExt_AIML | + +## 5.1.6.2.61 Type WlanPerSsidPerformanceInfo + +Table 5.1.6.2.61-1: Definition of type WlanPerSsidPerformanceInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------------|---|-------------|--------------------------------------------------------------------------------|---------------| +| ssid | string | M | 1 | SSID of WLAN access point. | | +| wlanPerTsInfos | array(WlanPerTsPerformanceInfo) | M | 1..N | WLAN performance information per Time Slot during the analytics target period. | | + +## 5.1.6.2.6.2 Type WlanPerTsPerformanceInfo + +Table 5.1.6.2.6.2-1: Definition of type WlanPerTsPerformanceInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tsStart | DateTime | M | 1 | Indicates the timestamp when the time slot starts during the Analytics target period. | | +| tsDuration | DurationSec | M | 1 | Indicates the time slot duration. (NOTE 3) | | +| rssi | integer | C | 0..1 | Indicated the RSSI in the unit of dBm.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to RSSI. (NOTE 1) | | +| rtt | UInteger | C | 0..1 | Indicates the RTT in the unit of millisecond.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to RTT. (NOTE 1) | | +| trafficInfo | TrafficInformation | C | 0..1 | Traffic information including UL/DL data rate and/or Traffic volume.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to TRAFFIC_INFO. (NOTE 1) | | +| numberOfUes | UInteger | C | 0..1 | Number of UEs observed for the SSID.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to NUMBER_OF_UES. (NOTE 1) | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE 2)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE 1: At least one value shall be provided. If the "listOfAnaSubsets" attribute with value only applicable to WLAN event is present in the subscription request, then only the corresponding attribute(s) shall be present. + +NOTE 2: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, which means the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +NOTE 3: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "tsDuration" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +## 5.1.6.2.6.3 Type TrafficInformation + +Table 5.1.6.2.6.3-1: Definition of type TrafficInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|----------------------------------------------------------------|---------------| +| uplinkRate | BitRate | C | 0..1 | Uplink data rate. | | +| downlinkRate | BitRate | C | 0..1 | Downlink data rate. | | +| uplinkVolume | Volume | C | 0..1 | Uplink traffic volume in unit of octet. | | +| downlinkVolume | Volume | C | 0..1 | Downlink traffic volume in unit of octet. | | +| totalVolume | Volume | C | 0..1 | Total data octets for both uplink and downlink traffic volume. | | + +NOTE: At least one of above attributes shall be present. + +## 5.1.6.2.64 Type AppListForUeComm + +Table 5.1.6.2.64-1: Definition of type AppListForUeComm + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | M | 1 | Identification of the application. | | +| startTime | DateTime | O | 0..1 | The time when the UE start to use the application. | | +| appDur | DurationSec | O | 0..1 | The length of time that the UE uses the application. | | +| occurRatio | SamplingRatio | O | 0..1 | In UE Communication Statistics, it represents the proportion of UE using the application in the requested time period.
In UE Communication Predictions, it represents the probability that the UE uses the application. | | +| spatialValidity | NetworkAreaInfo | O | 0..1 | The area where the service behavior applies.
(NOTE) | | + +NOTE: If the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes are provided in the request, the number of TAs or cells contained in "spatialValidity" attribute shall be smaller than or equal to the values of the "spatialGranSizeTa" and/or "spatialGranSizeCell" attributes. + +## 5.1.6.2.65 Type SessInactTimerForUeComm + +Table 5.1.6.2.65-1: Definition of type SessInactTimerForUeComm + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------|---|-------------|-----------------------------------------------|---------------| +| n4SessionId | PduSessionId | M | 1 | The identification of the N4 Session. | | +| sessInactiveTimer | DurationSec | M | 1 | The value of the N4 Session inactivity timer. | | + +## 5.1.6.2.66 Type DnPerformanceReq + +Table 5.1.6.2.66-1: Definition of type DnPerformanceReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------|---------------| +| dnPerfOrderCriter | DnPerfOrderingCriterion | O | 0..1 | Indicates the preferred order criterion of a list of Network Performance analytics results. | | +| order | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "dnPerfOrderCriter" attribute is included. (NOTE 1) | | +| reportThresholds | array(ThresholdLevel) | C | 1..N | Each of the element represents the reporting threshold of an analytics subset. (NOTE 2) | | + +NOTE 1: "CROSSED" value in data type "MatchingDirection" is not applicable for the "order" attribute. +NOTE 2: The value of "reportThresholds" attribute match in sequence with the properties in the "listOfAnaSubsets" attribute. This property shall only be provided if the "notifMethod" in "evtReq" is set to "ON\_EVENT\_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted. + +## 5.1.6.2.6.7 Type: RatFreqInformation + +Table 5.1.6.2.6.7-1: Definition of type RatFreqInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| allFreq | boolean | C | 0..1 | Set to "true" to indicate to handle all the frequencies the NWDAF received, set to "false" to indicate not to handle all the frequencies the NWDAF received. Default value is "false" if omitted. (NOTE 1) | | +| allRat | boolean | C | 0..1 | Set to "true" to indicate to handle all the RAT types the NWDAF received, set to "false" to indicate not to handle all the RAT types the NWDAF received. Default value is "false" if omitted. (NOTE 1) | | +| freq | ArfcnValueNR | C | 0..1 | Identification of the frequency of UE's serving cell(s) where the subscription/request applies. (NOTE 1) | | +| ratType | RatType | C | 0..1 | Identification of the RAT type where the subscription/request applies. (NOTE 1) | | +| svcExpThreshold | ThresholdLevel | C | 0..1 | Service Experience Threshold value. (NOTE 2). | | +| matchingDir | MatchingDirection | O | 0..1 | The matching direction may be provided alongside the service experience threshold. If omitted, the default value is CROSSED. | | + +NOTE 1: The "allFreq" attribute and the "freq" attribute are mutually exclusive. The "allRat" attribute and the "ratType" attribute are mutually exclusive. If both the "allFreq" attribute and the "allRat" attribute are present, then indicate all the RAT type(s) and Frequency(ies) values the NWDAF received. + +NOTE 2: Shall only be present in the subscription request as the service experience threshold value(s) for the RAT Type(s) and/or Frequency value(s) if the "notifMethod" in "evtReq" is set to "ON\_EVENT\_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted. + +## 5.1.6.2.6.8 Type PrevSubInfo + +Table 5.1.6.2.6.8-1: Definition of type PrevSubInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------|---------------| +| producerId | NfInstanceId | C | 0..1 | NWDAF instance identifier to which the NF service consumer has established this subscription. (NOTE) | | +| producerSetId | NfSetId | C | 0..1 | NWDAF set identifier to which the NF service consumer has established this subscription. (NOTE) | | +| subscriptionId | string | M | 1 | The identifier of the specific analytics subscription. | | +| nfAnaEvents | array(NwdafEvent) | O | 1..N | List of analytics types for which NF related analytics contexts can be retrieved. | | +| ueAnaEvents | array(UeAnalyticsContextDescriptor) | O | 1..N | List of objects that indicate for which SUPI and analytics types combinations analytics context can be retrieved. | | + +NOTE: One of "producerId" or "producerSetId" attributes shall be provided. + +## 5.1.6.2.69 Type MLModelInfo + +Table 5.1.6.2.69-1: Definition of type MLModelInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mlFileAddrs | array(MLModelAddr) | O | 1..N | Addresses of ML model files. May be included only when the source NWDAF itself provides the trained ML model(s) for the analytics subscription(s) being transferred | | +| modelProvId | NfInstanceId | C | 0..1 | NF instance identifier of the ML model provider NWDAF from which the NF service consumer currently subscribes to the ML model information.
(NOTE) | | +| modelProvSetId | NfSetId | C | 0..1 | The Set ID of NWDAF(s) to which the current NWDAF subscribe the ML model.
(NOTE) | | + +NOTE: One of the "modelProvId" and "modelProvSetId" attributes shall be provided. + +### 5.1.6.2.70 Type ObservedRedundantTransExp + +#### **Table 5.1.6.2.70-1: Definition of type ObservedRedundantTransExp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| +| avgPktDropRateUI | PacketLossRate | C | 0..1 | Average uplink packet drop rate on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to AVG_UL_PKT_DROP_RATE. | | +| varPktDropRateUI | Float | C | 0..1 | Variance of uplink packet drop rate on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to VAR_UL_PKT_DROP_RATE. | | +| avgPktDropRateDI | PacketLossRate | C | 0..1 | Average downlink packet drop rate on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to AVG_DL_PKT_DROP_RATE. | | +| varPktDropRateDI | Float | C | 0..1 | Variance of downlink packet drop rate on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to VAR_DL_PKT_DROP_RATE. | | +| avgPktDelayUI | PacketDelBudget | C | 0..1 | Average uplink packet delay round trip on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to AVG_UL_PKT_DELAY. | | +| varPktDelayUI | Float | C | 0..1 | Variance uplink packet delay round trip on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to VAR_UL_PKT_DELAY. | | +| avgPktDelayDI | PacketDelBudget | C | 0..1 | Average downlink packet delay round trip on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to AVG_DL_PKT_DELAY. | | +| varPktDelayDI | Float | C | 0..1 | Variance downlink packet delay round trip on GTP-U path on N3. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to VAR_DL_PKT_DELAY. | | +| avgE2ePktDelayUI | PacketDelBudget | C | 0..1 | Indicates average End-to-End (between UE and UPF) uplink packet delay. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to AVG_E2E_UL_PKT_DELAY. | RedundantTransExp Ext_eNA | +| varE2ePktDelayUI | Float | C | 0..1 | Indicates the variance of End-to-End (between UE and UPF) uplink packet delay. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to VAR_E2E_UL_PKT_DELAY. | RedundantTransExp Ext_eNA | +| avgE2ePktDelayDI | PacketDelBudget | C | 0..1 | Indicates average End-to-End (between UE and UPF) downlink packet delay. Shall be present if one of the element in the "listOfAnaSubsets" attribute was | RedundantTransExp Ext_eNA | + +| | | | | | | +|--------------------------|----------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------| +| | | | | set to
AVG_E2E_DL_PKT_DELAY. | | +| varE2ePktDelayDI | Float | C | 0..1 | Indicates the variance of End-to-End (between UE and UPF) downlink packet delay. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to
VAR_E2E_DL_PKT_DELAY. | RedundantTransExp
Ext_eNA | +| avgE2ePktLossRate
eUI | PacketLossRate | C | 0..1 | Indicates average End-to-End (between UE and UPF) uplink packet loss rate. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to
AVG_E2E_UL_PKT_LOSS_RATE. | RedundantTransExp
Ext_eNA | +| varE2ePktLossRate
UI | Float | C | 0..1 | Indicates the variance of End-to-End (between UE and UPF) uplink packet loss rate. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to
VAR_E2E_UL_PKT_LOSS_RATE. | RedundantTransExp
Ext_eNA | +| avgE2ePktLossRate
eDI | PacketLossRate | C | 0..1 | Indicates average End-to-End (between UE and UPF) downlink packet loss rate. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to
AVG_E2E_DL_PKT_LOSS_RATE. | RedundantTransExp
Ext_eNA | +| varE2ePktLossRate
DI | Float | C | 0..1 | Indicates the variance of End-to-End (between UE and UPF) downlink packet loss rate. Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to
VAR_E2E_DL_PKT_LOSS_RATE. | RedundantTransExp
Ext_eNA | + +## 5.1.6.2.71 Type UeMobilityReq + +Table 5.1.6.2.71-1: Definition of type UeMobilityReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| orderCriterion | UeMobilityOrder Criterion | O | 0..1 | The ordering criterion for the list of UE mobility analytics. | | +| orderDirection | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending time slot start. May be present when the "orderCriterion" attribute is included. (NOTE 1) | | +| ueLocOrderInd | boolean | O | 0..1 | UE Location order indication. Set to "true" to indicate the NWDAF to provide UE locations in the UE Mobility analytics in time order, otherwise set to "false" or omitted. (NOTE 2) | | +| distThresholds | array(uinteger) | O | 1..N | Indicates the linear distance threshold, i.e. if the straight line distance that the UE moves from the previous location to the current location exceeds the threshold, the analytics needs to be reported. | UeMobilityExt2_eNA | + +NOTE 1: The "CROSSED" value in "MatchingDirection" data type is not applicable for this attribute. +NOTE 2: If this attribute was set to "true", the NWDAF does not aggregate the UE locations in a long duration but provides the UE locations one by one in their own time period, i.e. the "locInfos" contained in UeMobility data type has only one UE location which indicates the UE is located in this location in the duration from the time slot start and the location information in adjacent durations is different from each other. Otherwise, if this attribute is included and set to "false" or omitted, the multiple UE locations will be aggregated. + +Editor's Note: whether the "distThresholds" attribute is single or plural is FFS. + +## 5.1.6.2.72 Type UeCommReq + +Table 5.1.6.2.72-1: Definition of type UeCommReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------------------------------------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------|---------------| +| orderCriterion | UeCommOrder Criterion | O | 0..1 | The ordering criterion for the list of UE communication analytics. | | +| orderDirection | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "orderCriterion" attribute is included. (NOTE) | | +| NOTE: The "CROSSED" value in "MatchingDirection" data type is not applicable for this attribute. | | | | | | + +## 5.1.6.2.73 Type PfdDeterminationInfo + +Table 5.1.6.2.73-1: Definition of type PfdDeterminationInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | M | 1 | Represents a known application identifier that refers to the application detection filter. | | +| snssai | Snssai | C | 0..1 | Represents an S-NSSAI. Shall be presented if the "snssais" attribute was provided within EventSubscription in the subscription request. | | +| dnn | Dnn | C | 0..1 | Represents a DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. Shall be present if the "dnns" attribute was provided within EventSubscription in the subscription request. | | +| flowDescriptions | array(string) | O | 1..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 [33]. (NOTE) | | +| urls | array(string) | O | 1..N | Represents a URL or a regular expression which is used to match the significant parts of the URL. (NOTE) | | +| domainNames | array(string) | O | 1..N | Represents an FQDN or a regular expression as a domain name matching criteria. (NOTE) | | +| dnProtocol | DomainNameProtocol | C | 0..1 | Represents the additional protocol and protocol field for domain names to be matched, it may only be provided when domainNames attribute is present. | | +| pfdConfidence | UInteger | O | 0..1 | Indicates the confidence on the provided PFD Determination analytics for the known Application identified by the included "appId" attribute. Minimum = 0. Maximum = 100. | | +| NOTE: At least one of the "flowDescriptions", "urls", and "domainNames" attributes shall be included. If multiple attributes are included, the PFD is only matched when every attribute contained in the PFD has a matching value. | | | | | | + +## 5.1.6.2.74 Type PduSessionInfo + +Table 5.1.6.2.74-1: Definition of type PduSessionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|---|-------------|---------------------------------------------|---------------| +| pduSessType | PduSessionType | O | 0..1 | Represents the PDU Session Type. | | +| sscMode | ScsMode | O | 0..1 | Represents the SSC mode of the PDU Session. | | +| accessTypes | array(AccessType) | O | 1..N | Represents the access types. | | +| NOTE: The consumer may provide one of "dnns", "snssais" (contained in EventSubscription data type), "pduSessType", "accessTypes" and "sscMode" attributes or provide a combination of these attributes. | | | | | | + +## 5.1.6.2.75 Type DirectionInfo + +Table 5.1.6.2.75-1: Definition of type DirectionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies a SUPI of a UE. (NOTE 1) | | +| gpsi | Gpsi | C | 0..1 | Identifies a GPSI of a UE. (NOTE 1) | | +| direction | Direction | M | 1 | Indicates the moving direction of the UE in the coverage area. | | +| numOfUe | UInteger | O | 0..1 | Indicate the total number of UEs in the specific direction. (NOTE 2) | | +| avrSpeed | Float | O | 0..1 | Indicate the average speed of users in the specific direction. (NOTE 2) | | +| ratio | SamplingRatio | O | 0..1 | Indicate the ratio of UEs in the specific direction. (NOTE 2) | | + +NOTE 1: The "supi" attribute and the "gpsi" attribute are mutually exclusive and one of them shall be provided by the NWDAF in the case of UE Mobility analytics. +NOTE 2: This attribute may be provided in the case of Movement Behaviour analytics. + +## 5.1.6.2.76 Type GeoDistributionInfo + +Table 5.1.6.2.76-1: Definition of type GeoDistributionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| loc | UserLocation | M | 1 | This attribute contains the detailed location, the ueLocationTimestamp attribute in the 3GPP access type of UserLocation data type shall not be provided. | | +| supis | array(Supi) | C | 1..N | Indicate SUPIs of a list of UE. Each element identifies a UE which is in the location. Shall only be included when used in the Nnwdaf service. (NOTE) | | +| gpsi | array(Gpsi) | C | 1..N | Indicate GPSIs of a list of UE. Each element identifies a UE which is in the location. Shall only be included when used in the Nnef service. (NOTE) | | + +NOTE: The "supis" attribute and the "gpsi" attribute are mutually exclusive. + +## 5.1.6.2.77 Type PduSesTrafficInfo + +Table 5.1.6.2.77-1: Definition of type PduSesTrafficInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supis | array(Supi) | C | 1..N | Each element identifies an UE.
May only be present if the subscription request applies to one or more UE(s).
(NOTE 3) | | +| dnn | Dnn | C | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only, for which analytics information is provided.
Shall be present if the DNN was provided in the request or subscription.
(NOTE 1) | | +| snssai | Snssai | C | 0..1 | Identifies the network slice information for which analytics information is provided.
Shall be present if the S-NSSAI was provided in the request or subscription.
(NOTE 1) | | +| tdMatchTraf | array(TdTraffic) | C | 1..N | Identifies traffic that matches Traffic Descriptor provided by the consumer in those PDU Sessions identified by the S-NSSAI and DNN above and the volume.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to "TRAFFIC_MATCH_TD".
(NOTE 2) | | +| tdUnmatchTraf | array(TdTraffic) | C | 1..N | Identifies traffic that does not match Traffic Descriptor provided by the consumer in those PDU Sessions identified by the S-NSSAI and DNN above and the volume.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to "TRAFFIC_UNMATCH_TD".
(NOTE 2) | | + +NOTE 1: At least one of the "dnn" and "snssai" attributes shall be provided for the PDU Session traffic statistics of the specific DNN and/or S-NSSAI. + +NOTE 2: At least one of the "tdMatchTraf" and "tdUnmatchTraf" attributes shall be provided. + +NOTE 3: When Target of Analytics Reporting is a UE group ID, or "Any UE" in the subscription, the NWDAF shall include the list of UEs matching the filter. + +## 5.1.6.2.78 Type TdTraffic + +Table 5.1.6.2.78-1: Definition of type TdTraffic + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| pduSesTrafReqs | array(PduSesTrafficReq) | C | 1..N | Indicates the PDU Session traffic analytics requirements. Shall be present if the "pduSesTrafReqs" attribute was provided in the request or subscription. | | +| ulVol | Volume | O | 0..1 | Indicates the UL data volume exchanged. | | +| dlVol | Volume | O | 0..1 | Indicates the DL data volume exchanged. | | +| allVol | Volume | O | 0..1 | Indicates the overall data volume exchanged. | | +| ulNumOfPkt | UInteger | O | 0..1 | Indicates the number of UL packets exchanged. | | +| dlNumOfPkt | UInteger | O | 0..1 | Indicates the number of DL packets exchanged. | | +| allNumOfPkt | UInteger | O | 0..1 | Indicates the number of overall packets exchanged. | | + +## 5.1.6.2.79 Type PduSesTrafficReq + +**Table 5.1.6.2.79-1: Definition of type PduSesTrafficReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------------|---|-------------|------------------------------------------------------------------------------------|---------------| +| flowDescs | array(FlowDescription) | C | 1..N | Indicates traffic flow filtering description(s) for IP flow(s). | | +| appId | ApplicationId | C | 0..1 | Indicates an application identifier. | | +| domainDescs | array(string) | C | 1..N | FQDN(s) or a regular expression which are used as a domain name matching criteria. | | + +NOTE: One of "flowDescs" attribute, "appId" attribute or "domainDescs" attribute shall be provided. + +## 5.1.6.2.80 Type WlanPerUedPerformanceInfo + +**Table 5.1.6.2.80-1: Definition of type WlanPerUedPerformanceInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------------|---|-------------|---------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | SUPI for a UE. | | +| wlanPerTsInfos | array(WlanPerTsPerformanceInfo) | M | 1..N | WLAN performance information per Time Slot during the analytics target period. (NOTE) | | + +NOTE: The "numberOfUes" attribute is not applicable for the WlanPerUedPerformanceInfo data type. + +## 5.1.6.2.81 Type ResourceUsageRequirement + +**Table 5.1.6.2.81-1: Definition of type ResourceUsageRequirement** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tfcDir | TrafficDirection | O | 0..1 | The traffic direction for the resource usage information.
If omitted, the value "UL_AND_DL" applies. | | +| valExp | ValueExpression | O | 0..1 | Indicates average or peak value of the resource usage for the network performance type (NOTE)
If omitted, the value "AVERAGE" applies. | | + +## 5.1.6.2.82 Type E2eDataVolTransTimeReq + +Table 5.1.6.2.82-1: Definition of type E2eDataVolTransTimeReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| criterion | E2eDataVolTransTimeCriterion | O | 0..1 | Indicates the ordering criterion for the list of E2E data volume transfer time. | | +| order | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "criterion" attribute is included.
(NOTE 1) | | +| highTransTmThr | Uinteger | O | 0..1 | Indicates the threshold of high-transfer time in unit of millisecond. If the transfer time is reached or greater than this threshold, the UEs are classified to high-transfer time.
(NOTE 2) | | +| lowTransTmThr | Uinteger | O | 0..1 | Indicates the threshold of low-transfer time in unit of millisecond. If the transfer time is reached or greater than this threshold, the UEs are classified to low-transfer time.
(NOTE 2) | | +| repeatDataTrans | Uinteger | C | 0..1 | Target number of repeating data transmissions within the Analytics target period.
(NOTE 3) | | +| tsIntervalDataTrans | DurationSec | C | 0..1 | Target time interval between data transmissions within the Analytics target period.
(NOTE 3) | | +| dataVolume | DataVolume | O | 0..1 | Data Volume UL/DL: indicates a specific data volume transmitted once from UE to AF and/or from AF to UE when subscribed event is "E2E_DATA_VOL_TRANS_TIME". | | +| maxNumberUes | Uinteger | O | 0..1 | The maximum number of UEs. | | + +NOTE 1: "CROSSED" value in data type "MatchingDirection" is not applicable for the "order" attribute. + +NOTE 2: The value of "highTransTmThr" shall not be less than the value of "lowTransTmThr". If the value of "highTransTmThr" is greater than the value of "lowTransTmThr", then the UEs between "highTransTmThr" and "lowTransTmThr" are ranking as medium-transfer time. If the value of "highTransTmThr" is equal to the value of "lowTransTmThr", then no medium-transfer time class. This property shall only be provided if the "notifMethod" in "evtReq" is set to "ON\_EVENT\_DETECTION" or "notificationMethod" in "eventSubscriptions" is set to "THRESHOLD" or omitted. + +NOTE 3: Only one of "repeatDataTrans" or "tsIntervalDataTrans" attribute may be present. + +## 5.1.6.2.83 Type E2eDataVolTransTimeInfo + +Table 5.1.6.2.83-1: Definition of type E2eDataVolTransTimeInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------------|----------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| e2eDataVolTransTimes | array(E2eDataVolTransTimePerTS) | M | 1..N | List of E2E Data Volume Trans Time for the application per time slot. | | +| e2eDataVolTransTimeUeLists | array(E2eDataVolTransTimeUeList) | C | 1..N | Contains the list of UEs classified based on experience level of E2E Data Volume Transfer Time. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set to "E2E_DATA_VOL_TRANS_TIME_FOR_UE_LIST". | | +| geoDistrInfos | array(GeoDistributionInfo) | O | 1..N | Indicates the geographical distribution of the UEs per location information | | +| confidence | UInteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE: If the requested period identified by the "tsStart" and "tsDuration" attributes in the "e2eDataVolTransTimes" type leads to future time period, then the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +## 5.1.6.2.84 Type E2eDataVolTransTimePerTS + +Table 5.1.6.2.84-1: Definition of type E2eDataVolTransTimePerTS + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|---------------------------------|---|-------------|---------------------------------------------------------------------------------------|---------------| +| tsStart | DateTime | M | 1 | Indicates the timestamp when the time slot starts during the Analytics target period. | | +| tsDuration | DurationSec | M | 1 | Indicates the time slot duration of Analytics target period. | | +| e2eDataVolTransTimePerUe | array(E2eDataVolTransTimePerUe) | M | 1..N | Represents the E2E data volume transfer time per UE. | | + +## 5.1.6.2.85 Type DataVolume + +Table 5.1.6.2.85-1: Definition of type DataVolume + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------|---------------| +| uplinkVolume | Volume | C | 0..1 | Uplink traffic volume in unit of octet. | | +| downlinkVolume | Volume | C | 0..1 | Downlink traffic volume in unit of octet. | | + +NOTE: At least one of above attributes shall be present. + +## 5.1.6.2.86 Type E2eDataVolTransTimePerUe + +Table 5.1.6.2.86-1: Definition of type E2eDataVolTransTimePerUe + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------------|------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| appId | ApplicationId | C | 0..1 | Indicates an application identifier. Shall be present if the "appId" attribute was provided in the request or subscription. | | +| ueLoc | UserLocation | C | 0..1 | TA or cells where the UE dispersed its transactions and/or data. Shall be present if "networkArea" attribute is included in the event subscription or analytics request. | | +| snssai | Snssai | C | 0..1 | Slice where the UE disperse its transactions and/or data. Shall be present if "snssais" attribute is included in the event subscription or analytics request. | | +| supi | Supi | C | 0..1 | Identifies the SUPI of an UE. May only be present if reporting inside 5GC. | | +| gpsi | Gpsi | C | 0..1 | Identifies the GPSI of an UE. May only be present if reused by the Nnef_AnalyticsExposure service reporting to external AF. | | +| dnn | Dnn | C | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. Shall be present if the "dnn" was provided in the request or subscription. | | +| dnai | Dnai | C | 0..1 | Indicates the DN Access Identifier representing location of the service flow. Shall be present if the "dnais" attribute was provided in the request or subscription. | | +| spatialValid | NetworkAreaInfo | C | 0..1 | Represents the area where the End to End data transfer volume transfer time analytics applies. Shall be present if "networkArea" attribute was provided in the request or subscription. | | +| temporalValidC
on | TimeWindow | O | 0..1 | Represents the valid period for the End to End data transfer volume transfer time analytics. | | +| dataVolTransTi
me | DataVolumeTransferTime | O | 0..1 | Indicates the E2E data volume transfer time and the data volume used to derive the transfer time. | | + +## 5.1.6.2.87 Type E2eDataVolTransTimeUeList + +Table 5.2.6.2.87-1: Definition of type E2eDataVolTransTimeUeList + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| highLevel | array(Supi) | C | 1..N | A list of UEs whose transfer time has reached or greater than the threshold of high level. This attribute may be present if the event subscription includes threshold for high level.
(NOTE) | | +| mediumLevel | array(Supi) | C | 1..N | A list of UEs whose transfer time is within the threshold range of medium level. This attribute may be present if the value of "highTransTmThr" is greater than the value of "lowTransTmThr".
(NOTE) | | +| lowLevel | array(Supi) | C | 1..N | A list of UEs whose transfer time has reached or lower than the threshold of low level. This attribute may be present if the event subscription includes threshold for low level.
(NOTE) | | +| highRatio | SamplingRatio | C | 0..1 | This attribute contains ratio of UEs per E2E data volume transfer time for high level class. Shall be present if the analytics result applies for a group of UEs. | | +| mediumRatio | SamplingRatio | C | 0..1 | This attribute contains ratio of UEs per E2E data volume transfer time for medium level class. Shall be present if the analytics result applies for a group of UEs. | | +| lowRatio | SamplingRatio | C | 0..1 | This attribute contains ratio of UEs per E2E data volume transfer for low level time class. Shall be present if the analytics result applies for a group of UEs. | | +| spatialValidity | NetworkAreaInfo | C | 0..1 | Represents the area where the Classified E2E data volume transfer times for a list of UEs analytics applies. Shall be present if "networkArea" attribute was provided in the request or subscription. | | +| validityPeriod | TimeWindow | O | 0..1 | Represents the validity period for the Classified E2E data volume transfer times for a list of UEs statistics. | | + +NOTE: At least one of "highLevel", "mediumLevel" or "lowLevel" shall be provided. + +## 5.1.6.2.88 Type AccuracyReq + +Table 5.1.6.2.88-1: Definition of type AccuracyReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| accuTimeWin | TimeWindow | O | 0..1 | Indicates the time interval. Only the accuracy information which is generated within this time interval will be considered by the consumer. | | +| accuPeriod | DurationSec | O | 0..1 | The time period for reporting the accuracy information. | | +| accuDevThr | UInteger | O | 0..1 | The reporting threshold of deviation value.
Minimum = 0. Maximum = 100. | | +| minNum | UInteger | O | 0..1 | The minimal number of analytics output provided by NWDAF that have to be considered in the determination of the accuracy information. | | +| updatedAnaFlg | boolean | O | 0..1 | Indicates the updated Analytics flag.
Set to "true" indicates that the NWDAF can provide the updated analytics if the analytics can be generated within the analytics accuracy information time window, which is specified by "accuTimeWin" attribute. Otherwise set to "false". Default value is "false" if omitted. | | +| correctionInterval | DurationSec | O | 0..1 | The relative time interval with respect to the time when the analytics is provided. It indicates the time interval during which the updated analytics can be accepted by the analytics consumer. | | + +## 5.1.6.2.89 Type AccuracyInfo + +Table 5.1.6.2.89-1: Definition of type AccuracyInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| accuracyVal | UInteger | C | 0..1 | The accuracy value.
Indicates percentage number of correct predictions out of all predictions. Minimum = 0. Maximum = 100.
Shall be present if the "accuracyReq" attribute is included in the request.
(NOTE) | | +| accuSampleNbr | UInteger | C | 0..1 | Indicates the analytics accuracy checking sampling number. | | +| anaAccuInd | AnalyticsAccuracyIndication | C | 0..1 | Indicates whether the accuracy value meet the analytics accuracy requirement or not, if not meet may also indicate the related action. Shall be present if the "accuracyReq" attribute is included in the request. | | + +NOTE: The NWDAF containing AnLF determines whether the prediction is correct one is up to implementation. + +## 5.1.6.2.90 Type DataVolumeTransferTime + +Table 5.1.6.2.90-1: Definition of type DataVolumeTransferTime + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------|---------------| +| uplinkVolume | Volume | O | 0..1 | Uplink traffic volume in unit of octet. | | +| avgTransTimeUI | Uinteger | O | 0..1 | The average time of E2E uplink data volume transfer in unit of millisecond. | | +| varTransTimeUI | Float | O | 0..1 | The E2E uplink data volume transfer time variance. | | +| downlinkVolume | Volume | O | 0..1 | Downlink traffic volume in unit of octet. | | +| avgTransTimeDI | Uinteger | O | 0..1 | The average time of E2E downlink data volume transfer in unit of millisecond. | | +| varTransTimeDI | Float | O | 0..1 | The E2E downlink data volume transfer time variance. | | + +## 5.1.6.2.91 Type MovBehavReq + +Table 5.1.6.2.91-1: Definition of type MovBehavReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|--------------------|---|-------------|---------------------------------------------------------------------------------|---------------| +| locationGranReq | LocInfoGranularity | O | 0..1 | Indicates the preferred granularity of location information requirement. (NOTE) | | +| reportThresholds | ThresholdLevel | O | 0..1 | Threshold level of speed. | | + +NOTE: Only applicable to the "LON\_AND\_LAT\_LEVEL" value within the "locationGranReq" attribute. + +## 5.1.6.2.92 Type MovBehavInfo + +Table 5.1.6.2.92-1: Definition of type MovBehavInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| geoLoc | GeographicalCoordinates | C | 0..1 | This attribute contains the geographical location (longitude and latitude level). Shall be provided when the "locationGranReq" attribute value "LON_AND_LAT_LEVEL" is subscribed or requested. | | +| movBehavs | array(MovBehav) | O | 1..N | The Movement Behaviour information per time slot. | | +| confidence | Uinteger | C | 0..1 | Indicates the confidence of the prediction. (NOTE)
Shall be present if the analytics result is a prediction.
Minimum = 0. Maximum = 100. | | + +NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, then the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWD AF shall return a zero confidence. + +## 5.1.6.2.93 Type MovBehav + +Table 5.1.6.2.93-1: Definition of type MovBehav + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tsStart | DateTime | M | 1 | Indicates the timestamp when the time slot starts during the Analytics target period. | | +| tsDuration | DurationSec | M | 1 | Indicates the time slot duration. | | +| numOfUe | Uinteger | C | 0..1 | Indicate the total number of users in the area of interest.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "NUM_OF_UE". | | +| ratio | SamplingRatio | C | 0..1 | Ratio of moving users in the area of interest.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "MOV_UE_RATIO". | | +| avrSpeed | Float | C | 0..1 | Average speed of all users in the area of interest, expressed in kilometres per hour.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "AVR_SPEED". | | +| speedThresInfos | array(SpeedThresholdInfo) | C | 1..N | UEs information in the area of interest whose speed is faster than the speed threshold.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "SPEED_THRESHOLD". | | +| directionUeInfos | array(DirectionInfo) | C | 1..N | Heading directions information of the UE flow in the area of interest.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "MOV_UE_DIRECTION". | | + +## 5.1.6.2.94 Type SpeedThresholdInfo + +Table 5.1.6.2.94-1: Definition of type SpeedThresholdInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|--------------------------------------------------------------------------------|---------------| +| numOfUe | Uinteger | O | 0..1 | Indicate the number of UEs whose speed is faster than the speed threshold. | | +| ratio | SamplingRatio | O | 0..1 | Indicate the percentage of UEs whose speed is faster than the speed threshold. | | + +## 5.1.6.2.95 Type GeoLocation + +Table 5.1.6.2.95-1: Definition of type GeoLocation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------------------------------------------------------------------------------------------------------------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------|---------------| +| point | Point | C | 0..1 | Horizontal location using geographical coordinates. (NOTE) | | +| pointAlt | PointAltitude | C | 0..1 | Horizontal and vertical location using geographical coordinates. (NOTE) | | +| refPoint | LocalOrigin | C | 0..1 | Reference point for the case of local co-ordinates. (NOTE) | | +| localCoords | RelativeCartesianLocation | C | 0..1 | Local co-ordinates representing horizontal and optionally also vertical distances from a reference point. (NOTE) | | +| NOTE: One of "point", "pointAlt" attribute, or the combination of "refPoint" and "localCoords" attributes shall be provided. | | | | | | + +## 5.1.6.2.96 Type LocAccuracyReq + +Table 5.1.6.2.96-1: Definition of type LocAccuracyReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| accThres | UInteger | O | 0..1 | The accuracy (percentage) threshold. The NWDAF is requested to report the location accuracy analytics when this threshold is crossed in the direction(s) indicated by the "accThresMatchDir" attribute.
Minimum = 1
Maximum = 100 | | +| accThresMatchDir | MatchingDirection | O | 0..1 | Matching direction for the accuracy threshold. It may only be provided if the "accThres" attribute is provided. | | +| inOutThres | UInteger | O | 0..1 | Contains the threshold for the percentage of UEs that are indoors. It may only be provided in the subscription for a network area. The NWDAF is requested to report the location accuracy analytics when this threshold is crossed in the direction(s) indicated by the "inOutThresMatchDir" attribute.
Minimum = 1
Maximum = 100
(NOTE) | | +| inOutThresMatchDir | MatchingDirection | O | 0..1 | Matching direction for the indoor/outdoor UEs percentage threshold. It may only be provided if the "inOutThres" attribute is provided.
(NOTE) | | +| posMethod | PositioningMethod | O | 1..N | List of used positioning methods for which the NF service consumer wants to receive analytics. | | + +NOTE: The attributes "inOutThres" and "inOutThresMatchDir" can be used to express the threshold and matching direction for the percentage of UEs that are outdoors since the percentage of outdoor UEs is equal to 100 minus the percentage of indoor UEs. + +## 5.1.6.2.97 Type LocAccuracyInfo + +Table 5.1.6.2.97-1: Definition of type LocAccuracyInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| locAccPerMeths | array(LocAccuracyPerMethod) | M | 1..N | Location accuracy information per positioning method. | | +| inOutUePct | UInteger | C | 0..1 | Contains the percentage of UEs that are indoors in the applicable area.
It shall be provided if the subscription was targeting a network area and the "IN_OUT_PERCENT" analytics subset was requested.
Minimum value = 0
Maximum value = 100
(NOTE 1)(NOTE 2) | | +| inOutInd | boolean | C | 0..1 | Indicates if the target location is indoors or outdoors. "true" means that the target location is indoors, while "false" means that the target location is outdoors. The default value is "false".
It shall be provided if the subscription was targeting a specific location and the "IN_OUT_PERCENT" analytics subset was requested.
(NOTE 1) | | + +NOTE: 1 The attributes "inOutUePct" and "inOutInd" are mutually exclusive. +NOTE: 2 The percentage of UEs that are outdoors in the applicable area is equal to 100 minus the value of the "inOutUePct" attribute. + +## 5.1.6.2.98 Type LocAccuracyPerMethod + +Table 5.1.6.2.98-1: Definition of type LocAccuracyPerMethod + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| posMethod | PositioningMethod | M | 1 | The used positioning method. | | +| locAcc | UInteger | M | 1 | Location accuracy (percentage) for the given positioning method in the applicable area or location.
Minimum value = 0
Maximum value = 100 | | +| losNlosPct | UInteger | O | 0..1 | Percentage of the LOS measurements among the measurements performed using this positioning method.
Minimum value = 0
Maximum value = 100
(NOTE) | | + +NOTE: The percentage of the NLOS measurements is equal to 100 minus the value of the "losNlosPct" attribute. + +## 5.1.6.2.99 Type RelProxReq + +Table 5.1.6.2.99-1: Definition of type RelProxReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|---------------------------------------------------------------------------------|---------------| +| direction | array(Direction) | O | 1..N | Indicates individual or set of direction(s) of interest. | | +| numOfUe | UInteger | O | 0..1 | Indicates the number of UEs for which one UE may report proximity information. | | +| proximityCrits | array(ProximityCriterion) | O | 1..N | One or several criteria to be considered when computing the relative proximity. | | + +## 5.1.6.2.100 Type RelProxInfo + +Table 5.1.6.2.100-1: Definition of type RelProxInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| tsStart | DateTime | M | 1 | Indicates the timestamp when the time slot starts during the Analytics target period. | | +| tsDuration | DurationSec | M | 1 | Indicates the time slot duration. | | +| supis | array(Supi) | C | 1..N | Identifies the UE(s) to which the proximity information applies. If omitted, the information applies to all the target UE(s) that were indicated in the subscription/request. If provided, it shall be a subset of the target UE(s) that were indicated in the subscription/request. | | +| gpsis | array(Gpsi) | C | 1..N | Identifies the UE(s) to which the proximity information applies. If omitted, the information applies to all the target UE(s) that were indicated in the subscription/request. If provided, it shall be a subset of the target UE(s) that were indicated in the subscription/request. Not applicable for this API. | | +| ueProximities | array(UeProximity) | M | 1..N | Observed or Predicted proximity information. | | +| ttlInfo | TimeToCollisionInfo | C | 0..1 | Time To Collision (TTC) information. Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "TIME_TO_COLLISION" and the analytics result is a prediction. | | + +## 5.1.6.2.101 Type UeProximity + +Table 5.1.6.2.101-1: Definition of type UeProximity + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| ueDistance | integer | O | 0..1 | Distance between two UEs, in centimeters. | | +| ueVelocity | VelocityEstimate | O | 0..1 | UE velocity.
May be present if one of the elements in the "proximityCrits" attribute was set to VELOCITY. | | +| avrSpeed | Float | O | 0..1 | Average speed of the users which this proximity information applies to, expressed in kilometres per hour.
May be present if one of the elements in the "proximityCrits" attribute was set to AVG_SPD. | | +| locOrientation | LocationOrientation | O | 0..1 | Indicates the preferred orientation of location information.
May be present if one of the elements in the "proximityCrits" attribute was set to ORIENTATION. | | +| ueTrajectories | array(UeTrajectory) | O | 1..N | Indicates timestamped UE positions.
May be present if one of the elements in the "proximityCrits" attribute was set to TRAJECTORY. | | +| ratio | SamplingRatio | O | 0..1 | Indicate ratio of UEs accounted based on proximity criteria. | | + +## 5.1.6.2.102 Type UeTrajectory + +Table 5.1.6.2.102-1: Definition of type UeTrajectory + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------|-----------------------|---|-------------|--------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | C | 0..1 | Identifies a SUPI of a UE for which this trajectory applies.
(NOTE) | | +| gpsi | Gpsi | C | 0..1 | Identifies a GPSI of a UE for which this trajectory applies.
Not applicable for this API.
(NOTE) | | +| timestampedLocs | array(TimestampedLoc) | M | 1..N | The timestamped locations of the trajectory of the UE. | | +| NOTE: One of "supi" or "gpsi" attributes shall be provided. | | | | | | + +## 5.1.6.2.103 Type TimestampedLocation + +Table 5.1.6.2.103-1: Definition of type TimestampedLocation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------|---------------| +| ts | DateTime | M | 1 | Time stamp for the UE location. | | +| locInfo | LocationInfo | M | 1 | This attribute includes the UE location information at the time indicated by "ts" attribute. | | + +## 5.1.6.2.104 Type TimeToCollisionInfo + +Table 5.1.6.2.104-1: Definition of type TimeToCollisionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| +| ttc | DateTime | O | 0..1 | Time until the predicted collision between UEs to which the proximity information applies. | | +| accuracy | UInteger | O | 0..1 | Accuracy of TTC (dependent on both the UE location accuracy and confidence of the prediction).
Minimum = 0. Maximum = 100. | | +| confidence | UInteger | O | 0..1 | Indicates the confidence of the prediction. (NOTE)
Minimum = 0. Maximum = 100. | | + +NOTE: If the requested period identified by the "startTs" and "endTs" attributes in the "EventReportingRequirement" type is a future time period, then the analytics result is a prediction. If no sufficient data is collected to provide the confidence of the prediction before the time deadline, the NWDAF shall return a zero confidence. + +## 5.1.6.2.105 Type AnalyticsFeedbackInfo + +Table 5.1.6.2.105-1: Definition of type AnalyticsFeedbackInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| actionTimes | array(DateTime) | M | 1..N | The time(s) at which the NF service consumer took an action(s) influenced by the previously provided analytics, which may or may not affect the ground truth data corresponding to the subscribed analytics event at the time which the prediction refers to, and consequently affect the ML Model accuracy monitoring. | | +| usedAnaTypes | array(NwdaEvent) | O | 1..N | List of analytics types that were used for taking the action(s). | | +| impactInd | boolean | O | 0..1 | If provided and set to "true", it indicates that the action taken by the NF service consumer impacts the ground truth data.
If provided and set to "false", it indicates that the action taken by the NF service consumer does not impact the ground truth data.
If omitted, there is no information about the action having an impact on the ground truth data or not. | | + +## 5.1.6.2.106 Type RoamingInfo + +**Table 5.1.6.2.106-1: Definition of type RoamingInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| plmnId | PlmnIdNid | O | 0..1 | Identifier of the HPLMN (if the analytics are requested by an NF service consumer in the VPLMN) or the VPLMN (if the analytics are requested by an NF service consumer in the HPLMN). | | +| aois | array(GeographicalArea) | O | 1..N | Area of Interest for the analytics in the HPLMN (if the analytics are requested by an NF service consumer in the VPLMN) or the VPLMN (if the analytics are requested by an NF service consumer in the HPLMN). | | +| servingNfIds | array(NfInstanceId) | O | 1..N | NF ID(s) of the NF(s) serving the roaming UE(s) in the VPLMN. | | +| servingNfSetIds | array(NfSetId) | O | 1..N | NF Set ID(s) of the NF Set(s) serving the roaming UE(s) in the VPLMN. | | + +## 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 | +|----------------------|-----------------|----------------------------------------------------------------------------------------------------------------------------------|---------------| +| AnySlice | boolean | "false" represents not applicable for all slices.
"true" represents applicable for all slices. | | +| LoadLevelInformation | integer | Load level information of the network slice and the optionally associated network slice instance.
Minimum = 0. Maximum = 100. | | + +## 5.1.6.3.3 Enumeration: NotificationMethod + +**Table 5.1.6.3.3-1: Enumeration NotificationMethod** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| PERIODIC | The subscription of NWDAF Event is periodically. The periodic of the notification is identified by repetitionPeriod defined in clause 5.1.6.2.3. | | +| THRESHOLD | The subscription of NWDAF Event is upon threshold exceeded. | | + +## 5.1.6.3.4 Enumeration: NwdafEvent + +**Table 5.1.6.3.4-1: Enumeration NwdafEvent** + +| Enumeration value | Description | Applicability | +|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| NF_LOAD | Indicates that the event subscribed is NF Load. | NfLoad | +| QOS_SUSTAINABILITY | Indicates that the event subscribed is QoS sustainability. | QoSustainability | +| SLICE_LOAD_LEVEL | Indicates that the event subscribed is load level information of Network Slice | | +| SERVICE_EXPERIENCE | Indicates that the event subscribed is service experience. | ServiceExperience | +| UE_MOBILITY | Indicates that the event subscribed is UE mobility information. | UeMobility | +| UE_COMM | Indicates that the event subscribed is UE communication information. | UeCommunication | +| ABNORMAL_BEHAVIOUR | Indicates that the event subscribed is abnormal behaviour information. | AbnormalBehaviour | +| USER_DATA_CONGESTION | Indicates that the event subscribed is user data congestion information | UserDataCongestion | +| NETWORK_PERFORMANCE | Indicates that the event subscribed is network performance information | NetworkPerformance | +| NSI_LOAD_LEVEL | Indicates that the event subscribed is load level information of Network Slice and the optionally associated Network Slice Instance | NsiLoad | +| DISPERSION | Indicates that the event subscribed is dispersion information. | Dispersion | +| RED_TRANS_EXP | Indicates that the event subscribed is redundant transmission experience. | RedundantTransmissionExp | +| WLAN_PERFORMANCE | Indicates that the event subscribed is WLAN performance. | WlanPerformance | +| DN_PERFORMANCE | Indicates that the event subscribed is DN performance information. | DnPerformance | +| E2E_DATA_VOL_TRANS_TIME | Indicates that the event subscribed is E2E data volume transfer time | E2eDataVolTransTime | +| SM_CONGESTION | Indicates that the event subscribed is the Session Management Congestion Control Experience information for specific DNN and/or S-NSSAI. | SMCCE | +| PFD_DETERMINATION | Indicates that the event subscribed is the PFD Determination information for known application identifier(s). | PfdDetermination | +| PDU_SESSION_TRAFFIC | Indicates that the event subscribed is the PDU Session traffic information. | PduSesTraffic | +| MOVEMENT_BEHAVIOUR | Indicates that the event subscribed is the Movement Behaviour information. | MovementBehaviour | +| LOC_ACCURACY | Indicates that the event subscribed is the Location Accuracy information. | LocAccuracy | +| RELATIVE_PROXIMITY | Indicates that the event subscribed is the Relative Proximity information. | RelativeProximity | + +## 5.1.6.3.5 Enumeration: Accuracy + +**Table 5.1.6.3.5-1: Enumeration Accuracy** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------|---------------| +| LOW | Low accuracy. | | +| MEDIUM | Medium accuracy. | ENAEExt | +| HIGH | High accuracy. | | +| HIGHEST | Highest accuracy. | ENAEExt | + +## 5.1.6.3.6 Enumeration: ExceptionId + +**Table 5.1.6.3.6-1: Enumeration ExceptionId** + +| Enumeration value | Description | Applicability | +|--------------------------------|----------------------------------------|---------------| +| UNEXPECTED_UE_LOCATION | Unexpected UE location | | +| UNEXPECTED_LONG_LIVE_FLOW | Unexpected long-live rate flows | | +| UNEXPECTED_LARGE_RATE_FLOW | Unexpected large rate flows | | +| UNEXPECTED_WAKEUP | Unexpected wakeup | | +| SUSPICION_OF_DDOS_ATTACK | Suspicion of DDoS attack | | +| WRONG_DESTINATION_ADDRESS | Wrong destination address | | +| TOO_FREQUENT_SERVICE_ACCESS | Too frequent Service Access | | +| UNEXPECTED_RADIO_LINK_FAILURES | Unexpected radio link failures | | +| PING_PONG_ACROSS_CELLS | Ping-ponging across neighbouring cells | | + +## 5.1.6.3.7 Enumeration: ExceptionTrend + +**Table 5.1.6.3.7-1: Enumeration ExceptionTrend** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------|---------------| +| UP | Up trend of the exception level. | | +| DOWN | Down trend of the exception level. | | +| UNKNOWN | Unknown trend of the exception level. | | +| STABLE | Stable trend of the exception level. | | + +## 5.1.6.3.8 Enumeration: CongestionType + +**Table 5.1.6.3.8-1: Enumeration CongestionType** + +| Enumeration value | Description | Applicability | +|------------------------|----------------------------------------------------------------|---------------| +| USER_PLANE | The congestion analytics type is User Plane. | | +| CONTROL_PLANE | The congestion analytics type is Control Plane. | | +| USER_AND_CONTROL_PLANE | The congestion analytics type is User Plane and Control Plane. | | + +## 5.1.6.3.9 Enumeration: TimeUnit + +**Table 5.1.6.3.9-1: Enumeration TimeUnit** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------|---------------| +| MINUTE | Time unit is per minute. | | +| HOUR | Time unit is per hour. | | +| DAY | Time unit is per day. | | + +## 5.1.6.3.10 Enumeration: NetworkPerfType + +Table 5.1.6.3.10-1: Enumeration NetworkPerfType + +| Enumeration value | Description | Applicability | +|--------------------------------------|--------------------------------------------------------------------------------------------|-----------------------------| +| GNB_ACTIVE_RATIO | Indicates the ratio of gNB active (i.e. up and running) number to the total number of gNB. | | +| GNB_COMPUTING_USAGE | Indicates gNodeB computing resource usage. | | +| GNB_MEMORY_USAGE | Indicates gNodeB memory usage. | | +| GNB_DISK_USAGE | Indicates gNodeB disk usage. | | +| GNB_RSC_USAGE_OVERALL_TRAFFIC | The gNB resource usage. | NetworkPerformanceExt_AIM L | +| GNB_RSC_USAGE_GBR_TRAFFIC | The gNB resource usage for GBR traffic. | NetworkPerformanceExt_AIM L | +| GNB_RSC_USAGE_DELAY_CRIT_GBR_TRAFFIC | The gNB resource usage for Delay-critical GBR traffic. | NetworkPerformanceExt_AIM L | +| NUM_OF_UE | Indicates number of UEs. | | +| SESS_SUCC_RATIO | Indicates ratio of successful setup of PDU sessions to total PDU session setup attempts. | | +| HO_SUCC_RATIO | Indicates Ratio of successful handovers to the total handover attempts. | | + +## 5.1.6.3.11 Enumeration: ExpectedAnalyticsType + +Table 5.1.6.3.11-1: Enumeration ExpectedAnalyticsType + +| Enumeration value | Description | Applicability | +|---------------------|--------------------------------------------------------------------------------------------------|---------------| +| MOBILITY | Mobility related abnormal behaviour analytics is expected by the consumer | | +| COMMUN | Communication related abnormal behaviour analytics is expected by the consumer | | +| MOBILITY_AND_COMMUN | Both mobility and communication related abnormal behaviour analytics is expected by the consumer | | + +## 5.1.6.3.12 Enumeration: MatchingDirection + +Table 5.1.6.3.12-1: Enumeration MatchingDirection + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------|---------------| +| ASCENDING | Threshold is crossed in ascending direction. | | +| DESCENDING | Threshold is crossed in descending direction. | | +| CROSSED | Threshold is crossed either in ascending or descending direction. | | + +## 5.1.6.3.13 Enumeration: NwdaFailureCode + +**Table 5.1.6.3.13-1: Enumeration NwdaFailureCode** + +| Enumeration value | Description | Applicability | +|--------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| UNAVAILABLE_DATA | Indicates the requested statistics information for the event is rejected since necessary data to perform the service is unavailable. | | +| BOTH_STAT_PRED_NOT_ALLOWED | Indicates the requested analysis information for the event is rejected since the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics. | | +| PREDICTION_NOT_ALLOWED | Indicates that the request for the prediction of the analytics event is not allowed. | PredictionError | +| UNSATISFIED_REQUESTED_ANALYTICS_TIME | Indicates that the requested event is rejected since the analytics information is not ready when the time indicated by the "timeAnaNeeded" attribute (as provided during the creation or modification of subscription) is reached. | EneNA | +| OTHER | Indicates the requested analysis information for the event is rejected due to other reasons. | | + +## 5.1.6.3.14 Enumeration: AnalyticsMetadata + +**Table 5.1.6.3.14-1: Enumeration AnalyticsMetadata** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------------------------------------|---------------| +| NUM_OF_SAMPLES | Number of data samples used for the generation of the output analytics. | | +| DATA_WINDOW | Data time window of the data samples. | | +| DATA_STAT_PROPS | Dataset statistical properties of the data used to generate the analytics. | | +| STRATEGY | Output strategy used for the reporting of the analytics. | | +| ACCURACY | Level of accuracy reached for the analytics. | | + +## 5.1.6.3.15 Enumeration: DatasetStatisticalProperty + +**Table 5.1.6.3.15-1: Enumeration DatasetStatisticalProperty** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------|---------------| +| UNIFORM_DIST_DATA | Indicates the use of data samples that are uniformly distributed according to the different aspects of the requested analytics. | | +| NO_OUTLIERS | Indicates that the data samples shall disregard data samples that are at the extreme boundaries of the value range. | | + +## 5.1.6.3.16 Enumeration: OutputStrategy + +**Table 5.1.6.3.16-1: Enumeration OutputStrategy** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| BINARY | Indicates that the analytics shall only be reported when the requested level of accuracy is reached within a cycle of periodic notification as defined in the analytics reporting information (i.e. in the ReportingInformation data type or the EventSubscription data type). | | +| GRADIENT | Indicates that the analytics shall be reported according with the periodicity defined in the analytics reporting information (i.e. in the ReportingInformation data type or the EventSubscription data type) irrespective of whether the requested level of accuracy has been reached or not. | | + +## 5.1.6.3.17 Enumeration: TransferRequestType + +**Table 5.1.6.3.17-1: Enumeration TransferRequestType** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------------------------------|---------------| +| PREPARE | Indicates that the request is for analytics subscription transfer preparation. | | +| TRANSFER | Indicates that the request is for analytics subscription transfer execution. | | + +5.1.6.3.18 Enumeration: AnalyticsSubset + +**Table 5.1.6.3.18-1: AnalyticsSubset** + +| Enumeration value | Description | Applicability | +|-------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| +| NUM_OF_UE_REG | The number of UE registered. This value is only applicable to NSI_LOAD_LEVEL event. | | +| NUM_OF_PDU_SESS_ESTBL | The number of PDU sessions established. This value is only applicable to NSI_LOAD_LEVEL event. | | +| RES_USAGE | The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance. This value is only applicable to NSI_LOAD_LEVEL event. | | +| NUM_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR | The number of times the resource usage threshold of the network slice instance is reached or exceeded if a threshold value is provided by the consumer. This value is only applicable to NSI_LOAD_LEVEL event. | | +| PERIOD_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR | The time interval between each time the threshold being met or exceeded on the network slice (instance). This value is only applicable to NSI_LOAD_LEVEL event. | | +| EXCEED_LOAD_LEVEL_THR_IND | Whether the Load Level Threshold is met or exceeded by the statistics value. This value is only applicable to NSI_LOAD_LEVEL event. | | +| LIST_OF_TOP_APP_UL | The list of applications that contribute the most to the traffic in the UL direction. This value is only applicable to USER_DATA_CONGESTION event. | | +| LIST_OF_TOP_APP_DL | The list of applications that contribute the most to the traffic in the DL direction. This value is only applicable to USER_DATA_CONGESTION event. | | +| NF_STATUS | The availability status of the NF on the Analytics target period, expressed as a percentage of time per status value (registered, suspended, undiscoverable). This value is only applicable to NF_LOAD event. | | +| NF_RESOURCE_USAGE | The average usage of assigned resources (CPU, memory, storage). This value is only applicable to NF_LOAD event. | | +| NF_LOAD | The average load of the NF instance over the Analytics target period. This value is only applicable to NF_LOAD event. | | +| NF_PEAK_LOAD | The maximum load of the NF instance over the Analytics target period. This value is only applicable to NF_LOAD event. | | +| NF_LOAD_AVG_IN_AOI | The average load of the NF instances over the area of interest. This value is only applicable to NF_LOAD event. | | +| DISPER_AMOUNT | Indicates the dispersion amount of the reported data volume or transaction dispersion type. This value is only applicable to DISPERSION event. | | +| DISPER_CLASS | Indicates the dispersion mobility class (fixed, camper or traveller) upon set its usage threshold, and/or the top-heavy class upon set its percentile rating threshold. This value is only applicable to DISPERSION event. | | +| RANKING | Data/transaction usage ranked high (i.e. value 1), medium (2) or low (3). This value is only applicable to DISPERSION event. | | +| PERCENTILE_RANKING | Percentile ranking of the target UE in the Cumulative Distribution Function of data usage for the population of all UEs. This value is only applicable to DISPERSION event. | | +| RSSI | Indicated the RSSI in the unit of dBm. This value is only applicable to WLAN_PERFORMANCE event. | | +| RTT | Indicates the RTT in the unit of millisecond. This value is only applicable to WLAN_PERFORMANCE event. | | +| TRAFFIC_INFO | Traffic information including UL/DL data rate and/or Traffic volume. This value is only applicable to WLAN_PERFORMANCE event. | | +| NUMBER_OF_UES | Number of UEs observed for the SSID. This value is only applicable to WLAN_PERFORMANCE event. | | +| APP_LIST_FOR_UE_COMM | The analytics of the application list used by UE. This value is only applicable to UE_COMM event. | | +| N4_SESS_INACT_TIMER_FOR_UE_COMM | The N4 Session inactivity timer. This value is only applicable to UE_COMM event. | | +| AVG_TRAFFIC_RATE | Indicates average traffic rate. This value is only applicable to DN_PERFORMANCE event. | | +| MAX_TRAFFIC_RATE | Indicates maximum traffic rate. This value is only applicable to DN_PERFORMANCE event. | | +| AGG_TRAFFIC_RATE | Indicates aggregated traffic rate. This value is only applicable to DN_PERFORMANCE event. | DnPerformanceExt_AIML | + +| | | | +|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| VAR_TRAFFIC_RATE | Indicates variance of traffic rate. This value is only applicable to DN_PERFORMANCE event. | DnPerformanceExt_AIML | +| AVG_PACKET_DELAY | Indicates average Packet Delay. This value is only applicable to DN_PERFORMANCE event. | | +| MAX_PACKET_DELAY | Indicates maximum Packet Delay. This value is only applicable to DN_PERFORMANCE event. | | +| VAR_PACKET_DELAY | Indicates variance of Packet Delay. This value is only applicable to DN_PERFORMANCE event. | DnPerformanceExt_AIML | +| AVG_PACKET_LOSS_RATE | Indicates average Packet Loss Rate. This value is only applicable to DN_PERFORMANCE event. | | +| MAX_PACKET_LOSS_RATE | Indicates maximum Packet Loss Rate. This value is only applicable to DN_PERFORMANCE event. | DnPerformanceExt_AIML | +| VAR_PACKET_LOSS_RATE | Indicates variance of Packet Loss Rate. This value is only applicable to DN_PERFORMANCE event. | DnPerformanceExt_AIML | +| UE_LOCATION | Indicates UE location information. This value is only applicable to SERVICE_EXPERIENCE event. | | +| LIST_OF_HIGH_EXP_UE | Indicates list of high experienced UE. This value is only applicable to SM_CONGESTION event. | | +| LIST_OF_MEDIUM_EXP_UE | Indicates list of medium experienced UE. This value is only applicable to SM_CONGESTION event. | | +| LIST_OF_LOW_EXP_UE | Indicates list of low experienced UE. This value is only applicable to SM_CONGESTION event. | | +| AVG_UL_PKT_DROP_RATE | Indicates average uplink packet drop rate on GTP-U path on N3. This value is only applicable to RED_TRANS_EXP event. | | +| VAR_UL_PKT_DROP_RATE | Indicates variance of uplink packet drop rate on GTP-U path on N3. This value is only applicable to RED_TRANS_EXP event. | | +| AVG_DL_PKT_DROP_RATE | Indicates average downlink packet drop rate on GTP-U path on N3. This value is only applicable to RED_TRANS_EXP event. | | +| VAR_DL_PKT_DROP_RATE | Indicates variance of downlink packet drop rate on GTP-U path on N3. This value is only applicable to RED_TRANS_EXP event. | | +| TRAFFIC_MATCH_TD | Identifies traffic that matches Traffic Descriptor provided by the consumer. This value is only applicable to PDU_SESSION_TRAFFIC event. | PduSesTraffic | +| TRAFFIC_UNMATCH_TD | Identifies traffic that does not match Traffic Descriptor provided by the consumer. This value is only applicable to PDU_SESSION_TRAFFIC event. | PduSesTraffic | +| NUMBER_OF_UE | Indicates the number of UEs. This value is only applicable to DN_PERFORMANCE event. | DnPerformanceExt_eNA | +| UE_GEOG_DIST | Indicates the geographical distribution of the UEs that can be selected by the AF for application service. This value is only applicable to UE_MOBILITY event. | UeMobilityExt2_eNA | +| UE_DIRECTION | Indicates the direction of the UEs. This value is only applicable to UE_MOBILITY event. | UeMobilityExt2_eNA | +| AVG_E2E_UL_PKT_DELAY | Indicates average End-to-End (between UE and UPF) uplink packet delay. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| VAR_E2E_UL_PKT_DELAY | Indicates the variance of End-to-End (between UE and UPF) uplink packet delay. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| AVG_E2E_DL_PKT_DELAY | Indicates average End-to-End (between UE and UPF) downlink packet delay. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| VAR_E2E_DL_PKT_DELAY | Indicates the variance of End-to-End (between UE and UPF) downlink packet delay. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| AVG_E2E_UL_PKT_LOSS_RATE | Indicates average End-to-End (between UE and UPF) uplink packet loss rate. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| VAR_E2E_UL_PKT_LOSS_RATE | Indicates the variance of End-to-End (between UE and UPF) uplink packet loss rate. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| AVG_E2E_DL_PKT_LOSS_RATE | Indicates average End-to-End (between UE and UPF) downlink packet loss rate. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | +| VAR_E2E_DL_PKT_LOSS_RATE | Indicates the variance of End-to-End (between UE and UPF) downlink packet loss rate. This value is only applicable to RED_TRANS_EXP event. | RedundantTransExpExt_eNA | + +| | | | +|-------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| | RED_TRANS_EXP event. | | +| E2E_DATA_VOL_TRANS_TIME_FOR_UE_LIST | Indicates the classified E2E data volume transfer time statistics or predictions for multiple UEs with respect to one or more reporting thresholds. | E2eDataVolTransTime | +| NUM_OF_UE | Indicates the total number of UEs in the area of interest. This value is only applicable to MOVEMENT_BEHAVIOUR event. | MovementBehaviour | +| MOV_UE_RATIO | Indicates the Ratio of moving UEs in the area of interest. This value is only applicable to MOVEMENT_BEHAVIOUR event. | MovementBehaviour | +| AVR_SPEED | Indicates the average speed of all UEs in the area of interest. This value is only applicable to MOVEMENT_BEHAVIOUR event. | MovementBehaviour | +| SPEED_THRESHOLD | Indicates the information on UEs in the area of interest whose speed is faster than the speed threshold. This value is only applicable to MOVEMENT_BEHAVIOUR event. | MovementBehaviour | +| MOV_UE_DIRECTION | Indicates the heading directions of the UE flow in the target area. This value is only applicable to MOVEMENT_BEHAVIOUR event. | MovementBehaviour | +| IN_OUT_PERCENT | Indicates the percentage of UEs that are indoors/outdoors. This value is only applicable to LOC_ACCURACY event. | LocAccuracy | +| TIME_TO_COLLISION | Indicates the time until for a collision with another UE happens. This value is only applicable to RELATIVE_PROXIMITY event prediction. | RelativeProximity | + +#### 5.1.6.3.19 Enumeration: DispersionType + +**Table 5.1.6.3.19-1: Enumeration DispersionType** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------|---------------| +| DVDA | Data Volume Dispersion Analytics. | | +| TDA | Transactions Dispersion Analytics. | | +| DVDA_AND_TDA | Data Volume Dispersion Analytics and Transactions Dispersion Analytics. | | + +#### 5.1.6.3.20 Enumeration: DispersionClass + +**Table 5.1.6.3.20-1: Enumeration DispersionClass** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| FIXED | Dispersion class as fixed UE, its data or transaction usage at a location or a slice, is higher than its class threshold set for its all data or transaction usage. | | +| CAMPER | Dispersion class as camper UE, its data or transaction usage at a location or a slice, is higher than its class threshold and lower than the fixed class threshold set for its all data or transaction usage. | | +| TRAVELLER | Dispersion class as traveller UE, its data or transaction usage at a location or a slice, is lower than the camper class threshold set for its all data or transaction usage. | | +| TOP_HEAVY | Dispersion class as Top_Heavy UE, who's dispersion percentile rating at a location or a slice, is higher than its class threshold. | | + +## 5.1.6.3.21 Enumeration: DispersionOrderingCriterion + +**Table 5.1.6.3.21-1: Enumeration DispersionOrderingCriterion** + +| Enumeration value | Description | Applicability | +|--------------------|-------------------------------------------------------------|---------------| +| TIME_SLOT_START | Indicates the order of time slot start. | | +| DISPERSION | Indicates the order of data/transaction dispersion. | | +| CLASSIFICATION | Indicates the order of data/transaction classification. | | +| RANKING | Indicates the order of data/transaction ranking. | | +| PERCENTILE_RANKING | Indicates the order of data/transaction percentile ranking. | | + +## 5.1.6.3.22 Enumeration: RedTransExpOrderingCriterion + +**Table 5.1.6.3.22-1: Enumeration RedTransExpOrderingCriterion** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------|---------------| +| TIME_SLOT_START | Indicates the order of time slot start. | | +| RED_TRANS_EXP | Indicates the order of Redundant Transmission Experience. | | + +## 5.1.6.3.23 Enumeration: WlanOrderingCriterion + +**Table 5.1.6.3.23-1: Enumeration WlanOrderingCriterion** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------|---------------| +| TIME_SLOT_START | Indicates the order of time slot start. | | +| NUMBER_OF_UES | Indicates the order of number of UEs. | | +| RSSI | Indicates the order of RSSI. | | +| RTT | Indicates the order of RTT. | | +| TRAFFIC_INFO | Indicates the order of Traffic Information | | + +## 5.1.6.3.24 Enumeration: ServiceExperienceType + +**Table 5.1.6.3.24-1: Definition of type ServiceExperienceType** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------------|---------------| +| VOICE | Indicates that the service experience analytics is for voice service. | | +| VIDEO | Indicates that the service experience analytics is for video service. | | +| OTHER | Indicates that the service experience analytics is for other service. | | + +## 5.1.6.3.25 Enumeration: DnPerfOrderingCriterion + +**Table 5.1.6.3.25-1: Enumeration DnPerfOrderingCriterion** + +| Enumeration value | Description | Applicability | +|--------------------------|-----------------------------------------|---------------| +| AVERAGE_TRAFFIC_RATE | Indicates the average traffic rate. | | +| MAXIMUM_TRAFFIC_RATE | Indicates the maximum traffic rate. | | +| AVERAGE_PACKET_DELAY | Indicates the average packet delay. | | +| MAXIMUM_PACKET_DELAY | Indicates the maximum packet delay. | | +| AVERAGE_PACKET_LOSS_RATE | Indicates the average packet loss rate. | | + +## 5.1.6.3.26 Enumeration: TermCause + +**Table 5.1.6.3.26-1: Enumeration TermCause** + +| Enumeration value | Description | Applicability | +|----------------------|-------------------------------------------------|---------------| +| USER_CONSENT_REVOKED | The user consent has been revoked. | | +| NWDAF_OVERLOAD | The NWDAF is overloaded. | | +| UE_LEFT_AREA | The UE has moved out of the NWDAF serving area. | | + +## 5.1.6.3.27 Enumeration: UserDataConOrderCrit + +**Table 5.1.6.3.27-1: Enumeration UserDataConOrderCrit** + +| Enumeration value | Description | Applicability | +|---------------------------|----------------------------------------------------------|---------------| +| APPLICABLE_TIME_WINDOW | The ordering criterion is the Applicable Time Window. | | +| NETWORK_STATUS_INDICATION | The ordering criterion is the network status indication. | | + +## 5.1.6.3.28 Enumeration: UeMobilityOrderCriterion + +**Table 5.1.6.3.28-1: Enumeration UeMobilityOrderCriterion** + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------------------|---------------| +| TIME_SLOT | The ordering criterion is the time slot. | | + +## 5.1.6.3.29 Enumeration: UeCommOrderCriterion + +**Table 5.1.6.3.29-1: Enumeration UeCommOrderCriterion** + +| Enumeration value | Description | Applicability | +|-------------------|-------------------------------------------------------------------------------|---------------| +| START_TIME | The ordering criterion of the analytics is the start time. | | +| DURATION | The ordering criterion of the analytics is the duration of the communication. | | + +## 5.1.6.3.30 Enumeration: NetworkPerfOrderCriterion + +**Table 5.1.6.3.30-1: Enumeration NetworkPerfOrderCriterion** + +| Enumeration value | Description | Applicability | +|--------------------|---------------------------------------------------------------------------|---------------| +| NUMBER_OF_UES | The ordering criterion of the analytics is the number of UEs. | | +| COMMUNICATION_PERF | The ordering criterion of the analytics is the communication performance. | | +| MOBILITY_PERF | The ordering criterion of the analytics is the mobility performance. | | + +## 5.1.6.3.31 Enumeration: DeviceType + +Table 5.1.6.3.31-1: Enumeration DeviceType + +| Enumeration value | Description | Applicability | +|----------------------|----------------------|---------------| +| MOBILE_PHONE | Mobile Phone | | +| SMART_PHONE | Smartphone | | +| TABLET | Tablet | | +| DONGLE | Dongle | | +| MODEM | Modem | | +| WLAN_ROUTER | WLAN Router | | +| IOT_DEVICE | IoT Device | | +| WEARABLE | Wearable | | +| MOBILE_TEST_PLATFORM | Mobile Test Platform | | +| UNDEFINED | Undefined | | + +## 5.1.6.3.32 Enumeration: LocInfoGranularity + +Table 5.1.6.3.32-1: Enumeration LocInfoGranularity + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------------------|---------------| +| TA_LEVEL | Indicates location granularity of TA level. | | +| CELL_LEVEL | Indicates location granularity of Cell level. | | +| LON_AND_LAT_LEVEL | Indicates location granularity of longitude and latitude level. | | + +## 5.1.6.3.33 Enumeration: TrafficDirection + +Table 5.1.6.3.33-1: Enumeration TrafficDirection + +| Enumeration value | Description | Applicability | +|-------------------|------------------------------|---------------| +| UL_AND_DL | Uplink and downlink traffic. | | +| UL | Uplink traffic. | | +| DL | Downlink traffic. | | + +## 5.1.6.3.34 Enumeration: ValueExpression + +Table 5.1.6.3.34-1: Enumeration ValueExpression + +| Enumeration value | Description | Applicability | +|-------------------|----------------------------------------------|---------------| +| AVERAGE | Resource usage information in average value. | | +| PEAK | Resource usage information in peak value. | | + +## 5.1.6.3.35 Enumeration: E2eDataVolTransTimeCriterion + +Table 5.1.6.3.35-1: Enumeration E2eDataVolTransTimeCriterion + +| Enumeration value | Description | Applicability | +|-------------------------|--------------------------------------------------------------|---------------| +| E2E_DATA_VOL_TRANS_TIME | The ordering criterion is the E2E data volume transfer time. | | + +5.1.6.3.36 Void + +5.1.6.3.37 Enumeration: AnalyticsAccuracyIndication + +**Table 5.1.6.3.37-1: Enumeration AnalyticsAccuracyIndication** + +| Enumeration value | Description | Applicability | +|-------------------|--------------------------------------------------------|---------------| +| MEET | Indicates meet the analytics accuracy requirement. | | +| NOT_MEET | Indicates not meet the analytics accuracy requirement. | | + +5.1.6.3.38 Enumeration: LocationOrientation + +**Table 5.1.6.3.38-1: Enumeration LocationOrientation** + +| Enumeration value | Description | Applicability | +|-------------------|-----------------------------------------------------|---------------| +| HORIZONTAL | Indicates horizontal orientation. | | +| VERTICAL | Indicates vertical orientation. | | +| BOTH | Indicates both horizontal and vertical orientation. | | + +5.1.6.3.39 Enumeration: Direction + +**Table 5.1.6.3.39-1: Enumeration Direction** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------|---------------| +| NORTH | North direction. | | +| SOUTH | South direction. | | +| EAST | East direction. | | +| WEST | West direction. | | +| NORTHWEST | Northwest direction. | | +| NORTHEAST | Northeast direction. | | +| SOUTHWEST | Southwest direction. | | +| SOUTHEAST | Southeast direction. | | + +5.1.6.3.40 Enumeration: ProximityCriterion + +**Table 5.1.6.3.40-1: Enumeration ProximityCriterion** + +| Enumeration value | Description | Applicability | +|-------------------|----------------------|---------------| +| VELOCITY | Velocity. | | +| AVG_SPD | Average speed. | | +| ORIENTATION | Orientation. | | +| TRAJECTORY | Mobility trajectory. | | + +## 5.1.7 Error handling + +5.1.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [6]. + +For the Nnwdaf\_EventsSubscription API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [7]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] 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 [6]. + +In addition, the requirements in the following clauses shall apply. + +### 5.1.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_EventsSubscription API. + +### 5.1.7.3 Application Errors + +The application errors defined for the Nnwdaf\_EventsSubscription API are listed in table 5.1.7.3-1. + +**Table 5.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| BOTH_STAT_PRED_NO_T_ALLOWED | 400 Bad Request | Indicates that the request shall be rejected, because for the requested observation period, the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics is not allowed. | | +| UE_AGGREGATION_NO_T_ALLOWED | 400 Bad Request | For the requested UE location aggregation in UE Mobility analytics is not allowed. | | +| PREDICTION_NOT_ALLOWED | 400 Bad Request | Indicates that the request shall be rejected because the prediction for the analytics event is not allowed. | PredictionError | +| USER_CONSENT_NOT_GRANTED | 403 Forbidden | Indicates that the request shall be rejected because an impacted user has not provided the required user consent. | | +| UNAVAILABLE_DATA | 500 Internal Server Error | Indicates the requested statistics in the past is rejected since necessary data to perform the service is unavailable. | | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | | + +### 5.1.8 Feature negotiation + +The optional features in table 5.1.8-1 are defined for the Nnwdaf\_EventsSubscription API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.1.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | ServiceExperience | This feature indicates support for the event related to service experience. | +| 2 | UeMobility | This feature indicates the support of analytics based on UE mobility information. | +| 3 | UeCommunication | This feature indicates the support of analytics based on UE communication information. | +| 4 | QoSustainability | This feature indicates support for the event related to QoS sustainability. | +| 5 | AbnormalBehaviour | This feature indicates support for the event related to abnormal behaviour information. | +| 6 | UserDataCongestion | This feature indicates support for the event related to user data congestion. | +| 7 | NfLoad | This feature indicates the support of the analytics related to the load of NF instances. | +| 8 | NetworkPerformance | This feature indicates the support of analytics based on network performance. | +| 9 | NsiLoad | This feature indicates the support of the event related to the load level of Network Slice and the optionally associated Network Slice Instance. | +| 10 | 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 [6] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. | +| 11 | EneNA | This feature indicates support for the enhancements of network data analytics requirements. | +| 12 | UserDataCongestionExt | This feature indicates support for the extensions to the event related to user data congestion, including support of GPSI and/or list of Top applications. Supporting this feature also requires the support of feature UserDataCongestion. | +| 13 | Aggregation | This feature indicates support for analytics aggregation. | +| 14 | NsiLoadExt | This feature indicates support for the extensions to the event related to the load level of Network Slice and the optionally associated Network Slice Instance, including support of area of interest, NF load information and number of UE or number of PDU Session. Supporting this feature also requires the support of feature NsiLoad. | +| 15 | ServiceExperienceExt | This feature indicates support for the extensions to the event related to service experience, including support of RAT type and/or Frequency. Supporting this feature also requires the support of feature ServiceExperience. | +| 16 | DnPerformance | This feature indicates the support of the analytics related to DN performance. | +| 17 | NfLoadExt | This feature indicates support for the extensions to the event related to the load of NF instances, including NF load over area of interest. Supporting this feature also requires the support of feature NfLoad. | +| 18 | Dispersion | This feature indicates support of the analytics related to dispersion analytics information. | +| 19 | RedundantTransmissionExp | This feature indicates support of the analytics related to redundant transmission experience analytics information. | +| 20 | WlanPerformance | This feature indicates support of the analytics related to WLAN performance information. | +| 21 | UeCommunicationExt | This feature indicates the support for the extensions to the event related to UE communication, including support of reporting the analytics of the application list used by UE, N4 Session inactivity timer, and whether the UE communicates periodically or not. Supporting this feature also requires the support of UeCommunication feature. | +| 22 | UeMobilityExt | This feature indicates support for extensions to the event related to UE mobility, including support of LADN DNN to refer the LADN service area as the AOI. Supporting this feature also requires the support of feature UeMobility. | + +| | | | +|----|-----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 23 | AnaCtxTransfer | This feature indicates support for functionality related to Analytics Context Transfer. | +| 24 | AnaSubTransfer | This feature indicates support for Analytics Subscription Transfer initiated by the source NWDAF. | +| 25 | UserConsent | Indicates the support of detailed handling of user consent, e.g. error responses related to the lack of user consent. | +| 26 | TermRequest | This feature indicates support for Analytics Subscription termination requests sent by the NWDAF to the NF service consumer. | +| 27 | ENAExt | This feature indicates support for the general enhancements of network data analytics requirements, including support more level of accuracy and support for use case context sent by the NF service consumer to the NWDAF. | +| 28 | EnAbnormalBehaviour | This feature indicates support for the enhancements of UE Abnormal Behaviour.
Supporting this feature also requires the support of AbnormalBehaviour feature. | +| 29 | EnQoSustainability | This feature indicates support for the enhancements of QoS Sustainability.
Supporting this feature also requires the support of QoSustainability feature. | +| 30 | UserDataCongestionExt2_eNA | This feature indicates support for the enhancements of user data congestion, including support of ordering criterion.
Supporting this feature also requires the support of UserDataCongestion and UserDataCongestionExt features. | +| 31 | UeMobilityExt2_eNA | This feature indicates support for the enhancements of UE mobility, including support of ordering criterion and linear distance threshold. Supporting this feature also requires the support of UeMobility and UeMobilityExt features. | +| 32 | UeCommunicationExt_eNA | This feature indicates support for the enhancements of UE Communication, including to indicate the ordering criterion for the list of analytics. Supporting this feature also requires the support of UeCommunication feature. | +| 33 | NetworkPerformanceExt_eNA | This feature indicates support for the enhancements of Network Performance, including support of ordering criterion for the list of analytics and analytics target period subset. Supporting this feature also requires the support of NetworkPerformance feature. | +| 34 | QoSustainabilityExt_eNA | This feature indicates support for the enhancements of QoS Sustainability, including enhancements of filter information. Supporting this feature also requires the support of QoSustainability feature. | +| 35 | PartialAnalyticsSubTransfer | This feature indicates support for partial successful analytics subscription transfer. | +| 36 | Void | Void | +| 37 | PfdDetermination | This feature indicates support for functionality related to NWDAF assisted PFD Determination information for known application identifier(s). | +| 38 | ServiceExperienceExt2_eNA | This feature indicates support for the extensions to the event related to service experience supporting eNA, including support for PDU Session parameters information for service experience analytics. Supporting this feature also requires the support of feature ServiceExperience. | +| 39 | DnPerformanceExt_AIML | This feature indicates support for extensions to the event related to DN Performance supporting AIML, including support of extended DN Performance Analytics for group of UEs. Supporting this feature also requires the support of feature DnPerformance. | +| 40 | UeMobilityExt_AIML | This feature indicates support for further extensions to the event related to UE mobility supporting AIML, including UE's geographical distribution and direction analytics. Supporting this feature also requires the support of feature UeMobility. | +| 41 | PduSesTraffic | This feature indicates support of the analytics related to PDU Session traffic information. | +| 42 | E2eDataVolTransTi
me | This feature indicates support for E2E data volume transfer time analytics | +| 43 | DispersionExt_eNA | This feature indicates support for the enhancements of | + +| | | | +|----|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | Dispersion, including the support of preferred granularity of UE location. Supporting this feature also requires the support of Dispersion feature. | +| 44 | WlanPerformanceExt_AIML | This feature indicates support for the enhancements of WLAN performance supporting AIML, including support of analytics per UE granularity. Supporting this feature also requires the support of feature WlanPerformance. | +| 45 | NetworkPerformanceExt_AIML | This feature indicates support of the network performance enhancements for AI/ML-based Services. Within this feature the following enhancements are covered:
- support of providing gNB resource usage for GBR traffic and Delay-critical GBR traffic.

Supporting this feature also requires the support of NetworkPerformance feature. | +| 46 | DnPerformanceExt_eNA | This feature indicates support for extensions to the event related to DN Performance, including support of number of UEs. Supporting this feature also requires the support of feature DnPerformance. | +| 47 | AnalyticsAccuracy | This feature indicates support for the Analytics Accuracy information. | +| 48 | RedundantTransExpExt_eNA | This feature indicates support extensions to the event related to redundant transmission experience analytics information including:
- support of providing the E2E UL/DL packet loss rate (average, variance), E2E UL/DL packet delay (average, variance) in the analytics.
- support of spatial and temporal granularity size.

Supporting this feature also requires the support of feature RedundantTransmissionExp. | +| 49 | WlanPerfExt_eNA | This feature indicates support for the enhancements of WLAN performance supporting AIML, including support of temporal granularity size. Supporting this feature also requires the support of feature WlanPerformance. | +| 50 | MovementBehaviour | This feature indicates support for the Movement Behaviour information. | +| 51 | LocAccuracy | This feature indicates support for the Location Accuracy analytics. | +| 52 | RelativeProximity | This feature indicates support for the Relative Proximity analytics. | +| 53 | StatisticsFailure | This feature indicates support for partial failure report for statistics during event notification.

Supporting this feature also requires the support of EneNA feature. | +| 54 | RoamingAnalytics | This feature indicates support for the Roaming analytics. | +| 55 | PredictionError | This feature indicates support for Prediction Error handling. | + +### 5.1.9 Security + +As indicated in 3GPP TS 33.501 [13] and 3GPP TS 29.500 [6], the access to the Nnwdaf\_EventsSubscription 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 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnwdaf\_EventsSubscription API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], 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 Nnwdaf\_EventsSubscription service. + +The Nnwdaf\_EventsSubscription API defines the following scopes for OAuth2 authorization as described in 3GPP TS 29.501 [7], clause 4.x. + +**Table 5.1.9-1: OAuth2 scopes defined in Nnwdaf\_EventsSubscription API** + +| Scope | Description | +|--------------------------------------|----------------------------------------------------------------------------| +| "nnwdaf-eventssubscription" | Access to the Nnwdaf_EventsSubscription API | +| "nnwdaf-eventssubscription:transfer" | Access to service operations applying to NWDAF event subscription transfer | + +## 5.2 Nnwdaf\_AnalyticsInfo Service API + +### 5.2.1 Introduction + +The Nnwdaf\_AnalyticsInfo service shall use the Nnwdaf\_AnalyticsInfo API. + +The API URI of the Nnwdaf\_AnalyticsInfo API shall be: + +{apiRoot}/ + +The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-analyticsinfo". +- 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 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_AnalyticsInfo 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 [6] for the usage of HTTP standard headers. + +##### 5.2.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 [6]. 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 [15]. + +### 5.2.2.3 HTTP custom headers + +The Nnwdaf\_AnalyticsInfo Service API shall support the mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_AnalyticsInfo Service API. + +## 5.2.3 Resources + +### 5.2.3.1 Resource Structure + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.2.3.1-1 depicts the resource URIs structure for the Nnwdaf\_AnalyticsInfo API. + +![Diagram showing the resource URI structure for the Nnwdaf_AnalyticsInfo API. The root URI is {apiRoot}/nnwdaf-analyticsinfo/. It branches into two resources: /analytics and /context.](c8eb5f8c1faa149b1aaa0d5e4a5c0e66_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnwdaf-analyticsinfo/"] --> Analytics["/analytics"] + Root --> Context["/context"] + +``` + +Diagram showing the resource URI structure for the Nnwdaf\_AnalyticsInfo API. The root URI is {apiRoot}/nnwdaf-analyticsinfo/. It branches into two resources: /analytics and /context. + +**Figure 5.2.3.1-1: Resource URI structure of the Nnwdaf\_AnalyticsInfo API** + +Table 5.2.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.2.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------|--------------|---------------------------------|-----------------------------------------------------------------------------| +| NWDAF Analytics | /analytics | GET | Retrieves the NWDAF analytics. | +| NWDAF Context | /context | GET | Retrieves the NWDAF context information related to analytics subscriptions. | + +### 5.2.3.2 Resource: NWDAF Analytics + +#### 5.2.3.2.1 Description + +The NWDAF Analytics resource represents the analytics to the Nnwdaf\_AnalyticsInfo service at a given NWDAF. + +#### 5.2.3.2.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-analyticsinfo//analytics + +The shall be set as described in clause 5.2.1. + +This resource shall support the resource URI variables defined in table 5.2.3.2.2-1. + +**Table 5.2.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.2.1 | + +### 5.2.3.2.3 Resource Standard Methods + +#### 5.2.3.2.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.3.2.3.1-1. + +**Table 5.2.3.2.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------| +| ana-req | EventReportingRequirement | O | 0..1 | Identifies the analytics reporting requirement information. | +| event-id | EventId | M | 1 | Shall be included to identify the analytics. | +| event-filter | EventFilter | C | 0..1 | Shall be included to identify the analytics when filter information is needed for the related event. | +| supported-features | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. | +| tgt-ue | TargetUeInformation | O | 0..1 | Identifies the target UE information. (NOTE) | +| NOTE: All target UE(s) indicated by this attribute shall belong to the same PLMN. When the RoamingAnalytics feature is supported and the target UE(s) indicated by this attribute belong to a PLMN different than the PLMN of the NF service consumer, the request should contain only attributes that are applicable also in the Nnwdaf_RoamingAnalytics service. | | | | | + +This method shall support the request data structures specified in table 5.2.3.2.3.1-2 and the response data structures and response codes specified in table 5.2.3.2.3.1-3. + +**Table 5.2.3.2.3.1-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.2.3.2.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------------------------------------------------------------------------------------------------------|---|-------------|---------------------------|------------------------------------------------------------------------------------------------------------| +| AnalyticsData | M | 1 | 200 OK | Containing the analytics with parameters as relevant for the requesting NF service consumer. | +| n/a | | | 204 No Content | If the request NWDAF Analytics data does not exist, the NWDAF shall respond with "204 No Content" | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetailsAnalyticsInfoRequest | O | 0..1 | 500 Internal Server Error | The request is rejected by the NWDAF and more details (not only the ProblemDetails) are returned. (NOTE 2) | +| ProblemDetails | O | 0..1 | 500 Internal Server Error | (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 [6] also apply. | | | | | +| NOTE 2: Failure cases are described in clause 5.2.7. | | | | | + +#### 5.2.3.2.4 Resource Custom Operations + +None in this release of the specification. + +### 5.2.3.3 Resource: NWDAF Context + +#### 5.2.3.3.1 Description + +The NWDAF Context resource represents the context information related to analytics subscriptions at the Nnwdaf\_AnalyticsInfo service at a given NWDAF. + +#### 5.2.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-analyticsinfo//context + +The shall be set as described in clause 5.2.1. + +This resource shall support the resource URI variables defined in table 5.2.3.3.2-1. + +**Table 5.2.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.2.1 | + +#### 5.2.3.3.3 Resource Standard Methods + +##### 5.2.3.3.3.1 GET + +This method shall support the URI query parameters specified in table 5.2.3.3.3.1-1. + +**Table 5.2.3.3.3.1-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-------------|------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| context-ids | ContextIdList | M | 1 | Identifies specific context information related to analytics subscriptions. | +| req-context | RequestedContext | O | 0..1 | Identifies the types of the analytics context information the consumer wishes to receive. Absence of this attribute means that the consumer wishes to receive available context information of all types. | + +This method shall support the request data structures specified in table 5.2.3.3.3.1-2 and the response data structures and response codes specified in table 5.2.3.3.3.1-3. + +**Table 5.2.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.2.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|------------------------------------------------------------------------------------------------------| +| ContextData | M | 1 | 200 OK | Contains the context information corresponding with the context identifiers provided in the request. | +| n/a | | | 204 No Content | If the requested context information does not exist, the NWDAF shall respond with "204 No Content". | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. | | | | | + +### 5.2.4 Custom Operations without associated resources + +None in this release of the specification. + +## 5.2.5 Notifications + +None in this release of the specification. + +## 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 Nnwdaf\_AnalyticsInfo service based interface protocol. + +**Table 5.2.6.1-1: Nnwdaf\_AnalyticsInfo specific Data Types** + +| Data type | Section defined | Description | Applicability | +|------------------------------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------|----------------------------| +| AdditionInfoAnalyticsInfoRequest | 5.2.6.2.5 | Contains more details (not only the ProblemDetails) in case an Nnwdaf_AnalyticsInfo request is rejected. | EneNA | +| AdrfDataType | 5.2.6.3.5 | Represents a type of data that is stored in the ADRF. | AnaCtxTransfer | +| AnalyticsData | 5.2.6.2.2 | Describes analytics with parameters indicated in the request. | | +| ContextData | 5.2.6.2.6 | Contains context information related to analytics subscriptions corresponding with one or more context identifiers. | AnaCtxTransfer | +| ContextElement | 5.2.6.2.7 | Contains context information corresponding with a specific context identifier. | AnaCtxTransfer | +| ContextIdList | 5.2.6.2.8 | Contains list of context identifiers of context information of analytics subscriptions. | AnaCtxTransfer | +| ContextType | 5.2.6.3.4 | Identifies the type of analytics context information. | AnaCtxTransfer | +| EventFilter | 5.2.6.2.3 | Represents the event filters used to identify the requested analytics. | | +| EventId | 5.2.6.3.3 | Describes the type of analytics. | | +| HistoricalData | 5.2.6.2.9 | Contains historical data related to an analytics subscription. | AnaCtxTransfer | +| NetworkPerfReq | 5.2.6.2.16 | Represents a network performance requirement. | NetworkPerformanceExt_eNA | +| ProblemDetailsAnalyticsInfoRequest | 5.2.6.4.1 | Data type that extends ProblemDetails. | EneNA | +| RequestedContext | 5.2.6.2.11 | Contains types of analytics context information. | AnaCtxTransfer | +| ResourceUsageRequPerNwPerfType | 5.2.6.2.17 | Indicates more requirements per network performance type when providing resource usage information for network performance. | NetworkPerformanceExt_AIML | +| SmcceInfo | 5.2.6.2.12 | Represents the analytics of Session Management congestion control experience | SMCCE | + +| | | | | +|-------------------------------|------------|-----------------------------------------------------------------------------------------------------------|----------------------------| +| | | information. | | +| SmcceUeList | 5.2.6.2.13 | Represents the List of UEs classified based on experience level of Session Management congestion control. | SMCCE | +| SpecificAnalyticsSubscription | 5.2.6.2.10 | Represents an existing subscription for a specific type of analytics to a specific NWDAF. | AnaCtxTransfer | +| SpecificDataSubscription | 5.2.6.2.14 | Represents an existing data collection subscription to a specific data source NF. | AnaCtxTransfer | +| UserDataCongestReq | 5.2.6.2.15 | Represents the user data congestion requirements. | UserDataCongestionExt2_eNA | + +Table 5.2.6.1-2 specifies data types re-used by the Nnwdaf\_AnalyticsInfo 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 Nnwdaf service based interface. + +Re-used data types of clause 5.1.6 refer here to requests instead of subscriptions. + +**Table 5.2.6.1-2: Nnwdaf\_AnalyticsInfo re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|---------------------|----------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------| +| AbnormalBehaviour | 5.1.6.2.15 | Represents the abnormal behaviour information. | AbnormalBehaviour | +| AccuracyInfo | 5.2.6.2.83 | The analytics accuracy information. | AnalyticsAccuracy | +| AccuracyReq | 5.1.6.3.82 | Represents the analytics accuracy requirement information. | AnalyticsAccuracy | +| AnalyticsContextIdentifier | 5.1.6.2.43 | Contains information about the available analytics contexts. | AnaCtxTransfer | +| AnalyticsMetadataInfo | 5.1.6.2.37 | Contains analytics metadata information required for analytics aggregation. | Aggregation | +| AnalyticsSubset | 5.1.6.3.18 | Contains information about the analytics subsets provided in the subscription request. | EneNA | +| AnySlice | 5.1.6.3.2 | | | +| ApplicationId | 3GPP TS 29.571 [8] | Identifies the application. | ServiceExperience
UeCommunication
AbnormalBehaviour
DnPerformance
PfdDetermination
E2eDataVolTransTime | +| BwRequirement | 5.1.6.2.25 | | ServiceExperience | +| DataNotification | 3GPP TS 29.575 [27] | Describes Notifications about data collection events that occurred. | EneNA | +| DataSubscription | 3GPP TS 29.575 [27] | Represents data subscription from data source (e.g. AMF, SMF, UDM, NEF, AF). | EneNA | +| DateTime | 3GPP TS 29.571 [8] | Identifies the time. | | +| DispersionRequirement | 5.1.6.2.50 | Dispersion analytics requirement. | Dispersion | +| DispersionInfo | 5.1.6.2.53 | Dispersion analytics information. | Dispersion | +| Dnai | 3GPP TS 29.571 [8] | Identifies a user plane access to one or more DN(s). | ServiceExperience
DnPerformance
E2eDataVolTransTime | +| Dnn | 3GPP TS 29.571 [8] | Identifies the DNN. | ServiceExperience
AbnormalBehaviour
UeCommunication
SMCCE
DnPerformance
PfdDetermination
PduSesTraffic
E2eDataVolTransTime | +| DnPerfInfo | 5.1.6.2.45 | Represents DN performance information | DnPerformance | +| DnPerformanceReq | 5.1.6.2.66 | Represents the DN performance requirements. | DnPerformance | +| DurationSec | 3GPP TS 29.571 [8] | | | +| EventNotification | 5.1.6.2.5 | Describes Notifications about analytics events that occurred. | AnaCtxTransfer | +| EventReportingRequirement | 5.1.6.2.7 | | | +| ExceptionId | 5.1.6.3.6 | | AbnormalBehaviour | +| ExpectedUeBehaviourData | 3GPP TS 29.503 [23] | | AbnormalBehaviour | +| ExpectedAnalyticsType | 5.1.6.3.11 | | AbnormalBehaviour | +| GeographicalArea | 3GPP TS 29.522 [32] | Identifies the geographical location (longitude and latitude | UeMobilityExt2_eNA
ServiceExperienceExt2_eNA
QoSSustainExt_eNA | + +| | | | | +|--|--|---------|--| +| | | level). | | +|--|--|---------|--| + +| | | | | +|---------------------------|---------------------|--------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| GeoLocation | 5.1.6.2.95 | Represents a geographic location, potentially using local coordinates and optionally including the altitude. | LocAccuracy | +| LocAccuracyInfo | 5.1.6.2.97 | Contains Location Accuracy information. | LocAccuracy | +| LocAccuracyReq | 5.1.6.2.96 | Contains Location Accuracy analytics requirements. | LocAccuracy | +| LocInfoGranularity | 5.1.6.3.32 | Represents the preferred granularity of location information. | ServiceExperienceExt2_eNA
UeMobilityExt2_eNA
DispersionExt_eNA | +| LocationOrientation | 5.1.6.3.38 | Represent preferred orientation of location information | MovementBehaviour | +| MatchingDirection | 5.1.6.3.12 | The matching direction. | UserDataCongestionExt2_eNA
NetworkPerformanceExt | +| ModelInfo | 5.1.6.2.42 | The information of the ML models. | AnaCtxTransfer | +| MovBehavInfo | 5.1.6.2.91 | Represents the Movement Behaviour information. | MovementBehaviour | +| MovBehavReq | 5.1.6.2.90 | Represents the Movement Behaviour analytics requirements | MovementBehaviour | +| NetworkAreaInfo | 3GPP TS 29.554 [18] | The network area information. | UeMobility
UeCommunication
NetworkPerformance
QoSustainability
ServiceExperience
UserDataCongestion
AbnormalBehaviour
NsiLoadExt
Dispersion
RedundantTransmissionExp
WlanPerformance
DnPerformance
NflLoadExt
E2eDataVolTransTime
MovementBehaviour | +| NetworkPerfInfo | 5.1.6.2.23 | Represents network performance information. | NetworkPerformance | +| NetworkPerfOrderCriterion | 5.1.6.3.30 | Represents a network performance requirement. | NetworkPerformanceExt_eNA | +| NetworkPerfType | 5.1.6.3.10 | Represents the network performance types. | NetworkPerformance | +| NflLoadLevelInformation | 5.1.6.2.31 | Represents load level information of a given NF instance. | NflLoad | +| NfInstanceId | 3GPP TS 29.571 [8] | Identifies an NF instance | NflLoad | +| NfSetId | 3GPP TS 29.571 [8] | Identifies an NF Set instance. | NflLoad | +| NFType | 3GPP TS 29.510 [12] | Identifies a type of NF. | NflLoad | +| NsiIdInfo | 5.1.6.2.33 | Identify the S-NSSAI and the associated Network Slice Instance(s). | ServiceExperience
NsiLoad
DnPerformance | +| NsiLoadLevelInfo | 5.1.6.2.34 | Represents the load level information for an S-NSSAI and the associated network slice instance. | NsiLoad | + +| | | | | +|------------------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NnwdafEventsSubscription | 5.1.6.2.2 | Represents an Individual NWDAF Event Subscription resource. | AnaCtxTransfer | +| PfdDeterminationInfo | 5.1.6.2.71 | Represents PFD Determination information. | PfdDetermination | +| ProblemDetails | 3GPP TS 29.571 [8] | Used in error responses to provide more detailed information about an error. | | +| QosRequirement | 5.1.6.2.20 | | QoSSustainability
E2eDataVolTransTime | +| QosSustainabilityInfo | 5.1.6.2.19 | | QoSSustainability | +| RatFreqInformation | 5.1.6.2.67 | Represents the RAT type and/or Frequency information | ServiceExperienceExt | +| RedundantTransmissionExpInfo | 5.1.6.2.57 | Redundant transmission experience analytics information. | RedundantTransmissionExp | +| RedundantTransmissionExpReq | 5.1.6.2.56 | Redundant transmission experience analytics requirement. | RedundantTransmissionExp | +| PduSessionInfo | 5.1.6.2.74 | Represents combination of PDU Session parameters. | ServiceExperienceExt2_eNA | +| RelProxInfo | 5.1.6.2.100 | Relative Proximity analytics information. | RelativeProximity | +| RelProxReq | 5.1.6.2.99 | Relative Proximity analytics requirements. | RelativeProximity | +| ResourceUsageRequirement | 5.1.6.2.81 | Indicates more requirements per network performance type when providing resource usage information for network performance. | NetworkPerformanceExt_AIML | +| RoamingInfo | 5.1.6.2.106 | Contains information related to roaming analytics. | RoamingAnalytics | +| ServiceExperienceInfo | 5.1.6.2.24 | | ServiceExperience | +| Supi | 3GPP TS 29.571 [8] | Identifies the UE. | ServiceExperience,
NfLoad
NetworkPerformance
UserDataCongestion
UeMobility
UeCommunication
AbnormalBehaviour
SMCCE
Dispersion
RedundantTransmissionExp
WlanPerformance
E2eDataVolTransTime | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of the optional features defined in table 5.2.8-1. | | +| Snssai | 3GPP TS 29.571 [8] | | | +| SliceLoadLevelInformation | 5.1.6.2.6 | | | +| TargetUeInformation | 5.1.6.2.8 | Identifies the target UE information. | ServiceExperience
NfLoad
NetworkPerformance
UserDataCongestion
UeMobility
UeCommunication
AbnormalBehaviour
QoSSustainability | + +| | | | | +|-------------------------|---------------------|---------------------------------------------------------------------------|-------------------------------------------------------------------------------------| +| | | | Dispersion
RedundantTransmissionExp
WlanPerformance
SMCCE
DnPerformance | +| UeCommunication | 5.1.6.2.13 | | UeCommunication | +| UeCommReq | 5.1.6.2.72 | UE communication analytics requirement. | UeCommunicationExt_eNA | +| UeMobility | 5.1.6.2.10 | | UeMobility | +| UeMobilityReq | 5.1.6.2.71 | UE mobility analytics requirement. | UeMobilityExt2_eNA | +| UInteger | 3GPP TS 29.571 [8] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. | | +| UpfInformation | 3GPP TS 29.508 [29] | The information of the UPF serving the UE. | ServiceExperienceExt
DnPerformance | +| PduSesTrafficInfo | 5.1.6.2.77 | Represents PDU Session traffic analytics information. | PduSesTraffic | +| PduSesTrafficReq | 5.1.6.2.79 | Represents PDU Session traffic analytics requirement. | PduSesTraffic | +| UserDataCongestionInfo | 5.1.6.2.17 | | UserDataCongestion | +| UserDataConOrderCrit | 5.1.6.2.15 | The ordering criterion for the list of User Data Congestion analytics. | UserDataCongestionExt2_eNA | +| WlanPerformanceInfo | 5.1.6.2.60 | WLAN performance analytics information. | WlanPerformance | +| WlanPerformanceReq | 5.1.6.2.59 | WLAN performance analytics requirement. | WlanPerformance | +| E2eDataVolTransTimeInfo | 5.1.6.2.82 | E2E data volume transfer time | E2eDataVolTransTime | +| E2eDataVolTransTimeReq | 5.1.6.2.83 | E2E data volume transfer time requirement | E2eDataVolTransTime | + +## 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 AnalyticsData + +**Table 5.2.6.2.2-1: Definition of type AnalyticsData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|----------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------| +| start | DateTime | O | 0..1 | It defines the start time of which the statistics analytics information is applicable or predictions analytics information is valid. (NOTE 1) (NOTE 7) | | +| expiry | DateTime | O | 0..1 | It defines the expiration time after which the statistics analytics information is applicable or predictions analytics information is invalid. (NOTE 1) (NOTE 7) | | +| timeStampGen | DateTime | C | 0..1 | It defines the timestamp of analytics generation. (NOTE 3) | | +| anaMetaInfo | AnalyticsMetadataInfo | C | 0..1 | Contains information about analytics metadata required to aggregate the analytics. It shall be present if the "anaMeta" attribute was included in the request, containing the information indicated by the "anaMeta" attribute. | Aggregation | +| sliceLoadLevelInfos | array(SliceLoadLevelInformation) | C | 1..N | The slices and the load level information. Shall be present when the requested event is "LOAD_LEVEL_INFORMATION". | | +| nsiLoadLevelInfos | array(NsiLoadLevelInfo) | C | 1..N | Each element identifies the load level information for an S-NSSAI and the optionally associated network slice instance. Shall be presented when the requested event is "NSI_LOAD_LEVEL" | NsiLoad | +| nwPerfs | array(NetworkPerfInfo) | C | 1..N | The network performance information. Shall be present when the requested event is "NETWORK_PERFORMANCE". | NetworkPerformance | +| nflLoadLevelInfos | array(NfLoadLevelInformation) | C | 1..N | The NF load information. When the requested event is "NF_LOAD", the nflLoadLevelInfos shall be included. | NfLoad | +| qosSustainInfos | array(QoSustainabilityInfo) | C | 1..N | The QoS sustainability informations in the certain geographic areas. It shall be present if the requested event is "QOS_SUSTAINABILITY". (NOTE 2) | QoSSustainability | +| ueMobs | array(UeMobility) | C | 1..N | The UE mobility information. When the requested event is "UE_MOBILITY", the "ueMobs" attribute shall be included. (NOTE 5) (NOTE 8) | UeMobility | +| ueComms | array(UeCommunication) | C | 1..N | The UE communication information. When the requested event is "UE_COMM", the "ueComms" attribute shall be included. (NOTE 9) | UeCommunication | +| userDataCongInfos | array(UserDataCongestionInfo) | C | 1..N | The user data congestion information. Shall be present when the requested event is "USER_DATA_CONGESTION". | UserDataCongestion | +| suppFeat | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.2.8. | | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | This parameter shall be supplied by NWDAF in the reply of GET request that request the analytics resource, if the consumer includes "supported-features" in the GET request. | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-------------------|-------------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------| +| svcExps | array(ServiceExperienceInfo) | C | 1..N | The service experience information.
Shall be present when the requested event is "SERVICE_EXPERIENCE". | ServiceExperience | +| abnorBehavrs | array(AbnormalBehaviour) | C | 1..N | The abnormal behaviour information.
Shall be present when the requested event is "ABNORMAL_BEHAVIOUR". | AbnormalBehaviour | +| smccExps | array(SmccInfo) | C | 1..N | The Session Management congestion control experience information.
Shall be present when the requested event is "SM_CONGESTION". | SMCCE | +| dispersInfos | array(DispersionInfo) | C | 1..N | The Dispersion information.
Shall be present when the requested event is "DISPERSION". | Dispersion | +| redTransInfos | array(RedundantTransmissionExpInfo) | C | 1..N | The Redundant Transmission Experience analytics information.
Shall be present when the requested event is "RED_TRANS_EXP". | RedundantTransmissionExp | +| wlanInfos | array(WlanPerformanceInfo) | C | 1..N | The WLAN performance related information.
When requested event is "WLAN_PERFORMANCE", the "wlanInfos" attribute shall be included. (NOTE 6) | WlanPerformance | +| dnPerfInfos | array(DnPerfInfo) | C | 1..N | The DN performance information.
Shall be present when the requested event is "DN_PERFORMANCE". (NOTE 4) | DnPerformance | +| pfdDeterminInfos | array(PfdDeterminationInfo) | C | 1..N | Represents the PFD Determination information for a known application identifier.
Shall be present when the requested event is "PFD_DETERMINATION". | PfdDetermination | +| pduSesTrafInfos | array(PduSesTrafficInfo) | C | 1..N | The PDU Session traffic related information.
Shall be present when the requested event is "PDU_SESSION_TRAFFIC". | PduSesTraffic | +| dataViTrnsTmInfos | array(E2eDataVolTransTimeInfo) | C | 1..N | E2E data volume transfer time information.
Shall be present when the requested event is "E2E_DATA_VOL_TRANS_TIME". | E2eDataVolTransTime | +| locAccInfos | array(LocAccuracyInfo) | C | 1..N | The Location Accuracy related information.
It shall be present when the requested event is "LOC_ACCURACY". | LocAccuracy | +| accuInfo | AccuracyInfo | C | 0..1 | The analytics accuracy information.
Shall be provided if the analytics accuracy requirement was requested in the "accuReq" attribute and the "cancelAccuInd" attribute is set to "false" or omitted. | AnalyticsAccuracy | +| cancelAccuInd | boolean | O | 0..1 | Indicates cancelled request of the analytics accuracy information. | AnalyticsAccuracy | + +| | | | | | | +|---------------|---------------------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| | | | | Set to "true" indicates the NWDAF cancelled request of analytics accuracy information as the NWDAF does not support the accuracy checking capability. Otherwise set to "false". Default value is "false" if omitted. | | +| movBehavInfos | array(MovBehavInfo) | C | 1..N | The Movement Behaviour information. Shall be present when the requested event is "MOVEMENT_BEHAVIOUR". | MovementBehaviour | +| relProxInfos | array(RelProxInfo) | C | 1..N | The Relative Proximity information. Shall be present when the requested event is "RELATIVE_PROXIMITY", | RelativeProximity | + +NOTE 1: If the "start" attribute and the "expiry" attribute are both provided, the DateTime of the "expiry" attribute shall not be earlier than the DateTime of the "start" attribute. + +NOTE 2: The "qosFlowRetThd" and "ranUeThrouThd" attributes in QosSustainabilityInfo data type are not applicable. + +NOTE 3: This attribute shall be included when ADRF is deployed. + +NOTE 4: The "minTrafficRate", "aggTrafficRate", "varTrafficRate", "trafRateUelds", "avePacketDelay", "maxPacketDelay", "varPacketDelay", "packDelayUelds", "maxPacketLossRate", "varPacketLossRate" and "packetLossUelds" attribute(s) within the DnPerfInfo data type is applicable only if the "DnPerformanceExt\_AIML" feature is supported. + +NOTE 5: The "directionInfos" attribute and the "geoDistInfos" attribute in the "locInfos" attribute within the UeMobility data type are applicable only if the "UeMobilityExt\_AIML" feature is supported. + +NOTE 6: The "wlanPerUeldInfos" attribute may be included within the "wlanInfos" attribute only if the "WlanPerformanceExt\_AIML" feature is supported. + +NOTE 7: The validity period specified by "start" and "expiry" attributes is determined by NWDAF internal logic, and is a subset of the analytics target period indicated by "startTs" and "endTs", or "offsetPeriod" attributes contained in "ana-req" attribute. If the analytics target period refers to the past, the period specified by these two attributes indicate the time period over which the statistics are applicable. If the analytics target period refers to the future, the period specified by these two attributes indicate the time period over which the predictions are valid. + +NOTE 8: If the "UeMobilityExt2\_eNA" feature is supported and the "locationGranReq" attribute value "LON\_AND\_LAT\_LEVEL" is requested, the "geoLoc" attribute within the "locInfos" attribute in the "UeMobility" type shall be provided to report the geographical location (longitude and latitude level). + +NOTE 9: The "perioCommInd", "anaOfAppList" and "sessInactTimer" attributes within the UeCommunication data type are applicable only if the "UeCommunicationExt" feature is supported. + +### 5.2.6.2.3 Type EventFilter + +**Table 5.2.6.2.3-1: Definition of type EventFilter** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| anySlice | AnySlice | C | 0..1 | Default is "false". (NOTE 1) | | +| appIds | array(ApplicationId) | C | 1..N | Represents the Application Identifier(s). The absence of appIds means applicable to all applications. (NOTE 4) (NOTE 10) (NOTE 12) | ServiceExperience
UeCommunication
AbnormalBehaviour
Dispersion
DnPerformance
PfdDetermination
E2eDataVolTransTime | +| dnns | array(Dnn) | C | 1..N | Represents the DNN(s). Each DNN is a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. The absence of dnns means applicable to all DNNs. (NOTE 4) (NOTE 13) | ServiceExperience
UeCommunication
AbnormalBehaviour
SMCCE
DnPerformance
RedundantTransmissionExp
PfdDetermination
PduSesTraffic
E2eDataVolTransTime
RelativeProximity | +| dnais | array(Dnai) | O | 1..N | Represents the Data Network Access Identifier(s) of user plane accesses to DN(s) where applications are deployed. | ServiceExperience
DnPerformance
E2eDataVolTransTime | +| ladnDnns | array(Dnn) | O | 1..N | Represents the LADN DNN(s) to indicate the LADN service area(s) as the AoI(s). | UeMobilityExt | +| snssais | array(Snssai) | C | 1..N | Identification(s) of network slice(s). (NOTE 1), (NOTE 4) (NOTE 13) (NOTE 20) | | +| roamingInfo | RoamingInfo | O | 0..1 | Information about roaming analytics. When this attribute is provided, the request should contain only attributes that are applicable also in the Nnwdaf_RoamingAnalytics service. | RoamingAnalytics | +| nfInstanceIds | array(NfInstanceId) | O | 1..N | Identification(s) of NF instance(s). | NfLoad | +| nfSetIds | array(NfSetId) | O | 1..N | Identification(s) of NF instance set(s). | NfLoad | +| nfTypes | array(NFType) | O | 1..N | Identification(s) of NF type(s). (NOTE 8) | NfLoad
NsiLoadExt | +| networkArea | NetworkAreaInfo | C | 0..1 | This IE represents the network area where the NF service consumer wants to know the analytics result. (NOTE 2), (NOTE 4) (NOTE 17) | UeMobility
UeCommunication
NetworkPerformance
QoSustainability
ServiceExperience
UserDataCongestion
AbnormalBehaviour
NsiLoadExt
NfLoadExt
Dispersion | + +| | | | | | | +|--|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | | | RedundantTransmissionExp
WlanPerformance
DnPerformance
PduSesTraffic
E2eDataVolTransTime
MovementBehaviour
LocAccuracy
RelativeProximity | +|--|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | | +|---------------------|-------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| location | GeoLocation | C | 0..1 | A location (i.e. geographical location or location in local coordinates) to which the request applies. (NOTE 18) | LocAccuracy | +| locAccInfos | array(LocAccuracyInfo) | C | 1..N | The Location Accuracy related information.
It shall be present when the requested event is "LOC_ACCURACY". | LocAccuracy | +| temporalGranSize | DurationSec | O | 0..1 | Indicates the minimum duration of each time slot for which the analytics are provided.
(NOTE 15) | NetworkPerformanceExt_eNA
UeMobilityExt2_eNA
UserDataCongestionExt2_eNA
QoSSustainExt_eNA
DispersionExt_eNA
WlanPerfExt_eNA
RedundantTransExpExt_eNA
DnPerfExt_eNA | +| spatialGranSizeTA | Uinteger | O | 0..1 | Indicates the maximum number of TAs used to define an area for which the analytics are provided.
May be included when the "networkArea" attribute in the EventSubscription data type is provided.
(NOTE 16) | NetworkPerformanceExt_eNA
UeMobilityExt2_eNA
UeCommunicationExt_eNA
QoSSustainExt_eNA
DispersionExt_eNA
DnPerfExt_eNA | +| spatialGranSizeCell | Uinteger | O | 0..1 | Indicates the maximum number of cells used to define an area for which the analytics are provided.
May be included when the "networkArea" attribute in the EventSubscription data type is provided.
(NOTE 16) | NetworkPerformanceExt_eNA
UeMobilityExt2_eNA
UeCommunicationExt_eNA
QoSSustainExt_eNA
DispersionExt_eNA
DnPerfExt_eNA | +| fineGranAreas | array(GeographicalArea) | O | 1..N | Indicates the fine granularity areas to which the request applies. (i.e. with a finer granularity than cell).
(NOTE 2) (NOTE 17) | ServiceExperienceExt2_eNA
UeMobilityExt2_eNA
QoSSustainExt_eNA | +| visitedAreas | array(NetworkAreaInfo) | O | 1..N | Identification(s) of network area(s) which the UEs had previously been in at least one of the Visited Area(s) of Interest. (NOTE 9) | UeMobilityExt | +| maxTopAppUINb | Uinteger | O | 0..1 | Indicates the requested maximum number of top applications that contribute the most to the traffic in Uplink direction.
Minimum = 1.
May be included when one of the elements in the "listOfAnaSubsets" attribute is set to LIST_OF_TOP_APP_UL. | UserDataCongestionExt | +| maxTopAppDINb | Uinteger | O | 0..1 | Indicates the requested maximum number of top applications that contribute the most to the traffic in Downlink direction.
Minimum = 1. | UserDataCongestionExt | + +| | | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------|--| +| | | | | May be included when one of the elements in the "listOfAnaSubsets" attribute is set to LIST_OF_TOP_APP_DL. | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|------------------|---------------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------| +| nsiIdInfos | array(NsiIdInfo) | O | 1..N | Each element identifies the S-NSSAI and the optionally associated network slice instance(s). May be included when the event-id is "NSI_LOAD_LEVEL", "SERVICE_EXPERIENCE" or "DN_PERFORMANCE". (NOTE 1) | ServiceExperience
NsiLoad
DnPerformance | +| nwPerfReqs | array(NetworkPerfReq) | O | 1..N | Represents the network performance requirements. This attribute may be included when the event-id is "NETWORK_PERFORMANCE". | NetworkPerformanceExt_eNA | +| nwPerfTypes | array(NetworkPerfType) | C | 1..N | Represents the network performance types. This attribute shall be included when event-id is "NETWORK_PERFORMANCE". | NetworkPerformance | +| addNwPerfReqs | array(ResourceUsageRequPerNwPerfType) | O | 1..N | Each element indicates more requirement for each network performance type (by each element in the "nwPerfTypes" attribute) when providing resource usage information for the network performance type. | NetworkPerformanceExt_AIML | +| userDataConReqs | array(UserDataCongestReq) | O | 1..N | Represents the network performance requirements. This attribute may be included when the event-id is "NETWORK_PERFORMANCE". | UserDataCongestionExt2_eNA | +| qosRequ | QoSRequirement | C | 0..1 | Represents the QoS requirements. This attribute shall be included when event-id is "QOS_SUSTAINABILITY" or E2E_DATA_VOL_TRANS_TIME. | QoSSustainability
E2eDataVolTransTime | +| bwReqs | array(BwRequirement) | O | 1..N | Represents the media/application bandwidth requirement for each application. It may only be present if "appls" attribute is provided. | ServiceExperience | +| excepIds | array(ExceptionId) | C | 1..N | Represents a list of Exception Ids. (NOTE 3), (NOTE 4) | AbnormalBehaviour | +| exptAnaType | ExpectedAnalyticsType | C | 0..1 | Represents expected UE analytics type. (NOTE 3), (NOTE 4) | AbnormalBehaviour | +| exptUeBehav | ExpectedUeBehaviourData | O | 0..1 | Represents expected UE behaviour. | AbnormalBehaviour | +| ratFreqs | array(RatFreqInformation) | O | 1..N | Identification(s) of the RAT type(s) and/or frequency(ies) of UE's serving cell(s) which the request applies. (NOTE 5) | ServiceExperienceExt | +| disperReqs | array(DispersionRequirement) | O | 1..N | Represents the dispersion analytics requirements. | Dispersion | +| redTransReqs | array(RedundantTransmissionExpReq) | O | 1..N | Represents the redundant transmission experience analytics requirements. | RedundantTransmissionExp | +| wlanReqs | array(WlanPerformanceReq) | O | 1..N | Represents other WLAN performance analytics requirements. If the attribute contains no content, may take default handling action. | WlanPerformance | +| listOfAnaSubsets | array(AnalyticsSubset) | O | 1..N | The list of analytics subsets used to indicate the content of the analytics. | EneNA | +| upfInfo | UpfInformation | O | 0..1 | Identifies the UPF. (NOTE 7) | ServiceExperienceExt
DnPerformance | +| appServerAddrs | array(AddrFqdn) | C | 1..N | Each element represents the Application Server Instance (IP address/FQDN of the Application Server). (NOTE 6) | ServiceExperienceExt
DnPerformance | +| dnPerfReqs | array(DnPerformanceReq) | O | 1..N | Represents the DN performance requirements. This attribute shall be included when event-id is | DnPerformance | + +| | | | | | | +|--|--|--|--|-------------------|--| +| | | | | "DN_PERFORMANCE". | | +|--|--|--|--|-------------------|--| + +| | | | | | | +|-----------------|-------------------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| +| dataViTrnsTmRqs | array(E2eDataVolTransTimeReq) | O | 1..N | Represents the list of E2E data volume transfer time requirement. This attribute may be included when event-id is "E2E_DATA_VOL_TRANS_TIME". | E2eDataVolTransTime | +| ueMobilityReqs | array(UeMobilityReq) | O | 1..N | Represents the UE mobility requirements. This attribute may be included when the event-id is "UE_MOBILITY". | UeMobilityExt2_eNA | +| ueCommReqs | array(UeCommReq) | O | 1..N | Represents the UE communication requirements. This attribute may be included when the event-id is "UE_MOBILITY". | UeCommunicationExt_eNA | +| pduSesInfos | array(PduSessionInfo) | O | 1..N | Represents combination of PDU Session parameters. (NOTE 12) | ServiceExperienceExt2_eNA | +| pduSesTrafReqs | array(PduSesTrafficReq) | C | 1..N | Represents the PDU Session traffic analytics requirements. This attribute shall be included when subscribed event is "PDU_SESSION_TRAFFIC". (NOTE 13) | PduSesTraffic | +| locAccReqs | array(LocAccuracyReq) | O | 1..N | Represents the Location Accuracy analytics requirements. This attribute may only be included when the subscribed event is "LOC_ACCURACY" and the attributes "accThres", "accThresMatchDir", "inOutThres", and "inOutThresMatchDir" inside it are not applicable for analytics requests. | LocAccuracy | +| locGranularity | LocInfoGranularity | O | 0..1 | The preferred granularity of UE location information.(NOTE 19) | ServiceExperienceExt2_eNA
UeMobilityExt2_eNA
DispersionExt_eNA
MovementBehaviour | +| locOrientation | LocationOrientation | O | 0..1 | Indicates the preferred orientation of location information. | MovementBehaviour
UeMobilityExt2_eNA | +| useCaseCxt | string | O | 0..1 | Indicates the context of usage of the analytics. The value and format of this parameter are not standardized. | ENAExt | +| accuReq | AccuracyReq | O | 0..1 | Represents the analytics accuracy requirement information. May be included as indication to the NWDAF (containing an AnLF supporting Accuracy checking capability) to activate checking the analytics accuracy information of the event. | AnalyticsAccuracy | +| movBehavReqs | array(MovBehavReq) | O | 1..N | Represents the Movement Behaviour analytics requirements. | MovementBehaviour | +| relProxReqs | array(RelProxReq) | O | 1..N | Represents the Relative Proximity analytics requirements. | RelativeProximity | + +NOTE 1: The "anySlice" attribute is not applicable to features "UeMobility" and "NetworkPerformance". The "snssais" attribute is not applicable to features "ServiceExperience", "NsiLoad", "UeMobility" and "NetworkPerformance". When event-id in the request is "LOAD\_LEVEL\_INFORMATION", the identifications of network slices, either information about slice(s) identified by the "snssais" attribute, or "anySlice" set to "true", shall be included. When the requested event-id is "NSI\_LOAD\_LEVEL" or "SERVICE\_EXPERIENCE", either the "nsiInfos" attribute or anySlice set to "true" shall be included. When the requested event-id is "QOS\_SUSTAINABILITY", "NF\_LOAD", "UE\_COMM", "ABNORMAL\_BEHAVIOUR", "USER\_DATA\_CONGESTION", "DISPERSION" "RED\_TRANS\_EXP", "PFD\_DETERMINATION", "PDU\_SESSION\_TRAFFIC" or "RELATIVE\_PROXIMITY", the identifications of network slices identified by the "snssais" attribute is optional. + +NOTE 2: For different events, the following rules apply: + +- For "NETWORK\_PERFORMANCE" or "USER\_DATA\_CONGESTION" event, the + +| | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +|

"networkArea" attribute shall be provided if the event applied for all UEs (i.e. "anyUe" attribute set to true).

  • - For "QOS_SUSTAINABILITY", at least one of "networkArea" and "fineGranAreas" attributes shall be provided.
  • - For "E2E_DATA_VOL_TRANS_TIME", the "networkArea" attribute shall be provided.
  • - For "MOVEMENT_BEHAVIOUR", the "networkArea" attribute shall be provided.
  • - For "SERVICE_EXPERIENCE" event, if the event applied for all UEs (i.e. "anyUe" attribute set to "true"): at least one of the "networkArea" and "fineGranAreas" attributes shall be provided.
| +| NOTE 3: Either "excepIds" or "exptAnaType" shall be provided if event-id in the request is "ABNORMAL_BEHAVIOUR". | +| NOTE 4: For "ABNORMAL_BEHAVIOUR" event with "anyUe" attribute in "tgt-ue" attribute sets to true,
  • - at least one of the "networkArea" and the "snssais" attribute should be included, if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via the "excepIds" attribute is mobility related;
  • - at least one of the "networkArea", "applIds", "dnns" and "snssais" attribute should be included, if the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via the "excepIds" attribute is communication related;
  • - the expected analytics type via the "exptAnaType" attribute or the list of Exception Ids via "excepIds" attribute shall not be requested for both mobility and communication related analytics at the same time.
| +| NOTE 5: If both the "allFreq" attribute and the "allRat" attributes in RatFreqInformation data type are present, then the only one instance of the RatFreqInformation data type shall be present to indicate for all the RAT type and Frequency value the NWDAF has received for the application. | +| NOTE 6: For service experience analytics, this parameter shall be provided when a consumer requires analytics for an edge application over a UP path. | +| NOTE 7: For service experience analytics, this parameter may be provided when a consumer requires analytics for an edge application over a UP path, and it is only needed when the target of the service experience analytics is a specific UPF included in this UP path. | +| NOTE 8: When event-id in the request is "NSI_LOAD_LEVEL" and the NsiLoadExt feature is supported, and the NF service consumer provides the "nftypes" attribute, then the NWDAF accounts only for the resource usage of the NF types included in "nftypes" to derive the output analytics. | +| NOTE 9: If this attribute is provided, the analytics target period shall be a past time period (i.e. only statistics is supported). | +| NOTE 10: When event-id in the request is "PFD_DETERMINATION" and the PfdDetermination feature is supported, the "applIds" attribute shall be included. | +| NOTE 11: Void. | +| NOTE 12: When the "pduSesInfos" attribute is provided, the associated "applIds" attribute shall be provided for the NWDAF to be able to compute the service experience per application. | +| NOTE 13: When the subscribed event is "PDU_SESSION_TRAFFIC" and the PduSesTraffic feature is supported, at least one of the "dnns" and/or "snssais" attributes as the route selection descriptor(s) for the URSP rule shall be included. | +| NOTE 14: Void. | +| NOTE 15: When this attribute is provided, the NWDAF shall provide the analytics per elementary time slot accordingly. | +| NOTE 16: When this attribute is provided, the NWDAF shall provide the analytics per group of TAs or cells accordingly. | +| NOTE 17: If both "networkArea" and "fineGranAreas" attributes are provided, the Area of Interest is interpreted as the intersection area indicated by these two attributes. | +| NOTE 18: When the subscribed event is "LOC_ACCURACY", only one of the "networkArea" or "location" attribute shall be included. | +| NOTE 19: The "LON_AND_LAT_LEVEL" value of "locGranularity" attribute is not applicable to features "DispersionExt_eNA". The "TA_LEVEL" or "CELL_LEVEL" value of "locGranularity" attribute is not applicable to features "MovementBehaviour". | +| NOTE 20: When the RoamingAnalytics feature is supported, the NF service consumer is in the VPLMN, and the NWDAF determines that the request is for roaming analytics in the HPLMN, this attribute may contain the mapped S-NSSAI(s) of the HPLMN. | + +NOTE: Care needs to be taken to avoid excessive signalling. + +Editor's Note: Which attributes of the accuReq attribute are applicable here is FFS. + +5.2.6.2.4 Void + +5.2.6.2.5 Type AdditionInfoAnalyticsInfoRequest + +**Table 5.2.6.2.5-1: Definition of type AdditionInfoAnalyticsInfoRequest** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| rvWaitTime | DurationSec | O | 0..1 | Recommended minimum time interval (in seconds) to be used to determine the time when analytics information is needed in similar future requests.
It may only be included if the "cause" attribute within the ProblemDetails data type is set to "UNSATISFIED_REQUESTED_ANALYTICS_TIME". | | + +5.2.6.2.6 Type ContextData + +**Table 5.2.6.2.6-1: Definition of type ContextData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------|---|-------------|-----------------------------------------------------------------------------------------|---------------| +| contextElem | array(ContextElement) | M | 1..N | List of items that contain context information corresponding with a context identifier. | | + +### 5.2.6.2.7 Type ContextElement + +**Table 5.2.6.2.7-1: Definition of type ContextElement** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| contextId | AnalyticsContextId
entifier | M | 1 | Context identifier of the context information contained in the rest of the attributes. | | +| pendAnalytics | array(EventNotification) | C | 1..N | Contains output analytics for the analytics subscription this context element is associated with, which have not yet been sent to the analytics consumer. It shall be provided if such analytics are available and the NF service consumer has requested the "PENDING_ANALYTICS" context type. | | +| histAnalytics | array(EventNotification) | C | 1..N | Contains historical output analytics for the analytics subscription this context element is associated with. It shall be provided if such analytics are available and the NF service consumer has requested the "HISTORICAL_ANALYTICS" context type. | | +| lastOutputTime | DateTime | C | 0..1 | Timestamp of the last output analytics provided to the analytics consumer. It shall be provided if output analytics had been provided and the NF service consumer has requested the "PENDING_ANALYTICS" and/or "HISTORICAL_ANALYTICS" context type. Absence of this attribute means that no output analytics had been sent. | | +| aggrSubs | array(SpecificAnalyticsSubscription) | C | 1..N | Contains analytics subscription aggregation information, i.e. information about analytics subscriptions that the NWDAF has with other NWDAFs that collectively serve an analytics subscription. It shall be provided if such subscriptions exist and the NF service consumer has requested the "AGGR_SUBS" context type. | | +| histData | array(HistoricalData) | C | 1..N | Contains historical data related to the analytics subscription this context element is associated with. It shall be provided if such data exists and the NF service consumer has requested the "DATA" context type. | | +| adrflId | NfInstanceId | O | 0..1 | Identifier of the ADRF in which the NWDAF stores analytics context information. | | +| adrfDataTypes | array(AdrfDataType) | C | 1..N | Type(s) of data stored in the ADRF by the NWDAF. It shall be provided if the attribute "adrflId" is provided. | | +| aggrNwdaflDs | array(NfInstanceId) | C | 1..N | NWDAF identifiers of NWDAF instances used by the NWDAF service consumer when aggregating multiple analytics subscriptions. It shall be provided if such information is available and the NF service consumer has requested the "AGGR_INFO" context type. | | +| modellInfos | array(ModellInfo) | C | 1..N | Contains information identifying the ML model(s) that the consumer | | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | NWDAF is currently subscribing for the analytics. It shall be provided if such information is available and the NF service consumer has requested the "ML_MODELS" context type. | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +#### 5.2.6.2.8 Type ContextIdList + +**Table 5.2.6.2.8-1: Definition of type ContextIdList** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------------|---|-------------|--------------------------------------------------------------------------------|---------------| +| contextIds | array(AnalyticsContextIdentifier) | M | 1..N | List of context identifiers of context information of analytics subscriptions. | | + +#### 5.2.6.2.9 Type HistoricalData + +**Table 5.2.6.2.9-1: Definition of type HistoricalData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------------------|---|-------------|---------------------------------------------------------------|---------------| +| startTime | DateTime | O | 0..1 | Start of the time period during which the data was collected. | | +| endTime | DateTime | O | 0..1 | End of the time period during which the data was collected. | | +| subsWithSources | array(SpecificDataSubscription) | O | 1..N | Information about subscriptions with the data sources. | | +| data | array(DataNotification) | M | 1..N | Historical data related to the analytics. | | + +#### 5.2.6.2.10 Type SpecificAnalyticsSubscription + +**Table 5.2.6.2.10-1: Definition of type SpecificAnalyticsSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------|---------------| +| subscriptionId | string | M | 1 | The identifier of the specific analytics subscription. | | +| producerId | NfInstanceId | C | 0..1 | NWDAF instance identifier to which the NF service consumer has established this subscription.
(NOTE) | | +| producerSetId | NfSetId | C | 0..1 | NWDAF set identifier to which the NF service consumer has established this subscription.
(NOTE) | | +| nwdafEvSub | NnwdafEventsSubscription | M | 1 | Contains information about the analytics subscription. | | + +NOTE: Exactly One of "producerId" and "producerSetId" shall be included. + +#### 5.2.6.2.11 Type RequestedContext + +**Table 5.2.6.2.11-1: Definition of type RequestedContext** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------|---------------| +| contexts | array(ContextType) | M | 1..N | Contains the types of the analytics context information the consumer wishes to receive. | | + +## 5.2.6.2.12 Type SmcceInfo + +Table 5.2.6.2.12-1: Definition of type SmcceInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dnn | Dnn | C | 0..1 | Identifies DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.
Shall be present if the "dnns" was provided in the event subscription or analytics request. | | +| snssai | Snssai | C | 0..1 | Identifies the network slice information.
Shall be present if the "snssais" was provided in the event subscription or analytics request. | | +| smcceUeList | SmcceUeList | M | 1 | Contains the list of UEs classified based on experience level of SM congestion control. | | + +## 5.2.6.2.13 Type SmcceUeList + +Table 5.2.6.2.13-1: Definition of type SmcceUeList + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| highLevel | array(Supi) | C | 1..N | A list of UEs whose experience level of SMCC for specific DNN and/or S-NSSAI is high.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "LIST_OF_HIGH_EXP_UE".
(NOTE 1) (NOTE 2) | | +| mediumLevel | array(Supi) | C | 1..N | A list of UEs whose experience level of SMCC for specific DNN and/or S-NSSAI is medium.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "LIST_OF_MEDIUM_EXP_UE".
(NOTE 1) (NOTE 2) | | +| lowLevel | array(Supi) | C | 1..N | A list of UEs whose experience level of SMCC for specific DNN and/or S-NSSAI is low.
Shall be present if one of the elements in the "listOfAnaSubsets" attribute was set with value as "LIST_OF_LOW_EXP_UE".
(NOTE 1) (NOTE 2) | | + +NOTE 1: At least one of "highLevel", "mediumLevel" or "lowLevel" shall be provided. + +NOTE 2: If the "listOfAnaSubsets" attribute with value only applicable to SMCC event is present in the request, then only the corresponding attribute(s) shall be present. + +## 5.2.6.2.14 Type SpecificDataSubscription + +Table 5.2.6.2.14-1: Definition of type SpecificDataSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------|---------------| +| subscriptionId | string | M | 1 | The identifier of the specific data subscription. | | +| producerId | NfInstanceId | C | 0..1 | NF instance identifier to which the NF service consumer has established this subscription. (NOTE) | | +| producerSetId | NfSetId | C | 0..1 | NF set identifier to which the NF service consumer has established this subscription. (NOTE) | | +| dataSub | DataSubscription | M | 1 | Contains information about the subscription with the data source. | | + +NOTE: One of "producerId" and "producerSetId" shall be included. + +## 5.2.6.2.15 Type UserDataCongestReq + +Table 5.2.6.2.15-1: Definition of type UserDataCongestReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------|---------------| +| orderCriterion | UserDataConOrderCrit | O | 0..1 | The ordering criterion for the list of User Data Congestion analytics. (NOTE 2) | | +| orderDirection | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "orderCriterion" attribute is included. (NOTE 1) | | + +NOTE 1: The "CROSSED" value in "MatchingDirection" data type is not applicable for this attribute. +NOTE 2: If the the value of "orderCriterion" attribute is "APPLICABLE\_TIME\_WINDOW", the "ASCENDING" direction indicates that the list of User Data Congestion analytics are in chronological order and the "DESCENDING" direction indicates that the list of User Data Congestion analytics are in reverse chronological order. + +## 5.2.6.2.16 Type NetworkPerfReq + +Table 5.2.6.2.16-1: Definition of type NetworkPerfReq + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------|---------------| +| orderCriterion | NetworkPerfOrderCriterion | O | 0..1 | The ordering criterion for the list of network performance analytics. | | +| orderDirection | MatchingDirection | O | 0..1 | Indicate the order: ascending or descending. May be present when the "orderCriterion" attribute is included. (NOTE) | | + +NOTE: The "CROSSED" value in "MatchingDirection" data type is not applicable for this attribute. + +### 5.2.6.2.17 Type ResourceUsageRequPerNwPerfType + +**Table 5.2.6.2.17-1: Definition of type ResourceUsageRequPerNwPerfType** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| nwPerfType | NetworkPerfType | M | 1 | Indicates network performance type. | | +| rscUsgReq | ResourceUsageRequirement | O | 0..1 | Indicates more requirements when providing resource usage information for the network performance type indicated by the "nwPerfType" attribute.
(NOTE) | | + +NOTE: The "rscUsgReq" value is only applicable when the "nwPerfType" attribute is set to "GNB\_RSC\_USAGE\_OVERALL\_TRAFFIC", "GNB\_RSC\_USAGE\_GBR\_TRAFFIC" or "GNB\_RSC\_USAGE\_DELAY\_CRIT\_GBR\_TRAFFIC". + +### 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 + +The simple data types defined in table 5.2.6.3.2-1 shall be supported. + +**Table 5.2.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| n/a | | | | + +## 5.2.6.3.3 Enumeration: EventId + +Table 5.2.6.3.3-1: Enumeration EventId + +| Enumeration value | Description | Applicability | +|-------------------------|---------------------------------------------------------------------------------------------------------------------------|--------------------------| +| E2E_DATA_VOL_TRANS_TIME | Represents the analytics of E2E data volume transfer time. | E2eDataVolTransTime | +| LOAD_LEVEL_INFORMATION | Represents the analytics of load level information of corresponding network slice. | | +| NETWORK_PERFORMANCE | Represents the analytics of network performance information | NetworkPerformance | +| NF_LOAD | Represents the analytics of NF Load information. | NfLoad | +| QOS_SUSTAINABILITY | Represents the analytics of QoS sustainability in the certain area. | QoSustainability | +| SERVICE_EXPERIENCE | Represents the analytics of service experience of corresponding application and/or network slice. | ServiceExperience | +| UE_MOBILITY | Represents the analytics of UE mobility. | UeMobility | +| UE_COMM | Represents the analytics of UE communication. | UeCommunication | +| USER_DATA_CONGESTION | Represents the analytics of the user data congestion in the certain area. | UserDataCongestion | +| ABNORMAL_BEHAVIOUR | Represents the analytics of abnormal behaviour information. | AbnormalBehaviour | +| NSI_LOAD_LEVEL | Represents the analytics of load level information of Network Slice and the optionally associated Network Slice Instance. | NsiLoad | +| SM_CONGESTION | Represents the analytics of Session Management congestion control experience information for specific DNN and/or S-NSSAI. | SMCCE | +| DN_PERFORMANCE | Represents the analytics of DN performance. | DnPerformance | +| DISPERSION | Represents the analytics of dispersion. | Dispersion | +| RED_TRANS_EXP | Represents the analytics of Redundant Transmission Experience. | RedundantTransmissionExp | +| WLAN_PERFORMANCE | Represents the analytics of WLAN performance. | WlanPerformance | +| PFD_DETERMINATION | Represents the analytics of PFD Determination information for known application identifier(s). | PfdDetermination | +| PDU_SESSION_TRAFFIC | Represents the analytics of PDU Session traffic information. | PduSesTraffic | +| MOVEMENT_BEHAVIOUR | Represents the analytics of Movement Behaviour information. | MovementBehaviour | +| LOC_ACCURACY | Represents the analytics of Location Accuracy. | LocAccuracy | +| RELATIVE_PROXIMITY | Represents the analytics of Relative Proximity information. | RelativeProximity | + +#### 5.2.6.3.4 Enumeration: ContextType + +**Table 5.2.6.3.4-1: Enumeration ContextType** + +| Enumeration value | Description | Applicability | +|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| PENDING_ANALYTICS | Represents context information that relates to pending output analytics. | | +| HISTORICAL_ANALYTICS | Represents context information that relates to historical output analytics. | | +| AGGR_SUBS | Represents context information about the analytics subscriptions that an NWDAF has with other NWDAFs that collectively serve an analytics subscription. | | +| DATA | Represents context information about historical data that is available. | | +| AGGR_INFO | Represents context information that is related to aggregation of analytics from multiple NWDAF subscriptions. | | +| ML_MODELS | Represents context information about used ML models. | | + +#### 5.2.6.3.5 Enumeration: AdrfDataType + +**Table 5.2.6.3.5-1: Enumeration AdrfDataType** + +| Enumeration value | Description | Applicability | +|----------------------|-------------------------------------------------------------|---------------| +| HISTORICAL_ANALYTICS | Indicates that historical analytics are stored in the ADRF. | | +| HISTORICAL_DATA | Indicates that historical data are stored in the ADRF. | | + +#### 5.2.6.4 Data types describing alternative data types or combinations of data types + +##### 5.2.6.4.1 Type ProblemDetailsAnalyticsInfoRequest + +**Table 5.2.6.4.1-1: Definition of type ProblemDetailsAnalyticsInfoRequest 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.571 [8]. | | +| AdditionInfoAnalyticsInfoRequest | 1 | Contains additional information why the analytics request is rejected. | | + +### 5.2.7 Error handling + +#### 5.2.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [6]. + +For the Nnwdaf\_AnalyticsInfo API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] 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 [6]. In addition, the requirements in the following clauses shall apply. + +#### 5.2.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_AnalyticsInfo API. + +### 5.2.7.3 Application Errors + +The application errors defined for the Nnwdaf\_AnalyticsInfo API are listed in table 5.2.7.3-1. + +**Table 5.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | Applicability | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------| +| BOTH_STAT_PRED_NOT_ALLOWED | 400 Bad Request | Indicates that the request shall be rejected, because for the requested observation period, the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics is not allowed. | | +| PREDICTION_NOT_ALLOWED | 400 Bad Request | Indicates that the request shall be rejected because the prediction for the analytics event is not allowed. | PredictionError | +| USER_CONSENT_NOT_GRANTED | 403 Forbidden | Indicates that the request shall be rejected because an impacted user has not provided the required user consent. | | +| UNAVAILABLE_DATA | 500 Internal Server Error | Indicates the requested statistics in the past is rejected since necessary data to perform the service is unavailable. | | +| UNSATISFIED_REQUESTED_ANALYTICS_TIME | 500 Internal Server Error | Indicates that the requested event is rejected since the analytics information is not ready when the time indicated by the "timeAnaNeeded" attribute (as provided during the request) is reached. | | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | | + +### 5.2.8 Feature negotiation + +The optional features in table 5.2.8-1 are defined for the Nnwdaf\_AnalyticsInfo API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.2.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | UeMobility | This feature indicates the support of analytics based on UE mobility information. | +| 2 | UeCommunication | This feature indicates the support of analytics based on UE communication information. | +| 3 | NetworkPerformance | This feature indicates the support of analytics based on network performance. | +| 4 | ServiceExperience | This feature indicates support for the event related to service experience. | +| 5 | QoSustainability | This feature indicates support for the event related to QoS sustainability. | +| 6 | AbnormalBehaviour | This feature indicates support for the event related to abnormal behaviour information. | +| 7 | UserDataCongestion | This feature indicates the support of the analytics related on user data congestion. | +| 8 | NfLoad | This feature indicates the support of the analytics related to the load of NF instances. | +| 9 | NsiLoad | This feature indicates the support of the analytics related to the load level of Network Slice and the optionally associated Network Slice Instance. | +| 10 | EneNA | This feature indicates support for the enhancements of network data analytics requirements. | +| 11 | UserDataCongestionExt | This feature indicates support for the extensions to the event related to user data congestion, including support of GPSI and/or list of Top applications. Supporting this feature also requires the support of feature UserDataCongestion. | +| 12 | Aggregation | This feature indicates support for analytics aggregation. | +| 13 | NsiLoadExt | This feature indicates support for the extensions to the event related to the load level of Network Slice and the optionally associated Network Slice Instance, including support of area of interest, NF load information and number of UE or number of PDU Session. Supporting this feature also requires the support of feature NsiLoad. | +| 14 | ServiceExperienceExt | This feature indicates support for the extensions to the event related to service experience, including support of RAT type and/or Frequency. Supporting this feature also requires the support of feature ServiceExperience. | +| 15 | SMCCE | This feature indicates support for the event related to SM congestion control experience. | +| 16 | NfLoadExt | This feature indicates support for the extensions to the event related to the load of NF instances, including NF load over area of interest. Supporting this feature also required the support of feature NfLoad. | +| 17 | Dispersion | This feature indicates support for the event related to dispersion analytics information. | +| 18 | RedundantTransmissionExp | This feature indicates support for the event related to redundant transmission experience analytics information. | +| 19 | WlanPerformance | This feature indicates support of the event related to WLAN performance analytics information. | +| 20 | UeMobilityExt | This feature indicates support for extensions to the event related to UE mobility, including support of LADN DNN to refer the LADN service area as the AOI. Supporting this feature also requires the support of feature UeMobility. | +| 21 | DnPerformance | This feature indicates the support of the analytics related to DN performance. | +| 22 | AnaCtxTransfer | This feature indicates the support of analytics context transfer. | +| 23 | UserConsent | Indicates the support of detailed handling of user consent, e.g. error responses related to the lack of user consent. | +| 24 | UserDataCongestionExt2_eNA | This feature indicates support for the enhancements of user data congestion, including support of ordering criterion. Supporting this feature also requires the support of UserDataCongestion and UserDataCongestionExt features. | +| 25 | UeMobilityExt2_eNA | This feature indicates support for the enhancements of UE mobility, including support of ordering criterion. Supporting this feature also requires the support of UeMobility and UeMobilityExt features. | + +| | | | +|----|----------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 26 | UeCommunicationExt_eNA | This feature indicates support for the enhancements of UE Communication, including support of ordering criterion. Supporting this feature also requires the support of UeCommunication feature. | +| 33 | NetworkPerformanceExt_eNA | This feature indicates support for the enhancements of Network Performance, including support of ordering criterion for the list of analytics and analytics target period subset. Supporting this feature also requires the support of NetworkPerformance feature. | +| 28 | PfdDetermination | This feature indicates the support of the analytics related to PFD Determination information of known application identifier(s). | +| 29 | ServiceExperienceExt2_eNA | This feature indicates extensions to the event related to service experience supporting eNA, including support for PDU Session parameters information for service experience analytics. Supporting this feature also requires the support of feature ServiceExperience. | +| 31 | DnPerformanceExt_AIML | This feature indicates support for extensions to the event related to DN Performance supporting AIML, including support of extended DN Performance Analytics for group of UEs. Supporting this feature also requires the support of feature DnPerformance. | +| 32 | UeMobilityExt_AIML | This feature indicates support for further extensions to the event related to UE mobility supporting AIML, including support of UE's geographical distribution and direction analytics. Supporting this feature also requires the support of feature UeMobility. | +| 33 | PduSesTraffic | This feature indicates support of the analytics related to PDU Session traffic information. | +| 34 | DispersionExt_eNA | This feature indicates support for the enhancements of Dispersion, including the support of preferred granularity of UE location. Supporting this feature also requires the support of Dispersion feature. | +| 35 | WlanPerformanceExt_AIML | This feature indicates support for the enhancements of WLAN performance supporting AIML, including support of analytics per UE granularity. Supporting this feature also requires the support of feature WlanPerformance. | +| 36 | NetworkPerformanceExt_AIML | This feature indicates support of the network performance enhancements for AI/ML-based Services. Within this feature the following enhancements are covered:
- support of providing gNB resource usage for GBR traffic and Delay-critical GBR traffic.

Supporting this feature also requires the support of NetworkPerformance feature. | +| 37 | E2eDataVolTransTime | This feature indicates support for E2E data volume transfer time analytics | +| 38 | AnalyticsAccuracy | This feature indicates support for the Analytics Accuracy information. | +| 39 | EnAbnormalBehaviour | This feature indicates support for the enhancements of UE Abnormal Behaviour. Supporting this feature also requires the support of AbnormalBehaviour feature. | +| 40 | UeCommunicationExt | This feature indicates the support for the extensions to the event related to UE communication, including support of reporting the analytics of the application list used by UE, N4 Session inactivity timer, and whether the UE communicates periodically or not. Supporting this feature also requires the support of UeCommunication feature. | +| 41 | QoSSustainExt_eNA | This feature indicates support for the enhancements of QoS Sustainability, including:
- support of temporal and spatial granularity size.

Supporting this feature also requires the support of QoSSustainability feature. | +| 42 | WlanPerfExt_eNA | This feature indicates support for the enhancements of WLAN performance, including:
- support of temporal granularity size.

Supporting this feature also requires the support of feature WlanPerformance. | + +| | | | +|----|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 43 | DnPerfExt_eNA | This feature indicates support for extensions to the event related to DN Performance, including support of number of UEs. Supporting this feature also requires the support of feature DnPerformance. | +| 44 | QoSustainExt_eNA | This feature indicates support for the enhancements of QoS Sustainability, including enhancements of filter information. Supporting this feature also requires the support of QoSustainability feature. | +| 45 | MovementBehaviour | This feature indicates support for the Movement Behaviour information. | +| 46 | LocAccuracy | This feature indicates support for the Location Accuracy analytics. | +| 47 | RelativeProximity | This feature indicates support for the Relative Proximity analytics. | +| 48 | ENAExt | This feature indicates support for the general enhancements of network data analytics requirements, including support more level of accuracy and support for use case context sent by the NF service consumer to the NWDAF. | +| 49 | RoamingAnalytics | This feature indicates support for the Roaming analytics. | +| 50 | PredictionError | This feature indicates support for Prediction Error handling. | + +## 5.2.9 Security + +As indicated in 3GPP TS 33.501 [13] and 3GPP TS 29.500 [6], the access to the Nnwdaf\_AnalyticsInfo 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 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnwdaf\_AnalyticsInfo API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], 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 Nnwdaf\_AnalyticsInfo service. + +The Nnwdaf\_AnalyticsInfo API defines the following scopes for OAuth2 authorization as described in 3GPP TS 29.501 [7], clause 4.x. + +**Table 5.2.9-1: OAuth2 scopes defined in Nnwdaf\_AnalyticsInfo API** + +| Scope | Description | +|----------------------------------------|-------------------------------------------------------------------------------------------------------------------| +| "nnwdaf-analyticsinfo" | Access to the Nnwdaf_AnalyticsInfo API | +| "nnwdaf-analyticsinfo:contexttransfer" | Access to service operations applying to NWDAF context transfer related service operations, i.e. ContextTransfer. | + +## 5.3 Nnwdaf\_DataManagement Service API + +### 5.3.1 Introduction + +The Nnwdaf\_DataManagement service shall use the Nnwdaf\_DataManagement API. + +The API URI of the Nnwdaf\_DataManagement API shall be: + +{apiRoot}// + +The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}/// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-datamanagement". + +- The shall be "v1". +- The shall be set as described in clause 5.3.3. + +## 5.3.2 Usage of HTTP + +### 5.3.2.1 General + +HTTP/2, IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_DataManagement is contained in Annex A. + +### 5.3.2.2 HTTP standard headers + +#### 5.3.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +#### 5.3.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 [6]. 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 [15]. + +### 5.3.2.3 HTTP custom headers + +The Nnwdaf\_DataManagement service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_DataManagement service API. + +## 5.3.3 Resources + +### 5.3.3.1 Resource Structure + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.3.3.1-1 depicts the resource URIs structure for the Nnwdaf\_DataManagement API. + +![Diagram showing the resource URI structure for the Nnwdaf_DataManagement API. The root URI is {apiRoot}/nnwdaf-datamanagement/. A line branches from this root to a box containing /subscriptions. From this box, another line branches to a box containing /{subscriptionId}.](00bb8c9fd2ec7fa7da34a98f824468b6_img.jpg) + +{apiRoot}/nnwdaf-datamanagement/ + +``` + +graph TD + Root["{apiRoot}/nnwdaf-datamanagement/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the resource URI structure for the Nnwdaf\_DataManagement API. The root URI is {apiRoot}/nnwdaf-datamanagement/. A line branches from this root to a box containing /subscriptions. From this box, another line branches to a box containing /{subscriptionId}. + +**Figure 5.3.3.1-1: Resource URI structure of the Nnwdaf\_DataManagement API** + +Table 5.3.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.3.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-----------------------------------------------|---------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------| +| NWDAF Data Management Subscriptions | /subscriptions | POST | Creates a new Individual NWDAF Data Management Subscription resource. | +| Individual NWDAF Data Management Subscription | /subscriptions/{subscriptionId} | DELETE | Deletes an Individual NWDAF Data Management Subscription identified by subresource {subscriptionId}. | +| | | PUT | Modifies an existing Individual NWDAF Data Management Subscription identified by subresource {subscriptionId}. | + +## 5.3.3.2 Resource: NWDAF Data Management Subscriptions + +### 5.3.3.2.1 Description + +The NWDAF Data Management Subscriptions resource represents all subscriptions to the Nnwdaf\_DataManagement Service at a given NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF Data Management Subscription resource. + +### 5.3.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnwdaf-datamanagement//subscriptions + +The shall be set as described in clause 5.3.1. + +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 this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.3.1 | + +### 5.3.3.2.3 Resource Standard Methods + +#### 5.3.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.3.2.3.1-1. + +**Table 5.3.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.3.2.3.1-2 and the response data structures and response codes specified in table 5.3.3.2.3.1-3. + +**Table 5.3.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|----------------------------------------------------------------------| +| NnwdafDataManagementSubsc | M | 1 | Create a new Individual NWDAF Data Management Subscription resource. | + +**Table 5.3.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| NnwdafDataManagementSubsc | M | 1 | 201 Created | The creation of an Individual NWDAF Data Management Subscription resource is confirmed and a representation of that resource is returned. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | (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 [6] also apply. +NOTE 2: Failure cases are described in clause 5.3.7. + +**Table 5.3.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}/nnwdaf-datamanagement//subscriptions/{subscriptionId} | + +### 5.3.3.2.4 Resource Custom Operations + +None in this release of the specification. + +## 5.3.3.3 Resource: Individual NWDAF Data Management Subscription + +### 5.3.3.3.1 Description + +The Individual NWDAF Data Management Subscription resource represents a single subscription to the Nnwdaf\_DataManagement Service at a given NWDAF. + +### 5.3.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-datamanagement//subscriptions/{subscriptionId} + +The shall be set as described in clause 5.3.1. + +This resource shall support the resource URI variables defined in table 5.3.3.3.2-1. + +**Table 5.3.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|----------------------------------------------------------------| +| apiRoot | string | See clause 5.3.1 | +| subscriptionId | string | Identifies a subscription to the Nnwdaf_DataManagement Service | + +### 5.3.3.3.3 Resource Standard Methods + +#### 5.3.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 5.3.3.3.3.1-1. + +**Table 5.3.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 5.3.3.3.3.1-2 and the response data structures and response codes specified in table 5.3.3.3.3.1-3. + +**Table 5.3.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|--------------------------------------------------------------------------------------| +| NnwdafDataManagementSubsc | M | 1 | Parameters to replace a subscription to NWDAF Data Management Subscription resource. | + +**Table 5.3.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| NnwdafDataManagementSubsc | M | 1 | 200 OK | The Individual NWDAF Data Management Subscription resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF Data Management Subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Data Management Subscription modification.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Data Management Subscription modification.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (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 [6] also apply. + +NOTE 2: Failure cases are described in clause 5.3.7. + +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.3.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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.3.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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.3.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.3.3.3.3.2-1. + +**Table 5.3.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.3.2-2 and the response data structures and response codes specified in table 5.3.3.3.3.2-3. + +**Table 5.3.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 | Successful case: The Individual NWDAF Data Management Subscription resource matching the subscriptionId was deleted. | +| NnwdafDataManagementNotification | C | 0..1 | 200 OK | Successful case: The Individual NWDAF Data Management Subscription resource matching the subscriptionId was deleted and including the stored unsent events in the response. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Data Management Subscription deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Data Management Subscription deletion.
(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 [6] 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 [6]). + +**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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +### 5.3.3.3.4 Resource Custom Operations + +None in this release of the specification. + +## 5.3.4 Custom Operations without associated resources + +## 5.3.5 Notifications + +### 5.3.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.3.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|--------------|---------------------------------|--------------------------------------| +| Event Notification | {notificURI} | POST | Report one or several observed data. | +| Fetch Notification | {fetchUri} | POST | Fetch one or several notified data. | + +### 5.3.5.2 Event Notification + +#### 5.3.5.2.1 Description + +The Event Notification is used by the NWDAF to report one or several observed data to an NF service consumer that has subscribed to such Notifications. + +#### 5.3.5.2.2 Operation Definition + +Callback URI: **{notificURI}** + +The operation shall support the callback URI variables defined in Table 5.3.5.2.2-1, the request data structures specified in table 5.3.5.2.2-2 and the response data structure and response codes specified in Table 5.3.5.2.2-3. + +**Table 5.3.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|------------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificURI | Uri | The Notification Uri is assigned within the Individual NWDAF Data Management Subscription Resource and described within the NnwdafDataManagementSubsc type (see table 5.3.6.2.2-1). | + +**Table 5.3.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|-------------------------------------------| +| NnwdafDataManagementNotif | M | 1 | Provides Information about observed data. | + +**Table 5.3.5.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. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during the event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event 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 [6] 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 [6]). + +**Table 5.3.5.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 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 [6]. | +| 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.3.5.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 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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +### 5.3.5.3 Fetch Notification + +#### 5.3.5.3.1 Description + +The Fetch Notification is used by the NF service consumer to retrieve data from the NWDAF. + +#### 5.3.5.3.2 Target URI + +The Callback URI "{fetchUri}" shall be used with the callback URI variables defined in table 5.3.5.3.2-1. + +**Table 5.3.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 within the FetchInstruction data type. | + +#### 5.3.5.3.3 Standard Methods + +##### 5.3.5.3.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.5.3.3.1-1. + +**Table 5.3.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.3.5.3.3.1-2 and the response data structures and response codes specified in table 5.3.5.3.3.1-3. + +**Table 5.3.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.3.5.3.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------|---|-------------|------------------------|-------------------------------------------------------------------| +| NnwdafDataManagementNotification | M | 1 | 200 OK | The stored data related to the fetch correlation identifier(s). | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during subscription retrieval.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during subscription retrieval.
(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 [6] 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 [6]). + +**Table 5.3.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 of the resource located in an alternative NWDAF 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 [6]. | +| 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.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 of the resource located in an alternative NWDAF 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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected. | + +## 5.3.6 Data Model + +### 5.3.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.3.6.1-1 specifies the data types defined for the Nnwdaf\_DataManagement service based interface protocol. + +**Table 5.3.6.1-1: Nnwdaf\_DataManagement specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------------------|----------------|------------------------------------------------------------------------------------------------------------|---------------| +| NnwdafDataManagementSubsc | 5.3.6.2.2 | Represents an Individual NWDAF Data Management Subscription resource. | | +| NnwdafDataManagementNotif | 5.3.6.2.3 | Represents a notification that corresponds with an Individual NWDAF Data Management Subscription resource. | | +| PendingNotificationCause | 5.3.6.3.3 | Represents the Pending Notification Cause for the stored unsent events. | EnhDataMgmt | + +Table 5.3.6.1-2 specifies data types re-used by the Nnwdaf\_DataManagement 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 Nnwdaf\_DataManagement service based interface. + +**Table 5.3.6.1-2: Nnwdaf\_DataManagement re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|---------------------|-------------------------------------------------------------------------------------------|----------------| +| DataCollectionPurpose | 3GPP TS 29.574 [26] | Represents the purpose for data collection, e.g. analytics or model training. | | +| DataNotification | 3GPP TS 29.575 [27] | Represents data subscription notification from data source (e.g. AMF, SMF, UDM, NEF, AF). | | +| DataSubscription | 3GPP TS 29.575 [27] | Represents data subscription from data source (e.g. AMF, SMF, UDM, NEF, AF). | | +| DateTime | 3GPP TS 29.571 [8] | Identifies the time. | | +| DeletionAlert | 3GPP TS 29.574 [26] | Contains information about data that are about to be deleted. | EnhDataMgmt | +| FormattingInstruction | 3GPP TS 29.574 [26] | DCCF formatting Instructions. | | +| FetchInstruction | 3GPP TS 29.576 [28] | The fetch instruction indicates whether the data can be fetched by the consumer. | | +| NfInstanceId | 3GPP TS 29.571 [8] | NF instance identifier. | | +| NfSetId | 3GPP TS 29.571 [8] | NF set identifier. | | +| NnwdafEventsSubscription | 5.1.6.2.2 | Represents an NWDAF analytics subscription. | | +| NotifSummaryReport | 3GPP TS 29.574 [26] | Contains a summary report of processed notifications. | | +| NotifyEndpoint | 3GPP TS 29.574 [26] | The information of notification endpoint. | DataAnaCollect | +| NotifResponse | 3GPP TS 29.574 [26] | Contains information about the planned action upon receiving a notification. | EnhDataMgmt | +| ProcessingInstruction | 3GPP TS 29.574 [26] | DCCF processing Instructions. | | +| StorageHandlingInformation | 3GPP TS 29.574 [26] | Contains storage handling information for data or analytics. | EnhDataMgmt | +| SupportedFeatures | 3GPP TS 29.571 [8] | | | +| TimeWindow | 3GPP TS 29.122 [19] | Represents a time window. | | +| Uri | 3GPP TS 29.571 [8] | URI. | | + +## 5.3.6.2 Structured data types + +### 5.3.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +### 5.3.6.2.2 Type NnwdafDataManagementSubsc + +**Table 5.3.6.2.2-1: Definition of type NnwdafDataManagementSubsc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|------------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| adrflId | NfInstanceId | O | 0..1 | Identifier of the ADRF to be used by the NWDAF.
If the subscription is for runtime analytics (i.e. the "timePeriod" attribute is either absent or contains a time window in the future) then the NWDAF shall store the notifications in this ADRF.
If the subscription is for historical analytics (i.e. the "timePeriod" attribute contains a time window in the past) then the NWDAF shall retrieve the data from this ADRF. (NOTE 2) | | +| adrSetId | NfSetId | O | 0..1 | Identifier of the ADRF Set to be used by the NWDAF.
If the subscription is for runtime analytics (i.e. the "timePeriod" attribute is either absent or contains a time window in the future) then the NWDAF shall store the notifications in this ADRF Set.
If the subscription is for historical analytics (i.e. the "timePeriod" attribute contains a time window in the past) then the NWDAF shall retrieve the data from this ADRF Set. (NOTE 2) | | +| anaSub | NnwdafEventsSubscription | C | 0..1 | Analytics subscription information to be used by the NWDAF to determine the data that is relevant to these analytics and shall thus be collected and reported, i.e. the "anaSub" attribute may be provided when the consumer requests from the NWDAF data that it needs in order to compute the analytics that is specified by the "anaSub" attribute. (NOTE 1) | | +| checkedConsentInd | boolean | O | 0..1 | If set to "true", it indicates that the NF service consumer has already checked the user consent. The default value is "false". | UserConsent | +| dataCollectPurposes | array(DataCollectionPurpose) | O | 1..N | The purpose of data collection. This attribute may only be provided if user consent is required depending on local policy and regulations, and the consumer has not checked user consent. | | +| dataSub | DataSubscription | C | 0..1 | Subscribed data events. (NOTE 1) (NOTE 6) (NOTE 7) | | +| formatInstruct | FormattingInstruction | O | 0..1 | Formatting instructions to be used for sending event | | + +| | | | | | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | notifications. If provided, they take precedence over any potentially conflicting event reporting requirements provided within the "dataSub" attribute. | | +|--|--|--|--|---------------------------------------------------------------------------------------------------------------------------------------------------------|--| + +| | | | | | | +|-----------------|------------------------------|---|------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| notifURI | Uri | M | 1 | Notification target address. | | +| notifEndpoints | array(NotifyEndpoint) | O | 1..N | The additional information of notification target address and correlation identifier. | DataAnaCollect | +| procInstr | ProcessingInstruction | O | 0..1 | Processing instructions to be used for sending event notifications.
This attribute may only be provided if the "dataSub" attribute is provided.
(NOTE 4) | | +| multiProcInstrs | array(ProcessingInstruction) | O | 1..N | Processing instructions to be used for sending event notifications.
This attribute may only be provided if the "dataSub" attribute is provided.
(NOTE 4) | MultiProcessingInstruction | +| suppFeat | SupportedFeatures | C | 0..1 | This IE represents a list of Supported features as described in clause 5.3.8.
(NOTE 5) | | +| targetNfId | NfInstanceId | O | 0..1 | NF instance identifier to which the NWDAF shall create the requested subscription. (NOTE 2) | | +| targetNfSetId | NfSetId | O | 0..1 | NF set identifier to which the NWDAF shall create the requested subscription. (NOTE 2) | | +| timePeriod | TimeWindow | O | 0..1 | Represents a start time and a stop time during which data was collected or is requested to be collected. If this attribute is included, then the internal attributes of the data subscription that indicate a subscription duration (e.g. the "targetPeriod" attribute of an "eventSubs" attribute of an "smfDataSub" attribute, or the "monDur" attribute of the ReportingInformation data type) shall not be provided.
(NOTE 3) | | +| immReport | NnwdafDataManagementNotif | O | 0..1 | Immediate report including available NWDAF data management notification. May only be present in the response to a subscription request and only if the immediate reporting indication and formatting or processing instructions were included in the subscription request. | DataAnaCollect | +| storeHandl | StorageHandlingInformation | O | 0..1 | Contains storage handling information for the data that will be collected and stored in an ADRF based on the requested subscription. | EnhDataMgmt | + +NOTE 1: Exactly one of these attributes shall be provided. +NOTE 2: "targetNfId" and "targetNfSetId" are mutually exclusive. "adrId" and "adrSetId" are also mutually exclusive. +NOTE 3: It includes the time period either in the past or in the future (i.e., start time as past time and stop time as future time is not allowed). + +- NOTE 4: The "multiProcInstrs" attribute shall be used instead of the "procInstr" attribute when the "MultiProcessingInstruction" feature is supported. +- NOTE 5: It shall be present in the POST request if at least one feature defined in clause 5.3.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. +- NOTE 6: The event reporting information within the "dataSub" attribute (e.g. "eventsReplInfo" attribute in the case of AF events) may include muting instructions (e.g. within the "notifFlagInstr" attribute in the case of AF events) and/or muting notifications settings (e.g. within the "mutingSetting" attribute in the case of AF events) only if the EnhDataMgmt feature is supported. +- NOTE 7: The "upfDataSub" attribute within the "dataSub" attribute is applicable only if the "UpEvents" feature is supported. The "gmlcDataSub" attribute within the "dataSub" attribute is applicable only if the "LocEvents" feature is supported. + +## 5.3.6.2.3 Type NnwdafDataManagementNotif + +Table 5.3.6.2.3-1: Definition of type NnwdafDataManagementNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dataNotification | DataNotification | C | 0..1 | List of data subscription notifications.
(NOTE 1, NOTE 3, NOTE 4) | | +| dataReports | array(NotifSummaryReport) | C | 1..N | List of reports with summarized data from multiple notifications received from data producer. (NOTE 1)
(NOTE 2) | | +| delAlert | DeletionAlert | C | 0..1 | Information about analytics that is about to be deleted. This attribute may not be present in the response of a Fetch request. (NOTE 1) | EnhDataMgmt | +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| terminationReq | string | O | 0..1 | If set to "true", it indicates that the termination of the data management subscription is requested by the NWDAF, i.e. NWDAF will not provide further notifications related to this subscription. If absent, no termination is requested. | | +| fetchInstr | FetchInstruction | C | 0..1 | The fetch instruction indicates whether the data are to be fetched by the Consumer. This attribute may not be present in the response of a Fetch request.
(NOTE 1) | | +| notifTimestamp | DateTime | M | 1 | It represents time when NWDAF completes preparation of the requested data. | | +| pendNotifCause | PendingNotificationCause | O | 0..1 | Represents the Pending Notification Cause for the stored unsent data. | EnhDataMgmt | + +NOTE 1: One of these attributes shall be provided. +NOTE 2: For every entry of the array, the "eventId" attribute shall not contain the "nwdafEvent" attribute. +NOTE 3: If the NWDAF has received the notifications from another source without a timestamp, then the NWDAF adds itself a timestamp based on the time it received the notification in timeStamp attribute contained in dataNotification attribute. +NOTE 4: The "upfEventNotifs" attribute within the "dataNotification" attribute is applicable only if the "UpEvents" feature is supported. The "gmlcEventNotifs" attribute within the "dataNotification" attribute is applicable only if the "LocEvents" feature is supported. + +## 5.3.6.3 Simple data types and enumerations + +## 5.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. + +### 5.3.6.3.2 Simple data types + +The simple data types defined in table 5.3.6.3.2-1 shall be supported. + +**Table 5.3.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| n/a | | | | + +### 5.3.6.3.3 Enumeration: PendingNotificationCause + +**Table 5.3.6.3.3-1: Enumeration PendingNotificationCause** + +| Enumeration value | Description | Applicability | +|---------------------------|-----------------------------------------------------|---------------| +| UE_OUT_OF_NF_SERVING_AREA | Represents the UE moved out of the NF serving area. | | +| OTHER | Represents the other cause. | | + +## 5.3.7 Error handling + +### 5.3.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of TS 29.500 [6]. + +For the Nnwdaf\_DataManagement API, HTTP error responses shall be supported as specified in clause 4.8 of TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of TS 29.500 [6] 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 TS 29.500 [6]. In addition, the requirements in the following clauses shall apply. + +### 5.3.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_DataManagement API. + +### 5.3.7.3 Application Errors + +The application errors defined for the Nnwdaf\_DataManagement API are listed in table 5.3.7.3-1. + +**Table 5.3.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SUBSCRIPTION_CANNOT_BE_SERVED | 400 Bad Request | Indicates that the NWDAF cannot use the contents of the request to either a) determine whether the subscription can already be served or interactions with the ADRF and/or data sources are required or b) determine what interactions with the ADRF and/or data sources are required (if it has determined that they are required). | +| USER_CONSENT_NOT_GRANTED | 403 Forbidden | Indicates that the request shall be rejected because an impacted user has not provided the required user consent. | +| MUTING_INSTR_NOT_ACCEPTED | 403 Forbidden | Indicates that the muting instructions received by the NF service consumer cannot be accepted. | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +## 5.3.8 Feature negotiation + +The optional features in table 5.3.8-1 are defined for the Nnwdaf\_DataManagement API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.3.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | MultiProcessingInstruction | Indicates the support of multiple processing instructions. | +| 2 | UserConsent | Indicates the support of detailed handling of user consent, e.g. indications that user consent has been checked and error responses related to the lack of user consent. | +| 3 | DataAnaCollect | This feature indicates support for the enhancement of data and analytics collection. | +| 4 | EnhDataMgmt | Indicates the support of enhanced data management mechanisms, including supporting of pending notification, muting and storage handling. | +| 5 | UpEvents | Indicates the support of UPF events. | +| 6 | LocEvents | Indicates the support of location events. | + +## 5.3.9 Security + +As indicated in TS 33.501 [13] and TS 29.500 [6], the access to the Nnwdaf\_DataManagement 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 TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnwdaf\_DataManagement API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in TS 29.510 [12], 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 Nnwdaf\_DataManagement service. + +The Nnwdaf\_DataManagement API defines a single scope "nnwdaf-datamanagement" for the entire service, and it does not define any additional scopes at resource or operation level. + +# 5.4 Nnwdaf\_MLModelProvision Service API + +## 5.4.1 Introduction + +The Nnwdaf\_MLModelProvision service shall use the Nnwdaf\_MLModelProvision API. + +The API URI of the Nnwdaf\_MLModelProvision API shall be: + +{apiRoot}/apiVersion> + +The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}/apiVersion>/apiSpecificResourceUriPart> + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-mlmodelprovision". +- The shall be "v1". +- The shall be set as described in clause 5.4.3. + +## 5.4.2 Usage of HTTP + +### 5.4.2.1 General + +HTTP/2, IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_MLModelProvision is contained in Annex A. + +### 5.4.2.2 HTTP standard headers + +#### 5.4.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +#### 5.4.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 [6]. 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 [15]. + +### 5.4.2.3 HTTP custom headers + +The Nnwdaf\_MLModelProvision service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_MLModelProvision service API. + +## 5.4.3 Resources + +### 5.4.3.1 Resource Structure + +This clause describes the structure for the Resource URIs and the resources and methods used for the service. + +Figure 5.4.3.1-1 depicts the resource URIs structure for the Nnwdaf\_MLModelProvision API. + +![Diagram showing the resource URI structure for the Nnwdaf_MLModelProvision API. The root URI is {apiRoot}/nnwdaf-mlmodelprovision/. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subscriptionId}.](7afb1fd052c6df368128542f16088890_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnwdaf-mlmodelprovision/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the resource URI structure for the Nnwdaf\_MLModelProvision API. The root URI is {apiRoot}/nnwdaf-mlmodelprovision/. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subscriptionId}. + +**Figure 5.4.3.1-1: Resource URI structure of the Nnwdaf\_MLModelProvision API** + +Table 5.4.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.4.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------------|---------------------------------|---------------------------------|-------------------------------------------------------------------------------------------------------------------| +| NWDAF ML Model Provision Subscriptions | /subscriptions | POST | Creates a new Individual NWDAF ML Model Provision Subscription resource. | +| Individual NWDAF ML Model Provision Subscription | /subscriptions/{subscriptionId} | DELETE | Deletes an Individual NWDAF ML Model Provision Subscription identified by subresource {subscriptionId}. | +| | | PUT | Modifies an existing Individual NWDAF ML Model Provision Subscription identified by subresource {subscriptionId}. | + +## 5.4.3.2 Resource: NWDAF ML Model Provision Subscriptions + +### 5.4.3.2.1 Description + +The NWDAF ML Model Provision Subscriptions resource represents all subscriptions to the Nnwdaf\_MLModelProvision service at a given NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF ML Model Provision Subscription resource. + +### 5.4.3.2.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-mlmodelprovision//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 this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.4.1 | + +### 5.4.3.2.3 Resource Standard Methods + +#### 5.4.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.4.3.2.3.1-1. + +**Table 5.4.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.4.3.2.3.1-2 and the response data structures and response codes specified in table 5.4.3.2.3.1-3. + +**Table 5.4.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|--------------------------------------------------------------------------| +| NwdafMLModelProvSubsc | M | 1 | Creates a new Individual NWDAF ML Model Provision Subscription resource. | + +**Table 5.4.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| NwdaifMLModelProvSubsc | M | 1 | 201 Created | The creation of an Individual NWDAF ML Model Provision Subscription resource is confirmed and a representation of that resource is returned. | +| ProblemDetails | O | 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.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure causes are described in subclause 5.4.7.3. + +**Table 5.4.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}/nnwdaif-mlmodelprovision//subscriptions/{subscriptionId} | + +#### 5.4.3.2.4 Resource Custom Operations + +None in this release of the specification. + +### 5.4.3.3 Resource: Individual NWDAF ML Model Provision Subscription + +#### 5.4.3.3.1 Description + +The Individual NWDAF ML Model Provision Subscription resource represents a single subscription to the Nnwdaif\_MLModelProvision service at a given NWDAF. + +#### 5.4.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaif-mlmodelprovision//subscriptions/{subscriptionId} + +The shall be set as described in clause 5.4.1. + +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 this resource** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------------| +| apiRoot | string | See clause 5.4.1. | +| subscriptionId | string | Identifies a subscription to the Nnwdaif_MLModelProvision service. | + +#### 5.4.3.3.3 Resource Standard Methods + +##### 5.4.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 5.4.3.3.3.1-1. + +**Table 5.4.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 5.4.3.3.3.1-2 and the response data structures and response codes specified in table 5.4.3.3.3.1-3. + +**Table 5.4.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|-----------------------------------------------------------------------------------------| +| NwdafMLModelProvSubsc | M | 1 | Parameters to replace a subscription to NWDAF ML Model Provision Subscription resource. | + +**Table 5.4.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| NwdafMLModelProvSubsc | M | 1 | 200 OK | The Individual NWDAF ML Model Provision Subscription resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF ML Model Provision Subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF ML Model Provision Subscription modification.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF ML Model Provision Subscription modification.
(NOTE 3) | +| ProblemDetails | O | 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.7.1-1 of 3GPP TS 29.500 [6] also apply. + +NOTE 2: Failure causes are described in subclause 5.4.7.3. + +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.4.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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.4.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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +## 5.4.3.3.3.2 + +## DELETE + +This method shall support the URI query parameters specified in table 5.4.3.3.3.2-1. + +**Table 5.4.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.4.3.3.3.2-2 and the response data structures and response codes specified in table 5.4.3.3.3.2-3. + +**Table 5.4.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.4.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 NWDAF ML Model Provision Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF ML Model Provision Subscription deletion.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF ML Model Provision Subscription deletion.

(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 [6] 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 [6]). + +**Table 5.4.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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.4.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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.4.3.3.4 Resource Custom Operations + +None in this release of the specification. + +### 5.4.4 Custom Operations without associated resources + +None in this release of the specification. + +### 5.4.5 Notifications + +#### 5.4.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.4.3.4.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|--------------|---------------------------------|----------------------------------------| +| Event Notification | {notifUri} | POST | Report one or several observed Events. | + +#### 5.4.5.2 Event Notification + +##### 5.4.5.2.1 Description + +The Event Notification is used by the NWDAF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications via the Individual NWDAF ML Model Provision Subscription Resource. + +#### 5.4.5.2.2 Operation Definition + +Callback URI: {notifUri} + +The operation shall support the callback URI variables defined in table 5.4.5.2.2-1, the request data structures specified in table 5.4.5.2.2-2 and the response data structure and response codes specified in table 5.4.5.2.2-3. + +**Table 5.4.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned within the Individual NWDAF ML Model Provision Subscription and described within the NwdafMLModelProvSubsc type (see table 5.4.6.2.2-1). | + +**Table 5.4.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|---------------------------------------------| +| array(NwdafMLModelProvNotif) | M | 1..N | Provides Information about observed events. | + +**Table 5.4.5.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. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during the event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event 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 [6] 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 [6]). + +**Table 5.4.5.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 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 [6]. | +| 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.4.5.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 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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected | + +## 5.4.6 Data Model + +### 5.4.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.4.6.1-1 specifies the data types defined for the Nnwdaf\_MLModelProvision service based interface protocol. + +**Table 5.4.6.1-1: Nnwdaf\_MLModelProvision specific Data Types** + +| Data type | Section defined | Description | Applicability | +|------------------------------|-----------------|------------------------------------------------------------------|----------------------------------------| +| AdditionalMLModelInformation | 5.4.6.2.14 | Represents the additional ML Model Information | ModelProvisionExt | +| FailureEventInfoForMLModel | 5.4.6.2.7 | | | +| InputDataInfo | 5.4.6.2.12 | Represents the metrics of the input data. | ModelProvisionExt | +| InferenceDataForModelTrain | 5.4.6.2.17 | Indicates the inference data stored in ADRF. | ModelProvisionExt | +| MLEventNotif | 5.4.6.2.6 | | | +| MLEventSubscription | 5.4.6.2.3 | | | +| MLModelAddr | 5.4.6.2.8 | | | +| MLModelAdrf | 5.4.6.2.15 | Represents the ADRF (Set) information of ML Model. | ModelProvisionExt | +| MLModelMetric | 5.4.6.2.9 | Indicates the ML model metric. | FederatedLearning
ModelProvisionExt | +| MLModelStatus | 5.4.6.2.10 | Indicates the pre-determined status of the ML model or training. | FederatedLearning | +| MLRepEventCondition | 5.4.6.2.11 | Indicates the ML event reporting condition. | FederatedLearning
ModelProvisionExt | +| ModelProvisionParamsExt | 5.4.6.2.13 | Represents extended model provision parameters. | ModelProvisionExt | +| NnwdafMLModelProvNotif | 5.4.6.2.5 | | | +| NnwdafMLModelProvSubsc | 5.4.6.2.2 | | | +| TrainInputDataInfo | 5.4.6.2.16 | Represents training input data information. | ModelProvisionExt | + +Table 5.4.6.1-2 specifies data types re-used by the Nnwdaf\_MLModelProvision 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 Nnwdaf\_MLModelProvision service based interface. + +**Table 5.4.6.1-2: Nnwdaf\_MLModelProvision re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|---------------------------------------------------------------------------|----------------------| +| Accuracy | 5.1.6.3.5 | Represents accuracy levels of interest for ML models | ModelProvisionExt | +| DateTime | 3GPP TS 29.571 [8] | Identifies the time. | | +| DccfEvent | 3GPP TS 29.574 [26] | Identifies the input data event. | ModelProvisionExt | +| EventFilter | 5.2.6.2.3 | Identifies the filter for the subscribed event. | | +| NetworkAreaInfo | 3GPP TS 29.554 [18] | Identifies the network area. | | +| NwdafEvent | 5.1.6.3.4 | | | +| NfInstanceId | 3GPP TS 29.571 [8] | Identifies an NF instance. | ModelProvisionExt | +| NfSetId | 3GPP TS 29.571 [8] | Identifies an NF Set. | ModelProvisionExt | +| RedirectResponse | 3GPP TS 29.571 [8] | | | +| ReportingInformation | 3GPP TS 29.523 [20] | Represents the requirements of reporting the subscription. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | | | +| TargetUeInformation | 5.1.6.2.8 | | | +| TimeWindow | 3GPP TS 29.122 [19] | | | +| Uinteger | 3GPP TS 29.571 [8] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. | ModelProvisionExt | +| Uri | 3GPP TS 29.571 [8] | | | +| VendorId | 3GPP TS 29.510 [12] | Represents the Vendor ID. | ModelSharing | + +## 5.4.6.2 Structured data types + +### 5.4.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.4.6.2.2 Type NwdafMLModelProvSubsc + +Table 5.4.6.2.2-1: Definition of type NwdafMLModelProvSubsc + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-----------------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mLEventSubscs | array(MLEventSubscription) | M | 1..N | Each element identifies the subscription for each event. | | +| notifUri | Uri | M | 1 | Identifies the recipient of Notifications sent by the NWDAF. | | +| mLEventNotifs | array(MLEventNotif) | C | 1..N | Notifications about Individual Events.
Shall only be present if the immediate reporting indication in the "immRep" attribute within the "eventReq" attribute sets to true in the event subscription, and the reports are available. | | +| suppFeats | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.4.8.
It shall be supplied by NF service consumer in the POST requests that request the creation of an NWDAF ML Model Provision Subscriptions resource, and shall be supplied by the NWDAF in the reply of corresponding request. | | +| notifCorrId | string | O | 0..1 | The value of Notification Correlation ID in the corresponding notification. | | +| eventReq | ReportingInformation | O | 0..1 | Reporting requirement information of the subscription.
If omitted, the default values within the ReportingInformation data type apply. | | +| failEventReports | array(FailureEventInfoForMLModel) | O | 1..N | Supplied by the NWDAF containing MTLF when available, shall contain the event(s) that the subscription is not successful including the failure reason(s). | | + +## 5.4.6.2.3 Type MLEventSubscription + +Table 5.4.6.2.3-1: Definition of type MLEventSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------| +| mLEvent | NwdafEvent | M | 1 | Identifies the subscribed event. | | +| mLEventFilter | EventFilter | M | 1 | Identifies the analytics filter for the subscribed event. | | +| tgtUe | TargetUeInformation | O | 0..1 | Identifies target UE information | | +| mLTargetPeriod | TimeWindow | O | 0..1 | Indicates the time interval for which the ML model for the analytics is requested. | | +| timeModelNeeded | DateTime | O | 0..1 | UTC time indicating the time when the ML model is needed. | ModelProvisionExt
FederatedLearning | +| expiryTime | DateTime | O | 0..1 | Indicates the time when the subscription expired. | | +| mlEvRepCon | MLRepEventCondition | O | 0..1 | Indicates the ML event reporting condition. This attribute can be provided when the "notifMethod" attribute within the ReportingInformation structure is set to "ON_EVENT_DETECTION" in the "eventReq" attribute within the NwdafMLModelProvSubsc data type. | FederatedLearning
ModelProvisionExt | +| modelInterInfo | string | O | 0..1 | Represents the ML Model Interoperability Information. This is vendor-specific information and is agreed between vendors, if necessary for sharing purposes.
The format of value is out of 3GPP. | ModelSharing | +| nfConsumerInfo | VendorId | O | 0..1 | Identifies a vendor. Vendor ID of the NF Service Consumer instance, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [30]. | ModelSharing | +| modelProvExt | ModelProvisionParamsExt | O | 0..1 | Extended ML model provisioning parameters. | ModelProvisionExt | +| useCaseCxt | string | O | 0..1 | Indicates the context of usage of the analytics. The value and format of this parameter are not standardized. | ENAExt | +| inferDataForModel | InferenceDataForModelTrain | O | 0..1 | Indicates the inference data stored in ADRF which can be used by MTLF to retrain or reprovision of the ML model. | ModelProvisionExt | + +## 5.4.6.2.4 Void + +## 5.4.6.2.5 Type NwdafMLModelProvNotif + +**Table 5.4.6.2.5-1: Definition of type NwdafMLModelProvNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------------|---|-------------|--------------------------------------------------------------------------|---------------| +| eventNotifs | array(MLEventNotif) | M | 1..N | Notifications about Individual Events | | +| subscriptionId | string | M | 1 | String identifying a subscription to the Nnwdaf_MLModelProvision Service | | + +## 5.4.6.2.6 Type MLEventNotif + +**Table 5.4.6.2.6-1: Definition of type MLEventNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------| +| event | NwdafEvent | M | 1 | Identifies the subscribed event. | | +| notifCorrelId | string | O | 0..1 | Notification correlation ID used to identify the subscription to which the notification relates. It shall be set to the same value as the "notifCorrelId" attribute of NwdafMLModelProvSubsc data type. | | +| mlFile | string | O | 0..1 | Indicates the ML model file. The format of value is out of 3GPP. This attribute is not applicable in the Nnwdaf_MLModelProvision API. | | +| mlFileAddr | MLModelAddr | C | 0..1 | Indicates the address (e.g. a URL or an FQDN) of the ML model file. (NOTE 1, NOTE 2) | | +| mlModelAdrf | MLModelAdrf | C | 0..1 | Indicates the ADRF (Set) information of the ML Model. (NOTE 2) | ModelProvisionExt | +| validityPeriod | TimeWindow | O | 0..1 | Indicates the time period when the provided ML model applies. (NOTE 1) | | +| spatialValidity | NetworkAreaInfo | O | 0..1 | Indicates the area where the provided ML model applies. (NOTE 1) | | +| addModelInfo | array(AdditionalMLModelInformation) | O | 1..N | Indicates the additional ML Model Information. (NOTE 1) | ModelProvisionExt | + +NOTE 1: If the "addModelInfo" attribute is provided, then the attributes "validityPeriod" and "spatialValidity" shall not be provided and the value of the "mlFileAddr" attribute of the MLEventNotif data type shall be ignored. + +NOTE 2: If the "ModelProvisionExt" feature is supported, one of the "mlFileAddr" or "mlModelAdrf" attribute shall be provided. + +## 5.4.6.2.7 Type FailureEventInfoForMLModel + +Table 5.1.6.2.7-1: Definition of type FailureEventInfoForMLModel + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|--------------------------------|---------------| +| event | NwdafEvent | M | 1 | Event that is subscribed. | | +| failureCode | FailureCode | M | 1 | Identifies the failure reason. | | + +## 5.4.6.2.8 Type MLModelAddr + +Table 5.4.6.2.8-1: Definition of type MLModelAddr + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------|---------------| +| mlModelUrl | Uri | C | 0..1 | The URL of the ML Model file.
(NOTE) | | +| mlFileFqdn | string | C | 0..1 | The FQDN of the ML Model file.
(NOTE) | | + +NOTE: One of the "mlModelUrl" and "mlFileFqdn" attributes shall be provided. + +## 5.4.6.2.9 Void + +## 5.4.6.2.10 Void + +## 5.4.6.2.11 Type MLRepEventCondition + +Table 5.4.6.2.11-1: Definition of type MLRepEventCondition + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mlTrainRound | UInteger | O | 0..1 | Indicates the report shall occur when the number of training round is a multiple of the value set for the attribute. | | +| mlTrainRepTime | TimeWindow | O | 0..1 | Indicates the report shall occur when every training time interval is achieved. | | +| mlAccuracyThreshold | UInteger | O | 0..1 | Indicates the report shall occur when the ML model accuracy is crossing the ML Model Accuracy threshold of the value set for the attribute, i.e., the accuracy either becomes higher or lower than the value set for the attribute. | | +| modelMetric | MLModelMetric | O | 0..1 | Indicates the ML model metric. | | + +## 5.4.6.2.12 Type InputDataInfo + +**Table 5.4.6.2.12-1: Definition of type TrainInputInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| inpEvent | DccfEvent | M | 1 | Identifies the input data event to which the information applies. | | +| maxNumSamples | UInteger | O | 0..1 | Maximum number of samples that have been taken to train an ML model. | | +| maxTimeInterval | UInteger | O | 0..1 | Maximum time interval between samples that are used to train an ML model. | | +| nfInstanceIds | array(NfInstanceId) | O | 1..N | NF instance identifiers of the used data sources. | | +| nfSetIds | array(NfSetId) | O | 1..N | NF set identifiers of the used data sources. | | +| ratio | UInteger | O | 0..1 | Sampling ratio, indicates the percentage of the available data values that are used by this ML model (for training or inference).
Minimum = 0. Maximum = 100. | | + +## 5.4.6.2.13 Type ModelProvisionParamsExt + +Table 5.4.6.2.13-1: Definition of type ModelProvisionParamsExt + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| modelInterInfo | string | O | 0..1 | Represents the ML Model Interoperability Information. This is vendor-specific information and is agreed between vendors, if necessary for sharing purposes. The format of value is out of 3GPP. | | +| reqRepRatio | UInteger | O | 0..1 | Minimum percentage of UEs whose data is used for training an ML model when the target of ML model reporting is a group of UEs. Minimum = 0. Maximum = 100. | | +| inferInpDataInfos | array(InputDataInfo) | O | 1..N | The metrics of input data that are expected to be used by NWDAF containing AnLF during inference. | | +| multModelsInd | boolean | O | 0..1 | If provided and set to "true", it indicates that the NF service consumer supports receiving multiple ML models. If omitted or set to "false" the NF service consumer does not support multiple ML models. The default value is false. | | +| numModels | UInteger | O | 0..1 | Maximum number of ML models that the consumer supports to receive for a specific analytics ID. It may only be provided if the "multModelInd" attribute is provided and set to "true". | | +| accuLevels | array(Accuracy) | O | 1..N | Provided accuracy levels of interest for ML models. | | + +## 5.4.6.2.14 Type AdditionalMLModelInformation + +Table 5.4.6.2.14-1: Definition of type AdditionalMLModelInformation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mLFileAddr | MLModelAddr | M | 1 | Indicates the address (e.g. a URL or an FQDN) of the ML model file. | | +| mLModelAdrf | MLModelAdrf | O | 0..1 | Indicates the ADRF (Set) information of the ML Model. | | +| validityPeriod | TimeWindow | O | 0..1 | Indicates the time period when the provided ML model applies. | | +| spatialValidity | NetworkAreaInfo | O | 0..1 | Indicates the area where the provided ML model applies. | | +| modelUniqueId | UInteger | O | 0..1 | Unique identifier for an ML model. The identifier shall be unique within 5GC scope. | | +| modelRepRatio | UInteger | O | 0..1 | Indicating the percentage of UEs in the group that is used to train an ML model when target of ML model reporting is a group of UEs. | | +| mlDegradInd | boolean | O | 0..1 | Set to "true" to indicate that the ML model is degraded.

Set to "false" to indicate that the ML model is not degraded.

Default value is "false" if omitted. | | +| trainInpInfos | array(TrainInputInfo) | O | 1..N | Training input data information that is used by NWDAF containing MTLF during training. | | +| modelMetric | MLModelMetric | O | 0..1 | Indicates the ML model metric. | | +| accMLModel | UInteger | O | 0..1 | Indicates the accuracy value of the ML model.
Minimum = 0. Maximum = 100. | | + +## 5.4.6.2.15 Type MLModelAdrf + +Table 5.4.6.2.15-1: Definition of type MLModelAdrf + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------|---------------| +| adrfId | NfInstanceId | C | 0..1 | Identifier of the ADRF.
(NOTE) | | +| adrfSetId | NfSetId | C | 0..1 | Identifier of the ADRF Set.
(NOTE) | | +| storTransId | string | O | 0..1 | Indicates Storage Transaction ID, may be provided when "adrfId" or "adrfSetId" attribute is provisioned. | | + +NOTE: One of "adrfId" and "adrfSetId" attributes shall be provided. + +## 5.4.6.2.16 Type TrainInputDataInfo + +**Table 5.4.6.2.16-1: Definition of type TrainInputDataInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dataInfo | InputDataInfo | O | 0..1 | The metrics of input data that has been used by NWDAF containing MTLF during training. | | +| time | TimeWindow | O | 0..1 | Indicates the time interval during which the data was obtained from the data source NFs. | | +| dataStatisticsInfos | string | O | 0..1 | Indicates the statistics information of the data identified by "dataInfo" attribute, e.g. data range including maximum and minimum values, mean and standard deviation and data distribution when applicable. | | + +Editor's note: The data type of "dataStatisticsInfos" attribute is FFS. + +## 5.4.6.2.17 Type InferenceDataForModelTrain + +**Table 5.4.6.2.17-1: Definition of type InferenceDataForModelTrain** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| adrflId | NfInstanceId | C | 0..1 | Identifier of the ADRF. (NOTE) | | +| adrSetId | NfSetId | C | 0..1 | Identifier of the ADRF Set. (NOTE) | | +| dataSetTag | DataSetTag | O | 0..1 | Data set tag of the data stored in ADRF which can be used by MTLF. | | +| modelId | UInteger | O | 0..1 | ML model Identifier. Indicates the model that the data corresponding to the DataSetTag is related to. This attribute may be present only in a subscription modification request. | | + +NOTE: One of "adrflId" and "adrSetId" attributes shall be provided. + +## 5.4.6.3 Simple data types and enumerations + +## 5.4.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.4.6.3.2 Simple data types + +The simple data types defined in table 5.1.6.3.2-1 shall be supported. + +**Table 5.4.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | +| | | | | + +#### 5.4.6.3.3 Enumeration: FailureCode + +**Table 5.4.6.3.3-1: Enumeration FailureCode** + +| Enumeration value | Description | Applicability | +|--------------------------|----------------------------------------------------------------|---------------| +| UNAVAILABLE_ML_MODEL_DEL | Indicates the requested ML model for the event is unavailable. | | + +#### 5.4.6.3.4 Enumeration: MLModelMetric + +**Table 5.4.6.3.4-1: Enumeration MLModelMetric** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------|---------------| +| ACCURACY | ML Model Accuracy metric. | | + +### 5.4.7 Error handling + +#### 5.4.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [6]. + +For the Nnwdaf\_MLModelProvision API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [7]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] 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 [6]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] for HTTP redirections shall be supported. + +In addition, the requirements in the following clauses shall apply. + +#### 5.4.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_MLModelProvision API. + +#### 5.4.7.3 Application Errors + +The application errors defined for the Nnwdaf\_MLModelProvision API are listed in table 5.4.7.3-1. + +**Table 5.4.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------|-------------------------------------------------------------| +| UNAVAILABLE_ML_MODEL_FOR_ALLEVEMENTS | 500 Internal Server Error | Indicates the requested all events ML model is unavailable. | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +### 5.4.8 Feature negotiation + +The optional features in table 5.4.8-1 are defined for the Nnwdaf\_MLModelProvision API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.4.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | FederatedLearning | Indicates the support of Federated Learning. | +| 2 | ModelSharing | This feature indicates the support of ML model sharing. | +| 3 | ENAExt | This feature indicates support for the general enhancements of network data analytics requirements, including support for use case context sent by the NF service consumer to the NWDAF. | +| 4 | ModelProvisionExt | This feature indicates support for the Model Provision Extension, including support for provisioning the ML model file address (e.g. URL or FQDN) or ADRF (Set) ID and additional ML Model Information to the NF service consumer. | + +## 5.4.9 Security + +As indicated in 3GPP TS 33.501 [13] and 3GPP TS 29.500 [6], the access to the Nnwdaf\_MLModelProvision 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 [12]) plays the role of the authorization server. + +If OAuth2 is used, a n NF Service Consumer, prior to consuming services offered by the Nnwdaf\_MLModelProvision API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], 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 Nnwdaf\_MLModelProvision service. + +The Nnwdaf\_MLModelProvision API defines a single scope "nnwdaf-mlmodelprovision" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 5.5 Nnwdaf\_MLModelTraining Service API + +### 5.5.1 Introduction + +The Nnwdaf\_MLModelTraining service shall use the Nnwdaf\_MLModelTraining API. + +The API URI of the Nnwdaf\_MLModelTraining API shall be: + +**{apiRoot}** + +The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-mlmodeltraining". +- The shall be "v1". +- The shall be set as described in clause 5.5.3. + +### 5.5.2 Usage of HTTP + +#### 5.5.2.1 General + +HTTP/2, IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_ MLModelTraining is contained in Annex A. + +## 5.5.2.2 HTTP standard headers + +### 5.5.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +### 5.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 [6]. 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 [15]. + +## 5.5.2.3 HTTP custom headers + +The Nnwdaf\_ MLModelTraining service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_ MLModelTraining service API. + +## 5.5.3 Resources + +### 5.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.5.3.1-1 depicts the resource URIs structure for the Nnwdaf\_ MLModelTraining API. + +![Diagram showing the resource URI structure for the Nnwdaf_ MLModelTraining API. The root URI is {apiRoot}/nnwdaf-mlmodeltraining/. It branches to /subscriptions, which further branches to /{subscriptionId}.](c54223b4f1a31104507af83ef6ee5392_img.jpg) + +``` +graph TD; Root["{apiRoot}/nnwdaf-mlmodeltraining/"] --- Subscriptions["/subscriptions"]; Subscriptions --- SubscriptionId["/{subscriptionId}"]; +``` + +Diagram showing the resource URI structure for the Nnwdaf\_ MLModelTraining API. The root URI is {apiRoot}/nnwdaf-mlmodeltraining/. It branches to /subscriptions, which further branches to /{subscriptionId}. + +**Figure 5.5.3.1-1: Resource URI structure of the Nnwdaf\_ MLModelTraining API** + +Table 5.5.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.5.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------------------------|---------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------| +| NWDAF ML Model Training Subscriptions | /subscriptions | POST | Creates a new Individual NWDAF ML Model Training Subscription resource. | +| Individual NWDAF ML Model Training Subscription | /subscriptions/{subscriptionId} | DELETE | Deletes an Individual NWDAF ML Model Training Subscription identified by subresource {subscriptionId}. | +| | | PUT | Modifies an existing Individual NWDAF ML Model Training Subscription identified by subresource {subscriptionId}. | +| | | PATCH | Partial update of an existing Individual NWDAF ML Model Training Subscription identified by subresource {subscriptionId}. | + +### 5.5.3.2 Resource: NWDAF ML Model Training Subscriptions + +#### 5.5.3.2.1 Description + +The NWDAF ML Model Training Subscriptions resource represents all subscriptions to the Nnwdaf\_MLModelTraining service at a given NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF ML Model Training Subscription resource. + +#### 5.5.3.2.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-mlmodeltraining//subscriptions + +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 this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.5.1 | + +#### 5.5.3.2.3 Resource Standard Methods + +##### 5.5.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.5.3.2.3.1-1. + +**Table 5.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.5.3.2.3.1-2 and the response data structures and response codes specified in table 5.5.3.2.3.1-3. + +**Table 5.5.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|-------------------------------------------------------------------------| +| NwdafMLModelTrainSubsc | M | 1 | Creates a new Individual NWDAF ML Model Training Subscription resource. | + +**Table 5.5.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| NwdafMLModelTrainSubsc | M | 1 | 201 Created | The creation of an Individual NWDAF ML Model Training Subscription resource is confirmed and a representation of that resource is returned. | +| ProblemDetails | O | 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.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure causes are described in subclause 5.5.7.3. + +**Table 5.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}/nnwdaf-mlmodeltraining//subscriptions/{subscriptionId} | + +## 5.5.3.2.4 Resource Custom Operations + +None in this release of the specification. + +## 5.5.3.3 Resource: Individual NWDAF ML Model Training Subscription + +### 5.5.3.3.1 Description + +The Individual NWDAF ML Model Training Subscription resource represents a single subscription to the Nnwdaf\_MLModelTraining service at a given NWDAF. + +### 5.5.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-mlmodeltraining//subscriptions/{subscriptionId} + +The shall be set as described in clause 5.5.1. + +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 this resource** + +| Name | Data type | Definition | +|----------------|-----------|------------------------------------------------------------------| +| apiRoot | string | See clause 5.5.1. | +| subscriptionId | string | Identifies a subscription to the Nnwdaf_MLModelTraining service. | + +### 5.5.3.3.3 Resource Standard Methods + +#### 5.5.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 5.5.3.3.3.1-1. + +**Table 5.5.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 5.5.3.3.3.1-2 and the response data structures and response codes specified in table 5.5.3.3.3.1-3. + +**Table 5.5.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------|---|-------------|----------------------------------------------------------------------------------------| +| NwdafMLModelTrainSubsc | M | 1 | Parameters to replace a subscription to NWDAF ML Model Training Subscription resource. | + +**Table 5.5.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NwdafMLModelTrainSubsc | M | 1 | 200 OK | The Individual NWDAF ML Model Training Subscription resource was modified successfully, and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF ML Model Training Subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF ML Model Training Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF ML Model Trainin Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. | +| ProblemDetails | O | 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.7.1-1 of 3GPP TS 29.500 [6] also apply. + +NOTE 2: Failure causes are described in subclause 5.5.7.3. + +**Table 5.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 | An alternative URI of the resource located in an alternative NWDAF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected | + +**Table 5.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 | An alternative URI of the resource located in an alternative NWDAF (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.5.3.3.3.2 PATCH + +#### PATCH + +This method shall support the URI query parameters specified in table 5.5.3.3.3.2-1. + +**Table 5.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.5.3.3.3.2-2 and the response data structures and response codes specified in table 5.5.3.3.3.2-3. + +**Table 5.5.3.3.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|--------------------------------------------------------------------------------------------------| +| NwdafMLModelTrainSubscPatch | M | 1 | Partial update of parameters to a subscription to NWDAF ML Model Training Subscription resource. | + +**Table 5.5.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------|---|-------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NwdafMLModelTrainSubsc | M | 1 | 200 OK | The Individual NWDAF ML Model Training Subscription resource was partial modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF ML Model Training Subscription resource was partial modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF ML Model Training Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF ML Model Trainin Subscription modification. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. | +| ProblemDetails | O | 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.7.1-1 of 3GPP TS 29.500 [6] also apply. + +NOTE 2: Failure causes are described in subclause 5.5.7.3. + +**Table 5.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 | An alternative URI of the resource located in an alternative NWDAF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected | + +**Table 5.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 | An alternative URI of the resource located in an alternative NWDAF (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.5.3.3.3.3 DELETE + +This method shall support the URI query parameters specified in table 5.5.3.3.3.3-1. + +**Table 5.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.5.3.3.3.3-2 and the response data structures and response codes specified in table 5.5.3.3.3.3-3. + +**Table 5.5.3.3.3.3-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| | | | | + +**Table 5.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 NWDAF ML Model Training Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF ML Model Training Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF ML Model Training Subscription deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative NWDAF (service) instance. | + +NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. + +**Table 5.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 | An alternative URI of the resource located in an alternative NWDAF (service) instance. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the request is redirected | + +**Table 5.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 | An alternative URI of the resource located in an alternative NWDAF (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.5.3.3.4 Resource Custom Operations + +None in this release of the specification. + +## 5.5.4 Custom Operations without associated resources + +None in this release of the specification. + +## 5.5.5 Notifications + +### 5.5.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.5.3.4.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|--------------|---------------------------------|----------------------------------------| +| Event Notification | {notifUri} | POST | Report one or several observed Events. | + +### 5.5.5.2 Event Notification + +#### 5.5.5.2.1 Description + +The Event Notification is used by the NWDAF to report one or several observed Events to a NF service consumer that has subscribed to such Notifications via the Individual NWDAF ML Model Training Subscription Resource. + +#### 5.5.5.2.2 Operation Definition + +Callback URI: {notifUri} + +The operation shall support the callback URI variables defined in table 5.5.5.2.2-1, the request data structures specified in table 5.5.5.2.2-2 and the response data structure and response codes specified in table 5.5.5.2.2-3. + +**Table 5.5.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri as assigned within the Individual NWDAF ML Model Training Subscription and described within the NwdafMLModelTrainSubsc type (see table 5.5.6.2.2-1). | + +**Table 5.5.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------------|---|-------------|---------------------------------------------| +| array(NwdafMLModelTrainNotif) | M | 1..N | Provides Information about observed events. | + +**Table 5.5.5.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. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during the event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative NF consumer (service) instance where the notification should be sent. | +| ProblemDetails | O | 0..1 | 403 Forbidden | (NOTE 2) | +| ProblemDetails | O | 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.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure cases are described in subclause 5.5.7.3. + +**Table 5.5.5.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 NF consumer (service) instance towards which the notification should be redirected. | +| 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.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 NF consumer (service) instance towards which the notification should be redirected. | +| 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.6 Data Model + +### 5.5.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.5.6.1-1 specifies the data types defined for the Nnwdaf\_MLModelTraining service-based interface protocol. + +**Table 5.5.6.1-1: Nnwdaf\_MLModelTraining specific Data Types** + +| Data type | Section defined | Description | Applicability | +|---------------------------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------| +| DataAvReq | 5.5.6.2.10 | Represents the requirement on available data for the ML model training. | | +| DelayEventNotif | 5.5.6.2.11 | Indicates that the NWDAF containing MTLF is not able to complete the training of ML model within the maximum response time, the cause code, and the expected time complete the training. | | +| FailureCodeTrain | 5.5.6.3.3 | Identifies the failure reason. | | +| FailureEventInfoForMLModelTrain | 5.5.6.2.7 | Represents the failure event information for a ML Model Training subscription. | | +| NnwdafMLModelTrainSubsc | 5.5.6.2.2 | Represents a ML Model Training subscription. | | +| NnwdafMLModelTrainSubscPatch | 5.5.6.2.3 | Represents parameters to request the modification of a ML Model Training subscription. | | +| MLModelInfo | 5.5.6.2.4 | Represents the ML Model information. | | +| MLModelTrainInfo | 5.5.6.2.5 | Represents the ML Model training information, include requirement on data availability and time availability, training filter information. | | +| NnwdafMLModelTrainNotif | 5.5.6.2.8 | Represents notification of a ML Model Training subscription. | | +| MLTrainReportInfo | 5.5.6.2.6 | Indicates the training reporting information. | | +| StatusReportInfo | 5.5.6.2.12 | Indicates status information generated by the NWDAF containing MTLF during ML model training. | | +| TermMLModelTrainInfo | 5.5.6.2.9 | Indicates that the subscription is requested to be terminated, contain the reasons. | | +| TermTrainCause | 5.5.6.3.4 | Represents the reasons that the ML Model Training to be terminated. | | +| TrainDataInfo | 5.5.6.2.13 | Represents the training input data information. | | + +Table 5.5.6.1-2 specifies data types re-used by the Nnwdaf\_MLModelTraining 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 Nnwdaf\_MLModelTraining service-based interface. + +**Table 5.5.6.1-2: Nnwdaf\_MLModelTraining re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------------|---------------------|---------------------------------------------------------------------------------|----------------------| +| Accuracy | 5.1.6.3.5 | Represents the accuracy level of the ML model. | | +| DatasetStatisticalProperty | 5.1.6.3.15 | Dataset statistical properties of the data used for ML model training. | | +| DccfEvent | 3GPP TS 29.574 [26] | Identifies the input data event. | | +| Dnn | 3GPP TS 29.571 [8] | Identifies the DNN. | | +| DurationSec | 3GPP TS 29.571 [8] | Represents the duration time in second(s). | | +| Float | 3GPP TS 29.571 [8] | | | +| MLEventSubscription | 5.4.6.2.3 | Represents an Individual NWDAF Event Subscription resource. | | +| MLEventNotif | 5.4.6.2.6 | Represents notifications about Individual Events. | | +| NwdafEvent | 5.1.6.3.4 | Describes the NWDAF Events. | | +| RedirectResponse | 3GPP TS 29.571 [8] | | | +| ReportingInformation | 3GPP TS 29.523 [20] | Represents the requirements of reporting the subscription. | | +| Sns sai | 3GPP TS 29.571 [8] | Identifies the S-NSSAI (Single Network Slice Selection Assistance Information). | | +| SupportedFeatures | 3GPP TS 29.571 [8] | | | +| TargetUeInformation | 5.1.6.2.8 | Identifies the target UE information. | | +| TimeWindow | 3GPP TS 29.122 [19] | | | +| Uri | 3GPP TS 29.571 [8] | | | + +## 5.5.6.2 Structured data types + +### 5.5.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.5.6.2.2 Type NwdafMLModelTrainSubsc + +**Table 5.5.6.2.2-1: Definition of type NwdafMLModelTrainSubsc** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventReq | ReportingInformation | O | 0..1 | Reporting requirement information of the subscription. If omitted, the default values within the ReportingInformation data type apply. | | +| failEventReports | array(FailureEventInfoForMLModelTrain) | O | 1..N | Supplied by the NWDAF containing MTLF when available, shall contain the event(s) that the subscription is not successful including the failure reason(s). | | +| mlCorreId | string | C | 0..1 | Identifies the Machine Learning procedure for training the ML model. It shall be present when the service is for Federated Learning. | | +| mlCorreId | string | C | 0..1 | Identifies the Machine Learning procedure for training the ML model. It shall be present when the service is for Federated Learning. | | +| mlEventSubscs | array(MLEventSubscription) | M | 1..N | Each element identifies the subscription for each event. The "modelInterInfo" attribute within the MLEventSubscription data type shall be provided. | | +| mlModelInfos | array(MLEventNotif) | O | 1..N | Each element contains ML Model information for a specific analytics type. (NOTE) | | +| immReports | array(NwdafMLModelTrainNotif) | O | 1..N | Immediately reported ML Model Training notifications. It may only be provided in the HTTP POST response of a subscription creation/update and only if the immediate reporting flag was set to "true" in the HTTP POST request. | | +| mlModelTrainInfos | array(MLModelTrainInfo) | O | 1..N | Each element represents the ML Model training information for each event, include requirement on data availability and time availability. | | +| mlPreFlag | boolean | C | 0..1 | Indicates whether the subscription is for preparation of ML Model training. Set to "true" if it is for ML training preparation, otherwise set to "false". Default value is "false" if omitted. It shall be present when the service is for preparation of Federated Learning. | | +| mlAccChkFlg | boolean | O | 0..1 | Indicates whether request using the local training data as the testing dataset to calculate the Model Accuracy of the global ML model | | + +| | | | | | | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--| +| | | | | provided by the consumer. Set to "true" if it is requested, otherwise set to "false". Default value is "false" if omitted. | | +| mLTrainRepInfo | MLTrainReportInfo | O | 0..1 | Indicates the training reporting information. This attribute can be provided when the "notifMethod" attribute within the ReportingInformation structure is set to "ON_EVENT_DETECTION" in the "eventReq" attribute. | | +| notifCorreId | string | M | 1 | The value of Notification Correlation ID in the corresponding notification. | | +| notifUri | Uri | M | 1 | URI at which the NF service consumer requests to receive notifications. | | +| roundInd | UInteger | O | 0..1 | Indicates the round number of the training in a multi-round training process. | | +| suppFeats | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.5.8. It shall be supplied by NF service consumer in the POST requests that request the creation of an NWDAF ML Model Training Subscriptions resource and shall be supplied by the NWDAF in the reply of corresponding request. | | +| tgtRepUe | TargetUeInformation | O | 0..1 | Indicates the UE(s) information for which data for ML model training is requested. | | +| uCaseCont | string | O | 0..1 | Indicates the use case context of the ML model. The value and format of this parameter are not standardized. | | +| NOTE: It is up to implementation to determine whether to include the "mlFile" attribute in the "NwdafMLModelTrainSubsc" data structure considering ML Model file size, etc. | | | | | | + +## 5.5.6.2.3 Type NwdafMLModelTrainSubscPatch + +Table 5.5.6.2.3-1: Definition of type NwdafMLModelTrainSubscPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| eventReq | ReportingInformation | O | 0..1 | Reporting requirement information of the subscription.
If omitted, the default values within the ReportingInformation data type apply. | | +| mlModelInfos | array(MLEventNotif) | O | 1..N | Each element contains ML Model information for a specific analytics type. | | +| mlModelTrainInfos | array(MLModelTrainInfo) | O | 1..N | Each element represents the ML Model training information, include requirement on data availability and time availability, training filter information. | | +| mlPreFlag | boolean | O | 0..1 | Indicates whether the subscription is for preparation of ML Model training. Set to "true" if it is for ML training preparation, otherwise set to "false". | | +| mlAccChkFlg | boolean | O | 0..1 | Indicates whether request using the local training data as the testing dataset to calculate the Model Accuracy of the global ML model provided by the consumer. Set to "true" if it is requested, otherwise set to "false". | | +| mlTrainRepInfo | MLTrainReportInfo | O | 0..1 | Indicates the training reporting information. This attribute can be provided when the "notifMethod" attribute within the ReportingInformation structure is set to "ON_EVENT_DETECTION" in the "eventReq" attribute. | | +| notifUri | Uri | O | 1 | URI at which the NF service consumer requests to receive notifications. | | +| roundInd | UInteger | O | 0..1 | Indicates the round number of the training in a multi-round training process. | | +| tgtRepUe | TargetUeInformation | O | 0..1 | Indicates the UE(s) information for which data for ML model training is requested. | | +| uCaseCont | string | O | 0..1 | Indicates the use case context of the ML model. The value and format of this parameter are not standardized. | | + +5.5.6.2.4 Void + +5.5.6.2.5 Type MLModelTrainInfo + +**Table 5.5.6.2.5-1: Definition of type MLModelTrainInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| dataAvReq | DataAvReq | C | 0..1 | Represents the requirement on available data for the ML model training.
Shall be provided when the "mlPreFlag" attribute in data type "NwdafMLModelTrainSubsc" is set to "true". | | +| timeAvReq | string | C | 0..1 | Represents the requirement on available time for the ML model training.
Shall be provided when the "mlPreFlag" attribute in data type "NwdafMLModelTrainSubsc" is set to "true". | | + +5.5.6.2.6 Type MLTrainReportInfo + +**Table 5.5.6.2.6-1: Definition of type MLTrainReportInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-------------------------------------------------------|---------------| +| maxResTime | DurationSec | O | 0..1 | Indicates the maximum time for waiting notifications. | | + +5.5.6.2.7 Type FailureEventInfoForMLModelTrain + +**Table 5.5.6.2.7-1: Definition of type FailureEventInfoForMLModelTrain** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|------------------|---|-------------|--------------------------------|---------------| +| mLTrainEvent | NwdafEvent | M | 1 | Event that is subscribed. | | +| failureCodeTrain | FailureCodeTrain | M | 1 | Identifies the failure reason. | | + +## 5.5.6.2.8 Type NwdafMLModelTrainNotif + +Table 5.5.6.2.8-1: Definition of type NwdafMLModelTrainNotif + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| delayEventNotif | DelayEventNotif | C | 0..1 | Indicates that the NWDAF containing MTLF is not able to complete the training of ML model within the maximum response time, the cause code, and the expected time complete the training. May be provided for Federated Learning training. (NOTE) | | +| mlCorreId | string | C | 0..1 | Identifies the Machine Learning procedure for training the ML model. It shall be present when the service is for Federated Learning. | | +| mlModelInfos | array(MLEventNotif) | C | 1..N | Identifies the Machine Learning procedure information for training the ML model. It shall be present when the service is for Federated Learning. (NOTE) | | +| notifCorreId | string | M | 1 | Notification correlation ID used to identify the subscription to which the notification relates. It shall be set to the same value as the "notifCorreId" attribute of NwdafMLModelTrainSubsc data type. | | +| roundInd | UInteger | O | 0..1 | Indicates the round number of the training in a multi-round training process. | | +| statusReport | StatusReportInfo | O | 0..1 | Indicates status information generated by the NWDAF containing MTLF during ML model training. May be provided for Federated Learning training. | | +| termTrainReq | TermTrainCause | C | 0..1 | If provided, it indicates that the subscription is requested to be terminated (i.e. no further notifications related to this subscription will be provided) and it contains the reason why the subscription is requested to be terminated. (NOTE) | | +| uCaseCont | string | O | 0..1 | Indicates the use case context of the ML model. The value and format of this parameter are not standardized. | | + +NOTE: At least one of the "delayEventNotif", "mlModelInfos" or "termTrainReq" attribute shall be provided. The "delayEventNotif" attribute and "mlModelInfos" attribute are mutually exclusive. The "delayEventNotif" attribute and "termTrainReq" attribute are mutually exclusive. + +## 5.5.6.2.9 Void + +## 5.5.6.2.10 Type DataAvReq + +**Table 5.5.6.2.10-1: Definition of type DataAvReq** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------------|---|-------------|--------------------------------------------------------------------------------------|---------------| +| dataStatProps | array(DatasetStatisticalProperty) | O | 1..N | List of dataset statistical properties of the data to be used for ML model training. | | +| inpEvents | array(DccfEvent) | M | 1..N | Event ID list of the data to be collected for ML model training. | | +| minNumSamples | UInteger | O | 0..1 | Minimum number of samples that be taken to train an ML model. | | +| timeWindows | array(TimeWindow) | O | 1..N | The time periods of the data samples. | | + +## 5.5.6.2.11 Type DelayEventNotif + +**Table 5.5.6.2.11-1: Definition of type DelayEventNotif** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| delayEventInd | boolean | M | 1 | Indicates the NWDAF containing MTLF is not able to complete the training of the ML model within the maximum response time provided by the "maxResTime" attribute in the "MLTrainReportInfo" data type.
Set to "true" if not able to complete the ML model training on time, otherwise set to "false". | | +| delayCause | DelayCause | O | 0..1 | Represents the reasons for the ML Model training delay. | | +| expCompTime | DurationSec | O | 0..1 | Indicates the expected remaining training time. | | + +## 5.5.6.2.12 Type StatusReportInfo + +**Table 5.5.6.2.12-1: Definition of type StatusReportInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|---------------|---|-------------|-----------------------------------------------------------------------------------|---------------| +| mlModelAcc | UInteger | O | 0..1 | Indicates the accuracy of the ML model in percent.
Minimum = 0. Maximum = 100. | | +| trainInDataInfo | TrainDataInfo | O | 0..1 | Represents the training input data information. | | + +### 5.5.6.2.13 Type TrainDataInfo + +**Table 5.5.6.2.13-1: Definition of type TrainDataInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------|---------------| +| areaDataSet | string | O | 0..1 | Indicates the areas covered by the data set. | | +| maxValues | array(string) | O | 1..N | Each element represents the maximum value of one dimension of data. | | +| minValues | array(string) | O | 1..N | Each element represents the minimum value of one dimension of data. | | +| samplRatio | UInteger | O | 0..1 | Sampling ratio, indicates the percentage of the available data that are taken to train an ML model.
Minimum = 0. Maximum = 100. | | + +Editor's Note: The data type for the "areaDataSet" attribute is FFS and will align with stage 2 requirement. + +Editor's Note: Whether need the "maxValues" and "minValues" attributes and their data type are FFS and will align with stage 2 requirements. + +### 5.5.6.3 Simple data types and enumerations + +#### 5.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.5.6.3.2 Simple data types + +The simple data types defined in table 5.1.6.3.2-1 shall be supported. + +**Table 5.5.6.3.2-1: Simple data types** + +| Type Name | Type Definition | Description | Applicability | +|-----------|-----------------|-------------|---------------| +| | | | | + +#### 5.5.6.3.3 Enumeration: FailureCodeTrain + +**Table 5.5.6.3.3-1: Enumeration FailureCodeTrain** + +| Enumeration value | Description | Applicability | +|----------------------------|-----------------------------------------------------------|---------------| +| UNAVAILABLE_ML_MODEL_TRAIN | Indicates the requested ML model training is unavailable. | | + +#### 5.5.6.3.4 Enumeration: TermTrainCause + +**Table 5.5.6.3.4-1: Enumeration TermTrainCause** + +| Enumeration value | Description | Applicability | +|------------------------|------------------------------------------------------------------------------------------------------------------|---------------| +| NWDAF_OVERLOAD | Indicates the NWDAF is overload, e.g. in computation and/or communication capability, for the ML model training. | | +| NOT_AVAILABLE_ML_TRAIN | Indicates the ML model training process is not available anymore. | | +| OTHERS | Indicates other cause. | | + +#### 5.5.6.3.5 Enumeration: DelayCause + +**Table 5.5.6.3.5-1: Enumeration DelayCause** + +| Enumeration value | Description | Applicability | +|------------------------|---------------------------------------------------------------|---------------| +| ML_MODEL_TRAIN_FAILURE | Indicates the ML model training is failed. | | +| NEED_MORE_TIME | Indicates that more time is needed for the ML model training. | | +| OTHERS | Indicates other cause. | | + +### 5.5.7 Error handling + +#### 5.5.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of 3GPP TS 29.500 [6]. + +For the Nnwdaf\_MLModelTraining API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [7]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] 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 [6]. + +Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] for HTTP redirections shall be supported. + +In addition, the requirements in the following clauses shall apply. + +#### 5.5.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_MLModelTraining API. + +#### 5.5.7.3 Application Errors + +The application errors defined for the Nnwdaf\_MLModelTraining API are listed in table 5.5.7.3-1. + +**Table 5.5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| UNAVAILABLE_ML_MODEL_TRAINING_F
OR_ALLEVENTS | 500 Internal Server
Error | Indicates the requested all events ML model training is unavailable. | +| ML_MODEL_TRAINING_REQS_NOT_MET | 403 Forbidden | Indicates the ML model training requirements are not met. The "ProblemDetails" data structure shall contain the attribute(s) that do not meet the ML model training requirements within the "invalidParams" attribute. | +| ML_TRAINING_NOT_COMPLETE | 403 Forbidden | Indicates the ML training is not complete. | +| OVERLOAD | 403 Forbidden | Indicates the NWDAF is overload. | +| NOT_AVAILABLE_FOR_FL_PROCESS_AN
YMORE | 403 Forbidden | Indicates the NWDAF is not available for the FL process anymore. | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +## 5.5.8 Feature negotiation + +The optional features in table 5.5.8-1 are defined for the Nnwdaf\_MLModelTraining API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.5.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|-----------------------|---------------------|--------------------| +| | | | + +## 5.5.9 Security + +As indicated in 3GPP TS 33.501 [13] and 3GPP TS 29.500 [6], the access to the Nnwdaf\_MLModelTraining 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 [12]) plays the role of the authorization server. + +If OAuth2 is used, a n NF Service Consumer, prior to consuming services offered by the Nnwdaf\_MLModelTraining API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], 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 Nnwdaf\_MLModelTraining service. + +The Nnwdaf\_MLModelTraining API defines a single scope "nnwda-mlmodeltraining" for the entire service, and it does not define any additional scopes at resource or operation level. + +# 5.6 Nnwdaf\_MLModelMonitor Service API + +## 5.6.1 Introduction + +The Nnwdaf\_MLModelMonitor service shall use the Nnwdaf\_MLModelMonitor API. + +The API URI of the Nnwdaf\_MLModelMonitor API shall be: + +{apiRoot}// + +The request URIs used in each HTTP requests from the NF service consumer towards the NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}/// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwda-mlmodelmonitor". +- The shall be "v1". +- The shall be set as described in clause 5.6.3. + +## 5.6.2 Usage of HTTP + +### 5.6.2.1 General + +HTTP/2, IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_MLModelMonitor is contained in Annex A. + +### 5.6.2.2 HTTP standard headers + +#### 5.6.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +#### 5.6.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 [6]. 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 [15]. + +### 5.6.2.3 HTTP custom headers + +The Nnwdaf\_MLModelMonitor service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_MLModelMonitor service API. + +## 5.6.3 Resources + +### 5.6.3.1 Resource Structure + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.6.3.1-1 depicts the resource URIs structure for the Nnwdaf\_MLModelMonitor API. + +![Figure 5.6.3.1-1: Resource URI structure of the Nnwdaf_MLModelMonitor API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nnwda-mlmodelmonitor/. It branches into /registrations and /subscriptions. /registrations further branches into /{registrationId}. /subscriptions further branches into /{subscriptionId}.](1ba9045eb6dc22039a16b92b1427e696_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnwda-mlmodelmonitor/"] --> Registrations["/registrations"] + Root --> Subscriptions["/subscriptions"] + Registrations --> RegistrationId["/{registrationId}"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Figure 5.6.3.1-1: Resource URI structure of the Nnwdaf\_MLModelMonitor API. The diagram shows a hierarchical tree structure starting from {apiRoot}/nnwda-mlmodelmonitor/. It branches into /registrations and /subscriptions. /registrations further branches into /{registrationId}. /subscriptions further branches into /{subscriptionId}. + +**Figure 5.6.3.1-1: Resource URI structure of the Nnwdaf\_MLModelMonitor API** + +Table 5.6.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.6.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|---------------------------------------------------|----------------------------------|---------------------------------|--------------------------------------------------------------------------------------------------------------------| +| NWDAF ML model monitoring registrations | /registrations | POST | Create a new Individual ML model monitoring registration resource on the NWDAF containing MTLF. | +| Individual NWDAF ML model monitoring registration | /registrations/{registrationsId} | DELETE | Delete an Individual ML model monitoring registration resource by {registrationsId} on the NWDAF containing MTLF. | +| NWDAF ML model monitoring Subscriptions | /subscriptions | POST | Create a new Individual ML model monitoring Subscription resource on the NWDAF containing AnLF. | +| Individual NWDAF ML model monitoring Subscription | /subscriptions/{subscriptionId} | PUT | Modifies an existing ML model monitoring Subscription resource on the NWDAF containing AnLF. | +| | | DELETE | Delete an individual ML model monitoring Subscription identified by {subscriptionId} on the NWDAF containing AnLF. | + +## 5.6.3.2 Resource: NWDAF ML model monitoring registrations + +### 5.6.3.2.1 Description + +The NWDAF ML model monitoring registrations resource represents all registrations to the Nnwdaf\_MLModelMonitor Service at a given NWDAF containing MTLF. The resource allows an NF service consumer to create a new Individual NWDAF ML model monitoring registration resource. + +### 5.6.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnwda-mlmodelmonitor//registrations + +The shall be set as described in clause 5.6.1. + +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 this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.6.1 | + +### 5.6.3.2.3 Resource Standard Methods + +#### 5.6.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.6.3.2.3.1-1. + +**Table 5.6.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.6.3.2.3.1-2 and the response data structures and response codes specified in table 5.6.3.2.3.1-3. + +**Table 5.6.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------------------------------------| +| MLModelMonitorReg | M | 1 | Create a new Individual NWDAF ML model monitoring registration resource. | + +**Table 5.6.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| MLModelMonitorReg | M | 1 | 201
Created | The creation of an Individual NWDAF ML model monitoring registration resource is confirmed and a representation of that resource is returned. | +| 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 [6] also apply. | | | | | +| NOTE 2: Failure cases are described in clause 5.6.7. | | | | | + +**Table 5.6.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}/nnwdaf-mlmodelmonitor//registrations/{registrationId} | + +### 5.6.3.2.4 Resource Custom Operations + +None in this release of the specification. + +## 5.6.3.3 Resource: Individual NWDAF ML model monitoring registration + +### 5.6.3.3.1 Description + +The Individual NWDAF ML model monitoring registration resource represents a single registration to the Nnwdaf\_MLModelMonitor Service at a given NWDAF containing MTLF. + +### 5.6.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwda-mlmodelmonitor//registrations/{registrationId} + +The shall be set as described in clause 5.6.1. + +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 this resource** + +| Name | Data type | Definition | +|----------------|-----------|-----------------------------------------------------------------| +| apiRoot | string | See clause 5.6.1. | +| registrationId | string | Identifies a registration to the Nnwdaf_MLModelMonitor Service. | + +### 5.6.3.3.3 Resource Standard Methods + +#### 5.6.3.3.3.1 DELETE + +This method shall support the URI query parameters specified in table 5.6.3.3.3.1-1. + +**Table 5.6.3.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 5.6.3.3.3.1-2 and the response data structures and response codes specified in table 5.6.3.3.3.1-3. + +**Table 5.6.3.3.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.6.3.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 | Successful case: The Individual NWDAF ML model monitoring registration resource matching the registrationId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual ML model monitoring registration deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual ML model monitoring registration deletion.
(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 [6] 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 [6]). + +**Table 5.6.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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.6.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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +### 5.6.3.3.4 Resource Custom Operations + +None in this release of the specification. + +### 5.6.3.4 Resource: NWDAF ML model monitoring Subscriptions + +#### 5.6.3.4.1 Description + +The NWDAF ML model monitoring Subscriptions resource represents all subscriptions to the Nnwdaf\_MLModelMonitor Service at a given NWDAF containing AnLF. The resource allows an NF service consumer to create a new Individual NWDAF ML model monitoring subscription resource. + +#### 5.6.3.4.2 Resource Definition + +Resource URI: {apiRoot}/nnwdaf-mlmodelmonitor//subscriptions + +The shall be set as described in clause 5.6.1. + +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 this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.6.1 | + +### 5.6.3.4.3 Resource Standard Methods + +#### 5.6.3.4.3.1 POST + +This method shall support the URI query parameters specified in table 5.6.3.4.3.1-1. + +**Table 5.6.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 5.6.3.4.3.1-2 and the response data structures and response codes specified in table 5.6.3.4.3.1-3. + +**Table 5.6.3.4.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------------------------------------| +| MLModelMonitorSub | M | 1 | Create a new Individual NWDAF ML model monitoring subscription resource. | + +**Table 5.6.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------------------------------------------------------| +| MLModelMonitorSub | M | 1 | 201
Created | The creation of an Individual NWDAF ML model monitoring subscription resource is confirmed and a representation of that resource is returned. | +| 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 [6] also apply. | | | | | +| NOTE 2: Failure cases are described in clause 5.6.7. | | | | | + +**Table 5.6.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}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId} | + +#### 5.6.3.4.4 Resource Custom Operations + +None in this release of the specification. + +### 5.6.3.5 Resource: Individual NWDAF ML model monitoring Subscription + +#### 5.6.3.5.1 Description + +The Individual NWDAF ML model monitoring Subscription resource represents a single subscription to the Nnwdaf\_MLModelMonitor Service at a given NWDAF containing AnLF. + +#### 5.6.3.5.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId} + +The shall be set as described in clause 5.6.1. + +This resource shall support the resource URI variables defined in table 5.6.3.5.2-1. + +**Table 5.6.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|-----------------------------------------------------------------| +| apiRoot | string | See clause 5.6.1. | +| subscriptionId | string | Identifies a subscription to the Nnwdaf_MLModelMonitor Service. | + +### 5.6.3.5.3 Resource Standard Methods + +#### 5.6.3.5.3.1 PUT + +This method shall support the URI query parameters specified in table 5.6.3.5.3.1-1. + +**Table 5.6.3.5.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.6.3.5.3.1-2 and the response data structures and response codes specified in table 5.6.3.5.3.1-3. + +**Table 5.6.3.5.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|------------------------------------------------------------------------------------------| +| MLModelMonitorSub | M | 1 | Parameters to replace a subscription to NWDAF ML model monitoring subscription resource. | + +**Table 5.6.3.5.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| MLModelMonitorSub | M | 1 | 200 OK | The Individual NWDAF ML model monitoring subscription resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF ML model monitoring subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF ML model monitoring subscription modification.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF ML model monitoring subscription modification.
(NOTE 3) | + +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 [6] also apply. + +NOTE 2: Failure cases are described in clause 5.6.7. + +NOTE 3: The RedirectResponse data structure may be provided by an SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.6.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 | Contains an alternative URI of the resource located in an alternative NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.6.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 | Contains an alternative URI of the resource located in an alternative NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.6.3.5.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.6.3.5.3.2-1. + +**Table 5.6.3.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 5.6.3.5.3.2-2 and the response data structures and response codes specified in table 5.6.3.5.3.2-3. + +**Table 5.6.3.5.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.6.3.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 NWDAF ML model monitoring subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual ML model monitoring subscription deletion.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual ML model monitoring subscription deletion.

(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 [6] 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 [6]). + +**Table 5.6.3.5.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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.6.3.5.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 NWDAF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +#### 5.6.3.5.4 Resource Custom Operations + +None in this release of the specification. + +### 5.6.4 Custom Operations without associated resources + +None in this release of the specification. + +### 5.6.5 Notifications + +#### 5.6.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.6.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|-------------------|---------------------------------|----------------------------------------| +| Event Notification | {notificationUri} | POST | Report analytics feedback information. | + +#### 5.6.5.2 Event Notification + +##### 5.6.5.2.1 Description + +The Event Notification is used by the NWDAF containing AnLF to report analytics feedback information to the NF service consumer that has subscribed to such Notifications. + +##### 5.6.5.2.2 Operation Definition + +Callback URI: {notificationUri} + +The operation shall support the callback URI variables defined in Table 5.6.5.2.2-1, the request data structures specified in table 5.6.5.2.2-2 and the response data structure and response codes specified in Table 5.6.5.2.2-3. + +**Table 5.6.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationUri | Uri | The Notification Uri is assigned within the Individual NWDAF ML model monitoring Subscription Resource and described within the MLModelMonitorSub data type (see table 5.6.6.2.3-1). | + +**Table 5.6.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------|---|-------------|------------------------------------------| +| MLModelMonitorNotify | M | 1 | Provides analytics feedback information. | + +**Table 5.6.5.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. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during the event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event 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 [6] 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 [6]). + +**Table 5.6.5.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 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 [6]. | +| 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.6.5.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 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 [6]. | +| 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.6 Data Model + +### 5.6.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.6.6.1-1 specifies the data types defined for the Nnwdaf\_MLModelMonitor service based interface protocol. + +**Table 5.6.6.1-1: Nnwdaf\_MLModelMonitor specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------------|----------------|-------------|---------------| +| AnalyticsFeedback | 5.6.6.2.6 | | | +| MLModelAccuracyInfo | 5.6.6.2.5 | | | +| MLModelMonitorNotify | 5.6.6.2.4 | | | +| MLModelMonitorReg | 5.6.6.2.2 | | | +| MLModelMonitorSub | 5.6.6.2.3 | | | + +Table 5.6.6.1-2 specifies data types re-used by the Nnwdaf\_MLModelMonitor 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 Nnwdaf\_MLModelMonitor service based interface. + +**Table 5.6.6.1-2: Nnwdaf\_MLModelMonitor re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|----------------------------------------------------------------------------------------|---------------| +| DataSetTag | 3GPP TS 29.575 [27] | Contains an identifier and a description of associated data or analytics records. | | +| DateTime | 3GPP TS 29.571 [8] | Identifies the time. | | +| Float | 3GPP TS 29.571 [8] | Number with format "float" as defined in OpenAPI Specification [11]. | | +| MLModelMetric | 5.4.6.3.4 | Indicates the ML Model Metric. | | +| NfInstanceId | 3GPP TS 29.571 [8] | Identifies an NF instance | | +| NfSetId | 3GPP TS 29.571 [8] | Identifies an NF Set instance. | | +| Nwdafevent | 5.1.6.3.4 | Indicates the NWDAF events. | | +| ReportingInformation | 3GPP TS 29.523 [20] | Represents the type of reporting the subscription requires. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of the optional features defined in table 5.1.8-1. | | +| UInteger | 3GPP TS 29.571 [8] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. | | +| Uri | 3GPP TS 29.571 [8] | Indicates the URI. | | + +## 5.6.6.2 Structured data types + +### 5.6.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.6.6.2.2 Type MLModelMonitorReg + +Table 5.6.6.2.2-1: Definition of type MLModelMonitorReg + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| consumerId | NfInstanceId | C | 0..1 | Indicates the NF instance ID of the consumer.
(NOTE) | | +| consumerSetId | NfSetId | C | 0..1 | Indicates the NF set ID of the consumer.
(NOTE) | | +| modelId | UInteger | M | 1 | The ML model ID. | | +| modelAccuInd | boolean | O | 0..1 | Indicates the ML Model accuracy transfer indication. Set to "true" to indicate that the monitoring of the accuracy of the ML model is supported. Default value is "false" if omitted. | | + +NOTE: One of "consumerId" and "consumerSetId" attributes shall be provided. + +## 5.6.6.2.3 Type MLModelMonitorSub + +Table 5.6.6.2.3-1: Definition of type MLModelMonitorSub + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| modelIds | array(Uinteger) | M | 1..N | The ML model IDs. | | +| notificationUri | Uri | M | 1 | Notification target address. | | +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| modelMetric | MLModelMetric | O | 0..1 | The ML model metrics to calculate the accuracy information. | | +| accuThreshold | Uinteger | O | 0..1 | Accuracy reporting threshold. Indicates the threshold upon the crossing of which (in either ascending or descending direction) the accuracy information needs to be reported. | | +| eventReportReq | ReportingInformation | O | 0..1 | Represents the reporting requirements of the event subscription.
If omitted, the default values within the ReportingInformation data type apply. | | +| immReports | array(MLModelMonitorNotify) | O | 1..N | Immediately reported ML model Monitoring notifications. It may only be provided in the HTTP POST response of a subscription creation/update and only if the immediate reporting flag was set to "true" in the HTTP POST request. | | +| suppFeat | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.1.8.
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 included the "suppFeat" attribute in the POST request. | | + +## 5.6.6.2.4 Type MLModelMonitorNotify + +Table 5.6.6.2.4-1: Definition of type MLModelMonitorNotify + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------------------|---|-------------|-------------------------------------------------------------------------------------|---------------| +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| modelAccuInfos | array(MLModelAccuracyInfo) | C | 1..N | The accuracy related information of the ML model.
(NOTE 1) | | +| anaFeedbacks | array(AnalyticsFeedback) | C | 1..N | The analytics feedback information.
(NOTE 1) | | +| validPeriod | TimeWindow | O | 0..1 | Represents the period during which the monitoring information is valid.
(NOTE 2) | | + +NOTE 1: At least one of "modelAccuInfos" and "anaFeedbacks" attributes shall be provided. +NOTE 2: If the "temporalGranSize" attribute is provided in the request, the duration indicated by the "validPeriod" attribute shall be greater than or equal to the value of the "temporalGranSize" attribute. + +## 5.6.6.2.5 Type MLModelAccuracyInfo + +Table 5.6.6.2.5-1: Definition of type MLModelAccuracyInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|---------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| modelId | UInteger | M | 1 | The ML model ID. | | +| deviation | Float | O | 0..1 | Indicates the deviation value of the predictions generated using the ML model from the ground truth data. | | +| inferenceNum | UInteger | O | 0..1 | The number of inferences that were performed during the time interval between Nnwdf MLModelMonitor_Register request and the Notify request or between the time of last Notification message and the time of the current Notification message. | | +| adrflId | NfInstanceId | O | 0..1 | Identifier of the ADRF.
(NOTE) | | +| adrSetId | NfSetId | O | 0..1 | Identifier of the ADRF Set.
(NOTE) | | +| dataSetTag | DataSetTag | O | 0..1 | Data set tag of the data stored in ADRF which can be used by MTLF. This attribute may be present if the "adrflId" or "adrSetId" attribute is present. | | +| modelMetric | MLModelMetric | O | 0..1 | The ML model metrics to calculate the accuracy information. | | + +NOTE: "adrflId" and "adrSetId" are mutually exclusive. + +### 5.6.6.2.6 Type AnalyticsFeedback + +**Table 5.6.6.2.6-1: Definition of type AnalyticsFeedback** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| events | array(Nwdafevent) | M | 1..N | Each element indicates the Analytics ID that was used to take this action. | | +| modelIds | array(uinteger) | M | 1..N | Each element indicate the ML Model identifier that was used to take this action. | | +| groundDataImpactInd | boolean | O | 0..1 | Indication whether the action will affect on ground truth data.
Set to "true" to indicate that the action will affect on ground truth data. Otherwise, default value is "false" if omitted. | | +| timeStamp | DateTime | O | 0..1 | Time stamp when the action was taken. | | + +## 5.6.7 Error handling + +### 5.6.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of TS 29.500 [6]. + +For the Nnwdafevent\_MLModelMonitor API, HTTP error responses shall be supported as specified in clause 4.8 of TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of TS 29.500 [6] 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 TS 29.500 [6]. In addition, the requirements in the following clauses shall apply. + +### 5.6.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdafevent\_MLModelMonitor API. + +### 5.6.7.3 Application Errors + +The application errors defined for the Nnwdafevent\_MLModelMonitor API are listed in table 5.6.7.3-1. + +**Table 5.6.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 5.6.8 Feature negotiation + +The optional features in table 5.6.8-1 are defined for the Nnwdafevent\_MLModelMonitor API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.6.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 5.6.9 Security + +As indicated in TS 33.501 [13] and TS 29.500 [6], the access to the Nnwdaf\_MLModelMonitor 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 TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnwdaf\_MLModelMonitor API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in TS 29.510 [12], 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 Nnwdaf\_MLModelMonitor service. + +The Nnwdaf\_MLModelMonitor API defines a single scope "nnwdaf-mlmodelmonitor" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 5.7 Nnwdaf\_RoamingData Service API + +### 5.7.1 Introduction + +The Nnwdaf\_RoamingData service shall use the Nnwdaf\_RoamingData API. + +The API URI of the Nnwdaf\_RoamingData API shall be: + +{apiRoot}/ + +The request URIs used in each HTTP requests from the NF service consumer towards the RE-NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-roamingdata". +- The shall be "v1". +- The shall be set as described in clause 5.7.3. + +### 5.7.2 Usage of HTTP + +#### 5.7.2.1 General + +HTTP/2, IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_RoamingData is contained in Annex A. + +#### 5.7.2.2 HTTP standard headers + +##### 5.7.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +##### 5.7.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 [6]. 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 [15]. + +### 5.7.2.3 HTTP custom headers + +The Nnwdaf\_RoamingData service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_RoamingData service API. + +## 5.7.3 Resources + +### 5.7.3.1 Resource Structure + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.7.3.1-1 depicts the resource URIs structure for the Nnwdaf\_RoamingData API. + +![Diagram showing the hierarchical structure of Resource URIs for the Nnwdaf_RoamingData API. The root URI is {apiRoot}/nnwda-roamingdata/. It branches to /subscriptions, which further branches to /{subscriptionId}.](746339de60a18834270b45f3928c3e8a_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnwda-roamingdata/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the hierarchical structure of Resource URIs for the Nnwdaf\_RoamingData API. The root URI is {apiRoot}/nnwda-roamingdata/. It branches to /subscriptions, which further branches to /{subscriptionId}. + +Figure 5.7.3.1-1: Resource URI structure of the Nnwdaf\_RoamingData API + +Table 5.7.3.1-1 provides an overview of the resources and applicable HTTP methods. + +Table 5.7.3.1-1: Resources and methods overview + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|--------------------------------------------|---------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------| +| NWDAF Roaming Data Subscriptions | /subscriptions | POST | Create a new Individual NWDAF Roaming Data Subscription resource on the NWDAF. | +| Individual NWDAF Roaming Data Subscription | /subscriptions/{subscriptionId} | PUT | Modifies an existing Roaming Data Subscription resource on the NWDAF. | +| | | DELETE | Delete an Individual NWDAF Roaming Data Subscription identified by {subscriptionId} on the NWDAF. | + +### 5.7.3.2 Resource: NWDAF Roaming Data Subscriptions + +#### 5.7.3.2.1 Description + +The NWDAF Roaming Data Subscriptions resource represents all subscriptions to the Nnwdaf\_RoamingData Service at a given RE-NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF Roaming Data Subscription resource. + +### 5.7.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnwda-roamingdata//subscriptions + +The shall be set as described in clause 5.7.1. + +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 this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.7.1 | + +### 5.7.3.2.3 Resource Standard Methods + +#### 5.7.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.7.3.2.3.1-1. + +**Table 5.7.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.7.3.2.3.1-2 and the response data structures and response codes specified in table 5.7.3.2.3.1-3. + +**Table 5.7.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-------------------------------------------------------------------| +| RoamingDataSub | M | 1 | Create a new Individual NWDAF Roaming Data Subscription resource. | + +**Table 5.7.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------| +| RoamingDataSub | M | 1 | 201
Created | The creation of an Individual NWDAF Roaming Data Subscription resource is confirmed and a representation of that resource is returned. | +| 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 [6] also apply. | | | | | +| NOTE 2: Failure cases are described in clause 5.7.7. | | | | | + +**Table 5.7.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}/nnwda-roamingdata//subscriptions/{subscriptionId} | + +### 5.7.3.2.4 Resource Custom Operations + +None in this release of the specification. + +### 5.7.3.3 Resource: Individual NWDAF Roaming Data Subscription + +#### 5.7.3.3.1 Description + +The Individual NWDAF Roaming Data Subscription resource represents a single subscription to the Nnwdaf\_RoamingData Service at a given RE-NWDAF. + +#### 5.7.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-roamingdata//subscriptions/{subscriptionId} + +The shall be set as described in clause 5.7.1. + +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 this resource** + +| Name | Data type | Definition | +|----------------|-----------|--------------------------------------------------------------| +| apiRoot | string | See clause 5.7.1. | +| subscriptionId | string | Identifies a subscription to the Nnwdaf_RoamingData Service. | + +#### 5.7.3.3.3 Resource Standard Methods + +##### 5.7.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 5.7.3.3.3.1-1. + +**Table 5.7.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 5.7.3.3.3.1-2 and the response data structures and response codes specified in table 5.7.3.3.3.1-3. + +**Table 5.7.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-----------------------------------------------------------------------------------| +| RoamingDataSub | M | 1 | Parameters to replace a subscription to NWDAF Roaming Data Subscription resource. | + +**Table 5.7.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|--------------------------------------------------------------------------------------------------------------------------------------| +| RoamingDataSub | M | 1 | 200 OK | The Individual NWDAF Roaming Data Subscription resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF Roaming Data Subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Roaming Data Subscription modification.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Roaming Data subscription modification.
(NOTE 3) | + +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 [6] also apply. + +NOTE 2: Failure cases are described in clause 5.7.7. + +NOTE 3: The RedirectResponse data structure may be provided by an SEPP or SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.7.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 RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SEPP or SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NWDAF (service) instance towards which the request is redirected. | + +**Table 5.7.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 RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SEPP or SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +### 5.7.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.7.3.3.3.2-1. + +**Table 5.7.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.7.3.3.3.2-2 and the response data structures and response codes specified in table 5.7.3.3.3.2-3. + +**Table 5.7.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.7.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 NWDAF Roaming Data Subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Roaming Data Subscription deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Roaming Data Subscription deletion.
(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 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SEPP or SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.7.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 RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SEPP or SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +**Table 5.7.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 RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SEPP or SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +### 5.7.3.3.4 Resource Custom Operations + +None in this release of the specification. + +## 5.7.4 Custom Operations without associated resources + +None in this release of the specification. + +## 5.7.5 Notifications + +### 5.7.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.7.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------|-------------------|---------------------------------|---------------------------------------------------| +| Event Notification | {notificationUri} | POST | Report data information related to roaming UE(s). | + +### 5.7.5.2 Event Notification + +#### 5.7.5.2.1 Description + +The Event Notification is used by the RE-NWDAF to report data information to the NF service consumer that has subscribed to such Notifications. + +#### 5.7.5.2.2 Operation Definition + +Callback URI: {notificationUri} + +The operation shall support the callback URI variables defined in Table 5.7.5.2.2-1, the request data structures specified in table 5.7.5.2.2-2 and the response data structure and response codes specified in Table 5.7.5.2.2-3. + +**Table 5.7.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|-----------------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notificationUri | Uri | The Notification Uri is assigned within the Individual NWDAF Roaming Data Subscription Resource and described within the RoamingDataSub data type (see table 5.7.6.2.3-1). | + +**Table 5.7.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|-----------------------------------------| +| NnwdafDataManagementNotif | M | 1 | Provides data related to roaming UE(s). | + +**Table 5.7.5.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. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during the event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event 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 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SEPP or SCP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.7.5.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 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 SEPP or SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 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.7.5.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 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 SEPP or SCP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.7.6 Data Model + +### 5.7.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.7.6.1-1 specifies the data types defined for the Nnwdaf\_RoamingData service based interface protocol. + +**Table 5.7.6.1-1: Nnwdaf\_RoamingData specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------|----------------|---------------------------------------------------|---------------| +| RoamingDataSub | 5.7.6.2.2 | Represents roaming data subscription information. | | + +Table 5.7.6.1-2 specifies data types re-used by the Nnwdaf\_RoamingData 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 Nnwdaf\_RoamingData service based interface. + +**Table 5.7.6.1-2: Nnwdaf\_RoamingData re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|---------------------------|---------------------|----------------------------------------------------------------------------------------|----------------------| +| DataSubscription | 3GPP TS 29.575 [27] | Subscription information for data retrieval from data source. | | +| DateTime | 3GPP TS 29.571 [8] | Identifies the time. | | +| FormattingInstruction | 3GPP TS 29.574 [26] | DCCF formatting Instructions. | | +| NfInstanceId | 3GPP TS 29.571 [8] | Identifies an NF instance | | +| NfSetId | 3GPP TS 29.571 [8] | Identifies an NF Set instance. | | +| NnwdafDataManagementNotif | 5.3.6.2.3 | The data notification. | | +| NwdafEvent | 5.1.6.3.4 | Indicates the NWDAF events. | | +| NnwdafEventsSubscription | 5.1.6.2.2 | Represents an NWDAF analytics subscription information. | | +| PlmnId | 3GPP TS 29.571 [8] | Identifies a PLMN Identifier. | | +| ProcessingInstruction | 3GPP TS 29.574 [26] | DCCF processing Instructions. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of the optional features defined in table 5.7.8-1. | | +| TimeWindow | 3GPP TS 29.122 [19] | Represents a time window. | | +| Uinteger | 3GPP TS 29.571 [8] | Unsigned Integer, i.e. only value 0 and integers above 0 are permissible. | | +| Uri | 3GPP TS 29.571 [8] | Indicates the URI. | | + +## 5.7.6.2 Structured data types + +### 5.7.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.7.6.2.2 Type RoamingDataSub + +**Table 5.7.6.2.2-1: Definition of type RoamingDataSub** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|----------------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notificationUri | Uri | M | 1 | Notification target address. | | +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| plmnId | PlmnId | M | 1 | PLMN ID of the consumer. | | +| dataSub | DataSubscription | C | 0..1 | Subscribed data events.
(NOTE 1) | | +| anaSub | NnwdafEventsSubscription | C | 0..1 | Analytics subscription information to be used by the NWDAF to determine the data that can be used to generate these analytics, specified by the "anaSub" attribute.
(NOTE 1) | | +| formatInstruct | FormattingInstruction | O | 0..1 | Formatting instructions to be used for sending event notifications. If provided, they take precedence over any potentially conflicting event reporting requirements provided within the "dataSub" attribute. | | +| procInstructs | array(ProcessingInstruction) | O | 1..N | Processing instructions to be used for sending event notifications. | | +| timePeriod | TimeWindow | O | 0..1 | Represents a start time and a stop time during which the data was collected or is requested to be collected. If provided, the time period related attributes contained in "dataSub" attribute shall be ignored.
(NOTE 2) | | +| targetNfId | NfInstanceId | O | 0..1 | The NF instance identifier from which the NWDAF may collect the requested data.
(NOTE 3) | | +| targetNfSetId | NfSetId | O | 0..1 | NF set identifier from which the NWDAF may collect the requested data.
(NOTE 3) | | +| immReports | array(NnwdafDataManagementNotif) | O | 1..N | Immediately reported roaming data notifications. It may only be provided in the HTTP POST response of a subscription creation/update and only if the immediate reporting flag was set to "true" in the HTTP POST request. | | +| suppFeat | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.7.8.
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 included the "suppFeat" attribute in the POST request. | | + +NOTE 1: One of these attributes shall be provided. + +NOTE 2: It includes the time period either in the past or in the future (i.e., start time as past time and stop time as + +future time is not allowed). + +NOTE 3: The "targetNfId" and "targetNfSetId" attributes are mutually exclusive. + +## 5.7.7 Error handling + +### 5.7.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of TS 29.500 [6]. + +For the Nnwdaf\_RoamingData API, HTTP error responses shall be supported as specified in clause 4.8 of TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of TS 29.500 [6] 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 TS 29.500 [6]. In addition, the requirements in the following clauses shall apply. + +### 5.7.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_RoamingData API. + +### 5.7.7.3 Application Errors + +The application errors defined for the Nnwdaf\_RoamingData API are listed in table 5.7.7.3-1. + +**Table 5.7.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------| +| | | | + +## 5.7.8 Feature negotiation + +The optional features in table 5.7.8-1 are defined for the Nnwdaf\_RoamingData API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.7.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 5.7.9 Security + +As indicated in TS 33.501 [13] and TS 29.500 [6], the access to the Nnwdaf\_RoamingData 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 TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnwdaf\_RoamingData API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in TS 29.510 [12], 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 Nnwdaf\_RoamingData service. + +The Nnwdaf\_RoamingData API defines a single scope "nnwdaf-roamingdata" for the entire service, and it does not define any additional scopes at resource or operation level. + +## 5.8 Nnwdaf\_RoamingAnalytics Service API + +### 5.8.1 Introduction + +The Nnwdaf\_RoamingAnalytics service shall use the Nnwdaf\_RoamingAnalytics API. + +The API URI of the Nnwdaf\_RoamingAnalytics API shall be: + +{apiRoot}/ + +The request URIs used in each HTTP requests from the NF service consumer towards the RE-NWDAF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +{apiRoot}// + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nnwdaf-roaminganalytics". +- The shall be "v1". +- The shall be set as described in clause 5.8.3. + +### 5.8.2 Usage of HTTP + +#### 5.8.2.1 General + +HTTP/2, IETF RFC 9113 [9], shall be used as specified in clause 5 of 3GPP TS 29.500 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nnwdaf\_RoamingAnalytics API is contained in Annex A.9. + +#### 5.8.2.2 HTTP standard headers + +##### 5.8.2.2.1 General + +See clause 5.2.2 of 3GPP TS 29.500 [6] for the usage of HTTP standard headers. + +##### 5.8.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 [6]. 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 an HTTP response body and shall be signalled by the content type "application/problem+json", as defined in IETF RFC 9457 [15]. + +#### 5.8.2.3 HTTP custom headers + +The Nnwdaf\_RoamingAnalytics service API shall support mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nnwdaf\_RoamingAnalytics service API. + +## 5.8.3 Resources + +### 5.8.3.1 Resource Structure + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +Figure 5.8.3.1-1 depicts the resource URIs structure for the Nnwdaf\_RoamingAnalytics API. + +![Diagram showing the hierarchical structure of resource URIs for the Nnwdaf_RoamingAnalytics API. The root is {apiRoot}/nnwda-roaminganalytics/. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subscriptionId}.](eabcc5363ff05be5b1ec4bf0aa360d2f_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nnwda-roaminganalytics/"] --> Subscriptions["/subscriptions"] + Subscriptions --> SubscriptionId["/{subscriptionId}"] + +``` + +Diagram showing the hierarchical structure of resource URIs for the Nnwdaf\_RoamingAnalytics API. The root is {apiRoot}/nnwda-roaminganalytics/. A line branches down to a box containing /subscriptions. From this box, another line branches down to a box containing /{subscriptionId}. + +**Figure 5.8.3.1-1: Resource URI structure of the Nnwdaf\_RoamingAnalytics API** + +Table 5.8.3.1-1 provides an overview of the resources and applicable HTTP methods. + +**Table 5.8.3.1-1: Resources and methods overview** + +| Resource name | Resource URI | HTTP method or custom operation | Description | +|-------------------------------------------------|---------------------------------|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------| +| NWDAF Roaming Analytics Subscriptions | /subscriptions | POST | Create a new Individual NWDAF Roaming Analytics Subscription resource on the NWDAF with roaming exchange capability. | +| Individual NWDAF Roaming Analytics Subscription | /subscriptions/{subscriptionId} | PUT | Modifies an existing Individual NWDAF Roaming Analytics Subscription resource on the NWDAF with roaming exchange capability. | +| | | DELETE | Delete the Individual NWDAF Roaming Analytics Subscription resource identified by {subscriptionId} on the NWDAF with roaming exchange capability. | + +### 5.8.3.2 Resource: NWDAF Roaming Analytics Subscriptions + +#### 5.8.3.2.1 Description + +The NWDAF Roaming Analytics Subscriptions resource represents all subscriptions to the Nnwdaf\_RoamingAnalytics Service at a given RE-NWDAF. The resource allows an NF service consumer to create a new Individual NWDAF Roaming Analytics Subscription resource. + +#### 5.8.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnwda-roaminganalytics//subscriptions + +The shall be set as described in clause 5.8.1. + +This resource shall support the resource URI variables defined in table 5.8.3.2.2-1. + +**Table 5.8.3.2.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|------------------| +| apiRoot | string | See clause 5.8.1 | + +### 5.8.3.2.3 Resource Standard Methods + +#### 5.8.3.2.3.1 POST + +This method shall support the URI query parameters specified in table 5.8.3.2.3.1-1. + +**Table 5.8.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.8.3.2.3.1-2 and the response data structures and response codes specified in table 5.8.3.2.3.1-3. + +**Table 5.8.3.2.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------------------|---|-------------|------------------------------------------------------------------------| +| RoamingAnalytics Subscription | M | 1 | Create a new Individual NWDAF Roaming Analytics subscription resource. | + +**Table 5.8.3.2.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------| +| RoamingAnalyticsSubscription | M | 1 | 201 Created | The creation of an Individual NWDAF Roaming Analytics subscription resource is confirmed and a representation of that resource is returned. | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 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.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure cases are described in clause 5.8.7. + +**Table 5.8.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}/nnwdaf-roaminganalytics//subscriptions/{subscriptionId} | + +### 5.8.3.2.4 Resource Custom Operations + +None in this release of the specification. + +### 5.8.3.3 Resource: Individual NWDAF Roaming Analytics Subscription + +#### 5.8.3.3.1 Description + +The Individual NWDAF Roaming Analytics Subscription resource represents a single subscription to the Nnwdaf\_RoamingAnalytics Service at a given RE-NWDAF. + +#### 5.8.3.3.2 Resource definition + +Resource URI: {apiRoot}/nnwdaf-roaminganalytics//subscriptions/{subscriptionId} + +The shall be set as described in clause 5.8.1. + +This resource shall support the resource URI variables defined in table 5.8.3.3.2-1. + +**Table 5.8.3.3.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|----------------|-----------|-------------------------------------------------------------------| +| apiRoot | string | See clause 5.8.1. | +| subscriptionId | string | Identifies a subscription to the Nnwdaf_RoamingAnalytics Service. | + +#### 5.8.3.3.3 Resource Standard Methods + +##### 5.8.3.3.3.1 PUT + +This method shall support the URI query parameters specified in table 5.8.3.3.3.1-1. + +**Table 5.8.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 5.8.3.3.3.1-2 and the response data structures and response codes specified in table 5.8.3.3.3.1-3. + +**Table 5.8.3.3.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|------------------------------------------------------------------| +| RoamingAnalyticsSubscription | M | 1 | Parameters to replace a subscription to NWDAF Roaming Analytics. | + +**Table 5.8.3.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------------------|---|-------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| RoamingAnalyticsSubscription | M | 1 | 200 OK | The Individual NWDAF Roaming Analytics subscription resource was modified successfully and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual NWDAF Roaming Analytics subscription resource was modified successfully. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual NWDAF Roaming Analytics subscription modification.
(NOTE 3) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual NWDAF Roaming Analytics subscription modification.
(NOTE 3) | +| ProblemDetails | O | 0..1 | 400 Bad Request | (NOTE 2) | +| ProblemDetails | O | 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.7.1-1 of 3GPP TS 29.500 [6] also apply. +NOTE 2: Failure cases are described in clause 5.8.7. +NOTE 3: The RedirectResponse data structure may be provided by an SCP or a SEPP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.8.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 RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP or SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +**Table 5.8.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 RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP or SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +### 5.8.3.3.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.8.3.3.2-1. + +**Table 5.8.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.8.3.3.3.2-2 and the response data structures and response codes specified in table 5.8.3.3.3.2-3. + +**Table 5.8.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.8.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 NWDAF Roaming Analytics subscription resource matching the subscriptionId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Roaming Analytics subscription deletion.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Roaming Analytics subscription deletion.
(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 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP or a SEPP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.8.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 RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP or SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +**Table 5.8.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 RE-NWDAF (service) instance towards which the request is redirected.

For the case where the request is redirected to the same target via a different SCP or SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target RE-NWDAF (service) instance towards which the request is redirected. | + +#### 5.8.3.3.4 Resource Custom Operations + +None in this release of the specification. + +### 5.8.4 Custom Operations without associated resources + +None in this release of the specification. + +### 5.8.5 Notifications + +#### 5.8.5.1 General + +Notifications shall comply with clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.8.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------|--------------|---------------------------------|--------------------------------------------| +| Roaming Analytics Notification | {notifUri} | POST | Report analytics related to roaming UE(s). | + +#### 5.8.5.2 Roaming Analytics Notification + +##### 5.8.5.2.1 Description + +The Roaming Analytics Notification is used by the RE-NWDAF to report analytics related to roaming UE(s) to the NF service consumer that has subscribed to such notifications. + +##### 5.8.5.2.2 Operation Definition + +Callback URI: **{notifUri}** + +The operation shall support the callback URI variables defined in Table 5.8.5.2.2-1, the request data structures specified in table 5.8.5.2.2-2 and the response data structure and response codes specified in Table 5.8.5.2.2-3. + +**Table 5.8.5.2.2-1: Callback URI variables** + +| Name | Data type | Definition | +|----------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| notifUri | Uri | The Notification Uri is assigned within the Individual NWDAF Roaming Analytics Subscription Resource and described within the RoamingAnalyticsSubscription data type. | + +**Table 5.8.5.2.2-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|------------------------------|---|-------------|----------------------------------------------| +| RoamingAnalyticsNotification | M | 1 | Provides analytics related to roaming UE(s). | + +**Table 5.8.5.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. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during the event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event 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 [6] also apply. +NOTE 2: The RedirectResponse data structure may be provided by an SCP or a SEPP (cf. clause 6.10.9.1 of 3GPP TS 29.500 [6]). + +**Table 5.8.5.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 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 or SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 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.8.5.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 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 or SEPP, refer to clause 6.10.9.1 of 3GPP TS 29.500 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance towards which the notification request is redirected. | + +## 5.8.6 Data Model + +### 5.8.6.1 General + +This clause specifies the application data model supported by the API. + +Table 5.8.6.1-1 specifies the data types defined for the Nnwdaf\_RoamingAnalytics service based interface protocol. + +**Table 5.8.6.1-1: Nnwdaf\_RoamingAnalytics specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|------------------------------|----------------|---------------------------------|---------------| +| RoamingAnalyticsSubscription | 5.8.6.2.2 | Roaming Analytics Subscription. | | +| RoamingAnalyticsNotification | 5.8.6.2.3 | Roaming Analytics Notification. | | + +Table 5.8.6.1-2 specifies data types re-used by the Nnwdaf\_RoamingAnalytics 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 Nnwdaf\_RoamingAnalytics service based interface. + +**Table 5.8.6.1-2: Nnwdaf\_RoamingAnalytics re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|----------------------------------------------------------------------------------------|----------------------| +| EventNotification | 5.1.6.2.5 | Contains NWDAF events that are being notified. | | +| EventSubscription | 5.1.6.2.3 | Contains NWDAF events to be subscribed. | | +| FailureEventInfo | 5.1.6.2.35 | Information about events for which the subscription failed. | | +| PlmnId | 3GPP TS 29.571 [8] | PLMN identifier. | | +| ReportingInformation | 3GPP TS 29.523 [20] | Represents the type of reporting the subscription requires. | | +| SupportedFeatures | 3GPP TS 29.571 [8] | Used to negotiate the applicability of the optional features defined in table 5.7.8-1. | | +| TermCause | 5.1.6.3.26 | Cause of termination of an analytics subscription. | | +| Uri | 3GPP TS 29.571 [8] | Indicates the URI. | | + +## 5.8.6.2 Structured data types + +### 5.8.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +## 5.8.6.2.2 Type RoamingAnalyticsSubscription + +Table 5.8.6.2.2-1: Definition of type RoamingAnalyticsSubscription + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|--------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| roamEventSubs | array(EventSubscription) | M | 1..N | Subscribed events. (NOTE 1) | | +| evtReq | ReportingInformation | O | 0..1 | Represents the reporting requirements of the event subscription. (NOTE 2, NOTE 3)
If omitted, the default values within the ReportingInformation data type apply. | | +| notifUri | Uri | M | 1 | Identifies the recipient of Notifications sent by the NWDAF. | | +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| consPlmnId | PlmnId | M | 1 | The PLMN ID of the NF service consumer. | | +| roamEventNotifs | array(EventNotification) | C | 1..N | Notifications about Individual Events.
Shall only be present in the response to a subscription creation or modification if the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute was set to true in the request and the reports are available. (NOTE 4) | | +| failEventReports | array(FailureEventInfo) | O | 1..N | It may be supplied by the NWDAF in the response to a subscription creation or modification. When available, it contains the event(s) for which the subscription was not successful including the failure reason(s). | | +| supportedFeatures | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.8.8.
This parameter shall be included in the response to the subscription creation or modification if it was included in the request. | | + +NOTE 1: The attributes "useCaseCxt", "accuReq", "pauseFlg", "resumeFlg", as well as the attributes "anaMeta" and "anaMetaInd" within the "extraReportReq" attribute, are not applicable here. + +NOTE 2: If the "evtReq" attribute (of data type ReportingInformation) is provided and contains the "notifMethod" attribute, the notification method indicated by the "notifMethod" attribute within the ReportingInformation data type takes precedence over the notification method indicated by the "notificationMethod" attribute within the EventSubscription data type. + +NOTE 3: If the "evtReq" attribute (of data type ReportingInformation) is provided and contains the "repPeriod" attribute, the periodic reporting time indicated by the "repPeriod" attribute in the ReportingInformation data type takes precedence over the periodic reporting time indicated by the "repetitionPeriod" attribute in the EventSubscription data type. + +NOTE 4: The attributes "anaMetaInfo", "accuInfo", "cancelAccuInd", "pauseInd", and "resumeInd" are not applicable here. + +### 5.8.6.2.3 Type RoamingAnalyticsNotification + +**Table 5.8.6.2.3-1: Definition of type RoamingAnalyticsNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|--------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| roamEventNotifs | array(EventNotification) | M | 1..N | Notifications about Individual Events.
(NOTE) | | +| notifCorrId | string | M | 1 | Notification correlation identifier. | | +| termCause | TermCause | O | 0..1 | A cause for which the NWDAF will send no further notifications for this subscription. Its presence indicates that the NWDAF requests the termination of the subscription. | | + +NOTE: The attributes "anaMetaInfo", "accuInfo", "cancelAccuInd", "pauseInd", and "resumeInd" are not applicable here. + +## 5.8.7 Error handling + +### 5.8.7.1 General + +HTTP error handling shall be supported as specified in clause 5.2.4 of TS 29.500 [6]. + +For the Nnwdaf\_RoamingAnalytics API, HTTP error responses shall be supported as specified in clause 4.8 of TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of TS 29.500 [6] 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 TS 29.500 [6]. In addition, the requirements in the following clauses shall apply. + +### 5.8.7.2 Protocol Errors + +In this Release of the specification, there are no additional protocol errors applicable for the Nnwdaf\_RoamingAnalytics API. + +### 5.8.7.3 Application Errors + +The application errors defined for the Nnwdaf\_RoamingAnalytics API are listed in table 5.8.7.3-1. + +**Table 5.8.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| BOTH_STAT_PRED_NOT_ALLOWED | 400 Bad Request | For the requested observation period, the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics. | +| UNAVAILABLE_DATA | 500 Internal Server Error | Indicates the requested statistics in the past is rejected since necessary data to perform the service is unavailable. | + +NOTE: 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.8 Feature negotiation + +The optional features in table 5.8.8-1 are defined for the Nnwdaf\_RoamingAnalytics API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +**Table 5.8.8-1: Supported Features** + +| Feature number | Feature Name | Description | +|----------------|--------------|-------------| +| | | | + +## 5.8.9 Security + +As indicated in TS 33.501 [13] and TS 29.500 [6], the access to the Nnwdaf\_RoamingAnalytics 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 TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, an NF service consumer, prior to consuming services offered by the Nnwdaf\_RoamingAnalytics API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in TS 29.510 [12], 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 Nnwdaf\_RoamingAnalytics service. + +The Nnwdaf\_RoamingAnalytics API defines a single scope "nnwdaf-roaminganalytics" 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 [11] specification of HTTP messages and content bodies used by the Nnwdaf\_EventsSubscription, the Nnwdaf\_AnalyticsInfo, Nnwdaf\_DataManagement, Nnwdaf\_ModelProvision, and Nnwdaf\_ModelTraining APIs. + +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: 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 [16] and clause 5.3.1 of the 3GPP TS 29.501 [7] for further information). + +## A.2 Nnwdaf\_EventsSubscription API + +``` +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.5 + title: Nnwdaf_EventsSubscription + description: | + Nnwdaf_EventsSubscription Service API. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/' + +security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + +servers: + - url: '{apiRoot}/nnwdaf-eventssubscription/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +paths: + /subscriptions: + post: + summary: Create a new Individual NWDAF Events Subscription + operationId: CreateNWDAFEventsSubscription + tags: + - NWDAF Events Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafEventsSubscription' + responses: + '201': + description: Create a new Individual NWDAF Event Subscription resource. + headers: + Location: +``` + +``` + +description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdafeventssubscription/{apiVersion}/subscriptions/{subscriptionId} +required: true +schema: + type: string +content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafeventsSubscription' +'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: + myNotification: + '{ $request.body#/notificationURI }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NnwdafeventsSubscriptionNotification' + minItems: 1 + 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' + +``` + +``` + +/subscriptions/{subscriptionId}: + delete: + summary: Delete an existing Individual NWDAF Events Subscription + operationId: DeleteNWDAFEventsSubscription + tags: + - Individual NWDAF Events Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_EventsSubscription Service + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF Event Subscription resource matching the subscriptionId + 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' + '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' + put: + summary: Update an existing Individual NWDAF Events Subscription + operationId: UpdateNWDAFEventsSubscription + tags: + - Individual NWDAF Events Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafEventsSubscription' + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_EventsSubscription Service. + required: true + schema: + type: string + responses: + '200': + description: > + The Individual NWDAF Event Subscription resource was modified successfully and a + representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafEventsSubscription' + '204': + description: The Individual NWDAF Event Subscription 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' + +/transfers: + post: + summary: Provide information about requested analytics subscriptions transfer and potentially +create a new Individual NWDAF Event Subscription Transfer resource. + operationId: CreateNWDAFEventSubscriptionTransfer + tags: + - NWDAF Event Subscription Transfers (Collection) + security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + - nnwdaf-eventssubscription:transfer + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AnalyticsSubscriptionsTransfer' + responses: + '201': + description: Create a new Individual NWDAF Event Subscription Transfer resource. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaf-eventssubscription/{apiVersion}/transfers/{transferId} + required: true + schema: + type: string + '204': + description: > + No Content. The receipt of the information about analytics subscription(s) that are + requested to be transferred and the ability to handle this information (e.g. execute the + steps required to transfer an analytics subscription directly) is confirmed. + '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' + +/transfers/{transferId}: + delete: + summary: Delete an existing Individual NWDAF Event Subscription Transfer + operationId: DeleteNWDAFEventSubscriptionTransfer + tags: + - Individual NWDAF Event Subscription Transfer (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + - nnwdaf-eventssubscription:transfer + parameters: + - name: transferId + in: path + description: > + String identifying a request for an analytics subscription transfer to the + Nnwdaf_EventsSubscription Service. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF Event Subscription Transfer resource matching the + transferId 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' + '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' + + put: + summary: Update an existing Individual NWDAF Event Subscription Transfer + operationId: UpdateNWDAFEventSubscriptionTransfer + tags: + - Individual NWDAF Event Subscription Transfer (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + - oAuth2ClientCredentials: + - nnwdaf-eventssubscription + - nnwdaf-eventssubscription:transfer + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AnalyticsSubscriptionsTransfer' + parameters: +``` + +``` +- name: transferId + in: path + description: > + String identifying a request for an analytics subscription transfer to the + Nnwdaf_EventsSubscription Service + required: true + schema: + type: string +responses: + '204': + description: > + The Individual NWDAF Event Subscription Transfer 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' + +components: + +securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnwdafeventssubscription: Access to the Nnwdaf_EventsSubscription API + nnwdafeventssubscription:transfer: > + Access to service operations applying to NWDAF event subscription transfer. + +schemas: + +NnwdafEventsSubscription: + description: Represents an Individual NWDAF Event Subscription resource. + type: object + properties: + eventSubscriptions: + type: array + items: + $ref: '#/components/schemas/EventSubscription' + minItems: 1 + description: Subscribed events + evtReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notificationURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + eventNotifications: +``` + +``` + type: array + items: + $ref: '#/components/schemas/EventNotification' + minItems: 1 + failEventReports: + type: array + items: + $ref: '#/components/schemas/FailureEventInfo' + minItems: 1 + prevSub: + $ref: '#/components/schemas/PrevSubInfo' + consNfInfo: + $ref: '#/components/schemas/ConsumerNfInformation' + required: + - eventSubscriptions + +EventSubscription: + description: Represents a subscription to a single event. + type: object + properties: + anySlice: + $ref: '#/components/schemas/AnySlice' + appIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + minItems: 1 + description: Identification(s) of application to which the subscription applies. + deviations: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + minItems: 1 + dnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + description: Identification(s) of DNN to which the subscription applies. + dnais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + event: + $ref: '#/components/schemas/Nwdafevent' + extraReportReq: + $ref: '#/components/schemas/EventReportingRequirement' + ladnDnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + description: Identification(s) of LADN DNN to indicate the LADN service area as the AOI. + loadLevelThreshold: + type: integer + description: > + Indicates that the NWDAF shall report the corresponding network slice load level to the + NF service consumer where the load level of the network slice identified by snssais is + reached. + notificationMethod: + $ref: '#/components/schemas/NotificationMethod' + matchingDir: + $ref: '#/components/schemas/MatchingDirection' + nfLoadLvlThds: + type: array + items: + $ref: '#/components/schemas/ThresholdLevel' + minItems: 1 + description: > + Shall be supplied in order to start reporting when an average load level is reached. + nfInstanceIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + nfSetIds: + type: array +``` + +``` +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +minItems: 1 +nfTypes: +type: array +items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' +minItems: 1 +networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' +location: + $ref: '#/components/schemas/GeoLocation' +temporalGranSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +spatialGranSizeTa: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +spatialGranSizeCell: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +fineGranAreas: +type: array +items: + $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' +minItems: 1 +description: Indicates the fine granularity areas to which the subscription applies. +visitedAreas: +type: array +items: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' +minItems: 1 +maxTopAppUINbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +maxTopAppDlNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +nsiIdInfos: +type: array +items: + $ref: '#/components/schemas/NsiIdInfo' +minItems: 1 +nsiLevelThrds: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +minItems: 1 +qosRequ: + $ref: '#/components/schemas/QosRequirement' +qosFlowRetThrds: +type: array +items: + $ref: '#/components/schemas/RetainabilityThreshold' +minItems: 1 +ranUeThrouThrds: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' +minItems: 1 +repetitionPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +snssai: +type: array +items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +minItems: 1 +description: > + Identification(s) of network slice to which the subscription applies. It corresponds to + snssais in the data model definition of 3GPP TS 29.520. +tgtUe: + $ref: '#/components/schemas/TargetUeInformation' +roamingInfo: + $ref: '#/components/schemas/RoamingInfo' +congThresholds: +type: array +items: + $ref: '#/components/schemas/ThresholdLevel' +minItems: 1 +nwPerfRequs: +type: array +items: + $ref: '#/components/schemas/NetworkPerfRequirement' +``` + +``` + minItems: 1 + ueCommReqs: + type: array + items: + $ref: '#/components/schemas/UeCommReq' + minItems: 1 + ueMobilityReqs: + type: array + items: + $ref: '#/components/schemas/UeMobilityReq' + minItems: 1 + userDataConOrderCri: + $ref: '#/components/schemas/UserDataConOrderCrit' + bwReqs: + type: array + items: + $ref: '#/components/schemas/BwRequirement' + minItems: 1 + excepReqs: + type: array + items: + $ref: '#/components/schemas/Exception' + minItems: 1 + exptAnaType: + $ref: '#/components/schemas/ExpectedAnalyticsType' + exptUeBehav: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExpectedUeBehaviourData' + ratFreqs: + type: array + items: + $ref: '#/components/schemas/RatFreqInformation' + minItems: 1 + listOfAnaSubsets: + type: array + items: + $ref: '#/components/schemas/AnalyticsSubset' + minItems: 1 + disperReqs: + type: array + items: + $ref: '#/components/schemas/DispersionRequirement' + minItems: 1 + redTransReqs: + type: array + items: + $ref: '#/components/schemas/RedundantTransmissionExpReq' + minItems: 1 + wlanReqs: + type: array + items: + $ref: '#/components/schemas/WlanPerformanceReq' + minItems: 1 + upfInfo: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/UpfInformation' + appServerAddrs: + type: array + items: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' + minItems: 1 + dnPerfReqs: + type: array + items: + $ref: '#/components/schemas/DnPerformanceReq' + minItems: 1 + pduSesInfos: + type: array + items: + $ref: '#/components/schemas/PduSessionInfo' + minItems: 1 + useCaseCxt: + type: string + description: > + Indicates the context of usage of the analytics. The value and format of this parameter + are not standardized. + pduSesTrafReqs: + type: array + items: + $ref: '#/components/schemas/PduSesTrafficReq' +``` + +``` + + minItems: 1 + locAccReqs: + type: array + items: + $ref: '#/components/schemas/LocAccuracyReq' + minItems: 1 + locGranularity: + $ref: '#/components/schemas/LocInfoGranularity' + locOrientation: + $ref: '#/components/schemas/LocationOrientation' + dataVlTrnsTmRqs: + type: array + items: + $ref: '#/components/schemas/E2eDataVolTransTimeReq' + minItems: 1 + accuReq: + $ref: '#/components/schemas/AccuracyReq' + pauseFlg: + type: boolean + description: > + Pause analytics consumption flag. Set to "true" to indicate the NWDAF to stop sending + the notifications of analytics. Default value is "false" if omitted. + resumeFlg: + type: boolean + description: > + Resume analytics consumption flag. Set to "true" to indicate the NWDAF to resume sending + the notifications of analytics. Default value is "false" if omitted. + movBehavReqs: + type: array + items: + $ref: '#/components/schemas/MovBehavReq' + minItems: 1 + relProxReqs: + type: array + items: + $ref: '#/components/schemas/RelProxReq' + minItems: 1 + feedback: + $ref: '#/components/schemas/AnalyticsFeedbackInfo' + required: + - event + not: + - required: [excepReqs, exptAnaType] + +NnwdafEventsSubscriptionNotification: + description: Represents an Individual NWDAF Event Subscription Notification resource. + type: object + properties: + eventNotifications: + type: array + items: + $ref: '#/components/schemas/EventNotification' + minItems: 1 + description: Notifications about Individual Events + subscriptionId: + type: string + description: String identifying a subscription to the Nnwdaf_EventsSubscription Service + notifCorrId: + type: string + description: Notification correlation identifier. + oldSubscriptionId: + type: string + description: > + Subscription ID which was allocated by the source NWDAF. This parameter shall be present + if the notification is for informing the assignment of a new Subscription Id by the + target NWDAF. + resourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + termCause: + $ref: '#/components/schemas/TermCause' + transEvents: + type: array + items: + $ref: '#/components/schemas/NwdafEvent' + minItems: 1 + required: + - subscriptionId + oneOf: + +``` + +``` +- required: [eventNotifications] +- allOf: + - required: [resourceUri] + - required: [oldSubscriptionId] + +EventNotification: + description: Represents a notification on events that occurred. + type: object + properties: + event: + $ref: '#/components/schemas/Nwdafevent' + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + expiry: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeStampGen: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + failNotifyCode: + $ref: '#/components/schemas/NwdafeventFailureCode' + rvWaitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + anaMetaInfo: + $ref: '#/components/schemas/AnalyticsMetadataInfo' + nfLoadLevelInfos: + type: array + items: + $ref: '#/components/schemas/NfLoadLevelInformation' + minItems: 1 + nsiLoadLevelInfos: + type: array + items: + $ref: '#/components/schemas/NsiLoadLevelInfo' + minItems: 1 + pfdDetermInfos: + type: array + items: + $ref: '#/components/schemas/PfdDeterminationInfo' + minItems: 1 + sliceLoadLevelInfo: + $ref: '#/components/schemas/SliceLoadLevelInformation' + svcExps: + type: array + items: + $ref: '#/components/schemas/ServiceExperienceInfo' + minItems: 1 + qosSustainInfos: + type: array + items: + $ref: '#/components/schemas/QosSustainabilityInfo' + minItems: 1 + ueComms: + type: array + items: + $ref: '#/components/schemas/UeCommunication' + minItems: 1 + ueMobs: + type: array + items: + $ref: '#/components/schemas/UeMobility' + minItems: 1 + userDataCongInfos: + type: array + items: + $ref: '#/components/schemas/UserDataCongestionInfo' + minItems: 1 + abnorBehavrs: + type: array + items: + $ref: '#/components/schemas/AbnormalBehaviour' + minItems: 1 + nwPerfs: + type: array + items: + $ref: '#/components/schemas/NetworkPerfInfo' + minItems: 1 + dnPerfInfos: + type: array + items: +``` + +``` + $ref: '#/components/schemas/DnPerfInfo' + minItems: 1 + disperInfos: + type: array + items: + $ref: '#/components/schemas/DispersionInfo' + minItems: 1 + redTransInfos: + type: array + items: + $ref: '#/components/schemas/RedundantTransmissionExpInfo' + minItems: 1 + wlanInfos: + type: array + items: + $ref: '#/components/schemas/WlanPerformanceInfo' + minItems: 1 + smccExps: + type: array + items: + $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/SmcceInfo' + minItems: 1 + pduSesTrafInfos: + type: array + items: + $ref: '#/components/schemas/PduSesTrafficInfo' + minItems: 1 + dataVlTrnsTmInfos: + type: array + items: + $ref: '#/components/schemas/E2eDataVolTransTimeInfo' + minItems: 1 + accuInfo: + $ref: '#/components/schemas/AccuracyInfo' + cancelAccuInd: + type: boolean + description: > + Indicates cancelled subscription of the analytics accuracy information. + Set to "true" indicates the NWDAF cancelled subscription of analytics accuracy + information as the NWDAF does not support the accuracy checking capability. + Otherwise set to "false". Default value is "false" if omitted. + pauseInd: + type: boolean + description: > + Pause analytics consumption indication. Set to "true" to indicate the consumer to stop + the consumption of the analytics. Default value is "false" if omitted. + resumeInd: + type: boolean + description: > + Resume analytics consumption indication. Set to "true" to indicate the consumer to + resume the consumption of the analytics. Default value is "false" if omitted. + movBehavInfos: + type: array + items: + $ref: '#/components/schemas/MovBehavInfo' + minItems: 1 + locAccInfos: + type: array + items: + $ref: '#/components/schemas/LocAccuracyInfo' + minItems: 1 + relProxInfos: + type: array + items: + $ref: '#/components/schemas/RelProxInfo' + minItems: 1 + required: + - event + +ServiceExperienceInfo: + description: Represents service experience information. + type: object + properties: + svcExprc: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/SvcExperience' + svcExprcVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + supis: +``` + +``` + + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + srvExpctype: + $ref: '#/components/schemas/ServiceExperienceType' + ueLocs: + type: array + items: + $ref: '#/components/schemas/LocationInfo' + minItems: 1 + upfInfo: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/UpfInformation' + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + appServerInst: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + nsiId: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + ratFreq: + $ref: '#/components/schemas/RatFreqInformation' + pduSesInfo: + $ref: '#/components/schemas/PduSessionInfo' + required: + - svcExprc + +BwRequirement: + description: Represents bandwidth requirements. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + required: + - appId + +SliceLoadLevelInformation: + description: Contains load level information applicable for one or several slices. + type: object + properties: + loadLevelInformation: + $ref: '#/components/schemas/LoadLevelInformation' + snssais: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + minItems: 1 + description: Identification(s) of network slice to which the subscription applies. + required: + - loadLevelInformation + - snssais + +NsiLoadLevelInfo: + description: > + Represents the network slice and optionally the associated network slice instance and the + load level information. + type: object + properties: + loadLevelInformation: + +``` + +``` +$ref: '#/components/schemas/LoadLevelInformation' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +nsiId: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' +resUsage: + $ref: '#/components/schemas/ResourceUsage' +numOfExceedLoadLevelThr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +exceedLoadLevelThrInd: + type: boolean + description: > + Indicates whether the Load Level Threshold is met or exceeded by the statistics value. + Set to "true" if the Load Level Threshold is met or exceeded, otherwise set to "false". + Shall be present if one of the element in the "listOfAnaSubsets" attribute was set to + EXCEED_LOAD_LEVEL_THR_IND. +networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' +timePeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' +resUsgThrCrossTimePeriod: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + minItems: 1 + description: > + Each element indicates the time elapsed between times each threshold is met or exceeded + or crossed. The start time and end time are the exact time stamps of the resource usage + threshold is reached or exceeded. May be present if the "listOfAnaSubsets" attribute is + provided and the maximum number of instances shall not exceed the value provided in the + "numOfExceedLoadLevelThr" attribute. +numOfUes: + $ref: '#/components/schemas/NumberAverage' +numOfPduSess: + $ref: '#/components/schemas/NumberAverage' +confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +required: +- loadLevelInformation +- snssai + +NsiIdInfo: + description: Represents the S-NSSAI and the optionally associated Network Slice Instance(s). + type: object + properties: + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + nsiIds: + type: array + items: + $ref: 'TS29531_Nnssf_NSSelection.yaml#/components/schemas/NsiId' + minItems: 1 + required: + - snssai + +EventReportingRequirement: + description: Represents the type of reporting that the subscription requires. + type: object + properties: + accuracy: + $ref: '#/components/schemas/Accuracy' + accPerSubset: + type: array + items: + $ref: '#/components/schemas/Accuracy' + minItems: 1 + description: > + Each element indicates the preferred accuracy level per analytics subset. It may be + present if the "listOfAnaSubsets" attribute is present in the subscription request. + startTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + offsetPeriod: + type: integer + description: > + Offset period in units of seconds to the reporting time, if the value is negative means + statistics in the past offset period, otherwise a positive value means prediction in the +``` + +``` + future offset period. May be present if the "repPeriod" attribute is included within the + "evtReq" attribute or the "repetitionPeriod" attribute is included within the + EventSubscription type. + sampRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + maxObjectNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + maxSupiNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + timeAnaNeeded: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + anaMeta: + type: array + items: + $ref: '#/components/schemas/AnalyticsMetadata' + minItems: 1 + anaMetaInd: + $ref: '#/components/schemas/AnalyticsMetadataIndication' + histAnaTimePeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + +TargetUeInformation: + description: Identifies the target UE information. + type: object + properties: + anyUe: + type: boolean + description: > + Identifies any UE when setting to "true". Default value is "false" if omitted. + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + intGroupIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + +UeMobility: + description: Represents UE mobility information. + type: object + properties: + ts: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + recurringTime: + $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime' + duration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + durationVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + locInfos: + type: array + items: + $ref: '#/components/schemas/LocationInfo' + minItems: 1 + directionInfos: + type: array + items: + $ref: '#/components/schemas/DirectionInfo' + minItems: 1 + allOf: + - required: [duration] + - required: [locInfos] + - oneOf: + - required: [ts] + - required: [recurringTime] + +LocationInfo: + description: Represents UE location information. + type: object + properties: +``` + +``` +loc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' +geoLoc: + $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' +ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' +confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +geoDistrInfos: + type: array + items: + $ref: '#/components/schemas/GeoDistributionInfo' + minItems: 1 +distThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +required: +- loc + +DirectionInfo: +description: Represents the UE direction information. +type: object +properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + numOfUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + avrSpeed: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + direction: + $ref: '#/components/schemas/Direction' +required: +- direction +oneOf: +- required: [supi] +- required: [gpsi] + +GeoDistributionInfo: +description: Represents the geographical distribution of the UEs. +type: object +properties: + loc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 +required: +- loc +oneOf: +- required: [supis] +- required: [gpsis] + +UeCommunication: +description: Represents UE communication information. +type: object +properties: + commDur: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + commDurVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + perioTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + perioTimeVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + ts: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tsVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' +``` + +``` + +recurringTime: + $ref: 'TS29122_CpProvisioning.yaml#/components/schemas/ScheduledCommunicationTime' +trafChar: + $ref: '#/components/schemas/TrafficCharacterization' +ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' +perioCommInd: + type: boolean + description: > + This attribute indicates whether the UE communicates periodically or not. Set to "true" + to indicate the UE communicates periodically, otherwise set to "false" or omitted. +confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +anaOfAppList: + $ref: '#/components/schemas/AppListForUeComm' +sessInactTimer: + $ref: '#/components/schemas/SessInactTimerForUeComm' +allOf: +- required: [commDur] +- required: [trafChar] +- oneOf: + - required: [ts] + - required: [recurringTime] +TrafficCharacterization: + description: Identifies the detailed traffic characterization. + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + fDescs: + type: array + items: + $ref: '#/components/schemas/IpEthFlowDescription' + minItems: 1 + maxItems: 2 + ulVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + ulVolVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + dlVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + dlVolVariance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + anyOf: + - required: [ulVol] + - required: [dlVol] +UserDataCongestionInfo: + description: Represents the user data congestion information. + type: object + properties: + networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + congestionInfo: + $ref: '#/components/schemas/CongestionInfo' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + required: + - networkArea + - congestionInfo +CongestionInfo: + description: Represents the congestion information. + type: object + properties: + congType: + $ref: '#/components/schemas/CongestionType' + timeIntev: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + nsi: + $ref: '#/components/schemas/ThresholdLevel' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + topAppListUl: + +``` + +``` + type: array + items: + $ref: '#/components/schemas/TopApplication' + minItems: 1 + topAppListDl: + type: array + items: + $ref: '#/components/schemas/TopApplication' + minItems: 1 + required: + - congType + - timeIntev + - nsi + + TopApplication: + description: Top application that contributes the most to the traffic. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ipTrafficFilter: + $ref: 'TS29122_CommonData.yaml#/components/schemas/FlowInfo' + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + oneOf: + - required: [appId] + - required: [ipTrafficFilter] + + QosSustainabilityInfo: + description: Represents the QoS Sustainability information. + type: object + properties: + areaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + fineAreaInfos: + type: array + items: + $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' + minItems: 1 + description: > + This attribute contains the geographical locations in a fine granularity. + + startTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endTs: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + qosFlowRetThd: + $ref: '#/components/schemas/RetainabilityThreshold' + ranUeThrouThd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + oneOf: + - required: [qosFlowRetThd] + - required: [ranUeThrouThd] + + QosRequirement: + description: Represents the QoS requirements. + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + gfbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + gfbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + resType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/QosResourceType' + pdb: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + per: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + deviceSpeed: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + deviceType: + $ref: '#/components/schemas/DeviceType' + oneOf: +``` + +``` +- required: [5qi] +- required: [resType] + +ThresholdLevel: + description: Represents a threshold level. + type: object + properties: + congLevel: + type: integer + nfLoadLevel: + type: integer + nfCpuUsage: + type: integer + nfMemoryUsage: + type: integer + nfStorageUsage: + type: integer + avgTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + aggTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + varTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + maxPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + varPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgPacketLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + maxPacketLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + varPacketLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + svcExpLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + speed: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + +NfLoadLevelInformation: + description: Represents load level information of a given NF instance. + type: object + properties: + nfType: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + nfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + nfStatus: + $ref: '#/components/schemas/NfStatus' + nfCpuUsage: + type: integer + nfMemoryUsage: + type: integer + nfStorageUsage: + type: integer + nfLoadLevelAverage: + type: integer + nfLoadLevelpeak: + type: integer + nfLoadAvgInAoi: + type: integer + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + allOf: + - required: [nfType] + - required: [nfInstanceId] + - anyOf: + - required: [nfStatus] + - required: [nfCpuUsage] +``` + +``` + - required: [nfMemoryUsage] + - required: [nfStorageUsage] + - required: [nfLoadLevelAverage] + - required: [nfLoadLevelPeak] + +NfStatus: + description: Contains the percentage of time spent on various NF states. + type: object + properties: + statusRegistered: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + statusUnregistered: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + statusUndiscoverable: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + anyOf: + - required: [statusRegistered] + - required: [statusUnregistered] + - required: [statusUndiscoverable] + +AnySlice: + type: boolean + description: > + "false" represents not applicable for all slices. "true" represents applicable for all +slices. + +LoadLevelInformation: + type: integer + description: > + Load level information of the network slice and the optionally associated network slice +instance. + +AbnormalBehaviour: + description: Represents the abnormal behaviour information. + type: object + properties: + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + excep: + $ref: '#/components/schemas/Exception' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + addtMeasInfo: + $ref: '#/components/schemas/AdditionalMeasurement' + required: + - excep + +Exception: + description: Represents the Exception information. + type: object + properties: + excepId: + $ref: '#/components/schemas/ExceptionId' + excepLevel: + type: integer + excepTrend: + $ref: '#/components/schemas/ExceptionTrend' + required: + - excepId + +AdditionalMeasurement: + description: Represents additional measurement information. + type: object + properties: + unexpLoc: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + unexpFlowTeps: + type: array + items: +``` + +``` + $ref: '#/components/schemas/IpEthFlowDescription' + minItems: 1 + unexpWakes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minItems: 1 + ddosAttack: + $ref: '#/components/schemas/AddressList' + wrgDest: + $ref: '#/components/schemas/AddressList' + circums: + type: array + items: + $ref: '#/components/schemas/CircumstanceDescription' + minItems: 1 + +IpEthFlowDescription: + description: Contains the description of an Uplink and/or Downlink Ethernet flow. + type: object + properties: + ipTrafficFilter: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + ethTrafficFilter: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + oneOf: + - required: [ipTrafficFilter] + - required: [ethTrafficFilter] + +AddressList: + description: Represents a list of IPv4 and/or IPv6 addresses. + 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 + +CircumstanceDescription: + description: Contains the description of a circumstance. + type: object + properties: + freq: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + tm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + locArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + vol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + +RetainabilityThreshold: + description: Represents a QoS flow retainability threshold. + type: object + properties: + relFlowNum: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + relTimeUnit: + $ref: '#/components/schemas/TimeUnit' + relFlowRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + oneOf: + - allOf: + - required: [relFlowNum] + - required: [relTimeUnit] + - required: [relFlowRatio] + +NetworkPerfRequirement: + description: Represents a network performance requirement. + type: object + properties: + nwPerfType: +``` + +``` + $ref: '#/components/schemas/NetworkPerfType' + relativeRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + absoluteNum: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + orderCriterion: + $ref: '#/components/schemas/NetworkPerfOrderCriterion' + rscUsgReq: + $ref: '#/components/schemas/ResourceUsageRequirement' + required: + - nwPerfType + not: + - required: [relativeRatio, absoluteNum] + +NetworkPerfInfo: + description: Represents the network performance information. + type: object + properties: + networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + nwPerfType: + $ref: '#/components/schemas/NetworkPerfType' + anaPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + relativeRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + absoluteNum: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + rscUsgReq: + $ref: '#/components/schemas/ResourceUsageRequirement' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + allOf: + - required: [networkArea] + - required: [nwPerfType] + - oneOf: + - required: [relativeRatio] + - required: [absoluteNum] + +FailureEventInfo: + description: Contains information on the event for which the subscription is not successful. + type: object + properties: + event: + $ref: '#/components/schemas/NwdafEvent' + failureCode: + $ref: '#/components/schemas/NwdafFailureCode' + required: + - event + - failureCode + +AnalyticsMetadataIndication: + description: > + Contains analytics metadata information requested to be used during analytics generation. + type: object + properties: + dataWindow: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dataStatProps: + type: array + items: + $ref: '#/components/schemas/DatasetStatisticalProperty' + minItems: 1 + strategy: + $ref: '#/components/schemas/OutputStrategy' + aggrNwdaIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + +AnalyticsMetadataInfo: + description: Contains analytics metadata information required for analytics aggregation. + type: object + properties: + numSamples: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + dataWindow: +``` + +``` +$ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' +dataStatProps: + type: array + items: + $ref: '#/components/schemas/DatasetStatisticalProperty' + minItems: 1 + strategy: + $ref: '#/components/schemas/OutputStrategy' + accuracy: + $ref: '#/components/schemas/Accuracy' +NumberAverage: + description: Represents average and variance information. + type: object + properties: + number: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + variance: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + skewness: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + required: + - number + - variance + +AnalyticsSubscriptionsTransfer: + description: Contains information about a request to transfer analytics subscriptions. + type: object + properties: + subsTransInfos: + type: array + items: + $ref: '#/components/schemas/SubscriptionTransferInfo' + minItems: 1 + failTransEventReports: + type: array + items: + $ref: '#/components/schemas/NwdafEvent' + minItems: 1 + required: + - subsTransInfos + +SubscriptionTransferInfo: + description: Contains information about subscriptions that are requested to be transferred. + type: object + properties: + transReqType: + $ref: '#/components/schemas/TransferRequestType' + nwdafEvSub: + $ref: '#/components/schemas/NnwdafEventsSubscription' + consumerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + contextId: + $ref: '#/components/schemas/AnalyticsContextIdentifier' + sourceNfIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + sourceSetIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + modelInfo: + type: array + items: + $ref: '#/components/schemas/ModelInfo' + minItems: 1 + required: + - transReqType + - nwdafEvSub + - consumerId + +ModelInfo: + description: Contains information about an ML model. + type: object + properties: + analyticsId: +``` + +``` + + $ref: '#/components/schemas/NwdafEvent' + mlModelInfos: + type: array + items: + $ref: '#/components/schemas/MLModelInfo' + minItems: 1 + required: + - analyticsId + - mlModelInfos +MLModelInfo: + description: Contains information about an ML models. + type: object + properties: + mlFileAddrs: + type: array + items: + $ref: 'TS29520_Nnwdaf_MLModelProvision.yaml#/components/schemas/MLModelAddr' + minItems: 1 + modelProvId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + modelProvSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + oneOf: + - required: [modelProvId] + - required: [modelProvSetId] + +AnalyticsContextIdentifier: + description: Contains information about available analytics contexts. + type: object + properties: + subscriptionId: + type: string + description: The identifier of a subscription. + nfAnaCtxts: + type: array + items: + $ref: '#/components/schemas/NwdafEvent' + minItems: 1 + description: > + List of analytics types for which NF related analytics contexts can be retrieved. + ueAnaCtxts: + type: array + items: + $ref: '#/components/schemas/UeAnalyticsContextDescriptor' + minItems: 1 + description: > + List of objects that indicate for which SUPI and analytics types combinations analytics + context can be retrieved. + allOf: + - anyOf: + - required: [nfAnaCtxts] + - required: [ueAnaCtxts] + - required: [subscriptionId] + +UeAnalyticsContextDescriptor: + description: Contains information about available UE related analytics contexts. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + anaTypes: + type: array + items: + $ref: '#/components/schemas/NwdafEvent' + minItems: 1 + description: > + List of analytics types for which UE related analytics contexts can be retrieved. + required: + - supi + - anaTypes + +DnPerfInfo: + description: Represents DN performance information. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + dnn: + +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +dnPerf: + type: array + items: + $ref: '#/components/schemas/DnPerf' + minItems: 1 + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + required: + - dnPerf + +DnPerf: + description: Represents DN performance for the application. + type: object + properties: + appServerInsAddr: + $ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' + upfInfo: + $ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/UpfInformation' + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + perfData: + $ref: '#/components/schemas/PerfData' + spatialValidCon: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + temporalValidCon: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + required: + - perfData + +PerfData: + description: Represents DN performance data. + type: object + properties: + avgTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + aggTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + varTrafficRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + trafRateUeIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + avePacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + maxPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + varPacketDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + packDelayUeIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + avgPacketLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + maxPacketLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + varPacketLossRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + packLossUeIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + numOfUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +DispersionRequirement: + description: Represents the dispersion analytics requirements. +``` + +``` +type: object +properties: + disperType: + $ref: '#/components/schemas/DispersionType' + classCriters: + type: array + items: + $ref: '#/components/schemas/ClassCriterion' + minItems: 1 + rankCriters: + type: array + items: + $ref: '#/components/schemas/RankingCriterion' + minItems: 1 + dispOrderCriter: + $ref: '#/components/schemas/DispersionOrderingCriterion' + order: + $ref: '#/components/schemas/MatchingDirection' +required: +- disperType + +ClassCriterion: +description: > + Indicates the dispersion class criterion for fixed, camper and/or traveller UE, and/or the + top-heavy UE dispersion class criterion. +type: object +properties: + disperClass: + $ref: '#/components/schemas/DispersionClass' + classThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + thresMatch: + $ref: '#/components/schemas/MatchingDirection' +required: +- disperClass +- classThreshold +- thresMatch + +RankingCriterion: +description: Indicates the usage ranking criterion between the high, medium and low usage UE. +type: object +properties: + highBase: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + lowBase: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' +required: +- highBase +- lowBase + +DispersionInfo: +description: > + Represents the Dispersion information. When subscribed event is "DISPERSION", the + "disperInfos" attribute shall be included. +type: object +properties: + tsStart: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tsDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + disperCollects: + type: array + items: + $ref: '#/components/schemas/DispersionCollection' + minItems: 1 + disperType: + $ref: '#/components/schemas/DispersionType' +required: +- tsStart +- tsDuration +- disperCollects +- disperType + +DispersionCollection: +description: Dispersion collection per UE location or per slice. +type: object +properties: + ueLoc: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gpsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + appVolumes: + type: array + items: + $ref: '#/components/schemas/ApplicationVolume' + minItems: 1 + disperAmount: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + disperClass: + $ref: '#/components/schemas/DispersionClass' + usageRank: + type: integer + description: Integer where the allowed values correspond to 1, 2, 3 only. + minimum: 1 + maximum: 3 + percentileRank: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + ueRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + allOf: + - oneOf: + - required: [ueLoc] + - required: [snssai] + - anyOf: + - required: [disperAmount] + - required: [disperClass] + - required: [usageRank] + - required: [percentileRank] + +ApplicationVolume: + description: Application data volume per Application Id. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + appVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + required: + - appId + - appVolume + +RedundantTransmissionExpReq: + description: Represents other redundant transmission experience analytics requirements. + type: object + properties: + redTOrderCriter: + $ref: '#/components/schemas/RedTransExpOrderingCriterion' + order: + $ref: '#/components/schemas/MatchingDirection' + +RedundantTransmissionExpInfo: + description: > + The redundant transmission experience related information. When subscribed event is + "RED_TRANS_EXP", the "redTransInfos" attribute shall be included. + type: object + properties: + spatialValidCon: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + redTransExps: + type: array + items: + $ref: '#/components/schemas/RedundantTransmissionExpPerTS' + +``` + +``` + + minItems: 1 + required: + - redTransExps + +RedundantTransmissionExpPerTS: + description: The redundant transmission experience per Time Slot. + type: object + properties: + tsStart: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tsDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + obsvRedTransExp: + $ref: '#/components/schemas/ObservedRedundantTransExp' + redTransStatus: + type: boolean + description: > + Redundant Transmission Status. Set to "true" if redundant transmission was activated, + otherwise set to "false". Default value is "false" if omitted. + ueRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + required: + - tsStart + - tsDuration + - obsvRedTransExp + +ObservedRedundantTransExp: + description: Represents the observed redundant transmission experience related information. + type: object + properties: + avgPktDropRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + varPktDropRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgPktDropRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + varPktDropRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgPktDelayUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + varPktDelayUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgPktDelayDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + varPktDelayDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgE2ePktDelayUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + varE2ePktDelayUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgE2ePktDelayDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + varE2ePktDelayDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgE2ePktLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + varE2ePktLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + avgE2ePktLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRate' + varE2ePktLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + +WlanPerformanceReq: + description: Represents other WLAN performance analytics requirements. + type: object + properties: + ssIds: + type: array + items: + type: string + minItems: 1 + bssIds: + type: array + items: + type: string + minItems: 1 + +``` + +``` +wlanOrderCriter: + $ref: '#/components/schemas/WlanOrderingCriterion' +order: + $ref: '#/components/schemas/MatchingDirection' + +WlanPerformanceInfo: + description: The WLAN performance related information. + type: object + properties: + networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + wlanPerSsidInfos: + type: array + items: + $ref: '#/components/schemas/WlanPerSsidPerformanceInfo' + minItems: 1 + wlanPerUeIdInfos: + type: array + items: + $ref: '#/components/schemas/WlanPerUeIdPerformanceInfo' + minItems: 1 + description: > + WLAN performance information for UE Id(s) of WLAN access points deployed in the Area + of Interest. + required: + - wlanPerSsidInfos + +WlanPerSsidPerformanceInfo: + description: The WLAN performance per SSID. + type: object + properties: + ssid: + type: string + wlanPerTsInfos: + type: array + items: + $ref: '#/components/schemas/WlanPerTsPerformanceInfo' + minItems: 1 + required: + - ssid + - wlanPerTsInfos + +WlanPerUeIdPerformanceInfo: + description: The WLAN performance per UE ID. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + wlanPerTsInfos: + type: array + items: + $ref: '#/components/schemas/WlanPerTsPerformanceInfo' + minItems: 1 + description: > + WLAN performance information per Time Slot during the analytics target period. + required: + - supi + - wlanPerTsInfos + +WlanPerTsPerformanceInfo: + description: WLAN performance information per Time Slot during the analytics target period. + type: object + properties: + tsStart: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tsDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + rssi: + type: integer + rtt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + trafficInfo: + $ref: '#/components/schemas/TrafficInformation' + numberOfUes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + required: +``` + +``` +- tsStart +- tsDuration +anyOf: +- required: [rssi] +- required: [rtt] +- required: [trafficInfo] +- required: [numberOfUes] + +TrafficInformation: +description: Traffic information including UL/DL data rate and/or Traffic volume. +type: object +properties: + uplinkRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + downlinkRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + uplinkVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + downlinkVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + totalVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' +anyOf: +- required: [uplinkRate] +- required: [downlinkRate] +- required: [uplinkVolume] +- required: [downlinkVolume] +- required: [totalVolume] + +AppListForUeComm: +description: Represents the analytics of the application list used by UE. +type: object +properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + appDur: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + occurRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + spatialValidity: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' +required: +- appId + +SessInactTimerForUeComm: +description: Represents the N4 Session inactivity timer. +type: object +properties: + n4SessId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + sessInactiveTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +required: +- n4SessId +- sessInactiveTimer + +DnPerformanceReq: +description: Represents other DN performance analytics requirements. +type: object +properties: + dnPerfOrderCriter: + $ref: '#/components/schemas/DnPerfOrderingCriterion' + order: + $ref: '#/components/schemas/MatchingDirection' + reportThresholds: + type: array + items: + $ref: '#/components/schemas/ThresholdLevel' + minItems: 1 + +RatFreqInformation: +description: Represents the RAT type and/or Frequency information. +type: object +properties: + allFreq: + type: boolean +``` + +``` + description: > + Set to "true" to indicate to handle all the frequencies the NWDAF received, otherwise + set to "false" or omit. The "allFreq" attribute and the "freq" attribute are mutually + exclusive. + allRat: + type: boolean + description: > + Set to "true" to indicate to handle all the RAT Types the NWDAF received, otherwise + set to "false" or omit. The "allRat" attribute and the "ratType" attribute are mutually + exclusive. + freq: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ArfcnValueNR' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + svcExpThreshold: + $ref: '#/components/schemas/ThresholdLevel' + matchingDir: + $ref: '#/components/schemas/MatchingDirection' + +PrevSubInfo: + description: Information of the previous subscription. + type: object + properties: + producerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + producerSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + subscriptionId: + type: string + description: The identifier of a subscription. + nfAnaEvents: + type: array + items: + $ref: '#/components/schemas/NwdafEvent' + minItems: 1 + ueAnaEvents: + type: array + items: + $ref: '#/components/schemas/UeAnalyticsContextDescriptor' + minItems: 1 + required: + - subscriptionId + oneOf: + - required: [producerId] + - required: [producerSetId] + +ResourceUsage: + description: > + The current usage of the virtual resources assigned to the NF instances belonging to a + particular network slice instance. + type: object + properties: + cpuUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + memoryUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + storageUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +ConsumerNfInformation: + description: Represents the analytics consumer NF Information. + type: object + properties: + nfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + nfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + taiList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' + minItems: 1 + oneOf: + - oneOf: + - required: [nfId] + - required: [nfSetId] + - required: [taiList] +``` + +``` +UeCommReq: + description: UE communication analytics requirement. + type: object + properties: + orderCriterion: + $ref: '#/components/schemas/UeCommOrderCriterion' + orderDirection: + $ref: '#/components/schemas/MatchingDirection' +UeMobilityReq: + description: UE mobility analytics requirement. + type: object + properties: + orderCriterion: + $ref: '#/components/schemas/UeMobilityOrderCriterion' + orderDirection: + $ref: '#/components/schemas/MatchingDirection' + ueLocOrderInd: + type: boolean + description: > + UE Location order indication. Set to "true" to indicate the NWDAF to provide UE + locations in the UE Mobility analytics in time order, otherwise set to "false" or + omitted. + distThresholds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 + description: Indicates the linear distance threshold. + +PduSessionInfo: + description: Represents combination of PDU Session parameter(s) information. + type: object + properties: + pduSessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + sscMode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ScsMode' + accessTypes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + minItems: 1 + +PfdDeterminationInfo: + description: Represents the PFD Determination information for a known application identifier. + type: object + properties: + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + 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: Represents the significant parts of the URL to be matched, e.g. host name. + domainNames: + type: array + items: + type: string + minItems: 1 + description: Represents Domain name matching criteria. + dnProtocol: + $ref: 'TS29122_PfdManagement.yaml#/components/schemas/DomainNameProtocol' + pfdConfidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +``` + +``` +required: + - appId + +PduSesTrafficInfo: + description: Represents the PDU Set traffic analytics information. + type: object + properties: + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + tdMatchTrafes: + type: array + items: + $ref: '#/components/schemas/TdTraffic' + minItems: 1 + tdUnmatchTrafes: + type: array + items: + $ref: '#/components/schemas/TdTraffic' + minItems: 1 + allOf: + - anyOf: + - required: [dnn] + - required: [snssai] + - anyOf: + - required: [tdMatchTrafes] + - required: [tdUnmatchTrafes] + +TdTraffic: + description: Represents traffic that matches or unmatches Traffic Descriptor of URSP rule. + type: object + properties: + pduSesTrafReqs: + type: array + items: + $ref: '#/components/schemas/PduSesTrafficReq' + minItems: 1 + ulVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + dlVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + allVol: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + ulNumOfPkt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + dlNumOfPkt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + allNumOfPkt: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +PduSesTrafficReq: + description: Represents the PDU Session traffic analytics requirements. + type: object + properties: + flowDescs: + type: array + items: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowDescription' + minItems: 1 + description: > + Indicates traffic flow filtering description(s) for IP flow(s). + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + domainDescs: + type: array + items: + type: string + minItems: 1 + description: > + FQDN(s) or a regular expression which are used as a domain name matching criteria. + oneOf: + - required: [flowDescs] +``` + +``` +- required: [appId] +- required: [domainDescs] + +ResourceUsageRequirement: + description: resource usage requirement. + type: object + properties: + tfcDir: + $ref: '#/components/schemas/TrafficDirection' + valExp: + $ref: '#/components/schemas/ValueExpression' + +E2eDataVolTransTimeReq: + description: Represents other E2E data volume transfer time analytics requirements. + type: object + properties: + criterion: + $ref: '#/components/schemas/E2eDataVolTransTimeCriterion' + order: + $ref: '#/components/schemas/MatchingDirection' + highTransTmThr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + lowTransTmThr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + repeatDataTrans: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + tsIntervalDataTrans: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + dataVolume: + $ref: '#/components/schemas/DataVolume' + maxNumberUes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + oneOf: + - required: [repeatDataTrans] + - required: [tsIntervalDataTrans] + +DataVolume: + description: Data Volume including UL/DL. + type: object + properties: + uplinkVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + downlinkVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + anyOf: + - required: [uplinkVolume] + - required: [downlinkVolume] + +E2eDataVolTransTimeInfo: + description: > + Represents the E2E data volume transfer time analytics information when subscribed event is + "E2E_DATA_VOL_TRANS_TIME", the "dataVlTrnsTmInfos" attribute shall be included. + type: object + properties: + e2eDataVolTransTimes: + type: array + items: + $ref: '#/components/schemas/E2eDataVolTransTimePerTS' + minItems: 1 + e2eDataVolTransTimeUeLists: + type: array + items: + $ref: '#/components/schemas/E2eDataVolTransTimeUeList' + minItems: 1 + geoDistrInfos: + type: array + items: + $ref: '#/components/schemas/GeoDistributionInfo' + minItems: 1 + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + required: + - e2eDataVolTransTimes + +E2eDataVolTransTimePerTS: + description: Represents the E2E data volume transfer time analytics per Time Slot. + type: object + properties: +``` + +``` + +tsStart: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +tsDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +e2eDataVolTransTimePerUe: + type: array + items: + $ref: '#/components/schemas/E2eDataVolTransTimePerUe' + minItems: 1 +required: +- tsStart +- tsDuration +- e2eDataVolTransTimePerUe + +E2eDataVolTransTimePerUe: + description: Represents the E2E data volume transfer time per UE. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + appId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + ueLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + dnai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + spatialValidity: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + validityPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dataVolTransTime: + $ref: '#/components/schemas/DataVolumeTransferTime' + oneOf: + - required: [ueLoc] + - required: [snssai] + +E2eDataVolTransTimeUeList: + description: > + Contains the list of UEs classified based on experience level of E2E Data Volume Transfer + Time + properties: + highLevel: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + mediumLevel: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + lowLevel: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + lowRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + mediumRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + highRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + spatialValidity: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + validityPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + anyOf: + - required: [highLevel] + - required: [mediumLevel] + - required: [lowLevel] + +DataVolumeTransferTime: + +``` + +``` +description: > + Indicates the E2E data volume transfer time and the data volume used to derive the transfer + time. +properties: + uplinkVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + avgTransTimeUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + varTransTimeUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + downlinkVolume: + $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + avgTransTimeDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + varTransTimeDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + +GeoLocation: + description: > + Represents a horizontal and optionally vertical location using either geographic + or local coordinates. + type: object + properties: + point: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Point' + pointAlt: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PointAltitude' + refPoint: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LocalOrigin' + localCoords: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/RelativeCartesianLocation' + anyOf: + - required: [point] + - required: [pointAlt] + - allOf: + - required: [refPoint] + - required: [localCoords] + +GeoAccuracyReq: + description: > + Contains location accuracy analytics requirements. + type: object + properties: + accThres: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + accThresMatchDir: + $ref: '#/components/schemas/MatchingDirection' + inOutThres: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + inOutThresMatchDir: + $ref: '#/components/schemas/MatchingDirection' + posMethod: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethod' + +GeoAccuracyInfo: + description: > + Contains location accuracy analytics. + type: object + properties: + locAccPerMeths: + type: array + items: + $ref: '#/components/schemas/LocAccuracyPerMethod' + minItems: 1 + description: Location accuracy information per positioning method. + inOutUePct: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + inOutInd: + type: boolean + description: Indicates if the target location is indoors or outdoors. + required: + - locAccPerMeths + not: + required: [inOutUePct, inOutInd] + +LocAccuracyPerMethod: + description: > + Contains location accuracy analytics per positioning method. +``` + +``` +type: object +properties: + posMethod: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethod' + locAcc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + losNlosPercent: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + required: + - posMethod + - locAcc +AccuracyReq: + description: Represents the analytics accuracy requirement information. + type: object + properties: + accuTimeWin: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + accuPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + accuDevThr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minNum: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + updatedAnaFlg: + type: boolean + description: > + Indicates the updated Analytics flag. Set to "true" indicates that the NWDAF can provide + the updated analytics if the analytics can be generated within the analytics accuracy + information time window, which is specified by "accuTimeWin" attribute. + Otherwise set to "false". Default value is "false" if omitted. + correctionInterval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +AccuracyInfo: + description: The analytics accuracy information. + type: object + properties: + accuracyVal: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + accuSampleNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + + anaAccuInd: + $ref: '#/components/schemas/AnalyticsAccuracyIndication' + +MovBehavReq: + description: Represents the Movement Behaviour analytics requirements. + properties: + locationGranReq: + $ref: '#/components/schemas/LocInfoGranularity' + reportThresholds: + $ref: '#/components/schemas/ThresholdLevel' + +MovBehavInfo: + description: Represents the Movement Behaviour information. + properties: + geoLoc: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicalCoordinates' + movBehavs: + type: array + items: + $ref: '#/components/schemas/MovBehav' + minItems: 1 + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +MovBehav: + description: Represents the Movement Behaviour information per time slot. + properties: + tsStart: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tsDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + numOfUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + avrSpeed: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/Float' +speedThresdInfos: + type: array + items: + $ref: '#/components/schemas/SpeedThresholdInfo' + minItems: 1 +directionUeInfos: + type: array + items: + $ref: '#/components/schemas/DirectionInfo' + minItems: 1 +required: +- tsStart +- tsDuration + +SpeedThresholdInfo: + description: UEs information whose speed is faster than the speed threshold. + properties: + numOfUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + +RelProxReq: + description: Represents the Relative Proximity analytics requirements. + properties: + direction: + type: array + items: + $ref: '#/components/schemas/Direction' + minItems: 1 + numOfUe: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + proximityCrits: + type: array + items: + $ref: '#/components/schemas/ProximityCriterion' + minItems: 1 + +RelProxInfo: + description: Represents the Relative Proximity information. + properties: + tsStart: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + tsDuration: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + supis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + gsis: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + minItems: 1 + ueProximities: + type: array + items: + $ref: '#/components/schemas/UeProximity' + minItems: 1 + ttcInfo: + $ref: '#/components/schemas/TimeToCollisionInfo' + required: + - tsStart + - tsDuration + - ueProximities + +UeProximity: + description: Represents the Observed or Predicted proximity information. + properties: + ueDistance: + type: integer + ueVelocity: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate' + avrSpeed: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + locOrientation: +``` + +``` +$ref: '#/components/schemas/LocationOrientation' +ueTrajectories: + type: array + items: + $ref: '#/components/schemas/UeTrajectory' + minItems: 1 +ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SamplingRatio' + +UeTrajectory: + description: Represents timestamped UE positions. + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + timestampedLocs: + type: array + items: + $ref: '#/components/schemas/TimestampedLocation' + minItems: 1 + required: + - timestampedLocs + oneOf: + - required: [supi] + - required: [gpsI] + +TimestampedLocation: + description: The timestamped locations of the trajectory of the UE. + properties: + ts: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + locInfo: + items: + $ref: '#/components/schemas/LocationInfo' + required: + - ts + - locInfo + +TimeToCollisionInfo: + description: Represents Time To Collision (TTC) information. + properties: + ttc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + accuracy: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + confidence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +AnalyticsFeedbackInfo: + description: Analytics feedback information. + properties: + actionTimes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + minItems: 1 + description: The times at which an action was taken. + usedAnaTypes: + type: array + items: + $ref: '#/components/schemas/NwdaEvent' + minItems: 1 + description: The analytics types that were used to take the action. + impactInd: + type: boolean + description: Indication about the impact of an action on the ground truth data. + required: + - actionTimes + +RoamingInfo: + description: Information related to roaming analytics. + type: object + properties: + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + aois: + type: array +``` + +``` +items: + $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' +minItems: 1 +description: Areas of Interest in the HPLMN or the VPLMN. +servingNFIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + description: NF ID(s) of the NF(s) serving the roaming UE(s) in the VPLMN. +servingNFSetIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + description: NF Set ID(s) of the NF Set(s) serving the roaming UE(s) in the VPLMN. +``` + +``` +# +# +# +``` + +#### ENUMERATIONS DATA TYPES + +##### NotificationMethod: + +``` +anyOf: +- type: string + enum: + - PERIODIC + - THRESHOLD +- 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 notification methods for the subscribed events. + Possible values are: + - PERIODIC: The notification of the subscribed NWDAF Event is periodical. The period + between the notifications is identified by repetitionPeriod and represents time in + seconds. + - THRESHOLD: The subscribe of NWDAF Event is upon threshold exceeded. +``` + +##### NwdafEvent: + +``` +anyOf: +- type: string + enum: + - SLICE_LOAD_LEVEL + - NETWORK_PERFORMANCE + - NF_LOAD + - SERVICE_EXPERIENCE + - UE_MOBILITY + - UE_COMMUNICATION + - QOS_SUSTAINABILITY + - ABNORMAL_BEHAVIOUR + - USER_DATA_CONGESTION + - NSI_LOAD_LEVEL + - DN_PERFORMANCE + - DISPERSION + - RED_TRANS_EXP + - WLAN_PERFORMANCE + - SM_CONGESTION + - PFD_DETERMINATION + - PDU_SESSION_TRAFFIC + - E2E_DATA_VOL_TRANS_TIME + - MOVEMENT_BEHAVIOUR + - NUM_OF_UE + - MOV_UE_RATIO + - AVR_SPEED + - SPEED_THRESHOLD + - MOV_UE_DIRECTION + - LOC_ACCURACY + - RELATIVE_PROXIMITY +- 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 NWDAF Events. + Possible values are: + - SLICE_LOAD_LEVEL: Indicates that the event subscribed is load level information of Network +``` + +- Slice. +- NETWORK\_PERFORMANCE: Indicates that the event subscribed is network performance information. + - NF\_LOAD: Indicates that the event subscribed is load level and status of one or several Network Functions. + - SERVICE\_EXPERIENCE: Indicates that the event subscribed is service experience. + - UE\_MOBILITY: Indicates that the event subscribed is UE mobility information. + - UE\_COMMUNICATION: Indicates that the event subscribed is UE communication information. + - QOS\_SUSTAINABILITY: Indicates that the event subscribed is QoS sustainability. + - ABNORMAL\_BEHAVIOUR: Indicates that the event subscribed is abnormal behaviour. + - USER\_DATA\_CONGESTION: Indicates that the event subscribed is user data congestion information. + - NSI\_LOAD\_LEVEL: Indicates that the event subscribed is load level information of Network Slice and the optionally associated Network Slice Instance. + - DN\_PERFORMANCE: Indicates that the event subscribed is DN performance information. + - DISPERSION: Indicates that the event subscribed is dispersion information. + - RED\_TRANS\_EXP: Indicates that the event subscribed is redundant transmission experience. + - WLAN\_PERFORMANCE: Indicates that the event subscribed is WLAN performance. + - SM\_CONGESTION: Indicates the Session Management Congestion Control Experience information for specific DNN and/or S-NSSAI. + - PFD\_DETERMINATION: Indicates that the event subscribed is the PFD Determination information for known application identifier(s). + - PDU\_SESSION\_TRAFFIC: Indicates that the event subscribed is the PDU Session traffic information. + - E2E\_DATA\_VOL\_TRANS\_TIME: Indicates that the event subscribed is of E2E data volume transfer time. + - MOVEMENT\_BEHAVIOUR: Indicates that the event subscribed is the Movement Behaviour information. + - LOC\_ACCURACY: Indicates that the event subscribed is of location accuracy. + - RELATIVE\_PROXIMITY: Indicates that the event subscribed is the Relative Proximity information. + +Accuracy: + +- anyOf: +- type: string +enum: + - LOW + - MEDIUM + - HIGH + - HIGHEST + - 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 preferred level of accuracy of the analytics. +Possible values are: + - LOW: Low accuracy. + - MEDIUM: Medium accuracy. + - HIGH: High accuracy. + - HIGHEST: Highest accuracy. + +CongestionType: + +- anyOf: +- type: string +enum: + - USER\_PLANE + - CONTROL\_PLANE + - USER\_AND\_CONTROL\_PLANE + - 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 congestion analytics type. +Possible values are: + - USER\_PLANE: The congestion analytics type is User Plane. + - CONTROL\_PLANE: The congestion analytics type is Control Plane. + - USER\_AND\_CONTROL\_PLANE: The congestion analytics type is User Plane and Control Plane. + +ExceptionId: + +- anyOf: +- type: string +enum: + - UNEXPECTED\_UE\_LOCATION + +- UNEXPECTED\_LONG\_LIVE\_FLOW +- UNEXPECTED\_LARGE\_RATE\_FLOW +- UNEXPECTED\_WAKEUP +- SUSPICION\_OF\_DDOS\_ATTACK +- WRONG\_DESTINATION\_ADDRESS +- TOO\_FREQUENT\_SERVICE\_ACCESS +- UNEXPECTED\_RADIO\_LINK\_FAILURES +- PING\_PONG\_ACROSS\_CELLS + +- 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 Exception Id. +Possible values are: +- UNEXPECTED\_UE\_LOCATION: Unexpected UE location. +- UNEXPECTED\_LONG\_LIVE\_FLOW: Unexpected long-live rate flows. +- UNEXPECTED\_LARGE\_RATE\_FLOW: Unexpected large rate flows. +- UNEXPECTED\_WAKEUP: Unexpected wakeup. +- SUSPICION\_OF\_DDOS\_ATTACK: Suspicion of DDoS attack. +- WRONG\_DESTINATION\_ADDRESS: Wrong destination address. +- TOO\_FREQUENT\_SERVICE\_ACCESS: Too frequent Service Access. +- UNEXPECTED\_RADIO\_LINK\_FAILURES: Unexpected radio link failures. +- PING\_PONG\_ACROSS\_CELLS: Ping-ponging across neighbouring cells. + +ExceptionTrend: +anyOf: +- type: string +enum: +- UP +- DOWN +- UNKNOW +- STABLE + +- 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 Exception Trend. +Possible values are: +- UP: Up trend of the exception level. +- DOWN: Down trend of the exception level. +- UNKNOW: Unknown trend of the exception level. +- STABLE: Stable trend of the exception level. + +TimeUnit: +anyOf: +- type: string +enum: +- MINUTE +- HOUR +- DAY + +- 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 unit for the session active time. +Possible values are: +- MINUTE: Time unit is per minute. +- HOUR: Time unit is per hour. +- DAY: Time unit is per day. + +NetworkPerfType: +anyOf: +- type: string +enum: +- GNB\_ACTIVE\_RATIO +- GNB\_COMPUTING\_USAGE +- GNB\_MEMORY\_USAGE +- GNB\_DISK\_USAGE +- GNB\_RSC\_USAGE\_OVERALL\_TRAFFIC +- GNB\_RSC\_USAGE\_GBR\_TRAFFIC +- GNB\_RSC\_USAGE\_DELAY\_CRIT\_GBR\_TRAFFIC +- NUM\_OF\_UE + +- SESS\_SUCC\_RATIO +- HO\_SUCC\_RATIO +- 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 performance types. +Possible values are: + - GNB\_ACTIVE\_RATIO: Indicates that the network performance requirement is gNodeB active (i.e. up and running) rate. Indicates the ratio of gNB active (i.e. up and running) number to the total number of gNB. + - GNB\_COMPUTING\_USAGE: Indicates gNodeB computing resource usage. + - GNB\_MEMORY\_USAGE: Indicates gNodeB memory usage. + - GNB\_DISK\_USAGE: Indicates gNodeB disk usage. + - GNB\_RSC\_USAGE\_OVERALL\_TRAFFIC: The gNB resource usage. + - GNB\_RSC\_USAGE\_GBR\_TRAFFIC: The gNB resource usage for GBR traffic. + - GNB\_RSC\_USAGE\_DELAY\_CRIT\_GBR\_TRAFFIC: The gNB resource usage for Delay-critical GBR traffic. + - NUM\_OF\_UE: Indicates number of UEs. + - SESS\_SUCC\_RATIO: Indicates ratio of successful setup of PDU sessions to total PDU session setup attempts. + - HO\_SUCC\_RATIO: Indicates Ratio of successful handovers to the total handover attempts. + +ExpectedAnalyticsType: +anyOf: +- type: string +enum: +- MOBILITY +- COMMUN +- MOBILITY\_AND\_COMMUN + +- 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 expected UE analytics type. +Possible values are: + +- MOBILITY: Mobility related abnormal behaviour analytics is expected by the consumer. +- COMMUN: Communication related abnormal behaviour analytics is expected by the consumer. +- MOBILITY\_AND\_COMMUN: Both mobility and communication related abnormal behaviour analytics is expected by the consumer. + +MatchingDirection: +anyOf: +- type: string +enum: +- ASCENDING +- DESCENDING +- CROSSED + +- 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 matching direction when crossing a threshold. +Possible values are: + +- ASCENDING: Threshold is crossed in ascending direction. +- DESCENDING: Threshold is crossed in descending direction. +- CROSSED: Threshold is crossed either in ascending or descending direction. + +NwdaFailureCode: +anyOf: +- type: string +enum: +- UNAVAILABLE\_DATA +- BOTH\_STAT\_PRED\_NOT\_ALLOWED +- PREDICTION\_NOT\_ALLOWED +- UNSATISFIED\_REQUESTED\_ANALYTICS\_TIME +- 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. + +description: | +Represents the failure reason. +Possible values are: +- UNAVAILABLE\_DATA: Indicates the requested statistics information for the event is rejected since necessary data to perform the service is unavailable. +- BOTH\_STAT\_PRED\_NOT\_ALLOWED: Indicates the requested analysis information for the event is rejected since the start time is in the past and the end time is in the future, which means the NF service consumer requested both statistics and prediction for the analytics. +- PREDICTION\_NOT\_ALLOWED: Indicates that the request for the prediction of the analytics event is not allowed. +- UNSATISFIED\_REQUESTED\_ANALYTICS\_TIME: Indicates that the requested event is rejected since the analytics information is not ready when the time indicated by the "timeAnaNeeded" attribute (as provided during the creation or modification of subscription) is reached. +- OTHER: Indicates the requested analysis information for the event is rejected due to other reasons. + +#### AnalyticsMetadata: + +anyOf: +- type: string +enum: +- NUM\_OF\_SAMPLES +- DATA\_WINDOW +- DATA\_STAT\_PROPS +- STRATEGY +- ACCURACY +- 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 types of analytics metadata information that can be requested. +Possible values are: +- NUM\_OF\_SAMPLES: Number of data samples used for the generation of the output analytics. +- DATA\_WINDOW: Data time window of the data samples. +- DATA\_STAT\_PROPS: Dataset statistical properties of the data used to generate the analytics. +- STRATEGY: Output strategy used for the reporting of the analytics. +- ACCURACY: Level of accuracy reached for the analytics. + +#### DatasetStatisticalProperty: + +anyOf: +- type: string +enum: +- UNIFORM\_DIST\_DATA +- NO\_OUTLIERS +- 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 dataset statistical properties. +Possible values are: +- UNIFORM\_DIST\_DATA: Indicates the use of data samples that are uniformly distributed according to the different aspects of the requested analytics. +- NO\_OUTLIERS: Indicates that the data samples shall disregard data samples that are at the extreme boundaries of the value range. + +#### OutputStrategy: + +anyOf: +- type: string +enum: +- BINARY +- GRADIENT +- 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 output strategy used for the analytics reporting. +Possible values are: +- BINARY: Indicates that the analytics shall only be reported when the requested level of accuracy is reached within a cycle of periodic notification. +- GRADIENT: Indicates that the analytics shall be reported according with the periodicity irrespective of whether the requested level of accuracy has been reached or not. + +``` +TransferRequestType: + anyOf: + - type: string + enum: + - PREPARE + - TRANSFER + - 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 request type for the analytics subscription transfer. + Possible values are: + - PREPARE: Indicates that the request is for analytics subscription transfer preparation. + - TRANSFER: Indicates that the request is for analytics subscription transfer execution. + +AnalyticsSubset: + anyOf: + - type: string + enum: + - NUM_OF_UE_REG + - NUM_OF_PDU_SESS_ESTBL + - RES_USAGE + - NUM_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR + - PERIOD_OF_EXCEED_RES_USAGE_LOAD_LEVEL_THR + - EXCEED_LOAD_LEVEL_THR_IND + - LIST_OF_TOP_APP_UL + - LIST_OF_TOP_APP_DL + - NF_STATUS + - NF_RESOURCE_USAGE + - NF_LOAD + - NF_PEAK_LOAD + - NF_LOAD_AVG_IN_AOI + - DISPER_AMOUNT + - DISPER_CLASS + - RANKING + - PERCENTILE_RANKING + - RSSI + - RTT + - TRAFFIC_INFO + - NUMBER_OF_UES + - APP_LIST_FOR_UE_COMM + - N4_SESS_INACT_TIMER_FOR_UE_COMM + - AVG_TRAFFIC_RATE + - MAX_TRAFFIC_RATE + - AGG_TRAFFIC_RATE + - VAR_TRAFFIC_RATE + - AVG_PACKET_DELAY + - MAX_PACKET_DELAY + - VAR_PACKET_DELAY + - AVG_PACKET_LOSS_RATE + - MAX_PACKET_LOSS_RATE + - VAR_PACKET_LOSS_RATE + - UE_LOCATION + - LIST_OF_HIGH_EXP_UE + - LIST_OF_MEDIUM_EXP_UE + - LIST_OF_LOW_EXP_UE + - AVG_UL_PKT_DROP_RATE + - VAR_UL_PKT_DROP_RATE + - AVG_DL_PKT_DROP_RATE + - VAR_DL_PKT_DROP_RATE + - AVG_UL_PKT_DELAY + - VAR_UL_PKT_DELAY + - AVG_DL_PKT_DELAY + - VAR_DL_PKT_DELAY + - TRAFFIC_MATCH_TD + - TRAFFIC_UNMATCH_TD + - NUMBER_OF_UE + - UE_GEOG_DIST + - UE_DIRECTION + - AVG_E2E_UL_PKT_DELAY + - VAR_E2E_UL_PKT_DELAY + - AVG_E2E_DL_PKT_DELAY + - VAR_E2E_DL_PKT_DELAY + - AVG_E2E_UL_PKT_LOSS_RATE + - VAR_E2E_UL_PKT_LOSS_RATE + - AVG_E2E_DL_PKT_LOSS_RATE +``` + +- VAR\_E2E\_DL\_PKT\_LOSS\_RATE +- E2E\_DATA\_VOL\_TRANS\_TIME\_FOR\_UE\_LIST +- IN\_OUT\_PERCENT +- TIME\_TO\_COLLISION +- 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 analytics subset. + - Possible values are: + - NUM\_OF\_UE\_REG: The number of UE registered. This value is only applicable to NSI\_LOAD\_LEVEL event. + - NUM\_OF\_PDU\_SESS\_ESTBL: The number of PDU sessions established. This value is only applicable to NSI\_LOAD\_LEVEL event. + - RES\_USAGE: The current usage of the virtual resources assigned to the NF instances belonging to a particular network slice instance. This value is only applicable to NSI\_LOAD\_LEVEL event. + - NUM\_OF\_EXCEED\_RES\_USAGE\_LOAD\_LEVEL\_THR: The number of times the resource usage threshold of the network slice instance is reached or exceeded if a threshold value is provided by the consumer. This value is only applicable to NSI\_LOAD\_LEVEL event. + - PERIOD\_OF\_EXCEED\_RES\_USAGE\_LOAD\_LEVEL\_THR: The time interval between each time the threshold being met or exceeded on the network slice (instance). This value is only applicable to NSI\_LOAD\_LEVEL event. + - EXCEED\_LOAD\_LEVEL\_THR\_IND: Whether the Load Level Threshold is met or exceeded by the statistics value. This value is only applicable to NSI\_LOAD\_LEVEL event. + - LIST\_OF\_TOP\_APP\_UL: The list of applications that contribute the most to the traffic in the UL direction. This value is only applicable to USER\_DATA\_CONGESTION event. + - LIST\_OF\_TOP\_APP\_DL: The list of applications that contribute the most to the traffic in the DL direction. This value is only applicable to USER\_DATA\_CONGESTION event. + - NF\_STATUS: The availability status of the NF on the Analytics target period, expressed as a percentage of time per status value (registered, suspended, undiscoverable). This value is only applicable to NF\_LOAD event. + - NF\_RESOURCE\_USAGE: The average usage of assigned resources (CPU, memory, storage). This value is only applicable to NF\_LOAD event. + - NF\_LOAD: The average load of the NF instance over the Analytics target period. This value is only applicable to NF\_LOAD event. + - NF\_PEAK\_LOAD: The maximum load of the NF instance over the Analytics target period. This value is only applicable to NF\_LOAD event. + - NF\_LOAD\_AVG\_IN\_AOI: The average load of the NF instances over the area of interest. This value is only applicable to NF\_LOAD event. + - DISPER\_AMOUNT: Indicates the dispersion amount of the reported data volume or transaction dispersion type. This value is only applicable to DISPERSION event. + - DISPER\_CLASS: Indicates the dispersion mobility class: fixed, camper, traveller upon set its usage threshold, and/or the top-heavy class upon set its percentile rating threshold. This value is only applicable to DISPERSION event. + - RANKING: Data/transaction usage ranking high (i.e.value 1), medium (2) or low (3). This value is only applicable to DISPERSION event. + - PERCENTILE\_RANKING: Percentile ranking of the target UE in the Cumulative Distribution Function of data usage for the population of all UEs. This value is only applicable to DISPERSION event. + - RSSI: Indicated the RSSI in the unit of dBm. This value is only applicable to WLAN\_PERFORMANCE event. + - RTT: Indicates the RTT in the unit of millisecond. This value is only applicable to WLAN\_PERFORMANCE event. + - TRAFFIC\_INFO: Traffic information including UL/DL data rate and/or Traffic volume. This value is only applicable to WLAN\_PERFORMANCE event. + - NUMBER\_OF\_UES: Number of UEs observed for the SSID. This value is only applicable to WLAN\_PERFORMANCE event. + - APP\_LIST\_FOR\_UE\_COMM: The analytics of the application list used by UE. This value is only applicable to UE\_COMM event. + - N4\_SESS\_INACT\_TIMER\_FOR\_UE\_COMM: The N4 Session inactivity timer. This value is only applicable to UE\_COMM event. + - AVG\_TRAFFIC\_RATE: Indicates average traffic rate. This value is only applicable to DN\_PERFORMANCE event. + - MAX\_TRAFFIC\_RATE: Indicates maximum traffic rate. This value is only applicable to DN\_PERFORMANCE event. + - AGG\_TRAFFIC\_RATE: Indicates aggregated traffic rate. This value is only applicable to DN\_PERFORMANCE event. + - VAR\_TRAFFIC\_RATE: Indicates variance traffic rate. This value is only applicable to DN\_PERFORMANCE event. + - AVG\_PACKET\_DELAY: Indicates average Packet Delay. This value is only applicable to DN\_PERFORMANCE event. + - MAX\_PACKET\_DELAY: Indicates maximum Packet Delay. This value is only applicable to DN\_PERFORMANCE event. + - VAR\_PACKET\_DELAY: Indicates variance Packet Delay. This value is only applicable to DN\_PERFORMANCE event. + +- AVG\_PACKET\_LOSS\_RATE: Indicates average Loss Rate. This value is only applicable to DN\_PERFORMANCE event. +- MAX\_PACKET\_LOSS\_RATE: Indicates maximum Packet Loss Rate. This value is only applicable to DN\_PERFORMANCE event. +- VAR\_PACKET\_LOSS\_RATE: Indicates variance Packet Loss Rate. This value is only applicable to DN\_PERFORMANCE event. +- UE\_LOCATION: Indicates UE location information. This value is only applicable to SERVICE\_EXPERIENCE event. +- LIST\_OF\_HIGH\_EXP\_UE: Indicates list of high experienced UE. This value is only applicable to SM\_CONGESTION event. +- LIST\_OF\_MEDIUM\_EXP\_UE: Indicates list of medium experienced UE. This value is only applicable to SM\_CONGESTION event. +- LIST\_OF\_LOW\_EXP\_UE: Indicates list of low experienced UE. This value is only applicable to SM\_CONGESTION event. +- AVG\_UL\_PKT\_DROP\_RATE: Indicates average uplink packet drop rate on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_UL\_PKT\_DROP\_RATE: Indicates variance of uplink packet drop rate on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- AVG\_DL\_PKT\_DROP\_RATE: Indicates average downlink packet drop rate on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_DL\_PKT\_DROP\_RATE: Indicates variance of downlink packet drop rate on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- AVG\_UL\_PKT\_DELAY: Indicates average uplink packet delay round trip on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_UL\_PKT\_DELAY: Indicates variance uplink packet delay round trip on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- AVG\_DL\_PKT\_DELAY: Indicates average downlink packet delay round trip on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_DL\_PKT\_DELAY: Indicates variance downlink packet delay round trip on GTP-U path on N3. This value is only applicable to RED\_TRANS\_EXP event. +- TRAFFIC\_MATCH\_TD: Identifies traffic that matches Traffic Descriptor provided by the consumer. +- TRAFFIC\_UNMATCH\_TD: Identifies traffic that does not match Traffic Descriptor provided by the consumer. +- NUMBER\_OF\_UE: Indicates the number of UEs. This value is only applicable to DN\_PERFORMANCE event. +- UE\_GEOG\_DIST: Indicates the geographical distribution of the UEs that can be selected by the AF for application service. This value is only applicable to UE\_MOBILITY event. +- UE\_DIRECTION: Indicates the direction of the UEs. This value is only applicable to UE\_MOBILITY event. +- AVG\_E2E\_UL\_PKT\_DELAY: Indicates average End-to-End (between UE and UPF) uplink packet delay. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_E2E\_UL\_PKT\_DELAY: Indicates the variance of End-to-End (between UE and UPF) uplink packet delay. This value is only applicable to RED\_TRANS\_EXP event. +- AVG\_E2E\_DL\_PKT\_DELAY: Indicates average End-to-End (between UE and UPF) downlink packet delay. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_E2E\_DL\_PKT\_DELAY: Indicates the variance of End-to-End (between UE and UPF) downlink packet delay. This value is only applicable to RED\_TRANS\_EXP event. +- AVG\_E2E\_UL\_PKT\_LOSS\_RATE: Indicates average End-to-End (between UE and UPF) uplink packet loss rate. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_E2E\_UL\_PKT\_LOSS\_RATE: Indicates the variance of End-to-End (between UE and UPF) uplink packet loss rate. This value is only applicable to RED\_TRANS\_EXP event. +- AVG\_E2E\_DL\_PKT\_LOSS\_RATE: Indicates average End-to-End (between UE and UPF) downlink packet loss rate. This value is only applicable to RED\_TRANS\_EXP event. +- VAR\_E2E\_DL\_PKT\_LOSS\_RATE: Indicates the variance of End-to-End (between UE and UPF) downlink packet loss rate. This value is only applicable to RED\_TRANS\_EXP event. +- E2E\_DATA\_VOL\_TRANS\_TIME\_FOR\_UE\_LIST: Indicates the classified E2E data volume transfer time statistics or predictions for multiple UEs with respect to one or more reporting thresholds. +- NUM\_OF\_UE: Indicates the total number of users in the area of interest. This value is only applicable to MOVEMENT\_BEHAVIOUR event. +- MOV\_UE\_RATIO: Indicates the Ratio of moving UEs in the area of interest. This value is only applicable to MOVEMENT\_BEHAVIOUR event. +- AVR\_SPEED: Indicates the average speed of all UEs in the area of interest. This value is only applicable to MOVEMENT\_BEHAVIOUR event. +- SPEED\_THRESHOLD: Indicates the information on UEs in the area of interest whose speed is faster than the speed threshold. This value is only applicable to MOVEMENT\_BEHAVIOUR event. +- MOV\_UE\_DIRECTION: Indicates the heading directions of the UE flow in the target area. This value is only applicable to MOVEMENT\_BEHAVIOUR event. +- IN\_OUT\_PERCENT: Indicates the percentage of indoor/outdoor UEs at a location. The value is only applicable to the LOC\_ACCURACY event. +- TIME\_TO\_COLLISION: Indicates the time until for a collision with another UE happens. This value is only applicable to RELATIVE\_PROXIMITY event prediction. + +DispersionType: +oneOf: +- type: string + +``` +enum: + - DVDA + - TDA + - DVDA_AND_TDA +- 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 dispersion type. + Possible values are: + - DVDA: Data Volume Dispersion Analytics. + - TDA: Transactions Dispersion Analytics. + - DVDA_AND_TDA: Data Volume Dispersion Analytics and Transactions Dispersion Analytics. + +DispersionClass: + oneOf: + - type: string + enum: + - FIXED + - CAMPER + - TRAVELLER + - TOP_HEAVY + - 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 dispersion class. + Possible values are: + - FIXED: Dispersion class as fixed UE its data or transaction usage at a location or + a slice, is higher than its class threshold set for its all data or transaction usage. + - CAMPER: Dispersion class as camper UE, its data or transaction usage at a location or + a slice, is higher than its class threshold and lower than the fixed class threshold set + for its all data or transaction usage. + - TRAVELLER: Dispersion class as traveller UE, its data or transaction usage at a location + or a slice, is lower than the camper class threshold set for its all data or transaction + usage. + - TOP_HEAVY: Dispersion class as Top_Heavy UE, who's dispersion percentile rating at a + location or a slice, is higher than its class threshold. + +DispersionOrderingCriterion: + anyOf: + - type: string + enum: + - TIME_SLOT_START + - DISPERSION + - CLASSIFICATION + - RANKING + - PERCENTILE_RANKING + - 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 order criterion for the list of dispersion. + Possible values are: + - TIME_SLOT_START: Indicates the order of time slot start. + - DISPERSION: Indicates the order of data/transaction dispersion. + - CLASSIFICATION: Indicates the order of data/transaction classification. + - RANKING: Indicates the order of data/transaction ranking. + - PERCENTILE_RANKING: Indicates the order of data/transaction percentile ranking. + +DeviceType: + anyOf: + - type: string + enum: + - MOBILE_PHONE + - SMART_PHONE + - TABLET + - DONGLE + - MODEM + - WLAN_ROUTER + - IOT_DEVICE +``` + +``` +- WEARABLE +- MOBILE_TEST_PLATFORM +- UNDEFINED +- 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 device type. +Possible values are: +- MOBILE_PHONE: Mobile Phone. +- SMART_PHONE: Smartphone. +- TABLET: Tablet. +- DONGLE: Dongle. +- MODEM: Modem. +- WLAN_ROUTER: WLAN Router. +- IOT_DEVICE: IoT Device. +- WEARABLE: Wearable. +- MOBILE_TEST_PLATFORM: Mobile Test Platform. +- UNDEFINED: Undefined. + +RedTransExpOrderingCriterion: +anyOf: +- type: string +enum: +- TIME_SLOT_START +- RED_TRANS_EXP +- 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 order criterion for the list of Redundant Transmission Experience. +Possible values are: +- TIME_SLOT_START: Indicates the order of time slot start. +- RED_TRANS_EXP: Indicates the order of Redundant Transmission Experience. + +WlanOrderingCriterion: +anyOf: +- type: string +enum: +- TIME_SLOT_START +- NUMBER_OF_UES +- RSSI +- RTT +- TRAFFIC_INFO +- 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 order criterion for the list of WLAN performance information. +Possible values are: +- TIME_SLOT_START: Indicates the order of time slot start. +- NUMBER_OF_UES: Indicates the order of number of UEs. +- RSSI: Indicates the order of RSSI. +- RTT: Indicates the order of RTT. +- TRAFFIC_INFO: Indicates the order of Traffic information. + +ServiceExperienceType: +anyOf: +- type: string +enum: +- VOICE +- VIDEO +- 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. +description: | +Represents the type of the service experience analytics. +Possible values are: +- VOICE: Indicates that the service experience analytics is for voice service. +- VIDEO: Indicates that the service experience analytics is for video service. +- OTHER: Indicates that the service experience analytics is for other service. +``` + +DnPerfOrderingCriterion: +anyOf: +- type: string +enum: +- AVERAGE\_TRAFFIC\_RATE +- MAXIMUM\_TRAFFIC\_RATE +- AVERAGE\_PACKET\_DELAY +- MAXIMUM\_PACKET\_DELAY +- AVERAGE\_PACKET\_LOSS\_RATE +- 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 order criterion for the list of DN performance analytics. +Possible values are: +- AVERAGE\_TRAFFIC\_RATE: Indicates the average traffic rate. +- MAXIMUM\_TRAFFIC\_RATE: Indicates the maximum traffic rate. +- AVERAGE\_PACKET\_DELAY: Indicates the average packet delay. +- MAXIMUM\_PACKET\_DELAY: Indicates the maximum packet delay. +- AVERAGE\_PACKET\_LOSS\_RATE: Indicates the average packet loss rate. + +TermCause: +anyOf: +- type: string +enum: +- USER\_CONSENT\_REVOKED +- NWDAF\_OVERLOAD +- UE\_LEFT\_AREA +- 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 for the analytics subscription termination request. +Possible values are: +- USER\_CONSENT\_REVOKED: The user consent has been revoked. +- NWDAF\_OVERLOAD: The NWDAF is overloaded. +- UE\_LEFT\_AREA: The UE has moved out of the NWDAF serving area. + +UserDataConOrderCrit: +anyOf: +- type: string +enum: +- APPLICABLE\_TIME\_WINDOW +- NETWORK\_STATUS\_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. +description: | +Represents the cause for requesting to terminate an analytics subscription. +Possible values are: +- APPLICABLE\_TIME\_WINDOW: The ordering criterion is the Applicable Time Window. +- NETWORK\_STATUS\_INDICATION: The ordering criterion is the network status indication. + +UeMobilityOrderCriterion: +anyOf: +- type: string +enum: +- TIME\_SLOT +- 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 ordering criterion for the list of UE mobility analytics. +Possible values are: +- TIME\_SLOT: The ordering criterion is the time slot. + +UeCommOrderCriterion: +anyOf: +- type: string +enum: +- START\_TIME +- DURATION +- 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 ordering criterion for the list of UE communication analytics. + +Possible values are: + +- START\_TIME: The ordering criterion of the analytics is the start time. +- DURATION: The ordering criterion of the analytics is the duration of the communication. + +NetworkPerfOrderCriterion: + +anyOf: + +- type: string + +enum: + +- NUMBER\_OF\_UES +- COMMUNICATION\_PERF +- MOBILITY\_PERF + +- 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 ordering criterion for the list of network performance analytics. + +Possible values are: + +- NUMBER\_OF\_UES: The ordering criterion of the analytics is the number of UEs. +- COMMUNICATION\_PERF: The ordering criterion of the analytics is the communication + +performance. + +- MOBILITY\_PERF: The ordering criterion of the analytics is the mobility performance. + +LocInfoGranularity: + +anyOf: + +- type: string + +enum: + +- TA\_LEVEL +- CELL\_LEVEL +- LON\_AND\_LAT\_LEVEL + +- 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 preferred granularity of location information. + +Possible values are: + +- TA\_LEVEL: Indicates location granularity of TA level. +- CELL\_LEVEL: Indicates location granularity of Cell level. +- LON\_AND\_LAT\_LEVEL: Indicates location granularity of longitude and latitude level. + +TrafficDirection: + +anyOf: + +- type: string + +enum: + +- UL\_AND\_DL +- UL +- DL + +- 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 traffic direction for the resource usage information. + +Possible values are: + +- UL\_AND\_DL: Uplink and downlink traffic. +- UL: Uplink traffic. +- DL: Downlink traffic. + +ValueExpression: + +anyOf: + +- type: string + +enum: + +- AVERAGE +- PEAK + +- 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 average or peak value of the resource usage for the network performance type. + +Possible values are: + +- AVERAGE: Resource usage information in average value. +- PEAK: Resource usage information in peak value. + +E2eDataVolTransTimeCriterion: +anyOf: +- type: string +enum: +- TIME\_SLOT\_START +- E2E\_DATA\_VOL\_TRANS\_TIME +- 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 ordering criterion for the list of E2E data volume transfer time. +Possible values are: +- TIME\_SLOT\_START: Indicates the order of time slot start. +- E2E\_DATA\_VOL\_TRANS\_TIME: The ordering criterion is the E2E data volume transfer time. + +AnalyticsAccuracyIndication: +anyOf: +- type: string +enum: +- MEET +- NOT\_MEET +- 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 notification methods for the subscribed events. +Possible values are: +- MEET: Indicates meet the analytics accuracy requirement. +- NOT\_MEET: Indicates not meet the analytics accuracy requirement. + +LocationOrientation: +anyOf: +- type: string +enum: +- HORIZONTAL +- VERTICAL +- HOR\_AND\_VER +- 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: +- HORIZONTAL: Indicates horizontal orientation. +- VERTICAL: Indicates vertical orientation. +- HOR\_AND\_VER: Indicates both horizontal and vertical orientation. + +Direction: +anyOf: +- type: string +enum: +- NORTH +- SOUTH +- EAST +- WEST +- NORTHWEST +- NORTHEAST +- SOUTHWEST +- SOUTHEAST +- 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: +- NORTH: North direction. +- SOUTH: South direction. +- EAST: EAST direction. +- WEST: WEST direction. +- NORTHWEST: Northwest direction. +- NORTHEAST: Northeast direction. +- SOUTHWEST: Southwest direction. + +``` + + - SOUTHEAST: Southeast direction. + +ProximityCriterion: + anyOf: + - type: string + enum: + - VELOCITY + - AVG_SPD + - ORIENTATION + - TRAJECTORY + - 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: + - VELOCITY: Velocity. + - AVG_SPD: Average speed. + - ORIENTATION: Orientation. + - TRAJECTORY: Mobility trajectory. + +``` + +## A.3 Nnwdaf\_AnalyticsInfo API + +``` + +openapi: 3.0.0 + +info: + version: 1.3.0-alpha.5 + title: Nnwdaf_AnalyticsInfo + description: | + Nnwdaf_AnalyticsInfo Service API. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/' + +security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-analyticsinfo + +servers: + - url: '{apiRoot}/nnwdaf-analyticsinfo/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +paths: + /analytics: + get: + summary: Read a NWDAF Analytics + operationId: GetNWDAFAnalytics + tags: + - NWDAF Analytics (Document) + parameters: + - name: event-id + in: query + description: Identify the analytics. + required: true + schema: + $ref: '#/components/schemas/EventId' + - name: ana-req + in: query + description: Identifies the analytics reporting requirement information. + required: false + content: + application/json: + schema: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventReportingRequirement' + - name: event-filter + in: query + description: Identify the analytics. + +``` + +``` + + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/EventFilter' +- name: supported-features + in: query + description: To filter irrelevant responses related to unsupported features. + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +- name: tgt-ue + in: query + description: Identify the target UE information. + required: false + content: + application/json: + schema: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/TargetUeInformation' +responses: + '200': + description: > + Containing the analytics with parameters as relevant for the requesting NF service + consumer. + content: + application/json: + schema: + $ref: '#/components/schemas/AnalyticsData' + '204': + description: No Content. The requested NWDAF Analytics data does not exist. + '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: Indicates that the NWDAF Analytics resource does not exist. + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + '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': + description: > + The request is rejected by the NWDAF and more details (not only the ProblemDetails) are + returned. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetailsAnalyticsInfoRequest' + '502': + $ref: 'TS29571_CommonData.yaml#/components/responses/502' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/context: + get: + summary: Get context information related to analytics subscriptions. + operationId: GetNnwdafContext + tags: + - NWDAF Context (Document) + security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-analyticsinfo + - oAuth2ClientCredentials: + - nnwdaf-analyticsinfo + - nnwdaf-analyticsinfo:contexttransfer + parameters: + - name: context-ids + +``` + +``` +in: query +description: Identifies specific context information related to analytics subscriptions. +required: true +content: + application/json: + schema: + $ref: '#/components/schemas/ContextIdList' +- name: req-context +in: query +description: > + Identifies the type(s) of the analytics context information the consumer wishes + to receive. +required: false +content: + application/json: + schema: + $ref: '#/components/schemas/RequestedContext' +responses: + '200': + description: > + Contains context information related to analytics subscriptions corresponding with + one or more context identifiers. + content: + application/json: + schema: + $ref: '#/components/schemas/ContextData' + '204': + description: > + No Content. No context information could be retrieved for the requested context + Identifiers. + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + +securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnwdaif-analyticsinfo: Access to the Nnwdaf_AnalyticsInfo API + nnwdaif-analyticsinfo:contexttransfer: > + Access to service operations applying to NWDAF context transfer related service + operations, i.e. ContextTransfer. + +schemas: + +AnalyticsData: + description: > + Represents the description of analytics with parameters as relevant for the requesting NF + service consumer. + type: object + properties: + start: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + expiry: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +timeStampGen: +$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +anaMetaInfo: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AnalyticsMetadataInfo' +sliceLoadLevelInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/SliceLoadLevelInformation' +minItems: 1 +description: The slices and their load level information. +nsiLoadLevelInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NsiLoadLevelInfo' +minItems: 1 +nfLoadLevelInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NfLoadLevelInformation' +minItems: 1 +nwPerfs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NetworkPerfInfo' +minItems: 1 +svcExps: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ServiceExperienceInfo' +minItems: 1 +qosSustainInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/QosSustainabilityInfo' +minItems: 1 +ueMobs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/UeMobility' +minItems: 1 +ueComms: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/UeCommunication' +minItems: 1 +userDataCongInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/UserDataCongestionInfo' +minItems: 1 +abnorBehavrs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AbnormalBehaviour' +minItems: 1 +smccExps: +type: array +items: +$ref: '#/components/schemas/SmcceInfo' +minItems: 1 +disperInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DispersionInfo' +minItems: 1 +redTransInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RedundantTransmissionExpInfo' +minItems: 1 +wlanInfos: +type: array +items: +``` + +``` +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/WlanPerformanceInfo' +minItems: 1 +dnPerfInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DnPerfInfo' +minItems: 1 +pfdDetermInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/PfdDeterminationInfo' +minItems: 1 +pduSesTrafInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/PduSesTrafficInfo' +minItems: 1 +dataVlTrnsTmInfos: +type: array +items: +$ref: +'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/E2eDataVolTransTimeInfo' +minItems: 1 +locAccInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/LocAccuracyInfo' +minItems: 1 +accuInfo: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AccuracyInfo' +cancelAccuInd: +type: boolean +description: > +Indicates cancelled request of the analytics accuracy information. +Set to "true" indicates the NWDAF cancelled request of analytics accuracy +information as the NWDAF does not support the accuracy checking capability. +Otherwise set to "false". Default value is "false" if omitted. +movBehavInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/MovBehavInfo' +minItems: 1 +relProxInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RelProxInfo' +minItems: 1 +suppFeat: +$ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +EventFilter: +description: Represents the event filters used to identify the requested analytics. +type: object +properties: +anySlice: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AnySlice' +snssais: +type: array +items: +$ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' +minItems: 1 +description: Identification(s) of network slice. +roamingInfo: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RoamingInfo' +appIds: +type: array +items: +$ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' +minItems: 1 +dnns: +type: array +items: +$ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +minItems: 1 +dnais: +type: array +items: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnai' + minItems: 1 + ladnDnns: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + minItems: 1 + description: Identification(s) of LADN DNN to indicate the LADN service area as the AOI. + location: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/GeoLocation' + networkArea: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + temporalGranSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + spatialGranSizeTa: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + spatialGranSizeCell: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + fineGranAreas: + type: array + items: + $ref: 'TS29522_AMPolicyAuthorization.yaml#/components/schemas/GeographicalArea' + minItems: 1 + description: Indicates the fine granularity areas to which the request applies. + visitedAreas: + type: array + items: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + minItems: 1 + maxTopAppUINbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + maxTopAppDlNbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + nfInstanceIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + nfSetIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + nfTypes: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/NFType' + minItems: 1 + nsiIdInfos: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NsiIdInfo' + minItems: 1 + qosRequ: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/QosRequirement' + nwPerfReqs: + type: array + items: + $ref: '#/components/schemas/NetworkPerfReq' + minItems: 1 + nwPerfTypes: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NetworkPerfType' + minItems: 1 + addNwPerfReqs: + type: array + items: + $ref: '#/components/schemas/ResourceUsageRequPerNwPerfType' + minItems: 1 + userDataConReqs: + type: array + items: + $ref: '#/components/schemas/UserDataCongestReq' + minItems: 1 + bwReqs: + type: array + items: + +``` + +``` +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/BwRequirement' +minItems: 1 +excepIds: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ExceptionId' +minItems: 1 +exptAnaType: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ExpectedAnalyticsType' +exptUeBehav: +$ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/ExpectedUeBehaviourData' +ratFreqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RatFreqInformation' +minItems: 1 +dispersReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DispersionRequirement' +minItems: 1 +redTransReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/RedundantTransmissionExpReq' +minItems: 1 +wlanReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/WlanPerformanceReq' +minItems: 1 +listOfAnaSubsets: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AnalyticsSubset' +minItems: 1 +upfInfo: +$ref: 'TS29508_Nsmf_EventExposure.yaml#/components/schemas/UpfInformation' +appServerAddrs: +type: array +items: +$ref: 'TS29517_Naf_EventExposure.yaml#/components/schemas/AddrFqdn' +minItems: 1 +dnPerfReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DnPerformanceReq' +minItems: 1 +ueMobilityReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/UeMobilityReq' +minItems: 1 +ueCommReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/UeCommReq' +minItems: 1 +pduSesInfos: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/PduSessionInfo' +minItems: 1 +pduSesTrafReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/PduSesTrafficReq' +minItems: 1 +locAccReqs: +type: array +items: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/LocAccuracyReq' +minItems: 1 +locGranularity: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/LocInfoGranularity' +locOrientation: +$ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/LocationOrientation' +``` + +``` + useCaseCxt: + type: string + description: > + Indicates the context of usage of the analytics. The value and format of this parameter + are not standardized. + dataVolTrnsTmRqs: + type: array + items: + $ref: + 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/E2eDataVolTransTimeReq' + minItems: 1 + accuReq: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/AccuracyReq' + movBehavReqs: + type: array + items: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/MovBehavReq' + minItems: 1 + relProxReqs: + type: array + items: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/RelProxReq' + minItems: 1 + not: + required: [anySlice, snssais] + +ProblemDetailsAnalyticsInfoRequest: + description: > + Extends ProblemDetails to indicate more details why the analytics request is rejected. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/AdditionInfoAnalyticsInfoRequest' + +AdditionInfoAnalyticsInfoRequest: + description: Indicates additional information why the analytics request is rejected. + type: object + properties: + rvWaitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +ContextData: + description: > + Contains context information related to analytics subscriptions corresponding with one or + more context identifiers. + type: object + properties: + contextElem: + type: array + items: + $ref: '#/components/schemas/ContextElement' + minItems: 1 + description: > + List of items that contain context information corresponding with a context identifier. + required: + - contextElem + +ContextElement: + description: Contains context information corresponding with a specific context identifier. + type: object + properties: + contextId: + $ref: + 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/AnalyticsContextIdentifier' + pendAnalytics: + type: array + items: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/EventNotification' + minItems: 1 + description: > + Output analytics for the analytics subscription which have not yet been sent to the + analytics consumer. + histAnalytics: + type: array + items: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/EventNotification' + minItems: 1 + description: Historical output analytics. + lastOutputTime: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +aggrSubs: + type: array + items: + $ref: '#/components/schemas/SpecificAnalyticsSubscription' + minItems: 1 + description: > + Information about analytics subscriptions that the NWDAF has with other NWDAFs to + perform aggregation. +histData: + type: array + items: + $ref: '#/components/schemas/HistoricalData' + minItems: 1 + description: Historical data related to the analytics subscription. +adrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +adrfDataTypes: + type: array + items: + $ref: '#/components/schemas/AdrfDataType' + minItems: 1 + description: Type(s) of data stored in the ADRF by the NWDAF. +aggrNwdaIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + description: > + NWDAF identifiers of NWDAF instances used by the NWDAF service consumer when aggregating + multiple analytics subscriptions. +modelInfo: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ModelInfo' + minItems: 1 + description: > + Contains information identifying the ML model(s) that the consumer NWDAF is currently + subscribing for the analytics. +required: +- contextId + +ContextIdList: + description: > + Contains a list of context identifiers of context information of analytics + subscriptions. + type: object + properties: + contextIds: + type: array + items: + $ref: +'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/AnalyticsContextIdentifier' + minItems: 1 + required: + - contextIds + +HistoricalData: + description: Contains historical data related to an analytics subscription. + type: object + properties: + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + subsWithSources: + type: array + items: + $ref: '#/components/schemas/SpecificDataSubscription' + minItems: 1 + description: Information about subscriptions with the data sources. + data: + type: array + items: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataNotification' + minItems: 1 + description: Historical data related to the analytics. + required: +``` + +``` +- data + +NetworkPerfReq: + description: Represents a network performance requirement. + type: object + properties: + orderCriterion: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/NetworkPerfOrderCriterion' + orderDirection: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/MatchingDirection' + +SpecificAnalyticsSubscription: + description: > + Represents an existing subscription for a specific type of analytics to a specific NWDAF. + type: object + properties: + subscriptionId: + type: string + producerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + producerSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + nwdaFevSub: + $ref: 'TS29520_NnwdaF_EventsSubscription.yaml#/components/schemas/NnwdaFEventsSubscription' + allOf: + - oneOf: + - required: [producerId] + - required: [producerSetId] + - required: [subscriptionId] + - required: [nwdaFevSub] + +RequestedContext: + description: Contains types of analytics context information. + type: object + properties: + contexts: + type: array + items: + $ref: '#/components/schemas/ContextType' + minItems: 1 + description: List of analytics context types. + required: + - contexts + +SmcceInfo: + description: Represents the Session Management congestion control experience information. + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + smcceUeList: + $ref: '#/components/schemas/SmcceUeList' + required: + - smcceUeList + +SmcceUeList: + description: > + Represents the List of UEs classified based on experience level of Session Management + congestion control. + type: object + properties: + highLevel: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + mediumLevel: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + lowLevel: + type: array +``` + +``` + + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + minItems: 1 + anyOf: + - required: [highLevel] + - required: [mediumLevel] + - required: [lowLevel] + +SpecificDataSubscription: + description: > + Represents an existing subscription for data collection to a specific data source NF. + type: object + properties: + subscriptionId: + type: string + producerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + producerSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + dataSub: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSubscription' + allOf: + - oneOf: + - required: [producerId] + - required: [producerSetId] + - required: [subscriptionId] + - required: [dataSub] + +UserDataCongestReq: + description: > + Represents a user data congestion requirement. + type: object + properties: + orderCriterion: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/UserDataConOrderCrit' + orderDirection: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/MatchingDirection' + +ResourceUsageRequPerNwPerfType: + description: More requirement for each network performance type. + type: object + properties: + nwPerfType: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NetworkPerfType' + rscUsgReq: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/ResourceUsageRequirement' + required: + - nwPerfType + +# +# ENUMERATIONS DATA TYPES +# +EventId: + anyOf: + - type: string + enum: + - LOAD_LEVEL_INFORMATION + - NETWORK_PERFORMANCE + - NF_LOAD + - SERVICE_EXPERIENCE + - UE_MOBILITY + - UE_COMMUNICATION + - QOS_SUSTAINABILITY + - ABNORMAL_BEHAVIOUR + - USER_DATA_CONGESTION + - NSI_LOAD_LEVEL + - SM_CONGESTION + - DISPERSION + - RED_TRANS_EXP + - WLAN_PERFORMANCE + - DN_PERFORMANCE + - PFD_DETERMINATION + - PDU_SESSION_TRAFFIC + - E2E_DATA_VOL_TRANS_TIME + - MOVEMENT_BEHAVIOUR + - LOC_ACCURACY + - RELATIVE_PROXIMITY + +``` + +``` +- 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 analytics type. + Possible values are: + - LOAD_LEVEL_INFORMATION: Represent the analytics of load level information of corresponding + network slice. + - NETWORK_PERFORMANCE: Represent the analytics of network performance information. + - NF_LOAD: Indicates that the event subscribed is NF Load. + - SERVICE_EXPERIENCE: Represent the analytics of service experience information of the + specific applications. + - UE_MOBILITY: Represent the analytics of UE mobility. + - UE_COMMUNICATION: Represent the analytics of UE communication. + - QOS_SUSTAINABILITY: Represent the analytics of QoS sustainability information in the + certain area. + - ABNORMAL_BEHAVIOUR: Indicates that the event subscribed is abnormal behaviour information. + - USER_DATA_CONGESTION: Represent the analytics of the user data congestion in the certain + area. + - NSI_LOAD_LEVEL: Represent the analytics of Network Slice and the optionally associated + Network Slice Instance. + - SM_CONGESTION: Represent the analytics of Session Management congestion control experience + information for specific DNN and/or S-NSSAI. + - DISPERSION: Represents the analytics of dispersion. + - RED_TRANS_EXP: Represents the analytics of Redundant Transmission Experience. + - WLAN_PERFORMANCE: Represents the analytics of WLAN performance. + - DN_PERFORMANCE: Represents the analytics of DN performance. + - PFD_DETERMINATION: Represents the analytics of PFD Determination information for known + application identifier(s). + - PDU_SESSION_TRAFFIC: Represents the analytics of PDU Session traffic. + - E2E_DATA_VOL_TRANS_TIME: Represents the analytics of E2E data volume transfer time. + - MOVEMENT_BEHAVIOUR: Represents the analytics of the Movement Behaviour information. + - LOC_ACCURACY: Represents the analytics of location accuracy. + - RELATIVE_PROXIMITY: Represents the analytics of Relative Proximity information. + +ContextType: + anyOf: + - type: string + enum: + - PENDING_ANALYTICS + - HISTORICAL_ANALYTICS + - AGGR_SUBS + - DATA + - AGGR_INFO + - ML_MODELS + - 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 analytics context information type. + Possible values are: + - PENDING_ANALYTICS: Represents context information that relates to pending output + analytics. + - HISTORICAL_ANALYTICS: Represents context information that relates to historical output + analytics. + - AGGR_SUBS: Represents context information about the analytics subscriptions that an NWDAF + has with other NWDAFs that collectively serve an analytics subscription. + - DATA: Represents context information about historical data that is available. + - AGGR_INFO: Represents context information that is related to aggregation of analytics + from multiple NWDAF subscriptions. + - ML_MODELS: Represents context information about used ML models. + +AdrfDataType: + anyOf: + - type: string + enum: + - HISTORICAL_ANALYTICS + - HISTORICAL_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 type of data that is stored in the ADRF. + Possible values are: + - HISTORICAL_ANALYTICS: Indicates that historical analytics are stored in the ADRF. + - HISTORICAL_DATA: Indicates that historical data are stored in the ADRF. + +``` + +## A.4 Nnwdaf\_DataManagement API + +``` + +openapi: 3.0.0 +info: + title: Nnwdaf_DataManagement + version: 1.1.0-alpha.4 + description: | + Nnwdaf_DataManagement API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/' + servers: + - url: '{apiRoot}/nnwdaf-datamanagement/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-datamanagement + paths: + /subscriptions: + post: + summary: subscribe to notifications + operationId: CreateIndividualSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafDataManagementSubsc' + responses: + '201': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafDataManagementSubsc' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaf-datamanagement//subscriptions/{subId}. + 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: + myNotification: + '{ $request.body#/notificURI }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafDataManagementNotif' + responses: + '200': + description: The notification is acknowledged and a planned action is provided. + content: + application/json: + schema: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/NotifResponse' + '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' + callbacks: + Fetch: + '{ $request.body#/fetchInstruct/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/NnwdafDataManagementNotif' + '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' + '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}: + put: + summary: Update an existing Individual NWDAF Data Subscription. + operationId: UpdateNWDAFDataSubscription + tags: + - Individual NWDAF Data Management Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NnwdafDataManagementSubsc' + parameters: + - name: subscriptionId + in: path + description: 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/NnwdafDataManagementSubsc' + '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: unsubscribe from notifications + operationId: DeleteNWDAFDataSubscription + tags: + - Individual NWDAF Data Management Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: Event Subscription ID + required: true + schema: + type: string + responses: + '204': + description: No Content. Resource was successfully deleted + '200': + description: > + Resource was successfully deleted and including the stored unsent events in the response. + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafDataManagementNotif' + '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: + nnwdaf-datamanagement: Access to the Nnwdaf_DataManagement API +schemas: + NnwdafDataManagementSubsc: + description: Represents an Individual NWDAF Data Management Subscription resource. + type: object + properties: + adrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + adrfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + anaSub: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription' + dataCollectPurposes: + type: array + items: + $ref: 'TS29574_Ndccb_DataManagement.yaml#/components/schemas/DataCollectionPurpose' + minItems: 1 + description: > + The purposes of data collection. This attribute may only be provided if user consent + is required depending on local policy and regulations and the consumer has + not checked user consent. + checkedConsentInd: + +``` + +``` +type: boolean +description: Indication that the NF service consumer has already checked the user consent. +dataSub: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSubscription' +formatInstruct: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/FormattingInstruction' +notifCorrId: + type: string + description: Notification correlation identifier. +notifURI: + $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. +suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +targetNfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +targetNfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +timePeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' +immReport: + $ref: '#/components/schemas/NnwdafDataManagementNotif' +storeHandl: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/StorageHandlingInformation' +required: +- notifCorrId +- notifURI +oneOf: +- required: [anaSub] +- required: [dataSub] +NnwdafDataManagementNotif: +description: Represents an Individual Notification. +type: object +properties: + dataNotification: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataNotification' + dataReports: + type: array + items: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/NotifSummaryReport' + minItems: 1 + description: List of summary reports of processed notifications. + delAlert: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/DeletionAlert' + notifCorrId: + type: string + description: Notification correlation identifier. + terminationReq: + type: string + description: > + It indicates that the termination of the data management subscription + is requested by the NWDAF. + fetchInstruct: + $ref: 'TS29576_Nmfa_3caDataManagement.yaml#/components/schemas/FetchInstruction' + notifTimestamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + pendNotifCause: + $ref: '#/components/schemas/PendingNotificationCause' +required: +- notifCorrId +- notifTimestamp +oneOf: +- required: [dataNotification] +- required: [dataReports] +- required: [fetchInstruct] +``` + +``` + +# +# ENUMERATIONS DATA TYPES +# + PendingNotificationCause: + anyOf: + - type: string + enum: + - UE_OUT_OF_NF_SERVING_AREA + - 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. + description: | + Represents the Pending Notification Cause for the stored unsent data. + Possible values are: + - UE_OUT_OF_NF_SERVING_AREA: The UE moved out of the NF serving area. + - OTHER: Other cause. + +``` + +## A.5 Nnwdaf\_MLModelProvision API + +openapi: 3.0.0 + +``` + +info: + title: Nnwdaf_MLModelProvision + version: 1.1.0-alpha.5 + description: | + Nnwdaf_MLModelProvision API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ + +servers: +- url: '{apiRoot}/nnwdaf-mlmodelprovision/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: +- {} +- oAuth2ClientCredentials: +- nnwdaf-mlmodelprovision + +paths: +/subscriptions: + post: + summary: Create a new Individual NWDAF ML Model Provision Subscription resource. + operationId: CreateNWDAFMLModelProvisionSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelProvSubsc' + responses: + '201': + description: Create a new Individual NWDAF ML Model Provision Subscription resource. + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelProvSubsc' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaf-mlmodelprovision/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: + myNotification: + '{ $request.body#/notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NwdaFModelProvNotif' + minItems: 1 + 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' + +/subscriptions/{subscriptionId}: + put: + summary: update an existing Individual NWDAF ML Model Provision Subscription + operationId: UpdateNWDAFMLModelProvisionSubscription + tags: + - Individual NWDAF ML Model Provision Subscription (Document) + requestBody: + required: true + +``` + +``` +content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelProvSubsc' +parameters: +- name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelProvision Service. + required: true + schema: + type: string +responses: +'200': + description: > + The Individual NWDAF ML Model Provision Subscription resource was modified successfully + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelProvSubsc' +'204': + description: > + The Individual NWDAF ML Model Provision Subscription 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' +'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: Delete an existing Individual NWDAF ML Model Provision Subscription. + operationId: DeleteNWDAFMLModelProvisionSubscription + tags: + - Individual NWDAF ML Model Provision Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelProvision Service. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF ML Model Provision Subscription matching the + subscriptionId 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: + nnwda-mlmodelprovision: Access to the Nnwdaf_MLModelProvision API + +schemas: + NwdafMLModelProvSubsc: + description: Represents NWDAF Event Subscription resources. + type: object + properties: + mLEventSubscs: + type: array + items: + $ref: '#/components/schemas/MLEventSubscription' + minItems: 1 + description: Subscribed events + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + mLEventNotifs: + type: array + items: + $ref: '#/components/schemas/MLEventNotif' + minItems: 1 + description: > + Notifications about Individual Events. Shall only be present if the immediate reporting + indication in the "immRep" attribute within the "eventReq" attribute sets to true in the + event subscription, and the reports are available. + suppFeats: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + notifCorreId: + type: string + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + failEventReports: + type: array + items: + $ref: '#/components/schemas/FailureEventInfoForMLModel' + minItems: 1 + description: > + Supplied by the NWDAF containing MTLF when available, shall contain the event(s) that + the subscription is not successful including the failure reason(s). + required: + - mLEventSubscs + - notifUri + +ModelProvisionParamsExt: + description: > + Extended parameters for ML model provisioning which can optionally be set by a service + consumer NF. + type: object + properties: + reqRepRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + inferInpDataInfos: + type: array + items: + $ref: '#/components/schemas/InputDataInfo' + minItems: 1 + description: > + Inference information that is used by NWDAF containing AnLF during inference. + +``` + +``` +multModelsInd: + type: boolean + description: Indicates if the NF service consumer supports multiple models. +numModels: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +accuLevels: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/Accuracy' + minItems: 1 + description: > + Provided accuracy levels of interest for ML models. + +InputDataInfo: + description: Contains information about inference that is used by NWDAF containing AnLF. + type: object + properties: + ratio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + maxNumSamples: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + maxTimeInterval: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + inpEvent: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/DccfEvent' + nfInstanceIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + minItems: 1 + nfSetIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + minItems: 1 + required: + - inpEvent + +MLEventSubscription: + description: Represents a subscription to a single event. + type: object + properties: + mLEvent: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + mLEventFilter: + $ref: 'TS29520_Nnwdaf_AnalyticsInfo.yaml#/components/schemas/EventFilter' + tgtUe: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/TargetUeInformation' + mLTargetPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + expiryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + timeModelNeeded: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + mLEvRepCon: + $ref: '#/components/schemas/MLRepEventCondition' + modelInterInfo: + type: string + description: String representing the ML Model Interoperability Information. + nfConsumerInfo: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/VendorId' + modelProvExt: + $ref: '#/components/schemas/ModelProvisionParamsExt' + description: > + Extended ML model parameters that a service consumer optionally sets when subscribing to + an ML model to be provisioned. + useCaseCxt: + type: string + description: > + Indicates the context of usage of the analytics. The value and format of this parameter + are not standardized. + inferDataForModel: + $ref: '#/components/schemas/InferenceDataForModelTrain' + required: + - mLEvent + - mLEventFilter +``` + +``` +NwdafMLModelProvNotif: + description: Represents notifications on events that occurred. + type: object + properties: + eventNotifs: + type: array + items: + $ref: '#/components/schemas/MLEventNotif' + minItems: 1 + description: Notifications about Individual Events. + subscriptionId: + type: string + description: String identifying a subscription to the Nnwdaf_MLModelProvision Service. + required: + - eventNotifs + - subscriptionId + +MLEventNotif: + description: Represents a notification related to a single event that occurred. + type: object + properties: + event: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + notifCorreId: + type: string + description: > + Contains notification correlation ID used to identify the subscription to which the + notification relates. It shall be set to the same value as the "notifCorreId" attribute + of NwdafMLModelProvSubsc data type. + mlFile: + type: string + description: Contains the ML model file. + mlFileAddr: + $ref: '#/components/schemas/MLModelAddr' + mlModelAdrf: + $ref: '#/components/schemas/MLModelAdrf' + validityPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + spatialValidity: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + addModelInfo: + type: array + items: + $ref: '#/components/schemas/AdditionalMLModelInformation' + minItems: 1 + description: Contains the additional ML Model Information besides the ML Model Address + allOf: + - required: [event] + - oneOf: + - required: [mlFileAddr] + - required: [mlModelAdrf] + +FailureEventInfoForMLModel: + description: > + Represents the event(s) that the subscription is not successful including the failure + reason(s). + type: object + properties: + event: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NwdafEvent' + failureCode: + $ref: '#/components/schemas/FailureCode' + required: + - event + - failureCode + +MLModelAddr: + description: Addresses of ML model files. + type: object + properties: + mlModelUrl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + mlFileFqdn: + type: string + description: The FQDN of the ML Model file. + oneOf: + - required: [mlModelUrl] + - required: [mlFileFqdn] +``` + +``` +MLRepEventCondition: + description: Indicates the ML event reporting condition. + type: object + properties: + mlTrainRound: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + mlTrainRepTime: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + mlAccuracyThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + modelMetric: + $ref: '#/components/schemas/MLModelMetric' + +AdditionalMLModelInformation: + description: Represents the additional ML Model Information. + type: object + properties: + mlFileAddr: + $ref: '#/components/schemas/MLModelAddr' + mlModelAdrf: + $ref: '#/components/schemas/MLModelAdrf' + validityPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + spatialValidity: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + modelUniqueId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + description: Unique identifier for an ML model. + modelRepRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + description: > + Minimum percentage of UEs whose data is used for training an ML model. + mlDegradInd: + type: boolean + description: > + Set to "true" to indicate support degradation of an ML model. Set to "false" to indicate + not support degradation of an ML model. Default value is "false" if omitted. + trainInpInfos: + type: array + items: + $ref: '#/components/schemas/TrainInputDataInfo' + minItems: 1 + description: > + Training information that is used by NWDAF containing MTLF during training. + modelMetric: + $ref: '#/components/schemas/MLModelMetric' + accMLModel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +MLModelAdrf: + description: ADRF (Set) information of the ML Model. + type: object + properties: + adrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + adrfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + storTransId: + type: string + description: String identifying a Storage Transaction ID. + oneOf: + - required: [adrfId] + - required: [adrfSetId] + +TrainInputDataInfo: + description: Contains Training input data information that is used by NWDAF containing MTLF. + type: object + properties: + dataInfo: + $ref: '#/components/schemas/InputDataInfo' + time: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + dataStatisticsInfos: + type: string +``` + +``` + +InferenceDataForModelTrain: + description: > + Indicates the inference data stored in ADRF which can be used by MTLF to retrain or + reprovision of the ML model. + type: object + properties: + adrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + adrfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + dataSetTag: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSetTag' + modelId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + oneOf: + - required: [adrfId] + - required: [adrfSetId] + +# +# ENUMERATIONS DATA TYPES +# + +FailureCode: + anyOf: + - type: string + enum: + - UNAVAILABLE_ML_MODEL + - 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 code. + Possible values are: + - UNAVAILABLE_ML_MODEL: Indicates the requested ML model for the event is unavailable. + +MLModelMetric: + anyOf: + - type: string + enum: + - ACCURACY + - 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 metric of the ML model. + Possible values are: + - ACCURACY: ML Model Accuracy metric. + +``` + +## A.6 Nnwdaf\_MLModelTraining API + +openapi: 3.0.0 + +``` + +info: + title: Nnwdaf_MLModelTraining + version: 1.0.0-alpha.3 + description: | + Nnwdaf_MLModelTraining API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ + +``` + +``` + +servers: + - url: '{apiRoot}/nnwdaf-mlmodeltraining/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +``` + +``` + +security: + - {} + - oAuth2ClientCredentials: + +``` + +``` + +- nnwda-mlmodeltraining + +paths: + /subscriptions: + post: + summary: Create a new Individual NWDAF ML Model Training Subscription resource. + operationId: CreateNWDAFMLModelTrainingSubscription + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelTrainSubsc' + responses: + '201': + description: Create a new Individual NWDAF ML Model Training Subscription resource. + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelTrainSubsc' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwda-mlmodeltraining/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: + myNotification: + '{ $request.body#/notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NwdafMLModelTrainNotif' + minItems: 1 + 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' +/subscriptions/{subscriptionId}: + put: + summary: update an existing Individual NWDAF ML Model Training Subscription + operationId: UpdateNWDAFMLModelTrainingSubscription + tags: + - Individual NWDAF ML Model Training Subscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelTrainSubsc' + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelTraining Service. + required: true + schema: + type: string + responses: + '200': + description: > + The Individual NWDAF ML Model Training Subscription resource was modified successfully + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelTrainSubsc' + '204': + description: > + The Individual NWDAF ML Model Training Subscription 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' + '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: partial update an existing Individual NWDAF ML Model Training Subscription + operationId: PartialUpdateNWDAFMLModelTrainingSubscription + tags: + - Individual NWDAF ML Model Training Subscription (Document) + requestBody: + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/NwdafMLModelTrainSubscPatch' + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelTraining Service. + required: true + schema: + type: string + responses: + '200': + description: > + The Individual NWDAF ML Model Training Subscription resource was partial modified + successfully and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/NwdafMLModelTrainSubsc' + '204': + description: > + The Individual NWDAF ML Model Training Subscription resource was partial 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' + '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: Delete an existing Individual NWDAF ML Model Training Subscription. + operationId: DeleteNWDAFMLModelTrainingSubscription + tags: + - Individual NWDAF ML Model Training Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelTraining Service. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF ML Model Training Subscription matching the + subscriptionId 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: + nnwdaif-mlmodeltraining: Access to the Nnwdaif_MLModelTraining API + +schemas: + NwdaifMLModelTrainSubsc: + description: Represents a ML Model Training subscription. + type: object + properties: + mLEventSubscs: + type: array + items: + $ref: 'TS29520_Nnwdaif_MLModelProvision.yaml#/components/schemas/MLEventSubscription' + minItems: 1 + description: Subscribed events + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + suppFeats: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + failEventReports: + type: array + items: + $ref: '#/components/schemas/FailureEventInfoForMLModelTrain' + minItems: 1 + description: > + Supplied by the NWDAF containing MTTF when available, shall contain the event(s) that + the subscription is not successful including the failure reason(s). + mlCorreId: + type: string + description: String identifying the subscription is for a Federated Learning procedure. + mLModelInfos: + type: array + items: + $ref: 'TS29520_Nnwdaif_MLModelProvision.yaml#/components/schemas/MLEventNotif' + minItems: 1 + description: Represents the ML Model information. + immReports: + type: array + items: + $ref: '#/components/schemas/NwdaifMLModelTrainNotif' + minItems: 1 + description: Immediately reported ML Model Training notifications. + mLModelTrainInfos: + type: array + items: + $ref: '#/components/schemas/MLModelTrainInfo' + minItems: 1 + description: Represents the ML Model training information. +``` + +``` + mLPreFlag: + type: boolean + description: > + Indicates whether the subscription is for preparation of ML Model training. Set to + "true" if it is for ML training preparation, otherwise set to "false". + mLAccChkFlg: + type: boolean + description: > + Indicates whether request using the local training data as the testing dataset to + calculate the Model Accuracy of the global ML model provided by the consumer. Set to + "true" if it is requested, otherwise set to "false". + mLTrainRepInfo: + $ref: '#/components/schemas/MLTrainReportInfo' + notifCorreId: + type: string + description: > + String identifying the Notification Correlation ID in the corresponding notification. + roundInd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + tgtRepUe: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/TargetUeInformation' + uCaseCont: + type: string + description: > + String identifying the use case context of the ML model. The value and format of this + parameter is not standardized. + required: + - mLEventSubscs + - notifUri + - notifCorreId + +NnwdafMLModelTrainSubscPatch: + description: > + Represents parameters to request the modification of a ML Model Training subscription. + type: object + properties: + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + eventReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + mLModelInfos: + type: array + items: + $ref: 'TS29520_Nnwdaf_MLModelProvision.yaml#/components/schemas/MLEventNotif' + minItems: 1 + description: Represents the ML Model information. + mLModelTrainInfos: + type: array + items: + $ref: '#/components/schemas/MLModelTrainInfo' + minItems: 1 + description: Represents the ML Model training information. + mLPreFlag: + type: boolean + description: > + Indicates whether the subscription is for preparation of ML Model training. Set to + "true" if it is for ML training preparation, otherwise set to "false". + mLAccChkFlg: + type: boolean + description: > + Indicates whether request using the local training data as the testing dataset to + Calculate the Model Accuracy of the global ML model provided by the consumer. Set to + "true" if it is requested, otherwise set to "false". + mLTrainRepInfo: + $ref: '#/components/schemas/MLTrainReportInfo' + roundInd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + tgtRepUe: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/TargetUeInformation' + uCaseCont: + type: string + description: > + String identifying the use case context of the ML model. The value and format of this + parameter are not standardized. + +NnwdafMLModelTrainNotif: + description: Represents notifications on events that occurred. + type: object +``` + +``` + +properties: + delayEventNotif: + $ref: '#/components/schemas/DelayEventNotif' + mlCorreId: + type: string + description: String identifying the subscription is for a Federated Learning procedure. + mLModelInfos: + type: array + items: + $ref: 'TS29520_Nnwdaf_MLModelProvision.yaml#/components/schemas/MLEventNotif' + minItems: 1 + description: Represents the ML Model information. + notifCorreId: + type: string + description: > + String identifying the Notification Correlation ID in the corresponding notification. + roundInd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + statusReport: + $ref: '#/components/schemas/StatusReportInfo' + termTrainReq: + $ref: '#/components/schemas/TermTrainCause' + uCaseCont: + type: string + description: > + String identifying the context of use of ML model. The value and format of this + parameter are not standardized. +required: +- notifCorreId +oneOf: +- required: [delayEventNotif] +- required: [mLModelInfos] +- required: [termTrainReq] +- required: [mLModelInfos, termTrainReq] + +MLModelTrainInfo: +description: > + Represents the ML Model training information, include requirement on data availability and + time availability, training filter information. +type: object +properties: + dataAvReq: + $ref: '#/components/schemas/DataAvReq' + timeAvReq: + type: string + description: > + String representing the requirement on available time for the ML model training. + +MLTrainReportInfo: +description: Represents the ML Model training reporting information. +type: object +properties: + maxResTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + +FailureEventInfoForMLModelTrain: +description: Represents the failure event information for a ML Model Training subscription. +type: object +properties: + mLTrainEvent: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEvent' + failureCodeTrain: + $ref: '#/components/schemas/FailureCodeTrain' +required: +- mLTrainEvent +- failureCodeTrain + +DataAvReq: +description: Represents the requirement on available data for the ML model training. +type: object +properties: + dataStatProps: + type: array + items: + $ref: + 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/DatasetStatisticalProperty' + minItems: 1 + inpEvents: + +``` + +``` + + type: array + items: + $ref: 'TS29574_Ndccf_DataManagement.yaml#/components/schemas/DccfEvent' + minItems: 1 + minNumSamples: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + timeWindows: + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + minItems: 1 + required: + - inpEvents + +DelayEventNotif: + description: > + Indicating that the NWDAF containing MTTF is not able to complete the training of ML model + within the maximum response time, the cause code, and the expected time complete the + training. + type: object + properties: + delayEventInd: + type: boolean + description: > + Indicates that the NWDAF containing MTTF is not able to complete the training of ML + model within the maximum response time. Set to "true" if not able to complete the ML + model training on time, otherwise set to "false". + delayCause: + $ref: '#/components/schemas/DelayCause' + expCompTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + required: + - delayEventInd + +StatusReportInfo: + description: > + Indicating status information generated by the NWDAF containing MTTF during ML model + training. + type: object + properties: + mlModelAcc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + trainInDataInfo: + $ref: '#/components/schemas/TrainDataInfo' + +TrainDataInfo: + description: Represents the training input data information. + type: object + properties: + areaDataSet: + type: string + description: Indicates the areas covered by the data set. + maxValues: + type: array + items: + type: string + minItems: 1 + description: Represents the maximum value of one dimension of data. + minValues: + type: array + items: + type: string + minItems: 1 + description: Represents the minimum value of one dimension of data. + samplRatio: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + +# +# ENUMERATIONS DATA TYPES +# +FailureCodeTrain: + anyOf: + - type: string + enum: + - UNAVAILABLE_ML_MODEL_TRAIN + - 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. + Possible values are: + - UNAVAILABLE_ML_MODEL_TRAIN: The ML model training is unavailable. + +TermTrainCause: + anyOf: + - type: string + enum: + - NWDAF_OVERLOAD + - NOT_AVAILABLE_ML_TRAIN + - OTHERS + - 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 reasons that ML Model Training to be terminated. + Possible values are: + - NWDAF_OVERLOAD: The NWDAF is overloaded for the ML model training. + - NOT_AVAILABLE_ML_TRAIN: The ML model training process is not available. + - OTHERS: Other cause. + +DelayCause: + anyOf: + - type: string + enum: + - ML_MODEL_TRAIN_FAILURE + - NEED_MORE_TIME + - OTHERS + - 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 reasons for ML Model training delay. + Possible values are: + - ML_MODEL_TRAIN_FAILURE: The ML model training is failure. + - NEED_MORE_TIME: The ML model training needs more time. + - OTHERS: Other cause. + +``` + +## A.7 Nnwdaf\_ MLModelMonitor API + +openapi: 3.0.0 + +``` + +info: + title: Nnwdaf_ MLModelMonitor + version: 1.0.0-alpha.1 + description: | + Nnwdaf_ MLModelMonitor API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ + +servers: + - url: '{apiRoot}/nnwdaf-mlmodelmonitor/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnwdaf-mlmodelmonitor + +paths: + /registrations: + post: + summary: Create a new Individual NWDAF ML Model monitoring registration resource. + operationId: CreateNWDAFMLModelMonitoringRegistration + +``` + +``` + +tags: + - registrations (Collection) +requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorReg' +responses: + '201': + description: Create a new Individual NWDAF ML Model monitoring registration resource. + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorReg' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaF-mlmodelmonitor//registrations/{registrationId}. + 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' + +/registrations/{registrationId}: + delete: + summary: Delete an existing Individual NWDAF ML model monitoring registration. + operationId: DeleteNWDAFMLModelMonitoringRegistration + tags: + - Individual NWDAF ML model monitoring registration (Document) + parameters: + - name: registrationId + in: path + description: String identifying a registration to the NnwdaF_MLModelMonitor Service. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF ML Model monitoring registration matching the + registrationId 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' + +/subscriptions: + post: + summary: Create a new Individual NWDAF ML model monitoring Subscription. + operationId: CreateNWDAFMLModelMonitoringSubscription + tags: + - NWDAF ML model monitoring Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorSub' + responses: + '201': + description: Create a new Individual NWDAF ML model monitoring Subscription resource. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaf-mlmodelmonitor//subscriptions/{subscriptionId} + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorSub' + '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: + myNotification: + '{ $request.body#/notificationUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/MLModelMonitorNotify' + minItems: 1 + 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' + +/subscriptions/{subscriptionId}: + put: + summary: Update an existing Individual NWDAF ML model monitoring Subscription resource. + operationId: UpdateNWDAFMLModelMonitoringSubscription + tags: + - Individual NWDAF ML model monitoring Subscription resource (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorSub' + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelMonitor Service. + required: true + schema: + type: string + responses: + '200': + description: > + The Individual NWDAF ML model monitoring Subscription resource was modified successfully + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/MLModelMonitorSub' + '204': + description: > + The Individual NWDAF ML model monitoring Subscription 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: Delete an existing Individual NWDAF ML model monitoring Subscription. + operationId: DeleteNWDAFMLModelMonitoringSubscription + tags: + - Individual NWDAF ML model monitoring Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_MLModelMonitor Service + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF ML model monitoring Subscription resource matching the + subscriptionId 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' + '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: + nnwdaf-mlmodelmonitor: Access to the Nnwdaf_MLModelMonitor API + +schemas: + MLModelMonitorReg: + description: Represents a ML Model monitoring registration. + type: object + properties: + consumerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + consumerSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + modelId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + modelAccuInd: + type: boolean + +``` + +``` + description: > + Indicates the ML Model accuracy transfer indication. Set to "true" to indicate that the + monitoring of the accuracy of the ML model is supported, otherwise set to "false". + Default value is "false" if omitted. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - modelId + oneOf: + - required: [consumerId] + - required: [consumerSetId] + +MLModelMonitorSub: + description: > + Represents parameters to request the modification of a ML Model monitoring registration. + type: object + properties: + modelIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 + description: Represents the ML Model IDs. + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + modelMetric: + $ref: 'TS29520_Nnwdaif_MLModelProvision.yaml#/components/schemas/MLModelMetric' + accuThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + eventReportReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + immReports: + $ref: '#/components/schemas/MLModelMonitorNotify' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - modelIds + - notificationUri + - notifCorrId + +MLModelMonitorNotify: + description: Represents notifications on events that occurred. + type: object + properties: + notifCorrId: + type: string + description: Notification correlation identifier. + modelAccuInfos: + type: array + items: + $ref: '#/components/schemas/MLModelAccuracyInfo' + minItems: 1 + description: The accuracy related information of the ML model. + anaFeedbacks: + type: array + items: + $ref: '#/components/schemas/AnalyticsFeedback' + minItems: 1 + description: The analytics feedback information. + validPeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + required: + - notifCorrId + anyOf: + - required: [modelAccuInfos] + - required: [anaFeedbacks] + +MLModelAccuracyInfo: + description: Represents the ML Model accuracy information. + type: object + properties: + modelId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + deviation: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' +``` + +``` + +inferenceNum: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' +adrfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' +adrfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' +dataSetTag: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSetTag' +modelMetric: + $ref: 'TS29520_Nnwdaf_ModelProvision.yaml#/components/schemas/MLModelMetric' +required: +- modelId + +AnalyticsFeedback: + description: Represents the analytics feedback. + type: object + properties: + events: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEvent' + minItems: 1 + description: Indicates the Analytics IDs that were used to take this action. + modelIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UInteger' + minItems: 1 + description: Indicates the ML Model identifier that were used to take this action. + groundDataImpactInd: + type: boolean + description: > + Indication whether the action will affect on ground truth data. Set to "true" to + indicate that the action will affect on ground truth data. Otherwise set to "false", + default value is "false" if omitted. + timeStamp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + required: + - events + - modelIds + +``` + +## A.8 Nnwdaf\_RoamingData API + +openapi: 3.0.0 + +``` + +info: + title: Nnwdaf_RoamingData + version: 1.0.0-alpha.1 + description: | + Nnwdaf_RoamingData API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` + +externalDocs: + description: 3GPP TS 29.520 V18.3.0; 5G System; Network Data Analytics Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ + +``` + +``` + +servers: +- url: '{apiRoot}/nnwdaf-roamingdata/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +``` + +``` + +security: +- {} +- oAuth2ClientCredentials: + - nnwdaf-roamingdata + +``` + +``` + +paths: + /subscriptions: + post: + summary: Create a new Individual NWDAF Roaming Data Subscription + operationId: CreateNWDAFRoamingDataSubscription + tags: + +``` + +``` + +- NWDAF Roaming Data Subscriptions (Collection) +requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingDataSub' +responses: + '201': + description: Create a new Individual NWDAF Roaming Data Subscription resource. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nnwdaf-roamingdata//subscriptions/{subscriptionId} + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingDataSub' + '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: + myNotification: + '{ $request.body#/notificationUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: 'TS29520_Nnwdaf_DataManagement.yaml#/components/schemas/NnwdafDataManagementNotif' + minItems: 1 +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' + +``` + +``` + + $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}: + put: + summary: Update an existing Individual NWDAF Roaming Data Subscription resource. + operationId: UpdateNWDAFRoamingDataSubscription + tags: + - Individual NWDAF Roaming Data Subscription resource (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingDataSub' + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_RoamingData Service. + required: true + schema: + type: string + responses: + '200': + description: > + The Individual NWDAF Roaming Data Subscription resource was modified successfully + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingDataSub' + '204': + description: > + The Individual NWDAF Roaming Data Subscription 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: Delete an existing Individual NWDAF Roaming Data Subscription. + operationId: DeleteNWDAFRoamingDataSubscription + +``` + +``` +tags: + - Individual NWDAF Roaming Data Subscription (Document) +parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_RoamingData Service + required: true + schema: + type: string +responses: + '204': + description: > + No Content. The Individual NWDAF Roaming Data Subscription resource matching the + subscriptionId 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' + '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: + nnwdaf-roamingdata: Access to the Nnwdaf_RoamingData API + +schemas: + RoamingDataSub: + description: > + Represents roaming data subscription information. + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + dataSub: + $ref: 'TS29575_Nadrf_DataManagement.yaml#/components/schemas/DataSubscription' + anaSub: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/NnwdafEventsSubscription' + formatInstruct: + $ref: 'TS29574_Ndccb_DataManagement.yaml#/components/schemas/FormattingInstruction' + procInstructs: + type: array + items: + $ref: 'TS29574_Ndccb_DataManagement.yaml#/components/schemas/ProcessingInstruction' + minItems: 1 + description: Processing instructions to be used for sending event notifications. + timePeriod: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + targetNfId: +``` + +``` + + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + targetNfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + immReport: + $ref: 'TS29520_Nnwdaf_DataManagement.yaml#/components/schemas/NnwdafDataManagementNotif' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - notificationUri + - notifCorrId + - plmnId + oneOf: + - required: [anaSub] + - required: [dataSub] + +``` + +## A.9 Nnwdaf\_RoamingAnalytics API + +openapi: 3.0.0 + +``` + +info: + title: Nnwdaf_RoamingAnalytics + version: 1.0.0-alpha.1 + description: | + Nnwdaf_RoamingAnalytics API Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.520 V18.4.0; 5G System; Network Data Analytics Services. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.520/ + +servers: +- url: '{apiRoot}/nnwdaf-roaminganalytics/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: +- {} +- oAuth2ClientCredentials: + - nnwdaf-roaminganalytics + +paths: + /subscriptions: + post: + summary: Create a new Individual NWDAF Roaming Analytics Subscription + operationId: CreateNnwdafRoamingAnalyticsSubscription + tags: + - NWDAF Roaming Analytics Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingAnalyticsSubscription' + responses: + '201': + description: Create a new Individual Roaming Analytics Subscription resource. + headers: + Location: + description: > + Contains the URI of the newly created resource. + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingAnalyticsSubscription' + '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: + myNotification: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/RoamingAnalyticsNotification' + minItems: 1 + 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' + +/subscriptions/{subscriptionId}: + put: + summary: Update an existing Individual Roaming Analytics Subscription resource. + operationId: UpdateNwdaRoamingAnalyticsSubscription + tags: + - Individual NWDAF Roaming Analytics Subscription resource (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingAnalyticsSubscription' + parameters: + +``` + +``` +- name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_RoamingAnalytics service. + required: true + schema: + type: string +responses: + '200': + description: > + The Individual NWDAF Roaming Analytics Subscription resource was modified successfully + and a representation of that resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/RoamingAnalyticsSubscription' + '204': + description: > + The Individual NWDAF Roaming Analytics Subscription 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: Delete an existing Individual NWDAF Roaming Analytics Subscription. + operationId: DeleteNnwdafRoamingAnalyticsSubscription + tags: + - Individual NWDAF Roaming Analytics Subscription (Document) + parameters: + - name: subscriptionId + in: path + description: String identifying a subscription to the Nnwdaf_RoamingAnalytics service + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual NWDAF Roaming Analytics Subscription resource matching the + subscriptionId 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' +'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: + nnwdaf-roaminganalytics: Access to the Nnwdaf_RoamingAnalytics API + +schemas: + RoamingAnalyticsSubscription: + description: Represents a Roaming Analytics subscription. + type: object + properties: + roamEventSubs: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventSubscription' + minItems: 1 + description: Represents Roaming Analytics subscription for a specific event. + evtReq: + $ref: 'TS29523_Npcf_EventExposure.yaml#/components/schemas/ReportingInformation' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorrId: + type: string + description: Notification correlation identifier. + consPlmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnId' + roamEventNotifs: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventNotification' + minItems: 1 + description: Contains immediate reports for Roaming Analytics. + failEventReports: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/FailureEventInfo' + minItems: 1 + description: Contains information about failed events. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - roamEventSubs + - notifUri + - notifCorrId + - consPlmnId + +RoamingAnalyticsNotification: + description: Represents a Roaming Analytics notification. + type: object + properties: + roamEventNotifs: + type: array + items: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/EventNotification' + minItems: 1 + description: Contains Roaming Analytics notification for a specific event. + notifCorrId: + type: string + description: Notification correlation identifier. + termCause: + $ref: 'TS29520_Nnwdaf_EventsSubscription.yaml#/components/schemas/TermCause' +``` + +``` +required: + - roamEventNotifs + - notifCorrId +``` + +--- + +## Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2017-10 | | | | | | TS skeleton of Network Data Analytics Services. | 0.0.0 | +| 2017-11 | CT3#92 | | | | | Inclusion of documents agreed in CT3#92 C3-175356. | 0.1.0 | +| 2017-12 | CT3#93 | | | | | Inclusion of documents agreed in CT3#93 C3-176166, C3-176260, C3-176324, C3-176325, C3-176326, and C3-176327. | 0.2.0 | +| 2018-01 | CT3#94 | | | | | Inclusion of documents agreed in CT3#94 C3-180252, C3-180253, C3-180254, C3-180255, C3-180256, C3-180257, C3-180344, C3-180345, C3-180346, C3-180323 and C3-180347. | 0.3.0 | +| 2018-03 | CT3#95 | | | | | Inclusion of documents agreed in CT3#95 C3-181253, C3-181255, C3-181256, C3-181257, C3-181260, C3-181312, C3-181342 and C3-181343. | 0.4.0 | +| 2018-03 | CT3#96 | | | | | Inclusion of documents agreed in CT3#96 C3-182379 and C3-182380. | 0.5.0 | +| 2018-05 | CT3#97 | | | | | Inclusion of documents agreed in CT3#97 C3-183285, C3-183532, C3-183533, C3-183534 and C3-183535. | 0.6.0 | +| 2018-06 | CT#80 | CP-181032 | | | | TS sent to plenary for approval | 1.0.0 | +| 2018-06 | CT#80 | CP-181032 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 3 | F | Clarification on mandatory HTTP error status codes | 15.1.0 | +| 2018-09 | CT#81 | CP-182209 | 0002 | 4 | B | OpenAPI for TS 29.520 | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0003 | 1 | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | 1 | F | Resource structure presentation | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0006 | | F | Default value for apiRoot | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0007 | 2 | F | Correct Nnwdaf service | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0008 | 1 | F | Cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0009 | | F | API version | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0010 | | F | ExternalDocs OpenAPI field | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0011 | 1 | F | Security | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0012 | 1 | F | Supported content types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0013 | 2 | F | HTTP Error responses | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0014 | 2 | F | Correct NWDAF resource | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0016 | 1 | F | Adding HTTP status code "204 No Content" | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0019 | | F | Location header field in OpenAPI | 15.2.0 | +| 2019-03 | CT#83 | CP-190113 | 0020 | | F | Support of NSSF as the service consumer | 15.3.0 | +| 2019-03 | CT#83 | CP-190113 | 0021 | 1 | F | Formatting of structured data types in query | 15.3.0 | +| 2019-03 | CT#83 | CP-190113 | 0022 | | F | OpenAPI info version update | 15.3.0 | +| 2019-03 | CT#83 | CP-190213 | 0023 | 1 | F | Correction of Location header in Nnwdaf_EventsSubscription OpenAPI | 15.3.0 | +| 2019-06 | CT#84 | CP-191078 | 0024 | 1 | F | Correction of Nnwdaf_EventsSubscription OpenAPI | 15.4.0 | +| 2019-06 | CT#84 | CP-191078 | 0029 | 7 | F | Corrections on TS 29.520 | 15.4.0 | +| 2019-06 | CT#84 | CP-191078 | 0035 | 1 | F | Precedence of OpenAPI file | 15.4.0 | +| 2019-06 | CT#84 | CP-191078 | 0037 | 1 | F | Copyright Note in YAML files | 15.4.0 | +| 2019-06 | CT#84 | CP-191090 | 0025 | 1 | B | Reference update and service representation | 16.0.0 | +| 2019-06 | CT#84 | CP-191090 | 0027 | 3 | B | Support of more consumers | 16.0.0 | +| 2019-06 | CT#84 | CP-191090 | 0028 | 1 | B | Support of more analytic events | 16.0.0 | +| 2019-06 | CT#84 | CP-191225 | 0031 | 9 | B | Subscribing of service experience for the application | 16.0.0 | +| 2019-06 | CT#84 | CP-191090 | 0033 | 2 | B | Delete the subscription of service experience for the application | 16.0.0 | +| 2019-06 | CT#84 | CP-191090 | 0034 | 5 | B | Notification of service experience for the application | 16.0.0 | +| 2019-06 | CT#84 | CP-191090 | 0039 | 2 | F | Copyright Note in YAML files | 16.0.0 | +| 2019-09 | CT#85 | CP-192146 | 0041 | 2 | F | Correct cardinality in NnwdafEventsSubscription | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0042 | 4 | B | UE mobility and communication analytics | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0043 | 2 | B | Support of network performance analytics in Nnwdaf_AnalyticsInfo_Request | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0047 | 1 | B | OAM as service consumer | 16.1.0 | +| 2019-09 | CT#85 | CP-192157 | 0048 | 1 | B | Update Nnwdaf_EventSubscription service for service experience | 16.1.0 | +| 2019-09 | CT#85 | CP-192261 | 0049 | 1 | B | Enhance the Nnwdaf_AnalyticsInfo service to support service experience | 16.1.0 | +| 2019-09 | CT#85 | CP-192177 | 0050 | 2 | B | Enhance the Nnwdaf_EventsSubscription service to support QoS sustainability | 16.1.0 | +| 2019-09 | CT#85 | CP-192177 | 0051 | 2 | B | Enhance the Nnwdaf_AnalyticsInfo service to support QoS sustainability | 16.1.0 | +| 2019-09 | CT#85 | CP-192173 | 0054 | 2 | F | OpenAPI version update TS 29.520 Rel-16 | 16.1.0 | +| 2019-12 | CT#86 | CP-193198 | 0055 | 3 | B | Abnormal behaviour analytics | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0056 | 4 | B | Enhance the Nnwdaf_EventsSubscription service to support User Data Congestion | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0057 | 2 | B | Enhance the Nnwdaf_AnalyticsInfo service to support user data congestion | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0058 | 1 | B | Definination of QoS sustainability information | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0059 | 4 | B | Inclusion of QoS requirements and thresholds for QoS Sustainability | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0062 | 2 | F | Clarify references to QoS sustainability analytics | 16.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------|--------| +| 2019-12 | CT#86 | CP-193198 | 0063 | 2 | F | Clarifications on NWDAF generalities | 16.2.0 | +| 2019-12 | CT#86 | CP-193267 | 0102 | 3 | B | OpenAPI file Update for Nnwdaf_EventsSubscription API | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0103 | | B | OpenAPI file Update for Nnwdaf_AnalyticsInfo API | 16.2.0 | +| 2019-12 | CT#86 | CP-193198 | 0104 | 1 | B | Slice identification for all analytics types | 16.2.0 | +| 2019-12 | CT#86 | CP-193234 | 0106 | 2 | B | NF Load analytics generalities | 16.2.0 | +| 2019-12 | CT#86 | CP-193212 | 0107 | 1 | F | Update of API version and TS version in OpenAPI file | 16.2.0 | +| 2020-03 | CT#87e | CP-200208 | 0109 | 1 | B | Definition of QoS Requirement | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0110 | 1 | B | Description of consumer functionalities | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0111 | 1 | B | Update the types of analytics events | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0114 | | B | DNN Clarification | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0115 | 1 | F | Update Feature applicability for Rel-16 new data types | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0118 | 2 | D | Corrections in TS29.520 | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0120 | 1 | F | Clarify start time and end time | 16.3.0 | +| 2020-03 | CT#87e | CP-200182 | 0121 | 2 | F | Correct QoS sustainability | 16.3.0 | +| 2020-03 | CT#87e | CP-200232 | 0122 | 1 | F | Correct UE mobility and communication | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0123 | 1 | B | Support network performance analytics | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0124 | 1 | F | Correcting QoS sustainability information | 16.3.0 | +| 2020-03 | CT#87e | CP-200214 | 0125 | | F | OpenAPI: usage of the "tags" keyword | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0126 | 1 | F | Corrections on resource name | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0127 | 1 | F | Data used for area of interest | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0128 | 1 | F | Any UE possibility for UE mobility and UE communication | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0129 | 1 | B | Nnwdaf_EventsSubscription API, Support of Service experience | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0130 | 1 | B | Nnwdaf_EventsSubscription API, Support of Service experience | 16.3.0 | +| 2020-03 | CT#87e | CP-200236 | 0131 | 2 | B | Nnwdaf_EventsSubscription API, Support of abnormal behaviour | 16.3.0 | +| 2020-03 | CT#87e | CP-200224 | 0132 | 1 | B | Nnwdaf_AnalyticsInfo API, Support of abnormal behaviour | 16.3.0 | +| 2020-03 | CT#87e | CP-200228 | 0136 | 2 | B | Support of NF Load analytics | 16.3.0 | +| 2020-03 | CT#87e | CP-200216 | 0140 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-06 | CT#88e | CP-201234 | 0142 | 1 | F | Condition description for threshold related attributes | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0143 | 1 | F | Some corrections to Nnwdaf_AnalyticsInfo Service | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0144 | 1 | F | Clarification on applicability for network slice information | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0145 | 1 | F | Analytics result per DNN | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0146 | 3 | F | Maximum number of SUPIs | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0147 | 1 | F | Correction on FlowDescription | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0149 | 3 | F | Support of Abnormal Behaviour | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0150 | 2 | F | Confidence for User Data Congestion Information. | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0151 | 1 | F | Data types used for NWDAF services | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0153 | 2 | F | Adding maxObjectNbr attribute in related feature of NWDAF analytics service | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0154 | 1 | F | Adding UDM as consumer of services provided by NWDAF | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0155 | | F | Corrections on descriptions of NF service consumers offered by NWDAF | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0157 | 1 | D | Updates to Abbreviations | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0158 | 2 | B | Support NSI ID | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0163 | 3 | B | Support Service Experience Variance | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0165 | 1 | F | Correction to Service Description | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0166 | 1 | F | Correction to description of consumer functionalities | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0167 | 1 | F | Correction to variance of Start time in UE Communication | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0169 | 1 | B | Correct supported feature in AnalyticsData | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0170 | 1 | F | Clarify service experience data | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0171 | | F | Correct threshold | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0172 | 1 | F | Resource type in QoS requirement | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0173 | 1 | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0176 | 2 | F | Analytics result per S-NSSAI | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0177 | 1 | F | Corrections on confidence for other NWDAF events | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0179 | 1 | F | URI of the Nnwdaf services | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0180 | 1 | F | Default value for matching direction | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0181 | | F | Support of immediate reporting | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0182 | 1 | F | Optionality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0183 | 1 | F | Correction to abnormal traffic volume | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0186 | 2 | F | Corrections on ratio of UEs in NWDAF event reports | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0187 | 1 | F | Corrections to TargetUeInformation | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0188 | | F | Corrections on AbnormalBehaviour | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0189 | | F | Plural of NF load level information related attribute | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0190 | 1 | F | locInfo attribute within the UeMobility data | 16.4.0 | +| 2020-06 | CT#88e | CP-201234 | 0191 | | F | Corrections on NfLoadLevelInformation | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0192 | 1 | F | Supported headers, Resource Data type, Operation Name and yaml mapping | 16.4.0 | +| 2020-06 | CT#88e | CP-201255 | 0193 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2020-09 | CT#89e | CP-202066 | 0196 | 1 | F | Description for NWDAF services | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0197 | 1 | F | Zero confidence | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0199 | | F | Correct QoS sustainability requirement | 16.5.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------|--------| +| 2020-09 | CT#89e | CP-202066 | 0200 | | F | Validity period for analytics information | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0201 | 1 | F | Timestamp of analytics generation | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0202 | | F | Notification about subscribed event | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0204 | 1 | F | Omitted event reporting information | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0205 | | F | Optional network slice identification | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0206 | | F | Slice load level information | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0207 | 1 | F | Matching direction | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0208 | | F | Time when analytics information is needed | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0209 | 1 | F | Confidence for UE mobility | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0210 | | F | Supported feature in Nnwdaf_AnalyticsInfo API | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0211 | | F | Target UE identification | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0212 | | F | Correction on NetworkPerfType | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0214 | | F | Corrections on appIds and dnnns | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0215 | 1 | F | Corrections to networkArea with anyUE | 16.5.0 | +| 2020-09 | CT#89e | CP-202066 | 0216 | 1 | F | Corrections to abnormal behaviour for any UE | 16.5.0 | +| 2020-09 | CT#89e | CP-202054 | 0218 | | A | ResourceURI correction during subscription update | 16.5.0 | +| 2020-09 | CT#89e | CP-202084 | 0221 | 1 | F | Update of OpenAPI version and TS version in externalDocs field | 16.5.0 | +| 2020-09 | CT#89e | CP-202073 | 0198 | | F | Reference to enumeration Accuracy | 17.0.0 | +| 2020-09 | CT#89e | CP-202085 | 0220 | 1 | F | Update of OpenAPI version and TS version in externalDocs field | 17.0.0 | +| 2020-12 | CT#90e | CP-203139 | 0223 | 1 | A | Essential corrections and alignments | 17.1.0 | +| 2020-12 | CT#90e | CP-203117 | 0226 | 1 | A | Correction to notificationURI attribute | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0228 | | A | Mapping of expected analytics types and exception Ids | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0230 | 1 | A | Analytics report correction | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0232 | 1 | A | Error response for statistics request | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0234 | | A | S-NSSAI applicability | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0236 | 1 | A | Reversal of Service Experience feature for nsiLevelThrds attribute | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0238 | 1 | A | Correction to sups of Service Experience Analytics | 17.1.0 | +| 2020-12 | CT#90e | CP-203155 | 0240 | 1 | A | Updates CEF as NWDAF consumer of Nnwdaf_EventsSubscription service | 17.1.0 | +| 2020-12 | CT#90e | CP-203130 | 0242 | 1 | F | Corrections to Validity Period | 17.1.0 | +| 2020-12 | CT#90e | CP-203129 | 0244 | 1 | A | Corrections to Threshold | 17.1.0 | +| 2020-12 | CT#90e | CP-203153 | 0246 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-03 | CT#91e | CP-210191 | 0248 | 1 | F | Support of stateless NFs | 17.2.0 | +| 2021-03 | CT#91e | CP-210217 | 0250 | | A | Storage of YAML files in ETSI Forge | 17.2.0 | +| 2021-03 | CT#91e | CP-210218 | 0251 | | F | OpenAPI reference | 17.2.0 | +| 2021-03 | CT#91e | CP-210206 | 0253 | 1 | A | Correction to S-NSSAI applicability | 17.2.0 | +| 2021-03 | CT#91e | CP-210206 | 0255 | 1 | A | Adding network slice instance load level information | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0256 | | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.2.0 | +| 2021-03 | CT#91e | CP-210219 | 0257 | | F | Removal of the NnwdafFailureCode data type from the Nnwdaf_AnalyticsInfo API | 17.2.0 | +| 2021-03 | CT#91e | CP-210230 | 0258 | | F | Missing data type in the Nnwdaf_EventsSubscription specific Data Types table | 17.2.0 | +| 2021-03 | CT#91e | CP-210230 | 0259 | | F | Wrong description of the EventFilter data type in the Nnwdaf_AnalyticsInfo specific Data Types table | 17.2.0 | +| 2021-03 | CT#91e | CP-210206 | 0261 | | A | Any Slice applicability | 17.2.0 | +| 2021-03 | CT#91e | CP-210206 | 0263 | 1 | A | Partial failure during event subscription | 17.2.0 | +| 2021-03 | CT#91e | CP-210206 | 0265 | | A | Supported feature | 17.2.0 | +| 2021-03 | CT#91e | CP-210240 | 0267 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-06 | CT#92e | CP-211220 | 0269 | 3 | A | Adding missing description for partial failure operation | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0270 | 4 | B | Adding time when analytics needed and revised time to analytics subscriptions | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0271 | 2 | B | Adding NWDAF as NWDAF services consumer due to analytics aggregation | 17.3.0 | +| 2021-06 | CT#92e | CP-211234 | 0272 | 1 | F | Support of optional HTTP custom header fields | 17.3.0 | +| 2021-06 | CT#92e | CP-211206 | 0278 | 1 | A | Correction on 404 Not Found | 17.3.0 | +| 2021-06 | CT#92e | CP-211220 | 0280 | | A | Missing attributes in subscription procedure | 17.3.0 | +| 2021-06 | CT#92e | CP-211220 | 0282 | 1 | A | Correction on the value of confidence | 17.3.0 | +| 2021-06 | CT#92e | CP-211206 | 0285 | 1 | A | Correction to Load Level Information | 17.3.0 | +| 2021-06 | CT#92e | CP-211220 | 0287 | 1 | A | Correction to NSI Load Level Information | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0288 | 1 | B | Service introduction of Nnwdaf_DataManagement service | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0289 | 1 | B | Service operations for Nnwdaf_DataManagement | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0290 | 1 | B | Nnwdaf_DataManagement Service API | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0291 | 1 | B | Service introduction of Nnwdaf_ModelProvision service | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0292 | 1 | B | Service operations for Nnwdaf_ModelProvision service | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0293 | 1 | B | Nnwdaf_ModelProvision Service API | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0294 | 2 | B | Partitioning criteria for applying sampling in specific UE partitions in NWDAF event exposure | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0295 | 1 | B | Complete definition of the Nnwdaf_ModelProvision API | 17.3.0 | +| 2021-06 | CT#92e | CP-211200 | 0297 | 1 | A | Redirect responses with "application/json" media type | 17.3.0 | +| 2021-06 | CT#92e | CP-211251 | 0298 | 1 | F | analytics for a specific time | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0299 | 1 | B | Service operations of Nnwdaf_ModelProvision service | 17.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------------------|--------| +| 2021-06 | CT#92e | CP-211221 | 0300 | 1 | B | Service description of Nnwdaf_ MLModelProvision service | 17.3.0 | +| 2021-06 | CT#92e | CP-211275 | 0301 | 1 | B | Extension to User Data Congestion Analytics with GPSI | 17.3.0 | +| 2021-06 | CT#92e | CP-211221 | 0302 | 1 | F | Correction of the description of the snssai attribute | 17.3.0 | +| 2021-06 | CT#92e | CP-211265 | 0305 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2021-09 | CT#93e | CP-212203 | 0306 | 1 | B | Aggregation support in analytics requests | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0307 | 1 | B | Aggregation support in analytics subscriptions | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0310 | | F | Small corrections in NWDAF APIs | 17.4.0 | +| 2021-09 | CT#93e | CP-212232 | 0311 | 1 | B | Extensions of Slice load level related network data analytics | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0312 | | F | Extend General for OpenAPI specification | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0313 | | B | Redirection handling for Nnwdaf_ MLModelProvision Service | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0314 | 2 | B | Extension to User Data Congestion Analytics in Nnwdaf_ EventsSubscription API | 17.4.0 | +| 2021-09 | CT#93e | CP-212203 | 0315 | 1 | B | Extension to User Data Congestion Analytics in Nnwdaf_ AnalyticsInfo API | 17.4.0 | +| 2021-09 | CT#93e | CP-212202 | 0317 | | A | Removal of NSI ID from PCF as consumer of NWDAF | 17.4.0 | +| 2021-09 | CT#93e | CP-212223 | 0318 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.4.0 | +| 2021-12 | CT#94e | CP-213228 | 0322 | 3 | F | Extension to Observed Service Experience in Nnwdaf_ EventsSubscription Service API | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0323 | 3 | F | Extension to Observed Service Experience in Nnwdaf_ AnalyticsInfo Service API | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0324 | 1 | B | Addition of network analytics for the PCF | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0325 | 2 | B | Updates to User Data Congestion Extension in Nnwdaf_ EventsSubscription API | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0326 | 1 | B | Updates to User Data Congestion Extension in Nnwdaf_ AnalyticsInfo API | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0327 | 1 | B | Analytics info context transfer operation descriptions | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0328 | 2 | B | Analytics info context transfer operation data model and OpenAPI | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0329 | 1 | B | Analytics info context transfer operation overview | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0330 | 1 | B | Analytics info context transfer operation resources | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0331 | 1 | B | Analytics subscription transfer operation descriptions | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0332 | 2 | B | Analytics subscription transfer operation data model and OpenAPI | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0333 | | B | Analytics subscription transfer operation overview | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0334 | 1 | B | Analytics subscription transfer operation resources | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0335 | 1 | B | Extending analytics subscription to enable context transfer | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0336 | 1 | B | Subscription modification procedure of Nnwdaf_ MLModelProvision service | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0337 | 1 | B | Support of Nnwdaf_ MLModelInfo Service | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0338 | | B | The OpenAPI file for Nnwdaf_ MLModelProvision | 17.5.0 | +| 2021-12 | CT#94e | CP-213227 | 0339 | 1 | B | Update of procedures and data type definition for Nnwdaf_ MLModelProvision | 17.5.0 | +| 2021-12 | CT#94e | CP-213239 | 0340 | 1 | F | Aligning API URI with SBI template | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0341 | 3 | B | Support of SM congestion control experience analytics by Nnwdaf_ AnalyticsInfo service | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0342 | | B | Adding DCCF as NWDAF events subscription NF service consumer | 17.5.0 | +| 2021-12 | CT#94e | CP-213226 | 0344 | | A | Remove QoS sustainability as analytics for PCF | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0347 | 1 | B | Support of DN performance analytics | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0348 | 1 | B | Define the list of analytics subsets in the request | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0349 | 1 | B | Add load level related information for NSI_LOAD_LEVEL event | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0350 | | B | Add load level related information for LOAD_LEVEL_INFORMATION event | 17.5.0 | +| 2021-12 | CT#94e | CP-213244 | 0352 | 1 | F | Corrections to EventReportingRequirement | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0353 | 1 | B | Add consumer NF information in Subscription | 17.5.0 | +| 2021-12 | CT#94e | CP-213228 | 0354 | | B | Updates geenrak description to analytics subscription transfer operation | 17.5.0 | +| 2021-12 | CT#94e | CP-213246 | 0355 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.5.0 | +| 2022-03 | CT#95e | CP-220190 | 0357 | 1 | B | Resolve Editor's Note on Slice load level related network data analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0358 | 1 | F | Clarification about conditional descriptions for Slice load level related network data analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0359 | | F | Correction of DN performance analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0360 | | F | Update the Nnwdaf_ AnalyticsInfo Service API specific data types table | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0362 | | F | Editorial correction of offsetPeriod attribute for Nnwdaf_ EventsSubscription API | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0365 | 1 | B | NF Load analytics extensions in Nnwdaf_ EventsSubscription API | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0366 | 1 | B | NF Load analytics extensions in Nnwdaf_ AnalyticsInfo API | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0367 | 3 | B | Support Dispersion Analytics in Nnwdaf_ EventsSubscription API | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0368 | 2 | B | Support Dispersion Analytics in Nnwdaf_ AnalyticsInfo API | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0369 | 1 | B | Support Redundant Transmission Experience Analytics in Nnwdaf_ EventsSubscription API | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0370 | | B | Support Redundant Transmission Experience Analytics in Nnwdaf_ AnalyticsInfo API | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0371 | 2 | B | Support WLAN performance analytics in | 17.6.0 | + +| | | | | | | | | +|--|--|--|--|--|--|-------------------------------|--| +| | | | | | | Nnwdaf_EventsSubscription API | | +|--|--|--|--|--|--|-------------------------------|--| + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------------|--------| +| 2022-03 | CT#95e | CP-220189 | 0372 | 1 | B | Support WLAN performance analytics in Nnwdaf_AnalyticsInfo API | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0373 | | F | Corrections to DN Performance Events | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0374 | 1 | B | Update extended features description and analytics events applicability | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0375 | 1 | F | Corrections to Nnwdaf_AnalyticsInfo Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0376 | 1 | F | Clarification on GPSI for UserDataCongestionExt | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0377 | 1 | F | Features in the applicability section | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0378 | 1 | F | Update of 5.1.6.1 | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0379 | 1 | F | Adding ADRF as a consumer of Nnwdaf_DataManagement Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220176 | 0381 | 2 | A | Alignment of "Application Errors" clauses with SBI TS template | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0382 | | B | Adding DCCF as Nnwdaf_AnalyticsInfo service consumer | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0383 | 1 | B | Service Description of Nnwdaf_DataManagement Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0384 | | F | Clarification on NF consumer of Nnwdaf_ModelProvision Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0385 | | F | Corrections to Nnwdaf_ModelProvision Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0386 | 1 | B | Support reporting the analytics of the application list used by UE in the UE communication analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0387 | 1 | B | Support reporting N4 session inactivity timer in the UE communication analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0388 | 1 | B | Support list of analytics subsets for Nnwdaf_AnalyticsInfo Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220189 | 0389 | | B | Resolve the Editor's Note for partial failure events handling in ML model subscription procedure | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0390 | 2 | B | Resolve the Editor's Note for ML model filter information | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0391 | 1 | B | Add visited AOI(s) to analytics filter for UE mobility analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0392 | 2 | B | Add UPF ID to analytics filter for Service Experience analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0393 | 1 | B | Add the periodic communication indicator to UeCommunication data type | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0394 | 1 | B | Add Service Experience Type to Service Experience analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0395 | 3 | B | Add Application Server Address(es) to analytics filter for Service Experience analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220190 | 0400 | | B | Extension of UE Mobility Analytics to support LADN DNN | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0401 | 1 | F | References to apiSpecificResourceUriPart for Nnwdaf_DataManagement and Nnwdaf_ModelProvision APIs | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0402 | 1 | D | Editorial modifications | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0403 | 1 | B | Add load level related information to analytics subset | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0404 | 1 | B | Add missing attribute to SM congestion control experience analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0405 | 1 | F | Correction on freqs attribute for Nnwdaf_EventsSubscription API | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0406 | 1 | B | Add missing attributes to DN Performance analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0407 | 1 | B | Add service description and operations to DN Performance analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220173 | 0409 | 1 | A | Correction of the description of end time | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0410 | 1 | F | Incorrect response code of PUT method for Event Subscription Transfer | 17.6.0 | +| 2022-03 | CT#95e | CP-220196 | 0411 | | F | Correction to descriptions in OpenAPI file | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0412 | 1 | B | Service Operation of Nnwdaf_DataManagement_Subscribe Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0413 | 1 | B | Service Operation of Nnwdaf_DataManagement_Unsubscribe Service | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0414 | 1 | B | Nnwdaf_DataManagement Service Resources | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0415 | 1 | B | Nnwdaf_DataManagement Service Data Model | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0417 | 1 | B | Add accuracy per analytics subset for the specific events | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0418 | 1 | B | Add list of analytics subsets to the Nnwdaf_AnalyticsInfo_Request procedure | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0419 | | B | Add list of analytics subsets to the subscription procedure | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0420 | 1 | B | Add requirement for DN performance analytics | 17.6.0 | +| 2022-03 | CT#95e | CP-220192 | 0421 | 1 | B | Add the missing data structure to the specific Data Types table | 17.6.0 | +| 2022-03 | CT#95e | CP-220191 | 0422 | | B | Solve the Editor's Note for ML model filter information | 17.6.0 | +| 2022-03 | CT#95e | CP-220194 | 0423 | | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-06 | CT#96 | CP-221130 | 0426 | 1 | B | Correction of DN Performance Analytics | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0427 | 1 | B | Update Observed Service Experience Analytics | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0429 | 1 | F | Resolving ENs about references in the Transfer procedures | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0430 | 1 | B | Resolving ENs about subscriptions with data sources in ContextTransfer | 17.7.0 | +| 2022-06 | CT#96 | CP-221132 | 0431 | 1 | F | Resolving EN about the definition of previous subscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0432 | | F | Removing inapplicable feature ES3XX in Transfer operation | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0433 | | F | Removing inapplicable feature ES3XX in ML provisioning | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0434 | | F | Resolving EN about partitioning criteria | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0435 | | B | Resolving ENs about how to implement NF ID in NF consumer information | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0436 | | F | Resolving EN about CANCEL type in Transfer request | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0437 | | F | Resolving EN about redirection codes in Context Transfer | 17.7.0 | +| 2022-06 | CT#96 | CP-221132 | 0438 | 1 | B | Fixing the data type for historcial data | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0439 | 1 | B | Add clarifications for analytics subsets of some attributes | 17.7.0 | +| 2022-06 | CT#96 | CP-221132 | 0440 | 1 | B | Clarification for the presence of some attributes in the request | 17.7.0 | + +| | | | | | | | | +|---------|-------|-----------|------|---|---|----------------------------------------------------------------------------------------------------|--------| +| 2022-06 | CT#96 | CP-221131 | 0441 | 1 | F | Correct the Cardinality of some attributes | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0442 | | B | Define Error Handling and Security for Nnwdaf_DataManagement Service | 17.7.0 | +| 2022-06 | CT#96 | CP-221134 | 0443 | 2 | B | Update the Service Experience Analytics for Nnwdaf_EventsSubscription service | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0444 | 1 | F | Update the Nnwdaf_ MLModelProvision OpenAPI and related data types | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0445 | 1 | F | Correction to topAppListUI and topAppListDI attributes | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0446 | | F | replace NwdafeventsSubscription with NnwdafEventsSubscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221129 | 0447 | | F | Incorrect definition of smcceUeList in openAPI file | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0453 | | F | Nnwdaf_ EventsSubscription API: n4SessId and lowBase properties | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0454 | 1 | F | Nnwdaf_ EventsSubscription API: removal of sibling elements | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0455 | | F | Nnwdaf_ AnalyticsInfo API: removal of sibling elements | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0456 | 1 | B | Updates on Dispersion Analytics | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0457 | 3 | B | Update RAT types and Frequencies in Service Experience Analytics in Nnwdaf_ EventsSubscription API | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0458 | 1 | B | Update RAT types and Frequencies in Service Experience Analytics in Nnwdaf_ AnalyticsInfo API | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0459 | 1 | B | Updates UE location in Service Experience Analytics | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0460 | 2 | B | Resolve editor's note for Analytics Subscription Transfer | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0464 | 1 | B | Updates to SMCCE | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0465 | 1 | B | Updates to Service Experience Type | 17.7.0 | +| 2022-06 | CT#96 | CP-221130 | 0468 | | B | Supplement the missing events and remove the ENs for ML model subscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0469 | 1 | B | Remove the Editor's Note for Nnwdaf_ MLModelInfo service | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0470 | 2 | B | Define SMCCE event for Nnwdaf_ EventsSubscription service | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0471 | 3 | B | Define Nnwdaf_ DataManagement API | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0472 | 1 | F | Formatting of description fields of Nnwdaf_ MLModelProvision API | 17.7.0 | +| 2022-06 | CT#96 | CP-221131 | 0473 | 1 | F | Correction to MLEventNotif data type | 17.7.0 | +| 2022-06 | CT#96 | CP-221134 | 0474 | 1 | B | Adding NF load over AOI to analytics subset | 17.7.0 | +| 2022-06 | CT#96 | CP-221128 | 0476 | | A | Removing UDM from the list of service consumers for Analytics Subscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221128 | 0478 | | A | Removing UDM from the list of service consumers for Analytics Information | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0479 | | F | Feature handling corrections in EventsSubscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0480 | 1 | F | Feature for Analytics Subsets in EventsSubscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0481 | 1 | F | Feature for ContextTransfer in EventsSubscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0483 | 1 | B | Separate feature for Slice Load Level analytics extensions in EventsSubscription | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0484 | | F | Removing EneNA dependency from the Aggregation feature in AnalyticsInfo | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0485 | 1 | F | Feature for Analytics Subsets in AnalyticsInfo | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0486 | 1 | F | Correcting the usage of features in AnalyticsInfo | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0487 | 1 | F | Correcting the definition and usage of features in MLModelProvision | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0488 | 1 | B | Corrections for the ML model related information in Transfer and ContextTransfer | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0491 | | B | Muting notifications | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0492 | 1 | B | Service Operation of Nnwdaf_ DataManagement_ Notify | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0493 | 1 | B | Nnwdaf_ DataManagement Data Model | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0494 | 1 | B | Service Operation of Nnwdaf_ DataManagement_ Fetch | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0495 | 1 | B | Nnwdaf_ DataManagement Service Notifications | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0496 | 1 | F | Removal of repetition in HTTP error response | 17.7.0 | +| 2022-06 | CT#96 | CP-221136 | 0498 | 1 | F | Analytics subscription data model sync for events | 17.7.0 | +| 2022-06 | CT#96 | CP-221155 | 0499 | 1 | F | Nnwdaf_ EventsSubscription API: formatting of description fields | 17.7.0 | +| 2022-06 | CT#96 | CP-221154 | 0500 | | F | Nnwdaf_ AnalyticsInfo: formatting of description fields | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0501 | 1 | B | Add Notification Correlation ID to Nnwdaf_ EventsSubscription service | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0503 | 1 | F | Add the missing required fields in the OpenAPI for SMCCE | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0504 | | F | Add the missing status codes for Nnwdaf_ EventsSubscription and Nnwdaf_ MLModelProvision service | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0505 | | F | Corrections on ML model data structure and Nnwdaf_ MLModelProvision API | 17.7.0 | +| 2022-06 | CT#96 | CP-221133 | 0506 | | F | Corrections on the data type of the revised waiting time | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0507 | 1 | F | Presence condition on consumer NF information data types | 17.7.0 | +| 2022-06 | CT#96 | CP-221238 | 0509 | 2 | A | Presence condition on data types of UE related analytics | 17.7.0 | +| 2022-06 | CT#96 | CP-221237 | 0510 | 3 | F | Presence condition on Dispersion data types | 17.7.0 | +| 2022-06 | CT#96 | CP-221128 | 0512 | 1 | A | Presence condition on Network Performance and Flow Description data types | 17.7.0 | +| 2022-06 | CT#96 | CP-221239 | 0514 | 2 | A | Presence condition on NF load data types | 17.7.0 | +| 2022-06 | CT#96 | CP-221240 | 0516 | 2 | A | Presence condition on QoS Sustainability data types | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0517 | 1 | F | Presence condition on SpecificAnalyticsSubscription data type | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0518 | 1 | B | Solve the ENs for exposing the network topology to the untrusted | 17.7.0 | + +| | | | | | | | | +|--|--|--|--|--|--|----|--| +| | | | | | | AF | | +|--|--|--|--|--|--|----|--| + +| | | | | | | | | +|---------|--------|-----------|------|---|---|--------------------------------------------------------------------------------------|--------| +| 2022-06 | CT#96 | CP-221135 | 0519 | 1 | B | Update the analytics subscription transfer procedure | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0520 | 1 | B | Update the ML model related information | 17.7.0 | +| 2022-06 | CT#96 | CP-221134 | 0521 | | F | Update the OpenAPI of DN performance and User data congestion | 17.7.0 | +| 2022-06 | CT#96 | CP-221134 | 0522 | | B | Update the UPF information for Service Experience and DN performance | 17.7.0 | +| 2022-06 | CT#96 | CP-221255 | 0523 | 1 | F | Corrections related to confidence | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0524 | 1 | F | Remove inapplicable event for EXCEED_LOAD_LEVEL_THR_IND | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0525 | 1 | F | Correct common attributes in analytics result for subscription and analytics request | 17.7.0 | +| 2022-06 | CT#96 | CP-221135 | 0526 | 1 | B | Support of Time Window in Nnwdaf_DataManagement_Subscribe service operation | 17.7.0 | +| 2022-06 | CT#96 | CP-221128 | 0528 | 1 | A | Correction to Threshold value in QosSustainabilityInfo | 17.7.0 | +| 2022-06 | CT#96 | CP-221128 | 0530 | | A | Correction to time period in CongestionInfo | 17.7.0 | +| 2022-06 | CT#96 | CP-221119 | 0536 | 1 | A | Correction to the re-used data types for the re-using Nnwdaf_AnalyticsInfo API | 17.7.0 | +| 2022-06 | CT#96 | CP-221155 | 0537 | 1 | F | Update the apiVersion placeholder 29.520 Rel-17 | 17.7.0 | +| 2022-06 | CT#96 | CP-221151 | 0538 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-09 | CT#97e | CP-222103 | 0463 | 4 | F | Updates on analytics target period | 17.8.0 | +| 2022-09 | CT#97e | CP-222103 | 0541 | 1 | F | ML Model Application Error code addition | 17.8.0 | +| 2022-09 | CT#97e | CP-222103 | 0542 | 2 | F | Correction of UPF information for Service Experience and DN performance | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0543 | 1 | B | Update Dispersion Analytics for missing conditional descriptions | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0544 | | F | Update re-used data type for Nnwdaf_AnalyticsInfo Service API | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0545 | | F | Update re-used data types for Nnwdaf_EventsSubscription Service API | 17.8.0 | +| 2022-09 | CT#97e | CP-222104 | 0546 | 1 | F | Update inputs of Nnwdaf_DataManagement service | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0547 | 1 | F | Removal of repetition in HTTP error response | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0548 | | F | Remove EN about further information in previous subscription information | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0549 | | F | Specifying the applicability of event subscription attributes to NSI load analytics | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0551 | | F | Corrections in the NumberAverage data type | 17.8.0 | +| 2022-09 | CT#97e | CP-222104 | 0552 | 1 | F | Aligning the NWDAF hosting DCCF with the DCCF - service descriptions | 17.8.0 | +| 2022-09 | CT#97e | CP-222104 | 0553 | 1 | F | Aligning the NWDAF hosting DCCF with the DCCF - resources and errors | 17.8.0 | +| 2022-09 | CT#97e | CP-222104 | 0555 | 1 | F | Aligning the NWDAF hosting DCCF with the DCCF - OpenAPI | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0556 | | F | Nnwdaf_EventsSubscription API: required n4SessId property | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0557 | | F | Correction of the name of appServerAddrs attribute | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0558 | | F | Incorrect data type name | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0559 | | F | missing presence condition for some conditional attributes | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0560 | | F | Clarification for SM_CONGESTION | 17.8.0 | +| 2022-09 | CT#97e | CP-222103 | 0561 | 1 | F | Clarification on notificationURI transferred by source NWDAF | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0562 | | F | Incorrect attribute name in AnalyticsContextIdentifier data type | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0563 | | F | Corrections in the error handling of NWDAF Analytics | 17.8.0 | +| 2022-09 | CT#97e | CP-222103 | 0564 | 1 | F | Update of Scope and Overview and Service Architecture | 17.8.0 | +| 2022-09 | CT#97e | CP-222103 | 0565 | 1 | F | Applicability corrections | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0567 | 1 | F | Correct the errors of the cardinality and data type in the data structures | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0568 | 1 | F | Remove the Editor's Note for analytics subset | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0569 | 1 | F | Remove the Editor's Note for ML model | 17.8.0 | +| 2022-09 | CT#97e | CP-222104 | 0571 | 1 | F | Update Nnwdaf_DataManagement_Fetch service operation | 17.8.0 | +| 2022-09 | CT#97e | CP-222103 | 0572 | 1 | F | Update Resource usage threshold crossings time period for NSI load | 17.8.0 | +| 2022-09 | CT#97e | CP-222210 | 0573 | 1 | F | Update the redundant transmission analytics | 17.8.0 | +| 2022-09 | CT#97e | CP-222101 | 0574 | | F | Updates to any UE for Dispersion | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0575 | 1 | F | Corrections to EventSubscription | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0577 | | F | Corrections on percentage value range | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0578 | | F | Correction to ConsumerNfInformation | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0579 | | F | Corrections to EventFilter | 17.8.0 | +| 2022-09 | CT#97e | CP-222102 | 0580 | 1 | F | Miscellaneous corrections on NWDAF services | 17.8.0 | +| 2022-09 | CT#97e | CP-222121 | 0581 | | F | Update of info and externalDocs fields | 17.8.0 | +| 2022-12 | CT#98e | CP-223173 | 0582 | 1 | F | Missing data reports for processed data notifications | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0583 | | F | Correcting the role of analytics subscription information for data collection | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0584 | 1 | F | User consent corrections for NWDAF data management | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0587 | 1 | F | Analytics output restrictions | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0591 | 1 | F | Corrections for time stamp in NWDAF | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0594 | | F | Corrections for Nnwdaf_AnalyticsInfo_Request procedure | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0595 | | F | Corrections related to analytics subscription transfer | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0596 | 1 | F | Corrections to NnwdafDataManagementNotif | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0597 | | F | Correction to visitedAreas attribute | 17.9.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------|--------| +| 2022-12 | CT#98e | CP-223172 | 0598 | | F | Incorrect attribute name referenced in DnPerformanceReq data type | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0599 | | F | Incorrect attribute name referenced in NwdaifMLModelProvSubsc data type | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0600 | | F | Aligning the notifications of Nnwdaif_DataManagement API with service description | 17.9.0 | +| 2022-12 | CT#98e | CP-223172 | 0602 | | F | features in Nnwdaif_MLModelProvision Service API | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0603 | 2 | F | Correction of data type of terminationReq | 17.9.0 | +| 2022-12 | CT#98e | CP-223224 | 0604 | 1 | F | adding resourceUri for analytics subscription transfer notification | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0608 | 2 | F | Correction to Event Notification in Nnwdaif_MLModelProvision API | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0610 | 1 | F | Corrections to NF Service Consumers | 17.9.0 | +| 2022-12 | CT#98e | CP-223174 | 0613 | 1 | F | Corrections to Slice Load level Analytics | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0616 | 1 | F | Corrections for DispersionCollection data type and MLEventSubscription data type | 17.9.0 | +| 2022-12 | CT#98e | CP-223173 | 0619 | 1 | F | Miscellaneous corrections | 17.9.0 | +| 2022-12 | CT#98e | CP-223188 | 0621 | | F | Update of info and externalDocs fields | 17.9.0 | +| 2022-12 | CT#98e | CP-223176 | 0585 | 1 | B | User consent enhancements for NWDAF analytics subscriptions | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0586 | 1 | B | User consent enhancements for NWDAF analytics info | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0588 | 1 | B | Analytics subscription termination request | 18.0.0 | +| 2022-12 | CT#98e | CP-223191 | 0590 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0605 | 1 | B | Correction of data type of procInstr | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0606 | 1 | F | Corrections in ServiceExperienceInfo data type | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0611 | 1 | F | Corrections to service operation procedures in Nnwdaif_EventsSubscription API | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0612 | 1 | F | Corrections to service operation procedures in Nnwdaif_AnalyticsInfo API | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0618 | 1 | F | Correct the presence and add the missing feature of some attributes | 18.0.0 | +| 2022-12 | CT#98e | CP-223176 | 0620 | | B | User consent enhancements for NWDAF data management | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0622 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230291 | 0624 | 2 | B | PFD Determination Analytics for Nnwdaif_AnalyticsInfo API | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0625 | | F | Update abbreviations clause and table of NWDAF services | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0632 | 1 | B | OAuth2 scopes in Nnwdaif_AnalyticsInfo API | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0633 | 1 | B | OAuth2 scopes in Nnwdaif_EventsSubscription API | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0635 | 1 | F | Corrections on offsetPeriod | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0637 | 1 | F | Corrections on list of analytics subsets in Network Performance Analytics | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0638 | 1 | B | Updates on analytics target period subset in Network Performance Analytics | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0639 | 1 | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230145 | 0641 | | A | Correction to DnPerformanceReq for Nnwdaif_AnalyticsInfo API | 18.1.0 | +| 2023-03 | CT#99 | CP-230145 | 0643 | 1 | A | Corrections related to ServiceExperienceExt | 18.1.0 | +| 2023-03 | CT#99 | CP-230145 | 0645 | | A | misplaced description and useless NOTE | 18.1.0 | +| 2023-03 | CT#99 | CP-230145 | 0647 | 2 | A | definition of the value for boolean data type | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0648 | 1 | F | Handling of fetch Instruction | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0649 | | B | Partial failure during analytics subscription transfer | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0650 | | F | Update of 5.1.6.1 and 5.2.6.1 | 18.1.0 | +| 2023-03 | CT#99 | CP-230167 | 0651 | 1 | F | Fix the description formatting issue | 18.1.0 | +| 2023-03 | CT#99 | CP-230129 | 0655 | 1 | A | Invalid JSON value | 18.1.0 | +| 2023-03 | CT#99 | CP-230145 | 0657 | 1 | A | Corrections for historical analytics exposure procedures | 18.1.0 | +| 2023-03 | CT#99 | CP-230147 | 0659 | 1 | B | QoS sustainability analytics with fine granularity | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0660 | 1 | F | Clarification for Analytics Specification in Nnwdaif_DataManagement Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0661 | 1 | F | Corrections for descriptions of boolean data types | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0662 | 1 | B | Enhancement of network performance for AnalyticsInfo Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0663 | 1 | F | Corrections for MLModelProvision | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0664 | 1 | B | Enhancement of UE communication for AnalyticsInfo Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0665 | 1 | B | Enhancement of UE mobility for AnalyticsInfo Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0666 | 1 | B | Enhancement of user data congestion for AnalyticsInfo Service | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0667 | | B | Support of multiple notification endpoints | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0668 | | B | Support of ordering criterion for network performance | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0669 | | B | Support of ordering criterion for UE communication | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0670 | 1 | B | Support of ordering criterion for UE mobility | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0671 | 1 | B | Support of ordering criterion for user data congestion | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0672 | | B | Support of the acceptable deviation from the threshold for QoS Sustainability | 18.1.0 | +| 2023-03 | CT#99 | CP-230148 | 0673 | | B | Support of the amount information in the notification for Abnormal behaviour | 18.1.0 | +| 2023-03 | CT#99 | CP-230149 | 0674 | 1 | B | Update the enumeration value of preferred level of accuracy | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0687 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231127 | 0626 | 3 | B | Updates for DN performance of Group UEs in Nnwdaif_EventsSubscription API | 18.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------------------------------------------|--------| +| 2023-06 | CT#100 | CP-231127 | 0627 | 2 | B | Updates for DN performance of Group UEs in Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0628 | 2 | B | Updates to UE Mobility support FL in Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0629 | 2 | B | Update for UE Mobility support FL in Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0675 | 2 | B | Support NWDAF assisted URSPs in Service Experience in Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0676 | 2 | B | Support NWDAF assisted URSPs in Service Experience in Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0677 | 1 | B | Support use case context in Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0678 | 2 | B | Support use case context in Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0679 | 2 | B | Support use case context in Nnwdaf_ModelProvision API | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0680 | 3 | B | Support PFD Determination Analytics in Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0682 | 2 | B | Update to Nnwdaf_ModelProvision Service API for Federated Learning | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0683 | 4 | B | Update to Nnwdaf_ModelProvision Service API for Model Sharing | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0688 | 1 | B | Event muting enhancements for Analytics Subscriptions | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0689 | 1 | B | Event muting enhancements for ML Model Provisioning | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0690 | 1 | B | Implementing immediate reports for NWDAF Data Management subscriptions | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0691 | 3 | F | Adding missing presence conditions | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0692 | | B | Update PFD Determination Analytics for Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231314 | 0693 | 4 | B | PDU Session traffic analytics for Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231145 | 0694 | 2 | B | PDU Session traffic analytics for Nnwdaf_AnalyticsInfo Service API | 18.2.0 | +| 2023-06 | CT#100 | CP-231338 | 0695 | 4 | B | Support Nnwdaf_ModelTraining Service | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0696 | 1 | B | End-to-end data volume transfer time analytics for Nnwdaf_EventsSubscription Service | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0697 | 1 | B | End-to-end data volume transfer time analytics for Nnwdaf_AnalyticsInfo Service | 18.2.0 | +| 2023-06 | CT#100 | CP-231316 | 0698 | 2 | B | End-to-end data volume transfer time analytics for Nnwdaf_ModelProvision Service | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0699 | 3 | B | Update to support extended parameters for ML model provisioning | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0700 | 1 | F | Addition of network analytics for the SMF | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0701 | 1 | F | Addition of network analytics for the PCF | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0702 | | F | Correction of the DnPerfOrderingCriterion enumeration | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0703 | 1 | B | Support of preferred granularity of location for EventsSubscription service | 18.2.0 | +| 2023-06 | CT#100 | CP-231137 | 0704 | 1 | B | Support of preferred granularity of location for AnalyticsInfo service | 18.2.0 | +| 2023-06 | CT#100 | CP-231124 | 0707 | 1 | B | Enhancements on UE Mobility analytics | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0708 | 1 | B | Enhancements to WLAN performance analytics for Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0709 | 1 | B | Enhancements to WLAN performance analytics for Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0710 | 1 | B | Enhancements to Network performance in Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231127 | 0711 | 1 | B | Enhancements to Network performance in Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0712 | 1 | B | Adding Storage Handling Information in NWDAF Data Management subscriptions | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0713 | 1 | B | Sending NWDAF Deletion Alerts | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0714 | 1 | B | Event muting enhancements for NWDAF Data Management subscriptions | 18.2.0 | +| 2023-06 | CT#100 | CP-231157 | 0715 | 1 | B | Usage of the upflnfo attribute | 18.2.0 | +| 2023-06 | CT#100 | CP-231157 | 0716 | 1 | B | Adding support of UPF events by the NWDAF | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0717 | 1 | B | Support of analytics subset and accuracy per analytics subset for UE mobility for Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231303 | 0718 | 2 | B | End-to-end data volume transfer time analytics for Nnwdaf_EventsSubscription Service API | 18.2.0 | +| 2023-06 | CT#100 | CP-231128 | 0719 | 1 | B | End-to-end data volume transfer time analytics for Nnwdaf_AnalyticsInfo Service API | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0720 | 1 | B | Update to Nnwdaf_ModelProvision API for Supporting ML Model Retrieval with ADRF | 18.2.0 | +| 2023-06 | CT#100 | CP-231159 | 0722 | 1 | A | Corrections on the validity period in the analytics | 18.2.0 | +| 2023-06 | CT#100 | CP-231125 | 0723 | 1 | B | Enhancement of DN Performance Analytics | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0724 | 1 | B | Support of analytics accuracy information for Nnwdaf_AnalyticsInfo API | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0725 | 1 | B | Support of analytics accuracy information for Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231126 | 0726 | 1 | B | Support of analytics subset and accuracy per analytics subset for UE mobility for Nnwdaf_EventsSubscription API | 18.2.0 | +| 2023-06 | CT#100 | CP-231138 | 0727 | 1 | F | Removal of the redundant descriptions for ML model service | 18.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------------------------|--------| +| 2023-06 | CT#100 | CP-231125 | 0728 | 1 | B | Updates for UE mobility analytics using fine granularity | 18.2.0 | +| 2023-06 | CT#100 | CP-231138 | 0730 | 1 | F | misplaced attributes | 18.2.0 | +| 2023-06 | CT#100 | CP-231138 | 0731 | 1 | F | Correction to EnAbnormalBehaviour feature | 18.2.0 | +| 2023-06 | CT#100 | CP-231138 | 0733 | 1 | F | Missing attributes in procedure description for NsiLoadExt feature | 18.2.0 | +| 2023-06 | CT#100 | CP-231159 | 0735 | 1 | A | Correction to UeCommunicationExt feature | 18.2.0 | +| 2023-06 | CT#100 | CP-231132 | 0736 | 1 | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0737 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-09 | CT#101 | CP-232082 | 0738 | 1 | B | Immediate reporting in the MLModelTraining API | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0739 | 1 | B | Applicabilities and restrictions in the MLModelProvision and MLModelTraining APIs | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0740 | 1 | F | Redundancies in the MLModelTraining service | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0741 | | F | Procedure descriptions corrections | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0742 | 1 | B | Location Accuracy Analytics for subscriptions | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0743 | 1 | B | Location Accuracy Analytics for requests | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0746 | 1 | B | Movement Behaviour analytics for Nnwdaf_EventsSubscription API | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0747 | 1 | B | Movement Behaviour analytics for Nnwdaf_AnalyticsInfo Service API | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0749 | | B | Update UE Mobility analytics | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0750 | 2 | B | Update End-to-end data volume transfer time analytics | 18.3.0 | +| 2023-09 | CT#101 | CP-232255 | 0751 | 2 | B | Update to Nnwdaf_ MLModelTraining Service API | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0752 | 1 | B | Update for adding NEF as Consumer of Multiple Analytics IDs | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0753 | 1 | D | Corrections to Nnwdaf_ MLModelProvision Service API | 18.3.0 | +| 2023-09 | CT#101 | CP-232097 | 0754 | 1 | F | Corrections to Nnwdaf_ EventsSubscription Service API | 18.3.0 | +| 2023-09 | CT#101 | CP-232097 | 0755 | 1 | F | Corrections to Nnwdaf_ AnalyticsInfo Service API | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0756 | 1 | B | Resolve the Editor's Note for the analytics subset of E2E data volume transfer time | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0757 | 1 | B | Support of reporting the E2E data volume transfer time and the corresponding volume | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0758 | 1 | B | Enhancement of Redundant Transmission Experience analytics for NWDAF-assisted URSP | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0759 | 1 | B | Enhancements of the QoS sustainability analytics request | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0760 | 1 | B | Enhancements of the QoS sustainability subscription | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0761 | 1 | B | Miscellaneous corrections for analytics | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0762 | 1 | B | Support for stopping and resuming the consumption of the analytics | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0763 | 1 | B | Support of spatial granularity size and temporal granularity size of the analytics request | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0764 | 1 | B | Support of spatial granularity size and temporal granularity size of the analytics subscription | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0765 | 1 | B | Support of the analytics subsets of PDU session traffic | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0766 | 1 | B | New ML Model Provisioning parameter | 18.3.0 | +| 2023-09 | CT#101 | CP-232097 | 0767 | | F | Merging two NetworkPerformanceExt_eNA features | 18.3.0 | +| 2023-09 | CT#101 | CP-232097 | 0768 | | F | misalignment of transEvents attribute | 18.3.0 | +| 2023-09 | CT#101 | CP-232087 | 0769 | 1 | F | Editors Note removal for E2E Data Volume Transfer Time analytics | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0770 | 1 | B | Corrections to PDU Session Traffic Analytics | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0771 | 1 | B | Updates to Analytics Accuracy Monitoring in Nnwdaf_ EventsSubscription API | 18.3.0 | +| 2023-09 | CT#101 | CP-232081 | 0772 | | B | Updates to Analytics Accuracy Monitoring in Nnwdaf_ AnalyticsInfo API | 18.3.0 | +| 2023-09 | CT#101 | CP-232082 | 0773 | 1 | B | Updates ML Model Provisioning supporting ML model accuracy monitoring | 18.3.0 | +| 2023-09 | CT#101 | CP-232085 | 0775 | | F | Update of info and externalDocs fields | 18.3.0 | +| 2023-09 | CT#101 | CP-232097 | 0777 | | B | Support of providing the number of impacted UE for Abnormal Behaviour analytics | 18.3.0 | +| 2023-12 | CT#102 | CP-233235 | 0778 | 1 | F | Corrections on End-to-end data volume transfer time analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0779 | 1 | B | Resolve the Editor's Note of UE mobility analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0780 | 1 | B | Support of End-to-end data volume transfer time for list of UEs | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0781 | 1 | B | Clarifications for UE Location order indicator in UE mobility analytics request | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0782 | 1 | F | Corrections on ML model provisioning | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0783 | 2 | B | Define Nnwdaf_ MLModelMonitor API | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0784 | 1 | B | Define the linear distance threshold for the UE mobility analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0785 | 2 | B | Enhancements on the inference input data and training input data | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0786 | 1 | B | Support list of Access Types in the Service Experience analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0787 | 1 | B | Support the consumer to provide the inference data stored in ADRF for model training | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0788 | 1 | B | Support the consumer to provide the time when the ML model is needed | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0789 | 1 | B | Relative Proximity analytics for Nnwdaf_ EventsSubscription API | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0790 | | B | Relative Proximity analytics for Nnwdaf_ AnalyticsInfo API | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0791 | | B | Adding confidence attributes to PFD Determination Analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0792 | | B | Update conditional description to locGranularity attribute. | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0793 | | B | Update direction data type | 18.4.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-------------------------------------------------------------------------------|--------| +| 2023-12 | CT#102 | CP-233224 | 0794 | | B | Update the description of accPerSubset attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233258 | 0796 | | A | Correcting a contradiction in the meaning of expiry | 18.4.0 | +| 2023-12 | CT#102 | CP-233224 | 0797 | 1 | B | Analytics feedback information in Subscriptions | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0798 | | F | add ENAExt feature for Nnwdaf_AnalyticsInfo Service | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0801 | 1 | B | Pending Notification in Nnwdaf_DataManagement API | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0802 | 1 | B | Updates to MLEventNotif in Nnwdaf_MLModelProvision API | 18.4.0 | +| 2023-12 | CT#102 | CP-233235 | 0803 | 1 | B | Adding confidence attribute to E2E data volume transfer time analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0805 | 1 | B | Applicability of UNAVAILABLE_DATA failure code | 18.4.0 | +| 2023-12 | CT#102 | CP-233258 | 0807 | | A | Corrections on attribute names | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0808 | 1 | F | Corrections for UE mobility analytics | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0809 | 1 | B | Define service descriptions of Nnwdaf_MLModelMonitor API | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0810 | | B | Define OpenAPI of Nnwdaf_MLModelMonitor API | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0811 | | B | Define Nnwdaf_RoamingData API | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0812 | 1 | B | Define service descriptions of Nnwdaf_RoamingData API | 18.4.0 | +| 2023-12 | CT#102 | CP-233136 | 0813 | 1 | B | Define OpenAPI of Nnwdaf_RoamingData API | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0814 | | F | Corrections on the presence and description of dnais attribute | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0815 | 1 | B | Roaming Analytics service definition | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0816 | 1 | B | Roaming Analytics service data model | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0817 | 1 | B | Roaming Analytics service OpenAPI | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0818 | 1 | B | Analytics subscription extensions to support analytics for roaming UEs | 18.4.0 | +| 2023-12 | CT#102 | CP-233225 | 0819 | | B | Analytics info extensions to support analytics for roaming UEs | 18.4.0 | +| 2023-12 | CT#102 | CP-233227 | 0820 | 1 | F | Applicability of muting exception instructions | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0821 | 1 | F | Wrong feature and service operation names | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0822 | | F | Data fetching correction | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0824 | 1 | F | Corrections to boolean type definitions | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0825 | 1 | B | Updates to error handling | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0826 | 1 | B | Updates for the Support of Nnwdaf_MLModelTraining_Subscribe Service Operation | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0827 | 1 | F | Update to the NnwdafMLModelTrainNotif Data Type | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0828 | | B | Updates for Application Error Handling | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0829 | 1 | F | Updates to the Data Model for Nnwdaf_EventsSubscription Service API | 18.4.0 | +| 2023-12 | CT#102 | CP-233226 | 0830 | | F | Updates to Nnwdaf_AnalyticsInfo Service API | 18.4.0 | +| 2023-12 | CT#102 | CP-233246 | 0831 | | F | Updates to NnwdafEventsSubscriptionNotification Data Type | 18.4.0 | +| 2023-12 | CT#102 | CP-233229 | 0832 | 1 | F | IETF RFC 7540, RFC 7807 obsoleted by RFC 9113 and RFC 9457 respectively | 18.4.0 | +| 2023-12 | CT#102 | CP-233237 | 0833 | | F | Update of info and externalDocs fields | 18.4.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29521/raw.md b/marked/Rel-18/29_series/29521/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..e97aa059b8f71d60caf775bab8df1ec04e047348 --- /dev/null +++ b/marked/Rel-18/29_series/29521/raw.md @@ -0,0 +1,4222 @@ + + +# 3GPP TS 29.521 V18.3.0 (2023-12) --- + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Binding Support Management 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 stylized font with a red signal wave icon below the 'P', and the text 'A GLOBAL INITIATIVE' in smaller letters below the logo. + +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 ..... | 6 | +| 1 Scope..... | 7 | +| 2 References..... | 7 | +| 3 Definitions and abbreviations ..... | 8 | +| 3.1 Definitions..... | 8 | +| 3.2 Abbreviations ..... | 8 | +| 4 Binding Support Management Service ..... | 8 | +| 4.1 Service Description ..... | 8 | +| 4.1.1 Overview ..... | 8 | +| 4.1.2 Service Architecture ..... | 9 | +| 4.1.3 Network Functions ..... | 10 | +| 4.1.3.1 Binding Support Function (BSF)..... | 10 | +| 4.1.3.2 NF Service Consumers ..... | 10 | +| 4.2 Service Operations ..... | 12 | +| 4.2.1 Introduction ..... | 12 | +| 4.2.2 Nbsf_Management_Register Service Operation ..... | 12 | +| 4.2.2.1 General..... | 12 | +| 4.2.2.2 Register a new PCF for a PDU Session binding information..... | 13 | +| 4.2.2.3 Register a new PCF for a UE binding information..... | 15 | +| 4.2.2.4 Register a new PCF for an MBS Session binding information ..... | 16 | +| 4.2.3 Nbsf_Management_Deregister Service Operation..... | 17 | +| 4.2.3.1 General..... | 17 | +| 4.2.3.2 Deregister an individual PCF for a PDU Session binding information..... | 18 | +| 4.2.3.3 Deregister an individual PCF for a UE binding information..... | 18 | +| 4.2.3.4 Deregister an individual PCF for an MBS Session binding information ..... | 19 | +| 4.2.4 Nbsf_Management_Discovery Service Operation..... | 19 | +| 4.2.4.1 General..... | 19 | +| 4.2.4.2 Retrieve the PCF binding information for a PDU session..... | 20 | +| 4.2.4.3 Retrieve the PCF binding information for a UE ..... | 21 | +| 4.2.4.4 Retrieve the PCF binding information for an MBS Session..... | 21 | +| 4.2.5 Nbsf_Management_Update Service Operation..... | 22 | +| 4.2.5.1 General..... | 22 | +| 4.2.5.2 Update an existing PCF for a PDU Session binding information..... | 23 | +| 4.2.5.3 Update an existing PCF for a UE binding information ..... | 24 | +| 4.2.5.4 Update an existing PCF for an MBS Session binding information ..... | 25 | +| 4.2.6 Nbsf_Management_Subscribe Service Operation..... | 26 | +| 4.2.6.1 General..... | 26 | +| 4.2.6.2 Creating a new subscription..... | 26 | +| 4.2.6.3 Modifying an existing subscription ..... | 27 | +| 4.2.7 Nbsf_Management_Unsubscribe Service Operation..... | 28 | +| 4.2.7.1 General..... | 28 | +| 4.2.7.2 Unsubscription from event notifications..... | 28 | +| 4.2.8 Nbsf_Management_Notify Service Operation ..... | 29 | +| 4.2.8.1 General..... | 29 | +| 4.2.8.2 Notification about subscribed events ..... | 29 | +| 5 Nbsf_Management Service API..... | 30 | +| 5.1 Introduction ..... | 30 | +| 5.2 Usage of HTTP..... | 31 | +| 5.2.1 General ..... | 31 | +| 5.2.2 HTTP standard headers ..... | 31 | +| 5.2.2.1 General..... | 31 | +| 5.2.2.2 Content type..... | 31 | +| 5.2.3 HTTP custom headers ..... | 31 | +| 5.2.3.1 General..... | 31 | + +| | | | +|------------|----------------------------------------------------------|----| +| 5.3 | Resources ..... | 31 | +| 5.3.1 | Resource Structure..... | 31 | +| 5.3.2 | Resource: PCF for a PDU Session Bindings..... | 33 | +| 5.3.2.1 | Description..... | 33 | +| 5.3.2.2 | Resource definition..... | 33 | +| 5.3.2.3 | Resource Standard Methods ..... | 34 | +| 5.3.2.3.1 | POST ..... | 34 | +| 5.3.2.3.2 | GET ..... | 34 | +| 5.3.3 | Resource: Individual PCF for a PDU Session Binding ..... | 36 | +| 5.3.3.1 | Description..... | 36 | +| 5.3.3.2 | Resource definition..... | 36 | +| 5.3.3.3 | Resource Standard Methods ..... | 36 | +| 5.3.3.3.1 | DELETE..... | 36 | +| 5.3.3.3.2 | PATCH..... | 37 | +| 5.3.4 | Resource: Binding Subscriptions ..... | 38 | +| 5.3.4.1 | Description..... | 38 | +| 5.3.4.2 | Resource definition..... | 39 | +| 5.3.4.3 | Resource Standard Methods ..... | 39 | +| 5.3.4.3.1 | POST ..... | 39 | +| 5.3.4.4 | Resource Custom Operations..... | 39 | +| 5.3.5 | Resource: Individual Binding Subscription..... | 39 | +| 5.3.5.1 | Description..... | 39 | +| 5.3.5.2 | Resource definition..... | 40 | +| 5.3.5.3 | Resource Standard Methods ..... | 40 | +| 5.3.5.3.1 | PUT ..... | 40 | +| 5.3.5.3.2 | DELETE..... | 41 | +| 5.3.5.4 | Resource Custom Operations..... | 42 | +| 5.3.6 | Void ..... | 43 | +| 5.3.7 | Resource: PCF for a UE Bindings..... | 43 | +| 5.3.7.1 | Description..... | 43 | +| 5.3.7.2 | Resource definition..... | 43 | +| 5.3.7.3 | Resource Standard Methods ..... | 43 | +| 5.3.7.3.1 | POST ..... | 43 | +| 5.3.7.3.2 | GET ..... | 44 | +| 5.3.8 | Resource: Individual PCF for a UE Binding ..... | 44 | +| 5.3.8.1 | Description..... | 44 | +| 5.3.8.2 | Resource definition..... | 44 | +| 5.3.8.3 | Resource Standard Methods ..... | 45 | +| 5.3.8.3.1 | DELETE..... | 45 | +| 5.3.8.3.2 | PATCH..... | 45 | +| 5.3.9 | Resource: PCF for an MBS Session Bindings ..... | 47 | +| 5.3.9.1 | Description..... | 47 | +| 5.3.9.2 | Resource definition..... | 47 | +| 5.3.9.3 | Resource Standard Methods ..... | 47 | +| 5.3.9.3.1 | POST ..... | 47 | +| 5.3.9.3.2 | GET ..... | 48 | +| 5.3.9.4 | Resource Custom Operations..... | 48 | +| 5.3.10 | Resource: Individual PCF for an MBS Session Binding..... | 48 | +| 5.3.10.1 | Description..... | 48 | +| 5.3.10.2 | Resource definition..... | 49 | +| 5.3.10.3 | Resource Standard Methods ..... | 49 | +| 5.3.10.3.1 | PATCH..... | 49 | +| 5.3.10.3.2 | DELETE..... | 50 | +| 5.3.10.4 | Resource Custom Operations..... | 51 | +| 5.4 | Custom Operations without associated resources ..... | 52 | +| 5.5 | Notifications..... | 52 | +| 5.5.1 | General ..... | 52 | +| 5.5.2 | BSF Notification..... | 52 | +| 5.5.2.1 | Description..... | 52 | +| 5.5.2.2 | Target URI..... | 52 | +| 5.5.2.3 | Standard Methods ..... | 52 | +| 5.5.2.3.1 | POST ..... | 52 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------------------------|-----------| +| 5.6 | Data Model..... | 53 | +| 5.6.1 | General ..... | 53 | +| 5.6.2 | Structured data types ..... | 55 | +| 5.6.2.1 | Introduction..... | 55 | +| 5.6.2.2 | Type PcfBinding..... | 56 | +| 5.6.2.3 | Type PcfBindingPatch ..... | 58 | +| 5.6.2.4 | Type ParameterCombination ..... | 58 | +| 5.6.2.5 | Type ExtProblemDetails..... | 59 | +| 5.6.2.6 | Type BindingResp ..... | 59 | +| 5.6.2.7 | Type BsfSubscription ..... | 59 | +| 5.6.2.8 | Type BsfNotification ..... | 60 | +| 5.6.2.9 | Type BsfEventNotification ..... | 60 | +| 5.6.2.10 | Type PcfForUeBinding..... | 61 | +| 5.6.2.11 | Type PcfForUeBindingPatch ..... | 61 | +| 5.6.2.12 | Type SnssaiDnnPair..... | 61 | +| 5.6.2.13 | Type PcfForUeInfo ..... | 62 | +| 5.6.2.14 | Type PcfForPduSessionInfo ..... | 62 | +| 5.6.2.15 | Type PcfMbsBinding..... | 63 | +| 5.6.2.16 | Type PcfMbsBindingPatch ..... | 64 | +| 5.6.2.17 | Type MbsExtProblemDetails..... | 64 | +| 5.6.2.18 | Type MbsBindingResp ..... | 64 | +| 5.6.3 | Simple data types and enumerations ..... | 64 | +| 5.6.3.1 | Introduction..... | 64 | +| 5.6.3.2 | Simple data types..... | 64 | +| 5.6.3.3 | Enumeration: BindingLevel..... | 65 | +| 5.6.3.4 | Void ..... | 65 | +| 5.6.3.5 | Enumeration: BsfEvent..... | 65 | +| 5.6.4 | Data types describing alternative data types or combinations of data types ..... | 65 | +| 5.6.4.1 | Type: BsfSubscriptionResp ..... | 65 | +| 5.7 | Error handling ..... | 65 | +| 5.7.1 | General ..... | 65 | +| 5.7.2 | Protocol Errors..... | 66 | +| 5.7.3 | Application Errors ..... | 66 | +| 5.8 | Feature negotiation..... | 66 | +| 5.9 | Security..... | 67 | +| Annex A (normative): | OpenAPI specification ..... | 68 | +| A.1 | General..... | 68 | +| A.2 | Nbsf_Management API..... | 68 | +| Annex B (informative): | Deployment option to support BSF and DRA coexistence due to network migration ..... | 86 | +| Annex C (informative): | Change history..... | 87 | + +# --- 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 Binding Support Management 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 Binding Support Management Service is 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 [5]. + +The Technical Realization of the Service Based Architecture and the Principles and Guidelines for Services Definition are specified in 3GPP TS 29.500 [6] and 3GPP TS 29.501 [7]. + +The Binding Support Management Service is provided by the Binding Support Function (BSF). + +# --- 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.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [6] 3GPP TS 29.500: "5G System; Technical Realization of Service Based Architecture; Stage 3". +- [7] 3GPP TS 29.501: "5G System; Principles and Guidelines for Services Definition; Stage 3". +- [8] IETF RFC 9113: "HTTP/2". +- [9] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [10] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [11] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [12] 3GPP TS 29.510: "5G System; Network Function Repository Services; Stage 3". +- [13] IETF RFC 9457: "Problem Details for HTTP APIs". +- [14] 3GPP TS 29.213: " Policy and Charging Control signalling flows and Quality of Service (QoS) parameter mapping". +- [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 23.527: "5G System; Restoration Procedures". + +- [18] 3GPP TR 21.900: "Technical Specification Group working methods". +- [19] 3GPP TS 23.316: "Wireless and wireline convergence access support for the 5G System (5GS)". +- [20] IETF RFC 7396: "JSON Merge Patch". +- [21] 3GPP TS 29.512: "5G System; Session Management Policy Control Service; 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]. + +| | | +|----------|----------------------------------------------------------------| +| 5G DDNMF | 5G Direct Discovery Name Management Function | +| 5G-RG | 5G Residential Gateway | +| AF | Application Function | +| AM | Access and Mobility Management | +| BSF | Binding Support Function | +| DNN | Data Network Name | +| DRA | Diameter Routing Agent | +| HTTP | Hypertext Transfer Protocol | +| FN-RG | Fixed Network Residential Gateway | +| FQDN | Fully Qualified Domain Name | +| GPSI | Generic Public Subscription Identifier | +| JSON | JavaScript Object Notation | +| MAC | Media Access Control | +| MBSF | Multicast/Broadcast Service Function | +| NEF | Network Exposure Function | +| NRF | Network Repository Function | +| NWDAF | Network Data Analytics Function | +| PCF | Policy Control Function | +| SMF | Session Management Function | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SUPI | Subscription Permanent Identifier | +| TSCTSF | Time Sensitive Communication and Time Synchronization Function | +| UDR | Unified Data Repository | + +# --- 4 Binding Support Management Service + +## 4.1 Service Description + +### 4.1.1 Overview + +The Binding Support Management Service as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [4], is provided by the Binding Support Function (BSF). + +The Nbsf\_Management service is used to provide: + +- a PCF for a PDU session binding functionality, which ensures that an AF request for a certain PDU Session reaches the relevant PCF holding that PDU Session information, or ensures that the same PCF is selected for multiple PDU sessions. +- a PCF for an MBS session binding functionality, which ensures that for location-dependent MBS services, an AF request for a certain MBS Session reaches the relevant PCF holding that MBS Session information. +- a PCF for a UE binding functionality, which ensures that an AF request for Access and Mobility related Policy Authorization for a UE reaches the relevant PCF for a UE holding the AM Policy Association. +- Subscription to notification events about a newly registered or deregistered PCF for a UE or PCF for a PDU session. + +This service: + +- allows NF service consumers to register, update and remove binding information; +- allows NF service consumers to retrieve binding information; +- allows NF service consumers to subscribe to notifications of registration/deregistration events of newly registered or deregistered PCF for a UE or PCF for a PDU session. + +### 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 23.503 [4] and 3GPP TS 29.513 [5]. + +The Binding Support Management Service (Nbsf\_Management) is exhibited by the Binding Support Function (BSF). + +The known consumers of the Nbsf\_Management service are: + +- Policy Control Function (PCF) +- Network Exposure Function (NEF) +- Application Function (AF); +- Multicast/Broadcast Service Function (MBSF); +- 5G Direct Discovery Name Management Function (5G DDNMF); +- Network Data Analytics Function (NWDAF); and +- Time Sensitivity Communication and Time Synchronization Function (TSCTSF). + +As described in 3GPP TS 23.503 [4], the BSF is a function that can be deployed standalone or as a functionality provided by other network functions, such as PCF, UDR, NRF, SMF. + +NOTE 1: The PCF accesses the Nbsf\_Management service at the BSF via an internal interface when it is collocated with BSF. + +NOTE 2: The DRA decides to select a BSF based on user IP address range when the DRA has no binding information for the subscriber to get the relevant PCF for a PDU session address. DRA and BSF coexistence is described in 3GPP TS 29.513 [5], Annex A. + +NOTE 2: The DRA decides to select a BSF based on user IP address range when the DRA has no binding information for the subscriber to get the relevant PCF for a PDU session address. DRA and BSF coexistence is described in 3GPP TS 29.513 [5], Annex A. + +![Figure 4.1.2-1: Reference Architecture for the Nbsf_Management service; SBI representation. The diagram shows a central BSF box containing an Nbsf service. Below it, the Nbsf_Management service is connected to seven network functions: PCF, NEF, AF, NWDAF, TSCTSF, MBSF, and 5G DDNMF.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +graph TD + BSF[BSF] -- Nbsf --> Nbsf_Management_service((Nbsf_Management service)) + Nbsf_Management_service --- PCF[PCF] + Nbsf_Management_service --- NEF[NEF] + Nbsf_Management_service --- AF[AF] + Nbsf_Management_service --- NWDAF[NWDAF] + Nbsf_Management_service --- TSCTSF[TSCTSF] + Nbsf_Management_service --- MBSF[MBSF] + Nbsf_Management_service --- 5GDDNMF[5G DDNMF] + +``` + +Figure 4.1.2-1: Reference Architecture for the Nbsf\_Management service; SBI representation. The diagram shows a central BSF box containing an Nbsf service. Below it, the Nbsf\_Management service is connected to seven network functions: PCF, NEF, AF, NWDAF, TSCTSF, MBSF, and 5G DDNMF. + +**Figure 4.1.2-1: Reference Architecture for the Nbsf\_Management service; SBI representation** + +NOTE 3: The PCF in the figure represents both, the PCF for a UE and the PCF for a PDU session. The PCF for a UE and the PCF for a PDU session separately and independently register themselves at the BSF, regardless they are deployed in the same NF instance or separately in different NF instances. + +### 4.1.3 Network Functions + +#### 4.1.3.1 Binding Support Function (BSF) + +The BSF: + +- stores the binding information for a certain PDU Session; +- stores the binding information for a certain MBS Session; +- stores the binding information for a certain UE; +- enables the subscription to notifications of PCF for a PDU session registration/deregistration events; +- enables the subscription to notifications of PCF for a UE registration/deregistration events; and +- enables the discovery of binding information (e.g. the address information of the selected PCF for a PDU session). + +The BSF allows NF service consumers (e.g. PCF) to register, update and remove a binding information, and allows NF service consumers (e.g. AF, NEF, NWDAF) to discover a binding information (e.g. the address information of the selected PCF). The BSF also allows NF service consumers (e.g. PCF for a UE, AF, NEF) to subscribe to notifications of PCF registration/deregistration events. + +The BSF can be deployed standalone or collocated with other network functions, such as PCF, UDR, NRF and SMF. + +#### 4.1.3.2 NF Service Consumers + +The Policy Control Function (PCF): + +- The PCF for a PDU session: + - a. registers binding information in the BSF for a UE when an IPv4 address and/or IPv6 prefix is allocated, or a MAC address is used for the PDU session; + +- b. updates binding information in the BSF when a UE address information is changed for the PDU Session; and +- c. removes binding information in the BSF when an IPv4 address and/or IPv6 prefix is released, or a MAC address is not used for the PDU Session. +- The PCF for an MBS session: + - a. registers binding information in the BSF for an MBS session; + - b. updates binding information in the BSF for the MBS session; + - c. removes binding information in the BSF for the MBS session. +- The PCF for a UE: + - a. registers binding information in the BSF for a UE when an AM/UE Policy Association is established; + - b. updates binding information in the BSF when a new PCF instance for a UE is selected; + - c. removes binding information in the BSF when the AM/UE Policy Association is terminated; and + - d. subscribes with the BSF to notification of registration/deregistration events of the PCF for a PDU session. + +##### The Network Exposure Function (NEF): + +- provides means for the Application Functions to securely interact with the Policy framework for policy control to 3GPP network. During the procedure, it needs to discover the selected PCF for a PDU session, the selected PCF for an MBS Session (if applicable) or the selected PCF for a UE by using the Nbsf\_Management\_Discovery service operation and the selected PCF for a UE by using the Nbsf\_Management\_Subscribe/Notify service operations. + +##### The Application Function (AF): + +- discovers the selected PCF for a PDU session, the selected PCF for an MBS Session (if applicable) or the selected PCF for a UE by using the Nbsf\_Management\_Discovery service operation and the selected PCF for a UE by using the Nbsf\_Management\_Subscribe/Notify service operations when it is allowed to interact directly with the policy framework for policy control. + +##### The Network Data Analytics Function (NWDAF): + +- discovers the selected PCF for a PDU session by using the Nbsf\_Management\_Discovery service operation. + +##### The Time Sensitive Communication and Time Synchronization Function (TSCTSF) + +- discovers the selected PCF for a PDU session by using the Nbsf\_Management\_Discovery service operation and the selected PCF for a UE by using Nbsf\_Management\_Subscribe/Notify service operations when it is allowed to interact with the policy framework for time sensitive communication and time synchronization control. + +##### The Multicast/Broadcast Service Function (MBSF): + +- discovers the selected PCF for an MBS session by using the Nbsf\_Management\_Discovery service operation. + +##### The 5G Direct Discovery Name Management Function (5G DDNMF): + +- handles the discovery of the selected PCF for a UE by using the Nbsf\_Management\_(un)Subscribe/Notify service operations. + +## 4.2 Service Operations + +### 4.2.1 Introduction + +**Table 4.2.1-1: Operations of the Nbsf\_Management Service** + +| Service operation name | Description | Initiated by | +|-----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------| +| Nbsf_Management_Register | This service operation is used to register the binding information for a PDU session or an MBS session or a UE. | NF service consumer (PCF) | +| Nbsf_Management_Deregister | This service operation is used to deregister the binding information for a PDU session or an MBS session or a UE. | NF service consumer (PCF) | +| Nbsf_Management_Discovery | This service operation is used by an NF service consumer to discover a selected PCF for a PDU session or a selected PCF for an MBS session or a selected PCF for a UE. | NF service consumer (NEF, AF, NWDAF, MBSF, TSCTSF) | +| Nbsf_Management_Update | This service operation is used to update an existing binding information for a PDU session or an MBS session or a UE. | NF service consumer (PCF) | +| Nbsf_Management_Subscribe | This service operation is used by an NF service consumer to subscribe or to modify a subscription for event notifications of PCF for the UE or PCF for the PDU session binding related events. | NF service consumer (NEF, AF, PCF, TSCTSF, 5G DDNMF) | +| Nbsf_Management_Unsubscribe | This service operation is used by an NF service consumer to terminate a previous subscription. | NF service consumer (NEF, AF, PCF, TSCTSF, 5G DDNMF) | +| Nbsf_Management_Notify | This service operation is used by the BSF to notify binding related event(s) to the NF service consumer which has subscribed to such event(s). | BSF | + +### 4.2.2 Nbsf\_Management\_Register Service Operation + +#### 4.2.2.1 General + +This service operation allows a NF service consumer (e.g. PCF for a PDU session) to register the session binding information for a UE in the BSF by providing the user identity, the DNN, the UE address(es) and the selected PCF address for a certain PDU Session to the BSF, and BSF stores the information. + +If the BindingUpdate feature is not supported and the NF service consumer (e.g. PCF for a PDU session) receives a new UE address (e.g. IPv6 prefix) and has already registered session binding information for this PDU session, the NF service consumer (e.g. PCF for a PDU session) shall register a new session binding information in the BSF. + +If the SamePcf feature or the ExtendedSamePcf feature is supported, this service operation allows the NF service consumer (e.g. PCF for a PDU session) to check whether PCF addressing information for Npcf\_SMPolicyControl service is already registered in the BSF by another PCF for a combination of the UE ID, DNN and S-NSSAI parameters of the PDU session. + +This service operation also allows a NF service consumer (e.g. PCF for a UE) to register PCF for a UE binding information for a UE in the BSF, by providing to the BSF the user identity and the selected PCF address for a certain UE, and the BSF stores the information. + +In addition, this service operation also allows a NF service consumer (e.g. PCF for an MBS session) to register the session binding information for an MBS Session at the BSF, by providing the MBS Session ID, the identifier of the selected PCF for the MBS Session and the related information (e.g. PCF (service) set information), and the BSF stores the information. + +The following procedures using the Nbsf\_Management\_Register service operation are supported: + +- Register a new PCF for a PDU Session binding information. + +- Register a new PCF for a UE binding information. +- Register a new PCF for an MBS Session binding information. + +#### 4.2.2.2 Register a new PCF for a PDU Session binding information + +![Sequence diagram showing the interaction between an NF Service Consumer and a BSF. The NF Service Consumer sends a POST request to the BSF at step 1, and the BSF responds with a 201 Created status at step 2.](410562339ce067fdc6fa41940c118658_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant BSF + Note left of NF Service Consumer: + NF Service Consumer->>BSF: 1. POST ../pcfBindings + BSF-->>NF Service Consumer: 2. 201 Created + +``` + +Sequence diagram showing the interaction between an NF Service Consumer and a BSF. The NF Service Consumer sends a POST request to the BSF at step 1, and the BSF responds with a 201 Created status at step 2. + +**Figure 4.2.2.2-1: NF service consumer register a new PCF for a PDU Session binding information** + +The NF service consumer shall invoke the Nbsf\_Management\_Register service operation to register the PDU session binding information for a UE in the BSF. The NF service consumer shall send for this an HTTP POST request with "{apiRoot}/nbsf-management/{apiVersion}/pcfBindings" as Resource URI representing the "PCF for a PDU Session Bindings", as shown in figure 4.2.2.2-1, step 1, to create a binding information for an "Individual PCF for a PDU Session Binding" according to the information (e.g. UE address(es), SUPI, GPSI, DNN, S-NSSAI) in the message body. When the "ExtendedSamePcf" feature is not supported, the "PcfBinding" data structure provided in the request body shall include: + +- if the "MultiUeAddr" feature is not supported or not yet known, address information of the served UE consisting of: + - (i) either IP address information consisting of: + - + the IPv4 address encoded as "ipv4Addr" attribute; and/or + - + the /128 IPv6 address, the IPv6 address prefix or an IPv6 prefix shorter than /64 encoded as "ipv6Prefix" attribute; or + - (ii) the MAC address encoded as "macAddr48" attribute; + +Otherwise, address information of the served UE consisting of: + +- (i) any IP address information consisting of: + - + the IPv4 address encoded as "ipv4Addr" attribute; + - + the /128 IPv6 address, the IPv6 address prefix or an IPv6 prefix shorter than /64 encoded as "ipv6Prefix" attribute; and/or + +NOTE 1: IPv6 prefix shorter than /64 are received when IPv6 Prefix Delegation applies, as specified in 3GPP TS 29.512 [21]. The /128 IPv6 address applies to wireline and wireless convergence, as described in 3GPP TS 29.512 [21], clause C.2.1.6. + +- + the additional /128 IPv6 addresses, the IPv6 address prefixes or IPv6 prefixes shorter than /64 encoded as "addIpv6Prefixes" attribute; or + +NOTE 2: Additional /128 IPv6 addresses and additional IPv6 prefixes shorter than /64 apply for wireline and wireless convergence, as specified in 3GPP TS 29.512 [21], clause C.2.1.6. + +- (ii) the MAC address encoded as "macAddr48" attribute and/or the additional MAC addresses encoded as "addMacAddrs" attribute; + +- PCF address information consisting of: + +- (i) if the PCF supports the Npcf\_PolicyAuthorization service: + - + the FQDN of the PCF encoded as "pcfFqdn" attribute; and/or + +- + a description of IP endpoints at the PCF hosting the Npcf\_PolicyAuthorization service encoded as "pcfIpEndPoints" attribute; and +- (ii) if the PCF supports the Rx interface: + - + the Diameter host id of the PCF encoded as "pcfDiamHost"; and + - + the Diameter realm of the PCF encoded as "pcfDiamRealm" attributes; +- DNN encoded as "dnn" attribute; +- S-NSSAI encoded as "snssai" attribute; and +- If the "SamePcf" feature defined in clause 5.8 is supported and the PCF determines based on operator policies that the same PCF shall be selected for the SM Policy associations: + - (i) PCF address information for Npcf\_SMPolicyControl service consisting of: + - + the FQDN of the PCF encoded as "pcfSmFqdn" attribute; or + - + a description of IP endpoints at the PCF hosting the Npcf\_SMPolicyControl service encoded as "pcfSmIpEndPoints" attribute; and + - (ii) the parameters combination for selecting the same PCF encoded within the "paraCom" attribute if the PCF registers the binding information for the indicated parameter combination for the first time. + +NOTE 3: When the "SamePcf" feature is supported, the PCF omits the "paraCom" attribute when creates the corresponding binding information related to the subsequent PDU sessions for the same parameter combination. + +and may include: + +- SUPI encoded as "supi" attribute; +- GPSI encoded as "gpsi" attribute; +- IPv4 address domain encoded as "ipDomain" attribute; and +- framed routes consisting of: + - (i) one or more framed routes within the "ipv4FrameRouteList" attribute for IPv4; and/or + - (ii) one or more framed routes within the "ipv6FrameRouteList" attribute for IPv6. + +When the "TimeSensitiveNetworking" feature or the "TimeSensitiveCommunication" feature is supported by the PCF as defined in clause 5.8 of 3GPP TS 29.512 [21], and for Ethernet type of PDU sessions, the address information of the served UE contains the MAC address of the DS-TT port encoded in the "macAddr48" attribute as received by the PCF when the SMF reports the bridge information of the detected TSC user plane node. + +NOTE 4: For the integration with time sensitive communication networks using IP type of applications, the address information of the served UE contains the UE IP address of the corresponding PDU session. + +When the "ExtendedSamePcf" feature is supported the address information of the served UE may be provided if available, i.e., the "ipv4Addr", the "ipv6Prefix" and/or "addIpv6Prefixes" attributes or the "macAddr48" and/or "addMacAddrs" attributes may be provided if available. + +When the "ExtendedSamePcf" feature is supported the PCF address for the Npcf\_PolicyAuthorization and/or Rx interface may be provided if available, i.e., the "pcfFqdn" and/or the "pcfIpEndPoints" attributes, and/or the "pcfDiamHost" and/or the "pcfDiamRealm" attributes may be provided if available. + +NOTE 5: Before requesting 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), the PCF determines whether the BSF supports the "SamePcf" and/or "ExtendedSamePcf" features either via local configuration or by checking the BSF profile retrieved from the NRF as specified in 3GPP TS 29.510 [12]. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nbsf-management//pcfBindings" as Resource URI and "PcfBinding" data structure as request body, the BSF shall: + +- create new binding information; +- assign a bindingId; and +- store the binding information. + +The PCF as NF service consumer may provide PCF Id in "pcfId" attribute and recovery timestamp in "recoveryTime" attribute. The BSF may use the "pcfId" attribute to supervise the status of the PCF as described in clause 5.2 of 3GPP TS 29.510 [12] and perform necessary clean up upon status change of the PCF later, and/or both the "pcfId" attribute and the "recoveryTime" attribute in clean up procedure as described in clause 6.4 of 3GPP TS 23.527 [17]. + +The PCF as a NF service consumer may provide PCF Set Id within the "pcfSetId" attribute and "bindLevel" attribute set to NF\_SET or provide PCF Set Id within the "pcfSetId" attribute, PCF instance Id within the "pcfId" attribute and "bindLevel" attribute set to NF\_INSTANCE. + +If the BSF created an "Individual PCF for a PDU Session Binding" resource, the BSF shall respond with "201 Created" status code with the message body containing a representation of the created binding information, as shown in figure 4.2.2.2-1, step 2. The BSF shall include a Location HTTP header field containing the URI of the created binding information, i.e. "{apiRoot}/nbsf-management//pcfBindings/{bindingId}". + +If errors occur when processing the HTTP POST request, the PCF shall apply error handling procedures as specified in clause 5.7. + +If the "SamePcf" feature defined in clause 5.8 is supported and the "paraCom" attribute is included in the HTTP POST message, the BSF shall check the received "paraCom" attribute. If the BSF detects that there is an existing PCF binding information including the same "dnn", "snssai" and "supi" attribute values as each of the corresponding attribute values within the "paraCom" attribute, the BSF shall reject the request with an HTTP "403 Forbidden" status code and shall include in the response the "ExtProblemDetails" data structure including the FQDN of the existing PCF hosting the Npcf\_SMPolicyControl service within the "pcfSmFqdn" attribute or the description of IP endpoints at the existing PCF hosting the Npcf\_SMPolicyControl service within the "pcfSmIpEndPoint" attribute of "BindingResp" data structure, and the "cause" attribute of the "ProblemDetails" data structure set to "EXISTING\_BINDING\_INFO\_FOUND". + +#### 4.2.2.3 Register a new PCF for a UE binding information + +![Sequence diagram showing the interaction between an NF service consumer and a BSF to register a new PCF for a UE binding information. Step 1: The consumer sends a POST request to the BSF. Step 2: The BSF responds with a 201 Created status.](70de8885bd7de15723aaad5eb5c5febf_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note right of NF service consumer: 1. POST .../pcf-ue-bindings + NF service consumer->>BSF: Request + Note left of BSF: 2. "201 Created" + BSF-->>NF service consumer: Response +``` + +Sequence diagram showing the interaction between an NF service consumer and a BSF to register a new PCF for a UE binding information. Step 1: The consumer sends a POST request to the BSF. Step 2: The BSF responds with a 201 Created status. + +Figure 4.2.2.3-1: NF service consumer registers a new PCF for a UE binding information + +The NF service consumer shall invoke the Nbsf\_Management\_Register service operation to register the PCF for a UE binding information in the BSF. The NF service consumer shall send for this an HTTP POST request with "{apiRoot}/nbsf-management//pcf-ue-bindings" as Resource URI representing the "PCF for a UE Bindings", as shown in figure 4.2.2.3-1, step 1, to create a binding information for an "Individual PCF for a UE Binding" according to the information in the message body. + +The "PcfForUeBinding" data structure included in the request message body shall include: + +- SUPI encoded as "supi" attribute; and + +- if the PCF supports the Npcf\_AMPolicyAuthorization service, the Npcf\_AMPolicyAuthorization service address information consisting of: + - a. the FQDN of the PCF encoded as "pcfForUeFqdn" attribute; and/or + - b. a description of IP endpoints at the PCF hosting the Npcf\_AMPolicyAuthorization service encoded as "pcfForUeIpEndPoints" attribute; + +NOTE: In this release of the specification the PCF for a UE registering the binding information in the BSF supports the Npcf\_AMPolicyAuthorization service. + +and may include: + +- GPSI encoded as "gpsi" attribute; +- PCF instance Id in "pcfId" attribute; +- the PCF Set identifier in the "pcfSetId" attribute; and +- the binding level in the "bindLevel" attribute. + +Upon the reception of an HTTP POST request with: "{apiRoot}/nbsf-management//pcf-ue-bindings" as Resource URI and "PcfForUeBinding" data structure as request body, the BSF shall: + +- create new binding information; +- assign a bindingId; and +- store the binding information. + +The PCF as a NF service consumer may provide information about the PCF Set and the binding level of subsequent request to the same or different PCF instances for the Npcf\_AMPolicyControl service. The PCF may provide the PCF Set Id within the "pcfSetId" attribute and "bindLevel" attribute set to NF\_SET, or may provide the PCF Set Id within the "pcfSetId" attribute, PCF instance Id within the "pcfId" attribute and "bindLevel" attribute set to NF\_INSTANCE. + +If the BSF created an "Individual PCF for a UE Binding" resource, the BSF shall respond with "201 Created" status code with the message body containing a representation of the created binding information, as shown in figure 4.2.2.3-1, step 2. The BSF shall include a Location HTTP header field containing the URI of the created binding information, i.e. "{apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId}". + +If errors occur when processing the HTTP POST request, the PCF shall apply error handling procedures as specified in clause 5.7. + +#### 4.2.2.4 Register a new PCF for an MBS Session binding information + +![Sequence diagram showing the registration procedure for an MBS Session binding information. The NF service consumer sends a POST request to the BSF, and the BSF responds with a 201 Created status.](2de714cedbbdd36f901f71bafa78f75a_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: Register a new PCF for an MBS Session binding information + NF service consumer->>BSF: 1. POST .../pcf-mbs-bindings (PcfMbsBinding) + BSF-->>NF service consumer: 2. 201 Created (PcfMbsBinding) + +``` + +Sequence diagram showing the registration procedure for an MBS Session binding information. The NF service consumer sends a POST request to the BSF, and the BSF responds with a 201 Created status. + +Figure 4.2.2.4-1: PCF for an MBS Session Binding information Registration procedure + +1. The NF service consumer (e.g. PCF for an MBS Session) shall invoke the Nbsf\_Management\_Register service operation to register a new PCF for an MBS Session binding at the BSF. The NF service consumer shall send for this purpose an HTTP POST request targeting the "PCF for an MBS Session Bindings" resource URI, i.e. "{apiRoot}/nbsf-management//pcf-mbs-bindings", with the request body containing the PcfMbsBinding data structure that shall include: + +- the identifier of the MBS Session to which the MBS Session binding is related, within the "mbsSessionId" attribute; +- the FQDN of the PCF handling the MBS Session, if available, within the "pcfFqdn" attribute; and +- the IP end point(s) of the PCF handling the MBS Session, if available, within the "pcfIpEndPoints" attribute; and may include: + - the identifier of the PCF instance handling the concerned MBS Session, within the "pcfId" attribute; + - the identifier of the PCF set to which the PCF instance handling the concerned MBS Session belongs, within the "pcfSetId" attribute; + - the level of binding of the PCF handling the concerned MBS Session, within the "bindLevel" attribute; and + - the recovery timestamp of the NF service consumer (e.g. PCF for an MBS Session), within the "recoveryTime" attribute. + +If the NF service consumer (e.g. PCF for an MBS Session) provides the PCF instance ID within the "pcfId" attribute, and optionally the recovery timestamp within "recoveryTime" attribute, the BSF may use this information to carry out the clean-up procedures defined in subclause 6.4 of 3GPP TS 23.527 [17], if necessary. + +2. Upon successful processing of the received HTTP POST request, the BSF shall check if there is an existing MBS Session Binding information with the same "mbsSessionId" attribute value. If it is the case, the the BSF shall reject the request with an HTTP "403 Forbidden" status code with the response body containing the MbsExtProblemDetails data structure that shall include the FQDN of the existing PCF within the "pcfFqdn" attribute or the description of the IP endpoints of the existing PCF within the "pcfIpEndPoints" attribute of the MbsBindingResp data structure, and the "cause" attribute of the ProblemDetails data structure set to "EXISTING\_BINDING\_INFO\_FOUND". + +If there is not existing MBS Session Binding information for the provided "mbsSessionId" attribute, the BSF shall create a new "Individual PCF for an MBS Session Binding" resource to store the requested PCF for an MBS Session binding. The BSF shall then respond to the NF service consumer with an HTTP "201 Created" status code including an HTTP Location header field containing the URI of the created "Individual PCF for an MBS Session Binding" resource, and the response body containing a representation of the created resource within the PcfMbsBinding data structure. + +If errors occur when processing the HTTP POST request, the BSF shall apply the error handling procedures, as specified in subclause 5.7. + +### 4.2.3 Nbsf\_Management\_Deregister Service Operation + +#### 4.2.3.1 General + +This service operation allows the NF service consumer to delete existing PCF for a PDU session binding information for a UE at the BSF. It is executed by deleting the corresponding "Individual PCF for a PDU Session Binding" resource. The operation is invoked by issuing an HTTP DELETE request targeting the resource URI representing the specific PCF for a PDU session binding information that is to be deleted. + +This service operation also allows the NF service consumer to delete existing PCF for a UE binding information for a UE at the BSF. It is executed by deleting the corresponding "Individual PCF for a UE Binding" resource. The operation is invoked by issuing an HTTP DELETE request targeting the resource URI representing the specific PCF for a UE binding information that is to be deleted. + +This service operation also allows the NF service consumer to delete existing PCF for an MBS Session binding information for an MBS Session at the BSF. It is executed by deleting the corresponding "Individual PCF for an MBS Session Binding" resource. The operation is invoked by issuing an HTTP DELETE request targeting the resource URI representing the specific PCF for an MBS Session binding information that is to be deleted. + +The following procedures using the Nbsf\_Management\_Deregistration service operation are supported: + +- Deregister an individual PCF for a PDU Session binding information. + +- Deregister an individual PCF for a UE binding information. +- Deregister an individual PCF for an MBS Session binding information. + +#### 4.2.3.2 Deregister an individual PCF for a PDU Session binding information + +![Sequence diagram for PDU Session Binding Information Deregistration](9cd90f495b95ad2116ff780248c26d95_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. DELETE .../pcfBindings/{bindingId} + BSF-->>NF service consumer: 2. 204 No Content +``` + +The diagram shows a sequence of two messages between an NF service consumer and a BSF. The NF service consumer sends a DELETE request to the BSF, and the BSF responds with a 204 No Content status code. + +Sequence diagram for PDU Session Binding Information Deregistration + +**Figure 4.2.3.2-1: PCF for a PDU Session Binding Information Deregistration** + +The NF service consumer shall invoke the Nbsf\_Management\_Deregister service operation to deregister the PCF for a PDU session binding information for a UE in the BSF. The NF service consumer shall send an HTTP DELETE request with "{apiRoot}/nbsf-management//pcfBindings/{bindingId}" as Resource URI, where "{bindingId}" is the "Individual PCF for a PDU Session Binding" resource identifier that is to be deleted, as shown in figure 4.2.3.2-1, step 1. + +Upon the reception of an HTTP DELETE request with: "{apiRoot}/nbsf-management//pcfBindings/{bindingId}" as Resource URI, the BSF shall: + +- remove the corresponding binding information. + +If the HTTP DELETE request message from the NF service consumer is accepted, the BSF shall respond with "204 No Content" status code, as shown in figure 4.2.3.2-1, step 2. + +If errors occur when processing the HTTP DELETE request, the BSF shall send an HTTP error response as specified in clause 5.7. + +If the Individual PCF for a PDU Session Binding resource does not exist, the BSF shall respond with "404 Not Found" error code. + +If the feature "ES3XX" is supported, and the BSF determines the received HTTP DELETE request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.2.3.3 Deregister an individual PCF for a UE binding information + +![Sequence diagram for UE Binding Information Deregistration](1320668e9151c5144f7e3696ae57e07f_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. DELETE .../pcf-ue-bindings/{bindingId} + BSF-->>NF service consumer: 2. "204 No Content" +``` + +The diagram shows a sequence of two messages between an NF service consumer and a BSF. The NF service consumer sends a DELETE request to the BSF, and the BSF responds with a 204 No Content status code. + +Sequence diagram for UE Binding Information Deregistration + +**Figure 4.2.3.3-1: PCF for a UE Binding Information Deregistration** + +The NF service consumer shall invoke the Nbsf\_Management\_Deregister service operation to deregister the session binding information for a UE in the BSF. The NF service consumer shall send an HTTP DELETE request with + +"`{apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId}`" as Resource URI, where "`{bindingId}`" is the "Individual PCF for a UE Binding" resource identifier that is to be deleted, as shown in figure 4.2.3.3-1, step 1. + +Upon the reception of an HTTP DELETE request with: "`{apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId}`" as Resource URI, the BSF shall: + +- remove the corresponding binding information. + +If the HTTP DELETE request message from the NF service consumer is accepted, the BSF shall respond with "204 No Content" status code, as shown in figure 4.2.3.3-1, step 2. + +If errors occur when processing the HTTP DELETE request, the BSF shall send an HTTP error response as specified in clause 5.7. + +If the Individual PCF for a UE Binding resource does not exist, the BSF shall respond with "404 Not Found" error code. + +If the BSF determines the received HTTP DELETE request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.2.3.4 Deregister an individual PCF for an MBS Session binding information + +![Sequence diagram for PCF for an MBS Session Binding information Deregistration procedure. The diagram shows two lifelines: 'NF service consumer' on the left and 'BSF' on the right. Step 1: A message '1. DELETE .../pcf-mbs-bindings/{bindingId}' is sent from the NF service consumer to the BSF. Step 2: A response '2. 204 No Content' is sent from the BSF back to the NF service consumer.](cdd4dfacab004e9979caed3fffea69e5_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. DELETE .../pcf-mbs-bindings/{bindingId} + BSF-->>NF service consumer: 2. 204 No Content + Note right of BSF: +``` + +Sequence diagram for PCF for an MBS Session Binding information Deregistration procedure. The diagram shows two lifelines: 'NF service consumer' on the left and 'BSF' on the right. Step 1: A message '1. DELETE .../pcf-mbs-bindings/{bindingId}' is sent from the NF service consumer to the BSF. Step 2: A response '2. 204 No Content' is sent from the BSF back to the NF service consumer. + +**Figure 4.2.3.4-1: PCF for an MBS Session Binding information Deregistration procedure** + +1. The NF service consumer shall invoke the `Nbsf_Management_Deregister` service operation to deregister an existing PCF for an MBS Session Binding at the BSF. The NF service consumer shall send for this purpose an HTTP DELETE request targeting the URI of the concerned "Individual PCF for an MBS Session Binding" resource, i.e. "`{apiRoot}/nbsf-management//pcf-mbs-bindings/{bindingId}`". +2. Upon success, the BSF shall delete the concerned "Individual PCF for an MBS Session Binding" resource and respond to the NF service consumer with an HTTP "204 No Content" status code. + +If errors occur when processing the HTTP DELETE request, the BSF shall apply the error handling procedures specified in subclause 5.7. + +If the BSF determines the received HTTP DELETE request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +If the "Individual PCF for an MBS Session Binding" resource does not exist, the BSF shall respond with "404 Not Found" error code. + +### 4.2.4 Nbsf\_Management\_Discovery Service Operation + +#### 4.2.4.1 General + +This service operation allows the service consumer to use the HTTP GET method to obtain the address information of the selected PCF. + +- Retrieve the PCF binding information for a PDU session. +- Retrieve the PCF binding information for a UE. +- Retrieve the PCF binding information for an MBS Session. + +#### 4.2.4.2 Retrieve the PCF binding information for a PDU session + +![Sequence diagram showing the interaction between an NF service consumer and a BSF to retrieve PCF binding information. The consumer sends a GET request to the BSF, and the BSF responds with a 200 OK containing the binding information.](523ab7b925beb555f88b2e1e1336974f_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. GET .../pcfBindings?query_parameters + BSF-->>NF service consumer: 2. 200 OK (pcfBinding) + +``` + +Sequence diagram showing the interaction between an NF service consumer and a BSF to retrieve PCF binding information. The consumer sends a GET request to the BSF, and the BSF responds with a 200 OK containing the binding information. + +**Figure 4.2.4.2-1: NF service consumer retrieve the PCF binding information for a PDU session** + +The NF service consumer shall invoke the Nbsf\_Management\_Discovery service operation to obtain address information of the selected PCF for a PDU session in the BSF. The NF service consumer shall send an HTTP GET request with "{apiRoot}/nbsf-management//pcfBindings" as Resource URI, and "query parameters" that shall include: + +- UE address; + +and may include: + +- SUPI or GPSI; +- DNN and optionally S-NSSAI; and +- IPv4 address domain. + +NOTE 1: The query parameters S-NSSAI and/or IPv4 address domain are helpful in the scenario of IPv4 address overlapping where the same IPv4 address may be allocated to UE PDU sessions. + +Upon the reception of an HTTP GET request with: "{apiRoot}/nbsf-management//pcfBindings" as Resource URI, the BSF shall search the corresponding binding information. + +If "ipv6Prefix" is used as an UE IPv6 address in the query parameters, the BSF shall use the longest prefix match to find a matching IPv6 prefix so that the IPv6 address in the query parameters is within the address range covered by that matching IPv6 prefix. + +NOTE 2: The matching is done by comparing the /128 IPv6 address of the query parameter with the IPv6 prefix of the PDU session. The management of the IPv6 prefix of the PDU session 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. + +The IPv6 address in the query parameters shall be formatted as an IPv6 prefix value including the trailing prefix length "/128". If the framed routes exist in the binding information, the BSF shall use framed routes to match the UE address in the query parameters. + +If the HTTP request message from the NF service consumer is accepted and a session binding resource matching the query parameters exists, the BSF shall reply with an HTTP "200 OK" response, as shown in figure 4.2.4.2-1, step 2, containing the corresponding "PcfBinding" data structure, as provided by the PCF during the Nbsf\_Management\_Register Service Operation, in the response body containing PCF addressing information, and if available, the related PCF Set Id and PCF instance Id. If there is no PCF binding information for a PDU session matching the query parameters, the BSF shall respond with an HTTP "204 No Content". + +NOTE 3: The NF service consumer (such as the AF or NEF) uses the PCF binding information as described in 3GPP TS 29.513 [5] clause 8.4.2 (see bullets d) and e) in that clause). If the NF service consumer (such as the AF or NEF) is not able to reach the received PCF address(es), the NF service consumer can use the PCF Set Id and the PCF instance Id as specified in 3GPP TS 29.513 [5] clause 8.4.2. + +If the "PCF for a PDU Session Bindings" resource does not exist, the BSF shall respond with "404 Not Found" HTTP error code. If an invalid combination of query parameters (i.e. a combination without UE address) is contained in the + +request URI, the BSF shall respond with an HTTP "400 Bad Request" error code containing "MANDATORY\_QUERY\_PARAM\_MISSING" as application error within the ProblemDetails IE. If more than one Individual PCF for a PDU Session Binding resources are found, the BSF shall respond with an HTTP "400 Bad Request" error code containing "MULTIPLE\_BINDING\_INFO\_FOUND" as application error within the ProblemDetails IE. + +#### 4.2.4.3 Retrieve the PCF binding information for a UE + +![Sequence diagram showing the NF service consumer retrieving PCF binding information for a UE from the BSF.](a24e89a6fe9bb70c83f8bf5202baba95_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. GET .../pcf-ue-bindings?query_parameters + BSF-->>NF service consumer: 2. 200 OK (array(PcfForUeBinding)) +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a BSF. The NF service consumer sends a GET request to the BSF for PCF-UE bindings with query parameters. The BSF responds with a 200 OK status containing an array of PcfForUeBinding objects. + +Sequence diagram showing the NF service consumer retrieving PCF binding information for a UE from the BSF. + +Figure 4.2.4.3-1: NF service consumer retrieve the PCF binding information for a UE + +The NF service consumer shall invoke the Nbsf\_Management\_Discovery service operation to obtain address information of the selected PCF for a UE in the BSF. The NF service consumer shall send an HTTP GET request with "{apiRoot}/nbsf-management//pcf-ue-bindings" as Resource URI, and "query parameters" that shall include: + +- SUPI and/or GPSI; + +Upon the reception of an HTTP GET request with: "{apiRoot}/nbsf-management//pcf-ue-bindings" as Resource URI, the BSF shall search the corresponding binding information. + +If the HTTP request message from the NF service consumer is accepted and a binding resource matching the query parameters exists, the BSF shall reply with an HTTP "200 OK" response, as shown in figure 4.2.4.3-1, step 2, containing the corresponding "PcfForUeBinding" data structure(s), as provided by the PCF during the Nbsf\_Management\_Register Service Operation, in the response body containing PCF addressing information, and if available, the related PCF Set Id and PCF instance Id. If there is no PCF binding information for a UE matching the query parameters, the BSF shall respond with an HTTP "200 OK" response with an empty array (i.e. "[]" in JSON). + +NOTE: If the NF service consumer (such as the AF or NEF) is not able to reach the received PCF address(es), the NF service consumer can use the PCF Set Id and the PCF instance Id as specified in 3GPP TS 29.513 [5] clause 6.2. + +If the "PCF for a UE Bindings" resource does not exist, the BSF shall respond with a "404 Not Found" HTTP error code. + +#### 4.2.4.4 Retrieve the PCF binding information for an MBS Session + +![Sequence diagram showing the NF service consumer retrieving PCF binding information for an MBS Session from the BSF.](2876be3592c7b4878400b85f209b2b6a_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. GET .../pcf-mbs-bindings? + BSF-->>NF service consumer: 2. 200 OK (array(PcfMbsBinding)) +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a BSF. The NF service consumer sends a GET request to the BSF for PCF-MBS bindings with query parameters. The BSF responds with a 200 OK status containing an array of PcfMbsBinding objects. + +Sequence diagram showing the NF service consumer retrieving PCF binding information for an MBS Session from the BSF. + +Figure 4.2.4.4-1: PCF for an MBS Session Binding Retrieval procedure + +1. The NF service consumer (e.g. NEF, MBSF, AF) shall invoke the Nbsf\_Management\_Discovery service operation to obtain from the BSF the addressing information of the selected PCF for an MBS Session. The NF service consumer shall send for this purpose an HTTP GET request targeting the "PCF for an MBS Session Bindings" resource URI, i.e. "{apiRoot}/nbsf-management//pcf-mbs-bindings", which shall include the following query parameters: + - the identifier of the MBS Session to which the requested MBS Session binding is related, within the "mbs-session-id" query parameter; and +2. Upon reception of the HTTP GET request with: "{apiRoot}/nbsf-management//pcf-mbs-bindings" as Resource URI, the BSF shall search the corresponding binding information. Then, + - if the HTTP GET request from the NF service consumer is accepted and a corresponding "Individual PCF for an MBS Session Binding" resource matching the provided query parameters exists, the BSF shall respond with an HTTP "200 OK" response, as shown in figure 4.2.4.4-1, step 2, containing the corresponding "PcfMbsBinding" data structure, as provided by the PCF during the Nbsf\_Management\_Register Service Operation, in the response body containing PCF addressing information, and if available, the related PCF Set Id and PCF instance Id; and + - if there is no PCF binding information for an MBS Session matching the received query parameters, the BSF shall respond with an HTTP "200 OK" response with an empty array (i.e. "[ ]" in JSON). + +NOTE: If the NF service consumer (such as the AF, NEF or MBSF) is not able to reach the received PCF address(es), the NF service consumer can use the PCF Set Id and the PCF instance Id as specified in subclause 8.6 of 3GPP TS 29.513 [5]. + +If errors occur when processing the HTTP GET request, the BSF shall apply the error handling procedures, as specified in subclause 5.7. + +If an invalid combination of query parameters (i.e. a combination without MBS Session Id) is contained in the request URI, the BSF shall respond with an HTTP "400 Bad Request" error code containing "MANDATORY\_QUERY\_PARAM\_MISSING" as application error within the ProblemDetails IE. If more than one Individual PCF for an MBS Session Binding resources are found, the BSF shall respond with an HTTP "400 Bad Request" error code containing "MULTIPLE\_BINDING\_INFO\_FOUND" as application error within the ProblemDetails IE. + +If the "PCF for an MBS Session Bindings" resource does not exist, the BSF shall respond with a "404 Not Found" HTTP error code. + +### 4.2.5 Nbsf\_Management\_Update Service Operation + +#### 4.2.5.1 General + +This service operation allows the NF service consumer to update an existing PCF for a PDU session binding information for a UE in the BSF by providing the information to be updated (e.g. the UE address(es)), and the BSF updates the PDU session binding information. + +This service operation also allows the NF service consumer to update an existing PCF for a UE binding information for a UE in the BSF by providing the information to be updated (e.g. PCF instance, and related PCF address), and the BSF updates the UE binding information. + +This service operation also allows the NF service consumer to update existing PCF for an MBS Session binding information for an MBS Session at the BSF by providing the information to be updated (e.g. PCF instance, PCF addresses), and the BSF update the MBS session binding information. + +The following procedures using the Nbsf\_Management\_Update service operation are supported: + +- Update an existing PCF for a PDU Session binding information. +- Update an existing PCF for a UE binding information. +- Update an existing PCF for an MBS Session binding information. + +#### 4.2.5.2 Update an existing PCF for a PDU Session binding information + +![Sequence diagram showing the interaction between an NF service consumer and a BSF to update a PCF binding. Step 1: The consumer sends a PATCH request to the BSF. Step 2: The BSF responds with a 200 OK status.](844077b3034f0030b404207db0ad76b4_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: + NF service consumer->>BSF: 1. PATCH .../pcfBindings/{bindingId} + BSF-->>NF service consumer: 2. 200 OK + +``` + +Sequence diagram showing the interaction between an NF service consumer and a BSF to update a PCF binding. Step 1: The consumer sends a PATCH request to the BSF. Step 2: The BSF responds with a 200 OK status. + +**Figure 4.2.5.2-1: NF service consumer update an existing PCF for a PDU Session binding information** + +If the feature "BindingUpdate" is supported, the NF service consumer shall invoke the Nbsf\_Management\_Update service operation to update PCF for a PDU the session binding information for a UE in the BSF. The NF service consumer shall send an HTTP PATCH request with "{apiRoot}/nbsf-management//pcfBindings/{bindingId}" as Resource URI, where "{bindingId}" is the "Individual PCF for a PDU Session Binding" resource identifier that is to be updated, as shown in figure 4.2.5.2-1, step 1. The "PcfBindingPatch" data structure provided in the request body shall contain the information to be updated as follows. + +The "PcfBindingPatch" data structure: + +- for the IP address information of the served UE: + - a) shall contain the "ipv4Addr" attribute if the IPv4 address is modified, or if the "ExtendedSamePcf" feature is supported, if the IPv4 address was not previously provided, and may contain the "ipDomain" attribute if the IPv4 address domain is modified or if the "ExtendedSamePcf" feature is supported, if the IPv4 address domain was not previously provided and applies. To remove the IPv4 address the "ipv4Addr" attribute shall be set to "null" and if applicable, the "ipDomain" attribute shall be set to "null"; and/or + - b) shall contain the "ipv6Prefix" attribute if the IPv6 address information is modified, or if the "ExtendedSamePcf" feature is supported, if the IPv6 address information was not previously provided. The "ipv6Prefix" attribute shall be set to "null" if the IPv6 address information is removed; and/or + - c) if the "MultiUeAddr" feature is supported, shall contain: + - 1) the "addIpv6Prefixes" attribute containing the new complete list of additional IPv6 Address Prefixes if the additional IPv6 address information is modified, or if the "ExtendedSamePcf" feature is supported, the current list of IPv6 address prefixes if it was not previously provided; or + - 2) the "addIpv6Prefixes" attribute set to "null" if all additional IPv6 Address Prefixes are removed; or +- for the MAC address information of the served UE: + - a) shall contain the "macAddr48" attribute if the MAC address is modified, or if the "ExtendedSamePcf" feature is supported, if the MAC address was not previously provided. The "macAddr48" attribute shall be set to "null" if the MAC address is removed; and/or + - b) if the "MultiUeAddr" feature is supported, shall contain: + - 1) the "addMacAddrs" attribute containing the new complete list of additional MAC addresses if the additional MAC address information is modified, or if the "ExtendedSamePcf" feature is supported, the current list of MAC address(es) if it was not previously provided; or + - 2) the "addMacAddrs" attribute set to "null" if all additional MAC addresses are removed; or +- for the PCF instance and the associated PCF address information of the PCF holding the SM policy association, should contain if a new PCF instance is selected: + - a) the PCF instance ID encoded as "pcfId" attribute; + - b) if the PCF supports the Npcf\_PolicyAuthorization service: + +- 1) the FQDN of the PCF encoded as "pcfFqdn" attribute; and/or + - 2) a description of IP endpoints at the PCF hosting the Npcf\_PolicyAuthorization service encoded as "pcfIpEndPoints" attribute; and/or +- c) if the PCF supports the Rx interface: + - 1) the Diameter host id of the PCF encoded as "pcfDiamHost"; and + - 2) the Diameter realm of the PCF and "pcfDiamRealm" attributes; and/or +- for the S-NSSAI of the PDU session, if the S-NSSAI has been replaced: + - a) shall contain the "snssai" attribute containing the alternate S-NSSAI used to replace the existing S-NSSAI if the "NetSliceRepl" feature is supported. + +If the BSF cannot successfully fulfil the received HTTP PATCH request due to the internal BSF error or due to the error in the HTTP PATCH request, the BSF shall send the HTTP error response as specified in clause 5.7. + +Otherwise, upon the reception of the HTTP PATCH request with: "{apiRoot}/nbsf-management//pcfBindings/{bindingId}" as Resource URI and the "PcfBindingPatch" data structure as request body, the BSF shall update the binding information. + +If the BSF successfully updated an "Individual PCF for a PDU Session Binding" resource, the BSF shall respond with "200 OK" status code with the message body containing the resource representation with the updated PCF for a PDU session binding information in the "PcfBinding" data structure, as shown in figure 4.2.5.2-1, step 2. + +If errors occur when processing the HTTP PATCH request, the BSF shall send an HTTP error response as specified in clause 5.7. + +If the feature "ES3XX" is supported, and the BSF determines the received HTTP PATCH request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.2.5.3 Update an existing PCF for a UE binding information + +![Sequence diagram showing the interaction between an NF service consumer and a BSF to update a PCF for a UE binding information. The consumer sends a PATCH request to the BSF, and the BSF responds with a 200 OK status.](d3b5eac55166fc428a223bba5c46961b_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note right of NF service consumer: 1. PATCH .../pcf-ue-bindings/{bindingId} + NF service consumer->>BSF: 1. PATCH .../pcf-ue-bindings/{bindingId} + Note left of BSF: 2. "200 OK" + BSF-->>NF service consumer: 2. "200 OK" +``` + +Sequence diagram showing the interaction between an NF service consumer and a BSF to update a PCF for a UE binding information. The consumer sends a PATCH request to the BSF, and the BSF responds with a 200 OK status. + +Figure 4.2.5.3-1: NF service consumer update an existing PCF for a UE binding information + +The NF service consumer shall invoke the Nbsf\_Management\_Update service operation to update the PCF for a UE binding information for a UE in the BSF. The NF service consumer shall send an HTTP PATCH request with "{apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId}" as Resource URI, where "{bindingId}" is the "Individual PCF for a UE Binding" resource identifier that is to be updated, as shown in figure 4.2.5.3-1, step 1. The "PcfForUeBindingPatch" data structure provided in the request body shall contain the information to be updated as follows. + +The "PcfForUeBindingPatch" data structure, for the PCF instance and the associated PCF address information of the PCF holding the AM policy association, shall contain if a new PCF instance is selected: + +- a) the PCF instance ID encoded as "pcfId" attribute; and + +- b) if the PCF supports the Npcf\_AMPolicyAuthorization service, the Npcf\_AMPolicyAuthorization service address information consisting of: + - 1) the FQDN of the PCF encoded as "pcfForUeFqdn" attribute; and/or + - 2) a description of IP endpoints at the PCF hosting the Npcf\_AMPolicyAuthorization service encoded as "pcfForUeIpEndPoints" attribute. + +NOTE: In this release of the specification the PCF for a UE registering the binding information in the BSF supports the Npcf\_AMPolicyAuthorization service. + +If the BSF cannot successfully fulfill the received HTTP PATCH request due to the internal BSF error or due to the error in the HTTP PATCH request, the BSF shall send the HTTP error response as specified in clause 5.7. + +Otherwise, upon the reception of the HTTP PATCH request with: "{apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId}" as Resource URI and the "PcfForUeBindingPatch" data structure as request body, the BSF shall update the binding information. + +If the BSF successfully updated an "Individual PCF for a UE Binding" resource, the BSF shall respond with "200 OK" status code with the message body containing the resource representation with the updated PCF for a UE binding information in the "PcfForUeBinding" data structure, as shown in figure 4.2.5.3-1, step 2. + +If the BSF determines the received HTTP PATCH request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +#### 4.2.5.4 Update an existing PCF for an MBS Session binding information + +![Sequence diagram showing the interaction between an NF service consumer and a BSF to update an existing PCF for an MBS Session binding information.](dd380ccd5aca1151074fede04826f1a4_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note left of NF service consumer: Update an existing PCF for an MBS Session binding information + NF service consumer->>BSF: 1. PATCH .../pcf-mbs-bindings/{bindingId} (PcfMbsBindingPatch) + BSF-->>NF service consumer: 2. 200 OK (PcfMbsBinding) / 204 No Content +``` + +Sequence diagram showing the interaction between an NF service consumer and a BSF to update an existing PCF for an MBS Session binding information. + +Figure 4.2.5.4-1: NF service consumer updates an existing PCF for an MBS Session binding information + +1. The NF service consumer (e.g. PCF handling the MBS Session) shall invoke the Nbsf\_Management\_Update service operation to request the modification of an existing PCF for an MBS Session binding information for an MBS Session at the BSF. The NF service consumer shall send for this purpose an HTTP PATCH request targeting the URI of the concerned "Individual PCF for an MBS Session Binding" resource, i.e. "{apiRoot}/nbsf-management//pcf-mbs-bindings/{bindingId}", with the request body containing the PcfMbsBindingPatch data structure including the requested modifications. +2. Upon successful modification of the PCF for an MBS Session binding, the BSF shall respond with either: + - an HTTP "200 OK" status code with the response body containing a representation of the updated "Individual PCF for an MBS Session Binding" resource within the PcfMbsBinding data structure; or + - an HTTP "204 No Content" status code. + +If errors occur when processing the HTTP PATCH request, the BSF shall apply the error handling procedures specified in subclause 5.7. + +If the BSF determines the received HTTP PATCH request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. + +### 4.2.6 Nbsf\_Management\_Subscribe Service Operation + +#### 4.2.6.1 General + +This service operation is used by an NF service consumer to subscribe to the notifications of registration/deregistration events for the PCF for a PDU Session or PCF for a UE. + +The following procedures using the Nbsf\_Management\_Subscribe service operation are supported: + +- Creating a new subscription; +- Modifying an existing subscription. + +#### 4.2.6.2 Creating a new subscription + +Figure 4.2.6.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 BSF, and the BSF responds with a 201 Created status.](f1fbb1287d999c7034742de35bdab836_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant BSF + Note right of NF service consumer: 1. POST .../subscriptions + NF service consumer->>BSF: Request + Note left of BSF: 2. "201 Created" + BSF-->>NF service consumer: Response + +``` + +Sequence diagram showing the creation of a subscription. An NF service consumer sends a POST request to the BSF, and the BSF responds with a 201 Created status. + +**Figure 4.2.6.2-1: Creation of a subscription** + +To subscribe to event notifications, the NF service consumer shall send an HTTP POST request with: "{apiRoot}/nbsf-management//subscriptions" as Resource URI and the BsfSubscription data structure as request body that shall include: + +- an URI where to receive the requested notifications within the "notifUri" attribute; +- a Notification Correlation Identifier provided by the NF service consumer for the requested notifications within the "notifCorrelId" attribute; +- identification of the events to subscribe as "events" attribute; +- the SUPI within the "supi" attribute; +- if the NF service consumer subscribes to event notifications of newly registered and deregistered PCF for a PDU session, the "events" attribute indicating "PCF\_PDU\_SESSION\_BINDING\_REGISTRATION"/"PCF\_PDU\_SESSION\_BINDING\_DEREGISTRATION" and/or subscribes to the event notifications of binding registration of the first PDU session and deregistration of the last PDU session for a S-NSSAI and DNN combination indicating "SNSSAI\_DNN\_BINDING\_REGISTRATION"/"SNSSAI\_DNN\_BINDING\_DEREGISTRATION" respectively, and one DNN and S-NSSAI pair to which the subscription applies within the "snssaiDnnPairs" attribute and, when the subscription applies to more than one DNN and S-NSSAI, the list of the remaining DNN and S-NSSAI pairs to which the subscription applies within the "addSnssaiDnnPairs" attribute, which includes the DNN within the "dnn" attribute and the S-NSSAI within the "snssai" attribute; + +NOTE 1: When the subscribed event is SNSSAI\_DNN\_BINDING\_REGISTRATION and SNSSAI\_DNN\_BINDING\_DEREGISTRATION, only the status of the binding for the concerned S-NSSAI and DNN combination is reported, i.e., it is not needed to report the complete binding related information, but only an indication of registration or deregistration event. + +- if the NF service consumer subscribes to event notifications of newly registered and deregistered PCF for a UE, the "events" attribute indicating "PCF\_UE\_BINDING\_REGISTRATION"/"PCF\_UE\_BINDING\_DEREGISTRATION". + +The BsfSubscription data structure as request body may also include: + +- the GPSI within the "gpsi" attribute. + +If the BSF cannot successfully fulfil the received HTTP POST request due to an internal BSF 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}/nbsf-management//subscriptions" as request URI and "BsfSubscription" data structure as request body, the BSF shall create a new "Individual Binding Subscription" resource, store the subscription and send a HTTP "201 Created" response as shown in figure 4.2.6.2-1, step 2. The BSF shall include in the "201 Created" response: + +- a Location header field; and +- a "BsfSubscriptionResp" data type in the content. + +The Location header field shall contain the URI of the created individual application session context resource i.e., "{apiRoot}/nbsf-management//subscriptions/{subId}". + +The "BsfSubscriptionResp" data type shall contain: + +- the representation of the created "Individual Binding Subscription" resource within the "BsfSubscription" data type; and +- when the BSF already has available the requested information at the time of the event subscription request, the related notification information within the "BsfNotification" data type as specified in clause 4.2.8.2. + +The subscription to any event lasts till the NF service consumer terminates it as described in subclause 4.2.7.2. For every subscribed event, the continuous reporting notification method shall apply. + +#### 4.2.6.3 Modifying an existing subscription + +Figure 4.2.6.3-1 illustrates the modification of an existing subscription. + +![Sequence diagram illustrating the modification of an existing subscription. The NF service consumer sends a PUT request to the BSF. The BSF responds with either a 200 OK or a 204 No Content.](db7ae70402c81d140ae7df14b002e057_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note right of NF service consumer: 1. PUT .../subscriptions/{subId} + NF service consumer->>BSF: Request + Note left of BSF: 2a. "200 OK" +2b. "204 No Content" + BSF-->>NF service consumer: Response +``` + +Sequence diagram illustrating the modification of an existing subscription. The NF service consumer sends a PUT request to the BSF. The BSF responds with either a 200 OK or a 204 No Content. + +Figure 4.2.6.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}/nbsf-management//subscriptions/{subId}" as Resource URI, where "{subId}" is the subscription correlation ID of the existing subscription, and BsfSubscription data structure as request body as described in clause 4.2.6.2. + +NOTE 1: The "notifUri" attribute within the BsfSubscription data structure can be modified to request that subsequent notifications are sent to a new NF service consumer. + +NOTE 2: This service operation does not allow the unsubscription of all subscribed events. The unsubscription of all subscribed events is described in clause 4.2.7.2. + +Upon the reception of an HTTP PUT request with: "{apiRoot}/nbsf-management//subscriptions/{subId}" as Resource URI and BsfSubscription data structure as request body, if the received HTTP request is successfully processed and accepted, the BSF shall: + +- update the concerned subscription; and +- send an HTTP "200 OK" response with a response body containing a representation of the updated subscription in the BsfSubscriptionResp data structure or send an HTTP "204 No Content". + +If errors occur when processing the HTTP PUT request, the BSF shall send an HTTP error response as specified in clause 5.7. + +If the BSF determines the received HTTP PUT request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +### 4.2.7 Nbsf\_Management\_Unsubscribe Service Operation + +#### 4.2.7.1 General + +This service operation is used by an NF service consumer to unsubscribe from event notifications. + +The following procedure using the Nbsf\_Management\_Unsubscribe service operation is supported: + +- Unsubscription from event notifications. + +#### 4.2.7.2 Unsubscription from event notifications + +Figure 4.2.7.2-1 illustrates the unsubscription from event notifications. + +![Sequence diagram showing the unsubscription process between an NF service consumer and a BSF.](d5918cee231b536f20789a18d861fae3_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant BSF + Note right of NF service consumer: 1. DELETE .../subscriptions/{subId} + NF service consumer->>BSF: 1. DELETE .../subscriptions/{subId} + Note left of BSF: 2. "204 No Content" + BSF-->>NF service consumer: 2. "204 No Content" +``` + +The diagram illustrates a sequence of interactions between an NF service consumer and a BSF. The NF service consumer sends a DELETE request to the BSF, and the BSF responds with a 204 No Content status. The sequence is as follows: 1. The NF service consumer sends a DELETE request to the BSF. 2. The BSF responds with a 204 No Content status. + +Sequence diagram showing the unsubscription process between an NF service consumer and a BSF. + +Figure 4.2.7.2-1: Unsubscription from event notifications + +To unsubscribe from all event(s) notifications, the NF service consumer shall send an HTTP DELETE request with: "{apiRoot}/nbsf-management//subscriptions/{subId}" as Resource URI, where "{subId}" is the subscription correlation ID of the existing subscription that is to be deleted. + +Upon the reception of the HTTP DELETE request with: "{apiRoot}/nbsf-management//subscriptions/{subId}" as Resource URI, if the received HTTP request is successfully processed and accepted, the BSF shall: + +- remove the corresponding subscription; and +- send an HTTP "204 No Content" response. + +If errors occur when processing the HTTP DELETE request, the BSF shall send an HTTP error response as specified in clause 5.7. + +If the BSF determines the received HTTP DELETE request needs to be redirected, the BSF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [5]. + +### 4.2.8 Nbsf\_Management\_Notify Service Operation + +#### 4.2.8.1 General + +The Nbsf\_Management\_Notify service operation enables the BSF to send notifications to NF service consumers upon the occurrence of a previously subscribed event. + +The following procedure using the Nbsf\_Management\_Notify service operation is supported: + +- Notification about subscribed events. + +#### 4.2.8.2 Notification about subscribed events + +The present "notification about subscribed events" procedure is performed by the BSF when any of the subscribed events occur. + +Figure 4.2.8.2-1 illustrates the notification about subscribed events. + +![Sequence diagram illustrating the notification about subscribed events. The diagram shows two lifelines: BSF and NF service consumer. Step 1: BSF sends a POST {notifUri} request to the NF service consumer. Step 2: NF service consumer responds with a 204 No Content response.](68d8089266ace7197304b43dcaf5d08e_img.jpg) + +``` +sequenceDiagram + participant BSF + participant NF as NF service consumer + Note right of BSF: 1. POST {notifUri} + BSF->>NF: 1. POST {notifUri} + Note left of NF: 2. "204 No Content" + NF-->>BSF: 2. "204 No Content" +``` + +Sequence diagram illustrating the notification about subscribed events. The diagram shows two lifelines: BSF and NF service consumer. Step 1: BSF sends a POST {notifUri} request to the NF service consumer. Step 2: NF service consumer responds with a 204 No Content response. + +Figure 4.2.8.2-1: Notification about subscribed events + +If the BSF observes event(s) for which an NF service consumer has subscribed, the BSF shall send an HTTP POST request as shown in figure 4.2.8.2-1, step 1, with the "{notifUri}" as request URI containing the value previously provided by the NF service consumer within the corresponding subscription, and the BsfNotification data structure. + +The BsfNotification data structure shall include: + +- the notification correlation ID provided by the NF service consumer during the subscription within "notifCorreId" attribute; +- the list of the reported events within the "eventNotifs" attribute. For each reported event, the BsfEventNotification data type shall include the event identifier and may include additional event information. + +Within each instance of BsfEventNotification data type, the BSF shall include: + +- When a subscription to "PCF\_PDU\_SESSION\_BINDING\_REGISTRATION" and "PCF\_PDU\_SESSION\_BINDING\_DEREGISTRATION" exists: + - a. When the BSF detects the registration of a PCF for a PDU session for a DNN and S-NSSAI, SUPI, and GPSI, if available, matching one of the DNN, S-NSSAI pairs, the SUPI and the GPSI, if available, provided during subscription, the BSF shall set the "event" attribute to "PCF\_PDU\_SESSION\_BINDING\_REGISTRATION" and shall include the "pcfForPduSessInfos" with the binding information of the detected PDU session. + - b. When the BSF detects the deregistration of a PCF for a PDU session for a DNN and S-NSSAI, SUPI, and GPSI, if available, matching one of the DNN, S-NSSAI pairs, the SUPI and the GPSI, if available, provided during subscription, the BSF shall set the "event" attribute to + +"PCF\_PDU\_SESSION\_BINDING\_DEREGISTRATION" and shall include the "pcfForPduSessInfos" with the binding information of the removed PDU session. + +- When a subscription to "PCF\_UE\_BINDING\_REGISTRATION" and "PCF\_UE\_BINDING\_DEREGISTRATION" exists: + - a. When the BSF detects the registration of a PCF for a UE for a SUPI and, if available, GPSI matching the SUPI and, if available, GPSI provided during subscription, the BSF shall set the "event" attribute to "PCF\_UE\_BINDING\_REGISTRATION" and shall include the "pcfForUeInfo" with the binding information of the detected UE. + - b. When the BSF detects the deregistration of a PCF for a UE for a SUPI and, if available, GPSI matching the SUPI and, if available, GPSI provided during subscription, the BSF shall set the "event" attribute to "PCF\_UE\_BINDING\_DEREGISTRATION" and shall include the "pcfForUeInfo" with the binding information of the removed UE. +- When a subscription to "SNSSAI\_DNN\_BINDING\_REGISTRATION" and "SNSSAI\_DNN\_BINDING\_DEREGISTRATION" exists: + - a. When the BSF detects the registration of PCF for a PDU session for a DNN and S-NSSAI, SUPI, and GPSI, if available, matching one of the DNN, S-NSSAI pairs, the SUPI and the GPSI, if available, provided during subscription, and this is the first PDU session for the DNN and S-NSSAI, SUPI, and GPSI, if available, combination, the BSF shall set the "event" attribute to "SNSSAI\_DNN\_BINDING\_REGISTRATION" and the "matchSnssaiDnns" attribute with the matching S-NSSAI and DNN pairs. + - b. When the BSF detects the deregistration of PCF for a PDU session for a DNN and S-NSSAI, SUPI, and GPSI, if available, matching one of the DNN, S-NSSAI pairs, the SUPI and the GPSI, if available, provided during subscription, and this is the last PDU session for the DNN and S-NSSAI, SUPI, and GPSI, if available, combination, the BSF shall set the "event" attribute to "SNSSAI\_DNN\_BINDING\_DEREGISTRATION" and the removed S-NSSAI and DNN combinations within the "matchSnssaiDnns" attribute. + +If the HTTP POST request from the BSF 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.8.2-1, step 2. + +If the HTTP POST request from the BSF 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 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]. + +# --- 5 Nbsf\_Management Service API + +## 5.1 Introduction + +The Nbsf\_Management Service shall use the Nbsf\_Management API. + +The API URI of the Nbsf\_Management API shall be: + +**{apiRoot}** + +The request URIs used in HTTP requests from the NF service consumer towards the BSF shall have the Resource URI structure defined in clause 4.4.1 of 3GPP TS 29.501 [7], i.e.: + +**{apiRoot}** + +with the following components: + +- The {apiRoot} shall be set as described in 3GPP TS 29.501 [7]. +- The shall be "nbsf-management". +- 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 [6]. + +HTTP/2 shall be transported as specified in clause 5.3 of 3GPP TS 29.500 [6]. + +The OpenAPI [11] specification of HTTP messages and content bodies for the Nbsf\_Management 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 [6] 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 [6]. 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]. + +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 [20]. + +### 5.2.3 HTTP custom headers + +#### 5.2.3.1 General + +The Nbsf\_Management Service API shall support the mandatory HTTP custom header fields specified in clause 5.2.3.2 of 3GPP TS 29.500 [6] and may support the optional HTTP custom header fields specified in clause 5.2.3.3 of 3GPP TS 29.500 [6]. + +In this release of the specification, no specific custom headers are defined for the Nbsf\_Management Service API. + +## 5.3 Resources + +### 5.3.1 Resource Structure + +This clause describes the structure for the Resource URIs, the resources and methods used for the service. + +The structure of the Resource URI of the Nbsf\_Management service is shown in figure 5.3.1-1. + +![Resource URI structure of the Nbsf_Management API diagram](e05b36c0d46549e681ce6581422c66b2_img.jpg) + +{apiRoot}/nbsf-management/ + +``` +graph TD; Root["{apiRoot}/nbsf-management/"] --- pcfBindings["/pcfBindings"]; Root --- pcfUeBindings["/pcf-ue-bindings"]; Root --- pcfMbsBindings["/pcf-mbs-bindings"]; Root --- subscriptions["/subscriptions"]; pcfBindings --- bindingId1["/{bindingId}"]; pcfUeBindings --- bindingId2["/{bindingId}"]; pcfMbsBindings --- bindingId3["/{bindingId}"]; subscriptions --- subId["/{subId}"]; +``` + +The diagram illustrates the hierarchical structure of the Nbsf\_Management API. The root path is {apiRoot}/nbsf-management/. It branches into four main resource paths: /pcfBindings, /pcf-ue-bindings, /pcf-mbs-bindings, and /subscriptions. Each of these paths further branches into a specific resource identifier: /{bindingId} for the first three, and /{subId} for subscriptions. + +Resource URI structure of the Nbsf\_Management API diagram + +**Figure 5.3.1-1: Resource URI structure of the Nbsf\_Management 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 | +|-------------------------------------------|----------------------------------------|---------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------| +| PCF for a PDU Session Bindings | /pcfBindings

(NOTE) | POST | Register a new PCF for a PDU Session binding information of a given UE address in the BSF. | +| | | GET | Retrieve the PCF for a PDU Session binding information i.e. PCF address information of a given tuple (UE address, SUPI; GPSI, DNN, S-NSSAI). | +| Individual PCF for a PDU Session Binding | /pcfBindings/{bindingId}

(NOTE) | DELETE | Deregister an existing PCF for a PDU Session binding information from the BSF. | +| | | PATCH | Update an existing PCF for a PDU Session binding information in the BSF. | +| PCF for a UE Bindings | /pcf-ue-bindings | POST | Register a new PCF for a UE binding information of a given UE identity in the BSF. | +| | | GET | Retrieve the PCF for a UE binding information i.e. PCF address information of a UE. | +| Individual PCF for a UE Binding | pcf-ue-bindings/{bindingId} | DELETE | Deregister an existing PCF for a UE binding information from the BSF. | +| | | PATCH | Update an existing PCF for a UE binding information in the BSF. | +| PCF for an MBS Session Bindings | /pcf-mbs-bindings | POST | Register a new PCF for an MBS Session Binding. | +| | | GET | Retrieve PCF for an MBS Session Binding information. | +| Individual PCF for an MBS Session Binding | /pcf-mbs-bindings/{bindingId} | PATCH | Modify an existing PCF for an MBS Session Binding. | +| | | DELETE | Deregister an existing PCF for an MBS Session Binding. | +| Binding Subscriptions | /subscriptions | POST | Create a new Individual Binding Subscription resource. | +| Individual Binding Subscription | /subscriptions/{subId} | PUT | Modify an existing Individual Binding Subscription resource. | +| | | DELETE | Delete an Individual Binding Subscription resource and cancel the related subscription. | + +NOTE: The path segment does not follow the related naming convention defined in 3GPP TS 29.501 [7]. The path segment is kept though as defined in the current specification for backward compatibility considerations. + +### 5.3.2 Resource: PCF for a PDU Session Bindings + +#### 5.3.2.1 Description + +This resource represents a collection of the different PCF for a PDU Session binding information of given UE address(es) registered in the BSF. + +#### 5.3.2.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//pcfBindings + +The shall be set as described in clause 5.1. + +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 | +|------------|---|-------------|----------------------------------------------------------------------| +| PcfBinding | M | 1 | Register a new Individual PCF for a PDU Session binding information. | + +**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 | +|-----------------------------------------------------------------------------------------------------------------------------------|---|-------------|------------------|---------------------------------------------------------------------------------------------------| +| PcfBinding | M | 1 | 201
Created | The creation of an individual PCF for a PDU Session binding. | +| ExtProblemDetails | O | 0..1 | 403
Forbidden | The existing PCF binding information stored in the BSF for the indicated combination is returned. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall 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}/nbsf-management//pcfBindings/{bindingId} | + +##### 5.3.2.3.2 GET + +This method shall support the URI query parameters specified in table 5.3.2.3.2-1. + +Table 5.3.2.3.2-1: URI query parameters supported by the GET method on this resource + +| Name | Data type | P | Cardinality | Description | +|------------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ipv4Addr
(NOTE 7) | Ipv4Addr | C | 0..1 | The IPv4 Address of the served UE. (NOTE 1) (NOTE 3) (NOTE 4) | +| ipv6Prefix
(NOTE 7) | Ipv6Prefix | C | 0..1 | The IPv6 Address of the served UE. (NOTE 1) (NOTE 3) (NOTE 4)
The NF service consumer shall append '/128' to the IPv6 address in the attribute value. E.g. '2001:db8:85a3::8a2e:370:7334/128'. | +| macAddr48
(NOTE 7) | MacAddr48 | C | 0..1 | The MAC Address of the served UE. (NOTE 1) | +| 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 6) | +| supi | Supi | O | 0..1 | Subscription Permanent Identifier | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier | +| snssai | Snssai | O | 0..1 | The identification of slice. (NOTE 2) | +| ipDomain
(NOTE 7) | string | O | 0..1 | The IPv4 address domain identifier. (NOTE 2) | +| supp-feat | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. (NOTE 5) | + +NOTE 1: One and only one of query parameter ipv4Addr, ipv6Prefix or macAddr48 shall be present. +NOTE 2: The query parameters snssai and/or ipDomain, if applicable (IPv4 address overlapping), shall be present with query parameter ipv4Addr. +NOTE 3: 5G-RG and FN-RG replaces UE for wireline access support. See 3GPP TS 23.316 [19]. +NOTE 4: The ipv4Addr and ipv6Prefix query parameters may include the IP address of devices in networks behind the UE (see clauses 5.6.14 and 5.8.2.2 of 3GPP TS 23.501 [2] and clause 4.6.2.3 of 3GPP TS 23.316 [19]). +NOTE 5: This query parameter may be present when there are supported features that apply to the retrieval of the "Individual PCF for a PDU Session Binding" resource as defined in clause 4.2.4.2. Otherwise, it shall be omitted. +NOTE 6: The BSF uses the DNN as received from the NF service consumer 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. +NOTE 7: The query parameter does not follow the related naming convention (i.e. "lower-with-hyphen") defined in clause 5.1.3.3 of 3GPP TS 29.501 [7]. This query parameter is however kept as currently defined in this specification for backward compatibility considerations. + +This method shall support the request data structures specified in table 5.3.2.3.2-2 and the response data structures and response codes specified in table 5.3.2.3.2-3. + +Table 5.3.2.3.2-2: Data structures supported by the GET Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.2.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------|---|-------------|-----------------|----------------------------------------------------------------------------------------------------------------| +| PcfBinding | M | 1 | 200 OK | The individual PCF for a PDU Session binding information resource matching the query parameter(s) is returned. | +| n/a | | | 204 No Content | There is no PCF for a PDU Session binding information matching the query parameter(s). | +| ProblemDetails | O | 0..1 | 400 Bad Request | More than one binding information is found. (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 [6] shall also apply. +NOTE 2: Failure cases are described in clause 5.7. + +### 5.3.3 Resource: Individual PCF for a PDU Session Binding + +#### 5.3.3.1 Description + +This resource represents an individual PCF for a PDU Session binding information of a given UE address(es) registered in the BSF. + +#### 5.3.3.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//pcfBindings/{bindingId} + +The shall be set as described in clause 5.1. + +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 | +| bindingId | string | Represents the individual PCF for a PDU Session Binding. To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [7]. | + +#### 5.3.3.3 Resource Standard Methods + +##### 5.3.3.3.1 DELETE + +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 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.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 DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.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 | Successful case: The Individual PCF for a PDU Session binding information resource is deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a PDU Session Binding deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a PDU Session Binding 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 [6] 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 [6]). + +**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 BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (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 BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (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 | +|-----------------|---|-------------|-----------------------------------------------| +| PcfBindingPatch | M | 1 | Update an individual PCF binding information. | + +**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 | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PcfBinding | M | 1 | 200 OK | Successful case: The Individual PCF for a PDU Session binding information resource is updated. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a PDU Session Binding modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a PDU Session Binding modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +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 [6] 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 [6]). + +**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 BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (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 BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +### 5.3.4 Resource: Binding Subscriptions + +#### 5.3.4.1 Description + +The Binding Subscriptions resource represents the collection of subscriptions to events in the Nbsf\_Management service. + +#### 5.3.4.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//subscriptions + +The shall be set as described in clause 5.1. + +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 | + +#### 5.3.4.3 Resource Standard Methods + +##### 5.3.4.3.1 POST + +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 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.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 POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|--------------------------------------------------------| +| BsfSubscription | M | 1 | Create a new Individual binding Subscription resource. | + +**Table 5.3.4.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|---------------------------------------------------------------------------| +| BsfSubscriptionResp | M | 1 | 201 Created | The creation of an Individual Binding Subscription resource is confirmed. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] also apply. | | | | | + +**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}/nbsf-management//subscriptions/{subId} | + +#### 5.3.4.4 Resource Custom Operations + +None. + +### 5.3.5 Resource: Individual Binding Subscription + +#### 5.3.5.1 Description + +The Individual Binding Subscription resource represents a single subscription to the event notification in the service. + +#### 5.3.5.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//subscriptions/{subId} + +The shall be set as described in clause 5.1. + +This resource shall support the resource URI variables defined in table 5.3.5.2-1. + +**Table 5.3.5.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| subId | string | Identifies a subscription to event notification. | + +#### 5.3.5.3 Resource Standard Methods + +##### 5.3.5.3.1 PUT + +This method shall support the URI query parameters specified in table 5.3.5.3.1-1. + +**Table 5.3.5.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.5.3.1-2 and the response data structures and response codes specified in table 5.3.5.3.1-3. + +**Table 5.3.5.3.1-2: Data structures supported by the PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------| +| BsfSubscription | M | 1 | Modify the existing Individual Binding Subscription resource matching the subId according to the representation in the BsfSubscription. | + +**Table 5.3.5.3.1-3: Data structures supported by the PUT Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|---------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------| +| BsfSubscriptionResp | M | 1 | 200 OK | Successful case: The Individual Binding Subscription resource matching the subId was modified and a representation is returned. | +| n/a | | | 204 No Content | Successful case: The Individual Binding Subscription resource matching the subId was modified. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual Binding Subscription modification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual Binding Subscription modification.
(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 [6] 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 [6]). + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +**Table 5.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 | Contains an alternative URI of the resource located in an alternative BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +##### 5.3.5.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.3.5.3.2-1. + +**Table 5.3.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 5.3.5.3.2-2 and the response data structures and response codes specified in table 5.3.5.3.2-3. + +**Table 5.3.5.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.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 Binding Subscription resource matching the subId was deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a PDU Session Binding deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a PDU Session Binding 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 [6] 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 [6]). + +**Table 5.3.5.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 BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +**Table 5.3.5.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 BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +#### 5.3.5.4 Resource Custom Operations + +None. + +### 5.3.6 Void + +### 5.3.7 Resource: PCF for a UE Bindings + +#### 5.3.7.1 Description + +This resource represents a collection of the different PCF for a UE binding information of given UE identifier (i.e., SUPI) registered in the BSF. + +#### 5.3.7.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//pcf-ue-bindings + +The shall be set as described in clause 5.1. + +This resource shall support the resource URI variables defined in table 5.3.7.2-1. + +**Table 5.3.7.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|----------------| +| apiRoot | string | See clause 5.1 | + +#### 5.3.7.3 Resource Standard Methods + +##### 5.3.7.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.7.3.1-1. + +**Table 5.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 5.3.7.3.1-2 and the response data structures and response codes specified in table 5.3.7.3.1-3. + +**Table 5.3.7.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------|---|-------------|-------------------------------------------------------------| +| PcfForUeBinding | M | 1 | Register a new Individual PCF for a UE Binding information. | + +**Table 5.3.7.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|-----------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------| +| PcfForUeBinding | M | 1 | 201
Created | The creation of an individual PCF for a UE Binding. | +| NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. | | | | | + +**Table 5.3.7.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}/nbsf-management//pcf-ue-bindings/{bindingId} | + +##### 5.3.7.3.2 GET + +This method shall support the URI query parameters specified in table 5.3.7.3.2-1. + +**Table 5.3.7.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|-----------|-------------------|---|-------------|--------------------------------------------------------------------------| +| supi | Supi | O | 0..1 | Subscription Permanent Identifier. (NOTE 1) | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier. (NOTE 1) | +| supp-feat | SupportedFeatures | O | 0..1 | To filter irrelevant responses related to unsupported features. (NOTE 2) | + +NOTE 1: At least one parameter shall be present. + +NOTE 2: This query parameter may be present when there are supported features that apply to the retrieval of the "Individual PCF for a UE Binding" resource as defined in clause 4.2.4.3. Otherwise, it shall be omitted. + +This method shall support the request data structures specified in table 5.3.7.3.2-2 and the response data structures and response codes specified in table 5.3.7.3.2-3. + +**Table 5.3.7.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.7.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|-----------------------------------------------------------------------------------------------| +| array(PcfForUeBinding) | M | 0..N | 200 OK | The individual PCF for a UE binding resource(s) matching the query parameter(s) are returned. | +| NOTE: The mandatory HTTP error status codes for the GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. | | | | | + +### 5.3.8 Resource: Individual PCF for a UE Binding + +#### 5.3.8.1 Description + +This resource represents an individual PCF for a UE binding information of given UE identifier (i.e SUPI) registered in the BSF. + +#### 5.3.8.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId} + +The shall be set as described in clause 5.1. + +This resource shall support the resource URI variables defined in table 5.3.8.2-1. + +**Table 5.3.8.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------|-----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See clause 5.1 | +| bindingId | string | Represents the individual PCF for a UE Binding.
To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [7]. | + +#### 5.3.8.3 Resource Standard Methods + +##### 5.3.8.3.1 DELETE + +This method shall support the URI query parameters specified in table 5.3.8.3.1-1. + +**Table 5.3.8.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 5.3.8.3.1-2 and the response data structures and response codes specified in table 5.3.8.3.1-3. + +**Table 5.3.8.3.1-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.8.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 | Successful case: The Individual PCF for a UE Binding information resource is deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a UE Binding deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a UE Binding deletion. The response shall include a Location header field containing an alternative URI of the resource located in an alternative BSF (service) instance. | +| NOTE: The mandatory HTTP error status codes for the DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. | | | | | + +**Table 5.3.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 BSF (service) instance. | +| 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.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 BSF (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.8.3.2 PATCH + +This method shall support the URI query parameters specified in table 5.3.8.3.2-1. + +**Table 5.3.8.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.8.3.2-2 and the response data structures and response codes specified in table 5.3.8.3.2-3. + +**Table 5.3.8.3.2-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------------|---|-------------|--------------------------------------------------------| +| PcfForUeBinding
Patch | M | 1 | Update an individual PCF for a UE binding information. | + +**Table 5.3.8.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PcfForUeBinding | M | 1 | 200 OK | Successful case: The Individual PCF for a UE binding information resource is updated. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a PDU Session Binding modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a PDU Session Binding modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +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 [6] 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 [6]). + +**Table 5.3.8.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 BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +**Table 5.3.8.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 BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +### 5.3.9 Resource: PCF for an MBS Session Bindings + +#### 5.3.9.1 Description + +This resource represents the collection of PCF for an MBS Session Bindings registered at the BSF. + +#### 5.3.9.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//pcf-mbs-bindings + +The shall be set as described in clause 5.1. + +This resource shall support the resource URI variables defined in table 5.3.9.2-1. + +**Table 5.3.9.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|---------|-----------|--------------------| +| apiRoot | string | See subclause 5.1. | + +#### 5.3.9.3 Resource Standard Methods + +##### 5.3.9.3.1 POST + +This method shall support the URI query parameters specified in table 5.3.9.3.1-1. + +**Table 5.3.9.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.9.3.1-2 and the response data structures and response codes specified in table 5.3.9.3.1-3. + +**Table 5.3.9.3.1-2: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|--------------------------------------------------------------------------------------| +| PcfMbsBinding | M | 1 | Contains the parameters to request to register a new PCF for an MBS Session Binding. | + +**Table 5.3.9.3.1-3: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------| +| PcfMbsBinding | M | 1 | 201 Created | Successful case. A new "Individual PCF for an MBS Session Binding" resource is created and the corresponding URI is returned in an HTTP Location header. | +| MbsExtProblemDetails | O | 0..1 | 403 Forbidden | The existing PCF binding information stored in the BSF for the MBS session shall be returned within the MbsExtProblemDetails data structure.
(NOTE 2) | +| NOTE: The mandatory HTTP error status codes for the HTTP POST method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. | | | | | +| NOTE 2: Failure cases are described in clause 5.7. | | | | | + +**Table 5.3.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}/nbsf-management//pcf-mbs-bindings/{bindingId} | + +##### 5.3.9.3.2 GET + +This method shall support the URI query parameters specified in table 5.3.9.3.2-1. + +**Table 5.3.9.3.2-1: URI query parameters supported by the GET method on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| mbs-session-id | MbsSessionId | M | 1 | Contains the identifier of the MBS Session to which the requested MBS Session binding is related. | +| supp-feat | SupportedFeatures | C | 0..1 | Contains the list of features supported by the NF service consumer and used to filter irrelevant responses related to unsupported features.

This query parameter shall be included if feature negotiation needs to take place. | + +This method shall support the request data structures specified in table 5.3.9.3.2-2 and the response data structures and response codes specified in table 5.3.9.3.2-3. + +**Table 5.3.9.3.2-2: Data structures supported by the GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 5.3.9.3.2-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------------------|---|-------------|-----------------|---------------------------------------------------------------------------------------------------------------------------------| +| array(PcfMbsBinding)

(NOTE 2) | M | 0..N | 200 OK | Successful case. The "Individual PCF for an MBS Session Binding" resource matching the provided query parameter(s) is returned. | +| ProblemDetails | O | 0..1 | 400 Bad Request | More than one binding information matching the provided query parameter(s) is found.

(NOTE 3) | + +NOTE 1: The mandatory HTTP error status codes for the HTTP GET method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] shall also apply. +NOTE 2: In this release of the specification, only a single element shall be provided within the array. +NOTE 3: Failure cases are described in clause 5.7. + +#### 5.3.9.4 Resource Custom Operations + +None. + +### 5.3.10 Resource: Individual PCF for an MBS Session Binding + +#### 5.3.10.1 Description + +This resource represents an "Individual PCF for an MBS Session Binding" registered at the BSF. + +#### 5.3.10.2 Resource definition + +Resource URI: {apiRoot}/nbsf-management//pcf-mbs-bindings/{bindingId} + +The shall be set as described in clause 5.1. + +This resource shall support the resource URI variables defined in table 5.3.10.2-1. + +**Table 5.3.10.2-1: Resource URI variables for this resource** + +| Name | Data type | Definition | +|-----------|-----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | string | See subclause 5.1. | +| bindingId | string | Represents the identifier of the "Individual PCF for an MBS Session Binding" resource.
To enable that the value is used as part of a URI, the string shall only contain characters allowed according to the "lower-with-hyphen" naming convention defined in 3GPP TS 29.501 [7]. | + +#### 5.3.10.3 Resource Standard Methods + +##### 5.3.10.3.1 PATCH + +This method shall support the URI query parameters specified in table 5.3.10.3.1-1. + +**Table 5.3.10.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 5.3.10.3.1-2 and the response data structures and response codes specified in table 5.3.10.3.1-3. + +**Table 5.3.10.3.1-2: Data structures supported by the PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------------------------------------------| +| PcfMbsBindingPatch | M | 1 | Contains the requested modifications to the PCF for an MBS Session Binding. | + +**Table 5.3.10.3.1-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| PcfMbsBinding | M | 1 | 200 OK | Successful case: The "Individual PCF for an MBS Session Binding" 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 "Individual PCF for an MBS Session Binding" resource is successfully modified and no content is returned in the response body. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a PDU Session Binding modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a PDU Session Binding modification.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +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 [6] 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 [6]). + +**Table 5.3.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 BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +**Table 5.3.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 BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +##### 5.3.10.3.2 DELETE + +This method shall support the URI query parameters specified in table 5.3.10.3.2-1. + +**Table 5.3.10.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.10.3.2-2 and the response data structures and response codes specified in table 5.3.10.3.2-3. + +**Table 5.3.10.3.2-2: Data structures supported by the DELETE Request Body on this resource** + +| Data type | P | Cardinality | Description | | +|-----------|---|-------------|-------------|--| +| n/a | | | | | + +**Table 5.3.10.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 PCF for an MBS Session Binding" resource is successfully deleted. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection, during Individual PCF for a PDU Session Binding deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during Individual PCF for a PDU Session Binding deletion.

Applicable if the feature "ES3XX" is supported.

(NOTE 2) | + +NOTE 1: The mandatory HTTP error status codes for the HTTP DELETE method listed in table 5.2.7.1-1 of 3GPP TS 29.500 [6] 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 [6]). + +**Table 5.3.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 BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +**Table 5.3.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 BSF (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 [6]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target BSF (service) instance towards which the request is redirected. | + +#### 5.3.10.4 Resource Custom Operations + +None. + +## 5.4 Custom Operations without associated resources + +None in this release of this specification. + +## 5.5 Notifications + +### 5.5.1 General + +Notifications shall comply to clause 6.2 of 3GPP TS 29.500 [6] and clause 4.6.2.3 of 3GPP TS 29.501 [7]. + +**Table 5.5.1-1: Notifications overview** + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|------------------|--------------|---------------------------------|-------------------------------------------------| +| BSF Notification | {notifUri} | POST | Provides information about observed BSF events. | + +### 5.5.2 BSF Notification + +#### 5.5.2.1 Description + +The BSF Notification is used by the BSF to report one or several observed events to an NF service consumer that has subscribed to such Notifications via the Individual Binding Subscription Resource. + +#### 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 within the Individual Binding Subscription Resource and described within the BsfSubscription type (see table 5.6.2.7-1). | + +#### 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 | +|-----------------|---|-------------|--------------------------------------------| +| BsfNotification | 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 the event notification.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection, during the event 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 [6] 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 [6]). + +**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 [6]. | +| 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.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 [6]. | +| 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 Nbsf\_Management service based interface protocol. + +Table 5.6.1-1: Nbsf\_Management specific Data Types + +| Data type | Section defined | Description | Applicability | +|----------------------|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| BindingLevel | 5.6.3.3 | Contains the binding level. | | +| BindingResp | 5.6.2.6 | Contains the binding information. | SamePcf | +| BsfEvent | 5.6.3.5 | Contains the event notified by the BSF. | | +| BsfEventNotification | 5.6.2.9 | Contains an event notification. | | +| BsfNotification | 5.6.2.8 | Contains the notification to the events. | | +| BsfSubscription | 5.6.2.7 | Contains the event subscription data. | | +| BsfSubscriptionResp | 5.6.4.1 | Contains the response to the subscription request. It consists of the resource representation within BsfSubscription data type and, if available, the matched observed event within the BsfNotification data type. | | +| ExtProblemDetails | 5.6.2.5 | Contains the FQDN or IP endpoints of the existing PCF and cause value if there is an existing PCF binding information for the indicated combination. | SamePcf | +| ParameterCombination | 5.6.2.4 | The combination used by the BSF to check whether there is an existing PCF binding information. | SamePcf | +| PcfBinding | 5.6.2.2 | Identifies an Individual PCF for a PDU session binding. | | +| PcfBindingPatch | 5.6.2.3 | Identifies an Individual PCF for a PDU session binding used for Patch method. | BindingUpdate | +| PcfMbsBinding | 5.6.2.15 | Represents an Individual PCF for an MBS Session binding. | | +| PcfMbsBindingPatch | 5.6.2.16 | Represents the requested modifications to an Individual PCF for an MBS Session binding. | | +| PcfForPduSessionInfo | 5.6.2.13 | The information of the PCF for a PDU session. | | +| PcfForUeBinding | 5.6.2.10 | Identifies an Individual PCF for a UE binding. | | +| PcfForUeBindingPatch | 5.6.2.11 | Identifies the updates to an Individual PCF for a UE binding. | | +| PcfForUeInfo | 5.6.2.14 | The information of the PCF for a UE. | | +| SnssaiDnnPair | 5.6.2.12 | Represents a S-NSSAI and DNN pair. | | + +Table 5.6.1-2 specifies data types re-used by the Nbsf\_Management 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 Nbsf\_Management service based interface. + +Table 5.6.1-2: Nbsf\_Management re-used Data Types + +| Data type | Reference | Comments | Applicability | +|-------------------|---------------------|--------------------------------------------------------------------------------------|---------------| +| DateTime | 3GPP TS 29.571 [10] | | | +| DiameterIdentity | 3GPP TS 29.571 [10] | | | +| Dnn | 3GPP TS 29.571 [10] | | | +| Fqdn | 3GPP TS 29.571 [10] | | | +| Gpsi | 3GPP TS 29.571 [10] | | | +| IpEndPoint | 3GPP TS 29.510 [12] | | | +| Ipv4Addr | 3GPP TS 29.571 [10] | | | +| Ipv4AddrMask | 3GPP TS 29.571 [10] | String identifying an IPv4 address mask. | | +| Ipv4AddrRm | 3GPP TS 29.571 [10] | | | +| Ipv6Prefix | 3GPP TS 29.571 [10] | | | +| Ipv6PrefixRm | 3GPP TS 29.571 [10] | | | +| MacAddr48 | 3GPP TS 29.571 [10] | | | +| MacAddr48Rm | 3GPP TS 29.571 [10] | | | +| MbsSessionId | 3GPP TS 29.571 [10] | Represents the identifier of an MBS Session. | | +| NfInstanceId | 3GPP TS 29.571 [10] | | | +| NfSetId | 3GPP TS 29.571 [10] | | | +| ProblemDetails | 3GPP TS 29.571 [10] | Used in error responses to provide more detailed information about an error. | | +| RedirectResponse | 3GPP TS 29.571 [10] | Contains redirection related information. | ES3XX | +| Snssai | 3GPP TS 29.571 [10] | | | +| Supi | 3GPP TS 29.571 [10] | | | +| SupportedFeatures | 3GPP TS 29.571 [10] | Used to negotiate the applicability of the optional features defined in table 5.8-1. | | + +### 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 PcfBinding + +Table 5.6.2.2-1: Definition of type PcfBinding + +| 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 | | +| ipv4Addr | Ipv4Addr | C | 0..1 | The IPv4 Address of the served UE. (NOTE 4) (NOTE 8) | | +| ipv6Prefix | Ipv6Prefix | C | 0..1 | The IPv6 Address Prefix of the served UE. (NOTE 4) (NOTE 5) (NOTE 8) | | +| addIpv6Prefixes | array(Ipv6Prefix) | O | 1..N | The additional IPv6 Address Prefixes of the served UE. (NOTE 4) (NOTE 5) (NOTE 8) (NOTE 10) | MultiUeAddr | +| ipDomain | string | O | 0..1 | IPv4 address domain identifier. (NOTE 1) (NOTE 8) | | +| macAddr48 | MacAddr48 | C | 0..1 | The MAC Address of the served UE. (NOTE 8) | | +| addMacAddrs | array(MacAddr48) | O | 1..N | The additional MAC Addresses of the served UE. (NOTE 8) (NOTE 10) | MultiUeAddr | +| dnn | Dnn | M | 1 | DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 11) | | +| pcfFqdn | Fqdn | C | 0..1 | FQDN of the PCF hosting the Npcf_PolicyAuthorization service. (NOTE 2) (NOTE 9) | | +| pcfIpEndPoints | array(IpEndPoint) | C | 1..N | IP end points of the PCF hosting the Npcf_PolicyAuthorization service. (NOTE 2) (NOTE 9) | | +| pcfDiamHost | DiameterIdentity | C | 0..1 | The diameter host for an individual PCF. (NOTE 3) (NOTE 9) | | +| pcfDiamRealm | DiameterIdentity | C | 0..1 | The diameter realm for an individual PCF. (NOTE 3) (NOTE 9) | | +| pcfSmFqdn | Fqdn | O | 0..1 | FQDN of the PCF hosting the Npcf_SMPolicyControl service. (NOTE 7) (NOTE 10) | SamePcf | +| pcfSmIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF hosting the Npcf_SMPolicyControl service. (NOTE 7) (NOTE 10) | SamePcf | +| snssai | Snssai | M | 1 | The identification of slice. | | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the supported optional features as described in clause 5.8.
Shall be present in the HTTP POST request/response; or in the HTTP GET response if the "supp-feat" attribute query parameter is included in the HTTP GET request. | | +| pcfId | NfInstanceId | O | 0..1 | PCF instance identifier | | +| pcfSetId | NfSetId | O | 0..1 | The PCF set Id | | +| recoveryTime | DateTime | O | 0..1 | Recovery time of the PCF | | +| paraCom | ParameterCombination | O | 0..1 | If it is included, the BSF shall check whether there is an existing PCF binding information for the indicated combination. (NOTE 6) (NOTE 10) | SamePcf | +| bindLevel | BindingLevel | O | 0..1 | Contains the level of binding. | | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------|---|------|-------------------------------------------|--| +| ipv4FrameRoute List | array(Ipv4AddrMask) | O | 1..N | List of Framed Route information of IPv4. | | +| ipv6FrameRoute List | array(Ipv6Prefix) | O | 1..N | List of Framed Route information of IPv6. | | +|

NOTE 1: The ipDomain attribute may only be provided if the ipv4Addr attribute is present.

NOTE 2: When the "ExtendedSamePcf" feature is not supported, at least one of "pcfFqdn" or "pcfIpEndPoints" shall be included if the PCF supports the Npcf_PolicyAuthorization service. When the "ExtendedSamePcf" feature is supported these attributes may be provided if available.

NOTE 3: When the "ExtendedSamePcf" feature is not supported, both pcfDiamHost and pcfDiamRealm are provided if the PCF supports Rx interface. When the "ExtendedSamePcf" feature is supported these attributes may be provided if available.

NOTE 4: 5G-RG and FN-RG replaces UE for wireline access support. See 3GPP TS 23.316 [19].

NOTE 5: IPv6 prefix(es) shorter than /64, according to 3GPP TS 23.501 [2], clause 5.8.2.2 and 3GPP TS 23.316 [19], clause 8.3.1, or full IPv6 address(es) with a /128 prefix, according to 3GPP TS 23.316 [19], clause 8.3.1, may be encoded as the "ipv6Prefix" and "addIpv6Prefixes" attributes.

NOTE 6: If the BSF finds that there is an existing Individual PCF for a PDU Session Binding resource for the indicated combination containing Npcf_SMPolicyControl service addressing information, the BSF shall not check other Individual PCF for a PDU Session Binding resources and shall reject the ongoing registration, and return the FQDN or IP endpoints of the Npcf_SMPolicyControl service of the matching Individual PCF for a PDU Session Binding resource to the requesting PCF.

NOTE 7: At least one of the "pcfSmFqdn" attribute or the "pcfSmIpEndPoints" attribute shall be included in the binding information, if the binding refers to an SM Policy association and if the "SamePcf" feature is supported and the PCF determines that the same PCF shall be selected for the SM Policy associations with the same SUPI/DNN/S-NSSAI parameter combination in the non-roaming or home-routed scenario based on operator's policies and configuration.

NOTE 8: When the "ExtendedSamePcf" feature is not supported the address information of the served UE shall be provided, i.e., either the "ipv4Addr", the "ipv6Prefix" and/or "addIpv6Prefixes" attributes or the "macAddr48" and/or "addMacAddrs" attributes shall be provided as specified in clause 4.2.2.2.

NOTE 9: When the "ExtendedSamePcf" feature is not supported the address information of the Npcf_PolicyAuthorization service and/or Rx interface shall be provided, i.e., both "pcfDiamHost" and "pcfDiamRealm" and/or at least one of the "pcfFqdn" or "pcfEndPoints" shall be provided as specified in clause 4.2.2.2.

NOTE 10: This attribute does not apply when the NF service consumer is an AF/NEF.

NOTE 11: The BSF uses the DNN as received from the NF service consumer 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.3 Type PcfBindingPatch + +**Table 5.6.2.3-1: Definition of type PcfBindingPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-------------------|---|-------------|--------------------------------------------------------------------------|---------------| +| ipv4Addr | Ipv4AddrRm | O | 0..1 | The IPv4 Address of the served UE. (NOTE 2) | | +| ipDomain | string | O | 0..1 | IPv4 address domain identifier. (NOTE 1) | | +| ipv6Prefix | Ipv6PrefixRm | O | 0..1 | The IPv6 Address Prefix of the served UE. (NOTE 2) (NOTE 3) | | +| addIpv6Prefixes | array(Ipv6Prefix) | O | 1..N | The additional IPv6 Address Prefixes of the served UE. (NOTE 2) (NOTE 3) | MultiUeAddr | +| macAddr48 | MacAddr48Rm | O | 0..1 | The MAC Address of the served UE. | | +| addMacAddrs | array(MacAddr48) | O | 1..N | The additional MAC Addresses of the served UE. | MultiUeAddr | +| pcfId | NfInstanceId | O | 0..1 | PCF instance identifier | | +| pcfFqdn | Fqdn | O | 0..1 | FQDN of the PCF hosting the Npcf_PolicyAuthorization service. | | +| pcfIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF hosting the Npcf_PolicyAuthorization service. | | +| pcfDiamHost | DiameterIdentity | O | 0..1 | The diameter host for an individual PCF. | | +| pcfDiamRealm | DiameterIdentity | O | 0..1 | The diameter realm for an individual PCF. | | +| snssai | Snssai | O | 0..1 | The updated S-NSSAI. | NetSliceRepl | + +NOTE 1: If applicable, the consumer (e.g. PCF) shall also request to remove the ipDomain attribute if the ipv4Addr attribute is requested to be removed. + +NOTE 2: 5G-RG and FN-RG replaces UE for wireline access support. See 3GPP TS 23.316 [19]. + +NOTE 3: IPv6 prefix(es) shorter than /64, according to 3GPP TS 23.501 [2], clause 5.8.2.2 and 3GPP TS 23.316 [19], clause 8.3.1, or full IPv6 address(es) with a /128 prefix, according to 3GPP TS 23.316 [19], clause 8.3.1, can be encoded as the "ipv6Prefix" and "addIpv6Prefixes" attributes. + +#### 5.6.2.4 Type ParameterCombination + +**Table 5.6.2.4-1: Definition of type ParameterCombination** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | O | 0..1 | Subscription Permanent Identifier | | +| dnn | Dnn | O | 0..1 | DNN, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 3) | | +| snssai | Snssai | O | 0..1 | The identification of slice. | | + +NOTE 1: At least one of the attributes in this table shall be included. + +NOTE 2: The applicable parameter combinations in a given deployment shall be disjoint combinations. E.g., if a deployment requires a parameter combination that includes a SUPI value for a DNN/S-NSSAI combination, subsequent parameter combinations of that DNN/S-NSSAI combination shall also include the corresponding SUPI attribute. + +NOTE 3: The BSF uses the DNN as received from the NF service consumer 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.5 Type ExtProblemDetails + +**Table 5.6.2.5-1: Definition of type ExtProblemDetails as a list of to be combined data types** + +| Data Type | P | Cardinality | Description | Applicability | +|----------------|---|-------------|-------------------------|---------------| +| ProblemDetails | O | 0..1 | Problem Details | | +| BindingResp | O | 0..1 | PCF Binding Information | | + +#### 5.6.2.6 Type BindingResp + +**Table 5.6.2.6-1: Definition of type BindingResp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------------|---|-------------|---------------------------------------------------------------------------|---------------| +| pcfSmFqdn | Fqdn | O | 0..1 | FQDN of the PCF hosting the Npcf_SMPolicyControl service. (NOTE) | | +| pcfSmIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF hosting the Npcf_SMPolicyControl service. (NOTE) | | + +NOTE: Either the "pcfSmFqdn" attribute or the "pcfSmIpEndPoints" attribute shall be included. + +#### 5.6.2.7 Type BsfSubscription + +**Table 5.6.2.7-1: Definition of type BsfSubscription** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------| +| events | array(BsfEvent) | M | 1..N | Subscribed Events. | | +| notifUri | Uri | M | 1 | Notification URI. | | +| notifCorrelId | string | M | 1 | It is used to set the value of Notification Correlation ID in the corresponding notification. | | +| supi | Supi | M | 1 | Subscription Permanent Identifier. | | +| gpsi | Gpsi | O | 0..1 | Identifies a GPSI. | | +| snssaiDnnPairs | SnssaiDnnPair | C | 0..1 | Represents the S-NSSAI and DNN pair for which the binding event report(s) shall apply. (NOTE) | | +| addSnssaiDnnPairs | array(SnssaiDnnPair) | C | 1..N | Represents the additional S-NSSAI and DNN pairs for which the binding event report(s) shall apply. (NOTE) | AddSnssaiDnnPair | +| suppFeat | SupportedFeatures | C | 0..1 | List of Supported features used as described in clause 5.8. This parameter shall be supplied by NF service consumer and BSF in the POST request that request the creation of an Individual Binding Subscription resource and the related reply, respectively. | | + +NOTE: If the NF service consumer needs to subscribe to notifications for more than one S-NSSAI and DNN pairs and the "AddSnssaiDnnPair" feature is supported, the NF service consumer shall include one S-NSSAI and DNN pair in the "snssaiDnnPairs" attribute and the remaining S-NSSAI and DNN pairs in the "addSnssaiDnnPairs" attribute. + +#### 5.6.2.8 Type BsfNotification + +**Table 5.6.2.8-1: Definition of type BsfNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| notifCorrId | string | M | 1 | Notification correlation ID used to identify the subscription to which the notification relates. It shall be set to the same value as the "notifCorrId" attribute of BsfSubscription data type. | | +| eventNotifs | array(BsfEventNotification) | M | 1..N | Notifications about Individual Events. | | + +#### 5.6.2.9 Type BsfEventNotification + +**Table 5.6.2.9-1: Definition of type BsfEventNotification** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------|-----------------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| event | BsfEvent | M | 1 | Event that is notified. | | +| pcfForUeInfo | PcfForUeInfo | C | 0..1 | The binding information of the PCF for a UE.
It shall be included if the BSF is subscribed to the notification of "PCF_UE_BINDING_REGISTRATION" and "PCF_UE_BINDING_DEREGISTRATION" event and the registration or deregistration of PCF for a UE is detected. | | +| pcfForPduSessionInfos | array(PcfForPduSessionInfo) | C | 1..N | The binding information of the PCF for a PDU session.
It shall be included if the BSF is subscribed to the notification of PCF_PDU_SESSION_BINDING_REGISTRATION event and the registration of the PCF for the PDU session is detected, and the BSF is subscribed to the notification of PCF_PDU_SESSION_BINDING_DEREGISTRATION and the deregistration of the PCF for the PDU session is detected. | | +| matchSnssaiDnns | array(SNSSAI_DNN_Pair) | C | 1..N | Matching S-NSSAI and DNN pairs.
It shall be included if the BSF is subscribed to the notification of SNSSAI_DNN_BINDING_REGISTRATION and a PCF registration for the first PDU session for the DNN and SNSSAI combination is detected, and the BSF is subscribed to the notification of SNSSAI_DNN_BINDING_DEREGISTRATION and a PCF deregistration for the last PDU session for the DNN and SNSSAI combination is detected . | | + +#### 5.6.2.10 Type PcfForUeBinding + +Table 5.6.2.10-1: Definition of type PcfForUeBinding + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | Subscription Permanent Identifier | | +| gpsi | Gpsi | O | 0..1 | Generic Public Subscription Identifier | | +| pcfForUeFqdn | Fqdn | C | 0..1 | FQDN of the PCF hosting the Npcf_AMPolicyAuthorization service, if available. (NOTE) | | +| pcfForUeIpEndPoints | array(IpEndPoint) | C | 1..N | IP end points of the PCF hosting the Npcf_AMPolicyAuthorization service, if available. (NOTE) | | +| pcfId | NfInstanceId | O | 0..1 | PCF instance identifier | | +| pcfSetId | NfSetId | O | 0..1 | The PCF set Id | | +| bindLevel | BindingLevel | O | 0..1 | Contains the level of binding. | | +| suppFeat | SupportedFeatures | C | 0..1 | Used to negotiate the supported optional features as described in clause 5.8.
Shall be present in the HTTP POST request/response or in the HTTP GET response if the "supp-feat" query parameter is included in the HTTP GET request. | | + +NOTE: At least one of the "pcfForUeFqdn" attribute or "pcfForUeIpEndPoints" attribute shall be provided. + +#### 5.6.2.11 Type PcfForUeBindingPatch + +Table 5.6.2.11-1: Definition of type PcfForUeBindingPatch + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------|---------------| +| pcfForUeFqdn | Fqdn | O | 0..1 | FQDN of the PCF hosting the Npcf_AMPolicyAuthorization service, if available. | | +| pcfForUeIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF hosting the Npcf_AMPolicyAuthorization service, if available. | | +| pcfId | NfInstanceId | O | 0..1 | PCF instance identifier | | + +#### 5.6.2.12 Type SnssaiDnnPair + +Table 5.6.2.12-1: Definition of type SnssaiDnnPair + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | S-NSSAI | | +| dnn | Dnn | M | 1 | Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE) | | + +NOTE: The BSF uses the DNN as received from the NF service consumer 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.13 Type PcfForUeInfo + +Table 5.6.2.13-1: Definition of type PcfForUeInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|--------------------------------------------------------------------------|---------------| +| pcfId | NfInstanceId | O | 0..1 | PCF instance identifier. | | +| pcfSetId | NfSetId | O | 0..1 | The PCF set ID. | | +| bindLevel | BindingLevel | O | 0..1 | Contains the level of binding. | | +| pcfFqdn | Fqdn | O | 0..1 | FQDN of the PCF hosting the Npcf_AMPolicyAuthorization service. | | +| pcfIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF hosting the Npcf_AMPolicyAuthorization service. | | + +NOTE: Either the "pcfFqdn" attribute or the "pcfIpEndPoints" attribute shall be included. + +#### 5.6.2.14 Type PcfForPduSessionInfo + +Table 5.6.2.14-1: Definition of type PcfForPduSessionInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| snssai | Snssai | M | 1 | S-NSSAI | | +| dnn | Dnn | M | 1 | Data Network Name, a full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only. (NOTE 3) | | +| pcfId | NfInstanceId | O | 0..1 | PCF instance identifier. | | +| pcfSetId | NfSetId | O | 0..1 | The PCF set ID. | | +| bindLevel | BindingLevel | O | 0..1 | Contains the level of binding. | | +| ipv4Addr | Ipv4Addr | O | 0..1 | The IPv4 Address of the served UE. | | +| ipDomain | string | O | 0..1 | IPv4 address domain identifier. (NOTE 2) | | +| ipv6Prefixes | array(Ipv6Prefix) | O | 1..N | The IPv6 Address Prefixes of the served UE. | | +| macAddrs | array(MacAddr48) | O | 1..N | The MAC Addresses of the served UE. | | +| pcfFqdn | Fqdn | O | 0..1 | FQDN of the PCF hosting the Npcf_PolicyAuthorization service. | | +| pcfIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF hosting the Npcf_PolicyAuthorization service. | | + +NOTE 1: Either the "pcfFqdn" attribute or the "pcfIpEndPoints" attribute shall be included. +NOTE 2: The "ipDomain" attribute may only be provided if the "ipv4Addr" attribute is present. +NOTE 3: The BSF uses the DNN as received from the NF service consumer 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.15 Type PcfMbsBinding + +Table 5.6.2.15-1: Definition of type PcfMbsBinding + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| mbsSessionId | MbsSessionId | M | 1 | Contains the identifier of the MBS Session to which the MBS Session binding is related. | | +| pcfFqdn | Fqdn | C | 0..1 | Contains the FQDN of the PCF handling the MBS Session.

This attribute shall be provided, if available.

(NOTE) | | +| pcfIpEndPoints | array(IpEndPoint) | C | 1..N | Contains the IP end points of the PCF handling the MBS Session.

This attribute shall be provided, if available.

(NOTE) | | +| pcfId | NfInstanceId | O | 0..1 | Contains the identifier of the PCF instance handling the concerned MBS Session. | | +| pcfSetId | NfSetId | O | 0..1 | Contains the identifier of the PCF set to which the PCF instance handling the MBS Session belongs. | | +| bindLevel | BindingLevel | O | 0..1 | Contains the level of binding of the PCF handling the MBS Session. | | +| recoveryTime | DateTime | O | 0..1 | Contains the recovery timestamp of the NF service consumer (e.g. PCF handling the MBS Session).

This attribute may be present only in the HTTP POST request. | | +| suppFeat | SupportedFeatures | C | 0..1 | Contains the supported features and is used to negotiate the supported optional features as described in clause 5.8.

This attribute may be present in the HTTP POST request. It shall be present in the HTTP POST response, if it is included in the corresponding HTTP POST request, or in the HTTP GET response, if the "supp-feat" query parameter is included in the corresponding HTTP GET request. | | + +NOTE: At least one of the "pcfFqdn" attribute or the "pcfIpEndPoints" attribute shall be present. + +#### 5.6.2.16 Type PcfMbsBindingPatch + +**Table 5.6.2.16-1: Definition of type PcfMbsBindingPatch** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|-----------------------------------------------------------------------------------------|---------------| +| pcfFqdn | Fqdn | O | 0..1 | Contains the updated FQDN of the PCF handling the MBS Session. | | +| pcfIpEndPoints | array(IpEndPoint) | O | 1..N | Contains the updated IP end points of the PCF handling the MBS Session. | | +| pcfId | NfInstanceId | O | 0..1 | Contains the updated identifier of the PCF instance handling the concerned MBS Session. | | + +#### 5.6.2.17 Type MbsExtProblemDetails + +**Table 5.6.2.17-1: Definition of type MbsExtProblemDetails as a list of to be combined data types** + +| Data Type | P | Cardinality | Description | Applicability | +|----------------|---|-------------|----------------------------------------------|---------------| +| ProblemDetails | O | 0..1 | Problem Details | | +| MbsBindingResp | O | 0..1 | PCF Binding Information for the MBS Session. | | + +#### 5.6.2.18 Type MbsBindingResp + +**Table 5.6.2.18-1: Definition of type MbsBindingResp** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|------------------------------------------------------------------|---------------| +| pcfFqdn | Fqdn | O | 0..1 | FQDN of the PCF handling the MBS Session.

(NOTE) | | +| pcfIpEndPoints | array(IpEndPoint) | O | 1..N | IP end points of the PCF handling the MBS Session.

(NOTE) | | + +NOTE: At least one of the "pcfFqdn" attribute or the "pcfIpEndPoints" attribute shall be present. + +### 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: BindingLevel + +**Table 5.6.3.3-1: Enumeration BindingLevel** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------|---------------| +| NF_SET | Indicates the NF set level of binding. | | +| NF_INSTANCE | Indicates the NF instance level of binding. | | + +#### 5.6.3.4 Void + +#### 5.6.3.5 Enumeration: BsfEvent + +**Table 5.6.3.5-1: Enumeration BsfEvent** + +| Enumeration value | Description | Applicability | +|----------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| PCF_PDU_SESSION_BINDING_REGISTRATION | Indicates the binding of a PCF for a PDU session is registered. | | +| PCF_PDU_SESSION_BINDING_DEREGISTRATION | Indicates the binding of a PCF for a PDU session is deregistered. | | +| PCF_UE_BINDING_REGISTRATION | Indicates the binding of a PCF for a UE is registered. | | +| PCF_UE_BINDING_DEREGISTRATION | Indicates the binding of a PCF for a UE is deregistered. | | +| SNSSAI_DNN_BINDING_REGISTRATION | Indicates the binding of a PCF for a PDU session corresponding to the first PDU session for a DNN and S-NSSAI combination is registered. | | +| SNSSAI_DNN_BINDING_DEREGISTRATION | Indicates the binding of a PCF for a PDU session corresponding to the last PDU session for a DNN and S-NSSAI combination is deregistered. | | + +### 5.6.4 Data types describing alternative data types or combinations of data types + +#### 5.6.4.1 Type: BsfSubscriptionResp + +**Table 5.6.4.1-1: Definition of type BsfSubscriptionResp as a list of non-exclusive alternatives** + +| Data type | Cardinality | Description | Applicability | +|-----------------|-------------|--------------------------------------------------------------------------------------------------------------------------------------|---------------| +| BsfNotification | 0..1 | It represents the notification of a match event during the creation or modification of the Individual Binding Subscription resource. | | +| BsfSubscription | 1 | It represents the Individual PCFBinding Subscription resource. | | + +## 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 [6]. + +For the Nbsf\_Management Service API, HTTP error responses shall be supported as specified in clause 4.8 of 3GPP TS 29.501 [7]. Protocol errors and application errors specified in table 5.2.7.2-1 of 3GPP TS 29.500 [6] 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 [6]. + +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 Nbsf\_Management Service API. + +### 5.7.3 Application Errors + +The application errors defined for the Nbsf\_Management Service API are listed in table 5.7.3-1. + +**Table 5.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|--------------------------------------------------------------------------------------------------------------------------------------------| +| MULTIPLE_BINDING_INFO_FOUND | 400 Bad Request | Indicates that the BSF found more than one binding resource so it cannot provide the selected PCF to the consumer. (NOTE 1) | +| EXISTING_BINDING_INFO_FOUND | 403 Forbidden | Indicates that the BSF found an existing PCF binding information for the indicated combination or for the applicable MBS Session. (NOTE 2) | +| NOTE 1: This application error is included in the responses to the GET request. | | | +| NOTE 2: This application error is included in the responses to the POST request. | | | +| NOTE 3: 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 Nbsf\_Management Service API. They shall be negotiated using the extensibility mechanism defined in clause 6.6 of 3GPP TS 29.500 [6]. + +Table 5.8-1: Supported Features + +| Feature number | Feature Name | Description | +|----------------|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 1 | MultiUeAddr | This feature indicates the support of multiple UE addresses (IPv6 prefixes or MAC addresses) in the same binding information. | +| 2 | BindingUpdate | The consumer can use this feature for updating the session binding information. | +| 3 | SamePcf | This feature indicates the support of same PCF selection for the indicated combination.
(NOTE) | +| 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 [6] and according to HTTP redirection principles for indirect communication, as specified in clause 6.10.9 of 3GPP TS 29.500 [6]. | +| 5 | ExtendedSamePcf | This feature extends the support of same PCF selection for the indicated combination. This feature requires the support of SamePcf feature.
(NOTE) | +| 6 | AddSnssaiDnnPair | This feature indicates the support of additional S-NSSAI and DNN pair(s) for which the binding event report(s) apply. | +| 7 | 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 BSF. | + +NOTE: The "SamePcf" feature is applicable to the deployments where the N5 and/or Rx interface apply and the UE address is available in the PCF at the creation of the SM Policy Association. The "ExtendedSamePcf" feature is applicable for any PCF deployment, regardless of UE address availability at the creation of SM Policy association and/or N5 and/or Rx applicability. + +## 5.9 Security + +As indicated in 3GPP TS 33.501 [15] and 3GPP TS 29.500 [6], the access to the Nbsf\_Management API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [16]), based on local configuration, using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [12]) plays the role of the authorization server. + +If OAuth2 is used, a n NF Service Consumer, prior to consuming services offered by the Nbsf\_Management API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [12], 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 Nbsf\_Management service. + +The Nbsf\_Management API defines a single scope "nbsf-management" 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 [11] specification of HTTP messages and content bodies used by the Nbsf\_Management 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 [18] and clause 5.3.1 of the 3GPP TS 29.501 [7] for further information). + +## --- A.2 Nbsf\_Management API + +``` +openapi: 3.0.0 + +info: + version: 1.4.0-alpha.3 + title: Nbsf_Management + description: | + Binding Support Management Service API. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.521 V18.2.0; 5G System; Binding Support Management Service. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.521/' + +servers: + - url: '{apiRoot}/nbsf-management/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nbsf-management + +paths: + /pcfBindings: + post: + summary: Create a new Individual PCF for a PDU Session binding information + operationId: CreatePCFBinding + tags: + - PCF Bindings (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcfBinding' + responses: + '201': + description: The creation of an individual PCF for a PDU Session binding. + content: + application/json: + schema: +``` + +``` + $ref: '#/components/schemas/PcfBinding' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nbsf-management/{apiVersion}/pcf-mbs-bindings/{bindingId} + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: > + The existing PCF binding information stored in the BSF for the indicated combination is + returned. + + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtProblemDetails' + '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' + +get: + summary: Read PCF for a PDU Session Bindings information + operationId: GetPCFBindings + tags: + - PCF Bindings (Collection) + parameters: + - name: ipv4Addr + in: query + description: The IPv4 Address of the served UE. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + - name: ipv6Prefix + in: query + description: > + The IPv6 Address of the served UE. The NF service consumer shall append '/128' to the + IPv6 address in the attribute value. E.g. '2001:db8:85a3::8a2e:370:7334/128'. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + - name: macAddr48 + in: query + description: The MAC Address of the served UE. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + - name: dnn + in: query + description: DNN. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + - name: supi + in: query + description: Subscription Permanent Identifier. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +``` + +``` +- name: gpsi + in: query + description: Generic Public Subscription Identifier + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' +- name: snssai + in: query + description: The identification of slice. + required: false + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' +- name: ipDomain + in: query + description: The IPv4 address domain identifier. + required: false + schema: + type: string +- name: supp-feat + in: query + description: To filter irrelevant responses related to unsupported features. + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: > + The individual PCF for a PDU Session binding session binding information resource + matching the query parameter(s) is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PcfBinding' + '204': + description: > + There is no PCF for a PDU Session binding information matching the query parameter(s). + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/pcfBindings/{bindingId}: + delete: + summary: Delete an existing Individual PCF for a PDU Session Binding information + operationId: DeleteIndPCFBinding + tags: + - Individual PCF Binding (Document) + parameters: + - name: bindingId + in: path + description: Represents the individual PCF for a PDU Session Binding. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual PCF for a PDU Session Binding information resource is + 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' +patch: + summary: Update an existing Individual PCF for a PDU Session Binding information + operationId: UpdateIndPCFBinding + tags: + - Individual PCF for a PDU Session Binding (Document) + parameters: + - name: bindingId + in: path + description: Represents the individual PCF for a PDU Session Binding. + required: true + schema: + type: string + requestBody: + description: Parameters to update the existing PCF for a PDU Session binding. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PcfBindingPatch' + responses: + '200': + description: OK (Successful update of the PCF for a PDU Session binding). + content: + application/json: + schema: + $ref: '#/components/schemas/PcfBinding' + '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: +``` + +``` + +post: + operationId: CreateIndividualSubscription + summary: Create an individual subscription for event notifications from the BSF + tags: + - Subscriptions (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BsfSubscription' + responses: + '201': + description: Created. + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nsmf-management//subscriptions/{subId} + required: true + schema: + type: string + content: + application/json: + schema: + $ref: '#/components/schemas/BsfSubscriptionResp' + '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: + myNotification: + '{$request.body#/notifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BsfNotification' + 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' + +``` + +``` + $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/{subId}: + put: + operationId: ReplaceIndividualSubscription + summary: Replace an individual subscription for event notifications from the BSF + tags: + - IndividualSubscription (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/BsfSubscription' + parameters: + - name: subId + in: path + description: Subscription correlation 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/BsfSubscriptionResp' + '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: + operationId: DeleteIndividualSubscription + summary: Delete an individual subscription for event notifications from the BSF + tags: + - IndividualSubscription (Document) + parameters: + - name: subId + in: path +``` + +``` + description: Subscription correlation 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' + +/pcf-ue-bindings: + post: + summary: Create a new Individual PCF for a UE binding information + operationId: CreatePCFForUEBinding + tags: + - PCF for a UE Bindings (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcfForUeBinding' + responses: + '201': + description: The creation of an individual PCF for a UE binding. + content: + application/json: + schema: + $ref: '#/components/schemas/PcfForUeBinding' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nbsf-management//pcf-ue-bindings/{bindingId} + 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' +get: + summary: Read PCF for a UE Bindings information + operationId: GetPCFForUeBindings + tags: + - PCF for a UE Bindings (Collection) + parameters: + - name: supi + in: query + description: Subscription Permanent Identifier. + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + - name: gpsi + in: query + description: Generic Public Subscription Identifier + required: false + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + - name: supp-feat + in: query + description: To filter irrelevant responses related to unsupported features. + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + responses: + '200': + description: > + The individual PCF for a UE binding session binding information resource matching the + query parameter(s) is returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PcfForUeBinding' + minItems: 0 + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/pcf-ue-bindings/{bindingId}: +delete: + summary: Delete an existing Individual PCF for a UE Binding information + operationId: DeleteIndPCFforUEBinding + tags: + - Individual PCF for a UE Binding (Document) + parameters: + - name: bindingId + in: path + description: Represents the individual PCF for a UE Binding. + required: true + schema: + type: string + responses: + '204': + description: > + No Content. The Individual PCF for a UE binding information resource is 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' +patch: + summary: Update an existing Individual PCF for a UE Binding information + operationId: UpdateIndPCFforUEBinding + tags: + - Individual PCF for a UE Binding (Document) + parameters: + - name: bindingId + in: path + description: Represents the individual PCF for a UE Binding. + required: true + schema: + type: string + requestBody: + description: Parameters to update the existing PCF for a UE binding. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PcfForUeBindingPatch' + responses: + '200': + description: OK. Successful update of the PCF for a PDU Session binding. + content: + application/json: + schema: + $ref: '#/components/schemas/PcfForUeBinding' + '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' + +/pcf-mbs-bindings: +``` + +``` +post: + summary: Create a new Individual PCF for an MBS Session binding. + operationId: CreatePCFMbsBinding + tags: + - PCF for an MBS Session Bindings (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcfMbsBinding' + responses: + '201': + description: > + Created. A new Individual PCF for an MBS Session Binding resource is created + and the corresponding URI is returned in an HTTP Location header. + content: + application/json: + schema: + $ref: '#/components/schemas/PcfMbsBinding' + headers: + Location: + description: > + Contains the URI of the newly created resource, according to the structure + {apiRoot}/nbsf-management/v1/pcf-mbs-bindings/{bindingId} + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: > + The existing PCF binding information stored in the BSF for the MBS session is + returned. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/MbsExtProblemDetails' + '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' + +get: + summary: Retrieve an existing PCF for an MBS Session binding. + operationId: GetPCFMbsBinding + tags: + - PCF for an MBS Session Bindings (Collection) + parameters: + - name: mbs-session-id + in: query + description: > + Contains the identifier of the MBS Session to which the requested MBS Session + binding is related. + required: true + content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + - name: supp-feat + in: query +``` + +``` +description: > + Contains the list of features supported by the NF service consumer and used to + filter irrelevant responses related to unsupported features. +content: + application/json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +responses: + '200': + description: > + OK. The Individual PCF for an MBS Session Binding resource(s) matching the provided + query parameter(s) are returned. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/PcfMbsBinding' + minItems: 0 + '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: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +/pcf-mbs-bindings/{bindingId}: + parameters: + - name: bindingId + in: path + description: > + Represents the identifier of the Individual PCF for an MBS Session Binding resource. + required: true + schema: + type: string + + patch: + summary: Request the modification of an existing Individual PCF for an MBS Session Binding + resource. + operationId: ModifyIndPCFMbsBinding + tags: + - Individual PCF for an MBS Session Binding (Document) + requestBody: + description: Parameters to request the modification of the PCF for an MBS Session Binding. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PcfMbsBindingPatch' + responses: + '200': + description: > + OK. The Individual PCF for an MBS Session Binding resource is successfully modified and + a representation of the updated resource is returned in the response body. + content: + application/json: + schema: + $ref: '#/components/schemas/PcfMbsBinding' + '204': + description: > + No Content. The Individual PCF for an MBS Session Binding resource is successfully + modified and no content is returned in the response body. +``` + +``` +'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: Request the deletion of an existing Individual PCF for an MBS Session Binding. + operationId: DeleteIndPCFMbsBinding + tags: + - Individual PCF for an MBS Session Binding (Document) + responses: + '204': + description: > + No Content. The Individual PCF for an MBS Session Binding resource is 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: + nbsf-management: Access to the Nbsf_Management API + + schemas: + + PcfBinding: + description: Identifies an Individual PCF for a PDU Session binding. + type: object +``` + +``` +properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + addIpv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + description: The additional IPv6 Address Prefixes of the served UE. + ipDomain: + type: string + macAddr48: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + addMacAddrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + minItems: 1 + description: The additional MAC Addresses of the served UE. + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + 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 + pcfDiamHost: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + pcfDiamRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + pcfSmFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfSmIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_SMPolicyControl service. + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + paraCom: + $ref: '#/components/schemas/ParameterCombination' + bindLevel: + $ref: '#/components/schemas/BindingLevel' + 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 + required: + - dnn + - snssai + +PcfBindingPatch: + description: Identifies an Individual PCF binding used in an HTTP Patch method. + type: object +``` + +``` +properties: + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrRm' + ipDomain: + type: string + nullable: true + ipv6Prefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6PrefixRm' + addIpv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + description: The additional IPv6 Address Prefixes of the served UE. + nullable: true + macAddr48: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48Rm' + addMacAddrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + minItems: 1 + description: The additional MAC Addresses of the served UE. + nullable: true + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + 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. + pcfDiamHost: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + pcfDiamRealm: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DiameterIdentity' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +ParameterCombination: + description: > + Represents the combination used by the BSF to check whether there is an existing PCF binding + information. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +ExtProblemDetails: + description: > + Contains the FQDN or IP endpoints of the existing PCF and the cause value if there is an + existing PCF binding information for the indicated combination. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/BindingResp' + +MbsExtProblemDetails: + description: > + Contains the FQDN or IP endpoints of the existing PCF and the cause value if there is an + existing PCF binding information for the MBS session. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - $ref: '#/components/schemas/MbsBindingResp' + +BindingResp: + description: Contains the binding information for a PCF for a PDU Session. + type: object + properties: + pcfSmFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfSmIpEndPoints: + type: array +``` + +``` + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_SMPolicyControl service. + +MbsBindingResp: + description: Contains the binding information for a PCF for an MBS Session. + 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 handling the MBS Session. + anyOf: + - required: [pcfFqdn] + - required: [pcfIpEndPoints] + +BsfSubscription: + description: Contains the event subscription data. + type: object + properties: + events: + type: array + items: + $ref: '#/components/schemas/BsfEvent' + minItems: 1 + description: Contain te subscribed events. + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorreId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssaiDnnPairs: + $ref: '#/components/schemas/SnssaiDnnPair' + addSnssaiDnnPairs: + type: array + items: + $ref: '#/components/schemas/SnssaiDnnPair' + minItems: 1 + description: > + Represents the additional S-NSSAI and DNN pair(s) for which the binding event report(s) + shall apply. + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - events + - notifUri + - notifCorreId + - supi + +BsfNotification: + description: Contains the event notifications. + type: object + properties: + notifCorreId: + type: string + description: Notification Correlation ID assigned by the NF service consumer. + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + bindLevel: + $ref: '#/components/schemas/BindingLevel' + eventNotifs: + type: array + items: + $ref: '#/components/schemas/BsfEventNotification' + minItems: 1 + description: Notifications about Individual Events. + required: +``` + +``` +- notifCorreId +- eventNotifs + +BsfEventNotification: + description: Contains an event notification. + type: object + properties: + event: + $ref: '#/components/schemas/BsfEvent' + pcfForUeInfo: + $ref: '#/components/schemas/PcfForUeInfo' + pcfForPduSessInfos: + type: array + items: + $ref: '#/components/schemas/PcfForPduSessionInfo' + minItems: 1 + description: The information of the PCF for a PDU session. + matchSnssaiDnns: + type: array + items: + $ref: '#/components/schemas/SnssaiDnnPair' + minItems: 1 + description: Matching S-NSSAI and DNN pairs. + required: + - event + +PcfForUeInfo: + description: Contains the information of the PCF for a UE. + 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_AmPolicyAuthorization service. + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + bindLevel: + $ref: '#/components/schemas/BindingLevel' + +PcfForPduSessionInfo: + description: Contains the information of the PCF for a PDU session. + type: object + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + 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_AmPolicyAuthorization service. + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrRm' + ipDomain: + type: string + ipv6Prefixes: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + description: The IPv6 Address Prefixes of the served UE. + macAddrs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + minItems: 1 + description: The MAC Addresses of the served UE. + pcfId: +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + bindLevel: + $ref: '#/components/schemas/BindingLevel' + required: + - snssai + - dnn + +PcfForUeBinding: + description: Identifies an Individual PCF for a UE binding. + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pcfForUeFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfForUeIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_AmPolicyAuthorization service. + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + bindLevel: + $ref: '#/components/schemas/BindingLevel' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supi + anyOf: + - required: [pcfForUeFqdn] + - required: [pcfForUeIpEndPoints] + +PcfForUeBindingPatch: + description: Identifies the updates of an Individual PCF for a UE binding. + type: object + properties: + pcfForUeFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfForUeIpEndPoints: + type: array + items: + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + description: IP end points of the PCF hosting the Npcf_AmPolicyAuthorization service. + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +SnssaiDnnPair: + description: Contains a S-NSSAI and DNN combination. + type: object + required: + - snssai + - dnn + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + +PcfMbsBinding: + description: Represents an Individual PCF for an MBS Session binding. + type: object + properties: + mbsSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MbsSessionId' + pcfFqdn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Fqdn' + pcfIpEndPoints: + type: array + items: +``` + +``` + $ref: 'TS29510_Nnrf_NFManagement.yaml#/components/schemas/IpEndPoint' + minItems: 1 + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + pcfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + bindLevel: + $ref: '#/components/schemas/BindingLevel' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - mbsSessionId + anyOf: + - required: [pcfFqdn] + - required: [pcfIpEndPoints] + +PcfMbsBindingPatch: + description: > + Represents the requested modification to an Individual PCF for an MBS Session binding. + 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 + pcfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + +BindingLevel: + anyOf: + - type: string + enum: + - NF_SET + - NF_INSTANCE + - 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 binding level. + Possible values are: + - NF_SET: Indicates the NF set level of binding. + - NF_INSTANCE: Indicates the NF instance level of binding. + +BsfEvent: + description: Represents an event to be notified by the BSF. + anyOf: + - type: string + enum: + - PCF_PDU_SESSION_BINDING_REGISTRATION + - PCF_PDU_SESSION_BINDING_DEREGISTRATION + - PCF_UE_BINDING_REGISTRATION + - PCF_UE_BINDING_DEREGISTRATION + - SNSSAI_DNN_BINDING_REGISTRATION + - SNSSAI_DNN_BINDING_DEREGISTRATION + - 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. + +BsfSubscriptionResp: + description: > + It represents a response to a modification or creation request of an Individual Binding + Subscription resource. It may contain the notification of the already met events. + anyOf: + - $ref: '#/components/schemas/BsfSubscription' + - $ref: '#/components/schemas/BsfNotification' +``` + +# --- Annex B (informative): Deployment option to support BSF and DRA coexistence due to network migration + +As described in Annex B of 3GPP TS 23.503 [4], the Diameter Routing Agent (DRA) and the BSF can coexist in an operator's network during the network migration to 5GC. The DRA is described in 3GPP TS 29.213 [14] and can be a service consumer of the Nbsf\_Management service. + +During the Rx session establishment, the DRA can discover the selected PCF for the related subscriber by using the Nbsf\_Management\_Discovery service operation to obtain the related PCF address 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. + +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 C (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|--------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2018-01 | | | | | | TS skeleton of Binding Support Management Service specification | 0.0.0 | +| 2018-01 | | | | | | Inclusion of documents agreed in CT3#94 C3-180301, C3-180191, C3-180192 and C3-180193. | 0.1.0 | +| 2018-03 | | | | | | Inclusion of documents agreed in CT3#95 C3-181350 and C3-181352. | 0.2.0 | +| 2018-04 | | | | | | Inclusion of documents agreed in CT3#96 C3-182424 and C3-182510. | 0.3.0 | +| 2018-05 | | | | | | Inclusion of documents agreed in CT3#97 C3-183287, C3-183500, C3-183881, C3-183502 and C3-183733. | 0.4.0 | +| 2018-06 | CT#80 | CP-181031 | | | | TS sent to plenary for approval. | 1.0.0 | +| 2018-06 | CT#80 | CP-181031 | | | | TS approved by plenary | 15.0.0 | +| 2018-09 | CT#81 | CP-182015 | 0001 | 2 | F | PCF id correction for BSF | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0002 | | F | Reference update: OpenAPI specification | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0004 | 2 | F | Clarification on mandatory HTTP error status codes | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0005 | 6 | B | OpenAPI for TS 29.521 | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0006 | 1 | F | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0007 | 1 | B | Support of IPv4 overlapping | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0008 | | F | Correction of the service name | 15.1.0 | +| 2018-09 | CT#81 | CP-182015 | 0009 | 1 | F | Resource structure presentation | 15.1.0 | +| 2018-12 | CT#82 | CP-183205 | 0011 | | F | Default value for apiRoot Default value for apiRoot | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0012 | | F | Correction to DELETE Method for Nbsf_Management Service API | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0013 | | F | Correction to Typos in URI Paths | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0015 | | F | API version | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0016 | | F | ExternalDocs OpenAPI field | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0017 | | F | Location header field in OpenAPI | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0018 | 1 | F | Security | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0019 | 1 | F | supported content types | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0020 | 2 | F | HTTP Error responses | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0021 | 2 | F | DRA as service consumer | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0023 | | F | Change presence in BSF binding | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0024 | 1 | F | Presence conditions in yaml file | 15.2.0 | +| 2018-12 | CT#82 | CP-183205 | 0025 | 1 | F | Missing 201 response body for POST to /pcfBindings | 15.2.0 | +| 2019-03 | CT#83 | CP-190113 | 0028 | 2 | F | Handling of unsupported query parameter combinations | 15.3.0 | +| 2019-03 | CT#83 | CP-190113 | 0029 | 1 | F | Correction of description of the Nbsf_Management_Register Service and Nbsf_Management_Discovery service operations | 15.3.0 | +| 2019-03 | CT#83 | CP-190113 | 0030 | | F | BSF resource cleanup | 15.3.0 | +| 2019-03 | CT#83 | CP-190113 | 0031 | 1 | F | Formatting of structured data types in query parameters | 15.3.0 | +| 2019-03 | CT#83 | CP-190113 | 0032 | 1 | F | Correction on the handling of UE addresses | 15.3.0 | +| 2019-03 | CT#83 | CP-190110 | 0033 | 2 | F | Miscellaneous BSF correction | 15.3.0 | +| 2019-03 | CT#83 | CP-190140 | 0034 | 1 | F | OpenAPI Version number update | 15.3.0 | +| 2019-06 | CT#84 | CP-191079 | 0036 | | F | Remove NSI ID | 15.4.0 | +| 2019-06 | CT#84 | CP-191106 | 0037 | 5 | B | Support multiple UE addresses in one binding | 16.0.0 | +| 2019-06 | CT#84 | CP-191106 | 0038 | 5 | B | Binding update support | 16.0.0 | +| 2019-06 | CT#84 | CP-191079 | 0039 | 1 | F | Precedence of OpenAPI file | 15.4.0 | +| 2019-06 | CT#84 | CP-191079 | 0040 | 1 | F | Copyright Note in YAML files | 15.4.0 | +| 2019-06 | CT#84 | CP-191089 | 0041 | 1 | F | Correction of Location header in Nbsf_Management OpenAPI | 16.0.0 | +| 2019-06 | CT#84 | CP-191101 | 0043 | 2 | F | OpenAPI version number update | 16.0.0 | +| 2019-09 | CT#85 | CP-192199 | 0045 | 2 | F | Session binding for IPv6 addresses | 16.1.0 | +| 2019-09 | CT#85 | CP-192156 | 0046 | | F | Support multiple UE addresses in BSF | 16.1.0 | +| 2019-09 | CT#85 | CP-192152 | 0047 | 1 | B | IP address handling in wireline access | 16.1.0 | +| 2019-09 | CT#85 | CP-192234 | 0050 | 2 | F | OpenAPI version update TS 29.521 Rel-16 | 16.1.0 | +| 2019-12 | CT#86 | CP-193197 | 0053 | 3 | B | Same PCF selection for the same UE ID, S-NSSAI and DNN combination | 16.2.0 | +| 2019-12 | CT#86 | CP-193197 | 0054 | | F | Update of API version and TS version in OpenAPI file | 16.2.0 | +| 2020-03 | CT#87e | CP-200207 | 0055 | 1 | B | Update of the same PCF selection | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0056 | | B | DNN Clarification | 16.3.0 | +| 2020-03 | CT#87e | CP-200208 | 0058 | 2 | B | Adding NWDAF as Nbsf_management service consumer | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0059 | | F | Resolve editor note for PATCH | 16.3.0 | +| 2020-03 | CT#87e | CP-200207 | 0060 | 1 | F | Miscellaneous errors | 16.3.0 | +| 2020-03 | CT#87e | CP-200253 | 0061 | 1 | F | Support of the Update service operation | 16.3.0 | +| 2020-03 | CT#87e | CP-200214 | 0062 | | F | OpenAPI: usage of the "tags" keyword | 16.3.0 | +| 2020-03 | CT#87e | CP-200260 | 0063 | 1 | B | PCF set Id/PCF Id in Nbsf_Management_Register/Update | 16.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------------|--------| +| 2020-03 | CT#87e | CP-200215 | 0064 | | F | Correction on PcfBinding | 16.3.0 | +| 2020-03 | CT#87e | CP-200216 | 0065 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.3.0 | +| 2020-06 | CT#88e | CP-201233 | 0066 | 1 | F | Corrections on SamePcf | 16.4.0 | +| 2020-06 | CT#88e | CP-201246 | 0067 | 1 | F | Corrections related to UEaddr | 16.4.0 | +| 2020-06 | CT#88e | CP-201259 | 0068 | 3 | B | Update of PCF address(es) | 16.4.0 | +| 2020-06 | CT#88e | CP-201275 | 0069 | 2 | B | Clarification of the DS-TT MAC address | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0070 | 3 | B | Support of full Frame Routing feature | 16.4.0 | +| 2020-06 | CT#88e | CP-201212 | 0071 | 1 | F | Binding information retrieval: PCF set ID and PCF instance ID | 16.4.0 | +| 2020-06 | CT#88e | CP-201296 | 0073 | 2 | F | Correct use of application error | 16.4.0 | +| 2020-06 | CT#88e | CP-201228 | 0074 | 1 | F | Correct IPv6 prefix | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0076 | 1 | F | Storage of YAML files in ETSI Forge | 16.4.0 | +| 2020-06 | CT#88e | CP-201246 | 0080 | 1 | F | Adding DRA as Nbsf_management service consumer | 16.4.0 | +| 2020-06 | CT#88e | CP-201258 | 0081 | 1 | B | Update of PCF address(es) | 16.4.0 | +| 2020-06 | CT#88e | CP-201256 | 0083 | 1 | F | URI of the Nbsf_Management service | 16.4.0 | +| 2020-06 | CT#88e | CP-201222 | 0085 | 1 | A | Correction to the condition of BSF service operations | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0086 | 1 | F | Optionality of ProblemDetails | 16.4.0 | +| 2020-06 | CT#88e | CP-201233 | 0087 | 1 | F | suppFeat attribute within PcfBinding data | 16.4.0 | +| 2020-06 | CT#88e | CP-201244 | 0088 | 1 | F | Supported headers, Resource Data type and yaml mapping | 16.4.0 | +| 2020-06 | CT#88e | CP-201255 | 0090 | | F | Update of OpenAPI version and TS version in externalDocs field | 16.4.0 | +| 2020-09 | CT#89e | CP-202077 | 0092 | | F | Data type corrections | 16.5.0 | +| 2020-12 | CT#90e | CP-203139 | 0093 | 1 | F | Essential Corrections and alignments | 16.6.0 | +| 2021-03 | CT#91e | CP-210191 | 0094 | 1 | F | Support of stateless NFs | 16.7.0 | +| 2021-03 | CT#91e | CP-210202 | 0095 | | F | Correction to Framed Routing feature | 16.7.0 | +| 2021-03 | CT#91e | CP-210217 | 0096 | | F | Storage of YAML files in ETSI Forge | 16.7.0 | +| 2021-03 | CT#91e | CP-210205 | 0098 | 1 | F | Correction to SamePcf feature | 16.7.0 | +| 2021-03 | CT#91e | CP-210219 | 0097 | | F | Adding some missing description fields to data type definitions in OpenAPI specification files | 17.0.0 | +| 2021-03 | CT#91e | CP-210221 | 0099 | 1 | F | OpenAPI reference | 17.0.0 | +| 2021-03 | CT#91e | CP-210240 | 0102 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.0.0 | +| 2021-06 | CT#92e | CP-211234 | 0103 | 1 | F | Support of optional HTTP custom header fields | 17.1.0 | +| 2021-06 | CT#92e | CP-211219 | 0105 | | A | Correction to Overview and Introduction | 17.1.0 | +| 2021-06 | CT#92e | CP-211200 | 0107 | 1 | A | Redirect responses with "application/json" media type | 17.1.0 | +| 2021-06 | CT#92e | CP-211219 | 0109 | 1 | A | Correction to ExtendedSamePcf feature | 17.1.0 | +| 2021-06 | CT#92e | CP-211265 | 0111 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.1.0 | +| 2021-09 | CT#93e | CP-212225 | 0113 | 1 | B | Subscription to notification of PCF registration | 17.2.0 | +| 2021-09 | CT#93e | CP-212224 | 0114 | | F | Correcting CR #0107 implementation | 17.2.0 | +| 2021-09 | CT#93e | CP-212225 | 0115 | 1 | B | DCAMP related update of BSF services | 17.2.0 | +| 2021-09 | CT#93e | CP-212225 | 0116 | 1 | B | DCAMP related updates in the resource structure | 17.2.0 | +| 2021-09 | CT#93e | CP-212225 | 0119 | 1 | B | Registration and Deregistration of the PCF for a UE | 17.2.0 | +| 2021-09 | CT#93e | CP-212225 | 0120 | 1 | B | DCAMP related updates in the OpenAPI file | 17.2.0 | +| 2021-09 | CT#93e | CP-212223 | 0121 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.2.0 | +| 2021-12 | CT#94e | CP-213194 | 0122 | | F | Correction to PCF for a UE binding update procedure | 17.3.0 | +| 2021-12 | CT#94e | CP-213194 | 0123 | 1 | B | Subscription to PCF registration/deregistration events for multiple DNN and SNNSAI | 17.3.0 | +| 2021-12 | CT#94e | CP-213234 | 0124 | | B | Update of BSF NF service consumers | 17.3.0 | +| 2021-12 | CT#94e | CP-213234 | 0125 | | B | Clarification to the registered UE address for TSN and non-TSN scenarios. | 17.3.0 | +| 2021-12 | CT#94e | CP-213239 | 0126 | | F | Aligning API URI with SBI template | 17.3.0 | +| 2021-12 | CT#94e | CP-213200 | 0130 | 1 | B | Discover a PCF for a UE | 17.3.0 | +| 2021-12 | CT#94e | CP-213224 | 0132 | | A | Correction to PCF Session binding update procedure | 17.3.0 | +| 2021-12 | CT#94e | CP-213239 | 0135 | 1 | F | Naming Convention | 17.3.0 | +| 2021-12 | CT#94e | CP-213246 | 0136 | | F | Update of OpenAPI version and TS version in externalDocs field | 17.3.0 | +| 2022-03 | CT#95e | CP-220197 | 0137 | 1 | B | Completion of subscription to notification of PCF registration | 17.4.0 | +| 2022-03 | CT#95e | CP-220197 | 0138 | 1 | F | Clarification of table 4.2.1-1 | 17.4.0 | +| 2022-03 | CT#95e | CP-220176 | 0139 | 2 | A | Alignment of "Application Errors" clause with SBI TS template | 17.4.0 | +| 2022-03 | CT#95e | CP-220197 | 0140 | | F | Correction of references to the PCF Session binding resource | 17.4.0 | +| 2022-03 | CT#95e | CP-220197 | 0142 | | F | Removal of BindingSubscription data type | 17.4.0 | +| 2022-03 | CT#95e | CP-220194 | 0143 | | F | Update of info and externalDocs fields | 17.4.0 | +| 2022-06 | CT#96 | CP-221159 | 0144 | 1 | F | Correction to subscription procedures | 17.5.0 | +| 2022-06 | CT#96 | CP-221155 | 0145 | 1 | F | Update of Fqdn data type definition | 17.5.0 | +| 2022-06 | CT#96 | CP-221154 | 0146 | | F | Formatting of description fields | 17.5.0 | +| 2022-06 | CT#96 | CP-221155 | 0147 | 1 | F | Update the apiVersion placeholder | 17.5.0 | +| 2022-06 | CT#96 | CP-221151 | 0148 | | F | Update of info and externalDocs fields | 17.5.0 | +| 2022-09 | CT#97e | CP-222125 | 0149 | 1 | F | Correction in the handling of features for Nbsf | 17.6.0 | +| 2022-09 | CT#97e | CP-222125 | 0150 | 2 | F | Routing binding indication in the interactions with the PCF | 17.6.0 | +| 2022-09 | CT#97e | CP-222127 | 0151 | 1 | F | Corrections to Nbsf_Management_Subscribe service operation | 17.6.0 | +| 2022-09 | CT#97e | CP-222127 | 0152 | | F | Corrections to Nbsf_Management_Notify service operation | 17.6.0 | +| 2022-09 | CT#97e | CP-222127 | 0153 | 1 | F | Replacement of subsld with subld | 17.6.0 | +| 2022-09 | CT#97e | CP-222127 | 0154 | | F | Alignment of ipDomain in PcfForPduSessionInfo data type | 17.6.0 | +| 2022-09 | CT#97e | CP-222127 | 0155 | 1 | F | Correction to PCF address in PcfForUeBinding | 17.6.0 | +| 2022-09 | CT#97e | CP-222127 | 0156 | 1 | F | Corrections to UE binding information update procedure | 17.6.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|----------------------------------------------------------------------------------------|--------| +| 2022-09 | CT#97e | CP-222127 | 0157 | | F | incorrect data structure in PUT response for subscription modification | 17.6.0 | +| 2022-09 | CT#97e | CP-222095 | 0158 | 1 | B | Updating the service description clauses to support the PCF for a MBS Session binding | 17.6.0 | +| 2022-09 | CT#97e | CP-222095 | 0159 | 1 | B | Defining the resources part to support the PCF for an MBS Session binding | 17.6.0 | +| 2022-09 | CT#97e | CP-222095 | 0160 | 1 | B | Defining the data model part to support the PCF for an MBS Session binding | 17.6.0 | +| 2022-09 | CT#97e | CP-222208 | 0161 | 1 | B | Updating the OpenAPI description part to support the PCF for an MBS Session binding | 17.6.0 | +| 2022-09 | CT#97e | CP-222121 | 0162 | 1 | F | Update of info and externalDocs fields | 17.6.0 | +| 2022-12 | CT#98e | CP-223167 | 0164 | 1 | F | adding MBSF as a consumer of Nbsf_Management_Discovery service | 17.7.0 | +| 2022-12 | CT#98e | CP-223167 | 0165 | 1 | F | missing MBS session binding functionality related description | 17.7.0 | +| 2022-12 | CT#98e | CP-223167 | 0169 | 1 | F | Correction in Registration of a new PCF for an MBS Session | 17.7.0 | +| 2022-12 | CT#98e | CP-223167 | 0170 | 1 | F | Correction to service description clauses to support the PCF for a MBS Session binding | 17.7.0 | +| 2022-12 | CT#98e | CP-223197 | 0173 | 1 | F | Corrections for Nbsf_Management API | 17.7.0 | +| 2022-12 | CT#98e | CP-223188 | 0174 | | F | Update of info and externalDocs fields | 17.7.0 | +| 2022-12 | CT#98e | CP-223191 | 0163 | | F | Adding the mandatory error code 502 Bad Gateway | 18.0.0 | +| 2022-12 | CT#98e | CP-223200 | 0167 | 3 | F | Update of 4.2.1 to add TSCTSF | 18.0.0 | +| 2022-12 | CT#98e | CP-223192 | 0168 | 1 | F | Indication of API version and BsFEvent enumeration | 18.0.0 | +| 2022-12 | CT#98e | CP-223199 | 0171 | 1 | F | Correction to DNN encoding | 18.0.0 | +| 2022-12 | CT#98e | CP-223189 | 0175 | | F | Update of info and externalDocs fields | 18.0.0 | +| 2023-03 | CT#99 | CP-230166 | 0176 | | F | Correction of the description fields in enumerations | 18.1.0 | +| 2023-03 | CT#99 | CP-230131 | 0178 | 1 | A | Miscellaneous essential corrections to the MBS related procedures | 18.1.0 | +| 2023-03 | CT#99 | CP-230166 | 0179 | | F | Corrections to query parameters not respecting the naming convention | 18.1.0 | +| 2023-03 | CT#99 | CP-230177 | 0180 | | B | Support of IPv6 prefix delegation | 18.1.0 | +| 2023-03 | CT#99 | CP-230161 | 0181 | | F | Update of info and externalDocs fields | 18.1.0 | +| 2023-06 | CT#100 | CP-231133 | 0182 | 1 | F | Corrections related to DCAMP | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 0183 | | F | Missing description of 404 Not Found in procedures | 18.2.0 | +| 2023-06 | CT#100 | CP-231131 | 0184 | 2 | F | Missing description of HTTP redirect response for 5MBS | 18.2.0 | +| 2023-06 | CT#100 | CP-231152 | 0185 | 1 | B | updating the S-NSSAI of the session binding information | 18.2.0 | +| 2023-06 | CT#100 | CP-231133 | 0187 | 1 | F | Error response for BSF notification | 18.2.0 | +| 2023-06 | CT#100 | CP-231179 | 0189 | 1 | A | Adding 5G DDNMF as consumer | 18.2.0 | +| 2023-06 | CT#100 | CP-231132 | 0190 | 1 | F | Corrections to the redirection mechanism description | 18.2.0 | +| 2023-06 | CT#100 | CP-231141 | 0191 | | F | Update of info and externalDocs fields | 18.2.0 | +| 2023-12 | CT#102 | CP-233250 | 0192 | 1 | F | feature naming for network slice replacement | 18.3.0 | +| 2023-12 | CT#102 | CP-233229 | 0194 | 1 | F | IETF RFC 7540 and 9457 obsoleted by RFC 9113 and 7807 | 18.3.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29526/raw.md b/marked/Rel-18/29_series/29526/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..3df460ad87c83dbc426043a3596b60f126b80edd --- /dev/null +++ b/marked/Rel-18/29_series/29526/raw.md @@ -0,0 +1,2412 @@ + + +# 3GPP TS 29.526 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Network Slice-Specific and SNPN Authentication and Authorization 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 'P' has a red signal wave icon at its base. + +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 ..... | 6 | +| 1 Scope..... | 8 | +| 2 References..... | 8 | +| 3 Definitions, abbreviations ..... | 9 | +| 3.1 Definitions..... | 9 | +| 3.2 Abbreviations ..... | 9 | +| 4 Overview..... | 9 | +| 4.1 Introduction ..... | 9 | +| 5 Services offered by the NSSAAF ..... | 10 | +| 5.1 Introduction ..... | 10 | +| 5.2 NnssAAF_NSSAA Service..... | 10 | +| 5.2.1 Service Description ..... | 10 | +| 5.2.2 Service Operations..... | 10 | +| 5.2.2.1 Introduction..... | 10 | +| 5.2.2.2 Authenticate ..... | 11 | +| 5.2.2.2.1 General ..... | 11 | +| 5.2.2.3 Re-Authentication Notification..... | 13 | +| 5.2.2.3.1 General ..... | 13 | +| 5.2.2.4 Revocation Notification..... | 15 | +| 5.2.2.4.1 General ..... | 15 | +| 5.3 NnssAAF_AIW Service..... | 16 | +| 5.3.1 Service Description ..... | 16 | +| 5.3.2 Service Operations..... | 16 | +| 5.3.2.1 Introduction..... | 16 | +| 5.3.2.2 Authenticate ..... | 16 | +| 5.3.2.2.1 General ..... | 16 | +| 6 API Definitions ..... | 18 | +| 6.1 NnssAAF_NSSAA Service API ..... | 18 | +| 6.1.1 Introduction ..... | 18 | +| 6.1.2 Usage of HTTP..... | 19 | +| 6.1.2.1 General..... | 19 | +| 6.1.2.2 HTTP standard headers..... | 19 | +| 6.1.2.2.1 General ..... | 19 | +| 6.1.2.2.2 Content type ..... | 19 | +| 6.1.2.3 HTTP custom headers..... | 19 | +| 6.1.3 Resources..... | 19 | +| 6.1.3.1 Overview..... | 19 | +| 6.1.3.2 Resource: slice-authentications (Collection) ..... | 20 | +| 6.1.3.2.1 Description ..... | 20 | +| 6.1.3.2.2 Resource Definition..... | 20 | +| 6.1.3.2.3 Resource Standard Methods..... | 20 | +| 6.1.3.2.4 Resource Custom Operations..... | 22 | +| 6.1.3.3 Resource: slice-authentication (Document)..... | 22 | +| 6.1.3.3.1 Description ..... | 22 | +| 6.1.3.3.2 Resource Definition..... | 22 | +| 6.1.3.3.3 Resource Standard Methods..... | 22 | +| 6.1.3.3.4 Resource Custom Operations..... | 24 | +| 6.1.4 Custom Operations without associated resources ..... | 24 | +| 6.1.4.1 Overview..... | 24 | +| 6.1.5 Notifications ..... | 24 | +| 6.1.5.1 General..... | 24 | +| 6.1.5.2 Re-authentication Notification..... | 24 | +| 6.1.5.2.1 Description ..... | 24 | +| 6.1.5.2.2 Target URI..... | 24 | + +| | | | +|-----------|----------------------------------------------------------------------------------|----| +| 6.1.5.2.3 | Standard Methods..... | 24 | +| 6.1.5.3 | Revocation Notification..... | 25 | +| 6.1.5.3.1 | Description ..... | 25 | +| 6.1.5.3.2 | Target URI..... | 25 | +| 6.1.5.3.3 | Standard Methods..... | 25 | +| 6.1.6 | Data Model ..... | 26 | +| 6.1.6.1 | General ..... | 26 | +| 6.1.6.2 | Structured data types..... | 27 | +| 6.1.6.2.1 | Introduction ..... | 27 | +| 6.1.6.2.2 | Type: SliceAuthInfo..... | 28 | +| 6.1.6.2.3 | Type: SliceAuthContext..... | 28 | +| 6.1.6.2.4 | Type: SliceAuthConfirmationData ..... | 28 | +| 6.1.6.2.5 | Type: SliceAuthConfirmationResponse..... | 29 | +| 6.1.6.2.6 | Type: SliceAuthReauthNotification..... | 29 | +| 6.1.6.2.7 | Type: SliceAuthRevocNotification..... | 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: SliceAuthNotificationType..... | 29 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 30 | +| 6.1.6.5 | Binary data ..... | 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 | +| 6.2 | Nnssaaaf_AIW Service API..... | 31 | +| 6.2.1 | Introduction ..... | 31 | +| 6.2.2 | Usage of HTTP..... | 32 | +| 6.2.2.1 | General ..... | 32 | +| 6.2.2.2 | HTTP standard headers..... | 32 | +| 6.2.2.2.1 | General ..... | 32 | +| 6.2.2.2.2 | Content type ..... | 32 | +| 6.2.2.3 | HTTP custom headers..... | 32 | +| 6.2.3 | Resources..... | 32 | +| 6.2.3.1 | Overview..... | 32 | +| 6.2.3.2 | Resource: authentications (Collection)..... | 33 | +| 6.2.3.2.1 | Description ..... | 33 | +| 6.2.3.2.2 | Resource Definition..... | 33 | +| 6.2.3.2.3 | Resource Standard Methods..... | 33 | +| 6.2.3.3 | Resource: authentication (Document) ..... | 35 | +| 6.2.3.3.1 | Description ..... | 35 | +| 6.2.3.3.2 | Resource Definition..... | 35 | +| 6.2.3.3.3 | Resource Standard Methods..... | 35 | +| 6.2.4 | Custom Operations without associated resources ..... | 37 | +| 6.2.5 | Notifications ..... | 37 | +| 6.2.6 | Data Model ..... | 37 | +| 6.2.6.1 | General ..... | 37 | +| 6.2.6.2 | Structured data types..... | 37 | +| 6.2.6.2.1 | Introduction ..... | 37 | +| 6.2.6.2.2 | Type: AuthInfo..... | 38 | +| 6.2.6.2.3 | Type: AuthContext..... | 38 | +| 6.2.6.2.4 | Type: AuthConfirmationData ..... | 38 | +| 6.2.6.2.5 | Type: AuthConfirmationResponse..... | 39 | +| 6.2.6.3 | Simple data types and enumerations..... | 39 | +| 6.2.6.3.1 | Introduction ..... | 39 | +| 6.2.6.3.2 | Simple data types ..... | 39 | +| 6.2.7 | Error Handling ..... | 39 | +| 6.2.7.1 | General ..... | 39 | +| 6.2.7.2 | Protocol Errors ..... | 39 | + +| | | | +|-------------------------------|------------------------------------|-----------| +| 6.2.7.3 | Application Errors..... | 39 | +| 6.2.8 | Feature negotiation ..... | 40 | +| 6.2.9 | Security ..... | 40 | +| 6.2.10 | HTTP redirection..... | 40 | +| Annex A (normative): | OpenAPI specification ..... | 41 | +| A.1 | General..... | 41 | +| A.2 | Nnssaaaf_NSSAA API ..... | 41 | +| A.3 | Nnssaaaf_AIW API ..... | 46 | +| Annex B (informative): | Change history..... | 50 | + +# 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 NnssAAF Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the NSSAAF. + +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 4648: "The Base16, Base32 and Base64 Data Encodings". +- [15] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [16] 3GPP TS 29.518: "5G System; Access and Mobility Management Services; Stage 3". +- [17] 3GPP TS 29.536: "5G System; Network Slice Admission Control Services; Stage 3". +- [18] 3GPP TS 29.509: "5G System; Authentication Server Services; Stage 3". +- [19] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +# 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]. + +| | | +|--------|---------------------------------------------------------------------------| +| NSSAA | Network Slice-Specific Authentication and Authorization | +| NSSAAF | Network Slice-specific and SNPN Authentication and Authorization Function | +| SNPN | Standalone Non-Public Network | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the NSSAAF offers services to the AMF and the AUSF via the Nnssaaf service-based interface. + +The AMF shall make use of the NSSAAF service when it needs to invoke network slice-specific authentication and authorization for a specific UE and a specific S-NSSAI (see 3GPP TS 23.502 [3] clause 4.2.9.2, and 3GPP TS 33.501 [14] clause 16.2 and 16.3). + +The NSSAAF service shall also be used by the AMF to receive slice re-authentication notification or slice authorization revocation notification sent from the AAA-S (see 3GPP TS 23.502 [3] clause 4.2.9.3, 4.2.9.4 and 3GPP TS 33.501 [14] clause 16.3 and 16.4). + +The AUSF shall make use of the NSSAAF service when it needs to invoke a primary authentication in SNPN with Credentials holder using AAA server; the AUSF shall also make use of this service during the UE onboarding procedure in SNPN scenarios, when the Default Credentials Server (DCS) uses an AAA server for primary authentication. + +Figure 4.1-1 provides the reference model with focus on the NSSAAF. + +![Reference model diagram showing AMF and AUSF connected to NSSAAF via the Nnssaaf interface.](a92b1fdf37a74b707e9f03087c8f1377_img.jpg) + +``` +graph LR; AMF[AMF] --- Nnssaaf((Nnssaaf)); AUSF[AUSF] --- Nnssaaf; Nnssaaf --- NSSAAF[NSSAAF]; style NSSAAF fill:#90EE90,stroke:#000 +``` + +The diagram illustrates the reference model for the NSSAAF. On the left, two rectangular boxes represent the AMF (Access and Management Function) and the AUSF (Authentication Server Function). Lines from both boxes converge to a central point labeled 'Nnssaaf', which is represented by a small circle. From this circle, a line extends to a larger rectangular box on the right labeled 'NSSAAF', which is highlighted with a light green fill. + +Reference model diagram showing AMF and AUSF connected to NSSAAF via the Nnssaaf interface. + +Figure 4.1-1: Reference model – NSSAAF + +# 5 Services offered by the NSSAAF + +## 5.1 Introduction + +The NSSAAF offers the following services via the Nnssaaf interface: + +- Nnssaaf\_NSSAA Service +- Nnssaaf\_AIW 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 | +|---------------|--------|---------------------------------------------------------|----------------------------|---------------|-------| +| Nnssaaf_NSSAA | 5.2 | Slice-specific authentication and authorization service | TS29526_Nnssaaf_NSSAA.yaml | nnssaaf-nssaa | A.2 | +| Nnssaaf_AIW | 5.x | AAA Interworking service | TS29526_Nnssaaf_AIW.yaml | nnssaaf-aiw | A.3 | + +## 5.2 Nnssaaf\_NSSAA Service + +### 5.2.1 Service Description + +The Nnssaaf\_NSSAA service provides slice-specific authentication and authorization for a given UE. The NSSAAF is acting as NF Service Producer, while the AMF is the NF Service Consumer. + +Following functionalities are provided by the Nnssaaf\_NSSAA service: + +- Perform slice-specific authentication and authorization for a given UE; +- Trigger slice-specific re-authentication to a given UE; +- Revoke the slice-specific authentication and authorization for a given UE. + +The Nnssaaf\_NSSAA service supports the following service operations. + +**Table 5.2.1-1: Service operations supported by the Nnssaaf\_NSSAA service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------------------|----------------------------------------------------------------------------------------------|---------------------|---------------------| +| Authenticate | Perform slice-specific authentication and authorization for a given UE. | Request/Response | AMF | +| Re-Authentication Notification | Request slice-specific re-authentication and re-authorization for a given UE. | Callback | AMF | +| Revocation Notification | Request revocation of slice-specific authentication and authorization result for a given UE. | Callback | AMF | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +See Table 5.2.1-1 for an overview of the service operations supported by the Nnssaaf\_NSSAA service. + +#### 5.2.2.2 Authenticate + +##### 5.2.2.2.1 General + +The Authenticate service operation permits the NF Service Consumer (i.e. the AMF) to initiate slice-specific authentication and authorization, e.g. during a UE Registration procedure or upon reception of a re-authentication notification from the NSSAAF (see clause 5.2.2.3). The NSSAAF may relay the EAP message to an AAA-S and collect the result of slice-specific authentication and authorization from the AAA-S, as specified in clause 4.2.9.2 of 3GPP TS 23.502 [3], and clause 16.3 of 3GPP TS 33.501 [8]. + +The NF Service Consumer (i.e. the AMF) shall send a POST request to the resource representing slice authentication collection (i.e. .../slice-authentications) to request the NSSAAF to create the corresponding resource context and perform slice-specific authentication and authorization. + +![Sequence diagram for Slice-Specific Authentication and Authorization between NF Service Consumer and NSSAAF.](8e14350b4b669119a3bdfca7869110ca_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSAAF + Note right of NSSAAF: AAA-S + Note right of NSSAAF: AAA-S + + Note left of NF Service Consumer: 1. POST .../slice-authentications (SliceAuthInfo) + NF Service Consumer->>NSSAAF: 1. POST .../slice-authentications (SliceAuthInfo) + Note right of NSSAAF: 2. Forward EAP ID to AAA-S + NSSAAF-->>AAA-S: 2. Forward EAP ID to AAA-S + Note right of AAA-S: -3a. 201 Created (SliceAuthContext) + AAA-S-->>NSSAAF: -3a. 201 Created (SliceAuthContext) + Note right of AAA-S: -3b. 4xx/5xx (ProblemDetails) + AAA-S-->>NSSAAF: -3b. 4xx/5xx (ProblemDetails) + Note right of AAA-S: -3c. 3xx (RedirectResponse) + AAA-S-->>NSSAAF: -3c. 3xx (RedirectResponse) + Note left of NF Service Consumer: 4. PUT .../slice-authentications/{authCtxId}/confirmation(SliceAuthConfirmationData) + NF Service Consumer->>NSSAAF: 4. PUT .../slice-authentications/{authCtxId}/confirmation(SliceAuthConfirmationData) + Note right of NSSAAF: 5. Forward EAP message to AAA-S + NSSAAF-->>AAA-S: 5. Forward EAP message to AAA-S + Note right of AAA-S: -6a. 200 OK (SliceAuthConfirmationResponse) + AAA-S-->>NSSAAF: -6a. 200 OK (SliceAuthConfirmationResponse) + Note right of AAA-S: -6b. 4xx/5xx (ProblemDetails) + AAA-S-->>NSSAAF: -6b. 4xx/5xx (ProblemDetails) + Note right of AAA-S: -6c. 3xx (RedirectResponse) + AAA-S-->>NSSAAF: -6c. 3xx (RedirectResponse) + Note left of NF Service Consumer: 7. PUT .../slice-authentications/{authCtxId}/confirmation(SliceAuthConfirmationData) + NF Service Consumer->>NSSAAF: 7. PUT .../slice-authentications/{authCtxId}/confirmation(SliceAuthConfirmationData) + Note right of NSSAAF: 8. Forward EAP message to AAA-S + NSSAAF-->>AAA-S: 8. Forward EAP message to AAA-S + Note right of AAA-S: -9a. 200 OK (SliceAuthConfirmationResponse) + AAA-S-->>NSSAAF: -9a. 200 OK (SliceAuthConfirmationResponse) + Note right of AAA-S: -9b. 4xx/5xx (ProblemDetails) + AAA-S-->>NSSAAF: -9b. 4xx/5xx (ProblemDetails) + Note right of AAA-S: -9c. 3xx (RedirectResponse) + AAA-S-->>NSSAAF: -9c. 3xx (RedirectResponse) + +``` + +Sequence diagram for Slice-Specific Authentication and Authorization between NF Service Consumer and NSSAAF. + +**Figure 5.2.2.2.1-1: Slice-Specific Authentication and Authorization** + +1. The NF Service Consumer (AMF) shall send a POST request to the NSSAAF, targeting the resource of slice authentication collection (i.e. .../slice-authentications), to perform slice-specific authentication and authorization. + +The HTTP content shall contain the slice authentication information, which includes: + +- UE ID (i.e. GPSI), if multiple GPSIs received from the UDM, the NF Service Consumer shall include any one of the GPSIs. +- S-NSSAI +- EAP ID Response message (if it is received from the UE), or the EAP ID Response message with EAP ID stored, or the EAP ID Response message with Null value (if EAP ID is not requested or received); +- optionally, the callback URI of the AMF to receive re-authentication notification from the NSSAAF; + +- optionally, the callback URI of the AMF to receive revocation notification from the NSSAAF. + +Based on local policy, the AMF may determine to provide callback URI(s) for receiving re-authentication notification or revocation notification. For example, the callback URIs are provided for an UE identified with low mobility characteristic. + +If Slice-Specific Authentication and Authorization is triggered by the AMF during a Registration procedure as described in clause 4.2.9.2 of 3GPP TS 23.502 [3], the AMF shall set "status" attribute for the given slice listed in "nssaaStatusList" attribute to "PENDING" (See 3GPP TS 29.518 [16]). + +2. The NSSAAF creates slice authentication context for the UE, and starts the slice-specific authentication and authorization procedure. If the AAA-S is involved in slice-specific authentication and authorization procedure, the NSSAAF shall forward the EAP ID Response message to the AAA-S if the EAP ID Response message does not contain the Null value. Depending on the result, either step 3a or step 3b is performed. The NSSAAF obtains the AAA-S address from local configuration, based on S-NSSAI. +- 3a. On success, "201 Created" shall be returned. The "Location" header shall contain the URI of the created resource (e.g. .../slice-authentications/{authCtxId}). The content shall contain the slice authentication context, which includes the EAP message generated by the NSSAAF or from the AAA-S. The NF Service Consumer (i.e. the AMF) shall forward the received EAP message to the UE in NAS message, as specified in clause 4.2.9.2 of 3GPP TS 23.502 [3]. +- 3b. On failure, one of the HTTP status code listed in Table 6.1.7.3-1 shall be returned. For a 4xx/5xx response, 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. If the slice is not authorized, the NSSAAF shall use the "SLICE\_AUTH\_REJECTED" application error code. +- 3c. 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.2.3.1-3. +4. Once receiving EAP message from the UE, the NF Service Consumer (i.e. the AMF) shall send a PUT request to the NSSAAF, targeting the resource of the slice authentication context (i.e. .../slice-authentications/{authCtxId}). + +The HTTP content shall carry the slice authentication confirmation data which includes: + +- UE ID (i.e. GPSI) +- S-NSSAI +- AAA-S address +- EAP Message (which is received from the UE) + +5. The NSSAAF checks and confirms the slice-specific authentication and authorization. If the AAA-S is involved, the NSSAAF shall forward the EAP Message to the AAA-S to confirm the slice-specific authentication and authorization. Depending on the result, either step 6a or step 6b is performed. +- 6a. On success, "200 OK" shall be returned. The content shall contain the slice authentication confirmation response, which includes the EAP message (e.g. EAP success/failure message) generated by the NSSAAF or from the AAA-S. The NF Service Consumer (i.e. the AMF) shall forward the EAP message to the UE in NAS message. + +If the UE is authenticated, the NSSAAF shall set the "authResult" attribute to "EAP\_SUCCESS". If failed to authenticate the UE, the "authResult" attribute shall be set to "EAP\_FAILURE". + +If subsequent EAP message exchange is needed between the UE and the NSSAAF(AAA-S), the NSSAAF shall not include SliceAuthResult in the response message. + +- 6b. On failure, one of the HTTP status codes listed in Table 6.1.7.3-1 shall be returned. For a 4xx/5xx response, 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. +- 6c. 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.3.1-3. + +- 7-9. If subsequent EAP message exchange is needed between the UE and the NSSAAF to finish the EAP based authentication, step 7-9 are performed. On failure, one of the HTTP status codes listed in Table 6.1.7.3-1 shall be returned. For a 4xx/5xx response, 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. On redirection, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned, and a RedirectResponse IE may be included in the message body, as specified in table 6.1.3.3.1-3. + +In above steps, if the AAA-S is involved in the slice-specific authentication and authorization procedure while there is no expected response from the AAA-S in the case of time out, the NSSAAF shall return HTTP status code "504 Gateway Timeout", with the message body containing a ProblemDetails structure with the "cause" attribute set to "TIMED\_OUT\_REQUEST". + +After the completion of slice-specific authentication and authorization procedure, it is up to implementation whether the NSSAAF stores the slice authentication context and related resources for a configured period, or deletes the context and resource immediately, e.g. depending on the potential need for AAA-S initiated slice-specific re-authentication/revocation notification. + +If the slice-specific authentication and authorization was successful (i.e. "authResult" attribute received from NSSAAF in step 6a is set to "EAP\_SUCCESS"), the AMF shall set "status" attribute for the given slice listed in "nssaaStatusList" attribute to "EAP\_SUCCESS" (see 3GPP TS 29.518 [16]). + +If the slice-specific authentication and authorization finally fails (i.e. "authResult" attribute received from NSSAAF in step 6a is set to "EAP\_FAILURE"), the AMF shall set "status" attribute for the given slice listed in "nssaaStatusList" attribute to "EAP\_FAILURE" (see 3GPP TS 29.518 [16]). In this case, if there are PDU sessions previously established corresponding to the S-NSSAIs required to be authenticated, the AMF should additionally trigger the release of those PDU sessions. + +If the slice-specific authentication and authorization cannot be completed, then: + +- If it is due to receiving a response with HTTP status code "504 Gateway Timeout" or due to lack of response from the NSSAAF during an NSSAA procedure, the AMF may later re-initiate slice-specific authentication and authorization procedure based on its policy. The AMF should wait for a configured period before re-initiating slice-specific authentication and authorization procedure. If the retry attempts are exhausted, the AMF stops the slice-specific authentication and authorization procedure. + +NOTE 1: It is recommended to limit the number of retry attempts as described in 3GPP TS 29.500 [4]. + +- If it is due to the UE becoming unreachable during an NSSAA procedure, the AMF stops the slice-specific authentication and authorization procedure. +- If the AMF stops the slice-specific authentication and authorization procedure (i.e. after exhausting the retry attempts or when the UE becomes unreachable), the AMF shall keep the "status" attribute set to "PENDING", for the given slice(s) listed in "nssaaStatusList" attribute (see 3GPP TS 29.518 [16]). + +NOTE 2: The AMF initiates the slice-specific authentication and authorization for S-NSSAIs in "PENDING" status at next UE uplink activity. + +If an S-NSSAI subject to the NSSAA is rejected due to Network Slice Admission Control as the total number of UEs exceeds the maximum number of UEs allowed to be registered to this slice as specified in clause 5.2.2.2.2 of 3GPP TS 29.536 [17]), the AMF shall keep the "status" attribute stored as not impacted (see clause 4.2.9.1 of 3GPP TS 23.502 [3] and 3GPP TS 29.518 [16]). + +#### 5.2.2.3 Re-Authentication Notification + +##### 5.2.2.3.1 General + +The Re-Authentication Notification service operation shall be used by the NSSAAF to notify the AMF to re-initiate slice-specific authentication and authorization for a given UE, as specified in clause 4.2.9.3 of 3GPP TS 23.502 [3], and clause 16.4 of 3GPP TS 33.501 [8]. + +If there are two different AMFs serving the UE (e.g. the NSSAAF retrieves two different AMFs from the UDM), the NSSAAF may determine to send the re-authentication notification to both AMFs. Or, the NSSAAF may first send re-authentication notification to one of the AMF, and then send revocation notification to another AMF if EAP authentication fails in first AMF. If EAP authentication succeeds in first AMF then NSSAAF does not notify the other AMF. + +Upon receiving the Network Slice-Specific Re-authentication and Re-authorization from an AAA-S, the NSSAAF shall verify whether the AAA-S is authorized to request the procedure, by checking its local configuration. If the AAA-S is authorized to request the re-authentication, the NSSAAF shall notify the NF Service Consumer (i.e. the AMF) by using the HTTP POST method as shown in Figure 5.2.2.3.1-1. + +![Sequence diagram showing the Re-authentication Notification process between an NF Service Consumer and an NSSAAF. The NSSAAF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with one of three possible status codes: 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse).](bd671b21db63e6fdb2196e9b18502aac_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSAAF + Note right of NSSAAF: 1. POST {reauthNotifUri} (SliceAuthReauthNotification) + NSSAAF->>NF Service Consumer: + Note left of NF Service Consumer: -2a. 204 No Content + NF Service Consumer-->>NSSAAF: + Note left of NF Service Consumer: -2b. 4xx/5xx (ProblemDetails) + NF Service Consumer-->>NSSAAF: + Note left of NF Service Consumer: -2c. 3xx (RedirectResponse) + NF Service Consumer-->>NSSAAF: + +``` + +Sequence diagram showing the Re-authentication Notification process between an NF Service Consumer and an NSSAAF. The NSSAAF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with one of three possible status codes: 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails), or 2c. 3xx (RedirectResponse). + +**Figure 5.2.2.3.1-1: Re-authentication Notification** + +1. The NSSAAF shall send a POST request to the callback URI used to receiving re-authentication notification, which is either provided by the NF Service Consumer (i.e. the AMF), or retrieved from the AMF profile stored in the NRF (in default notification subscription for "NSSAA\_REAUTH\_NOTIFICATION" notification type). If the NF Service Consumer is located in a different PLMN (i.e. the AMF in VPLMN for a roaming UE), the NSSAAF shall use the inter-PLMN callback URI to deliver the notification if the inter-PLMN callback URI is present in the default notification subscription. + +The content of the POST request shall contain the SliceAuthReauthNotification data structure, within which: + +- the notificationType set to the SliceAuthNotificationType of "SLICE\_RE\_AUTH"; +- the gpsi set to the GPSI of the given UE required to be re-authenticated; +- the snssai set to the S-NSSAI required to be re-authenticated; +- the supi set to the SUPI of the given UE required to be re-authenticated. + +NOTE: The NSSAAF can obtain the SUPI of the UE in the response of a previous Nudm\_UECM\_Get used by the NSSAAF to retrieve the AMF ID. + +- 2a. On success, "204 No Content" shall be returned and the content of the POST response shall be empty. + +After responding the request, the NF Service Consumer (i.e. the AMF) shall send NAS message to the UE to trigger re-authentication and re-authorization for the given slice. + +The AMF then decides to execute the Slice-Specific Authentication and Authorization if needed as described in clause 5.2.2.2.1. + +If the S-NSSAI is not in the Mapping Of Allowed NSSAI, the AMF removes any status of the corresponding S-NSSAI subject to Slice-Specific Authentication and Authorization in the UE context it may have kept, so that an Slice-Specific Authentication and Authorization procedure is executed next time the UE requests to register with the S-NSSAI. + +- 2b. On failure, one of the HTTP status code (e.g. "404 Not Found") listed in Table 6.1.7.3-1 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, the appropriate HTTP status code (e.g. "307 Temporary Redirect") shall be returned. A RedirectResponse IE may be included in the POST response, as specified in table 6.1.5.2.3.1-2. + +If the NF Service Consumer (i.e. the AMF) is not able to handle the request, but knows that another NF Service Consumer (i.e. the AMF) is able to handle it, it shall reply with an HTTP 3xx redirect response pointing to the URI of the new NF Service Consumer (i.e. the AMF). + +#### 5.2.2.4 Revocation Notification + +##### 5.2.2.4.1 General + +The Revocation Notification service operation shall be used by the NSSAAF to notify the AMF to revoke slice-specific authentication and authorization result, as specified in clause 4.2.9.4 of 3GPP TS 23.502 [3], and clause 16.5 of 3GPP TS 33.501 [8], and may trigger the AMF to release the corresponding PDU sessions associated to the indicated slice. + +If there are two different AMFs serving the UE (e.g. the NSSAAF retrieves two different AMFs from the UDM), the NSSAAF may determine to send revocation notification to both AMFs. + +Upon receiving the Network Slice-Specific Authorization Revocation procedure from an AAA-S, the NSSAAF shall verify whether the AAA-S is authorized to request the procedure, by checking its local configuration. If the AAA-S is authorized to request the revocation, the NSSAAF shall notify the NF Service Consumer (i.e. the AMF) by using the HTTP POST method as shown in Figure 5.2.2.4.1-1. + +![Sequence diagram showing the Revocation Notification process between an NF Service Consumer and an NSSAAF. The NSSAAF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails) or 3xx, or 2c. 3xx (RedirectResponse).](c67d21fb3d9042e88cdc669f071b4e7c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant NSSAAF + Note left of NF Service Consumer: NF Service Consumer + Note right of NSSAAF: NSSAAF + NSSAAF->>NF Service Consumer: 1. POST {revocNotifUri} (SliceAuthRevocNotification) + NF Service Consumer-->>NSSAAF: 2a. 204 No Content + NF Service Consumer-->>NSSAAF: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>NSSAAF: 2c. 3xx (RedirectResponse) + +``` + +Sequence diagram showing the Revocation Notification process between an NF Service Consumer and an NSSAAF. The NSSAAF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content, 2b. 4xx/5xx (ProblemDetails) or 3xx, or 2c. 3xx (RedirectResponse). + +Figure 5.2.2.4.1-1: Revocation Notification + +- The NSSAAF shall send a POST request to the revocation notification callback URI, which is either provided by the NF Service Consumer (i.e. the AMF), or retrieved from the AMF profile stored in the NRF (in default notification subscription for "NSSAA\_REVOC\_NOTIFICATION" notification type). If the NF Service Consumer is located in a different PLMN (i.e. the AMF in VPLMN for a roaming UE), the NSSAAF shall use the inter-PLMN callback URI to deliver the notification if the inter-PLMN callback URI is present in the default notification subscription. + +The content of the POST request shall contain the SliceAuthRevocNotification data structure, within which: + +- the notificationType set to the SliceAuthNotificationType of "SLICE\_REVOCATION"; +- the gpsi set to the GPSI of the given UE for whom the slice-specific authorization revocation is required; +- the snssai set to the S-NSSAI for which the slice-specific authorization revocation is required; +- the supi set to the SUPI of the given UE for whom the slice-specific authorization revocation is required. + +NOTE: The NSSAAF can obtain the SUPI of the UE in the response of a previous Nudm\_UECM\_Get used by the NSSAAF to retrieve the AMF ID. + +- On success, "204 No Content" shall be returned and the content of the POST response shall be empty. + +On receiving the request, the NF Service Consumer (i.e. the AMF) shall revoke the slice-specific authentication and authorization result for the given UE. If there is PDU session associated to the given slice, the AMF shall trigger the PDU session release to the SMF, with appropriate cause value. + +The AMF shall remove the "status" for the given slice in "nssaaStatusList" attribute (see 3GPP TS 29.518 [16]). + +- On failure, one of the HTTP status code (e.g. "404 Not Found") listed in Table 6.1.7.3-1 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, 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.5.3.3.1-2. + +If the NF Service Consumer (i.e. the AMF) is not able to handle the request, but knows that another NF Service Consumer (i.e. the AMF) is able to handle it, it shall reply with an HTTP 307/308 redirect response pointing to the URI of the new NF Service Consumer (i.e. the AMF). + +## 5.3 Nnssaaaf\_AIW Service + +### 5.3.1 Service Description + +The Nnssaaaf\_AIW service provides primary Authentication and Authorization service to the consumer NF (AUSF) by relaying EAP or EAP-TTLS inner method messages towards an AAA Server and performing related protocol conversion as needed. The NSSAAF is acting as NF Service Producer, while the AUSF is the NF Service Consumer. + +Following functionalities are provided by the Nnssaaaf\_AIW service: + +- Perform primary authentication and authorization for a given UE towards an AAA Server. + +The Nnssaaaf\_AIW service supports the following service operations. + +**Table 5.3.1-1: Service operations supported by the Nnssaaaf\_AIW service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|----------------------------------------------------------------------------------------|---------------------|---------------------| +| Authenticate | Perform primary authentication and authorization for a given UE towards an AAA Server. | Request/Response | AUSF | + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +See Table 5.3.1-1 for an overview of the service operations supported by the Nnssaaaf\_AIW service. + +#### 5.3.2.2 Authenticate + +##### 5.3.2.2.1 General + +The Authenticate service operation permits the NF Service Consumer (i.e., the AUSF) to perform authentication and authorization for a given UE towards an AAA Server. + +The NF Service Consumer (i.e., the AUSF) shall send a POST request to the resource representing authentication collection (i.e., .../authentications) to request the NSSAAF to create the corresponding resource context and perform primary authentication and authorization. + +![Sequence diagram showing AAA Interworking Authentication and Authorization between NF Service Consumer and NSSAAF. The diagram includes 9 steps: 1. POST .../authentications (AuthInfo) from Consumer to NSSAAF; 2. Forward EAP ID to AAA-S (dashed box); 3a. 201 Created (AuthContext) and 3b. 4xx/5xx (ProblemDetails) from NSSAAF to Consumer; 4. PUT .../authentications/{authCtxId}/confirmation (AuthConfirmationData) from Consumer to NSSAAF; 5. Forward EAP message to AAA-S (dashed box); 6a. 200 OK (AuthConfirmationResponse) and 6b. 4xx/5xx (ProblemDetails) or 3xx from NSSAAF to Consumer; 7. PUT .../authentications/{authCtxId}/confirmation (AuthConfirmationData) from Consumer to NSSAAF; 8. Forward EAP message to AAA-S (dashed box); 9a. 200 OK (AuthConfirmationResponse) and 9b. 4xx/5xx (ProblemDetails) or 3xx from NSSAAF to Consumer.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +sequenceDiagram + participant Consumer as NF Service Consumer + participant NSSAAF + Note right of NSSAAF: 2. Forward EAP ID to AAA-S + Consumer->>NSSAAF: 1. POST .../authentications (AuthInfo) + NSSAAF-->>Consumer: 3a. 201 Created (AuthContext) + Note right of NSSAAF: 5. Forward EAP message to AAA-S + NSSAAF-->>Consumer: 3b. 4xx/5xx (ProblemDetails) + Consumer->>NSSAAF: 4. PUT .../authentications/{authCtxId}/confirmation (AuthConfirmationData) + Note right of NSSAAF: 8. Forward EAP message to AAA-S + NSSAAF-->>Consumer: 6a. 200 OK (AuthConfirmationResponse) + Consumer->>NSSAAF: 7. PUT .../authentications/{authCtxId}/confirmation (AuthConfirmationData) + NSSAAF-->>Consumer: 6b. 4xx/5xx (ProblemDetails) or 3xx + NSSAAF-->>Consumer: 9a. 200 OK (AuthConfirmationResponse) + NSSAAF-->>Consumer: 9b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing AAA Interworking Authentication and Authorization between NF Service Consumer and NSSAAF. The diagram includes 9 steps: 1. POST .../authentications (AuthInfo) from Consumer to NSSAAF; 2. Forward EAP ID to AAA-S (dashed box); 3a. 201 Created (AuthContext) and 3b. 4xx/5xx (ProblemDetails) from NSSAAF to Consumer; 4. PUT .../authentications/{authCtxId}/confirmation (AuthConfirmationData) from Consumer to NSSAAF; 5. Forward EAP message to AAA-S (dashed box); 6a. 200 OK (AuthConfirmationResponse) and 6b. 4xx/5xx (ProblemDetails) or 3xx from NSSAAF to Consumer; 7. PUT .../authentications/{authCtxId}/confirmation (AuthConfirmationData) from Consumer to NSSAAF; 8. Forward EAP message to AAA-S (dashed box); 9a. 200 OK (AuthConfirmationResponse) and 9b. 4xx/5xx (ProblemDetails) or 3xx from NSSAAF to Consumer. + +**Figure 5.3.2.2.1-1: AAA Interworking Authentication and Authorization** + +- The NF Service Consumer (AUSF) shall send a POST request (AuthInfo) to the NSSAAF, targeting the resource of authentication collection (i.e. .../authentications), to perform authentication and authorization. + +The payload of the body shall contain the authentication information, which may include: + +- UE ID (i.e. SUPI) + - EAP-ID Response message + - EAP-TTLS Inner Method Container +- The NSSAAF creates an authentication context for the UE and starts the authentication and authorization procedure. The NSSAAF shall send an authentication request message to the AAA-S. Depending on the result, either step 3a or step 3b is performed. The NSSAAF obtains the AAA-S address from local configuration. + - On success, "201 Created" shall be returned (AuthContext). The "Location" header shall contain the URI of the created resource (e.g. .../authentications/{authCtxId}). The payload body shall contain the authentication context, which includes the EAP message generated by the AAA-S. + - On failure, one of the HTTP status code listed in Table 6.2.7.3-1 shall be returned with the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.7.3-1. + +4. Once receiving EAP message from the UE, the NF Service Consumer (i.e., the AUSF) shall send a PUT request (AuthConfirmationData) to the NSSAAF, targeting the resource of the authentication context (i.e. .../authentications/{authCtxId}). + +The payload body shall carry the authentication confirmation data which includes: + +- UE ID (i.e., SUPI) + - EAP Message (which is received from the UE) +5. The NSSAAF shall forward the EAP Message to the AAA-S to confirm the authentication and authorization. Depending on the result, either step 6a or step 6b is performed. + - 6a. On success, "200 OK" shall be returned (AuthConfirmationResponse). The payload body shall contain the authentication confirmation response, which includes the EAP message (e.g., EAP success/failure message) generated by the AAA-S. + +If the UE is authenticated, the NSSAAF shall set the "authResult" attribute to "EAP\_SUCCESS"; the response message shall contain the MSK received from the AAA-S and may contain the address of the SNPN UE onboarding Provisioning Servers (PVS). + +If failed to authenticate the UE, the "authResult" attribute shall be set to "EAP\_FAILURE". + +If subsequent EAP message exchange is needed between the UE and the NSSAAF (AAA-S), the NSSAAF shall not include AuthResult in the response message. + +- 6b. On failure or redirection, one of the HTTP status codes listed in Table 6.2.7.3-1 shall be returned with the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.7.3-1. +- 7-9. If subsequent EAP message exchange is needed between the UE and the NSSAAF to finish the EAP based authentication, steps 7-9 are performed. On failure or redirection, one of the HTTP status codes listed in Table 6.2.7.3-1 shall be returned with the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.2.7.3-1. + +In above steps, if there is no expected response from the AAA-S in the case of time out, the NSSAAF shall return HTTP status code "504 Gateway Timeout", with the message body containing a ProblemDetails structure with the "cause" attribute set to "TIMED\_OUT\_REQUEST". + +# --- 6 API Definitions + +## 6.1 Nnssaaf\_NSSAA Service API + +### 6.1.1 Introduction + +The Nnssaaf\_NSSAA service shall use the Nnssaaf\_NSSAA API. + +The API URI of the Nnssaaf\_NSSAA API shall be: + +**{apiRoot}/** + +The request URIs used in HTTP request 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 "nnssaaf-nssaa". + +- 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 Nnssaaaf\_NSSAA 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 applicable. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +The structure of the Resource URIs of the Nnssaaaf\_NSSAA service is shown in Figure 6.1.3.1-1 + +![Diagram showing the Resource URI structure of the NSSAA API. The root URI is ///nnssaaaf-nssaa/. It branches to /slice-authentications, which further branches to //.](262a3a1913ff07a5129940d6903b53f1_img.jpg) + +``` +graph TD; Root["///nnssaaaf-nssaa/"] --- SliceAuth["/slice-authentications"]; SliceAuth --- AuthCtxId["//"]; +``` + +Diagram showing the Resource URI structure of the NSSAA API. The root URI is ///nnssaaaf-nssaa/. It branches to /slice-authentications, which further branches to //. + +**Figure 6.1.3.1-1: Resource URI structure of the NSSAA 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-authentications (Collection) | //slice-authentications | POST | Initiate the slice-specific authentication and authorization process by providing inputs related to the UE and a specific slice. | +| slice-authentication (Document) | //slice-authentications/{authCtxId} | PUT | Put the UE response from the EAP process. | + +#### 6.1.3.2 Resource: slice-authentications (Collection) + +##### 6.1.3.2.1 Description + +This resource represents a collection of the slice-authentication resources generated by the NSSAAF. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nnsaaf-nssaa //slice-authentications + +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 | +| apiVersion | 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 | +|---------------|---|-------------|-------------------------------------------------------------------| +| SliceAuthInfo | M | 1 | Contains the GPSI, S-NSSAI, and EAP ID Response from the UE, etc. | + +**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 | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SliceAuthContext | M | 1 | 201 Created | This case indicates the corresponding resource has been created by the NSSAAF for the requested slice-specific authentication and authorization, and further EAP process is required.
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 slice-specific authentication and authorization because of input parameter error. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents when the UE or the slice is not allowed to be authenticated.
The "cause" attribute may be used to indicate one of the following application errors:
- SLICE_AUTH_REJECTED | +| ProblemDetails | O | 0..1 | 404 Not Found | This case represents the user or user context is not found.
The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 504 Gateway Time out | This case represents network error or remote peer (i.e. AAA-S) error, e.g. not reachable, no response and time out.
The "cause" attribute may be used to indicate one of the following application errors:
- NETWORK_FAILURE
- UPSTREAM_SERVER_ERROR
- TIME_OUT_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 POST method on this resource** + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +**Table 6.1.3.2.3.1-5: Headers supported by the 201 response code on this resource** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------| +| Location | URI | M | 1 | URI of created resource for the slice authentication context.
The URI structure is defined in clause 6.1.3.3.1. | + +**Table 6.1.3.2.3.1-6: Headers supported by the 307 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request 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]. | + +**Table 6.1.3.2.3.1-7: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request 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]. | + +##### 6.1.3.2.4 Resource Custom Operations + +There is no Resource Custom Operations in the current version of this API. + +#### 6.1.3.3 Resource: slice-authentication (Document) + +##### 6.1.3.3.1 Description + +The sub-resource "slice-authentication" is generated by the NSSAAF. This subresource should not persist after the slice-specific authentication and authorization process finishes. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nssaaaf-nssaa//slice-authentications/{authCtxId} + +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 | +| apiVersion | string | See clause 6.1.1 | +| authCtxId | string | The slice authentication context ID, which is of data type SliceAuthCtxId defined in clause 6.1.6.3.2. | + +##### 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 | 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 PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------------|---|-------------|-----------------------------------------------------------------------| +| SliceAuthConfirmationData | M | 1 | Contains the EAP message 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 | +|-------------------------------|---|-------------|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| SliceAuthConfirmationResponse | M | 1 | 200 OK | This case indicates that the NSSAAF has performed the slice-specific authentication. The response body shall contain the result of the slice-specific authentication and authorization. | +| 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 slice-specific authentication failure because of input parameter error. This indicates that the NSSAAF was not able to process the slice-specific authentication. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents when the UE or the slice is not allowed to be authenticated.
The "cause" attribute may be used to indicate one of the following application errors:
- SLICE_AUTH_REJECTED | +| ProblemDetails | O | 0..1 | 404 Not Found | This case represents the UE or UE related context is not found.
The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 504 Gateway Time out | This case represents network error or remote peer (i.e. AAA-S) error, e.g. not reachable, no response when time out.
The "cause" attribute may be used to indicate one of the following application errors:
- NETWORK_FAILURE
- UPSTREAM_SERVER_ERROR
- TIMED_OUT_REQUEST | + +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: 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 PUT method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Table 6.1.3.3.3.1-5: Headers supported by the 200 response code on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Table 6.1.3.3.3.1-6: Headers supported by the 307 Response Code on this endpoint + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request 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]. | + +**Table 6.1.3.3.3.1-7: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request 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]. | + +##### 6.1.3.3.4 Resource Custom Operations + +There is no Resource Custom Operations in the current version of this API. + +### 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 + +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 | Resource URI | HTTP method or custom operation | Description (service operation) | +|--------------------------------|-----------------------------------------------------------------------|---------------------------------|---------------------------------| +| Re-authentication Notification | {reauthNotifUri}
(NF Service Consumer provided callback reference) | POST | Re-authentication Notification | +| Revocation Notification | {revocNotifUri}
(NF Service Consumer provided callback reference) | POST | Revocation Notification | + +#### 6.1.5.2 Re-authentication Notification + +##### 6.1.5.2.1 Description + +The Re-authentication Notification is used by the NSSAAF to trigger the NF Service Consumer (i.e. the AMF) to re-initiate slice-specific authentication and authorization for a given UE. + +##### 6.1.5.2.2 Target URI + +The Notification URI "{reauthNotifUri}" shall be used with the resource URI variables defined in table 6.1.5.2.2-1. + +**Table 6.1.5.2.2-1: Resource URI variables for this resource** + +| Name | Definition | +|----------------|-------------------------------------------------------------------------------| +| reauthNotifUri | String formatted as URI which carries the re-authentication notification URI. | + +##### 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-2. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------------|---|-------------|----------------------------------------------------------------------------------------------| +| SliceAuthReauthNotification | M | 1 | SliceAuthReauthNotification which carries the re-authentication notification for a given UE. | + +**Table 6.1.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 | Successful notification of the re-authentication. | +| 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 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.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 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]. | + +**Table 6.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 | 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 [4]. | + +#### 6.1.5.3 Revocation Notification + +##### 6.1.5.3.1 Description + +The Revocation Notification is used by the NSSAAF to trigger the NF Service Consumer (i.e. the AMF) to revoke the slice-specific authentication and authorization result for a given UE. + +##### 6.1.5.3.2 Target URI + +The Notification URI "{revocNotifUri}" shall be used with the resource URI variables defined in table 6.1.5.3.2-1. + +**Table 6.1.5.3.2-1: Resource URI variables for this resource** + +| Name | Definition | +|---------------|------------------------------------------------------------------------| +| revocNotifUri | String formatted as URI which carries the revocation notification URI. | + +##### 6.1.5.3.3 Standard Methods + +###### 6.1.5.3.3.1 POST + +This method shall support the request data structures specified in table 6.1.5.3.3.1-1 and the response data structures and response codes specified in table 6.1.5.3.3.1-2. + +**Table 6.1.5.3.3.1-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------------------|---|-------------|--------------------------------------------------------------------------------------| +| SliceAuthRevocNotification | M | 1 | SliceAuthRevocNotification which carries the revocation notification for a given UE. | + +**Table 6.1.5.3.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 | Successful notification of the revocation. | +| 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 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.5.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 [4]. | + +**Table 6.1.5.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 [4]. | + +### 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 Nnssaaaf service based interface protocol. + +**Table 6.1.6.1-1: Nnssaaaf specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|-------------------------------|----------------|-------------------------------------------------------------------------------------------------------|---------------| +| SliceAuthInfo | 6.1.6.2.2 | Contains the GPSI, S-NSSAI, EAP ID Response, etc. | | +| SliceAuthContext | 6.1.6.2.3 | Contains the information of the resource created for slice-specific authentication and authorization. | | +| SliceAuthConfirmationData | 6.1.6.2.4 | Contains the EAP message from the UE for EAP process. | | +| SliceAuthConfirmationResponse | 6.1.6.2.5 | Contains the slice-specific authentication and authorization result from the NSSAAF to the UE. | | +| SliceAuthReauthNotification | 6.1.6.2.6 | Contains the re-authentication notification for slice-specific authentication and authorization. | | +| SliceAuthRevocNotification | 6.1.6.2.7 | Contains the revocation notification for slice-specific authentication and authorization. | | +| SliceAuthCtxId | 6.1.6.3.2 | Contains the resource ID of slice authentication context. | | +| EapMessage | 6.1.6.3.2 | Contains the string formatted EAP message. | | +| SliceNotificationType | 6.1.6.3.3 | Notification type of slice-specification authentication and authorization. | | + +Table 6.1.6.1-2 specifies data types re-used by the Nnssaaaf 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 Nnssaaaf service based interface. + +**Table 6.1.6.1-2: Nnssaaaf re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|---------------------|------------------------------------------|---------------| +| ProblemDetails | 3GPP TS 29.571 [16] | Common Data Type used in response bodies | | +| RedirectResponse | 3GPP TS 29.571 [16] | Redirect Response | | +| Gpsi | 3GPP TS 29.571 [16] | GPSI | | +| Snssai | 3GPP TS 29.571 [16] | S-NSSAI | | +| AuthStatus | 3GPP TS 29.571 [16] | Slice Authentication Status | | +| Supi | 3GPP TS 29.571 [16] | SUPI of the UE | | + +#### 6.1.6.2 Structured data types + +The following clause defines the structures to be used in resource representations. + +##### 6.1.6.2.1 Introduction + +This clause defines the structures to be used in resource representations. + +##### 6.1.6.2.2 Type: SliceAuthInfo + +Table 6.1.6.2.2-1: Definition of type SliceAuthInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|--------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| eapIdRsp | EapMessage | M | 1 | Contains the EAP ID Responses message from the UE.
If no EAP ID Responses message is received or requested, it shall contain the Null value. | | +| amfInstanceId | NfInstanceId | O | 0..1 | This IE may be present, if the AMF determines to provide the re-authentication/revocation notification URI to the NSSAAF.
When present, it shall contain the NF Instance Id of the AMF. | | +| reauthNotifUri | Uri | O | 0..1 | This IE may be present, e.g. if the AMF determines the UE with low mobility characteristic.
When present, it shall contain the re-authentication notification URI. | | +| revocNotifUri | Uri | O | 0..1 | This IE may be present, e.g. if the AMF determines the UE with low mobility characteristic.
When present, it shall contain the revocation notification URI. | | + +##### 6.1.6.2.3 Type: SliceAuthContext + +Table 6.1.6.2.3-1: Definition of type SliceAuthContext + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|----------------|---|-------------|-----------------------------------------------------------------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| authCtxId | SliceAuthCtxId | M | 1 | Indicates the resource ID uniquely identifying the slice authentication context, generated by the NSSAAF. | | +| eapMessage | EapMessage | M | 1 | Contains the EAP message to be sent to the UE. | | + +##### 6.1.6.2.4 Type: SliceAuthConfirmationData + +Table 6.1.6.2.4-1: Definition of type SliceAuthConfirmationData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|------------------------------------------------|---------------| +| gpsi | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| eapMessage | EapMessage | M | 1 | Contains the EAP message received from the UE. | | + +##### 6.1.6.2.5 Type: SliceAuthConfirmationResponse + +Table 6.1.6.2.5-1: Definition of type SliceAuthConfirmationResponse + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|------------------------------------------------------------------------------------------------|---------------| +| gps | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| eapMessage | EapMessage | M | 1 | Contains the EAP success/failure message needs to be sent to the UE. | | +| authResult | AuthStatus | O | 0..1 | When present, it shall indicate the result of slice-specific authentication and authorization. | | + +##### 6.1.6.2.6 Type: SliceAuthReauthNotification + +Table 6.1.6.2.6-1: Definition of type SliceAuthReauthNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------|---|-------------|----------------------------------------------------------------|---------------| +| notificationType | SliceAuthNotificationType | M | 1 | Indicate the type of slice authentication notification. | | +| gps | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| supi | Supi | C | 0..1 | This IE should be sent by the NSSAAF to the AMF, if available. | | + +##### 6.1.6.2.7 Type: SliceAuthRevocNotification + +Table 6.1.6.2.7-1: Definition of type SliceAuthRevocNotification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|---------------------------|---|-------------|----------------------------------------------------------------|---------------| +| notificationType | SliceAuthNotificationType | M | 1 | Indicate the type of slice authentication notification. | | +| gps | Gpsi | M | 1 | Contains the GPSI of the UE. | | +| snssai | Snssai | M | 1 | Contains the S-NSSAI for authentication. | | +| supi | Supi | C | 0..1 | This IE should be sent by the NSSAAF to the AMF, if available. | | + +#### 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 | +|----------------|-----------------|--------------------------------------------------------------------------------------------------------------|---------------| +| SliceAuthCtxId | string | The resource ID uniquely identifying the slice authentication context, generated by the NSSAAF. | | +| EapMessage | string | The EAP packet is encoded using base64 (see IETF RFC 4648 [14]) and represented as a String.
Format: byte | | + +##### 6.1.6.3.3 Enumeration: SliceAuthNotificationType + +The enumeration SliceAuthNotificationType represents the notification type of slice-specific authentication and authorization. It shall comply with the provisions defined in table 6.1.6.3.3-1. + +**Table 6.1.6.3.3-1: Enumeration SliceAuthNotificationType** + +| Enumeration value | Description | Applicability | +|-------------------|---------------------------------------------------------------------------------------------------------------|---------------| +| SLICE_RE_AUTH | This value is used to indicate the re-authentication is needed | | +| SLICE_REVOCATION | This value is used to indicate the previous slice-specific authentication and authorization shall be revoked. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There is no alternative data types defined in this specification. + +#### 6.1.6.5 Binary data + +There is no binary data type defined in this specification. + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nnssaaaf\_NSSAA 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 Nnssaaaf\_NSSAA API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nnssaaaf\_NSSAA service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nnssaaaf\_NSSAA service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RESOURCE_TEMP_MOVED | 307 Temporary Redirect | Indicates that the NSSAAF is not able to handle the request, but points to the URI of another NSSAAF. | +| RESOURCE_MOVED | 308 Permanent Redirect | Indicates that the NSSAAF is not able to handle the request, but points to the URI of another NSSAAF. | +| SLICE_AUTH_REJECTED | 403 Forbidden | The user cannot be authenticated, e.g. authentication request rejected by the AAA-S. | +| CONTEXT_NOT_FOUND | 404 Not Found | The NSSAAF cannot find the resource corresponding to the URI provided by the NF Service Consumer, i.e. the resource identified by the authCtxId does not exist in the NSSAAF. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist in the HPLMN. | +| UPSTREAM_SERVER_ERROR | 504 Gateway Timeout | Error happens in reaching the remote peer (i.e. the AAA-S). | +| NETWORK_FAILURE | 504 Gateway Timeout | The request is rejected due to a network problem. | +| TIMED_OUT_REQUEST | 504 Gateway Timeout | No response is received from the remote peer (i.e. the AAA-S) when time out. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nnssaaaf\_NSSAA 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 Nnssaaf\_NSSAA 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 Nnssaaf\_NSSAA 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 Nnssaaf\_NSSAA service. + +The Nnssaaf\_NSSAA API defines a single scope "nnssaaf-nssaa" 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 NSSAAF service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different NSSAAF producer instance will return the NF Instance ID of the new NSSAAF 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 NSSAAF redirects a service request to a different NSSAAF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new NSSAAF 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 Nnssaaf\_AIW Service API + +### 6.2.1 Introduction + +The Nnssaaf\_AIW service shall use the Nnssaaf\_AIW API. + +The API URI of the Nnssaaf\_AIW API shall be: + +**{apiRoot}//** + +The request URIs used in HTTP request 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 "nnssaaf-aiw". +- 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 [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 Nnssaaaf\_AIW 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 applicable. + +### 6.2.3 Resources + +#### 6.2.3.1 Overview + +The structure of the Resource URIs of the Nnssaaaf\_AIW service is shown in Figure 6.2.3.1-1 + +![Diagram showing the Resource URI structure of the AIW API. The root URI is {apiRoot}/nnssaaaf-aiw/. A line branches down to a box containing /authentications. From this box, another line branches down to a box containing /{authCtxId}.](a04d24ddad7620a923d3895a834d71a8_img.jpg) + +``` +graph TD; Root["{apiRoot}/nnssaaaf-aiw/"] --> Auth["/authentications"]; Auth --> AuthCtxId["/{authCtxId}"]; +``` + +Diagram showing the Resource URI structure of the AIW API. The root URI is {apiRoot}/nnssaaaf-aiw/. A line branches down to a box containing /authentications. From this box, another line branches down to a box containing /{authCtxId}. + +**Figure 6.2.3.1-1: Resource URI structure of the AIW 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 | +|------------------------------|------------------------------|---------------------------------|----------------------------------------------------------------------------------------------| +| authentications (Collection) | /authentications | POST | Initiate the authentication and authorization process by providing inputs related to the UE. | +| authentication (Document) | /authentications/{authCtxId} | PUT | Put the UE response from the EAP process. | + +#### 6.2.3.2 Resource: authentications (Collection) + +##### 6.2.3.2.1 Description + +This resource represents a collection of the authentication resources generated by the NSSAAF. + +##### 6.2.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nssaaaf-aiw//authentications + +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 | Applicability | +|------|-----------|---|-------------|-------------|---------------| +| 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 | +|-----------|---|-------------|------------------------------------------------------| +| AuthInfo | M | 1 | Contains the SUPI, EAP ID Response from the UE, etc. | + +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 | +|------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthContext | M | 1 | 201 Created | This case indicates the corresponding resource has been created by the NSSAAF for the requested authentication and authorization, and further EAP process is required. 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 and authorization because of input parameter error. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents when the UE is not allowed to be authenticated. | +| ProblemDetails | O | 0..1 | 404 Not Found | This case represents the user or user context is not found. The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 504 Gateway Time out | This case represents network error or remote peer (i.e. AAA-S) error, e.g. not reachable, no response and time out. The "cause" attribute may be used to indicate one of the following application errors:
- NETWORK_FAILURE
- UPSTREAM_SERVER_ERROR
- TIME_OUT_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.2.3.2.3.1-4: Headers supported by the POST method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Table 6.2.3.2.3.1-5: Headers supported by the 201 response code on this resource + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------| +| Location | URI | M | 1 | URI of created resource for the authentication context. The URI structure is defined in clause 6.2.3.3.1. | + +Table 6.2.3.2.3.1-6: Headers supported by the 307 Response Code on this endpoint + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request 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]. | + +**Table 6.2.3.2.3.1-7: Headers supported by the 308 Response Code on this endpoint** + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request 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]. | + +#### 6.2.3.3 Resource: authentication (Document) + +##### 6.2.3.3.1 Description + +The sub-resource "authentication" is generated by the NSSAAF. This subresource should not persist after the authentication and authorization process finishes. + +##### 6.2.3.3.2 Resource Definition + +Resource URI: {apiRoot}/nnssaaf-aiw//authentications/{authCtxId} + +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 | +| authCtxId | string | The authentication context ID, which is of data type AuthCtxId defined in clause 6.2.6.3.2. | + +##### 6.2.3.3.3 Resource Standard Methods + +###### 6.2.3.3.3.1 PUT + +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 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 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 PUT Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------------------|---|-------------|------------------------------------------------------------------------| +| AuthConfirmation Data | M | 1 | Contains the EAP message generated by the UE and provided to the AUSF. | + +Table 6.2.3.3.3.1-3: Data structures supported by the PUT Response Body on this resource + +| Data type | P | Cardinality | Response codes | Description | +|--------------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| AuthConfirmationResponse | M | 1 | 200 OK | This case indicates that the NSSAAF has performed the authentication. The response body shall contain the result of the authentication and authorization. | +| 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 authentication failure because of input parameter error. This indicates that the NSSAAF was not able to process the authentication. | +| ProblemDetails | O | 0..1 | 403 Forbidden | This case represents when the UE is not allowed to be authenticated. | +| ProblemDetails | O | 0..1 | 404 Not Found | This case represents the UE or UE related context is not found.
The "cause" attribute may be used to indicate one of the following application errors:
- CONTEXT_NOT_FOUND
- USER_NOT_FOUND | +| ProblemDetails | O | 0..1 | 504 Gateway Time out | This case represents network error or remote peer (i.e. AAA-S) error, e.g. not reachable, no response when time out.
The "cause" attribute may be used to indicate one of the following application errors:
- NETWORK_FAILURE
- UPSTREAM_SERVER_ERROR
- TIMED_OUT_REQUEST | + +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: 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-4: Headers supported by the PUT method on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Table 6.2.3.3.3.1-5: Headers supported by the 200 response code on this resource + +| Name | Data type | P | Cardinality | Description | +|------|-----------|---|-------------|-------------| +| n/a | | | | | + +Table 6.2.3.3.3.1-6: Headers supported by the 307 Response Code on this endpoint + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request 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]. | + +Table 6.2.3.3.3.1-7: Headers supported by the 308 Response Code on this endpoint + +| Name | Data type | P | Cardinality | Description | +|----------|-----------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Location | string | M | 1 | URI pointing to the resource of another NF service producer to which the request 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]. | + +### 6.2.4 Custom Operations without associated resources + +There are no Custom Operation in the current version of this API. + +### 6.2.5 Notifications + +There are no Notifications 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 NnssAAF service based interface protocol. + +**Table 6.2.6.1-1: NnssAAF\_AIW specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|--------------------------|----------------|----------------------------------------------------------------------------------------|---------------| +| AuthInfo | 6.2.6.2.2 | Contains the SUPI, EAP ID Response, etc. | | +| AuthContext | 6.2.6.2.3 | Contains the information of the resource created for authentication and authorization. | | +| AuthConfirmationData | 6.2.6.2.4 | Contains the EAP message from the UE for EAP process. | | +| AuthConfirmationResponse | 6.2.6.2.5 | Contains the authentication and authorization result from the NSSAAF to the UE. | | +| AuthCxtId | 6.2.6.3.2 | Contains the resource ID of authentication context. | | + +Table 6.2.6.1-2 specifies data types re-used by the NnssAAF\_AIW service based interface from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the NnssAAF\_AIW service based interface. + +**Table 6.2.6.1-2: NnssAAF re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------------|---------------------|-----------------------------------------------------------------|---------------| +| ProblemDetails | 3GPP TS 29.571 [16] | Common Data Type used in response bodies | | +| RedirectResponse | 3GPP TS 29.571 [16] | Redirect Response | | +| AuthStatus | 3GPP TS 29.571 [16] | Authentication Status | | +| Supi | 3GPP TS 29.571 [16] | SUPI of the UE | | +| SupportedFeatures | 3GPP TS 29.571 [16] | Supported Features | | +| ServerAddressingInfo | 3GPP TS 29.571 [16] | Addressing information (FQDNs and/or IP addresses) of a server. | | +| EapMessage | 3GPP TS 29.526 | See clause 6.1.6.3.2 | | +| Msk | 3GPP TS 29.509 [18] | | | + +#### 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: AuthInfo + +Table 6.2.6.2.2-1: Definition of type AuthInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | Contains the SUPI of the UE. | | +| eapIdRsp | EapMessage | C | 0..1 | Contains the EAP Identity Response message. (NOTE) | | +| ttlsInnerMethodContainer | EapMessage | C | 0..1 | Contains the EAP-TTLS inner method messages. It is included when EAP-TTLS is used, after the initial EAP-TLS exchange. (NOTE) | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.9 is supported. | | + +NOTE: Either eapIdRsp or ttlInnerMethodContainer shall be present, but not both. + +##### 6.2.6.2.3 Type: AuthContext + +Table 6.2.6.2.3-1: Definition of type AuthContext + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | Contains the SUPI of the UE. | | +| authCtxId | AuthCtxId | M | 1 | Indicates the resource ID uniquely identifying the authentication context, generated by the NSSAAF. | | +| eapMessage | EapMessage | C | 0..1 | Contains the EAP message to be sent to the UE. (NOTE) | | +| ttlsInnerMethodContainer | EapMessage | C | 0..1 | Contains the EAP-TTLS inner method messages. It is included when EAP-TTLS is used, after the initial EAP exchange. (NOTE) | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.2.9 is supported. | | + +NOTE: Either eapIdRsp or ttlInnerMethodContainer shall be present, but not both. + +##### 6.2.6.2.4 Type: AuthConfirmationData + +Table 6.2.6.2.4-1: Definition of type AuthConfirmationData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | Contains the SUPI of the UE. | | +| eapMessage | EapMessage | M | 1 | Contains the EAP message received from the UE. | | +| 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.5 Type: AuthConfirmationResponse + +Table 6.2.6.2.5-1: Definition of type AuthConfirmationResponse + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|-----------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| supi | Supi | M | 1 | Contains the SUPI of the UE. | | +| eapMessage | EapMessage | M | 1 | Contains the EAP success/failure message needs to be sent to the UE. | | +| authResult | AuthStatus | O | 0..1 | When present, it shall indicate the result of authentication and authorization. | | +| pvsInfo | array(ServerAddressingInfo) | O | 1..N | When present, it shall contain the FQDN(s) and/or IP address(es) of the SNPn UE onboarding Provisioning Servers. | | +| msk | Msk | C | 0..1 | This IE shall be present if MSK is received from AAA-S after successful authentication, as specified in clause I.2.2.2 of 3GPP TS 33.501 [8]. | | +| 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.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 | +|-----------|-----------------|-------------------------------------------------------------------------------------------|---------------| +| AuthCtxId | string | The resource ID uniquely identifying the authentication context, generated by the NSSAAF. | | + +### 6.2.7 Error Handling + +#### 6.2.7.1 General + +For the Nnssaaaf\_AIW 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 Nnssaaaf\_AIW API. + +#### 6.2.7.2 Protocol Errors + +No specific procedures for the Nnssaaaf\_AIW service are specified. + +#### 6.2.7.3 Application Errors + +The application errors defined for the Nnssaaaf\_AIW service are listed in Table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-----------------------|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| RESOURCE_TEMP_MOVED | 307 Temporary Redirect | Indicates that the NSSAAF is not able to handle the request, but points to the URI of another NSSAAF. | +| RESOURCE_MOVED | 308 Permanent Redirect | Indicates that the NSSAAF is not able to handle the request, but points to the URI of another NSSAAF. | +| CONTEXT_NOT_FOUND | 404 Not Found | The NSSAAF cannot find the resource corresponding to the URI provided by the NF Service Consumer, i.e. the resource identified by the authCtxId does not exist in the NSSAAF. | +| USER_NOT_FOUND | 404 Not Found | The user does not exist. | +| UPSTREAM_SERVER_ERROR | 504 Gateway Timeout | Error happens in reaching the remote peer (i.e., the AAA-S). | +| NETWORK_FAILURE | 504 Gateway Timeout | The request is rejected due to a network problem. | +| TIMED_OUT_REQUEST | 504 Gateway Timeout | No response is received from the remote peer (i.e., the AAA-S) when time out. | + +### 6.2.8 Feature negotiation + +The optional features in table 6.2.8-1 are defined for the NnssAAF\_AIW 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 | Description | +|----------------|--------------|-------------| +| | | | + +### 6.2.9 Security + +As indicated in 3GPP TS 33.501 [8] and 3GPP TS 29.500 [4], the access to the NnssAAF\_AIW 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 NnssAAF\_AIW 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 NnssAAF\_AIW service. + +The NnssAAF\_AIW API defines a single scope "nnssAAF-aiw" 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 NSSAAF service instance when using direct or indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different NSSAAF producer instance will return the NF Instance ID of the new NSSAAF 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 NSSAAF redirects a service request to a different NSSAAF using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new NSSAAF 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 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 hosted, 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 Nnssaaf\_NSSAA API + +``` +openapi: 3.0.0 + +info: + title: Nnssaaf_NSSAA + version: 1.2.0-alpha.2 + description: | + Network Slice-Specific Authentication and Authorization Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS29.526, NSSAA Service, version 18.3.0. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.526/ + +servers: + - url: '{apiRoot}/nnssaaf-nssaa/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnssaaf-nssaa + +paths: + /slice-authentications: + post: + summary: Create slice authentication context + operationId: CreateSliceAuthenticationContext + tags: + - Slice Authentication Context Creation + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthInfo' + required: true + responses: + '201': + description: SliceAuthContext + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthContext' + headers: + Location: +``` + +``` + + description: 'Contains the URI of the newly created resource according to the +structure: {apiRoot}/nnssaaaf-nssaa//slice-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 slice authentication rejected + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +'404': + description: User does not exist + 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' +'504': + description: Network error or remote peer error + content: + application/problem+json: + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' +callbacks: + reauthenticationNotification: + '{request.body#/reauthNotifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthReauthNotification' +responses: +'204': + description: slice re-authentication notification response +'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' + 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' + 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: + description: Unexpected error + revocationNotification: + '{request.body#/revocNotifUri}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthRevocNotification' + responses: + '204': + description: slice revocation notification response + '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' + 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' + 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: + description: Unexpected error + +/slice-authentications/{authCtxId}: + put: + summary: Confirm the slice authentication result + operationId: ConfirmSliceAuthentication + tags: + - Confirm Slice Authentication + parameters: + - name: authCtxId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthConfirmationData' + responses: + '200': + description: Request processed (EAP success or Failure) + content: + application/json: + schema: + $ref: '#/components/schemas/SliceAuthConfirmationResponse' + '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' + '504': + description: Network error or remote peer error + content: + application/problem+json: + schema: +``` + +``` +$ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnssaaf-nssaa: Access to the nnssaaf-nssaa API + +schemas: + +# +# COMPLEX TYPES: +# + +SliceAuthInfo: + type: object + properties: + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + eapIdRsp: + $ref: '#/components/schemas/EapMessage' + amfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + reauthNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + revocNotifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + required: + - gsi + - snssai + - eapIdRsp + +SliceAuthContext: + type: object + properties: + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + authCtxId: + $ref: '#/components/schemas/SliceAuthCtxId' + eapMessage: + $ref: '#/components/schemas/EapMessage' + required: + - gsi + - snssai + - authCtxId + - eapMessage + +SliceAuthConfirmationData: + type: object + properties: + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + eapMessage: + $ref: '#/components/schemas/EapMessage' + required: + - gsi + - snssai + - eapMessage + +SliceAuthConfirmationResponse: + type: object + properties: + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + eapMessage: + $ref: '#/components/schemas/EapMessage' +``` + +``` + + authResult: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AuthStatus' + required: + - gpsi + - snssai + - eapMessage + +SliceAuthReauthNotification: + type: object + properties: + notifType: + $ref: '#/components/schemas/SliceAuthNotificationType' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + required: + - notifType + - gpsi + - snssai + +SliceAuthRevokeNotification: + type: object + properties: + notifType: + $ref: '#/components/schemas/SliceAuthNotificationType' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SNSSAI' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + required: + - notifType + - gpsi + - snssai + +# +# SIMPLE TYPES: +# + +SliceAuthCtxId: + type: string + description: contains the resource ID of slice authentication context + nullable: false + +EapMessage: + type: string + format: byte + description: contains an EAP packet + nullable: true + +# +# ENUMS: +# + +SliceAuthNotificationType: + type: string + enum: + - SLICE_RE_AUTH + - SLICE_REVOCATION + +``` + +## A.3 Nnssaaaf\_AIW API + +openapi: 3.0.0 + +``` + +info: + title: Nnssaaaf_AIW + version: 1.1.0-alpha.2 + description: | + AAA Interworking Authentication and Authorization Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +``` + +``` +externalDocs: + description: 3GPP TS29.526, NSSAA Service, version 18.3.0. + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.526/ + +servers: + - url: '{apiRoot}/nnssaaf-aiw/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nnssaaf-aiw + +paths: + /authentications: + post: + summary: Create authentication context + operationId: CreateAuthenticationContext + tags: + - Authentications (Collections) + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AuthInfo' + required: true + responses: + '201': + description: AuthContext successfully created + content: + application/json: + schema: + $ref: '#/components/schemas/AuthContext' + headers: + Location: + description: 'Contains the URI of the newly created resource according to the +structure: {apiRoot}/nnssaaf-aiw//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' + '504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' + + /authentications/{authCtxId}: + put: + summary: Confirm the authentication result + operationId: ConfirmAuthentication + tags: +``` + +``` +- Authentication (Document) +parameters: +- name: authCtxId + in: path + required: true + schema: + type: string +requestBody: +content: + application/json: + schema: + $ref: '#/components/schemas/AuthConfirmationData' +responses: +'200': + description: Request processed (EAP success or Failure) + content: + application/json: + schema: + $ref: '#/components/schemas/AuthConfirmationResponse' +'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' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nnssaaf-aiw: Access to the nnssaaf-aiw API + +schemas: + +# +# COMPLEX TYPES: +# + +AuthInfo: + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + eapIdRsp: + $ref: 'TS29526_Nnssaaf_NSSAA.yaml#/components/schemas/EapMessage' + ttlsInnerMethodContainer: + $ref: 'TS29526_Nnssaaf_NSSAA.yaml#/components/schemas/EapMessage' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supi +``` + +``` +AuthContext: + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + authCtxId: + $ref: '#/components/schemas/AuthCtxId' + eapMessage: + $ref: 'TS29526_Nnssaaaf_NSSAA.yaml#/components/schemas/EapMessage' + ttlsInnerMethodContainer: + $ref: 'TS29526_Nnssaaaf_NSSAA.yaml#/components/schemas/EapMessage' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supi + - authCtxId + +AuthConfirmationData: + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + eapMessage: + $ref: 'TS29526_Nnssaaaf_NSSAA.yaml#/components/schemas/EapMessage' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supi + - eapMessage + +AuthConfirmationResponse: + type: object + properties: + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + eapMessage: + $ref: 'TS29526_Nnssaaaf_NSSAA.yaml#/components/schemas/EapMessage' + authResult: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AuthStatus' + pvsInfo: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServerAddressingInfo' + minItems: 1 + msk: + $ref: 'TS29509_Nausf_UEAuthentication.yaml#/components/schemas/Msk' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + required: + - supi + - eapMessage + +# +# SIMPLE TYPES: +# + +AuthCtxId: + type: string + description: contains the resource ID of authentication context + nullable: false + +# +# ENUMS: +# +``` + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|---------------------------------------------------------------|------|-----|-----|---------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2020-06 | CT4#98E | C4-203683 | | | | TS skeleton. | 0.1.0 | +| 2020-06 | CT4#98E | C4-202084
C4-202085
C4-202086
C4-203709
C4-203710 | | | | Implementation of pCRs agreed in CT4#98E | 0.2.0 | +| 2020-06 | CT#88e | CP-201193 | | | | TS presented for information and approval. | 1.0.0 | +| 2020-06 | CT#88e | | | | | TS approved at CT#88e | 16.0.0 | +| 2020-09 | CT#89 | CP-202104 | 0005 | 1 | F | Update References | 16.1.0 | +| 2020-09 | CT#89 | CP-202104 | 0007 | 1 | F | Release PDU Session if NSSAA Re-Authentication and Re-Authorization Fails | 16.1.0 | +| 2020-09 | CT#89 | CP-202104 | 0008 | 1 | F | NSSAA status management | 16.1.0 | +| 2020-12 | CT#90 | CP-203054 | 0009 | 2 | F | Amendments for stateless NF support | 16.2.0 | +| 2020-12 | CT#90 | CP-203040 | 0010 | - | F | Remove Editor's Notes on AAA Server Address | 16.2.0 | +| 2020-12 | CT#90 | CP-203048 | 0011 | 1 | F | Storage of YAML files in 3GPP Forge | 16.2.0 | +| 2020-12 | CT#90 | CP-203040 | 0012 | 1 | F | AMF behaviour for NSSAA procedure due to temporal NW failure | 16.2.0 | +| 2020-12 | CT#90 | CP-203036 | 0013 | - | F | API version and External doc update | 16.2.0 | +| 2021-03 | CT#91 | CP-210049 | 0014 | - | F | Incorrect Media Type | 16.3.0 | +| 2021-03 | CT#91 | CP-210054 | 0016 | - | F | 29.526 Rel-16 API version and External doc update | 16.3.0 | +| 2021-03 | CT#91 | CP-210034 | 0015 | 1 | F | OpenAPI Reference | 17.0.0 | +| 2021-06 | CT#92 | CP-211068 | 0018 | 1 | F | Unsuccessful cases for handling of NSSAA status in AMF | 17.1.0 | +| 2021-06 | CT#92 | CP-211028 | 0019 | - | F | TS Clean-up | 17.1.0 | +| 2021-06 | CT#92 | CP-211068 | 0021 | 1 | F | SUPI in Notifications from NSSAAF | 17.1.0 | +| 2021-06 | CT#92 | CP-211059 | 0023 | 1 | F | Redirect Response | 17.1.0 | +| 2021-06 | CT#92 | CP-211050 | 0024 | - | F | 29.526 Rel-17 API version and External doc update | 17.1.0 | +| 2021-09 | CT#93 | CP-212045 | 0026 | 1 | F | Attack from AAA-S | 17.2.0 | +| 2021-09 | CT#93 | CP-212070 | 0028 | 1 | F | NSSAA procedure from two different AMFs | 17.2.0 | +| 2021-09 | CT#93 | CP-212060 | 0031 | - | F | 3xx description correction for SCP | 17.2.0 | +| 2021-09 | CT#93 | CP-212026 | 0032 | - | F | Base64 Encoding of binary attributes in JSON objects | 17.2.0 | +| 2021-09 | CT#93 | CP-212045 | 0033 | - | F | Re-authentication Request when S-NSSAI is not in use | 17.2.0 | +| 2021-09 | CT#93 | CP-212059 | 0034 | - | F | 29.526 Rel-17 API version and External doc update | 17.2.0 | +| 2021-09 | CT#94 | CP-213139 | 0036 | 2 | F | Remove AMF behaviour related to back-off timer from NSSAA procedure | 17.3.0 | +| 2021-12 | CT#94 | CP-213085 | 0037 | - | F | Miscellaneous corrections | 17.3.0 | +| 2021-12 | CT#94 | CP-213139 | 0039 | 1 | F | Correction to Re-Authentication / Revocation Notification Procedure | 17.3.0 | +| 2021-12 | CT#94 | CP-213092 | 0041 | 1 | F | Clarification of NSAC and exposure service | 17.3.0 | +| 2021-12 | CT#94 | CP-213120 | 0042 | - | F | 307/308 redirection | 17.3.0 | +| 2022-12 | CT#95 | CP-220047 | 0043 | 1 | F | Changing the Title of the TS 29.526 | 17.4.0 | +| 2022-03 | CT#95 | CP-220047 | 0051 | 3 | B | AIW Service | 17.4.0 | +| 2022-03 | CT#95 | CP-220026 | 0053 | 1 | F | 3xx Redirect Response | 17.4.0 | +| 2022-03 | CT#95 | CP-220075 | 0055 | 1 | F | Incorrect Service Name | 17.4.0 | +| 2022-03 | CT#95 | CP-220025 | 0057 | - | F | EAP ID Response message | 17.4.0 | +| 2022-03 | CT#95 | CP-220066 | 0058 | - | F | 29.526 Rel-17 API version and External doc update | 17.4.0 | +| 2022-06 | CT#96 | CP-221051 | 0061 | - | F | 29.526 Rel-17 API version and External doc update | 17.5.0 | +| 2022-09 | CT#97 | CP-222056 | 0063 | - | F | Multiple GPSIs | 17.6.0 | +| 2022-12 | CT#98 | CP-223049 | 0066 | 1 | F | MSK in Primary Authentication Successful Response | 17.7.0 | +| 2022-12 | CT#98 | CP-223066 | 0068 | - | F | 29.526 Rel-17 API version and External doc update | 17.7.0 | +| 2022-12 | CT#98 | CP-223028 | 0065 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0067 | - | F | 29.526 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230066 | 0070 | 1 | F | Corrections on the reference number | 18.1.0 | +| 2023-06 | CT#100 | CP-231027 | 0069 | 4 | F | Location header and missing Redirection clause | 18.2.0 | +| 2023-06 | CT#100 | CP-231073 | 0074 | 1 | F | Default Notification for Inter-PLMN Access | 18.2.0 | +| 2023-09 | CT#101 | CP-232058 | 0075 | - | F | Major API version | 18.3.0 | +| 2023-09 | CT#101 | CP-232271 | 0076 | 1 | F | 29.526 Rel-18 API version and External doc update | 18.3.0 | +| 2023-12 | CT#102 | CP-233027 | 0077 | - | F | Obsoleted HTTP/2 RFCs | 18.4.0 | +| 2023-12 | CT#102 | CP-233027 | 0078 | - | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29542/raw.md b/marked/Rel-18/29_series/29542/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..fbefaee8fd3d3403b754cc50d7ef3cefabcfa8f7 --- /dev/null +++ b/marked/Rel-18/29_series/29542/raw.md @@ -0,0 +1,849 @@ + + +# 3GPP TS 29.542 V18.3.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Session Management Services for Non-IP Data Delivery (NIDD); 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 below that, the text 'A GLOBAL INITIATIVE' 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, symbols and abbreviations ..... | 7 | +| 3.1 Terms..... | 7 | +| 3.2 Symbols..... | 7 | +| 3.3 Abbreviations ..... | 7 | +| 4 Overview..... | 7 | +| 4.1 Introduction ..... | 7 | +| 5 Services offered by the SMF for NIDD ..... | 8 | +| 5.1 Introduction ..... | 8 | +| 5.2 Nsmf_NIDD Service ..... | 8 | +| 5.2.1 Service Description ..... | 8 | +| 5.2.2 Service Operations..... | 8 | +| 5.2.2.1 Introduction..... | 8 | +| 5.2.2.2 Delivery ..... | 8 | +| 5.2.2.2.1 General ..... | 8 | +| 6 API Definitions ..... | 9 | +| 6.1 Nsmf_NIDD Service API..... | 9 | +| 6.1.1 Introduction ..... | 9 | +| 6.1.2 Usage of HTTP..... | 9 | +| 6.1.2.1 General..... | 9 | +| 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..... | 10 | +| 6.1.3 Resources..... | 10 | +| 6.1.3.1 Overview..... | 10 | +| 6.1.3.2 Resource: Individual PDU session ..... | 11 | +| 6.1.3.2.1 Description ..... | 11 | +| 6.1.3.2.2 Resource Definition..... | 11 | +| 6.1.3.2.3 Resource Standard Methods..... | 11 | +| 6.1.3.2.4 Resource Custom Operations..... | 12 | +| 6.1.3.2.4.2.1 Description..... | 12 | +| 6.1.3.2.4.2.2 Operation Definition ..... | 12 | +| 6.1.4 Custom Operations without associated resources ..... | 13 | +| 6.1.5 Notifications ..... | 13 | +| 6.1.6 Data Model ..... | 13 | +| 6.1.6.1 General..... | 13 | +| 6.1.6.2 Structured data types..... | 14 | +| 6.1.6.2.1 Introduction ..... | 14 | +| 6.1.6.2.2 Type: DeliverReqData..... | 14 | +| 6.1.6.2.3 Type: DeliverAddInfo..... | 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 ..... | 14 | +| 6.1.6.4.1 Type: DeliverError ..... | 14 | +| 6.1.6.5 Binary data..... | 15 | +| 6.1.6.5.1 Mobile Terminated 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 | +| 6.1.10 | HTTP redirection..... | 16 | +| Annex A (normative): | OpenAPI specification ..... | 17 | +| A.1 | General..... | 17 | +| A.2 | Nsmf_NIDD API ..... | 17 | +| Annex B (informative): | Change history ..... | 20 | + +# 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 Interfaces for Non-IP Data Delivery (NIDD). It provides stage 3 protocol definitions and message flows, and specifies the API for the service offered by the SMF. + +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: "Hypertext Transfer Protocol Version 2 (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 29.541: "5G System (5GS); Network Exposure (NE) function services for Non-IP Data Delivery (NIDD) and Short Message Services (SMS); Stage 3". +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Terms + +Void. + +## 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 | +| H-SMF | Home SMF | +| I-SMF | Intermediate SMF | +| NEF | Network Exposure Function | +| NIDD | Non-IP Data Delivery | +| MT | Mobile Terminated | +| SMF | Session Management Function | +| V-SMF | Visited SMF | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the SMF offers services to the NF service consumers via the Nsmf 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 services specified within the present specification. + +![Reference model diagram showing the NEF connected to the SMF via the N29 reference point.](06da11ab76cacc38bbcd714e437797ea_img.jpg) + +The diagram illustrates the reference model for the SMF. It features two main components: a Network Exposure Function (NEF) on the left and a Session Management Function (SMF) on the right. The NEF is represented by a light green rectangle. The SMF is represented by a larger light green rectangle with a semi-circular interface on its left side. A horizontal line connects the NEF to the SMF's interface. This line is labeled with 'N29' near the NEF and 'Nsmf' near the SMF's interface, indicating the reference point and service based interface respectively. + +Reference model diagram showing the NEF connected to the SMF via the N29 reference point. + +Figure 4.1-1: Reference model – SMF + +N29 is the reference point between the (H-)SMF and the NEF. + +The functionalities supported by the SMF are listed in clause 6.2.2 of 3GPP TS 23.501 [2]. + +# 5 Services offered by the SMF for NIDD + +## 5.1 Introduction + +The SMF supports the following service(s) for NIDD. + +**Table 5.1-1: NF Service(s) provided by SMF for NIDD** + +| Service Name | Description | Example Consumer | +|--------------|---------------------------------------------------------------------------------|------------------| +| Nsmf_NIDD | This service allows the NF consumer NF to deliver NIDD MT data to PDU sessions. | NEF | + +## 5.2 Nsmf\_NIDD Service + +### 5.2.1 Service Description + +The Nsmf\_NIDD service operates on the PDU Sessions. The service operations exposed by this service allow an NF consumer (i.e. NEF) to deliver NEF anchored Mobile Terminated (MT) data for a given PDU session of a UE towards the SMF. + +The Nsmf\_NIDD service supports the following service operations: + +**Table 5.2.1-1: Service operations supported by the Nsmf\_NIDD service** + +| Service Operations | Description | Operation Semantics | Example Consumer(s) | +|--------------------|---------------------------------------------------------|---------------------|---------------------| +| Delivery | Deliver MT NIDD user data to the PDU session of the UE. | Request/Response | NEF | + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +See Table 5.2.1-1 for an overview of the service operations supported by the Nsmf\_NIDD service. + +#### 5.2.2.2 Delivery + +##### 5.2.2.2.1 General + +The Delivery service operation shall be used to transfer NEF anchored MT data for a given PDU session. + +It is used in the following procedures: + +- NEF anchored Mobile Terminated Data Transport (see clause 4.25.5 of 3GPP TS 23.502 [3]). + +The NF Service Consumer (i.e. NEF) shall deliver MT data to the SMF by using the HTTP POST method ("deliver" custom operation) as shown in Figure 5.2.2.2.1-1. + +![Sequence diagram showing the transfer of MT data from an NF Service Consumer to an SMF. The consumer sends a POST request to the URI '.../pdu-sessions/{pduSessionRef}/deliver' with 'DeliverReqData'. The SMF responds with either a 204 No Content (2a) or an error status code (2b) such as 4xx/5xx (DeliverError/ProblemDetails) or 3xx.](562f471e8153729557e6a4ee6343c32c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SMF + Note right of NF Service Consumer: 1. POST .../pdu-sessions/{pduSessionRef}/deliver (DeliverReqData) + NF Service Consumer->>SMF: Request + Note left of SMF: 2a. 204 No Content + SMF-->>NF Service Consumer: Response 2a + Note left of SMF: 2b. 4xx/5xx (DeliverError/ProblemDetails) or 3xx + SMF-->>NF Service Consumer: Response 2b + +``` + +Sequence diagram showing the transfer of MT data from an NF Service Consumer to an SMF. The consumer sends a POST request to the URI '.../pdu-sessions/{pduSessionRef}/deliver' with 'DeliverReqData'. The SMF responds with either a 204 No Content (2a) or an error status code (2b) such as 4xx/5xx (DeliverError/ProblemDetails) or 3xx. + +**Figure 5.2.2.2.1-1: Transfer MT Data** + +1. The NF Service Consumer shall send a POST request to the URI of "deliver" custom operation on an Individual PDU session resource in the SMF. The content of the POST request shall contain the MT data to be delivered. + +NOTE: The URI of the individual PDU session resource is provided by SMF to the NEF during SMF-NEF connection creation (see clause 5.2.2.2.1 of 3GPP TS 29.541 [14]). + +- 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 DeliverError or ProblemDetails object, with the "cause" attribute indicating the cause of the failure. If Estimated Maximum Waiting Time is received from AMF, the SMF shall include it in the message body. + +# 6 API Definitions + +## 6.1 Nsmf\_NIDD Service API + +### 6.1.1 Introduction + +The Nsmf\_NIDD service shall use the Nsmf\_NIDD API. + +The API URI of the Nsmf\_NIDD API shall be: + +**{apiRoot}///** + +The request URI used in HTTP request 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 "nsmf-nidd". +- 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 Nsmf\_NIDD API is contained in Annex A. + +#### 6.1.2.2 HTTP standard headers + +##### 6.1.2.2.1 General + +The usage of HTTP standard headers shall be supported as 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 [12]). 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 [13]). The use of the Problem Details JSON object in a HTTP response body shall be signalled by the content type "application/problem+json". + +NOTE: "application/json" is used in a response that includes a payload body containing an application-specific data structure, see clause 4.8 of 3GPP TS 29.501 [5]. + +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 or two binary body parts 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.5gnas | Binary encoded payload, encoding a 5GS NAS message or 5G NAS IEs, as specified in 3GPP TS 24.501 [7]. | + +See clause 6.1.6.5 for the binary payloads supported in the binary body part of multipart messages. + +#### 6.1.2.3 HTTP custom headers + +In this release of the specification, no specific custom headers are defined for the Nsmf\_NIDD 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.1.3 Resources + +#### 6.1.3.1 Overview + +Figure 6.1.3.1-1 describes the resource URI structure of the Nsmf\_NIDD API. + +![Figure 6.1.3.1-1: Resource URI structure of the Nsmf_NIDD API. The diagram shows a hierarchical tree structure of URI paths. The root is {apiRoot}/nsmf-nidd/. It branches to /pdu-sessions, which branches to /{pduSessionRef}, which finally branches to /deliver. The /deliver path is enclosed in a dashed box.](e9314c83043183351ed74908e9bf2f90_img.jpg) + +``` + + {apiRoot}/nsmf-nidd/ + | + +-- /pdu-sessions + | + +-- /{pduSessionRef} + | + +-- /deliver + +``` + +Figure 6.1.3.1-1: Resource URI structure of the Nsmf\_NIDD API. The diagram shows a hierarchical tree structure of URI paths. The root is {apiRoot}/nsmf-nidd/. It branches to /pdu-sessions, which branches to /{pduSessionRef}, which finally branches to /deliver. The /deliver path is enclosed in a dashed box. + +**Figure 6.1.3.1-1: Resource URI structure of the Nsmf\_NIDD 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 | +|------------------------|---------------------------------------|---------------------------------|----------------------------| +| Individual PDU session | /pdu-sessions/{pduSessionRef}/deliver | deliver (POST) | Delivery Service Operation | + +#### 6.1.3.2 Resource: Individual PDU session + +##### 6.1.3.2.1 Description + +This resource represents an individual PDU session created in SMF for NIDD. + +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}/nsmf-nidd//pdu-sessions/{pduSessionRef} + +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 | Definition | +|---------------|-------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| apiVersion | See clause 6.1.1 | +| pduSessionRef | PDU session reference assigned by the SMF during SMF-NEF Connection creation. | + +##### 6.1.3.2.3 Resource Standard Methods + +None. + +##### 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 | +|-----------------------|--------------------|-----------------------------| +| {resourceUri}/deliver | POST | Delivery service operation. | + +###### 6.1.3.2.4.2 Operation: deliver + +###### 6.1.3.2.4.2.1 Description + +This custom operation enables to deliver NEF anchored MT data for a given PDU session towards the SMF. + +###### 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 | +|----------------|---|-------------|----------------------------------------------------| +| DeliverReqData | M | 1 | Representation of the payload of a Deliver Request | + +**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 | Successful delivery of MT data. | +| RedirectResponse | O | 0..1 | 307 Temporary Redirect | Temporary redirection.
(NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection.
(NOTE 2) | +| DeliverError | O | 0..1 | 504 Gateway Timeout | The "cause" attribute may be used to indicate the following application errors:
- UE_NOT_REACHABLE, if the UE is not reachable to deliver the mobile terminated data; if Estimated Maximum Waiting Time shall be included if available;

See table 6.1.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 when needed (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.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 SMF or SMF (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 SMF or SMF (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 + +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 Nsmf\_NIDD service based interface protocol. + +**Table 6.1.6.1-1: Nsmf\_NIDD specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------|----------------|-----------------------------------------------|---------------| +| DeliverReqData | 6.1.6.2.2 | Information within Deliver Request | | +| DeliverAddInfo | 6.1.6.2.3 | Deliver Error Response Additional Information | | +| DeliverError | 6.1.6.4.1 | Deliver Error Response | | + +Table 6.1.6.1-2 specifies data types re-used by the N 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 N service based interface. + +**Table 6.1.6.1-2: Nsmf\_NIDD re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|------------------|---------------------|------------------------------------------------------------------------------------------------|---------------| +| RefToBinaryData | 3GPP TS 29.571 [15] | Cross-Reference to binary data encoded within a binary body part in an HTTP multipart message. | | +| ProblemDetails | 3GPP TS 29.571 [15] | Error description | | +| DurationSec | 3GPP TS 29.571 [15] | Duration in units of seconds | | +| RedirectResponse | 3GPP TS 29.571 [15] | Redirect Response | | + +#### 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: DeliverReqData + +**Table 6.1.6.2.2-1: Definition of type DeliverReqData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------------|---|-------------|----------------------------------------------------------------------------|---------------| +| mtData | RefToBinaryData | M | 1 | This IE shall reference the Mobile Terminated Data (see clause 6.1.6.5.1). | | + +##### 6.1.6.2.3 Type: DeliverAddInfo + +**Table 6.1.6.2.3-1: Definition of type DeliverAddInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------|---|-------------|-----------------------------------------------------------------------------------------------|---------------| +| maxWaitingTime | DurationSec | C | 0..1 | This IE shall contain the estimated maximum wait time (see clause 4.25.5 of 3GPP 23.502 [3]). | | + +#### 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 + +##### 6.1.6.4.1 Type: DeliverError + +**Table 6.1.6.4.1-1: Definition of type DeliverError as a list of "to be combined data types"** + +| Data type | Cardinality | Description | Applicability | +|----------------|-------------|----------------------------------------------------------|---------------| +| ProblemDetails | 1 | Detail information of the problem | | +| DeliverAddInfo | 1 | Additional information to be returned in error response. | | + +#### 6.1.6.5 Binary data + +##### 6.1.6.5.1 Mobile Terminated Data + +Mobile Terminated Data shall encode the Data Contents of the Payload Container specified in 3GPP TS 24.501 [7], using the vnd.3gpp.5gnas content-type, as summarized in Table 6.1.6.5.1-1. + +**Table 6.1.6.5.1-1: Mobile Terminated Data** + +| Mobile Terminated Data | Reference
(3GPP TS 24.501 [7]) | Related NAS SM message | +|---------------------------------------------|-----------------------------------|------------------------| +| Payload container contents in octets 4 to n | 9.11.3.39 | DL NAS Transport | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nsmf\_NIDD 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 Nsmf\_NIDD API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nsmf\_NIDD service are specified. + +#### 6.1.7.3 Application Errors + +The common application errors defined in Table 5.2.7.2-1 of 3GPP TS 29.500 [4] may be used for the Nsmf\_NIDD service. + +The application errors defined for the Nsmf\_NIDD service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|---------------------|------------------------------------------| +| UE_NOT_REACHABLE | 504 Gateway Timeout | The UE is not reachable for the service. | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nsmf\_NIDD 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 Nsmf\_NIDD 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 Nsmf\_NIDD 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 Nsmf\_NIDD service. + +The Nsmf\_NIDD API defines scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [15]; it defines a single scope consisting on the name of the service (i.e., "nsmf-nidd"), 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 SMF service instance, within the same SMF or a different SMF of an SMF set, e.g. when an SMF service instance is part of an SMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). + +An SCP that reselects a different SMF producer instance will return the NF Instance ID of the new SMF 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 SMF within an SMF set redirects a service request to a different SMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new SMF 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 Nsmf\_NIDD Service API. 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 Nsmf\_NIDD API + +``` +openapi: 3.0.0 + +info: + version: '1.2.0-alpha.1' + title: 'Nsmf_NIDD' + description: | + SMF NIDD Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.542 V18.0.0; 5G System; Session Management Services for Non-IP Data + Delivery (NIDD); Stage 3 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.542/ + +servers: + - url: '{apiRoot}/nsmf-nidd/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501. + +security: + - {} + - oAuth2ClientCredentials: + - nsmf-nidd + +paths: + '/pdu-sessions/{pduSessionRef}/deliver': + post: + summary: Delivery Service Operation + tags: + - Individual PDU session + operationId: Deliver + parameters: + - name: pduSessionRef + in: path + description: PDU session reference + required: true + schema: + type: string + requestBody: + description: representation of the payload of Deliver Request + required: true + content: +``` + +``` + + multipart/related: # message with a binary body part + schema: + type: object + properties: + jsonData: + $ref: '#/components/schemas/DeliverReqData' + binaryMtData: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryMtData: + contentType: application/vnd.3gpp.5gnas + headers: + Content-Id: + schema: + type: string + responses: + '204': + description: successful transfering of Delivery + '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': + description: unsuccessful delivery of mobile terminated data - gateway timeout + content: + application/json: + schema: + $ref: '#/components/schemas/DeliverError' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + nsmf-nidd: Access to the nsmf-nidd API + +schemas: +# +# STRUCTURED DATA TYPES +# + +DeliverReqData: + description: Representation of the payload of a Deliver Request. + type: object + properties: + mtData: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + required: + +``` + +- mtData + +DeliverAddInfo: +description: Additional information in an error response to a Deliver Request. +type: object +properties: + maxWaitingTime: + \$ref: 'TS29571\_CommonData.yaml#/components/schemas/DurationSec' + +# + +# DATA TYPES DESCRIBING ALTERNATIVE OR COMBINATION OF DATA TYPES + +# + +DeliverError: +description: Representation of the payload in an error response to a Deliver Request. +allOf: + - \$ref: 'TS29571\_CommonData.yaml#/components/schemas/ProblemDetails' + - \$ref: '#/components/schemas/DeliverAddInfo' + +# Annex B (informative): Change history + +| Change history | | | | | | | | | +|----------------|----------|-----------|------|-----|-----|-----------------------------------------------------|--|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | | New version | +| 2020-03 | CT4#96-e | C4-201267 | | | | Initial Draft. | | 0.1.0 | +| 2020-03 | CT#87e | CP-200093 | | | | Presented for information and approval | | 1.0.0 | +| 2020-03 | CT#87e | | | | | Approved at CT#87e | | 16.0.0 | +| 2020-06 | CT#88e | CP-201071 | 0001 | 2 | F | Storage of YAML files in ETSI Forge | | 16.1.0 | +| 2020-06 | CT#88e | CP-201046 | 0003 | | F | Miscellaneous Corrections | | 16.1.0 | +| 2020-06 | CT#88e | CP-201073 | 0004 | | F | 29.542 Rel-16 API version and External doc update | | 16.1.0 | +| 2020-09 | CT#89e | CP-202105 | 0005 | | F | Optionality of DeliverError | | 16.2.0 | +| 2020-12 | CT#90e | CP-203032 | 0007 | | F | YAML files in 3GPP Forge | | 16.3.0 | +| 2021-03 | CT#91e | CP-210037 | 0010 | 1 | F | HTTP 3xx redirection | | 17.0.0 | +| 2021-03 | CT#91e | CP-210034 | 0011 | 1 | F | OpenAPI Reference | | 17.0.0 | +| 2021-03 | CT#91e | CP-210054 | 0013 | - | F | 29.542 Rel-16 API version and External doc update | | 17.0.0 | +| 2021-06 | CT#92e | CP-210050 | 0014 | 1 | F | Resolving Warning in Nsmf_NIDD API | | 17.1.0 | +| 2021-06 | CT#92e | CP-210050 | 0017 | 1 | A | Redirect Response | | 17.1.0 | +| 2021-06 | CT#92e | CP-210050 | 0018 | | F | 29.542 Rel-17 API version and External doc update | | 17.1.0 | +| 2021-09 | CT#93e | CP-212060 | 0021 | - | A | 3xx description correction for SCP | | 17.2.0 | +| 2022-03 | CT#95e | CP-220025 | 0025 | 1 | F | SMF reference model update | | 17.3.0 | +| 2022-06 | CT#96 | CP-221051 | 0027 | | F | 29.542 Rel-17 API version and External doc update | | 17.4.0 | +| 2022-12 | CT#98 | CP-223028 | 0029 | 1 | F | Missing Mandatory Status Codes in OpenAPI | | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0030 | | F | 29.542 Rel-18 API version and External doc update | | 18.0.0 | +| 2023-06 | CT#100 | CP-231028 | 0031 | 3 | F | Location header description | | 18.1.0 | +| 2023-09 | CT#101 | CP-232063 | 0035 | 1 | F | Update on the references | | 18.2.0 | +| 2023-12 | CT#102 | CP-233029 | 0036 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | | 18.3.0 | +| 2023-12 | CT#102 | CP-233030 | 0037 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | | 18.3.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29543/raw.md b/marked/Rel-18/29_series/29543/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..fba8170f5f7514a3c6ffb02f602e316774381dcb --- /dev/null +++ b/marked/Rel-18/29_series/29543/raw.md @@ -0,0 +1,1559 @@ + + +# 3GPP TS 29.543 V18.1.0 (2024-06) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Data Transfer Policy 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 small capital 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. + +© 2024, 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 Data Transfer Policy Control Services offered by the PCF ..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Npcf_PDTQPolicyControl Service ..... | 10 | +| 5.2.1 Service Description ..... | 10 | +| 5.2.2 Service Operations..... | 10 | +| 5.2.2.1 Introduction..... | 10 | +| 5.2.2.2 Npcf_PDTQPolicyControl_Create service operation..... | 10 | +| 5.2.2.2.1 General ..... | 10 | +| 5.2.2.2.2 Retrieval of PDTQ policies..... | 10 | +| 5.2.2.3 Npcf_PDTQPolicyControl_Update service operation..... | 13 | +| 5.2.2.3.1 General ..... | 13 | +| 5.2.2.3.2 Indication about selected PDTQ policy ..... | 13 | +| 5.2.2.3.3 Modification of PDTQ warning notification request indication ..... | 14 | +| 5.2.2.4 Npcf_PDTQPolicyControl_Notify service operation..... | 14 | +| 5.2.2.4.1 General ..... | 14 | +| 5.2.2.4.2 Sending the PDTQ warning notification ..... | 14 | +| 6 API Definitions ..... | 15 | +| 6.1 Npcf_PDTQPolicyControl Service API..... | 15 | +| 6.1.1 Introduction ..... | 15 | +| 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.3 Resources..... | 16 | +| 6.1.3.1 Overview..... | 16 | +| 6.1.3.2 Resource: PDTQ policies (Collection) ..... | 17 | +| 6.1.3.2.1 Description ..... | 17 | +| 6.1.3.2.2 Resource Definition..... | 17 | +| 6.1.3.2.3 Resource Standard Methods..... | 17 | +| 6.1.3.2.4 Resource Custom Operations..... | 18 | +| 6.1.3.3 Resource: Individual PDTQ policy (Document) ..... | 18 | +| 6.1.3.3.1 Description ..... | 18 | +| 6.1.3.3.2 Resource Definition..... | 18 | +| 6.1.3.3.3 Resource Standard Methods..... | 18 | +| 6.1.4 Custom Operations without associated resources ..... | 20 | +| 6.1.5 Notifications ..... | 21 | +| 6.1.5.1 General..... | 21 | +| 6.1.5.2 PDTQ warning notification ..... | 21 | +| 6.1.5.2.1 Description ..... | 21 | +| 6.1.5.2.2 Target URI..... | 21 | +| 6.1.5.2.3 Standard Methods..... | 21 | +| 6.1.6 Data Model ..... | 22 | +| 6.1.6.1 General..... | 22 | + +| | | | +|------------------------------------------------------------|----------------------------------------------------------------------------------|-----------| +| 6.1.6.2 | Structured data types..... | 23 | +| 6.1.6.2.1 | Introduction ..... | 23 | +| 6.1.6.2.2 | Type: PdtqPolicyData ..... | 24 | +| 6.1.6.2.3 | Type: QosParameterSet..... | 26 | +| 6.1.6.2.4 | Type: AltQosParamSet..... | 26 | +| 6.1.6.2.5 | Type: PdtqPolicy ..... | 27 | +| 6.1.6.2.6 | Type PdtqPolicyPatchData..... | 27 | +| 6.1.6.2.7 | Type Notification ..... | 27 | +| 6.1.6.3 | Simple data types and enumerations..... | 27 | +| 6.1.6.3.1 | Introduction ..... | 27 | +| 6.1.6.3.2 | Simple data types ..... | 27 | +| 6.1.6.4 | Data types describing alternative data types or combinations of data types ..... | 28 | +| 6.1.6.5 | Binary data ..... | 28 | +| 6.1.6.5.1 | Binary Data Types..... | 28 | +| 6.1.7 | Error Handling ..... | 28 | +| 6.1.7.1 | General ..... | 28 | +| 6.1.7.2 | Protocol Errors ..... | 28 | +| 6.1.7.3 | Application Errors ..... | 28 | +| 6.1.8 | Feature negotiation ..... | 28 | +| 6.1.9 | Security ..... | 28 | +| Annex A (normative): OpenAPI specification..... | | 30 | +| A.1 | General ..... | 30 | +| A.2 | Npcf_PDTQPolicyControl API ..... | 30 | +| Annex B (informative): Withdrawn API versions ..... | | 35 | +| B.1 | General ..... | 35 | +| B.2 | Npcf_PDTQPolicyControl API ..... | 36 | +| Annex C (informative): Change history..... | | 37 | + +# 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 Service Based Interface (SBI) of the Data Transfer Policy Control Services. It provides stage 3 protocol definitions and message flows, and specifies the APIs of the Data Transfer Policy Control Services offered by the Policy Control Function (PCF). + +The 5G System stage 2 architecture is specified in 3GPP TS 23.501 [2]. The stage 2 definition and related procedures for Data Transfer Policy Control Services are specified in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [14]. + +The 5G System stage 3 call flows are provided in 3GPP TS 29.513 [15]. + +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] 3GPP TS 23.503: "Policy and Charging Control Framework for the 5G System; Stage 2". +- [15] 3GPP TS 29.513: "5G System; Policy and Charging Control signalling flows and QoS parameter mapping; Stage 3". +- [16] 3GPP TS 29.504: "5G System; Unified Data Repository Services; 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 29.520: "5G System; Network Data Analytics Services; Stage 3". +- [19] IETF RFC 7396: "JSON Merge Patch". +- [20] IETF RFC 3986: "Uniform Resource Identifier (URI): Generic Syntax". +- [21] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [22] 3GPP TS 29.554: "5G System; Background Data Transfer Policy Control Service; Stage 3". +- [23] 3GPP TS 29.122: "T8 reference point for Northbound APIs". + +# --- 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: + +- 5G System** +- Network Function** +- NF service** +- Service based interface** + +## 3.2 Symbols + +No symbol is defined in this Release of the present document. + +## 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]. + +| | | +|---------|-------------------------------------------------------| +| 5QI | 5G QoS Identifier | +| AF | Application Function | +| ASP | Application Service Provider | +| DNN | Data Network Name | +| NEF | Network Exposure Function | +| NWDAF | Network Data Analytics Function | +| PCF | Policy Control Function | +| PDTQ | Planned Data Transfer with QoS | +| QoS | Quality of Service | +| S-NSSAI | Single Network Slice Selection Assistance Information | +| SBI | Service Based Interface | +| TAI | Tracking Area Identity | +| UDR | Unified Data Repository | + +# --- 4 Overview + +The Data Transfer Policy Control Services, as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [14], are part of the Npcf service based interface exhibited by the Policy Control Function (PCF). + +The Network Exposure Function (NEF) is the only NF service consumer of the Data Transfer Policy Control Services. + +The NEF accesses the Data Transfer Policy Control Services at the PCF via the N30 Reference point. In this release, the roaming is not supported. + +Figures 4-1 and 4-2 depict the Data Transfer Policy Control Services related reference architecture of the PCF respectively in SBI representation and reference point representation. + +![Figure 4-1: Reference Architecture for the Npcf Data Transfer Policy Control Services; SBI representation. This diagram shows a Service Based Interface (SBI) between the PCF and the NEF. The PCF is at the top, represented by a rectangle with a small circle at its bottom edge. The NEF is at the bottom, represented by a rectangle. A vertical line connects the circle on the PCF to the NEF, and this line is labeled 'Npcf'.](367926125450c2bc3f4bdca9d59a62ba_img.jpg) + +Figure 4-1: Reference Architecture for the Npcf Data Transfer Policy Control Services; SBI representation. This diagram shows a Service Based Interface (SBI) between the PCF and the NEF. The PCF is at the top, represented by a rectangle with a small circle at its bottom edge. The NEF is at the bottom, represented by a rectangle. A vertical line connects the circle on the PCF to the NEF, and this line is labeled 'Npcf'. + +Figure 4-1: Reference Architecture for the Npcf Data Transfer Policy Control Services; SBI representation + +![Figure 4-2: Reference Architecture for the Npcf Data Transfer Policy Control Services; reference point representation. This diagram shows a reference point connection between the PCF and the NEF. The PCF is at the top, represented by a rectangle. The NEF is at the bottom, represented by a rectangle. A vertical line connects the PCF to the NEF, and this line has a small horizontal tick mark in the middle, labeled 'N30'.](0b87abe67b21a93777287649c33e755d_img.jpg) + +Figure 4-2: Reference Architecture for the Npcf Data Transfer Policy Control Services; reference point representation. This diagram shows a reference point connection between the PCF and the NEF. The PCF is at the top, represented by a rectangle. The NEF is at the bottom, represented by a rectangle. A vertical line connects the PCF to the NEF, and this line has a small horizontal tick mark in the middle, labeled 'N30'. + +Figure 4-2: Reference Architecture for the Npcf Data Transfer Policy Control Services; reference point representation + +# 5 Data Transfer Policy Control Services offered by the PCF + +## 5.1 Introduction + +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 | +|-------------------------|--------|--------------------------------------------------------------|-------------------------------------|--------------------------|-------| +| Npcf_PDTQPolicy Control | 5.2 | Planned Data Transfer with QoS (PDTQ) Policy Control service | TS29543_Npcf_PDTQPolicyControl.yaml | npcf-pdtq-policy-control | A.2 | + +## 5.2 Npcf\_PDTQPolicyControl Service + +### 5.2.1 Service Description + +The PDTQ Policy Control service, as defined in 3GPP TS 23.502 [3] and 3GPP TS 23.503 [14], provides negotiation for planned data transfer with QoS requirements (PDTQ) policies. + +The PDTQ Policy Control service offers the following functionalities: + +- provide PDTQ policies based on the request from the NF service consumer; +- update an existing PDTQ data based on the request from the NF service consumer; and +- provide a PDTQ warning notification to trigger renegotiation of a PDTQ policy. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operations defined for the Npcf\_PDTQPolicyControl service are shown in table 5.2.2.1-1. + +**Table 5.2.2.1-1: Operations of the Npcf\_PDTQPolicyControl service** + +| Service operation name | Description | Initiated by | +|-------------------------------|------------------------------------------------------------------|--------------------------------| +| Npcf_PDTQPolicyControl_Create | Provides the requested PDTQ policies to the NF service consumer. | NF service consumer (e.g. NEF) | +| Npcf_PDTQPolicyControl_Update | Updates the existing PDTQ data. | NF service consumer (e.g. NEF) | +| Npcf_PDTQPolicyControl_Notify | Sends a PDTQ warning notification to the NF service consumer. | PCF | + +#### 5.2.2.2 Npcf\_PDTQPolicyControl\_Create service operation + +##### 5.2.2.2.1 General + +The Npcf\_PDTQPolicyControl\_Create service operation is used by an NF service consumer to request the PCF to create an "Individual PDTQ policy" resource. + +The following procedure using the Npcf\_PDTQPolicyControl\_Create service operation is supported: + +- retrieval of PDTQ policies. + +##### 5.2.2.2.2 Retrieval of PDTQ policies + +This procedure is used by the NF service consumer to request PDTQ policies from the PCF, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [14]. + +Figure 5.2.2.2.2-1 illustrates retrieval of PDTQ policies. + +![Sequence diagram showing the interaction between an NF service consumer and a PCF for the retrieval of PDTQ policies. The NF service consumer sends a POST request to .../pdtq-policies, and the PCF responds with a 201 Created status.](5a4e62bead259c258d069fd3663ea670_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. POST .../pdtq-policies + NF service consumer->>PCF: Request + Note left of PCF: 2. "201 Created" + PCF-->>NF service consumer: Response + +``` + +Sequence diagram showing the interaction between an NF service consumer and a PCF for the retrieval of PDTQ policies. The NF service consumer sends a POST request to .../pdtq-policies, and the PCF responds with a 201 Created status. + +**Figure 5.2.2.2.2-1: Retrieval of PDTQ policies** + +In order to get PDTQ policies, the NF service consumer shall invoke the Npcf\_PDTQPolicyControl\_Create service operation by sending an HTTP POST request to the URI representing a "PDTQ policies" collection resource of the PCF (as shown in figure 5.2.2.2.2-1, step 1). The NF service consumer shall include in a body of the HTTP POST request a PdtqPolicyData data type which shall contain: + +- a) an ASP identifier in the "aspId" attribute; +- b) an expected number of UEs in the "numOfUes" attribute; +- c) a list of desired time windows in the "desTimeInts" attribute; +- d) requested QoS requirements provided as a QoS Reference in the "qosReference" attribute or as a QoS parameter set in the "qosParamSet" attribute that shall contain one or more of the following individual QoS parameters: + - 1) Priority Level in the "priorLevel" attribute; + - 2) Maximum Burst Size: + - A) if the Maximum Burst Size value is greater than 4095 Bytes in the "extMaxBurstSize" attribute; or + - B) if the Maximum Burst Size value is lower than or equal to 4095 Bytes in the "maxBurstSize" attribute; + - 3) 5GS Delay in the "pdb" attribute; + - 4) Maximum Bitrate in downlink and/or uplink directions in the "maxBitRateDI" and/or "maxBitRateUI" attributes; + - 5) Guaranteed Flow Bitrate in downlink and/or uplink directions in the "gfbrDI" and/or "gfbrUI" attributes; and + - 6) Packet Error Rate in the "per" attribute, + +and may contain: + +- a) a network area information (e.g. list of TAIs and/or list of NG-RAN nodes and/or list of cells identifiers) in the "nwAreaInfo" attribute; +- b) an application identifier in the "appId" attribute; +- c) a DNN corresponding to the ASP identifier, in the "dnn" attribute; +- d) an S-NSSAI corresponding to the ASP identifier, in the "snssai" attribute; +- e) alternative service requirements provided as: + - 1) one or more alternative QoS References in a prioritized order in the "altQosRefs" attribute; or + - 2) one or more alternative QoS Parameter Sets in a prioritized order in the "altQosParamSets" attribute which shall contain one or more of the following individual QoS parameters: + - A) 5GS Delay in the "pdb" attribute; + +- B) Guaranteed Flow Bitrate in downlink and/or uplink directions in the "gfbrDI" and/or "gfbrUI" attributes; and + - C) Packet Error Rate in the "per" attribute; and +- f) a notification URI in the "notifUri" attribute and a request to enable a PDTQ warning notification for the planned data transfer with QoS requirements in the "warnNotifReq" attribute. + +NOTE 1: The PCF can be configured to map the ASP identifier to a target DNN and S-NSSAI if the NF service consumer did not provide the DNN, S-NSSAI to the PCF. + +Upon the reception of the HTTP POST request from the NF service consumer indicating a PDTQ policies request, the PCF: + +- a) shall invoke the Nudr\_DataRepository\_Query service operation, as described in 3GPP TS 29.504 [16] and 3GPP TS 29.519 [17], to request from the UDR all existing PDTQ policies; +- b) may invoke the Nnwdaf\_EventsSubscription\_Subscribe service operation and/or the Nnwdaf\_AnalyticsInfo\_Request service operation as described in 3GPP TS 29.520 [18], to get from the NWDAF the Network Performance analytics or the DN Performance analytics; + +NOTE 2: Whether the PCF subscribes to Network Performance analytics or DN Performance analytics is based on PCF configuration. + +- c) shall determine one or more acceptable PDTQ policy based on: + - 1) information provided by the NF service consumer; and + - 2) other available information (e.g. the network analytics related to "Network Performance" or "DN Performance", the existing PDTQ policies, the network policy); +- d) shall create a PDTQ Reference ID; +- e) shall send to the NF service consumer a "201 Created" response to the HTTP POST request, as shown in figure 5.2.2.2.2-1, step 2. The PCF shall include in the "201 Created" response a Location header field containing the URI of the created "Individual PDTQ policy" resource, and the response body with a PdtqPolicyData data type which shall contain: + - 1) acceptable PDTQ policy/ies in the "pdtqPolicies" attribute. For each included PDTQ policy, the PCF shall provide: + - A) an identity of a PDTQ policy represented as an integer value greater than zero in the "pdtqPolicyId" attribute; and + - B) recommended time window in the "recTimeInt" attribute; and + - 2) the PDTQ Reference ID in the "pdtqRefId" attribute; or +- f) 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, shall send the HTTP error response as specified in clause 6.1.7. + +If the PCF included in the PdtqPolicyData data type: + +- more than one PDTQ policy, the PCF shall wait for an indication about selected PDTQ policy from the NF service consumer as described in clause 5.2.2.3.2; or +- only one PDTQ policy, the PCF shall invoke the Nudr\_DataRepository\_Update service operation, as described in 3GPP TS 29.504 [16] and 3GPP TS 29.519 [17], to update the UDR with the selected PDTQ policy, the corresponding PDTQ Reference ID, the expected number of UEs, the list of desired time windows, the QoS Reference or individual QoS parameters, whether the PDTQ policy renegotiation has been accepted and, if available, the network area information and the alternative service requirements listed in a prioritized order for the provided ASP identifier. + +NOTE 3: The selected PDTQ policy can be deleted in the PCF when the time window within the "recTimeInt" attribute reaches the maximum timestamp value. + +#### 5.2.2.3 Npcf\_PDTQPolicyControl\_Update service operation + +##### 5.2.2.3.1 General + +The Npcf\_PDTQPolicyControl\_Update service operation is used by an NF service consumer to request the PCF to update an existing "Individual PDTQ policy" resource. + +The following procedures using the Npcf\_PDTQPolicyControl\_Update service operation are supported: + +- indication about selected PDTQ policy; and +- modification of a PDTQ warning notification request indication. + +##### 5.2.2.3.2 Indication about selected PDTQ policy + +This procedure is used by the NF service consumer to inform the PCF about selected PDTQ policy, as defined in 3GPP TS 23.501 [2], 3GPP TS 23.502 [3] and 3GPP TS 23.503 [14], if the PDTQ policy has been selected from the received list of PDTQ policies after: + +- retrieval of PDTQ policies as described in clause 5.2.2.2.2; or +- reception of a PDTQ warning notification as described in clause 5.2.2.4.2. + +Figure 5.2.2.3.2-1 illustrates an indication about selected PDTQ policy. + +![Sequence diagram illustrating the indication about selected PDTQ policy. The NF service consumer sends a PATCH request to the PCF. The PCF responds with either a 204 No Content or a 200 OK.](5dfc130b129ace4df375839020a5700d_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of NF service consumer: 1. PATCH .../pdtq-policies/{pdtqPolicyId} + NF service consumer->>PCF: 1. PATCH .../pdtq-policies/{pdtqPolicyId} + Note left of PCF: 2a. "204 No Content" or + Note left of PCF: 2b. "200 OK" + PCF-->>NF service consumer: 2a. "204 No Content" or + PCF-->>NF service consumer: 2b. "200 OK" +``` + +Sequence diagram illustrating the indication about selected PDTQ policy. The NF service consumer sends a PATCH request to the PCF. The PCF responds with either a 204 No Content or a 200 OK. + +**Figure 5.2.2.3.2-1: Indication about selected PDTQ policy** + +In order to inform the PCF about selected PDTQ policy, the NF service consumer shall invoke the Npcf\_PDTQPolicyControl\_Update service operation by sending an HTTP PATCH targeting the URI of the corresponding "Individual PDTQ policy" resource (as shown in figure 5.2.2.3.2-1, step 1). The NF service consumer shall include in a body of the HTTP PATCH request a PdtqPolicyPatchData data type which shall contain: + +- a) if the NF service consumer has provided the selected PDTQ policy, the identifier of the selected PDTQ policy in the "selPdtqPolicyId" attribute; or +- b) in case of a PDTQ policy renegotiation and if no PDTQ policy has been selected, the "selPdtqPolicyId" attribute set to value "0" to indicate no PDTQ policy is selected. + +Upon the reception of the HTTP PATCH request from the NF service consumer, if 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 [4]. Otherwise, the PCF: + +- a) in case of the initial PDTQ policy negotiation, may invoke the Nudr\_DataRepository\_Update service operation, as described in 3GPP TS 29.504 [16] and 3GPP TS 29.519 [17], with the selected PDTQ policy, the corresponding PDTQ Reference ID, the expected number of UEs, the list of desired time windows, the QoS Reference or individual QoS parameters, whether the PDTQ policy renegotiation has been accepted and, if available, the network area information and the alternative service requirements listed in a prioritized order for the provided ASP identifier; + +- b) in case of the PDTQ policy renegotiation if the PDTQ policy is selected and the PCF invoked the Nudr\_DataRepository\_Update service operation during the initial PDTQ policy negotiation the PCF shall invoke the Nudr\_DataRepository\_Update service operation, as described in 3GPP TS 29.504 [16] and 3GPP TS 29.519 [17], to update the UDR with the selected PDTQ policy; and + +NOTE: If the NF service consumer has not provided any of the PDTQ policies included in the candidate list, the previously negotiated PDTQ policy shall be kept. + +- c) shall acknowledge the received HTTP PATCH request by sending to the NF service consumer: + - 1) a "204 No Content" response (as shown in figure 5.2.2.3.2-1, step 2a); + - 2) a "200 OK" response (as shown in figure 5.2.2.3.2-1, step 2b) with a PdtqPolicyData data type in the response body; or + - 3) 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, an HTTP error response as specified in clause 6.1.7. + +##### 5.2.2.3.3 Modification of PDTQ warning notification request indication + +This procedure is used by the NF service consumer to inform the PCF whether the PDTQ warning notification has to be enabled or disabled. + +In order to modify a PDTQ warning notification request indication, the NF service consumer shall invoke the Npcf\_PDTQPolicyControl\_Update service operation by sending an HTTP PATCH request to the PCF, as described in clause 5.2.2.3.2. The NF service consumer shall include in a PdtqPolicyPatchData data type a "warnNotifReq" attribute set to value: + +- "false" if the PDTQ warning notification is no longer required; or +- "true" if the PDTQ warning notification is required. + +If the PDTQ warning notification is required and a notification URI was not previously provided or has been changed, the NF service consumer shall include: + +- the notification URI in the "notifUri" attribute. + +Upon the reception of the HTTP PATCH request from the NF service consumer indicating a modification of the PDTQ warning notification request indication, the PCF shall: + +- acknowledge that request by sending an HTTP response message as described in clause 5.2.2.3.2; and +- if the PCF invoked the Nudr\_DataRepository\_Update service operation during the initial PDTQ policy negotiation, invoke the Nudr\_DataRepository\_Update service operation, as described in 3GPP TS 29.504 [16] and 3GPP TS 29.519 [17], to update the UDR with the modified PDTQ warning notification request indication. + +#### 5.2.2.4 Npcf\_PDTQPolicyControl\_Notify service operation + +##### 5.2.2.4.1 General + +The Npcf\_PDTQPolicyControl\_Notify service operation is used by the PCF to send a PDTQ notification to the NF service consumer. + +The following procedure using the Npcf\_PDTQPolicyControl\_Notify service operation is supported: + +- sending a PDTQ warning notification to the NF service consumer. + +##### 5.2.2.4.2 Sending the PDTQ warning notification + +This procedure is used by the PCF to provide a list of new candidate PDTQ policies to the NF service consumer due to a network performance or DN performance degradation, as defined in clause 4.16.15.2.2 of 3GPP TS 23.502 [3] and clause 6.1.2.7 of 3GPP TS 23.503 [14]. + +Figure 5.2.2.4.2-1 illustrates a PDTQ warning notification from the PCF. + +![Sequence diagram showing PDTQ warning notification between NF service consumer and PCF.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +sequenceDiagram + participant NF service consumer + participant PCF + Note right of PCF: 1. POST {notifUri} + PCF->>NF service consumer: + Note left of NF service consumer: 2. "204 No Content" + NF service consumer->>PCF: +``` + +The diagram illustrates a sequence of two messages between an NF service consumer and a PCF. The first message, labeled '1. POST {notifUri}', is sent from the PCF to the NF service consumer. The second message, labeled '2. "204 No Content"', is sent from the NF service consumer back to the PCF. + +Sequence diagram showing PDTQ warning notification between NF service consumer and PCF. + +Figure 5.2.2.4.2-1: PDTQ warning notification + +When the PCF gets the notification from the NWDAF, that the network performance or DN performance in the requested area of interest reaches the reporting threshold as described in 3GPP TS 29.520 [18] and if the PDTQ warning notification is enabled, the PCF may try to renegotiate the affected PDTQ policies. To do this, the PCF retrieves all the PDTQ policies together with their additionally stored NF service consumer provided information for PDTQ policy decision (e.g. their corresponding list of desired time windows, the number of UEs, etc.) from the UDR, identifies the PDTQ policy(ies) that are not desirable anymore due to the degradation of the network performance or DN performance and tries to calculate one or more new candidate PDTQ policies based on the NF service consumer provided information, the PDTQ policies retrieved from the UDR and the current network performance or DN performance. If the PCF does not find any new candidate PDTQ policy, the previously negotiated PDTQ policy shall be kept and no interaction with the NF service consumer shall occur. + +If one or more new candidate PDTQ policies are calculated, the PCF shall invoke the Npcf\_PDTQPolicyControl\_Notify service operation by sending the HTTP POST request with a PDTQ warning notification to the NF service consumer. + +The PCF shall include in a body of the HTTP POST request a "Notification" data type which shall contain: + +- the PDTQ Reference ID of the impacted PDTQ policy within the "pdtqRefId" attribute; and +- the list of candidates PDTQ policies in the "candPolicies" attribute. + +NOTE: The NF service consumer might, or might not provide a new PDTQ policy from the offered candidate list. + +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 with the corresponding status code: + +- 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]; +- if the HTTP POST request from the PCF is accepted, the NF service consumer shall acknowledge the receipt of the notification with a "204 No Content" response to HTTP POST request, as shown in figure 5.2.2.4.2-1, step 2; or +- if the HTTP POST request from the PCF is not accepted, the NF service consumer shall send an HTTP error response as specified in clause 6.1.7. + +# 6 API Definitions + +## 6.1 Npcf\_PDTQPolicyControl Service API + +### 6.1.1 Introduction + +The PDTQ Policy Control shall use the Npcf\_PDTQPolicyControl API. + +The API URI of the Npcf\_PDTQPolicyControl 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 "npcf-pdtq-policy-control". +- 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 Npcf\_PDTQPolicyControl API is contained in clause A.2. + +#### 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]. + +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 [19]. + +#### 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 Npcf\_PDTQPolicyControl API. + +![Diagram showing the resource URI structure of the Npcf_PDTQPolicyControl API. The root URI is {apiRoot}/npcf-pdtq-policy-control/. A line branches from this root to a box containing /pdtq-policies. Another line branches from the /pdtq-policies box to a box containing /{pdtqPolicyId}.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +graph TD + Root["{apiRoot}/npcf-pdtq-policy-control/"] --> Policies["/pdtq-policies"] + Policies --> PolicyId["/{pdtqPolicyId}"] + +``` + +Diagram showing the resource URI structure of the Npcf\_PDTQPolicyControl API. The root URI is {apiRoot}/npcf-pdtq-policy-control/. A line branches from this root to a box containing /pdtq-policies. Another line branches from the /pdtq-policies box to a box containing /{pdtqPolicyId}. + +**Figure 6.1.3.1-1: Resource URI structure of the Npcf\_PDTQPolicyControl 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) | +|------------------------|--------------------------------------------|---------------------------------|-------------------------------------------------------| +| PDTQ policies | /pdtq-policies | POST | Creates a new Individual PDTQ policy resource. | +| Individual PDTQ policy | /pdtq-policies/{pdtqPolicyId} | GET | Reads an Individual PDTQ policy resource. | +| | | PATCH | Modifies an existing Individual PDTQ policy resource. | + +#### 6.1.3.2 Resource: PDTQ policies (Collection) + +##### 6.1.3.2.1 Description + +The PDTQ policies resource represents all PDTQ policies that exist in the PDTQ Policy Control service at a given PCF instance. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/npcf-pdtq-policy-control//pdtq-policies + +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 | +|----------------|---|-------------|---------------------------------------------------------------------------------| +| PdtqPolicyData | M | 1 | Contains information for the creation of a new Individual PDTQ policy 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 | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|----------------------------------------------------------------------------------------------------------------------| +| PdtqPolicyData | M | 1 | 201 Created | Successful case.
An Individual PDTQ policy resource is created 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 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}/npcf-pdtq-policy-control//pdtq-policies/{pdtqPolicyId} | + +##### 6.1.3.2.4 Resource Custom Operations + +None. + +#### 6.1.3.3 Resource: Individual PDTQ policy (Document) + +##### 6.1.3.3.1 Description + +The Individual PDTQ policy resource represents the planned data transfer with QoS requirements policy that exist in the PDTQ Policy Control service at a given PCF instance. + +##### 6.1.3.3.2 Resource Definition + +Resource URI: {apiRoot}/npcf-pdtq-policy-control//pdtq-policies/{pdtqPolicyId} + +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. | +| pdtqPolicyId | string | Identifies the individual PDTQ policy resource in the PCF.
To enable the value to be used as part of a URI, the string shall only contain allowed characters according to the "lower-with-hyphen" naming convention defined in clause 5.1.3 of 3GPP TS 29.501 [5] and rules for a path segment defined in IETF RFC 3986 [20]. | + +##### 6.1.3.3.3 Resource Standard Methods + +###### 6.1.3.3.3.1 GET + +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 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.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 GET Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|-------------| +| n/a | | | | + +**Table 6.1.3.3.3.1-3: Data structures supported by the GET Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|---------------------------------------------------------------------| +| PdtqPolicyData | M | 1 | 200 OK | A representation of an Individual PDTQ policy 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) | +| ProblemDetails | O | 0..1 | 404 Not Found | (NOTE 3) | + +NOTE 1: 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. + +NOTE 2: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +NOTE 3: Failure cases are described in clause 6.1.7. + +**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 | 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 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 | 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. | + +###### 6.1.3.3.3.2 PATCH + +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 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.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 PATCH Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------------|---|-------------|-----------------------------------------------------------------------------------------------| +| PdtqPolicyPatchData | M | 1 | Contains modifications that shall be applied on the existing Individual PDTQ policy resource. | + +**Table 6.1.3.3.3.2-3: Data structures supported by the PATCH Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------| +| PdtqPolicyData | M | 1 | 200 OK | The Individual PDTQ policy resource is modified and a representation of that resource is returned. | +| n/a | | | 204 No Content | The Individual PDTQ policy resource is modified. | +| 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 | (NOTE 3) | + +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: The RedirectResponse data structure may be provided by an SCP (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). + +NOTE 3: Failure cases are described in clause 6.1.7. + +**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 | 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 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 | 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. | + +### 6.1.4 Custom Operations without associated resources + +No custom operation is defined in this Release of the specification. + +### 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) | +|---------------------------|--------------|---------------------------------|---------------------------------------| +| PDTQ warning notification | {notifUri} | POST | Provides a PDTQ warning notification. | + +#### 6.1.5.2 PDTQ warning notification + +##### 6.1.5.2.1 Description + +The PDTQ warning notification is used by the PCF to notify the NF service consumer about changed conditions for a planned data transfer with QoS requirements e.g. that a network performance or DN performance in the area of interest goes below the criteria set by the operator. + +##### 6.1.5.2.2 Target URI + +The Callback URI "{notifUri}" 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 | +|----------|-----------------------------------------------| +| notifUri | String formatted as URI with the Callback Uri | + +##### 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-2. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|---------------------------------------| +| Notification | M | 1 | Provides a PDTQ warning notification. | + +**Table 6.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 | The reception of a PDTQ warning notification is acknowledged. | +| 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 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 (refer to clause 6.10.9.1 of 3GPP TS 29.500 [4]). | | | | | + +**Table 6.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 | Contains an alternative URI representing the end point of an alternative NF service consumer instance towards which the notification 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 consumer instance towards which the notification request is redirected. | + +**Table 6.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 | Contains an alternative URI representing the end point of an alternative NF service consumer instance towards which the notification 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 consumer instance towards which the notification request is redirected. | + +### 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 Npcf\_PDTQPolicyControl service based interface protocol. + +**Table 6.1.6.1-1: Npcf\_PDTQPolicyControl specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|---------------------|----------------|---------------------------------------------------------------------------------------------------|---------------| +| AltQosParamSet | 6.1.6.2.4 | Contains the alternative QoS requirements expressed as the list of individual QoS parameter sets. | | +| Notification | 6.1.6.2.7 | Contains the PDTQ notification information. | | +| PdtqPolicy | 6.1.6.2.5 | Describes a PDTQ policy. | | +| PdtqPolicyData | 6.1.6.2.2 | Describes an Individual PDTQ policy resource. | | +| PdtqPolicyPatchData | 6.1.6.2.6 | Represents modifications of an Individual PDTQ policy resource. | | +| PdtqReferenceId | 6.1.6.3.2 | Represents a PDTQ Reference ID. | | +| QosParameterSet | 6.1.6.2.3 | Contains the QoS requirements expressed as one or more individual QoS parameters. | | + +Table 6.1.6.1-2 specifies data types re-used by the Npcf\_PDTQPolicyControl 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\_PDTQPolicyControl service based interface. + +Table 6.1.6.1-2: Npcf\_PDTQPolicyControl re-used Data Types + +| Data type | Reference | Comments | Applicability | +|--------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| 5QiPriorityLevel | 3GPP TS 29.571 [21] | Represents 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. | | +| ApplicationId | 3GPP TS 29.571 [21] | Contains the application identifier. | | +| BitRate | 3GPP TS 29.571 [21] | Represents the bitrate in kbits per second. | | +| Dnn | 3GPP TS 29.571 [21] | Identifies a Data Network Name. | | +| ExtMaxDataBurstVol | 3GPP TS 29.571 [21] | Represents the Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501 [2]), expressed in Bytes.
Minimum = 4096. Maximum = 2000000. | | +| MaxDataBurstVol | 3GPP TS 29.571 [21] | Represents the Maximum Data Burst Volume (see clauses 5.7.3.7 and 5.7.4 of 3GPP TS 23.501 [2]), expressed in Bytes.
Minimum = 1. Maximum = 4095. | | +| NetworkAreaInfo | 3GPP TS 29.554 [22] | Describes a network area information in which the NF service consumer requests the number of UEs. | | +| PacketDelBudget | 3GPP TS 29.571 [21] | Represents the Packet Delay Budget (see clauses 5.7.3.4 and 5.7.4 of 3GPP TS 23.501 [2]), expressed in milliseconds. | | +| PacketErrRate | 3GPP TS 29.571 [21] | Represents the Packet Error Rate (see clause 5.7.3.5 and 5.7.4 of 3GPP TS 23.501 [2]), expressed as a "scalar x 10 -k " where the scalar and the exponent k are each encoded as one decimal digit. | | +| ProblemDetails | 3GPP TS 29.571 [21] | Used in error responses to provide more detailed information about an error. | | +| RedirectResponse | 3GPP TS 29.571 [21] | Contains redirection related information. | | +| Snssai | 3GPP TS 29.571 [21] | Identifies a Single Network Slice Selection Assistance Information. | | +| SupportedFeatures | 3GPP TS 29.571 [21] | Used to negotiate the applicability of the optional features defined in table 6.1.8-1. | | +| TimeWindow | 3GPP TS 29.122 [23] | Specifies a time interval. | | +| Uri | 3GPP TS 29.571 [21] | String providing an URI. | | + +#### 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: PdtqPolicyData + +**Table 6.1.6.2.2-1: Definition of type PdtqPolicyData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| altQosParamSets | array(AltQosParamSet) | O | 1..N | This IE contains the alternative QoS requirements expressed as the list of individual QoS parameter sets in a prioritized order.
The lower the index of the array for a given entry, the higher the priority.
(NOTE 4) | | +| altQosRefs | array(string) | O | 1..N | This IE contains the alternative QoS requirements expressed as the list of QoS References in a prioritized order.
The lower the index of the array for a given entry, the higher the priority.
(NOTE 3) | | +| appId | ApplicationId | O | 0..1 | This IE contains an application identifier. | | +| aspId | string | M | 1 | This IE contains an identity of an application service provider. | | +| desTimeInts | array(TimeWindow) | M | 1..N | This IE contains a list of desired time windows for PDTQ. | | +| dnn | Dnn | O | 0..1 | This IE identifies a DNN. A full DNN with both the Network Identifier and Operator Identifier, or a DNN with the Network Identifier only.
(NOTE 1) | | +| notifUri | Uri | O | 0..1 | This IE contains an URI of the recipient of the PDTQ notification. | | +| nwAreaInfo | NetworkAreaInfo | O | 0..1 | This IE represents a network area information in which the NF service consumer requests a number of UEs. | | +| numOfUes | integer | M | 1 | This IE indicates a number of UEs. | | +| pdtqPolicies | array(PdtqPolicy) | C | 1..N | This IE contains PDTQ policies.
Shall be present in the response of the create message. | | +| pdtqRefId | PdtqReferenceId | O | 0..1 | This IE identifies PDTQ policies of planned data transfer with QoS requirements for provided ASP. | | +| qosParamSet | QosParameterSet | C | 0..1 | This IE contains the requested QoS requirements expressed as one or more individual QoS parameters.
(NOTE 2) | | +| qosReference | string | C | 0..1 | This IE contains the requested QoS requirements expressed as the QoS Reference which represents a pre-defined QoS information.
(NOTE 2) | | +| selPdtqPolicyId | integer | O | 0..1 | This IE contains the identity of the selected PDTQ policy.
(NOTE 5) | | +| snssai | Snssai | O | 0..1 | This IE identifies a slice. | | +| suppFeat | SupportedFeatures | O | 0..1 | This IE represents a list of Supported features used as described in clause 6.1.8. | | +| warnNotifReq | boolean | O | 0..1 | This IE indicates whether the PDTQ warning notification is enabled or disabled.

true: enabled;
false: disabled (default). | | + +| | +|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| NOTE 1: The PCF uses the DNN as received from the NF service consumer 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. | +| NOTE 2: Either the "qosReference" attribute or the "qosParamSet" attribute shall be included. | +| NOTE 3: The "altQosRefs" attribute may be included only if the ""qosReference" attribute is included. | +| NOTE 4: The "altQosParamSets" attribute may be included only if the "qosParamSet" attribute is included. | +| NOTE 5: The value "0" indicates that no PDTQ policy is selected. | + +##### 6.1.6.2.3 Type: QosParameterSet + +**Table 6.1.6.2.3-1: Definition of type QosParameterSet** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------------------------------------------------------------------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------|---------------| +| extMaxBurstSize | ExtMaxDataBurstVol | O | 0..1 | This IE represents the Maximum Burst Size value greater than 4095 Bytes. (NOTE 1) | | +| gfbrDI | BitRate | O | 0..1 | This IE represents the Guaranteed Flow Bitrate in downlink direction. | | +| gfbrUI | BitRate | O | 0..1 | This IE represents the Guaranteed Flow Bitrate in uplink direction. | | +| maxBitRateDI | BitRate | O | 0..1 | This IE represents the Maximum Bitrate in downlink direction. | | +| maxBitRateUI | BitRate | O | 0..1 | This IE represents the Maximum Bitrate in uplink direction. | | +| maxBurstSize | MaxDataBurstVol | O | 0..1 | This IE represents the Maximum Burst Size value lower than or equal to 4095 Bytes. (NOTE 1) | | +| pdb | PacketDelBudget | O | 0..1 | This IE represents the 5GS Packet Delay Budget. | | +| per | PacketErrRate | O | 0..1 | This IE represents the Packet Error Rate. | | +| priorLevel | 5QIPriorityLevel | O | 0..1 | This represents the Priority Level. | | +| NOTE 1: The attributes "extMaxBurstSize" and "maxBurstSize" are mutually exclusive. | | | | | | +| NOTE 2: At least one of the attributes shall be present. | | | | | | + +##### 6.1.6.2.4 Type: AltQosParamSet + +**Table 6.1.6.2.4-1: Definition of type AltQosParamSet** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------------------------------------------|-----------------|---|-------------|-----------------------------------------------------------------------|---------------| +| gfbrDI | BitRate | O | 0..1 | This IE represents the Guaranteed Flow Bitrate in downlink direction. | | +| gfbrUI | BitRate | O | 0..1 | This IE represents the Guaranteed Flow Bitrate in uplink direction. | | +| pdb | PacketDelBudget | O | 0..1 | This IE represents the 5GS Packet Delay Budget. | | +| per | PacketErrRate | O | 0..1 | This IE represents the Packet Error Rate. | | +| NOTE: At least one of the attributes shall be present. | | | | | | + +##### 6.1.6.2.5 Type: PdtqPolicy + +Table 6.1.6.2.5-1: Definition of type PdtqPolicy + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|------------|---|-------------|--------------------------------------------------------------|---------------| +| pdtqPolicyId | integer | M | 1 | This IE contains an identity of a PDTQ policy.
(NOTE) | | +| recTimeInt | TimeWindow | M | 1 | This IE contains a recommended time window of a PDTQ policy. | | + +NOTE: The identity of a PDTQ policy shall be greater than zero. + +##### 6.1.6.2.6 Type PdtqPolicyPatchData + +Table 6.1.6.2.6-1: Definition of type PdtqPolicyPatchData + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------|-----------|---|-------------|---------------------------------------------------------------------------------------------------------------------------|---------------| +| notifUri | Uri | O | 0..1 | This IE contains an URI of the recipient of the PDTQ notification. | | +| selPdtqPolicyId | integer | O | 0..1 | This IE contains an identity (i.e. the pdtqPolicyId value) of a selected PDTQ policy.
(NOTE 2) | | +| warnNotifReq | boolean | O | 0..1 | This IE indicates whether the PDTQ warning notification is enabled or disabled.

true: enabled;
false: disabled. | | + +NOTE 1: At least one of the attributes shall be included. +NOTE 2: The value "0" indicates that no PDTQ policy is selected. + +##### 6.1.6.2.7 Type Notification + +Table 6.1.6.2.7-1: Definition of type Notification + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------|---------------| +| pdtqRefId | PdtqReferenceId | M | 1 | This IE identifies the PDTQ policy to which the notification corresponds. | | +| candPolicies | array(PdtqPolicy) | M | 1..N | This IE contains a list of the candidate PDTQ policies from which the NF service consumer may provide a new PDTQ policy. | | + +#### 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 | +|-----------------|-----------------|---------------------------------|---------------| +| PdtqReferenceId | string | Represents a PDTQ Reference ID. | | + +#### 6.1.6.4 Data types describing alternative data types or combinations of data types + +There are no data types describing alternative data types or combinations of data types defined for this API in this Release of the present document. + +#### 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 | +|------|----------------|--------------| +| | | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Npcf\_PDTQPolicyControl 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 Npcf\_PDTQPolicyControl API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Npcf\_PDTQPolicyControl service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Npcf\_PDTQPolicyControl service are listed in table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|----------------------------------------------------------------------------------------------------| +| PDTQ_POLICY_NOT_FOUND | 404 Not Found | The HTTP request is rejected because the specified Individual PDTQ policy resource does not exist. | +| NOTE: Including a "ProblemDetails" data structure with the "cause" attribute in the HTTP response is optional unless explicitly mandated in the service operation clauses. | | | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Npcf\_PDTQPolicyControl 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 Npcf\_PDTQPolicyControl 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 Npcf\_PDTQPolicyControl 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 Npcf\_PDTQPolicyControl service. + +The Npcf\_PDTQPolicyControl API defines a single scope "npcf-pdtq-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 + +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 Npcf\_PDTQPolicyControl API + +``` +openapi: 3.0.0 + +info: + title: Npcf_PDTQPolicyControl API + version: 1.0.0 + description: | + PCF PDTQ Policy Control service. + © <2024>, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.543 V18.1.0; 5G System; Data Transfer Policy Control Services; Stage 3. + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.543/' + +servers: + - url: '{apiRoot}/npcf-pdtq-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-pdtq-policy-control + +paths: + + /pdtq-policies: + post: + summary: Creates a new Individual PDTQ policy resource. + operationId: CreatePDTQPolicy + tags: + - PDTQ policies (Collection) + requestBody: + description: > + Contains information for the creation of a new Individual PDTQ policy resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqPolicyData' + responses: + '201': + description: > +``` + +``` +Created, an Individual PDTQ policy resource is created and a representation of that +resource is returned. +content: + application/json: + schema: + $ref: '#/components/schemas/PdtqPolicyData' +headers: + Location: + description: > + Contains the URI of the created Individual PDTQ policy resource, + according to the structure + {apiRoot}/npcf-pdtq-policy-control/v1/pdtq-policies/{pdtqPolicyId} + 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: + PDTQNotification: + '{ $request.body#/notifUri }': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Notification' +responses: + '204': + description: > + No Content, the reception of a PDTQ warning 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' + +/pdtq-policies/{pdtqPolicyId}: + + get: + summary: Reads an Individual PDTQ policy resource. + operationId: GetIndPDTQPolicy + tags: + - Individual PDTQ policy (Document) + parameters: + - name: pdtqPolicyId + description: String identifying the individual PDTQ policy resource in the PCF. + in: path + required: true + schema: + type: string + responses: + '200': + description: OK, a representation of an Individual PDTQ policy resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/PdtqPolicyData' + '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 PDTQ policy resource. + operationId: ModifyIndPDTQPolicy + tags: + - Individual PDTQ policy (Document) + parameters: + - name: pdtqPolicyId + description: String identifying the individual PDTQ policy resource in the PCF. + in: path + required: true + schema: + type: string + requestBody: + description: > + Contains modifications that shall be applied on the existing Individual PDTQ + policy resource. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/PdtqPolicyPatchData' + responses: + '200': + description: > + OK, the Individual PDTQ policy resource is modified and a representation of + that resource is returned. + content: + application/json: +``` + +``` + + schema: + $ref: '#/components/schemas/PdtqPolicyData' + '204': + description: No Content, the Individual PDTQ policy resource is 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' + +components: + + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcf-pdtq-policy-control: Access to the Npcf_PDTQPolicyControl API + +schemas: + +# Structured data types + + PdtqPolicyData: + description: Describes an Individual PDTQ policy resource. + type: object + required: + - aspId + - destTimeInts + - numOfUes + oneOf: + - required: [qosReference] + - required: [qosParamSet] + properties: + altQosParamSets: + description: > + Contains the alternative QoS requirements expressed as the list of individual + QoS parameter sets in a prioritized order. The lower the index of the array for + a given entry, the higher the priority. + type: array + items: + $ref: '#/components/schemas/AltQosParamSet' + minItems: 1 + altQosRefs: + description: > + Contains the alternative QoS requirements expressed as the list of QoS References + in a prioritized order. The lower the index of the array for a given entry, the + higher the priority. + type: array + items: + type: string + minItems: 1 + appId: + +``` + +``` + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationId' + aspId: + description: Contains an identity of an application service provider. + type: string + desTimeInts: + description: Contains a list of desired time windows for PDTQ. + type: array + items: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + minItems: 1 + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + nwAreaInfo: + $ref: 'TS29554_Npcf_BDTPolicyControl.yaml#/components/schemas/NetworkAreaInfo' + numOfUes: + description: Indicates a number of UEs. + type: integer + pdtqPolicies: + description: Contains PDTQ policies. + type: array + items: + $ref: '#/components/schemas/PdtqPolicy' + minItems: 1 + pdtqRefId: + $ref: '#/components/schemas/PdtqReferenceId' + qosParamSet: + $ref: '#/components/schemas/QosParameterSet' + qosReference: + description: > + Contains the requested QoS requirements expressed as the QoS Reference which + represents a pre-defined QoS information. + type: string + selPdtqPolicyId: + description: Contains the identity of the selected PDTQ policy. + type: integer + snssai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + warnNotifReq: + description: > + Indicates whether the PDTQ warning notification is enabled (true) or + disabled (false). Default value is false. + type: boolean + default: false + +QosParameterSet: + description: > + Contains the QoS requirements expressed as one or more individual QoS parameters. + type: object + properties: + extMaxBurstSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVol' + gfbRdl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + gfbRul: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxBitRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxBitRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxBurstSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVol' + pdb: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + per: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + priorLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevel' + +AltQosParamSet: + description: > + Contains the alternative QoS requirements expressed as the list of individual QoS + parameter sets. + type: object + properties: +``` + +``` +gfbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' +gfbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' +pdb: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' +per: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + +PdtqPolicy: + description: Describes a PDTQ policy. + type: object + required: + - pdtqPolicyId + - recTimeInt + properties: + pdtqPolicyId: + description: Contains an identity of a PDTQ policy. + type: integer + recTimeInt: + $ref: 'TS29122_CommonData.yaml#/components/schemas/TimeWindow' + +PdtqPolicyPatchData: + description: Represents modifications of an Individual PDTQ policy resource. + type: object + properties: + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + selPdtqPolicyId: + description: Contains the identity of the selected PDTQ policy. + type: integer + warnNotifReq: + description: > + Indicates whether the PDTQ warning notification is enabled (true) or + disabled (false). + type: boolean + +Notification: + description: Contains the PDTQ notification information. + type: object + required: + - pdtqRefId + - candPolicies + properties: + pdtqRefId: + $ref: '#/components/schemas/PdtqReferenceId' + candPolicies: + description: > + Contains a list of the candidate PDTQ policies from which the NF service + consumer may provide a new PDTQ policy. + type: array + items: + $ref: '#/components/schemas/PdtqPolicy' + minItems: 1 + +# Simple data types + +PdtqReferenceId: + description: Represents a PDTQ Reference ID. + type: string +``` + +# --- 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 Npcf\_PDTQPolicyControl API + +The API versions listed in table B.2-1 are withdrawn for the Npcf\_PDTQPolicyControl API. + +**Table B.2-1: Withdrawn API versions of the Npcf\_PDTQPolicyControl service** + +| API version number | Remarks | +|--------------------|---------| +| | | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29544/raw.md b/marked/Rel-18/29_series/29544/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..77b8ff81de65568d065b4700f8cb3d57749c4ca2 --- /dev/null +++ b/marked/Rel-18/29_series/29544/raw.md @@ -0,0 +1,767 @@ + + +# 3GPP TS 29.544 V18.1.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Secured Packet Application Function (SP-AF) 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 Terms..... | 8 | +| 3.2 Symbols..... | 8 | +| 3.3 Abbreviations ..... | 8 | +| 4 Overview..... | 8 | +| 4.1 Introduction ..... | 8 | +| 5 Services offered by the SP-AF..... | 9 | +| 5.1 Introduction ..... | 9 | +| 5.2 Nspaf_SecuredPacket Service..... | 9 | +| 5.2.1 Service Description ..... | 9 | +| 5.2.2 Service Operations..... | 9 | +| 5.2.2.1 Introduction..... | 9 | +| 5.2.2.2 Provide ..... | 9 | +| 5.2.2.2.1 General ..... | 9 | +| 5.2.2.2.2 Secured Packet Retrieval..... | 9 | +| 6 API Definitions ..... | 10 | +| 6.1 Nspaf_SecuredPacket 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..... | 11 | +| 6.1.2.2.1 General ..... | 11 | +| 6.1.2.2.2 Content type ..... | 11 | +| 6.1.2.3 HTTP custom headers..... | 11 | +| 6.1.3 Resources..... | 11 | +| 6.1.3.1 Overview..... | 11 | +| 6.1.3.2 Resource: SecuredPacket..... | 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..... | 12 | +| 6.1.3.2.4.2.1 Description..... | 12 | +| 6.1.3.2.4.2.2 Operation Definition ..... | 12 | +| 6.1.4 Custom Operations without associated resources ..... | 13 | +| 6.1.5 Notifications ..... | 13 | +| 6.1.6 Data Model ..... | 13 | +| 6.1.6.1 General..... | 13 | +| 6.1.6.2 Structured data types..... | 13 | +| 6.1.6.2.1 Introduction ..... | 13 | +| 6.1.6.2.2 Type: UiccConfigurationParameter ..... | 14 | +| 6.1.6.2.3 Type: ExtendedSteeringContainer ..... | 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.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 Nspaf\_SecuredPacket API..... 16 +**Annex B (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 Nspaf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the SP-AF. + +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] 3GPP TS 29.503: "Unified Data Management Services"; Stage 3. +- [15] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [16] 3GPP TS 31.115: "Secured packet structure for (Universal) Subscriber Identity Module (U)SIM Toolkit applications". +- [17] 3GPP TS 29.509: "Authentication Server Services; Stage 3". +- [18] 3GPP TS 23.040: "Technical realization of the Short Message Service (SMS)" +- [19] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". + +# 3 Definitions, symbols and abbreviations + +## 3.1 Terms + +Void. + +## 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]. + +| | | +|--------|------------------------------------------| +| OTA | Over The Air | +| SOR-AF | Steering Of Roaming Application Function | +| SP-AF | Secured Packet Application Function | +| UDM | Unified Data Management | + +# 4 Overview + +## 4.1 Introduction + +Within the 5GC, the SP-AF offers services to the UDM and to the SOR-AF via the Nspaf service based interface. + +The UDM or SOR-AF shall make use of the SP-AF services when it needs to protect UE parameters for which the final consumer is the USIM (see 3GPP TS 33.501 [8] clause 6.15.2.1). + +Figure 4.1-1 provides the reference model with focus on the SP-AF. + +NOTE: The generation of the secured packet and the definition of the storage and handling of OTA keys or other sensitive data are out of scope of this document. For more details, refer to 3GPP TS 23.040 [18] and 3GPP TS 31.115 [16]. + +![Reference model diagram showing UDM and SOR-AF connected to SP-AF via the Nspaf interface.](6078636a87fbe0e699aab4a6fddd15d7_img.jpg) + +The diagram illustrates the reference model for the SP-AF. On the left, there are two rectangular boxes labeled 'UDM' and 'SOR-AF'. Lines from both boxes converge to a single point labeled 'Nspaf'. From this point, a line connects to a large green rectangular box on the right labeled 'SP-AF'. + +Reference model diagram showing UDM and SOR-AF connected to SP-AF via the Nspaf interface. + +Figure 4.1-1: Reference model – SP-AF + +# 5 Services offered by the SP-AF + +## 5.1 Introduction + +The SP-AF offers the following services via the Nspaf interface: + +- Nspaf\_SecuredPacket 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 | +|---------------------|--------|------------------------------|-----------------------------------|----------------------|-------| +| Nspaf_SecuredPacket | 6.1 | Nspaf Secured Packet Service | TS29544_Nspaf_SecuredPacket .yaml | nspaf-secured-packet | A.2 | + +## 5.2 Nspaf\_SecuredPacket Service + +### 5.2.1 Service Description + +The Nspaf\_SecuredPacket Service may be consumed by the NF consumer (e.g. UDM or SOR-AF) when it has detected that a UICC configuration parameter (e.g. Routing ID data or Steering of Roaming information) needs to be updated, and the new value is not available in secured packet format. + +For the list of service operations see clause 5.2.2.1 + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +For the Nspaf\_SecuredPacket service the following service operations are defined: + +- Provide + +The Nspaf\_SecuredPacket Service is used by Consumer NFs (e.g. UDM or SOR-AF) to request the SP-AF to provide a secured packet that contains an UICC configuration parameter as sent in the request by means of the Provide service operation + +#### 5.2.2.2 Provide + +##### 5.2.2.2.1 General + +This service operation is used by the NF Service Consumer (e.g. UDM or SOR-AF) to request construction of a secured packet that contains the provided UICC configuration information (e.g. Routing Indicator or Steering of Roaming information). + +The following procedures using the Provide service operation are supported: + +- Secured Packet Retrieval + +##### 5.2.2.2.2 Secured Packet Retrieval + +Figure 5.2.2.2.2-1 shows a scenario where the NF consumer (e.g. UDM or SOR-AF) sends a request to the SP-AF to provide a secured packet. + +The request contains the UE's identity (/{supi}) and the UICC configuration parameter. + +![Sequence diagram showing the interaction between an NF-consumer and an SP-AF. The NF-consumer sends a POST request to the SP-AF. The SP-AF responds with either a 200 OK (SecuredPacket) or a 404 Not Found.](e6df2733626a85205c1db682e6259c46_img.jpg) + +``` + +sequenceDiagram + participant NF-consumer + participant SP-AF + Note right of NF-consumer: 1. POST.../{supi}/provide-secured-packet (UiccConfigurationParameter) + NF-consumer->>SP-AF: Request + Note left of SP-AF: 2a. 200 OK (SecuredPacket) + SP-AF-->>NF-consumer: Response 2a + Note left of SP-AF: 2b. 404 Not Found + SP-AF-->>NF-consumer: Response 2b + +``` + +Sequence diagram showing the interaction between an NF-consumer and an SP-AF. The NF-consumer sends a POST request to the SP-AF. The SP-AF responds with either a 200 OK (SecuredPacket) or a 404 Not Found. + +**Figure 5.2.2.2.2-1: NF consumer requests the SP-AF to provide a secured packet** + +1. The NF consumer sends a POST request (custom method: provide-secured-packet) to the resource representing the SUPI. +- 2a. On success, the SP-AF responds with "200 OK", containing the requested SecuredPacket. +- 2b. If the resource does not exist (the supi is unknown in the SP-AF), the SP-AF returns the HTTP status code "404 Not Found", and additional error information should be included in the response body (in "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 POST response body. + +# 6 API Definitions + +## 6.1 Nspaf\_SecuredPacket Service API + +### 6.1.1 Introduction + +The Nspaf\_SecuredPacket service shall use the Nspaf\_SecuredPacket 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 "nspaf-secured-packet". +- 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 Nspaf\_SecuredPacket 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 applicable. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +![Diagram showing the hierarchical structure of the nspaf-secured-packet API URI. The root is {apiRoot}/nspaf-secured-packet/. It branches to /{supi}, which in turn branches to /provide-secured-packet (indicated by a dashed box).](ca7c7526ec57cd5a2f278c194c0a6a00_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nspaf-secured-packet/"] --> Supi["/{supi}"] + Supi --> Packet["/provide-secured-packet"] + style Packet stroke-dasharray: 5 5 + +``` + +Diagram showing the hierarchical structure of the nspaf-secured-packet API URI. The root is {apiRoot}/nspaf-secured-packet/. It branches to /{supi}, which in turn branches to /provide-secured-packet (indicated by a dashed box). + +**Figure 6.1.3.1-1: Resource URI structure of the nspaf-secured-packet 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 | +|----------------------------------|--------------------------------|---------------------------------|--------------------------------------------------------------------------------------------| +| SecuredPacket (Custom operation) | /{supi}/provide-secured-packet | Provide-secured-packet (POST) | The SP-AF generates a secured packet containing the presented UICC configuration parameter | + +#### 6.1.3.2 Resource: SecuredPacket + +##### 6.1.3.2.1 Description + +This resource represents the information that is needed to construct secured packets for the SUPI. + +##### 6.1.3.2.2 Resource Definition + +Resource URI: {apiRoot}/nspaf-secured-packet/v1/{supi}/provide-secured-packet + +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 | Definition | +|---------|--------------------------------------------------------------------------------------------------------------------------------------| +| apiRoot | See clause 6.1.1 | +| supi | Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "^(imsi-[0-9]{5,15} nai-.[+.]\$)" | + +##### 6.1.3.2.3 Resource Standard Methods + +No Standard Methods are supported for this 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** + +| Custom operation URI | Mapped HTTP method | Description | +|-------------------------|--------------------|-------------------------------------------------------------------------------------------------------------| +| /provide-secured-packet | POST | The SP-AF generates a secured packet for the SUPI that contains the presented UICC configuration parameter. | + +###### 6.1.3.2.4.2 Operation: provide-secured-packet + +###### 6.1.3.2.4.2.1 Description + +This custom operation is used by the NF service consumer (e.g. UDM) to request a secured packet for the SUPI containing the presented UICC configuration parameter. The returned secured packet shall be constructed as an SMS-Deliver as specified in 3GPP TS 23.040 [18] and protected as specified in 3GPP TS 31.115 [16]. + +###### 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 | +|-----------------------------|---|-------------|----------------------------------------------------------| +| UiccConfiguration Parameter | M | 1 | Contains the parameter that is to be updated in the UICC | + +**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 | +|----------------------------------------------------------------------------------------------------------------------------|---|-------------|----------------|--------------------------------------------------------------------------------------------------| +| SecuredPacket | M | 1 | 200 OK | Upon success, a response body containing the generated secured packet shall be returned. | +| ProblemDetails | O | 0..1 | 404 Not Found | The "cause" attribute may be used to convey the following application error:
- USER NOT FOUND | +| 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. | | | | | + +### 6.1.4 Custom Operations without associated resources + +In this release of this specification, no custom operations without associated resources are defined for the Nspaf\_SecuredPacket Service. + +### 6.1.5 Notifications + +In this release of this specification, no notifications are defined for the Nspaf\_SecuredPacket 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 Nspaf service based interface protocol. + +**Table 6.1.6.1-1: Nspaf specific Data Types** + +| Data type | Clause defined | Description | Applicability | +|----------------------------|----------------|-----------------------------------------------------------------------------------------|---------------| +| UiccConfigurationParameter | 6.1.6.2.2 | UICC Configuration Parameters | | +| RoutingId | 6.1.6.3.2 | Routing ID | | +| ExtendedSteeringContainer | 6.1.6.2.3 | Extended Steering Container (including the contents of Steering Container and SOR-CMCI) | | + +Table 6.1.6.1-2 specifies data types re-used by the Nspaf 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 Nspaf service based interface. + +**Table 6.1.6.1-2: Nspaf re-used Data Types** + +| Data type | Reference | Comments | Applicability | +|----------------|---------------------|-----------------------------------------------------|---------------| +| SecuredPacket | 3GPP TS 29.503 [14] | Secured Packet | | +| ProblemDetails | 3GPP TS 29.571 [15] | | | +| SteeringInfo | 3GPP TS 29.509 [17] | Steering Information | | +| SorCmci | 3GPP TS 29.503 [14] | Contains SOR-CMCI as defined in 3GPP TS 24.501 [19] | | + +#### 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: UiccConfigurationParameter + +Table 6.1.6.2.2-1: Definition of type UiccConfigurationParameter + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| routingId | RoutingId | C | 0..1 | The Routing Id that needs to be updated in the USIM. | | +| steeringContainer | array(SteeringInfo) | C | 1..N | List of PLMN/AccessTechnologies combinations that need to be updated in the USIM. | | +| extendedSteeringContainer | ExtendedSteeringContainer | C | 0..1 | Extended Steering Container that includes list of PLMN/AccessTechnologies combinations with the SOR-CMCI that need to be updated in the USIM | | + +Note: Exactly one attribute shall be present + +##### 6.1.6.2.3 Type: ExtendedSteeringContainer + +Table 6.1.6.2.3-1: Definition of type ExtendedSteeringContainer + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-------------------|---------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| steeringContainer | array(SteeringInfo) | C | 1..N | List of PLMN/AccessTechnologies combinations that need to be updated in the USIM. | | +| sorCmci | SorCmci | C | 0..1 | When present, provides the SOR-CMCI values as defined in 3GPP TS 24.501 [19] | | +| storeSorCmciInMe | boolean | C | 0..1 | When present, indicates "Store the SOR-CMCI in the ME", i.e. whether to instruct UE to store SOR-CMCI in the ME as defined in 3GPP TS 23.122 [14] and 3GPP TS 24.501 [27].

- True: Indicates to store the SOR-CMCI in the ME
- False or absent: Indicates storing the SOR-CMCI in the ME is not required | | + +NOTE: At least one attribute shall be present. If no additional attributes than steeringContainer is included, then use of steeringContainer can be considered instead of using ExtendedSteeringContainer. + +#### 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 | +|-----------|-----------------|-------------------------|---------------| +| RoutingId | string | Pattern: "[0-9]{1,4}\$" | | + +### 6.1.7 Error Handling + +#### 6.1.7.1 General + +For the Nspaf\_SecuredPacket 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 Nspaf\_SecuredPacket API. + +#### 6.1.7.2 Protocol Errors + +No specific procedures for the Nspaf\_SecuredPacket service are specified. + +#### 6.1.7.3 Application Errors + +The application errors defined for the Nspaf\_SecuredPacket service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|-------------------|------------------|-------------------------| +| USER_NOT_FOUND | 404 Not Found | The user does not exist | + +### 6.1.8 Feature negotiation + +The optional features in table 6.1.8-1 are defined for the Nspaf\_SecuredPacket 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 Nspaf\_SecuredPacket 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 Nspaf\_SecuredPacket 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 Nspaf\_SecuredPacket service. + +The Nspaf\_SecuredPacket API defines a single scope "nspaf-secured-packet" 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: 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 Nspaf\_SecuredPacket API + +``` +openapi: 3.0.0 +info: + title: 'Nspaf_SecuredPacket' + version: '1.2.0-alpha.1' + description: | + Nspaf Secured Packet Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.544, SP-AF Services, version V18.0.0 + url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.544/ +servers: + - url: '{apiRoot}/nspaf-secured-packet/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +security: + - {} + - oAuth2ClientCredentials: + - nspaf-secured-packet +paths: + /{supi}/provide-secured-packet: + post: + summary: request generation of a secured packet + operationId: ProvideSecuredPacket + tags: + - SecuredPacket Generation (Custom Operation) + parameters: + - name: supi + in: path + description: SUPI of the user + required: true + schema: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UiccConfigurationParameter' + responses: + '200': + description: Success + content: +``` + +``` + + application/json: + schema: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SecuredPacket' + '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: + nspaf-secured-packet: Access to the nspaf-secured-packet API + schemas: + +# COMPLEX TYPES: + +UiccConfigurationParameter: + description: Represents UICC Configuration Parameters. + type: object + oneOf: + - required: [routingId ] + - required: [steeringContainer ] + - required: [extendedSteeringContainer ] + properties: + routingId: + $ref: '#/components/schemas/RoutingId' + steeringContainer: + type: array + items: + $ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo' + minItems: 1 + extendedSteeringContainer: + $ref: '#/components/schemas/ExtendedSteeringContainer' + +ExtendedSteeringContainer: + description: Represents Extended Steering Containers. + type: object + properties: + steeringContainer: + type: array + items: + $ref: 'TS29509_Nausf_SoRProtection.yaml#/components/schemas/SteeringInfo' + minItems: 1 + sorCmci: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/SorCmci' + storeSorCmciInMe: + type: boolean + +# SIMPLE TYPES: + +RoutingId: + description: Represents a routing indicator. + type: string + +``` + +pattern: '^[0-9]{1,4}\$' + +# ENUMS: + +# Annex B (informative): Change history + +| Change history | | | | | | | | +|----------------|---------|-----------|------|-----|-----|-------------------------------------------------------------------------------------------------------------------------------|-------------| +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +| 2019-10 | CT4#94 | C4-194013 | | | | Initial Draft. | 0.1.0 | +| 2019-10 | CT4#94 | C4-194367 | | | | Notaf Overview | 0.2.0 | +| 2019-10 | CT4#94 | C4-194488 | | | | Notaf_SecuredPacket-Provide service operation | 0.2.0 | +| 2019-10 | CT4#94 | C4-194492 | | | | Resources | 0.2.0 | +| 2019-10 | CT4#94 | C4-194516 | | | | Data Model | 0.2.0 | +| 2019-10 | CT4#94 | C4-194490 | | | | OpenAPI Specification | 0.2.0 | +| 2019-11 | CT4#95 | C4-195481 | | | | Clean Up | 0.3.0 | +| 2019-12 | CT#86 | CP-193071 | | | | TS presented for information | 1.0.0 | +| 2019-12 | CT#86 | CP-193285 | | | | A title updated | 1.0.1 | +| 2020-03 | CT4#96e | C4-201119 | | | | Pseudo-CR on SOR | 1.1.0 | +| 2020-03 | CT4#96e | C4-201123 | | | | Pseudo-CR on Clean Up | 1.1.0 | +| 2020-03 | CT4#96e | C4-201217 | | | | Pseudo-CR on the necessary modifications to change OTAF NF name to SP-AF | 1.1.0 | +| 2020-03 | CT4#96e | C4-201314 | | | | Pseudo-CR on API descriptions table in clause 5.1 | 1.1.0 | +| 2020-03 | CT#87e | CP-200062 | | | | TS presented for approval | 2.0.0 | +| 2020-03 | CT#87e | | | | | Approved at CT#87e | 16.0.0 | +| 2020-07 | CT#88e | CP-201040 | 0001 | 1 | C | Clarification on Secured Packet format provided by SP-AF | 16.1.0 | +| 2020-07 | CT#88e | CP-201040 | 0002 | | F | Storage of YAML files in ETSI Forge | 16.1.0 | +| 2020-07 | CT#88e | CP-201040 | 0003 | 1 | F | Miscellaneous Corrections | 16.1.0 | +| 2020-07 | CT#88e | CP-201073 | 0005 | | F | 3GPP TS 29.544 API Version and External doc Update | 16.1.0 | +| 2020-09 | CT#89e | CP-202110 | 0006 | 1 | F | Miscellaneous corrections | 16.2.0 | +| 2020-09 | CT#89e | CP-202096 | 0007 | | F | API version and External doc update | 16.2.0 | +| 2020-12 | CT#90e | CP-203048 | 0008 | | F | Storage of yaml files | 16.3.0 | +| 2021-06 | CT#92e | CP-211051 | 0011 | | F | OpenAPI Reference | 17.0.0 | +| 2021-06 | CT#92e | CP-211028 | 0012 | 1 | F | Adding some missing description fields to data type definitions in OpenAPI specification files of the Nspaf_SecuredPacket API | 17.0.0 | +| 2021-06 | CT#92e | CP-211050 | 0013 | | F | 29.544 Rel-17 API version and External doc update | 17.0.0 | +| 2021-12 | CT#94e | CP-213197 | 0014 | 2 | B | SOR-CMCI support | 17.1.0 | +| 2021-12 | CT#94e | CP-213121 | 0015 | | F | 29.544 Rel-17 API version and External doc update | 17.1.0 | +| 2022-03 | CT#95e | CP-220041 | 0016 | | B | Addition of SOR-CMCI related attribute as input to SP-AF | 17.2.0 | +| 2022-03 | CT#95e | CP-220066 | 0017 | | F | API version and External doc update | 17.2.0 | +| 2022-06 | CT#96 | CP-221300 | 0018 | 1 | F | API version and External doc update | 17.3.0 | +| 2022-12 | CT#98e | CP-223027 | 0020 | 1 | F | Missing Mandatory Status Codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98e | CP-223033 | 0021 | | F | 29.544 Rel-18 API version and External doc update | 18.0.0 | +| 2023-12 | CT#102 | CP-233028 | 0022 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.1.0 | +| 2023-12 | CT#102 | CP-233029 | 0023 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.1.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29572/raw.md b/marked/Rel-18/29_series/29572/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..9162c8072a73739369486328ae35f7083fb12f73 --- /dev/null +++ b/marked/Rel-18/29_series/29572/raw.md @@ -0,0 +1,6110 @@ + + +# 3GPP TS 29.572 V18.4.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Location Management Services; Stage 3 (Release 18)** + +![5G Advanced logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring the text "5G" in a bold, black font with a green signal wave icon above the letter "G". The word "ADVANCED" is written in smaller, black, uppercase letters to the right of the "G". + +5G Advanced logo + +![3GPP logo](5fb340ad68b0c71df0b56698b137e35b_img.jpg) + +The logo for 3GPP, featuring the text "3GPP" in a bold, black font. The letter "P" is stylized with a red signal wave icon below it. Below the logo, the text "A GLOBAL INITIATIVE" is written in smaller, black, uppercase letters. + +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 ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions and abbreviations ..... | 10 | +| 3.1 Definitions..... | 10 | +| 3.2 Abbreviations ..... | 10 | +| 4 Overview..... | 11 | +| 5 Services Offered by the LMF..... | 11 | +| 5.1 Introduction ..... | 11 | +| 5.2 Nlmf_Location Service ..... | 12 | +| 5.2.1 Service Description ..... | 12 | +| 5.2.2 Service Operations..... | 12 | +| 5.2.2.1 Introduction..... | 12 | +| 5.2.2.2 DetermineLocation ..... | 12 | +| 5.2.2.2.1 General ..... | 12 | +| 5.2.2.2.2 Retrieve UE Location..... | 12 | +| 5.2.2.2.3 Retrieve UE Location for 5G-MO-LR ..... | 13 | +| 5.2.2.3 EventNotify..... | 14 | +| 5.2.2.3.1 General ..... | 14 | +| 5.2.2.3.2 Periodic or Triggered Event Notification ..... | 14 | +| 5.2.2.3.3 Intermediate location reporting Event Notification ..... | 15 | +| 5.2.2.4 CancelLocation ..... | 16 | +| 5.2.2.4.1 General ..... | 16 | +| 5.2.2.4.2 Cancel Periodic or Triggered Location ..... | 16 | +| 5.2.2.5 LocationContextTransfer..... | 16 | +| 5.2.2.5.1 General ..... | 16 | +| 5.2.2.5.2 Transfer Location Context ..... | 16 | +| 5.2.2.6 MeasurementData ..... | 17 | +| 5.2.2.6.1 General ..... | 17 | +| 5.2.2.6.2 Location Measurements ..... | 17 | +| 5.2.2.7 UPSubscribe..... | 18 | +| 5.2.2.7.1 General ..... | 18 | +| 5.2.2.7.2 Subscribe to Notification of LCS-UP connection ..... | 18 | +| 5.2.2.8 UPNotify..... | 18 | +| 5.2.2.8.1 General ..... | 18 | +| 5.2.2.8.2 Notification of LCS-UP connection ..... | 18 | +| 5.2.2.9 UPConfig ..... | 19 | +| 5.2.2.9.1 General ..... | 19 | +| 5.2.2.9.2 Set up LCS-UP connection ..... | 19 | +| 5.3 Nlmf_Broadcast Service ..... | 20 | +| 5.3.1 Service Description ..... | 20 | +| 5.3.2 Service Operations..... | 20 | +| 5.3.2.1 Introduction..... | 20 | +| 5.3.2.2 CipheringKeyData ..... | 20 | +| 5.3.2.2.1 General ..... | 20 | +| 5.3.2.2.2 Request Ciphering Key Information ..... | 20 | +| 5.3.2.2.3 Provide Ciphering Key Information..... | 21 | +| 6 API Definitions ..... | 21 | +| 6.1 Nlmf_Location Service API..... | 21 | +| 6.1.1 API URI..... | 21 | +| 6.1.2 Usage of HTTP..... | 22 | +| 6.1.2.1 General..... | 22 | +| 6.1.2.2 HTTP Standard Headers ..... | 22 | + +| | | | +|------------|----------------------------------------------------------|----| +| 6.1.2.2.1 | General ..... | 22 | +| 6.1.2.2.2 | Content type ..... | 22 | +| 6.1.2.3 | HTTP custom headers..... | 22 | +| 6.1.2.3.1 | General ..... | 22 | +| 6.1.2.4 | HTTP multipart messages..... | 23 | +| 6.1.3 | Resources..... | 23 | +| 6.1.3.1 | Overview..... | 23 | +| 6.1.4 | Custom Operations without associated resources ..... | 24 | +| 6.1.4.1 | Overview..... | 24 | +| 6.1.4.2 | Operation: determine-location ..... | 24 | +| 6.1.4.2.1 | Description ..... | 24 | +| 6.1.4.2.2 | Operation Definition ..... | 24 | +| 6.1.4.3 | Operation: cancel-location..... | 26 | +| 6.1.4.3.1 | Description ..... | 26 | +| 6.1.4.3.2 | Operation Definition ..... | 26 | +| 6.1.4.4 | Operation: location-context-transfer..... | 27 | +| 6.1.4.4.1 | Description ..... | 27 | +| 6.1.4.4.2 | Operation Definition ..... | 27 | +| 6.1.4.5 | Operation: location-measure..... | 28 | +| 6.1.4.5.1 | Description ..... | 28 | +| 6.1.4.5.2 | Operation Definition ..... | 28 | +| 6.1.4.6 | Operation: up-subscription ..... | 29 | +| 6.1.4.6.1 | Description ..... | 29 | +| 6.1.4.6.2 | Operation Definition ..... | 29 | +| 6.1.4.7 | Operation: up-configure..... | 30 | +| 6.1.4.7.1 | Description ..... | 30 | +| 6.1.4.7.2 | Operation Definition ..... | 30 | +| 6.1.5 | Notifications ..... | 31 | +| 6.1.5.1 | EventNotify..... | 32 | +| 6.1.5.1.1 | Description ..... | 32 | +| 6.1.5.1.2 | Notification Definition ..... | 32 | +| 6.1.5.1.3 | Notification Standard Methods ..... | 32 | +| 6.1.5.2 | UPNNotify ..... | 33 | +| 6.1.5.2.1 | Description ..... | 33 | +| 6.1.5.2.2 | Notification Definition ..... | 33 | +| 6.1.5.2.3 | Notification Standard Methods ..... | 33 | +| 6.1.6 | Data Model ..... | 34 | +| 6.1.6.1 | General..... | 34 | +| 6.1.6.2 | Structured data types..... | 38 | +| 6.1.6.2.1 | Introduction ..... | 38 | +| 6.1.6.2.2 | Type: InputData..... | 39 | +| 6.1.6.2.3 | Type: LocationData..... | 44 | +| 6.1.6.2.4 | Type: GeographicalCoordinates..... | 47 | +| 6.1.6.2.5 | Type: GeographicArea ..... | 47 | +| 6.1.6.2.6 | Type: Point..... | 47 | +| 6.1.6.2.7 | Type: PointUncertaintyCircle ..... | 48 | +| 6.1.6.2.8 | Type: PointUncertaintyEllipse ..... | 48 | +| 6.1.6.2.9 | Type: Polygon ..... | 48 | +| 6.1.6.2.10 | Type: PointAltitude ..... | 48 | +| 6.1.6.2.11 | Type: PointAltitudeUncertainty ..... | 49 | +| 6.1.6.2.12 | Type: EllipsoidArc ..... | 49 | +| 6.1.6.2.13 | Type: LocationQoS ..... | 50 | +| 6.1.6.2.14 | Type: CivicAddress..... | 51 | +| 6.1.6.2.15 | Type: PositioningMethodAndUsage ..... | 53 | +| 6.1.6.2.16 | Type: GnssPositioningMethodAndUsage ..... | 54 | +| 6.1.6.2.17 | Type: VelocityEstimate ..... | 54 | +| 6.1.6.2.18 | Type: HorizontalVelocity..... | 54 | +| 6.1.6.2.19 | Type: HorizontalWithVerticalVelocity..... | 54 | +| 6.1.6.2.20 | Type: HorizontalVelocityWithUncertainty ..... | 55 | +| 6.1.6.2.21 | Type: HorizontalWithVerticalVelocityAndUncertainty ..... | 55 | +| 6.1.6.2.22 | Type: UncertaintyEllipse..... | 55 | +| 6.1.6.2.23 | Type: UeLcsCapability ..... | 55 | + +| | | | +|------------|------------------------------------------------|----| +| 6.1.6.2.24 | Type: PeriodicEventInfo ..... | 56 | +| 6.1.6.2.25 | Type: AreaEventInfo ..... | 57 | +| 6.1.6.2.26 | Type: ReportingArea ..... | 57 | +| 6.1.6.2.27 | Type: MotionEventInfo ..... | 58 | +| 6.1.6.2.28 | Void ..... | 58 | +| 6.1.6.2.29 | Type: CancelLocData ..... | 58 | +| 6.1.6.2.30 | Type: LocContextData ..... | 59 | +| 6.1.6.2.31 | Type: EventReportMessage ..... | 60 | +| 6.1.6.2.32 | Type: EventReportingStatus ..... | 60 | +| 6.1.6.2.33 | Type: UELocationInfo ..... | 60 | +| 6.1.6.2.34 | Type: EventNotifyData ..... | 61 | +| 6.1.6.2.35 | Type: UeConnectivityState ..... | 64 | +| 6.1.6.2.36 | Type: LocalOrigin ..... | 64 | +| 6.1.6.2.37 | Type: RelativeCartesianLocation ..... | 64 | +| 6.1.6.2.38 | Type: Local2dPointUncertaintyEllipse ..... | 65 | +| 6.1.6.2.39 | Type: Local3dPointUncertaintyEllipsoid ..... | 65 | +| 6.1.6.2.40 | Type: UncertaintyEllipsoid ..... | 65 | +| 6.1.6.2.41 | Type: LocalArea ..... | 66 | +| 6.1.6.2.42 | Type: UeAreaIndication ..... | 66 | +| 6.1.6.2.43 | Type: MinorLocationQoS ..... | 66 | +| 6.1.6.2.44 | Type: MbsrInfo ..... | 66 | +| 6.1.6.2.45 | Type: LocMeasurementReq ..... | 67 | +| 6.1.6.2.46 | Type: LocMeasurementResp ..... | 67 | +| 6.1.6.2.47 | Type: LocMeasurements ..... | 67 | +| 6.1.6.2.48 | Type: HighAccuracyGnssMetrics ..... | 68 | +| 6.1.6.2.49 | Type: UpNotifyData ..... | 68 | +| 6.1.6.2.50 | Type: UpSubscription ..... | 68 | +| 6.1.6.2.52 | Type: UpConfig ..... | 69 | +| 6.1.6.2.58 | Type: LocationDataExt ..... | 70 | +| 6.1.6.2.59 | Type: EventNotifyDataExt ..... | 70 | +| 6.1.6.2.60 | Type: MappedLocationQoSEps ..... | 70 | +| 6.1.6.2.61 | Type: AdditionalUeInfo ..... | 70 | +| 6.1.6.3 | Simple data types and enumerations ..... | 71 | +| 6.1.6.3.1 | Introduction ..... | 71 | +| 6.1.6.3.2 | Simple data types ..... | 71 | +| 6.1.6.3.3 | Enumeration: ExternalClientType ..... | 74 | +| 6.1.6.3.4 | Enumeration: SupportedGADShapes ..... | 75 | +| 6.1.6.3.5 | Enumeration: ResponseTime ..... | 75 | +| 6.1.6.3.6 | Enumeration: PositioningMethod ..... | 76 | +| 6.1.6.3.7 | Enumeration: PositioningMode ..... | 76 | +| 6.1.6.3.8 | Enumeration: GnssId ..... | 77 | +| 6.1.6.3.9 | Enumeration: Usage ..... | 77 | +| 6.1.6.3.10 | Enumeration: LcsPriority ..... | 77 | +| 6.1.6.3.11 | Enumeration: VelocityRequested ..... | 77 | +| 6.1.6.3.12 | Enumeration: AccuracyFulfilmentIndicator ..... | 78 | +| 6.1.6.3.13 | Enumeration: VerticalDirection ..... | 78 | +| 6.1.6.3.14 | Enumeration: LdrType ..... | 78 | +| 6.1.6.3.15 | Enumeration: ReportingAreaType ..... | 78 | +| 6.1.6.3.16 | Enumeration: OccurrenceInfo ..... | 78 | +| 6.1.6.3.17 | Enumeration: ReportingAccessType ..... | 79 | +| 6.1.6.3.18 | Enumeration: EventClass ..... | 79 | +| 6.1.6.3.19 | Enumeration: ReportedEventType ..... | 79 | +| 6.1.6.3.20 | Enumeration: TerminationCause ..... | 80 | +| 6.1.6.3.21 | Enumeration: LcsQosClass ..... | 80 | +| 6.1.6.3.22 | Enumeration: UeLocationServiceInd ..... | 80 | +| 6.1.6.3.23 | Enumeration: IndoorOutdoorInd ..... | 80 | +| 6.1.6.3.24 | Enumeration: FixType ..... | 80 | +| 6.1.6.3.25 | Enumeration: LosNlosMeasureInd ..... | 80 | +| 6.1.6.3.26 | Enumeration: UpConnectionStatus ..... | 80 | +| 6.1.6.3.27 | Enumeration: RangingSIResult ..... | 81 | +| 6.1.6.3.28 | Enumeration: RelatedUETYPE ..... | 81 | +| 6.1.6.3.29 | Enumeration: LcsUpConnectionInd ..... | 81 | + +| | | | +|------------|------------------------------------------------------|----| +| 6.1.6.3.30 | Enumeration: UeUpPositioningCapabilities ..... | 82 | +| 6.1.6.4 | Binary data ..... | 82 | +| 6.1.6.4.1 | Introduction ..... | 82 | +| 6.1.6.4.2 | LPP Message ..... | 82 | +| 6.1.7 | Error Handling ..... | 82 | +| 6.1.7.1 | General ..... | 82 | +| 6.1.7.2 | Protocol Errors ..... | 82 | +| 6.1.7.3 | Application Errors ..... | 82 | +| 6.1.8 | Security ..... | 83 | +| 6.1.9 | Feature Negotiation ..... | 83 | +| 6.1.10 | HTTP redirection ..... | 84 | +| 6.2 | Nlmf_Broadcast Service API ..... | 84 | +| 6.2.1 | API URI ..... | 84 | +| 6.2.2 | Usage of HTTP ..... | 85 | +| 6.2.2.1 | General ..... | 85 | +| 6.2.2.2 | HTTP Standard Headers ..... | 85 | +| 6.2.2.2.1 | General ..... | 85 | +| 6.2.2.2.2 | Content type ..... | 85 | +| 6.2.2.3 | HTTP custom headers ..... | 85 | +| 6.2.2.3.1 | General ..... | 85 | +| 6.2.3 | Resources ..... | 85 | +| 6.2.3.1 | Overview ..... | 85 | +| 6.2.4 | Custom Operations without associated resources ..... | 86 | +| 6.2.4.1 | Overview ..... | 86 | +| 6.2.4.4 | Operation: cipher-key-data ..... | 86 | +| 6.2.4.4.1 | Description ..... | 86 | +| 6.2.4.4.2 | Operation Definition ..... | 86 | +| 6.2.5 | Notifications ..... | 87 | +| 6.2.5.1 | CipheringKeyData ..... | 87 | +| 6.2.5.1.1 | Description ..... | 87 | +| 6.2.5.1.2 | Notification Definition ..... | 87 | +| 6.2.5.1.3 | Notification Standard Methods ..... | 87 | +| 6.2.6 | Data Model ..... | 88 | +| 6.2.6.1 | General ..... | 88 | +| 6.2.6.2 | Structured data types ..... | 89 | +| 6.2.6.2.1 | Introduction ..... | 89 | +| 6.2.6.2.2 | Type: CipheringKeyInfo ..... | 89 | +| 6.2.6.2.3 | Type: CipheringKeyResponse ..... | 90 | +| 6.2.6.2.4 | Type: CipheringDataSet ..... | 91 | +| 6.2.6.2.5 | Type: CipheringSetReport ..... | 96 | +| 6.2.6.2.6 | Type: CipherRequestData ..... | 97 | +| 6.2.6.2.7 | Type: CipherResponseData ..... | 97 | +| 6.2.6.3 | Simple data types and enumerations ..... | 97 | +| 6.2.6.3.1 | Introduction ..... | 97 | +| 6.2.6.3.2 | Simple data types ..... | 97 | +| 6.2.6.3.3 | Enumeration: StorageOutcome ..... | 97 | +| 6.2.6.3.4 | Enumeration: DataAvailability ..... | 97 | +| 6.2.7 | Error Handling ..... | 98 | +| 6.2.7.1 | General ..... | 98 | +| 6.2.7.2 | Protocol Errors ..... | 98 | +| 6.2.7.3 | Application Errors ..... | 98 | +| 6.2.8 | Security ..... | 98 | +| 6.2.9 | Feature Negotiation ..... | 98 | +| 6.2.10 | HTTP redirection ..... | 99 | + +| | | | +|-------------------------------|------------------------------------|------------| +| Annex A (normative): | OpenAPI specification ..... | 99 | +| A.1 | General ..... | 99 | +| A.2 | Nlmf_Location API..... | 99 | +| A.3 | Nlmf_Broadcast API..... | 128 | +| Annex B (informative): | Change history ..... | 132 | + +# 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 Nlmf Service Based Interface. It provides stage 3 protocol definitions and message flows, and specifies the API for each service offered by the LMF. + +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] IETF RFC 4776: "Dynamic Host Configuration Protocol (DHCPv4 and DHCPv6) Option for Civic Addresses Configuration Information". +- [7] IETF RFC 5139: "Revised Civic Location Format for Presence Information Data Format Location Object (PIDF-LO)". +- [8] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces; Stage 3". +- [9] 3GPP TS 33.501: "Security architecture and procedures for 5G system". +- [10] IETF RFC 6749: "The OAuth 2.0 Authorization Framework". +- [11] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [12] IETF RFC 9113: "HTTP/2". +- [13] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". + +- [14] OpenAPI Initiative, "OpenAPI Specification Version 3.0.0", . +- [15] IETF RFC 9457: "Problem Details for HTTP APIs". +- [16] 3GPP TR 21.900: "Technical Specification Group working methods". +- [17] 3GPP TS 22.071: "Location Services (LCS); Service description; Stage 1". +- [18] 3GPP TS 29.002: "Mobile Application Part (MAP) specification". +- [19] 3GPP TS 23.273: "5G System (5GS) Location Services (LCS); Stage 2". +- [20] 3GPP TS 24.080: "Mobile radio interface layer 3 Supplementary services specification; Formats and coding". +- [21] 3GPP TS 37.355: " LTE Positioning Protocol (LPP)". +- [22] 3GPP TS 24.501: "Non-Access-Stratum (NAS) protocol for 5G System (5GS); Stage 3". +- [23] 3GPP TS 29.518: "Access and Mobility Management Services". +- [24] 3GPP TS 29.171: "Location Services (LCS); LCS Application Protocol (LCS-AP) between the Mobile Management Entity (MME) and Evolved Serving Mobile Location Centre (E-SMLC); SLs interface". +- [25] IETF RFC 4119: "A Presence-based GEOPRIV Location Object Format". +- [26] 3GPP TS 33.256: "Security aspects of Uncrewed Aerial Systems (UAS)". +- [27] 3GPP TS 29.515: "5G System; Gateway Mobile Location Services Stage 3". +- [28] 3GPP TS 29.515: "5G System; Gateway Mobile Location Services Stage 3". +- [29] 3GPP TS 29.122: "T8 reference point for Northbound APIs". + +# --- 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]. + +| | | +|-------|-----------------------------------------| +| LDR | Location Deferred Request | +| LIR | Location Immediate Request | +| LMF | Location Management Function | +| LPHAP | Low Power and High Accuracy Positioning | + +# 4 Overview + +The Location Management Function (LMF) is the network entity in the 5G Core Network (5GC) supporting the following functionality: + +- Supports location determination for a UE. +- Obtains downlink location measurements or a location estimate from the UE. +- Obtains uplink location measurements from the NG RAN. +- Obtains non-UE associated assistance data from the NG RAN. +- Provides broadcast assistance data to UEs and forwards associated ciphering keys to an AMF. + +Other functions of an LMF are listed in clause 4.3.8 of 3GPP TS 23.273 [19]. + +Figure 4-1 provides the reference model (in service based interface representation and in reference point representation), with focus on the LMF: + +![Figure 4-1: Reference model – LMF. The diagram shows two network functions, LMF and AMF, connected to a central LMF entity. The LMF on the left is connected via the NL7 interface to the central LMF. The AMF on the left is connected via the NL1 interface to the central LMF. The central LMF is represented by a large rectangle with a small circle on its left side, labeled Nlmf, indicating a service based interface.](c78c2eefd86269d1740ab85a916f24f2_img.jpg) + +Figure 4-1: Reference model – LMF. The diagram shows two network functions, LMF and AMF, connected to a central LMF entity. The LMF on the left is connected via the NL7 interface to the central LMF. The AMF on the left is connected via the NL1 interface to the central LMF. The central LMF is represented by a large rectangle with a small circle on its left side, labeled Nlmf, indicating a service based interface. + +Figure 4-1: Reference model – LMF + +# 5 Services Offered by the LMF + +## 5.1 Introduction + +The LMF offers to other NFs the following services: + +- Nlmf\_Location +- Nlmf\_Broadcast + +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 | +|----------------|--------|-----------------------|-----------------------------|----------------|-------| +| Nlmf_Location | 6.1 | LMF Location Service | TS29572_Nlmf_Location.yaml | nlmf-loc | A.2 | +| Nlmf_Broadcast | 6.2 | LMF Broadcast Service | TS29572_Nlmf_Broadcast.yaml | nlmf-broadcast | A.3 | + +## 5.2 Nlmf\_Location Service + +### 5.2.1 Service Description + +The Nlmf\_Location service enables an NF to request location determination (current geodetic and optionally local and/or civic location) for a target UE or to request periodic or triggered location for a target UE. + +### 5.2.2 Service Operations + +#### 5.2.2.1 Introduction + +The service operations defined for the Nlmf\_Location service are as follows: + +- DetermineLocation: It provides UE location information to the consumer NF. +- EventNotify: It notifies the consumer NF of an event for periodic or triggered location for a target UE, or cumulative event report for the location reporting over user plane from the UE. +- CancelLocation: It enables a consumer NF to cancel an ongoing periodic or triggered location for a target UE. +- LocationContextTransfer: It enables a consumer NF to transfer location context information for periodic or triggered location of a target UE to a new LMF. +- MeasurementData: It enables a consumer NF to request the PRU location measurements from PRU serving LMFs. +- UPSubscribe: It enables a consumer NF to subscribe about status of a secure LCS-UP connection for a target UE. +- UPNotify: It notifies the consumer NF of the status or modification of a secure LCS-UP connection for a target UE. +- UPConfig: It enables a consumer NF to set up, modify or terminate a secure LCS-UP connection for a target UE. + +#### 5.2.2.2 DetermineLocation + +##### 5.2.2.2.1 General + +The following procedures are defined, using the "DetermineLocation" service operation: + +- Retrieve UE Location +- Retrieve UE Location for 5G-MO-LR +- Retrieve UE Location for Ranging and Sidelink Positioning + +##### 5.2.2.2.2 Retrieve UE Location + +This procedure allows a consumer NF to request the location information (geodetic location and, optionally, local and/or civic location) for a target UE or to activate periodic or triggered deferred location for a target UE. + +![Sequence diagram showing the DetermineLocation Request procedure between an NF Service Consumer and an LMF. The NF Service Consumer sends a POST request to the LMF. The LMF responds with either a 200 OK (LocationData) or a 4xx/5xx (ProblemDetails) or 3xx status code.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: 1. POST ../determine-location (InputData) + NF Service Consumer->>LMF: 1. POST ../determine-location (InputData) + Note right of LMF: 2a. 200 OK (LocationData) + Note right of LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + LMF-->>NF Service Consumer: 2a. 200 OK (LocationData) + LMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the DetermineLocation Request procedure between an NF Service Consumer and an LMF. The NF Service Consumer sends a POST request to the LMF. The LMF responds with either a 200 OK (LocationData) or a 4xx/5xx (ProblemDetails) or 3xx status code. + +**Figure 5.2.2.2.2-1: DetermineLocation Request** + +1. The NF Service Consumer shall send an HTTP POST request to the resource URI associated with the "determine-location" custom operation. The input parameters for the request (external client type, LCS correlation identifier, serving cell identifier, location QoS, mapped location QoS applicable to EPS, supported GAD shapes, LDR Type, H-GMLC address, LDR Reference, UE connectivity state per access type, TNAP identifier, TWAP identifier, scheduled location time, LpHapType, UE User Plane Positioning Capability, reporting indication, MBSR Info, Additional UE Info, integrity requirements, requested ranging\_SL location results, related UEs ...) may be included in the HTTP POST request body; + +If UE geographical area identified by the country, area within a country or international area needs to be determined, the NF Service Consumer shall include UE geographical area determination indication for PLMN selection verification in the request; + +If UE Unaware Positioning is required, the NF Service Consumer shall include UE unaware indication in the request; + +If UE LCS Capability is received in the request indicating LPP is not supported by the UE, the LMF shall not send LPP messages to the UE in subsequent positioning procedures. + +During 5GC-MT-LR multiple location procedure for regulatory location service, the AMF shall also include the indication of acceptance for intermediate response and the maximum response time, the GMLC callback address and the LIR reference number, if received from the GMLC. The AMF may overwrite the received maximum response time (e.g. to avoid HTTP service request timeout) when passing it to the LMF. + +For deferred periodic or triggered 5GC-MT-LR procedures, if the NF Service Consumer requests the location reporting over user plane, the NF Service Consumer shall include the endpoint address of the location reporting over user plane, the cumulative event report timer, or the maximum number of location reports over user plane. + +- 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 location, civic location, positioning methods, LOS/NLOS measurement indication, ...); + +If the NF service consumer has requested to determine UE country, area within a country or international area, the LMF shall also include ueAreaInd. + +If the indication of acceptance for intermediate response was received in the request, the LMF shall perform positioning procedures and determines multiple location estimates within the maximum response time. The LMF shall include the FINAL location in the content of this response message. If any intermediate location(s) are determined, the LMF shall send intermediate location reporting event notification(s) to the GMLC (see clause 5.2.2.3.3). + +During deferred periodic or triggered 5GC-MT-LR procedures, if the mapped location QoS applicable to EPS was received in the request and if the access type allowed for the UE for event reporting includes "E-UTRAN connected to EPC", the LMF shall forward the mapped location QoS applicable to EPS to the UE. + +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.4.2.2-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.4.2.2-2. + +##### 5.2.2.2.3 Retrieve UE Location for 5G-MO-LR + +This procedure allows a consumer NF (i.e. an AMF) to request the location information or location assistance data for a target UE which initiates MO-LR procedure (see 3GPP TS 23.273 [19]). + +![Sequence diagram showing the DetermineLocation Request for 5G-MO-LR. The NF Service Consumer sends a POST .../determine-location (InputData) request to the LMF. The LMF responds with 2a. 200 OK (LocationDataExt) or 204 No Content, and 2b. 4xx/5xx (ProblemDetails) or 3xx.](a33da0f14e456f92539ce3e9b7d81f9a_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: + NF Service Consumer->>LMF: 1. POST .../determine-location (InputData) + Note right of LMF: + LMF-->>NF Service Consumer: 2a. 200 OK (LocationDataExt) or 204 No Content + LMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the DetermineLocation Request for 5G-MO-LR. The NF Service Consumer sends a POST .../determine-location (InputData) request to the LMF. The LMF responds with 2a. 200 OK (LocationDataExt) or 204 No Content, and 2b. 4xx/5xx (ProblemDetails) or 3xx. + +**Figure 5.2.2.2.3-1: DetermineLocation Request for 5G-MO-LR** + +The same requirements in clause 5.2.2.2.2 shall be applied with following modifications: + +1. Same as step 1 of figure 5.2.2.2.2-1, the request body shall include the following additional information: + - The indication received from UE indicating whether a location estimate or location assistance data is required. + - The LPP messages if received in MO-LR Request from UE + - UE's subscribed assistance data for 5GC-MO-LR if received from UDM. +- 2a. Same as step 2a of figure 5.2.2.2.2-1 if a consumer NF requests the location information for a target UE. If a NF consumer requests location assistance data for a target UE and LMF has successfully delivered location assistance data to the UE, 204 No Content shall be returned. +- 2b. Same as step 2b of figure 5.2.2.2.2-1. + +This procedure is also used to retrieve UE Location for Ranging and Sidelink Positioning. + +#### 5.2.2.3 EventNotify + +##### 5.2.2.3.1 General + +The following procedures are defined, using the "EventNotify" service operation: + +- Periodic or Triggered Event Notification + +##### 5.2.2.3.2 Periodic or Triggered Event Notification + +This procedure notifies the NF Service Consumer (i.e. GMLC) about event information related to periodic or triggered location of a target UE. The notification is delivered to: + +- the callback URI of an H-GMLC received (from an AMF) during an earlier DetermineLocation service operation if still available and if the LMF is configured for direct access to the H-GMLC; +- the callback URI of an H-GMLC received (from another LMF) during an earlier LocationContextTransfer service operation if still available and if the LMF is configured for direct access to the H-GMLC; +- the callback URI of an H-GMLC received (from the target UE) in a supplementary services event report if the LMF is configured for direct access to the H-GMLC; + +otherwise (if not available), + +- the callback URI of a V-GMLC registered in the NRF, if the V-GMLC registered to the NRF with notification endpoints for periodic or triggered event notifications; or + +otherwise (if not available), + +- the URI of a V-GMLC locally provisioned in the LMF. + +![Sequence diagram for Figure 5.2.2.3.2-1: EventNotify Request. The diagram shows a request from LMF to NF Service Consumer, followed by a success (2a) or failure (2b) response.](7efae06af3af43ffe5d4b956a679cf54_img.jpg) + +``` +sequenceDiagram + participant LMF + participant NF Service Consumer + Note left of LMF: 1. POST {hgmlcCallBackURI}(EventNotifyDataExt) + LMF->>NF Service Consumer: 1. POST {hgmlcCallBackURI}(EventNotifyDataExt) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>LMF: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +Sequence diagram for Figure 5.2.2.3.2-1: EventNotify Request. The diagram shows a request from LMF to NF Service Consumer, followed by a success (2a) or failure (2b) response. + +**Figure 5.2.2.3.2-1: EventNotify Request** + +1. The LMF shall send a POST request to the GMLC callback URI determined as described above. The request body shall include a notification correlation ID (LDR reference), the UE identification (SUPI and if available GPSI), the type of event and may include a geodetic location, local location, civic location, position methods used, and other available parameters related to the position if any (e.g. Velocity, Altitude etc.), H-GMLC callback URI (if the NF consumer is a V-GMLC), serving LMF identification, LOS/NLOS measurement indication, and the statistics on the location reporting over user plane. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, one of the appropriate HTTP status code listed in Table 6.1.5.1.3.1-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure indicating appropriate additional error information. + +##### 5.2.2.3.3 Intermediate location reporting Event Notification + +This procedure notifies the NF Service Consumer (i.e. GMLC) about event information related to intermediate location of a target UE. The notification is delivered to: + +- the callback URI of the GMLC for multiple location request received (from an AMF) during an earlier DetermineLocation service operation (see clause 5.2.2.2.2). + +![Sequence diagram for Figure 5.2.2.3.3-1: Intermediate location reporting Event Notification Request. The diagram shows a request from LMF to NF Service Consumer, followed by a success (2a) or failure (2b) response.](a7c51c18111139f9aca2805114108565_img.jpg) + +``` +sequenceDiagram + participant LMF + participant NF Service Consumer + Note left of LMF: 1. POST {lirGmlcCallBackURI}(EventNotifyDataExt) + LMF->>NF Service Consumer: 1. POST {lirGmlcCallBackURI}(EventNotifyDataExt) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>LMF: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +Sequence diagram for Figure 5.2.2.3.3-1: Intermediate location reporting Event Notification Request. The diagram shows a request from LMF to NF Service Consumer, followed by a success (2a) or failure (2b) response. + +**Figure 5.2.2.3.3-1: Intermediate location reporting Event Notification Request** + +1. The LMF shall send a POST request to the GMLC callback URI determined as described above. The request body shall include the associated LIR reference number, the UE identification (SUPI and if available GPSI), the type of event ("INTERMEDIATE\_EVENT") and the intermediate location of the UE (geodetic location, local location, civic location, position methods used), and other available parameters related to the position if any (e.g. Velocity, Altitude etc.). +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, one of the appropriate HTTP status code listed in Table 6.1.5.1.3.1-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure indicating appropriate additional error information. + +#### 5.2.2.4 CancelLocation + +##### 5.2.2.4.1 General + +The following procedures are defined, using the "CancelLocation" service operation: + +- Cancel Periodic or Triggered Location + +##### 5.2.2.4.2 Cancel Periodic or Triggered Location + +This procedure allows a consumer NF to cancel periodic or triggered location for a target UE. The cancellation is delivered to a resource URI on the serving LMF identified by the serving LMF identification provided to the consumer NF (i.e. AMF) by a V-GMLC or H-GMLC (see 3GPP TS 23.273 [19]). + +![Sequence diagram for CancelLocation Request. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'LMF' on the right. A solid arrow labeled '1. POST {servingLMFURI} (CancelLocData)' points from the consumer to the LMF. From the LMF, two dashed arrows point back to the consumer: '2a. 204 No Content' and '2b. 4xx/5xx (ProblemDetails) or 3xx'.](6f341f415ee0f8c724e5d6daeb1e9b4a_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: + NF Service Consumer->>LMF: 1. POST {servingLMFURI} (CancelLocData) + Note right of LMF: + LMF-->>NF Service Consumer: 2a. 204 No Content + LMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +Sequence diagram for CancelLocation Request. The diagram shows two lifelines: 'NF Service Consumer' on the left and 'LMF' on the right. A solid arrow labeled '1. POST {servingLMFURI} (CancelLocData)' points from the consumer to the LMF. From the LMF, two dashed arrows point back to the consumer: '2a. 204 No Content' and '2b. 4xx/5xx (ProblemDetails) or 3xx'. + +**Figure 5.2.2.4.2-1: CancelLocation Request** + +1. The NF Service Consumer shall send an HTTP POST request to the resource URI of "cancel-location" custom operation on the serving LMF. The request body shall include a notification correlation ID (LDR reference) and an H-GMLC callback URI. +- 2a. On success, "204 No content" shall be returned by the LMF. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.4.3.2-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.4.3.2-2. + +#### 5.2.2.5 LocationContextTransfer + +##### 5.2.2.5.1 General + +The following procedures are defined, using the "LocationContextTransfer" service operation: + +- Transfer Location Context + +##### 5.2.2.5.2 Transfer Location Context + +This procedure allows a NF service consumer (e.g. the old LMF) to transfer location context information for periodic or triggered location for a target UE (see clause 6.4 and clause 6.7.2 of 3GPP TS 23.273 [19]). The NF service consumer discovers the service URI of the new LMF by performing a discovery via NRF using: + +- the identification of the LMF received (from an AMF) during an earlier Namf\_Communication\_N1MessageNotify service operation to the consumer NF; +- otherwise (if not available), +- the identification of an LMF locally provisioned in the consumer NF. + +![Sequence diagram for Figure 5.2.2.5.2-1: LocationContextTransfer Request. The diagram shows an NF Service Consumer sending a POST request to an LMF. The request is '1. POST ../location-context-transfer (LocContextData)'. The LMF responds with '2a. 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) or 3xx' on failure or redirection.](8307f6b04df072c9332f9987e034272c_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: 1. POST ../location-context-transfer (LocContextData) + NF Service Consumer->>LMF: Request + Note right of LMF: 2a. 204 No Content + LMF-->>NF Service Consumer: Success Response + Note right of LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + LMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for Figure 5.2.2.5.2-1: LocationContextTransfer Request. The diagram shows an NF Service Consumer sending a POST request to an LMF. The request is '1. POST ../location-context-transfer (LocContextData)'. The LMF responds with '2a. 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) or 3xx' on failure or redirection. + +**Figure 5.2.2.5.2-1: LocationContextTransfer Request** + +1. The NF Service Consumer shall send an HTTP POST request to the Custom operation URI ("/location-context-transfer") on the Service URI discovered as described above. The request body shall include an AMF identity, Deferred location type, Deferred location parameters, Notification Target Address (H-GMLC callback URI), Notification Correlation ID (LDR reference), an embedded event report message and may include an event reporting status, UE location information, scheduled location time and LOS/NLOS measurement indication, and shall include an indication of Control Plane CIoT 5GS Optimisation if N1 message is received from the UE with Control Plane CIoT 5GS Optimisation. If the location context information for periodic or triggered location for a target UE includes the endpoint address of the location reporting over user plane, the NF Service Consumer may include the cumulative event report timer, or the maximum number of location reports over user plane. +- 2a. On success, "204 No content" shall be returned by the LMF. +- 2b. On failure or redirection, one of the HTTP status codes listed in Table 6.1.4.4.2-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.4.4.2-2. + +#### 5.2.2.6 MeasurementData + +##### 5.2.2.6.1 General + +The following procedures are defined, using the "MeasurementData" service operation: + +- Location Measurements + +##### 5.2.2.6.2 Location Measurements + +This procedure allows a consumer NF (e.g. LMF) to request PRU location measurements from PRU serving LMF. + +![Sequence diagram for Figure 5.2.2.6.2-1: DetermineLocation Request. The diagram shows an NF Service Consumer sending a POST request to an LMF. The request is '1. POST ../location-measure (LocMeasurementReq)'. The LMF responds with '2a. 200 OK (LocMeasurementResp)' on success or '2b. 4xx/5xx (ProblemDetails) or 3xx' on failure or redirection.](9b62a616c7a1097c5da57f001ab6dd64_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: 1. POST ../location-measure (LocMeasurementReq) + NF Service Consumer->>LMF: Request + Note right of LMF: 2a. 200 OK (LocMeasurementResp) + LMF-->>NF Service Consumer: Success Response + Note right of LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + LMF-->>NF Service Consumer: Error/Redirect Response + +``` + +Sequence diagram for Figure 5.2.2.6.2-1: DetermineLocation Request. The diagram shows an NF Service Consumer sending a POST request to an LMF. The request is '1. POST ../location-measure (LocMeasurementReq)'. The LMF responds with '2a. 200 OK (LocMeasurementResp)' on success or '2b. 4xx/5xx (ProblemDetails) or 3xx' on failure or redirection. + +**Figure 5.2.2.6.2-1: DetermineLocation Request** + +1. The NF Service Consumer shall send an HTTP POST request to the resource URI associated with the "location-measure" custom operation. The request body shall include target UE cell ID and may include the Pre-calculated location of target UE. +- 2a. On success, "200 OK" shall be returned. The response body shall contain the parameters related to the location measurements of the PRU and the known location of the associated PRU. + +2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.4.5.2-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.4.5.2-2. + +#### 5.2.2.7 UPSubscribe + +##### 5.2.2.7.1 General + +The following procedures are defined, using the "UPSubscribe" service operation: + +- Subscribe to Notification of LCS-UP connection + +##### 5.2.2.7.2 Subscribe to Notification of LCS-UP connection + +This procedure allows a consumer NF to subscribe about status of a secure LCS-UP connection for a target UE. + +![Sequence diagram showing the interaction between an NF service consumer and an LMF for subscribing to notifications.](124c6108c63173818afb8ed49521e22d_img.jpg) + +``` +sequenceDiagram + participant NF as NF service consumer + participant LMF as LMF + Note left of NF: + NF->>LMF: 1. POST.../up-subscription (UpSubscription) + Note right of LMF: + LMF-->>NF: 2a. 204 No Content + Note right of LMF: + LMF-->>NF: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +The diagram illustrates a sequence of interactions between an 'NF service consumer' and an 'LMF'. The consumer sends a '1. POST.../up-subscription (UpSubscription)' request to the LMF. The LMF responds with '2a. 204 No Content' on success or '2b. 4xx/5xx (ProblemDetails) or 3xx' on failure or redirection. + +Sequence diagram showing the interaction between an NF service consumer and an LMF for subscribing to notifications. + +**Figure 5.2.2.7.2-1: NF service consumer subscribes to notifications** + +1. The NF Service Consumer shall send a POST request to the resource URI representing the "up-subscriptions" collection resource. +- 2a. On success, the LMF responds with "204 No Content". +- 2b. On failure or redirection, one of the HTTP status code listed in Table Table 6.1.4.6.2-2 shall be returned. For a 4xx/5xx response, the message body containing a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table Table 6.1.4.6.2-2. + +#### 5.2.2.8 UPNotify + +##### 5.2.2.8.1 General + +The following procedures are defined, using the "UPNotify" service operation: + +- Notification of LCS-UP connection + +##### 5.2.2.8.2 Notification of LCS-UP connection + +This procedure notifies the NF Service Consumer (i.e. AMF) about status or modification of a secure LCS-UP connection for a target UE. + +![Sequence diagram for UPNotify. The LMF sends a POST {upNotifyCallBackURI}(UpNotifyData) request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx.](8fa679f79a1bb1f527cba9f29e784e89_img.jpg) + +``` + +sequenceDiagram + participant LMF + participant NF Service Consumer + Note left of LMF: 1. POST {upNotifyCallBackURI}(UpNotifyData) + LMF->>NF Service Consumer: 1. POST {upNotifyCallBackURI}(UpNotifyData) + Note right of NF Service Consumer: 2a. 204 No Content + NF Service Consumer-->>LMF: 2a. 204 No Content + Note right of NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + NF Service Consumer-->>LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for UPNotify. The LMF sends a POST {upNotifyCallBackURI}(UpNotifyData) request to the NF Service Consumer. The NF Service Consumer responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx. + +Figure 5.2.2.8.2-1: UPNotify + +1. The LMF shall send a POST request to the upNotify callback URI determined as described above. The request body shall include a notification correlation ID (LDR reference), LCS-UP connection status and may include a target LMF identifier. +- 2a. On success, "204 No content" shall be returned by the NF Service Consumer. +- 2b. On failure or redirection, one of the appropriate HTTP status code listed in Table 6.1.5.1.3.1-2 shall be returned. For a 4xx/5xx response, the message body should contain a ProblemDetails structure indicating appropriate additional error information. + +#### 5.2.2.9 UPConfig + +##### 5.2.2.9.1 General + +The following procedures are defined, using the "UPConfig" service operation: + +- LCS-UP connection + +##### 5.2.2.9.2 Set up LCS-UP connection + +This procedure allows a consumer NF to set up, modify or terminate a secure LCS-UP connection for a target UE. + +![Sequence diagram for LCS-UP connection. The NF service consumer sends a POST ../up-configure (UpConfig) request to the LMF. The LMF responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx.](f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg) + +``` + +sequenceDiagram + participant NF service consumer + participant LMF + Note left of NF service consumer: 1. POST ../up-configure (UpConfig) + NF service consumer->>LMF: 1. POST ../up-configure (UpConfig) + Note right of LMF: 2a. 204 No Content + LMF-->>NF service consumer: 2a. 204 No Content + Note right of LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + LMF-->>NF service consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram for LCS-UP connection. The NF service consumer sends a POST ../up-configure (UpConfig) request to the LMF. The LMF responds with either 2a. 204 No Content or 2b. 4xx/5xx (ProblemDetails) or 3xx. + +Figure 5.2.2.9.2-1: LCS-UP connection + +1. The NF Service Consumer shall send an HTTP POST request to the resource URI associated with the "up-configure" custom operation to set up, modify or terminate LCS-UP connection. +- 2a. On success, "204 No Content" shall be returned if no additional information needs to be returned in the response. +- 2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.4.7.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 errors listed in Table 6.1.4.7.2-2. + +## 5.3 Nlmf\_Broadcast Service + +### 5.3.1 Service Description + +The Nlmf\_Broadcast service enables an NF to obtain ciphering keys and associated parameters applicable to location assistance data that is broadcast to subscribed UEs in ciphered form. + +### 5.3.2 Service Operations + +#### 5.3.2.1 Introduction + +The service operations defined for the Nlmf\_Broadcast service are as follows: + +- CipheringKeyData: It provides the ciphering key information to the consumer NF. + +#### 5.3.2.2 CipheringKeyData + +##### 5.3.2.2.1 General + +The following procedures are defined, using the "CipheringKeyData" service operation: + +- Request Ciphering Key Information +- Provide Ciphering Key Information + +NOTE: The Request Ciphering Key procedure is included in order to provide a valid context in OpenAPI version 3 for the Provide Ciphering Key Information procedure. The Request Ciphering Key procedure is not used for support of ciphering key transfer in 3GPP TS 23.273 [19] and hence need not be supported by an NF Service Consumer or by an LMF. + +##### 5.3.2.2.2 Request Ciphering Key Information + +This procedure allows a consumer NF to request ciphering key information. + +![Sequence diagram for CipheringKeyData Request showing interaction between NF Service Consumer and LMF.](9a047c6501a487b3f18cfff971bcb33f_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant LMF + Note left of NF Service Consumer: Request Ciphering Key Information + NF Service Consumer->>LMF: 1. POST .../cipher-key-data (CipherRequestData) + Note right of LMF: Response + LMF-->>NF Service Consumer: 2a. 200 OK (CipherResponseData) + Note right of LMF: Failure/Redirection + LMF-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) or 3xx +``` + +Sequence diagram for CipheringKeyData Request showing interaction between NF Service Consumer and LMF. + +**Figure 5.3.2.2.2-1: CipheringKeyData Request** + +1. The NF Service Consumer shall send an HTTP POST request to the resource URI associated with the "cipher-key-data" custom operation. The request body shall include a notification callback URI. +- 2a. On success, "200 OK" shall be returned. The response body shall indicate whether the LMF has ciphering key data. If the LMF has ciphering key data, the Provide Ciphering Key Information procedure is used to provide the ciphering key data to the NF Service Consumer. +- 2b. On failure or redirection, one of the HTTP status codes listed in Table 6.2.4.4.2-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 errors listed in Table 6.2.7.3-1. + +##### 5.3.2.2.3 Provide Ciphering Key Information + +This procedure notifies the NF Service Consumer (i.e. AMF) about updated ciphering key information applicable to broadcast of location assistance data in ciphered form to subscribed UEs. The notification is delivered to: + +- the callback URI of an AMF received during an earlier CipheringKeyData request service operation if still available; or +- a callback URI registered in the NRF, if the AMF registered to the NRF with notification endpoints for ciphering key data notifications; + +Otherwise (if not available), + +- an AMF callback URI locally provisioned in the LMF. + +The procedure is invoked by issuing a POST request to the callback URI of the NF Service Consumer. See figure 5.3.2.2.3-1. + +![Sequence diagram showing the interaction between LMF and NF Service Consumer for CipheringKeyData Notify. The LMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 200 OK (CipheringKeyResponse) or a 4xx/5xx (ProblemDetails) or 3xx status code.](608f1b5ef8f3dc0723f2b4ea1fb72be2_img.jpg) + +``` + +sequenceDiagram + participant LMF + participant NFSC as NF Service Consumer + Note left of LMF: LMF + Note right of NFSC: NF Service Consumer + LMF->>NFSC: 1. POST {amfCallBackURI} (CipheringKeyInfo) + NFSC-->>LMF: 2a. 200 OK (CipheringKeyResponse) + NFSC-->>LMF: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram showing the interaction between LMF and NF Service Consumer for CipheringKeyData Notify. The LMF sends a POST request to the NF Service Consumer. The NF Service Consumer responds with either a 200 OK (CipheringKeyResponse) or a 4xx/5xx (ProblemDetails) or 3xx status code. + +Figure 5.3.2.2.3-1: CipheringKeyData Notify + +1. The LMF shall send an HTTP POST request to the callback URI for the NF service consumer determined as described above. The request body shall include one or more ciphering keys and for each ciphering key may include a ciphering key value, ciphering key identifier, validity period and set of applicable types of broadcast assistance data. +- 2a. On success or partial success, "200 OK" shall be returned. The response body shall indicate which ciphering key information was successfully stored by the NF service consumer. +- 2b. On failure or redirection to store any ciphering key information, one of the HTTP status codes listed in table 6.2.5.1.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 errors listed in table 6.2.5.1.3.1-2. + +# 6 API Definitions + +## 6.1 Nlmf\_Location Service API + +### 6.1.1 API URI + +The Nlmf\_Location service shall use the Nlmf\_Location API. + +The API URI of the Nlmf\_Location API shall be: + +**{apiRoot}//** + +The request URI 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 "nlmf-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 [12], 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 Nlmf\_Location service shall comply with the OpenAPI [14] 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 [13], 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". + +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 or more binary body parts 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.lpp | Binary encoded payload, encoding LTE Positioning Protocol (LPP) IEs, as specified in 3GPP TS 37.355 [21]. | +| NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload (e.g. LPP information) 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.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 [4], clause 5.2.3.2.2. + +This API does not define any new HTTP custom headers. + +#### 6.1.2.4 HTTP multipart messages + +HTTP multipart messages shall be supported, to transfer opaque LPP Information, in the following service operations (and HTTP messages): + +- DetermineLocation Request (POST); + +HTTP multipart messages shall include one JSON body part and one or more binary body parts comprising: + +- one LPP payload (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. + +For each binary body part in a HTTP multipart message, the binary body part shall include a Content-ID header (see IETF RFC 2045 [10]), and the JSON body part shall include an attribute, defined with the RefToBinaryData type, that contains the value of the Content-ID header field of the referenced binary body part. + +### 6.1.3 Resources + +#### 6.1.3.1 Overview + +The structure of the Resource URIs of the Nlmf\_Location service is shown in figure 6.1.3.1-1. + +![Figure 6.1.3.1-1: Resource URI structure of the Nlmf_Location API. The diagram shows a vertical hierarchy starting with {apiRoot}/nlmf-loc/. Six horizontal branches lead to resource paths: /determine-location, /cancel-location, /location-context-transfer, /location-measure, /up-subscription, and /up-configure. Each path is enclosed in a dashed rounded rectangle.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +``` + +graph TD + Root["{apiRoot}/nlmf-loc/"] --> D["/determine-location"] + Root --> C["/cancel-location"] + Root --> L["/location-context-transfer"] + Root --> M["/location-measure"] + Root --> U["/up-subscription"] + Root --> P["/up-configure"] + style D stroke-dasharray: 5 5 + style C stroke-dasharray: 5 5 + style L stroke-dasharray: 5 5 + style M stroke-dasharray: 5 5 + style U stroke-dasharray: 5 5 + style P stroke-dasharray: 5 5 + +``` + +Figure 6.1.3.1-1: Resource URI structure of the Nlmf\_Location API. The diagram shows a vertical hierarchy starting with {apiRoot}/nlmf-loc/. Six horizontal branches lead to resource paths: /determine-location, /cancel-location, /location-context-transfer, /location-measure, /up-subscription, and /up-configure. Each path is enclosed in a dashed rounded rectangle. + +Figure 6.1.3.1-1: Resource URI structure of the Nlmf\_Location API + +### 6.1.4 Custom Operations without associated resources + +#### 6.1.4.1 Overview + +The URI structure for Custom Operations without associated resources is included as part of the Figure 6.1.3.1-1 + +Table 6.1.4.1-1: Custom operations without associated resources + +| Operation Name | Custom operation URI | Mapped HTTP method | Description (Service Operation) | +|---------------------------|----------------------------|--------------------|---------------------------------------------------| +| determine-location | /determine-location | POST | Determine Location | +| cancel-location | /cancel-location | POST | Cancel Location | +| location-context-transfer | /location-context-transfer | POST | Transfer Location Context | +| location-measure | /location-measure | POST | Location Measure | +| up-subscription | /up-subscription | POST | UpSubscribe | +| up-configure | /up-configure | POST | Create, Modify or Terminate the LCS-UP connection | + +#### 6.1.4.2 Operation: determine-location + +##### 6.1.4.2.1 Description + +This clause will describe the custom operation and what it is used for, and the custom operation's URI. + +##### 6.1.4.2.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.2.2-1 and 6.1.4.2.2-2. + +Table 6.1.4.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 "Determine Location" operation | + +Table 6.1.4.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 activation of periodic or triggered location in the UE.

Upon success, a response body is returned containing the different parameters of the location data with one or more corresponding UEs if obtained, such as:
  • - Geographic Area
  • - Civic Location
  • - Local location,
  • - Positioning methods
| +| n/a | | | 204 No Content | This case represents the successful delivery of location assistance data to the UE, during MO-LR requesting for location assistance data for the 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 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
  • - POSITIONING_DENIED
  • - UNSPECIFIED
  • - UNSUPPORTED_BY_UE
  • - PAGING_NOT_ALLOWED

See table 6.1.7.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.7.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

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.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 LMF or LMF (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.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 LMF or LMF (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.3 Operation: cancel-location + +##### 6.1.4.3.1 Description + +This clause describes the custom operation and what it is used for. + +##### 6.1.4.3.2 Operation Definition + +This operation shall support the request and response data structures and response codes specified in table 6.1.4.3.2-1 and table 6.1.4.3.2-2. + +**Table 6.1.4.3.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|---------------|---|-------------|------------------------------------------| +| CancelLocData | M | 1 | The information used to cancel location. | + +**Table 6.1.4.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. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
  • - UNSPECIFIED
  • - LOCATION_SESSION_UNKNOWN
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.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 LMF or LMF (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.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 LMF or LMF (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.4 Operation: location-context-transfer + +##### 6.1.4.4.1 Description + +This clause will describe the custom operation and what it is used for. + +##### 6.1.4.4.2 Operation Definition + +This operation shall support the request and response data structures and response codes specified in table 6.1.4.4.2-1 and table 6.1.4.4.2-2. + +**Table 6.1.4.4.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|---------------------------------------------------------------| +| LocContextData | M | 1 | Input parameters to the "Location Context Transfer" operation | + +**Table 6.1.4.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 transfer of the location context. | +| 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 | The "cause" attribute may be used to indicate the following application errors:
  • - UNSPECIFIED
  • - LOCATION_TRANSFER_NOT_SUPPORTED
  • - INSUFFICIENT_RESOURCES
  • - EVENT_REPORT_UNRECOGNIZED
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.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 LMF or LMF (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.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 LMF or LMF (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.5 Operation: location-measure + +##### 6.1.4.5.1 Description + +This clause will describe the custom operation and what it is used for, and the custom operation's URI. + +##### 6.1.4.5.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.5.2-1 and 6.1.4.5.2-2. + +**Table 6.1.4.5.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|------------------------------------------------------| +| LocMeasurement Req | M | 1 | Input parameters to the "Location Measure" operation | + +**Table 6.1.4.5.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| LocMeasurementResp | M | 1 | 200 OK | This case represents the successful retrieval of the location measurements of the PRU. | +| 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 a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| 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 a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
  • - UNSPECIFIED
  • - LOCATION_MEASUREMENT_UNKNOWN
See table 6.1.7.3-1 for the description of these errors. | + +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]). + +**Table 6.1.4.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 LMF or LMF (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.1.4.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 LMF or LMF (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.1.4.6 Operation: up-subscription + +##### 6.1.4.6.1 Description + +This clause will describe the custom operation and what it is used for, and the custom operation's URI. + +##### 6.1.4.6.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.6.2-1 and 6.1.4.6.2-2. + +**Table 6.1.4.6.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|----------------|---|-------------|-------------------------------------------------| +| UpSubscription | M | 1 | Input parameters to the "UPSubscribe" operation | + +**Table 6.1.4.6.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 delivery of location assistance data to the UE, during MO-LR requesting for location assistance data for the UE. | +| 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 a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| 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 a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | + +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]). + +**Table 6.1.4.6.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 LMF or LMF (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.1.4.6.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 LMF or LMF (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.1.4.7 Operation: up-configure + +##### 6.1.4.7.1 Description + +This clause will describe the custom operation and what it is used for, and the custom operation's URI. + +##### 6.1.4.7.2 Operation Definition + +This operation shall support the response data structures and response codes specified in tables 6.1.4.7.2-1 and 6.1.4.7.2-2. + +Table 6.1.4.7.2-1: Data structures supported by the POST Request Body on this resource + +| Data type | P | Cardinality | Description | +|-----------|---|-------------|----------------------------------------------| +| UpConfig | M | 1 | Input parameters to the "UPConfig" operation | + +Table 6.1.4.7.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 set up, modify or terminate LCS-UP connection. | +| 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 a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| 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 a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set. | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
  • - UNSPECIFIED
See table 6.1.7.3-1 for the description of these errors. | + +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]). + +Table 6.1.4.7.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 LMF or LMF (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.1.4.7.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 LMF or LMF (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.1.5 Notifications + +This clause specifies the notifications provided by the Nlmf\_Location service. + +Table 6.1.5.1-1: Notifications overview + +| Notification | Callback URI | HTTP method or custom operation | Description (service operation) | +|--------------|--------------------|---------------------------------|---------------------------------| +| EventNotify | {hgmlcCallBackURI} | POST | | + +#### 6.1.5.1 EventNotify + +##### 6.1.5.1.1 Description + +The EventNotify operation is used to notify the occurrence of periodic or triggered location event for a target UE to a consumer NF (e.g. GMLC). + +##### 6.1.5.1.2 Notification Definition + +Callback URI: {hgmlcCallBackURI} + +See clause 5.2.2.1.2 for the description of how the LMF obtains the Callback URI of the NF Service Consumer (e.g. GMLC). + +##### 6.1.5.1.3 Notification Standard Methods + +###### 6.1.5.1.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.5.1.3.1-1 and table 6.1.5.1.3.1-2. + +Table 6.1.5.1.3.1-1: Data structures supported by the POST Request Body + +| Data type | P | Cardinality | Description | +|--------------------|---|-------------|-----------------------------------------------------------| +| EventNotifyDataExt | M | 1 | Input parameters to the "Location Event Notify" operation | + +Table 6.1.5.1.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. (NOTE 2) | +| RedirectResponse | O | 0..1 | 308 Permanent Redirect | Permanent redirection. (NOTE 2) | +| ProblemDetails | O | 0..1 | 403 Forbidden | The "cause" attribute may be used to indicate the following application errors:
- UNSPECIFIED
- LOCATION_SESSION_UNKNOWN

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.5.1.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 [4]. | +| 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.5.1.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 [4]. | +| 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.2 UPNotify + +##### 6.1.5.2.1 Description + +The UPNotify operation is used to notify the status or modification of a secure LCS-UP connection for a target UE to a consumer NF (e.g. AMF). + +##### 6.1.5.2.2 Notification Definition + +Callback URI: {upNotifyCallBackURI} + +See clause 5.2.2.1.2 for the description of how the LMF obtains the Callback URI of the NF Service Consumer (e.g. AMF). + +##### 6.1.5.2.3 Notification Standard Methods + +###### 6.1.5.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.5.2.3.1-1 and table 6.1.5.2.3.1-2. + +**Table 6.1.5.2.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|--------------|---|-------------|----------------------------------------------| +| UpNotifyData | M | 1 | Input parameters to the "UPNotify" operation | + +**Table 6.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 | This case represents successful notification of the event. | +| 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 | The "cause" attribute may be used to indicate the following application errors:
- UNSPECIFIED
- LOCATION_SESSION_UNKNOWN

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.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 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 notification is redirected | + +**Table 6.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 | 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 [4]. | +| 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.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 Nlmf\_Location service based interface protocol. + +**Table 6.1.6.1-1: Nlmf\_Location specific Data Types** + +| Data type | Clause defined | Description | +|----------------------------------------------|----------------|---------------------------------------------------------------------------------------| +| InputData | 6.1.6.2.2 | Information within Determine Location Request | +| LocationData | 6.1.6.2.3 | Information within Determine Location Response | +| GeographicalCoordinates | 6.1.6.2.4 | Geographical coordinates | +| GeographicArea | 6.1.6.2.5 | Geographic area specified by different shape | +| Point | 6.1.6.2.6 | Ellipsoid Point | +| PointUncertaintyCircle | 6.1.6.2.7 | Ellipsoid point with uncertainty circle | +| PointUncertaintyEllipse | 6.1.6.2.8 | Ellipsoid point with uncertainty ellipse | +| Polygon | 6.1.6.2.9 | Polygon | +| PointAltitude | 6.1.6.2.10 | Ellipsoid point with altitude | +| PointAltitudeUncertainty | 6.1.6.2.11 | Ellipsoid point with altitude and uncertainty ellipsoid | +| EllipsoidArc | 6.1.6.2.12 | Ellipsoid Arc | +| LocationQoS | 6.1.6.2.13 | QoS of Location request | +| CivicAddress | 6.1.6.2.14 | Indicates a Civic address | +| PositioningMethodAndUsage | 6.1.6.2.15 | Indicates the usage of a positioning method | +| GnssPositioningMethodAndUsage | 6.1.6.2.16 | Indicates the usage of a Global Navigation Satellite System (GNSS) positioning method | +| VelocityEstimate | 6.1.6.2.17 | Velocity estimate | +| HorizontalVelocity | 6.1.6.2.18 | Horizontal velocity | +| HorizontalWithVerticalVelocity | 6.1.6.2.19 | Horizontal and vertical velocity | +| HorizontalVelocityWithUncertainty | 6.1.6.2.20 | Horizontal velocity with speed uncertainty | +| HorizontalWithVerticalVelocityAndUncertainty | 6.1.6.2.21 | Horizontal and vertical velocity with speed uncertainty | +| UncertaintyEllipse | 6.1.6.2.22 | Ellipse with uncertainty | +| UeLcsCapability | 6.1.6.2.23 | Indicates the LCS capability supported by the UE. | +| PeriodicEventInfo | 6.1.6.2.24 | Indicates the information of periodic event reporting | +| AreaEventInfo | 6.1.6.2.25 | Indicates the information of area based event reporting | +| ReportingArea | 6.1.6.2.26 | Indicates an area for event reporting | +| MotionEventInfo | 6.1.6.2.27 | Indicates the information of motion based event reporting | +| CancelLocData | 6.1.6.2.29 | Information within Cancel Location Request | +| LocContextData | 6.1.6.2.30 | Information within Transfer Location Context Request | +| EventReportMessage | 6.1.6.2.31 | Indicates an event report message | +| EventReportingStatus | 6.1.6.2.32 | Indicates the status of event reporting | +| UELlocationInfo | 6.1.6.2.33 | Indicates location information of a UE | +| EventNotifyData | 6.1.6.2.34 | Information within Event Notify Request | +| UeConnectivityState | 6.1.6.2.35 | Indicates the connectivity state of a UE | +| LocalOrigin | 6.1.6.2.36 | Indicates a Local origin in a reference system. | +| RelativeCartesianLocation | 6.1.6.2.37 | Relative Cartesian Location | +| Local2dPointUncertaintyEllipse | 6.1.6.2.38 | Local 2D point with uncertainty ellipse | +| Local3dPointUncertaintyEllipsoid | 6.1.6.2.39 | Local 3D point with uncertainty ellipsoid | +| UncertaintyEllipsoid | 6.1.6.2.40 | Ellipsoid with uncertainty | +| LocalArea | 6.1.6.2.41 | Local area specified by different shape | +| UeAreaIndication | 6.1.6.2.42 | UE area Indication | +| MinorLocationQoS | 6.1.6.2.43 | Minor Location QoS | +| MbsrInfo | 6.1.6.2.44 | MBSR Information | +| LocMeasurementReq | 6.1.6.2.45 | Location Measurement Request | +| LocMeasurementResp | 6.1.6.2.46 | Location Measurement Response | +| LocMeasurements | 6.1.6.2.47 | Location Measurements result | +| HighAccuracyGnssMetrics | 6.1.6.2.48 | High Accuracy GNSS Metrics | +| UpNotifyData | 6.1.6.2.49 | UP Notify Data | +| UpSubscription | 6.1.6.2.50 | UP Subscription | +| RelatedUE | 6.1.6.2.51 | Specifies information for related UE for ranging and sidelink positioning | +| UpConfig | 6.1.6.2.52 | UP Config | +| RangeDirection | 6.1.6.2.53 | Represents the range and direction between two points. | + +| | | | +|-----------------------------|------------|------------------------------------------------------------------------------------------------------| +| 2DRelativeLocation | 6.1.6.2.54 | Represents 2D local co-ordinates with origin corresponding to another known point. | +| 3DRelativeLocation | 6.1.6.2.55 | Represents 3D local co-ordinates with origin corresponding to another known point. | +| AddLocationDatas | 6.1.6.2.56 | Contains one or more LocationData. | +| AddEventNotifyDatas | 6.1.6.2.57 | Contains one or more EventNotifyData. | +| LocationDataExt | 6.1.6.2.58 | Represents location data with one or more corresponding UEs. | +| EventNotifyDataExt | 6.1.6.2.59 | Represents notified data with one or more corresponding UEs, containing one or more EventNotifyData. | +| MappedLocationQoSEps | 6.1.6.2.60 | Mapped Location QoS for EPS | +| AdditionalUeInfo | 6.1.6.2.61 | MBSR UE Information | +| Altitude | 6.1.6.3.2 | Indicates value of altitude | +| Angle | 6.1.6.3.2 | Indicates value of angle | +| Uncertainty | 6.1.6.3.2 | Indicates value of uncertainty | +| Orientation | 6.1.6.3.2 | Indicates value of orientation angle | +| Confidence | 6.1.6.3.2 | Indicates value of confidence | +| Accuracy | 6.1.6.3.2 | Indicates value of accuracy | +| InnerRadius | 6.1.6.3.2 | Indicates value of the inner radius | +| CorrelationID | 6.1.6.3.2 | LCS Correlation ID | +| AgeOfLocationEstimate | 6.1.6.3.2 | Indicates value of the age of the location estimate | +| HorizontalSpeed | 6.1.6.3.2 | Indicates value of horizontal speed | +| VerticalSpeed | 6.1.6.3.2 | Indicates value of vertical speed | +| SpeedUncertainty | 6.1.6.3.2 | Indicates value of speed uncertainty | +| BarometricPressure | 6.1.6.3.2 | Specifies the measured uncompensated atmospheric pressure | +| LcsServiceType | 6.1.6.3.2 | LCS service type | +| LdrReference | 6.1.6.3.2 | LDR Reference | +| LirReference | 6.1.6.3.2 | LIR Reference | +| ReportingAmount | 6.1.6.3.2 | Number of required periodic event reports | +| ReportingInterval | 6.1.6.3.2 | Event reporting periodic interval | +| MinimumInterval | 6.1.6.3.2 | Minimum interval between event reports | +| MaximumInterval | 6.1.6.3.2 | Maximum interval between event reports | +| SamplingInterval | 6.1.6.3.2 | Maximum time interval between consecutive evaluations by a UE of a trigger event | +| ReportingDuration | 6.1.6.3.2 | Maximum duration of event reporting | +| LinearDistance | 6.1.6.3.2 | Minimum straight line distance moved by a UE to trigger a motion event report | +| LMFIdentification | 6.1.6.3.2 | LMF identification | +| EventReportCounter | 6.1.6.3.2 | Number of event reports received from the target UE | +| EventReportDuration | 6.1.6.3.2 | Duration of event reporting | +| UePositioningCapabilities | 6.1.6.3.2 | Indicates the positioning capabilities supported by the UE. | +| ExternalClientType | 6.1.6.3.3 | Indicates types of External Clients | +| SupportedGADShapes | 6.1.6.3.4 | Indicates supported GAD shapes | +| ResponseTime | 6.1.6.3.5 | Indicates acceptable delay of location request | +| PositioningMethod | 6.1.6.3.6 | Indicates supported positioning methods | +| PositioningMode | 6.1.6.3.7 | Indicates supported modes used for positioning method | +| GnssId | 6.1.6.3.8 | Global Navigation Satellite System (GNSS) ID | +| Usage | 6.1.6.3.9 | Indicates usage made of the location measurement | +| LcsPriority | 6.1.6.3.10 | Indicates priority of the LCS client | +| VelocityRequested | 6.1.6.3.11 | Indicates velocity requirement | +| AccuracyFulfilmentIndicator | 6.1.6.3.12 | Indicates fulfilment of requested accuracy | +| VerticalDirection | 6.1.6.3.13 | Indicates direction of vertical speed | +| LdrType | 6.1.6.3.14 | Indicates LDR types | +| ReportingAreaType | 6.1.6.3.15 | Indicates type of event reporting area | +| OccurrenceInfo | 6.1.6.3.16 | Specifies occurrence of event reporting | +| ReportingAccessType | 6.1.6.3.17 | Specifies access types of event reporting | +| EventClass | 6.1.6.3.18 | Specifies event classes | + +| | | | +|-----------------------------|------------|------------------------------------------------------------------------| +| ReportedEventType | 6.1.6.3.19 | Specifies type of event reporting | +| TerminationCause | 6.1.6.3.20 | Specifies causes of event reporting termination | +| LcsQosClass | 6.1.6.3.21 | Specifies LCS QoS class | +| UeLocationServiceInd | 6.1.6.3.22 | Specifies location service types requested by UE | +| IndoorOutdoorInd | 6.1.6.3.23 | Indoor Outdoor Indication | +| FixType | 6.1.6.3.24 | Fix Type | +| LosNlosMeasureInd | 6.1.6.3.25 | LOS/NLOS measurement indication | +| UpConnectionStatus | 6.1.6.3.26 | UP Connection Status | +| RangingSIResult | 6.1.6.3.27 | Specifies result type for ranging and sidelink positioning | +| RelatedUEType | 6.1.6.3.28 | Specifies type of related UE for ranging and sidelink positioning | +| LcsUpConnectionInd | 6.1.6.3.29 | LCS UP Connection Indication | +| UeUpPositioningCapabilities | 6.1.6.3.30 | Indicates the user plane positioning capabilities supported by the UE. | + +Table 6.1.6.1-2 specifies data types re-used by the Nlmf\_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 Nlmf\_Location service based interface. + +**Table 6.1.6.1-2: Nlmf\_Location re-used Data Types** + +| Data type | Reference | Comments | +|-----------------------|---------------------|-------------------------------------------------------------------| +| Supi | 3GPP TS 29.571 [8] | Subscription Permanent Identifier | +| Pei | 3GPP TS 29.571 [8] | Permanent Equipment Identifier | +| Gpsi | 3GPP TS 29.571 [8] | Generic Public Subscription Identifier | +| Ecgi | 3GPP TS 29.571 [8] | E-UTRA Cell Identity | +| Ncgi | 3GPP TS 29.571 [8] | NR Cell Identity | +| NfInstanceId | 3GPP TS 29.571 [8] | Network Function Instance ID | +| Uri | 3GPP TS 29.571 [8] | Uniform Resource Identifier | +| RefToBinaryData | 3GPP TS 29.571 [8] | Reference to binary data | +| AccessType | 3GPP TS 29.571 [8] | Access type | +| CmState | 3GPP TS 29.518 [23] | Connection Management State | +| Guami | 3GPP TS 29.571 [8] | GUAMI | +| SupportedFeatures | 3GPP TS 29.571 [8] | Supported Features | +| RedirectResponse | 3GPP TS 29.571 [8] | Redirect Response | +| TwapId | 3GPP TS 29.571 [8] | TWAP identifier | +| TnapId | 3GPP TS 29.571 [8] | TNAP identifier | +| DateTime | 3GPP TS 29.571 [8] | Date and Time | +| DurationSec | 3GPP TS 29.571 [8] | Duration Second | +| LpHapType | 3GPP TS 29.518 [23] | Type of Low Power and/or High Accuracy Positioning | +| ReportingInd | 3GPP TS 29.515 [27] | Reporting indication | +| IntegrityRequirements | 3GPP TS 29.515 [28] | Integrity Requirements | +| UpLocRepAddrAfRm | 3GPP TS 29.122 [29] | Endpoint address for location reporting over user plane | +| UpCumEvtRptCriteria | 3GPP TS 29.515 [27] | Criteria for sending cumulative events reports over control plane | + +#### 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: InputData + +**Table 6.1.6.2.2-1: Definition of type InputData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| externalClientType | ExternalClientType | O | 0..1 | When present, this IE shall carry the external client type of the requester. | | +| correlationID | CorrelationID | O | 0..1 | When present, this IE shall carry the correlation ID of the request. | | +| amfId | NfInstanceId | O | 0..1 | Indicates the AMF Instance serving the UE. LMF shall use the AMF Instance to forward LCS related N1/N2 messages to the UE/RAN. | | +| locationQoS | LocationQoS | O | 0..1 | When present, this IE shall carry the QoS of the location request. | | +| supportedGADShapes | array(SupportedGADShapes) | O | 1..N | When present, this IE shall carry the GAD shapes supported by the requester. | | +| supi | Supi | O | 0..1 | Indicates the SUPI of the target UE. | | +| pei | Pei | O | 0..1 | Indicates the PEI of the target UE. | | +| gpsi | Gpsi | O | 0..1 | Indicates the GPSI of the target UE. | | +| ecgi | Ecgi | O | 0..1 | When present, this IE shall indicate the identifier of the E-UTRAN cell serving the UE or the serving cell identifier of the Primary Cell in the Master RAN Node that is an E-UTRAN node on Dual Connectivity scenarios. (NOTE 2) | | +| ecgiOnSecondNode | Ecgi | O | 0..1 | When present, the serving cell identifier of the Primary Cell in the Secondary RAN Node that is an E-UTRAN node when available on Dual Connectivity scenarios. (NOTE 3) (NOTE 4) | | +| ncgi | Ncgi | O | 0..1 | When present, this IE shall indicate the identifier of the NR cell serving the UE or the serving cell identifier of the Primary Cell in the Master RAN Node that is a NR node on Dual Connectivity scenarios. (NOTE 2) | | +| ncgiOnSecondNode | Ncgi | O | 0..1 | When present, the serving cell identifier of the Primary Cell in the Secondary RAN Node that is a NR node when available on Dual Connectivity scenarios. (NOTE 3) (NOTE 4) | | +| priority | LcsPriority | O | 0..1 | When present, this IE shall indicate the priority of the location request. | | +| velocityRequested | VelocityRequested | O | 0..1 | When present, this IE shall indicate whether velocity is requested or not. | | +| ueLcsCap | UeLcsCapability | O | 0..1 | When present, this IE shall indicate the LCS capability supported by the UE. | | +| lcsServiceType | LcsServiceType | O | 0..1 | The LCS service type | | +| ldrType | LdrType | O | 0..1 | The type of LDR | | +| hgmlcCallBackURI | Uri | C | 0..1 | Callback URI of the H-GMLC

It shall be present, if attribute LdrType is present.

This IE shall also be present for location service in PNI-NPN with signalling optimisation, as specified in 3GPP TS 23.273 [42] clause 6.1.2. | | +| lirGmlcCallBackUri | Uri | C | 0..1 | This IE shall be present when the intermediateLocationInd IE is present with the value "true".

When present, this IE shall contain callback URI of the GMLC to receive the intermediate location reports. | | +| vgmlcAddress | Uri | C | 0..1 | V-GMLC address that corresponds to the V-GMLC that receives Location Request
It shall be present, if attribute LdrType is present and the target UE is in roaming case. | | + +| | | | | | | +|-----------------------|---------------------------------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----| +| ldrReference | LdrReference | C | 0..1 | LDR Reference Number

It shall be present, if attribute LdrType is present.

This IE shall be present for location service in PNI-NPN with signalling optimisation, as specified in 3GPP TS 23.273 [42] clause 6.1.2. | | +| lirReference | LirReference | C | 0..1 | This IE shall be present when the intermediateLocationInd IE is present with the value "true".

When present, this IE shall contain the LIR Reference Number for a multiple location request | | +| periodicEventInfo | PeriodicEventInfo | C | 0..1 | Information for periodic event reporting | | +| areaEventInfo | AreaEventInfo | C | 0..1 | Information for area event reporting | | +| motionEventInfo | MotionEventInfo | C | 0..1 | Information for motion event reporting | | +| reportingAccessTypes | array(ReportingAccessTypes) | O | 1..N | Allowed access types for event reporting | | +| ueConnectivityStates | array(UeConnectivityState) | O | 1..N | When present, this IE shall indicate the UE connectivity state per access type | | +| ueLocationServiceInd | UeLocationServiceInd | C | 0..1 | If UE sends an MO-LR Request message, this IE shall be present and indicate the request type for a 5GC-MO-LR. | | +| moAssistanceDataTypes | LcsBroadcastAssistanceTypesData | O | 0..1 | When present, this IE shall indicate a list of one or more types of location assistance data that UE subscribed. | | +| lppMessage | RefToBinaryData | C | 0..1 | If UE includes the first LPP message in MO-LR Request, this IE shall be present and Indicate the binary data of LPP message.
(NOTE 5) | | +| lppMessageExt | array(RefToBinaryData) | C | 1..N | If UE includes the additional LPP messages (maximum 3) in MO-LR Request, this IE shall be present and Indicates the binary data of LPP message.
(NOTE 5) | | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | | +| uePositioningCap | UePositioningCapabilities | O | 0..1 | When present, this IE shall indicate the positioning capabilities supported by the UE. | | +| tnapId | TnapId | O | 0..1 | When present, this IE shall contain the TNAP Identifier.

This IE may be present for non-3GPP access. | | +| twapId | TwapId | O | 0..1 | When present, This IE shall contain the TWAP Identifier.
This IE may be present for non-3GPP access. | | +| ueCountryDetInd | boolean | O | 0..1 | When present, This IE shall contain an indication of determining the UE geographical area identified by the country, area within a country or international area indication where UE is located for PLMN selection verification. | SAT | +| scheduledLocTime | DateTime | O | 0..1 | When present, this IE shall contain the scheduled time (in UTC) that the UE needs to be located. | | +| 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 [26] 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 | | + +| | | | | | | +|--------------------------|-------------------------------------|---|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------| +| evtRptAllowedAreas | array(ReportingArea) | O | 1..250 | When present, this IE shall contain a list of event report allowed areas, where UE is allowed to generate and send the event report to network during the deferred 5GC-MT-LR procedure for UE power saving purpose. | | +| ueUnawareInd | boolean | C | 0..1 | UE Unaware Positioning indication.

If the UE Unaware Positioning is required, as specified in 3GPP TS 23.273 [19] clause 5.12, this IE shall be included and set to true; otherwise, the IE shall be absent. | | +| intermediateLocationInd | boolean | C | 0..1 | This IE shall be included by the AMF if received from the GMLC, during a 5GC-MT-LR multiple location procedure for the regulatory location service (see clause 6.1.3 and clause 6.10.4 of 3GPP TS 23.273 [19]).

When present, this IE shall indicate the acceptance of intermediate location response at the GMLC:
- true: intermediate location response acceptable
- false (default): intermediate location response not acceptable | | +| maxRespTime | DurationSec | C | 0..1 | This IE shall be included by the AMF if received from the GMLC.

When present, this IE shall contain the maximum response time for the GMLC to receive the final location response.

The AMF may overwrite the received maximum response time when passing it to the LMF, e.g., to avoid timeout of the HTTP service request. | | +| 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 [19]. | | +| ueUpPosCaps | array(UeUpPositioning Capabilities) | O | 1..N | When present, this IE shall indicate the user plane positioning capabilities supported by the UE. | | +| reportingInd | ReportingInd | O | 0..1 | This IE may be present if the evtRptAllowedAreas IE 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 allowed areas:
- Inside reporting (default)
- Outside reporting
(see 3GPP TS 23.273 [19] clause 5.14 and 6.3.1) | | +| mbsrInfo | MbsrInfo | O | 0..1 | Indicates that serving cell of the UE belongs to a MBSR | MBSR | +| additionalUeInfo | AdditionalUeInfo | O | 0..1 | When present, this IE indicates the serving cell of the MBSR UE (i.e., IAB UE) | MBSR | +| integrityRequirements | IntegrityRequirements | O | 0..1 | When present, this IE shall indicate the integrity requirements. | | +| requestedRangingSIResult | array(RangingSIResult ) | O | 1..N | 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. | | +| relatedUEs | array(RelatedUE) | O | 1..N | This IE contains a list of the information for the related UEs for the ranging and sidelink positioning. | | + +| | | | | | | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| upLocRepAddrAf | UpLocRepAddrAfRm | O | 0..1 | This IE shall be present if the request is for the location reporting over user plane. | | +| upCumEvtRptCriteria | UpCumEvtRptCriteria | O | 0..1 | This IE may be present if the upLocRepAddrAf is present. | | +| 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 | +| mappedQoSEps | MappedLocationQoSeps | C | 0..1 | This IE shall be present 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 [19]). | | +| NOTE 1: At least one of the attributes defined in this table shall be present in the InputData structure. | | | | | | +| NOTE 2: Attribute "ecgi" and "ncgi" shall not be present at the same time. | | | | | | +| NOTE 3: Attribute "ecgiOnSecondNode" and "ncgiOnSecondNode" shall not be present at the same time. | | | | | | +| NOTE 4: Attribute "ecgiOnSecondNode" or "ncgiOnSecondNode" shall not be present if neither attribute "ecgi" nor "ncgi" is present. | | | | | | +| NOTE 5: If 3 LPP messages are received, then first LPP message shall be encoded in lppMessage IE and additional 2 LPP messages shall be encoded in lppMessageExt IE. | | | | | | + +##### 6.1.6.2.3 Type: LocationData + +**Table 6.1.6.2.3-1: Definition of type LocationData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|--------------------------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| locationEstimate | GeographicArea | M | 1 | For a request for triggered location where location estimates are not required, the location estimate can be based on current serving cell. | | +| accuracyFulfilmentIndicator | AccuracyFulfilmentIndicator | O | 0..1 | When present, this IE shall indicate fulfilment of required accuracy. | | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | When present, this IE shall indicate age of the 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). | | +| velocityEstimate | VelocityEstimate | O | 0..1 | When present, this IE shall indicate velocity estimate. | | +| civicAddress | CivicAddress | O | 0..1 | When present, this IE shall indicate a civic address. | | +| localLocationEstimate | LocalArea | O | 0..1 | When present, this IE shall indicate a local area in reference system. | | +| positioningDataList | array(PositioningMethodAndUsage) | O | 1..N | When present, this IE shall include a list of data related to positioning methods. | | +| gnssPositioningDataList | array(GNSSPositioningMethodAndUsage) | O | 1..N | When present, this IE shall include a list of data related to GNSS positioning methods. | | +| ecgi | Ecgi | O | 0..1 | When present, this IE shall indicate the ID of the E-UTRAN cell serving the UE. | | +| ncgi | Ncgi | O | 0..1 | When present, this IE shall indicate the ID of the NR cell serving the UE. | | +| altitude | Altitude | O | 0..1 | Altitude of the positioning estimate. When the shape used in "locationEstimate" supports conveying the altitude parameter, this IE shall be absent. | | +| barometricPressure | BarometricPressure | O | 0..1 | If present, this IE contains the barometric pressure measurement as reported by the target UE. | | +| servingLMFIdentification | LMFIdentification | O | 0..1 | When present, this IE shall indicate the identity of the serving LMF | | +| uePositioningCap | UePositioningCapabilities | O | 0..1 | When present, this IE shall indicate the positioning capabilities supported by 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. | | + +| | | | | | | +|---------------------------|-------------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| +| ueAreaInd | UeAreaIndication | O | 0..1 | When present, this IE shall contain a country, area in a country or international area indication where UE is located.

If UE is outside of the area of any known country, i.e. international area, then the LMF shall provide the International Area Indication without a country. | SAT | +| achievedQos | MinorLocationQoS | O | 0..1 | When present, this IE shall contain the achieved Location QoS Accuracy of the estimated location.

This IE may be present if the LCS QoS Class required in the request message is "MULTIPLE_QOS".

If it's absent, LCS QoS Class required in the request message is "MULTIPLE_QOS" and AccuracyFulfilmentIndicator is "REQUESTED_ACCURACY_FULFILLED", it indicates that the location QoS in the highest priority is achieved. | 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 | | +| indoorOutdoorInd | IndoorOutdoorInd | O | 0..1 | When present, this IE shall indicate whether the UE is indoor or outdoor. | | +| acceptedPeriodicEventInfo | PeriodicEventInfo | C | 0..1 | This IE shall be present if PeriodicEventInfo was received in the request which includes reportingAmountInf IE and/or reportingIntervalMs IE.

When present, this IE shall provide the accepted periodic event reporting information. | | +| haGnssMetrics | HighAccuracyGnssMetrics | O | 0..1 | When present, this IE shall indicate the high accuracy GNSS metrics received from the device in the LPP HA-GNSS-Metrics-r17 IE as specified in 3GPP TS 37.355 [21]. | | +| losNlosMeasureInd | LosNlosMeasureInd | O | 0..1 | When present, this IE shall indicate whether LOS measurement or NLOS measurement is used. | | + +##### 6.1.6.2.4 Type: GeographicalCoordinates + +Table 6.1.6.2.4-1: Definition of type GeographicalCoordinates + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------| +| lon | number | M | 1 | Longitude (Double-precision float value):
Format: double
Minimum: -180
Maximum: 180 | +| lat | number | M | 1 | Latitude (Double-precision float value):
Format: double
Minimum: -90
Maximum: 90 | + +##### 6.1.6.2.5 Type: GeographicArea + +Table 6.1.6.2.5-1: Definition of type GeographicArea as a list of mutually exclusive alternatives + +| Data type | Cardinality | Discriminator property name | Discriminator mapping | Description | +|--------------------------|-------------|-----------------------------|----------------------------|----------------------------------------------------------------------------------------------| +| Point | 1 | shape | POINT | Geographical area consisting of a single point, represented by its longitude and latitude. | +| PointUncertaintyCircle | 1 | shape | POINT_UNCERTAINTY_CIRCLE | Geographical area consisting of a point and an uncertainty value. | +| PointUncertaintyEllipse | 1 | shape | POINT_UNCERTAINTY_ELLIPSE | Geographical area consisting of a point, plus an uncertainty ellipse and a confidence value. | +| Polygon | 1 | shape | POLYGON | Geographical area consisting of a list of points (between 3 to 15 points). | +| PointAltitude | 1 | shape | POINT_ALTITUDE | Geographical area consisting of a point and an altitude value. | +| PointAltitudeUncertainty | 1 | shape | POINT_ALTITUDE_UNCERTAINTY | Geographical area consisting of a point, an altitude value and an uncertainty value. | +| EllipsoidArc | 1 | shape | ELLIPSOID_ARC | Geographical area consisting of an ellipsoid arc. | + +NOTE: The "anyOf" keyword (instead of "oneOf" keyword which is normally used for mutually exclusive alternatives) is used for GeographicArea type in yaml file to avoid validation failure of OpenAPI. According to current definition, a PointUncertaintyCircle object will always pass the validation with both PointUncertaintyCircle and Point, which fails the qualification of "oneOf" keyword. + +##### 6.1.6.2.6 Type: Point + +Table 6.1.6.2.6-1: Definition of type Point + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | + +##### 6.1.6.2.7 Type: PointUncertaintyCircle + +Table 6.1.6.2.7-1: Definition of type PointUncertaintyCircle + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT_UNCERTAINTY_CIRCLE". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| uncertainty | Uncertainty | M | 1 | Indicates the uncertainty value. | + +##### 6.1.6.2.8 Type: PointUncertaintyEllipse + +Table 6.1.6.2.8-1: Definition of type PointUncertaintyEllipse + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT_UNCERTAINTY_ELLIPSE". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| uncertaintyEllipse | UncertaintyEllipse | M | 1 | Indicates an uncertainty ellipse. | +| confidence | Confidence | M | 1 | Indicates the value of confidence. | + +##### 6.1.6.2.9 Type: Polygon + +Table 6.1.6.2.9-1: Definition of type Polygon + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|--------------------------------|---|-------------|----------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POLYGON". | +| pointList | array(GeographicalCoordinates) | M | 3..15 | Array with up to 15 items, where each item is a "point". | + +##### 6.1.6.2.10 Type: PointAltitude + +Table 6.1.6.2.10-1: Definition of type PointAltitude + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT_ALTITUDE". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| altitude | Altitude | M | 1 | Indicates the value of altitude. | + +##### 6.1.6.2.11 Type: PointAltitudeUncertainty + +Table 6.1.6.2.11-1: Definition of type PointAltitudeUncertainty + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "POINT_ALTITUDE_UNCERTAINTY". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| altitude | Altitude | M | 1 | Indicates the value of altitude. | +| uncertaintyEllipse | UncertaintyEllipse | M | 1 | Indicates the uncertainty ellipse | +| uncertaintyAltitude | Uncertainty | M | 1 | Indicates the uncertainty of the altitude. | +| confidence | Confidence | M | 1 | Indicates the value of confidence. | + +##### 6.1.6.2.12 Type: EllipsoidArc + +Table 6.1.6.2.12-1: Definition of type EllipsoidArc + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------|---|-------------|-------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "ELLIPSOID_ARC". | +| point | GeographicalCoordinates | M | 1 | Indicates a geographic point represented by its longitude and latitude. | +| innerRadius | InnerRadius | M | 1 | Indicates the value of inner radius of the Ellipsoid Arc. | +| uncertaintyRadius | Uncertainty | M | 1 | Indicates the uncertainty radius of the Ellipsoid Arc. | +| offsetAngle | Angle | M | 1 | Indicates the offset angle of the Ellipsoid Arc. | +| includedAngle | Angle | M | 1 | Indicates the included angle of the Ellipsoid Arc. | +| confidence | Confidence | M | 1 | Indicates the value of confidence. | + +##### 6.1.6.2.13 Type: LocationQoS + +Table 6.1.6.2.13-1: Definition of type LocationQoS + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| hAccuracy | Accuracy | O | 0..1 | Horizontal accuracy | | +| vAccuracy | Accuracy | O | 0..1 | Vertical accuracy | | +| vertRequested | boolean | O | 0..1 | Vertical accuracy requested (yes/no) | | +| responseTime | ResponseTime | O | 0..1 | No delay, Low delay or Delay tolerant | | +| minorLocQoses | array(MinorLocationQoS) | C | 1..2 | If present, this IE shall contain a list of MinorLocationQoS in priority order.

When the lcsQosClass sets to "MULTIPLE_QOS", this IE shall be present, and when lcsQosClass sets to either "BEST EFFORT" or "ASSURED" this IE shall be absent. | MUTIQOS | +| lcsQosClass | LcsQosClass | C | 0..1 | LCS QoS Class, see clause 4.1b of 3GPP TS 23.273 [19].
This IE shall be absent if neither hAccuracy nor vAccuracy is included. | | + +NOTE: If the lcsQosClass set to "MULTIPLE\_QOS", at least one of attributes hAccuracy, vAccuracy shall be present. + +6.1.6.2.14 Type: CivicAddress + +**Table 6.1.6.2.14-1: Definition of type CivicAddress** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------| +| country | string | M | 1 | The two-letter ISO 3166 country code in capital ASCII letters, e.g., DE or US
IETF RFC 4776 [6] | +| A1 | string | O | 0..1 | National subdivisions (state, canton, region, province, prefecture)
IETF RFC 4776 [6] | +| A2 | string | O | 0..1 | County, parish, gun (JP), district (IN)
IETF RFC 4776 [6] | +| A3 | string | O | 0..1 | City, township, shi (JP)
IETF RFC 4776 [6] | +| A4 | string | O | 0..1 | City division, borough, city district, ward, chou (JP)
IETF RFC 4776 [6] | +| A5 | string | O | 0..1 | Neighbourhood, block
IETF RFC 4776 [6] | +| A6 | string | O | 0..1 | Group of streets below the neighbourhood level
IETF RFC 4776 [6] | +| PRD | string | O | 0..1 | Leading street direction
IETF RFC 4776 [6] | +| POD | string | O | 0..1 | Trailing street suffix
IETF RFC 4776 [6] | +| STS | string | O | 0..1 | Street suffix or type
IETF RFC 4776 [6] | +| HNO | string | O | 0..1 | House number
IETF RFC 4776 [6] | +| HNS | string | O | 0..1 | House number suffix
IETF RFC 4776 [6] | +| LMK | string | O | 0..1 | Landmark or vanity address
IETF RFC 4776 [6] | +| LOC | string | O | 0..1 | Additional location information
IETF RFC 4776 [6] | +| NAM | string | O | 0..1 | Name (residence and office occupant)
IETF RFC 4776 [6] | +| PC | string | O | 0..1 | Postal/zip code
IETF RFC 4776 [6] | +| BLD | string | O | 0..1 | Building (structure)
IETF RFC 5139 [7] | +| UNIT | string | O | 0..1 | Unit (apartment, suite)
IETF RFC 5139 [7] | +| FLR | string | O | 0..1 | Floor
IETF RFC 4776 [6] | +| ROOM | string | O | 0..1 | Room
IETF RFC 5139 [7] | +| PLC | string | O | 0..1 | Place-type
IETF RFC 5139 [7] | +| PCN | string | O | 0..1 | Postal community name
IETF RFC 5139 [7] | +| POBOX | string | O | 0..1 | Post office box (P.O. box)
IETF RFC 5139 [7] | +| ADDCODE | string | O | 0..1 | Additional code
IETF RFC 5139 [7] | +| SEAT | string | O | 0..1 | Seat (desk, cubicle, workstation)
IETF RFC 5139 [7] | +| RD | string | O | 0..1 | Primary road or street
IETF RFC 5139 [7] | +| RDSEC | string | O | 0..1 | Road clause
IETF RFC 5139 [7] | +| RDBR | string | O | 0..1 | Road branch
IETF RFC 5139 [7] | +| RDSUBBR | string | O | 0..1 | Road sub-branch
IETF RFC 5139 [7] | +| PRM | string | O | 0..1 | Road pre-modifier
IETF RFC 5139 [7] | +| POM | string | O | 0..1 | Road post-modifier
IETF RFC 5139 [7] | + +| | | | | | +|------------|--------|---|------|----------------------------------------------------------------------------------------------------------------------------------------------| +| usageRules | string | O | 0..1 | When present, this IE shall carry the value of "usage-rules" Element of the PIDL-LO XML document, with UTF-8 encoding.
IETF RFC 4119 [25] | +| method | string | O | 0..1 | When present, this IE shall contain the method token, carried by the "method" Element of the PIDL-LO XML document.
IETF RFC 4119 [25] | +| providedBy | string | O | 0..1 | When present, this IE shall carry the value of "provided-by" Element of the PIDL-LO XML document, with UTF-8 encoding.
IETF RFC 4119 [25] | + +EXAMPLE: The above structure follows the same label naming as in the XML schema shown in IETF RFC 5139 [7]. The same example shown in XML in that RFC, in clause 5, would be equivalent to the following JSON document: + +``` +{ + "country": "AU", + "A1": "NSW", + "A3": "Wollongong", + "A4": "North Wollongong", + "RD": "Flinders", + "STS": "Street", + "RDBR": "Campbell Street", + "LMK": "Gilligan's Island", + "LOC": "Corner", + "NAM": "Video Rental Store", + "PC": "2500", + "ROOM": "Westerns and Classics", + "PLC": "store", + "POBOX": "Private Box 15" +} +``` + +##### 6.1.6.2.15 Type: PositioningMethodAndUsage + +**Table 6.1.6.2.15-1: Definition of type PositioningMethodAndUsage** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| method | PositioningMethod | M | 1 | Indicates the related positioning method | +| mode | PositioningMode | M | 1 | Indicates the mode of the location measurement from the related positioning method. | +| usage | Usage | M | 1 | Indicates the usage of the location measurement from the related positioning method. | +| methodCode | integer | C | 0..1 | This IE shall be present when the method IE is with value "NETWORK_SPECIFIC".

When present, this IE shall carry the code value of the network specific positioning method in decimal which encodes the binary value "10000 to 11111" (bits 8-4 of " Positioning Method and Usage " IE within " Positioning Data " parameter, as specified in clause 7.4.13 of 3GPP TS 29.171 [24].)

Minimum: 16
Maximum: 31 | + +6.1.6.2.16 Type: GnssPositioningMethodAndUsage + +**Table 6.1.6.2.16-1: Definition of type GnssPositioningMethodAndUsage** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|---------------------------------------------------------------------------------------| +| mode | PositioningMode | M | 1 | Indicates the mode of location measurement from the related GNSS positioning method. | +| gnss | GnssId | M | 1 | Indicates the related GNSS positioning method | +| usage | Usage | M | 1 | Indicates the usage of the location measurement from related GNSS positioning method. | + +6.1.6.2.17 Type: VelocityEstimate + +**Table 6.1.6.2.17-1: Definition of type VelocityEstimate as a list of mutually exclusive alternatives** + +| Data type | Cardinality | Description | +|----------------------------------------------|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| HorizontalVelocity | 1 | Velocity estimate including horizontal speed and bearing. | +| HorizontalWithVerticalVelocity | 1 | Velocity estimate including horizontal speed and bearing, and also vertical speed and vertical direction. | +| HorizontalVelocityWithUncertainty | 1 | Velocity estimate including horizontal speed and bearing; it also includes an uncertainty value. | +| HorizontalWithVerticalVelocityAndUncertainty | 1 | Velocity estimate including horizontal speed and bearing, and also vertical speed and vertical direction; it also includes uncertainty value for horizontal and vertical speeds. | + +6.1.6.2.18 Type: HorizontalVelocity + +**Table 6.1.6.2.18-1: Definition of type HorizontalVelocity** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|----------------------------------------------------------| +| hSpeed | HorizontalSpeed | M | 1 | Horizontal speed in kilometres per hour. | +| bearing | Angle | M | 1 | Bearing angle in degrees, measured clockwise from North. | + +6.1.6.2.19 Type: HorizontalWithVerticalVelocity + +**Table 6.1.6.2.19-1: Definition of type HorizontalWithVerticalVelocity** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|----------------------------------------------------------| +| hSpeed | HorizontalSpeed | M | 1 | Horizontal speed in kilometres per hour. | +| bearing | Angle | M | 1 | Bearing angle in degrees, measured clockwise from North. | +| vSpeed | VerticalSpeed | M | 1 | Vertical Speed in kilometres per hour. | +| vDirection | VerticalDirection | M | 1 | Vertical Direction: upward or downward. | + +6.1.6.2.20 Type: HorizontalVelocityWithUncertainty + +**Table 6.1.6.2.20-1: Definition of type HorizontalVelocityWithUncertainty** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|------------------|---|-------------|----------------------------------------------------------| +| hSpeed | HorizontalSpeed | M | 1 | Speed in kilometres per hour. | +| bearing | Angle | M | 1 | Bearing angle in degrees, measured clockwise from North. | +| uncertainty | SpeedUncertainty | M | 1 | Uncertainty of horizontal speed in kilometres per hour. | + +6.1.6.2.21 Type: HorizontalWithVerticalVelocityAndUncertainty + +**Table 6.1.6.2.21-1: Definition of type HorizontalWithVerticalVelocityAndUncertainty** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------|---|-------------|----------------------------------------------------------| +| hspeed | HorizontalSpeed | M | 1 | Speed in kilometres per hour. | +| bearing | Angle | M | 1 | Bearing angle in degrees, measured clockwise from North. | +| vSpeed | VerticalSpeed | M | 1 | Vertical Speed in kilometres per hour. | +| vDirection | VerticalDirection | M | 1 | Vertical Direction: upwards or downwards. | +| hUncertainty | SpeedUncertainty | M | 1 | Uncertainty of horizontal speed in kilometres per hour. | +| vUncertainty | SpeedUncertainty | M | 1 | Uncertainty of vertical speed in kilometres per hour. | + +6.1.6.2.22 Type: UncertaintyEllipse + +**Table 6.1.6.2.22-1: Definition of type UncertaintyEllipse** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------|---|-------------|-----------------------------------------------------------| +| semiMajor | Uncertainty | M | 1 | Indicates the semi-major axis of the uncertainty ellipse. | +| semiMinor | Uncertainty | M | 1 | Indicates the semi-minor axis of the uncertainty ellipse. | +| orientationMajor | Orientation | M | 1 | Indicates the orientation angle of the major axis. | + +6.1.6.2.23 Type: UeLcsCapability + +**Table 6.1.6.2.23-1: Definition of type UeLcsCapability** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| lppSupport | boolean | O | 0..1 | Indicates whether the UE supports LPP or not.

- true (default): LPP supported by the UE
- false: LPP not supported by the UE | +| ciotOptimisation | boolean | O | 0..1 | Indicates whether the UE supports and is allowed to use Control Plane CIoT 5GS Optimisation to send an event report for periodic or triggered location or not. Refer to 3GPP TS 23.273 [19] clause 6.7 for more detail.

- true: Control Plane CIoT 5GS Optimisation is supported by the UE and allowed
- false (default): Control Plane CIoT 5GS Optimisation not supported by the UE or not allowed | + +##### 6.1.6.2.24 Type: PeriodicEventInfo + +Table 6.1.6.2.24-1: Definition of type PeriodicEventInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|---------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| reportingAmount | ReportingAmount | M | 1 | Number of event reports | +| reportingInterval | ReportingInterval | M | 1 | Interval of event reports | +| reportingInfiniteInd | boolean | O | 0..1 |

When present, this IE shall be set to the value true, indicating that as many reports as possible to be generated during allowed duration (8639999 seconds).

When this IE is present in a request, the reportingAmount should be set to the largest possible value (see NOTE) for backward compatibility consideration. An LMF supporting this IE shall ignore the reportingAmount IE and an LMF not supporting this IE will use reportingAmount IE to generate indicated number of reports as legacy.

When this IE is present in a response, it indicates that this IE is supported and accepted by the LMF.

| +| reportingIntervalMs | ReportingIntervalMs | O | 0..1 |

When present, this IE shall indicate the Interval of event reports in milliseconds.

When this IE is present in a request, the reportingInterval is set to 1 for backward compatible consideration. An LMF supporting this IE shall ignore the reportingInterval IE; an LMF not supporting this IE will use reportingInterval IE to generate report with minimal interval as legacy, i.e. 1 second.

When this IE is present in a response, it indicates that this IE is supported by the LMF and it shall indicate the value accepted by the LMF.

| + +NOTE: reportingAmount x reportingInterval shall not exceed 8639999 (99 days, 23 hours, 59 minutes and 59 seconds) for compatibility with OMA MLP and RLP. + +##### 6.1.6.2.25 Type: AreaEventInfo + +Table 6.1.6.2.25-1: Definition of type AreaEventInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|----------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| areaDefinition | array(ReportingArea) | M | 1..250 | One or more reporting areas | +| occurrenceInfo | OccurrenceInfo | O | 0..1 | One time only report indication | +| minimumInterval | MinimumInterval | C | 0..1 | Minimum interval between event reports.
This IE shall not be included if occurrenceInfo is present and set to one time event. | +| maximumInterval | MaximumInterval | C | 0..1 | Maximum interval between event reports.
This IE shall not be included if occurrenceInfo is present and set to one time event. | +| samplingInterval | SamplingInterval | O | 0..1 | Maximum time interval between consecutive evaluations by a UE of a trigger event. | +| reportingDuration | ReportingDuration | O | 0..1 | Maximum duration of event reporting. | +| reportingLocationReq | boolean | C | 0..1 | This IE shall be present and set to true if a location estimate is required for each event report.

When present, it shall be set as follows:
- true: location report is required.

- false: location report is not required. | + +##### 6.1.6.2.26 Type: ReportingArea + +Table 6.1.6.2.26-1: Definition of type ReportingArea + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------------------------------------|-------------------|---|-------------|---------------------------------------------------------------------------------------------------| +| areaType | ReportingAreaType | M | 1 | Type of reporting area. | +| tai | Tai | C | 1 | TAI for EPS or 5GS.
This IE shall be present if the reporting area type is EPS TAI or 5GS TAI. | +| ecgi | Ecgi | C | 1 | ECGI.
This IE shall be present if the reporting area type is ECGI. | +| ncgi | Ncgi | C | 1 | NCGI.
This IE shall be present if the reporting area type is NCGI. | +| NOTE: One of tai, ecgi or ncgi shall be included. | | | | | + +##### 6.1.6.2.27 Type: MotionEventInfo + +Table 6.1.6.2.27-1: Definition of type MotionEventInfo + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-------------------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| linearDistance | LinearDistance | M | 1 | Minimum linear (straight line) distance for motion event reports. | +| occurrenceInfo | OccurrenceInfo | O | 0..1 | One time only report indication | +| minimumInterval | MinimumInterval | C | 0..1 | Minimum interval between event reports.
This IE shall not be included if occurrenceInfo is present and set to one time event. | +| maximumInterval | MaximumInterval | C | 0..1 | Maximum interval between event reports.
This IE shall not be included if occurrenceInfo is present and set to one time event. | +| samplingInterval | SamplingInterval | O | 0..1 | Maximum time interval between consecutive evaluations by a UE of a trigger event. | +| reportingDuration | ReportingDuration | O | 0..1 | Maximum duration of event reporting. | +| reportingLocationReq | boolean | C | 0..1 | This IE shall be present and set to true if a location estimate is required for each event report.

When present, it shall be set as follows:
- true: location report is required.

- false: location report is not required. | + +##### 6.1.6.2.28 Void + +##### 6.1.6.2.29 Type: CancelLocData + +Table 6.1.6.2.29-1: Definition of type CancelLocData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| hGMLCCallbackURI | Uri | M | 1 | Callback URI of the H-GMLC | +| LDRReference | LDRReference | M | 1 | LDR Reference | +| 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.30 Type: LocContextData + +Table 6.1.6.2.30-1: Definition of type LocContextData + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|---------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| amfId | NfInstanceId | M | 1 | Indicates the AMF Instance serving the UE. LMF shall use the AMF Instance to forward LCS related N1/N2 messages to the UE/RAN. | +| locationQoS | LocationQoS | C | 0..1 | This IE shall contain the location QoS if available. | +| supportedGADShapes | array(SupportedGADShapes) | C | 0..N | This IE shall contain the supported GAD shapes if available. | +| supi | Supi | C | 0..1 | This IE shall contain the SUPI if available. | +| gpsi | Gpsi | C | 0..1 | This IE shall contain the GPSI if available. | +| ldrType | LdrType | M | 1 | The type of LDR | +| hgmlcCallbackURI | Uri | M | 1 | Callback URI of the H-GMLC | +| ldrReference | LdrReference | M | 1 | LDR Reference | +| periodicEventInfo | PeriodicEventInfo | C | 0..1 | Information for periodic event reporting | +| areaEventInfo | AreaEventInfo | C | 0..1 | Information for area event reporting | +| motionEventInfo | MotionEventInfo | C | 0..1 | Information for motion event reporting | +| eventReportMessage | EventReportMessage | M | 1 | Contains an embedded event report | +| eventReportingStatus | EventReportingStatus | O | 0..1 | Status of event reporting | +| ueLocationInfo | UELocationInfo | O | 0..1 | Location information for the target UE | +| cloT5GSOptimisation | boolean | C | 0..1 | This IE shall be present if it was received from AMF. When present, it shall be set as follows:
- true: Control Plane CLoT 5GS Optimisation was used and no signalling or data is currently pending for the UE at the AMF.
- false (default): Control Plane CLoT 5GS Optimisation was not used or signalling or data is currently pending for the UE at the AMF. | +| ecgi | Ecgi | C | 0..1 | When present, this IE shall indicate the identifier of the E-UTRAN cell serving the UE.
This IE shall be present if it was received from AMF. | +| ncgi | Ncgi | C | 0..1 | When present, this IE shall indicate the identifier of the NR cell serving the UE.
This IE shall be present if it was received from AMF | +| guami | Guami | C | 0..1 | This IE shall be present if it was received from AMF.

When present, it shall contain the GUAMI serving 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. | +| uePositioningCap | UePositioningCapabilities | O | 0..1 | When present, this IE shall indicate the positioning capabilities supported by the UE. | +| scheduledLocTime | DateTime | O | 0..1 | When present, this IE shall contain the scheduled time (in UTC) that the UE needs to be located. | +| indoorOutdoorInd | IndoorOutdoorInd | O | 0..1 | When present, this IE shall indicate whether the UE is indoor or outdoor. | +| losNlosMeasureInd | LosNlosMeasureInd | O | 0..1 | When present, this IE shall indicate whether LOS measurement or NLOS measurement is used. | +| upCumEvtRptCriteria | UpCumEvtRptCriteria | O | 0..1 | When present, this IE shall include the cumulative event report timer or the maximum number of location reporting over user plane or both. | + +NOTE: At least one of periodicEventInfo, areaEventInfo or motionEventInfo shall be present in the LocContextData structure. + +##### 6.1.6.2.31 Type: EventReportMessage + +Table 6.1.6.2.31-1: Definition of type EventReportMessage + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------------|---|-------------|------------------------------------------------------------------------------------------| +| eventClass | EventClass | M | 1 | This IE shall contain the event class for the message content specified in eventContent. | +| eventContent | RefToBinaryData | M | 1 | This IE shall reference the event report binary data corresponding to the eventClass. | + +##### 6.1.6.2.32 Type: EventReportingStatus + +Table 6.1.6.2.32-1: Definition of type EventReportingStatus + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------|---|-------------|--------------------------------------------------------| +| eventReportCounter | EventReportCounter | O | 0..1 | This IE shall contain a count of event reports. | +| eventReportDuration | EventReportDuration | O | 0..1 | This IE shall contain the duration of event reporting. | + +##### 6.1.6.2.33 Type: UELocationInfo + +Table 6.1.6.2.33-1: Definition of type UELocationInfo + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| locationEstimate | GeographicArea | O | 0..1 | Previous location estimate for the target UE. | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | Age of previous 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). | +| velocityEstimate | VelocityEstimate | O | 0..1 | Previous velocity estimate for the target UE. | +| ageOfVelocityEstimate | AgeOfVelocityEstimate | O | 0..1 | Age of previous velocity estimate. | +| timestampOfVelocityEstimate | DateTime | O | 0..1 | When present, this IE shall indicate the estimated UTC time when the velocity estimate corresponded to the UE velocity (i.e. when the velocity estimate and the actual UE velocity was the same). | + +6.1.6.2.34 Type: EventNotifyData + +**Table 6.1.6.2.34-1: Definition of type EventNotifyData** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|-----------------------------|--------------------------------------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------| +| reportedEventType | ReportedEventType | M | 1 | This IE shall contain the type of event being reported. | | +| supi | Supi | C | 0..1 | This IE shall contain the SUPI if available. | | +| gpsi | Gpsi | C | 0..1 | This IE shall contain the GPSI if available. | | +| hgnlCallbackURI | Uri | C | 0..1 | Callback URI of the H-GMLC (NOTE 1) | | +| ldrReference | LdrReference | M | 1 | LDR Reference

When the ReportedEventType is "INTERMEDIATE_EVENT", the LMF shall set this IE to the value "NULL" and shall be ignored by the receiver. | | +| lirReference | LirReference | C | 0..1 | This IE shall be present when the ReportedEventType is set to the value "INTERMEDIATE_EVENT".

When present, this IE shall include the LIR Reference number received in the 5GC-MR-LR multiple location request. | | +| locationEstimate | GeographicArea | O | 0..1 | If present, this IE shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate. | | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | If present, this IE shall contain an indication of how long ago the location estimate was obtained. | | +| 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). | | +| civicAddress | CivicAddress | O | 0..1 | If present, this IE shall contain a civic address. | | +| localLocationEstimate | LocalArea | O | 0..1 | When present, this IE shall indicate a local area in reference system. | | +| 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. | | +| servingLMFIdentification | LMFIdentification | C | 0..1 | This IE shall be included to identify an LMF which acts as a serving LMF if a serving LMF is used. | | +| terminationCause | TerminationCause | C | 0..1 | This IE shall be included if event reporting has been terminated | | +| velocityEstimate | VelocityEstimate | O | 0..1 | If present, this IE shall contain an estimate of the velocity of the target UE, composed by horizontal speed, vertical speed, and their respective uncertainty. | | + +| | | | | | | +|---------------------------|-------------------------|---|------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| altitude | Altitude | O | 0..1 | If present, this IE indicates the altitude of the positioning estimate. When the shape used in "locationEstimate" supports conveying the altitude parameter, this IE shall be absent. | | +| achievedQos | MinorLocationQoS | O | 0..1 | When present, this IE shall contain the achieved Location QoS
Accuracy of the estimated location.

This IE may be present if the required LCS QoS Class in the location request procedure is "MULTIPLE_QOS".

If it's absent, the required LCS QoS Class in the location request procedure is "MULTIPLE_QOS" and AccuracyFulfilmentIndicator is "REQUESTED_ACCURACY_FULFILLED", it indicates that the location QoS in the highest priority is achieved. | MUTIQOS | +| supportedFeatures | SupportedFeatures | C | 0..1 | This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported. | | +| indoorOutdoorInd | IndoorOutdoorInd | O | 0..1 | When present, this IE shall indicate whether the UE is indoor or outdoor. | | +| haGnssMetrics | HighAccuracyGnssMetrics | O | 0..1 | When present, this IE shall indicate the high accuracy GNSS metrics received from the device in the LPP HA-GNSS-Metrics-r17 IE as specified in 3GPP TS 37.355 [21]. | | +| losNlosMeasurement | LosNlosMeasurement | O | 0..1 | When present, this IE shall indicate whether LOS measurement or NLOS measurement is used. | | +| 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 | | +| 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 | +| NOTE 1: If the reportedEventType is not "INTERMEDIATE_EVENT", the hgmlcCallBackURI shall be included when the consumer NF is not the H-GMLC. | | | | | | + +6.1.6.2.35 Type: UeConnectivityState + +**Table 6.1.6.2.35-1: Definition of type UeConnectivityState** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|------------|---|-------------|-----------------------------------------------------------------------------------------| +| accessType | AccessType | M | 1 | Shall indicate the access type of the UE. | +| connectivitystate | CmState | O | 0..1 | When present, it shall indicate the UE connectivity state in the indicated access type. | + +6.1.6.2.36 Type: LocalOrigin + +**Table 6.1.6.2.36-1: Definition of type LocalOrigin** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-------------------------|---|-------------|-------------------------------------------------------------------------------| +| coordinateId | string | M | 1 | This IE defines a known reference point which configured by the PLMN operator | +| point | GeographicalCoordinates | O | 0..1 | Indicates a geographic point represented by its longitude and latitude. | + +6.1.6.2.37 Type: RelativeCartesianLocation + +**Table 6.1.6.2.37-1: Definition of type RelativeCartesianLocation** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| x | Float | M | 1 | Indicates the value (in the unit of meters) on x-axis of the relative location in the cartesian system.

Positive value represents easting from reference point (origin). | +| y | Float | M | 1 | Indicates the value (in the unit of meters) on y-axis of the relative location in the cartesian system.

Positive value represents northing from reference point (origin). | +| z | Float | O | 0..1 | Indicates the value (in the unit of meters) on z-axis of the relative location in the cartesian system for a 3D-Point.

Positive value represents height above reference point (origin). | + +6.1.6.2.38 Type: Local2dPointUncertaintyEllipse + +**Table 6.1.6.2.38-1: Definition of type Local2dPointUncertaintyEllipse** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|---------------------------|---|-------------|--------------------------------------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE". | +| localOrigin | LocalOrigin | M | 1 | Indicates the local origin in the local Cartesian co-ordinates system configured by the PLMN operator. | +| point | RelativeCartesianLocation | M | 1 | Indicates a 2D-point (specified by "x" and "y" coordinates) relative to origin in reference system. | +| uncertaintyEllipse | UncertaintyEllipse | M | 1 | Indicates an uncertainty ellipse. | +| confidence | Confidence | M | 1 | Indicates the value of confidence. | + +6.1.6.2.39 Type: Local3dPointUncertaintyEllipsoid + +**Table 6.1.6.2.39-1: Definition of type Local3dPointUncertaintyEllipsoid** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|---------------------------|---|-------------|----------------------------------------------------------------------------------------------------------| +| shape | SupportedGADShapes | M | 1 | It shall take the value "LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID". | +| localOrigin | LocalOrigin | M | 1 | Indicates the local origin in the local Cartesian co-ordinates system configured by the PLMN operator. | +| point | RelativeCartesianLocation | M | 1 | Indicates a 3D-point (specified by "x", "y" and "z" coordinates) relative to origin in reference system. | +| uncertaintyEllipsoid | UncertaintyEllipsoid | M | 1 | Indicates the uncertainty ellipsoid | +| confidence | Confidence | M | 1 | Indicates the value of confidence. | + +6.1.6.2.40 Type: UncertaintyEllipsoid + +**Table 6.1.6.2.40-1: Definition of type UncertaintyEllipsoid** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|-------------|---|-------------|-------------------------------------------------------------| +| semiMajor | Uncertainty | M | 1 | Indicates the semi-major axis of the uncertainty ellipsoid. | +| semiMinor | Uncertainty | M | 1 | Indicates the semi-minor axis of the uncertainty ellipsoid. | +| vertical | Uncertainty | M | 1 | Indicates the vertical axis of the uncertainty ellipsoid. | +| orientationMajor | Orientation | M | 1 | Indicates the orientation angle of the major axis. | + +##### 6.1.6.2.41 Type: LocalArea + +Table 6.1.6.2.41-1: Definition of type LocalArea as a list of mutually exclusive alternatives + +| Data type | Cardinality | Discriminator property name | Discriminator mapping | Description | +|----------------------------------|-------------|-----------------------------|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Local2dPointUncertaintyEllipse | 1 | shape | LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE | Local area consisting of a point described in 2D local coordinates relative to an origin in a reference system, plus an uncertainty ellipse and a confidence value. | +| Local3dPointUncertaintyEllipsoid | 1 | shape | LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID | Local area consisting of a point described in 3D local coordinates relative to an origin in a reference system, 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"). | + +##### 6.1.6.2.42 Type: UeAreaIndication + +Table 6.1.6.2.42-1: Definition of type UeAreaIndication + +| Attribute name | Data type | P | Cardinality | Description | +|----------------------|-----------|---|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| country | string | C | 0..1 | This IE shall be present if the country or the area of country where the UE is located is determined. When present, this IE contains two-letter ISO 3166 country code in capital ASCII letters, e.g., DE or US IETF RFC 4776 [6] | +| internationalAreaInd | boolean | C | 0..1 | Indicates international area

When present, it shall be set as follows:
- true: UE is located in international area.

- false (default): UE is not located in international area. | + +NOTE: Either country or internationalAreaInd shall be present. + +##### 6.1.6.2.43 Type: MinorLocationQoS + +Table 6.1.6.2.43-1: Definition of type MinorLocationQoS + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|---------------------| +| hAccuracy | Accuracy | O | 0..1 | Horizontal accuracy | +| vAccuracy | Accuracy | O | 0..1 | Vertical accuracy | + +##### 6.1.6.2.44 Type: MbsrInfo + +Table 6.1.6.2.44-1: Definition of type MbsrInfo + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|----------------------|---------------| +| ecgi | Ecgi | O | 0..1 | E-UTRA Cell Identity | | +| ncgi | Ncgi | O | 0..1 | NR Cell Identity | | + +6.1.6.2.45 Type: LocMeasurementReq + +**Table 6.1.6.2.45-1: Definition of type LocMeasurementReq** + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------|----------------|---|-------------|---------------------------------------------------------------------| +| ecgi | Ecgi | O | 0..1 | E-UTRA Cell Identity (NOTE) | +| ncgi | Ncgi | O | 0..1 | NR Cell Identity (NOTE) | +| preCalcuLocEstimate | GeographicArea | O | 0..1 | Pre-calculated location estimate of target UE | +| timestampOfPreCalcULocEstimate | DateTime | O | 0..1 | Timestamp (in UTC) of pre-calculated location estimate of target UE | +| NOTE: Either the "ecgi" attribute or the "ncgi" attribute shall be included. | | | | | + +6.1.6.2.46 Type: LocMeasurementResp + +**Table 6.1.6.2.46-1: Definition of type LocMeasurementResp** + +| Attribute name | Data type | P | Cardinality | Description | +|-----------------------------|-----------------------|---|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| locMeasurements | LocMeasurements | M | 1 | PRU Location Measurements | +| locationEstimate | GeographicArea | M | 1 | For a request for triggered location where location estimates are not required, the location estimate can be based on current serving cell. | +| ageOfLocationEstimate | AgeOfLocationEstimate | O | 0..1 | When present, this IE shall indicate age of the 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). | +| velocityEstimate | VelocityEstimate | O | 0..1 | When present, this IE shall indicate velocity estimate. | +| localLocationEstimate | LocalArea | O | 0..1 | When present, this IE shall indicate a local area in reference system. | + +6.1.6.2.47 Type: LocMeasurements + +**Table 6.1.6.2.47-1: Definition of type LocMeasurements** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|-----------|---|-------------|-----------------------------------------------------------------------------| +| rstd | Integer | O | 0..1 | Reference Signal Time Difference (RSTD), as specified in 3GPP TS 38.305 [3] | + +Editor's note: The details of LocMeasurements are based on Stage2's details and referred to TS 23.273 and TS 38.305. + +6.1.6.2.48 Type: HighAccuracyGnssMetrics + +**Table 6.1.6.2.48-1: Definition of type HighAccuracyGnssMetrics** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|-----------|---|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nrOfUsedSatellites | integer | M | 1 | Indicates the number of satellites used for the high accuracy GNSS positioning method.
Minimum: 0. Maximum: 64. | +| hdopi | Integer | O | 0..1 | When present, this IE shall indicate the horizontal dilution of precision for the location estimate, scale factor 0.1.
Minimum: 1. Maximum: 256. | +| pdopi | integer | O | 0..1 | When present, this IE shall indicate the 3D position dilution of precision, scale factor 0.1.
Minimum: 1. Maximum: 256. | +| age | integer | O | 0..1 | When present, this IE shall indicate the age of the most recent used assistance data for high accuracy GNSS, scale factor 0.1 second.
Minimum: 0. Maximum: 99. | +| fixType | FixType | O | 0..1 | When present, this IE shall indicate the the positioning fix type. | + +6.1.6.2.49 Type: UpNotifyData + +**Table 6.1.6.2.49-1: Definition of type UpNotifyData** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------------|--------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| ldrReference | LdrReference | M | 1 | LDR Reference | +| upConnectionStatus | UpConnectionStatus | M | 1 | UP Connection Status | +| targetLMFIdentification | LMFIdentification | O | 0..1 | This IE shall be present if the UpConnectionStatus is set to "MOVE".
When present, this IE shall indicate Target LMF ID. | + +6.1.6.2.50 Type: UpSubscription + +**Table 6.1.6.2.50-1: Definition of type UpSubscription** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|-----------|---|-------------|-----------------------------------------| +| upNotifyCallBackURL | Uri | M | 1 | Callback URI of the NF Service Consumer | +| supi | Supi | M | 1 | SUPI | +| gpsi | Gpsi | O | 0..1 | GPSI | + +6.1.6.2.51 Type: RelatedUE + +**Table 6.1.6.2.51-1: Definition of type RelatedUE** + +| Attribute name | Data type | P | Cardinality | Description | +|--------------------|--------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| applicationlayerId | ApplicationlayerId | M | 1 | The application layer identification of the UE | +| relatedUETYPE | RelatedUETYPE | M | 1 | The type of the related UE for ranging and sidelink positioning, such as located UE, reference UE, etc. | + +##### 6.1.6.2.52 Type: UpConfig + +Table 6.1.6.2.52-1: Definition of type UpConfig + +| Attribute name | Data type | P | Cardinality | Description | +|------------------------------------------------------------------------------------|--------------------|---|-------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| upNotifyCallBackURI | Uri | M | 1 | Callback URI of the NF Service Consumer | +| supi | Supi | O | 0..1 | SUPI (NOTE) | +| gpsi | Gpsi | O | 0..1 | GPSI (NOTE) | +| amfReallocationInd | boolean | O | 0..1 | Indicates AMF reallocation indication.

When present, it shall be set as follows:
- true: AMF reallocated.

- false (default): AMF not reallocated. | +| lcsUpConnectionInd | LcsUpConnectionInd | O | 0..1 | LCS-UP connection indication | +| targetLMFIdentification | LMFIdentification | O | 0..1 | Target LMF ID | +| NOTE: At least one of the supi or gpsi shall be present in the UpConfig structure. | | | | | + +##### 6.1.6.2.53 Type: RangeDirection + +Table 6.1.6.2.53-1: Definition of type RangeDirection + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|--------------------|-----------|---|-------------|-------------------------------------------------------------|---------------| +| range | number | O | 0..1 | Identifies the distance from point A to point B. | | +| azimuthDirection | Angle | O | 0..1 | Identifies the azimuth direction from point A to point B. | | +| elevationDirection | Angle | O | 0..1 | Identifies the elevation direction from point A to point B. | | + +##### 6.1.6.2.54 Type: 2DRelativeLocation + +Table 6.1.6.2.54-1: Definition of type 2DRelativeLocation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|------------------|-------------|---|-------------|-----------------------------------------------------------|---------------| +| semiMinor | Uncertainty | M | 1 | Indicates the semi-major axis of the uncertainty ellipse. | | +| semiMajor | Uncertainty | M | 1 | Indicates the semi-minor axis of the uncertainty ellipse. | | +| orientationAngle | Angle | M | 1 | Identifies the angle of orientation A. | | + +##### 6.1.6.2.55 Type: 3DRelativeLocation + +Table 6.1.6.2.55-1: Definition of type 3DRelativeLocation + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|-------------|---|-------------|-----------------------------------------------------------|---------------| +| semiMinor | Uncertainty | M | 1 | Indicates the semi-major axis of the uncertainty ellipse. | | +| semiMajor | Uncertainty | M | 1 | Indicates the semi-minor axis of the uncertainty ellipse. | | +| verticalUncertainty | Uncertainty | M | 1 | Indicates the vertical uncertainty. | | +| orientationAngle | Angle | M | 1 | Identifies the angle of orientation A. | | + +6.1.6.2.56 Type: AddLocationDatas + +**Table 6.1.6.2.56-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.6.2.57 Type: AddEventNotifyDatas + +**Table 6.1.6.2.57-1: Definition of type AddEventNotifyDatas** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|---------------------|---------------------|---|-------------|---------------------------------------|---------------| +| addEventNotifyDatas | array(LocationData) | O | 1..N | Contains one or more EventNotifyData. | | + +6.1.6.2.58 Type: LocationDataExt + +**Table 6.1.6.2.58-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.6.2.59 Type: EventNotifyDataExt + +**Table 6.1.6.2.59-1: Definition of type EventNotifyDataExt as a list of data types to be combined** + +| Data type | Cardinality | Description | Applicability | +|---------------------|-------------|----------------------------------------|---------------| +| EventNotifyData | 1 | Positioning event notify | | +| AddEventNotifyDatas | 1 | Additional positioning event(s) notify | | + +6.1.6.2.60 Type: MappedLocationQoSEps + +**Table 6.1.6.2.60-1: Definition of type MappedLocationQoSEps** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------|---------------| +| hAccuracy | Accuracy | M | 1 | Mapped Horizontal accuracy for EPS | | +| vAccuracy | Accuracy | O | 0..1 | Mapped Vertical accuracy for EPS | | + +6.1.6.2.61 Type: AdditionalUeInfo + +**Table 6.1.6.2.61-1: Definition of type AdditionalUeInfo** + +| Attribute name | Data type | P | Cardinality | Description | Applicability | +|----------------|-----------|---|-------------|------------------------------------------------|---------------| +| ecgi | Ecgi | O | 0..1 | E-UTRA Cell Identity of MBSR UE (i.e., IAB UE) | | +| ncgi | Ncgi | O | 0..1 | NR Cell Identity of MBSR UE (i.e., IAB UE) | | + +#### 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 | +|-----------------------|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Altitude | number | Double-precision float value of the altitude, expressed in meters.
Minimum: -32767. Maximum: 32767.
Format: double. | +| Angle | integer | Integer value of the angle, expressed in degrees.
Minimum: 0. Maximum: 360. | +| Uncertainty | number | Float value of uncertainty, expressed in meters.
Minimum: 0
Format: float. | +| Orientation | integer | Integer value of the orientation angle, expressed in degrees.
Minimum: 0. Maximum: 180. | +| Confidence | integer | Integer value of the confidence, expressed in percentage value.
Minimum: 0. Maximum: 100. | +| Accuracy | number | Float value of accuracy, expressed in meters.
Minimum: 0
Format: float. | +| InnerRadius | integer | Integer value of the inner radius, expressed in meters.
Minimum: 0. Maximum: 327675.
Format: int32. | +| CorrelationID | string | LCS Correlation ID. The correlation ID shall be of a minimum length of 1 character and maximum length of 255 characters. | +| AgeOfLocationEstimate | integer | Integer value of the age of the location estimate, expressed in minutes.
Minimum: 0. Maximum: 32767. | +| HorizontalSpeed | number | Float value of horizontal speed, expressed in kilometres per hour.
Minimum: 0. Maximum: 2047.
Format: float. | +| VerticalSpeed | number | Float value of horizontal speed, expressed in kilometres per hour.
Minimum: 0. Maximum: 255.
Format: float. | +| SpeedUncertainty | number | Float value of speed uncertainty, expressed in kilometres per hour.
Minimum: 0. Maximum: 255.
Format: float. | +| BarometricPressure | integer | This IE specifies the measured uncompensated atmospheric pressure in units of Pascal (Pa).
Minimum: 30000. Maximum: 115000. | +| LcsServiceType | integer | The LCS service type as defined in 3GPP TS 22.071 [17] and clause 17.7.8 of 3GPP TS 29.002 [18].
Minimum: 0. Maximum: 127. | +| LdrReference | string | LDR Reference encoded as a string of hexadecimal characters. The LdrReference shall be of a minimum length of 2 characters and maximum length of 510 characters. | +| LirReference | string | LIR Reference encoded as a string of hexadecimal characters. The LdrReference shall be of a minimum length of 2 characters and maximum length of 510 characters. | +| ReportingAmount | integer | Number of required periodic event reports.
Minimum: 1. Maximum: 8639999. | + +| | | | +|---------------------------|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ReportingInterval | integer | Event reporting periodic interval in seconds.
Minimum: 1. Maximum: 8639999.
ReportingInterval x ReportingAmount shall not exceed 8639999. | +| ReportingIntervalMs | integer | Event reporting periodic interval in milliseconds.
Minimum: 1. Maximum: 999. | +| MinimumInterval | integer | Minimum interval between event reports in seconds.
Minimum: 1. Maximum: 32767. | +| MaximumInterval | integer | Maximum interval between event reports in seconds.
Minimum: 1. Maximum: 86400. | +| SamplingInterval | integer | Maximum time interval between consecutive evaluations by a UE of a trigger event, in seconds.
Minimum: 1. Maximum: 3600 | +| ReportingDuration | integer | Maximum duration of event reporting, in seconds.
Minimum: 1. Maximum: 8640000. | +| LinearDistance | integer | The minimum straight line distance moved by a UE to trigger a motion event report, in meters.
Minimum: 1. Maximum: 10000. | +| LMFIdentification | string | The serving LMF identification as defined in 3GPP TS 23.273 [19], encoded as a string of hexadecimal characters. | +| EventReportCounter | integer | Number of event reports received from the target UE.
Minimum: 1. Maximum: 8640000.
Note: the current event report is included in the count. | +| EventReportDuration | integer | Duration of event reporting, in seconds.
Minimum: 0. Maximum: 8640000.
Note: the duration starts when event reporting is activated in the UE and extends to the current time. | +| UePositioningCapabilities | Bytes | Positioning capabilities supported by the UE.

String with format "byte" as defined in OpenAPI Initiative [14], i.e. base64-encoded characters, encoding the "ProvideCapabilities-r9-IEs" IE as specified in clause 6.3 of 3GPP TS 37.355 [21] (start from octet 1). | + +##### 6.1.6.3.3 Enumeration: ExternalClientType + +The enumeration ExternalClientType represents the different types of clients of the location service. + +**Table 6.1.6.3.3-1: Enumeration ExternalClientType** + +| Enumeration value | Description | +|-------------------------------------------|-------------------------------------------------------------| +| "EMERGENCY_SERVICES" | External client for emergency services | +| "VALUE_ADDED_SERVICES" | External client for value added services | +| "PLMN_OPERATOR_SERVICES" | External client for PLMN operator services | +| "LAWFUL_INTERCEPT_SERVICES" | External client for Lawful Intercept services | +| "PLMN_OPERATOR_BROADCAST_SERVICES" | External client for PLMN Operator Broadcast services | +| "PLMN_OPERATOR_OM" | External client for PLMN Operator O&M | +| "PLMN_OPERATOR_ANONYMOUS_STATISTICS" | External client for PLMN Operator anonymous statistics | +| "PLMN_OPERATOR_TARGET_MS_SERVICE_SUPPORT" | External client for PLMN Operator target MS service support | + +##### 6.1.6.3.4 Enumeration: SupportedGADShapes + +The enumeration SupportedGADShapes represents the different types, or shapes, of geographic areas supported by the system. + +**Table 6.1.6.3.4-1: Enumeration SupportedGADShapes** + +| Enumeration value | Description | +|----------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "POINT" | Ellipsoid Point | +| "POINT_UNCERTAINTY_CIRCLE" | Ellipsoid point with uncertainty circle | +| "POINT_UNCERTAINTY_ELLIPSE" | Ellipsoid point with uncertainty ellipse | +| "POLYGON" | Polygon | +| "POINT_ALTITUDE" | Ellipsoid point with altitude | +| "POINT_ALTITUDE_UNCERTAINTY" | Ellipsoid point with altitude and uncertainty ellipsoid | +| "ELLIPSOID_ARC" | Ellipsoid Arc | +| "LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE" | Local 2D point with uncertainty ellipse | +| "LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID" | Local 3D point with uncertainty ellipsoid | +| "RANGE_DIRECTION" | 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 | +| "RELATIVE_2D_LOCATION_UNCERTAINTY_ELLIPSE" | 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. | +| "RELATIVE_3D_LOCATION_UNCERTAINTY_ELLIPSOID" | 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"). | + +##### 6.1.6.3.5 Enumeration: ResponseTime + +The enumeration ResponseTime represents the acceptable delay in the determination of the location of the UE. + +**Table 6.1.6.3.5-1: Enumeration ResponseTime** + +| Enumeration value | Description | +|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------| +| "LOW_DELAY" | Location request is expected with low delay level. | +| "DELAY_TOLERANT" | Location request is delay tolerant. | +| "NO_DELAY " | Location request is expected with no delay (NOTE) | +| NOTE: The value is only used in the interface between GMLC and AF/LCS client via NEF, not further delivered to other NFs in the network. After receiving the enumeration value, the GMLC shall immediately return any location estimate, local location or civic location that it currently has. The GMLC shall return either the Initial or Last Known Location of the Target UE. If no location estimate or Dispatchable Location is available, the GLMC shall return the failure indication and may optionally initiate procedures to obtain a location estimate or Dispatchable Location (e.g. to be available for a later request). | | + +##### 6.1.6.3.6 Enumeration: PositioningMethod + +The enumeration PositioningMethod represents the method used to determine the location of the UE. + +**Table 6.1.6.3.6-1: Enumeration PositioningMethod** + +| Enumeration value | Description | +|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| "CELLID" | Cell ID positioning method | +| "ECID" | Enhanced cell ID methods based on LTE signals | +| "OTDOA" | Observed time difference of arrival positioning based on LTE signals | +| "BAROMETRIC_PRESSURE" | Positioning method based on barometric Pressure Sensor | +| "WLAN" | WLAN positioning | +| "BLUETOOTH" | Bluetooth positioning | +| "MBS" | Terrestrial Beacon System (TBS) positioning based on MBS signals | +| "MOTION_SENSOR" | Positioning method based on motion Sensor | +| "DL_TDOA" | Downlink Time Difference of Arrival (DL-TDOA) based on NR signals | +| "DL_AOD" | Downlink Angle-of-Departure (DL-AoD) based on NR signals | +| "MULTI-RTT" | Multi-Round Trip Time Positioning (Multi-RTT based on NR signals). | +| "NR_ECID" | NR enhanced cell ID methods (NR E-CID) based on NR signals. | +| "UL_TDOA" | Uplink Time Difference of Arrival (UL-TDOA) based on NR signals | +| "UL_AOA" | Uplink Angle of Arrival (UL-AoA), including the Azimuth of Arrival (A-AoA) and the Zenith of Arrival (Z-AoA) based on NR signals. | +| "NETWORK_SPECIFIC" | Network specific position methods. | + +##### 6.1.6.3.7 Enumeration: PositioningMode + +The enumeration PositioningMode represents the mode used to determine the location of the UE when a certain positioning method is used. + +**Table 6.1.6.3.7-1: Enumeration PositioningMode** + +| Enumeration value | Description | +|-------------------|-------------------| +| "UE_BASED" | UE-based mode | +| "UE_ASSISTED" | UE-assisted mode | +| "CONVENTIONAL" | Conventional mode | + +##### 6.1.6.3.8 Enumeration: GnssId + +The enumeration GnssId represents the different GNSS systems. + +**Table 6.1.6.3.8-1: Enumeration GnssId** + +| Enumeration value | Description | +|-------------------|--------------------------------------| +| "GPS" | GPS | +| "GALILEO" | Galileo | +| "SBAS" | Space Based Augmentation Systems | +| "MODERNIZED_GPS" | Modernized GPS | +| "QZSS" | Quasi Zenith Satellite System | +| "GLONASS" | Global Navigation Satellite System | +| "BDS" | BeiDou Navigation Satellite System | +| "NAVIC" | Navigation with Indian Constellation | + +##### 6.1.6.3.9 Enumeration: Usage + +The enumeration Usage represents the type of usage made of the location measurement from the UE. + +**Table 6.1.6.3.9-1: Enumeration Usage** + +| Enumeration value | Description | +|---------------------------------------------|----------------------------------------------------------| +| "UNSUCCESS" | Not successful | +| "SUCCESS_RESULTS_NOT_USED" | Successful result not used | +| "SUCCESS_RESULTS_USED_TO_VERIFY_LOCATION" | Successful result used to verify the location estimate | +| "SUCCESS_RESULTS_USED_TO_GENERATE_LOCATION" | Successful result used to generate the location estimate | +| "SUCCESS_METHOD_NOT_DETERMINED" | Successful method not determined | + +##### 6.1.6.3.10 Enumeration: LcsPriority + +The enumeration LcsPriority represents the priority of the LCS client. + +**Table 6.1.6.3.10-1: Enumeration LcsPriority** + +| Enumeration value | Description | +|--------------------|----------------------------------| +| "HIGHEST_PRIORITY" | LCS client with highest priority | +| "NORMAL_PRIORITY" | LCS client with normal priority | + +##### 6.1.6.3.11 Enumeration: VelocityRequested + +The enumeration VelocityRequested represents the indication of velocity requirement. + +**Table 6.1.6.3.11-1: Enumeration VelocityRequested** + +| Enumeration value | Description | +|-----------------------------|-----------------------------------| +| "VELOCITY IS NOT REQUESTED" | velocity estimate is required | +| "VELOCITY IS REQUESTED" | velocity estimate is not required | + +##### 6.1.6.3.12 Enumeration: AccuracyFulfilmentIndicator + +The enumeration AccuracyFulfilmentIndicator represents whether the requested accuracy was fulfilled or not. + +**Table 6.1.6.3.12-1: Enumeration AccuracyFulfilmentIndicator** + +| Enumeration value | Description | +|------------------------------------|-------------------------------------| +| "REQUESTED_ACCURACY_FULFILLED" | requested accuracy is fulfilled | +| "REQUESTED_ACCURACY_NOT_FULFILLED" | requested accuracy is not fulfilled | + +##### 6.1.6.3.13 Enumeration: VerticalDirection + +The enumeration VerticalDirection represents the direction (upward/downward) of the vertical speed. + +**Table 6.1.6.3.13-1: Enumeration VerticalDirection** + +| Enumeration value | Description | +|-------------------|----------------------------| +| "UPWARD" | Vertical speed is upward | +| "DOWNWARD" | Vertical speed is downward | + +##### 6.1.6.3.14 Enumeration: LdrType + +**Table 6.1.6.3.14-1: Enumeration LdrType** + +| Enumeration value | Description | +|----------------------|-------------------------| +| "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 | + +##### 6.1.6.3.15 Enumeration: ReportingAreaType + +The enumeration ReportingAreaType indicates the type of a reporting area. + +**Table 6.1.6.3.15-1: Enumeration ReportingAreaType** + +| Enumeration value | Description | +|--------------------------------------|-------------| +| "EPS_TRACKING_AREA_IDENTITY" | EPS TAI | +| "E-UTRAN_CELL_GLOBAL_IDENTIFICATION" | ECGI | +| "5GS_TRACKING_AREA_IDENTITY" | 5GS TAI | +| "NR_CELL_GLOBAL_IDENTITY" | NCGI | + +##### 6.1.6.3.16 Enumeration: OccurrenceInfo + +The enumeration OccurrenceInfo indicates whether event reporting is one time. + +**Table 6.1.6.3.16-1: Enumeration AreaType** + +| Enumeration value | Description | +|-----------------------|-------------------------------------| +| "ONE_TIME_EVENT" | Event to be reported one-time only | +| "MULTIPLE_TIME_EVENT" | Event to be reported multiple times | + +##### 6.1.6.3.17 Enumeration: ReportingAccessType + +The enumeration ReportingAccessType indicates an allowed access type for event reporting. + +**Table 6.1.6.3.17-1: Enumeration ReportingAccessType** + +| Enumeration value | Description | +|-----------------------------|----------------------------------| +| "NR" | NG Radio access | +| "EUTRA_CONNECTED_TO_5GC" | E-UTRAN access connected to 5GC | +| "NON_3GPP_CONNECTED_TO_5GC" | Non-3GPP access connected to 5GC | +| "NR_LEO" | NR (LEO) satellite access | +| "NR_MEO" | NR (MEO) satellite access | +| "NR_GEO" | NR (GEO) satellite access | +| "NR_OTHER_SAT" | NR (OTHERSAT) satellite access | +| "EUTRA_CONNECTED_TO_EPC" | E-UTRAN access connected to EPC | + +##### 6.1.6.3.18 Enumeration: EventClass + +**Table 6.1.6.3.18-1: Enumeration EventClass** + +| Enumeration value | Description | +|--------------------------|-----------------------------------------------------------------------------------------------------------------------------| +| "SUPPLEMENTARY_SERVICES" | A supplementary services message containing an argument for an lcs-EventReport operation as defined in 3GPP TS 24.080 [20]. | + +##### 6.1.6.3.19 Enumeration: ReportedEventType + +**Table 6.1.6.3.19-1: Enumeration ReportedEventType** + +| Enumeration value | Description | +|-------------------------------------|------------------------------------------------| +| "PERIODIC_EVENT" | Periodic reporting event | +| "ENTERING_AREA_EVENT" | Entering area reporting event | +| "LEAVING_AREA_EVENT" | Leaving area reporting event | +| "BEING_INSIDE_AREA_EVENT" | Being inside area reporting event | +| "MOTION_EVENT" | Motion reporting event | +| "MAXIMUM_INTERVAL_EXPIRATION_EVENT" | Expiration of maximum reporting interval event | +| "LOCATION_CANCELLATION_EVENT" | Cancellation of location reporting event | +| "INTERMEDIATE_EVENT" | Intermediate location reporting event | +| "DIRECT_REPORT_EVENT" | Direct location reporting event | +| "CUMULATIVE_EVENT_REPORT" | Cumulative event report for events reported | + +##### 6.1.6.3.20 Enumeration: TerminationCause + +Table 6.1.6.3.20-1: Enumeration TerminationCause + +| Enumeration value | Description | +|--------------------------|---------------------------------------| +| "TERMINATION BY_UE" | Event reporting terminated by UE | +| "TERMINATION BY_NETWORK" | Event reporting terminated by Network | +| "NORMAL_TERMINATION" | Normal Termination | + +###### 6.1.6.3.21 Enumeration: LcsQosClass + +Table 6.1.6.3.21-1: Enumeration LcsQosClass + +| Enumeration value | Description | +|-------------------|--------------------| +| "BEST_EFFORT" | Best Effort Class | +| "ASSURED" | Assured Class | +| "MULTIPLE_QOS" | Multiple QoS Class | + +MUTIQOS + +## 6.1.6.3.22 Enumeration: UeLocationServiceInd + +Table 6.1.6.3.22-1: Enumeration UeLocationServiceInd + +| Enumeration value | Description | +|----------------------------|----------------------------------| +| "LOCATION_ESTIMATE" | Request location estimate | +| "LOCATION_ASSISTANCE_DATA" | Request location assistance data | + +## 6.1.6.3.23 Enumeration: IndoorOutdoorInd + +Table 6.1.6.3.23-1: Enumeration IndoorOutdoorInd + +| Enumeration value | Description | +|-------------------|-------------| +| "INDOOR" | UE indoor. | +| "OUTDOOR" | UE outdoor. | + +## 6.1.6.3.24 Enumeration: FixType + +Table 6.1.6.3.24-1: Enumeration FixType + +| Enumeration value | Description | +|-----------------------|--------------------------------------------------------------| +| "CARRIER_PHASE_FLOAT" | Converging carrier phase floating point ambiguity resolution | +| "CARRIER_PHASE_FIX" | Converged carrier phase integer ambiguity resolution | + +## 6.1.6.3.25 Enumeration: LosNlosMeasureInd + +Table 6.1.6.3.25-1: Enumeration LosNlosMeasureInd + +| Enumeration value | Description | +|-------------------|-------------------| +| "LOS" | LOS measurement. | +| "NLOS" | NLOS measurement. | + +## 6.1.6.3.26 Enumeration: UpConnectionStatus + +The enumeration UpConnectionStatus indicates the UP Connection Status. + +**Table 6.1.6.3.26-1: Enumeration UpConnectionStatus** + +| Enumeration value | Description | +|-------------------|-------------------------------| +| "ESTABLISHED" | UP Connection Established | +| "RELEASED" | UP Connection Released | +| "MOVE" | UP Connection Move Indication | + +#### 6.1.6.3.27 Enumeration: RangingSIResult + +The enumeration RangingSIResult represents the type of result requested for ranging and sidelink positioning. + +**Table 6.1.6.3.27-1: Enumeration RangingSIResult** + +| Enumeration value | Description | +|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| "ABSOLUTE_LOCATION" | This value indicates that the absolute location of the target UE is required. | +| "RELATIVE_LOCATION" | This value indicates that the position of the target UE relative to other UEs is required. | +| "RANGING_DIRECTION" | This value indicates that the distance between two UEs or more UEs and the direction of one UE (i.e. Target UE) from another UE (i.e. Reference UE) is required. | +| "RANGING" | This value indicates that the distance between two UEs or more UEs is required. | +| "DIRECTION" | This value indicates that the direction of one UE (i.e. Target UE) from another UE (i.e. Reference UE) is required. | +| "VELOCITY" | This value indicates that the velocities of the target UE is required. | +| "RELATIVE_VELOCITY" | This value indicates that the velocities of the target UE relative to other UEs is required. | + +#### 6.1.6.3.28 Enumeration: RelatedUEType + +The enumeration RelatedUEType represents the different roles of UE for ranging and sidelink positioning service. + +**Table 6.1.6.3.28-1: Enumeration RelatedUEType** + +| Enumeration value | Description | +|-------------------|---------------------------------------------------------------------| +| "LOCATED_UE" | UE as located UE for the ranging and sidelink positioning service | +| "REFERENCE_UE" | UE as reference UE for the ranging and sidelink positioning service | + +#### 6.1.6.3.29 Enumeration: LcsUpConnectionInd + +The enumeration LcsUpConnectionInd indicates the LCS UP Connection Indication. + +**Table 6.1.6.3.29-1: Enumeration LcsUpConnectionInd** + +| Enumeration value | Description | +|-------------------|---------------------------------------------| +| "TERMINATION" | LCS-UP connection termination indication | +| "SETUP" | LCS-UP connection set up request indication | + +#### 6.1.6.3.30 Enumeration: UeUpPositioningCapabilities + +The enumeration UeUpPositioningCapabilities represents the user plane positioning capabilities supported by the UE. + +**Table 6.1.6.3.30-1: UeUpPositioningCapabilities** + +| Enumeration value | Description | +|-------------------|--------------------------------------------------------------------| +| "LCS-UPP" | Indicates the capability to support LCS-UPP user plane positioning | +| "SUPL" | Indicates the capability to support SUPL user plane positioning | + +### 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). + +#### 6.1.6.4.2 LPP Message + +LPP Message shall encode a LPP message as specified in 3GPP TS 37.355 [21], using the vnd.3gpp.lpp content-type. + +## 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 application errors defined for the Nlmf\_Location service are listed in Table 6.1.7.3-1. + +**Table 6.1.7.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 | A request for periodic or triggered location is not supported by the UE. | +| PAGING_NOT_ALLOWED | 403 Forbidden | The UE cannot be paged during the UE Unaware Positioning procedure. | +| LOCATION_SESSION_UNKNOWN | 403 Forbidden | The location context was not found. | +| LOCATION_TRANSFER_NOT_SUPPORTED | 403 Forbidden | Transfer of a location context is not supported | +| INSUFFICIENT_RESOURCES | 403 Forbidden | Insufficient resources for location context transfer | +| EVENT_REPORT_UNRECOGNIZED | 403 Forbidden | The event report is unrecognizable or cannot be parsed. | +| LOCATION_MEASUREMENT_UNKNOWN | 403 Forbidden | The location measurements were not found. | +| 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. | + +## 6.1.8 Security + +As indicated in 3GPP TS 33.501 [9], the access to the Nlmf\_Location API may be authorized by means of the OAuth2 protocol (see IETF RFC 6749 [10]), using the "Client Credentials" authorization grant, where the NRF (see 3GPP TS 29.510 [11]) plays the role of the authorization server. + +If OAuth2 authorization is used, an NF Service Consumer, prior to consuming services offered by the Nlmf\_Location API, shall obtain a "token" from the authorization server, by invoking the Access Token Request service, as described in 3GPP TS 29.510 [11], 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 Nlmf\_Location service. + +The Nlmf\_Location API defines the following scopes for OAuth2 authorization as specified in 3GPP TS 33.501 [9]: + +**Table 6.1.8-1: OAuth2 scopes defined in Nlmf\_Location API** + +| Scope | Description | +|---------------------------------------------|---------------------------------------| +| "nlmf-loc" | Access to the Nlmf_Location API. | +| "nlmf-loc:determine-location:invoke" | Access to invoke Determine Location | +| "nlmf-loc:cancel-location:invoke" | Access to invoke Cancel Location | +| "nlmf-loc:location-context-transfer:invoke" | Access to invoke Location Context | +| "nlmf-loc:location-measure:invoke" | Access to invoke Location Measurement | +| "nlmf-loc:up-subscription:invoke" | Access to invoke UP Subscription | +| "nlmf-loc:up-configure:invoke" | Access to invoke UP Config | + +## 6.1.9 Feature Negotiation + +The optional features in table 6.1.9-1 are defined for the Nlmf\_Location 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 Location service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | +| 2 | SAT | O | Satellite Access

Support of this feature implies the LMF shall be able to determine the geographical area identified by a country, area of a country or International area where UE is located for PLMN selection verification. | +| 3 | MUTIQOS | O | Support of Multiple Location QoSes.

This feature bit indicates whether the LMF support that more than one Location QoSes during consuming location service are required. | +| 4 | MBSR | O | Support of Mobile Base Station Relay.

This feature indicates whether the LMF support that location service capability for MBSR. | +| 5 | Ranging_SL | O | 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.10 HTTP redirection + +An HTTP request may be redirected to a different LMF service instance, within the same LMF or a different LMF of an LMF set, e.g. when an LMF service instance is part of an LMF (service) set or when using indirect communications (see 3GPP TS 29.500 [4]). See also the ES3XX feature in clause 6.1.9. + +An SCP that reselects a different LMF producer instance will return the NF Instance ID of the new LMF 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 LMF within an LMF set redirects a service request to a different LMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new LMF 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 Nlmf\_Broadcast Service API + +### 6.2.1 API URI + +The Nlmf\_Broadcast service shall use the Nlmf\_Broadcast API. + +The API URI of the Nlmf\_Broadcast API shall be: + +**{apiRoot}/** + +The request URI 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 "nlmf-broadcast". +- 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 [12], 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 Nlmf\_Location service shall comply with the OpenAPI [14] specification contained in Annex A. + +### 6.2.2.2 HTTP Standard Headers + +#### 6.2.2.2.1 General + +#### 6.2.2.2.2 Content type + +The following content types shall be supported: + +- JSON, as defined in IETF RFC 8259 [13], 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.2.2.3 HTTP custom headers + +#### 6.2.2.3.1 General + +The following HTTP custom headers shall be supported: + +- 3gpp-Sbi-Message-Priority: See 3GPP TS 29.500 [4], clause 5.2.3.2.2. + +This API does not define any new HTTP custom headers. + +## 6.2.3 Resources + +### 6.2.3.1 Overview + +The structure of the Resource URIs of the Nlmf\_Broadcast service is shown in figure 6.2.3.1-1. + +![Diagram showing the Resource URI structure of the Nlmf_Broadcast API. The base URI is {apiRoot}/nlmf-broadcast/. A line branches down from the base URI to a dashed box containing the resource path /cipher-key-data.](ebebcfd45155572c64483e069ed43320_img.jpg) + +``` +graph TD; A["{apiRoot}/nlmf-broadcast/"] --> B["/cipher-key-data"]; +``` + +Diagram showing the Resource URI structure of the Nlmf\_Broadcast API. The base URI is {apiRoot}/nlmf-broadcast/. A line branches down from the base URI to a dashed box containing the resource path /cipher-key-data. + +**Figure 6.2.3.1-1: Resource URI structure of the Nlmf\_Broadcast API** + +## 6.2.4 Custom Operations without associated resources + +### 6.2.4.1 Overview + +The URI structure for Custom Operations without associated resources is included as part of the Figure 6.2.3.1-1 + +**Table 6.2.4.1-1: Custom operations without associated resources** + +| Operation Name | Custom operation URI | Mapped HTTP method | Description | +|-----------------|----------------------|--------------------|--------------------| +| cipher-key-data | /cipher-key-data | POST | Ciphering Key Data | + +### 6.2.4.4 Operation: cipher-key-data + +#### 6.2.4.4.1 Description + +This clause describes the custom operation and what it is used for. + +#### 6.2.4.4.2 Operation Definition + +This operation shall support the request and response data structures and response codes specified in table 6.2.4.4.2-1 and table 6.2.4.4.2-2. + +**Table 6.2.4.4.2-1: Data structures supported by the POST Request Body on this resource** + +| Data type | P | Cardinality | Description | +|-------------------|---|-------------|--------------------------------------------------------| +| CipherRequestData | M | 1 | Input parameters to the "Ciphering Key Data" operation | + +**Table 6.2.4.4.2-2: Data structures supported by the POST Response Body on this resource** + +| Data type | P | Cardinality | Response codes | Description | +|--------------------|---|-------------|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CipherResponseData | M | 1 | 200 OK | This case represents a successful request for ciphering key data.

Upon success, a response body is returned indicating whether the LMF has ciphering key data. The ciphering key data is returned separately in a CipheringKeyData notification. | +| 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 | The "cause" attribute may be set to one of the following application errors:
- UNSPECIFIED
- BROADCAST_CIPHERING_KEYS_NOT_SUPPORTED

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.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 LMF or LMF (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.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 LMF or LMF (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.5 Notifications + +### 6.2.5.1 CipheringKeyData + +#### 6.2.5.1.1 Description + +The CipheringKeyData operation is used to notify the occurrence of new ciphering key information to a consumer NF (e.g. AMF). + +#### 6.2.5.1.2 Notification Definition + +Callback URI: {amfCallBackURI} + +See clause 5.3.2.2.2 for the description of how the LMF obtains the Callback URI of the NF Service Consumer (i.e. AMF). + +#### 6.2.5.1.3 Notification Standard Methods + +##### 6.2.5.1.3.1 POST + +This method sends a ciphering key data notify to the NF Service Consumer. + +This method shall support the request and response data structures and response codes specified in table 6.2.5.1.3.1-1 and table 6.2.5.1.3.1-2. + +**Table 6.2.5.1.3.1-1: Data structures supported by the POST Request Body** + +| Data type | P | Cardinality | Description | +|------------------|---|-------------|--------------------------------------------------------| +| CipheringKeyInfo | M | 1 | Input parameters to the "Ciphering Key Data" operation | + +**Table 6.2.5.1.3.1-2: Data structures supported by the POST Response Body** + +| Data type | P | Cardinality | Response codes | Description | +|----------------------|---|-------------|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| CipheringKeyResponse | M | 1 | 200 OK | This case represents successful or partially successful storage of ciphering key information by the service consumer NF.

A response body is returned containing the following parameters:
- List of Ciphering Set IDs successfully stored
- List of Ciphering Set IDs not successfully stored | +| 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 | The "cause" attribute may be set to one of the following application errors:
- UNSPECIFIED
- UNABLE_TO_STORE_CIPHERING_KEY_DATA

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.1.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 [4]. | +| 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.2.5.1.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 [4]. | +| 3gpp-Sbi-Target-Nf-Id | string | O | 0..1 | Identifier of the target NF (service) instance ID towards which the notification 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 Nlmf\_Broadcast service based interface protocol. + +**Table 6.2.6.1-1: Nlmf\_Broadcast specific Data Types** + +| Data type | Clause defined | Description | +|----------------------|----------------|-------------------------------------------------------------| +| CipheringKeyInfo | 6.2.6.2.2 | Information within Ciphering Key Data Notification request | +| CipheringKeyResponse | 6.2.6.2.3 | Information within Ciphering Key Data Notification Response | +| CipheringDataSet | 6.2.6.2.4 | Represents a Ciphering Data Set | +| CipheringSetReport | 6.2.6.2.5 | Represents a report of Ciphering Data Set storage | +| Cipher requestData | 6.2.6.2.6 | Information within Ciphering Key Data request | +| Cipher responseData | 6.2.6.2.7 | Information within Ciphering Key Data Response | +| CipheringSetID | 6.2.6.3.2 | Ciphering Data Set ID | +| CipheringKey | 6.2.6.3.2 | Ciphering Key | +| C0 | 6.2.6.3.2 | First component of the initial ciphering counter | +| ValidityDuration | 6.2.6.3.2 | Validity Duration of the Ciphering Data Set | +| StorageOutcome | 6.2.6.3.3 | Indicates the result of Ciphering Data Set storage | +| DataAvailability | 6.2.6.3.4 | Indicates availability of ciphering key data at an LMF | + +Table 6.2.6.1-2 specifies data types re-used by the Nlmf\_Broadcast 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 Nlmf\_Broadcast service based interface. + +**Table 6.2.6.1-2: Nlmf\_Broadcast re-used Data Types** + +| Data type | Reference | Comments | +|-------------------|--------------------|--------------------------------------------------| +| Bytes | 3GPP TS 29.571 [8] | Binary data encoded as a base64 character string | +| DateTime | 3GPP TS 29.571 [8] | Date and Time | +| Uri | 3GPP TS 29.571 [8] | Uniform Resource Identifier | +| SupportedFeatures | 3GPP TS 29.571 [8] | Supported Features | +| RedirectResponse | 3GPP TS 29.571 [8] | Redirect Response | + +## 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: CipheringKeyInfo + +**Table 6.2.6.2.2-1: Definition of type CipheringKeyInfo** + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------| +| cipheringData | array(CipheringDataSet) | M | 1..N | This IE contains one or more ciphering data sets, where each ciphering data set contains information for one ciphering key. | +| 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: CipheringKeyResponse + +**Table 6.2.6.2.3-1: Definition of type CipheringKeyResponse** + +| Attribute name | Data type | P | Cardinality | Description | +|---------------------|---------------------------|---|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| cipheringDataReport | Array(CipheringSetReport) | O | 1..N |

This IE indicates the ciphering data sets which were successfully stored or not stored.

The absence of this IE indicates that all ciphering data sets were successfully stored.

| + +6.2.6.2.4 Type: CipheringDataSet + +**Table 6.2.6.2.4-1: Definition of type CipheringDataSet** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|----------------------------------------------------------------------------------------------------| +| cipheringSetID | CipheringSetID | M | 1 | Identification of a ciphering data set | +| cipheringKey | CipheringKey | M | 1 | A ciphering key value | +| c0 | C0 | M | 1 | First component of the initial ciphering counter as defined in clause 7.4.2 of 3GPP TS 37.355 [21] | + +| | | | | | +|----------------|-------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| ltePosSibTypes | Bytes | O | 0..1 |

This IE contains a bitmap indicating the LTE positioning SIB types for which the ciphering data set is applicable:

  • - a bit set to 0 indicates that the ciphering data set is not applicable to the corresponding LTE positioning SIB type
  • - a bit set to 1 indicates that the ciphering data set is applicable to the corresponding LTE positioning SIB type

The mapping of the bits to the LTE positioning SIB types is as follows:

  • -- bit 8 in the first octet maps to positioning SIB Type 1-1
  • -- bit 7 in the first octet maps to positioning SIB Type 1-2
  • -- bit 6 in the first octet maps to positioning SIB Type 1-3
  • -- bit 5 in the first octet maps to positioning SIB Type 1-4
  • -- bit 4 in the first octet maps to positioning SIB Type 1-5
  • -- bit 3 in the first octet maps to positioning SIB Type 1-6
  • -- bit 2 in the first octet maps to positioning SIB Type 1-7
  • -- bit 1 in the first octet maps to positioning SIB Type 1-8

  • -- bit 8 in the second octet maps to positioning SIB Type 2-1
  • -- bit 7 in the second octet maps to positioning SIB Type 2-2
  • -- bit 6 in the second octet maps to positioning SIB Type 2-3
  • -- bit 5 in the second octet maps to positioning SIB Type 2-4
  • -- bit 4 in the second octet maps to positioning SIB Type 2-5
  • -- bit 3 in the second octet maps to positioning SIB Type 2-6
  • -- bit 2 in the second octet maps to positioning SIB Type 2-7
  • -- bit 1 in the second octet maps to positioning SIB Type 2-8

  • -- bit 8 in the third octet maps to positioning SIB Type 2-9
  • -- bit 7 in the third octet maps to positioning SIB Type 2-10
  • -- bit 6 in the third octet maps to positioning SIB Type 2-11
  • -- bit 5 in the third octet maps to positioning SIB Type 2-12
  • -- bit 4 in the third octet maps to positioning SIB Type 2-13
  • -- bit 3 in the third octet maps to positioning SIB Type 2-14
  • -- bit 2 in the third octet maps to positioning SIB Type 2-15
  • -- bit 1 in the third octet maps to positioning SIB Type 2-16

  • -- bit 8 in the fourth octet maps to
| +|----------------|-------|---|------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

positioning SIB Type 2-17

  • -- bit 7 in the fourth octet maps to positioning SIB Type 2-18
  • -- bit 6 in the fourth octet maps to positioning SIB Type 2-19
  • -- bit 5 in the fourth octet maps to positioning SIB Type 2-20
  • -- bit 4 in the fourth octet maps to positioning SIB Type 2-21
  • -- bit 3 in the fourth octet maps to positioning SIB Type 2-22
  • -- bit 2 in the fourth octet maps to positioning SIB Type 2-23
  • -- bit 1 in the fourth octet maps to positioning SIB Type 2-24
  • -- bit 8 in the fifth octet maps to positioning SIB Type 2-25
  • -- bit 7 in the fifth octet maps to positioning SIB Type 3-1
  • -- bit 6 in the fifth octet maps to positioning SIB Type 4-1
  • -- bit 5 in the fifth octet maps to positioning SIB Type 5-1

Any unassigned bits are spare and shall be coded as zero. Non-included bits shall be treated as being coded as zero.
(NOTE 1)

| +|--|--|--|--|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|---------------|-------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| nrPosSibTypes | Bytes | O | 0..1 |

This IE contains a bitmap indicating the NR positioning SIB types for which the ciphering data set is applicable:

  • - a bit set to 0 indicates that the ciphering data set is not applicable to the corresponding NR positioning SIB type
  • - a bit set to 1 indicates that the ciphering data set is applicable to the corresponding NR positioning SIB type

The mapping of the bits to the NR positioning SIB types is as follows:

  • -- bit 8 in the first octet maps to positioning SIB Type 1-1
  • -- bit 7 in the first octet maps to positioning SIB Type 1-2
  • -- bit 6 in the first octet maps to positioning SIB Type 1-3
  • -- bit 5 in the first octet maps to positioning SIB Type 1-4
  • -- bit 4 in the first octet maps to positioning SIB Type 1-5
  • -- bit 3 in the first octet maps to positioning SIB Type 1-6
  • -- bit 2 in the first octet maps to positioning SIB Type 1-7
  • -- bit 1 in the first octet maps to positioning SIB Type 1-8

  • -- bit 8 in the second octet maps to positioning SIB Type 2-1
  • -- bit 7 in the second octet maps to positioning SIB Type 2-2
  • -- bit 6 in the second octet maps to positioning SIB Type 2-3
  • -- bit 5 in the second octet maps to positioning SIB Type 2-4
  • -- bit 4 in the second octet maps to positioning SIB Type 2-5
  • -- bit 3 in the second octet maps to positioning SIB Type 2-6
  • -- bit 2 in the second octet maps to positioning SIB Type 2-7
  • -- bit 1 in the second octet maps to positioning SIB Type 2-8

  • -- bit 8 in the third octet maps to positioning SIB Type 2-9
  • -- bit 7 in the third octet maps to positioning SIB Type 2-10
  • -- bit 6 in the third octet maps to positioning SIB Type 2-11
  • -- bit 5 in the third octet maps to positioning SIB Type 2-12
  • -- bit 4 in the third octet maps to positioning SIB Type 2-13
  • -- bit 3 in the third octet maps to positioning SIB Type 2-14
  • -- bit 2 in the third octet maps to positioning SIB Type 2-15
  • -- bit 1 in the third octet maps to positioning SIB Type 2-16

  • -- bit 8 in the fourth octet maps to positioning SIB Type 2-17
| +|---------------|-------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + +| | | | | | +|-----------------------------------------------------------------------------|------------------|---|------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| | | | |

-- bit 7 in the fourth octet maps to positioning SIB Type 2-18

-- bit 6 in the fourth octet maps to positioning SIB Type 2-19

-- bit 5 in the fourth octet maps to positioning SIB Type 2-20

-- bit 4 in the fourth octet maps to positioning SIB Type 2-21

-- bit 3 in the fourth octet maps to positioning SIB Type 2-22

-- bit 2 in the fourth octet maps to positioning SIB Type 2-23

-- bit 1 in the fourth octet maps to positioning SIB Type 3-1


-- bit 8 in the fifth octet maps to positioning SIB Type 4-1

-- bit 7 in the fifth octet maps to positioning SIB Type 5-1

-- bit 6 in the fifth octet maps to positioning SIB Type 6-1

-- bit 5 in the fifth octet maps to positioning SIB Type 6-2

-- bit 4 in the fifth octet maps to positioning SIB Type 6-3


Any unassigned bits are spare and shall be coded as zero. Non-included bits shall be treated as being coded as zero.
(NOTE 1)

| +| validityStartTime | DateTime | M | 1 | This IE contains the UTC time when the ciphering data set becomes valid. | +| validityDuration | ValidityDuration | M | 1 | The validity duration of the ciphering data set. | +| tailList | Bytes | O | 0..1 |

This IE contains the TAIs of the tracking areas for which the ciphering data set is applicable. It is encoded as octets 2 to n of the 5GS tracking area identity list IE specified in clause 9.11.3.9 of 3GPP TS 24.501 [22].

If this IE is omitted, the ciphering data set is valid in the entire PLMN.

| +| NOTE 1: At least one of ltesibTypes IE and nrsibTypes IE shall be included. | | | | | + +#### 6.2.6.2.5 Type: CipheringSetReport + +**Table 6.2.6.2.5-1: Definition of CipheringSetReport** + +| Attribute name | Data type | P | Cardinality | Description | +|----------------|----------------|---|-------------|-----------------------------------------------------------------------------------------| +| cipheringSetID | CipheringSetID | M | 1 | Identification of a ciphering data set | +| storageOutcome | StorageOutcome | M | 1 | Indication of whether the ciphering data set was successfully stored or was not stored. | + +## 6.2.6.2.6 Type: CipherRequestData + +Table 6.2.6.2.6-1: Definition of CipherRequestData + +| Attribute name | Data type | P | Cardinality | Description | +|-------------------|-------------------|---|-------------|-------------------------------------------------------------------------------------------------| +| amfCallBackURI | Uri | M | 1 | Callback URI of the NF Service Consumer | +| 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.7 Type: CipherResponseData + +Table 6.2.6.2.7-1: Definition of CipherResponseData + +| Attribute name | Data type | P | Cardinality | Description | +|------------------|------------------|---|-------------|---------------------------------------------------------------------------------------------------------| +| dataAvailability | DataAvailability | M | 1 | An indication of whether the LMF currently has ciphering key data applicable to the NF Service Consumer | + +## 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 | +|------------------|-----------------|-------------------------------------------------------------------| +| CipheringSetID | integer | The ciphering set ID
Minimum = 0. Maximum = 65535 | +| CipheringKey | Bytes | A 128 bit ciphering key encoded as a base64 character string | +| C0 | Bytes | A 128 bit value for C0 encoded as a base64 character string | +| ValidityDuration | integer | The validity duration in minutes.
Minimum = 1. Maximum = 65535 | + +## 6.2.6.3.3 Enumeration: StorageOutcome + +The enumeration StorageOutcome represents the outcome of cipher set data storage at the service consumer NF. + +Table 6.2.6.3.3-1: Enumeration StorageOutcome + +| Enumeration value | Description | +|----------------------|-----------------------------------------------------------| +| "STORAGE_SUCCESSFUL" | Indicates storage of Ciphering Data Set is successful | +| "STORAGE_FAILED" | Indicates storage of Ciphering Data Set is not successful | + +## 6.2.6.3.4 Enumeration: DataAvailability + +The enumeration DataAvailability represents the availability of ciphering key data at an LMF. + +**Table 6.2.6.3.4-1: Enumeration DataAvailability** + +| Enumeration value | Description | +|-----------------------------------|------------------------------------------------------| +| "CIPHERING_KEY_DATA_AVAILABLE" | Indicates Ciphering Data Set is available in LMF | +| CIPHERING_KEY_DATA_NOT_AVAILABLE" | Indicates Ciphering Data Set is not available in LMF | + +## 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 errors handling shall be supported as specified in clause 5.2.7 of 3GPP TS 29.500 [4]. + +### 6.2.7.3 Application Errors + +The application errors defined for the Nlmf\_Broadcast service are listed in table 6.2.7.3-1. + +**Table 6.2.7.3-1: Application errors** + +| Application Error | HTTP status code | Description | +|----------------------------------------|------------------|-----------------------------------------------------------------| +| UNSPECIFIED | 403
Forbidden | The request is rejected due to unspecified reasons. | +| UNABLE_TO_STORE_CIPHERING_KEY_DATA | 403
Forbidden | The service consumer NF was unable to store ciphering key data. | +| BROADCAST_CIPHERING_KEYS_NOT_SUPPORTED | 403
Forbidden | Ciphering keys for broadcast are not supported. | + +## 6.2.8 Security + +The Nlmf\_Broadcast API does not define service operations for which additional security is needed in this version of the specification. + +## 6.2.9 Feature Negotiation + +The optional features in table 6.2.9-1 are defined for the Nlmf\_Broadcast 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. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Broadcast service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15. | + +## 6.2.10 HTTP redirection + +An HTTP request may be redirected to a different LMF service instance, within the same LMF or a different LMF of an LMF set, e.g. when an LMF service instance is part of an LMF (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 LMF producer instance will return the NF Instance ID of the new LMF 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 LMF within an LMF set redirects a service request to a different LMF of the set using an 307 Temporary Redirect or 308 Permanent Redirect status code, the identity of the new LMF 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 Nlmf Service APIs. 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: 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 Nlmf\_Location API + +``` +openapi: 3.0.0 + +info: + version: '1.3.0-alpha.5' + title: 'LMF Location' + description: | + LMF Location Service. + © 2023, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.572 V18.4.0; 5G System; Location Management Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.572/' + +servers: + - url: '{apiRoot}/nlmf-loc/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc +``` + +``` +paths: + /determine-location: + post: + summary: Determine Location of an UE + operationId: DetermineLocation + tags: + - Determine Location + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:determine-location:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/InputData' + multipart/related: # message with binary body part(s) + schema: + type: object + properties: # Request parts + jsonData: + $ref: '#/components/schemas/InputData' + binaryDataLppMessage: + type: string + format: binary + encoding: + jsonData: + contentType: application/json + binaryDataLppMessage: + contentType: application/vnd.3gpp.lpp + headers: + Content-Id: + schema: + type: string + binaryDataLppMessageExt1: + contentType: application/vnd.3gpp.lpp + headers: + Content-Id: + schema: + type: string + binaryDataLppMessageExt2: + contentType: application/vnd.3gpp.lpp + headers: + Content-Id: + schema: + type: string + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LocationDataExt' + '204': + description: Expected response for MO-LR requesting location assistance 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' +'504': + $ref: 'TS29571_CommonData.yaml#/components/responses/504' +default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +callbacks: + EventNotify: + '{ $request.body#/htmlCallbackURI }': + 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' +/up-subscription: + post: + summary: subscribe about status of a secure LCS-UP connection for a target UE + operationId: UpSubscription + tags: + - UP Subscribe + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:up-subscription:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpSubscription' + required: true + responses: + '204': + description: Expected response to successful UP 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: + UPNotify: + "{$request.body#/upNotifyCallBackURI}": + post: + requestBody: + description: UP Connection Status Notification + content: + application/json: + schema: + $ref: '#/components/schemas/UpNotifyData' + 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: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-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-context-transfer: + post: + summary: transfer context information for periodic or triggered location + operationId: LocationContextTransfer + tags: + - Location Context Transfer + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:location-context-transfer:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocContextData' + 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' +/location-measure: + post: + summary: PRU location measurement + operationId: LocationMeasure + tags: + - Location Measure + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:location-measure:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LocMeasurementReq' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/LocMeasurementResp' + '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' +``` + +``` + +/up-configure: + post: + summary: set up, modify or terminate a secure LCS-UP connection for a target UE + operationId: UpConfig + tags: + - UP Configure + security: + - {} + - oAuth2ClientCredentials: + - nlmf-loc + - oAuth2ClientCredentials: + - nlmf-loc + - nlmf-loc:up-configure:invoke + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UpConfig' + required: true + responses: + '204': + description: Expected response to successful set up, modify or terminate LCS-UP +connection. + '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: + nlmf-loc: Access to the Nlmf_Location API + nlmf-loc:determine-location:invoke: Access to invoke Determine Location + nlmf-loc:cancel-location:invoke: Access to invoke Cancel Location + nlmf-loc:location-context-transfer:invoke: Access to invoke Location Context + nlmf-loc:location-measure:invoke: Access to invoke Location Measurement + nlmf-loc:up-subscription:invoke: Access to invoke UP Subscription + nlmf-loc:up-configure:invoke: Access to invoke UP Config + +schemas: +# +# COMPLEX TYPES +# + InputData: + description: Information within Determine Location Request. + type: object + not: + +``` + +``` +required: [ ecgi, ncgi ] +properties: + externalClientType: + $ref: '#/components/schemas/ExternalClientType' + correlationID: + $ref: '#/components/schemas/CorrelationID' + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + locationQoS: + $ref: '#/components/schemas/LocationQoS' + supportedGADShapes: + type: array + items: + $ref: '#/components/schemas/SupportedGADShapes' + minItems: 1 + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + requestedRangingSlResult: + type: array + items: + $ref: '#/components/schemas/RangingSlResult' + minItems: 1 + relatedUEs: + type: array + items: + $ref: '#/components/schemas/RelatedUE' + minItems: 1 + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ecgiOnSecondNode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ncgiOnSecondNode: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + priority: + $ref: '#/components/schemas/LcsPriority' + velocityRequested: + $ref: '#/components/schemas/VelocityRequested' + ueLcsCap: + $ref: '#/components/schemas/UeLcsCapability' + lcsServiceType: + $ref: '#/components/schemas/LcsServiceType' + ldrType: + $ref: '#/components/schemas/LdrType' + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + lirGmlcCallBackUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + vgmlcAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + lirReference: + $ref: '#/components/schemas/LirReference' + periodicEventInfo: + $ref: '#/components/schemas/PeriodicEventInfo' + areaEventInfo: + $ref: '#/components/schemas/AreaEventInfo' + motionEventInfo: + $ref: '#/components/schemas/MotionEventInfo' + reportingAccessTypes: + type: array + items: + $ref: '#/components/schemas/ReportingAccessType' + minItems: 1 + ueConnectivityStates: + $ref: '#/components/schemas/UeConnectivityState' + ueLocationServiceInd: + $ref: '#/components/schemas/UeLocationServiceInd' + moAssistanceDataTypes: + $ref: 'TS29503_Nudm_SDM.yaml#/components/schemas/LcsBroadcastAssistanceTypesData' + lppMessage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' +``` + +``` +lppMessageExt: + description: Indicates the lpp message extension. + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + uePositioningCap: + $ref: '#/components/schemas/UePositioningCapabilities' + tnapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TnapId' + twapId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TwapId' + ueCountryDetInd: + type: boolean + scheduledLocTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + reliableLocReq: + type: boolean + default: false + evtRptAllowedAreas: + type: array + items: + $ref: '#/components/schemas/ReportingArea' + minItems: 1 + maxItems: 250 + ueUnawareInd: + type: boolean + enum: + - true + intermediateLocationInd: + type: boolean + default: false + maxRespTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + lpHapType: + $ref: 'TS29518_Namf_Location.yaml#/components/schemas/LpHapType' + ueUpPosCaps: + type: array + items: + $ref: '#/components/schemas/UeUpPositioningCapabilities' + minItems: 1 + reportingInd: + allOf: + - $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/ReportingInd' + default: INSIDE_REPORTING + mbsrInfo: + $ref: '#/components/schemas/MbsrInfo' + integrityRequirements: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/IntegrityRequirements' + upLocRepAddrAf: + $ref: 'TS29122_MonitoringEvent.yaml#/components/schemas/UpLocRepAddrAfRm' + upCumEvtRptCriteria: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UpCumEvtRptCriteria' + mappedQoSEps: + $ref: '#/components/schemas/MappedLocationQoSEps' + additionalUeInfo: + $ref: '#/components/schemas/AdditionalUeInfo' + +LocationDataExt: + description: Extended Location Data for UEs + allOf: + - $ref: '#/components/schemas/LocationData' + - $ref: '#/components/schemas/AddLocationDatas' + +LocationData: + description: Information within Determine Location Response. + type: object + required: + - locationEstimate + properties: + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + accuracyFulfilmentIndicator: + $ref: '#/components/schemas/AccuracyFulfilmentIndicator' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' +``` + +``` +timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' +civicAddress: + $ref: '#/components/schemas/CivicAddress' +localLocationEstimate: + $ref: '#/components/schemas/LocalArea' +positioningDataList: + type: array + items: + $ref: '#/components/schemas/PositioningMethodAndUsage' + minItems: 1 +gnssPositioningDataList: + type: array + items: + $ref: '#/components/schemas/GnssPositioningMethodAndUsage' + minItems: 1 +ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' +ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' +altitude: + $ref: '#/components/schemas/Altitude' +barometricPressure: + $ref: '#/components/schemas/BarometricPressure' +servingLMFIdentification: + $ref: '#/components/schemas/LMFIdentification' +uePositioningCap: + $ref: '#/components/schemas/UePositioningCapabilities' +ueAreaInd: + $ref: '#/components/schemas/UeAreaIndication' +supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' +achievedQos: + $ref: '#/components/schemas/MinorLocationQoS' +directReportInd: + type: boolean + default: false +indoorOutdoorInd: + $ref: '#/components/schemas/IndoorOutdoorInd' +acceptedPeriodicEventInfo: + $ref: '#/components/schemas/PeriodicEventInfo' +haGnssMetrics: + $ref: '#/components/schemas/HighAccuracyGnssMetrics' +losNlosMeasureInd: + $ref: '#/components/schemas/LosNlosMeasureInd' +relatedApplicationlayerId: + type: string +rangeDirection: + $ref: '#/components/schemas/RangeDirection' +2dRelativeLocation: + $ref: '#/components/schemas/2DRelativeLocation' +3dRelativeLocation: + $ref: '#/components/schemas/3DRelativeLocation' +relativeVelocity: + $ref: '#/components/schemas/VelocityEstimate' + +GeographicArea: + description: Geographic area specified by different shape. + anyOf: + - $ref: '#/components/schemas/Point' + - $ref: '#/components/schemas/PointUncertaintyCircle' + - $ref: '#/components/schemas/PointUncertaintyEllipse' + - $ref: '#/components/schemas/Polygon' + - $ref: '#/components/schemas/PointAltitude' + - $ref: '#/components/schemas/PointAltitudeUncertainty' + - $ref: '#/components/schemas/EllipsoidArc' + +GADShape: + description: Common base type for GAD shapes. + type: object + required: + - shape + properties: + shape: + $ref: '#/components/schemas/SupportedGADShapes' +``` + +``` +discriminator: + propertyName: shape + mapping: + POINT: '#/components/schemas/Point' + POINT_UNCERTAINTY_CIRCLE: '#/components/schemas/PointUncertaintyCircle' + POINT_UNCERTAINTY_ELLIPSE: '#/components/schemas/PointUncertaintyEllipse' + POLYGON: '#/components/schemas/Polygon' + POINT_ALTITUDE: '#/components/schemas/PointAltitude' + POINT_ALTITUDE_UNCERTAINTY: '#/components/schemas/PointAltitudeUncertainty' + ELLIPSOID_ARC: '#/components/schemas/EllipsoidArc' + LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE: '#/components/schemas/Local2dPointUncertaintyEllipse' + LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID: + '#/components/schemas/Local3dPointUncertaintyEllipsoid' + +Point: + description: Ellipsoid Point. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + +PointUncertaintyCircle: + description: Ellipsoid point with uncertainty circle. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - uncertainty + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + uncertainty: + $ref: '#/components/schemas/Uncertainty' + +PointUncertaintyEllipse: + description: Ellipsoid point with uncertainty ellipse. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - uncertaintyEllipse + - confidence + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + uncertaintyEllipse: + $ref: '#/components/schemas/UncertaintyEllipse' + confidence: + $ref: '#/components/schemas/Confidence' + +Polygon: + description: Polygon. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - pointList + properties: + pointList: + $ref: '#/components/schemas/PointList' + +PointAltitude: + description: Ellipsoid point with altitude. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - altitude + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' +``` + +``` + altitude: + $ref: '#/components/schemas/Altitude' + +PointAltitudeUncertainty: + description: Ellipsoid point with altitude and uncertainty ellipsoid. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - altitude + - uncertaintyEllipse + - uncertaintyAltitude + - confidence + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + altitude: + $ref: '#/components/schemas/Altitude' + uncertaintyEllipse: + $ref: '#/components/schemas/UncertaintyEllipse' + uncertaintyAltitude: + $ref: '#/components/schemas/Uncertainty' + confidence: + $ref: '#/components/schemas/Confidence' + +EllipsoidArc: + description: Ellipsoid Arc. + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - point + - innerRadius + - uncertaintyRadius + - offsetAngle + - includedAngle + - confidence + properties: + point: + $ref: '#/components/schemas/GeographicalCoordinates' + innerRadius: + $ref: '#/components/schemas/InnerRadius' + uncertaintyRadius: + $ref: '#/components/schemas/Uncertainty' + offsetAngle: + $ref: '#/components/schemas/Angle' + includedAngle: + $ref: '#/components/schemas/Angle' + confidence: + $ref: '#/components/schemas/Confidence' + +LocalOrigin: + description: Indicates a Local origin in a reference system + type: object + properties: + coordinateId: + type: string + point: + $ref: '#/components/schemas/GeographicalCoordinates' + +RelativeCartesianLocation: + description: Relative Cartesian Location + type: object + required: + - x + - y + properties: + x: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + y: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + z: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + +LocalArea: + description: Local area specified by different shape +``` + +``` +oneOf: + - $ref: '#/components/schemas/Local2dPointUncertaintyEllipse' + - $ref: '#/components/schemas/Local3dPointUncertaintyEllipsoid' + +UeAreaIndication: + description: Indicates area (country, area in a country or international area) where UE is located + type: object + oneOf: + - required: + - country + - required: + - internationalAreaInd + properties: + country: + description: Indicates country or area in a country where UE is located + type: string + internationalAreaInd: + description: Indicates international area indication if UE is located in international +area + type: boolean + default: false + +Local2dPointUncertaintyEllipse: + description: Local 2D point with uncertainty ellipse + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - localOrigin + - point + - uncertaintyEllipse + - confidence + properties: + localOrigin: + $ref: '#/components/schemas/LocalOrigin' + point: + $ref: '#/components/schemas/RelativeCartesianLocation' + uncertaintyEllipse: + $ref: '#/components/schemas/UncertaintyEllipse' + confidence: + $ref: '#/components/schemas/Confidence' + +Local3dPointUncertaintyEllipsoid: + description: Local 3D point with uncertainty ellipsoid + allOf: + - $ref: '#/components/schemas/GADShape' + - type: object + required: + - localOrigin + - point + - uncertaintyEllipsoid + - confidence + properties: + localOrigin: + $ref: '#/components/schemas/LocalOrigin' + point: + $ref: '#/components/schemas/RelativeCartesianLocation' + uncertaintyEllipsoid: + $ref: '#/components/schemas/UncertaintyEllipsoid' + confidence: + $ref: '#/components/schemas/Confidence' + +GeographicalCoordinates: + description: Geographical coordinates. + type: object + required: + - lon + - lat + properties: + lon: + type: number + format: double + minimum: -180 + maximum: 180 + lat: + type: number + format: double +``` + +``` + minimum: -90 + maximum: 90 + +UncertaintyEllipse: + description: Ellipse with uncertainty. + type: object + required: + - semiMajor + - semiMinor + - orientationMajor + properties: + semiMajor: + $ref: '#/components/schemas/Uncertainty' + semiMinor: + $ref: '#/components/schemas/Uncertainty' + orientationMajor: + $ref: '#/components/schemas/Orientation' + +UncertaintyEllipsoid: + description: Ellipsoid with uncertainty + type: object + required: + - semiMajor + - semiMinor + - vertical + - orientationMajor + properties: + semiMajor: + $ref: '#/components/schemas/Uncertainty' + semiMinor: + $ref: '#/components/schemas/Uncertainty' + vertical: + $ref: '#/components/schemas/Uncertainty' + orientationMajor: + $ref: '#/components/schemas/Orientation' + +PointList: + description: List of points. + type: array + items: + $ref: '#/components/schemas/GeographicalCoordinates' + minItems: 3 + maxItems: 15 + +LocationQoS: + description: QoS of Location request. + type: object + properties: + hAccuracy: + $ref: '#/components/schemas/Accuracy' + vAccuracy: + $ref: '#/components/schemas/Accuracy' + verticalRequested: + type: boolean + responseTime: + $ref: '#/components/schemas/ResponseTime' + minorLocQoses: + type: array + items: + $ref: '#/components/schemas/MinorLocationQoS' + minItems: 1 + maxItems: 2 + lcsQoSClass: + $ref: '#/components/schemas/LcsQoSClass' + +PositioningMethodAndUsage: + description: Indicates the usage of a positioning method. + type: object + required: + - method + - mode + - usage + properties: + method: + $ref: '#/components/schemas/PositioningMethod' + mode: + $ref: '#/components/schemas/PositioningMode' + usage: +``` + +``` +$ref: '#/components/schemas/Usage' +methodCode: + type: integer + minimum: 16 + maximum: 31 + +GnssPositioningMethodAndUsage: + description: Indicates the usage of a Global Navigation Satellite System (GNSS) positioning +method. + type: object + required: + - mode + - gnss + - usage + properties: + mode: + $ref: '#/components/schemas/PositioningMode' + gnss: + $ref: '#/components/schemas/GnssId' + usage: + $ref: '#/components/schemas/Usage' + +CivicAddress: + description: Indicates a Civic address. + type: object + properties: + country: + type: string + A1: + type: string + A2: + type: string + A3: + type: string + A4: + type: string + A5: + type: string + A6: + type: string + PRD: + type: string + POD: + type: string + STS: + type: string + HNO: + type: string + HNS: + type: string + LMK: + type: string + LOC: + type: string + NAM: + type: string + PC: + type: string + BLD: + type: string + UNIT: + type: string + FLR: + type: string + ROOM: + type: string + PLC: + type: string + PCN: + type: string + POBOX: + type: string + ADDCODE: + type: string + SEAT: + type: string + RD: + type: string +``` + +``` +RDSEC: + type: string +RDBR: + type: string +RDSUBBR: + type: string +PRM: + type: string +POM: + type: string +usageRules: + type: string +method: + type: string +providedBy: + type: string + +VelocityEstimate: + description: Velocity estimate. + oneOf: + - $ref: '#/components/schemas/HorizontalVelocity' + - $ref: '#/components/schemas/HorizontalWithVerticalVelocity' + - $ref: '#/components/schemas/HorizontalVelocityWithUncertainty' + - $ref: '#/components/schemas/HorizontalWithVerticalVelocityAndUncertainty' + +HorizontalVelocity: + description: Horizontal velocity. + type: object + required: + - hSpeed + - bearing + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + +HorizontalWithVerticalVelocity: + description: Horizontal and vertical velocity. + type: object + required: + - hSpeed + - bearing + - vSpeed + - vDirection + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + vSpeed: + $ref: '#/components/schemas/VerticalSpeed' + vDirection: + $ref: '#/components/schemas/VerticalDirection' + +HorizontalVelocityWithUncertainty: + description: Horizontal velocity with speed uncertainty. + type: object + required: + - hSpeed + - bearing + - hUncertainty + properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + hUncertainty: + $ref: '#/components/schemas/SpeedUncertainty' + +HorizontalWithVerticalVelocityAndUncertainty: + description: Horizontal and vertical velocity with speed uncertainty. + type: object + required: + - hSpeed + - bearing + - vSpeed + - vDirection +``` + +``` +- hUncertainty +- vUncertainty +properties: + hSpeed: + $ref: '#/components/schemas/HorizontalSpeed' + bearing: + $ref: '#/components/schemas/Angle' + vSpeed: + $ref: '#/components/schemas/VerticalSpeed' + vDirection: + $ref: '#/components/schemas/VerticalDirection' + hUncertainty: + $ref: '#/components/schemas/SpeedUncertainty' + vUncertainty: + $ref: '#/components/schemas/SpeedUncertainty' + +UeLcsCapability: + description: Indicates the LCS capability supported by the UE.. + type: object + properties: + lppSupport: + type: boolean + default: true + ciotOptimisation: + type: boolean + default: false + +PeriodicEventInfo: + description: Indicates the information of periodic event reporting. + type: object + required: + - reportingAmount + - reportingInterval + properties: + reportingAmount: + $ref: '#/components/schemas/ReportingAmount' + reportingInterval: + $ref: '#/components/schemas/ReportingInterval' + reportingInfiniteInd: + type: boolean + enum: + - true + reportingIntervalMs: + $ref: '#/components/schemas/ReportingIntervalMs' + +AreaEventInfo: + description: Indicates the information of area based event reporting. + type: object + required: + - areaDefinition + properties: + areaDefinition: + type: array + items: + $ref: '#/components/schemas/ReportingArea' + minItems: 1 + maxItems: 250 + occurrenceInfo: + $ref: '#/components/schemas/OccurrenceInfo' + minimumInterval: + $ref: '#/components/schemas/MinimumInterval' + maximumInterval: + $ref: '#/components/schemas/MaximumInterval' + samplingInterval: + $ref: '#/components/schemas/SamplingInterval' + reportingDuration: + $ref: '#/components/schemas/ReportingDuration' + reportingLocationReq: + type: boolean + default: true + +ReportingArea: + description: Indicates an area for event reporting. + type: object + required: + - areaType + properties: + areaType: +``` + +``` +$ref: '#/components/schemas/ReportingAreaType' +tai: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Tai' +ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' +ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + +MotionEventInfo: + description: Indicates the information of motion based event reporting. + type: object + required: + - linearDistance + properties: + linearDistance: + $ref: '#/components/schemas/LinearDistance' + occurrenceInfo: + $ref: '#/components/schemas/OccurrenceInfo' + minimumInterval: + $ref: '#/components/schemas/MinimumInterval' + maximumInterval: + $ref: '#/components/schemas/MaximumInterval' + samplingInterval: + $ref: '#/components/schemas/SamplingInterval' + reportingDuration: + $ref: '#/components/schemas/ReportingDuration' + reportingLocationReq: + type: boolean + default: true + +CancelLocData: + description: Information within Cancel Location Request. + type: object + required: + - hgmlcCallBackURI + - ldrReference + properties: + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +LocContextData: + description: Information within Transfer Location Context Request. + type: object + required: + - amfId + - ldrType + - hgmlcCallBackURI + - ldrReference + - eventReportMessage + properties: + amfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + locationQoS: + $ref: '#/components/schemas/LocationQoS' + supportedGADShapes: + type: array + items: + $ref: '#/components/schemas/SupportedGADShapes' + minItems: 1 + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + ldrType: + $ref: '#/components/schemas/LdrType' + hgmlcCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + periodicEventInfo: + $ref: '#/components/schemas/PeriodicEventInfo' + areaEventInfo: + $ref: '#/components/schemas/AreaEventInfo' + motionEventInfo: +``` + +``` + $ref: '#/components/schemas/MotionEventInfo' + eventReportMessage: + $ref: '#/components/schemas/EventReportMessage' + eventReportingStatus: + $ref: '#/components/schemas/EventReportingStatus' + ueLocationInfo: + $ref: '#/components/schemas/UELocationInfo' + cIoT5GSOptimisation: + type: boolean + default: false + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + uePositioningCap: + $ref: '#/components/schemas/UePositioningCapabilities' + scheduledLocTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + indoorOutdoorInd: + $ref: '#/components/schemas/IndoorOutdoorInd' + losNlosMeasureInd: + $ref: '#/components/schemas/LosNlosMeasureInd' + upCumEvtRptCriteria: + $ref: 'TS29515_Ngmlc_Location.yaml#/components/schemas/UpCumEvtRptCriteria' + +EventReportMessage: + description: Indicates an event report message. + type: object + required: + - eventClass + - eventContent + properties: + eventClass: + $ref: '#/components/schemas/EventClass' + eventContent: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RefToBinaryData' + +EventReportingStatus: + description: Indicates the status of event reporting. + type: object + properties: + eventReportCounter: + $ref: '#/components/schemas/EventReportCounter' + eventReportDuration: + $ref: '#/components/schemas/EventReportDuration' + +UELocationInfo: + description: Indicates location information of a UE. + type: object + properties: + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' + ageOfVelocityEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + timestampOfVelocityEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +EventNotifyDataExt: + description: Extended Event Notify Data for UEs + allOf: + - $ref: '#/components/schemas/EventNotifyData' + - $ref: '#/components/schemas/AddEventNotifyDatas' + +EventNotifyData: + description: Information within Event Notify Request. + type: object + required: + - reportedEventType +``` + +``` + - ldrReference +properties: + reportedEventType: + $ref: '#/components/schemas/ReportedEventType' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + hgmlcCallbackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + ldrReference: + $ref: '#/components/schemas/LdrReference' + lirReference: + $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/LirReference' + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + civicAddress: + $ref: '#/components/schemas/CivicAddress' + localLocationEstimate: + $ref: '#/components/schemas/LocalArea' + positioningDataList: + type: array + items: + $ref: '#/components/schemas/PositioningMethodAndUsage' + minItems: 1 + gnssPositioningDataList: + type: array + items: + $ref: '#/components/schemas/GnssPositioningMethodAndUsage' + minItems: 1 + servingLMFIdentification: + $ref: '#/components/schemas/LMFIdentification' + terminationCause: + $ref: '#/components/schemas/TerminationCause' + velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' + altitude: + $ref: '#/components/schemas/Altitude' + achievedQoS: + $ref: '#/components/schemas/MinorLocationQoS' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + indoorOutdoorInd: + $ref: '#/components/schemas/IndoorOutdoorInd' + haGnssMetrics: + $ref: '#/components/schemas/HighAccuracyGnssMetrics' + losNlosMeasureInd: + $ref: '#/components/schemas/LosNlosMeasureInd' + upLocRepStatAf: + type: integer + relatedApplicationlayerId: + type: string + rangeDirection: + $ref: '#/components/schemas/RangeDirection' + 2dRelativeLocation: + $ref: '#/components/schemas/2DRelativeLocation' + 3dRelativeLocation: + $ref: '#/components/schemas/3DRelativeLocation' + relativeVelocity: + $ref: '#/components/schemas/VelocityEstimate' + +UeConnectivityState: + description: Indicates the connectivity state of a UE. + type: object + required: + - accessType + properties: + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + connectivitystate: + $ref: 'TS29518_Namf_EventExposure.yaml#/components/schemas/CmState' + +MinorLocationQoS: +``` + +``` +description: Contain Minor Location QoS. +type: object +properties: + hAccuracy: + $ref: '#/components/schemas/Accuracy' + vAccuracy: + $ref: '#/components/schemas/Accuracy' + +MbsrInfo: + description: MBSR Information + type: object + properties: + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + +LocMeasurementReq: + description: Location Measurement Request. + type: object + properties: + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + preCalcuLocEstimate: + $ref: '#/components/schemas/GeographicArea' + timestampOfPreCalcuLocEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + +LocMeasurementResp: + description: Location Measurement Response. + type: object + required: + - locMeasurements + - locationEstimate + properties: + locMeasurements: + $ref: '#/components/schemas/LocMeasurements' + locationEstimate: + $ref: '#/components/schemas/GeographicArea' + ageOfLocationEstimate: + $ref: '#/components/schemas/AgeOfLocationEstimate' + timestampOfLocationEstimate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + velocityEstimate: + $ref: '#/components/schemas/VelocityEstimate' + localLocationEstimate: + $ref: '#/components/schemas/LocalArea' + +LocMeasurements: + description: PRU Location Measurements. + type: object + properties: + rstd: + type: integer + +HighAccuracyGnssMetrics: + description: High Accuracy GNSS Positioning Metrics. + type: object + properties: + nrOfUsedSatellites: + type: integer + minimum: 0 + maximum: 64 + hdopi: + type: integer + minimum: 1 + maximum: 256 + pdopi: + type: integer + minimum: 1 + maximum: 256 + age: + type: integer + minimum: 0 + maximum: 99 +``` + +``` +fixType: + $ref: '#/components/schemas/FixType' + +UpNotifyData: + description: UP Subscription + type: object + required: + - ldrReference + - upConnectionStatus + properties: + ldrReference: + $ref: '#/components/schemas/LdrReference' + upConnectionStatus: + $ref: '#/components/schemas/UpConnectionStatus' + targetLMFIdentification: + $ref: '#/components/schemas/LMFIdentification' + +UpSubscription: + description: UP Subscription + type: object + required: + - upNotifyCallBackURI + - supi + properties: + upNotifyCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + +RelatedUE: + description: Related UE Information + type: object + required: + - applicationlayerId + - relatedUEType + properties: + applicationlayerId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationlayerId' + relatedUEType: + $ref: '#/components/schemas/RelatedUEType' + +UpConfig: + description: UP Config + type: object + required: + - upNotifyCallBackURI + properties: + upNotifyCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + amfReallocationInd: + type: boolean + default: false + lcsUpConnectionInd: + $ref: '#/components/schemas/LcsUpConnectionInd' + targetLMFIdentification: + $ref: '#/components/schemas/LMFIdentification' + +RangeDirection: + description: Represents a range and direction from a point A to a point B. + type: object + properties: + range: + type: number + azimuthDirection: + $ref: '#/components/schemas/Angle' + elevationDirection: + $ref: '#/components/schemas/Angle' + +2DRelativeLocation: + description: Represents a relative 2D location with uncertainty ellipse. + type: object + properties: +``` + +``` + semiMinor: + $ref: '#/components/schemas/Uncertainty' + semiMajor: + $ref: '#/components/schemas/Uncertainty' + orientationAngle: + $ref: '#/components/schemas/Angle' + +3DRelativeLocation: + description: Represents a relative 3D location with uncertainty ellipsoid. + type: object + properties: + semiMinor: + $ref: '#/components/schemas/Uncertainty' + semiMajor: + $ref: '#/components/schemas/Uncertainty' + verticalUncertainty: + $ref: '#/components/schemas/Uncertainty' + orientationAngle: + $ref: '#/components/schemas/Angle' + +AddLocationDatas: + type: object + properties: + addLocationDatas: + type: array + items: + $ref: '#/components/schemas/LocationData' + minItems: 1 + +AddEventNotifyDatas: + type: object + properties: + addEventNotifyDatas: + type: array + items: + $ref: '#/components/schemas/EventNotifyData' + minItems: 1 + +MappedLocationQoSEps: + description: Mapped Location QoS for EPS. + type: object + required: + - hAccuracy + properties: + hAccuracy: + $ref: '#/components/schemas/Accuracy' + vAccuracy: + $ref: '#/components/schemas/Accuracy' + +AdditionalUeInfo: + description: MBSR UE Information + type: object + properties: + ncgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi' + ecgi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi' + +# +# +# SIMPLE TYPES +# +Altitude: + description: Indicates value of altitude. + type: number + format: double + minimum: -32767 + maximum: 32767 + +Angle: + description: Indicates value of angle. + type: integer + minimum: 0 + maximum: 360 + +Uncertainty: + description: Indicates value of uncertainty. +``` + +``` +type: number +format: float +minimum: 0 + +Orientation: + description: Indicates value of orientation angle. + type: integer + minimum: 0 + maximum: 180 + +Confidence: + description: Indicates value of confidence. + type: integer + minimum: 0 + maximum: 100 + +Accuracy: + description: Indicates value of accuracy. + type: number + format: float + minimum: 0 + +InnerRadius: + description: Indicates value of the inner radius. + type: integer + format: int32 + minimum: 0 + maximum: 327675 + +CorrelationID: + description: LCS Correlation ID. + type: string + minLength: 1 + maxLength: 255 + +AgeOfLocationEstimate: + description: Indicates value of the age of the location estimate. + type: integer + minimum: 0 + maximum: 32767 + +HorizontalSpeed: + description: Indicates value of horizontal speed. + type: number + format: float + minimum: 0 + maximum: 2047 + +VerticalSpeed: + description: Indicates value of vertical speed. + type: number + format: float + minimum: 0 + maximum: 255 + +SpeedUncertainty: + description: Indicates value of speed uncertainty. + type: number + format: float + minimum: 0 + maximum: 255 + +BarometricPressure: + description: Specifies the measured uncompensated atmospheric pressure. + type: integer + minimum: 30000 + maximum: 115000 + +LcsServiceType: + description: LCS service type. + type: integer + minimum: 0 + maximum: 127 + +LdrReference: + description: LDR Reference. + type: string + minLength: 2 +``` + +``` + maxLength: 510 + + LirReference: + description: LIR Reference. + type: string + minLength: 2 + maxLength: 510 + + ReportingAmount: + description: Number of required periodic event reports. + type: integer + minimum: 1 + maximum: 8639999 + + ReportingInterval: + description: Event reporting periodic interval in seconds. + type: integer + minimum: 1 + maximum: 8639999 + + ReportingIntervalMs: + description: Event reporting periodic interval in milliseconds. + type: integer + minimum: 1 + maximum: 999 + + MinimumInterval: + description: Minimum interval between event reports. + type: integer + minimum: 1 + maximum: 32767 + + MaximumInterval: + description: Maximum interval between event reports. + type: integer + minimum: 1 + maximum: 86400 + + SamplingInterval: + description: Maximum time interval between consecutive evaluations by a UE of a trigger event. + type: integer + minimum: 1 + maximum: 3600 + + ReportingDuration: + description: Maximum duration of event reporting. + type: integer + minimum: 1 + maximum: 8640000 + + LinearDistance: + description: Minimum straight line distance moved by a UE to trigger a motion event report. + type: integer + minimum: 1 + maximum: 10000 + + LMFIdentification: + description: LMF identification. + type: string + + EventReportCounter: + description: Number of event reports received from the target UE. + type: integer + minimum: 1 + maximum: 8640000 + + EventReportDuration: + description: Duration of event reporting. + type: integer + minimum: 1 + maximum: 8640000 + + UePositioningCapabilities: + description: Positioning capabilities supported by the UE. A string encoding the + "ProvideCapabilities-r9-IEs" IE as specified in clause 6.3 of 3GPP TS 37.355 (start from octet 1). + type: string + format: byte +``` + +``` +# +# ENUMS +# +ExternalClientType: + description: Indicates types of External Clients. + anyOf: + - type: string + enum: + - EMERGENCY_SERVICES + - VALUE_ADDED_SERVICES + - PLMN_OPERATOR_SERVICES + - LAWFUL_INTERCEPT_SERVICES + - PLMN_OPERATOR_BROADCAST_SERVICES + - PLMN_OPERATOR_OM + - PLMN_OPERATOR_ANONYMOUS_STATISTICS + - PLMN_OPERATOR_TARGET_MS_SERVICE_SUPPORT + - type: string + +SupportedGADShapes: + description: Indicates supported GAD shapes. + anyOf: + - type: string + enum: + - POINT + - POINT_UNCERTAINTY_CIRCLE + - POINT_UNCERTAINTY_ELLIPSE + - POLYGON + - POINT_ALTITUDE + - POINT_ALTITUDE_UNCERTAINTY + - ELLIPSOID_ARC + - LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE + - LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID + - RANGE_DIRECTION + - RELATIVE_2D_LOCATION_UNCERTAINTY_ELLIPSE + - RELATIVE_3D_LOCATION_UNCERTAINTY_ELLIPSOID + - type: string + +ResponseTime: + description: Indicates acceptable delay of location request. + anyOf: + - type: string + enum: + - LOW_DELAY + - DELAY_TOLERANT + - NO_DELAY + - type: string + +PositioningMethod: + description: Indicates supported positioning methods. + anyOf: + - type: string + enum: + - CELLID + - ECID + - OTDOA + - BAROMETRIC_PRESSURE + - WLAN + - BLUETOOTH + - MBS + - MOTION_SENSOR + - DL_TDOA + - DL_AOD + - MULTI-RTT + - NR_ECID + - UL_TDOA + - UL_AOA + - NETWORK_SPECIFIC + - type: string + +PositioningMode: + description: Indicates supported modes used for positioning method. + anyOf: + - type: string + enum: + - UE_BASED + - UE_ASSISTED + - CONVENTIONAL + - type: string +``` + +GnssId: +description: Global Navigation Satellite System (GNSS) ID. +anyOf: +- type: string +enum: +- GPS +- GALILEO +- SBAS +- MODERNIZED\_GPS +- QZSS +- GLONASS +- BDS +- NAVIC +- type: string + +Usage: +description: Indicates usage made of the location measurement. +anyOf: +- type: string +enum: +- UNSUCCESS +- SUCCESS\_RESULTS\_NOT\_USED +- SUCCESS\_RESULTS\_USED\_TO\_VERIFY\_LOCATION +- SUCCESS\_RESULTS\_USED\_TO\_GENERATE\_LOCATION +- SUCCESS\_METHOD\_NOT\_DETERMINED +- type: string + +LcsPriority: +description: Indicates priority of the LCS client. +anyOf: +- type: string +enum: +- HIGHEST\_PRIORITY +- NORMAL\_PRIORITY +- type: string + +VelocityRequested: +description: Indicates velocity requirement. +anyOf: +- type: string +enum: +- VELOCITY\_IS\_NOT\_REQUESTED +- VELOCITY\_IS\_REQUESTED +- type: string + +AccuracyFulfilmentIndicator: +description: Indicates fulfilment of requested accuracy. +anyOf: +- type: string +enum: +- REQUESTED\_ACCURACY\_FULFILLED +- REQUESTED\_ACCURACY\_NOT\_FULFILLED +- type: string + +VerticalDirection: +description: Indicates direction of vertical speed. +type: string +enum: +- UPWARD +- DOWNWARD + +LdrType: +description: Indicates LDR types. +anyOf: +- type: string +enum: +- UE\_AVAILABLE +- PERIODIC +- ENTERING\_INTO\_AREA +- LEAVING\_FROM\_AREA +- BEING\_INSIDE\_AREA +- MOTION +- type: string + +ReportingAreaType: +description: Indicates type of event reporting area. +anyOf: + +- type: string + - enum: + - EPS\_TRACKING\_AREA\_IDENTITY + - E-UTRAN\_CELL\_GLOBAL\_IDENTIFICATION + - 5GS\_TRACKING\_AREA\_IDENTITY + - NR\_CELL\_GLOBAL\_IDENTITY +- type: string + +OccurrenceInfo: + +description: Specifies occurrence of event reporting. + +anyOf: + +- type: string + - enum: + - ONE\_TIME\_EVENT + - MULTIPLE\_TIME\_EVENT +- type: string + +ReportingAccessType: + +description: Specifies access types of event reporting. + +anyOf: + +- type: string + - enum: + - NR + - EUTRA\_CONNECTED\_TO\_5GC + - NON\_3GPP\_CONNECTED\_TO\_5GC + - NR\_LEO + - NR\_MEO + - NR\_GEO + - NR\_OTHER\_SAT + - EUTRA\_CONNECTED\_TO\_EPC +- type: string + +EventClass: + +description: Specifies event classes. + +anyOf: + +- type: string + - enum: + - SUPPLEMENTARY\_SERVICES +- type: string + +ReportedEventType: + +description: Specifies type of event reporting. + +anyOf: + +- type: string + - enum: + - PERIODIC\_EVENT + - ENTERING\_AREA\_EVENT + - LEAVING\_AREA\_EVENT + - BEING\_INSIDE\_AREA\_EVENT + - MOTION\_EVENT + - MAXIMUM\_INTERVAL\_EXPIRATION\_EVENT + - LOCATION\_CANCELLATION\_EVENT + - INTERMEDIATE\_EVENT + - DIRECT\_REPORT\_EVENT + - CUMULATIVE\_EVENT\_REPORT +- type: string + +TerminationCause: + +description: Specifies causes of event reporting termination. + +anyOf: + +- type: string + - enum: + - TERMINATION\_BY\_UE + - TERMINATION\_BY\_NETWORK + - NORMAL\_TERMINATION +- type: string + +LcsQoSClass: + +description: Specifies LCS QoS class. + +anyOf: + +- type: string + - enum: + - BEST\_EFFORT + - ASSURED + - MULTIPLE\_QOS +- type: string + +UeLocationServiceInd: + +description: Specifies location service types requested by UE. +anyOf: +- type: string +enum: +- LOCATION\_ESTIMATE +- LOCATION\_ASSISTANCE\_DATA +- type: string + +IndoorOutdoorInd: +description: Specifies UE location indoor or outdoor. +anyOf: +- type: string +enum: +- INDOOR +- OUTDOOR +- type: string + +FixType: +description: Specifies the positioning fix type. +anyOf: +- type: string +enum: +- CARRIER\_PHASE\_FLOAT +- CARRIER\_PHASE\_FIX +- type: string + +LosNlosMeasureInd: +description: Specifies LOS measurement or NLOS measurement. +anyOf: +- type: string +enum: +- LOS +- NLOS +- type: string + +UpConnectionStatus: +description: UP Connection Status. +anyOf: +- type: string +enum: +- ESTABLISHED +- RELEASED +- MOVE +- type: string + +RangingSlResult: +description: Specifies the type of result requested for ranging and sidelink positioning. +anyOf: +- type: string +enum: +- ABSOLUTE\_LOCATION +- RELATIVE\_LOCATION +- RANGING\_DIRECTION +- RANGING +- DIRECTION +- VELOCITY +- RELATIVE\_VELOCITY +- type: string + +RelatedUEType: +description: Specifies the different roles of UE for ranging and sidelink positioning service. +anyOf: +- type: string +enum: +- LOCATED\_UE +- REFERENCE\_UE +- type: string + +LcsUpConnectionInd: +description: LCS UP Connection Indication. +anyOf: +- type: string +enum: +- TERMINATION +- SETUP +- type: string + +UeUpPositioningCapabilities: + +``` +description: User plane positioning capabilities supported by the UE. +anyOf: + - type: string + enum: + - LCS-UPP + - SUPL + - type: string +``` + +--- + +## A.3 Nlmf\_Broadcast API + +openapi: 3.0.0 + +``` +info: + version: '1.2.0-alpha.1' + title: 'LMF Broadcast' + description: | + LMF Broadcast Service. + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +``` + +``` +externalDocs: + description: 3GPP TS 29.572 V18.0.0; 5G System; Location Management Services; Stage 3 + url: 'https://www.3gpp.org/ftp/Specs/archive/29_series/29.572/' +``` + +``` +servers: + - url: '{apiRoot}/nlmf-broadcast/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501 +``` + +``` +paths: + /cipher-key-data: + post: + summary: Request ciphering key data + operationId: CipheringKeyData + tags: + - Request Ciphering Key Data + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Cipher requestData' + required: true + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CipherResponseData' + '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: + CipheringKeyData: + '{ $request.body#/amfCallBackURI }': + post: + requestBody: + description: Ciphering Key Data Notification + content: + application/json: + schema: + $ref: '#/components/schemas/CipheringKeyInfo' + responses: + '200': + description: Expected response to a valid request + content: + application/json: + schema: + $ref: '#/components/schemas/CipheringKeyResponse' + '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: + schemas: +# +# COMPLEX TYPES +# + CipheringKeyInfo: + description: Information within Ciphering Key Data Notification request. + type: object + required: + - cipheringData + properties: + cipheringData: + type: array + items: + $ref: '#/components/schemas/CipheringDataSet' + minItems: 1 + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + + CipheringKeyResponse: + description: Information within Ciphering Key Data Notification Response. + +``` + +``` +type: object +properties: + cipheringDataReport: + type: array + items: + $ref: '#/components/schemas/CipheringSetReport' + minItems: 1 + +CipheringDataSet: + description: Represents a Ciphering Data Set. + type: object + required: + - cipheringSetID + - cipheringKey + - c0 + - validityStartTime + - validityDuration + properties: + cipheringSetID: + $ref: '#/components/schemas/CipheringSetID' + cipheringKey: + $ref: '#/components/schemas/CipheringKey' + c0: + $ref: '#/components/schemas/C0' + ltePossSibTypes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + nrPossSibTypes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + validityStartTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + validityDuration: + $ref: '#/components/schemas/ValidityDuration' + tailList: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + +CipheringSetReport: + description: Represents a report of Ciphering Data Set storage. + type: object + required: + - cipheringSetID + - storageOutcome + properties: + cipheringSetID: + $ref: '#/components/schemas/CipheringSetID' + storageOutcome: + $ref: '#/components/schemas/StorageOutcome' + +Cipher requestData: + description: Information within Ciphering Key Data request. + type: object + required: + - amfCallBackURI + properties: + amfCallBackURI: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + supportedFeatures: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + +CipherResponseData: + description: Information within Ciphering Key Data Response. + type: object + required: + - dataAvailability + properties: + dataAvailability: + $ref: '#/components/schemas/DataAvailability' + +# +# +# SIMPLE TYPES +# + +CipheringSetID: + description: Ciphering Data Set Identifier. + type: integer + minimum: 0 + maximum: 65535 + +CipheringKey: + description: Ciphering Key. +``` + +format: byte +type: string + +C0: +description: First component of the initial ciphering counter. +format: byte +type: string + +ValidityDuration: +description: Validity Duration of the Ciphering Data Set. +type: integer +minimum: 1 +maximum: 65535 + +# + +# ENUMS + +# + +StorageOutcome: +description: Indicates the result of Ciphering Data Set storage. +anyOf: +- type: string +enum: +- STORAGE\_SUCCESSFUL +- STORAGE\_FAILED + +DataAvailability: +description: Indicates availability of ciphering key data at an LMF. +anyOf: +- type: string +enum: +- CIPHERING\_KEY\_DATA\_AVAILABLE +- CIPHERING\_KEY\_DATA\_NOT\_AVAILABLE + +--- + +## Annex B (informative): Change history + +| Date | Meeting | TDoc | CR | Rev | Cat | Subject/Comment | New version | +|---------|---------|-----------|------|-----|-----|----------------------------------------------------------------------------------------------------------------------------------|-------------| +| 2018-01 | CT4#82 | | | | | TS Skeleton agreed in CT4#82 | 0.0.0 | +| 2018-01 | CT4#82 | C4-181398 | | | | Initial draft (C4-181119)
Incorporation of agreed pCRs from CT4#82: C4-181121, C4-181233, C4-181234 | 0.1.0 | +| 2018-03 | CT4#83 | C4-182444 | | | | Incorporation of agreed pCRs from CT4#83: C4-182181, C4-182427 | 0.2.0 | +| 2018-03 | CT#79 | CP-180034 | | | | Presented for information | 1.0.0 | +| 2018-04 | CT4#84 | C4-183524 | | | | Incorporation of agreed pCRs from CT4#84: C4-183184, C4-183363, C4-183510 | 1.1.0 | +| 2018-05 | CT4#85 | C4-184640 | | | | Incorporation of agreed pCRs from CT4#85: C4-184195, C4-184197, C4-184198, C4-184199, C4-184202, C4-184443, C4-184446, C4-184547 | 1.2.0 | +| 2018-06 | CT#80 | CP-181111 | | | | Presented for approval | 2.0.0 | +| 2018-06 | CT#80 | | | | | Approved in CT#80 | 15.0.0 | +| 2018-09 | CT#81 | CP-182066 | 0002 | 2 | | Error Cases | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0003 | - | | Custom Headers | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0004 | - | | Overall Clean-up | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0005 | - | | Description of Structured data types | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0006 | 1 | | Resource structure presentation | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0007 | 1 | | LMF servers clause in OpenAPI | 15.1.0 | +| 2018-09 | CT#81 | CP-182066 | 0008 | - | | API Version Update | 15.1.0 | +| 2018-12 | CT#82 | CP-183025 | 0010 | 1 | F | Cardinality | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0011 | - | F | APIRoot Clarification | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0012 | - | F | AMF Id | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0013 | - | F | Barometric Pressure in Location Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0014 | 1 | F | Clarify Serving Cell in Input Data | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0015 | 1 | F | Oauth2 Corrections | 15.2.0 | +| 2018-12 | CT#82 | CP-183025 | 0016 | - | F | API Version | 15.2.0 | +| 2018-12 | CT#82 | CP-183179 | 0017 | - | F | ExternalDocs Update | 15.2.0 | +| 2019-03 | CT#83 | CP-190030 | 0018 | 1 | F | OpenAPI Corrections | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0019 | 1 | F | Application Errors | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0020 | 1 | F | Essential Correction to InnerRadius | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0021 | 1 | F | Mandatory Response Codes | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0022 | 1 | F | Essential correction to OpenAPI definition of GeographicArea | 15.3.0 | +| 2019-03 | CT#83 | CP-190030 | 0023 | - | F | API version update | 15.3.0 | +| 2019-06 | CT#84 | CP-191042 | 0024 | 2 | F | UE Capabilities | 15.4.0 | +| 2019-06 | CT#84 | CP-191042 | 0025 | 2 | F | Storage of OpenAPI specification files | 15.4.0 | +| 2019-06 | CT#84 | CP-191042 | 0027 | 1 | F | Copyright Note in OpenAPI Spec | 15.4.0 | +| 2019-06 | CT#84 | CP-191042 | 0028 | 1 | F | Major API version | 15.4.0 | +| 2019-06 | CT#84 | CP-191042 | 0030 | - | F | Open API Version | 15.4.0 | +| 2019-09 | CT#85 | CP-192113 | 0031 | 1 | F | Missing attribute FLR in Civic Address | 16.0.0 | +| 2019-09 | CT#85 | CP-192192 | 0033 | 2 | B | LMF service operations for a deferred 5GC-MT-LR | 16.0.0 | +| 2019-09 | CT#85 | CP-192192 | 0034 | 1 | B | LMF service operations for a commercial 5GC-MT-LR | 16.0.0 | +| 2019-09 | CT#85 | CP-192192 | 0035 | - | F | High Accuracy Support | 16.0.0 | +| 2019-09 | CT#85 | CP-192113 | 0037 | 1 | D | Correct type Polygon | 16.0.0 | +| 2019-09 | CT#85 | CP-192120 | 0039 | - | F | 3GPP TS 29.572 API version update | 16.0.0 | +| 2019-12 | CT#86 | CP-193033 | 0041 | 1 | A | Motion Sensor Position Method | 16.1.0 | +| 2019-12 | CT#86 | CP-193165 | 0042 | 3 | B | Addition of the LMF Broadcast Service Operations | 16.1.0 | +| 2019-12 | CT#86 | CP-193055 | 0043 | 1 | B | LCS QoS Class | 16.1.0 | +| 2019-12 | CT#86 | CP-193036 | 0045 | 1 | F | ExternalDoc Clause | 16.1.0 | +| 2019-12 | CT#86 | CP-193036 | 0046 | 1 | F | ProblemDetails Optional in Error Response | 16.1.0 | +| 2019-12 | CT#86 | CP-193044 | 0048 | - | F | 3GPP TS 29.572 API version update | 16.1.0 | +| 2020-03 | CT#87 | CP-200039 | 0049 | 2 | F | Add Corresponding API descriptions in clause 5.1 | 16.2.0 | +| 2020-03 | CT#87 | CP-200039 | 0050 | 2 | D | Editorial corrections | 16.2.0 | +| 2020-03 | CT#87 | CP-200039 | 0051 | 1 | F | Correction - formatting consistency | 16.2.0 | +| 2020-03 | CT#87 | CP-200018 | 0052 | | B | Connectivity state per access type | 16.2.0 | +| 2020-03 | CT#87 | CP-200018 | 0053 | | B | Primary Cell in the Secondary RAN node | 16.2.0 | +| 2020-03 | CT#87 | CP-200052 | 0055 | | F | 3GPP TS 29.572 Rel16 API External doc update | 16.2.0 | +| 2020-03 | CT#87 | CP-200180 | 0054 | 4 | B | Request Type and embedded LPP message | 16.2.0 | +| 2020-06 | CT#88e | CP-201060 | 0056 | 1 | F | Add a new Notifications Overview Table | 16.3.0 | +| 2020-06 | CT#88e | CP-201060 | 0057 | 1 | F | Add custom operation Name | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0058 | | F | Location Context Transfer | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0059 | 1 | B | Network Specific Positioning Methods | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0060 | | B | Positioning Methods Support | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0061 | 2 | F | Storage of YAML files in ETSI Forge | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0062 | 1 | F | Resolve Editor Notes | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0063 | 1 | F | LDRreference | 16.3.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|------------------------------------------------------------------------------------------|--------| +| 2020-06 | CT#88e | CP-201032 | 0065 | 1 | F | Resolution of EN on NR positioning SIBs | 16.3.0 | +| 2020-06 | CT#88e | CP-201032 | 0068 | 1 | F | Adding ResponseTime enumeration value | 16.3.0 | +| 2020-06 | CT#88e | CP-201060 | 0069 | | F | Missing Descriptions | 16.3.0 | +| 2020-06 | CT#88e | CP-201073 | 0070 | | F | 29.572 Rel-16 API version and External doc update | 16.3.0 | +| 2020-09 | CT#89e | CP-202112 | 0071 | 1 | F | Optionality of ProblemDetails in TS29.572 cleanup | 16.4.0 | +| 2020-09 | CT#89e | CP-202112 | 0073 | 1 | F | Adding missing navigation satellite systems for positioning | 16.4.0 | +| 2020-09 | CT#89e | CP-202112 | 0074 | 1 | F | Including VGMLC address towards LMF when requesting LMF's Location service | 16.4.0 | +| 2020-09 | CT#89e | CP-202112 | 0075 | 1 | F | Corrections on EventNotify service operation | 16.4.0 | +| 2020-09 | CT#89e | CP-202043 | 0077 | 1 | F | Correct mismatch on GeographicArea between table and yaml | 16.4.0 | +| 2020-09 | CT#89e | CP-202096 | 0078 | - | F | 29.572 Rel-16 API version and External doc update | 16.4.0 | +| 2020-12 | CT#90e | CP-203050 | 0080 | 1 | F | Essential corrections in clause 5.2.2.4 CancelLocation | 16.5.0 | +| 2020-12 | CT#90e | CP-203050 | 0081 | 1 | F | Indication of control plane CLoT 5GS optimization in LocationContextTransfer | 16.5.0 | +| 2020-12 | CT#90e | CP-203035 | 0082 | 1 | F | YAML files in 3GPP Forge | 16.5.0 | +| 2020-12 | CT#90e | CP-203036 | 0085 | 1 | F | 29.572 Rel-16 API version and External doc update | 16.5.0 | +| 2021-03 | CT#91e | CP-210041 | 0087 | - | F | Missing PIDL-LO elements in Location Information | 17.0.0 | +| 2021-03 | CT#91e | CP-210037 | 0088 | 1 | F | HTTP 3xx redirection | 17.0.0 | +| 2021-03 | CT#91e | CP-210034 | 0089 | - | F | Reference change | 17.0.0 | +| 2021-03 | CT#91e | CP-210054 | 0091 | - | F | 29.572 Rel-16 API version and External doc update | 17.0.0 | +| 2021-06 | CT#92e | CP-211055 | 0092 | 1 | F | Resolving Warning in Nlmf_BroadCast API | 17.1.0 | +| 2021-06 | CT#92e | CP-211055 | 0093 | | F | Resolving Warning in Nlmf_Location API | 17.1.0 | +| 2021-06 | CT#92e | CP-211026 | 0094 | 1 | B | Add List of Assistance Data Types for MO-LR | 17.1.0 | +| 2021-06 | CT#92e | CP-211026 | 0095 | 3 | B | Add Local Coordinates | 17.1.0 | +| 2021-06 | CT#92e | CP-211051 | 0096 | | F | OpenAPI Reference | 17.1.0 | +| 2021-06 | CT#92e | CP-211059 | 0098 | | A | 3xx description correction for SCP | 17.1.0 | +| 2021-06 | CT#92e | CP-211059 | 0102 | 1 | A | Redirect Response | 17.1.0 | +| 2021-06 | CT#92e | CP-211050 | 0103 | | F | 29.572 Rel-17 API version and External doc update | 17.1.0 | +| 2021-09 | CT#93e | CP-212034 | 0105 | 1 | B | Add UE Positioning Capabilities | 17.2.0 | +| 2021-09 | CT#93e | CP-212034 | 0108 | 2 | B | Support for Area Decision of Satellite Access | 17.2.0 | +| 2021-09 | CT#93e | CP-212034 | 0109 | 1 | B | LMF Parameters Support for non-3GPP Access | 17.2.0 | +| 2021-09 | CT#93e | CP-212064 | 0111 | | A | Encoding of binary attributes in JSON objects | 17.2.0 | +| 2021-09 | CT#93e | CP-212034 | 0114 | 1 | B | Multiple QoS Class | 17.2.0 | +| 2021-09 | CT#93e | CP-212059 | 0115 | | F | 29.572 Rel-17 API version and External doc update | 17.2.0 | +| 2021-12 | CT#94e | CP-213096 | 0118 | 1 | B | Multiple LPP messages | 17.3.0 | +| 2021-12 | CT#94e | CP-213096 | 0119 | 1 | B | Higher Resolution Timestamp for Location Estimates | 17.3.0 | +| 2021-12 | CT#94e | CP-213096 | 0120 | | F | UE Positioning Capabilities Data Type | 17.3.0 | +| 2021-12 | CT#94e | CP-213096 | 0121 | 1 | B | Update allowed access type for event report | 17.3.0 | +| 2021-12 | CT#94e | CP-213118 | 0122 | | F | Resolve OpenAPI Warnings | 17.3.0 | +| 2021-12 | CT#94e | CP-213120 | 0123 | | F | 307/308 redirection | 17.3.0 | +| 2021-12 | CT#94e | CP-213121 | 0124 | | F | 29.572 Rel-17 API version and External doc update | 17.3.0 | +| 2022-03 | CT#95e | CP-220034 | 0128 | | F | Corrections on the RelativeCartesianLocation | 17.4.0 | +| 2022-03 | CT#95e | CP-220227 | 0130 | 1 | A | Corrections on attributes | 17.4.0 | +| 2022-03 | CT#95e | CP-220090 | 0131 | | F | Update incorrect table number | 17.4.0 | +| 2022-03 | CT#95e | CP-220217 | 0133 | | F | 29.572 Rel-17 API version and External doc update | 17.4.0 | +| 2022-06 | CT#96 | CP-221022 | 0135 | 1 | B | Schedule location time for LMF | 17.5.0 | +| 2022-06 | CT#96 | CP-221022 | 0136 | | F | Update the title of RelativeCartesianLocation | 17.5.0 | +| 2022-06 | CT#96 | CP-221051 | 0138 | | F | 29.572 Rel-17 API version and External doc update | 17.5.0 | +| 2022-09 | CT#97 | CP-222030 | 0139 | 1 | F | Alignment on the service name used with template | 17.6.0 | +| 2022-09 | CT#97 | CP-222036 | 0140 | 1 | F | Indication of Network Assisted Positioning method | 17.6.0 | +| 2022-09 | CT#97 | CP-222058 | 0141 | | F | 29.572 Rel-17 API version and External doc update | 17.6.0 | +| 2022-12 | CT#98 | CP-223028 | 0142 | 1 | F | Missing mandatory status codes in OpenAPI | 18.0.0 | +| 2022-12 | CT#98 | CP-223055 | 0143 | 1 | F | Correction on country verification for satellite access | 18.0.0 | +| 2022-12 | CT#98 | CP-223064 | 0146 | 1 | F | Boolean type IEs definition correction | 18.0.0 | +| 2022-12 | CT#98 | CP-223033 | 0147 | | F | 29.572 Rel-18 API version and External doc update | 18.0.0 | +| 2023-03 | CT#99 | CP-230032 | 0153 | 2 | B | Support of Event Report Allowed Area | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0154 | 2 | B | Support of UE Unaware Positioning | 18.1.0 | +| 2023-03 | CT#99 | CP-230324 | 0155 | 3 | B | Multiple location report for MT-LR Immediate Location Request for the regulatory service | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0158 | 2 | B | Location service in PNI-NPN with signalling optimisation | 18.1.0 | +| 2023-03 | CT#99 | CP-230032 | 0159 | 2 | B | Support of low power and high accuracy positioning | 18.1.0 | +| 2023-03 | CT#99 | CP-230071 | 0161 | | F | 29.572 Rel-18 API version and External doc update | 18.1.0 | +| 2023-06 | CT#100 | CP-231028 | 0160 | 4 | F | Location header description | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0164 | 2 | B | NWDAF assisted LMF positioning method determination | 18.2.0 | +| 2023-06 | CT#100 | CP-231075 | 0166 | 1 | A | Missing finer periodicities than 1s and an infinite reporting amount | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0168 | 1 | B | Support of UE User Plane Positioning Capability | 18.2.0 | +| 2023-06 | CT#100 | CP-231026 | 0172 | | B | OAuth2 scopes in the Nlmf_Location API | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0175 | 3 | B | Clarification of the location QoS mapping | 18.2.0 | +| 2023-06 | CT#100 | CP-231031 | 0176 | 2 | B | Add reporting indication | 18.2.0 | +| 2023-06 | CT#100 | CP-231055 | 0177 | 1 | B | Support of location service involving Mobile Base Station Relay | 18.2.0 | +| 2023-06 | CT#100 | CP-231070 | 0180 | | F | 29.572 Rel-18 API version and External doc update | 18.2.0 | + +| | | | | | | | | +|---------|--------|-----------|------|---|---|-----------------------------------------------------------------------------|--------| +| 2023-09 | CT#101 | CP-232035 | 0183 | 1 | F | Correction on Reporting Indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232063 | 0185 | 1 | A | Missed HA GNSS Metrics Support over SBI | 18.3.0 | +| 2023-09 | CT#101 | CP-232154 | 0186 | 2 | B | The service operation of Nlmf_Location_MeasurementData | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 0188 | 2 | B | Support on NLOS/LOS measurement indication | 18.3.0 | +| 2023-09 | CT#101 | CP-232155 | 0189 | 3 | B | Nlmf_Location_UPNotify service operation | 18.3.0 | +| 2023-09 | CT#101 | CP-232035 | 0190 | 2 | B | Nlmf_Location_UPSubscribe service operation | 18.3.0 | +| 2023-09 | CT#101 | CP-232062 | 0192 | 1 | A | Add GNSS integrity requirement | 18.3.0 | +| 2023-09 | CT#101 | CP-232178 | 0193 | 3 | B | Update on LMF service for MT procedures for ranging_SL | 18.3.0 | +| 2023-09 | CT#101 | CP-232060 | 0194 | | F | 29.572 Rel-18 API version and External doc update | 18.3.0 | +| 2023-12 | CT#102 | CP-233037 | 0182 | 3 | B | Periodic or triggered location events via user plane to an LCS Client or AF | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0196 | 1 | F | Addition of missing interface between LMF and GMLC | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0197 | 1 | B | Add the Nlmf_Location_UPConfig | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0198 | | F | Align with the SBI template | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0199 | | F | Correction on the description of scheduledLocTime | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0201 | | B | Update on UpNotifyData | 18.4.0 | +| 2023-12 | CT#102 | CP-233029 | 0203 | 1 | F | HTTP RFCs obsoleted by IETF RFC 9110, 9111 and 9113 | 18.4.0 | +| 2023-12 | CT#102 | CP-233294 | 0204 | 4 | B | Update on LMF service for ranging_SL | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0205 | 1 | F | Reporting Indication Definition Alignment to Stage 2 | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0206 | 2 | B | Multiple QoS for Deferred Location Service Continuation from 5GS to EPS | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0207 | 1 | B | Allowed Reporting Access Type for EUTRAN Connected to EPC | 18.4.0 | +| 2023-12 | CT#102 | CP-233030 | 0208 | | F | ProblemDetails RFC 7807 obsoleted by 9457 | 18.4.0 | +| 2023-12 | CT#102 | CP-233052 | 0209 | 1 | B | Addition of additional ULI of the MBSR UE | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0210 | | F | Correction on PRU Location Measurements | 18.4.0 | +| 2023-12 | CT#102 | CP-233037 | 0211 | 2 | B | Update user plane positioning capabilities | 18.4.0 | +| 2023-12 | CT#102 | CP-233031 | 0214 | | F | Correction on OAuth Scopes Names | 18.4.0 | +| 2023-12 | CT#102 | CP-233060 | 0215 | 3 | F | 29.572 Rel-18 API version and External doc update | 18.4.0 | \ No newline at end of file diff --git a/marked/Rel-18/29_series/29573/raw.md b/marked/Rel-18/29_series/29573/raw.md new file mode 100644 index 0000000000000000000000000000000000000000..4c542cb3bf39e5226578f4e811a21b63d8a2039b --- /dev/null +++ b/marked/Rel-18/29_series/29573/raw.md @@ -0,0 +1,5134 @@ + + +# 3GPP TS 29.573 V18.5.0 (2023-12) + +*Technical Specification* + +## **3rd Generation Partnership Project; Technical Specification Group Core Network and Terminals; 5G System; Public Land Mobile Network (PLMN) Interconnection; Stage 3 (Release 18)** + +![5G ADVANCED logo](64662465bba247703fdec49c8f3309f9_img.jpg) + +The logo for 5G Advanced, featuring a large '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 + +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 ..... | 8 | +| 1 Scope..... | 9 | +| 2 References..... | 9 | +| 3 Definitions and abbreviations ..... | 10 | +| 3.1 Definitions..... | 10 | +| 3.2 Abbreviations ..... | 10 | +| 4 General Description ..... | 11 | +| 4.1 Introduction ..... | 11 | +| 4.2 N32 Interface..... | 11 | +| 4.2.1 General ..... | 11 | +| 4.2.2 N32-c Interface ..... | 11 | +| 4.2.3 N32-f Interface ..... | 12 | +| 4.3 Protocol Stack ..... | 12 | +| 4.3.1 General ..... | 12 | +| 4.3.2 HTTP/2 Protocol ..... | 13 | +| 4.3.2.1 General..... | 13 | +| 4.3.2.2 HTTP standard headers..... | 13 | +| 4.3.2.3 HTTP custom headers..... | 14 | +| 4.3.2.4 HTTP/2 connection management ..... | 14 | +| 4.3.3 Transport Protocol ..... | 14 | +| 4.3.4 Serialization Protocol ..... | 15 | +| 5 N32 Procedures ..... | 15 | +| 5.1 Introduction ..... | 15 | +| 5.2 N32 Handshake Procedures (N32-c)..... | 15 | +| 5.2.1 General ..... | 15 | +| 5.2.2 Security Capability Negotiation Procedure ..... | 15 | +| 5.2.3 Parameter Exchange Procedure ..... | 18 | +| 5.2.3.1 General..... | 18 | +| 5.2.3.2 Parameter Exchange Procedure for Cipher Suite Negotiation..... | 18 | +| 5.2.3.3 Parameter Exchange Procedure for Protection Policy Exchange ..... | 19 | +| 5.2.3.4 Parameter Exchange Procedure for Security Information list Exchange..... | 21 | +| 5.2.4 N32-f Context Termination Procedure ..... | 22 | +| 5.2.5 N32-f Error Reporting Procedure ..... | 23 | +| 5.3 Message Forwarding Procedure on N32 (N32-f)..... | 24 | +| 5.3.1 Introduction ..... | 24 | +| 5.3.2 Use of Application Layer Security ..... | 24 | +| 5.3.2.1 General..... | 24 | +| 5.3.2.2 Protection Policy Lookup ..... | 25 | +| 5.3.2.3 Message Reformatting ..... | 26 | +| 5.3.2.4 Message Forwarding to Peer SEPP ..... | 28 | +| 5.3.2.5 JOSE Protected Forwarding Options ..... | 29 | +| 5.3.3 Message Forwarding to Peer SEPP when TLS is used ..... | 29 | +| 5.3.4 Void ..... | 30 | +| 5.4 Nsepp_Telescopic_FQDN_Mapping Service..... | 30 | +| 5.4.1 General ..... | 30 | +| 5.4.2 Foreign FQDN to Telescopic FQDN Mapping Procedure..... | 30 | +| 5.4.3 Telescopic FQDN to Foreign FQDN Mapping Procedure..... | 30 | +| 5.5 Support of Roaming Intermediaries ..... | 31 | +| 5.5.1 General ..... | 31 | +| 5.5.2 N32-c connection establishment via Roaming Intermediaries ..... | 31 | +| 5.5.2.1 N32-c connection establishment using HTTP CONNECT ..... | 31 | +| 5.5.2.2 Error messages originated by Roaming Intermediaries over the N32-c interface ..... | 31 | +| 5.5.2.2.1 General ..... | 31 | +| 5.5.2.2.2 N32-c connection establishment rejection by Roaming Intermediaries ..... | 32 | + +| | | | +|------------|----------------------------------------------------------------------------------------------------|----| +| 5.5.3 | N32-f messages forwarding or origination via Roaming Intermediaries ..... | 32 | +| 5.5.3.1 | Error messages originated by (or related to) Roaming Intermediaries over the N32-f interface ..... | 32 | +| 5.5.3.1.1 | General ..... | 32 | +| 5.5.3.2 | N32-f related error determined upon receipt of an N32-f request ..... | 34 | +| 5.5.3.2.1 | Error message originated by Roaming Intermediary via N32-f..... | 34 | +| 5.5.3.2.2 | Error message originated by pSEPP on N32-f (and optionally N32-c) ..... | 35 | +| 5.5.3.3 | N32-f related error determined upon receipt of an N32-f response..... | 36 | +| 5.5.3.3.1 | Error message originated by Roaming Intermediary via N32-f..... | 36 | +| 5.5.3.3.2 | Error message formatting by the Roaming Intermediary ..... | 37 | +| 5.5.3.4 | Applicative (i.e. SBI related) error determined upon receipt of an N32-f request ..... | 38 | +| 5.5.3.4.1 | Applicative error originated by Roaming Intermediary via N32-f ..... | 38 | +| 5.5.3.4.2 | Error message formatting by the Roaming Intermediary ..... | 38 | +| 6 | API Definitions ..... | 39 | +| 6.1 | N32 Handshake API..... | 39 | +| 6.1.1 | API URI..... | 39 | +| 6.1.2 | Usage of HTTP..... | 39 | +| 6.1.2.1 | General..... | 39 | +| 6.1.2.2 | HTTP standard headers..... | 40 | +| 6.1.2.2.1 | General ..... | 40 | +| 6.1.2.2.2 | Content type ..... | 40 | +| 6.1.2.3 | HTTP custom headers..... | 40 | +| 6.1.2.3.1 | General ..... | 40 | +| 6.1.3 | Resources..... | 40 | +| 6.1.3.1 | Overview..... | 40 | +| 6.1.4 | Custom Operations without Associated Resources ..... | 40 | +| 6.1.4.1 | Overview..... | 40 | +| 6.1.4.2 | Operation: Security Capability Negotiation ..... | 40 | +| 6.1.4.2.1 | Description ..... | 40 | +| 6.1.4.2.2 | Operation Definition ..... | 41 | +| 6.1.4.3 | Operation: Parameter Exchange ..... | 41 | +| 6.1.4.3.1 | Description ..... | 41 | +| 6.1.4.3.2 | Operation Definition ..... | 42 | +| 6.1.4.4 | Operation: N32-f Context Terminate..... | 42 | +| 6.1.4.4.1 | Description ..... | 42 | +| 6.1.4.4.2 | Operation Definition ..... | 43 | +| 6.1.4.5 | Operation: N32-f Error Reporting ..... | 43 | +| 6.1.4.5.1 | Description ..... | 43 | +| 6.1.4.5.2 | Operation Definition ..... | 43 | +| 6.1.5 | Data Model ..... | 44 | +| 6.1.5.1 | General..... | 44 | +| 6.1.5.2 | Structured data types..... | 44 | +| 6.1.5.2.1 | Introduction ..... | 44 | +| 6.1.5.2.2 | Type: SecNegotiateReqData ..... | 45 | +| 6.1.5.2.3 | Type: SecNegotiateRspData ..... | 46 | +| 6.1.5.2.4 | Type: SecParamExchReqData ..... | 47 | +| 6.1.5.2.5 | Type: SecParamExchRspData..... | 48 | +| 6.1.5.2.6 | Type: ProtectionPolicy..... | 49 | +| 6.1.5.2.7 | Type: ApiMapping..... | 49 | +| 6.1.5.2.8 | Type: IeInfo..... | 50 | +| 6.1.5.2.9 | Type: ApiSignature ..... | 51 | +| 6.1.5.2.10 | Type: N32fContextInfo ..... | 51 | +| 6.1.5.2.11 | Type: N32fErrorInfo ..... | 52 | +| 6.1.5.2.12 | Type: FailedModificationInfo ..... | 53 | +| 6.1.5.2.13 | Type: N32fErrorDetail ..... | 53 | +| 6.1.5.2.14 | Type: CallbackName..... | 53 | +| 6.1.5.2.15 | Type: IpxProviderSecInfo ..... | 53 | +| 6.1.5.2.16 | Type: IntendedN32Purpose..... | 54 | +| 6.1.5.3 | Simple data types and enumerations..... | 54 | +| 6.1.5.3.1 | Introduction ..... | 54 | +| 6.1.5.3.2 | Simple data types ..... | 54 | +| 6.1.5.3.3 | Enumeration: SecurityCapability ..... | 54 | + +| | | | +|------------|------------------------------------------------------|----| +| 6.1.5.3.4 | Enumeration: HttpMethod..... | 54 | +| 6.1.5.3.5 | Enumeration: IeType..... | 55 | +| 6.1.5.3.6 | Enumeration: IeLocation..... | 55 | +| 6.1.5.3.7 | Enumeration: N32fErrorType ..... | 56 | +| 6.1.5.3.8 | Enumeration: FailureReason ..... | 56 | +| 6.1.5.3.9 | Enumeration: N32Purpose ..... | 57 | +| 6.1.5.4 | Binary data..... | 57 | +| 6.1.6 | Error Handling ..... | 57 | +| 6.1.6.1 | General..... | 57 | +| 6.1.6.2 | Protocol Errors ..... | 57 | +| 6.1.6.3 | Application Errors..... | 57 | +| 6.1.7 | Feature Negotiation ..... | 58 | +| 6.1.8 | HTTP redirection..... | 59 | +| 6.2 | JOSE Protected Message Forwarding API on N32..... | 59 | +| 6.2.1 | API URI..... | 59 | +| 6.2.2 | Usage of HTTP..... | 59 | +| 6.2.2.1 | General..... | 59 | +| 6.2.2.2 | HTTP standard headers..... | 60 | +| 6.2.2.2.1 | General ..... | 60 | +| 6.2.2.2.2 | Content type ..... | 60 | +| 6.2.2.2.3 | Accept-Encoding..... | 60 | +| 6.2.2.3 | HTTP custom headers..... | 60 | +| 6.2.2.3.1 | General ..... | 60 | +| 6.2.3 | Resources..... | 60 | +| 6.2.3.1 | Overview..... | 60 | +| 6.2.4 | Custom Operations without associated resources ..... | 60 | +| 6.2.4.1 | Overview..... | 60 | +| 6.2.4.2 | Operation: JOSE Protected Forwarding ..... | 61 | +| 6.2.4.2.1 | Description ..... | 61 | +| 6.2.4.2.2 | Operation Definition ..... | 61 | +| 6.2.4.3 | Operation: JOSE Protected Forwarding Options ..... | 63 | +| 6.2.4.3.1 | Description ..... | 63 | +| 6.2.4.3.2 | Operation Definition ..... | 63 | +| 6.2.5 | Data Model ..... | 64 | +| 6.2.5.1 | General..... | 64 | +| 6.2.5.2 | Structured data types..... | 65 | +| 6.2.5.2.1 | Introduction ..... | 65 | +| 6.2.5.2.2 | Type: N32fReformattedReqMsg..... | 65 | +| 6.2.5.2.3 | Type: N32fReformattedRspMsg..... | 66 | +| 6.2.5.2.4 | Type: DataToIntegrityProtectAndCipherBlock ..... | 66 | +| 6.2.5.2.5 | Type: DataToIntegrityProtectBlock ..... | 67 | +| 6.2.5.2.6 | Type: RequestLine ..... | 67 | +| 6.2.5.2.7 | Type: HttpHeaders..... | 68 | +| 6.2.5.2.8 | Type: HttpPayload..... | 69 | +| 6.2.5.2.9 | Type: MetaData..... | 70 | +| 6.2.5.2.10 | Type: Modifications ..... | 71 | +| 6.2.5.2.11 | Type: FlatJweJson..... | 72 | +| 6.2.5.2.12 | Type: FlatJwsJson ..... | 73 | +| 6.2.5.2.13 | Type: IndexToEncryptedValue ..... | 73 | +| 6.2.5.2.14 | Type: EncodedHttpHeaderValue ..... | 73 | +| 6.2.5.2.15 | Type: ProblemDetailsMsgForwarding ..... | 73 | +| 6.2.5.2.16 | Type: AdditionInfoMsgForwarding ..... | 74 | +| 6.2.5.3 | Simple data types and enumerations..... | 74 | +| 6.2.5.3.1 | Introduction ..... | 74 | +| 6.2.5.3.2 | Simple data types ..... | 74 | +| 6.2.5.3.3 | Void..... | 74 | +| 6.2.5.3.4 | Void..... | 74 | +| 6.2.6 | Error Handling..... | 74 | +| 6.2.6.1 | General..... | 74 | +| 6.2.6.2 | Protocol Errors ..... | 74 | +| 6.2.6.3 | Application Errors..... | 74 | +| 6.3 | Nsepp_Telescopic_FQDN_Mapping API..... | 75 | + +| | | | +|-------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------| +| 6.3.1 | API URI..... | 75 | +| 6.3.2 | Usage of HTTP..... | 76 | +| 6.3.2.1 | General..... | 76 | +| 6.3.2.2 | HTTP standard headers..... | 76 | +| 6.3.2.2.1 | General ..... | 76 | +| 6.3.2.2.2 | Content type ..... | 76 | +| 6.3.2.3 | HTTP custom headers..... | 76 | +| 6.3.2.3.1 | General ..... | 76 | +| 6.3.3 | Resources..... | 76 | +| 6.3.3.1 | Overview..... | 76 | +| 6.3.3.2 | Resource: Mapping..... | 77 | +| 6.3.3.2.1 | Description ..... | 77 | +| 6.3.3.2.2 | Resource Defintion..... | 77 | +| 6.3.3.2.3 | Resource Standard Methods..... | 77 | +| 6.3.4 | Data Model ..... | 78 | +| 6.3.4.1 | General..... | 78 | +| 6.3.4.2 | Structured data types..... | 78 | +| 6.3.4.2.1 | Introduction ..... | 78 | +| 6.3.4.2.2 | Type: TelescopicMapping..... | 79 | +| 6.3.4.3 | Simple data types and enumerations..... | 79 | +| 6.3.4.3.1 | Introduction ..... | 79 | +| 6.3.4.3.2 | Simple data types ..... | 79 | +| 6.3.5 | Error Handling ..... | 79 | +| 6.3.5.1 | General..... | 79 | +| 6.3.5.2 | Protocol Errors ..... | 79 | +| 6.3.5.3 | Application Errors..... | 79 | +| 6.3.6 | Feature Negotiation ..... | 80 | +| 6.3.7 | Security..... | 80 | +| 6.3.7.1 | General..... | 80 | +| Annex A (normative): | OpenAPI Specification..... | 80 | +| A.1 | General..... | 80 | +| A.2 | N32 Handshake API..... | 80 | +| A.3 | JOSE Protected Message Forwarding API on N32-f..... | 88 | +| A.4 | SEPP Telescopic FQDN Mapping API ..... | 92 | +| Annex B (informative): | Examples of N32-f Encoding..... | 94 | +| B.1 | General..... | 94 | +| B.2 | Input Message Containing No Binary Part ..... | 94 | +| B.3 | Input Message Containing Multipart Binary Part ..... | 95 | +| Annex C (informative): | End to end call flows when SEPP is on path..... | 98 | +| C.1 | General..... | 98 | +| C.2 | TLS security between SEPPs..... | 98 | +| C.2.1 | When http URI scheme is used..... | 98 | +| C.2.1.1 | General ..... | 98 | +| C.2.1.2 | Without TLS protection between NF and SEPP and with TLS security without the 3gpp-Sbi-Target-apiRoot header used over N32f..... | 98 | +| C.2.1.3 | Without TLS protection between NF and SEPP and with TLS security with the 3gpp-Sbi-Target-apiRoot header used over N32f..... | 101 | +| C.2.2 | When https URI scheme is used..... | 102 | +| C.2.2.1 | General ..... | 102 | +| C.2.2.2 | With TLS protection between NF and SEPP relying on telescopic FQDN, and TLS security without the 3gpp-Sbi-Target-apiRoot header used over N32f..... | 102 | +| C.2.2.3 | With TLS protection between NF and SEPP relying on 3gpp-Sbi-Target-apiRoot header, and TLS security without the 3gpp-Sbi-Target-apiRoot header used over N32f..... | 106 | + +| | | | +|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|------------| +| C.2.2.4 | With TLS protection between NF and SEPP relying on telescopic FQDN, and TLS security with the 3gpp-Sbi-Target-apiRoot header used over N32f ..... | 109 | +| C.2.2.5 | With TLS protection between NF and SEPP relying on 3gpp-Sbi-Target-apiRoot header, and TLS security with the 3gpp-Sbi-Target-apiRoot header used over N32f..... | 112 | +| C.3 | Application Layer Security between SEPPs ..... | 114 | +| C.3.1 | When http URI scheme is used ..... | 114 | +| C.3.2 | When https URI scheme is used..... | 116 | +| C.3.2.1 | General ..... | 116 | +| C.3.2.2 | With TLS protection between NF and SEPP relying on telescopic FQDN ..... | 117 | +| C.3.2.3 | With TLS protection between NF and SEPP relying on 3gpp-Sbi-Target-apiRoot header ..... | 120 | +| Annex D (informative): | Withdrawn API versions ..... | 124 | +| D.1 | General ..... | 124 | +| D.2 | N32 Handshake API..... | 124 | +| Annex E (informative): | Change history ..... | 126 | + +# 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 PLMN and/or SNPN interconnection Interface. It provides stage 3 protocol definitions and message flows, and specifies the APIs for the procedures on the PLMN interconnection interface (i.e N32). + +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]. + +The stage 2 level N32 procedures are specified in 3GPP TS 33.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 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 33.501: "Security architecture and procedures for 5G system". +- [7] IETF RFC 9113: "HTTP/2". +- [8] IETF RFC 8259: "The JavaScript Object Notation (JSON) Data Interchange Format". +- [9] IETF RFC 9110: "HTTP Semantics". +- [10] Void. +- [11] IETF RFC 793: "Transmission Control Protocol". +- [12] 3GPP TS 29.571: "5G System; Common Data Types for Service Based Interfaces Stage 3". +- [13] IETF RFC 7518: "JSON Web Algorithms (JWA)". + +- [14] IETF RFC 7516: "JSON Web Encryption (JWE)". +- [15] IETF RFC 4648: "The Base16, Base32, and Base64 Data Encodings". +- [16] IETF RFC 7515: "JSON Web Signature (JWS)". +- [17] IETF RFC 6901: "JavaScript Object Notation (JSON) Pointer". +- [18] 3GPP TS 29.510: "Network Function Repository Services; Stage 3". +- [19] 3GPP TS 23.003: "Numbering, addressing and identification". +- [20] 3GPP TR 21.900: "Technical Specification Group working methods". +- [21] IETF RFC 7468: "Textual Encodings of PKIX, PKCS, and CMS Structures". +- [22] IETF RFC 9457: "Problem Details for HTTP APIs". +- [23] IETF RFC 1952: "GZIP file format specification version 4.3". +- [24] Void +- [25] 3GPP TS 29.518: "5G System; Access and Mobility Management Service; Stage 3". +- [26] 3GPP TS 29.503: "5G System; Unified Data Management Services; Stage 3". +- [27] OpenAPI: "OpenAPI Specification Version 3.0.0", . +- [28] 3GPP TS 22.261: "Service requirements for the 5G system; Stage 1". + +# --- 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]. + +**c-SEPP:** The SEPP that is present on the NF service consumer side is called the c-SEPP. + +**p-SEPP:** The SEPP that is present on the NF service producer side is called the p-SEPP. + +**NOTE:** For the purpose of N32-c procedures, the two interacting SEPPs are called "initiating" SEPP and "responding" SEPP. The c-SEPP and p-SEPP terminology is not used in this specification though it is used in 3GPP TS 33.501 [6]. + +**c-IPX:** The IPX on the NF service consumer side. + +**p-IPX:** The IPX of the NF service producer side. + +**N32-c context:** This context is set up at the SEPP after the Security Capability Exchange procedure is finalized. It defines the security capability that is mutually agreed and effective for both the cSEPP and the pSEPP. + +**Roaming Intermediary:** an entity that provides roaming related services (see clause 3.1 of 3GPP TS 33.501 [6]). + +## 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]. + +| | | +|------|---------| +| GZIP | GNU ZIP | +|------|---------| + +| | | +|-------|------------------------------------------| +| IPX | IP Exchange Service | +| JOSE | Javascript Object Signing and Encryption | +| JWT | JSON Web Encryption | +| JWS | JSON Web Signature | +| PRINS | PRotocol for N32 INterconnect Security | +| SEPP | Security and Edge Protection Proxy | +| TLS | Transport Layer Security | +| UPU | UE Parameters Update | + +# 4 General Description + +## 4.1 Introduction + +This clause provides a general description of the interconnect interfaces used between the PLMNs and/or SNPNs for transporting the service based interface message exchanges. + +## 4.2 N32 Interface + +### 4.2.1 General + +The N32 interface is used between SEPPs of different PLMNs for both roaming and PLMN interconnect scenarios. + +The N32 interface may also be used between SEPPs from an SNPN and another SNPN or PLMN, for SNPN interconnect scenarios (e.g. for SNPN connectivity with a Credentials Holder network, see clause 5.30.2.9.3 of 3GPP TS 23.501 [2]). Unless specified otherwise, references to "PLMN" throughout this specification shall be substituted by "SNPN" for a SEPP that is deployed in an SNPN. + +The SEPP that is on the NF service consumer side is called the c-SEPP and the SEPP that is on the NF service producer is called the p-SEPP. The NF service consumer or SCP may be configured with the c-SEPP or discover the c-SEPP by querying the NRF. The NF service producer or SCP may be configured with the p-SEPP or discover the p-SEPP by querying the NRF. + +The N32 interface can be logically considered as 2 separate interfaces as given below. + +- N32-c, a control plane interface between the SEPPs for performing initial handshake and negotiating the parameters to be applied for the actual N32 message forwarding. +- N32-f, a forwarding interface between the SEPPs which is used for forwarding the communication between the NF service consumer and the NF service producer after applying application level security protection or TLS security protection. + +### 4.2.2 N32-c Interface + +The following figure shows the scope of the N32-c interface. + +![Diagram showing the N32-c interface between two SEPPs in different PLMNs.](e58a867750e4ae01604318506b79df7a_img.jpg) + +The diagram illustrates the N32-c interface between two SEPPs. On the left is a box labeled "SEPP in PLMN A" and on the right is a box labeled "SEPP in PLMN B". A double-headed arrow labeled "N32-c" connects the two boxes, indicating a bidirectional control plane interface. + +Diagram showing the N32-c interface between two SEPPs in different PLMNs. + +**Figure 4.2.2-1: N32-c Interface** + +The N32-c interface provides the following functionalities: + +- Initial handshake procedure between the SEPP in PLMN A (called the initiating SEPP) and the SEPP in PLMN B (called the responding SEPP), that involves capability negotiation and parameter exchange as specified in 3GPP TS 33.501 [6]. + +### 4.2.3 N32-f Interface + +The following figures shows the scope of the N32-f interface. + +![Figure 4.2.3-1a: N32-f Interface with TLS security. This diagram shows two boxes labeled 'SEPP in PLMN A' and 'SEPP in PLMN B'. Between them are two dashed boxes labeled 'IPX (PLMN A Side)' and 'IPX (PLMN B Side)'. A solid line labeled 'N32-f' connects the two IPX boxes. Arrows indicate a bidirectional flow of messages between the SEPPs through the IPX providers.](7f17c430b9598e4d748a8041457810b3_img.jpg) + +Figure 4.2.3-1a: N32-f Interface with TLS security. This diagram shows two boxes labeled 'SEPP in PLMN A' and 'SEPP in PLMN B'. Between them are two dashed boxes labeled 'IPX (PLMN A Side)' and 'IPX (PLMN B Side)'. A solid line labeled 'N32-f' connects the two IPX boxes. Arrows indicate a bidirectional flow of messages between the SEPPs through the IPX providers. + +**Figure 4.2.3-1a: N32-f Interface with TLS security** + +![Figure 4.2.3-1b: N32-f Interface with PRINS. This diagram shows two boxes labeled 'SEPP in PLMN A' and 'SEPP in PLMN B'. Between them are two dashed boxes labeled 'IPX (PLMN A Side)' and 'IPX (PLMN B Side)'. The connections between the SEPP and the first IPX, between the two IPX boxes, and between the second IPX and the SEPP are all labeled 'N32-f' with double-headed arrows, indicating that the N32-f interface is used at each hop when PRINS is negotiated.](853f59c89931a666c07903b31d098277_img.jpg) + +Figure 4.2.3-1b: N32-f Interface with PRINS. This diagram shows two boxes labeled 'SEPP in PLMN A' and 'SEPP in PLMN B'. Between them are two dashed boxes labeled 'IPX (PLMN A Side)' and 'IPX (PLMN B Side)'. The connections between the SEPP and the first IPX, between the two IPX boxes, and between the second IPX and the SEPP are all labeled 'N32-f' with double-headed arrows, indicating that the N32-f interface is used at each hop when PRINS is negotiated. + +**Figure 4.2.3-1b: N32-f Interface with PRINS** + +The N32-f interface shall be used to forward the HTTP/2 messages of the NF service producers and the NF service consumers in different PLMN, through the SEPPs of the respective PLMN. + +If TLS is the negotiated security policy between the SEPP, then the N32-f shall involve only the forwarding of the HTTP/2 messages of the NF service producers and the NF service consumers without any reformatting at the SEPPs and/or the IPXs (see figure 4.2.3-1a). + +The application layer security protection functionality of the N32-f is used only if the PProtocol for N32 INterconnect Security (PRINS) is negotiated between the SEPPs using N32-c (see figure 4.2.3-1b). + +The N32-f interface provides the following application layer security protection functionalities: + +- Message protection of the information exchanged between the NF service consumer and the NF service producer across PLMNs by applying application layer security mechanisms as specified in 3GPP TS 33.501 [6]. +- Forwarding of the application layer protected message from a SEPP in one PLMN to a SEPP in another PLMN. Such forwarding may involve IPX providers on path. +- If IPX providers are on the path from SEPP in PLMN A to SEPP in PLMN B, the forwarding on the N32-f interface may involve the insertion of content modification instructions which the receiving SEPP applies after verifying the integrity of such modification instructions. + +## 4.3 Protocol Stack + +### 4.3.1 General + +The protocol stack for the N32 interface is shown below in Figure 4.3.1-1. + +![N32 Protocol Stack diagram showing layers from Application down to L1.](ff0952ef692c9d960ce5f6708bcc9711_img.jpg) + +| | +|----------------------------------------------| +| Application (PRINS may be used for security) | +| HTTP/2 | +| TLS (Conditional) | +| TCP | +| IP | +| L2 | +| L1 | + +N32 Protocol Stack diagram showing layers from Application down to L1. + +Figure 4.3.1-1: N32 Protocol Stack + +The N32 interfaces (N32-c and N32-f) use HTTP/2 protocol (see clause 4.2.2 and 4.2.3, respectively) with JSON (see clause 4.2.4) as the application layer serialization protocol. For the security protection at the transport layer, the SEPPs shall support TLS as specified in clause 13.1.2 of 3GPP TS 33.501 [6]. + +For the N32-f interface, the application layer (i.e the JSON content) encapsulates the complete HTTP/2 message between the NF service consumer and the NF service producer, by transforming the HTTP/2 headers and the body into specific JSON attributes as specified in clause 6.2. For the scenarios when there are IPX entities between SEPPs, see clause 4.3.2 for TLS/PRINS usage. + +### 4.3.2 HTTP/2 Protocol + +#### 4.3.2.1 General + +HTTP/2 as described in IETF RFC 9113 [7] shall be used for N32 interface. + +#### 4.3.2.2 HTTP standard headers + +The HTTP request standard headers and the HTTP response standard headers that shall be supported on the N32 interface are defined in Table 4.2.2.2-1 and in Table 4.2.2.2-2 respectively. + +Table 4.3.2.2-1: Mandatory to support HTTP request standard headers + +| Name | Reference | Description | +|-----------------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Accept | IETF RFC 9110 [9] | This header is used to specify response media types that are acceptable. | +| Accept-Encoding | IETF RFC 9110 [9] | This header may be used to indicate what response content-encodings (e.g gzip) are acceptable in the response. | +| Content-Length | IETF RFC 9110 [10] | This header is used to provide the anticipated size, as a decimal number of octets, for a potential content. | +| Content-Type | IETF RFC 9110 [9] | This header is used to indicate the media type of the associated representation. | +| Via | IETF RFC 9110 [10] | This header is used to indicate the intermediate proxies in the service request path. Please refer to clause 6.10.8 of 3GPP TS 29.500 [4] for encoding of the via header | + +**Table 4.3.2.2-2: Mandatory to support HTTP response standard headers** + +| Name | Reference | Description | +|------------------|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Content-Length | IETF RFC 9110 [10] | This header may be used to provide the anticipated size, as a decimal number of octets, for a potential content. | +| Content-Type | IETF RFC 9110 [9] | This header shall be used to indicate the media type of the associated representation. | +| Content-Encoding | IETF RFC 9110 [9] | This header may be used in some responses to indicate to the HTTP/2 client the content encodings (e.g gzip) applied to the response body beyond those inherent in the media type. | +| Via | IETF RFC 9110 [10] | This header is used to indicate the intermediate proxies in the service response path. Please refer to clause 6.10.8 of 3GPP TS 29.500 [4] for encoding of the via header. | +| Server | IETF RFC 9110 [9] | This header is used to indicate the originator of an HTTP error response. | + +#### 4.3.2.3 HTTP custom headers + +The HTTP custom headers specified in clause 5.2.3 of 3GPP TS 29.500 [4] shall be supported on the N32 interface. + +#### 4.3.2.4 HTTP/2 connection management + +Each SEPP initiates HTTP/2 connections towards its peer SEPP for the following purposes + +- N32-c interface +- N32-f interface + +The scope of the HTTP/2 connection used for the N32-c interface is short-lived. Once the initial handshake is completed the connection is torn down as specified in 3GPP TS 33.501 [6]. The HTTP/2 connection used for N32-c is end to end between the SEPPs and does not involve an IPX to intercept the HTTP/2 connection, though an IPX may be involved for IP level routing. + +The scope of the HTTP/2 connection used for the N32-f interface is long-lived. The N32-f HTTP/2 connection at a SEPP can be: + +- Case A: Towards a SEPP of another PLMN without involving any IPX intermediaries or involving IPX intermediaries where IPX does not require modification or observation of the information; or +- Case B: Towards a SEPP of another PLMN via IPX where IPX requires modification or observation of the information. In this case, the HTTP/2 connection from a SEPP terminates at the next hop IPX with the IPX acting as a HTTP proxy. + +For the N32-f interface the HTTP/2 connection management requirements specified in clause 5.2.6 of 3GPP TS 29.500 [4] shall be applicable. The URI scheme used for the N32-f JOSE protected message forwarding API shall be "http". If confidentiality protection of all IEs for the N32-f JOSE protected message forwarding procedure is required, then: + +- For case A, the security between the SEPPs shall be ensured by means of an IPSec or TLS connection; +- For case B, hop-by-hop security between the SEPP and the IPXs should be established on N32-f. This hop-by-hop security shall be established using an IPSec or TLS connection. + +### 4.3.3 Transport Protocol + +The Transmission Control Protocol as described in IETF RFC 793 [11] shall be used as transport protocol as required by HTTP/2 (see IETF RFC 9113 [7]). + +When there is no IPX between the SEPPs or IPX(s) are offering only IP routing service without modification or observation of the content, TLS shall be used for security protection (see clause 13.1.2 of 3GPP TS 33.501 [6]). When there is IPX between the SEPPs and IPX requires modification or observation of the content, TLS or NDS/IP should be used for security protection as specified in clause 13.1.2 of 3GPP TS 33.501 [6]. + +NOTE: When using TCP as the transport protocol, an HTTP/2 connection is mapped to a TCP connection. + +### 4.3.4 Serialization Protocol + +The JavaScript Object Notation (JSON) format as described in IETF RFC 8259 [8] shall be used as the serialization protocol. + +# 5 N32 Procedures + +## 5.1 Introduction + +The procedures on the N32 interface are split into two categories: + +- Procedures that happen end to end between the SEPPs on the N32-c interface; +- Procedures that are used for the forwarding of messages on the service based interface between the NF service consumer and the NF service producer via the SEPP across the N32-f interface. + +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 | +|-----------------------------------|--------|----------------------------------|---------------------------------------------|-----------------|-------| +| N32 Handshake | 6.1 | N32-c Handshake Service | TS29573_N32_Handshake.yaml | n32c-handshake | A.2 | +| JOSE Protected Message Forwarding | 6.2 | N32-f Message Forwarding Service | TS29573_JOSEProtectedMessageForwarding.yaml | n32f-forward | A.3 | +| Nsepp_Telescopic_FQDN_Mapping | 6.3 | SEPP Telescopc FQDN Mapping | TS29573_SeppTelescopcFqdnMapping.yaml | nsepp-telescopc | A.4 | + +## 5.2 N32 Handshake Procedures (N32-c) + +### 5.2.1 General + +The N32 handshake procedure is used between the SEPPs in two PLMNs to mutually authenticate each other and negotiate the security mechanism to use over N32-f along with associated security configuration parameters. + +A HTTP/2 connection shall be established between the initiating SEPP and the responding SEPP end to end over TLS. The following N32 handshake procedures are specified in the clauses below. + +- Security Capability Negotiation Procedure +- Parameter Exchange Procedure +- N32-f Context Termination Procedure +- N32-f Error Reporting Procedure + +### 5.2.2 Security Capability Negotiation Procedure + +The initiating SEPP shall initiate a Security Capability Negotiation procedure towards the responding SEPP to agree on a security mechanism to use for protecting NF service related signalling over N32-f. An end to end TLS connection shall be setup between the SEPPs before the initiation of this procedure. This procedure may also be used to tear down + +the N32-f TLS connection if the remote SEPP indicated support of the feature NFLTST during the setup of the N32-c connection. The procedure is described in Figure 5.2.2-1 below. + +![Sequence diagram of Security Capability Negotiation Procedure between Initiating SEPP and Responding SEPP.](16152cf1d84aea10848758f51a91ff6a_img.jpg) + +``` + +sequenceDiagram + participant Initiating SEPP + participant Responding SEPP + Note left of Initiating SEPP: Initiating SEPP + Note right of Responding SEPP: Responding SEPP + Initiating SEPP->>Responding SEPP: 1. POST .../exchange-capability (SecNegotiateReqData) + Responding SEPP-->>Initiating SEPP: 2a. 200 OK (SecNegotiateRspData) + Responding SEPP-->>Initiating SEPP: 2b. 4xx/5xx (ProblemDetails) or 3xx + +``` + +Sequence diagram of Security Capability Negotiation Procedure between Initiating SEPP and Responding SEPP. + +**Figure 5.2.2-1: Security Capability Negotiation Procedure** + +- The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the "SecNegotiateReqData" IE carrying the following information: + - Supported security capabilities (i.e., PRINS and/or TLS); + - Whether the 3gpp-Sbi-Target-apiRoot HTTP header is supported, if TLS security is supported; + - Sender PLMN ID(s) or SNPN ID(s); + - Target PLMN ID or SNPN ID; + - Purpose of the intended usage of N32 connection. + - The senderN32fFqdn IE, if the initiating SEPP wishes the responding SEPP to establish the N32-f connection towards a specific FQDN (of the initiating SEPP). + - The senderN32fPortList IE, if the initiating SEPP wishes the responding SEPP to establish the N32-f connection using a specific port number. When present, the list shall contain one port number per supported security capability (i.e., PRINS and/or TLS). + +If different PLMNs or SNPNs are represented by different PLMN IDs or SNPN IDs (respectively) supported by a SEPP, then the SEPP shall use separate N32-connections for each pair of local and remote PLMN or SNPN. Both SEPPs shall store the mapping between the N32 connections and their pair of PLMN IDs or SNPN IDs. + +NOTE 1: If SEPPs support separate FQDN per PLMN or SNPN, then Target PLMN Id or Target SNPN Id is not required as target PLMN or SNPN can be selected by the FQDN. + +To tear down the N32-f connection when negotiated security scheme is TLS, the "SecNegotiateReqData" IE shall contain: + +- Supported security capability set to "NONE" +- On successful processing of the request, the responding SEPP shall respond to the initiating SEPP with a "200 OK" status code and a POST response body that contains "SecNegotiateRspData" IE carrying the following information: + - Selected security capability (i.e., PRINS or TLS); + - Whether the 3gpp-Sbi-Target-apiRoot HTTP header is supported, if TLS security is selected; + - Sender PLMN ID(s) or SNPN ID(s). + - Purpose of the accepted usage of N32 connection. + - The senderN32fFqdn IE, if the responding SEPP wishes the initiating SEPP to establish the N32-f connection towards a specific FQDN (of the responding SEPP). + - The senderN32fPort IE, if the responding SEPP wishes the initiating SEPP to establish the N32-f connection using a specific port number. + +NOTE 2: Same SEPP endpoints can serve all accepted purposes over the same N32-f connection established as the result of request/response messages. + +The responding SEPP compares the initiating SEPP's supported security capabilities to its own supported security capabilities and selects, based on its local policy, a security mechanism, which is supported by both the SEPPs. If the selected security capability indicates any other capability other than PRINS, then the HTTP/2 connection initiated between the two SEPPs for the N32 handshake procedures shall be terminated. The negotiated security capability shall be applicable on both the directions. If the selected security capability is PRINS, then the two SEPPs may decide to create (if not available) / maintain HTTP/2 connection(s) where each SEPP acts as a client towards the other (which acts as a server). This may be used for later signalling of N32-f error reporting procedure (see clause 5.2.5) and N32-f context termination procedure (see clause 5.2.4). + +If different PLMNs or SNPNs are represented by different PLMN IDs or SNPN IDs (respectively) supported by a SEPP, then the SEPP shall use separate N32-connections for each pair of local and remote PLMN or SNPN. Both SEPPs shall store the mapping between the N32 connections and their pair of PLMN IDs or SNPN IDs. + +The SEPP shall select the PLMN or SNPN from the list of supported PLMN(s) or SNPN(s) based on the received Target PLMN ID or SNPN ID, or based on PLMN or SNPN specific FQDN used in the request, and provide the selected PLMN's PLMN Id(s) in the plmnIdList or the selected SNPN's SNPN Id(s) in the snpnIdList. + +In case no purposes are exchanged, the receiving SEPP shall assume by default that purposes are for Roaming and inter-PLMN mobility as described in clause 6.1.5.3.9. + +The initiating SEPP and/or responding SEPP may enable the establishment of an N32 connection for the purpose of Disaster Roaming only during disaster conditions. + +When the request is for tearing down the existing N32-f TLS connection, the "SecNegotiateRspData" IE shall contain: + +- Supported security capability set to "NONE" + +and, subsequently, both SEPP shall terminate the N32-c and N32-f TLS connection. + +If the initiating SEPP receives the senderN32fQdn IE and/or the senderN32fPort IE from the responding SEPP, the initiating SEPP shall establish the N32-f connection towards the responding SEPP using the received N32-f FQDN and/or the senderN32fPort IE. + +If the responding SEPP receives the senderN32fQdn IE and/or the senderN32fPortList IE from the initiating SEPP, the responding SEPP shall establish the N32-f connection towards the initiating SEPP using the received N32-f FQDN and/or the N32-f port number received in the senderN32fPortList IE corresponding to the selected security capability (i.e., TLS or PRINS). + +If the N32-f context exists between the peer SEPPs, and the N32 exchange capability request is not for tearing down the N32-f connections, the responding SEPP shall: + +- stop sending any further messages over the N32-f towards the initiating SEPP; +- delete the current N32-f context and terminate any N32-f connection with the initiating SEPP; and +- process the received exchange capability request. + +2b. On failure or redirection, the responding SEPP shall respond to the initiating SEPP with an appropriate status code as specified in clause 6.1.4.2. + +If the responding SEPP has sent an outgoing Security Capability Negotiation request to the initiating SEPP, the responding SEPP shall compare the FQDN of the initiating SEPP that has been received in the incoming Security Capability Negotiation request message with the FQDN of the responding SEPP that has been sent in the outgoing Security Capability Negotiation request. If the responding SEPP's FQDN lexicographically precedes, it shall reject the incoming HTTP request message with the cause "N32C\_EXCHANGE\_CAPABILITY\_ONGOING" and it shall continue with its initiated procedure and vice versa. + +EXAMPLE: assuming SEPP A's FQDN is "sepp.5gc.mnc345.mcc012.3gppnetwork.org" and SEPP B's FQDN is "sepp.5gc.mnc346.mcc012.3gppnetwork.org", then SEPP A's FQDN precedes SEPP B's FQDN and SEPP A proceeds with its exchange capability procedure. + +A SEPP may be configured to accept an HTTP request from a given PLMN and not to send an HTTP request for exchange capability towards that PLMN. + +### 5.2.3 Parameter Exchange Procedure + +#### 5.2.3.1 General + +The parameter exchange procedure shall be executed if the security capability negotiation procedure selected the security capability as PRINS. The parameter exchange procedure is performed to: + +- Agree on a cipher suite to use for protecting NF service related signalling over N32-f; and +- Optionally, exchange the protection policies to use for protecting NF service related signalling over N32. + +#### 5.2.3.2 Parameter Exchange Procedure for Cipher Suite Negotiation + +The parameter exchange procedure for cipher suite negotiation shall be performed after the security capability negotiation procedure if the selected security policy is PRINS. If there is a change in the cipher suite and the SEPP wants to renegotiate it, then the SEPP may reuse the parameter exchange procedure to override what was exchanged before. + +The procedure is described in Figure 5.2.3.2-1 below. + +![Sequence diagram showing the Parameter Exchange Procedure for Cipher Suite Negotiation between an Initiating SEPP and a Responding SEPP. The Initiating SEPP sends a POST request (1) to the Responding SEPP. The Responding SEPP responds with either a 200 OK (2a) or a 4xx/5xx (2b) response.](e928f4874ed492d3ad4c6fa2d29aedbc_img.jpg) + +``` + +sequenceDiagram + participant Initiating SEPP + participant Responding SEPP + Note right of Initiating SEPP: 1. POST .../exchange-params +(SecParamExchReqData) + Initiating SEPP->>Responding SEPP: 1. POST .../exchange-params +(SecParamExchReqData) + Note left of Responding SEPP: 2a. 200 OK (SecParamExchRspData) + Responding SEPP-->>Initiating SEPP: 2a. 200 OK (SecParamExchRspData) + Note left of Responding SEPP: 2b. 4xx/5xx (ProblemDetails) + Responding SEPP-->>Initiating SEPP: 2b. 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram showing the Parameter Exchange Procedure for Cipher Suite Negotiation between an Initiating SEPP and a Responding SEPP. The Initiating SEPP sends a POST request (1) to the Responding SEPP. The Responding SEPP responds with either a 200 OK (2a) or a 4xx/5xx (2b) response. + +**Figure 5.2.3.2-1: Parameter Exchange Procedure for Cipher Suite Negotiation** + +1. The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the "SecParamExchReqData" IE carrying the following information + +- Supported cipher suites; + +The supported cipher suites shall be an ordered list with the cipher suites mandated by 3GPP TS 33.501 [6] appearing at the top of the list. + +The initiating SEPP also provides a N32-f context identifier for the responding SEPP to use towards the initiating SEPP for subsequent JOSE Protected Message Forwarding procedures over N32-f (see clause 5.3.3) when the responding SEPP acts as the forwarding SEPP. + +- 2a. On successful processing of the request, the responding SEPP shall respond to the initiating SEPP with a "200 OK" status code and a POST response body that contains the following information + +- Selected cipher suite + +The responding SEPP compares the initiating SEPP's supported cipher suites to its own supported cipher suites and selects, based on its local policy, a cipher suite, which is supported by both the SEPPs. The responding SEPP's supported cipher suites shall be an ordered list with the cipher suites mandated by 3GPP TS 33.501 [6] appearing at the top of the list. The selected cipher suite is applicable for both the directions of communication between the SEPPs. + +The responding SEPP also provides a N32-f context identifier for the initiating SEPP to use towards the responding SEPP for subsequent JOSE Protected Message Forwarding procedures over N32-f (see clause 5.3.3) when the initiating SEPP acts as the forwarding SEPP. + +If the receiving SEPP already has a previously negotiated cipher suite, the SEPP shall overwrite it with the new one. + +2b. On failure, the responding p-SEPP shall respond to the initiating SEPP with an appropriate 4xx/5xx status code as specified in clause 6.1.4.3. If the SEPP already has a previously negotiated cipher suite, the SEPP shall continue to use the same. + +NOTE : If a SEPP already has a previously negotiated cipher suite and a new cipher suite is also received, the SEPP starts applying the new cipher suite immediately and also continues with the old cipher suite for a limited time period. This allows messages with old policies to be completed gracefully. + +If the initiating SEPP receives a security parameter exchange request from the responding SEPP before receiving a response for its request (i.e security parameter exchange procedure collision), the initiating SEPP shall compare its FQDN that was sent in its request with the FQDN of the responding SEPP that is received in the security parameter exchange request message. If the initiating SEPP's FQDN lexicographically precedes, it shall reject the incoming HTTP request message with the cause "SECURITY\_PARAM\_EXCHANGE\_COLLISION" and it shall continue with its initiated procedure and vice versa. + +EXAMPLE: Assuming SEPP A's FQDN is "sepp.5gc.mnc345.mcc012.3gppnetwork.org" and SEPP B's FQDN is "sepp.5gc.mnc346.mcc012.3gppnetwork.org", then SEPP A's FQDN precedes SEPP B's FQDN and SEPP A proceeds with its security parameter exchange procedure. + +#### 5.2.3.3 Parameter Exchange Procedure for Protection Policy Exchange + +The parameter exchange procedure for protection policy exchange may be performed after the Parameter Exchange Procedure for Cipher Suite Negotiation (see clause 5.2.3.2). If a HTTP/2 connection does not exist towards the peer SEPP at the time of initiating this procedure, the HTTP/2 connection shall be established. If there is a change in the protection policy exchange and the SEPP wants to renegotiate it, then the SEPP may reuse the parameter exchange procedure for the protection policy exchange to override what was exchanged before. If the parameter exchange procedure for the protection policy exchange is not performed then the protection policies between the SEPP shall be exchanged out of bands. + +The procedure is described in Figure 5.2.3.3-1 below. + +![Sequence diagram showing the Parameter Exchange Procedure for Protection Policy Exchange between an Initiating SEPP and a Responding SEPP. The Initiating SEPP sends a POST request (1. POST .../exchange-params) to the Responding SEPP. The Responding SEPP responds with either a 200 OK (2a. 200 OK) or a 4xx/5xx status code (2b. 4xx/5xx).](f388cbdae6f0ef3aeb96fdf9984d1284_img.jpg) + +``` + +sequenceDiagram + participant Initiating SEPP + participant Responding SEPP + Note left of Initiating SEPP: Initiating SEPP + Note right of Responding SEPP: Responding SEPP + Initiating SEPP->>Responding SEPP: 1. POST .../exchange-params (SecParamExchReqData) + Responding SEPP-->>Initiating SEPP: 2a. 200 OK (SecParamExchRspData) + Responding SEPP-->>Initiating SEPP: 2b. 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram showing the Parameter Exchange Procedure for Protection Policy Exchange between an Initiating SEPP and a Responding SEPP. The Initiating SEPP sends a POST request (1. POST .../exchange-params) to the Responding SEPP. The Responding SEPP responds with either a 200 OK (2a. 200 OK) or a 4xx/5xx status code (2b. 4xx/5xx). + +**Figure 5.2.3.3-1: Parameter Exchange Procedure for Protection Policy Exchange** + +1. The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the "SecParamExchReqData" IE carrying the following information + +- Protection policy information + +The protection policy information contains: + +- API to IE mapping containing the mapping information of list of leaf IEs for each: + +- Request/response and Subscribe / Unsubscribe service operation, identified by the API URI and method; and/or +- Callbacks (e.g Notification service operation), identified by the value of the 3GPP custom HTTP header "3gpp-Sbi-Callback" (see clause 5.2.3 of 3GPP TS 29.500 [4]). +- List of IE types that are to be protected across N32-f (i.e the data type encryption policy as specified in clause 13.2.3.2 of 3GPP TS 33.501 [6]); and +- Modification policy: Against each leaf IE in the API to IE mapping information, a boolean flag indicating whether that IE is allowed to be modified by an IPX on the side of the SEPP sending the protection policy information. + +2a. On successful processing of the request, the responding SEPP shall respond to the initiating SEPP with a "200 OK" status code and a POST response body that contains the following information + +- Selected protection policy information + +The Selected protection policy information contains the IEs allowed to be modified by an IPX on the side of the responding SEPP. If the responding SEPP connects to several IPXs, an isModifiable IE may be included to indicate an IE is allowed to be modified by all IPX(s) or an map type of isModifiableByIpx IE may be included to indicate an IE is allowed to be modified by an IPX identified by the key of ipxProviderId IE if this IE is allowed to be modified by some of (but not all) the IPX(s), as specified in clause 13.2.3.4 of 3GPP TS 33.501 [6]. + +The initiating SEPP shall store the modification policy which are sent from responding SEPP in selected protection policy information and the responding SEPP shall store the modification policy which are sent from the initiating SEPP in the protection policy information. The SEPP receiving the subsequent message transfers over N32-f shall check whether the modifications performed by the IPXs were permitted by the respective modification policy. + +The SEPPs shall store the encryption policy in selected protection policy information and shall apply this policy for subsequent message transfers over N32-f. The encryption policy in selected protection policy is applicable for both the directions of communication between the SEPPs. + +If the receiving SEPP already has a previously negotiated protection policy information, the SEPP shall overwrite it with the new one. + +The HTTP/2 connection used for the N32 handshake procedures may be terminated after the completion of this procedure. + +2b. On failure, the responding SEPP shall respond to the initiating SEPP with an appropriate 4xx/5xx status code as specified in clause 6.1.4.3. If the SEPP already has previously negotiated protection policy information, the SEPP shall continue to use the same. + +NOTE : If a SEPP already has a previously negotiated cipher suite and a new cipher suite is also received, the SEPP starts applying the new cipher suite immediately and also continues with the old cipher suite for a limited time period. This allows messages with old policies to be completed gracefully. + +An illustration of how the protection policy is stored and looked up in the SEPP is provided in figure 5.2.3.3-2 + +![Diagram illustrating Protection Policy Storage and Lookup in SEPP. It shows how the SEPP uses API URI, HTTP Method, and IE Info to look up protection policies and callback types.](79e1709a7317ead45379cbb8ff3ba802_img.jpg) + +The diagram illustrates the Protection Policy Storage and Lookup in SEPP. It shows the following components and flow: + +- API URI Storage:** Four boxes labeled API URI1, API URI2, API URI3, and API URI4 are stacked vertically on the left. +- Policy Lookup:** + - API URI1 and API URI2 are connected to a box containing "HTTP Method" and "IE Info". This box points to a policy box containing "Data Type Encryption Policy = IETypeList" and "Modification Policy = IETypeList". + - API URI3 and API URI4 are connected to another box containing "HTTP Method" and "IE Info". This box points to another policy box containing "Data Type Encryption Policy = IETypeList" and "Modification Policy = IETypeList". +- Incoming Request Processing:** + - An "Incoming HTTP Request" box points to a step: "2. Search for an API URI matching the :path in incoming HTTP request/response to the SEPP", which then points back to the API URI boxes. + - The "Incoming HTTP Request" also points to a step: "1. If the incoming HTTP message has "3gpp-Sbi-Callback" header lookup the callback type list exchanged during protection policy exchange". +- Callback Type Lookup:** + - The step "1. If the incoming HTTP message has "3gpp-Sbi-Callback" header lookup the callback type list exchanged during protection policy exchange" points to a box containing "Callback Type#n", "Callback Type#2", and "Callback Type#1". + - This box points to an "IE Info" box. + - The "IE Info" box points to a policy box containing "Data Type Encryption Policy = IETypeList" and "Modification Policy = IETypeList". + +Diagram illustrating Protection Policy Storage and Lookup in SEPP. It shows how the SEPP uses API URI, HTTP Method, and IE Info to look up protection policies and callback types. + +**Figure 5.2.3.3-2: Protection Policy Storage and Lookup in SEPP** + +During the N32-f message forwarding, the SEPP looks at a HTTP request or response it receives from an NF service consumer or NF service producer and then uses the above tables to decide which IEs and headers in the message it shall cipher and integrity protect and which IEs it shall allow the IPXes to modify. + +#### 5.2.3.4 Parameter Exchange Procedure for Security Information list Exchange + +The initiating SEPP shall initiate a Security Information list exchange procedure towards the responding SEPP to exchange the Security Information lists that contain information on IPX public keys or certificates that are needed to verify IPX modifications at the receiving SEPP as specified in clause 13.2.2.2 of 3GPP TS 33.501 [6]. If there is a + +change in the security information list and the SEPP wants to renegotiate it, then the SEPP may reuse the parameter exchange procedure for the security information list exchange to override what was exchanged before. + +The procedure is described in Figure 5.2.3.4-1 below. + +![Sequence diagram showing the Parameter Exchange Procedure for Security Information List exchange between an Initiating SEPP and a Responding SEPP. The Initiating SEPP sends a POST .../exchange-params (SecParamExchReqData) to the Responding SEPP. The Responding SEPP responds with either a 200 OK (SecParamExchRspData) or a 4xx/5xx (ProblemDetails).](7d3d5fb5d09c0cd35a9d637be241651e_img.jpg) + +``` + +sequenceDiagram + participant Initiating SEPP + participant Responding SEPP + Note left of Initiating SEPP: Initiating SEPP + Note right of Responding SEPP: Responding SEPP + Initiating SEPP->>Responding SEPP: 1. POST .../exchange-params (SecParamExchReqData) + Responding SEPP-->>Initiating SEPP: 2a. 200 OK (SecParamExchRspData) + Responding SEPP-->>Initiating SEPP: 2b. 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram showing the Parameter Exchange Procedure for Security Information List exchange between an Initiating SEPP and a Responding SEPP. The Initiating SEPP sends a POST .../exchange-params (SecParamExchReqData) to the Responding SEPP. The Responding SEPP responds with either a 200 OK (SecParamExchRspData) or a 4xx/5xx (ProblemDetails). + +**Figure 5.2.3.4-1: Parameter Exchange Procedure for Security Information List exchange** + +1. The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the "SecParamExchReqData" IE carrying the following information: + - IPX provider identifier connected to the initiating SEPP; + - List of raw public keys or certificates for that IPX. + - 2a. On successful processing of the request, the responding SEPP shall respond to the initiating SEPP with a "200 OK" status code and a POST response body that contains the "SecParamExchRspData" IE carrying the following information: + - IPX provider identifier connected to the responding SEPP; + - List of raw public keys or certificates for that IPX. + +If the receiving SEPP already has a previously negotiated security information list, the SEPP shall overwrite it with the new one. + - 2b. On failure, the responding SEPP shall respond to the initiating SEPP with an appropriate 4xx/5xx status code as specified in clause 6.1.4.3. If the SEPP already has previously negotiated security information list, the SEPP shall continue to use the same. +- NOTE : If a SEPP already has a previously negotiated cipher suite and a new cipher suite is also received, the SEPP starts applying the new cipher suite immediately and also continues with the old cipher suite for a limited time period. This allows messages with old policies to be completed gracefully. + +### 5.2.4 N32-f Context Termination Procedure + +After the completion of the security capability negotiation procedure and/or the parameter exchange procedures, an N32-f context is established between the two SEPPs. The "n32fContextId" of each SEPP is provided to the other SEPP. This context identifier shall be stored in each SEPP until the context is explicitly terminated by the N32-f context termination procedure. The SEPP that is initiating the N32-f context termination procedure shall use the HTTP method POST on the URI: {apiRoot}/n32c-handshake//n32f-terminate. If a HTTP/2 connection does not exist towards the receiving SEPP, a HTTP/2 connection shall be created before initiating this procedure. The procedure is shown below in Figure 5.2.4-1. + +![Sequence diagram of N32f Context Termination Procedure between Initiating SEPP and Responding SEPP.](eb03559a4d92ea9ebd63ea9be663c50a_img.jpg) + +``` + +sequenceDiagram + participant Initiating SEPP + participant Responding SEPP + Note right of Initiating SEPP: 1. POST .../n32f-terminate (N32fContextInfo) + Initiating SEPP->>Responding SEPP: 1. POST .../n32f-terminate (N32fContextInfo) + Note left of Responding SEPP: 2a. 200 OK (N32fContextInfo) + Responding SEPP-->>Initiating SEPP: 2a. 200 OK (N32fContextInfo) + Note left of Responding SEPP: 2b. 4xx/5xx (ProblemDetails) + Responding SEPP-->>Initiating SEPP: 2b. 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram of N32f Context Termination Procedure between Initiating SEPP and Responding SEPP. + +**Figure 5.2.4-1: N32f Context Termination Procedure** + +1. The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the N32-f context id information that is to be terminated. +- 2a. On success, the responding SEPP, shall: + - stop sending any further messages over the N32-f towards the initiating SEPP; + - once all the ongoing N32-f message exchanges with the initiating SEPP are completed or timed out, delete the N32-f context identified by the "n32fContextId" provided in the request. + +The N32-f HTTP/2 connections from the responding SEPP shall not be deleted if they terminate at an IPX, since that HTTP/2 connection may carry traffic towards other PLMN SEPPs as well. The responding SEPP shall return the status code "200 OK" together with an N32ContextInfo content that carries the "n32fContextId" of the initiating SEPP that the responding SEPP has stored. + +The initiating SEPP shall: + +- stop sending any further messages over the N32-f towards the responding SEPP; +- once all the ongoing N32-f message exchanges with the responding SEPP are completed or timed out, delete the local N32-f context identified by this "n32fContextId". + +If the initiating SEPP receives a N32-f termination request from the responding SEPP before receiving a response for its request (i.e N32-f Context Termination Procedure collision), the initiating SEPP shall process the received N32-f termination request from the responding SEPP and shall return the status code "200 OK" together with an N32ContextInfo content that carries the "n32fContextId" of the responding SEPP that the initiating SEPP has stored. The initiating SEPP shall behave as specified above without waiting for a response from the responding SEPP for its N32-f Context Termination request. + +- 2b. On failure, the responding SEPP shall return an appropriate 4xx/5xx status code together with the "ProblemDetails" JSON body. + +### 5.2.5 N32-f Error Reporting Procedure + +When a SEPP is not able to process a message it received over the N32-f interface due to errors, the error information is conveyed to the sending SEPP by using the N32-f error reporting procedure over the N32-c interface. The SEPP that is initiating the N32-f error reporting procedure shall use the HTTP method POST on the URI: {apiRoot}/n32c-handshake//n32f-error. If a HTTP/2 connection does not exist towards the receiving SEPP, a HTTP/2 connection shall be created before initiating this procedure. The procedure is shown below in Figure 5.2.5-1. + +![Sequence diagram of N32f Error Reporting Procedure between Initiating SEPP and Responding SEPP.](ae53f90bb87d6d09e2d6b5278d7c338f_img.jpg) + +``` + +sequenceDiagram + participant Initiating SEPP + participant Responding SEPP + Note right of Initiating SEPP: 1. POST .../n32f-error (N32fErrorInfo) + Initiating SEPP->>Responding SEPP: Request + Note left of Responding SEPP: 2a. 204 No Content + Responding SEPP-->>Initiating SEPP: Success Response + Note left of Responding SEPP: 2b. 4xx/5xx (ProblemDetails) + Responding SEPP-->>Initiating SEPP: Error Response + +``` + +Sequence diagram of N32f Error Reporting Procedure between Initiating SEPP and Responding SEPP. + +**Figure 5.2.5-1: N32f Error Reporting Procedure** + +1. The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the N32-f error information that is to be reported. +- 2a. On success, the responding SEPP, shall: + - log that the N32-f request / response message identified by the "n32fMessageId" is not processed by the receiving SEPP; + The responding SEPP shall return the status code "204 No Content". +- 2b. On failure, the responding SEPP shall return an appropriate 4xx/5xx status code together with the "ProblemDetails" JSON body. + +## 5.3 Message Forwarding Procedure on N32 (N32-f) + +### 5.3.1 Introduction + +The N32-f interface is used between two SEPPs for: + +- The forwarding of JOSE protected HTTP/2 messages between the NF service consumer and the NF service producer across two PLMNs, when PRINS is the negotiated security policy. The message forwarding on N32-f shall be based on the negotiated security capability and the exchanged security parameters between the two SEPPs (see clause 5.2). +- Forwarding of the HTTP/2 messages between the NF service consumer and the NF service producer without any reformatting and application layer protection, when TLS is the negotiated security policy. + +### 5.3.2 Use of Application Layer Security + +#### 5.3.2.1 General + +If the negotiated security capability between the two SEPPs is PRINS, one or more HTTP/2 connections between the two SEPPs for the forwarding of JOSE protected message shall be established, which may involve IPX providers on path. The forwarding of messages over the N32-f interface involves the following steps at the sending SEPP: + +1. Identification of the protection policy applicable for the API being invoked (i.e either a request/response NF service API or a subscribe/unsubscribe service API or a notification API). +2. Message reformatting as per the identified protection policy. +3. Forwarding of the reformatted message over the N32 interface. + +The processing of a message received over the N32-f interface at the receiving IPX provider involves the following steps: + +1. Apply the modifications in the "modificationsBlock" appended by the sending IPX provider as JSON patches in the DataToIntegrityProtectBlock (from the decoded "aad" part), if the "modificationsBlock" is received in the message. + +2. Determine further modifications required based on modification policy and insert the modification entries in "modificationsBlock". +3. Forwarding the received message with the above inserted modification entries in "modificationsBlock" over the N32 interface. + +The processing of a message received over the N32-f interface at the receiving SEPP involves the following steps. + +1. Identify the N32-f context using the N32-f context Id received in the message. +2. Verify the integrity protection of the message using the keying material obtained from the TLS layer during the parameter exchange procedure for that N32-f context (see 3GPP TS 33.501 [6]). The TLS connection from which the keying material is obtained is the N32-c TLS connection used for the parameter exchange procedure. +3. Decrypt the ciphertext part of the received JWE message. Decode the "aad" part of the JWE message using BASE64URL decoding. +4. For each entry in the "modificationsBlock" of the received message: + - First verify the integrity protection of that entry using the keying material applicable for the IPX that inserted that block (using the "identity" IE in the "modificationsBlock"); + - Identify the modifications policy exchanged during the parameter exchange procedure with the sending SEPP if the IPX that inserted the modificationsBlock is from the sending SEPP side; else identify the modifications policy applicable for the IPX based on local configuration; + - Check if the inserted modifications are as per the identified modifications policy; + - Apply the modifications as a JSON patch in the DataToIntegrityProtectBlock (from the decoded "aad" part). +5. Form the original JSON request / response body from the decrypted ciphertext and the decoded integrity verified "aad" block possibly modified as described in step 4. +6. If the reconstructed HTTP message has an "Authorization" header, then the SEPP shall check whether the service consumer's PLMN ID or SNPN ID is present in the Bearer token contained in the Authorization header (see 3GPP TS 29.510 [18], clause 6.3.5.2.4) and if it matches with the "Remote PLMN ID" or "Remote SNPN ID" of the N32-f context. If they do not match, the SEPP shall respond to the sending SEPP with "403 Forbidden" status code with the application specific cause set as "PLMNID\_MISMATCH" or "SNPNID\_MISMATCH". + +NOTE 1: In this case, the N32-f Error Reporting procedure specified in clause 5.2.5 is not used since the processing of the complete N32-f message fails at the receiving SEPP. + +NOTE 2: If the service consumer's PLMN ID or SNPN ID is present in the reconstructed HTTP message, then the receiving SEPP compares this with the sending SEPP's PLMN ID or SNPN ID, which is retrieved from N32f Context (see clause 5.9.3 in 3GPP TS 33.501 [6]). See the above step 6 for the receiving SEPP behaviour. If the service consumer's PLMN ID and SNPN ID are not present, the comparison is not done. + +SEPPs and IPX should support gzip coding (see IETF RFC 1952 [23]) 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] and clause 6.2.2.2.3. + +#### 5.3.2.2 Protection Policy Lookup + +When a SEPP receives a HTTP/2 request or response message intended to be routed towards another PLMN, the sending SEPP shall identify the protection policy as given below + +1. Identify the target PLMN from the ":authority" part of the message using the format specified in clause 6.1.4.3 of 3GPP TS 29.500 [4]. +2. Check if the incoming HTTP/2 message has the "3gpp-Sbi-Callback" header. When present, the SEPP shall select the data encryption and modification policy applicable for the specific notification type, identified by the value of the "3gpp-Sbi-Callback" header and the target PLMN, using the notification type list stored as specified in subclass 5.2.3.3. + +3. Else, if it is a HTTP/2 request message, then from the ":authority" and ":path" part of the received HTTP/2 request message, form the API URI. For the identified PLMN, check if a protection policy exists for the API URI using the table stored as specified in clause 5.2.3.3. +4. Else, if it is a HTTP/2 response message, then based on the HTTP/2 stream ID on which the response is received, identify the corresponding request that was sent by the SEPP and the protection policy applicable for that request, as specified in step 3. +5. If an entry is not found, then it means that either the particular API has no protection policy exchanged. + +Once a protection policy is identified, the SEPP shall apply the application layer security as per the identified protection policy. + +#### 5.3.2.3 Message Reformatting + +A SEPP on the sending side PLMN applies message reformatting in the following cases: + +- When it receives a HTTP/2 request message from an NF service consumer to a an NF service producer in another PLMN; +- When it receives a response HTTP/2 response message from an NF service producer to an NF service consumer in another PLMN. +- When it receives a HTTP/2 notification request message from an NF service producer to an NF service consumer in another PLMN; +- When it receives a HTTP/2 notification response message from an NF service consumer to an NF service producer in another PLMN + +The SEPP shall reformat the HTTP/2 message by encapsulating the whole message into the body of a new HTTP POST message. The body of the HTTP POST request / response message shall contain the reformatted original HTTP/2 request/response message respectively. The HTTP POST request/response body shall be encoded as the "N32fReformattedReqMsg"/"N32fReformattedRspMsg" JSON bodies respectively, as specified in clause 6.2.5. + +The "N32fReformattedReqMsg"/"N32fReformattedRspMsg" are structured as given below: + +![Figure 5.3.2.3-1: JSON representation of a reformatted HTTP message. The diagram shows the mapping of N32fReformattedReqMsg / N32fReformattedRspMsg components to FlatJweJson and FlatJwsJson structures. FlatJweJson contains Headers, protected, unprotected, iv, aad, and ciphertext (BASE64URL of JWE CipherText). FlatJwsJson contains Unprotected, headers, payload, and JWS signature. The ciphertext is derived from BASE64URL (DataToIntegrityProtectBlock) and Input to JWE Cipher Text (DataToIntegrityProtectAndCipherBlock).](2ae3eae1bd80a90f192f568ae246a9a6_img.jpg) + +The diagram illustrates the JSON representation of a reformatted HTTP message. It shows the mapping of components from `N32fReformattedReqMsg / N32fReformattedRspMsg` to `FlatJweJson` and `FlatJwsJson`. + +- FlatJweJson** structure: + - Headers, protected, unprotected + - iv + - aad + - ciphertext = BASE64URL(JWE CipherText) +- FlatJwsJson** structure: + - Unprotected, headers + - payload + - JWS signature +- BASE64URL (DataToIntegrityProtectBlock)** structure: + - metaData(n32fContextId) + - requestLine / statusLine + - Headers = array{"header":
, "value": {free form obj}} + - JsonPayload = [{"ieName": , "value": {free form obj}}] +- Input to JWE Cipher Text (DataToIntegrityProtectAndCipherBlock)** structure: + - [ "hdr1val", {payload 1}, "payload 2", ... ] +- BASE64URL (Modifications)** structure: + - operations (array of PatchItem) + - identity + - tag + +Figure 5.3.2.3-1: JSON representation of a reformatted HTTP message. The diagram shows the mapping of N32fReformattedReqMsg / N32fReformattedRspMsg components to FlatJweJson and FlatJwsJson structures. FlatJweJson contains Headers, protected, unprotected, iv, aad, and ciphertext (BASE64URL of JWE CipherText). FlatJwsJson contains Unprotected, headers, payload, and JWS signature. The ciphertext is derived from BASE64URL (DataToIntegrityProtectBlock) and Input to JWE Cipher Text (DataToIntegrityProtectAndCipherBlock). + +Figure 5.3.2.3-1 JSON representation of a reformatted HTTP message + +The "cipherText" part of the reformatted message in FlatJweJson shall be prepared as given below + +![Figure 5.3.2.3-2: Transformation of HTTP Header and Content to Encrypt into CipherText. The diagram shows a linear process: Input for Cipher Text -> Encryption Function -> BASE64URL Transform -> Ciphertext part of FlatJweJson.](088921fa3f5a44c8551815122517eefd_img.jpg) + +The diagram illustrates the transformation of HTTP Header and Content to Encrypt into CipherText. The process is as follows: + +- Input for Cipher Text**: { "hdr1value", {payload1 obj}, "payload2 val", ... } +- Encryption Function**: $\Phi(\text{Input})$ +- BASE64URL Transform**: BASE64URL(JWE Ciphertext) +- Ciphertext part of FlatJweJson** + +Figure 5.3.2.3-2: Transformation of HTTP Header and Content to Encrypt into CipherText. The diagram shows a linear process: Input for Cipher Text -> Encryption Function -> BASE64URL Transform -> Ciphertext part of FlatJweJson. + +Figure 5.3.2.3-2 Transformation of HTTP Header and Content to Encrypt into CipherText + +- Based on the protection policy exchanged between the SEPPs, the sending SEPP prepares an input for the JWT ciphering and integrity protection as an array of arbitrary types in the "DataToIntegrityProtectAndCipher" block with each entry containing either a HTTP header value or the value of a JSON payload IE of the API message being reformatted. The index value "encBlockIdx" in the contentpart of DataToIntegrityProtectBlock shall point to the index of a header value or IE value in this input array. +- The input block is fed into an encryption function along with the other required inputs for JWT as specified in IETF RFC 7516 [14]. +- The encryption function outputs the cipher text information. This cipher text is then subjected to BASE64URL transformation as specified in IETF RFC 4648 [15] clause 5. + +4. The output of the BASE64URL transform is then encoded as the ciphertext part of FlatJweJson IE specified in clause 6.2.5.2.11. + +#### 5.3.2.4 Message Forwarding to Peer SEPP + +Once a SEPP reformats the HTTP/2 message into the "N32ReformattedReqMsg"/"N32ReformattedRspMsg" JSON object as specified in clause 5.3.2, the SEPP forwards the message to the receiving SEPP by invoking a HTTP POST method as shown in figure 5.3.2.4-1 below. + +![Sequence diagram showing message forwarding between SEPP (PLMN A) and SEPP (PLMN B).](705ee99c3c44fd2a1ea6a3348ce8878f_img.jpg) + +``` + +sequenceDiagram + participant SEPP_A as SEPP (PLMN A) + participant SEPP_B as SEPP (PLMN B) + Note left of SEPP_A: Initiating SEPP + SEPP_A->>SEPP_B: 1. POST .../n32f-process (N32fReformattedReqMsg) + Note right of SEPP_B: Responding SEPP + SEPP_B-->>SEPP_A: 2a. 200 OK (N32fReformattedRspMsg) + SEPP_B-->>SEPP_A: 2b. 4xx/5xx (ProblemDetails) + +``` + +The diagram illustrates the interaction between two SEPPs, SEPP (PLMN A) and SEPP (PLMN B). SEPP (PLMN A) sends a POST request (1. POST .../n32f-process (N32fReformattedReqMsg)) to SEPP (PLMN B). SEPP (PLMN B) responds with either a 200 OK (2a. 200 OK (N32fReformattedRspMsg)) or a 4xx/5xx status code (2b. 4xx/5xx (ProblemDetails)). + +Sequence diagram showing message forwarding between SEPP (PLMN A) and SEPP (PLMN B). + +**Figure 5.3.2.4-1 Message Forwarding between SEPP on N32-f** + +1. The initiating SEPP issues a HTTP POST request towards the responding SEPP with the request body containing the "N32ReformattedReqMsg" IE carrying the reformatted HTTP/2 message. The request message shall contain the "n32fContextId" information provided by the responding SEPP to the initiating SEPP earlier during the parameter exchange procedure (see clause 5.2.3). The responding SEPP shall use the "n32fContextId" information to: + - Locate the agreed cipher suite and protection policy; + - Locate the n32fContextId to be used in the response. + +If the HTTP request/response message to be forwarded over N32-f includes an 3gpp-Sbi-Message-Priority header, the initiating/responding SEPP should additionally insert a 3gpp-Sbi-Message-Priority header in the N32-f message with the same contents as the 3gpp-Sbi-Message-Priority header encoded within the "N32ReformattedReqMsg"/"N32ReformattedRspMsg" IE respectively. + +NOTE 1: Replicating the information in a N32-f message header enables the receiving SEPP to determine the priority of the forwarded HTTP request/response without having to parse the N32-f message content. + +The HTTP request content may be compressed hop by hop over N32-f, if the initiating SEPP or IPX and its next hop (IPX or SEPP) support gzip coding (see IETF RFC 1952 [23]). + +- 2a. On successful processing of the request, the responding SEPP shall: + - decompress the N32-f HTTP request content, if it is compressed; + - reconstruct the HTTP/2 message towards the NF service producer; + - compress the reconstructed HTTP request if the reconstructed HTTP content contains a Content-Encoding header indicating gzip compression; + - forward the reconstructed HTTP/2 message to the NF service producer; + - wait for the response from the NF service producer; and then + - once the response from the NF service producer is received, respond to the initiating SEPP with a "200 OK" status code and a POST response body that contains the "N32ReformattedRspMsg". The "N32ReformattedRspMsg" shall contain the reformatted HTTP response message from the responding PLMN. The response message shall contain the "n32fContextId" information provided by the initiating SEPP to the responding SEPP earlier during the parameter exchange procedure (see clause 5.2.3). + +NOTE 2: For unsuccessful processing of the request with "PLMNID\_MISMATCH", see clause 5.3.2.1. + +The responding SEPP shall be able to map the response received from the NF service producer to the HTTP/2 stream ID for the corresponding response it needs to generate towards the initiating SEPP. The HTTP/2 stream ID and the HTTP/2 connection information on either side shall be used to derive this mapping. + +The HTTP response content may be compressed hop by hop over N32-f, if the responding SEPP or IPX and its next hop (IPX or SEPP) support gzip coding (see IETF RFC 1952 [23]). + +- 2b. On failure or unsuccessful processing of the request, the responding SEPP shall respond to the initiating SEPP with an appropriate 4xx/5xx status code, the message body shall contain a ProblemDetails structure with the "cause" attribute set to one of the application error as specified in clause 6.2.4.2. The "cause" attribute shall be set to "UNSPECIFIED", if the responding SEPP fails to process the reconstructed message, and the error is reported by N32f error reporting procedure as specified in clause 5.2.5. + +#### 5.3.2.5 JOSE Protected Forwarding Options + +The JOSE Protected Forwarding Options is used by the sending SEPP or IPX to discover the communication options supported by its next hop (IPX or SEPP) for N32-f message processing. + +![Sequence diagram showing the discovery of communication options. A box labeled 'SEPP or IPX' on the left sends a message '1. OPTIONS .../n32f-process' to a box labeled 'IPX or SEPP' on the right. The 'IPX or SEPP' box responds with '2. 204 No Content Or 4xx/5xx (ProblemDetails)' back to the 'SEPP or IPX' box.](f2ea0f64a770b22b902820457d262265_img.jpg) + +``` + +sequenceDiagram + participant SEPP or IPX + participant IPX or SEPP + Note left of SEPP or IPX: SEPP or IPX + Note right of IPX or SEPP: IPX or SEPP + SEPP or IPX->>IPX or SEPP: 1. OPTIONS .../n32f-process + IPX or SEPP-->>SEPP or IPX: 2. 204 No Content +Or 4xx/5xx (ProblemDetails) + +``` + +Sequence diagram showing the discovery of communication options. A box labeled 'SEPP or IPX' on the left sends a message '1. OPTIONS .../n32f-process' to a box labeled 'IPX or SEPP' on the right. The 'IPX or SEPP' box responds with '2. 204 No Content Or 4xx/5xx (ProblemDetails)' back to the 'SEPP or IPX' box. + +**Figure 5.3.2.5-1: Procedure for the discovery of communication options supported by the next hop** + +1. The sending SEPP or IPX shall send an OPTIONS request to discover the communication options supported by its next hop (IPX or SEPP) for N32-f message processing. +2. If the request is accepted, the next hop (IPX or SEPP) shall respond with the status code 204 No Content and include an Accept-Encoding header (as described in IETF RFC 9110 [24]). + +On failure, the next hop shall return one of the HTTP status code listed in Table 6.2.4.3.2.1-3. + +### 5.3.3 Message Forwarding to Peer SEPP when TLS is used + +When the negotiated security policy between the SEPPs is TLS, then the procedures described in clause 5.3.2 shall not be applied. Messages shall be forwarded to the peer SEPP as specified in clause 6.1.4.3.4 of 3GPP TS 29.500 [4]. + +On failure or unsuccessful processing of the incoming N32-f request, the responding SEPP shall respond to the initiating SEPP with an appropriate 4xx/5xx status code including a ProblemDetails structure with the "cause" attribute set to one of the following application errors as specified in Table 5.3.3-1. + +**Table 5.3.3-1: Protocol and application errors generated by SEPP** + +| Protocol or application Error | HTTP status code | Description | +|-------------------------------|------------------|--------------------------------------------------------------------------------------------------------------| +| "CONTEXT_NOT_FOUND" | 403 Forbidden | The N32-f request which was received over TLS connection is rejected due to having no related N32-c context. | + +### 5.3.4 Void + +## 5.4 Nsepp\_Telescopic\_FQDN\_Mapping Service + +### 5.4.1 General + +The Nsepp\_Telescopic\_FQDN\_Mapping service is used between any Network Function and the SEPPs in the same PLMN, if TLS protection between the Network Function and the SEPP relies on using telescopic FQDN. See clause 28.5.2 of 3GPP TS 23.003 [19] and clause 6.1.4.3 of 3GPP TS 29.500 [4]) for the definition and use of Telescopic FQDN. + +### 5.4.2 Foreign FQDN to Telescopic FQDN Mapping Procedure + +This procedure is initiated by an NF Service Consumer (typically an NRF or an NSSF) that needs to interact with a NF in a foreign PLMN (typically the corresponding NRF or NSSF), and to do so, it needs to build a telescopic FQDN of said NF (i.e. concatenation of the FQDN of the foreign FQDN, and the FQDN of the local SEPP), and then the resulting telescopic FQDN needs to be "flattened" (i.e. the FQDN of the NF in the foreign PLMN needs to be converted to a singel label). The procedure is described in Figure 5.4.2-1 below. + +![Sequence diagram of the Foreign FQDN to Telescopic FQDN Mapping Procedure. It shows an NF Service Consumer sending a GET request to a SEPP, and the SEPP responding with either a 200 OK (TelescopicMapping) or a 4xx/5xx (ProblemDetails).](7fe7bcb3d40736e0b29d9f48ff3cc026_img.jpg) + +``` +sequenceDiagram + participant NF Service Consumer + participant SEPP + Note left of NF Service Consumer: + NF Service Consumer->>SEPP: 1. GET .../mapping?foreign-fqdn= + Note right of SEPP: + SEPP-->>NF Service Consumer: 2a. 200 OK (TelescopicMapping) + SEPP-->>NF Service Consumer: 2b. 4xx/5xx (ProblemDetails) +``` + +Sequence diagram of the Foreign FQDN to Telescopic FQDN Mapping Procedure. It shows an NF Service Consumer sending a GET request to a SEPP, and the SEPP responding with either a 200 OK (TelescopicMapping) or a 4xx/5xx (ProblemDetails). + +Figure 5.4.2-1: Foreign FQDN to Telescopic FQDN Mapping Procedure + +1. The NF Service Consumer issues an HTTP GET request towards the local SEPP with a query parameter "foreign-fqdn" containing the FQDN of the NF in the foreign PLMN, that needs to be transformed into a flattened telescopic FQDN. +- 2a. On successful processing of the request, the responding SEPP shall respond to the NF Service Consumer with a "200 OK" status code and a response body that contains a JSON object of type "TelescopicMapping", containing as attributes the label to be used as first label in the telescopic FQDN, and the domain of the local SEPP to be appended after such first label. The resulting FQDN shall be used by the NF Consumer to setup a TLS session terminated in the local SEPP, where the SEPP shall present a server certificate with a wildcard domain matching the returned telescopic FQDN. + +### 5.4.3 Telescopic FQDN to Foreign FQDN Mapping Procedure + +This procedure is initiated by an NF Service Consumer (typically another SEPP) that has received a service request with an unknown first label of a telescopic FQDN. Typically, this SEPP may interact with other SEPPs in the same PLMN in order to determine if there is an existing mapping for a given label to an FQDN of a foreign FQDN; this procedure is only expected to be used when multiple SEPPs are deployed in a PLMN. The procedure is described in Figure 5.4.3-1 below. + +![Sequence diagram showing the Foreign FQDN to Telescopic FQDN Mapping Procedure. An NF Service Consumer sends a GET request to a SEPP. The SEPP responds with either a 200 OK (TelescopicMapping) or a 4xx/5xx (ProblemDetails).](00504fc688ebcf131ccbeff94dfc9939_img.jpg) + +``` + +sequenceDiagram + participant NF Service Consumer + participant SEPP + Note left of NF Service Consumer: 1. GET .../mapping?telescopic-label=