-
Notifications
You must be signed in to change notification settings - Fork 29
/
IASZoneInfoResURI.swagger.json
200 lines (200 loc) · 7 KB
/
IASZoneInfoResURI.swagger.json
1
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
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
{
"swagger": "2.0",
"info": {
"title": "IAS Zone Info",
"version": "2019-05-13",
"license": {
"name": "OCF Data Model License",
"url": "https://github.com/openconnectivityfoundation/core/blob/e28a9e0a92e17042ba3e83661e4c0fbce8bdc4ba/LICENSE.md",
"x-copyright": "Copyright 2019 Open Connectivity Foundation, Inc. All rights reserved."
},
"termsOfService": "https://openconnectivityfoundation.github.io/core/DISCLAIMER.md"
},
"schemes": ["http"],
"consumes": ["application/json"],
"produces": ["application/json"],
"paths": {
"/IASZoneInfoResURI" : {
"get": {
"description": "This Resource describes information associated with an Intruder Alert System (IAS) Zone.\nZone Type provides the information about the type of device/alarm.\nZone Status provides an array which has 10 items representing various status information(e.g., battery status, mode, alarm (Up to two), supervision of IAS network, etc.\nA Device implementing this Resource can be enrolled to IAS Control and Indicator Equipment (CIE). IAS CIE can allocate an ID for the Device and update this Resource on the Device.\nThis Resource may provide multiple sensitivity levels (>2). NumberofZoneSensitivityLevelSupported provides the number of the levels. A specific level can be selected as currentzonesensitivityLevel.",
"parameters": [
{"$ref": "#/parameters/interface-all"}
],
"responses": {
"200": {
"description" : "",
"x-example":
{
"rt": ["oic.r.iaszoneinfo"],
"zonetype": "motionsensor",
"zonestatus": {
"alarms": ["presence"],
"tamper": false,
"zonestatusreports": "statuschangeonly",
"fault": false,
"test": false
},
"iascieaddress": "ACDE9F56A3FE6B98",
"zonestate": true,
"zoneid": 64,
"numzonesensitivitylevel": 3,
"currentzonesensitivitylevel": 2
},
"schema": { "$ref": "#/definitions/IASZoneInfo" }
}
}
},
"post": {
"description": "Sets the current sensitivity level of the IASZone.\n",
"parameters": [
{"$ref": "#/parameters/interface-rw"},
{
"name": "body",
"in": "body",
"required": true,
"schema": { "$ref": "#/definitions/IASZoneInfo-Update" },
"x-example":
{
"currentzonesensitivitylevel": 3
}
}
],
"responses": {
"200": {
"description" : "Success path response code\n"
}
}
}
}
},
"parameters": {
"interface-all" : {
"in" : "query",
"name" : "if",
"type" : "string",
"enum" : ["oic.if.rw", "oic.if.baseline"]
},
"interface-rw" : {
"in" : "query",
"name" : "if",
"type" : "string",
"enum" : ["oic.if.rw"]
}
},
"definitions": {
"IASZoneInfo" : {
"properties": {
"rt" : {
"description": "Resource Type",
"items": {
"type": "string",
"enum": ["oic.r.iaszoneinfo"]
},
"minItems": 1,
"readOnly": true,
"type": "array"
},
"zonestate" : {
"description": "The IAS zone state. True = enrolled, False = not enrolled.",
"readOnly": true,
"type": "boolean"
},
"zonestatus" : {
"description": "Set of alarm indicators.",
"properties": {
"alarms": {
"type": "array",
"description": "Array of alarms. The alarms exposed are dependent on the zonetype.",
"readOnly": true,
"minItems": 1,
"maxItems": 2,
"items": {
"type": "string",
"enum": ["system","intrusion","presence","1stportalopenclose","2ndportalopenclose","fire","wateroverflow","CO","cooking","fall","emergencybutton","movement","vibration","panic","emergency","glassbreak"]
}
},
"zonestatusreports": {
"description": "Controls the generation of status indications",
"type": "string",
"enum": ["none","statuschangeonly","alarmclearonly","statuschangeandalarmclear"]
},
"tamper": {
"description": "Tamper status. True = tampered, False = not tampered.",
"readOnly": true,
"type": "boolean"
},
"test": {
"description": "Test mode indicator. True = sensor is in test mode, False = sensor is in operational mode",
"readOnly": true,
"type": "boolean"
},
"fault": {
"description": "Fault indicator. True = fault detected, False = no fault detected",
"readOnly": true,
"type": "boolean"
}
},
"readOnly": true,
"type": "object"
},
"numzonesensitivitylevel" : {
"description": "Number of supported zone sensitivity levels",
"minimum": 2,
"readOnly": true,
"type": "integer"
},
"zoneid" : {
"description": "ID allocated by the IAS CIE",
"readOnly": true,
"type": "integer"
},
"iascieaddress" : {
"description": "EUI-64 Address of the enrolled IAS Control and Indicating Equipment (CIE)",
"readOnly": true,
"type": "string"
},
"zonetype" : {
"description": "IAS zone type. See OCF enumeration map for set of valid values.",
"readOnly": true,
"type": "string"
},
"currentzonesensitivitylevel" : {
"description": "Current zone sensitivity level",
"minimum": 0,
"type": "integer"
},
"n": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/n"
},
"id": {
"$ref": "https://openconnectivityfoundation.github.io/core/schemas/oic.common.properties.core-schema.json#/definitions/id"
},
"if" : {
"description": "The OCF Interface set supported by this Resource",
"items": {
"enum": [
"oic.if.rw",
"oic.if.baseline"
],
"type": "string"
},
"minItems": 2,
"maxItems": 2,
"readOnly": true,
"type": "array"
}
},
"required": ["zonetype", "zonestate", "zonestatus", "zoneid", "iascieaddress"]
},
"IASZoneInfo-Update" : {
"properties": {
"currentzonesensitivitylevel" : {
"description": "Current zone sensitivity level, Client can only set 1 or higher.",
"minimum": 1,
"type": "integer"
}
},
"required": ["currentzonesensitivitylevel"]
}
}
}