A.2 Ngmlc_Location API
29.5153GPP5G SystemGateway Mobile Location ServicesRelease 18Stage 3TS
openapi: 3.0.0
info:
version: ‘1.2.0-alpha.1’
title: ‘Ngmlc_Location’
description: |
GMLC Location Service.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: 3GPP TS 29.515 V18.0.0; 5G System; Gateway Mobile Location Services; Stage 3
url: ‘https://www.3gpp.org/ftp/Specs/archive/29_series/29.515/’
servers:
– url: ‘{apiRoot}/ngmlc-loc/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 4.4 of 3GPP TS 29.501
security:
– {}
– oAuth2ClientCredentials:
– ngmlc-loc
paths:
/provide-location:
post:
summary: Request Location of an UE
operationId: RequestLocation
tags:
– Request Location
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/InputData’
required: true
responses:
‘200’:
description: Expected response to a valid request
content:
application/json:
schema:
$ref: ‘#/components/schemas/LocationData’
‘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:
EventNotify:
‘{$request.body#/hgmlcCallBackUri}’:
post:
requestBody:
description: UE Event Notification
content:
application/json:
schema:
$ref: ‘#/components/schemas/EventNotifyDataExt’
responses:
‘204’:
description: Expected response to a valid notification
‘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’
EventNotifyNef:
‘{$request.body#/eventNotificationUri}’:
post:
requestBody:
description: UE Event Notification
content:
application/json:
schema:
$ref: ‘#/components/schemas/EventNotifyData’
responses:
‘204’:
description: Expected response to a valid notification
‘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’
/cancel-location:
post:
summary: request cancellation of periodic or triggered location
operationId: CancelLocation
tags:
– Cancel Location
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/CancelLocData’
required: true
responses:
‘204’:
description: Expected response to a successful cancellation
‘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’
/location-update:
post:
summary: update UE location information
operationId: UpdateLocation
tags:
– Update Location
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/LocUpdateData’
required: true
responses:
‘204’:
description: Expected response to successful location context transfer
‘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’
/loc-update-subs:
post:
summary: subscribe to notifications of UE location information
operationId: LocationUpdateSubcribe
tags:
– UE location information Subscription creation
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/LocUpdateSubs’
required: true
responses:
‘204’:
description: Expected response to successful UE location information subscription
‘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:
LocationUpdateNotify:
‘{$request.body#/notifUri}’:
post:
requestBody:
description: Location Update Notification
content:
application/json:
schema:
$ref: ‘#/components/schemas/LocUpdateNotification’
responses:
‘204’:
description: Expected response to a valid notification
‘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:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{nrfApiRoot}/oauth2/token’
scopes:
ngmlc-loc: Access to the Ngmlc_Location API
schemas:
#
# COMPLEX TYPES
#
InputData:
description: Contains the input parameters in ProvideLocation service operation
type: object
required:
– externalClientType
properties:
gpsi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
extGroupId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ExternalGroupId’
intGroupId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/GroupId’
externalClientType:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/ExternalClientType’
locationQoS:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LocationQoS’
supportedGADShapes:
type: array
items:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/SupportedGADShapes’
minItems: 1
serviceIdentity:
$ref: ‘#/components/schemas/ServiceIdentity’
serviceCoverage:
type: array
items:
$ref: ‘#/components/schemas/E164CountryCodeOfGeographicArea’
minItems: 1
ldrType:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LdrType’
periodicEventInfo:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/PeriodicEventInfo’
areaEventInfo:
$ref: ‘#/components/schemas/AreaEventInfoExt’
motionEventInfo:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/MotionEventInfo’
ldrReference:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference’
hgmlcCallBackUri:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
eventNotificationUri:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
externalClientIdentification:
$ref: ‘#/components/schemas/ExternalClientIdentification’
afId:
type: string
uePrivacyRequirements:
$ref: ‘#/components/schemas/UePrivacyRequirements’
lcsServiceType:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LcsServiceType’
velocityRequested:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/VelocityRequested’
priority:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LcsPriority’
locationTypeRequested:
$ref: ‘#/components/schemas/LocationTypeRequested’
maximumAgeOfLocationEstimate:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate’
amfId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/AmfId’
codeWord:
$ref: ‘#/components/schemas/CodeWord’
scheduledLocTime:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
reliableLocReq:
type: boolean
default: false
LocationData:
description: Contains the response parameters in ProvideLocation service operation
type: object
properties:
gpsi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
locationEstimate:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea’
civicAddress:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress’
localLocationEstimate:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LocalArea’
ageOfLocationEstimate:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate’
timestampOfLocationEstimate:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
positioningDataList:
type: array
items:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethodAndUsage’
minItems: 1
gnssPositioningDataList:
type: array
items:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/GnssPositioningMethodAndUsage’
minItems: 1
accuracyFulfilmentIndicator:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/AccuracyFulfilmentIndicator’
ueVelocity:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate’
ldrReference:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference’
altitude:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/Altitude’
servingLMFIdentification:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification’
locationPrivacyVerResult:
$ref: ‘TS29518_Namf_Location.yaml#/components/schemas/LocationPrivacyVerResult’
successType:
$ref: ‘#/components/schemas/SuccessType’
achievedQos:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/MinorLocationQoS’
CancelLocData:
description: Contains the input parameters in CancelLocation service operation
type: object
required:
– hgmlcCallBackUri
– ldrReference
properties:
gpsi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
extGroupId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/ExternalGroupId’
intGroupId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/GroupId’
hgmlcCallBackUri:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
ldrReference:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference’
lmfIdentification:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification’
amfId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/AmfId’
LocUpdateData:
description: Contains the input parameters in LocationUpdate service operation
type: object
required:
– locationRequestType
– locationEstimate
– ageOfLocationEstimate
– accuracyFulfilmentIndicator
– lcsQosClass
properties:
gpsi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
pseudonymIndicator:
$ref: ‘#/components/schemas/PseudonymIndicator’
locationRequestType:
$ref: ‘#/components/schemas/LocationRequestType’
locationEstimate:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea’
ageOfLocationEstimate:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate’
timestampOfLocationEstimate:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
accuracyFulfilmentIndicator:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/AccuracyFulfilmentIndicator’
civicAddress:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress’
lcsQosClass:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LcsQosClass’
externalClientIdentification:
$ref: ‘#/components/schemas/ExternalClientIdentification’
afId:
type: string
gmlcNumber:
type: string
pattern: ‘^[0-9]{5,15}$’
lcsServiceType:
$ref: ‘#/components/schemas/LcsServiceTypeId’
EventNotifyData:
description: Contains the input parameters for the target UE in EventNotify Notification service operation
type: object
required:
– eventNotifyDataType
– ldrReference
properties:
gpsi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
ldrReference:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LdrReference’
eventNotifyDataType:
$ref: ‘#/components/schemas/EventNotifyDataType’
locationEstimate:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea’
civicAddress:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress’
localLocationEstimate:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LocalArea’
ageOfLocationEstimate:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate’
timestampOfLocationEstimate:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
positioningDataList:
type: array
items:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/PositioningMethodAndUsage’
minItems: 1
gnssPositioningDataList:
type: array
items:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/GnssPositioningMethodAndUsage’
minItems: 1
lmfIdentification:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LMFIdentification’
amfId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/AmfId’
terminationCause:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/TerminationCause’
velocityEstimate:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/VelocityEstimate’
altitude:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/Altitude’
targetNode:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfInstanceId’
accuracyFulfilmentIndicator:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/AccuracyFulfilmentIndicator’
failureCause:
$ref: ‘#/components/schemas/FailureCause’
achievedQos:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/MinorLocationQoS’
UePrivacyRequirements:
description: UE privacy requirements from (H)GMLC to the serving AMF or VGMLC(in the roaming case) for the target UE
type: object
properties:
lcsServiceAuthInfo:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/LcsServiceAuth’
codeWordCheck:
type: boolean
LocUpdateNotification:
description: Location Update Notification
type: object
required:
– locationRequestType
– locationEstimate
– ageOfLocationEstimate
– accuracyFulfilmentIndicator
– lcsQosClass
properties:
gpsi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
locationRequestType:
$ref: ‘#/components/schemas/LocationRequestType’
locationEstimate:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea’
ageOfLocationEstimate:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/AgeOfLocationEstimate’
timestampOfLocationEstimate:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
accuracyFulfilmentIndicator:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/AccuracyFulfilmentIndicator’
civicAddress:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/CivicAddress’
lcsQosClass:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LcsQosClass’
afId:
type: string
serviceIdentity:
$ref: ‘#/components/schemas/ServiceIdentity’
LocUpdateSubs:
description: UE location information subscription
type: object
required:
– nfInstanceId
– notifURI
properties:
nfInstanceId:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/NfInstanceId’
notifURI:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Uri’
gpsi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
supi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Supi’
EventNotifyDataExt:
description: Extended Event Notify Data for UEs of a target group
allOf:
– $ref: ‘#/components/schemas/EventNotifyData’
– $ref: ‘#/components/schemas/EventNotifyDataAdditionalInfo’
EventNotifyDataAdditionalInfo:
description: Additional information to Event Notify Data
type: object
properties:
addEventDataList:
type: array
items:
$ref: ‘#/components/schemas/EventNotifyData’
minItems: 1
AreaEventInfoAddition:
description: Additional information for Extended Area event information
type: object
properties:
geoAreaList:
type: array
items:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/GeographicArea’
minItems: 1
ignoreAreaDefInd:
type: boolean
default: false
AreaEventInfoExt:
description: Extended Area Event Information
allOf:
– $ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/AreaEventInfo’
– $ref: ‘#/components/schemas/AreaEventInfoAddition’
#
# SIMPLE TYPES
#
ServiceIdentity:
description: Contains the service identity
type: string
ExternalClientIdentification:
description: Contains the external client identification
type: string
CodeWord:
description: Contains the codeword
type: string
E164CountryCodeOfGeographicArea:
description: Contains the E.164 country codes for geographic areas
type: string
LcsServiceTypeId:
description: LCS Service Type Id.
type: integer
minimum: 0
maximum: 127
#
# ENUMS
#
PseudonymIndicator:
description: It defines if a pseudonym is requested
anyOf:
– type: string
enum:
– PSEUDONYM_REQUESTED
– PSEUDONYM_NOT_REQUESTED
– type: string
LocationRequestType:
description: NI-LR, MT-LR or MO-LR
anyOf:
– type: string
enum:
– NI_LR
– MT_LR
– MO_LR
– type: string
LocationTypeRequested:
description: Contains the location type requested by the LCS client
anyOf:
– type: string
enum:
– CURRENT_LOCATION
– CURRENT_OR_LAST_KNOWN_LOCATION
– INITIAL_LOCATION
– NOTIFICATION_VERIFICATION_ONLY
– type: string
EventNotifyDataType:
description: Contains the type of event that triggers event notification
anyOf:
– type: string
enum:
– UE_AVAILABLE
– PERIODIC
– ENTERING_INTO_AREA
– LEAVING_FROM_AREA
– BEING_INSIDE_AREA
– MOTION
– MAXIMUM_INTERVAL_EXPIRATION_EVENT
– LOCATION_CANCELLATION_EVENT
– ACTIVATION_OF_DEFERRED_LOCATION
– UE_MOBILITY_FOR_DEFERRED_LOCATION
– 5GC_MT_LR
– type: string
FailureCause:
description: Positioning failure cause
anyOf:
– type: string
enum:
– POSITIONING_DENIED
– UNSUPPORTED_BY_UE
– NOT_REGISTED_UE
– UNSPECIFIED
– type: string
SuccessType:
description: Success Type to indicate full or partial success
anyOf:
– type: string
enum:
– SUCCESS_COMPLETELY
– SUCCESS_PARTIALLY
– type: string
Annex B (informative):
Change history
|
Change history |
|||||||
|
Date |
Meeting |
TDoc |
CR |
Rev |
Cat |
Subject/Comment |
New version |
|
2019-04 |
CT4#90 |
C4-191340 |
Initial Draft of Gateway Mobile Location Services |
0.1.0 |
|||
|
2019-05 |
CT4#91 |
C4-192485 |
V0.2.0 |
0.2.0 |
|||
|
2019-09 |
CT4#93 |
C4-193845 |
Implementation of pCRs agreed at CT4#93 |
0.3.0 |
|||
|
2019-10 |
CT4#94 |
C4-194555 |
Implementation of pCRs agreed at CT4#94 |
0.4.0 |
|||
|
2019-11 |
CT4#95 |
C4-195413, C4-195409, C4-195296 |
Implementation of pCRs agreed at CT4#95 |
0.5.0 |
|||
|
2019-12 |
CT#86 |
CP-193065 |
TS presented for information |
1.0.0 |
|||
|
2020-03 |
CT4#96e |
C4-200725, C4-200727, C4-200943, C4-200993, C4-200995, C4-201286 |
Implementation of pCRs agreed at CT4#96e |
1.1.0 |
|||
|
2020-03 |
CT#87e |
CP-200060 |
TS presented for approval |
2.0.0 |
|||
|
2020-03 |
CT#87e |
Approved at CT87e |
16.0.0 |
||||
|
2020-04 |
CT#87e |
C4-202409 |
0001 |
1 |
F |
Correct the errors |
16.1.0 |
|
2020-04 |
CT#87e |
C4-202325 |
0003 |
– |
F |
Miscellaneous corrections on TS 29.515 |
16.1.0 |
|
2020-04 |
CT#87e |
C4-202326 |
0004 |
– |
F |
Removing pseudonym of UE |
16.1.0 |
|
2020-04 |
CT#87e |
C4-202532 |
0005 |
1 |
F |
UE Privacy Requirements Corrections |
16.1.0 |
|
2020-06 |
CT#88e |
C4-203181 |
0006 |
– |
F |
Error corrections |
16.1.0 |
|
2020-06 |
CT#88e |
C4-203540 |
0007 |
1 |
F |
Storage of YAML files in ETSI Forge |
16.1.0 |
|
2020-06 |
CT#88e |
C4-203524 |
0008 |
1 |
F |
Correct the Example Consumer(s) in Table 5.1-1 |
16.1.0 |
|
2020-06 |
CT#88e |
C4-203269 |
0010 |
– |
F |
LDRreference |
16.1.0 |
|
2020-06 |
CT#88e |
C4-203360 |
0003 |
1 |
F |
Miscellaneous corrections on TS 29.515 |
16.1.0 |
|
2020-06 |
CT#88e |
C4-203645 |
0011 |
– |
F |
3GPP TS 29.515 API Version Update |
16.1.0 |
|
2020-09 |
CT#89e |
CP-202112 |
0012 |
1 |
F |
API name correction |
16.2.0 |
|
2020-09 |
CT#89e |
CP-202112 |
0014 |
1 |
F |
Correction of CodeWord Checking for UE Notification and Verification |
16.2.0 |
|
2020-09 |
CT#89e |
CP-202112 |
0015 |
1 |
F |
Correction of Notification or Verification only for UE Positioning |
16.2.0 |
|
2020-09 |
CT#89e |
CP-202112 |
0016 |
1 |
F |
Corrections on EventNotify service operation |
16.2.0 |
|
2020-09 |
CT#89e |
CP-202112 |
0017 |
1 |
F |
Corrections on Application Errors in provide-location response |
16.2.0 |
|
2020-09 |
CT#89e |
CP-202112 |
0018 |
1 |
F |
Corrections on LocationData |
16.2.0 |
|
2020-09 |
CT#89e |
CP-202139 |
0020 |
2 |
F |
Essential correction to OpenAPI specification for LocationUpdateNotify service operation |
16.2.0 |
|
2020-09 |
CT#89e |
CP-202096 |
0021 |
– |
F |
API version and External doc update |
16.2.0 |
|
2020-11 |
CT#90e |
CP-203050 |
0022 |
1 |
F |
CancelLocation for a group of UEs |
16.3.0 |
|
2020-11 |
CT#90e |
CP-203050 |
0023 |
2 |
F |
EventNotify for UEs in a group |
16.3.0 |
|
2020-11 |
CT#90e |
CP-203050 |
0024 |
1 |
F |
Provide Locations of a group of UEs |
16.3.0 |
|
2020-11 |
CT#90e |
CP-203050 |
0028 |
– |
F |
Essential corrections |
16.3.0 |
|
2020-11 |
CT#90e |
CP-203050 |
0029 |
– |
F |
Storage of YAML files in 3GPP Forge |
16.3.0 |
|
2020-11 |
CT#90e |
CP-203050 |
0030 |
– |
F |
API version and External doc update |
16.3.0 |
|
2021-03 |
CT#91e |
CP-210037 |
0033 |
1 |
F |
HTTP 3xx redirection |
16.4.0 |
|
2021-03 |
CT#91e |
CP-210041 |
0032 |
1 |
F |
Geographic Area |
16.4.0 |
|
2021-03 |
CT#91e |
CP-210054 |
0035 |
– |
F |
29.515 Rel-16 API version and External doc update |
16.4.0 |
|
2021-03 |
CT#91e |
CP-210034 |
0034 |
1 |
F |
OpenAPI Reference |
17.0.0 |
|
2021-06 |
CT#92e |
0036 |
2 |
B |
Add Local Address |
17.1.0 |
|
|
2021-06 |
CT#92e |
0047 |
- |
F |
Data Types Descriptions |
17.1.0 |
|
|
2021-06 |
CT#92e |
0050 |
- |
F |
29.515 Rel-17 API version and External doc update |
17.1.0 |
|
|
2021-06 |
CT#92e |
0040 |
1 |
A |
3xx description correction for SCP |
17.1.0 |
|
|
2021-06 |
CT#92e |
0046 |
1 |
A |
Redirect Responses |
17.1.0 |
|
|
2021-06 |
CT#92e |
0038 |
1 |
A |
LCS Service Type and External Client Type |
17.1.0 |
|
|
2021-06 |
CT#92e |
0044 |
- |
A |
Remove LcsServiceType |
17.1.0 |
|
|
2021-06 |
CT#92e |
0048 |
- |
A |
Wrong data type name |
17.1.0 |
|
|
2021-09 |
CT#93e |
C4-214712 |
0056 |
1 |
A |
LCS Service Type |
17.2.0 |
|
2021-09 |
CT#93e |
C4-214826 |
0054 |
1 |
B |
Multiple QoS Class |
17.2.0 |
|
2021-09 |
CT#93e |
C4-214766 |
0057 |
– |
F |
29.515 Rel-17 API version and External doc update |
17.2.0 |
|
2021-12 |
CT#94e |
C4-215455 |
0059 |
– |
B |
Higher Resolution Timestamp for Location Estimates |
17.3.0 |
|
2021-12 |
CT#94e |
C4-216164 |
0063 |
– |
A |
Correct the table name of SuccessType |
17.3.0 |
|
2021-12 |
CT#94e |
C4-216520 |
0065 |
1 |
A |
Add the missing pseudonymIndicator IE in OpenAPI |
17.3.0 |
|
2021-12 |
CT#94e |
C4-216534 |
0067 |
1 |
A |
Information for HGMLC Discovery |
17.3.0 |
|
2021-12 |
CT#94e |
CP-213174 |
0069 |
2 |
A |
LCS Service Type in MO-LR |
17.3.0 |
|
2021-12 |
CT#94e |
C4-216481 |
0070 |
– |
F |
29.515 Rel-17 API version and External doc update |
17.3.0 |
|
2022-03 |
CT#95e |
C4-220339 |
0074 |
1 |
F |
Editorial corrections |
17.4.0 |
|
2022-03 |
CT#95e |
C4-220368 |
0072 |
1 |
B |
Schedule location time for GMLC |
17.4.0 |
|
2022-03 |
CT#95e |
C4-221352 |
0076 |
– |
F |
Editorial corrections |
17.4.0 |
|
2022-03 |
CT#95e |
C4-221603 |
0077 |
– |
F |
29.515 Rel-17 API version and External doc update |
17.4.0 |
|
2022-06 |
CT#96 |
CP-221022 |
0079 |
– |
B |
Scheduled location time for bulk operation |
17.5.0 |
|
2022-06 |
CT#96 |
CP-221051 |
0081 |
– |
F |
29.515 Rel-17 API version and External doc update |
17.5.0 |
|
2022-09 |
CT#97e |
CP-222036 |
0082 |
1 |
F |
Indication of Network Assisted Positioning method |
17.6.0 |
|
2022-09 |
CT#97e |
CP-222058 |
0083 |
– |
F |
29.515 Rel-17 API version and External doc update |
17.6.0 |
|
2022-12 |
CT#98e |
CP-223028 |
0084 |
1 |
F |
Missing mandatory status codes in OpenAPI |
18.0.0 |
|
2022-12 |
CT#98e |
CP-223033 |
0085 |
– |
F |
29.515 Rel-18 API version and External doc update |
18.0.0 |