IEC 60839-11-31:2016

IEC 60839-11-31 ®
Edition 1.0 2016-11
INTERNATIONAL
STANDARD
NORME
INTERNATIONALE
colour
inside
Alarm and electronic security systems –
Part 11-31: Electronic access control systems – Core interoperability protocol
based on Web services
Systèmes d'alarme et de sécurité électroniques –
Partie 11-31: Systèmes de contrôle d'accès électronique – Protocole de base
d’interopérabilité en fonction des services Web

All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or utilized in any form
or by any means, electronic or mechanical, including photocopying and microfilm, without permission in writing from
either IEC or IEC's member National Committee in the country of the requester. If you have any questions about IEC
copyright or have an enquiry about obtaining additional rights to this publication, please contact the address below or
your local IEC member National Committee for further information.

Droits de reproduction réservés. Sauf indication contraire, aucune partie de cette publication ne peut être reproduite
ni utilisée sous quelque forme que ce soit et par aucun procédé, électronique ou mécanique, y compris la photocopie
et les microfilms, sans l'accord écrit de l'IEC ou du Comité national de l'IEC du pays du demandeur. Si vous avez des
questions sur le copyright de l'IEC ou si vous désirez obtenir des droits supplémentaires sur cette publication, utilisez
les coordonnées ci-après ou contactez le Comité national de l'IEC de votre pays de résidence.

IEC Central Office Tel.: +41 22 919 02 11
3, rue de Varembé Fax: +41 22 919 03 00
CH-1211 Geneva 20 info@iec.ch
Switzerland www.iec.ch
About the IEC
The International Electrotechnical Commission (IEC) is the leading global organization that prepares and publishes
International Standards for all electrical, electronic and related technologies.

About IEC publications
The technical content of IEC publications is kept under constant review by the IEC. Please make sure that you have the
latest edition, a corrigenda or an amendment might have been published.

IEC Catalogue - webstore.iec.ch/catalogue Electropedia - www.electropedia.org
The stand-alone application for consulting the entire The world's leading online dictionary of electronic and
bibliographical information on IEC International Standards, electrical terms containing 20 000 terms and definitions in
Technical Specifications, Technical Reports and other English and French, with equivalent terms in 15 additional
documents. Available for PC, Mac OS, Android Tablets and languages. Also known as the International Electrotechnical
iPad. Vocabulary (IEV) online.

IEC publications search - www.iec.ch/searchpub IEC Glossary - std.iec.ch/glossary
The advanced search enables to find IEC publications by a 65 000 electrotechnical terminology entries in English and
variety of criteria (reference number, text, technical French extracted from the Terms and Definitions clause of
committee,…). It also gives information on projects, replaced IEC publications issued since 2002. Some entries have been
and withdrawn publications. collected from earlier publications of IEC TC 37, 77, 86 and

CISPR.
IEC Just Published - webstore.iec.ch/justpublished
Stay up to date on all new IEC publications. Just Published IEC Customer Service Centre - webstore.iec.ch/csc
details all new publications released. Available online and If you wish to give us your feedback on this publication or
also once a month by email. need further assistance, please contact the Customer Service
Centre: csc@iec.ch.
A propos de l'IEC
La Commission Electrotechnique Internationale (IEC) est la première organisation mondiale qui élabore et publie des
Normes internationales pour tout ce qui a trait à l'électricité, à l'électronique et aux technologies apparentées.

A propos des publications IEC
Le contenu technique des publications IEC est constamment revu. Veuillez vous assurer que vous possédez l’édition la
plus récente, un corrigendum ou amendement peut avoir été publié.

Catalogue IEC - webstore.iec.ch/catalogue Electropedia - www.electropedia.org
Application autonome pour consulter tous les renseignements
Le premier dictionnaire en ligne de termes électroniques et
bibliographiques sur les Normes internationales,
électriques. Il contient 20 000 termes et définitions en anglais
Spécifications techniques, Rapports techniques et autres
et en français, ainsi que les termes équivalents dans 15
documents de l'IEC. Disponible pour PC, Mac OS, tablettes
langues additionnelles. Egalement appelé Vocabulaire
Android et iPad.
Electrotechnique International (IEV) en ligne.

Recherche de publications IEC - www.iec.ch/searchpub
Glossaire IEC - std.iec.ch/glossary
65 000 entrées terminologiques électrotechniques, en anglais
La recherche avancée permet de trouver des publications IEC
en utilisant différents critères (numéro de référence, texte, et en français, extraites des articles Termes et Définitions des
comité d’études,…). Elle donne aussi des informations sur les publications IEC parues depuis 2002. Plus certaines entrées
projets et les publications remplacées ou retirées. antérieures extraites des publications des CE 37, 77, 86 et

