vnd.3gpp.lpp

Binary encoded payload, encoding LTE Positioning Protocol (LPP) IEs, as specified in 3GPP TS 37.355 [21].

NOTE: Using 3GPP vendor content subtypes allows to describe the nature of the opaque payload (e.g. LPP information) without having to rely on metadata in the JSON payload.

determine-location

/determine-location

POST

Determine Location

cancel-location

/cancel-location

POST

Cancel Location

location-context-transfer

/location-context-transfer

POST

Transfer Location Context

InputData

M

1

Input parameters to the "Determine Location" operation

LocationData

M

1

200 OK

This case represents the successful retrieval of the location of the UE or successful activation of periodic or triggered location in the UE.

Upon success, a response body is returned containing the different parameters of the location data if obtained, such as:

– Geographic Area

– Civic Location

– Local location,

– Positioning methods

n/a

204 No Content

This case represents the successful delivery of location assistance data to the UE, during MO-LR requesting for location assistance data for the UE.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set.

ProblemDetails

O

0..1

403 Forbidden

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

– POSITIONING_DENIED

– UNSPECIFIED

– UNSUPPORTED_BY_UE

See table 6.1.7.3-1 for the description of these errors.

ProblemDetails

O

0..1

500 Internal Server Error

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

– POSITIONING_FAILED

See table 6.1.7.3-1 for the description of these errors.

ProblemDetails

O

0..1

504 Gateway Timeout

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

– UNREACHABLE_USER

See table 6.1.7.3-1 for the description of this error.

NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

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

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Location

string

M

1

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

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

CancelLocData

M

1

The information used to cancel location.

n/a

204 No Content

This case represents successful cancellation of location.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set.

ProblemDetails

O

0..1

403 Forbidden

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

– UNSPECIFIED

– LOCATION_SESSION_UNKNOWN

See table 6.1.7.3-1 for the description of this error.

NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

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

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Location

string

M

1

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

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

LocContextData

M

1

Input parameters to the "Location Context Transfer" operation

n/a

204 No Content

This case represents successful transfer of the location context.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set.

ProblemDetails

O

0..1

403 Forbidden

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

– UNSPECIFIED

– LOCATION_TRANSFER_NOT SUPPORTED

– INSUFFICIENT_RESOURCES

– EVENT_REPORT_UNRECOGNIZED

See table 6.1.7.3-1 for the description of this error.

NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

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

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Location

string

M

1

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

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

EventNotify

{hgmlcCallBackURI}

POST

EventNotifyData

M

1

Input parameters to the "Location Event Notify" operation

n/a

204 No Content

This case represents successful notification of the event.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

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

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

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

ProblemDetails

O

0..1

403 Forbidden

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

– UNSPECIFIED

– LOCATION_SESSION_UNKNOWN

See table 6.1.7.3-1 for the description of this error.

NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

A URI pointing to the endpoint of NF service consumer to which the notification should be sent

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Location

string

M

1

A URI pointing to the endpoint of NF service consumer to which the notification should be sent

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

InputData

6.1.6.2.2

Information within Determine Location Request

LocationData

6.1.6.2.3

Information within Determine Location Response

GeographicalCoordinates

6.1.6.2.4

Geographical coordinates

GeographicArea

6.1.6.2.5

Geographic area specified by different shape

Point

6.1.6.2.6

Ellipsoid Point

PointUncertaintyCircle

6.1.6.2.7

Ellipsoid point with uncertainty circle

PointUncertaintyEllipse

6.1.6.2.8

Ellipsoid point with uncertainty ellipse

Polygon

6.1.6.2.9

Polygon

PointAltitude

6.1.6.2.10

Ellipsoid point with altitude

PointAltitudeUncertainty

6.1.6.2.11

Ellipsoid point with altitude and uncertainty ellipsoid

EllipsoidArc

6.1.6.2.12

Ellipsoid Arc

LocationQoS

6.1.6.2.13

QoS of Location request

CivicAddress

6.1.6.2.14

Indicates a Civic address

PositioningMethodAndUsage

6.1.6.2.15

Indicates the usage of a positioning method

GnssPositioningMethodAndUsage

6.1.6.2.16

Indicates the usage of a Global Navigation Satellite System (GNSS) positioning method

VelocityEstimate

6.1.6.2.17

Velocity estimate

HorizontalVelocity

6.1.6.2.18

Horizontal velocity

HorizontalWithVerticalVelocity

6.1.6.2.19

Horizontal and vertical velocity

HorizontalVelocityWithUncertainty

6.1.6.2.20

Horizontal velocity with speed uncertainty

HorizontalWithVerticalVelocityAndUncertainty

6.1.6.2.21

Horizontal and vertical velocity with speed uncertainty

UncertaintyEllipse

6.1.6.2.22

Ellipse with uncertainty

UeLcsCapability

6.1.6.2.23

Indicates the LCS capability supported by the UE.

PeriodicEventInfo

6.1.6.2.24

Indicates the information of periodic event reporting

AreaEventInfo

6.1.6.2.25

Indicates the information of area based event reporting

ReportingArea

6.1.6.2.26

Indicates an area for event reporting

MotionEventInfo

6.1.6.2.27

Indicates the information of motion based event reporting

CancelLocData

6.1.6.2.29

Information within Cancel Location Request

LocContextData

6.1.6.2.30

Information within Transfer Location Context Request

EventReportMessage

6.1.6.2.31

Indicates an event report message

EventReportingStatus

6.1.6.2.32

Indicates the status of event reporting

UELocationInfo

6.1.6.2.33

Indicates location information of a UE

EventNotifyData

6.1.6.2.34

Information within Event Notify Request

UeConnectivityState

6.1.6.2.35

Indicates the connectivity state of a UE

LocalOrigin

6.1.6.2.36

Indicates a Local origin in a reference system.

RelativeCartesianLocation

6.1.6.2.37

Relative Cartesian Location

Local2dPointUncertaintyEllipse

6.1.6.2.38

Local 2D point with uncertainty ellipse

Local3dPointUncertaintyEllipsoid

6.1.6.2.39

Local 3D point with uncertainty ellipsoid

UncertaintyEllipsoid

6.1.6.2.40

Ellipsoid with uncertainty

LocalArea

6.1.6.2.41

Local area specified by different shape

UeAreaIndication

6.1.6.2.42

UE area Indication

MinorLocationQoS

6.1.6.2.43

Minor Location QoS

Altitude

6.1.6.3.2

Indicates value of altitude

Angle

6.1.6.3.2

Indicates value of angle

Uncertainty

6.1.6.3.2

Indicates value of uncertainty

Orientation

6.1.6.3.2

Indicates value of orientation angle

Confidence

6.1.6.3.2

Indicates value of confidence

Accuracy

6.1.6.3.2

Indicates value of accuracy

InnerRadius

6.1.6.3.2

Indicates value of the inner radius

CorrelationID

6.1.6.3.2

LCS Correlation ID

AgeOfLocationEstimate

6.1.6.3.2

Indicates value of the age of the location estimate

HorizontalSpeed

6.1.6.3.2

Indicates value of horizontal speed

VerticalSpeed

6.1.6.3.2

Indicates value of vertical speed

SpeedUncertainty

6.1.6.3.2

Indicates value of speed uncertainty

BarometricPressure

6.1.6.3.2

Specifies the measured uncompensated atmospheric pressure

LcsServiceType

6.1.6.3.2

LCS service type

LdrReference

6.1.6.3.2

LDR Reference

ReportingAmount

6.1.6.3.2

Number of required periodic event reports

ReportingInterval

6.1.6.3.2

Event reporting periodic interval

MinimumInterval

6.1.6.3.2

Minimum interval between event reports

MaximumInterval

6.1.6.3.2

Maximum interval between event reports

SamplingInterval

6.1.6.3.2

Maximum time interval between consecutive evaluations by a UE of a trigger event

ReportingDuration

6.1.6.3.2

Maximum duration of event reporting

LinearDistance

6.1.6.3.2

Minimum straight line distance moved by a UE to trigger a motion event report

LMFIdentification

6.1.6.3.2

LMF identification

EventReportCounter

6.1.6.3.2

Number of event reports received from the target UE

EventReportDuration

6.1.6.3.2

Duration of event reporting

UePositioningCapabilities

6.1.6.3.2

Indicates the positioning capabilities supported by the UE.

ExternalClientType

6.1.6.3.3

Indicates types of External Clients

SupportedGADShapes

6.1.6.3.4

Indicates supported GAD shapes

ResponseTime

6.1.6.3.5

