5.3.2 Service Operations

29.5623GPP5G SystemHome Subscriber Server (HSS) servicesRelease 18Stage 3TS

Tools: ARFCN - Frequency Conversion for 5G NR/LTE/UMTS/GSM

5.3.2.1 Introduction

For the Nhss_imsSubscriberDataManagement service the following service operations are defined:

– Get

– Subscribe to notification of data changes and UE reachability for IP

– Unsubscribe to notification of data changes and UE reachability for IP

– Notification of data changes and UE reachability for IP

– Update

The Nhss_imsSubscriberDataManagement Service is used by Consumer NFs (S-CSCF, IMS-AS) to retrieve the UE’s individual subscription data relevant to the consumer NF, or by I-CSCF to retrieve S-CSCF capabilities or the assigned S-CSCF, from the SBI capable HSS by means of the Get service operation. If the consumer NF supports the feature "sharedData", the retrieved individual subscription data for the UE may contain shared data identifier identifying additional parts of subscription data shared by several UEs. If so, the Nhss_imsSubscriberDataManagement Service is also used by Consumer NFs to:

– retrieve shared subscription data from the HSS by means of the Get service operation.

The Nhss_imsSubscriberDataManagement Service is also used by Consumer NFs to:

– subscribe to notifications of data change by means of the Subscribe service operation. If the consumer NF supports the feature "sharedData", the consumer NF may also subscribe to notifications of shared data change by means of the Subscribe service operation.

– to unsubscribe from notifications of data changes by means of the Unsubscribe service operation. If the feature "sharedData" is supported, it may also be used to unsubscribe from notifications of shared data changes by means of the Unsubscribe service operation.

– get notified by means of the Notification service operation when HSS decides to modify the subscribed data. If the feature "sharedData" is supported by the consumer NF and the consumer NF has previously subscribed to notifications of shared data change, it is also used by the consumer NF to get notified by means of the Notification service operation when the HSS decides to modify the subscribed shared data.

It is also used by Consumer NFs to:

– provide the information about the status of the subscription data management procedures.

– update information (e.g. transparent data) associated to the subscription data management.

5.3.2.2 Get

5.3.2.2.1 General

The following procedures using the Get service operation are supported:

– Repository Data Retrieval

– IMS Identity Data (e.g. IMS associated identities including Implicit Registration Set and Alias Group) Retrieval

– IMS Profile Data (e.g. IFCs) Retrieval

– IMS Location Data Retrieval

– IMS Registration Status Data Retrieval

– Access Data (e.g. T-ADS) Retrieval

– SRVCC Data (e.g. STN-SR) Retrieval

– Service Data (e.g. DSAI) Retrieval

– Retrieval Of Multiple Data Sets

– Shared Subscription Data Retrieval

– Trace Data Retrieval

– PSI Activation State Retrieval

– DSAI information Retrieval

– S-CSCF Selection Assistance Information Retrieval

When the feature SharedData is supported and the retrieved UE-individual data (i.e. data other than Shared Subscription Data) contain SharedDataIds, the NF service consumer shall also retrieve the shared data identified by the received shared data Ids unless the identified shared data are already available at the NF service consumer. The order of sequence of sharedDataIds within UE-individual data is significant: Individual data take precedence over shared data; shared data "SharedDataX" identified by a sharedDataId X takes precedence over shared data "SharedDataY" identified by a sharedDataId Y if X appears before Y within the list of SharedDataIds in the UE-individual data.

5.3.2.2.2 Identity Data

5.3.2.2.2.1 IMS Identity Data Retrieval

Figure 5.3.2.2.2.1-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE’s IMS Identity Data for the IMS associated Identities (IRS and Alias group information). The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/identities/ims-associated-identities) and query parameters (e.g. supported-features).

Figure 5.3.2.2.2.1-1: IMS Identity Data Retrieval

1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE’s Identity Data for the IMS associated identities with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the UE’s Implicit Registration Set (if any) and the Alias Group information (if any) which the UE’s identity belongs to as relevant for the requesting NF service consumer. Additional information (e.g. distinct or wildcarded type of identity, registration state of the IRS) is also included in the response.

2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.2.2 MSISDN(s) Retrieval

