2N Helios IP Instruction sheet

www.2n.czVersion
Firmware
2N
®Helios IP HTTP API
Door Access Intercom
Configuration Manual
2.6
2.6.0



The 2N TELEKOMUNIKACE a.s. is a Czech manufacturer and supplier of telecommunications
equipment.
The product family developed by 2N TELEKOMUNIKACE a.s. includes GSM gateways, private
branch exchanges (PBX), and door and lift communicators. 2N TELEKOMUNIKACE a.s. has
been ranked among the Czech top companies for years and represented a symbol of
stability and prosperity on the telecommunications market for almost two decades. At
present, we export our products into over 120 countries worldwide and have exclusive
distributors on all continents.
2N is a registered trademark of 2N TELEKOMUNIKACE a.s. Any product and/or other
®
names mentioned herein are registered trademarks and/or trademarks or brands protected
by law.
2N TELEKOMUNIKACE a.s. administers the FAQ database to help you quickly find
information and to answer your questions about 2N products and services. On
www.faq.2n.cz you can find information regarding products adjustment and instructions for
optimum use and procedures „What to do if...“.
2N TELEKOMUNIKACE a.s. hereby declares that the 2N product
®Helios IP HTTP API
complies with all basic requirements and other relevant provisions of the 1999/5/EC
directive. For the full wording of the Declaration of Conformity see the CD-ROM enclosed or
our website at www.2n.cz.
This device complies with part 15 of the FCC Rules. Operation is subject to the following
two conditions: (1) This device may not cause harmful interference, and (2) this device
must accept any interference received, including interference that may cause undesired
operation.
The 2N TELEKOMUNIKACE a.s. is the holder of the ISO 9001:2009 certificate. All
development, production and distribution processes of the company are managed by this
standard and guarantee a high quality, technical level and professional aspect of all our
products.
Content

Content
1. Terms and Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2. HTTP API General Description . . . . . . . . . . . . . . . . . . . . . . . 5
3. Event Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4. HTTP API Message List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
5. Logged Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
6. Format of Selected Parameters . . . . . . . . . . . . . . . . . . . . . . . 28

42N TELEKOMUNIKACE a.s., www.2n.cz
®
1. Terms and Symbols
Symbols Used in Manual
Safety
Always abide by this information to prevent injury of persons.
Warning
Always abide by this information to prevent damage to the device.
Caution
Important information for system functionality.
Tip
Useful advice for quick and efficient functionality.
Note
Routines or advice for efficient use of the device.

52N TELEKOMUNIKACE a.s., www.2n.cz
®
2. HTTP API General
Description
2N® Helios IP HTTP API (Application Programming Interface) is an interface designed
for 2N® Helios IP remote control, configuration and data retrieval via third party
applications. 2N® Helios IP API enables 2N intercoms to be integrated in extensive
user infrastructures (home automation, attendance control systems, etc.).
2N® Helios IP HTTP API provides a simple interface based on standard protocols
(SOAP/HTTP), which helps read out state or statistic information.
2N® Helios IP HTTP API is defined through a web service available at:
http://helios_ip_address/automation - 2N® Helios IP control commands;
http://helios_ip_address/notification - log data retrieval commands.
Send an HTTP request including a properly formatted SOAP/XML data to one of the
above mentioned addresses. 2N® Helios IP executes the requested operation and
sends back a SOAP/XML response.
The general structure of the HTTP request is as follows:

62N TELEKOMUNIKACE a.s., www.2n.cz
®
POST /… HTTP/1.1
Host: …
Content-Type: application/soap+xml
Content-Length: …
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
additional control information of request
</s:Header>
<s:Body>
request parameters
</s:Body>
</s:Envelope>
If the request is processed successfully, 2N® Helios IP sends the following HTTP
response:
HTTP/1.1 200 OK
Content-Type: application/soap+xml
Content-Length: nnn
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
additional control information of response
</s:Header>
<s:Body>
Response parameters
</s:Body>
</s:Envelope>
If the request cannot be processed or an error occurs during processing, 2N Helios IP
®
sends the 400 Bad Request reply including SOAP/XML data with error identification.

72N TELEKOMUNIKACE a.s., www.2n.cz
®
HTTP/1.1 400 Bad Request
Content-Length: …
Content-Type: application/soap+xml
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope
xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:ter="http://www.onvif.org/ver10/error">
<s:Body>
<s:Fault>
<s:Code>
<s:Value> error code </s:Value>
<s:Subcode>
<s:Value> error subcode </s:Value>
</s:Subcode>
</s:Code>
<s:Reason>
<s:Text xml:lang="en"> error cause details </s:Text>
</s:Reason>
<s:Detail>
<s:Text> additional error details </s:Text>
</s:Detail>
</s:Fault>
</s:Body>
</s:Envelope>

