2N Helios IP HTTP API User Manual v2.8

www.2n.czVersion

Firmware

2N

®

Helios IP HTTP API

IP Intercom

Configuration Manual

2.8

2.8





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

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

1. Terms and Symbols

The following symbols and pictograms are used in the manual:

Safety

abide by this information to prevent persons from injury.Always

Warning

abide by this information to prevent damage to the device.Always

Caution

Important information for system functionality.

Tip

Useful information for quick and efficient functionality.

Note

Routines or advice for efficient use of the device.

®

42N TELEKOMUNIKACE a.s., www.2n.cz

2. HTTP API General Description

2N Helios IP® HTTP API (Application Programming Interface) is an interface designed
for remote control, configuration and data retrieval via third party2N Helios IP

®

applications. API enables 2N intercoms to be integrated in extensive2N Helios IP

®

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 - control commands;2N Helios IP

®

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. executes the requested operation and2N Helios IP

®

sends back a SOAP/XML response.

The general structure of the HTTP request is as follows:

®

52N 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, sends the following HTTP2N Helios IP

®

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

®

sends the 400 Bad Request reply including SOAP/XML data with errorHelios IP

identification.

®

62N 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>

®

72N 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 event logs can be arranged in a table:2N Helios IP

®

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 event log readout is based on the WS-BaseNotification standard.2N Helios IP

®

There are two log event retrieval modes – and 2N Helios IP

®

Subscription PullPoint

.

®

82N TELEKOMUNIKACE a.s., www.2n.cz

In the mode, sends events to the subscriber in the formSubscription 2N Helios IP

®

of 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 in the Subscription mode, subscribe via the 2N Helios IP

®

command, specifying the type of events to be retrieved, the HTTP sendingSubscribe

address and the subscription time.

If the subscription is successful, sends the includi2N Helios IP

®

SubscribeResponse

ng the Subscription Id for subsequent communication with .2N Helios IP

®

Now starts sending messages to the specified HTTP address.2N Helios IP

®

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. will replyRenew 2N Helios IP

®

with the message.RenewResponse

Send the request to unsubscribe explicitly. will reply withUnsubscribe 2N Helios IP

®

the message.UnsubscribeResponse

If there is a firewall or NAT between you and , the Subscription mode2N Helios IP

®

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 - message2N Helios IP

®

sequence.

®

92N TELEKOMUNIKACE a.s., www.2n.cz

Data Retrieval in PullPoint Mode

To retrieve events from in the PullPoint mode, create the PullPoint via2N Helios IP

®

the request, specifying the type of events to be retrieved and theCreatePullPoint
subscription time.

If the subscription is successful, sends the 2N Helios IP

®

CreatePullPointResponse

including the Subscription Id for subsequent communication with .2N Helios IP

®

Now you can read out events from periodically using the 2N Helios IP

®

GetMessages

request. sends the including the list of2N Helios IP

®

GetMessagesResponse

events. 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. will replyRenew 2N Helios IP

®

with the message.RenewResponse

Send the request to unsubscribe explicitly. will reply withUnsubscribe 2N Helios IP

®

the message.UnsubscribeResponse

®

102N TELEKOMUNIKACE a.s., www.2n.cz

®

112N 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 events in the2N Helios IP

®

Subscribe mode, in which sends events autonomously in the form of2N Helios IP

®

Notify messages to the HTTP address specified in the request.

Send the Subscribe request to the address: 2N Helios IP

®

.http://helios_ip_address/notification

2N Helios IP® will reply with the SubscribeResponse message.

Subscribe request format:

®

122N 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.

®

132N 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.

®