Figure 5.3.2.2.2.2-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE’s MSISDN(s). The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/identities/msisdns) and query parameters (e.g. supported-features).

Figure 5.3.2.2.2.2-1: MSISDN(s) Retrieval

1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE’s MSISDN(s) with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the UE’s MSISDN(s) as relevant for the requesting NF service consumer. The type of MSISDN (basic/C-MSISDN or additional MSISDN) is included in the response.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.2.3 Private Identities Retrieval

Figure 5.3.2.2.2.3-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE’s Private Identities (IMS Private User Identity, IMSI). The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/identities/private-identities) and query parameters (e.g. supported-features).

Figure 5.3.2.2.2.3-1: Private Identities Retrieval

1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE’s Private Identities with query optional parameters indicating the supported-features and/or impi.

2a. On success, the HSS responds with "200 OK" with the message body containing the UE’s Private Identities as relevant for the requesting NF service consumer. The type of Private Identity (e.g. IMPI, IMSI) is included in the response. If an impi was provided as query parameter in the GET request, only the Private Identity of type IMSI that is associated with the provided impi shall be returned.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.2.4 IMEI(SV) Retrieval

Figure 5.3.2.2.2.4-1 shows a scenario where the NF service consumer (e.g. IMS AS) sends a request to the HSS to receive the IMEI(SV) for the UE. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/identities/imeisv) and query parameters (e.g. supported-features).

Figure 5.3.2.2.2.4-1: IMEI(SV) Retrieval

1. The NF service consumer (e.g. IMS AS) sends a GET request to the resource representing the UE’s IMEI(SV) information with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the last known IMEI(SV) associated to the UE.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.3 IMS Location Data and Status

5.3.2.2.3.1 S-CSCF Capabilities Retrieval

Figure 5.3.2.2.3.1-1 shows a scenario where the NF service consumer (I-CSCF), after authorization information has been performed without obtaining an S-CSCF name, sends a request to the HSS to receive the UE’s S-CSCF capabilities (mandatory and/or optional). The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/ims-data/location-data/scscf-capabilities) and query parameters (e.g. supported-features).

Figure 5.3.2.2.3.1-1: S-CSCF Capabilities Retrieval

1. The NF service consumer (I-CSCF) sends a GET request to the resource representing the UE’s S-CSCF capabilities with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the UE’s S-CSCF capabilities relevant for the requesting NF service consumer. The type of S-CSCF capabilities (mandatory and/or optional) is included in the response.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.3.2 Server Name Retrieval

Figure 5.3.2.2.3.2-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the Server Name (S-CSCF name) associated to the UE. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (ims-data/location-data/server-name) and query parameters (e.g. supported-features).

Figure 5.3.2.2.3.2-1: Server Name Retrieval

1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE’s IMS location information with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the IMS location information (S-CSCF name) as relevant for the service consumer.

2b. If there is no valid data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.3.3 IMS Registration Status Retrieval

Figure 5.3.2.2.3.3-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to IMS registration status of a user. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (ims-data/registration-status) and query parameters (e.g. supported-features).

Figure 5.3.2.2.3.3-1: IMS Registration Status Retrieval

1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE’s IMS registration status with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the IMS registration status (e.g. unregistered) as relevant for the service consumer.

2b. If there is no valid data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.3.4 S-CSCF Selection Assistance Information Retrieval

Figure 5.3.2.2.3.4-1 shows a scenario where the NF service consumer (I-CSCF), sends a request to the HSS to receive the UE’s S-CSCF Selection Assistance Information. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/ims-data/location-data/scscf-selection-assistance-info) and query parameters (e.g. supported-features).

5.3.2.2.3.4-1: S-CSCF Selection assistance Information Retrieval

1. The NF service consumer (I-CSCF) sends a GET request to the resource representing the UE’s S-CSCF Selection Assistance Information with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the UE’s S-CSCF Selection Assistance Information.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.4 IMS Profile Data

5.3.2.2.4.1 IMS User Profile Retrieval

Figure 5.3.2.2.4.1-1 shows a scenario where the NF service consumer (S-CSCF) sends a request to the HSS to receive the UE’s IMS profile data. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/ims-data/profile-data) and query parameters (e.g. supported-features).

