Newer
Older
Sebastian Muellers
committed
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
type: string
example: zone01
accessPointId:
description: >-
Identifier of access point, <E-CGI><Cell Portion ID> (reference ETSI
TS 129 171). Where the E-CGI is made up of the PLMN and Cell Identity
(28 bit string). Then the PLMN is made up of the 3 digit MCC & 2 or 3
digit MNC. The Cell Portion is an optional element
type: string
example: '001010000000000000000000000000001'
numberOfUsersInZone:
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'
numberOfUsersInAP:
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'
operationStatus:
description: The operation status of the access point
type: string
example: Serviceable
timestamp:
description: Indicates the time of day for zonal presence notification.
type: string
format: date-time
example: '2017-01-01T02:51:43Z'
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:
required:
- rel
- href
properties:
rel:
description: Describes the relationship between the URI and the resource.
type: object
format: string
href:
description: URI
type: object
format: anyURI
example: >-
rel="ZonalStatusSubscription"
href="http://example.com/exampleAPI/location/v1/subscriptions/zonalStatus/sub123"
ZoneStatusSubscription:
required:
- callbackReference
- zoneId
properties:
clientCorrelator:
description: >-
Uniquely identifies this create subscription request. If there is a
communication failure during the request, using the same
clientCorrelator when retrying the request allows the operator to
avoid creating a duplicate subscription.
type: string
example: '0123'
resourceURL:
description: Self referring URL.
type: string
format: uri
example: >-
http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123
callbackReference:
required:
- notifyURL
properties:
notifyURL:
description: The URL of your own listener application.
type: string
format: url
example: 'http://clientApp.example.com/location_notifications/123456'
zoneId:
description: Identifier of zone
type: string
example: zone01
numberOfUsersZoneThreshold:
description: >-
Threshold number of users in a zone which if crossed shall cause a
notification.
type: integer
format: uint32
example: '40'
numberOfUsersAPThreshold:
description: >-
Threshold number of users in an access point which if crossed shall
cause a notification.
type: integer
format: uint32
example: '20'
operationStatus:
description: >-
List of operation status values to generate notifications for (these
apply to all access points within a zone).
type: array
items:
description: The operation status of the access point
type: string
example: Serviceable