sor-information

(Document)

/{supi}/sor-information

GET

Retrieve the SoR information.

sor-ack

(Document)

/{supi}/sor-information/sor-ack

PUT

Inform the SOR-AF of the reception status of the Acknowledgment of successful reception of SoR information by the UE.

apiRoot

string

See clause 6.1.1

supi

Supi

Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "^(imsi-[0-9]{5,15}|nai-.+|.+)$"

supported-features

SupportedFeatures

O

0..1

See clause 6.1.8, and 3GPP TS 29.500 [4] clause 6.6.

plmn-id

PlmnIdNid

M

1

Identity of the PLMN or SNPN serving the UE.

access-type

AccessType

O

0..1

Access type used by the UE.

n/a

SorInformation

M

1

200 OK

Upon success, a response with "200 OK" status code and a response body containing the SoR information as requested by the NF consumer (e.g. UDM) shall be returned by the SOR-AF.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP.

(NOTE 2)

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

NOTE 1: The manadatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponses may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Cache-Control

string

M

1

The Cache-Control HTTP header is set to the value "no-cache" instructing the NF consumer (e.g. UDM) to not cache the received SoR information.

Location

string

M

1

A URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP.

Location

string

M

1

A URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP.

apiRoot

string

See clause 6.1.1

supi

Supi

Represents the Subscription Permanent Identifier (see 3GPP TS 23.501 [2] clause 5.9.2)
pattern: "^(imsi-[0-9]{5,15}|nai-.+|.+)$"

n/a

SorAckInfo

M

1

Contains an indication on the reception status of the acknowledgment of successful reception of SoR information by the UE.

n/a

204 No Content

Upon success, a response with "204 No Content" status code shall be returned.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP.

(NOTE 2)

ProblemDetails

O

0..1

404 Not Found

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

– USER_NOT_FOUND

NOTE 1: The manadatory HTTP error status code for the PUT method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponses may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

A URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP.

Location

string

M

1

A URI pointing to a resource located on alternative SOR-AF or the initial target SOR-AF when this is a redirection triggered by an SCP via another SCP.

SorInformation

6.1.6.2.2

Contains the SoR information to be conveyed to the UE.

SorAckInfo

6.1.6.2.3

Contains an indication to the SOR-AF on the reception status of the acknowledgment of successful reception of SoR Information by the UE.

SteeringContainer

6.1.6.2.x

It consists of either a list (array) of SteeringInfo objects, or a Secured Packet.

SteeringInfo

6.1.6.2.x

Contains a PLMN-ID, or SNPN-ID or a GIN, and, for the case of PLMNs, the preferred access technologies.

SorAckStatus

6.1.6.3.3

Contains the reception status of the acknowledgment of successful reception of SoR Information by the UE.

PlmnId

3GPP TS 29.571 [16]

PLMN Identity

PlmnIdNid

3GPP TS 29.571 [16]

SNPN Identity or GIN

ProblemDetails

3GPP TS 29.571 [16]

Common data type used in response bodies

RedirectResponse

3GPP TS 29.571 [10]

Redirect Response

SupportedFeatures

3GPP TS 29.571 [16]

see 3GPP TS 29.500 [4] clause 6.6

Supi

3GPP TS 29.571 [16]

Contains the SUPI information.

DateTime

3GPP TS 29.571 [16]

Date Time

AccessType

3GPP TS 29.571 [16]

Access type (e.g. 3GPP)

SorCmci

3GPP TS 29.503 [15]

Contains SOR-CMCI as defined in 3GPP TS 24.501 [18]

AccessTech

3GPP TS 29.509 [20]

List of access technologies

SecuredPacket

3GPP TS 29.509 [20]

Secured Packet

supportedFeatures

SupportedFeatures

O

0..1

Features supported by the SOR-AF (see clause 6.1.8).

steeringContainer

SteeringContainer

C

0..1

When present, this attribute contains the information needed to update the "Operator Controlled PLMN Selector with Access Technology" list stored in the UE, either as an array of preferred PLMN/Access Technologies combinations in priority order (with the first entry in the array indicating the highest priority and the last entry indicating the lowest) or a secured packet.