Figure 5.3.2.2.4.1-1: IMS User Profile Retrieval

1. The NF service consumer (S-CSCF) sends a GET request to the resource representing the UE’s IMS profile with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the UE’s Profile Data as relevant for the requesting NF service consumer. The Initial Filter Criteria (IFC) is included in the response. Additional information (e.g. service priority information, chargingInfo, serviceLevelTraceInfo, maxAllowedSimulReg), if any, may also be included.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.4.2 Service Priority Level Information Retrieval

Figure 5.3.2.2.4.2-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the Service Priority levels allowed for the UE. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (ims-data/profile-data/priority-levels) and query parameters (e.g. supported-features).

Figure 5.3.2.2.4.2-1: Service Priority Level Information Retrieval

1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE’s Service Priority Level with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the Namespaces and priority levels allowed for the user.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.4.3 Initial Filter Criteria Retrieval

Figure 5.3.2.2.4.3-1 shows a scenario where the NF service consumer (e.g. AS, S-CSCF) sends a request to the HSS to receive the UE’s Initial Filter Criteria. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (ims-data/profile-data/ifcs) and query parameters (e.g. supported-features).

Figure 5.3.2.2.4.3-1: Initial Filter Criteria Retrieval

1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE’s IMS profile with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the UE’s Initial Filter Criteria (possibly containing S-CSCF-Specific IFC Set Identifiers, if supported and configured in S-CSCF) as relevant for the requesting NF service consumer.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.4.4 Service Trace Level Information Retrieval

Figure 5.3.2.2.4.4-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the UE’s IMS service level trace information associated to the UE. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (ims-data/profile-data/ service-level-trace-info) and query parameters (e.g. supported-features).

Figure 5.3.2.2.4.4-1: Service Trace Level Information Retrieval

1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE’s IMS service level trace information with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the IMS service level trace information (see 3GPP TS 24.323 [24]) so that the service consumer performs logging at IMS service level as described in IETF RFC 8497 [23].

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.4.5 Charging Information Retrieval

Figure 5.3.2.2.4.5-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the UE’s charging information. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (ims-data/profile-data/ charging-info) and query parameters (e.g. supported-features).

Figure 5.3.2.2.4.5-1: Charging Information Retrieval

1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE’s charging information with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the ChargingInfo.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.5 Access Data

5.3.2.2.5.1 Location Information Retrieval for CS/PS Domains

Figure 5.3.2.2.5.1-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the Location Information associated to the UE The request contains the UE’s identity (/{imsUeId}), the type of the requested information, the domain (cs-domain or ps-domain) requested (e.g. ims-data/access-data/ps-domain/location-data) and query parameters (e.g. supported-features, requested-nodes).

Figure 5.3.2.2.5.1-1: Location Information Retrieval for CS/PS Domains

1a. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE’s location information at PS domain with query parameters indicating the supported-features and optionally the requested nodes (e.g. MME, AMF)

1b. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE’s location information at CS domain with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the location information for the requested domain (PS) and the requested nodes or all nodes (if no requested nodes were present in the request)

2b. On success, the HSS responds with "200 OK" with the message body containing the location information for the requested domain (CS).

2c. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.5.2 IP Address Information Retrieval

Figure 5.3.2.2.5.2-1 shows a scenario where the NF service consumer (e.g. SCC-AS) sends a request to the HSS to receive the IP Address of the UE. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/access-data/ps-domain/ip-address) and query parameters (e.g. supported-features).

Figure 5.3.2.2.5.2-1: IP Address Information Retrieval

1. The NF service consumer (e.g. SCC-AS) sends a GET request to the resource representing the UE’s IP address information with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing either an IPv4 address, IPv6 address or IPv6 prefix and/or IPv6 interface identifier.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.5.3 T-ADS Information Retrieval

Figure 5.3.2.2.5.3-1 shows a scenario where the NF service consumer (e.g. SCC-AS) sends a request to the HSS to receive the T-ADS information for the UE. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/access-data/ps-domain/tads-info) and query parameters (e.g. supported-features).

Figure 5.3.2.2.5.3-1: T-ADS Information Retrieval

