~~NOTOC~~
~~Title: GET list~~
====== GET /wakeup/list ======
Return list of wakeup calls. Function defaults to return all calls during specified time period.

|Authentication|Required|
|URI Path|/rest/wakeup/list/<optional parameter>|
|Version|6.1.0|

=== Method Parameters ===
^ Parameter ^ Required ^ Type ^ Description ^
| answered | no | string | List only answered wakeup calls. |
| failed | no | string | List only failed wakeup calls. |
| pending | no | string | List only pending wakeup calls. |
| today | no | string | Return all answered, failed, and pending wakeup calls for current day. |

=== Query Parameters ===
^ Parameter ^ Type ^ Description ^
| end | string | Date to end search. Formatted as YYYYMMDDHHMM. This field is optional and will be set to the end of the current day if not specified.|
| start | string | Start date to search from. Formatted as YYYYMMDDHHMM. If not specified default is current day starting at 00:00. |
| room | string | Room number to return results for only. |

=== Resource Errors ===
^ HTTP Code ^ Description ^
| 200 | Success. |
| 401 | Not authorized. |
| 404 | No wakeup calls found. |
| 405 | Method specified is not supported. |

=== Response Parameters ===
^ Name ^ Type ^ Description ^
| answered | array | All answered wakeup calls. |
| failed | array | All failed wakeup calls. |
| pending | array | All pending wakeup calls. |
| wakeups | array | Only specified if no parameter is given. |

== answered, failed, pending and wakeups ==
| action | int | Action performed for this entry. \\ -1 Unknown action type - update conversion failed to determine correct action ID. \\ 0 Schedule a wakeup call. \\ 1 Cancel a wakeup call. \\ 2 Wakeup call attempt (call guest). \\ 3 Wakeup call attempt (call operator). \\ 4 End wakeup call to operator alert due to max call attempts. \\ 5 End wakeup call to guest due to max call attempts. \\ 6 Purge all wakeup calls at checkout. \\ 7 Purge all wakeup calls due to mailbox reset from Mailbox Administration. \\ 8 Schedule an operator alert. \\ 9 Send an operator alert email. \\ 10 Alert operator call attempt. |
| actor | string | User who created or last edited the wakeup call. |
| count | int | Number of attempts performed. |
| date | string | Date the wakeup is scheduled for. |
| firstname | string | First name of guest within room at the time. |
| id | string | Wakeup ID. |
| line | int | Line number action was performed on. |
| lastName | string | Last name of the guest within room at the time. |
| notes | string | Notes about the action. |
| prompt | int | Prompt number to be played by the system. |
| result | int | Result of the last attempt. \\ -1 Unknown, typically has not been attempted yet. \\ 0 Wakeup call performed successfully. \\ 1 Call answered and finished. \\ 2 Call answered; guest opted to snooze the call. \\ 3 Call not answered: No answer (RNA). \\ 4 Call not answered: Busy. \\ 5 Call not answered: Covered to voice mail. \\ 6 Call failed:  No ring or no dialtone on the line. \\ 7 Call failed:  Invalid number (operator intercept or fax tone). \\ 8 Call canceled. \\ 9 All active calls purged and log entries marked as archived. \\ 10 Scheduling attempt failed. \\ 11 Call halted due to exceeding the max number of call attempts allowed. |
| room | string | Room wakeup call has been scheduled for. |
| source | int | Source of the wakeup call. \\ 0 Guest. \\ 1 Administrator via the telephone. \\ 2 Administrator via Mailbox Administration. \\ 3 FrontDesk. \\ 4 InnDesk. \\ 5 Property Management System (PMS). \\ 6 System, typically an auto-scheduled wakeup call. \\ 7 DuVoice REST API. \\ 8 Test application. Typically only used during installation. |
| status | int | Current status of the wakeup call. \\ -4 Failed wakeup call, alert staff failed. \\ -3 Failed wakeup call, alert staff succeeded. \\ -2 Failed wakeup call, alert staff in progress. \\ -1 Failed. \\ 0 Pending wakeup call. \\ 1 Active wakeup call (in progress). \\ 2 Wakup call was answered (success). \\ 3 Wakeup call was canceled. \\ 4 Failed wakeup call was acknowledged by staff. |
| tenant | string | Tenant ID of the mailbox the wakeup call has been scheduled for. |
| time | string | Time the wakeup calls is to be performed in 24 hour format. |
| timestamp | string | Time of log entry. In YYYYMMDDHHMMSSmmm format. |

=== Examples ===

  GET /rest/wakeup/list

== Response ==
<code YAML>
{
  "answered" : [
  ],
  "failed" : [  
  ],
  "pending" : [
      "actor" : "sampson",
      "attempts" : 0,
      "created" : "2017-05-12T09:03:00-07:00",
      "daily" : false,
      "id" : "85923ae8-372c-11e7-ba1c-902b34db254e",
      "prompt" : 1668,
      "result" : -1,
      "room" : "7101",
      "scheduled" : "2017-05-13T08:01:00-07:00",
      "snoozes" : 0,
      "source" : 4,
      "status" : 0,
      "tenant" : "288e1ab6-2f5b-11e7-b2a7-902b34db254e"
    },
    {
      "actor" : "sampson",
      "attempts" : 0,
      "created" : "2017-05-12T08:36:00-07:00",
      "daily" : false,
      "id" : "b3f188f2-3728-11e7-b851-902b34db254e",
      "prompt" : 1668,
      "result" : -1,
      "room" : "7101",
      "scheduled" : "2017-05-13T08:00:00-07:00",
      "snoozes" : 0,
      "source" : 4,
      "status" : 0,
      "tenant" : "288e1ab6-2f5b-11e7-b2a7-902b34db254e"
    },
    {
      "actor" : "sampson",
      "attempts" : 0,
      "created" : "2017-05-12T09:12:00-07:00",
      "daily" : false,
      "id" : "bc465226-372d-11e7-9fc1-902b34db254e",
      "prompt" : 1668,
      "result" : -1,
      "room" : "7101",
      "scheduled" : "2017-05-13T08:03:00-07:00",
      "snoozes" : 0,
      "source" : 4,
      "status" : 0,
      "tenant" : "288e1ab6-2f5b-11e7-b2a7-902b34db254e"
    }
  ]
}
</code>