If no change of the "Operator Controlled PLMN Selector with Access Technology" list stored in the UE is needed, then this attribute shall be absent.

When the eNPN feature is supported, this IE may contain SOR information for SNPNs or GINs.

sorAckIndication

Boolean

M

1

This attribute indicates to the NF consumer (e.g. UDM) whether an Acknowledgment of successful reception of SoR information shall be requested to the UE (when set to "True") or not (when set to "False").

sorCmci

SorCmci

O

0..1

When present, provides the SOR-CMCI values as defined in 3GPP TS 24.501 [18]

If "ME Support of SOR-CMCI" as provided in meSupportOfSorCmci from UE to SOR-AF via AMF and UDM is not stored as "supported", then this attribute shall be absent.

Shall be absent if steeringContainer is provided with contents in secured packet.

storeSorCmciInMe

Boolean

O

0..1

When present, indicates "Store the SOR-CMCI in the ME" as supported as defined in 3GPP TS 23.122 [14] and 3GPP TS 24.501 [18].

If sorCmci is absent, then this attribute shall also be absent.

– True: Indicates to store the SOR-CMCI in the ME

– False or absent: Indicates storing the SOR-CMCI in the ME is not required

Shall be absent if steeringContainer is provided with contents in secured packet.

sorSendingTime

DateTime

M

1

Contains the date and time at which SOR-AF returns SorInformation.

It is used to correlate the SoR acknowledgement with the associated SoR information.

sorAckStatus

SorAckStatus

M

1

Contains the reception status of the acknowledgment of successful reception of SoR Information by the UE.

sorSendingTime

DateTime

M

1

Contains the date and time at which SOR-AF sent the SorInformation to which the acknowledgment status relates.

meSupportOfSorCmci

Boolean

O

0..1

When present, indicates "ME support of SOR-CMCI" sent from UE to SOR-AF via AMF and UDM as defined in 3GPP TS 23.122 [14] and 3GPP TS 24.501 [18].

– True: ME supports SOR-CMCI

– False or absent: ME does not support SOR-CMCI

array(SteeringInfo)

1..N

List of PLMN/AccessTechnologies combinations.

SecuredPacket

1

A secured packet containing one or more APDUs commands dedicated to Remote File Management.

plmnId

PlmnId

C

0..1

Contains a preferred PLMN identity.

(NOTE)

snpnId

PlmnIdNid

C

0..1

Contains a preferred SNPN identity.

(NOTE)

gin

PlmnIdNid

C

0..1

Contains a preferred Group ID for Network Selection.

(NOTE)

accessTechList

array(AccessTech)

O

1..N

This IE is only applicable when plmnId is present, and it shall be absent when snpnId or gin are present.

It contains the preferred access technologies for such PLMN, as listed in clause 6.2.6.3.3 of 3GPP TS 29.509 [20]. If absent it means that all access technologies are equivalently preferred in such PLMN.

NOTE: Exactly one of plmnId, snpnId or gin shall be present.

n/a

"ACK_SUCCESSFUL"

Indicates to the SOR-AF that the acknowledgment of successful reception of SoR information was received from the UE and the integrity check was successful.

"ACK_NOT_RECEIVED"

Indicates to the SOR-AF that the acknowledgment of successful reception of SoR information was NOT received from the UE.

"ACK_NOT_SUCCESSFUL"

Indicates to the SOR-AF that the acknowledgment of successful reception of SoR information was received from the UE and the integrity check was NOT successful.

USER_NOT_FOUND

404 Not Found

The user does not exist

This error is applicable to all Nsoraf_SOR operations.

1

eNPN

If this feature is supported, the query parameter "plmn-id" (see Table 6.1.3.2.3.1-1) is recognized by the SOR-AF as a PLMN-ID or an SNPN-ID, and the steeringContainer attribute (see clause 6.1.6.2.2) returned by the SOR-AF may include SOR information for SNPNs.

If this feature is not supported, such query parameter is recognized by the SOR-AF as a PLMN-ID, and the steeringContainer attribute contains only SOR information for PLMNs.