Create a wakeup call.
Authentication | Required |
URI Path | /rest/wakeup |
Version | 6.1.0 |
Method Parameters
Parameter | Required | Type | Description |
none |
Post Parameters
Parameter | Type | Description |
room | string | Room number or CSV to create wakeup call for. |
datetime | date | Date and time for wakeup call in ISO8601 format Use this field or date and time fields but NOT both. |
date | string | Date for the wakeup call. Default is current day. Formatted as YYYYMMDD. |
daily | bool | Should wakeup call be performed daily. This can be expressed as 0, 1, true, or false. Default is false. |
time | string | Time for wakeup call. Formatted as HHMM. |
Resource Errors
HTTP Code | Description |
200 | Success. |
401 | Not authorized. |
404 | Room not found. |
405 | Method specified is not supported. |
Response Parameters
Name | Type | Description |
error | int | Error code. |
description | string | Description of the error code. |
id | string | Unique wakeup call id if created. |
Example
POST /rest/wakeup
room=7101&date=20170513&time=0800
Response
{
"description" : "OK",
"error" : 0,
"id" : "b3f188f2-3728-11e7-b851-902b34db254e"
}