Repository Data
(Document)

/{imsUeId}/repository-data/{serviceIndication}

GET

Retrieve repository data for a service indication

DELETE

Delete repository data for a service indication

PUT

Update repository data for a service indication

Repository Data List (Document)

/{imsUeId}/repository-data

GET

Retrieve multiple repository data for a list of service indications

IMS Associated Identities
(Document)

/{imsUeId}/identities/ims-associated-identities

GET

Retrieve the UE’s IMS associated identities (implicit and alias)

MSISDNs
(Document)

/{imsUeId}/identities/msisdns

GET

Retrieve the UE’s MSISDNs (basic and additional)

PrivateIdentities
(Document)

/{imsUeId}/identities/private-identities

GET

Retrieve the UE’s Private Identities (IMPI and IMSI)

ImeiSvInformation
(Document)

/{imsUeId}/identities/imeisv

GET

Retrieve the UE’s IMEISV

IMS Profile Data

(Document)

/{imsUeId}/ims-data/profile-data

GET

Retrieve the UE’s subscribed Profile

Initial Filter Criteria
(Document)

/{imsUeId}/ims-data/
profile-data/ifcs

GET

Retrieve the UE’s subscribed Initial Filter Criteria

Service Level Trace Information
(Document)

/{imsUeId}/ims-data/profile-data/service-level-trace-info

GET

Retrieve the UE’s subscribed Service Level Trace Information

Service Priority Information
(Document)

/{imsUeId}/ims-data/
profile-data/priority-levels

GET

Retrieve the UE’s subscribed Service Priority Levels

Charging Information
(Document)

/{imsUeId}/ims-data/
profile-data/chargingInfo

GET

Retrieve the UE’s subscribed Charging Information

IMS Location Data
(Document)

/{imsUeId}/ims-data/location-data/server-name

GET

Retrieve the UE’s S-CSCF name

S-CSCF Capabilities
(Document)

/{imsUeId}/ims-data/location-data/scscf-capabilities

GET

Retrieve the UE’s S-CSCF capabilities (mandatory and/or optional)

S-CSCF Selection Assistance Information
(Document)

/{imsUeId}/ims-data/location-data/scscf-selection-assistance-info

GET

Retrieve the UE’s S-CSCF Selection Assistance Information

IMS Registration Status
(Document)

/{imsUeId}/ims-data/
registration-status

GET

Retrieve the UE’s IMS registration status.

Subscriptions
(Collection)

/{imsUeId}/subscriptions

POST

Create a subscription

Individual subscription
(Document)

/{imsUeId}/subscriptions/
{subscriptionId}

DELETE

Delete the subscription identified by {subscriptionId}, i.e. unsubscribe

PATCH

Modify the sdm-subscription identified by {subscriptionId}

PS Location Information(Document)

/{imsUeId}/access-data/
ps-domain/location-data

GET

Retrieve the UE’s location in PS domain

CS Location Information(Document)

/{imsUeId}/access-data/
cs-domain/location-data

GET

Retrieve the UE’s location in CS domain

PsUserState
(Document)

/{imsUeId}/access-data/
ps-domain/user-state

GET

Retrieve the UE’s state in PS domain

CsUserState
(Document)

/{imsUeId}/access-data/
cs-domain/user-state

GET

Retrieve the UE’s state in CS domain

TadsInfo
(Document)

/{imsUeId}/access-data/
ps-domain/tads-info

GET

Retrieve the UE’s T-ADS information

UeReachabilityIpSubscriptions
(Collection)

/{imsUeId}/access-data/
ps-domain/ue-reach-subscriptions

POST

Create a subscription to UE Reachability for IP

UE reachability individual subscription
(Document)

/{imsUeId}/access-data/
ps-domain/ue-reach-subscriptions/
{subscriptionId}

DELETE

Delete the subscription to UE reachability for IP identified by {subscriptionId}, i.e. unsubscribe

PATCH

Modify the subscription to UE reachability for IP identified by {subscriptionId}

IpAddress
(Document)

/{imsUeId}/access-data/
ps-domain/ip-address

GET

Retrieve the UE’s stored IP Address Secure Binding Information

Csrn

(Document)

/{imsUeId}/access-data/
cs-domain/csrn

GET

Retrieve a CSRN for the UE

ReferenceAccessLocation

(Document)

/{imsUeId}/access-data/wireline-domain/reference-location

GET

Retrieve the UE’s subscribed Reference Access Location

SRVCC Data

(Document)

/{imsUeId}/srvcc-data

GET

Retrieve the UE’s STN-SR and SRVCC capability

PATCH

Update the UE’s STN-SR.

PSI Activation State

