POST /protocols/bacnet/local/objects/calendar/{objectInstance}/properties/date-list
FROM API REVISION 6.0
The resource posted has to be a BacnetProperty object.
The value property of this object is an Array of CalendarEntry.
There is three type of CalendarEntry that can be created :
Those three types won't contain a TimeValues array.
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
| propertyName | 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: CalendarEntry
| propertyName | type | description | method |
|---|---|---|---|
| Type required |
String | Possible values : - SimpleDate - WeekAndDay - DateRange |
GET POST |
| SimpleDate required |
Object | This object contains a Date, a DayOfWeek and the TimeValues (the last one is optional : It depends of the use case). | GET POST |
| WeekAndDay | Object | GET POST |
|
| DateRange | Object | GET POST |
Object Name: SimpleDate
| propertyName | type | description | method |
|---|---|---|---|
| Date required |
String | This can be : - 2018-08-01 - 2018-08-* - 2018-*-* - *-*-* |
GET POST |
| DayOfWeek required |
String | This is the day of the week: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday - * (The number of star doesn’t matter) If a bad day is entered, the star(*) will be set. |
GET POST |
| TimeValues optional |
Array <TimeValue> |
An array of TimeValue object. | GET POST |
Object Name: WeekAndDay
| propertyName | type | description | method |
|---|---|---|---|
| DayOfWeek required |
String | This is the day of the week: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday - * (The number of star doesn’t matter) If a bad day is entered, the star(*) will be set. |
GET POST |
| TimeValues optional |
Array <TimeValue> |
An array of TimeValue object. | GET POST |
| Week required |
Integer | These are the numbers allowed: - 1 → days1to7 - 2 → days8to14 - 3 → days15to21 - 4 → days22to28 - 5 → days29to31 - 6 → last7days - 255 → any |
GET POST |
| Month required |
String | This can be: - January - February - March - April - May - June - July - August - September - October - November - December -*(The number of star doesn’t matter) If a bad Month is entered, the star(*) will be set. |
GET POST |
Object Name: DateRange
| propertyName | type | description | method |
|---|---|---|---|
| TimeValues required |
Array <TimeValue> |
An array of TimeValue object. | GET POST |
| StartDate required |
String | This can be : - 2018-08-01 - 2018-08-* - 2018-*-* - *-*-* |
GET POST |
| EndDate required |
String | This can be : - 2018-08-01 - 2018-08-* - 2018-*-* - *-*-* |
GET POST |
Url Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/local/objects/calendar/1/properties/date-list
{
"value": [
{
"type": "simpleDate",
"simpleDate": {
"date": "2024-2-1",
"dayOfWeek": "***"
}
},
{
"type": "dateRange",
"dateRange": {
"startDate": "2019-2-2",
"endDate": "2026-2-22"
}
},
{
"type": "weekAndDay",
"weekAndDay": {
"month": "August",
"dayOfWeek": "***",
"week": 1
}
}
]
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/bacnet/local/objects/calendar/1/properties/date-list
<?xml version="1.0" encoding="utf-8"?>
<BacnetProperty>
<Value>
<CalendarEntry>
<Type>simpleDate</Type>
<SimpleDate>
<Date>2024-2-1</Date>
<DayOfWeek>***</DayOfWeek>
</SimpleDate>
</CalendarEntry>
<CalendarEntry>
<Type>dateRange</Type>
<DateRange>
<StartDate>2019-2-2</StartDate>
<EndDate>2026-2-22</EndDate>
</DateRange>
</CalendarEntry>
<CalendarEntry>
<Type>weekAndDay</Type>
<WeekAndDay>
<DayOfWeek>***</DayOfWeek>
<Week>1</Week>
<Month>August</Month>
</WeekAndDay>
</CalendarEntry>
</Value>
</BacnetProperty>