Newer
Older
2
3
4
5
6
7
8
9
10
11
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
"zonalTrafficSubscription": {
"description": "A type containing zonal traffic subscription",
"type": "object",
"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"
},
"callbackReference": {
"description": "Notification callback definition.",
"type": "object",
"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"
},
"interestRealm": {
"description": "Interest realms of access points within a zone (e.g. geographical area, a type of industry etc.).",
"type": "array",
"items": {
"description": "Interest realm of access point (e.g. geographical area, a type of industry etc.).",
"type": "string",
"example": "LA"
}
},
"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": {
"description": "User event",
"type": "string",
"enum": [
"Entering",
"Leaving",
"Transferring"
],
"example": "Entering"
}
},
"duration": {
"description": "Period (in seconds) of time notifications are provided for. If set to \"0\" (zero), a default duration time, which is specified by the service policy, will be used. If the parameter is omitted, the notifications will continue until the maximum duration time, which is specified by the service policy, unless the notifications are stopped by deletion of subscription for notifications. This element MAY be given by the client during resource creation in order to signal the desired lifetime of the subscription. The server MUST return in this element the period of time for which the subscription will still be valid.",
"type": "string",
"example": "0"
},
"resourceURL": {
"description": "Self referring URL.",
"type": "string",
"format": "uri",
"example": "http://example.com/exampleAPI/location/v1/subscriptions/userTracking/subscription123"
}
}
}
}