Indicates acceptable delay of location request

PositioningMethod

6.1.6.3.6

Indicates supported positioning methods

PositioningMode

6.1.6.3.7

Indicates supported modes used for positioning method

GnssId

6.1.6.3.8

Global Navigation Satellite System (GNSS) ID

Usage

6.1.6.3.9

Indicates usage made of the location measurement

LcsPriority

6.1.6.3.10

Indicates priority of the LCS client

VelocityRequested

6.1.6.3.11

Indicates velocity requirement

AccuracyFulfilmentIndicator

6.1.6.3.12

Indicates fulfilment of requested accuracy

VerticalDirection

6.1.6.3.13

Indicates direction of vertical speed

LdrType

6.1.6.3.14

Indicates LDR types

ReportingAreaType

6.1.6.3.15

Indicates type of event reporting area

OccurrenceInfo

6.1.6.3.16

Specifies occurrence of event reporting

ReportingAccessType

6.1.6.3.17

Specifies access types of event reporting

EventClass

6.1.6.3.18

Specifies event classes

ReportedEventType

6.1.6.3.19

Specifies type of event reporting

TerminationCause

6.1.6.3.20

Specifies causes of event reporting termination

LcsQosClass

6.1.6.3.21

Specifies LCS QoS class

UeLocationServiceInd

6.1.6.3.22

Specifies location service types requested by UE

Supi

3GPP TS 29.571 [8]

Subscription Permanent Identifier

Pei

3GPP TS 29.571 [8]

Permanent Equipment Identifier

Gpsi

3GPP TS 29.571 [8]

Generic Public Subscription Identifier

Ecgi

3GPP TS 29.571 [8]

E-UTRA Cell Identity

Ncgi

3GPP TS 29.571 [8]

NR Cell Identity

NfInstanceId

3GPP TS 29.571 [8]

Network Function Instance ID

Uri

3GPP TS 29.571 [8]

Uniform Resource Identifier

RefToBinaryData

3GPP TS 29.571 [8]

Reference to binary data

AccessType

3GPP TS 29.571 [8]

Access type

CmState

3GPP TS 29.518 [23]

Connection Management State

Guami

3GPP TS 29.571 [8]

GUAMI

SupportedFeatures

3GPP TS 29.571 [8]

Supported Features

RedirectResponse

3GPP TS 29.571 [8]

Redirect Response

TwapId

3GPP TS 29.571 [8]

TWAP identifier

TnapId

3GPP TS 29.571 [8]

TNAP identifier

DateTime

3GPP TS 29.571 [8]

Date and Time

externalClientType

ExternalClientType

O

0..1

When present, this IE shall carry the external client type of the requester.

correlationID

CorrelationID

O

0..1

When present, this IE shall carry the correlation ID of the request.

amfId

NfInstanceId

O

0..1

Indicates the AMF Instance serving the UE. LMF shall use the AMF Instance to forward LCS related N1/N2 messages to the UE/RAN.

locationQoS

LocationQoS

O

0..1

When present, this IE shall carry the QoS of the location request.

supportedGADShapes

array(SupportedGADShapes)

O

1..N

When present, this IE shall carry the GAD shapes supported by the requester.

supi

Supi

O

0..1

Indicates the SUPI of the target UE.

pei

Pei

O

0..1

Indicates the PEI of the target UE.

gpsi

Gpsi

O

0..1

Indicates the GPSI of the target UE.

ecgi

Ecgi

O

0..1

When present, this IE shall indicate the identifier of the E-UTRAN cell serving the UE or the serving cell identifier of the Primary Cell in the Master RAN Node that is an E-UTRAN node on Dual Connectivity scenarios.

(NOTE 2)

ecgiOnSecondNode

Ecgi

O

0..1

When present, the serving cell identifier of the Primary Cell in the Secondary RAN Node that is an E-UTRAN node when available on Dual Connectivity scenarios.

(NOTE 3) (NOTE 4)

ncgi

Ncgi

O

0..1

When present, this IE shall indicate the identifier of the NR cell serving the UE or the serving cell identifier of the Primary Cell in the Master RAN Node that is a NR node on Dual Connectivity scenarios.

(NOTE 2)

ncgiOnSecondNode

Ncgi

O

0..1

When present, the serving cell identifier of the Primary Cell in the Secondary RAN Node that is a NR node when available on Dual Connectivity scenarios.

(NOTE 3) (NOTE 4)

priority

LcsPriority

O

0..1

When present, this IE shall indicate the priority of the location request.

velocityRequested

VelocityRequested

O

0..1

When present, this IE shall indicate whether velocity is requested or not.

ueLcsCap

UeLcsCapability

O

0..1

When present, this IE shall indicate the LCS capability supported by the UE.

lcsServiceType

LcsServiceType

O

0..1

The LCS service type

ldrType

LdrType

O

0..1

The type of LDR

hgmlcCallBackURI

Uri

C

0..1

Callback URI of the H-GMLC

It shall be present, if attribute LdrType is present.

vgmlcAddress

Uri

C

0..1

V-GMLC address that corresponds to the V-GMLC that receives Location Request

It shall be present, if attribute LdrType is present and the target UE is in roaming case.

ldrReference

LdrReference

C

0..1

LDR Reference Number

It shall be present, if attribute LdrType is present.

periodicEventInfo

PeriodicEventInfo

C

0..1

Information for periodic event reporting

areaEventInfo

AreaEventInfo

C

0..1

Information for area event reporting

motionEventInfo

MotionEventInfo

C

0..1

Information for motion event reporting

reportingAccessTypes

array(ReportingAccessType)

O

1..N

Allowed access types for event reporting

ueConnectivityStates

array(UeConnectivityState)

O

1..N

When present, this IE shall indicate the UE connectivity state per access type

ueLocationServiceInd

UeLocationServiceInd

C

0..1

If UE sends an MO-LR Request message, this IE shall be present and indicate the request type for a 5GC-MO-LR.

moAssistanceDataTypes

LcsBroadcastAssistanceTypesData

O

0..1

When present, this IE shall indicate a list of one or more types of location assistance data that UE subscribed.

lppMessage

RefToBinaryData

C

0..1

If UE includes the first LPP message in MO-LR Request, this IE shall be present and Indicate the binary data of LPP message.

(NOTE 5)

lppMessageExt

array(RefToBinaryData)

C

1..N

If UE includes the additional LPP messages (maximum 3) in MO-LR Request, this IE shall be present and Indicates the binary data of LPP message.

(NOTE 5)

supportedFeatures

SupportedFeatures

C

0..1

This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported.

uePositioningCap

UePositioningCapabilities

O

0..1

When present, this IE shall indicate the positioning capabilities supported by the UE.

tnapId

TnapId

O

0..1

When present, this IE shall contain the TNAP Identifier.

This IE may be present for non-3GPP access.

twapId

TwapId

O

0..1

When present, This IE shall contain the TWAP Identifier.

This IE may be present for non-3GPP access.

ueCountryDetInd

boolean

O

0..1

When present, This IE shall contain an indication of determining the UE geographical area identified by the country, area within a country or international area indication where UE is located for PLMN selection verification.

SAT

scheduledLocTime

DateTime

O

0..1

When present, this IE shall contain the scheduled time that the UE needs to be located.

reliableLocReq

boolean

C

0..1

This IE shall be included with the value "true" to indicate that reliable UE location information is required, as specified in 3GPP TS 33.256 [26] clause 5.3.2.

When present, this IE shall be set as following:

– true: the reliable UE location information is required

– false (default): the reliable UE location information is not required

NOTE 1: At least one of the attributes defined in this table shall be present in the InputData structure.

NOTE 2: Attribute "ecgi" and "ncgi" shall not be present at the same time.

NOTE 3: Attribute "ecgiOnSecondNode" and "ncgiOnSecondNode" shall not be present at the same time.

NOTE 4: Attribute "ecgiOnSecondNode" or "ncgiOnSecondNode" shall not be present if neither attribute "ecgi" nor "ncgi" is present.

NOTE 5: If 3 LPP messages are received, then first LPP message shall be encoded in lppMessage IE and additional 2 LPP messages shall be encoded in lppMessageExt IE.

locationEstimate

GeographicArea

M

1

For a request for triggered location where location estimates are not required, the location estimate can be based on current serving cell.

accuracyFulfilmentIndicator

AccuracyFulfilmentIndicator

O

0..1

When present, this IE shall indicate fulfilment of required accuracy.

ageOfLocationEstimate

AgeOfLocationEstimate

O

0..1

When present, this IE shall indicate age of the location estimate.

