Newer
Older
Sebastian Muellers
committed
swagger: '2.0'
info:
description: >-
The MEC-013 Location API described using OpenAPI, which is
based on the Open Mobile Alliance's specification RESTful Network API for
Zonal Presence
version: 1.0.0
title: MEC Location API
license:
name: ETSI Forge copyright notice
url: 'https://forge.etsi.org/etsi-forge-copyright-notice.txt'
Sebastian Muellers
committed
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
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
121
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
153
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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
externalDocs:
description: ETSI MEC013 V1.0.1 Location Service API
url: 'https://docbox.etsi.org/ISG/MEC/70-Draft/0013LocationApi'
host: '127.0.0.1:8081'
basePath: /exampleAPI/location/v1/
schemes:
- http
- https
consumes:
- application/json
produces:
- application/json
parameters:
ZoneId:
name: zoneId
in: query
description: Zone ID
required: true
type: string
AccessPointId:
name: accessPointId
in: query
description: 'Identifier of access point, reference "definitions" for string format'
required: false
type: string
InterestRealm:
name: interestRealm
in: query
description: >-
Interest realm of access point (e.g. geographical area, a type of industry
etc.).
required: false
type: string
paths:
/zones:
get:
description: >-
Used to get a list of identifiers for zones authorized for use by the
application.
produces:
- application/json
responses:
'200':
description: Successful response to a query regarding the status of a zone
schema:
properties:
zoneList:
description: Collection of the zone information list.
required:
- resourceURL
properties:
zone:
description: Collection of the zone information list.
type: array
items:
description: A type containing zone information.
required:
- zoneId
- numberOfAccessPoints
- numberOfUnservicableAccessPoints
- numberOfUsers
- resourceURL
properties:
zoneId:
description: Identifier of zone
type: string
example: zone01
numberOfAccessPoints:
description: The number of access points within the zone
type: integer
format: uint32
example: '10'
numberOfUnservicableAccessPoints:
description: Number of inoperable access points within the zone.
type: integer
format: uint32
example: '9'
numberOfUsers:
description: The number of users currently on the access point.
type: integer
format: uint32
example: '7'
resourceURL:
description: Self referring URL.
type: string
format: uri
example: >-
http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
resourceURL:
description: Self referring URL.
type: string
format: uri
example: >-
http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
examples:
application/json:
zoneList:
zone:
- zoneId: zone01
numberOfAccessPoints: '3'
numberOfUnserviceableAccessPoints: '1'
numberOfUsers: '10'
resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01'
- zoneId: zone02
numberOfAccessPoints: '12'
numberOfUnserviceableAccessPoints: '0'
numberOfUsers: '36'
resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone02'
resourceURL: 'http://example.com/exampleAPI/location/v1/zones'
'/zones/{zoneId}':
get:
description: Used to get the status of a zone.
produces:
- application/json
parameters:
- name: zoneId
in: path
description: Zone ID
required: true
type: string
responses:
'200':
description: Successful response to a query regarding the status of a zone
schema:
properties:
zoneInfo:
description: A type containing zone information.
required:
- zoneId
- numberOfAccessPoints
- numberOfUnservicableAccessPoints
- numberOfUsers
- resourceURL
properties:
zoneId:
description: Identifier of zone
type: string
example: zone01
numberOfAccessPoints:
description: The number of access points within the zone
type: integer
format: uint32
example: '10'
numberOfUnservicableAccessPoints:
description: Number of inoperable access points within the zone.
type: integer
format: uint32
example: '9'
numberOfUsers:
description: The number of users currently on the access point.
type: integer
format: uint32
example: '7'
resourceURL:
description: Self referring URL.
type: string
format: uri
example: >-
http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
examples:
application/json:
zoneInfo:
zoneId: zone01
numberOfAccessPoints: '3'
numberOfUnserviceableAccessPoints: '1'
numberOfUsers: '10'
resourceURL: 'http://example.com/exampleAPI/location/v1/zones/zone01'
'/zones/{zoneId}/accessPoints':
get:
description: >-
Access point status can be retrieved for sets of access points matching
attribute in the request.
produces:
- application/json
parameters:
- name: zoneId
in: path
description: Zone ID
required: true
type: string
- name: interestRealm
in: query
description: >-
Interest realm of access point (e.g. geographical area, a type of
industry etc.).
required: false
type: string
responses:
'200':
Loading full blame...