Tech-
invite
3GPP
space
IETF
space
21
22
23
24
25
26
27
28
29
31
32
33
34
35
36
37
38
4‑5x
Content for
TS 29.572
Word version: 18.6.0
1…
5…
5
Services Offered by the LMF
5.1
Introduction
5.2
Nlmf_Location Service
5.3
Nlmf_Broadcast Service
6
API Definitions
6.1
Nlmf_Location Service API
6.2
Nlmf_Broadcast Service API
A
OpenAPI specification
$
Change history
5
Services Offered by the LMF
p. 11
5.1
Introduction
p. 11
5.2
Nlmf_Location Service
p. 12
5.2.1
Service Description
p. 12
5.2.2
Service Operations
p. 12
5.2.2.1
Introduction
p. 12
5.2.2.2
DetermineLocation
p. 12
5.2.2.2.1
General
p. 12
5.2.2.2.2
Retrieve UE Location
p. 12
5.2.2.2.3
Retrieve UE Location for 5G-MO-LR
|R16|
p. 13
5.2.2.3
EventNotify
|R16|
p. 14
5.2.2.3.1
General
p. 14
5.2.2.3.2
Periodic or Triggered Event Notification
p. 14
5.2.2.3.3
Intermediate location reporting Event Notification
|R18|
p. 15
5.2.2.4
CancelLocation
|R16|
p. 16
5.2.2.4.1
General
p. 16
5.2.2.4.2
Cancel Periodic or Triggered Location
p. 16
5.2.2.5
LocationContextTransfer
|R16|
p. 16
5.2.2.5.1
General
p. 16
5.2.2.5.2
Transfer Location Context
p. 16
5.2.2.6
MeasurementData
|R18|
p. 17
5.2.2.6.1
General
p. 17
5.2.2.6.2
Location Measurements
p. 17
5.2.2.7
UPSubscribe
|R18|
p. 18
5.2.2.7.1
General
p. 18
5.2.2.7.2
Subscribe to Notification of LCS-UP connection status
p. 18
5.2.2.8
UPNotify
|R18|
p. 18
5.2.2.8.1
General
p. 18
5.2.2.8.2
Notification of LCS-UP connection
p. 18
5.2.2.9
UPConfig
|R18|
p. 19
5.2.2.9.1
General
p. 19
5.2.2.9.2
Configure LCS-UP connection
p. 19
5.2.2.10
UPUnSubscribe
|R18|
p. 20
5.2.2.10.1
General
p. 20
5.2.2.10.2
Unsubscribe to notification of LCS-UP connection status
p. 20
5.3
Nlmf_Broadcast Service
|R16|
p. 20
5.3.1
Service Description
p. 20
5.3.2
Service Operations
p. 20
5.3.2.1
Introduction
p. 20
5.3.2.2
CipheringKeyData
p. 20
5.3.2.2.1
General
p. 20
5.3.2.2.2
Request Ciphering Key Information
p. 21
5.3.2.2.3
Provide Ciphering Key Information
p. 21
6
API Definitions
p. 22
6.1
Nlmf_Location Service API
p. 22
6.1.1
API URI
p. 22
6.1.2
Usage of HTTP
p. 22
6.1.2.1
General
p. 22
6.1.2.2
HTTP Standard Headers
p. 23
6.1.2.2.1
General
p. 23
6.1.2.2.2
Content type
p. 23
6.1.2.3
HTTP custom headers
p. 23
6.1.2.3.1
General
p. 23
6.1.2.4
HTTP multipart messages
|R16|
p. 23
6.1.3
Resources
p. 24
6.1.3.1
Overview
p. 24
6.1.3.2
Resource: up-subscriptions (Collection)
|R18|
p. 25
6.1.3.2.1
Description
p. 25
6.1.3.2.2
Resource Definition
p. 25
6.1.3.2.3
Resource Standard Methods
p. 25
6.1.3.3
Resource: up-subscription (Document)
|R18|
p. 26
6.1.3.3.1
Description
p. 26
6.1.3.3.2
Resource Definition
p. 26
6.1.3.3.3
Resource Standard Methods
p. 27
6.1.4
Custom Operations without associated resources
p. 28
6.1.4.1
Overview
p. 28
6.1.4.2
Operation: determine-location
p. 28
6.1.4.2.1
Description
p. 28
6.1.4.2.2
Operation Definition
p. 28
6.1.4.3
Operation: cancel-location
|R16|
p. 30
6.1.4.3.1
Description
p. 30
6.1.4.3.2
Operation Definition
p. 30
6.1.4.4
Operation: location-context-transfer
|R16|
p. 31
6.1.4.4.1
Description
p. 31
6.1.4.4.2
Operation Definition
p. 31
6.1.4.5
Operation: measure-location
|R18|
p. 32
6.1.4.5.1
Description
p. 32
6.1.4.5.2
Operation Definition
p. 32
6.1.4.6
Void
6.1.4.7
Operation: configure-up
|R18|
p. 33
6.1.4.7.1
Description
p. 33
6.1.4.7.2
Operation Definition
p. 34
6.1.5
Notifications
p. 35
6.1.5.1
EventNotify
|R16|
p. 35
6.1.5.1.1
Description
p. 35
6.1.5.1.2
Notification Definition
p. 35
6.1.5.1.3
Notification Standard Methods
p. 35
6.1.5.2
UPNotify
|R18|
p. 36
6.1.5.2.1
Description
p. 36
6.1.5.2.2
Notification Definition
p. 36
6.1.5.2.3
Notification Standard Methods
p. 37
6.1.6
Data Model
p. 38
6.1.6.1
General
p. 38
6.1.6.2
Structured data types
p. 42
6.1.6.2.1
Introduction
p. 42
6.1.6.2.2
Type: InputData
p. 43
6.1.6.2.3
Type: LocationData
p. 48
6.1.6.2.4
Type: GeographicalCoordinates
p. 52
6.1.6.2.5
Type: GeographicArea
p. 52
6.1.6.2.6
Type: Point
p. 52
6.1.6.2.7
Type: PointUncertaintyCircle
p. 53
6.1.6.2.8
Type: PointUncertaintyEllipse
p. 53
6.1.6.2.9
Type: Polygon
p. 53
6.1.6.2.10
Type: PointAltitude
p. 53
6.1.6.2.11
Type: PointAltitudeUncertainty
p. 54
6.1.6.2.12
Type: EllipsoidArc
p. 54
6.1.6.2.13
Type: LocationQoS
p. 55
6.1.6.2.14
Type: CivicAddress
p. 56
6.1.6.2.15
Type: PositioningMethodAndUsage
p. 58
6.1.6.2.16
Type: GnssPositioningMethodAndUsage
p. 59
6.1.6.2.17
Type: VelocityEstimate
p. 59
6.1.6.2.18
Type: HorizontalVelocity
p. 59
6.1.6.2.19
Type: HorizontalWithVerticalVelocity
p. 59
6.1.6.2.20
Type: HorizontalVelocityWithUncertainty
p. 60
6.1.6.2.21
Type: HorizontalWithVerticalVelocityAndUncertainty
p. 60
6.1.6.2.22
Type: UncertaintyEllipse
p. 60
6.1.6.2.23
Type: UeLcsCapability
p. 60
6.1.6.2.24
Type: PeriodicEventInfo
|R16|
p. 61
6.1.6.2.25
Type: AreaEventInfo
|R16|
p. 62
6.1.6.2.26
Type: ReportingArea
|R16|
p. 62
6.1.6.2.27
Type: MotionEventInfo
|R16|
p. 63
6.1.6.2.28
Void
6.1.6.2.29
Type: CancelLocData
|R16|
p. 63
6.1.6.2.30
Type: LocContextData
|R16|
p. 64
6.1.6.2.31
Type: EventReportMessage
|R16|
p. 65
6.1.6.2.32
Type: EventReportingStatus
|R16|
p. 65
6.1.6.2.33
Type: UELocationInfo
|R16|
p. 65
6.1.6.2.34
Type: EventNotifyData
|R16|
p. 66
6.1.6.2.35
Type: UeConnectivityState
|R16|
p. 69
6.1.6.2.36
Type: LocalOrigin
|R17|
p. 69
6.1.6.2.37
Type: RelativeCartesianLocation
|R17|
p. 70
6.1.6.2.38
Type: Local2dPointUncertaintyEllipse
|R17|
p. 70
6.1.6.2.39
Type: Local3dPointUncertaintyEllipsoid
|R17|
p. 71
6.1.6.2.40
Type: UncertaintyEllipsoid
|R17|
p. 71
6.1.6.2.41
Type: LocalArea
|R17|
p. 72
6.1.6.2.42
Type: UeAreaIndication
|R17|
p. 72
6.1.6.2.43
Type: MinorLocationQoS
|R17|
p. 72
6.1.6.2.44
Type: MbsrInfo
|R17|
p. 72
6.1.6.2.45
Type: LocMeasurementReq
|R18|
p. 73
6.1.6.2.46
Type: LocMeasurementResp
|R18|
p. 73
6.1.6.2.47
Type: LocMeasurements
|R18|
p. 73
6.1.6.2.48
Type: HighAccuracyGnssMetrics
|R18|
p. 74
6.1.6.2.49
Type: UpNotifyData
|R18|
p. 74
6.1.6.2.50
Type: UpSubscription
|R18|
p. 74
6.1.6.2.52
Type: UpConfig
|R18|
p. 75
6.1.6.2.58
Type: LocationDataExt
|R18|
p. 76
6.1.6.2.59
Type: EventNotifyDataExt
|R18|
p. 76
6.1.6.2.60
Type: MappedLocationQoSEps
|R18|
p. 76
6.1.6.2.61
Type: AdditionalUeInfo
|R18|
p. 76
6.1.6.3
Simple data types and enumerations
p. 77
6.1.6.3.1
Introduction
p. 77
6.1.6.3.2
Simple data types
p. 77
6.1.6.3.3
Enumeration: ExternalClientType
p. 81
6.1.6.3.4
Enumeration: SupportedGADShapes
p. 81
6.1.6.3.5
Enumeration: ResponseTime
p. 82
6.1.6.3.6
Enumeration: PositioningMethod
p. 82
6.1.6.3.7
Enumeration: PositioningMode
p. 83
6.1.6.3.8
Enumeration: GnssId
p. 83
6.1.6.3.9
Enumeration: Usage
p. 84
6.1.6.3.10
Enumeration: LcsPriority
p. 84
6.1.6.3.11
Enumeration: VelocityRequested
p. 84
6.1.6.3.12
Enumeration: AccuracyFulfilmentIndicator
p. 84
6.1.6.3.13
Enumeration: VerticalDirection
p. 85
6.1.6.3.14
Enumeration: LdrType
|R16|
p. 85
6.1.6.3.15
Enumeration: ReportingAreaType
|R16|
p. 85
6.1.6.3.16
Enumeration: OccurrenceInfo
|R16|
p. 85
6.1.6.3.17
Enumeration: ReportingAccessType
|R16|
p. 86
6.1.6.3.18
Enumeration: EventClass
|R16|
p. 86
6.1.6.3.19
Enumeration: ReportedEventType
|R16|
p. 86
6.1.6.3.20
Enumeration: TerminationCause
|R16|
p. 86
6.1.6.3.21
Enumeration: LcsQosClass
|R16|
p. 87
6.1.6.3.22
Enumeration: UeLocationServiceInd
|R16|
p. 87
6.1.6.3.23
Enumeration: IndoorOutdoorInd
|R17|
p. 87
6.1.6.3.24
Enumeration: FixType
|R18|
p. 87
6.1.6.3.25
Enumeration: LosNlosMeasureInd
|R18|
p. 87
6.1.6.3.26
Enumeration: UpConnectionStatus
|R18|
p. 87
6.1.6.3.27
Enumeration: RangingSlResult
|R18|
p. 88
6.1.6.3.28
Enumeration: RelatedUeType
|R18|
p. 88
6.1.6.3.29
Enumeration: LcsUpConnectionInd
|R18|
p. 88
6.1.6.3.30
Enumeration: UeUpPositioningCapabilities
|R18|
p. 89
6.1.6.4
Binary data
|R16|
p. 89
6.1.6.4.1
Introduction
p. 89
6.1.6.4.2
LPP Message
p. 89
6.1.7
Error Handling
p. 89
6.1.7.1
General
p. 89
6.1.7.2
Protocol Errors
p. 89
6.1.7.3
Application Errors
p. 89
6.1.8
Security
p. 90
6.1.9
Feature Negotiation
|R16|
p. 90
6.1.10
HTTP redirection
|R16|
p. 91
6.2
Nlmf_Broadcast Service API
|R16|
p. 91
6.2.1
API URI
p. 91
6.2.2
Usage of HTTP
p. 92
6.2.2.1
General
p. 92
6.2.2.2
HTTP Standard Headers
p. 92
6.2.2.2.1
General
p. 92
6.2.2.2.2
Content type
p. 92
6.2.2.3
HTTP custom headers
p. 92
6.2.2.3.1
General
p. 92
6.2.3
Resources
p. 92
6.2.3.1
Overview
p. 92
6.2.4
Custom Operations without associated resources
p. 93
6.2.4.1
Overview
p. 93
6.2.4.4
Operation: cipher-key-data
p. 93
6.2.4.4.1
Description
p. 93
6.2.4.4.2
Operation Definition
p. 93
6.2.5
Notifications
p. 94
6.2.5.1
CipheringKeyData
p. 94
6.2.5.1.1
Description
p. 94
6.2.5.1.2
Notification Definition
p. 94
6.2.5.1.3
Notification Standard Methods
p. 95
6.2.6
Data Model
p. 96
6.2.6.1
General
p. 96
6.2.6.2
Structured data types
p. 96
6.2.6.2.1
Introduction
p. 96
6.2.6.2.2
Type: CipheringKeyInfo
p. 97
6.2.6.2.3
Type: CipheringKeyResponse
p. 97
6.2.6.2.4
Type: CipheringDataSet
p. 98
6.2.6.2.5
Type: CipheringSetReport
p. 103
6.2.6.2.6
Type: CipherRequestData
p. 104
6.2.6.2.7
Type: CipherResponseData
p. 104
6.2.6.3
Simple data types and enumerations
p. 104
6.2.6.3.1
Introduction
p. 104
6.2.6.3.2
Simple data types
p. 104
6.2.6.3.3
Enumeration: StorageOutcome
p. 104
6.2.6.3.4
Enumeration: DataAvailability
p. 104
6.2.7
Error Handling
p. 105
6.2.7.1
General
p. 105
6.2.7.2
Protocol Errors
p. 105
6.2.7.3
Application Errors
p. 105
6.2.8
Security
p. 105
6.2.9
Feature Negotiation
p. 105
6.2.10
HTTP redirection
p. 106
A
(Normative) OpenAPI specification
p. 106
A.1
General
p. 106
A.2
Nlmf_Location API
p. 106
A.3
Nlmf_Broadcast API
|R16|
p. 136
$
Change history
p. 140