GET /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.
This resource will represent 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 :
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.
To address the raw value of a primitive property, clients append a path segment containing the string $value to the property URL.
To use this query option you need to use the classic resource and add the element name you want to print followed by the query string name.
Be careful, the parameter query string is used in the URL and is not like other parameters.
The $select system query option allows clients to request a limited set of properties for each entity.
The value pass in the parameter can be:
*"(star): This will show all child elements.," (comma).If there is no value after the select query option, the parameter will be ignored. All the values that are not specified will not be printed in the response.
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.
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 | empty | An array of TimeValue object. | GET POST |
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"
}
]
},
{
"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"
}
]
},
{
"timeValues": []
},
{
"timeValues": []
},
{
"timeValues": []
},
{
"timeValues": []
},
{
"timeValues": []
}
],
"asnValue": "DrQIAAAAkQK0CQAAAAC0DgAAAJEEtBAAAAAADw60CAAAAJECtAkAAAAAtA4AAACRBLQQAAAAAA8ODw4PDg8ODw4P",
"isArray": false,
"implementation": "",
"name": "weeklySchedule"
}
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>
<Name>weeklySchedule</Name>
<IsArray>false</IsArray>
<Implementation />
<AsnValue>
DrQIAAAAkQK0CQAAAAC0DgAAAJEEtBAAAAAADw60CAAAAJECtAkAAAAAtA4AAACRBLQQAAAAAA8ODw4PDg8ODw4P
</AsnValue>
<Value>
<DailySchedule>
<TimeValues>
<TimeValue>
<Time>08:00:00.00</Time>
<Type>enumerated</Type>
<Value>2</Value>
</TimeValue>
<TimeValue>
<Time>09: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>09: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 />
</DailySchedule>
<DailySchedule>
<TimeValues />
</DailySchedule>
<DailySchedule>
<TimeValues />
</DailySchedule>
<DailySchedule>
<TimeValues />
</DailySchedule>
<DailySchedule>
<TimeValues />
</DailySchedule>
</Value>
</BacnetProperty>