1. The NF service consumer (e.g. SCC-AS) sends a GET request to the resource representing the UE’s T-ADS information with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the most recent IMS Voice over PS Sessions support indication as indicated by the serving nodes.for the user.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.5.4 User State Retrieval for CS/PS Domains

Figure 5.3.2.2.5.4-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to receive the User State associated to the UE The request contains the UE’s identity (/{imsUeId}), the type of the requested information, the domain (cs-domain or ps-domain) requested (e.g. ims-data/access-data/ps-domain/user-state) and query parameters (e.g. supported-features, requested-nodes).

Figure 5.3.2.2.5.4-1: User State Retrieval for CS/PS Domains

1a. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE’s user state information at PS domain with query parameters indicating the supported-features and optionally the requested nodes (e.g. MME, AMF)

1b. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE’s User State information at CS domain with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the User State information for the requested domain (PS) and the requested nodes or all nodes (if no requested nodes were present in the request)

2b. On success, the HSS responds with "200 OK" with the message body containing the User State information for the requested domain (CS).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.5.5 CSRN Retrieval

Figure 5.3.2.2.5.5-1 shows a scenario where the NF service consumer (e.g. SCC-AS) sends a request to the HSS to receive a CS Domain Routeing Number (CSRN, see 3GPP TS 23.003 [13]) for the UE. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/access-data/cs-domain/csrn) and query parameters (e.g. supported-features, pre-paging).

Figure 5.3.2.2.5.5-1: T-ADS Information Retrieval

1. The NF service consumer (e.g. SCC-AS) sends a GET request to the resource representing the UE’s CSRN information with query parameters indicating the supported-features and/or pre-paging indication.

2a. On success, the HSS responds with "200 OK" with the message body containing the CSRN as provided by the MSC/VLR.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.5.6 Reference Location Information Retrieval

Figure 5.3.2.2.5.6-1 shows a scenario where the NF service consumer (e.g. IMS-AS) sends a request to the HSS to receive the reference location information for the UE. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/access-data/wireline-domain/reference-location) and query parameters (e.g. supported-features).

Figure 5.3.2.2.5.6-1: Reference Location Information Retrieval

1. The NF service consumer (e.g. IMS-AS) sends a GET request to the resource representing the UE’s reference location information with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the access type and/or the access info and associated value (line identifier in fixed access networks).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.6 SRVCC Data

5.3.2.2.6.1 SRVCC Data Retrieval

Figure 5.3.2.2.6.1-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to retrieve the SRVCC data for the UE. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/srvcc-data) and query parameters (e.g. supported-features).

Figure 5.3.2.2.6.2-1: SRVCC Data Retrieval

1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the UE’s SRVCC data information with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the STN-SR and the UE SRVCC capability for the user.

2b. If there is no valid SRVCC data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.7 Service Data

5.3.2.2.7.1 PSI Activation State Retrieval

Figure 5.3.2.2.7.1-1 shows a scenario where the NF service consumer (e.g. AS) sends a request to the HSS to retrieve the PSI activation state. The request contains the Public Service Identity (/{imsUeId}), the type of the requested information (/service-data/psi-status) and query parameters (e.g. supported-features).

Figure 5.3.2.2.7.1-1: PSI Activation State Retrieval

1. The NF service consumer (e.g. AS) sends a GET request to the resource representing the PSI activation state with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the PSI activation state (active or inactive).

2b. If there is no valid activation state for the PSI, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.7.2 SMS Registration Information retrieval

Figure 5.3.2.2.7.2-1 shows a scenario where the NF service consumer (e.g. IP-SM-GW) sends a request to the HSS to retrieve the SMS registration information associated to a UE. The request contains the UE identity (/{imsUeId}), the type of the requested information (/service-data/sms-registration-info) and query parameters (e.g. supported-features).

Figure 5.3.2.2.7.2-1: SMS Registration Information Retrieval

1. The NF service consumer (e.g. IP-SM-GW) sends a GET request to the resource representing the SMS registration information with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the IP-SM-GW number and optionally the SC address.

2b. If there is no valid SMS registration information, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.7.3 DSAI Information retrieval

Figure 5.3.2.2.7.3-1 shows a scenario where the NF service consumer (e.g. IMS-AS) sends a request to the HSS to retrieve the DSAI information associated to an Application Server. The request contains the UE identity (/{imsUeId}), the type of the requested information (/service-data/dsai) and query parameters (e.g. Application Server Name).

