SDK API

Overview

  • XML Web Services
  • Allows for 3rd Party Integration
  • Supports All Commands

 

To setup the SDK Client Tester, please follow these steps:

  1. Goto IS2000 Hardware Manager and Unlock the module.
  2. Select the Web Server object from the Hardware Tree.
  3. Locate and set the SDK Allowed IP Client(s) and TCP Port property.  Multiple IP addresses can be entered by separating them with a comma.
  4. Install the SDK Client Tester on the desired PC and run the application once installed.
  5. Set the Host IP Address to the IP address of the PC that is running IS2000.Set the TCP Port to the same port that you specified in IS2000’s SDK TCP Port property.
  6. Click on Connect and it should connect to IS2000 and receive any push events, along with allowing for commands/requests to be sent.

Features/Functions of the SDK Tester

  • The SDK Tester allows for a third party application to perform all SDK functions in IS2000.
  • Multiple clients running 3rd party application can be used, add a comma in between IP addresses included under the ‘SDK Allowed IP Client(s)’ property in IS2000 Hardware Manager.
  • Will only accept commands from specified client(s) (IP address/Port).

IMRON SDK supports the following Personnel functions (and more):

  1. Create, Modify, Delete, Retrieve – Person records
  2. Create, Modify, Delete, Retrieve – Card assignment to Person records
  3. Create, Modify, Delete – PIN assignment to Person records
  4. Create, Modify, Delete, Retrieve – Access Level Groups, Access Levels and Readers
  5. Create, Modify, Delete, Retrieve – Time zones assigned to Access Level Groups, Access Levels, Readers, Cards
  6. Retrieve physical access events (Card, Access, Alarms events)
  7. Retrieve PACS User events (Users login/login-denial in PACS)

Updating Personnel Records

The build 10.3.56 adds the features to the SDK to allow you to make updates to a Personnel record or group of Personnel records without having to know what the unique record ID is. Records are filtered based on a criteria similar to what is used in a SQL WHERE clause by simply specifying the field name and the qualifying value(s).

We also updated the SDK Client Tool to support the new DBSet and MultiSet commands for Personnel and Personnel2:

Updating Personnel using DBSet ‘Personnel2’ or DBMultiSet Personnel commands now support a broader criteria format that supports almost any ‘where clause’ scenario. Any valid criteria will do updates to all of the records that meet that criteria.

Note: Trying to set a card number to a card number that already exists in the Personnel table when the No_Duplicates option is set will yield a duplicate card number error.

 

DBMultiSet

Note: The Access_Level field is NOT supported by this command, please use the DBSet if you need to modify the Access_Level field.

 

Assigning Access Levels to Personnel Record(s)

Assigning an Access Level will require the specific Personnel record ID, because Access Level assignments are only allowed 1 record at a time.

dbSet(Admin) 17386 Personnel2|last_name like ‘j%’|access_level=1,3;2,2;3,12

 

In the example above, all Personnel records with the last name beginning with the letter ‘J’ will get Access Level 3 for Controller Group 1, Access Level 2 for Controller Group 2 and Access Level 12 for Controller Group 3.

Removing Access Levels from Personnel Record(s)

The command below will remove ALL Access Levels in Controller Group 1 for the same subset of Personnel records.

dbSet(Admin) 16003 Personnel2|last_name like ‘j%’|Access_Level=1,0

 

Assigning Card_Types to Personnel Record(s)

To do a Card_Type assignment to more than one Personnel record, we recommend that you use the dbSet command with a criteria that yields the group of records. The ‘Card_Type’ contains multiple fields which should already be pre-defined.

dbSet(Admin) 21166 Personnel2|company=’ABC’|Card_Type=’Normal’

 

In the example above, all of the Personnel records that belong to the ‘ABC’ company will get a Card Type assignment of ‘Normal’ and will automatically be assigned to the following field values as defined by the Card Type:

  • Access Levels
  • Activate_Date
  • De_Activate_Date
  • Card Number 1 Format
  • Card Number 2 Format
  • Trigger_Code
  • Company
  • Department
  • Work_Number
  • Address1
  • Address2
  • Use_Limit
  • User_Flag
  • Badge_Type