SmartSense report API
SmartSense provides a set of endpoints for generating report information.
Report Specific Types
The SmartSense Report API defines the following types:
Numbers
TaskSelectionType
TaskSelectionType describes the type of task selection. This type has four values:
0: None
1: Fixed
2: Randomized
3: Dynamic
The Fixed type means that all tasks in the checklist must be completed by the designated type. The Randomized type is a Fixed-type checklist with the items in a random order. The _Dynamic type means that a specified number of tasks must be completed. E.g., if there are 12 listed tasks, the user may only have to complete 6 of the 12.
TaskType
TaskType describes the task. This type has 10 values:
0: Manual Temperature
1: Sensor Temperature
2: Probe Temperature
3: Manual Number
4: Manual Text
5: Select Single
6: Select Many
7: Picture
8: Checkbox
9: Asset Sensor Reading
Enums
Fields that are enums are returned as strings in JSON. The string value will be limited to the possible enum values as defined for the type. All enum types have the possibility of being null.
AnswerStatus
Specifies the type of reading. Values:
"Incomplete"
"Complete"
"CompletedNotApplicable"
"RequiresFollowUp"
"CompletedWithCorrectiveAction"
The Incomplete status means that the user has not yet responded to the task. The Complete status means that the user provided a response to a task and that the task has a value associated, e.g., the user used a temperature probe to take a temperature or inputted the temperature manually. The CompletedNotApplicable status means that the user responded to a task, but it was not necessary to provide a value. The RequiresFollowUp status means that the user has missed follow-up tasks that still need to be completed. The CompletedWithCorrectiveAction status means that the task was completed and performed at least one associated corrective action.
TaskClass
Specifies the class of a task. Values:
"FoodStep"
"Task"
The FoodStep class indicates that the task relates to a specific food item, e.g., checking the temperature of cooked chicken. The Task class indicates that the task does not relate to a specific food item, e.g., checking the SmartSense web application for any new incidents.
Interactive API Documentation
For detailed endpoint documentation and the ability to test API calls directly, visit our Swagger documentation:
The Swagger interface provides:
- Complete endpoint specifications
- Request and response schemas
- Interactive API testing
- Real-time examples