Get the logs pairs from a specified time-interval

getRegistrations2(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

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:uen="uen:esws">
<soapenv:Header/>
<soapenv:Body>
<uen:Esws.getRegistrations soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<p_companyID xsi:type="xsd:string">^4p;tU0Q+#dEIhTWkuj5FnLD^aOLqVu0</p_companyID>
<p_exportTimeFrom xsi:type="xsd:string">2021-01-06 10:00:00</p_exportTimeFrom>
<p_exportTimeTo xsi:type="xsd:string">2021-01-06 18:00:00</p_exportTimeTo>
<p_locationId xsi:type="xsd:string">12</p_locationId>
<p_moduleId xsi:type="xsd:string">1</p_moduleId>
<p_userId xsi:type="xsd:string">234</p_userId>
</uen:Esws.getRegistrations>
</soapenv:Body>
</soapenv:Envelope>

Response

<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="uen:esws">
<SOAP-ENV:Body>
<ns1:Esws.getRegistrationsResponse xmlns:ns1="uen:esws">
<return xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:getRegistrationsObject[2]">
<item xsi:type="tns:getRegistrationsObject">
<id xsi:type="xsd:string">1459</id>
<user_id xsi:type="xsd:string">7</user_id>
<checkin_location_id xsi:type="xsd:string">3</checkin_location_id>
<checkin_timestamp xsi:type="xsd:string">2020-01-22 10:47:26</checkin_timestamp>
<checkout_location_id xsi:type="xsd:string">3</checkout_location_id>
<checkout_timestamp xsi:type="xsd:string">2020-01-22 10:48:13</checkout_timestamp>
<details xsi:type="xsd:string">IN;OUT</details>
</item>
<item xsi:type="tns:getRegistrationsObject">
<id xsi:type="xsd:string">1460</id>
<user_id xsi:type="xsd:string">7</user_id>
<checkin_location_id xsi:type="xsd:string">3</checkin_location_id>
<checkin_timestamp xsi:type="xsd:string">2020-01-22 10:48:14</checkin_timestamp>
<checkout_location_id xsi:type="xsd:string">3</checkout_location_id>
<checkout_timestamp xsi:type="xsd:string">2020-01-22 10:48:21</checkout_timestamp>
<details xsi:type="xsd:string">IN;OUT</details>
</item>
</return>
</ns1:Esws.getRegistrationsResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>