Environment Management

Get the site access logs. Start-End date range must not exceed 365 days

Changed on
post/KindooGetSiteUserAccessLogs

Request

  • Base URL
    https://api.kindoo.tech/v3/webservice.asmx
  • URL
    https://api.kindoo.tech/v3/webservice.asmx/KindooGetSiteUserAccessLogs
  • Auth
    API key in header SessionTokenID

Request body application/x-www-form-urlencoded

EIDinteger required
StartDatestring date-time required

The start date for the logs to be retrieved. Format YYYY-MM-DDTHH:mm:ssZ

EndDatestring date-time required

The end date for the logs to be retrieved. Format YYYY-MM-DDTHH:mm:ssZ

KeyWordstring required

The keyword to search for in the logs (user first name or last name or entry point name). Send empty string to retrieve all logs.

EntryPointIDinteger

Fetch all the logs by entry point ID. Send empty to retrieve logs for all entry points.

UIDstring uuid

Fetch all the logs by user ID. Send empty to retrieve logs for all users.

ViewLogTypeinteger

Send 0 for all logs. 1 for successfull logs. 2 for failed logs. default value 0

Response

OK

IDinteger
TimeStampstring date-time

The date and time when the access log (format YYYY-MM-DDTHH:mm:ss, UTC timezone)

Usernamestring

The user full name

DoorNamestring

Entry point name

ScheduleNamestring

Controller schedule name

ControllerNamestring

Controller name

PINstring
WorkOrderNumberstring
Successboolean

Whether the access attempt was successful or not

ActionNamestring

The action that ran (On, Off, Unlock, etc...)

ReasonTextstring

The reason why access was denied

IsMasterLicenseAccessboolean

Whether the access was granted through a master license or not

IsLockdownboolean

If the log was to deactivate entry point

InvitedByFirstNamestring
InvitedByLastNamestring
InvitedByUsernamestring
InvitedOnstring date-time

The date and time when the user was invited (format YYYY-MM-DDTHH:mm:ss, UTC timezone)

RuleSetNamestring

Access rule name

FromDatestring date-time

Access right from date (format YYYY-MM-DDTHH:mm:ss, UTC timezone). Filled if access right type is weekly of FROM-TO

ToDatestring date-time

Access right to date (format YYYY-MM-DDTHH:mm:ss, UTC timezone). Filled if access right type is weekly of FROM-TO

Alwaysboolean

Whether the access right is of type always

WeeklyRecurrentboolean

Whether the access right is of type weekly

DayOfWeekinteger

If the access right is of type weekly, the day of week of the access right. 0 for Sunday, 1 for monday, 2 for tuesday, 3 for wednesday, 4 for thursday, 5 for friday, 6 for saturday

TimeZonestring

The display name of the C# timezone

GrantedByFirstNamestring
GrantedByLastNamestring
GrantedByUsernamestring
GrantedOnstring date-time

The date and time when the access right was granted (format YYYY-MM-DDTHH:mm:ss, UTC timezone)

IsHolidayboolean

Whether the access right is of type holiday

IsSpecialEventboolean

Whether the access right is of type special event

HolidayOrSpecialEventNamestring

The name of the holiday or special event

Changes

    • breaking

      the request property became required

    • info

      api operation id KindooGetSiteUserAccessLogs was added