Version 2.0.1
25-10-2024
Get the logs pairs from a specified time-interval
getRegistrations(p_companyID, p_exportTimeFrom, p_exportTimeTo, p_locationId, p_moduleId, p_userId)
You can use this endpoint to retrieve set of pair logs from our software.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| p_companyID | string | Yes | The security code you have been provided with, string (32) |
| p_exportTimeFrom | string | Yes | The start of the periode, datetime formatted string (yyyy-mm-dd hh:ii:ss) |
| p_exportTimeTo | string | Yes | The end of the periode, datetime formatted string (yyyy-mm-dd hh:ii:ss) |
| p_locationId | integer | No | If provided we retrieve the logs for that specific location |
| p_moduleId | integer | No | If provided we retrieve the logs for that specific module |
| p_userId | integer | No | If provided we retrieve the logs for that specific user |
Return values
getRegistrationsObjectArray (array), containing structs (arrays) of getRegistrationsObject with the following keys:
| Name | Type | Description |
|---|---|---|
| id | string | The id of from the registrations table, the id of the actual log pair |
| user_id | integer | The id of the user |
| checkin_location_id | integer | Location id of the IN/DUTY IN type log |
| checkin_timestamp | string | The event time of the IN/DUTY IN type log |
| checkout_location_id | integer | Location id of the OUT/DUTY OUT type log |
| checkout_timestamp | string | The event time of the OUT/DUTY OUT type log |
| details | string | The pair log details – could be IN, IN;OUT, DUTY IN, DUTY IN/DUTY OUT |
NOTE 1*:
In case there is no result set to be returned, we send a "-1 NO RECORD" message in the id field.
NOTE 2*:
In case there is > 4000 records to be returned by our wsdl, we display a warning message in the id field, asking the user to use a smaller time frame to filter the logs.
NOTE 3*:
+1 extra day is added to the p_exportTimeTo date when the registrations pairs are collected. All the registrations with checkin_timepstamp greater or equal than p_exportTimeFrom and checkout_timestamp smaller or equal than p_exportTimeTo will be collected.
NOTE 4*:
If the registration pair does not have an OUT time and the checkin_timepstamp is larger or equal with p_exportTimeFrom than that registration record will be part of the registrations collection that is returned.
NOTE 5*:
Example:
p_exportTimeFrom 2022-01-05 03:59:00 - p_exportTimeTo 2022-01-05 04:00:00 (in the background we add +1 day) so it will become 2022-01-06 04:00:00
In the above case we will return all registrations that have checkin_timestamp equal or greater than 2022-01-05 03:59:00 and checkout_timestamp equal or lesser than 2022-01-06 04:00:00 (because in the background we add an extra day)
All scanactions with IN time >= 2021-01-05 03:59:00 and OUT time <= 2021-01-06 04:00:00 will be returned.
A registration example:
checkin_timestamp: 2022-01-05 04:30:00 - checkout_timestamp: 2022-01-06 01:30:30
Sample
Response