timestampOfLocationEstimate

DateTime

O

0..1

When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same).

velocityEstimate

VelocityEstimate

O

0..1

When present, this IE shall indicate velocity estimate.

civicAddress

CivicAddress

O

0..1

When present, this IE shall indicate a civic address.

localLocationEstimate

LocalArea

O

0..1

When present, this IE shall indicate a local area in reference system.

positioningDataList

array(PositioningMethodAndUsage)

O

1..N

When present, this IE shall include a list of data related to positioning methods.

gnssPositioningDataList

array(GnssPositioningMethodAndUsage)

O

1..N

When present, this IE shall include a list of data related to GNSS positioning methods.

ecgi

Ecgi

O

0..1

When present, this IE shall indicate the ID of the E-UTRAN cell serving the UE.

ncgi

Ncgi

O

0..1

When present, this IE shall indicate the ID of the NR cell serving the UE.

altitude

Altitude

O

0..1

Altitude of the positioning estimate. When the shape used in "locationEstimate" supports conveying the altitude parameter, this IE shall be absent.

barometricPressure

BarometricPressure

O

0..1

If present, this IE contains the barometric pressure measurement as reported by the target UE.

servingLMFidentification

LMFIdentification

O

0..1

When present, this IE shall indicate the identity of the serving LMF

uePositioningCap

UePositioningCapabilities

O

0..1

When present, this IE shall indicate the positioning capabilities supported by the UE.

supportedFeatures

SupportedFeatures

C

0..1

This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported.

ueAreaInd

UeAreaIndication

O

0..1

When present, this IE shall contain a country, area in a country or international area indication where UE is located.

If UE is outside of the area of any known country, i.e. international area, then the LMF shall provide the International Area Indication without a country.

SAT

achievedQos

MinorLocationQoS

O

0..1

When present, this IE shall contain the achieved Location QoS Accuracy of the estimated location.

This IE may be present if the LCS QoS Class required in the request message is "MULTIPLE_QOS".

If it’s absent, LCS QoS Class required in the request message is "MULTIPLE_QOS" and AccuracyFulfilmentIndicator is "REQUESTED_ACCURACY_FULFILLED", it indicates that the location QoS in the highest priority is achieved.

MUTIQOS

lon

number

M

1

Longitude (Double-precision float value):

Format: double

Minimum: -180

Maximum: 180

lat

number

M

1

Latitude (Double-precision float value):

Format: double

Minimum: -90

Maximum: 90

Point

1

shape

POINT

Geographical area consisting of a single point, represented by its longitude and latitude.

PointUncertaintyCircle

1

shape

POINT_UNCERTAINTY_CIRCLE

Geographical area consisting of a point and an uncertainty value.

PointUncertaintyEllipse

1

shape

POINT_UNCERTAINTY_ELLIPSE

Geographical area consisting of a point, plus an uncertainty ellipse and a confidence value.

Polygon

1

shape

POLYGON

Geographical area consisting of a list of points (between 3 to 15 points).

PointAltitude

1

shape

POINT_ALTITUDE

Geographical area consisting of a point and an altitude value.

PointAltitudeUncertainty

1

shape

POINT_ALTITUDE_UNCERTAINTY

Geographical area consisting of a point, an altitude value and an uncertainty value.

EllipsoidArc

1

shape

ELLIPSOID_ARC

Geographical are consisting of an ellipsoid arc.

NOTE: The "anyOf" keyword (instead of "oneOf" keyword which is normally used for mutually exclusive alternatives) is used for GeographicArea type in yaml file to avoid validation failure of OpenAPI. According to current definition, a PointUncertaintyCircle object will always pass the validation with both PointUncertaintyCircle and Point, which fails the qualification of "oneOf" keyword.

shape

SupportedGADShapes

M

1

It shall take the value "POINT".

point

GeographicalCoordinates

M

1

Indicates a geographic point represented by its longitude and latitude.

shape

SupportedGADShapes

M

1

It shall take the value "POINT_UNCERTAINTY_CIRCLE".

point

GeographicalCoordinates

M

1

Indicates a geographic point represented by its longitude and latitude.

uncertainty

Uncertainty

M

1

Indicates the uncertainty value.

shape

SupportedGADShapes

M

1

It shall take the value "POINT_UNCERTAINTY_ELLIPSE".

point

GeographicalCoordinates

M

1

Indicates a geographic point represented by its longitude and latitude.

uncertaintyEllipse

UncertaintyEllipse

M

1

Indicates an uncertainty ellipse.

confidence

Confidence

M

1

Indicates the value of confidence.

shape

SupportedGADShapes

M

1

It shall take the value "POLYGON".

pointList

array(GeographicalCoordinates)

M

3..15

Array with up to15 items, where each item is a "point".

shape

SupportedGADShapes

M

1

It shall take the value "POINT_ALTITUDE".

point

GeographicalCoordinates

M

1

Indicates a geographic point represented by its longitude and latitude.

altitude

Altitude

M

1

Indicates the value of altitude.

shape

SupportedGADShapes

M

1

It shall take the value "POINT_ALTITUDE_UNCERTAINTY".

point

GeographicalCoordinates

M

1

Indicates a geographic point represented by its longitude and latitude.

altitude

Altitude

M

1

Indicates the value of altitude.

uncertaintyEllipse

UncertaintyEllipse

M

1

Indicates the uncertainty ellipse

uncertaintyAltitude

Uncertainty

M

1

Indicates the uncertainty of the altitude.

confidence

Confidence

M

1

Indicates the value of confidence.

shape

SupportedGADShapes

M

1

It shall take the value "ELLIPSOID_ARC".

point

GeographicalCoordinates

M

1

Indicates a geographic point represented by its longitude and latitude.

innerRadius

InnerRadius

M

1

Indicates the value of inner radius of the Ellipsoid Arc.

uncertaintyRadius

Uncertainty

M

1

Indicates the uncertainty radius of the Ellipsoid Arc.

offsetAngle

Angle

M

1

Indicates the offset angle of the Ellipsoid Arc.

includedAngle

Angle

M

1

Indicates the included angle of the Ellipsoid Arc.

confidence

Confidence

M

1

Indicates the value of confidence.

hAccuracy

Accuracy

O

0..1

Horizontal accuracy

vAccuracy

Accuracy

O

0..1

Vertical accuracy

vertRequested

boolean

O

0..1

Vertical accuracy requested (yes/no)

responseTime

ResponseTime

O

0..1

No delay, Low delay or Delay tolerant

minorLocQoses

array(MinorLocationQoS)

C

1..2

If present, this IE shall contain a list of MinorLocationQoS in priority order.

When the lcsQosClass sets to "MULTIPLE_QOS", this IE shall be present, and when lcsQosClass sets to either "BEST_EFFORT" or "ASSURED" this IE shall be absent.

MUTIQOS

lcsQosClass

LcsQosClass

C

0..1

LCS QoS Class, see clause 4.1b of 3GPP TS 23.273 [19].

This IE shall be absent if neither hAccuracy nor vAccuracy is included.

NOTE: If the lcsQosClass set to "MULTIPLE_QOS", at least one of attributes hAccuracy, vAccuracy shall be present.

country

string

M

1

The two-letter ISO 3166 country code in capital ASCII letters, e.g., DE or US

IETF RFC  4776 [6]

A1

string

O

0..1

National subdivisions (state, canton, region, province, prefecture)

IETF RFC  4776 [6]

A2

string

O

0..1

County, parish, gun (JP), district (IN)

IETF RFC  4776 [6]

A3

string

O

0..1

City, township, shi (JP)

IETF RFC  4776 [6]

A4

string

O

0..1

City division, borough, city district, ward, chou (JP)

IETF RFC  4776 [6]

A5

string

O

0..1

Neighbourhood, block

IETF RFC  4776 [6]

A6

string

O

0..1

Group of streets below the neighbourhood level

IETF RFC  4776 [6]

PRD

string

O

0..1

Leading street direction

IETF RFC  4776 [6]

POD

string

O

0..1

Trailing street suffix

IETF RFC  4776 [6]

STS

string

O

0..1

Street suffix or type

IETF RFC  4776 [6]

HNO

string

O

0..1

House number

IETF RFC  4776 [6]

HNS

string

O

0..1

House number suffix

IETF RFC  4776 [6]

LMK

string

O

0..1

Landmark or vanity address

IETF RFC  4776 [6]

LOC

string

O

0..1

Additional location information

IETF RFC  4776 [6]

NAM

string

O

0..1

Name (residence and office occupant)

IETF RFC  4776 [6]

