Reminders
Retrieves a list of reminders associated with your employees or company.
Table Specific Information
Select
Query the Reminders table. The driver will use the TSheets API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the driver.
- Id and UserId fields support the '=' and IN operators.
- ReminderType field and ActiveStatus filter support the '=' operator.
- LastModified field supports the <=,<,>=,>,= operators.
For example, the following queries are processed server side:
SELECT * FROM Reminders WHERE Id IN (72595, 72599) AND UserId = 37 SELECT * FROM Reminders WHERE ReminderType = 'clock-in'
Insert
Insert can be executed by specifying UserId, ReminderType, DueTime, DueDaysOfWeek, DistributionMethods, Active and Enabled columns. The columns that are not required can be inserted optionally. Following is an example of how to insert into this table
INSERT INTO Reminders (UserId,ReminderType,DueTime,DueDaysOfWeek,DistributionMethods,Active,Enabled) VALUES ('37','clock-in','08:10:00','Mon,Tue,Sat','Push','true','true')
Update
Update can be executed by specifying the Id in the WHERE Clause. The columns that are not read-only can be Updated.
For example:
UPDATE Reminders SET DueTime = '08:10:00', DistributionMethods = 'Email' WHERE Id = '10055'
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | Integer | True |
Id of the reminder. |
| UserId | Integer | True |
User id for the user that this reminder pertains to. 0 indicates that this is a company-wide reminder. |
| ReminderType | String | True |
The type of this reminder object. Supported reminder_types are 'clock-in' and 'clock-out'. |
| DueTime | String | False |
The 24-hour time that the reminder should be sent, expressed as 'hh:mm:ss'. |
| DueDaysOfWeek | String | False |
A comma-separated list of the days of the week when the reminder should be sent. The value can be any combination of 'Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri' and 'Sat'. |
| DistributionMethods | String | False |
The message text of the notification. The maximum message length is 2000 characters. |
| Active | Boolean | False |
If true, this reminder is active and will be evaluated at the 'due_time' and 'due_days_of_week'. If false, this reminder is inactive and will not be evaluated. If active=false for user-specific reminders, then the company-wide reminder of the same reminder type will apply. |
| Enabled | Boolean | False |
If true, the reminder is enabled and will be sent at the 'due_time' and 'due_days_of_week'. If false, the reminder is disabled and will not be sent. A user with an active (active = true), but disabled (enabled = false) reminder will not receive that reminder type regardless of how company-wide reminders are configured. |
| Created | Datetime | True |
Date/time when this reminder was created |
| LastModified | Datetime | True |
Date/time when this reminder was last modified, |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| ActiveStatus | String |
Filter column for whether to fetch only active records, only archived records, or both. By default, only active records are fetched. Possible values are: yes, no, both |