CISPR de l'IEC.
IEC Just Published - webstore.iec.ch/justpublished

Service Clients - webstore.iec.ch/csc
Restez informé sur les nouvelles publications IEC. Just
Published détaille les nouvelles publications parues. Si vous désirez nous donner des commentaires sur cette
Disponible en ligne et aussi une fois par mois par email. publication ou si vous avez des questions contactez-nous:
csc@iec.ch.
IEC 60839-11-31 ®
Edition 1.0 2016-11
INTERNATIONAL
STANDARD
NORME
INTERNATIONALE
colour
inside
Alarm and electronic security systems –

Part 11-31: Electronic access control systems – Core interoperability protocol

based on Web services
Systèmes d'alarme et de sécurité électroniques –

Partie 11-31: Systèmes de contrôle d'accès électronique – Protocole de base

d’interopérabilité en fonction des services Web

INTERNATIONAL
ELECTROTECHNICAL
COMMISSION
COMMISSION
ELECTROTECHNIQUE
INTERNATIONALE
ICS 13.320 ISBN 978-2-8322-3778-6

– 2 – IEC 60839-11-31:2016 © IEC 2016
CONTENTS
FOREWORD . 10
INTRODUCTION . 12
1 Scope . 13
2 Normative references . 13
3 Terms, definitions and abbreviated terms . 15
3.1 Terms and definitions . 15
3.2 Abbreviated terms . 16
4 Overview . 17
4.1 General . 17
4.2 Web services . 17
4.3 IP configuration . 18
4.4 Device discovery . 18
4.5 Device management . 19
4.5.1 General . 19
4.5.2 Capabilities. 19
4.5.3 Network . 19
4.5.4 System . 20
4.5.5 Retrieval of system information . 20
4.5.6 Firmware upgrade . 20
4.5.7 SystemRestore . 20
4.5.8 Security . 20
4.6 DeviceIO . 21
4.7 Event handling . 21
4.8 Security . 21
5 Web services framework . 21
5.1 General . 21
5.2 Services overview . 22
5.2.1 General . 22
5.2.2 Services requirements . 22
5.3 WSDL overview . 22
5.4 Namespaces . 23
5.5 Types. 24
5.6 Messages . 24
5.7 Operations . 25
5.7.1 General . 25
5.7.2 One-way operation type . 26
5.7.3 Request-response operation type . 26
5.8 Port types . 27
5.9 Binding . 27
5.10 Ports . 27
5.11 Services . 28
5.12 Error handling . 28
5.12.1 General . 28
5.12.2 Protocol errors . 28
5.12.3 SOAP errors . 28
5.13 Security . 31

5.13.1 Authentication. 31
5.13.2 User-based access control . 31
5.14 String representation . 33
5.14.1 Character set . 33
5.14.2 Allowed characters in strings . 33
5.15 Proprietary extensions . 33
6 IP configuration . 33
7 Device discovery . 34
7.1 General . 34
7.2 Modes of operation . 34
7.3 Discovery definitions . 35
7.3.1 Endpoint reference . 35
7.3.2 Hello . 35
7.3.3 Probe and probe match . 36
7.3.4 Resolve and resolve match . 37
7.3.5 Bye . 37
7.3.6 SOAP fault messages . 37
8 Device management . 37
8.1 General . 37
8.2 Capabilities . 38
8.2.1 Get WSDL URL . 38
8.2.2 Capability exchange . 38
8.3 Network . 40
8.3.1 Get hostname . 40
8.3.2 Set hostname . 40
8.3.3 Set hostname from DHCP . 41
8.3.4 Get DNS settings . 41
8.3.5 Set DNS settings . 42
8.3.6 Get NTP settings . 42
8.3.7 Set NTP settings. 43
8.3.8 Get dynamic DNS settings . 43
8.3.9 Set dynamic DNS settings . 44
8.3.10 Get network interface configuration . 44
8.3.11 Set network interface configuration . 45
8.3.12 Get network protocols . 46
8.3.13 Set network protocols . 47
8.3.14 Get default gateway . 47
8.3.15 Set default gateway . 48
8.3.16 Get zero configuration . 48
8.3.17 Set zero configuration . 48
8.3.18 Get IP address filter . 49
8.3.19 Set IP address filter . 49
8.3.20 Add an IP filter address . 50
8.3.21 Remove an IP filter address . 50
8.3.22 IEEE 802.11 configuration . 51
8.4 System . 55
8.4.1 Device information . 55
8.4.2 Get system URIs . 55
8.4.3 Backup . 56