Figure 5.3.2.2.7.3-1: DSAI Information Retrieval

1. The NF service consumer (e.g. IMS-AS) sends a GET request to the resource representing the DSAI information with query parameter indicating the Application Server Name. Additional query parameters (e.g.supported-features) may be included.

2a. On success, the HSS responds with "200 OK" with the message body containing the DSAI tags and their respective status associated to the received Application Server Name.

2b. If there are no DSAI tags for the Application Server, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.8 Repository Data

5.3.2.2.8.1 Repository Data Retrieval

Figure 5.3.2.2.8.1-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE’s Repository Data for a given Service Indication. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/repository-data/{serviceIndication}) and query parameters (e.g. supported-features).

Figure 5.3.2.2.8.1-1: Repository Data Retrieval

1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE’s Repository Data for a given Service Indication, with query parameters indicating the supported-features.

2a. On success, the HSS responds with "200 OK" with the message body containing the UE’s Repository Data for the requested Service Indication as relevant for the requesting NF service consumer.

2b. If there is no valid subscription data or Repository Data for the UE, HTTP status code "404 Not Found" shall be returned and it should include additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.8.2 Repository Data Retrieval for multiple service indications

Figure 5.3.2.2.8.2-1 shows a scenario where the NF service consumer (IMS-AS) sends a request to the HSS to receive the UE’s Repository Data for multiple Service Indications. The request contains the UE’s identity (/{imsUeId}), the type of the requested information (/repository-data) and query parameters (e.g. list of service indications, supported-features).

Figure 5.3.2.2.8.2-1: Repository Data Retrieval for multiple service indications

1. The NF service consumer (IMS-AS) sends a GET request to the resource representing the UE’s Repository Data, with query parameters indicating the supported-features and list of service indications.

2a. On success, the HSS responds with "200 OK" with the message body containing the UE’s Repository Data for the requested Service Indications as relevant for the requesting NF service consumer.

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.2.9 Shared Subscription Data

5.3.2.2.9.1 Shared Subscription Data Retrieval

Figure 5.3.2.2.9.1-1 shows a scenario where the NF service consumer (e.g.S-CSCF) sends a request to the HSS to receive the shared subscription data. The request contains the type of the requested information (/shared-data) and query parameters (supportedFeatures, shared-data-id).

Figure 5.3.2.2.9.1-1: Shared Subscription Data Retrieval

1. The NF service consumer (e.g. S-CSCF) sends a GET request to the resource representing the SharedData, with query parameters indicating the supportedFeatures and shared-data-id.

2a. On success, the HSS responds with "200 OK" with the message body containing the SharedData.

2b. If there is no valid shared data for one or more of the shared-data-ids, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the GET response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.3 Subscribe

5.3.2.3.1 General

The following procedures using the Subscribe service operation are supported:

– Subscription to notification of data change

– Subscription to notification of UE reachability for IP

5.3.2.3.2 Subscription to notifications of data change

Figure 5.3.2.3.2-1 shows a scenario where the NF service consumer (e.g. S-CSCF) sends a request to the HSS to subscribe to notifications of data change. The request contains a callback URI and the URI of the monitored resource.

Figure 5.3.2.3.2-1: NF service consumer subscribes to notifications

1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (…/{imsUeId}/sdm-subscriptions), to create a subscription as present in message body.

2a. On success, the HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription.

2b. If there is no valid subscription data for the UE, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

2c. If the UE subscription data exist, but the requested subscription to data change notification cannot be created (e.g. due to an invalid/unsupported data reference to be monitored, contained in the ImsSdmSubscription parameter), HTTP status code "501 Not Implemented" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.3.3 Subscription to notifications of shared data change

Figure 5.3.2.3.3-1 shows a scenario where the NF service consumer sends a request to the HSS to subscribe to notifications of shared data change. The request contains a callback URI and the URI of the monitored resource.

Figure 5.3.2.3.3-1: NF service consumer subscribes to notifications of shared data change

1. The NF service consumer sends a POST request to the parent resource (collection of subscriptions) (…/shared-data-subscriptions), to create a subscription as present in message body.

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.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.3.4 Subscriptions to notification of UE Reachability for IP

