A.3 Nlmf_Broadcast API
29.5723GPP5G SystemLocation Management ServicesRelease 18Stage 3TS
openapi: 3.0.0
info:
version: ‘1.2.0-alpha.1’
title: ‘LMF Broadcast’
description: |
LMF Broadcast Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.572 V18.0.0; 5G System; Location Management Services; Stage 3
url: ‘https://www.3gpp.org/ftp/Specs/archive/29_series/29.572/’
servers:
– url: ‘{apiRoot}/nlmf-broadcast/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
paths:
/cipher-key-data:
post:
summary: Request ciphering key data
operationId: CipheringKeyData
tags:
– Request Ciphering Key Data
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/CipherRequestData’
required: true
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/CipherResponseData’
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
‘504’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/504’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
callbacks:
CipheringKeyData:
‘{$request.body#/amfCallBackURI}’:
post:
requestBody:
description: Ciphering Key Data Notification
content:
application/json:
schema:
$ref: ‘#/components/schemas/CipheringKeyInfo’
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/CipheringKeyResponse’
‘307’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/500’
‘502’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/502’
‘503’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/503’
‘504’:
$ref: ‘TS29571_CommonData.yaml#/components/responses/504’
default:
$ref: ‘TS29571_CommonData.yaml#/components/responses/default’
components:
schemas:
#
# COMPLEX TYPES
#
CipheringKeyInfo:
description: Information within Ciphering Key Data Notification request.
type: object
required:
– cipheringData
properties:
cipheringData:
type: array
items:
$ref: ‘#/components/schemas/CipheringDataSet’
minItems: 1
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
CipheringKeyResponse:
description: Information within Ciphering Key Data Notification Response.
type: object
properties:
cipheringDataReport:
type: array
items:
$ref: ‘#/components/schemas/CipheringSetReport’
minItems: 1
CipheringDataSet:
description: Represents a Ciphering Data Set.
type: object
required:
– cipheringSetID
– cipheringKey
– c0
– validityStartTime
– validityDuration
properties:
cipheringSetID:
$ref: ‘#/components/schemas/CipheringSetID’
cipheringKey:
$ref: ‘#/components/schemas/CipheringKey’
c0:
$ref: ‘#/components/schemas/C0’
ltePosSibTypes:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Bytes’
nrPosSibTypes:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Bytes’
validityStartTime:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
validityDuration:
$ref: ‘#/components/schemas/ValidityDuration’
taiList:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Bytes’
CipheringSetReport:
description: Represents a report of Ciphering Data Set storage.
type: object
required:
– cipheringSetID
– storageOutcome
properties:
cipheringSetID:
$ref: ‘#/components/schemas/CipheringSetID’
storageOutcome:
$ref: ‘#/components/schemas/StorageOutcome’
CipherRequestData:
description: Information within Ciphering Key Data request.
type: object
required:
– amfCallBackURI
properties:
amfCallBackURI:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
supportedFeatures:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
CipherResponseData:
description: Information within Ciphering Key Data Response.
type: object
required:
– dataAvailability
properties:
dataAvailability:
$ref: ‘#/components/schemas/DataAvailability’
#
#
# SIMPLE TYPES
#
CipheringSetID:
description: Ciphering Data Set Identifier.
type: integer
minimum: 0
maximum: 65535
CipheringKey:
description: Ciphering Key.
format: byte
type: string
C0:
description: First component of the initial ciphering counter.
format: byte
type: string
ValidityDuration:
description: Validity Duration of the Ciphering Data Set.
type: integer
minimum: 1
maximum: 65535
#
# ENUMS
#
StorageOutcome:
description: Indicates the result of Ciphering Data Set storage.
anyOf:
– type: string
enum:
– STORAGE_SUCCESSFUL
– STORAGE_FAILED
DataAvailability:
description: Indicates availability of ciphering key data at an LMF.
anyOf:
– type: string
enum:
– CIPHERING_KEY_DATA_AVAILABLE
– CIPHERING_KEY_DATA_NOT_AVAILABLE
Annex B (informative):
Change history
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2018-01 |
CT4#82 |
TS Skeleton agreed in CT4#82 |
0.0.0 |
||||
|
2018-01 |
CT4#82 |
C4-181398 |
Initial draft (C4-181119) Incorporation of agreed pCRs from CT4#82: C4-181121, C4-181233, C4-181234 |
0.1.0 |
|||
|
2018-03 |
CT4#83 |
C4-182444 |
Incorporation of agreed pCRs from CT4#83: C4-182181, C4-182427 |
0.2.0 |
|||
|
2018-03 |
CT#79 |
CP-180034 |
Presented for information |
1.0.0 |
|||
|
2018-04 |
CT4#84 |
C4-183524 |
Incorporation of agreed pCRs from CT4#84: C4-183184, C4-183363, C4-183510 |
1.1.0 |
|||
|
2018-05 |
CT4#85 |
C4-184640 |
Incorporation of agreed pCRs from CT4#85: C4-184195, C4-184197, C4-184198, C4-184199, C4-184202, C4-184443, C4-184446, C4-184547 |
1.2.0 |
|||
|
2018-06 |
CT#80 |
CP-181111 |
Presented for approval |
2.0.0 |
|||
|
2018-06 |
CT#80 |
Approved in CT#80 |
15.0.0 |
||||
|
2018-09 |
CT#81 |
CP-182066 |
0002 |
2 |
Error Cases |
15.1.0 |
|
|
2018-09 |
CT#81 |
CP-182066 |
0003 |
– |
Custom Headers |
15.1.0 |
|
|
2018-09 |
CT#81 |
CP-182066 |
0004 |
– |
Overall Clean-up |
15.1.0 |
|
|
2018-09 |
CT#81 |
CP-182066 |
0005 |
– |
Description of Structured data types |
15.1.0 |
|
|
2018-09 |
CT#81 |
CP-182066 |
0006 |
1 |
Resource structure presentation |
15.1.0 |
|
|
2018-09 |
CT#81 |
CP-182066 |
0007 |
1 |
LMF servers clause in OpenAPI |
15.1.0 |
|
|
2018-09 |
CT#81 |
CP-182066 |
0008 |
– |
API Version Update |
15.1.0 |
|
|
2018-12 |
CT#82 |
CP-183025 |
0010 |
1 |
F |
Cardinality |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183025 |
0011 |
– |
F |
APIRoot Clarification |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183025 |
0012 |
– |
F |
AMF Id |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183025 |
0013 |
– |
F |
Barometric Pressure in Location Data |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183025 |
0014 |
1 |
F |
Clarify Serving Cell in Input Data |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183025 |
0015 |
1 |
F |
Oauth2 Corrections |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183025 |
0016 |
– |
F |
API Version |
15.2.0 |
|
2018-12 |
CT#82 |
CP-183179 |
0017 |
– |
F |
ExternalDocs Update |
15.2.0 |
|
2019-03 |
CT#83 |
CP-190030 |
0018 |
1 |
F |
OpenAPI Corrections |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190030 |
0019 |
1 |
F |
Application Errors |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190030 |
0020 |
1 |
F |
Essential Correction to InnerRadius |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190030 |
0021 |
1 |
F |
Mandatory Response Codes |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190030 |
0022 |
1 |
F |
Essential correction to OpenAPI definition of GeographicArea |
15.3.0 |
|
2019-03 |
CT#83 |
CP-190030 |
0023 |
– |
F |
API version update |
15.3.0 |
|
2019-06 |
CT#84 |
CP-191042 |
0024 |
2 |
F |
UE Capabilities |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191042 |
0025 |
2 |
F |
Storage of OpenAPI specification files |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191042 |
0027 |
1 |
F |
Copyright Note in OpenAPI Spec |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191042 |
0028 |
1 |
F |
Major API version |
15.4.0 |
|
2019-06 |
CT#84 |
CP-191042 |
0030 |
– |
F |
Open API Version |
15.4.0 |
|
2019-09 |
CT#85 |
CP-192113 |
0031 |
1 |
F |
Missing attribute FLR in Civic Address |
16.0.0 |
|
2019-09 |
CT#85 |
CP-192192 |
0033 |
2 |
B |
LMF service operations for a deferred 5GC-MT-LR |
16.0.0 |
|
2019-09 |
CT#85 |
CP-192192 |
0034 |
1 |
B |
LMF service operations for a commercial 5GC-MT-LR |
16.0.0 |
|
2019-09 |
CT#85 |
CP-192192 |
0035 |
– |
F |
High Accuracy Support |
16.0.0 |
|
2019-09 |
CT#85 |
CP-192113 |
0037 |
1 |
D |
Correct type Polygon |
16.0.0 |
|
2019-09 |
CT#85 |
CP-192120 |
0039 |
– |
F |
3GPP TS 29.572 API version update |
16.0.0 |
|
2019-12 |
CT#86 |
CP-193033 |
0041 |
1 |
A |
Motion Sensor Position Method |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193165 |
0042 |
3 |
B |
Addition of the LMF Broadcast Service Operations |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193055 |
0043 |
1 |
B |
LCS QoS Class |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193036 |
0045 |
1 |
F |
ExternalDoc Clause |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193036 |
0046 |
1 |
F |
ProblemDetails Optional in Error Response |
16.1.0 |
|
2019-12 |
CT#86 |
CP-193044 |
0048 |
– |
F |
3GPP TS 29.572 API version update |
16.1.0 |
|
2020-03 |
CT#87 |
CP-200039 |
0049 |
2 |
F |
Add Corresponding API descriptions in clause 5.1 |
16.2.0 |
|
2020-03 |
CT#87 |
CP-200039 |
0050 |
2 |
D |
Editorial corrections |
16.2.0 |
|
2020-03 |
CT#87 |
CP-200039 |
0051 |
1 |
F |
Correction – formatting consistency |
16.2.0 |
|
2020-03 |
CT#87 |
CP-200018 |
0052 |
B |
Connectivity state per access type |
16.2.0 |
|
|
2020-03 |
CT#87 |
CP-200018 |
0053 |
B |
Primary Cell in the Secondary RAN node |
16.2.0 |
|
|
2020-03 |
CT#87 |
CP-200052 |
0055 |
F |
3GPP TS 29.572 Rel16 API External doc update |
16.2.0 |
|
|
2020-03 |
CT#87 |
CP-200180 |
0054 |
4 |
B |
Request Type and embedded LPP message |
16.2.0 |
|
2020-06 |
CT#88e |
CP-201060 |
0056 |
1 |
F |
Add a new Notifications Overview Table |
16.3.0 |
|
2020-06 |
CT#88e |
CP-201060 |
0057 |
1 |
F |
Add custom operation Name |
16.3.0 |
|
2020-06 |
CT#88e |
CP-201032 |
0058 |
|
F |
Location Context Transfer |
16.3.0 |
|
2020-06 |
CT#88e |
CP-201032 |
0059 |
1 |
B |
Network Specific Positioning Methods |
16.3.0 |
|
2020-06 |
CT#88e |
CP-201032 |
0060 |
|
B |
Positioning Methods Support |
16.3.0 |
|
2020-06 |
CT#88e |
CP-201032 |
0061 |
2 |
F |
Storage of YAML files in ETSI Forge |
16.3.0 |
|
2020-06 |
CT#88e |
CP-201032 |
0062 |
1 |
F |
Resolve Editor Notes |
16.3.0 |
|
2020-06 |
CT#88e |
CP-201032 |
0063 |
1 |
F |
LDRreference |
16.3.0 |
|
2020-06 |
CT#88e |
CP-201032 |
0065 |
1 |
F |
Resolution of EN on NR positioning SIBs |
16.3.0 |
|
2020-06 |
CT#88e |
CP-201032 |
0068 |
1 |
F |
Adding ResponseTime enumaration value |
16.3.0 |
|
2020-06 |
CT#88e |
CP-201060 |
0069 |
|
F |
Missing Descriptions |
16.3.0 |
|
2020-06 |
CT#88e |
CP-201073 |
0070 |
|
F |
29.572 Rel-16 API version and External doc update |
16.3.0 |
|
2020-09 |
CT#89e |
CP-202112 |
0071 |
1 |
F |
Optionality of ProblemDetails in TS29.572 cleanup |
16.4.0 |
|
2020-09 |
CT#89e |
CP-202112 |
0073 |
1 |
F |
Adding missing navigation satellite systems for positioning |
16.4.0 |
|
2020-09 |
CT#89e |
CP-202112 |
0074 |
1 |
F |
Including VGMLC address towards LMF when requesting LMF’s Location service |
16.4.0 |
|
2020-09 |
CT#89e |
CP-202112 |
0075 |
1 |
F |
Corrections on EventNotify service operation |
16.4.0 |
|
2020-09 |
CT#89e |
CP-202043 |
0077 |
1 |
F |
Correct mismatch on GeographicArea between table and yaml |
16.4.0 |
|
2020-09 |
CT#89e |
CP-202096 |
0078 |
– |
F |
29.572 Rel-16 API version and External doc update |
16.4.0 |
|
2020-12 |
CT#90e |
CP-203050 |
0080 |
1 |
F |
Essential corrections in clause 5.2.2.4 CancelLocation |
16.5.0 |
|
2020-12 |
CT#90e |
CP-203050 |
0081 |
1 |
F |
Indication of control plane CIoT 5GS optimization in LocationContextTransfer |
16.5.0 |
|
2020-12 |
CT#90e |
CP-203035 |
0082 |
1 |
F |
YAML files in 3GPP Forge |
16.5.0 |
|
2020-12 |
CT#90e |
CP-203036 |
0085 |
1 |
F |
29.572 Rel-16 API version and External doc update |
16.5.0 |
|
2021-03 |
CT#91e |
CP-210041 |
0087 |
– |
F |
Missing PIDL-LO elements in Location Information |
17.0.0 |
|
2021-03 |
CT#91e |
CP-210037 |
0088 |
1 |
F |
HTTP 3xx redirection |
17.0.0 |
|
2021-03 |
CT#91e |
CP-210034 |
0089 |
– |
F |
Reference change |
17.0.0 |
|
2021-03 |
CT#91e |
CP-210054 |
0091 |
– |
F |
29.572 Rel-16 API version and External doc update |
17.0.0 |
|
2021-06 |
CT#92e |
CP-211055 |
0092 |
1 |
F |
Resolving Warning in Nlmf_BroadCast API |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211055 |
0093 |
|
F |
Resolving Warning in Nlmf_Location API |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211026 |
0094 |
1 |
B |
Add List of Assistance Data Types for MO-LR |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211026 |
0095 |
3 |
B |
Add Local Coordinates |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211051 |
0096 |
|
F |
OpenAPI Reference |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211059 |
0098 |
|
A |
3xx description correction for SCP |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211059 |
0102 |
1 |
A |
Redirect Response |
17.1.0 |
|
2021-06 |
CT#92e |
CP-211050 |
0103 |
|
F |
29.572 Rel-17 API version and External doc update |
17.1.0 |
|
2021-09 |
CT#93e |
CP-212034 |
0105 |
1 |
B |
Add UE Positioning Capabilities |
17.2.0 |
|
2021-09 |
CT#93e |
CP-212034 |
0108 |
2 |
B |
Support for Area Decision of Satellite Access |
17.2.0 |
|
2021-09 |
CT#93e |
CP-212034 |
0109 |
1 |
B |
LMF Parameters Support for non-3GPP Access |
17.2.0 |
|
2021-09 |
CT#93e |
CP-212064 |
0111 |
A |
Encoding of binary attributes in JSON objects |
17.2.0 |
|
|
2021-09 |
CT#93e |
CP-212034 |
0114 |
1 |
B |
Multiple QoS Class |
17.2.0 |
|
2021-09 |
CT#93e |
CP-212059 |
0115 |
F |
29.572 Rel-17 API version and External doc update |
17.2.0 |
|
|
2021-12 |
CT#94e |
CP-213096 |
0118 |
1 |
B |
Multiple LPP messages |
17.3.0 |
|
2021-12 |
CT#94e |
CP-213096 |
0119 |
1 |
B |
Higher Resolution Timestamp for Location Estimates |
17.3.0 |
|
2021-12 |
CT#94e |
CP-213096 |
0120 |
|
F |
UE Positioning Capabilities Data Type |
17.3.0 |
|
2021-12 |
CT#94e |
CP-213096 |
0121 |
1 |
B |
Update allowed access type for event report |
17.3.0 |
|
2021-12 |
CT#94e |
CP-213118 |
0122 |
|
F |
Resolve OpenAPI Warnings |
17.3.0 |
|
2021-12 |
CT#94e |
CP-213120 |
0123 |
|
F |
307/308 redirection |
17.3.0 |
|
2021-12 |
CT#94e |
CP-213121 |
0124 |
|
F |
29.572 Rel-17 API version and External doc update |
17.3.0 |
|
2022-03 |
CT#95e |
CP-220034 |
0128 |
F |
Corrections on the RelativeCartesianLocation |
17.4.0 |
|
|
2022-03 |
CT#95e |
CP-220227 |
0130 |
1 |
A |
Corrections on attributes |
17.4.0 |
|
2022-03 |
CT#95e |
CP-220090 |
0131 |
F |
Update incorrect table number |
17.4.0 |
|
|
2022-03 |
CT#95e |
CP-220217 |
0133 |
F |
29.572 Rel-17 API version and External doc update |
17.4.0 |
|
|
2022-06 |
CT#96 |
CP-221022 |
0135 |
1 |
B |
Schedule location time for LMF |
17.5.0 |
|
2022-06 |
CT#96 |
CP-221022 |
0136 |
F |
Update the title of RelativeCartesianLocation |
17.5.0 |
|
|
2022-06 |
CT#96 |
CP-221051 |
0138 |
F |
29.572 Rel-17 API version and External doc update |
17.5.0 |
|
|
2022-09 |
CT#97 |
CP-222030 |
0139 |
1 |
F |
Alignment on the service name used with template |
17.6.0 |
|
2022-09 |
CT#97 |
CP-222036 |
0140 |
1 |
F |
Indication of Network Assisted Positioning method |
17.6.0 |
|
2022-09 |
CT#97 |
CP-222058 |
0141 |
|
F |
29.572 Rel-17 API version and External doc update |
17.6.0 |
|
2022-12 |
CT#98 |
CP-223028 |
0142 |
1 |
F |
Missing mandatory status codes in OpenAPI |
18.0.0 |
|
2022-12 |
CT#98 |
CP-223055 |
0143 |
1 |
F |
Correction on country verification for satellite access |
18.0.0 |
|
2022-12 |
CT#98 |
CP-223064 |
0146 |
1 |
F |
Boolean type IEs definition correction |
18.0.0 |
|
2022-12 |
CT#98 |
CP-223033 |
0147 |
F |
29.572 Rel-18 API version and External doc update |
18.0.0 |