A.2 SS_LocationReporting API
29.5493GPPApplication Programming Interface (API) specificationRelease 18Service Enabler Architecture Layer for Verticals (SEAL)Stage 3TS
openapi: 3.0.0
info:
title: SS_LocationReporting
description: |
API for SEAL Location Reporting Configuration.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.
version: "1.2.0-alpha.1"
externalDocs:
description: >
3GPP TS 29.549 V18.0.0 Service Enabler Architecture Layer for Verticals (SEAL);
Application Programming Interface (API) specification; Stage 3.
url: https://www.3gpp.org/ftp/Specs/archive/29_series/29.549/
security:
– {}
– oAuth2ClientCredentials: []
servers:
– url: ‘{apiRoot}/ss-lr/v1’
variables:
apiRoot:
default: https://example.com
description: apiRoot as defined in clause 6.5 of 3GPP TS 29.549
paths:
/trigger-configurations:
post:
description: Creates a new location reporting configuration.
operationId: CreateLocReportingConfig
tags:
– SEAL Location Reporting Configurations (Collection)
requestBody:
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/LocationReportConfiguration’
responses:
‘201’:
description: Location reporting configuration resource is created sucessfully.
content:
application/json:
schema:
$ref: ‘#/components/schemas/LocationReportConfiguration’
headers:
Location:
description: Contains the URI of the newly created resource.
required: true
schema:
type: string
‘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’
/trigger-configurations/{configurationId}:
get:
description: Retrieves an individual SEAL location reporting configuration information.
operationId: RetrieveLocReportingConfig
tags:
– Individual SEAL Location Reporting Configuration (Document)
parameters:
– name: configurationId
in: path
description: String identifying an individual configuration resource.
required: true
schema:
type: string
responses:
‘200’:
description: The location reporting configuration information.
content:
application/json:
schema:
$ref: ‘#/components/schemas/LocationReportConfiguration’
‘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’
‘406’:
$ref: ‘TS29122_CommonData.yaml#/components/responses/406’
‘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’
put:
description: Updates an individual SEAL location reporting configuration.
operationId: UpdateLocReportingConfig
tags:
– Individual SEAL Location Reporting Configuration (Document)
parameters:
– name: configurationId
in: path
description: String identifying an individual configuration resource.
required: true
schema:
type: string
requestBody:
description: Configuration information to be updated in location management server.
required: true
content:
application/json:
schema:
$ref: ‘#/components/schemas/LocationReportConfiguration’
responses:
‘200’:
description: The configuration is updated successfully.
content:
application/json:
schema:
$ref: ‘#/components/schemas/LocationReportConfiguration’
‘204’:
description: No Content
‘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’
delete:
description: Deletes an individual SEAL location reporting configuration.
operationId: DeleteLocReportingConfig
tags:
– Individual SEAL Location Reporting Configuration (Document)
parameters:
– name: configurationId
in: path
description: String identifying an individual configuration resource.
required: true
schema:
type: string
responses:
‘204’:
description: The individual configuration matching configurationId is deleted.
‘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’
‘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’
patch:
description: Modify an existing SEAL Location Reporting Configuration.
operationId: ModifyLocReportingConfig
tags:
– Individual SEAL Location Reporting Configuration (Document)
parameters:
– name: configurationId
in: path
description: Identifier of an individual SEAL location reporting configuration.
required: true
schema:
type: string
requestBody:
required: true
content:
application/merge-patch+json:
schema:
$ref: ‘#/components/schemas/LocationReportConfigurationPatch’
responses:
‘200’:
description: >
The individual SEAL location reporting configuration is modified successfully and
a representation of the updated SEAL location reporting configuration is returned
in the request body.
content:
application/json:
schema:
$ref: ‘#/components/schemas/LocationReportConfiguration’
‘204’:
description: >
No Content. The individual SEAL location reporting configuration is
modified successfully.
‘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:
LocationReportConfiguration:
description: Represents the location reporting configuration information.
type: object
properties:
valServerId:
type: string
valTgtUe:
$ref: ‘TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe’
immRep:
type: boolean
monDur:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
repPeriod:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DurationSec’
accuracy:
$ref: ‘TS29122_MonitoringEvent.yaml#/components/schemas/Accuracy’
suppFeat:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/SupportedFeatures’
required:
– valServerId
– valTgtUe
LocationReportConfigurationPatch:
description: Represents the location reporting configuration information patch.
type: object
properties:
valTgtUe:
$ref: ‘TS29549_SS_UserProfileRetrieval.yaml#/components/schemas/ValTargetUe’
monDur:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DateTime’
repPeriod:
$ref: ‘TS29571_CommonData.yaml#/components/schemas/DurationSec’
accuracy:
$ref: ‘TS29122_MonitoringEvent.yaml#/components/schemas/Accuracy’