Figure 5.3.2.3.4-1 shows a scenario where the NF service consumer (e.g. IP-SM-GW) sends a request to the HSS to subscribe to UE reachability for IP. The request contains the UE’s identity (/{imsUeId}), the resource to be monitored (/access-data/ps-domain/ue-reach-subscriptions), an expiry time, a callback URI and query parameters (e.g. supported-features).

Subscriptions to notification on UE Reachability for IP are requests for a one-time notification, i.e. after notification the subscription becomes invalid.

Figure 5.3.2.3.4-1: Subscription to notification of UE reachability for IP

1. The NF service consumer (e.g. IP-SM-GW) sends a POST request to the parent resource (collection of UE reachability subscriptions) (…/{ueIdentity}/ue-reach-subscriptions), to create a subscription to UE reachability for IP. The request contains an expiry time, suggested by the NF Service Consumer, representing the time upto which the subscription is desired to be kept active and the time after which the UE reachability event shall not generate a notification.

2a. On success, the HSS sets the URRP flag for the relevant serving nodes and may contact UDM (see 3GPP TS 23.632, clause 5.4.5). The HSS responds with "201 Created" with the message body containing a representation of the created subscription. The Location HTTP header shall contain the URI of the created subscription.

The response contains the expiry time, as determined by the HSS (possible based on operator policy) after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the HSS. The NF Service Producer shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time.

2b. If the user does not exist, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the POST response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.4 Unsubscribe

5.3.2.4.1 General

The following procedures using the Unsubscribe service operation are supported:

– Unsubscribe to notification of data change

– Unsubscribe to notification of UE reachability for IP

5.3.2.4.2 Unsubscribe to notifications of data change

Figure 5.3.2.4.2-1 shows a scenario where the NF service consumer (e.g. S-CSCF) sends a request to the HSS to unsubscribe from notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription.

Figure 5.3.2.4.2-1: NF service consumer unsubscribes to notifications

1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation.

2a. On success, the HSS responds with "204 No Content".

2b. If there is no valid subscription available (e.g. due to an unknown subscriptionId value), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.4.3 Unsubscribe to notifications of shared data change

Figure 5.3.2.4.3-1 shows a scenario where the NF service consumer sends a request to the HSS to unsubscribe from notifications of shared data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription.

Figure 5.3.2.4.3-1: NF service consumer unsubscribes to notifications for shared data

1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation.

2a. On success, the HSS responds with "204 No Content".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.4.4 Unsubscribe to notification of UE Reachability for IP

Figure 5.3.2.4.4-1 shows a scenario where the NF service consumer (e.g. IP-SM-GW) sends a request to the HSS to unsubscribe from notifications of UE Reachability for IP. The request contains the URI previously received in the Location HTTP header of the response to the subscription.

Figure 5.3.2.4.4-1: Unsubscription to notification of UE reachability for IP

1. The NF service consumer sends a DELETE request to the resource identified by the URI previously received during subscription creation.

2a. On success, the HSS responds with "204 No Content".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the DELETE response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.5 ModifySubscription

5.3.2.5.1 General

The following procedures using the ModifySubscription service operation are supported:

– Modification of a Subscription to notification of data change (for UE individual data)

– Modification of a Subscription to notification of shared data change

– Modification of a Subscription to notification of UE Reachability for IP

The ModifySubscription service operation can be used for the following purpose:

– Extend the expiry time of ImsSdmSubscription;

– Extend the expiry time of UeReachabilitySubscription;

– Modify the resource URIs to be monitored, e.g. add/remove resource URIs to/from the monitored resource URI list.

5.3.2.5.2 Modification of a subscription to notifications of data change

Figure 5.3.2.5.2-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription.

Figure 5.3.2.5.2-1: NF service consumer modifies a subscription to notifications

1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation.

The NF service consumer may include "monitoredResourceUris" to replace the existing monitored resource URIs, e.g. to add/remove specific resource URIs from the monitored resource URI list.

2a. On success, the HSS responds with "200 OK" or "204 No Content".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.5.3 Modification of a subscription to notifications of shared data change

Figure 5.3.2.z.3-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of shared data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription.