PC

string

O

0..1

Postal/zip code

IETF RFC  4776 [6]

BLD

string

O

0..1

Building (structure)

IETF RFC 5139 [7]

UNIT

string

O

0..1

Unit (apartment, suite)

IETF RFC 5139 [7]

FLR

string

O

0..1

Floor

IETF RFC  4776 [6]

ROOM

string

O

0..1

Room

IETF RFC 5139 [7]

PLC

string

O

0..1

Place-type

IETF RFC 5139 [7]

PCN

string

O

0..1

Postal community name

IETF RFC 5139 [7]

POBOX

string

O

0..1

Post office box (P.O. box)

IETF RFC 5139 [7]

ADDCODE

string

O

0..1

Additional code

IETF RFC 5139 [7]

SEAT

string

O

0..1

Seat (desk, cubicle, workstation)

IETF RFC 5139 [7]

RD

string

O

0..1

Primary road or street

IETF RFC 5139 [7]

RDSEC

string

O

0..1

Road clause

IETF RFC 5139 [7]

RDBR

string

O

0..1

Road branch

IETF RFC 5139 [7]

RDSUBBR

string

O

0..1

Road sub-branch

IETF RFC 5139 [7]

PRM

string

O

0..1

Road pre-modifier

IETF RFC 5139 [7]

POM

string

O

0..1

Road post-modifier

IETF RFC 5139 [7]

usageRules

string

O

0..1

When present, this IE shall carry the value of "usage-rules" Element of the PIDL-LO XML document, with UTF-8 encoding.

IETF RFC 4119 [25]

method

string

O

0..1

When present, this IE shall contain the method token, carried by the "method" Element of the PIDL-LO XML document.

IETF RFC 4119 [25]

providedBy

string

O

0..1

When present, this IE shall carry the value of "provided-by" Element of the PIDL-LO XML document, with UTF-8 encoding.

IETF RFC 4119 [25]

method

PositioningMethod

M

1

Indicates the related positioning method

mode

PositioningMode

M

1

Indicates the mode of the location measurement from the related positioning method.

usage

Usage

M

1

Indicates the usage of the location measurement from the related positioning method.

methodCode

integer

C

0..1

This IE shall be present when the method IE is with value "NETWORK_SPECIFIC".

When present, this IE shall carry the code value of the network specific positioning method in decimal which encodes the binary value "10000 to 11111" (bits 8-4 of "Positioning Method and Usage" IE within "Positioning Data" parameter, as specified in clause 7.4.13 of 3GPP TS 29.171 [24].)

Minimum: 16

Maximum: 31

mode

PositioningMode

M

1

Indicates the mode of location measurement from the related GNSS positioning method.

gnss

GnssId

M

1

Indicates the related GNSS positioning method

usage

Usage

M

1

Indicates the usage of the location measurement from related GNSS positioning method.

HorizontalVelocity

1

Velocity estimate including horizontal speed and bearing.

HorizontalWithVerticalVelocity

1

Velocity estimate including horizontal speed and bearing, and also vertical speed and vertical direction.

HorizontalVelocityWithUncertainty

1

Velocity estimate including horizontal speed and bearing; it also includes an uncertainty value.

HorizontalWithVerticalVelocityAndUncertainty

1

Velocity estimate including horizontal speed and bearing, and also vertical speed and vertical direction; it also includes uncertainty value for horizontal and vertical speeds.

hSpeed

HorizontalSpeed

M

1

Horizontal speed in kilometres per hour.

bearing

Angle

M

1

Bearing angle in degrees, measured clockwise from North.

hSpeed

HorizontalSpeed

M

1

Horizontal speed in kilometres per hour.

bearing

Angle

M

1

Bearing angel in degrees, measured clockwise from North.

vSpeed

VerticalSpeed

M

1

Vertical Seed in kilometres per hour.

vDirection

VerticalDirection

M

1

Vertical Direction: upward or downward.

hSpeed

HorizontalSpeed

M

1

Speed in kilometres per hour.

bearing

Angle

M

1

Bearing angel in degrees, measured clockwise from North.

uncertainty

SpeedUncertainty

M

1

Uncertainty of horizontal speed in kilometres per hour.

hspeed

HorizontalSpeed

M

1

Speed in kilometres per hour.

bearing

Angle

M

1

Bearing angel in degrees, measured clockwise from North.

vSpeed

VerticalSpeed

M

1

Vertical Seed in kilometres per hour.

vDirection

VerticalDirection

M

1

Vertical Direction: upwards or downwards.

hUncertainty

SpeedUncertainty

M

1

Uncertainty of horizontal speed in kilometres per hour.

vUncertainty

SpeedUncertainty

M

1

Uncertainty of vertical speed in kilometres per hour.

semiMajor

Uncertainty

M

1

Indicates the semi-major axis of the uncertainty ellipse.

semiMinor

Uncertainty

M

1

Indicates the semi-minor axis of the uncertainty ellipse.

orientationMajor

Orientation

M

1

Indicates the orientation angle of the major axis.

lppSupport

boolean

O

0..1

Indicates whether the UE supports LPP or not.

– true (default): LPP supported by the UE

– false: LPP not supported by the UE

ciotOptimisation

boolean

O

0..1

Indicates whether the UE supports and is allowed to use Control Plane CIoT 5GS Optimisation to send an event report for periodic or triggered location or not. Refer to 3GPP TS 23.273 [19] clause 6.7 for more detail.

– true: Control Plane CIoT 5GS Optimisation is supported by the UE and allowed

– false (default): Control Plane CIoT 5GS Optimisation not supported by the UE or not allowed

reportingAmount

ReportingAmount

M

1

Number of event reports

reportingInterval

ReportingInterval

M

1

Interval of event reports

NOTE: reportingAmount x reportingInterval shall not exceed 8639999 (99 days, 23 hours, 59 minutes and 59 seconds) for compatibility with OMA MLP and RLP.

areaDefinition

array(ReportingArea)

M

1..250

One or more reporting areas

occurrenceInfo

OccurrenceInfo

O

0..1

One time only report indication

minimumInterval

MinimumInterval

C

0..1

Minimum interval between event reports.

This IE shall not be included if occurrenceInfo is present and set to one time event.

maximumInterval

MaximumInterval

C

0..1

Maximum interval between event reports.

This IE shall not be included if occurrenceInfo is present and set to one time event.

samplingInterval

SamplingInterval

O

0..1

Maximum time interval between consecutive evaluations by a UE of a trigger event.

reportingDuration

ReportingDuration

O

0..1

Maximum duration of event reporting.

reportingLocationReq

boolean

C

0..1

This IE shall be present and set to true if a location estimate is required for each event report.

When present, it shall be set as follows:

– true: location report is required.

– false: location report is not required.

areaType

ReportingAreaType

M

1

Type of reporting area.

tai

Tai

C

1

TAI for EPS or 5GS.

This IE shall be present if the reporting area type is EPS TAI or 5GS TAI.

ecgi

Ecgi

C

1

ECGI.

This IE shall be present if the reporting area type is ECGI.

ncgi

Ncgi

C

1

NCGI.

This IE shall be present if the reporting area type is NCGI.

NOTE: One of tai, ecgi or ncgi shall be included.

linearDistance

LinearDistance

M

1

Minimum linear (straight line) distance for motion event reports.

occurrenceInfo

OccurrenceInfo

O

0..1

One time only report indication

minimumInterval

MinimumInterval

C

0..1

Minimum interval between event reports.

This IE shall not be included if occurrenceInfo is present and set to one time event.

maximumInterval

MaximumInterval

C

0..1

Maximum interval between event reports.

This IE shall not be included if occurrenceInfo is present and set to one time event.

samplingInterval

SamplingInterval

O

0..1

Maximum time interval between consecutive evaluations by a UE of a trigger event.

reportingDuration

ReportingDuration

O

0..1

Maximum duration of event reporting.

reportingLocationReq

boolean

C

0..1

This IE shall be present and set to true if a location estimate is required for each event report.

When present, it shall be set as follows:

– true: location report is required.

– false: location report is not required.

hgmlcCallBackURI

Uri

M

1

Callback URI of the H-GMLC

ldrReference

LdrReference

M

1

LDR Reference

supportedFeatures

SupportedFeatures

C

0..1

This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported.

amfId

NfInstanceId

M

1

Indicates the AMF Instance serving the UE. LMF shall use the AMF Instance to forward LCS related N1/N2 messages to the UE/RAN.

locationQoS

LocationQoS

C

0..1

This IE shall contain the location QoS if available.

supportedGADShapes

