Download
Share
Print this page
2N Helios IP Configuration Manual
  1. Manuals
  2. Brands
  3. 2N Manuals
  4. Intercom System
  5. Helios IP
  6. Configuration manual

2N Helios IP Configuration Manual

Door access intercom http api
Hide thumbs Also See for Helios IP:

Advertisement

Quick Links

Download this manual See also: Configuration Manual, Documentation
®
2N
Firmware
2.6
Version
2.6.0
Helios IP HTTP API
Door Access Intercom
Configuration Manual
 
www.2n.cz

Advertisement

loading
Need help?

Need help?

Do you have a question about the Helios IP and is the answer not in the manual?

Questions and answers

Related Manuals for 2N Helios IP

Summary of Contents for 2N Helios IP

  • Page 1 ® Helios IP HTTP API Door Access Intercom Configuration Manual Firmware Version 2.6.0 www.2n.cz  ...
  • Page 2 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.

  • Page 3: Table Of Contents

    Content 1. Terms and Symbols ....... . 4 2. HTTP API General Description .

  • Page 4: Terms And Symbols

    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. Useful advice for quick and efficient functionality. Note Routines or advice for efficient use of the device. ® TELEKOMUNIKACE a.s., www.2n.cz...

  • Page 5: Http Api General Description

    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.).
  • Page 6 <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>...
  • Page 7 <?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> ® TELEKOMUNIKACE a.s., www.2n.cz...

  • Page 8: Event Logging

    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.
  • Page 9 2N® Helios IP will reply with UnsubscribeResponse message. 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.
  • Page 10 Data Retrieval in PullPoint Mode To retrieve events from 2N® Helios IP in the PullPoint mode, create the PullPoint via CreatePullPoint request, specifying the type of events to be retrieved and the subscription time. If the subscription is successful, 2N® Helios IP sends the CreatePullPointResponse ncluding the Subscription Id for subsequent communication with 2N®...
  • Page 11 ® TELEKOMUNIKACE a.s., www.2n.cz...

  • Page 12: Http Api Message List

    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.
  • Page 13 {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. ® TELEKOMUNIKACE a.s., www.2n.cz...
  • Page 14 If no value is set, all log events starting with the time specified in the START_TIMESTAMP parameter will be sent. SubscribeResponse ® 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. ® TELEKOMUNIKACE a.s., www.2n.cz...
  • Page 15 </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 ®...
  • Page 16 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.
  • Page 17 CreatePullPointResponse ® 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/CreatePullPointRespo </wsa5:Action> </s:Header> <s:Body> <wsnt:CreatePullPointResponse> <wsnt:SubscriptionReference>...
  • Page 18 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.
  • Page 19 (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"?>...
  • Page 20 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"...
  • Page 21 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 Helios IP replies with the GetMessageResponse. <?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">...
  • Page 22 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. ® Helios IP sends Notify to the address specified in the Subscribe request. <?xml version="1.0" encoding="UTF-8"?> <s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope"...
  • Page 23 Message Parameters 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. ® TELEKOMUNIKACE a.s., www.2n.cz...

  • Page 24: Logged Events

    5. Logged Events This subsection includes a list of events to be stored in the 2N® Helios IP log and 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.
  • Page 25 – 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. ® TELEKOMUNIKACE a.s., www.2n.cz...
  • Page 26 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. ® TELEKOMUNIKACE a.s., www.2n.cz...
  • Page 27 CODE Numerical code entered, e.g. 1234. VALID_FLAG ® If the entered code is valid (matches the 2N Helios IP valid codes), the parameter value is true . If not, the parameter is set to false DeviceState The DeviceState event is generated whenever any of the selected device state changes occurs.

  • Page 28: Format Of Selected Parameters

    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 ® TELEKOMUNIKACE a.s., www.2n.cz...
  • Page 29 2N TELEKOMUNIKACE a.s. Modřanská 621, 143 01 Prague 4, Czech Republic Phone: +420 261 301 500, Fax: +420 261 301 599 E-mail: sales@2n.cz Web: www.2n.cz 2043v1 ® TELEKOMUNIKACE a.s., www.2n.cz...