(Document)

/{imsUeId}/service-data/
psi-status

GET

Retrieve a PSI activation status

PATCH

Update a PSI activation status

Dsai

(Document)

/{imsUeId}/service-data/dsai

GET

Retrieve DSAI data (i.e. DSAI tags and status) associated to an Application Server

PATCH

Update DSAI data associated to an Application Server

SMSRegistrationInfo

(Document)

/{imsUeId}/service-data/
sms-registration-info

GET

Retrieve the SMS Registration Information (e.g. IP-SM-GW address)

PUT

Creates or updates the SMS Registration Information (e.g. IP-SM-GW address)

DELETE

Deletes the SMS Registration Information (e.g. IP-SM-GW address)

SharedData
(Collection)

/shared-data

GET

Retrieve shared data

SharedDataSubscriptions
(Collection)

/shared-data-subscriptions

POST

Create a subscription

Shared Data Individual Subscription
(Document)

/shared-data-subscriptions/{subscriptionId}

DELETE

Delete the subscription identified by {subscriptionId}, i.e. unsubscribe

PATCH

Modify the subscription identified by {subscriptionId}

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

n/a

n/a

ImsAssociatedIdentities

M

1

200 OK

A response body containing the list of identities belonging to the same Implicit Registration Set shall be returned, together with the related information (Alias Group, if any, identity type, IRS default identity, registration state of the IRS).

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

private-id

PrivateId

O

0..1

IMS Private Identity (IMPI) of the UE. It shall be included if there are multiple Private Identities associated to the Public Identity received and the basic MSISDN (C-MSISDN) is requested.

n/a

MsisdnList

M

1

200 OK

A response body containing the list of MSISDNs associated to the UE and all Private Identities shall be returned. If the response is for a basic MSISDN (C-MSISDN) query (query parameter IMPI was present), only one MSISDN shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

n/a

n/a

ScscfCapabilityList

M

1

200 OK

A response body containing the list mandatory and/or optional capabilities shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

NOTE: DATA_NOT_FOUND indicates that any S-CSCF can be selected, e.g. based on I-CSCF local policy.

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

dataset-names

array(DataSetName)

O

1..N

Datasets to be retrieved

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

n/a

ImsProfileData

M

1

200 OK

Upon success, a response body containing the User’s Profile Data shall be included.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

n/a

ImsSdmSubscription

M

1

The subscription that is to be created.

ImsSdmSubscription

M

1

201 Created

Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

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

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

ProblemDetails

O

0..1

501 Not Implemented

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

– UNSUPPORTED_RESOURCE_URI

This response shall not be cached.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

subscriptionId

The subscriptionId identifies an individual subscription to notifications.

n/a

n/a

The request body shall be empty.

n/a

204 No Content

Upon success, an empty response body shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

array(PatchItem)

M

1

It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12].

n/a

204 No Content

Upon success, a response with no content is returned.

(NOTE 1)

PatchResult

M

1

200 OK

Upon success, the execution report is returned. (NOTE 1)

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

ProblemDetails

O

0..1

403 Forbidden

One or more attributes are not allowed to be modified.

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

– MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS 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 has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

n/a

ImsSdmSubscription

M

1

The subscription that is to be created.

ImsSdmSubscription

M

1

201 Created

Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

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

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

501 Not Implemented

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

– UNSUPPORTED_RESOURCE_URI

This response shall not be cached.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

subscriptionId

The subscriptionId identifies an individual subscription to notifications.

n/a

n/a

The request body shall be empty.

n/a

204 No Content

Upon success, an empty response body shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

The resource corresponding to the SubscriptionId can’t be found.

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

– SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

array(PatchItem)

M

1

It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12].

n/a

204 No Content

Upon success, a response with no content is returned. (NOTE 1)

PatchResult

M

1

200 OK

Upon success, the execution report is returned. (NOTE 1)

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

The resource corresponding to the SubscriptionId can’t be found.

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

– SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

ProblemDetails

O

0..1

403 Forbidden

One or more attributes are not allowed to be modified.

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

– MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS 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 has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

n/a

ImsRegistrationStatus

M

1

200 OK

A response body containing the IMS registration status of the user.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

DATA_NOT_FOUND indicates the user has not performed yet any IMS registration.

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

supported-features

SupportedFeatures

O

0..1

see 3GPP 1 29.500 [4] clause 6.6

n/a

PriorityLevels

M

1

200 OK

A response body containing the service priority information (priority namespaces and associated levels) allowed for the user shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user does not have priority service.

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

application-server-name

SipServerName

O

0..1

This information element indicates application server’s SIP URI.

n/a

Ifcs

