Entity Types Overview
Entity Types
Coolr divides the entity type in the following categories:
- Management: Necessary data for platform function. This data is usually generated within Coolr system
- Master Data: Client specific data that usually requires integration. This data generally originates from the client systems
- Transactional Data: Transactional data (including Telemetry) generated/ stored on the Coolr platform
- Actions: Actions generated based on transactional data
Deletion
We generally use soft-delete approach when a record is to be removed. This allows traceability. If you need permanent deletion of any data, please reach out to support.
Common Fields/ Primary Keys
A lot of our APIs return the referencing primary keys as well for you to be able to look up related entities. Some of the common keys are:
Modification Log/ Tracking related
| Field | Description |
|---|---|
| IsDeleted | 1 - If record is deleted, 0 - If active |
| CreatedByUserId | UserId of the user who created the record |
| CreatedByUser | Email Address of user who created record |
| CreatedOn | UTC Date/ time when the record was created |
| ModifiedByUserId | UserId of the user who last modified the record |
| ModifiedByUser | Email Address of user who last modified record |
| ModifiedOn | UTC Date/ time when the record was last modified |
Primary Keys
| Field | Related entity |
|---|---|
| AssetId | Asset |
| LocationId | Location |
| AssetTypeId | AssetType |
| StateId | State |
| SmartDeviceId | SmartDevice |
| ClientId | Client |
| SmartDeviceTypeId | SmartDeviceType |
| DistributorId | Distributor |
| CountryId | Country |
| ManufacturerId | Manufacturer |
| MarketId | Market |
| ProductId | Product |
| PlanogramId | Planogram |
| TimeZoneId | TimeZone |
Other Common Fields
| Field | Description |
|---|---|
| LastPing | Last Ping time |
| LastPingUtc | Last Ping time in UTC |
| EventTime | Event time |
| EventTimeUtc | Event time in UTC |
| RowNumber | Record Sequence Number in List API. Particularly useful when using paging |
| LocationCode | Location Code |
| Location | Location Name |
| AssetType | Asset Type/ Model. Usually the asset type is given as Manufacturer + Model. |
| City | City Of Location/ Asset - Derived from Location table. |
| State | State Of Location/ Asset - Derived from Location table. |
| PostalCode | PostalCode Of Location/ Asset - Derived from Location table. |
| Street | Street Address of location - Line 1 |
| Street2 | Street Address of Location - Line 2 |
| Street3 | Street Address of Location - Line 3 |
| ClientName | Name of Tenant/Client |