GuardPointPro APIs
Contents
1. txt txt amp Save Record by user amp anUserEventRecord UserName amp amp anUserEventRecord RecordScreen amp amp anUserEventRecord RecordDetails End Select e RichTextBoxl AppendText txt amp vbCrLf For more code sample see function Private Sub acDLL_UserEvent ByVal anUserEventRecord As acAPI UserEventRecord Handles acDLL UserEvent ControllerCommunicationError Wake up the application when a controller starts to be in Communication error It returns the text to be displayed in Log windows ControllerCommunicationOK Wake up the application when a controller returns to be in Communication OK It returns the text to be displayed in Log windows TextForLog Wake up the application when information to be displayed in Log windows arrives It returns the text to be displayed in Log windows TextForStatusBar Wake up the application when information to be displayed in Status bar arrives It returns the text to be displayed in the Status bar and the percent of the progress bar This is useful to get the feedback of the progress of the initialization of a controller APInotDocumented Wake up the application when a message arrives that has not been documented in the current API For specific integration request that has not been documented here please contact us SpreadPollingError Wake up the application when the communication layer Spread returns an error code2. 100 acAPI User Manual Issue July the 30th 2008 Page 18 25 The error codes are 1 ILLEGAL_SPREAD 2 COULD NOT CONNECT 3 REJECT QUOTA 4 REJECT NAME 5 REJECT ILLEGAL NAME 6 REJECT NOT UNIQUE VERSION 8 CONNECTION CLOSED 9 REJECT AUTH 11 ILLEGAL SESSION 12 ILLEGAL SERVICE 13 ILLEGAL MESSAGE 14 ILLEGAL GROUP 15 BUFFER TOO SHORT 16 GROUPS TOO SHORT 17 MESSAGE TOO LONG The more frequents error codes are 8 and 11 and happens when the spread process is not running most of the time due to a wrong configuration file spread conf Check the Computers definition in GuardPointPro ExceptionHappen Wake up the application when an exception happens in the DLL code It returns the Function Name and the exception object 100 acAPI User Manual Issue July the 30th 2008 Page 19 25 100 acAPI User Manual Issue July the 30th 2008 Page 20 25 Appendix A Screens ID Screens ID Description ID APBLevel Anti Pass Back Level ID Area Area ID Departement Department ID Diagnostic Diagnose ID Visitor Visitor ID AccessGroup Access Group ID Actions Action ID Badge
3. 54 Access Denied sss s From Reader Rdr 1 MEGA Access Group 100 acAPI User Manual Issue July the 30th 2008 Page 23 25 Test Access Control APIs Disarm Constantly Disarm Until Time Zone Disarm NONE Cancel Previous Dt Am 45 Am 10 Minutes Am Constantly Am Until Time Zone Constant Deactivated Am NONE Cancel Previous Activ Normal according to WP InputGroup ID 1 E InputID 1 X Polling Polling Now 30 07 2008 14 48 28 Access Granted Smith John Dir784 From Reader Rdr01 MEGA Transaction Code 99 30 07 2008 14 48 30 Unknown Badge 20570040 From andi Rdr 1 MEGA 30 07 2008 14 49 54 Access Denied sss s From Reader Rdr01 MEGA Access Group m 100 acAPI User Manual Issue July the 30th 2008 Page 24 25 30 07 2008 14 49 54 Access Denied sss s From Reader Rdr01 MEGA Access Group Mandatory Field Imported Sucessfully From Date 9 01 01 2008 08 00 jv To Date 30 07 2008 02 46 gv Validated V Supervisor Keep Card on motorized reader 7 7 No acces during holidays Reset 7 NeedEscort Badge Printing Layo Personal WP 100 acAPI User Manual Issue July the 30th 2008 Page 25 25
4. True Street As String City As String ZIP Strang Personal Phone As String Description As String Car Number As String ID As String 100 acAPI User Manual Issue July the 30th 2008 Page 12 25 Supervisor As Boolean Label 1 As String Label 2 As String Label 3 As String Label 4 As String Company As String Lift Program As String Parking Users Group As String MultiSite Type As MultiSite Types isLocal isShared isGlobal Site As String Personal WP As String Personal CL As String Keep card on motorized reader As Boolean No APB As Boolean No access during holidays As Boolean Reset APB As Boolean Need Escort As Boolean Badge Printing Layout As String Visited person As String Visited person location As String Visit purpose As String And ImportResults options are e UpdateSuccessfully InsertSuccessfully MandatoryFieldMissing UpdateFailed InsertFailed AuthorisationExcedded CannotChangeGuard DuplicateName CardHolderDeleted BadgeCodeNotOK The import creates the cardholder the badge the access group if not found the department if not found the lift program if not found the parking user group if not found the personal weekly program if not found It supports e Multiple Access Group use to separate the names of the access group Dyna
5. normal mode the input 1 acDLL SetInputState 1 acAPI API InputStates Normal This command allows to control alarms sensors to be arm or not SetinputGroupState Send a request to modify the Input group state Deactivate Force activate the input group with the db InputGroupID cf Appendix B 100 acAPI User Manual Issue July the 30th 2008 Page 9 25 Syntax Sub SetInputGroupState ByVal InputGroupID As Long ByVal InputGroupState As InputGroupStates Optional ByVal Delay As Integer 0 Where InputGroupStates Disarm DuringSeconds Disarm DuringMinutes Disarm Constantly Disarm UntilTimeZone Disarm NONE CancelPreviousDelay Arm DuringSeconds Arm DuringMinutes Arm Constantly Arm UntilTimeZone Arm NONE CancelPreviousDelay Sample To disarm the input group 1 during 30 seconds acDLL SetInputGroupState l1 acAPI API InputGroupStates Disarm DuringSeconds 30 This command allows to control alarm zones defined as group of inputs to be arm or not ActivateAllDoorRelays Send a request to modify the Input state Deactivate Force activate the input with the db InputID cf Appendix B Syntax Sub ActivateAllDoorRelays ByVal db ControllerID As Long ByVal DoorRelayState As DoorRelayStates Optional ByVal Delay As Integer 0 GetTimeDate Send a request to get the time and date of a controller db ControllerID cf Appendix B Syntax Function GetTimeDate ByVal db ControllerID As Long As Date GetDi
6. Badge ID Cardholders Cardholders ID Computer Computer ID Configuration Customized Label ID Controllers Controller ID Counters Counter ID DailyProgram Daily Program ID EventHandlingProgram Event Handling Program ID GlobalReflex Global Reflex ID InputGroup Input Group ID OutputGroup Output Group ID Holiday Holiday ID Log Active Alarms ID Network Network ID Process Process ID WeeklyProgram Weekly Program ID ParkingDefinition Parking Lot ID Company Company Site ID Parking User Group ID User Users ID AuthorisationsLevels Authorisation Levels ID Icons Icons Symbols ID Maps Maps ID Positions Position ID LiftAuthorisationGroups Lift Authorisation group only when Lift per Reader ID LiftProgram Lift program ID TimeAttendance Roll Call ID CrisisLevel Send a Crisis Level ID ExecuteProcess Execute Process ID GuardDefinition Guard Definition ID ViewPhoto View Photo ID PatrolTour Patrol Tour ID CheckPoint Checkpoints ID PatrolStatus Patrol status ID DisplayJournalSmall Report wizard ID CreateagroupofBadges Group of Badge ID ImportProfile Import profiles ID CustomizedFields Customized fields ID Camera Camera ID Matrix Matrix ID LocationStatus Location Status 100 acAPI User Manual Issue July the 30th 2008 Page 21 25 The database fields Appen
7. ETTE LT 3 Exception Happen tun 3 100 acAPI User Manual Issue July the 30th 2008 Page 2 25 Contacting SENSOR ACCESS for Technical Support Fout Bladwijzer niet gedefinieerd Appendix A Screens ID Me e M 3 Appendix B Database adven penis TAM a NUI LE 3 100 acAPI User Manual Issue July the 30th 2008 Page 3 25 Introduction This document is dedicated to explain the existing API of GuardPointPro It allows an easy integration with SENSOR ACCESS Access control and alarm monitoring software called GuardPointPro This means that an external application could receive many information from GuardPointPro such as online events of access control system s Access granted Access denied Start of Alarm e and act on Access control system s by o Creating cardholders o Manages doors status and relays status Open a door for a while open constantly close constantly or return to default status Manage alarm status disarm a zone input group Executing existing actions and processes of GuardPointPro Login Logoff User interface messages on screen Download configuration to controllers that may be updated directly in DB by an external application GuardPointPro has also other integration gateway such as OPC ModbusTCP e Wizcon The d
8. GuardPointPro APIs Publication No 10UExxx Issue July the 30 2008 TABLE OF CONTENTS Introduction sic 3 Installa OM cant Mee 3 PROUT ANN ueste sss ctus 3 Properties 3 dta 3 Spreadt ODE DEAETOH codici geo 3 3 ser ends 3 Den SLE Cea UN S M MEE 3 E 3 dissi 3 Displ y Mess o 3 Insert EE Ea EE A 3 InsertTextinStatus Bar a o es b oq MEMO HN 3 Js 3 BXGCUD aps saca sas E 3 Execute 3 1 3 3 Recr ateMemofy ables Me a 3 e N ERR E E ae 3 seica nt eE E
9. PowerDown Case acAPI TechnicalEventRecord Event txt 5 txt amp PowerUp Case acAPI TechnicalEventRecord Event txt txt amp Power Down End Select txt txt amp From Controller UserEvent amp TechRec ControllerName e RichTextBoxl AppendText txt amp vbCrLf For more code sample see function Private Sub acDLL Technicali As acAPI TechnicalEventRecord Wake up the application when a user event arrives We return an object UserEventRecord that contains Properties of UserEventRecord EventDate As Date EventType As EventTypes ewRecord SaveRecord DeleteRecord Login Logout Event description UserName As String WorkStationName As String RecordScreen As String RecordDetails As String db_ UserID As Long Database Fields db SocID As Long reference db TableLOG ID As Long Cf Appendix B Sample Dim txt As tring txt anus EventRecord l K EventDate amp Select Cas Case acAPI anUserEventR UserEventRecord cord EventType EventTypes Logout Event ByVal Handles acDLL TechnicalEvent 100 acAPI User Manual Issue July the 30th 2008 Page 17 25 txt txt amp Logout From user amp anUserEventRecord UserName amp amp anUserEventRecord WorkStationName Case acAPI UserEventRecord EventTypes SaveRecord
10. This command update the polling queues it adds new controllers or remove controllers have been set as not active You can specify a specific controller or network Without defining any controller it stops all the communication polling with the controllers Syntax 100 acAPI User Manual Issue July the 30th 2008 Page 11 25 Sub StartPolling Optional ByVal db ControllerID As Long 0 Optional ByVal db NetworkID As Long 0 StopPolling Send a request to Stop Polling the controllers You can specify a specific controller Without defining any controller it stops all the communication polling with the controllers Syntax Sub StopPolling Optional ByVal db ControllerID As Long 0 ImportCardholder Send a request to import a cardholder in the database and inform the controllers This allows adding updating or deleting cardholders Syntax Function ImportCardHolder ByVal a As CardholderFields As ImportResults Where CardholderFields contains the cardholder fields Properties of CardholderFields Number As String Last Name As String First Name As String Type As CardholderTypes Visitor Cardholder Guard DELETED Badge As String Technology As CardTechnologies Magnetic BarCode Wiegand Wiegand2 WiegandKeypad BioSmartCard Touch Radio Photo As String Department As String Office Phone As String Access Group As String PIN code As String From Date As String To Date As String Validated As Boolean Default value
11. b TableLOG ID As Long Sample Dim txt As String txt AccessRec EventDate amp If AccessRec EventType acAPI AccessEventRecord EventTypes AccessGranted Then txt 5 txt amp Access Granted End If txt 5 txt amp AccessRec CardHolderName amp From Reader amp AccessRec ReaderName txt txt amp Transaction Code amp AccessRec TransactionCode Me RichTextBoxl SelectionColor Color Green Me RichTextBoxl AppendText txt amp vbCrLf For more code sample see function Private Sub acDLL AccessEvent ByVal AccessRec As acAPI AccessEventRecord Handles acDLL AccessEvent 100 acAPI User Manual Issue July the 30th 2008 Page 15 25 AlarmEvent Wake up the application when an Alarm event arrives We return an object AlarmEventRecord that contains Properties of AlarmEventRecord EventDate As Date EventType As EventTypes StartOfAlarm Immediate StartOfAlarm Delayed EndOfAlarm LineShort LineCut Statusl AnalogInput Status2 AnalogInput description Status3 AnalogInput Status4 AnalogInput isFromBus2 As Boolean isDoorContact As Boolean isRTX As Boolean DoorName As String db InputID As Long db ControllerID As Long Database Fields db SocID As Long reference db CameraID As Long Cf Appendix B db TableLOG ID As Long Event Sample Dim txt As String txt 5 AlarmRec EventDate amp Select Case AlarmRec Eve
12. dix B Database Fields db ControllerID Select ID Name from Controller db ReaderID Select ID Name from Reader db InputID Select ID Name from Input db OuputID Select ID Name from Output db NetworkID Select ID Name from Network db SocID db ReaderSocID db CardHolderSocID Select ID Name from SOC db TableLOG ID Select ID from LOG db CardHolderID Select ID Last Name amp amp First Name as Name from CRDHLD db CameraID Select ID Name from Camera db InputGroupID Select ID Name from IGrp db ActionID Select ID Name from Action db ProcessID Select ID Name from Process We plan to improve the API to allow access to Database tables and records 100 acAPI User Manual Issue July the 30th 2008 Page 22 25 Appendix C Sample application print screen Test Access Control APIs Preview Video Camera ID 1 Preview Report Report D DEV Amadeus Insert Text in StatusBar Play Sound Percent 50 SoundFile Text Hi How are you C Windows Media Windows Notify 30 07 2008 14 48 28 Access Granted Smith John Dir784 From Reader Rdr01 MEGA Transaction Code 99 30 07 2008 14 48 30 Unknown Badge 20570040 From Reader Rdr01 MEGA 30 07 2008 14 49 23 Save Record by user dds Event h 30 07 2008 14 49 25 End Of Alarm From Input i01 MEGA 30 07 2008 14 49
13. gitallnputStatus Send a request to get the input and output status of a controller db ControllerID cf Appendix B It returns the logical state of the input physical state according to NO NC and the Syntax Function GetDigitalInputStatus ByVal db ControllerID As Long As String 100 acAPI User Manual Issue July the 30th 2008 Page 10 25 The returned string is build of 0 1 in the following order e Inputs 1 16 e Relays 1 64 e Inputs 17 24 GetHardwareVersion Send a request to get the hardware version of a controller db_ControllerID cf Appendix B It returns a string For more information consult the TPL User Manual Syntax Function GetHardwareVersion ByVal db ControllerID As Long As String GetFirmareVersion Send a request to get the firmware version of a controller db ControllerID cf Appendix B It returns the Eprom date and checksum Syntax Function GetFirmareVersion ByVal db ControllerID As Long As String GetMemoryOccupation Send a request to get the memory occupation of a controller db ControllerID cf Appendix B It returns the number of cardholders stored in the controller memory Syntax Function GetMemoryOccupation ByVal db ControllerID As Long As Long isPollingNow Send a request to know if currently we are polling or not the controllers It returns True False Syntax Function isPollingNow As Boolean StartPolling Send a request to Start Polling the controllers
14. houtCardholder As Boolean False Optional ByVal EraseOption As EraseOptions EraseOptions AllDB NoBuffer Where EraseOptions are EventBufferOnly AIIDBExceptCardholder CardholderOnly EventBuffer And AIIDBExceptCardholder EventBuffer AndCardholder AIIDB NoBuffer ALL memory RecreateMemoryTables Send a request to initialize an existing controller db ControllerID cf Appendix B with recreation of memory tables 100 acAPI User Manual Issue July the 30th 2008 Page 8 25 Syntax Sub RecreateMemoryTables ByVal db ControllerID As Long SetRelayState Send a request to modify the relay state Activate the relay Inhibit the relay with the db OutputID cf Appendix B Syntax Sub SetRelayState ByVal db OutputID As Long ByVal RelayState As RelayStates Optional ByVal Delay As Integer 0 Where RelayStates are Normal e ConstantON e ConstantOFF e Delay Sample To activate the relay 1 Constant ON acDLL SetRelayState 1 acAPI API RelayStates ConstantON This command allows to control doors relays and other output e g alarm siren SetinputState Send a request to modify the Input state Deactivate Force activate the input with the db_InputID cf Appendix B Syntax Sub SetInputState ByVal db_InputID As Long ByVal InputState As InputStates Optional ByVal Delay As Integer 0 Where InputStates are e Normal e ConstantActivate e ConstantDeactivate e Delay Sample to return to
15. mic Fields e Multi site fields 100 acAPI User Manual Issue July the 30th 2008 Page 13 25 For more details about the import consult the user manual of GuardPointPro about import profiles 100 acAPI User Manual Issue July the 30th 2008 Page 14 25 Events AccessEvent Wake up the application when an Access event arrives We return an object AccessEventRecord that contains Properties of AccessEventRecord EventDate As Date EventType As EventTypes Access Granted Access Granted with Duress Code Access Denied Access Denied Too Much Trials Unknown Badge Unknown Badge Too Much Trials Non Allocated Badge ReaderName As String TransactionCode As Integer CardHolderName As String E t CardHolderPhotoFileName As String Denied WrongFinger As Boolean description Denied WrongKeypadCode As Boolean Denied FullorLock As Boolean Denied Time As Boolean Denied APB As Boolean Denied ReaderNotAllowed As Boolean Denied SiteCode As Boolean Denied InhibitedCardholder As Boolean Denied AccessGroup As Boolean isEscort As Boolean Denied EscortTimeout As Boolean Denied EscortNotAuthorized As Boolean db ReaderID As Long db ControllerID As Long 2 Database db_CardHolderID As Long db ReaderSocID As Long Fields db CardHolderSocID As Long reference db CameraID As Long Cf Appendix B d
16. ntType Case acAPI AlarmEventRecord EventTypes StartOfAlarm Immediate txt txt amp Start of Alarm Immediate Case acAPI AlarmEventRecord EventTypes StartOfAlarm Delayed txt 5 txt amp Start of Alarm Delayed Case acAPI AlarmEventRecord EventTypes EndOfAlarm txt txt amp End Of Alarm End Select txt txt amp From Input amp AlarmRec InputName e RichTextBoxl AppendText txt amp vbCrLf For more code sample see function Private Sub acDLL_AlarmEvent ByVal AlarmRec As acAPI AlarmEventRecord Handles acDLL AlarmEvent TechnicalEvent Wake up the application when a technical event arrives We return an object TechnicalEventRecord that contains Properties of TechnicalEventRecord EventDate As Date Event EventType As EventTypes ableError LowBattery PowerDown description 100 acAPI User Manual Issue July the 30th 2008 Page 16 25 For MEGA Only PowerSupplyFailure PowerSupplyOK BoxOpened BoxClosed ReaderDisconnected ReaderConnected PowerUp ReaderName As String ControllerName As String db ControllerID As Long Database Fields db ReaderlID As Long db SocID As Long reference db TableLOG ID As Long Cf Appendix B Sample Dim txt As String txt 5 TechRec EventDate amp Select Case TechRec EventType ypes PowerUp ypes
17. ocument is based on GuardPointPro Version 1 8 003 June 2008 Most of the commands are supported in previous versions but in order to simplify we will only work on the basis of the actual version To get the latest version of GuardPointPro consult http www sensoraccess co uk The communication with GuardPointPro is done by a communication engine called Spread For more information about Spread see www spread org Installation Unzip the zip file Install in your project folder the acAPI dll Add Reference to this DLL in your project 100 acAPI User Manual Issue July the 30th 2008 Page 4 25 Sample Program The acAPI dll is given with a sample program including its source code named Test AcAPLexe This project Test AcAPI was compiled with Visual Basic 2008 with compatibility with Framework v2 0 The source code of this program 15 delivered in the zip file Have a look at the program source code to help you to fast interface with the acAPI dll Properties DestinationPCName This property defines the PC we are sending it the commands Default value Current PC Name SpreadConfiguration This property defines how to connect to Spread Communication layer that we use to send the commands Default value 4803 localhost 100 acAPI User Manual Issue July the 30th 2008 Page 5 25 Methods ChangeUserLogin Send a request to change the user logged in by another one with the
18. teed eee 3 aia 3 Activ teA yS kinean riea REE TEE E ENES 3 ae Dale ncen E E 3 M 3 Oe i pas qud DEEST eR up UR eK PME RM UE 2 GetPirmate VebSIOfL S 3 a Eta arent vr REN REA EN 3 MG RR T NN RS 3 sour uil M 3 StopPO le P 3 ImportCardholdet 3 ce 2 PERE SSE VEU P 3 T 3 eas DENEN MUNDUS 3 USE VENT apg hehe wnt ice ies acca 3 3 ConmrallerCGommullicatoD tix Installing el ies vx pei 3 dus EE 3 TextForStatusBat 3 PEP OUD GAC TE tU s 3 SpreadPolling T
19. tinLog ByVal Text As String Sample acDLL InsertTextinLog Hi How are you InsertTextinStatusBar Send a request to insert message in the status bar and set the percent of the progress bar Syntax Sub InsertTextinStatusBar ByVal Text As String ByVal Percent As Byte Sample acDLL InsertTextinStatusBar Downloading Cardholders 30 PlaySound Send a request to play a sound file with the full path of the sound file Syntax Sub PlaySound ByVal SoundFile As String Sample acDLL PlaySound C Windows Media Windows Notify wav ExecuteAction Send a request to execute an existing action with db ActionID cf Appendix B 100 acAPI User Manual Issue July the 30th 2008 Page 7 25 Syntax Sub ExecuteAction ByVal db ActionID As Long Sample acDLL ExcecuteAction 1 ExecuteProcess Send a request to preview an existing process with db ProcessID cf Appendix B Syntax Sub ExecuteProcess ByVal db ProcessID As Long Sample acDLL ExecuteProcess 1 ExecuteApplication Send a request to execute an application file with the full path of the application file Syntax ExecuteApplication ByVal ApplicationPath As String Sample acDLL ExecuteApplication C Windows Calc exe InitializeController Send a request to initialize an existing controller db_ControllerID cf Appendix B Syntax Sub InitializeController ByVal db_ControllerID As Long Optional ByVal Wit
20. user name and password Syntax Sub ChangeUserLogin ByVal User As String ByVal Password As String Sample acDLL ChangeUserLogin user password OpenScreen Send a request to open a screen The command supports selecting on which record on which tab and the screen size Normal minimize or maximize Syntax Sub OpenScreen ByVal Screen As String Optional ByVal MinMax As Integer 0 Optional ByVal ViewPhotoListReader As Long 0 Optional ByVal onRecordID As Long 0 Optional ByVal onTabNumber As Integer 0 Sample acDLL OpenScreen ID Cardholders Cf Appendix A Screens ID to get all the parameter according to the screen you want to open PreviewVideo Send a request to preview a camera live video with the db CameralID cf Appendix B Syntax Sub PreviewVideo ByVal db CameraID As Long Sample acDLL PreviewVideo 1 PreviewReport Send a request to preview an existing report with the report full name Syntax Sub PreviewReport ByVal ReportFile As String 100 acAPI User Manual Issue July the 30th 2008 Page 6 25 Sample acDLL PreviewReport C Program Files GuardPointPro Reports Last report rpx DisplayMessage Send a request to display a message box with the text Syntax Sub DisplayMessage ByVal Message As String Sample acDLL DisplayMessage Hi How are you InsertTextinLog Send a request to insert message in the Log windows Syntax Sub InsertTex
Download Pdf Manuals
Related Search