array(SupportedGADShapes)

C

0..N

This IE shall contain the supported GAD shapes if available.

supi

Supi

C

0..1

This IE shall contain the SUPI if available.

gpsi

Gpsi

C

0..1

This IE shall contain the GPSI if available.

ldrType

LdrType

M

1

The type of LDR

hgmlcCallBackURI

Uri

M

1

Callback URI of the H-GMLC

ldrReference

LdrReference

M

1

LDR Reference

periodicEventInfo

PeriodicEventInfo

C

0..1

Information for periodic event reporting

areaEventInfo

AreaEventInfo

C

0..1

Information for area event reporting

motionEventInfo

MotionEventInfo

C

0..1

Information for motion event reporting

eventReportMessage

EventReportMessage

M

1

Contains an embedded event report

eventReportingStatus

EventReportingStatus

O

0..1

Status of event reporting

ueLocationInfo

UELocationInfo

O

0..1

Location information for the target UE

cIoT5GSOptimisation

boolean

C

0..1

This IE shall be present if it was received from AMF. When present, it shall be set as follows:

– true: Control Plane CIoT 5GS Optimisation was used and no signalling or data is currently pending for the UE at the AMF.

– false (default): Control Plane CIoT 5GS Optimisation was not used or signalling or data is currently pending for the UE at the AMF.

ecgi

Ecgi

C

0..1

When present, this IE shall indicate the identifier of the E-UTRAN cell serving the UE.

This IE shall be present if it was received from AMF.

ncgi

Ncgi

C

0..1

When present, this IE shall indicate the identifier of the NR cell serving the UE.

This IE shall be present if it was received from AMF

guami

Guami

C

0..1

This IE shall be present if it was received from AMF.

When present, it shall contain the GUAMI serving the UE.

supportedFeatures

SupportedFeatures

C

0..1

This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported.

uePositioningCap

UePositioningCapabilities

O

0..1

When present, this IE shall indicate the positioning capabilities supported by the UE.

scheduledLocTime

DateTime

O

0..1

When present, this IE shall contain the scheduled time that the UE needs to be located.

NOTE: At least one of periodicEventInfo, areaEventInfo or motionEventInfo shall be present in the LocContextData structure.

eventClass

EventClass

M

1

This IE shall contain the event class for the message content specified in eventContent.

eventContent

RefToBinaryData

M

1

This IE shall reference the event report binary data corresponding to the eventClass.

eventReportCounter

EventReportCounter

O

0..1

This IE shall contain a count of event reports.

eventReportDuration

EventReportDuration

O

0..1

This IE shall contain the duration of event reporting.

locationEstimate

GeographicArea

O

0..1

Previous location estimate for the target UE.

ageOfLocationEstimate

AgeOfLocationEstimate

O

0..1

Age of previous location estimate.

timestampOfLocationEstimate

DateTime

O

0..1

When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same).

velocityEstimate

VelocityEstimate

O

0..1

Previous velocity estimate for the target UE.

ageOfVelocityEstimate

AgeOfLocationEstimate

O

0..1

Age of previous velocity estimate.

timestampOfVelocityEstimate

DateTime

O

0..1

When present, this IE shall indicate the estimated UTC time when the velocity estimate corresponded to the UE velocity (i.e. when the velocity estimate and the actual UE velocity was the same).

reportedEventType

ReportedEventType

M

1

This IE shall contain the type of event being reported.

supi

Supi

C

0..1

This IE shall contain the SUPI if available.

gpsi

Gpsi

C

0..1

This IE shall contain the GPSI if available.

hgmlcCallBackURI

Uri

C

0..1

Callback URI of the H-GMLC (NOTE 1)

ldrReference

LdrReference

M

1

LDR Reference

locationEstimate

GeographicArea

O

0..1

If present, this IE shall contain an estimate of the location of the UE in universal coordinates and the accuracy of the estimate.

ageOfLocationEstimate

AgeOfLocationEstimate

O

0..1

If present, this IE shall contain an indication of how long ago the location estimate was obtained.

timestampOfLocationEstimate

DateTime

O

0..1

When present, this IE shall indicate the estimated UTC time when the location estimate corresponded to the UE location (i.e. when the location estimate and the actual UE location was the same).

civicAddress

CivicAddress

O

0..1

If present, this IE shall contain a civic address.

localLocationEstimate

LocalArea

O

0..1

When present, this IE shall indicate a local area in reference system.

positioningDataList

array(PositioningMethodAndUsage)

O

1..N

If present, this IE shall indicate the usage of each non-GANSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully.

gnssPositioningDataList

array(GnssPositioningMethodAndUsage)

O

1..N

If present, this IE shall indicate the usage of each GANSS positioning method that was attempted to determine the location estimate, either successfully or unsuccessfully.

servingLMFIdentification

LMFIdentification

C

0..1

This IE shall be included to identify an LMF which acts as a serving LMF if a serving LMF is used.

terminationCause

TerminationCause

C

0..1

This IE shall be included if event reporting has been terminated

velocityEstimate

VelocityEstimate

O

0..1

If present, this IE shall contain an estimate of the velocity of the target UE, composed by horizontal speed, vertical speed, and their respective uncertainty.

altitude

Altitude

O

0..1

If present, this IE indicates the altitude of the positioning estimate.

When the shape used in "locationEstimate" supports conveying the altitude parameter, this IE shall be absent.

achievedQos

MinorLocationQoS

O

0..1

When present, this IE shall contain the achieved Location QoS Accuracy of the estimated location.

This IE may be present if the required LCS QoS Class in the location request procedure is "MULTIPLE_QOS".

If it’s absent, the required LCS QoS Class in the location request procedure is "MULTIPLE_QOS" and AccuracyFulfilmentIndicator is "REQUESTED_ACCURACY_FULFILLED", it indicates that the location QoS in the highest priority is achieved.

MUTIQOS

supportedFeatures

SupportedFeatures

C

0..1

This IE shall be present if at least one optional feature defined in clause 6.1.9 is supported.

NOTE 1: The hgmlcCallBackURI shall be included when the consumer NF is not the H-GMLC.

accessType

AccessType

M

1

Shall indicate the access type of the UE.

connectivitystate

CmState

O

0..1

When present, it shall indicate the UE connectivity state in the indicated access type.

coordinateId

string

M

1

This IE defines a known reference point which configured by the PLMN operator

point

GeographicalCoordinates

O

0..1

Indicates a geographic point represented by its longitude and latitude.

x

Float

M

1

Indicates the value (in the unit of meters) on x-axis of the relative location in the cartesian system.

Positive value represents easting from reference point (origin).

y

Float

M

1

Indicates the value (in the unit of meters) on y-axis of the relative location in the cartesian system.

Positive value represents northing from reference point (origin).

z

Float

O

0..1

Indicates the value (in the unit of meters) on z-axis of the relative location in the cartesian system for a 3D-Point.

Positive value represents height above reference point (origin).

shape

SupportedGADShapes

M

1

It shall take the value "LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE".

localOrigin

LocalOrigin

M

1

Indicates the local origin in the local Cartesian co-ordinates system configured by the PLMN operator.

point

RelativeCartesianLocation

M

1

Indicates a 2D-point (specified by "x" and "y" coordinates) relative to origin in refenrece system.

uncertaintyEllipse

UncertaintyEllipse

M

1

Indicates an uncertainty ellipse.

confidence

Confidence

M

1

Indicates the value of confidence.

shape

SupportedGADShapes

M

1

It shall take the value "LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID".

localOrigin

LocalOrigin

M

1

Indicates the local origin in the local Cartesian co-ordinates system configured by the PLMN operator.

point

RelativeCartesianLocation

M

1

Indicates a 3D-point (specified by "x", "y" and "z" coordinates) relative to origin in refenrece system.

uncertaintyEllipsoid

UncertaintyEllipsoid

M

1

Indicates the uncertainty ellipsoid

confidence

Confidence

M

1

Indicates the value of confidence.

semiMajor

Uncertainty

M

1

Indicates the semi-major axis of the uncertainty ellipsoid.

semiMinor

Uncertainty

M

1

Indicates the semi-minor axis of the uncertainty ellipsoid.

vertical

Uncertainty

M

1

Indicates the vertical axis of the uncertainty ellipsoid.

orientationMajor

Orientation

M

1

Indicates the orientation angle of the major axis.

Local2dPointUncertaintyEllipse

1

shape

LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE

Local area consisting of a point described in 2D local co-ordinates relative to an origin in a reference system, plus an uncertainty ellipse and a confidence value.