Figure 5.3.2.5.3-1: NF service consumer modifies a subscription to notifications for shared data

1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation.

The NF service consumer may include "monitoredResourceUris" to replace the existing monitored resource URIs, e.g. for the purposes to add/remove specific resource URIs from the monitored resource URI list.

2a. On success, the HSS responds with "200 OK" or "204 No Content".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.5.4 Modification of a subscription to notifications of data change

Figure 5.3.2.5.4-1 shows a scenario where the NF service consumer sends a request to the HSS to modify a subscription to notifications of data changes. The request contains the URI previously received in the Location HTTP header of the response to the subscription.

Figure 5.3.2.5.4-1: NF service consumer modifies a subscription to notifications

1. The NF service consumer sends a PATCH request to the resource identified by the URI previously received during subscription creation.

The NF service consumer includes a new expiry time, e.g. to extend the monitoring time of the event.

2a. On success, the HSS responds with "200 OK" or "204 No Content".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.6 Notification

5.3.2.6.1 General

The following procedures using the Notification service operation are supported:

– Data change notification to NF;

– UE Reachability for IP notification to NF.

5.3.2.6.2 Data Change Notification To NF

Figure 5.3.2.6.2-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change. The request contains the callbackReference URI as previously received in the ImsSdmSubscription.

Figure 5.3.2.6.2-1: Subscription Data Change Notification

1. The HSS sends a POST request to the callbackReference as provided by the NF service consumer during the subscription.

2. The NF service consumer responds with "204 No Content".

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.

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 an alternative notification endpoint.

5.3.2.6.3 UE Reachability for IP Notification to NF

Figure 5.3.2.6.3-1 shows a scenario where the HSS notifies the NF service consumer (that has subscribed to receive such notification) about subscription data change. The request contains the callbackReference URI as previously received in the UeReachabilitySubscription.

Figure 5.3.2.6.3-1: UE Reachability for IP Notification

1. The HSS sends a POST request to the callbackReference as provided by the NF service consumer during the subscription. The notification includes information about UE reachability for IP event detected.

2. The NF service consumer responds with "204 No Content".

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.

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 an alternative notification endpoint.

5.3.2.7 Update

5.3.2.7.1 General

The following procedures using the Update service operation are supported:

– Repository Data Create/Update/Delete

– STN-SR update

– SMS registration information Create/Update/Delete

– PSI activation state Update

– DSAI-tag activation state Update

5.3.2.7.2 Repository Data Creation or Update

Figure 5.3.2.7.2-1 shows a scenario where the IMS-AS sends a request to the HSS to create or update the repository data for a given service indication. The request contains the UE’s identity (/{imsUeId}) which shall be an IMS Public Identity, the service indication and repository data with the associated version (sequence number).

Figure 5.3.2.7.2-1: IMS AS creating or updating repository data

1. The IMS AS sends a PUT request to the resource representing the UE’s Repository Data for a requested Service Indication.

The IMS AS may request the creation of the Repository Data (sequence number equal to zero) or may request the update of the Repository Data (sequence number greater than zero)

2a. On success, the HSS updates the RepositoryData resource by replacing it with the received resource information, and responds with "200 OK" or "204 No Content".

2b. If the resource does not exist (there is no repository data associated to the requested service indication), HSS stores the received Repository Data and responds with HTTP Status Code "201 created". A response body may be included to convey additional information to the NF consumer (e.g., features supported by HSS).

2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the service indication and the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information 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 PUT response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.7.3 Repository Data Deletion

Figure 5.3.2.7.3-1 shows a scenario where the IMS-AS sends a request to the HSS to delete the repository data for a given service indication. The request contains the UE’s identity (/{imsUeId}) which shall be an IMS Public Identity and the service indication.

Figure 5.3.2.7.3-1: IMS AS deleting repository data

1. The IMS AS sends a DELETE request to the resource representing the UE’s Repository Data for a requested Service Indication.

2a. On success, the HSS deletes the resource and responds with "204 No Content".

2b. If the repository data does not exist in the HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the service indication and operation requested, HTTP status code "403 Forbidden" should be returned including additional error information 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 DELETE response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.7.4 STN-SR update