– 4 – IEC 60839-11-31:2016 © IEC 2016
8.4.4 Restore. 56
8.4.5 Start system restore . 57
8.4.6 Get system date and time . 57
8.4.7 Set system date and time . 58
8.4.8 Factory default. 59
8.4.9 Firmware upgrade . 59
8.4.10 Start firmware upgrade . 60
8.4.11 Get system logs . 61
8.4.12 Get support information . 61
8.4.13 Reboot. 62
8.4.14 Get scope parameters . 62
8.4.15 Set scope parameters . 62
8.4.16 Add scope parameters . 63
8.4.17 Remove scope parameters . 63
8.4.18 Get discovery mode . 64
8.4.19 Set discovery mode . 64
8.5 Security . 65
8.5.1 General . 65
8.5.2 Get access policy . 65
8.5.3 Set access policy . 65
8.5.4 Get users . 65
8.5.5 Create users . 66
8.5.6 Delete users . 67
8.5.7 Set users settings . 67
8.5.8 IEEE 802.1X configuration . 68
8.5.9 Create self-signed certificate . 71
8.5.10 Get certificates . 71
8.5.11 Get CA certificates . 71
8.5.12 Get certificate status . 72
8.5.13 Set certificate status . 72
8.5.14 Get certificate request . 72
8.5.15 Get client certificate status . 73
8.5.16 Set client certificate status . 73
8.5.17 Load device certificate . 74
8.5.18 Load device certificates in conjunction with its private key . 74
8.5.19 Get certificate information request . 75
8.5.20 Load CA certificates . 76
8.5.21 Delete certificate . 76
8.5.22 Get remote user . 76
8.5.23 Set remote user . 77
8.5.24 Get endpoint reference . 77
8.6 Auxiliary operation . 78
8.7 Monitoring events . 78
8.7.1 Processor usage . 78
8.7.2 Link status . 79
8.7.3 Upload status . 79
8.7.4 Operating time . 79
8.7.5 Environmental conditions . 81
8.7.6 Battery capacity . 81

8.7.7 Device management . 82
8.8 Service specific fault codes . 82
9 Device I/O . 86
9.1 General . 86
9.2 Relay outputs . 86
9.2.1 Overview . 86
9.2.2 Get relay outputs . 86
9.2.3 Get relay output options. 86
9.2.4 Set relay output settings . 87
9.2.5 Trigger relay output . 88
9.3 Digital inputs . 88
9.3.1 Overview . 88
9.3.2 GetDigitalInputs . 88
9.4 SerialPorts . 89
9.4.1 Overview . 89
9.4.2 GetSerialPorts . 89
9.4.3 GetSerialPortConfiguration . 89
9.4.4 SetSerialPortConfiguration . 89
9.4.5 GetSerialPortConfigurationOptions . 90
9.4.6 Send and/or Receive serial command . 90
9.5 Capabilities . 92
9.6 Events . 92
9.6.1 DigitalInput state change . 92
9.6.2 Relay output trigger . 92
9.7 Service specific fault codes . 93
10 Event handling . 93
10.1 General . 93
10.2 Real-time Pull-Point notification interface . 93
10.2.1 General . 93
10.2.2 Create pull point subscription . 95
10.2.3 Pull messages . 95
10.2.4 Renew . 96
10.2.5 Unsubscribe . 96
10.2.6 Seek . 97
10.2.7 Pull point lifecycle . 98
10.2.8 Persistent notification storage . 98
10.3 Basic notification interface . 98
10.3.1 General . 98
10.3.2 Summary . 98
10.3.3 Requirements . 99
10.4 Properties . 100
10.5 Notification structure . 100
10.5.1 General . 100
10.5.2 Notification information . 101
10.5.3 Message format . 102
10.5.4 Message description language . 103
10.5.5 Message content filter . 104
10.6 Synchronization point . 105
10.7 Topic structure . 105

– 6 – IEC 60839-11-31:2016 © IEC 2016
10.7.1 General . 105
10.7.2 ONVIF topic namespace . 106
10.7.3 Topic type information . 106
10.7.4 Topic filter . 107
10.8 Get event properties . 108
10.9 Capabilities . 108
10.10 SOAP fault messages . 109
10.11 Notification example . 110
10.11.1 General . 110
10.11.2 GetEventPropertiesRequest. 110
10.11.3 GetEventPropertiesResponse . 110
10.11.4 CreatePullPointSubscription . 111
10.11.5 CreatePullPointSubscriptionResponse . 111
10.11.6 PullMessagesRequest . 112
10.11.7 PullMessagesResponse . 112
10.11.8 UnsubscribeRequest . 113
10.11.9 UnsubscribeResponse . 113
10.12 Persistent storage event:BeginingOfBuffer . 114
10.13 Service specific fault codes . 114
11 Security . 114
11.1 General . 114
11.2 Transport level security . 114
11.2.1 General . 114
11.2.2 Supported cipher suites . 115
11.2.3 Server authentication . 115
11.2.4 Client authentication . 115
11.3 IEEE 802.1X . 116
Annex A (informative) Example for GetServices response with capabilities . 117
Annex B (normative) Device IP network Iiterface XML schemata . 119
B.1 Device management service WSDL . 119
B.2 Device IO service WSDL . 161
B.3 Event service WSDL . 168
B.4 Common schema . 179
Bibliography . 197

