Skip to content

IL Cloud access control API

Public programming interace for 3rd party integration.

Version: v1

Terms of service

https://ironlogic.com.au

Contact information:
Alex Volvach
https://ironlogic.com.au

License: Use under LICX

/API/equipment/converters

POST

Summary

Retrives paginated converters list info

Parameters
Name Located in Description Required Schema
body body Pagination request No DataTableModel
Responses
Code Description
200 Success

/API/equipment/ctrl/{id}

DELETE

Summary

Deletes the controller from the database

Parameters
Name Located in Description Required Schema
id path Controller id number for deletion Yes integer
Responses
Code Description
200 Success

/API/equipment/refresh_from_ctrl/{id}

GET

Summary

Sends a query to a controller to update the database information

Parameters
Name Located in Description Required Schema
id path Controller id number Yes integer
Responses
Code Description
200 Success

/API/equipment/converter/{id}

DELETE

Summary

Deletes a converter from the database All the controllers linked to the converter should be deleted prior.

Parameters
Name Located in Description Required Schema
id path Converter's id number to delete Yes integer
Responses
Code Description
200 Success

/API/equipment/SaveController

POST

Summary

Saving controller's inforamtion to the database

Parameters
Name Located in Description Required Schema
body body Structure with the contrroller's information No ilController
Responses
Code Description
200 Success

/API/equipment/add_converter

POST

Summary

Register a new converter into the account. Converter should be setup and pointed to the cloud before the registration.

Parameters
Name Located in Description Required Schema
body body Structure with the converter's info No Converter
Responses
Code Description
200 Success

/API/equipment/controllers/{converter_id}

POST

Summary
Parameters
Name Located in Description Required Schema
converter_id path Id number of the converter for the controllers to be retrieved. '-1' value will output all the controlers for the account. Yes integer
body body Pagination request structure No DataTableModel
Responses
Code Description
200 Success

/API/equipment/getController/{id}

GET

Summary

Gets information of the controller by the id number.

Parameters
Name Located in Description Required Schema
id path Controller's id number Yes integer
Responses
Code Description
200 Success

/API/equipment/openDoor/{ctrl_id}/{direction}

GET

Summary

Opens the door by the controller's id number

Parameters
Name Located in Description Required Schema
ctrl_id path Controller's id Yes integer
direction path Yes integer
Responses
Code Description
200 Success

/API/equipment/getPendingCmdCount

GET

Summary

Retrieves the summary of all not synced with the equipment parts for the account

Responses
Code Description
200 Success

/API/equipment/get_controllers/{location_id}

GET

Summary

Get the controller list by the location

Parameters
Name Located in Description Required Schema
location_id path Location id Yes integer
Responses
Code Description
200 Success

/API/equipment/resyncCards/{ctrl_id}

GET

Summary

Syncing cards database with the controller

Parameters
Name Located in Description Required Schema
ctrl_id path Controller id Yes integer
Responses
Code Description
200 Success

/api/departments/get/{id}

GET

Summary

Gets department information

Parameters
Name Located in Description Required Schema
id path Department's id number Yes integer
Responses
Code Description
200 Success

/api/departments/getlist

GET

Summary

Get the depratment list for the account

Responses
Code Description
200 Success

/api/departments/SaveDepartment

POST

Summary

Saves the department into the database

Parameters
Name Located in Description Required Schema
body body Department structure. -1 value in id field will register a new department No DepartmentModel
Responses
Code Description
200 Success

/api/departments/DeleteDepartment/{id}

GET

Summary

Deletes a department from the database

Parameters
Name Located in Description Required Schema
id path Department id to delete Yes integer
Responses
Code Description
200 Success

/api/departments/getDepartmentLocations/{id}

GET

Summary

Retreives the list of assigned locations by the department id

Parameters
Name Located in Description Required Schema
id path Department's id number Yes integer
Responses
Code Description
200 Success

/api/employees/getPhoto/{id}

GET

Summary

Gets employees photo by the id number. JWT security token must be provided in the request's query parameters

Parameters
Name Located in Description Required Schema
id path Employee id number Yes integer
token query JWT token No string
Responses
Code Description
200 Success

/api/employees/getCCTVPhoto/{event_id}

GET

Summary

Gets CCTV image for the event. JWT security token must be provided in the request's query parameters

Parameters
Name Located in Description Required Schema
event_id path Event id number Yes integer
token query JWT Token No string
Responses
Code Description
200 Success

/api/employees/get/{id}

GET

Summary

Gets employee info by the id number

Parameters
Name Located in Description Required Schema
id path Employee's id number Yes integer
Responses
Code Description
200 Success

/api/employees/get_list

POST

Summary

Gets paginated list of employees

