You can use this endpoint to retrieve set of pair logs from our software.
|p_companyID||string||Yes||The security code you have been provided with, string (32)|
|p_codeProject||string||Yes||If a value is provided will retrieve only the log records which have been clocked on the Project with the same code value.|
|p_codeActivity||string||Yes||If a value is provided will retrieve only the log records which have been clocked on the Activity with the same code value.|
|p_codeSubactivity||string||No||If a value is provided will retrieve only the log records which have been clocked on the Subactivity with the same code.|
p_codeProject, p_codeActivity or p_codeSubactivity (they are filters actually) can be used all together, grouped two-by-two or alone.
bportalRegistrationObjectArray, containing structs (arrays) of bportalRegistrationObject with the following keys (all values are returned as strings):
|id||string||The id of from the registrations table, the id of the actual log pair|
|user_id||integer||The id of the user|
|project_code||string||The code of the Project|
|activity_code||string||The code of the Activity|
|subactivity_code||string||The code of the Subactivity|
|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|
|checkin_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|
If an error will occur during the function call, in the bportalRegistrationObject structure's id field we will return one of the following error messages:
ERROR_NO_SECURITY_HASH - user did not supply $p_companyId security code.
ERROR_UNKNOWN_SECURITY_HASH - supplied security code $p_companyId is invalid.
NO_CODE_RECEIVED – neither of $p_codeProject, $p_codeActivity or $p_codeSubactivity filters is supplied.
CODE_PROJECT_NOT_FOUND – no Project found with the supplied $p_codeProject.
CODE_ACTIVITY_NOT_FOUND – no Activity found with the supplied $p_codeActivity.
CODE_SUBACTIVITY_NOT_FOUND – no Subactivity found with the supplied $p_codeSubactivity.
ACTIVITY_NOT_LINKED_TO_PROJECT – we have $p_codeProject & $p_codeActivity filters and the corresponding tasks are not linked between them.
SUBACTIVITY_NOT_LINKED_TO_ACTIVITY – in case $p_codeActivity & $p_codeSubactivity filters and the corresponding tasks are not linked between them.
NO_RECORD – no log record was found with the given filters.