Local3dPointUncertaintyEllipsoid

1

shape

LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID

Local area consisting of a point described in 3D local co-ordinates relative to an origin in a reference system, distances r1 (the "semi-major uncertainty"), r2 (the "semi-minor uncertainty") and r3 (the "vertical uncertainty") and an angle of orientation A (the "angle of the major axis").

country

string

C

0..1

This IE shall be present if the country or the area of country where the UE is located is determined.

When present, this IE contains two-letter ISO 3166 country code in capital ASCII letters, e.g., DE or US

IETF RFC  4776 [6]

internationalAreaInd

boolean

C

0..1

Indicates international area

When present, it shall be set as follows:

– true: UE is located in international area.

– false (default): UE is not located in international area.

NOTE: Either country or internationalAreaInd shall be present.

hAccuracy

Accuracy

O

0..1

Horizontal accuracy

vAccuracy

Accuracy

O

0..1

Vertical accuracy

Altitude

number

Double-precision float value of the altitude, expressed in meters.

Minimum: -32767. Maximum: 32767.

Format: double.

Angle

integer

Integer value of the angle, expressed in degrees.

Minimum: 0. Maximum: 360.

Uncertainty

number

Float value of uncertainty, expressed in meters.

Minimum: 0

Format: float.

Orientation

integer

Integer value of the orientation angle, expressed in degrees.

Minimum: 0. Maximum: 180.

Confidence

integer

Integer value of the confidence, expressed in percentage value.

Minimum: 0. Maximum: 100.

Accuracy

number

Float value of accuracy, expressed in meters.

Minimum: 0

Format: float.

InnerRadius

integer

Integer value of the inner radius, expressed in meters.

Minimum: 0. Maximum: 327675.

Format: int32.

CorrelationID

string

LCS Correlation ID. The correlation ID shall be of a minimum length of 1 character and maximum length of 255 characters.

AgeOfLocationEstimate

integer

Integer value of the age of the location estimate, expressed in minutes.

Minimum: 0. Maximum: 32767.

HorizontalSpeed

number

Float value of horizontal speed, expressed in kilometres per hour.

Minimum: 0. Maximum: 2047.

Format: float.

VerticalSpeed

number

Float value of horizontal speed, expressed in kilometres per hour.

Minimum: 0. Maximum: 255.

Format: float.

SpeedUncertainty

number

Float value of speed uncertainty, expressed in kilometres per hour.

Minimum: 0. Maximum: 255.

Format: float.

BarometricPressure

integer

This IE specifies the measured uncompensated atmospheric pressure in units of Pascal (Pa).

Minimum: 30000. Maximum: 115000.

LcsServiceType

integer

The LCS service type as defined in 3GPP TS 22.071 [17] and clause 17.7.8 of 3GPP TS 29.002 [18].

Minimum: 0. Maximum: 127.

LdrReference

string

LDR Reference encoded as a string of hexadecimal characters. The LdrReference shall be of a minimum length of 2 characters and maximum length of 510 characters.

ReportingAmount

integer

Number of required periodic event reports.

Minimum: 1. Maximum: 8639999.

ReportingInterval

integer

Event reporting periodic interval in seconds.

Minimum: 1. Maximum: 8639999.

ReportingInterval x ReportingAmount shall not exceed 8639999.

MinimumInterval

integer

Minimum interval between event reports in seconds.

Minimum: 1. Maximum: 32767.

MaximumInterval

integer

Maximum interval between event reports in seconds.

Minimum: 1. Maximum: 86400.

SamplingInterval

integer

Maximum time interval between consecutive evaluations by a UE of a trigger event, in seconds.

Minimum: 1. Maximum: 3600

ReportingDuration

integer

Maximum duration of event reporting, in seconds.

Minimum: 1. Maximum: 8640000.

LinearDistance

integer

The minimum straight line distance moved by a UE to trigger a motion event report, in meters.

Minimum: 1. Maximum: 10000.

LMFIdentification

string

The serving LMF identification as defined in 3GPP TS 23.273 [19], encoded as a string of hexadecimal characters.

EventReportCounter

integer

Number of event reports received from the target UE.

Minimum: 1. Maximum: 8640000.

Note: the current event report is included in the count.

EventReportDuration

integer

Duration of event reporting, in seconds.

Minimum: 0. Maximum: 8640000.

Note: the duration starts when event reporting is activated in the UE and extends to the current time.

UePositioningCapabilities

Bytes

Positioning capabilities supported by the UE.

String with format "byte" as defined in OpenAPI Initiative [14], i.e. base64-encoded characters, encoding the "ProvideCapabilities-r9-IEs" IE as specified in clause 6.3 of 3GPP TS 37.355 [21] (start from octet 1).

"EMERGENCY_SERVICES"

External client for emergency services

"VALUE_ADDED_SERVICES"

External client for value added services

"PLMN_OPERATOR_SERVICES"

External client for PLMN operator services

"LAWFUL_INTERCEPT_SERVICES"

External client for Lawful Intercept services

"PLMN_OPERATOR_BROADCAST_SERVICES"

External client for PLMN Operator Broadcast services

"PLMN_OPERATOR_OM"

External client for PLMN Operator O&M

"PLMN_OPERATOR_ANONYMOUS_STATISTICS"

External client for PLMN Operator anonymous statistics

"PLMN_OPERATOR_TARGET_MS_SERVICE_SUPPORT"

External client for PLMN Operator target MS service support

"POINT"

Ellipsoid Point

"POINT_UNCERTAINTY_CIRCLE"

Ellipsoid point with uncertainty circle

"POINT_UNCERTAINTY_ELLIPSE"

Ellipsoid point with uncertainty ellipse

"POLYGON"

Polygon

"POINT_ALTITUDE"

Ellipsoid point with altitude

"POINT_ALTITUDE_UNCERTAINTY"

Ellipsoid point with altitude and uncertainty ellipsoid

"ELLIPSOID_ARC"

Ellipsoid Arc

"LOCAL_2D_POINT_UNCERTAINTY_ELLIPSE"

Local 2D point with uncertainty ellipse

"LOCAL_3D_POINT_UNCERTAINTY_ELLIPSOID"

Local 3D point with uncertainty ellipsoid

"LOW_DELAY"

Location request is expected with low delay level.

"DELAY_TOLERANT"

Location request is delay tolerant.

"NO_DELAY "

Location request is expected with no delay

(NOTE)

NOTE: The value is only used in the interface between GMLC and AF/LCS client via NEF, not further delivered to other NFs in the network. After receiving the enumeration value, the GMLC shall immediately return any location estimate, local location or civic location that it currently has. The GMLC shall return either the Initial or Last Known Location of the Target UE. If no location estimate or Dispatchable Location is available, the GLMC shall return the failure indication and may optionally initiate procedures to obtain a location estimate or Dispatchable Location (e.g. to be available for a later request).

"CELLID"

Cell ID positioning method

"ECID"

Enhanced cell ID methods based on LTE signals

"OTDOA"

Observed time difference of arrival positioning based on LTE signals

"BAROMETRIC_PRESSURE"

Positioning method based on barometric Pressure Sensor

"WLAN"

WLAN positioning

"BLUETOOTH"

Bluetooth positioning

"MBS"

Terrestrial Beacon System (TBS) positioning based on MBS signals

"MOTION_SENSOR"

Positioning method based on motion Sensor

"DL_TDOA"

Downlink Time Difference of Arrival (DL-TDOA) based on NR signals

"DL_AOD"

Downlink Angle-of-Departure (DL-AoD) based on NR signals

"MULTI-RTT"

Multi-Round Trip Time Positioning (Multi-RTT based on NR signals).

"NR_ECID"

NR enhanced cell ID methods (NR E-CID) based on NR signals.

"UL_TDOA"

Uplink Time Difference of Arrival (UL-TDOA) based on NR signals

"UL_AOA"

Uplink Angle of Arrival (UL-AoA), including the Azimuth of Arrival (A-AoA) and the Zenith of Arrival (Z-AoA) based on NR signals.

"NETWORK_SPECIFIC"

Network specific position methods.

"UE_BASED"

UE-based mode

"UE_ASSISTED"

UE-assisted mode

"CONVENTIONAL"

Conventional mode

"GPS"

GPS

"GALILEO"

Galileo

"SBAS"

Space Based Augmentation Systems

"MODERNIZED_GPS"

Modernized GPS

"QZSS"

Quasi Zenith Satellite System

"GLONASS"

Global Navigation Satellite System

"BDS"

BeiDou Navigation Satellite System

"NAVIC"

