POST /protocols/bacnet/local/objects/schedule/{objectInstance}/properties/weekly-schedule
FROM API REVISION 6.0
This resource is used to initialize a Weekly Schedule of a BACnet Schedule object.
The resource posted has to be a BacnetProperty object.
The value property of this object is an Array of DailySchedule.
It can contain up to 7 DailySchedule object.
The objects will follow this order :
If more than 7 objects are sent, the surplus will be discarded.
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
There are multiple possible values according the resource:
If this parameter is not present during the request, and error 415 Unsupported Media Type will be thrown.
This is the instance of a specific BACnet object type.
The Content-Length entity-header field indicates the size of the entity-body.
Object Name: BacnetProperty
| Property Name | Type | Description | Method |
|---|---|---|---|
| Name | String | This property is the name of the BACnet property. | GET |
| IsArray | Boolean | This property indicates if the BACnet property is an array or not. | GET |
| Implementation | String | GET | |
| AsnValue | String | This property is the ASN value of a BACnet property encoded in Base64. | GET |
| Value required |
String | This property is the readable value of a BACnet property. According the BACnet property, it's possible the type of this property vary. (See the description of the resource for more details) |
GET POST |
Object Name: TimeValue
| Property Name | Type | Description | Method |
|---|---|---|---|
| Value required |
Integer | This is the value of the TimeValue object The type of this property will depend of the Type property value.If the type property is : - Enumerated or Numeric : The type will be integer. - Boolean : The type will be boolean. - Null : The type will be null (empty in XML and null in JSON : See example). |
GET POST |
| Type required |
String | Possible values : - enumerated - boolean - numeric - null |
GET POST |
| Time required |
String | This is the time value. It can follow two formats: - 08:00 - 08:00:00.00 |
GET POST |
Object Name: DailySchedule
| Property Name | Type | Description | Method |
|---|---|---|---|
| TimeValues optional |
Array <TimeValues> |
An array of TimeValue object. | POST GET |
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/local/objects/schedule/1/properties/weekly-schedule
{
"value": [
{
"timeValues": [
{
"value": 2,
"type": "enumerated",
"time": "08:00:00.00"
},
{
"value": null,
"type": "null",
"time": "09:00:00.00"
},
{
"value": 4,
"type": "enumerated",
"time": "14:00:00.00"
},
{
"value": null,
"type": "null",
"time": "16:00:00.00"
}
]
}
]
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/local/objects/schedule/1/properties/weekly-schedule
<?xml version="1.0" encoding="utf-8"?>
<BacnetProperty>
<Value>
<DailySchedule>
<TimeValues>
<TimeValue>
<Time>08:00:00.00</Time>
<Type>enumerated</Type>
<Value>2</Value>
</TimeValue>
<TimeValue>
<Time>9:00:00.00</Time>
<Type>null</Type>
<Value />
</TimeValue>
<TimeValue>
<Time>14:00:00.00</Time>
<Type>enumerated</Type>
<Value>4</Value>
</TimeValue>
<TimeValue>
<Time>16:00:00.00</Time>
<Type>null</Type>
<Value />
</TimeValue>
</TimeValues>
</DailySchedule>
<DailySchedule>
<TimeValues>
<TimeValue>
<Time>08:00:00.00</Time>
<Type>enumerated</Type>
<Value>2</Value>
</TimeValue>
<TimeValue>
<Time>9:00:00.00</Time>
<Type>null</Type>
<Value />
</TimeValue>
<TimeValue>
<Time>14:00:00.00</Time>
<Type>enumerated</Type>
<Value>4</Value>
</TimeValue>
<TimeValue>
<Time>16:00:00.00</Time>
<Type>null</Type>
<Value />
</TimeValue>
</TimeValues>
</DailySchedule>
</Value>
</BacnetProperty>