A.11 MoLcsNotify API
29.5223GPP5G SystemNetwork Exposure Function Northbound APIsRelease 18Stage 3TS
openapi: 3.0.0
info:
title: 3gpp-mo-lcs-notify
version: 1.1.1
description: |
API for UE updated location information notification.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
externalDocs:
description: >
3GPP TS 29.522 V17.7.0; 5G System; Network Exposure Function Northbound APIs.
url: ‘https://www.3gpp.org/ftp/Specs/archive/29_series/29.522/’
security:
– {}
– oAuth2ClientCredentials: []
servers:
– url: ‘{apiRoot}/3gpp-mo-lcs-notify/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 5.2.4 of 3GPP TS 29.122.
paths:
/:
post:
summary: UE location information update notification
operationId: UELocationNotify
tags:
– AF level UE location update notification operation
requestBody:
content:
application/json:
schema:
$ref: ‘#/components/schemas/LocUpdateData’
required: true
responses:
‘200’:
description: Success
content:
application/json:
schema:
$ref: ‘#/components/schemas/LocUpdateDataReply’
‘307’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/307’
‘308’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/308’
‘400’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/400’
‘401’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/401’
‘403’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/403’
‘404’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/404’
‘411’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/411’
‘413’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/413’
‘415’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/415’
‘429’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/429’
‘500’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/500’
‘503’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/503’
default:
$ref: ‘TS29122_CommonData.yaml#/components/responses/default’
components:
securitySchemes:
oAuth2ClientCredentials:
type: oauth2
flows:
clientCredentials:
tokenUrl: ‘{tokenUrl}’
scopes: {}
schemas:
LocUpdateData:
description: Represents a UE updated location information.
type: object
properties:
gpsi:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/Gpsi’
locInfo:
$ref: ‘TS29122_MonitoringEvent.yaml#/components/schemas/LocationInfo’
lcsQosClass:
$ref: ‘TS29572_Nlmf_Location.yaml#/components/schemas/LcsQosClass’
svcId:
$ref: ‘TS29515_Ngmlc_Location.yaml#/components/schemas/ServiceIdentity’
suppFeat:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
required:
– gpsi
– lcsQosClass
– locInfo
– suppFeat
LocUpdateDataReply:
description: Represents a reply to a MO LCS notification.
type: object
properties:
suppFeat:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
required:
– suppFeat