| Name | Description | Details |
|---|---|---|
| deviceId | string | -Device IDs are globally unique, must be 50 or less characters long, and must not contain '/', '%', '#', or '+' characters. | -
| authToken | -boolean | Standard SSL only supports one-way authentication.
- The Care Daily AI Platform takes security a leap forward by allowing the use of an optional cryptographic authentication token to be used for bi-directional authentication of a device.
- If requested, your device will be responsible for securely storing the generated authentication token and including it in all future HTTP requests to the Care Daily AI Platform. - true - Request an authentication token - false - Do not use an authentication token |
-
| startDate | In milliseconds or ISO 8601 | -The absolute date timestamp when the device is registered to the user's account. - The Care Daily AI Platform will not store any data from a device before its registration time. - For example, if you have historical data from this device that you want associated with the user's account, - then the registration time should be set in the past to be able to store all that historical data. - The default start time is the current time on the server. | -
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | integer | Question ID assigned by the system | ||||||||||||
| key | string | -Unique key to identify this context of this question later, regardless of the description or language of the question itself. | ||||||||||||
| appInstanceId | integer | The bot instance ID, that asks the question. | ||||||||||||
| creationDateMs | milliseconds | Creation timestamp | ||||||||||||
| question | string | The actual text of the question to ask. | ||||||||||||
| placeholder | string | A placeholder for this question. | ||||||||||||
| editable | boolean | -If the message is editable, then that means it will show up in a place in the bot where the user can reconfigure the question later. - This is typically used by bots to enable a UI for settings to configure the bot through questions. | ||||||||||||
| responseType | integer | The type of question (see below) | ||||||||||||
| displayType | integer | -Application-layer display type for each type of question (for example, yes/no vs. on/off switch, or a slider that shows integers vs. a slider that shows minutes:seconds) | ||||||||||||
| deviceId | string | Name of the device ID referenced by this question, if any. | ||||||||||||
| icon | string | Icon to show next to the question, if any. | ||||||||||||
| media | string | Reference to some kind of S3 media to play/associate with the question. | ||||||||||||
| defaultAnswer | string | Pre-populated default values for question responses, or force-change the user's response. | ||||||||||||
| answerFormat | string | Regular expression to validate answer format in UI. | ||||||||||||
| slider | structure | -
-
| ||||||||||||
| sectionTitle | string | The title of a group of questions | ||||||||||||
| sectionId | integer | The ID of a group of questions, and the order in which to display this group | ||||||||||||
| questionWeight | integer | The position of a single question within a group. The higher the weight, the lower down on the list the question appears relative to other questions | ||||||||||||
| status | integer | -Question status:
- 0 - replaced by a new question (of the same key) - 2 - available, waiting for an answer - 3 - skipped, the user is going to answer it later - 4 - answered - 5 - no answer, the user is not going to answer on it - | ||||||||||||
| answerStatus | integer | The same as status (used for backward compatibility) | ||||||||||||
| answer | string | User's answer:
- * Boolean: 0 = No, 1 = Yes
- * Multi-choice Single-select: ID of the radio button
- * Multi-choice Multi-select: Bitmask representing response options
- * Slider value
- * Text entered by the user
-
- Days of the week are represented by a bitmask:
-
- 1 - Sunday (1 << 0) - 2 - Monday (1 << 1) - 4 - Tuesday (1 << 2) - 8 - Wednesday (1 << 3) - 16 - Thursday (1 << 4) - 32 - Friday (1 << 5) - 64 - Saturday (1 << 6) - | ||||||||||||
| answerDate | string | When the user has answered this question. | ||||||||||||
| answerModified | boolean | Indicate if the original answer has been modified by other user. | ||||||||||||
| collectionName | string | The name of collection the question belongs to (can be null). |
| Response Type ID | Name | Display Type Definitions |
|---|---|---|
| 1 | Boolean 0 = False 1 = True |
- 0 = On/Off Switch - default. - 1 = Yes/No. - 2 = Single 'Yes' button only, the question's default value is applied to the button's text. Used to trigger bot actions from the UI. - 3 = Thumbs-up / Thumbs-down - The answer is a 0 or 1. |
| 2 | Multiple choice - Single select | -0 = Radio buttons - default. - A list of radio buttons. Requires the "responses" array to list the possible responses. - Users can only select one response. Available for anonymous aggregated public reporting. - 1 = Drop-down list / Picker. - A drop down list. Same as radio buttons, but can contain more items. - 2 = Slider. - Slider UI view with predefined stops as an options. - 3 = Modal Bottom Action Sheet. - Multiple-choice buttons that slide up from the bottom of the screen. - The answer is the ID of the response option. |
| 4 | Multiple choice - Multiple select | -A list of checkbox options. Requires the "responses" array to list the possible responses.
- Users can select multiple responses. Available for anonymous aggregated public reporting. - The answer is a bitmask of selected choices. |
| 6 | Day of the week | Day of the week input.
- The UI can optimize itself for selecting days of the week [Sun][XXX][Tue][Wed][Thu][XXX][Sat]. - 0 = Select multiple days simultaneously. - 1 = Pick a single day only. - The answer is a bitmasked value, days can be logically-OR'd together to specify multiple days of the week, ranging from SUN=0x1 to SAT=0x40. |
| 7 | Slider | -0 = Integer select - default. - Slider, with a defined minimum and maximum. - By default, minimum = 0 and maximum = 100. - 1 = Floating point select. - 2 = Minutes:Seconds. - Answer is the number selected. For time, the answer is in integer seconds. |
| 8 | Time in seconds since midnight | -0 = hours:minutes:seconds (am|pm) - default. - This accesses the native UI method of declaring a time. - 1 = hours:minutes (am|pm). - The answer is in integer seconds since midnight. |
| 9 | Date and Time in ISO 8601 | -0 = Date and time. - 1 = Date only. - The answer is in ISO 8601 format, `YYYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]` |
| 10 | Text box | -Open-ended question. - For example, if you were to ask, "Who just walked by the camera?" - The answer is a string of text. |
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | integer | Question ID assigned by the system | ||||||||||||
| key | string | +Unique key to identify this context of this question later, regardless of the description or language of the question itself. | ||||||||||||
| appInstanceId | integer | The bot instance ID, that asks the question. | ||||||||||||
| creationDateMs | milliseconds | Creation timestamp | ||||||||||||
| question | string | The actual text of the question to ask. | ||||||||||||
| placeholder | string | A placeholder for this question. | ||||||||||||
| editable | boolean | +If the message is editable, then that means it will show up in a place in the bot where the user can reconfigure the question later. + This is typically used by bots to enable a UI for settings to configure the bot through questions. | ||||||||||||
| responseType | integer | The type of question (see below) | ||||||||||||
| displayType | integer | +Application-layer display type for each type of question (for example, yes/no vs. on/off switch, or a slider that shows integers vs. a slider that shows minutes:seconds) | ||||||||||||
| deviceId | string | Name of the device ID referenced by this question, if any. | ||||||||||||
| icon | string | Icon to show next to the question, if any. | ||||||||||||
| media | string | Reference to some kind of S3 media to play/associate with the question. | ||||||||||||
| defaultAnswer | string | Pre-populated default values for question responses, or force-change the user's response. | ||||||||||||
| answerFormat | string | Regular expression to validate answer format in UI. | ||||||||||||
| slider | structure | +
+
| ||||||||||||
| sectionTitle | string | The title of a group of questions | ||||||||||||
| sectionId | integer | The ID of a group of questions, and the order in which to display this group | ||||||||||||
| questionWeight | integer | The position of a single question within a group. The higher the weight, the lower down on the list the question appears relative to other questions | ||||||||||||
| status | integer | +Question status:
+ 0 - replaced by a new question (of the same key) + 2 - available, waiting for an answer + 3 - skipped, the user is going to answer it later + 4 - answered + 5 - no answer, the user is not going to answer on it + | ||||||||||||
| answerStatus | integer | The same as status (used for backward compatibility) | ||||||||||||
| answer | string | User's answer:
+ * Boolean: 0 = No, 1 = Yes
+ * Multi-choice Single-select: ID of the radio button
+ * Multi-choice Multi-select: Bitmask representing response options
+ * Slider value
+ * Text entered by the user
+ Days of the week are represented by a bitmask:
+
+ 1 - Sunday (1 << 0) + 2 - Monday (1 << 1) + 4 - Tuesday (1 << 2) + 8 - Wednesday (1 << 3) + 16 - Thursday (1 << 4) + 32 - Friday (1 << 5) + 64 - Saturday (1 << 6) + | ||||||||||||
| answerDate | string | When the user has answered this question. | ||||||||||||
| answerModified | boolean | Indicate if the original answer has been modified by other user. | ||||||||||||
| collectionName | string | The name of collection the question belongs to (can be null). |
| Response Type ID | Name | Display Type Definitions |
|---|---|---|
| 1 | Boolean 0 = False 1 = True |
+ 0 = On/Off Switch - default. + 1 = Yes/No. + 2 = Single 'Yes' button only, the question's default value is applied to the button's text. Used to trigger bot actions from the UI. + 3 = Thumbs-up / Thumbs-down + The answer is a 0 or 1. |
| 2 | Multiple choice - Single select | +0 = Radio buttons - default. + A list of radio buttons. Requires the "responses" array to list the possible responses. + Users can only select one response. Available for anonymous aggregated public reporting. + 1 = Drop-down list / Picker. + A drop down list. Same as radio buttons, but can contain more items. + 2 = Slider. + Slider UI view with predefined stops as an options. + 3 = Modal Bottom Action Sheet. + Multiple-choice buttons that slide up from the bottom of the screen. + The answer is the ID of the response option. |
| 4 | Multiple choice - Multiple select | +A list of checkbox options. Requires the "responses" array to list the possible responses.
+ Users can select multiple responses. Available for anonymous aggregated public reporting. + The answer is a bitmask of selected choices. |
| 6 | Day of the week | Day of the week input.
+ The UI can optimize itself for selecting days of the week [Sun][XXX][Tue][Wed][Thu][XXX][Sat]. + 0 = Select multiple days simultaneously. + 1 = Pick a single day only. + The answer is a bitmasked value, days can be logically-OR'd together to specify multiple days of the week, ranging from SUN=0x1 to SAT=0x40. |
| 7 | Slider | +0 = Integer select - default. + Slider, with a defined minimum and maximum. + By default, minimum = 0 and maximum = 100. + 1 = Floating point select. + 2 = Minutes:Seconds. + Answer is the number selected. For time, the answer is in integer seconds. |
| 8 | Time in seconds since midnight | +0 = hours:minutes:seconds (am|pm) - default. + This accesses the native UI method of declaring a time. + 1 = hours:minutes (am|pm). + The answer is in integer seconds since midnight. |
| 9 | Date and Time in ISO 8601 | +0 = Date and time. + 1 = Date only. + The answer is in ISO 8601 format, `YYYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]` |
| 10 | Text box | +Open-ended question. + For example, if you were to ask, "Who just walked by the camera?" + The answer is a string of text. |
| Request | Description | Details |
|---|---|---|
| Request | Type | Description |
| name | string | Name of the location (i.e. "My House" or "Upstairs Bedroom") |
| type | numeric |
10 - Residence @@ -20975,7 +20093,8 @@ tags: See the Date and Time Formats for more details. |
| appName | string | App name used to create this location |
| language | string | Preferred language for location states and narratives |
| externalId | string | Location's ID in partner's cloud |
| externalId | string | Single location's ID in partner's cloud |
| externalLocations | array | Array of partner identifiers of this location. |
| locationUser | object | User properties on the location |
| fileUploadPolicy | integer | 0 - Keep old files @@ -21001,21 +20120,19 @@ tags: |
| latitude | string | The latitude in degrees |
| longitude | string | The longitude in degrees |
| test | boolean | This is a test location. |
| codeType | integer | Location code type |