Parameters
Name Located in Description Required Schema
search_str query Search string to be filtered by (first, last name search only) No string
sort_by query Integer valiue for sorting the results: 1 - Sorting by first, last name 2 - Employee's state 3 - Employee's location 4 - Employee's perosnal number 5 - Employee's assigned department 6 - Employee's position 7 - Employee's assigned keys qty No integer
sort_dir query No integer
body body Pagination object for the request No DataTableModel
Responses
Code Description
200 Success

/api/employees/delete/{id}

GET

Summary

Deletes an employee by the id number

Parameters
Name Located in Description Required Schema
id path Employee's id to delete Yes integer
Responses
Code Description
200 Success

/api/employees/RasOpenDoor

GET

Summary

Opens the door without JWT authentication.

Parameters
Name Located in Description Required Schema
u query Employee id number No string
key query Employee secret key generated by sendOpenDoor call No string
acc query Account name No string
ctrl_id query Controller id number No string
direction query Direction 0 - entry, 1 - exit No string
Responses
Code Description
200 Success

/api/employees/getRasConfig

GET

Summary

Gets employee's remote access configuration for the current moment

Parameters
Name Located in Description Required Schema
u query Employee id number No string
key query Employee secret key generated by sendOpenDoor cal No string
acc query Account name No string
Responses
Code Description
200 Success

POST

Summary

Creates and sends a email for remote cardless access to employee

Responses
Code Description
200 Success

/api/employees/save

POST

Summary

Saves employee into the database. -1 vvalue in id field will create a new emplyee

Responses
Code Description
200 Success

/api/identifiers/types

GET

Responses
Code Description
200 Success

/api/identifiers/get_with_filter/{emp_id}/{sort_by}/{sort_dir}

POST

Parameters
Name Located in Description Required Schema
emp_id path Yes integer
sort_by path Yes integer
sort_dir path Yes integer
body body No DataTableModel
Responses
Code Description
200 Success

/api/identifiers/get_history/{key_id}

POST

Parameters
Name Located in Description Required Schema
key_id path Yes integer
body body No DataTableModel
Responses
Code Description
200 Success

/api/identifiers/get/{id}

GET

Parameters
Name Located in Description Required Schema
id path Yes integer
Responses
Code Description
200 Success

/api/identifiers/clear_unused_tags

GET

Responses
Code Description
200 Success

/api/identifiers/delete_tag/{id}

POST

Parameters
Name Located in Description Required Schema
id path Yes integer
body body No DataTableModel
Responses
Code Description
200 Success

/api/identifiers/Save

POST

Parameters
Name Located in Description Required Schema
body body No identifierModel
Responses
Code Description
200 Success

/api/locations/getlist

GET

Responses
Code Description
200 Success

/api/locations/get/{id}

GET

Parameters
Name Located in Description Required Schema
id path Yes integer
Responses
Code Description
200 Success

/api/locations/remove_ctrl/{obj_id}/{ctrl_id}

DELETE

Parameters
Name Located in Description Required Schema
obj_id path Yes integer
ctrl_id path Yes integer
Responses
Code Description
200 Success

/api/locations/del_location/{id}

DELETE

Parameters
Name Located in Description Required Schema
id path Yes integer
Responses
Code Description
200 Success

/api/locations/saveLocation

POST

Parameters
Name Located in Description Required Schema
body body No locationModel
Responses
Code Description
200 Success

/API/auth/login

POST

Parameters
Name Located in Description Required Schema
body body No UserModel
Responses
Code Description
200 Success

/API/auth/logout

POST

Responses
Code Description
200 Success

/api/logs/getEvents

POST

Parameters
Name Located in Description Required Schema
ctrl_id query No integer
body body No DataTableModel
Responses
Code Description
200 Success

/api/logs/getEvent/{id}

GET

Parameters
Name Located in Description Required Schema
id path Yes integer
Responses
Code Description
200 Success

/api/logs/getEmplInOut

POST

Parameters
Name Located in Description Required Schema
emp_id query No integer
body body No DataTableModel
Responses
Code Description
200 Success

/api/Reports/getXlsReport

POST

Parameters
Name Located in Description Required Schema
body body No ReportRequestModel
Responses
Code Description
200 Success

/api/Reports/loadReport

POST

Parameters
Name Located in Description Required Schema
body body No ReportRequestModel
Responses
Code Description
200 Success

/API/RTSP/showStream

GET

Parameters
Name Located in Description Required Schema
rtsp_link query No string
Responses
Code Description
200 Success

/API/system-settings

GET

Parameters
Name Located in Description Required Schema
lang query No string
Responses
Code Description
200 Success

/API/SaveSettings

POST

Parameters
Name Located in Description Required Schema
body body No [ settingsModel ]
Responses
Code Description
200 Success