Navigation with Indian Constellation

"UNSUCCESS"

Not successful

"SUCCESS_RESULTS_NOT_USED"

Successful result not used

"SUCCESS_RESULTS_USED_TO_VERIFY_LOCATION"

Successful result used to verify the location estimate

"SUCCESS_RESULTS_USED_TO_GENERATE_LOCATION"

Successful result used to generate the location estimate

"SUCCESS_METHOD_NOT_DETERMINED"

Successful method not determined

"HIGHEST_PRIORITY"

LCS client with highest priority

"NORMAL_PRIORITY"

LCS client with normal priority

"VELOCITY_IS_NOT_REQUESTED"

velocity estimate is required

"VELOCITY_IS_REQUESTED"

velocity estimate is not required

"REQUESTED_ACCURACY_FULFILLED"

requested accuracy is fulfilled

"REQUESTED_ACCURACY_NOT_FULFILLED"

requested accuracy is not fulfilled

"UPWARD"

Vertical speed is upward

"DOWNWARD"

Vertical speed is downward

"UE_AVAILABLE"

UE available event

"PERIODIC"

Periodic event

"ENTERING_INTO_AREA"

Entering area event

"LEAVING_FROM_AREA"

Leaving area event

"BEING_INSIDE_AREA"

Being inside area event

"MOTION"

Motion event

"EPS_TRACKING_AREA_IDENTITY"

EPS TAI

"E-UTRAN_CELL_GLOBAL_IDENTIFICATION"

ECGI

"5GS_TRACKING_AREA_IDENTITY"

5GS TAI

"NR_CELL_GLOBAL_IDENTITY"

NCGI

"ONE_TIME_EVENT"

Event to be reported one-time only

"MULTIPLE_TIME_EVENT"

Event to be reported multiple times

"NR"

NG Radio access

"EUTRA_CONNECTED_TO_5GC"

E-URTAN access connected to 5GC

"NON_3GPP_CONNECTED_TO_5GC"

Non-3GPP access connected to 5GC

"NR_LEO"

NR (LEO) satellite access

"NR_MEO"

NR (MEO) satellite access

"NR_GEO"

NR (GEO) satellite access

"NR_OTHER_SAT"

NR (OTHERSAT) satellite access

"SUPPLEMENTARY_SERVICES"

A supplementary services message containing an argument for an lcs-EventReport operation as defined in 3GPP TS 24.080 [20].

"PERIODIC_EVENT"

Periodic reporting event

"ENTERING_AREA_EVENT"

Entering area reporting event

"LEAVING_AREA_EVENT"

Leaving area reporting event

"BEING_INSIDE_AREA_EVENT"

Being inside area reporting event

"MOTION_EVENT"

Motion reporting event

"MAXIMUM_INTERVAL_EXPIRATION_EVENT"

Expiration of maximum reporting interval event

"LOCATION_CANCELLATION_EVENT"

Cancellation of location reporting event

"TERMINATION_BY_UE"

Event reporting terminated by UE

"TERMINATION_BY_NETWORK"

Event reporting terminated by Network

"NORMAL_TERMINATION"

Normal Termination

"BEST_EFFORT"

Best Effort Class

"ASSURED"

Assured Class

"MULTIPLE_QOS"

Multiple QoS Class

MUTIQOS

"LOCATION_ESTIMATE"

Request location estimate

"LOCATION_ASSISTANCE_DATA"

Request location assistance data

POSITIONING_DENIED

403 Forbidden

The positioning procedure was denied.

UNSPECIFIED

403 Forbidden

The request is rejected due to unspecified reasons.

UNSUPPORTED_BY_UE

403 Forbidden

A request for periodic or triggered location is not supported by the UE.

LOCATION_SESSION_UNKNOWN

403 Forbidden

The location context was not found.

LOCATION_TRANSFER_NOT_SUPPORTED

403 Forbidden

Transfer of a location context is not supported

INSUFFICIENT_RESOURCES

403 Forbidden

Insufficient resources for location context transfer

EVENT_REPORT_UNRECOGNIZED

403 Forbidden

The event report is unrecognized or cannot be parsed.

POSITIONING_FAILED

500 Internal Server Error

The positioning procedure failed.

UNREACHABLE_USER

504 Gateway Timeout

The user could not be reached in order to perform positioning procedure.

1

ES3XX

M

Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Location service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15.

2

SAT

O

Satellite Access

Support of this feature implies the LMF shall be able to determine the geographical area identified by a country, area of a country or International area where UE is located for PLMN selection verification.

3

MUTIQOS

O

Support of Mlutiple Location QoSes.

This feature bit indicates whether the LMF support that more than one Location QoSes during consuming location service are required.

cipher-key-data

/cipher-key-data

POST

Ciphering Key Data

CipherRequestData

M

1

Input parameters to the "Ciphering Key Data" operation

CipherResponseData

M

1

200 OK

This case represents a successful request for ciphering key data.

Upon success, a response body is returned indicating whether the LMF has ciphering key data. The ciphering key data is returned separately in a CipheringKeyData notification.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same LMF or LMF (service) set.

ProblemDetails

O

0..1

403 Forbidden

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

– UNSPECIFIED

– BROADCAST_CIPHERING_KEYS_NOT_SUPPORTED

See table 6.2.7.3-1 for the description of this error.

NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

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

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Location

string

M

1

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

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

CipheringKeyInfo

M

1

Input parameters to the "Ciphering Key Data" operation

CipheringKeyResponse

M

1

200 OK

This case represents successful or partially successful storage of ciphering key information by the service consumer NF.

A response body is returned containing the following parameters:

– List of Ciphering Set IDs successfully stored

– List of Ciphering Set IDs not successfully stored

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

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

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

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

ProblemDetails

O

0..1

403 Forbidden

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

– UNSPECIFIED

– UNABLE_TO_STORE_CIPHERING_KEY_DATA

See table 6.2.7.3-1 for the description of this error.

NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] other than those specified in the table above also apply, with a ProblemDetails data type (see clause 5.2.7 of 3GPP TS 29.500 [4]).

Location

string

M

1

A URI pointing to the endpoint of NF service consumer to which the notification should be sent

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

Location

string

M

1

A URI pointing to the endpoint of NF service consumer to which the notification should be sent

3gpp-Sbi-Target-Nf-Id

string

O

0..1

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

CipheringKeyInfo

6.2.6.2.2

Information within Ciphering Key Data Notification request

CipheringKeyResponse

6.2.6.2.3

Information within Ciphering Key Data Notification Response

CipheringDataSet

6.2.6.2.4

Represents a Ciphering Data Set

CipheringSetReport

6.2.6.2.5

Represents a report of Ciphering Data Set storage

CipherRequestData

6.2.6.2.6

Information within Ciphering Key Data request

CipherResponseData

6.2.6.2.7

Information within Ciphering Key Data Response

CipheringSetID

6.2.6.3.2

Ciphering Data Set ID

CipheringKey

6.2.6.3.2

Ciphering Key

C0

6.2.6.3.2

First component of the initial ciphering counter

ValidityDuration

6.2.6.3.2

Validity Duration of the Ciphering Data Set

StorageOutcome

6.2.6.3.3

Indicates the result of Ciphering Data Set storage

DataAvailability

6.2.6.3.4

Indicates availability of ciphering key data at an LMF

Bytes

3GPP TS 29.571 [8]

Binary data encoded as a base64 character string

DateTime

3GPP TS 29.571 [8]

Date and Time

Uri

3GPP TS 29.571 [8]

Uniform Resource Identifier

SupportedFeatures

3GPP TS 29.571 [8]

Supported Features

RedirectResponse

3GPP TS 29.571 [8]

Redirect Response

cipheringData

array(CipheringDataSet)

M

1..N

This IE contains one or more ciphering data sets, where each ciphering data set contains information for one ciphering key.

supportedFeatures

SupportedFeatures

C

0..1

This IE shall be present if at least one optional feature defined in clause 6.2.9 is supported.

cipheringDataReport

Array(CipheringSetReport)

O

1..N

This IE indicates the ciphering data sets which were successfully stored or not stored.

The absence of this IE indicates that all ciphering data sets were successfully stored.

cipheringSetID

CipheringSetID

M

1

Identification of a ciphering data set

cipheringKey

CipheringKey

M

1

A ciphering key value

c0

C0

M

1

First component of the initial ciphering counter as defined in clause 7.4.2 of 3GPP TS 37.355 [21]

ltePosSibTypes

Bytes

O

0..1

This IE contains a bitmap indicating the LTE positioning SIB types for which the ciphering data set is applicable:

– a bit set to 0 indicates that the ciphering data set is not applicable to the corresponding LTE positioning SIB type

– a bit set to 1 indicates that the ciphering data set is applicable to the corresponding LTE positioning SIB type

The mapping of the bits to the LTE positioning SIB types is as follows:

— bit 8 in the first octet maps to positioning SIB Type 1-1

— bit 7 in the first octet maps to positioning SIB Type 1-2

— bit 6 in the first octet maps to positioning SIB Type 1-3

— bit 5 in the first octet maps to positioning SIB Type 1-4

— bit 4 in the first octet maps to positioning SIB Type 1-5

— bit 3 in the first octet maps to positioning SIB Type 1-6

— bit 2 in the first octet maps to positioning SIB Type 1-7

— bit 1 in the first octet maps to positioning SIB Type 1-8

— bit 8 in the second octet maps to positioning SIB Type 2-1

— bit 7 in the second octet maps to positioning SIB Type 2-2

— bit 6 in the second octet maps to positioning SIB Type 2-3

— bit 5 in the second octet maps to positioning SIB Type 2-4

— bit 4 in the second octet maps to positioning SIB Type 2-5

— bit 3 in the second octet maps to positioning SIB Type 2-6

— bit 2 in the second octet maps to positioning SIB Type 2-7

— bit 1 in the second octet maps to positioning SIB Type 2-8

— bit 8 in the third octet maps to positioning SIB Type 2-9

— bit 7 in the third octet maps to positioning SIB Type 2-10

— bit 6 in the third octet maps to positioning SIB Type 2-11

— bit 5 in the third octet maps to positioning SIB Type 2-12

— bit 4 in the third octet maps to positioning SIB Type 2-13

— bit 3 in the third octet maps to positioning SIB Type 2-14

— bit 2 in the third octet maps to positioning SIB Type 2-15

— bit 1 in the third octet maps to positioning SIB Type 2-16

— bit 8 in the fourth octet maps to positioning SIB Type 2-17

— bit 7 in the fourth octet maps to positioning SIB Type 2-18

— bit 6 in the fourth octet maps to positioning SIB Type 2-19

— bit 5 in the fourth octet maps to positioning SIB Type 2-20

— bit 4 in the fourth octet maps to positioning SIB Type 2-21

— bit 3 in the fourth octet maps to positioning SIB Type 2-22

— bit 2 in the fourth octet maps to positioning SIB Type 2-23

— bit 1 in the fourth octet maps to positioning SIB Type 2-24

— bit 8 in the fifth octet maps to positioning SIB Type 2-25

— bit 7 in the fifth octet maps to positioning SIB Type 3-1

— bit 6 in the fifth octet maps to positioning SIB Type 4-1

— bit 5 in the fifth octet maps to positioning SIB Type 5-1

Any unassigned bits are spare and shall be coded as zero. Non-included bits shall be treated as being coded as zero.

(NOTE 1)

nrPosSibTypes

Bytes

O

0..1

This IE contains a bitmap indicating the NR positioning SIB types for which the ciphering data set is applicable:

– a bit set to 0 indicates that the ciphering data set is not applicable to the corresponding NR positioning SIB type

– a bit set to 1 indicates that the ciphering data set is applicable to the corresponding NR positioning SIB type

The mapping of the bits to the NR positioning SIB types is as follows:

— bit 8 in the first octet maps to positioning SIB Type 1-1

— bit 7 in the first octet maps to positioning SIB Type 1-2

— bit 6 in the first octet maps to positioning SIB Type 1-3

— bit 5 in the first octet maps to positioning SIB Type 1-4

— bit 4 in the first octet maps to positioning SIB Type 1-5

— bit 3 in the first octet maps to positioning SIB Type 1-6

— bit 2 in the first octet maps to positioning SIB Type 1-7

— bit 1 in the first octet maps to positioning SIB Type 1-8

— bit 8 in the second octet maps to positioning SIB Type 2-1

— bit 7 in the second octet maps to positioning SIB Type 2-2

— bit 6 in the second octet maps to positioning SIB Type 2-3

— bit 5 in the second octet maps to positioning SIB Type 2-4

— bit 4 in the second octet maps to positioning SIB Type 2-5

— bit 3 in the second octet maps to positioning SIB Type 2-6

— bit 2 in the second octet maps to positioning SIB Type 2-7

— bit 1 in the second octet maps to positioning SIB Type 2-8

— bit 8 in the third octet maps to positioning SIB Type 2-9

— bit 7 in the third octet maps to positioning SIB Type 2-10

— bit 6 in the third octet maps to positioning SIB Type 2-11

— bit 5 in the third octet maps to positioning SIB Type 2-12

— bit 4 in the third octet maps to positioning SIB Type 2-13

— bit 3 in the third octet maps to positioning SIB Type 2-14

— bit 2 in the third octet maps to positioning SIB Type 2-15

— bit 1 in the third octet maps to positioning SIB Type 2-16

— bit 8 in the fourth octet maps to positioning SIB Type 2-17

— bit 7 in the fourth octet maps to positioning SIB Type 2-18

— bit 6 in the fourth octet maps to positioning SIB Type 2-19

— bit 5 in the fourth octet maps to positioning SIB Type 2-20

— bit 4 in the fourth octet maps to positioning SIB Type 2-21

— bit 3 in the fourth octet maps to positioning SIB Type 2-22

— bit 2 in the fourth octet maps to positioning SIB Type 2-23

— bit 1 in the fourth octet maps to positioning SIB Type 3-1

— bit 8 in the fifth octet maps to positioning SIB Type 4-1

— bit 7 in the fifth octet maps to positioning SIB Type 5-1

— bit 6 in the fifth octet maps to positioning SIB Type 6-1

— bit 5 in the fifth octet maps to positioning SIB Type 6-2

— bit 4 in the fifth octet maps to positioning SIB Type 6-3

Any unassigned bits are spare and shall be coded as zero. Non-included bits shall be treated as being coded as zero.

(NOTE 1)

validityStartTime

DateTime

M

1

This IE contains the UTC time when the ciphering data set becomes valid.

validityDuration

ValidityDuration

M

1

The validity duration of the ciphering data set.

taiList

Bytes

O

0..1

This IE contains the TAIs of the tracking areas for which the ciphering data set is applicable. It is encoded as octets 2 to n of the 5GS tracking area identity list IE specified in clause 9.11.3.9 of 3GPP TS 24.501 [22].

If this IE is omitted, the ciphering data set is valid in the entire PLMN.

NOTE 1: At least one of ltesibTypes IE and nrsibTypes IE shall be included.

cipheringSetID

CipheringSetID

M

1

Identification of a ciphering data set

storageOutcome

StorageOutcome

M

1

Indication of whether the ciphering data set was successfully stored or was not stored.

amfCallBackURI

Uri

M

1

Callback URI of the NF Service Consumer

supportedFeatures

SupportedFeatures

C

0..1

This IE shall be present if at least one optional feature defined in clause 6.2.9 is supported.

dataAvailability

DataAvailability

M

1

An indication of whether the LMF currently has ciphering key data applicable to the NF Service Consumer

CipheringSetID

integer

The ciphering set ID

Minimum = 0. Maximum = 65535

CipheringKey

Bytes

A 128 bit ciphering key encoded as a base64 character string

C0

Bytes

A 128 bit value for C0 encoded as a base64 character string

ValidityDuration

integer

The validity duration in minutes.

Minimum = 1. Maximum = 65535

"STORAGE_SUCCESSFUL"

Indicates storage of Ciphering Data Set is successful

"STORAGE_FAILED"

Indicates storage of Ciphering Data Set is not successful

"CIPHERING_KEY_DATA_AVAILABLE"

Indicates Ciphering Data Set is available in LMF

CIPHERING_KEY_DATA_NOT_AVAILABLE"

Indicates Ciphering Data Set is not available in LMF

UNSPECIFIED

403 Forbidden

The request is rejected due to unspecified reasons.

UNABLE_TO_STORE_CIPHERING_KEY_DATA

403 Forbidden

The service consumer NF was unable to store ciphering key data.

BROADCAST_CIPHERING_KEYS_NOT_SUPPORTED

403 Forbidden

Ciphering keys for broadcast are not supported.

1

ES3XX

M

Extended Support of HTTP 307/308 redirection

An NF Service Consumer (e.g. AMF) that supports this feature shall support handling of HTTP 307/308 redirection for any service operation of the Broadcast service. An NF Service Consumer that does not support this feature does only support HTTP redirection as specified for 3GPP Release 15.