GuardPoint Pro XML APIs
Contents
1. ACCESSTECHNOLOGY How to send commands SpreadCmd for command without answer only Target D DEV GuardPoint Pro SpreadCmd exe DANIEL lt perform gt lt cmd gt DisplayMessage lt cmd gt lt param gt lt query gt lt Param1 gt Hi How are you lt Param1 gt lt query gt lt param gt lt perform gt Where DANIEL is the PC Name And GuardPoint Pro should be running XMLAPISample See the project source code in VB NET to see how to connect to Spread and send and receive XML message Note that GuardPoint Pro should already be running h Message Addressee lt perform gt lt cmd gt DisplayMessage lt cmd gt lt param gt lt query gt lt Param1 gt Hi How are you a DANIEL lt Param1 gt lt query gt lt param gt lt perform gt lt pertorm gt lt cmd gt WS_RetreshPendingCounter lt cmd gt lt param gt Ah lt param gt lt perform gt a lt perform gt lt cmd gt TreatE vent lt cmd gt lt param gt lt query gt lt ID gt 0 lt AID gt lt mD ate 26 12 2008 12 09 02 lt mD ate gt lt Tm_Type gt 25 lt Tm_Type gt lt From_Name gt Mega lt From_Name gt lt Desc1 gt 0 lt Desc1 gt lt Desc2 gt lt Desc2 gt lt Desc3 gt lt Dese3 gt lt Reader gt 0 lt Reader lt minput gt 0 lt mlinput gt lt Controller gt 1 lt Controllen lt Cardholder gt 0 lt Cardholder lt Use m0 lt Userm lt Soc gt 1 lt Soc gt lt Soc2 gt 0 lt Soc2 gt lt CH_Trans gt 0 lt CH_Trans gt lt Acknowledged gt 0 lt Acknowledged gt lt Confirmed gt2. ACCESSTECHNOLOGY GuardPoint Pro XML APIs TABLE OF CONTENTS Introduction 3 How to send receive commands 4 XML Structure 6 Methods 7 ChangeUserLogin 7 OpenScreen 7 PreviewVideo 7 PreviewReport 8 DisplayMessage 8 MenuPrint InsertTextinLog 8 FloodUpdateText InsertTextinStatusBar 9 PlaySound 9 ExecuteAction 9 ExecuteProcess 10 CC_RecreateMemoryTables RecreateMemoryTables 10 ActivateRelay SetRelayState 10 OutputAction SetRelayState 11 Activatelnput SetinputState 11 ActivateDeactivelnput SetinputState 11 ActiveDeactivelnputGroup SetInputGroupState 12 Methods with answer 13 GetTimeDate 13 GetDigitallnputStatus 13 GetHardwareVersion 14 GetFirmareVersion 14 GetMemoryOccupation 15 isPollingNow 15 StartPolling 16 StopPolling 16 ImportCardholder 17 Events 21 TreatEvent 21 ControllerCommunicationError 23 ControllerCommunicationOK 23 Refresh_ioXML 23 Appendix A Screens ID 25 Appendix B Database Fields 26 Appendix C Transaction Type 27 Appendix D Denied Reasons 28 sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs Introduction This document is dedicated to explain the existing XML API of GuardPoint Pro It allows an easy integration with Sensor Access control and alarm monitoring software called GuardPoint Pro This means that an external application could receive many information from GuardPoint Pro such as online events of acc
3. 0 lt Confirmed gt lt tmpStyle gt 0 lt tmpS tyle gt lt NoLogHistory gt 0 lt NoLogHistory gt lt EmpPhoto gt lt EmpPhoto gt lt isDoorContact gt 0 lt is DoorContact gt lt isR TX gt 0 lt isR TX gt lt DoorN ame gt lt DoorN ame gt lt CameralD gt 0 lt CameralD gt lt query gt lt patam gt lt pertorm gt lt perform gt lt cmd gt WS_RefreshPendingCounter lt cmd gt lt param gt Ah lt param gt lt perform gt The example uses a DLL libtspd dll compiled for Windows plateform a9 Ford sco For other platforms please visit www spread org or specifically the page on supported platforms www spread org SpreadPlatforms html Linux Mac Note the spread version used by GuardPoint Pro is version 3 17 GuardPoint Pro build the conf file and start the spread daemon on its computer from the definitions of PCs in GuardPoint Pro software If you need to work from another PC there are 2 solutions Run a local daemon and connect to you local daemon 4803 localhost Do not run any local daemon and connect to GuardPoint Pro PC daemon by connecting to 4803 lt PCName or IP of GuardPoint Pro PC gt www sensoraccess co uk sales sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs How to receive events messages In previous versions of GuardPoint Pro it was enough to listen to group gui to receive all type of events from any sites From version 1 8 206
4. lt ID gt lt ID gt lt Supervisor gt 1 lt Supervisor gt lt Label_1 gt lt Label_1 gt lt Label_2 gt lt Label_2 gt lt Label_3 gt lt Label_3 gt lt Label_4 gt lt Label_4 gt lt Company gt lt Company gt lt Lift_Program gt lt Lift_Program gt lt Parking_Users_Group gt lt Parking_ Users Group gt lt MultiSite_Type gt 0 lt MultiSite_Type gt lt Site gt lt Site gt lt Personal_WP gt lt Personal_WP gt lt Personal_CL gt 0 lt Personal_CL gt lt Keep_card_on_motorized_reader gt 1 lt Keep_card_on_motorized_reader gt lt No_APB gt 1 lt No_APB gt lt No_access_during_holidays gt 1 lt No_access_during_holidays gt lt Reset_APB gt 1 lt Reset_APB gt lt Need_Escort gt 1 lt Need_Escort gt lt Badge Printing Layout gt lt Badge Printing Layout gt lt Visited_person gt lt Visited_person gt lt Visited_person_location gt lt Visited_person_location gt lt Visit_purpose gt lt Visit_purpose gt lt Eye_Color gt Blue lt Eye_Color gt lt query gt lt param gt lt perform gt The import creates the cardholder e the badge e the access group if not found e the department if not found e the lift program if not found e 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 e Dynamic Fields Multi site fields For more details about the import consult the user m
5. Appendix B NetID db_NetwokID cf Appendix B SyncID see GetTimeDate explanation AnswerID see GetTimeDate explanation Example lt perform gt lt cmd gt StartPolling lt cmd gt lt param gt lt query gt lt CtrID gt 0 lt CtriID gt lt NetID gt 0 lt NetID gt lt SynclID gt 2 lt SynclD gt lt AnswerlD myID API_DANIEL gt lt query gt lt param gt lt perform gt Note that we send a SyncID even if we do not require a answer in order to force GuardPoint Pro to finish this request before processing another request StopPolling Send a request to Stop Polling the controllers You can specify a specific controller Without defining any controller CtrID 0 it stops all the communication polling with the controllers Syntax Cmd StopPolling Parameters CtrID db_ControllerlD cf Appendix B SyncID see GetTimeDate explanation AnswerID see GetTimeDate explanation Example lt perform gt lt cmd gt StopPolling lt cmd gt lt param gt lt query gt lt CtrID gt 0 lt CtriID gt lt SyncID gt 3 lt SyncID gt lt Answer ID mylD API_DANIEL gt lt query gt lt param gt lt perform gt Note that we send a SyncID even if we do not require a answer in order to force GuardPoint Pro to finish this request before processing another request sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs ImportCardholder Send a request to import a cardholder
6. co uk 44 0 1273 242 355
7. is used to is used to set a input state that remain permanently until next change Syntax Cmd ActivateDeactivelnput Parameters InputID db_InputID cf Appendix B CodeAction action code 0 for Normal mode 8 for Deactivated 9 for Activated Example to deactivate input ID 1 lt perform gt lt cmd gt ActivateDeactivelnput lt cmd gt lt param gt lt query gt lt InputID gt 1 lt InputID gt lt CodeAction gt 8 lt CodeAction gt lt query gt lt param gt lt perform gt This command allows to control alarms sensors to be arm or not sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs ActiveDeactivelnputGroup SetInputGroupState Send a request to modify the Input group state Deactivate Force activate the input group with the db_InputGroupID cf Appendix B Syntax Cmd ActiveDeactivelnputGroup Parameters InputGroupID db_InputGroupID cf Appendix B InputGroupMode action code 9 for Disarm during x seconds 10 for Disarm during x minutes 11 for Constant deactivated 12 for Return to normal mode Cancel previous delay 13 for Disarm until next time zone 14 for Activate during x seconds 15 for Activate during x minutes 16 for Constant activated 17 for Normal to normal mode Cancel previous delay 18 for Arm until next time zone Delay x seconds 1 to 60 seconds 1 191 minutes Example To disarm the input group 1 during 30
8. Trn_Type gt 10 lt Trn_Type gt lt From_Name gt i01 Mega lt From_Name gt lt Desc1 gt 0 lt Desci gt lt Desc2 gt lt Desc2 gt lt Desc3 gt lt Desc3 gt lt Reader gt 0 lt Reader gt lt mIinput gt 1 lt minput gt lt Controller gt 1 lt Controller gt lt Cardholder gt 0 lt Cardholder gt lt User gt 0 lt User gt lt Soc gt 1 lt Soc gt lt Soc2 gt 0 lt Soc2 gt lt CH_Trans gt 0 lt CH_Trans gt lt Acknowledged gt 0 lt Acknowledged gt lt Confirmed gt 0 lt Confirmed gt lt tmpStyle gt 0 lt tmpStyle gt lt NoLogHistory gt 0 lt NoLogHistory gt lt EmpPhoto gt lt EmpPhoto gt lt isDoorContact gt 1 lt isDoorContact gt lt isRTX gt 0 lt isRTX gt lt DoorName gt Rdr01 Mega lt DoorName gt lt CameralD gt 0 lt CameralD gt lt query gt lt param gt lt perform gt 16 12 08 14 53 03 Start of Alarm From input i01 Mega Immediate Door forced Rdr01 1C4000 sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs ControllerCommunicationError Wake up the application when a controller starts to be in Communication error It returns the text to be displayed in Log windows Example lt perform gt lt cmd gt PollingError lt cmd gt lt param gt lt query gt lt Text gt 16 12 2008 15 32 38 263 Communication error Mega Error 263 Timeout lt Text gt lt CtrSoc gt 1 lt CtrSoc gt lt query gt lt param gt lt perform gt ControllerCcommunicationOK Wake up
9. _DANIEL gt lt query gt lt param gt lt perform gt Response from GuardPoint Pro lt perform gt lt cmd gt syncGetResult lt cmd gt lt param gt lt query gt lt SynclD gt 8 lt SynclID gt lt Answer gt 16 12 2008 15 53 50 lt Answer gt lt query gt lt param gt lt perform gt sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs GetDigitallnputStatus Send a request to get the input and output status of a controller db_Controller lD cf Appendix B It returns the logical state of the input physical state according to NO NC and the Syntax Cmd GetDigitallnputStatus Parameters CtrID db_ControllerID cf Appendix B SyncID see GetTimeDate explanation AnswerID see GetTimeDate explanation The returned string is build of 0 1 in the following order Inputs 1 16 Relays 1 64 Inputs 17 24 Mega specific indication R1 R2 R3 R4 PSF MS 0 O for Reader1 to 4 R1 R4 1 if connected 0 if not connected PSF Power Supply Failure input on board MS MS input on board to indicate if box open or not and two last values not used always 0 Example Sent to GuardPoint Pro lt perform gt lt cmd gt GetDigitallnputStatus lt cmd gt lt param gt lt query gt lt CtrID gt 1 lt CtriID gt lt SynclD gt 3 lt SynclD gt lt AnswerlD myID API_DANIEL gt lt query gt lt param gt lt perform gt Response from GuardPoint Pro
10. ame gt lt DoorName gt lt CameralD gt 0 lt CameralD gt lt query gt lt param gt lt perform gt 16 12 08 14 41 47 Access Denied Smith John 00000003 From reader Rdr02 IC4000 Not Authorized at this time sales sensoraccess co uk 44 0 1273 242 355 www sensoraccess co uk ACCESSTECHNOLOGY GuardPoint Pro XML APIs lt perform gt lt cmd gt TreatEvent lt cmd gt lt param gt lt query gt lt ID gt 0 lt ID gt lt mDate gt 16 12 2008 14 53 02 lt mDate gt lt Trn_Type gt 11 lt Trn_Type gt lt From_Name gt i05 Mega lt From_Name gt lt Desc1 gt 2 lt Desci gt lt Desc2 gt lt Desc2 gt lt Desc3 gt lt Desc3 gt lt Reader gt 0 lt Reader gt lt mInput gt 5 lt minput gt lt Controller gt 1 lt Controller gt lt Cardholder gt 0 lt Cardholder gt lt User gt 0 lt User gt lt Soc gt 1 lt Soc gt lt Soc2 gt 0 lt Soc2 gt lt CH_Trans gt 0 lt CH_Trans gt lt Acknowledged gt 0 lt Acknowledged gt lt Confirmed gt 0 lt Confirmed gt lt tmpStyle gt 0 lt tmpStyle gt lt NoLogHistory gt 0 lt NoLogHistory gt lt EmpPhoto gt lt EmpPhoto gt lt isDoorContact gt 0 lt isDoorContact gt lt isRTX gt 0 lt isRTX gt lt DoorName gt lt DoorName gt lt CameralD gt 0 lt CameralD gt lt query gt lt param gt lt perform gt 16 12 08 14 53 02 End of alarm From input i05 1C4000 lt perform gt lt cmd gt TreatEvent lt cmd gt lt param gt lt query gt lt ID gt 0 lt ID gt lt mDate gt 16 12 2008 14 53 03 lt mDate gt lt
11. anual of GuardPoint Pro about import profiles sales sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs Events TreatEvent Wake up the application when information to be displayed in Log windows arrives Syntax Cmd TreatEvent Parameters SynclD see GetTimeDate explanation AnswerID see GetTimeDate explanation Trn_Type Transaction type see Appendix C Aececcarantea Access Unknown Start of End of Technical 9 denied Card Alarm Alarm Alarm db_TableLOG_ID cf Appendix B Date of the event From_Name Input Name Eea Reader name name 0 if immedi Transaction code ate 1 if delayed Desc2 Denied Reasons see Appendix D EmpPhoto Filename of the employee photo ES if comes from Alarm priority bus DoorName Reader name if RTX or a a contact db_ReaderlD cf Appendix B sales sensoraccess co uk 44 0 1273 242 355 www sensoraccess co uk ACCESSTECHNOLOGY GuardPoint Pro XML APIs e a a e EE D E S E Acknowledged oe tm db_CameralD cf Appendix B Examples lt perform gt lt cmd gt TreatEvent lt cmd gt lt param gt lt query gt lt ID gt 0 lt ID gt lt mDate gt 16 12 2008 14 40 57 lt mDate gt lt Trn_Type gt 1 lt Trn_Type gt lt From_Name gt Rdr01 Mega lt From_Name gt lt Desc1 gt 0 lt Desc1 gt lt Desc2 gt 0 lt Desc2 gt lt Desc3 gt Smith John 00000003 lt Desc3 gt lt Reader gt 1 lt Reader gt lt minput gt 0 lt mInput gt lt Contro
12. ess control system s Access granted Access denied Start of Alarm and act on Access control system s by o Creating cardholders oO 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 GuardPoint Pro Login Logoff User interface messages on screen Download configuration to controllers that may be updated directly in DB by an external application GuardPoint Pro has also other integration gateway such as OPC ModbusTCP e Wizcon GuardPoint Pro has existing integration with Visitor management application Telemaque www safeware fr_ Windows account management ISLOG www islog eu LPR Zamir Outdoor Perimeter Security Systems www magal co il Integration with RFID Readers on Pocket PC PDA External Events Reception of ONSSI Video Systems alarms External Events 00000 The document is based on GuardPoint Pro 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 The communication with GuardPoint Pro is done by a communication engine called Spread For more infor mation about Spread see www spread org sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 GuardPoint Pro XML APIs
13. gram ID_ParkingDefinition ID_Company ID_ZonelD ID_User ID_AuthorisationsLevels ID_Icons www sensoraccess co uk Authorisation Levels Icons Symbols sales sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs ID_LiftAuthorisationGroups Lift Authorisation group only when Lift per Read er sales sensoraccess co uk 44 0 1273 242 355 www sensoraccess co uk ACCESSTECHNOLOGY GuardPoint Pro XML APIs Appendix B Database Fields The database fields db_ControllerlD db_ReaderID db_InputID db_OuputID db_NetworkID db_SoclD db_ReaderSoclD db_CardHolderSoclD db_TableLOG_ID db_CardHolderlD db_CameralD db_InputGroupID db_ActionID db_Process ID www sensoraccess co uk Eo Select ID Name from SOC Select ID from LOG Select ID Last_Name amp amp First_Name as Name from CRDHLD sales sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs Appendix C Transaction Type The TRN_TYPE is describe in Param database in table Log Events 1 Access Granted 90 Arrival 2 Access Granted Duress code 91 Early Arrival 3 Access Denied 92 No arrival on time 4 Access Denied unsuccessful successive trials 93 Late Arrival 10 Start of Alarm 94 Start guard tour 11 Endofalarm 100 Scheduler 12 Line short 200 Initialize Controller 13 Line cut 14 Status 1 Analog Input 15 Status 2 Analog Input 16 S
14. gt 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 Cmd OpenScreen Parameters Param1 ScreenID Cf Appendix A Param3 MinMax 0 Normal 1 Minimized 2 Maximized Param4 Only for Display Photo screen onRecordID on which record ID onTabNumber on which tab number starting from 0 Example lt perform gt lt cmd gt OpenScreen lt cmd gt lt param gt lt query gt lt Param1 gt ID_Cardholders lt Param1 gt lt Param3 gt 0 lt Param3 gt lt Param4 gt 0 lt Param4 gt lt onRecordID gt 0 lt onRecord ID gt lt onTabNumber gt 0 lt onTabNumber gt lt query gt lt param gt lt perform gt Cf Appendix A Screens ID to get all the parameter according to the screen you want to open sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs PreviewVideo Send a request to preview a camera live video with the db_CameralD cf Appendix B Syntax Cmd PreviewVideo Parameters Param1 db_CameralD cf Appendix B Note that this command should be sent to the PC name in uppercase where we want the display video to be open Example lt perform gt lt cmd gt PreviewVideo lt cmd gt lt param gt lt query gt lt Param1 gt 1 lt Param1 gt lt query gt lt param gt lt perform gt PreviewReport Send a request to preview an exist
15. in the database and inform the controllers This allows adding updating or deleting cardholders Syntax Cmd ImportOneCardHolderXML Parameters SynclD see GetTimeDate explanation Supervisor AnswerlD see GetTimeDate explanation Label_1 Number Label_2 Last_Name name of the cardholder Label_3 First_Name first name Label_4 Type Company O for Cardholder Lift_Program name of lift Program 1 for Visitor Parking Users_Group name of Parking User Group 2 for Guard MultiSite_Type 3 for Deleted 0 for Local Badge badge code most of the time 8 digits 1 for Shared Technology 2 for Global 1 for Magnetic Site name of the site 2 for BarCode Personal_WP name of the Weekly Program 3 for Wiegand Personal_CL value of the Crisis Level 0 7 4 for Wiegand2 Keep_card_on_motorized_reader 1 for True O for False 5 for WiegandKeypad No_APB 1 for True O for False 6 for BioSmartCard No_access_during_holidays 1 for True 0 for False 7 for Touch Reset_APB 1 for True O for False 8 for Radio Need_Escort 1 for True 0 for False Photo file name of the picture Badge _Printing_Layout Department name of the department Visited_person Office_Phone Visited_person_location Access_Group name of the access groups separated with Visit_purpose PIN_code 4 digits From_Date To_Date Validated 1 for True O for False Street City ZIP Eye Color This field is an example of Customized Fields They should be added i
16. ing report with the report full name Syntax Cmd PreviewReport Parameters Param1 report full name with path Example lt perform gt lt cmd gt PreviewReport lt cmd gt lt param gt lt query gt lt Param1 gt D DEV GuardPoint ProAPI Reports Last report rpx lt Param1 gt lt query gt lt param gt lt perform gt DisplayMessage Send a request to display a message box with the text Syntax Cmd DisplayMessage Parameters Param1 message text Example lt perform gt lt cmd gt DisplayMessage lt cmd gt lt param gt lt query gt lt Param1 gt Hi How are you lt Param1 gt lt query gt lt param gt lt perform gt sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs MenuPrint InsertTextinLog Send a request to insert message in the Log windows of GuardPoint Pro Syntax Cmd MenuPrint Parameters st message text Soc 1 by default Use to filter information on Multi site Multi company installation only mStyle Event Type Will be display with the same color as defined for the event specified JustinLog Not used inViewPhotoAlso Not used Example lt perform gt lt cmd gt MenuPrint lt cmd gt lt param gt lt query gt lt st gt Hi How are you lt st gt lt Soc gt 1 lt Soc gt lt mStyle gt 0 lt mStyle gt lt JustinLog gt 0 lt JustinLog gt lt inViewPhotoAlso gt 0 lt inViewPhotoAlso gt lt query gt lt param gt lt pe
17. ix B Example lt perform gt lt cmd gt ExecuteProcess lt cmd gt lt param gt lt query gt lt pID gt 1 lt pID gt lt query gt lt param gt lt perform gt CC_RecreateMemoryTables RecreateMemoryTables Send a request to initialize an existing controller db_ControllerlD cf Appendix B with recreation of memory tables Syntax Cmd CC_RecreateMemoryTables Parameters CtrID db_ControllerlD cf Appendix B ReStartPolling WantClearMemory Example lt perform gt lt cmd gt CC_RecreateMemoryTables lt cmd gt lt param gt lt query gt lt CtrID gt db_ControllerID lt CtriD gt lt ReStartPolling gt O lt ReStartPolling gt lt WantClearMemory gt 1 lt WantClearMemory gt lt query gt lt param gt lt perform gt sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs ActivateRelay SetRelayState Send a request to modify the relay state with the db_OutputID cf Appendix B Activate relay is only to acti vate a relay few seconds Syntax Cmd ActivateRelay Parameters OutputID db_OutputID cf Appendix B Delay x seconds 1 to 120 seconds Example to activate relay ID 1 during 3 sec lt perform gt lt cmd gt ActivateRelay lt cmd gt lt param gt lt query gt lt OutputID gt 1 lt OutputID gt lt Delay gt 3 lt Delay gt lt query gt lt param gt lt perform gt OutputAction SetRelayState Send a request to modify the relay state with
18. ller gt 1 lt Controller gt lt Cardholder gt 4 lt Cardholder gt lt User gt 0 lt User gt lt Soc gt 1 lt Soc gt lt Soc2 gt 1 lt Soc2 gt lt CH_Trans gt 1 lt CH_Trans gt lt Acknowledged gt 0 lt Acknowledged gt lt Confirmed gt 0 lt Confirmed gt lt tmpStyle gt 0 lt tmpStyle gt lt NoLogHistory gt 0 lt NoLogHistory gt lt EmpPhoto gt lt EmpPhoto gt lt isDoorContact gt 0 lt isDoorContact gt lt isRTX gt 0 lt isRTX gt lt DoorName gt lt DoorName gt lt CameralD gt 0 lt CameralD gt lt query gt lt param gt lt perform gt 16 12 08 14 40 57 Access Granted Smith John 00000003 From reader Rdr01 IC4000 lt perform gt lt cmd gt TreatEvent lt cmd gt lt param gt lt query gt lt ID gt 0 lt ID gt lt mDate gt 16 12 2008 14 41 47 lt mDate gt lt Trn_Type gt 3 lt Trn_Type gt lt From_Name gt Rdr02 Mega lt From_Name gt lt Desc1 gt 0 lt Desc1 gt lt Desc2 gt 8 lt Desc2 gt lt Desc3 gt Smith John 00000003 lt Desc3 gt lt Reader gt 2 lt Reader gt lt minput gt 0 lt mInput gt lt Controller gt 1 lt Controller gt lt Cardholder gt 4 lt Cardholder gt lt User gt 0 lt User gt lt Soc gt 1 lt Soc gt lt Soc2 gt 1 lt Soc2 gt lt CH_Trans gt 1 lt CH_Trans gt lt Acknowledged gt 0 lt Acknowledged gt lt Confirmed gt 0 lt Confirmed gt lt tmpStyle gt 0 lt tmpStyle gt lt NoLogHistory gt 0 lt NoLogHistory gt lt EmpPhoto gt lt EmpPhoto gt lt isDoorContact gt 0 lt isDoorContact gt lt isRTX gt 0 lt isRTX gt lt DoorN
19. lt perform gt lt cmd gt syncGetResult lt cmd gt lt param gt lt query gt lt SynclD gt 3 lt Syn clD gt lt Answer gt 00000000000000000000000000000000000000000000000000000000000000000000000000000 00000000000 11001100 lt Answer gt lt query gt lt param gt lt perform gt sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs GetHardwareVersion Send a request to get the hardware version of a controller db_Controller D cf Appendix B It returns a string For more information consult the TPL User Manual Syntax Cmd GetHardwareVersion Parameters CtrID db_ControllerlD cf Appendix B SyncID see GetTimeDate explanation AnswerID see GetTimeDate explanation To understand the string return please consult the TPL user manual Example Sent to GuardPoint Pro lt perform gt lt cmd gt GetHardwareVersion lt cmd gt lt param gt lt query gt lt CtrID gt 1 lt CtrID gt lt SynclD gt 5 lt SynclD gt lt AnswerlD mylD API_DANIEL gt lt query gt lt param gt lt perform gt Response from GuardPoint Pro lt perform gt lt cmd gt syncGetResult lt cmd gt lt param gt lt query gt lt SyncID gt 5 lt SynclD gt lt Answer gt 09 00 61 61 00 00 01 10 C7 07 lt Answer gt lt query gt lt param gt lt perform gt GetFirmareVersion Send a request to get the firmware version of a controller db_ControllerlD cf Appendix B It returns the Eprom date a
20. n the XML in order to import them sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs Example Sent to GuardPoint Pro lt perform gt lt cmd gt ImportOneCardHolderxXML lt cmd gt lt param gt lt query gt lt SynclD gt 17 lt SynclD gt lt AnswerlD myID API_DANIEL gt lt Number gt Dir784 lt Number gt lt Last_Name gt Smith lt Last_Name gt lt First_Name gt John lt First_Name gt lt Type gt 1 lt Type gt lt Badge gt 12345678 lt Badge gt lt Technology gt 3 lt Technology gt lt Photo gt lt Photo gt lt Department gt lt Department gt lt Office_Phone gt lt Office_Phone gt lt Access_Group gt Anytime Anywhere lt Access_Group gt lt PIN_code gt lt PIN_code gt lt From_Date gt 01 01 2008 08 00 00 lt From_Date gt lt To_Date gt lt To_Date gt lt Validated gt 1 lt Validated gt lt Street gt lt Street gt lt City gt lt City gt lt ZIP gt lt ZIP gt lt Personal_Phone gt lt Personal_Phone gt Response from GuardPoint Pro The answer contains the result 0 for UpdateSuccessfully 1 for InsertSuccessfully 10 for MandatoryFieldMissing 11 for UpdateFailed 12 for InsertFailed 13 for AuthorisationExcedded 14 for CannotChangeGuard 15 for DuplicateName 16 for CardHolderDeleted 17 for BadgeCodeNotOK www sensoraccess co uk lt Description gt lt Description gt lt Car_Number gt lt Car_Number gt
21. nd checksum Syntax Cmd GetFirmareVersion Parameters CtrID db_ControllerID cf Appendix B SyncID see GetTimeDate explanation AnswerID see GetTimeDate explanation The returned string is the date and check sum of the firmware Example Sent to GuardPoint Pro lt perform gt lt cmd gt GetFirmareVersion lt cmd gt lt param gt lt query gt lt CtrID gt 1 lt CtriD gt lt SyncID gt 4 lt SynclD gt lt AnswerlID mylD API_DANIEL gt lt query gt lt param gt lt perform gt Response from GuardPoint Pro lt perform gt lt cmd gt syncGetResult lt cmd gt lt param gt lt query gt lt SynclID gt 4 lt SynclD gt lt Answer gt 10 07 08 3782 lt Answer gt lt query gt lt param gt lt perform gt sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs 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 Cmd GetMemoryOccupation Parameters CtrID db_ControllerID cf Appendix B SyncID see GetTimeDate explanation AnswerID see GetTimeDate explanation Example Sent to GuardPoint Pro lt perform gt lt cmd gt GetMemoryOccupation lt cmd gt lt param gt lt query gt lt CtrID gt 1 lt CtriD gt lt SyncID gt 6 lt SynclD gt lt AnswerlD mylD API_DANIEL gt lt query gt lt param gt lt perform gt Re
22. rform gt FloodUpdateText InsertTextinStatusBar Send a request to insert message in the status bar and set the percent of the progress bar Syntax Cmd FloodUpdateText Parameters pb percentage number 0 100 st message text srv Not used Example lt perform gt lt cmd gt FloodUpdateText lt cmd gt lt param gt lt query gt lt srv gt lt srv gt lt pb gt 50 lt pb gt lt st gt Hi How are you lt st gt lt query gt lt param gt lt perform gt PlaySound Send a request to play a sound file with the full path of the sound file Syntax Cmd PlaySound Parameters Param1 sound file full name with path Example lt perform gt lt cmd gt PlaySound lt cmd gt lt param gt lt query gt lt Param1 gt C Windows Media Windows Notify wav lt Param1 gt lt query gt lt param gt lt perform gt sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs ExecuteAction Send a request to execute an existing action with db_ActionID cf Appendix B Syntax Cmd ExecuteAction Parameters pID db_ActionID cf Appendix B Example lt perform gt lt cmd gt ExecuteAction lt cmd gt lt param gt lt query gt lt p ID gt 1 lt pID gt lt query gt lt param gt lt perform gt ExecuteProcess Send a request to preview an existing process with db_ProcessID cf Appendix B Syntax Cmd ExecuteProcess Parameters pID db_ProcessID cf Append
23. seconds lt perform gt lt cmd gt ActiveDeactivelnputGroup lt cmd gt lt param gt lt query gt lt InputGroupID gt 1 lt InputGroupID gt lt InputGroupMode gt 9 lt InputGroupMode gt lt Delay gt 30 Delay gt lt query gt lt param gt lt perform gt Example To arm the input group 1 during 15 minutes lt perform gt lt cmd gt ActiveDeactivelnputGroup lt cmd gt lt param gt lt query gt lt InputGroupID gt 1 lt InputGroupID gt lt InputGroupMode gt 15 lt InputGroupMode gt lt Delay gt 10 lt Delay gt lt query gt lt param gt lt perform gt This command allows to control alarm zones defined as group of inputs to be arm or not sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs Methods with answer GetTimeDate Send a request to get the time and date of a controller db_ControllerID cf Appendix B Syntax Cmd GetTimeDate Parameters CtrID db_ControllerlD cf Appendix B SyncID as the answer is return asynchronously we define an number in the question that is returned in the answer to know the link between the answer and the question AnswerID contains in mylD the group to whom the GuardPoint Pro server should answer We recommend to make such a group per PC Example Sent to GuardPoint Pro lt perform gt lt cmd gt GetTimeDate lt cmd gt lt param gt lt query gt lt CtrID gt 1 lt CtrID gt lt SyncID gt 8 lt SyncID gt lt AnswerlD mylD API
24. sponse from GuardPoint Pro lt perform gt lt cmd gt syncGetResult lt cmd gt lt param gt lt query gt lt SyncID gt 6 lt SynclD gt lt Answer gt 9 lt Answer gt lt query gt lt param gt lt perform gt isPollingNow Send a request to know if currently we are polling or not the controllers It returns True False Syntax Cmd GetMemoryOccupation Parameters CtrID db_ControllerlD cf Appendix B SynclD see GetTimeDate explanation AnswerID see GetTimeDate explanation Example Sent to GuardPoint Pro lt perform gt lt cmd gt isPollingNow lt cmd gt lt param gt lt query gt lt SynclD gt 7 lt SyncID gt lt AnswerlD mylD API_DANIEL gt lt query gt lt param gt lt perform gt Response from GuardPoint Pro lt perform gt lt cmd gt syncGetResult lt cmd gt lt param gt lt query gt lt SyncID gt 7 lt SynclD gt lt Answer gt 1 lt Answer gt lt query gt lt param gt lt perform gt sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs StartPolling Send a request to Start Polling the controllers 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 CtriD 0 it starts the com munication polling with all the controllers Syntax Cmd StartPolling Parameters CtrID db_ControllerlD cf
25. tatus 3 Analog Input 17 Status 4 Analog Input 22 Table Error 23 Low Battery 24 Power Down 25 PowerUp 26 Power Supply Failure input PSF closed 27 Power Supply OK input PSF opened 28 Box Opened input MS opened 29 Box Closed input MS closed 31 Communication OK 32 Communication Error 33 Satellite alarm 3 Reader disconnected 35 Reader connected 40 User Acknowledgment 50 User Confirmation 51 User Comment 61 Unknown Card 62 Unknown card unsuccessful successive trials 63 Non Allocated Badge 70 New record 71 Save record 72 Delete record 81 Application Login 82 Application Logout sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs Appendix D Denied Reasons The denied reasons is decimal value that indicate a combination of 8 reasons If the value 250 means Supervisor If the value 255 means Access Group For other values the value should be change in binary 1 wrong finger 2 Wrong Keypad Code 4 Full Lock No answer from Door 8 Not Authorized at this time 16 Anti Pass Back 32 Reader not allowed 64 Site Code not ok 128 Inhibited Cardholder If escort 1 Card Unknown 2 Wrong Keypad Code 4 No card after 10 sec 8 Not Authorized at this time 16 Anti Pass Back 32 Inhibited Cardholder 64 Site Code not ok 128 Escort not authorized sales sensoraccess co uk www sensoraccess
26. the application when a controller returns to be in Communication OK It returns the text to be displayed in Log windows Example lt perform gt lt cmd gt ComOK lt cmd gt lt param gt lt query gt lt Text gt 16 12 2008 15 33 58 Communication OK Mega lt Text gt lt CtrSoc gt 1 lt CtrSoc gt lt query gt lt param gt lt perform gt Refresh_ioXML Wake up the application when changes on input output status logical status arrives It returns the states of all input outputs of all the controllers Cf GetDigitallnputStatus methods for the format of the io string Example lt perform gt lt cmd gt Refresh_ioXML lt cmd gt lt param gt lt io server DANIEL gt lt ctr1 io 0000100000000000000000000000000000000000000000000000000000000000000000000000000000000 000 11001100 server DANIEL gt lt ctr2 io 1000000000000000000000000000000000000000000000000000000000000000000000000000000000000 000 11001100 server DANIEL gt lt io gt lt param gt lt perform gt sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs Appendix A Screens ID ID_APBLevel ID_Area ID_ Departement ID_Diagnostic ID_Visitor ID_AccessGroup ID_Actions ID_Badge ID_Cardholders ID_Computer ID_Configuration ID_Controllers ID_Counters ID_DailyProgram ID_EventHandlingProgram ID_GlobalReflex ID_InputGroup ID_OutputGroup ID_ Holiday ID_Log ID_Network ID_Process ID_WeeklyPro
27. the db_OutputID cf Appendix B OutputAction is used to set a relay state that remain permanently until next change Syntax Cmd OutputAction Parameters OutputID db_OutputID cf Appendix B Action action code 1 for normal mode 6 for constant on 7 for constant off Example to activate relay ID 1 constant on lt perform gt lt cmd gt OutputAction lt cmd gt lt param gt lt query gt lt OutputID gt 1 lt OutputID gt lt Action gt 6 lt Action gt lt query gt lt param gt lt perform gt Note this command update also the latest state of the relay in GuardPoint Pro This command allows to control doors relays and other output e g alarm siren sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs Activatelnput SetinputState Send a request to modify the Input state with the db_InputID cf Appendix B Activatelnput is used to pulse the input few seconds Syntax Cmd Activatelnput Parameters InputID db_InputID cf Appendix B Delay multiple x 200ms 1 to 255 x 200 ms Example to pulse input ID 1 during delay of 200 ms lt perform gt lt cmd gt Activatelnput lt cmd gt lt param gt lt query gt lt InputID gt 1 lt InputID gt lt Delay gt 1 lt Delay gt lt query gt lt param gt lt perform gt ActivateDeactivelnput SetinputState Send a request to modify the Input state with the db_InputID cf Appendix B ActivateDeactivelnput
28. we add an optimization that separate the unique listen group in many groups Now each client should listen to the followings groups names ag lt Site ID gt for Access granted ot_ lt Site ID gt for other type of events dp_ lt Site ID gt for debug info where Site ID is the site ID from table SOC io_ lt ServerlD gt for IO dynamic status Where Server ID is the ID of the server from table PC XML Structure All XML Sent to and from GuardPoint Pro has the following Structure lt perform gt lt cmd gt Name of the Command lt cmd gt lt param gt lt query gt lt Argument1 gt Value1 lt Argument1 gt lt Argument2 gt Value2 lt Argument2 gt lt Argument3 gt Value3 lt Argument3 gt lt ArgumentN gt ValueN lt ArgumentN gt lt query gt lt param gt lt perform gt The Cmd define the command name The param contains a list of arguments sales sensoraccess co uk www sensoraccess co uk 44 0 1273 242 355 ACCESSTECHNOLOGY GuardPoint Pro XML APIs Methods ChangeUserLogin Send a request to change the user logged in by another one with the user name and password Syntax Cmd ChangeUserLogin Parameters CmdLine us UserName pw password Where UserName and Password are the credential used in Login screen of GuardPoint Pro Example lt perform gt lt cmd gt ChangeUserLogin lt cmd gt lt param gt lt query gt lt CmdLine gt us 1000 pw 2000 lt CmdLine gt lt query gt lt param gt lt perform
Download Pdf Manuals
Related Search