82N TELEKOMUNIKACE a.s., www.2n.cz
®
3. Event Logging
2N® Helios IP implements an internal event log, which records events arising in the
device – such as KeyPressed, CodeEntered, CardEntered, CallStateChanged and so on.
The log capacity is 500 events. When the log fills up, any new event deletes the oldest
record. Events are arranged according to date and time (TimeStamp) in the log. The
maximum time resolution is 1s. Also, each event is assigned a unique 16-bit RecordId,
which is automatically incremented by 1s with every new event. The RecordId code
helps distinguish between records of the same date and time.
The 2N® Helios IP event logs can be arranged in a table:
TimeStamp RecordID Event Type Event Data
1 13/06/01 12:05:01 65533 CardEntered Card=…
2 13/06/01 17:30:23 65534 CardEntered Card=…
3 14/06/01 08:10:23 65535 KeyPressed Key=…
4 14/06/01 08:10:23 0 KeyPressed Key=..
… … … …
500 27/06/01 17:05:01 496 CardEntered Card=…
The first table row represents the oldest record (log beginning). The last row
represents the most recent record (log end). Being a 16-bit number, the RecordID
automatically overflows from 65535 to 0.
2N® Helios IP defines several types of events to be logged.
Event Popis
KeyPressed Keystroke
CallStateChanged Call state change
CodeEntered Numerical code entering
CardEntered RFID card detection
DeviceState Device state change
The 2N Helios IP event log readout is based on the WS-BaseNotification standard.
®
There are two 2N Helios IP log event retrieval modes – and .
® Subscription PullPoint

92N TELEKOMUNIKACE a.s., www.2n.cz
®
In the mode, 2N Helios IP sends events to the subscriber in the form ofSubscription ®
Notify messages.
In the mode, the client sends the GetMessages request to retrieve the logPullPoint
data.
Data Retrieval in Subscription Mode
To retrieve events from 2N® Helios IP in the Subscription mode, subscribe via the
command, specifying the type of events to be retrieved, the HTTP sendingSubscribe
address and the subscription time.
If the subscription is successful, 2N® Helios IP sends the includinSubscribeResponse
g the Subscription Id for subsequent communication with 2N® Helios IP.
Now 2N® Helios IP starts sending messages to the specified HTTP address.Notify
Events are sent at the moment of rise without delay. In your Subscribe request, you
can specify the maximum count of events to be sent within one Notify message.
The subscription time is limited (as specified in the Subscribe request). When the
subscription time expires, you will be unsubscribed automatically. To extend the
subscription time, send the request before expiry. 2N® Helios IP will reply withRenew
the message.RenewResponse
Send the request to unsubscribe explicitly. 2N® Helios IP will reply withUnsubscribe
the message.UnsubscribeResponse
If there is a firewall or NAT between you and 2N® Helios IP, the Subscription mode
may not be convenient. The Notify messages are delivered only if the network
elements are properly configured.
The figure below shows the status diagram and typical client - 2N® Helios IP message
sequence.

102N TELEKOMUNIKACE a.s., www.2n.cz
®
Data Retrieval in PullPoint Mode
To retrieve events from 2N® Helios IP in the PullPoint mode, create the PullPoint via
the request, specifying the type of events to be retrieved and theCreatePullPoint
subscription time.
If the subscription is successful, 2N® Helios IP sends the iCreatePullPointResponse
ncluding the Subscription Id for subsequent communication with 2N® Helios IP.
Now you can read out events from 2N® Helios IP periodically using the GetMessages
request. 2N® Helios IP sends the including the list of events.GetMessagesResponse
In case there is no event in the queue, the event list is empty in the response.
The subscription time is limited (as specified in the CreatePullPoint request). When the
subscription time expires, you will be unsubscribed automatically. To extend the
subscription time, send the request before expiry. 2N® Helios IP will reply withRenew
the message.RenewResponse
Send the request to unsubscribe explicitly. 2N® Helios IP will reply withUnsubscribe
the message.UnsubscribeResponse

112N TELEKOMUNIKACE a.s., www.2n.cz
®

