5.13 MoLcsNotify API

29.5223GPP5G SystemNetwork Exposure Function Northbound APIsRelease 18Stage 3TS

5.13.1 Resources

There is no resource defined for this API.

5.13.2 Notifications

5.13.2.1 Introduction

Upon receipt of a UE location information update notification from the GMLC, the NEF shall send an HTTP POST message in order to notify the AF of the updated UE location information.

5.13.2.2 Event Notification

Callback URI: {notificationDestination} shall be used with the callback URI variables defined in table 5.13.2.2-1.

Table 5.13.2.2-1: Callback URI variables

Name

Definition

notificationDestination

A URI indicating the notification destination where N33 notification requests shall be delivered to.

This URI shall be preconfigured in the NEF.

5.13.2.3 Operation Definition

5.13.2.3.1 Notification via HTTP POST

This method shall support the request data structures specified in table 5.13.2.3.1-1 and the response data structures and response codes specified in table 5.13.2.3.1-2.

Table 5.13.2.3.1-1: Data structures supported by the POST Request Body on this resource

Data type

P

Cardinality

Description

LocUpdateData

M

1

Delivers UE location to AF during MO-LR procedure

Table 5.13.2.3.1-2: Data structures supported by the POST Response Body on this resource

Data type

P

Cardinality

Response

codes

Description

LocUpdateDataReply

M

1

200 OK

The notification is received successfully.

N/A

307 Temporary Redirect

Temporary redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

N/A

308 Permanent Redirect

Permanent redirection, during notification. The response shall include a Location header field containing an alternative URI representing the end point of an alternative AF where the notification should be sent.

Redirection handling is described in clause 5.2.10 of 3GPP TS 29.122 [4].

NOTE: The mandatory HTTP error status codes for the POST method listed in table 5.2.6-1 of 3GPP TS 29.122 [4] also apply.

Table 5.13.2.3.1-3: Headers supported by the 307 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

Table 5.13.2.3.1-4: Headers supported by the 308 Response Code on this resource

Name

Data type

P

Cardinality

Description

Location

string

M

1

An alternative URI representing the end point of an alternative AF towards which the notification should be redirected.

5.13.3 Data Model

5.13.3.1 General

This clause specifies the application data model supported by the MoLcsNotify API.

5.13.3.2 Reused data types

The data types reused by the MoLcsNotify API from other specifications are listed in table 5.13.3.2-1.

Table 5.13.3.2-1: Re-used Data Types

Data type

Reference

Comments

SupportedFeatures

3GPP TS 29.571 [8]

Used to negotiate the applicability of the optional features defined in table 5.13.4-1.

Gpsi

3GPP TS 29.571 [8]

Identifies a GPSI.

LocationInfo

3GPP TS 29.122 [4]

Represent user location information for exposure.

LcsQosClass

3GPP TS 29.572 [34]

LCS QoS Class.

ServiceIdentity

3GPP TS 29.515 [35]

Service identity

5.13.3.3 Structured data types

5.13.3.3.1 Introduction

This clause defines the structured data types to be used by the MoLcsNotify API.

5.13.3.3.2 Type: LocUpdateData

This type represents a UE updated location information from the NEF to the AF.

Table 5.13.3.3.2-1: Definition of type LocUpdateData

Attribute name

Data type

P

Cardinality

Description

Applicability

gpsi

Gpsi

M

1

Generic Public Subscription identifier

locInfo

LocationInfo

M

1

Represent user location information for exposure.

lcsQosClass

LcsQosClass

M

1

LCS QoS Class.

svcId

ServiceIdentity

O

0..1

Service Identity may be specified by the UE for LCS request.

suppFeat

SupportedFeatures

M

1

Indicates the list of Supported features used as described in clause 5.13.4.

5.13.3.3.3 Type: LocUpdateDataReply

This data type represents a reply to a MO LCS notification and is sent from the AF to the NEF.

Table 5.13.3.3.3-1: Definition of type LocUpdateDataReply

Attribute name

Data type

P

Cardinality

Description

Applicability

suppFeat

SupportedFeatures

M

1

Indicates the list of Supported features used as described in clause 5.13.4.

5.13.3.4 Simple data types and enumerations

5.13.3.4.1 Introduction

This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.

5.13.3.4.2 Simple data types

The simple data types defined in table 5.13.3.4.2-1 shall be supported.

Table 5.13.3.4.2-1: Simple data types

Type Name

Type Definition

Description

Applicability

5.13.4 Used Features

The table below defines the features applicable to the MoLcsNotify API. Those features are negotiated as described in clause 5.2.7 of 3GPP TS 29.122 [4].

Table 5.13.4-1: Features used by MoLcsNotify API

Feature number

Feature Name

Description

5.13.5 Error handling

5.13.5.1 General

HTTP error handling shall be supported as specified in clause 5.2.6 of 3GPP TS 29.122 [4].

In addition, the requirements in the following clauses shall apply.

5.13.5.2 Protocol Errors

In this Release of the specification, there are no additional protocol errors applicable for the MoLcsNotify API.

5.13.5.3 Application Errors

The application errors defined for MoLcsNotify API are listed in table 5.13.5.3-1.

Table 5.13.5.3-1: Application errors

Application Error

HTTP status code

Description

Applicability