Commit af639506 authored by Michel Roy's avatar Michel Roy
Browse files

added v2.1.1 draft version

parent 6bafe099
Pipeline #4990 failed with stage
in 0 seconds
description: A type containing zone information.
type: object
required:
- zoneId
- numberOfAccessPoints
- numberOfUnservicableAccessPoints
- numberOfUsers
- resourceURL
properties:
zoneId:
$ref: '#/definitions/ZoneId'
numberOfAccessPoints:
$ref: '#/definitions/NumberOfAccessPoints'
numberOfUnservicableAccessPoints:
$ref: '#/definitions/NumberOfUnserviceableAccessPoints'
numberOfUsers:
$ref: '#/definitions/NumberOfUsers'
resourceURL:
$ref: '#/definitions/ResourceURL'
\ No newline at end of file
description: Collection of the zone information list.
type: object
required:
- resourceURL
properties:
zone:
description: Collection of the zone information list.
type: array
items:
$ref: '#/definitions/ZoneInfo'
resourceURL:
$ref: '#/definitions/ResourceURL'
description: A type containing zone status notification.
type: object
required:
- zoneId
- timestamp
properties:
callbackData:
$ref: '#/definitions/CallbackData'
zoneId:
$ref: '#/definitions/ZoneId'
accessPointId:
$ref: '#/definitions/AccessPointId'
numberOfUsersInZone:
$ref: '#/definitions/NumberOfUsersInZone'
numberOfUsersInAP:
$ref: '#/definitions/NumberOfUsersInAP'
operationStatus:
$ref: '#/definitions/OperationStatus'
timestamp:
$ref: '#/definitions/Timestamp'
link:
description: Link to other resources that are in relationship with this notification. The server SHOULD include a link to the related subscription. No other links are required or suggested by this specification.
type: array
items:
$ref: '#/definitions/Link'
example: rel="ZonalStatusSubscription" href="http://example.com/exampleAPI/location/v1/subscriptions/zonalStatus/sub123"
description: A type containing zone status subscription.
type: object
required:
- callbackReference
- zoneId
properties:
clientCorrelator:
$ref: '#/definitions/ClientCorrelator'
resourceURL:
$ref: '#/definitions/ResourceURL'
callbackReference:
$ref: '#/definitions/CallbackReference'
zoneId:
$ref: '#/definitions/ZoneId'
numberOfUsersZoneThreshold:
$ref: '#/definitions/NumberOfUsersZoneThreshold'
numberOfUsersAPThreshold:
$ref: '#/definitions/NumberOfUsersAPThreshold'
operationStatus:
description: List of operation status values to generate notifications for (these apply to all access points within a zone).
type: array
items:
$ref: '#/definitions/OperationStatus'
\ No newline at end of file
AccessPointId:
$ref: ./AccessPointId.yaml
AccessPointInfo:
$ref: ./AccessPointInfo.yaml
AccessPointList:
$ref: ./AccessPointList.yaml
Address:
$ref: ./Address.yaml
AncillaryInfo:
$ref: ./AncillaryInfo.yaml
CallbackData:
$ref: ./CallbackData.yaml
CallbackReference:
$ref: ./CallbackReference.yaml
ClientCorrelator:
$ref: ./ClientCorrelator.yaml
ConnectionType:
$ref: ./ConnectionType.yaml
ContextLocationInfo:
$ref: ./ContextLocationInfo.yaml
CurrentAccessPointId:
$ref: ./CurrentAccessPointId.yaml
Duration:
$ref: ./Duration.yaml
InterestRealm:
$ref: ./InterestRealm.yaml
Link:
$ref: ./Link.yaml
LocationInfo:
$ref: ./LocationInfo.yaml
NotifyURL:
$ref: ./NotifyURL.yaml
NumberOfAccessPoints:
$ref: ./NumberOfAccessPoints.yaml
NumberOfUnserviceableAccessPoints:
$ref: ./NumberOfUnserviceableAccessPoints.yaml
NumberOfUsers:
$ref: ./NumberOfUsers.yaml
NumberOfUsersAPThreshold:
$ref: ./NumberOfUsersAPThreshold.yaml
NumberOfUsersInAP:
$ref: ./NumberOfUsersInAP.yaml
NumberOfUsersInZone:
$ref: ./NumberOfUsersInZone.yaml
NumberOfUsersZoneThreshold:
$ref: ./NumberOfUsersZoneThreshold.yaml
OperationStatus:
$ref: ./OperationStatus.yaml
PreviousAccessPointId:
$ref: ./PreviousAccessPointId.yaml
ResourceURL:
$ref: ./ResourceURL.yaml
Timestamp:
$ref: ./Timestamp.yaml
Timezone:
$ref: ./Timezone.yaml
UserEventCriteria:
$ref: ./UserEventCriteria.yaml
UserEventType:
$ref: ./UserEventType.yaml
UserInfo:
$ref: ./UserInfo.yaml
UserList:
$ref: ./UserList.yaml
UserTrackingSubscription:
$ref: ./UserTrackingSubscription.yaml
ZonalPresenceNotification:
$ref: ./ZonalPresenceNotification.yaml
ZonalTrafficSubscription:
$ref: ./ZonalTrafficSubscription.yaml
ZoneId:
$ref: ./ZoneId.yaml
ZoneInfo:
$ref: ./ZoneInfo.yaml
ZoneList:
$ref: ./ZoneList.yaml
ZoneStatusNotification:
$ref: ./ZoneStatusNotification.yaml
ZoneStatusSubscription:
$ref: ./ZoneStatusSubscription.yaml
\ No newline at end of file
{
"accessPointInfo": {
"accessPointId": "001010000000000000000000000000001",
"locationInfo": {
"latitude": "90.123",
"longitude": "80.123",
"altitude": "10.0",
"accuracy": "0"
},
"connectionType": "Macro",
"operationStatus": "Serviceable",
"numberOfUsers": "5",
"interestRealm": "LA",
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone001/accessPoints/ap001"
}
}
\ No newline at end of file
{
"accessPointList": {
"zoneId": "zone01",
"accessPoint": [{
"accessPointId": "001010000000000000000000000000001",
"locationInfo": {
"latitude": "90.123",
"longitude": "80.123",
"altitude": "10.0",
"accuracy": "0"
},
"connectionType": "Macro",
"operationStatus": "Serviceable",
"numberOfUsers": "5",
"interestRealm": "LA",
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap001"
}, {
"accessPointId": "001010000000000000000000000000010",
"locationInfo": {
"latitude": "91.123",
"longitude": "81.123",
"altitude": "12.0",
"accuracy": "1"
},
"connectionType": "Macro",
"operationStatus": "Unserviceable",
"numberOfUsers": "0",
"interestRealm": "DC",
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap002"
}, {
"accessPointId": "001010000000000000000000000000011",
"locationInfo": {
"latitude": "93.123",
"longitude": "83.123",
"altitude": "16.0",
"accuracy": "3"
},
"connectionType": "Macro",
"operationStatus": "Serviceable",
"numberOfUsers": "5",
"interestRealm": "NJ",
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints/ap003"
}
],
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone01/accessPoints"
}
}
\ No newline at end of file
{
"notificationSubscriptionList": {
"userTrackingSubscription":
[{
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"address": "acr:192.0.2.1",
"userEventCriteria": "Transferring"
}, {
"clientCorrelator": "0124",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription124",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"address": "acr:192.0.2.2",
"userEventCriteria": "Transferring"
}
],
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking"
}
}
\ No newline at end of file
{
"notificationSubscriptionList": {
"zonalTrafficSubscription":
[{
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"zoneId": "zone01",
"interestRealm": "LA",
"userEventCriteria": "Transferring"
}, {
"clientCorrelator": "0124",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription124",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123457"
},
"zoneId": "zone02",
"interestRealm": "LA",
"userEventCriteria": "Transferring"
}
],
"resourceURL": "http://example.com/exampleAPI/location/v1/zonalTraffic"
}
}
\ No newline at end of file
{
"notificationSubscriptionList": {
"zoneStatusSubscription":
[{
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"zoneId": "zone01",
"numberOfUsersZoneThreshold": "500",
"operationStatus": "Serviceable"
}, {
"clientCorrelator": "0124",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription124",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123457"
},
"zoneId": "zone02",
"numberOfUsersAPThreshold": "50",
"operationStatus": "Serviceable"
}
],
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus"
}
}
\ No newline at end of file
{
"userInfo": {
"address": "acr:192.0.2.1",
"accessPointId": "001010000000000000000000000000001",
"zoneId": "zone01",
"resourceURL": "http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.1",
"locationInfo": {
"latitude": "90.123",
"longitude": "80.123",
"altitude": "10.0",
"accuracy": "0"
},
"contextLocationInfo": "GroundFloor"
}
}
\ No newline at end of file
{
"userList": {
"user": [{
"address": "acr:192.0.2.1",
"accessPointId": "001010000000000000000000000000001",
"zoneId": "zone01",
"resourceURL": "http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.1"
}, {
"address": "acr:192.0.2.2",
"accessPointId": "001010000000000000000000000000001",
"zoneId": "zone01",
"resourceURL": "http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.2"
}, {
"address": "acr:192.0.2.3",
"accessPointId": "001010000000000000000000000000010",
"zoneId": "zone01",
"resourceURL": "http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.3"
}, {
"address": "acr:192.0.2.4",
"accessPointId": "001010000000000000000000000000001",
"zoneId": "zone02",
"resourceURL": "http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.4"
}, {
"address": "acr:192.0.2.5",
"accessPointId": "001010000000000000000000000000010",
"zoneId": "zone02",
"resourceURL": "http://example.com/exampleAPI/location/v1/users/acr%3A192.0.2.5"
}
],
"resourceURL": "http://example.com/exampleAPI/location/v1/users"
}
}
\ No newline at end of file
{
"userTrackingSubscription": {
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"address": "acr:192.0.2.1",
"userEventCriteria": "Transferring"
}
}
\ No newline at end of file
{
"zonalTrafficSubscription": {
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"zoneId": "zone01",
"interestRealm": "LA",
"userEventCriteria": "Transferring"
}
}
\ No newline at end of file
{
"zoneInfo": {
"zoneId": "zone01",
"numberOfAccessPoints": "3",
"numberOfUnserviceableAccessPoints": "1",
"numberOfUsers": "10",
"resourceURL": "http://example.com/exampleAPI/location/v1/zones/zone01"
}
}
\ No newline at end of file
{
"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"
}
}
\ No newline at end of file
{
"zoneStatusSubscription": {
"clientCorrelator": "0123",
"resourceURL": "http://example.com/exampleAPI/location/v1/subscriptions/zoneStatus/subscription123",
"callbackReference": {
"notifyURL": "http://clientApp.example.com/location_notifications/123456"
},
"zoneId": "zone01",
"numberOfUsersZoneThreshold": "500",
"operationStatus": "Serviceable"
}
}
\ No newline at end of file
description: 'ETSI MEC013 V1.1.1 Location Service API'
url: 'http://www.etsi.org/deliver/etsi_gs/MEC/001_099/013/01.01.01_60/gs_mec013v010101p.pdf'
\ No newline at end of file
title: 'Location API'
version: '1.1.1'
description: "The ETSI MEC ISG MEC012 Location API described using OpenAPI. The API is based on the Open Mobile Alliance's specification RESTful Network API for Zonal Presence"
license:
name: BSD-3-Clause
url: 'https://forge.etsi.org/legal-matters'
name: userTrackingSubscription
in: body
description: User Tracking Subscription
required: true
schema:
$ref: '#/definitions/UserTrackingSubscription'
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment