Documentation for WEB Report System PSIM 2.0.

Previous page Next page

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

A request without the personId parameter returns a list of accesses of all users in the system.

A request without the EMULATOR_READER parameter returns a list of accesses of all objids.

You can filter the users by area ID (the area_id field from the OBJ_PERSON table; for more details, see Base Axxon PSIM database tables).

All users are returned in ascending order of personId.

General format of a request

GET http://<IP address of the Web server>:8081/AccessManager/ReportApi/GetEmployeeWalkwayData?from=<beginning of the time interval>&to=<end of the time interval>

Examples of request parameters:

Parameter

Required

Description

personId 

No

User IDs separated by commas

withTempr 

No

User temperature data, default is false

from

Yes

The period from: the beginning of the time interval containing the date and time in the format YYYY-MM-DDTHH:MM:SS

to

Yes

The period to: the end of time interval containing date and time in the format YYYY-MM-DDTHH:MM:SS

objid

NoThe ID of the object that generated the event

EMULATOR_READER

No

The type of the object that generated the event, such as ACFA_EMULATOR_ACS_CONTROLLER. You can view a list of objects, their names in the database and in the interface using the ddi.exe utility

eventAction

NoThe type of event, for example, ACCESS_IN

area_id

No

ID of the Area object in which the user is located according to the data of the emergency monitoring system that is a part of ACFA PSIM (see Working with Emergency Monitoring)

page

No

The page number of data displayed as a result of the request, default is 0

limit

No

The maximum number of data rows; by default, all data is displayed.

For example, if page=0 and limit=1000 are set, the first 1000 rows are displayed. If page=2 and limit=1000 are set, rows 2001-3000 are displayed

Attention!

If there are many objects in the system (>1000), then use page-by-page output.

Example of a request to display access data of users with personId=2 and personId=4, sorted by the field area_id=1.2, when the EMULATOR_READER and objid parameters are specified:

GET localhost:8081/reports/AccessManager/ReportApi/GetEmployeeWalkwayData?withTempr=true&personId=2,4from=2025-03-05T00:00:00&to=2025-03-08T23:59:59&objid=1.1.1&EMULATOR_READER=ACFA_EMULATOR_ACS_CONTROLLER&eventAction=ACCESS_IN

Example of a request to display access data of all users across all access points when the personId, EMULATOR_READER, and objid parameters are not specified:

GET localhost:8081/reports/AccessManager/ReportApi/GetEmployeeWalkwayData?withTempr=true&from=2025-03-04T00:00:00&to=2025-03-10T23:59:59&objid=1.1.1&eventAction=ACCESS_IN&areaId=1.2&page=1&limit=1000

Example of a response:

{
    "employeeID": "2,4",
    "result":[
{ "PersonId": "2", "timeclockID": "Emulator ACFA Reader 1.1.1",         "scantime": "2025-03-06T09:01:01",        "clockInOut": "in",
"Temperature": "-"
},        { "PersonId": "4", "timeclockID": "Emulator ACFA Reader 1.1.1",         "scantime": "2025-03-06T09:01:19",        "clockInOut": "in",
"Temperature": "-"
},
{ "PersonId": "2", "timeclockID": "Emulator ACFA Reader 1.1.1",         "scantime": "2025-03-07T09:00:46",        "clockInOut": "in",
"Temperature": "-"
},
{ "PersonId": "4", "timeclockID": "Emulator ACFA Reader 1.1.1",         "scantime": "2025-03-07T09:00:53",        "clockInOut": "in",
"Temperature": "-"
}     ],
"status": "success",
"transactionID": 1760702475

Response parameters:

Parameter

Description

employeeID

Employee ID

PersonId

User ID

timeclockID

ID of the time and attendance device of an employee

scantime
Date and time of the access event
clockInOut

Employee clock-in/clock-out

Temperature

Employee temperature

transactionID

Transaction ID

status

The status of the completed request: successsuccessful. Otherwise, the request ends with an error


  • No labels