M

1

200 OK

A response body containing the list of complete IFCs and/or shared IFC set identifiers shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

DATA_NOT_FOUND indicates that there is no Initial Filter Criteria associated to the user (i.e. no AS is triggered by S-CSCF for the user)

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

n/a

ImsLocationData

M

1

200 OK

A response body containing the S-CSCF name stored for the user.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

DATA_NOT_FOUND indicates the user has not performed yet any IMS registration.

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

n/a

ServiceLevelTraceInformation

M

1

200 OK

A response body containing the IMS service level trace information shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the service level tracing is disabled for the user.

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

requested-nodes

array(RequestedNode)

O

1..N

Indicates the serving node(s) for which the request is applicable.

serving-node

boolean

O

0..1

Indicates that only the stored NF id/address of the serving node(s) requested and PLMN identity are required, that is, other location data (e.g. Global Cell ID) is not required.

It shall be absent if current-location is present with value true.

true: only the requested node(s) address(es) are requested

false or absent: location data as retrieved from the requested node(s) is requested.

local-time

boolean

O

0..1

Indicates that only the Local Time Zone information (Time Zone and Daylight Saving Time) and the PLMN identity of the location in the visited network where the UE is attached is requested, that is, other location data (e.g. Global Cell ID) is not required.

true: only the local time is requested

false or absent: location data as retrieved from the requested node(s) is requested.

current-location

boolean

O

0..1

Indicates whether an active location retrieval has to be initiated by the requested node(s).

true: active location retrieval is requested

false or absent: active location retrieval is not requested

rat-type

boolean

O

0..1

Indicates whether retrieval of RAT type is requested.

true: requested

false: not requested

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

private-identity

PrivateId

C

0..1

Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities.

n/a

PsLocation

M

1

200 OK

A response body containing the PS location information as requested shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the location information is unknown or unavailable.

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

serving-node

boolean

O

0..1

Indicates that only the MSC/VLR address and PLMN identity are required, that is, other location data (e.g. Global Cell ID) is not required.

It shall be absent if current-location is present.

true: only the MSC/VLR number requested

false or absent: location data as retrieved from the MSC/VLR is requested.

local-time

boolean

O

0..1

Indicates that only the Local Time Zone information (Time Zone and Daylight Saving Time) and the PLMN identity of the location in the visited network where the UE is attached is requested, that is, other location data (e.g. Global Cell ID) is not required.

It shall be absent if current-location is present.

current-location

boolean

O

0..1

Indicates whether an active location retrieval has to be initiated by the MSC/VLR.

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

private-identity

PrivateId

C

0..1

Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities.

n/a

CsLocation

M

1

200 OK

A response body containing the CS location information as requested shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the location information is unknown or unavailable.

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

private-identity

PrivateId

C

0..1

Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities.

n/a

SrvccData

M

1

200 OK

A response body containing the STN-SR and the UE SRVCC capabilities for the user shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user is not subscribed to SRVCC.

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

private-identity

PrivateId

C

0..1

Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities.

array(PatchItem)

M

1..N

Items describe the modifications to the SRVCC data.

Modification are not applicable to UE SRVCC capabilities.

n/a

204 No Content

Upon success, an empty response body shall be returned. (NOTE 1)

PatchResult

M

1

200 OK

Upon success, the execution report is returned. (NOTE 1)

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user is not subscribed to SRVCC.

ProblemDetails

O

0..1

403 Forbidden

One or more attributes are not allowed to be modified.

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

– MODIFICATION_NOT_ALLOWED, see GPP TS 29.500 [4] table 5.2.7.2-1.

– OPERATION_NOT_ALLOWED

NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS 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 has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Service Identity

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

n/a

PsiActivationState

M

1

200 OK

A response body containing the PSI activation state shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– SERVICE_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

array(PatchItem)

M

1..N

Items describe the modifications to the PSI activation state.

n/a

204 No Content

Upon success, an empty response body shall be returned. (NOTE 1)

PatchResult

M

1

200 OK

Upon success, the execution report is returned. (NOTE 1)

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– SERVICE_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

One or more attributes are not allowed to be modified.

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

– MODIFICATION_NOT_ALLOWED, see GPP TS 29.500 [4] table 5.2.7.2-1.

– OPERATION_NOT_ALLOWED

NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS 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 has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

serviceIndication

Represents the identifier of a service related data.

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

n/a

RepositoryData

M

1

200 OK

A response body containing the Repository Data for the requested Service Indication.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

n/a

RepositoryData

M

1

The Repository Data to be created or replaced.

RepositoryData

M

1

201 Created

