Newer
Older
contact:
url: https://forge.etsi.org/rep/mec/gs013-location-api
title: ETSI GS MEC 013 - Location API
version: 2.1.1
description: The ETSI MEC ISG MEC013 Location API described using OpenAPI.
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
externalDocs:
description: ETSI MEC013 V2.1.1 Location API
url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/02.01.01_60/gs_mec013v020101p.pdf'
servers:
- url: 'https://localhost/location/v2'
tags:
- name: 'location'
summary: 'UE Distance Lookup of a specific UE'
description: 'UE Distance Lookup between terminals or a terminal and a location'
operationId: distanceGET
parameters:
- $ref: '#/components/parameters/Query.Requester'
- $ref: '#/components/parameters/Query.AddressMandatory'
- $ref: '#/components/parameters/Query.Latitude'
- $ref: '#/components/parameters/Query.Longitude'
responses:
'200':
description: 'Successful response to a distance request'
content:
application/json:
schema:
type: object
properties:
terminalDistance:
$ref: '#/components/schemas/TerminalDistance'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'queries'
/queries/users:
get:
summary: 'UE Location Lookup of a specific UE or group of UEs'
description: 'UE Location Lookup of a specific UE or group of UEs'
operationId: usersGET
parameters:
- $ref: '#/components/parameters/Query.ZoneId'
- $ref: '#/components/parameters/Query.AccessPointId'
- $ref: '#/components/parameters/Query.Address'
responses:
'200':
description: 'Successful response to users request'
content:
application/json:
schema:
type: object
properties:
userList:
$ref: '#/components/schemas/UserList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: "queries"
/queries/zones:
get:
tags:
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
summary: 'Zones information Lookup'
description: 'Used to get a list of identifiers for zones authorized for use by the application.'
operationId: zonesGET
responses:
'200':
description: 'Successful response to zones request'
content:
application/json:
schema:
type: object
properties:
zoneList:
$ref: '#/components/schemas/ZoneList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: "queries"
/queries/zones/{zoneId}:
get:
tags:
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
summary: 'Zones information Lookup'
description: 'Used to get the information for an authorized zone for use by the application.'
operationId: zonesGetById
parameters:
- $ref: '#/components/parameters/Path.ZoneId'
responses:
'200':
description: 'Successful response to an access point Id request'
content:
application/json:
schema:
type: object
properties:
zoneInfo:
$ref: '#/components/schemas/ZoneInfo'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'queries'
/queries/zones/{zoneId}/accessPoints:
get:
tags:
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
summary: 'Radio Node Location Lookup'
description: 'Radio Node Location Lookup to retrieve a list of radio nodes associated to a zone.'
operationId: apGET
parameters:
- $ref: '#/components/parameters/Path.ZoneId'
- $ref: '#/components/parameters/Query.InterestRealm'
responses:
'200':
description: 'Successful response to an access point Id request'
content:
application/json:
schema:
type: object
properties:
accessPointList:
$ref: '#/components/schemas/AccessPointList'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: "queries"
/queries/zones/{zoneId}/accessPoints/{accessPointId}:
get:
tags:
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
summary: 'Radio Node Location Lookup'
description: 'Radio Node Location Lookup to retrieve a radio node associated to a zone.'
operationId: apByIdGET
parameters:
- $ref: '#/components/parameters/Path.ZoneId'
- $ref: '#/components/parameters/Path.AccessPointId'
responses:
'200':
description: 'Successful response to an access point Id request'
content:
application/json:
schema:
type: object
properties:
accessPointInfo:
$ref: '#/components/schemas/AccessPointInfo'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'queries'
/subscriptions/area/circle:
get:
tags:
summary: 'Retrieves all active subscriptions to area change notifications'
description: 'This operation is used for retrieving all active subscriptions to area change notifications.'
operationId: areaCircleSubListGET
responses:
'200':
description: 'Response to retrieve area subscriptions'
content:
application/json:
schema:
type: object
required:
- notificationSubscriptionList
properties:
notificationSubscriptionList:
$ref: '#/components/schemas/NotificationSubscriptionList'
examples:
- notificationSubscriptionList:
circleNotificationSubscription:
- clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
checkImmediate: true
enteringLeavingCriteria: 'Entering'
frequency: 10
latitude: -80.88
longitude: 41.277
radius: 500
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123'
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle'
summary: 'Creates a subscription for area change notification'
description: 'Creates a subscription to the Location Service for an area change notification.'
operationId: areaCircleSubPOST
requestBody:
description: 'Subscription to be created'
required: true
content:
application/json:
schema:
type: object
properties:
circleNotificationSubscription:
$ref: '#/components/schemas/CircleNotificationSubscription'
examples:
- circleNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
checkImmediate: true
enteringLeavingCriteria: 'Entering'
frequency: 10
latitude: -80.88
longitude: 41.277
radius: 500
trackingAccuracy: 10
responses:
'201':
description: 'Successful subscription'
content:
application/json:
schema:
type: object
properties:
circleNotificationSubscription:
$ref: '#/components/schemas/CircleNotificationSubscription'
examples:
- circleNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
checkImmediate: true
enteringLeavingCriteria: 'Entering'
frequency: 10
latitude: -80.88
longitude: 41.277
radius: 500
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
callbacks:
notification:
'{$request.body#/circleNotificationSubscription.callbackReference.notifyURL}':
post:
summary: 'Callback POST used to send a notification'
description: 'Notification from Location service, content based on subscription type'
operationId: circleNotificationPOST
requestBody:
description: 'Subscription notification'
required: true
content:
application/json:
schema:
type: object
properties:
subscriptionNotification:
$ref: '#/components/schemas/SubscriptionNotification'
examples:
- subscriptionNotification:
enteringLeavingCriteria: 'Entering'
isFinalNotification: false,
link:
rel: CircleNotificationSubscription
href: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/sub123'
terminalLocation:
address: 'acr:10.0.0.1'
currentLocation:
accuracy: 100
altitude: 1001.0
latitude: -80.86302
longitude: 41.277306
timestamp:
seconds: 1483231138
nanoSeconds": 0
locationRetrievalStatus: 'Retrieved'
responses:
'204':
$ref: '#/components/responses/204'
x-swagger-router-controller: 'subscriptions'
/subscriptions/area/circle/{subscriptionId}:
get:
tags:
summary: 'Retrieve subscription information'
description: 'Get subscription information.'
operationId: areaCircleSubGET
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Subscription information regarding subscription notifications'
content:
application/json:
schema:
type: object
required:
- circleNotificationSubscription
properties:
circleNotificationSubscription:
$ref: '#/components/schemas/CircleNotificationSubscription'
examples:
- circleNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
checkImmediate: true
enteringLeavingCriteria: 'Entering'
frequency: 10
latitude: -80.88
longitude: 41.277
radius: 500
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
put:
tags:
summary: 'Updates a subscription information'
description: 'Updates a subscription.'
operationId: areaCircleSubPUT
requestBody:
description: 'Subscription to be modified'
required: true
content:
application/json:
schema:
type: object
properties:
circleNotificationSubscription:
$ref: '#/components/schemas/CircleNotificationSubscription'
examples:
- circleNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
checkImmediate: true
enteringLeavingCriteria: 'Entering'
frequency: 10
latitude: -80.88
longitude: 41.277
radius: 500
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123'
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Successful subscription to response to subscription notifications'
content:
application/json:
schema:
type: object
properties:
circleNotificationSubscription:
$ref: '#/components/schemas/CircleNotificationSubscription'
examples:
- circleNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
checkImmediate: true
enteringLeavingCriteria: 'Entering'
frequency: 10
latitude: -80.88
longitude: 41.277
radius: 500
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/area/circle/subscription123'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'412':
$ref: '#/components/responses/412'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
delete:
tags:
summary: 'Cancel a subscription'
description: 'Method to delete a subscription.'
operationId: areaCircleSubDELETE
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'204':
$ref: '#/components/responses/204'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
/subscriptions/distance:
get:
tags:
summary: 'Retrieves all active subscriptions to distance change notifications'
description: 'This operation is used for retrieving all active subscriptions to a distance change notifications.'
operationId: distanceSubListGET
responses:
'200':
description: 'Response to retrieve area subscriptions'
content:
application/json:
schema:
type: object
required:
- notificationSubscriptionList
properties:
notificationSubscriptionList:
$ref: '#/components/schemas/NotificationSubscriptionList'
examples:
- notificationSubscriptionList:
distanceNotificationSubscription:
- clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
monitoredAddress:
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
checkImmediate: true
criteria: 'AllWithinDistance'
distance: 100
frequency: 10
referenceAddress: 'acr:10.0.0.3'
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/sub123'
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance'
summary: 'Creates a subscription for distance change notification'
description: 'Creates a subscription to the Location Service for a distance change notification.'
operationId: distanceSubPOST
requestBody:
description: 'Subscription to be created'
required: true
content:
application/json:
schema:
type: object
properties:
distanceNotificationSubscription:
$ref: '#/components/schemas/DistanceNotificationSubscription'
examples:
- distanceNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
checkImmediate: true
criteria: 'AllWithinDistance'
distance: 100
frequency: 10
referenceAddress: 'acr:10.0.0.3'
trackingAccuracy: 10
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
responses:
'201':
description: 'Successful subscription'
content:
application/json:
schema:
type: object
properties:
distanceNotificationSubscription:
$ref: '#/components/schemas/DistanceNotificationSubscription'
examples:
- distanceNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
monitoredAddress:
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
checkImmediate: true
criteria: 'AllWithinDistance'
distance: 100
frequency: 10
referenceAddress: 'acr:10.0.0.3'
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
callbacks:
notification:
'{$request.body#/distanceNotificationSubscription.callbackReference.notifyURL}':
post:
summary: 'Callback POST used to send a notification'
description: 'Notification from Location service, content based on subscription type'
operationId: distanceNotificationPOST
requestBody:
description: 'Subscription notification'
required: true
content:
application/json:
schema:
type: object
properties:
subscriptionNotification:
$ref: '#/components/schemas/SubscriptionNotification'
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
examples:
- subscriptionNotification:
distanceCriteria: 'AllWithinDistance'
isFinalNotification: false,
link:
rel: DistanceNotificationSubscription
href: 'http://meAppServer.example.com/location/v2/subscriptions/distance/sub123'
terminalLocation:
- address: 'acr:10.0.0.1'
currentLocation:
accuracy: 100
altitude: 1001.0
latitude: -80.86302
longitude: 41.277306
timestamp:
seconds: 1483231138
nanoSeconds": 0
locationRetrievalStatus: 'Retrieved'
- address: 'acr:10.0.0.2'
currentLocation:
accuracy: 100
altitude: 1001.0
latitude: -80.86301
longitude: 41.277306
timestamp:
seconds: 1483231138
nanoSeconds": 0
locationRetrievalStatus: 'Retrieved'
responses:
'204':
$ref: '#/components/responses/204'
x-swagger-router-controller: "subscriptions"
/subscriptions/distance/{subscriptionId}:
get:
tags:
summary: 'Retrieve subscription information'
description: 'Get subscription information.'
operationId: distanceSubGET
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Subscription information regarding subscription notifications'
content:
application/json:
schema:
type: object
required:
- distanceNotificationSubscription
properties:
distanceNotificationSubscription:
$ref: '#/components/schemas/DistanceNotificationSubscription'
examples:
- distanceNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
monitoredAddress:
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
checkImmediate: true
criteria: 'AllWithinDistance'
distance: 100
frequency: 10
referenceAddress: 'acr:10.0.0.3'
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
put:
tags:
summary: 'Updates a subscription information'
description: 'Updates a subscription.'
operationId: distanceSubPUT
requestBody:
description: 'Subscription to be modified'
required: true
content:
application/json:
schema:
type: object
properties:
distanceNotificationSubscription:
$ref: '#/components/schemas/DistanceNotificationSubscription'
examples:
- distanceNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
checkImmediate: true
criteria: 'AllWithinDistance'
distance: 100
frequency: 10
referenceAddress: 'acr:10.0.0.3'
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123'
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Successful subscription to response to subscription notifications'
content:
application/json:
schema:
type: object
properties:
distanceNotificationSubscription:
$ref: '#/components/schemas/DistanceNotificationSubscription'
examples:
- distanceNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
monitoredAddress:
- 'acr:10.0.0.1'
- 'acr:10.0.0.2'
checkImmediate: true
criteria: 'AllWithinDistance'
distance: 100
frequency: 10
referenceAddress: 'acr:10.0.0.3'
trackingAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/distance/subscription123'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'412':
$ref: '#/components/responses/412'
'422':
$ref: '#/components/responses/422'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
delete:
tags:
summary: 'Cancel a subscription'
description: 'Method to delete a subscription.'
operationId: distanceSubDELETE
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'204':
$ref: '#/components/responses/204'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
/subscriptions/periodic:
get:
tags:
summary: 'Retrieves all active subscriptions to periodic notifications'
description: 'This operation is used for retrieving all active subscriptions to periodic notifications.'
operationId: periodicSubListGET
responses:
'200':
description: 'Response to retrieve area subscriptions'
content:
application/json:
schema:
type: object
required:
- notificationSubscriptionList
properties:
notificationSubscriptionList:
$ref: '#/components/schemas/NotificationSubscriptionList'
examples:
- notificationSubscriptionList:
periodicNotificationSubscription:
- clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
frequency: 10
requestedAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123'
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic'
summary: 'Creates a subscription for periodic notification'
description: 'Creates a subscription to the Location Service for a periodic notification.'
operationId: periodicSubPOST
requestBody:
description: Subscription to be created
required: true
content:
application/json:
schema:
type: object
properties:
periodicNotificationSubscription:
$ref: '#/components/schemas/PeriodicNotificationSubscription'
examples:
- periodicNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
frequency: 10
requestedAccuracy: 10
responses:
'201':
description: 'Successful subscription'
content:
application/json:
schema:
type: object
properties:
periodicNotificationSubscription:
$ref: '#/components/schemas/PeriodicNotificationSubscription'
examples:
- periodicNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
frequency: 10
requestedAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
callbacks:
notification:
'{$request.body#/periodicNotificationSubscription.callbackReference.notifyURL}':
post:
summary: 'Callback POST used to send a notification'
description: 'Notification from Location service, content based on subscription type'
operationId: periodicNotificationPOST
requestBody:
description: 'Subscription notification'
required: true
content:
application/json:
schema:
type: object
properties:
subscriptionNotification:
$ref: '#/components/schemas/SubscriptionNotification'
examples:
- subscriptionNotification:
isFinalNotification: false,
link:
rel: PeriodicNotificationSubscription
href: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/sub123'
terminalLocation:
address: 'acr:10.0.0.1'
currentLocation:
accuracy: 100
altitude: 1001.0
latitude: -80.86302
longitude: 41.277306
timestamp:
seconds: 1483231138
nanoSeconds": 0
locationRetrievalStatus: 'Retrieved'
responses:
'204':
$ref: '#/components/responses/204'
x-swagger-router-controller: 'subscriptions'
/subscriptions/periodic/{subscriptionId}:
get:
tags:
summary: 'Retrieve subscription information'
description: 'Get subscription information.'
operationId: periodicSubGET
parameters:
- $ref: '#/components/parameters/Path.SubscrId'
responses:
'200':
description: 'Subscription information regarding subscription notifications'
content:
application/json:
schema:
type: object
required:
- periodicNotificationSubscription
properties:
periodicNotificationSubscription:
$ref: '#/components/schemas/PeriodicNotificationSubscription'
examples:
- periodicNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
frequency: 10
requestedAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'406':
$ref: '#/components/responses/406'
'429':
$ref: '#/components/responses/429'
x-swagger-router-controller: 'subscriptions'
put:
tags:
summary: 'Updates a subscription information'
description: 'Updates a subscription.'
operationId: periodicSubPUT
requestBody:
description: 'Subscription to be modified'
required: true
content:
application/json:
schema:
type: object
properties:
periodicNotificationSubscription:
$ref: '#/components/schemas/PeriodicNotificationSubscription'
examples:
- periodicNotificationSubscription:
clientCorrelator: '0123'
callbackReference:
callbackData: '1234'
notifyURL: 'http://clientApp.example.com/location_notifications/123456'
address: 'acr:10.0.0.1'
frequency: 10
requestedAccuracy: 10
resourceURL: 'http://meAppServer.example.com/location/v2/subscriptions/periodic/subscription123'