Figure 5.3.2.7.4-1 shows a scenario where the IMS-AS sends a request to the HSS to update the STN-SR. The request contains the UE’s identity (/{imsUeId}) which shall be an IMS Public Identity or a Private Identity and an instruction to modify the STN-SR.

Figure 5.3.2.7.4-1: IMS AS updating STN-SR

1. The IMS AS sends a PATCH request to the resource representing the UE’s SRVCC Data.

2a. On success, the HSS responds with "204 No Content".

2b. If the resource does not exist (i.e. the user is not subscribed to SRVCC), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element).

2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions for the operation requested, HTTP status code "403 Forbidden" should be returned including additional error information 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 PATCH response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.7.5 PSI activation state update

Figure 5.3.2.7.5-1 shows a scenario where the IMS-AS sends a request to the HSS to update the PSI activation state. The request contains the Public Service Identity (/{imsUeId}) and an instruction to modify the activation state.

Figure 5.3.2.7.5-1: IMS AS updating a PSI activation state

1. The IMS AS sends a PATCH request to the resource representing the PSI activation state.

2a. On success, the HSS responds with "204 No Content".

2b. If the resource does not exist (i.e. the service does not exist), HTTP status code "404 Not Found" should be returned including additional error information in the response body (in the "ProblemDetails" element).

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.7.6 SMS Registration Information Creation or Update

Figure 5.3.2.7.6-1 shows a scenario where the IMS-AS sends a request to the HSS to create or update the SMS registration information. The request contains the UE’s identity (/{imsUeId}) which shall be an IMS Public Identity and the SMS registration information (IP-SM-GW number).

Figure 5.3.2.7.6-1: IMS AS creating or updating the SMS registration information

1. The IMS AS sends a PUT request to the resource representing the UE’s SMS registration information. The request contains the IP-SM-GW number and, if s6c is supported, the Diameter Identity and Diameter Realm of the IP-SM-GW.

If the IP-SM-GW supports SBI-based MT SM transmit, the "SBI support indication" of the IP-SM-GW shall be included in the SMS Registration Information.

2a. On success, the HSS updates the SMS registration information resource by replacing it with the received resource information and responds with "200 OK" or "204 No Content".

2b. If the resource does not exist (there is no IP-SM-GW number associated to the user), HSS stores the received SMS registration information and responds with HTTP Status Code "201 created". A response body may be included to convey additional information to the NF consumer (e.g., features supported by HSS).

2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions or the IP-SM-GW number is pre-configured and cannot be overwritten, HTTP status code "403 Forbidden" should be returned including additional error information 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 PUT response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.7.7 SMS Registration Information Deletion

Figure 5.3.2.7.7-1 shows a scenario where the IMS-AS sends a request to the HSS to delete the SMS registration information. The request contains the UE’s identity (/{imsUeId}) which shall be an IMS Public Identity.

Figure 5.3.2.7.7-1: IMS AS deleting SMS registration information

1. The IMS AS sends a DELETE request to the resource representing the UE’s SMS registration information.

2a. On success, the HSS deletes the resource and responds with "204 No Content".

2b. If the SMS registration information does not exist in the HSS, HTTP status code "404 Not Found" shall be returned including additional error information in the response body (in the "ProblemDetails" element).

2c. If the operation is not authorized due to e.g IMS AS does not have the required permissions or the IP-SM-GW number is pre-configured and cannot be deleted, HTTP status code "403 Forbidden" should be returned including additional error information 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 DELETE response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.

5.3.2.7.8 DSAI tag activation state update

Figure 5.3.2.7.8-1 shows a scenario where the IMS-AS sends a request to the HSS to update the DSAI tag activation state. The request contains the Public Service Identity (/{imsUeId}) and an instruction to modify the activation state of DSAI tag.

Figure 5.3.2.7.8-1: IMS AS updating DSAI tag activation state

1. The IMS AS sends a PATCH request to the resource representing the DSAI tag activation state.

2a. On success, the HSS responds with "204 No Content".

On failure, the appropriate HTTP status code indicating the error shall be returned and appropriate additional error information should be returned in the PATCH response body.

In the case of redirection, the HSS shall return 3xx status code, which shall contain a Location header with an URI pointing to the endpoint of another HSS (service) instance.