Upon success, a response body containing a representation of the created Individual RepositoryData resource shall be returned.

RepositoryData

M

1

200 OK

Upon success, a response body containing a representation of the updated Individual RepositoryData resource shall be returned.

n/a

204 No Content

Upon success, an empty response body shall be returned

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

ProblemDetails

O

0..1

409 Conflict

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

– OUT_OF_SYNC

ProblemDetails

O

0..1

413 Payload Too Large

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

– TOO_MUCH_DATA

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

n/a

n/a

The request body shall be empty.

n/a

204 No Content

Upon success, an empty response body shall be returned

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no repository data exists for the requested service indication.

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

shared-data-ids

array(SharedDataId)

M

1..N

n/a

array(SharedData)

M

1..N

200 OK

Upon success, a response body containing a list of SharedData shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– DATA_NOT_FOUND

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

private-identity

PrivateId

C

0..1

Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities.

n/a

ImeiSvInformation

M

1

200 OK

A response body containing the IMEI(SV) information for the user shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. non-shared IMS Public User identity) or the IMS Private Identity.

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

n/a

IpAddr

M

1

200 OK

A response body containing the IP address (IPv4, Ipv6, Ipv6 prefix and/or IPv6 interface identifier) for the user shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

DATA_NOT_FOUND indicates that no IP Address is currently allocated for the user.

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

private-identity

PrivateId

C

0..1

Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities.

n/a

TadsInformation

M

1

200 OK

A response body containing the T-ADS information (most recent VoPS support) for the user shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

private-identity

PrivateId

C

0..1

Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities.

UeReachabilitySubscription

M

1

The subscription to UE reachability for IP that is to be created.

CreatedUeReachabilitySubscription

M

1

201 Created

Upon success, a response body containing a representation of the created Individual subscription resource shall be returned.

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

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity)

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

subscriptionId

The subscriptionId identifies an individual subscription to notification of UE reachability for IP.

private-identity

PrivateId

C

0..1

Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities.

n/a

The request body shall be empty.

n/a

204 No Content

Upon success, an empty response body shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

private-identity

PrivateId

C

0..1

Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities.

array(PatchItem)

M

1

It contains the list of changes to be made to the resource representing the individual subscription, according to the JSON PATCH format specified in IETF RFC 6902 [12].

n/a

204 No Content

Upon success, a response with no content is returned.

(NOTE 1)

PatchResult

M

1

200 OK

Upon success, the execution report is returned. (NOTE 1)

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– SUBSCRIPTION_NOT_FOUND, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

ProblemDetails

O

0..1

403 Forbidden

One or more attributes are not allowed to be modified.

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

– MODIFICATION_NOT_ALLOWED, see 3GPP TS 29.500 [4] table 5.2.7.2-1.

NOTE 1: If all the modification instructions in the PATCH request have been implemented, the HSS 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 has included in the supported-feature query parameter the "PatchReport" feature number, the HSS shall respond with PatchResult.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

requested-nodes

array(RequestedNode)

O

1..N

Indicates the serving node(s) for which the request is applicable.

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

private-identity

PrivateId

C

0..1

Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities.

n/a

PsUserState

M

1

200 OK

A response body containing the PS user state information as requested shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

– DATA_NOT_FOUND

DATA_NOT_FOUND indicates that the user state information is unknown or unavailable.

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity or Public Service Identity) or the IMS private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

private-identity

PrivateId

C

0..1

Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities.

n/a

CsUserState

M

1

200 OK

A response body containing the CS user state information as requested shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI. The URI shall be an alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

ProblemDetails

O

0..1

403 Forbidden

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

– OPERATION_NOT_ALLOWED

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same HSS (service) set.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected.

apiRoot

See clause 6.2.1

apiVersion

See clause 6.2.1

imsUeId

Represents the IMS Public Identity (i.e. IMS Public User identity) or the IMS Private Identity. If both the IMS Public Identity and the IMS Private Identity are available at the service consumer, the imsUeId represents the IMS Public Identity.

pattern: "^(impu-sip\:([a-zA-Z0-9_\-.!~*()&=+$,;?\/]+)\@([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}|impu-tel\:\+[0-9]{5,15}|impi-.+|.+)$"

supported-features

SupportedFeatures

O

0..1

see 3GPP TS 29.500 [4] clause 6.6

pre-paging

PrePaging

O

0..1

Indicates if pre-paging is supported

true: pre-paging is supported

false or absent: pre-paging is not supported

private-identity

PrivateId

C

0..1

Represents the IMS Private Identity.
Shall be present if the imsUeId variable in the resource URI takes the value of an IMS Public User Identity that is shared by several Private User Identities.