122N TELEKOMUNIKACE a.s., www.2n.cz
®
4. HTTP API Message List
2N Helios HTTP API® defines the following types of messages:
Subscribe
SubscribeResponse
CreatePullPoint
CreatePullPointResponse
Renew
RenewResponse
Unsubscribe
UnsubscribeResponse
GetMessages
GetMessagesResponse
Notify
See below for details on the messages and their parameters and use.
Subscribe
The Subscribe request helps you subscribe to retrieval of 2N Helios IP events in the
®
Subscribe mode, in which 2N Helios IP sends events autonomously in the form of
®
Notify messages to the HTTP address specified in the request.
Send the Subscribe request to the 2N Helios IP address:
®
.http://helios_ip_address/notification
2N Helios IP will reply with the SubscribeResponse message.
®
Subscribe request format:

132N TELEKOMUNIKACE a.s., www.2n.cz
®
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2"
xmlns:a="http://www.w3.org/2005/08/addressing"
xmlns:event2n="http://www.2n.cz/2013/event">
<s:Header>
</s:Header>
<s:Body>
<wsnt:Subscribe>
<wsnt:ConsumerReference>
<a:Address>
{HTTP_CONSUMER_ADDRESS}
</a:Address>
</wsnt:ConsumerReference>
<wsnt:Filter>
<wsnt:TopicExpression Dialect=
"http://www.2n.cz/2013/TopicExpression/Multiple">
{EVENTS_LIST}
</wsnt:TopicExpression>
</wsnt:Filter>
<wsnt:InitialTerminationTime>
{DATETIME_OR_DURATION}
</wsnt:InitialTerminationTime>
<wsnt:SubscriptionPolicy>
<event2n:MaximumNumber>
{MAX_NUMBER_OF_MSGS_AT_ONCE}
</event2n:MaximumNumber>
<event2n:SimpleMessages>
{SIMPLE_MSGS_ENABLED_FLAG}
</event2n:SimpleMessages>
<event2n:StartRecordId>
{START_RECORD_ID}
</event2n:StartRecordId>
<event2n:StartTimestamp>
{START_TIMESTAMP}
</event2n:StartTimestamp>
</wsnt:SubscriptionPolicy>
</wsnt:Subscribe>
</s:Body>
</s:Envelope>
Message Parameters
HTTP_CONSUMER_ADDRESS
Specify the address to which the Notify messages including the requested events shall
be sent. Keep the HTP URI address format, e.g. .http://192.168.23.73/notify_server
The parameter is obligatory.

142N TELEKOMUNIKACE a.s., www.2n.cz
®
DATETIME_OR_DURATION
Set the subscription time. Subscription will be cancelled automatically by when this
time period expires. Send the Renew request before expiry to extend the subscription
time. Enter the absolute time (DateTime) or relative duration (Duration) to specify the
subscription time; refer to the Format of Selected Parameters subsection. The
parameter is obligatory.
EVENTS_LIST
Make up a list of requested events. Separate the event types with a comma, e.g.
event2n:KeyPressed, event2n:CardEntered. The parameter is optional. If you define no
events, you will get all types of events.
MAX_NUMBER_OF_MSGS_AT_ONCE
Set the maximum count of events to be sent within one Notify message. The
parameter is optional. If no value is completed, up to 10 events will be sent in one
Notify message.
SIMPLE_MSGS_ENABLED_FLAG
Specify the format of event elements to be sent in the Notify message. If you set 0,
the ONVIF standard (extended messages) will be applied. If you set 1, a more efficient
format will be used (as described herein). The parameter is optional. If no value is
defined, a more efficient format is used.
START_TIMESTAMP
Set the data and time for the oldest log event to be the first in the Notify message. The
parameter is optional. If no value is set, all log events will be sent.
START_RECORD_ID
Set the RecordId for the log event to be the first in the Notify message. This parameter
can only be used together with the START_TIMESTAMP parameter. The parameter is
optional. If no value is set, all log events starting with the time specified in the
START_TIMESTAMP parameter will be sent.
SubscribeResponse
2N Helios IP sends the SubscribeResponse message in reply to the Subscribe request
®
to inform the client that the client’s subscription has been completed successfully.

