Add a Raw Time Event
Add a Raw Time Event.
Command
POST https://{server}/api/v1/{tenantId}/rawTimeEvent
Parameters
| Name | Required | Data Type | Description | Parameter Type |
|---|---|---|---|---|
| tenantId | Yes | String | The unique identifier of the tenant. | Path |
| rawTimeEvent | Yes | String | See Raw Time Events. | Request Body |
Responses
Status and Error Codes
Response Body
| Field | Description |
|---|---|
| hostId | The identifier of the host instance that is returning the request. |
| status | The status of the request. Because raw time events are unprocessed information data points collected from a terminal system, they always return a SUCCESS message, even when the event triggers an error. For more information about raw time event errors, see Raw Time Event Errors. |
| content | Returns the ID of the record that was added. |
| messages | This field is always blank. |
| count | The number of records returned. |
Examples
| Sample API Call |
|---|
POST http://company.com/api/v1/pX3459712f8/rawTimeEvents X-Application-Key: TPS_pX3459712f8 Content-Type: application/json Authorization: Bearer eyJhbGciOiJSUzI1NiIsImprdSI6Imh0dHB= |
Example Body Requests
| Request Body Sample |
|---|
{
"terminalExternalId": "C20394996",
"timestamp": "2020-10-08 08:20:00.000 +0000",
"timeEventType": "CLOCK_IN",
"attributes": {}
} |
Successful Responses
| Response Body Sample |
|---|
{
"hostId": "acfc5411b04391bc4ea4341cd20bc539",
"status": "SUCCESS",
"content":"z2002121940443675032311f",
"messages":[],
"count": 1
} |