Delete TS24283_Lms_LocationReport.yaml (ab8b13db) · Commits · All Groups / 5G APIs

TS24283_Lms_LocationReport.yaml

deleted100644 → 0

+0 −247

Original line number	Diff line number	Diff line
		openapi: 3.0.0

		info:
		title: LMS_LocationReport
		version: 1.0.0-alpha.6
		description: \|
		API for LocationReports to LMS Service.
		© 2025, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
		All rights reserved.

		externalDocs:
		description: 3GPP TS 24.283 v1.0.0; Mission Critical Location Management (MCLoc).
		url: http://www.3gpp.org/ftp/Specs/archive/24_series/24.283/

		servers:
		- url: '{apiRoot}/lms-location-report/v1'
		variables:
		apiRoot:
		default: https://example.com
		description: apiRoot as defined in clause 8.2.44D1 of 3GPP TS 24.483

		security:
		- BearerAuth: []

		paths:
		/locationreports:
		post:
		summary: submit a MC UE location report
		security:
		- BearerAuth: []
		operationId: submitLocationReport
		tags:
		- MC UE Location Report (Collection)
		requestBody:
		required: true
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/MCUELocation'
		responses:
		'201':
		description: Successful submission of location report.
		content:
		application/json:
		schema:
		$ref: '#/components/schemas/MCUELocation'
		'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'
		'503':
		$ref: 'TS29571_CommonData.yaml#/components/responses/503'
		default:
		$ref: 'TS29571_CommonData.yaml#/components/responses/default'

		components:
		securitySchemes:
		BearerAuth:
		type: http
		scheme: bearer

		# API specific definitions
		schemas:
		MCUELocation:
		description: Describes the parameters to perform LMS Location reports.
		type: object
		properties:
		functionalAlias:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Uri'
		interRatType:
		$ref: '#/components/schemas/InterRatType'
		locationData:
		$ref: '#/components/schemas/LocationInfo'
		locTimestamp:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
		mclocClientId:
		$ref: '#/components/schemas/MclocClientId'
		mcServiceUELabel:
		type: string
		description: Used to identify the reporting MC UE for the end users, this may be used
		when multiple MC UEs are used by the same MC service user.
		reportId:
		type: string
		description: Attribute is used to return the value in the RequestId attribute
		in the an Location Request.
		reportType:
		$ref: '#/components/schemas/ReportType'
		triggerId:
		type: array
		items:
		type: string
		description: Attribute which can occur multiple times that contain the value
		of the TriggerId attribute associated with a trigger that has fired.
		locationHistoryData:
		$ref: '#/components/schemas/LocationHistoryData'
		locationHistoryStatus:
		$ref: '#/components/schemas/LocationHistoryStatus'
		MclocClientId:
		type: string
		format: uuid
		description: Used to identify the reporting LMC, this is required when multiple location
		information responses for different requested LMC are sent.

		LocationInfo:
		description: object that includes coordinates typically obtained from GPS.
		type: object
		properties:
		currentCoordinate:
		$ref: '#/components/schemas/CurrentCoordinate'
		ecgi:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi'
		mbmsSaiId:
		type: integer
		minimum: 0
		maximum: 65535
		description: Attribute containing the MBMS Service Area Id the LMC is located in.
		mbsfnArea:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/MbsfnArea'
		ncgi:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi'
		neighbouringEcgi:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Ecgi'
		neighbouringNcgi:
		type: array
		items:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/Ncgi'
		nr5GMbsfsaArea:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/MbsFsaId'

		CurrentCoordinate:
		description: This object contains one specific location point, speed and bearing (e.g.,
		received from a GPS reciever).
		type: object
		properties:
		altitude:
		anyOf:
		- $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Altitude'
		bearingAndSpeed:
		anyOf:
		- $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/HorizontalWithVerticalVelocity'
		geographicalCoordinate:
		anyOf:
		- $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/GeographicalCoordinates'
		horizontalaccuracy:
		anyOf:
		- $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy'
		verticalaccuracy:
		anyOf:
		- $ref: 'TS29572_Nlmf_Location.yaml#/components/schemas/Accuracy'



		LocationHistoryData:
		description: This object contains one or multiple time stamped location information reports.
		type: array
		items:
		$ref: '#/components/schemas/LocationHistoryEvent'


		LocationHistoryEvent:
		description: This object respresents a single location information report that has been
		stored in the LMC.
		type: object
		properties:
		locationData:
		$ref: '#/components/schemas/LocationInfo'
		locTimestamp:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
		triggerId:
		type: array
		items:
		type: string
		description: Attribute which can occur multiple times that contain the value
		of the TriggerId attribute associated with a trigger that has fired.



		LocationHistoryStatus:
		description: This object respresents Location history summary status of the location reports
		that has been stored in the LMC and has not yet been reporeted.
		type: object
		properties:
		storedReports:
		type: integer
		description: set to the number of stored reports.
		startTime:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
		endTime:
		$ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime'
		triggerId:
		type: array
		items:
		type: string
		description: Attribute which can occur multiple times that contain the value
		of the TriggerId attribute associated with a trigger that has fired.


		#
		# Simple Types:
		#


		#
		# Enumeration data types
		#
		InterRatType:
		description: Attribute containing the inter-RAT change type.
		anyOf:
		- type: string
		enum:
		- 5G_MBS_TO_LTE_MBMS
		- 5G_MBS_TO_LTE_UNICAST
		- LTE_MBMS_TO_5G_MBS
		- LTE_MBMS_TO_5G_UNICAST
		- type: string
		description: This string provides forward-compatibility with future extensions to the
		enumeration and is not used to encode content defined in the present version
		of this API.

		ReportType:
		description: Used to inform whether the LMC is sending the report in an emergency
		situation or not.
		anyOf:
		- type: string
		enum:
		- EMERGENCY
		- NONEMERGENCY
		- type: string
		description: This string provides forward-compatibility with future extensions to the
		enumeration and is not used to encode content defined in the present version
		of this API.