Figure 1 – Web services based development principles . 18
Figure 2 – Sequence diagram for the Real-time Pull-Point notification interface . 94
Figure 3 – Sequence diagram for the base notification interface . 99

Table 1 – Defined namespaces in this document . 23
Table 2 – Referenced namespaces (with prefix) . 24
Table 3 – Referenced namespaces (without prefix) . 24
Table 4 – Operation description outline used in this document . 25
Table 5 – Generic faults . 30
Table 6 – HTTP errors . 31
Table 7 – Access class to user level mapping . 32
Table 8 – Scope parameters . 36

Table 9 – GetWSDLUrl command. 38
Table 10 – GetServices command. 38
Table 11 – GetServiceCapabilities command . 39
Table 12 – Capabilities in the GetServiceCapabilities command . 39
Table 13 – GetHostname command . 40
Table 14 – SetHostname command . 41
Table 15 – SetHostnameFromDHCP command . 41
Table 16 – GetDNS command . 42
Table 17 – SetDNS command . 42
Table 18 – GetNTP command . 43
Table 19 – SetNTP command . 43
Table 20 – GetDynamicDNS command . 44
Table 21 – SetDynamicDNS command . 44
Table 22 – GetNetworkInterfaces command . 45
Table 23 – SetNetworkInterfaces command . 46
Table 24 – GetNetworkProtocols command . 47
Table 25 – SetNetworkProtocols command . 47
Table 26 – GetNetworkDefaultGateway command . 47
Table 27 – SetNetworkDefaultGateway command . 48
Table 28 – GetZeroConfiguration command . 48
Table 29 – SetZeroConfiguration command . 49
Table 30 – GetIPAddressFilter command . 49
Table 31 – SetIPAddressFilter command . 50
Table 32 – AddIPAddressFilter command . 50
Table 33 – RemoveIPAddressFilter command . 51
Table 34 – GetDot11Capabilities. 53
Table 35 – IEEE 802.11 capabilities . 53
Table 36 – GetDot11Status . 54
Table 37 – ScanAvailableDot11Networks . 55
Table 38 – GetDeviceInformation command . 55
Table 39 – GetSystemUris command . 56
Table 40 – GetSystemBackup command . 56
Table 41 – RestoreSystem command . 57
Table 42 – StartSystemRestore command . 57
Table 43 – GetSystemDateAndTime command . 58
Table 44 – SetSystemDateAndTime command . 59
Table 45 – SetSystemFactoryDefault command . 59
Table 46 – UpgradeSystemFirmware command . 60
Table 47 – StartFirmwareUpgrade command . 60
Table 48 – GetSystemLog command . 61
Table 49 – GetSystemSupportInformation command . 61
Table 50 – SystemReboot command . 62
Table 51 – GetScopes command . 62

– 8 – IEC 60839-11-31:2016 © IEC 2016
Table 52 – SetScopes command . 63
Table 53 – AddScopes command . 63
Table 54 – RemoveScopes command . 64
Table 55 – GetDiscoveryMode command . 64
Table 56 – SetDiscoveryMode command . 64
Table 57 – GetAccessPolicy command . 65
Table 58 – SetAccessPolicy command . 65
Table 59 – GetUsers command . 66
Table 60 – CreateUsers command . 66
Table 61 – DeleteUsers command . 67
Table 62 – SetUser command . 67
Table 63 – CreateDot1XConfiguration command . 69
Table 64 – SetDot1XConfigurationRequest command . 69
Table 65 – GetDot1XConfiguration command . 70
Table 66 – GetDot1XConfigurations command . 70
Table 67 – DeleteDot1XConfigurations command . 70
Table 68 – CreateCertificate command . 71
Table 69 – GetCertificates command . 71
Table 70 – GetCACertificates command . 72
Table 71 – GetCertificatesStatus command . 72
Table 72 – SetCertificatesStatus command . 72
Table 73 – GetPkcs10Request command . 73
Table 74 – GetClientCertificateMode command . 73
Table 75 – SetClientCertificateMode command . 74
Table 76 – LoadCertificates command . 74
Table 77 – LoadCertificateWithPrivateKey command . 75
Table 78 – GetCertificateInformation command . 75
Table 79 – LoadCACertificates command .
...