152N TELEKOMUNIKACE a.s., www.2n.cz
®
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope
xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsa5="http://www.w3.org/2005/08/addressing"
xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2"
xmlns:event2n="http://www.2n.cz/2013/event">
<s:Header>
<wsa5:Action s:mustUnderstand="true">
http://docs.oasis-open.org/wsn/bw-2/NotificationProducer/SubscribeResponse
</wsa5:Action>
<s:Header>
<s:Body>
<wsnt:SubscribeResponse>
<wsnt:SubscriptionReference>
<wsa5:Address>
{NOTIFICATIONS_PRODUCER_ADDRESS}
</wsa5:Address>
<wsa5:ReferenceParameters>
<event2n:SubscriptionId>
{SUBSCRIPTION_ID}
</event2n:SubscriptionId>
</wsa5:ReferenceParameters>
</wsnt:SubscriptionReference>
<wsnt:CurrentTime>
{CURRENT_TIME}
</wsnt:CurrentTime>
<wsnt:TerminationTime>
{EXPIRE_TIME}
</wsnt:TerminationTime>
</wsnt:SubscribeResponse>
</s:Body>
</s:Envelope>
Message Parameters
NOTIFICATIONS_PRODUCER_ADDRESS
Specify the address for subsequent subscription communication with 2N Helios IP (i.e.
®
a new address for Unsubscribe and Renew requests). In the present implementation,
the address is .http://helios_ip_address/notification
SUBSCRIPTION_ID
A unique subscription identification code to be used for subsequent Renew and
Unsubscribe communication with 2N Helios. Edit the Id as a common text.
®
CURRENT_TIME
Subscription date and time from the viewpoint of 2N Helios IP. Refer to the Format of
®
Selected Parameters for format details.

162N TELEKOMUNIKACE a.s., www.2n.cz
®
EXPIRE_TIME
Specify the subscription date and time. Use the Renew request to extend the
subscription time before expiry. Refer to the Format of Selected Parameters for format
details.
CreatePullPoint
The CreatePullPoint request helps you subscribe to 2N Helios IP event retrieval in the
®
PullPoint mode, in which you read out events from the log actively using the
GetMessages request.
Send the CreatePullPoint request to the 2N Helios IP address:
®
.http://helios_ip_address/notification
2N Helios IP will reply with the CreatePullPointResponse.
®
CreatePullPoint request format:
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope
xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2"
xmlns:event2n="http://www.2n.cz/2013/event">
<s:Header>
</s:Header>
<s:Body>
<wsnt:CreatePullPoint>
<wsnt:Filter>
<wsnt:TopicExpression Dialect=
"http://www.2n.cz/2013/TopicExpression/Multiple">
{EVENTS_LIST}
</wsnt:TopicExpression>
</wsnt:Filter>
<wsnt:InitialTerminationTime>
{DATETIME_OR_DURATION}
</wsnt:InitialTerminationTime>
<wsnt:SubscriptionPolicy>
<event2n:SimpleMessages>
{SIMPLE_MSGS_ENABLED_FLAG}
</event2n:SimpleMessages>
<event2n:StartRecordId>
{START_RECORD_ID}
</event2n:StartRecordId>
<event2n:StartTimestamp>
{START_TIMESTAMP}
</event2n:StartTimestamp>
</wsnt:SubscriptionPolicy>
</wsnt:Subscribe>
</s:Body>
</s:Envelope>

172N TELEKOMUNIKACE a.s., www.2n.cz
®
CreatePullPointResponse
2N Helios IP sends the CreatePullPointResponse in reply to the CreatePullPoint
®
request to inform the client that the client’s subscription has been completed
successfully.
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope
xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsa5="http://www.w3.org/2005/08/addressing"
xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2"
xmlns:event2n="http://www.2n.cz/2013/event">
<s:Header>
<wsa5:Action>//http://docs.oasis-open.org/wsn/bw-2/CreatePullPoint/CreatePullPointResponse
</wsa5:Action>
</s:Header>
<s:Body>
<wsnt:CreatePullPointResponse>
<wsnt:SubscriptionReference>
<wsa5:Address>
{NOTIFICATIONS_PRODUCER_ADDRESS}
</wsa5:Address>
<wsa5:ReferenceParameters>
<event2n:SubscriptionId>
{SUBSCRIPTION_ID}
</event2n:SubscriptionId>
</wsa5:ReferenceParameters>
</wsnt:SubscriptionReference>
<wsnt:CurrentTime>
{CURRENT_TIME}
</wsnt:CurrentTime>
<wsnt:TerminationTime>
{EXPIRE_TIME}
</wsnt:TerminationTime>
</wsnt:CreatePullPointResponse>
</s:Body>
</s:Envelope>
Message Parameters
NOTIFICATIONS_PRODUCER_ADDRESS
Specify the address for subsequent subscription communication with 2N Helios IP (i.e.
®
a new address for Unsubscribe, Renew and GetMessages requests). In the present
implementation, the address is .http://helios_ip_address/notification
SUBSCRIPTION_ID
A unique subscription identification code to be used for subsequent Renew, Unsubscribe
and GetMessages communication with 2N Helios. Edit the Id as a common text.
®

