The "other" data type allows for the integration of generic event data into the Solink platform, accommodating a broad range of applications beyond the predefined retail and restaurant categories.
Metadata Fields (required)
dataType (string): Specifies the object format. Must be "other".
schemaVersion (string): Indicates the schema version. Set to "1".
startTime (integer): Event start time in Unix time format or ISO time format.
locationId (string): ID of the event location, configured in the Solink system.
dataSourceId (string): ID of the data source, configured in the Solink system.
eventUniqueId (string): A unique ID for the event, unique per location.
eventType (string): Descriptive text of the event.
Metadata Fields (optional)
endTime (integer): Event end time in Unix time format or ISO time format.
eventDetails (string): Additional searchable information about the event.
employeeId (string): ID of the involved employee.
employeeName (string): Name of the involved employee.
status (string): Status of the event.
items (array): List of items related to the event, with fields:
type (string): Item type.
quantity (number): Quantity of the item, defaults to 1.
description (string): Description of the item.
time (integer): Specific time for the item in Unix time format, defaults to event's start time.
JSON Example
Below is an example of how the "other" data type could be structured in JSON format for submission:
{
"dataType": “other”, // determines which object format is being used
"schemaVersion": "1", // specifies which schema version is being used for this event, should be "1"
"startTime": 1557943653649, // start time in unix time format (milliseconds since jan 1 1970). also supports ISO time format (2023-10-21T14:00:12-0400)
"endTime": 1557943678649, // optional, end time in unix time format (milliseconds since jan 1 1970). also supports ISO time format (2023-10-21T14:00:12-0400)
"locationId": "123", // ID of the location for this data, needs to be configured on the associated Solink system
"dataSourceId": "1", // ID of the data source for this data, needs to be configured on Solink system (for camera associations)
"eventUniqueId": "93688-START", // ID of the event, needs to be unique per location
"eventType": "Start Batch", // some description of the event
"eventDetails": "Additional Details", // optional, include any additional information that needs to be searchable
"employeeId": "27", // optional, ID of the employee doing the transaction
"employeeName": "MICHELLE", // optional, name of the Employee doing the transaction
"status": “START”, // optional, Type of event status.
"items": [ // optional, list of items included in the transaction
{
"type": "", // type of item
"quantity": 1.0, // quantity of the current item, defaults to 1 if not specified
"description": "", // description of the item
"time": 1555898203000 // optional, used to specify item time, otherwise will default to start time
}
]
}