Other Data Type Schema

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. Time is absolute and must adhere to the convention defined here.

Required Object Fields

Field	Type	Description
`dataSourceId`	String	Unique identifier of the data source generating the event.
`dataType`	String	Must be set to "other" to specify which data type the current event is.
`eventType`	String	Describes the type of event.
`eventUniqueId`	String	Unique id which identifies the event, unique per location.
`schemaVersion`	String	Must be set to "1" to specify which version of the schema is being used for this event (e.g. "1", "2", etc).
`siteExternalId`	String	Unique location identifier within the customer's set of locations.
`startTime`	Number \| String	Start time of the event in either Unix time format milliseconds or ISO-8601 compliant format.

Optional Object Fields

Field	Type	Description
`employeeId`	String	Unique employee id to identify the employee involved in the event.
`employeeName`	String	The name of the employee involved in the event.
`endTime`	Number \| String	End time of the event in either Unix time format milliseconds or ISO-8601 compliant format.
`eventDetails`	String	Additional searchable information about the event.
`items`	Array	List of items related to the event
`notes`	String	Additional notes or comments about the event.
`status`	String	Status of the event.

Required Item Object Fields

Field	Type	Description
`description`	String	Description of the item.
`quantity`	Number	Quantity of the item, defaults to 1.
`time`	Number \| String	Specific time for the item in either Unix time format milliseconds or ISO-8601 compliant format., defaults to event's startTime.
`type`	String	Item type.

JSON Example

Below is an example of how the "other" data type could be structured in JSON format for submission:

{
  "dataType": "other",
  "schemaVersion": "1",
  "startTime": 1557943653649,
  "endTime": 1557943678649,
  "siteExternalId": "123",
  "dataSourceId": "1",
  "eventUniqueId": "93688-START",
  "eventType": "Start Batch",
  "eventDetails": "Additional Details",
  "employeeId": "27",
  "employeeName": "MICHELLE",
  "status": "START",
  "items": [
    {
      "type": "",
      "quantity": 1.0,
      "description": "",
      "time": 1555898203000
    }
  ]
}