182N TELEKOMUNIKACE a.s., www.2n.cz
®
CURRENT_TIME
Subscription date and time from the viewpoint of 2N Helios IP. Refer to the Format of
®
Selected Parameters for format details.
EXPIRE_TIME
Specify the subscription date and time. Use the Renew request to extend the
subscription time before expiry. Refer to the Format of Selected Parameters for format
details.
Renew
The Renew request helps you extend your subscription time. Send the request to the
address included in the SubscribeResponse message. 2N Helios IP replies with the
®
RenewResponse message.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope
xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2"
xmlns:event2n="http://www.2n.cz/2013/event">
<s:Header>
<event2n:SubscriptionId a:IsReferenceParameter="true">
{SUBSCRIPTION_ID}
</event2n:SubscriptionId>
</s:Header>
<s:Body>
<wsnt:Renew>
<wsnt:TerminationTime>
{DATETIME_OR_DURATION}
</wsnt:TerminationTime>
</wsnt:Renew>
</s:Body>
</s:Envelope>
Message Parameters
SUBSCRIPTION_ID
A unique subscription identification code included in the SubscriptionResponse. The
parameter is obligatory.

192N TELEKOMUNIKACE a.s., www.2n.cz
®
DATETIME_OR_DURATION
Extend the subscription time. Subscription will be cancelled automatically by 2N Helio
®
s IP when this time period expires. Send another Renew request before expiry to
extend the subscription time. Enter the absolute time (DateTime) or relative duration
(Duration) to specify the subscription time; refer to the Format of Selected Parameters
subsection. The parameter is obligatory.
RenewResponse
The RenewResponse message is a reply to the Renew request, in which 2N Helios IP
®
informs the client of the prolongation of the client’s subscription time.
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope
xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsa5="http://www.w3.org/2005/08/addressing"
xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2">
<s:Header>
<wsa5:Action s:mustUnderstand="true">
http://docs.oasis-open.org/wsn/bw-2/SubscriptionManager/RenewResponse
</wsa5:Action>
</s:Header>
<s:Body>
<wsnt:RenewResponse>
<wsnt:TerminationTime>
{CURRENT_TIME}
</wsnt:TerminationTime>
<wsnt:CurrentTime>
{EXPIRE_TIME}
</wsnt:CurrentTime>
</wsnt:RenewResponse>
</s:Body>
</s:Envelope>
Message Parameters
CURRENT_TIME
Subscription date and time from the viewpoint of 2N Helios IP. Refer to the Format of
®
selected parameters for format details.
EXPIRE_TIME
Specify the subscription date and time. Use the Renew request to extend the
subscription time before expiry. Refer to the Format of Selected Parameters for format
details.

202N TELEKOMUNIKACE a.s., www.2n.cz
®
Unsubscribe
The Unsubscribe request helps you terminate your subscription. Send this request to
the address included in the SubscribeResponse message. 2N Helios IP replies with the
®
UnsubscribeResponse.
<?xml version="1.0" encoding="utf-8"?>
<s:Envelope
xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2"
xmlns:event2n="http://www.2n.cz/2013/event">
<s:Header>
<event2n:SubscriptionId a:IsReferenceParameter="true">
{SUBSCRIPTION_ID}
</event2n:SubscriptionId>
</s:Header>
<s:Body>
<wsnt:Unsubscribe>
</wsnt:Unsubscribe>
</s:Body>
</s:Envelope>
Message Parameters
SUBSCRIPTION_ID
A unique subscription identification code included in the SubscriptionResponse. The
parameter is obligatory.
UnsubscribeResponse
The RenewResponse message is a reply to the Unsubscribe request, in which 2N Helio
®
s IP confirms the client’s subscription termination.
<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope
xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:wsa5="http://www.w3.org/2005/08/addressing"
xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2">
<s:Header>
<wsa5:Action s:mustUnderstand="true">
http://docs.oasis-open.org/wsn/bw-2/SubscriptionManager/UnsubscribeResponse
</wsa5:Action>
</s:Header>
<s:Body>
<wsnt:UnsubscribeResponse>
</wsnt:UnsubscribeResponse>
</s:Body>
</s:Envelope>