DEXICON Enterprise Webservice-Interface V5.2.0 10/2019 DEXICON Enterprise Webservice-Interface V5.2.0 Warning and indicating symbols This warning symbol indicates hazards to your health and life (e.g. risk of coming into contact with mains voltage). You should always read and follow the text next to the symbol. This warning symbol indicates hazards that may cause damage to the device or system (malfunction, data loss, material damage, etc.) Text pointed out in this way requires you to do something. This symbol points to information that may facilitate your handling of the product or the use of this manual. DEXICON Enterprise Webservice-Interface V5.2.0 10/2019 PCS Systemtechnik GmbH Pfälzer-Wald-Str. 36, D-81539 Munich, Germany, Phone +49 - 89 - 68004-0 Home page: http://www.pcs.com Technical Support Phone: +49 - 89 - 68004-666 Fax: +49 - 89 - 68004-410 Email: [email protected] Copying this manual in whole or in parts is forbidden without the express authority of PCS Systemtechnik GmbH. The information in this manual is subject to changes so that we can maintain the state of the art at all times. PCS, INTUS, DEXICON, INTUS LBus and „PCS. The Terminal People.“ are trademarks or registered trademark of PCS Systemtechnik GmbH. All other brands and product names are trademarks or registered trademarks of the respective companies and organizations. Copyright 2019 by PCS Systemtechnik GmbH 2 10/2019 DEXICON Enterprise Webservice-Interface V5.2.0 Table of contents Warning and indicating symbols ................................................................................................... 2 1 Preface ........................................................................................................................... 7 1.1 Scope of this document .................................................................................................. 7 1.2 Additional manuals ........................................................................................................ 7 1.3 Using code examples ..................................................................................................... 7 2 Introduction .................................................................................................................. 9 2.1 Architecture of DEXICON Enterprise ........................................................................... 9 2.2 Properties of the Webservice-Interface .......................................................................... 9 2.2.1 Licensing ........................................................................................................................ 9 2.2.2 Accessible via Browser .................................................................................................. 9 2.3 Securing the Webservice-Interface .............................................................................. 10 3 Use cases ...................................................................................................................... 11 3.1 Attendance states ......................................................................................................... 11 3.1.1 Web attendance panel .................................................................................................. 11 3.1.2 Attendance report with SAP Crystal Reports .............................................................. 13 3.2 Reporting on time bookings ......................................................................................... 17 3.3 Archiving access records ............................................................................................. 18 3.4 Active Directory as person master record source ........................................................ 19 3.5 Integrating time recording with the PBX ..................................................................... 20 4 Protocol examples ...................................................................................................... 23 4.1 Person master records .................................................................................................. 23 4.1.1 Bulk synchronization of person master records ........................................................... 23 4.1.2 Creation of a single person master record .................................................................... 24 4.1.3 Update of a single person master record ...................................................................... 25 4.1.4 Reading person master records .................................................................................... 25 4.1.5 Deletion of a person master record .............................................................................. 26 4.2 Accesses ....................................................................................................................... 26 4.3 Attendance states ......................................................................................................... 27 4.3.1 Get attendance states .................................................................................................... 27 4.3.2 Set attendance states .................................................................................................... 29 5 REST API reference .................................................................................................. 31 5.1 Basics ........................................................................................................................... 32 5.1.1 Support for multiple superordinate systems................................................................. 32 5.1.1.1 Authentication .............................................................................................................. 32 5.1.1.2 Available actions .......................................................................................................... 33 5.1.2 HTTP/1.1 ..................................................................................................................... 33 5.1.2.1 Compliance .................................................................................................................. 33 5.1.2.2 Connection handling .................................................................................................... 33 5.1.3 Unicode ........................................................................................................................ 34 5.1.4 Character sets ............................................................................................................... 34 5.1.4.1 Byte order marks .......................................................................................................... 34 © PCS Systemtechnik GmbH 3 DEXICON Enterprise Webservice-Interface V5.2.0 5.1.4.2 HTTP-Authentication .................................................................................................. 34 5.1.4.3 URIs ............................................................................................................................. 35 5.1.5 Reliable transport ......................................................................................................... 35 5.1.6 Optimistic locking and caching ................................................................................... 35 5.1.7 Media type negotiation ................................................................................................ 35 5.2 REST methods ............................................................................................................. 35 5.2.1 Person master records .................................................................................................. 35 5.2.1.1 Operations on a single master record ........................................................................... 35 5.2.1.2 Setting the PIN of a single master record .................................................................... 36 5.2.1.3 Bulk synchronization ................................................................................................... 37 5.2.1.4 Attendance status ......................................................................................................... 37 5.2.1.5 Collections of person master records ........................................................................... 38 5.2.2 Authorizations and building logic ................................................................................ 40 5.2.2.1 Administration units..................................................................................................... 40 5.2.2.2 Roles ............................................................................................................................ 41 5.2.2.3 Areas ............................................................................................................................ 41 5.2.2.4 Time models ................................................................................................................ 42 5.2.2.5 Organization units ........................................................................................................ 43 5.2.2.6 Reader function groups (Authorization groups) .......................................................... 43 5.2.2.7 Companies ................................................................................................................... 44 5.2.3 Infrastructure ................................................................................................................ 44 5.2.3.1 INTUS COM administration units