/API/users/complete_reg/{guid}

GET

Summary

Finilizes a new account registration

Parameters
Name Located in Description Required Schema
guid path GUID from the email sent with StartClientReg call Yes string
Responses
Code Description
200 Success

/API/users/StartClientReg

POST

Summary

Starts client registration (send auth email)

Parameters
Name Located in Description Required Schema
body body Unique client name (no spaces allowed) No ClientModel
Responses
Code Description
200 Success

/API/users/getUser

GET

Responses
Code Description
200 Success

/API/users/getAllUsers

GET

Responses
Code Description
200 Success

/API/users/getPhoto/{id}

GET

Parameters
Name Located in Description Required Schema
id path Yes integer
token query No string
Responses
Code Description
200 Success

/API/users/delUser/{id}

GET

Parameters
Name Located in Description Required Schema
id path Yes integer
Responses
Code Description
200 Success

/API/users/saveUser

POST

Parameters
Name Located in Description Required Schema
body body No UserModel
Responses
Code Description
200 Success

/API/users/changePwd

POST

Parameters
Name Located in Description Required Schema
body body No ChangePwdModel
Responses
Code Description
200 Success

Models

DataTableModel

Name Type Description Required
start integer Skips first items from start No
length integer Takes number or records from start No
filter string filters by the object type (if applicable) No
search_str string seraches the objects by name property No

TimeSpan

Name Type Description Required
ticks long No
days integer No
hours integer No
milliseconds integer No
minutes integer No
seconds integer No
totalDays double No
totalHours double No
totalMilliseconds double No
totalMinutes double No
totalSeconds double No

TimeZoneModel

Name Type Description Required
number integer No
days integer No
from TimeSpan No
to TimeSpan No
active boolean No
mode integer No

ilController

Name Type Description Required
id integer No
converter_id integer No
exit_loc integer No
serial long No
name string No
type integer No
conv_name string No
conv_type integer No
conv_desc string No
lastonline dateTime No
mode integer No
status integer No
cardsMemorySize integer No
eventMemorySize integer No
cardsQty integer No
inverted boolean No
entry_cctv_link string No
exit_cctv_link string No
entry_rtsp string No
exit_rtsp string No
fw string No
desc string No
selected boolean No
in_open_time integer No
in_close_wait_time integer No
banks integer No
in_open_wait_time integer No
out_open_time integer No
out_close_wait_time integer No
out_open_wait_time integer No
pending_cmd_qty integer No
auto_mode_conf [ TimeZoneModel ] No

Line

Name Type Description Required
port integer No
type integer No

Info

Name Type Description Required
Info object

Converter

Name Type Description Required
id integer No
serial long No
name string No
desc string No
ip string No
interface string No
status integer No
controllerQty integer No
active integer No
lastOnline dateTime No
options integer No
fw string No
line Line No
info Info No
type integer No
auth_key string No
controllers [ ilController ] No
work_mode integer No

DepartmentModel

Name Type Description Required
id integer No
name string No
comment string No
parentId integer No
dayStartTime integer No
dayEndTime integer No
lunchStartTime integer No
lunchEndTime integer No
shortDay integer No
shortDayEndTime integer No
startEarly integer No
endEarly integer No
endLate integer No
outOfOffice integer No
level integer No
startLate integer No
assigned_locations [ integer ] No

identifierModel

Name Type Description Required
id integer No
number long No
lastscanned dateTime No
assigned boolean No
flags integer No
emp string No
employee_id integer No
new_emp_name string No
avatar_url string No
guest_name string No
create_guest boolean No

locationModel

Name Type Description Required
id integer No
name string No
level integer No
rate double No
comment string No
color string No
parentId integer No
isPeriodInheritance boolean No
loc_time_zone string No
controllers [ ilController ] No
timeZones [ TimeZoneModel ] No
children [ locationModel ] No

myFile

Name Type Description Required
name string No
lastModified long No
lastModifiedDate dateTime No
webkitRelativePath string No
size integer No
type string No
raw string No
bytes byte No

UserModel

Name Type Description Required
id integer No
account string No
login string No
password string No
fullName string No
shortName string No
role string No
email string No
avatar myFile No
avatar_url string No
active boolean No

ReportRequestModel

Name Type Description Required
rep_type integer No
from_date dateTime No
to_date dateTime No
take integer No
skip integer No

settingsModel

Name Type Description Required
settingId integer No
value string No

ClientModel

Name Type Description Required
id integer No
acc_name string No
first_name string No
last_name string No
email string No
phone string No
pwd string No
pwd1 string No

ChangePwdModel

Name Type Description Required
old_pwd string No
new_pwd string No
new_pwd1 string No