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: The number of access points within the zone
type: integer
format: uint32
example: "10"
\ No newline at end of file
description: Number of inoperable access points within the zone.
type: integer
format: uint32
example: "9"
\ No newline at end of file
description: The number of users currently on the access point.
type: integer
format: uint32
example: "7"
\ No newline at end of file
description: Threshold number of users in an access point which if crossed shall cause a notification.
type: integer
format: uint32
example: "20"
\ No newline at end of file
description: This element shall be present when ZoneStatusSubscription includes numberOfUsersAPThreshold element and the number of users in an access point exceeds the threshold defined in the subscription.
type: integer
format: uint32
example: "12"
\ No newline at end of file
description: This element shall be present when ZoneStatusSubscription includes numberOfUsersZoneThreshold element and the number of users in a zone exceeds the threshold defined in this subscription.
type: integer
format: uint32
example: "20"
\ No newline at end of file
description: Threshold number of users in a zone which if crossed shall cause a notification.
type: integer
format: uint32
example: "40"
\ No newline at end of file
description: The operation status of the access point
type: string
enum:
- Serviceable
- Unserviceable
- Unknown
example: "Serviceable"
\ No newline at end of file
description: Zone ID
type: string
example: "zone02"
\ No newline at end of file
description: Self referring URL.
type: string
format: uri
example: "http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123"
\ No newline at end of file
description: Indicates the time of day for zonal presence notification.
type: string
format: date-time
example: "2017-01-01T02:51:43Z"
\ No newline at end of file
description: Time zone of access point
type: string
format: date-time
example: "2017-01-01T02:51:43Z"
\ No newline at end of file
description: List of user event values to generate notifications for (these apply to address specified). If this element is missing, a notification is requested to be generated for any change in user event.
type: array
items:
$ref: '#/definitions/UserEventType'
\ No newline at end of file
description: User event
type: string
enum:
- Entering
- Leaving
- Transferring
example: "Entering"
\ No newline at end of file
description: A type containing user information.
type: object
required:
- address
- accessPointId
- zoneId
- resourceURL
properties:
address:
$ref: '#/definitions/Address'
accessPointId:
$ref: '#/definitions/AccessPointId'
zoneId:
$ref: '#/definitions/ZoneId'
resourceURL:
$ref: '#/definitions/ResourceURL'
locationInfo:
$ref: '#/definitions/LocationInfo'
contextLocationInfo:
$ref: '#/definitions/ContextLocationInfo'
ancillaryInfo:
$ref: '#/definitions/AncillaryInfo'
\ No newline at end of file
description: A type containing list of users.
type: object
required:
- resourceURL
properties:
user:
description: Collection of the zone information list.
type: array
items:
$ref: '#/definitions/UserInfo'
resourceURL:
$ref: '#/definitions/ResourceURL'
\ No newline at end of file
description: A type containing user tracking subscription.
type: object
required:
- callbackReference
- address
properties:
clientCorrelator:
$ref: '#/definitions/ClientCorrelator'
callbackReference:
$ref: '#/definitions/CallbackReference'
address:
$ref: '#/definitions/Address'
userEventCriteria:
$ref: '#/definitions/UserEventCriteria'
resourceURL:
$ref: '#/definitions/ResourceURL'
\ No newline at end of file
description: A type containing zonal presence notification
type: object
required:
- zoneId
- address
- userEventType
- currentAccessPointId
- timestamp
properties:
callbackData:
$ref: '#/definitions/CallbackData'
zoneId:
$ref: '#/definitions/ZoneId'
address:
$ref: '#/definitions/Address'
interestRealm:
$ref: '#/definitions/InterestRealm'
userEventType:
$ref: '#/definitions/UserEventType'
currentAccessPointId:
$ref: '#/definitions/CurrentAccessPointId'
previousAccessPointId:
$ref: '#/definitions/PreviousAccessPointId'
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="ZonalTrafficSubscription" href="http://example.com/exampleAPI/location/v1/subscriptions/zonalTraffic/sub123"/
description: A type containing zonal traffic subscription
type: object
required:
- callbackReference
- zoneId
properties:
clientCorrelator:
$ref: '#/definitions/ClientCorrelator'
callbackReference:
$ref: '#/definitions/CallbackReference'
zoneId:
$ref: '#/definitions/ZoneId'
interestRealm:
description: Interest realms of access points within a zone (e.g. geographical area, a type of industry etc.).
type: array
items:
$ref: '#/definitions/InterestRealm'
userEventCriteria:
description: List of user event values to generate notifications for (these apply to zone identifier or all interest realms within zone identifier specified). If this element is missing, a notification is requested to be generated for any change in user event.
type: array
items:
$ref: '#/definitions/UserEventType'
duration:
$ref: '#/definitions/Duration'
resourceURL:
$ref: '#/definitions/ResourceURL'
\ No newline at end of file
description: Identifier of zone
type: string
example: "zone01"
\ No newline at end of file
Markdown is supported
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