{apiRoot}/ngmlc-loc/<apiVersion>/provide-location

POST

Request or Subscribe the geodetic and optionally local and/or civic location of a target UE or a target group of UEs

{apiRoot}/ngmlc-loc/<apiVersion>/cancel-location

POST

Cancel an on-going periodic or triggered location request of a target UE or a target group of UEs

{apiRoot}/ngmlc-loc/<apiVersion>/location-update

POST

Enable the UE to update UE location information towards the consumer NF

{apiRoot}/ngmlc-loc/<apiVersion>/loc-update-subs

POST

Enable a NF service consumer (e.g. NEF) to subscribe to UE location information

InputData

M

1

Input parameters to the "Provide-Location" operation

LocationData

M

1

200 OK

This case represents the successful retrieval of the location of the UE or successful subscription of periodic or triggered location of the UE, or represents completely or partially accept of the requesting locations for a target group.

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

– Geographic Area

– Local Location

– Civic Location

– Age of Location

– Accuracy of Location

– Positioning methods

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, tthe URI shall be an alternative URI of the resource located on an alternative service instance within the same GMLC or GMLC (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 GMLC or GMLC (service) set.

ProblemDetails

O

0..1

403 Forbidden

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

– POSITIONING_DENIED

– UNSPECIFIED

– UNSUPPORTED_BY_UE

– DETACHED_USER

See table 6.1.6.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.6.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

– PEER_NOT_RESPONDING

See table 6.1.6.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 [5] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [5]).

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same GMLC or GMLC (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 GMLC or GMLC (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 is used to cancel deferred 5GC-MT-LR for a single UE or for a group of UE.

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 GMLC or GMLC (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 GMLC or GMLC (service) set.

ProblemDetails

O

0..1

403 Forbidden

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

– UNSPECIFIED

– LOCATION_SESSION_UNKNOWN

See table 6.1.6.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 [5] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [5]).

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same GMLC or GMLC (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 GMLC or GMLC (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

LocUpdateData

M

1

Input parameters to the "location-update" operation

n/a

204 No Content

This case represents successful update 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 GMLC or GMLC (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 GMLC or GMLC (service) set.

ProblemDetails

O

0..1

403 Forbidden

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

– UNSPECIFIED

– UNREQUESTED_BY_UE

– UNKOWN_EXTERNAL_CLIENT_OR_AF

– UNREACHABLE_EXTERNAL_CLIENT_OR_AF

See table 6.1.6.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 [5] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [5]).

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same GMLC or GMLC (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 GMLC or GMLC (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

LocUpdateSubs

M

1

Contains the subscription to UE location update information that is to be created.

n/a

204 No Content

This case represents the successful UE location information subscription creation.

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 GMLC or GMLC (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 GMLC or GMLC (service) set.

ProblemDetails

O

0..1

403 Forbidden

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

– UNSPECIFIED

– UNREQUESTED_BY_UE

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

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

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same GMLC or GMLC (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 GMLC or GMLC (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

EventNotifyDataExt

M

1

Input parameters to the "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 one of the following application errors:

– UNSPECIFIED

– LOCATION_SESSION_UNKNOWN

See table 6.1.6.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 [5] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [5]).

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

LocUpdateNotification

M

1

Input parameters to the "LocationUpdateNotification" 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 one of the following application errors:

– UNSPECIFIED

– UNKOWN_EXTERNAL_CLIENT_OR_AF

– UNREACHABLE_EXTERNAL_CLIENT_OR_AF

See table 6.1.6.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 [5] other than those specified in the table above also apply, with a ProblemDetails data type when needed (see clause 5.2.7 of 3GPP TS 29.500 [5]).

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.5.2.2

the input parameters in ProvideLocation service operation

LocationData

6.1.5.2.3

the response parameters in ProvideLocation service operation

CancelLocData

6.1.5.2.4

the input parameters in CancelLocation service operation

LocUpdateData

6.1.5.2.5

the input parameters in LocationUpdate service operation

EventNotifyData

6.1.5.2.6

the input parameters for the target UE in EventNotify Notification service operation

UePrivacyRequirements

6.1.5.2.7

UE privacy requirements from (H)GMLC to the serving AMF or VGMLC(in the roaming case) for the target UE

LocUpdateNotification

6.1.5.2.9

Location Update Notification

LocUpdateSubs

6.1.5.2.10

UE location information subscription

AreaEventInfoAddition

6.1.5.2.13

Additional information for Extended Area event information

AreaEventInfoExt

6.1.5.2.14

Extended Area Event Information

ServiceIdentity

6.1.5.3.2

service identity

CodeWord

6.1.5.3.2

codeword

ExternalClientIdentification

6.1.5.3.2

external client identification

E164CountryCodeOfGeographicArea

6.1.5.3.2

E.164 country codes for geographic areas

LcsServiceTypeId

6.1.5.3.2

LCS Service Type Id

PseudonymIndicator

6.1.5.3.3

It defines if a pseudonym is requested

LocationRequestType

6.1.5.3.4

NI-LR, MT-LR or MO-LR

LocationTypeRequested

6.1.5.3.5

the location type requested by the LCS client

EventNotifyDataType

6.1.5.3.6

the type of event that triggers event notification

EventNotifyDataAdditionalInfo

6.1.5.2.11

Additional information to Event Notify Data

EventNotifyDataExt

6.1.5.2.12

Extended Event Notify Data for UEs of a target group

FailureCause

6.1.5.3.7

Positioning failure cause

SuccessType

6.1.5.3.8

Success Type to indicate full or partial success

Gpsi

3GPP TS 29.571 [11]

Supi

3GPP TS 29.571 [11]

Uri

3GPP TS 29.571 [11]

AmfId

3GPP TS 29.571 [11]

NfInstanceId

3GPP TS 29.571 [11]

ExternalClientType

3GPP TS 29.572 [12]

LocationQoS

3GPP TS 29.572 [12]

LcsQosClass

3GPP TS 29.572 [12]

SupportedGADShapes

3GPP TS 29.572 [12]

PeriodicEventInfo

3GPP TS 29.572 [12]

AreaEventInfo

3GPP TS 29.572 [12]

MotionEventInfo

3GPP TS 29.572 [12]

LdrType

3GPP TS 29.572 [12]

LdrReference

3GPP TS 29.572 [12]

AgeOfLocationEstimate

3GPP TS 29.572 [12]

PositioningMethod

3GPP TS 29.572 [12]

AccuracyFulfilmentIndicator

3GPP TS 29.572 [12]

LmfIdentification

3GPP TS 29.572 [12]

LcsServiceType

3GPP TS 29.572 [12]

VelocityRequested

3GPP TS 29.572 [12]

LcsPriority

3GPP TS 29.572 [12]

VelocityEstimate

3GPP TS 29.572 [12]

TerminationCause

3GPP TS 29.572 [12]

PositioningMethodAndUsage

3GPP TS 29.572 [12]

GnssPositioningMethodAndUsage

3GPP TS 29.572 [12]

LcsServiceAuth

3GPP TS 29.571 [11]

Ecgi

3GPP TS 29.571 [11]

Ncgi

3GPP TS 29.571 [11]

Altitude

3GPP TS 29.572 [12]

Altitude

BarometricPressure

3GPP TS 29.572 [12]

Barometric pressure

MinorLocationQoS

3GPP TS 29.572 [12]

Minor Location QoS

MUTIQOS

LocationPrivacyVerResult

3GPP TS 29.518 [20]

ExternalGroupId

3GPP TS 29.571 [11]

External Group Identifier

GroupId

3GPP TS 29.571 [11]

Group Identifier

CivicAddress

3GPP TS 29.572 [12]

Civic Address

GeographicArea

3GPP TS 29.572 [12]

Geographic Area

LocalArea

3GPP TS 29.572 [12]

Local area specified by different shape

RedirectResponse

3GPP TS 29.571 [11]

DateTime

3GPP TS 29.571 [11]

Date and Time

gpsi

Gpsi

O

0..1

Generic Public Subscription Identifier

(NOTE 3).

supi

Supi

O

0..1

Subscription Permanent Identifier

(NOTE 3).

extGroupId

ExternalGroupId

O

0..1

This IE may be present when requesting LCS service for a group of target UEs, if present this IE shall contain the External Group ID

(NOTE 3).

intGroupId

GroupId

O

0..1

This IE may be present when requesting LCS service for a group of target UEs, if present this IE shall contain the Internal Group ID

(NOTE 3).

externalClientType

ExternalClientType

M

1

This IE shall contain LCS client type

locationQoS

LocationQoS

O

0..1

Requested location QoS

Multiple QoS Class (lcsQosClass sets to "MULTIPLE_QOS") shall only be used when GMLC support MUTIQOS feature.

supportedGADShapes

array(SupportedGADShapes)

O

1..N

Supported Geographical Area Description shapes

serviceIdentity

ServiceIdentity

O

0..1

Service identity

serviceCoverage

array(E164CountryCodeOfGeographicArea)

O

1..N

A list of E.164 country codes for geographic areas (see ITU Recommendation E.164 [13]) where the LCS client is permitted to request and receive UE location information.

ldrType

LdrType

C

0..1

Location deferred request event type

periodicEventInfo

PeriodicEventInfo

C

0..1

Periodic event information of the location request for a target UE

areaEventInfo

AreaEventInfoExt

C

0..1

Area event information of the location request for a target UE

motionEventInfo

MotionEventInfo

C

0..1

Motion event information of the location request for a target UE

ldrReference

LdrReference

C

0..1

Notification correlation

ID

It shall be present in the request from NEF if it is allocated by NEF for the Deferred 5GC-MT-LR procedure.

It shall be present in the request from NEF for requesting location service for a group of UEs.

It shall be present in the request to VGMLC for the Deferred 5GC-MT-LR procedure.

hgmlcCallBackUri

Uri

O

0..1

Notification target address for HGMLC

eventNotificationUri

Uri

O

0..1

The call-back Uri of NF service consumer (i.e. NEF) for implicit subscription to notification of Eventnotify.

This IE should be included and is used to receive the location information for UEs in the group when requesting LCS service for a group of target UEs or requesting deferred 5GC MT LCS service for a single UE.

externalClientIdentification

ExternalClientIdentification

O

0..1

External LCS client identification

afId

string

O

0..1

The identification of AF that initiated location request

uePrivacyRequirements

UePrivacyRequirements

O

0..1

UE privacy requirement

lcsServiceType

LcsServiceType

O

0..1

LCS service type

This IE may be present when being sent from HGMLC to VGMLC.

When present, it shall contain the LCS service type, which is mapped from attribute serviceIdentity of the LCS Request by the HGMLC.

velocityRequested

VelocityRequested

O

0..1

Velocity of the target UE is requested

priority

LcsPriority

O

0..1

Priority of the location request

locationTypeRequested

LocationTypeRequested

O

0..1

Requested type of location, applicable to location immediate request (NOTE 2)

maximumAgeOfLocationEstimate

AgeOfLocationEstimate

O

0..1

Requested maximum age of the location estimate

amfId

AmfId

O

0..1

The identification of serving AMF

codeWord

CodeWord

O

0..1

Code word (NOTE 1)

scheduledLocTime

DateTime

O

0..1

The scheduled time for location determination

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 [22] 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: Checking of the Codeword in UE applies only when the Codeword parameter is present and when the codeWordCheck parameter (specified in clause 6.1.5.2.7) is present and set to TRUE.

NOTE 2: If the LocationTypeRequested parameter is set to value "NOTIFICATION_VERIFICATION_ONLY", then the lcsServiceAuthInfo attribute in the uePrivacyRequirements IE, if present, shall be set to either "NOTIFICATION_ONLY" or "NOTIFICATION_AND_VERIFICATION_ONLY".

NOTE 3: If retrieving the location for a target UE, the UE identification (attributes gpsi and/or supi) shall be included, if retrieving the UE locations for a target group, the group identification (attributes extGroupId and/or intGroupId), UE identification and group identification shall be included exclusively.

gpsi

Gpsi

O

0..1

Generic Public Subscription Identitfier

supi

Supi

O

0..1

Subscription Permanent Identifier

locationEstimate

GeographicArea

O

0..1

Geographic area of the target UE

civicAddress

CivicAddress

O

0..1

Civic address of the target UE

localLocationEstimate

LocalArea

O

0..1

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

ageOfLocationEstimate

AgeOfLocationEstimate

O

0..1

Age of 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).

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.

accuracyFulfilmentIndicator

AccuracyFulfilmentIndicator

O

0..1

The indication whether the obtained location estimate satisfies the requested accuracy or not

ueVelocity

VelocityEstimate

O

0..1

Responded UE velocity, if requested and available

ldrReference

LdrReference

C

0..1

Notification correlation ID

It shall be present in the response to NEF if it is allocated by HGMLC for the the Deferred 5GC-MT-LR procedure.

altitude

Altitude

C

0..1

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

This IE shall be sent from (V)GMLC to (H)GMLC if received by VGMLC from AMF when roaming.

servingLMFIdentification

LMFIdentification

C

0..1

If present, this IE contains the identification of a serving LMF for periodic or triggered location.

This IE shall be sent from (V)GMLC to (H)GMLC if received by VGMLC from AMF when roaming.

locationPrivacyVerResult

LocationPrivacyVerResult

C

0..1

If present, this IE contains the result of location privacy verification by UE.

The IE shall be included from (V)GMLC to (H)GMLC if received from the serving AMF by (V)GMLC when roaming and a location request with notification and privacy verification only indication is sent to the serving AMF via (V)GMLC by (H)GMLC during location request procedure..

successType

SuccessType

C

0..1

This IE is only used for requesting LCS service for a group, and shall be present to indicate one of the following value.

– SUCCESS_COMPLETELY

– SUCCESS_PARTIALLY

The value "SUCCESS_COMPLETELY" indicates that requesting/subscribing to LCS service is successful for all the UE(s) within the group identified by the external/internal group ID.

The value "SUCCESS_PARTIALLY" indicates that requesting/subscribing to LCS service is only successful for a part of the UE(s) within the group identified by the external/internal group ID.

The default value of this attribute is "SUCCESS_COMPLETELY" if this IE is not present.

achievedQos

MinorLocationQoS

O

0..1

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

This IE shall be present if received.

MUTIQOS

supi

Supi

O

0..1

This IE may be present when requesting cancellation of LCS service for a single UE.

When present, this IE shall contain the Subscription Permanent Identifier of the target UE.

(NOTE).

gpsi

Gpsi

O

0..1

This IE may be present when requesting cancellation of LCS service for a single UE.

When present, this IE shall contain the Generic Public Subscription identifier of the target UE.

(NOTE).

extGroupId

ExternalGroupId

O

0..1

This IE may be present when requesting cancellation of LCS service for a group of target UEs.

When present this IE shall contain the External Group ID

(NOTE).

O

0..1

This IE may be present when requesting cancellation of LCS service for a group of target UEs.

When present this IE shall contain the Internal Group ID

(NOTE).

hgmlcCallBackUri

Uri

M

1

Notification target address

ldrReference

LdrReference

M

1

LDR Reference

lmfIdentification

LmfIdentification

O

0..1

The latest LMF identification received

amfId

AmfId

O

0..1

The identification of the serving AMF

NOTE: If cancelling the location for a target UE, the UE identification (attributes gpsi and/or supi) shall be included, if cancelling the UE locations for a target group, the group identification (attributes extGroupId and/or intGroupId), UE identification and group identification shall be included exclusively.

supi

Supi

O

0..1

Subscription Permanent Identifier

gpsi

Gpsi

O

0..1

Generic Public Subscription identitfier

pseudonymIndicator

PseudonymIndicator

O

0..1

Pseudonym indicator

locationRequestType

LocationRequestType

M

1

Event causing the location estimate (5GC-MO-LR)

locationEstimate

GeographicArea

M

1

Geographic area of the target UE

ageOfLocationEstimate

AgeOfLocationEstimate

M

1

Age of 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).

accuracyFulfilmentIndicator

AccuracyFulfilmentIndicator

M

1

The indication whether the obtained location estimate satisfies the requested accuracy or not

civicAddress

CivicAddress

O

0..1

Civic address of the target UE

lcsQosClass

LcsQosClass

M

1

The LCS QoS Class requested by the target UE

externalClientIdentification

ExternalClientIdentification

O

0..1

Identity of the LCS client

afId

string

O

0..1

Identity of the AF

gmlcNumber

string

C

0..1

This IE shall be included by the AMF in the request to V-GMLC, if the "mlc-number" IE is received in MO request from the UE.

When present, this IE shall contain the GMLC Number (in E.164 international number format) indicated in the "mlc-number" IE of the MO request from the UE. The V-GMLC may query NRF to obtain the H-GMLC using the GMLC Number.

Pattern: "^[0-9]{5,15}$"

lcsServiceType

LcsServiceTypeId

O

0..1

When present, this IE shall contain the LCS Service Type received from the UE, as specified in clause 6.2 of 3GPP TS 23.273 [4].

When received, the H-GMLC shall map the received LCS Service Type to the Service Identity in Location Update Notification.

supi

Supi

O

0..1

Subscription Permanent Identifier

gpsi

Gpsi

O

0..1

Generic Public Subscription Identifier

ldrReference

LdrReference

M

1

LDR Reference

eventNotifyDataType

EventNotifyDataType

M

1

The type of event that triggers event notification

locationEstimate

GeographicArea

O

0..1

Geographic area of the target UE

civicAddress

CivicAddress

O

0..1

Civic address of the target UE

localLocationEstimate

LocalArea

O

0..1

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

ageOfLocationEstimate

AgeOfLocationEstimate

O

0..1

Age of 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).

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.

lmfIdentification

LmfIdentification

O

0..1

LMF identification that stores the location context of the target UE

amfId

AmfId

O

0..1

The identification of AMF that is serving the target UE

terminationCause

TerminationCause

C

0..1

The IE shall be included if event reporting has been terminated

velocityEstimate

VelocityEstimate

C

0..1

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

This IE shall be sent from (V)GMLC to (H)GMLC if received by VGMLC from AMF when roaming.

altitude

Altitude

C

0..1

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

This IE shall be sent from (V)GMLC to (H)GMLC if received by VGMLC from AMF when roaming.

targetNode

NfInstanceId

C

0..1

For mobility of a UE with periodic or triggered location, this IE contains the address of the new serving node and shall be sent from (V)GMLC to (H)GMLC if received by VGMLC from AMF when roaming.

accuracyFulfilmentIndicator

AccuracyFulfilmentIndicator

O

0..1

The indication whether the obtained location estimate satisfies the requested accuracy or not

failureCause

FailureCause

C

0..1

This IE shall contain the failure cause for the UE if present.

The IE shall be included if positioning has failed for the target UE in the target group.

achievedQos

MinorLocationQoS

O

0..1

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

This IE shall be present if received.

MUTIQOS

lcsServiceAuthInfo

LcsServiceAuth

O

0..1

When present, this IE shall contain an indication of privacy related notification or verification for the target UE.

The default value of this parameter if not presents is "LOCATION_ALLOWED_WITHOUT_NOTIFICATION".

codeWordCheck

boolean

O

0..1

When present, it shall indicate whether the Codeword parameter shall be checked in UE. (NOTE)

NOTE: Checking of the Codeword in UE applies only when the Codeword parameter (specified in clause 6.1.5.2.2) is present and when the codeWordCheck parameter is present and set to TRUE.

supi

Supi

O

0..1

Subscription Permanent Identifier

gpsi

Gpsi

O

0..1

Generic Public Subscription identitfier

locationRequestType

LocationRequestType

M

1

Event causing the location estimate (5GC-MO-LR)

locationEstimate

GeographicArea

M

1

geographic area of the target UE

ageOfLocationEstimate

AgeOfLocationEstimate

M

1

Age of 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).

accuracyFulfilmentIndicator

AccuracyFulfilmentIndicator

M

1

The indication whether the obtained location estimate satisfies the requested accuracy or not

civicAddress

CivicAddress

O

0..1

Civic address of the target UE

lcsQosClass

LcsQosClass

M

1

The LCS QoS Class requested by the target UE

afId

string

O

0..1

Identity of the AF

serviceIdentity

ServiceIdentity

O

0..1

When present, this IE shall contain Service Identity mapped from the LCS Service Type specified by the UE, as specified in clause 6.2 of 3GPP TS 23.273 [4].

nfInstanceId

NfInstanceId

M

1

Identity of the NF Instance creating the subscription.

notifUri

Uri

M

1

The URI via which the NF service consumer wants to receive notifications related to this subscription.

supi

Supi

C

0..1

SUPI of the UE concerned by the subscription.

This attribute shall be present if the gpsi attribute is not present.

gpsi

Gpsi

C

0..1

GPSI of the UE concerned by the subscription.

This attribute shall be present if the supi attribute is not present.

addEventDataList

array(EventNotifyData)

O

1..N

When present, this IE shall include a list of event reports of the additional UE(s) which belong to the target group.

EventNotifyData

1

Event Notification Data

EventNotifyDataAdditionalInfo

1

Additional information of the Event Notification Data

geoAreaList

array(GeographicArea)

O

1..N

One or more geographic areas for location reporting event

ignoreAreaDefInd

boolean

O

0..1

Indicating whether the "areaDefinition" IE in AreaEventInfoExt combined data type shall be ignored or not:

– true: the "areaDefinition" IE shall be ignored.

– false (default)" the "areaDefinition" IE shall not be ignored.

AreaEventInfo

1

Area Event Information

AreaEventInfoAddition

1

Addition information for Extended Area Event Information

ServiceIdentity

string

Service identity

ExternalClientIdentification

string

External LCS client identification

CodeWord

string

codeword

E164CountryCodeOfGeographicArea

string

The combination of one, two or three digits identifying a specific country, countries in an integrated numbering plan, or a specific geographic area

LcsServiceTypeId

integer

LCS Service Type Id, as specified clause 7.6.11.15 of 3GPP TS 29.002 [xx].

Minimum = 0. Maximum = 127

"PSEUDONYM_REQUESTED"

A pseudonym is requested

"PSEUDONYM_NOT_REQUESTED"

A pseudonym is not requested

"NI-LR"

Network induced location request

"MT-LR"

Mobile terminated location request

"MO-LR"

Mobile originated location request

"CURRENT_LOCATION"

Requesting the current location of the target UE

"CURRENT_OR_LAST_KNOWN_LOCATION"

Requesting the current or last known location of the target UE

"INITIAL_LOCATION"

Requesting the initial location of the target UE

"NOTIFICATION_VERIFICATION_ONLY"

Requesting notification verification only

"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

"MAXIMUM_INTERVAL_EXPIRATION_EVENT"

Expiration of maximum reporting interval event

"LOCATION_CANCELLATION_EVENT"

Cancellation of location reporting event

"ACTIVATION_OF_DEFERRED_LOCATION"

A confirmation that periodic or triggered location was successfully activated in the target UE

"UE_MOBILITY_FOR_DEFERRED_LOCATION"

Mobility of the target UE to a different NF

"5GC_MT_LR"

Report of immediate 5GC mobile terminated location.

It is used for 5GC_MT_LR request targeting to a group of UE procedure.

"POSITIONING_DENIED"

Positioning is denied

"UNSUPPORTED_BY_UE"

Positioning is not supported by UE

"NOT_REGISTED_UE"

UE doesn’t register

"UNSPECIFIED"

Unspecified

"SUCCESS_COMPLETELY"

It is completely successful.

"SUCCESS_PARTIALLY"

It is partially successful.

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

the position request for periodic or triggered location is not supported by the target UE

LOCATION_SESSION_UNKNOWN

403 Forbidden

the location context was not found

UNREQUESTED_BY_UE

403 Forbidden

the UE did not request transfer of its location to an LCS Client or AF

UNKOWN_EXTERNAL_CLIENT_OR_AF

403 Forbidden

the external LCS client or AF is unknown

UNREACHABLE_EXTERNAL_CLIENT_OR_AF

403 Forbidden

the external LCS client or AF is unreachable

DETACHED_USER

403 Forbidden

the user is deregistered in the AMF

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

PEER_NOT_RESPONDING

504 Gateway Timeout

No response is received from a remote peer, i.e.,

1) The response from the serving AMF wasn’t received by (V)GMLC, or;

2) (V)GMLC received HTTP status code 504 with PEER_NOT_RESPONDING from AMF.

1

MUTIQOS

Support of Multiple Location QoSes.

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