Guideline for using SIP2 over https


Published: 16 December 2013



Guideline for using SIP2 over https



This guideline describes a method for exchanging SIP2 messages over https.


SIP2 messages are typically exchanged directly over tcp or via telnet, but this prevents SIP2 being used over an internet connection, since many SIP2 messages contain sensitive information that must not be exchanged without proper encryption. This can be obtained by using VPN or similar technologies, but a more straightforward and simpler approach is using https as transport protocol.


Messages exchanged by the described method still has to conform to the 3M Standard Interchange Protocol, but are incapsulated in XML for validation purposes.



The scope for this guideline is library system vendors delivering SIP2 servers and self service vendors delivering equipment using SIP2 for server communication. Other types of equipment, e.g. gate trackers, using SIP2 for communication with a SIP2 server are also included.



A SIP2 request from the client application must be sent as a POST over https. The server application responds over the same https connection. Both request and response must conform to the XML schema below.

<?xml version="1.0" encoding="UTF-8"?>

<!-- sip.xsd  $Revision: 1.7 $ -->

<xs:schema xmlns:xs="" xmlns:ns1="" targetNamespace="" elementFormDefault="unqualified" attributeFormDefault="unqualified">

  <xs:element name="sip">



        <xs:element name="request" type="xs:string"/>

        <xs:element name="response" type="xs:string"/>

        <xs:element name="error" type="xs:string"/>


      <xs:attribute name="login" type="xs:string"/>

      <xs:attribute name="password" type="xs:string"/>





The request and response elements must contain valid SIP2 messages. The login and password elements can be used for authentication. The SIP2 server application can require that all SIP2 requests from the client application must  contain a valid login and password.



Request from SIP2 client application:


<?xml version="1.0" encoding="UTF-8"?>

<ns1:sip password="kodeord" login="testuser" xsi:schemaLocation=" sip.xsd" xmlns:ns1="" xmlns:xsi="">

           <request>990 401.00</request>



Response from SIP2 server:


<?xml version="1.0" encoding="UTF-8"?>

<ns1:sip xsi:schemaLocation=" sip.xsd" xmlns:ns1="" xmlns:xsi="">

           <response>98YYYYYY00500520130306    1613561.00AODK-400150|AMKlokkerholm Library|ANHovedterminal|BXYYYYYYNYYYYNNYYY|AFOnline|AGOnline print|</response>



The content of the response element must be in one line as specified by the SIP2 protocol.



The Standard Interchange Protocol:






Preben Aagaard Nielsen


Danish Agency for Culture



H.C. Andersens Boulevard 2

DK-1553 Copenhagen V

Direct +45 33 73 33 40

Phone: +45 3373 3373

Telefax: +45 3373 3372