142N 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 (i.2N Helios IP

®

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 . Edit the Id as a common text.2N Helios

®

CURRENT_TIME

Subscription date and time from the viewpoint of . Refer to the Format2N Helios IP

®

of Selected Parameters for format details.

®

152N 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 event retrieval in2N Helios IP

®

the PullPoint mode, in which you read out events from the log actively using the
GetMessages request.

Send the CreatePullPoint request to the address: 2N Helios IP

®

.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>

®

162N 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 (i.2N Helios IP

®

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 . Edit the Id as a common text.2N Helios

®

®

172N TELEKOMUNIKACE a.s., www.2n.cz

CURRENT_TIME

Subscription date and time from the viewpoint of . Refer to the Format2N Helios IP

®

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. replies with the2N Helios IP

®

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.

DATETIME_OR_DURATION

Extend the subscription time. Subscription will be cancelled automatically by 2N

®

when this time period expires. Send another Renew request before expiry toHelios IP
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.

®

182N TELEKOMUNIKACE a.s., www.2n.cz

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 . Refer to the Format2N Helios IP

®

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.

Unsubscribe

The Unsubscribe request helps you terminate your subscription. Send this request to
the address included in the SubscribeResponse message. replies with2N Helios IP

®

the UnsubscribeResponse.

®

192N 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: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

®

confirms the client’s subscription termination.Helios IP

<?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>

GetMessages

The GetMessages request helps you read out events actively from .2N Helios IP

®

Send the request to the address included in the CreatePullPointResponse. 2N

®

replies with the GetMessageResponse.Helios IP

®

202N 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:event2n="http://www.2n.cz/2013/event">
<s:Header>
<event2n:SubscriptionId a:IsReferenceParameter="true">
{SUBSCRIPTION_ID}
</event2n:SubscriptionId>
</s:Header>
<s:Body>
<wsnt:GetMessages>
<wsnt:MaximumNumber>
{MAXIMUM_MSGS_IN_RESPONSE}
</wsnt:MaximumNumber>
</wsnt:GetMessages>
</s:Body>
</s:Envelope>

Message Parameters

SUBSCRIPTION_ID

A unique subscription identification code included in the SubscriptionResponse. The
parameter is obligatory.

MAXIMUM_MSGS_IN_RESPONSE

Set the maximum count of events to be sent within the GetMessagesResponse. The
parameter is optional. If no value is completed, up to 10 events will be sent in one
GetMessagesResponse message.

GetMessagesResponse

The GetMessagesResponse message is a reply to the GetMessages request.

®

212N 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:topic2n="http://www.2n.cz/2013/event/topics"
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/PullPoint/GetMessagesResponse
</wsa5:Action>
</s:Header>
<s:Body>
<wsnt:GetMessagesResponse>
{EVENT_LIST}
</wsnt:GetMessagesResponse>
</s:Body>
</s:Envelope>

Message Parameters

EVENT_LIST

Refer to the Logged Events subsection for the list of events. The event list can be
empty. Specify the maximum count of events to be sent at one time in the
CreatePullPoint request in the Subscribe or the GetMessages request.

Notify

The Notify message informs you of the rise of a new event in the Subscription mode.

sends Notify to the address specified in the Subscribe request. 2N Helios IP

®

<?xml version="1.0" encoding="UTF-8"?>
<s:Envelope
xmlns:s="http://www.w3.org/2003/05/soap-envelope"
xmlns:topic2n="http://www.2n.cz/2013/event/topics"
xmlns:event2n="http://www.2n.cz/2013/event"
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/NotificationConsumer/Notify
</wsa5:Action>
</s:Header>
<s:Body>
<wsnt:Notify>
{EVENT_LIST}
</wsnt:Notify>
</s:Body>
</s:Envelope>

Message Parameters

®

222N TELEKOMUNIKACE a.s., www.2n.cz

EVENT_LIST

Refer to the Logged Events subsection for the list of events. The message always
includes one event at least. Specify the maximum count of events in the Subscribe
request.

®

232N TELEKOMUNIKACE a.s., www.2n.cz

5. Logged Events

This subsection includes a list of events to be stored in the log and2N Helios IP

®

specifies the transfer format via the Notify and GetMessagesResponse messages.

KeyPressed
CallStateChanged
CardEntered
CodeEntered
DeviceState

See below for details on the events and their parameters and use.

KeyPressed

The KeyPressed event is generated whenever a key is pressed on the device.

<event2n:Msg>
<event2n:Timestamp>{TIMESTAMP}</event2n:Timestamp>
<event2n:EventName>event2n:KeyPressed</event2n:EventName>
<event2n:Data>
<event2n:Key>{KEYCODE}</event2n:Key>
</event2n:Data>
</event2n:Msg>

Event Parameters

TIMESTAMP

Event date and time; refer to the Format of Selected Parameters.

KEYCODE

Code of the key pressed. Applicable values:

®

242N TELEKOMUNIKACE a.s., www.2n.cz

0, 1, …, 9, *, # – numerical keypad buttons
%1..%54 – call buttons

CallStateChanged

The CallStateChanged event is generated whenever a change of the currently made call
occurs.

<event2n:Msg>
<event2n:Timestamp>{TIMESTAMP}</event2n:Timestamp>
<event2n:EventName>event2n:CallStateChanged</event2n:EventName>
<event2n:Data>
<event2n:State>{STATE}</event2n:State>
<event2n:Direction>{DIRECTION}</event2n:Direction>
</event2n:Data>
</event2n:Msg>

Event Parameters

TIMESTAMP

Event date and time; refer to the Format of Selected Parameters.

STATE

Event type specification. Applicable values:

ringing – ringing
connected – call connected
terminated – call terminated

DIRECTION

Call direction. Applicable values:

incoming for incoming calls
outgoing for outgoing calls

CardEntered

The CardEntered event is generated whenever a card is applied to the RFID card reader
connected to the device.

<event2n:Msg>
<event2n:Timestamp>{TIMESTAMP}</event2n:Timestamp>
<event2n:EventName>event2n:CardEntered</event2n:EventName>
<event2n:Data>
<event2n:Card>{CARD}</event2n:Card>
<event2n:Valid>{VALID_FLAG}</event2n:Valid>
</event2n:Data>
</event2n:Msg>

®

252N TELEKOMUNIKACE a.s., www.2n.cz

Event Parameters

TIMESTAMP

Event date and time; refer to the Format of Selected Parameters.

CARD

Detected card identification with a 24-64-bit number in the hexadecimal format, e.g.
54A86B87C5.

VALID_FLAG

If the detected card is valid, the parameter value is . If not, the parameter is settrue
to .false

CodeEntered

The CodeEntered event is generated whenever a numerical code is entered and
confirmed via the device keypad.

<event2n:Msg>
<event2n:Timestamp>{TIMESTAMP}</event2n:Timestamp>
<event2n:EventName>event2n:CodeEntered</event2n:EventName>
<event2n:Data>
<event2n:Code>{CODE}</event2n:Code>
<event2n:Valid>{VALID_FLAG}</event2n:Valid>
</event2n:Data>
</event2n:Msg>

Event Parameters

TIMESTAMP

Event date and time; refer to the Format of Selected Parameters.

CODE

Numerical code entered, e.g. 1234.

VALID_FLAG

If the entered code is valid (matches the 2N

®

valid codes), the parameterHelios IP

value is . If not, the parameter is set to .true false

®

262N TELEKOMUNIKACE a.s., www.2n.cz

DeviceState

The DeviceState event is generated whenever any of the selected device state changes
occurs.

<event2n:Msg>
<event2n:Timestamp>{TIMESTAMP}</event2n:Timestamp>
<event2n:EventName>event2n:DeviceState</event2n:EventName>
<event2n:Data>
<event2n:State>{STATE}</event2n:State>
</event2n:Data>
</event2n:Msg>

Event Parameters

TIMESTAMP

Event date and time; refer to the Format of Selected Parameters.

STATE

Event type specification. Applicable values:

startup – event generated upon device start

®

272N TELEKOMUNIKACE a.s., www.2n.cz

6. Format of Selected Parameters

TimeStamp – Absolute Time

The absolute time parameter obeys the ISO8601 subset standard: it is set as a string
of characters in the CCYY-MM-DDThh:mm:ss format, where CC stands for the century,
YY for the year, MM for the month and DD for the day. The T character separates date
and time. hh represents hours, mm minutes and ss seconds.

Examples:

2013-05-31T13:20:00 – 31.5.2013 13:20

Duration

The duration parameter obeys the extended ISO8601 standard: it is set as a string of
characters in the PnYnMnDTnHnMnS format, where nY stands for the year count, nM
for the month count and nD for the day count. T is the date/time separator, nH gives
the count of hours, nM gives the count of minutes and nS sets the count of seconds. n
must be an integer.

Examples:

PT60S 60 seconds
P1DT12H 1 day and 12 hours

®

282N TELEKOMUNIKACE a.s., www.2n.cz

2N TELEKOMUNIKACE a.s.

Modřanská 621, 143 01 Prague 4, Czech Republic
Phone: [phone], Fax: [phone]
E-mail: [e-mail]
Web: www.2n.cz

2043v1

®

292N TELEKOMUNIKACE a.s., www.2n.cz