SIP2-Dokumentation
Stand 07/2023
SIP2.Command
Behandlung variabler SIP/2 Felder
Das Trennzeichen für Felder mit variabler Feldlänge ist fest als '|' (hexadezimal 7C) definiert und kann nicht geändert werden.
SIP2 Kommandos
Liste der SIP2-Kommandos, die an ein ACS (Automated Circulation Software) gesendet werden können und deren Umsetzungsstatus in BIBLIOTHECAplus. In den Spalten SIP2 Anfrage und SIP2 Antwort sind die Kommando-Kennungen der SIP2 Befehle notiert.
Kommando |
Bedeutung |
SIP2 An-frage |
SIP2 Ant-wort |
Funktionsname in BIBLIOTHECA |
---|---|---|---|---|
Block Patron |
Benutzer/Ausweis sperren |
1 |
98 |
clsComm3mSC.HandleBlockUser() |
Checkin |
Rückgabe |
9 |
10 |
clsComm3mSC.HandleCheckinRequest() |
Checkout |
Ausleihe |
11 |
12 |
clsComm3mSC.HandleCheckoutRequest() |
Item Infor mation |
Abfrage von Exemplardaten |
17 |
18 |
clsComm3mSC.HandleItemInformation() |
Patron Sta tus Request |
Leser/Ausweis prüfen |
23 |
24 |
clsComm3mSC.HandleUserStatusRequest() |
Patron Ena ble |
Leser entsperren |
25 |
26 |
clsComm3mSC.HandleUserRefresh() |
Renew |
Einzelverlängerung |
29 |
30 |
clsComm3mSC.HandleRenew() |
End Patron Session |
Benutzersession beenden |
35 |
36 |
clsComm3mSC.HandleEndSession() |
Fee Paid |
Gebühr bezahlen |
37 |
38 |
clsComm3mSC.HandlePayment() |
Patron In formation |
Benutzer konto abfragen |
63 |
64 |
clsComm3mSC.HandlePatronInformation() |
Renew All |
Alle Exemplare eines Be nutzers verlängern |
65 |
66 |
clsComm3mSC.HandleRenewAll() |
Login |
Benutzer/Passwort prüfen |
93 |
94 |
clsComm3mSC.HandleLogin() |
Request ACS Resend |
Letztes Kommando erneut senden |
97 |
(letztes Kommando) |
(Keine separate Funktion) |
SC Status |
Selbstverbuchers meldet Status an ACS. ACS antwortet mit eige nem Sta tus. |
99 |
98 |
clsComm3mSC.HandleStatusCommand() |
BlockPatron
Leser/Ausweis sperren
BIBLIOTHECAplus antwortet bei dieser Anfrage anstatt der laut SIP/2-Protokoll vorgegebenen 24er Antwort mit der 98, was dem Befehl "ACS Status" entspricht.
Request
01<card retained><transaction date><institution id><blocked card msg><patron identifier><terminal password>
Feld |
ID |
Format |
Erforderlich |
Beschreibung |
---|---|---|---|---|
card retained |
|
1 Zeichen feste Länge: Y oder N |
erforderlich |
Karte einbehalten. Der Wert des Feldes wird nicht verarbeitet |
transaction date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
institution id |
AO |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
blocked card msg |
AL |
variable Länge |
erforderlich |
Dieser Wert wird im Benutzerkonto als Sperrmerker eingetragen. |
patron identifier |
AA |
variable Länge |
erforderlich |
Benutzernummer oder Ausweisnummer, Konfiguration über Parameter IsSVABenutzerNr , Ben2Ausweis |
terminal password |
AC |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
Response
98<on-line status><checkin ok><checkout ok><ACS renewal policy><status update ok><off-line ok><timeout period><retries allowed><date / time sync><protocol version><institution id><library name><supported messages ><terminal location><screen message><print line>
Feld |
ID |
Format |
Beschreibung |
---|---|---|---|
on-line status |
|
1 Zeichen feste Länge: Y oder N |
Hier wird immer Y zurückgegeben |
checkin ok |
|
1 Zeichen feste Länge: Y oder N |
Hier wird immer Y zurückgegeben |
checkout ok |
|
1 Zeichen feste Länge: Y oder N |
Hier wird immer Y zurückgegeben |
ACS renewal policy |
|
1 Zeichen feste Länge: Y oder N |
Hier wird immer Y zurückgegeben |
status update ok |
|
1 Zeichen feste Länge: Y oder N |
Hier wird immer Y zurückgegeben |
off-line ok |
|
1 Zeichen feste Länge |
Hier wird immer Y zurückgegeben |
timeout period |
|
3 Zeichen feste Länge |
Es wird der Inhalt des Parameters mmmRetryTimeOut zurückgegeben |
retries allowed |
|
3 Zeichen feste Länge |
|
date / time sync |
|
18 Zeichen feste Länge |
Es wird das aktuelle Systemdatum und die -zeit zurückgegeben |
Protokollversion |
|
|
Es wird der Inhalt des Parameters mmmProtocolVersion zurückgegeben |
InstitutionID |
AO |
variable Länge |
Es wird der Inhalt des Parameters mmmInstitutionID zurückgegeben |
Library Name |
AM |
variable Länge |
Es wird der Inhalt des Parameters mmmLibraryName zurückgegeben |
Supported Messages |
BX |
variable Länge |
Es wird der Inhalt des Parameters mmmSupportedMessages zurückgegeben |
Zweigstelle |
AN |
variable Länge |
Es wird der Inhalt des Parameters mmmZweigstelle zurückgegeben |
Screen Message |
AF |
variable Länge |
Es wird der Inhalt des Parameters mmm98ScreenMessage zurückgegeben |
Print Line |
AG |
variable Länge |
Es wird der Inhalt des Parameters mmm98PrintLine zurückgegeben |
Beispielanfrage
Request.: 01Y20141118 113219AOTestInstitution|ALKarte gesperrt|AA00009435|ACPass|AZE6C2<CR>
Checkin
Rückgabe eines Mediums
Request
09 <no block ><transaction date><return date><current location><institution id><item identifier><terminal password> <item properties><cancel>
Feld |
ID |
Format |
Erforderlich |
Beschreibung |
---|---|---|---|---|
no block |
|
1 Zeichen feste Länge: Y oder N |
erforderlich |
Wenn der Wert des Feldes Y ist, werden keine Prüfungen durchgeführt. |
transaction date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
return date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
current location |
AP |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
institution id |
AO |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
item identifier |
AB |
variable Länge |
erforderlich |
Es wird eine Buchungsnummer erwartet |
terminal password |
AC |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
item properties |
CH |
variable Länge |
optional |
Der Wert des Feldes wird nicht verarbeitet |
cancel |
BI |
1 Zeichen feste Länge: Y oder N |
optional |
Eine cancel-Anforderung (Rückgängigmachen eines Checkout) kann nur dann erfolgen, wenn der Checkin noch nicht verbucht wurde. Die Verbuchung erfolgt, wenn der Timer ‚ResetTimer‘ (Parameter [Ausleihe].ResetTimer) aktiv wird, oder Daten eines neuen Lesers über SIP/2 verarbeitet werden sollen. |
Response
10<ok><resensitize><magnetic media><alert><transaction date><institution id><item identifier><permanent location><title identifier><sort bin><patron identifier><media type><item properties><collection code><call number><destination location><alert type><hold patron id><hold patron name><screen message><print line>
Feld |
ID |
Format |
Beschreibung |
---|---|---|---|
ok |
|
1 Zeichen feste Länge: 0 oder 1 |
Rückgabe durchgeführt |
resensitize |
|
1 Zeichen feste Länge: Y oder N |
Wenn magnetic media = Y wird hier N übergeben. Wenn magnetic media = N, wird Y übergeben. |
magnetic media |
|
1 Zeichen feste Länge: Y oder N |
Konfiguration über Parameter Magnetische-Mediengruppen . Wenn die Mediengruppe des Exemplars im Wert des Parameters enthalten oder leer ist wird Y zurückgegeben. Ansonsten N. |
alert |
|
1 Zeichen feste Länge: Y oder N |
Konfiguration über Parameter 3MRejectCheckinOverdue . Wenn der Parameter auf N gesetzt ist, wird Alert auf Y gesetzt, wenn das Exemplar überzogen ist. |
transaction date |
|
18 Zeichen feste Länge |
Zeitpunkt der Bearbeitung der Anfrage (aktuelles Systemdatum und -zeit) |
institution id |
AO |
variable Länge |
Es wird der Wert des Parameters mmmInstitutionID zurückgegeben |
item identifier |
AB |
variable Länge |
Es wird der Wert des AB-Feldes der Anfrage übergeben. |
permanent location |
AQ |
variable Länge |
Es wird die Zweigstelle des Exemplars übergeben. |
title identifier |
AJ |
variable Länge |
Es wird der Kurztitel und der Verfasser des Exemplars übergeben, sofern im Exemplar angegeben. |
sort bin |
CL |
variable Länge |
Wenn für das Exemplar Vormerkungen existieren, wird der Wert R übergeben. Ansonsten der Inhalt des BIN-Werts des Exemplars. |
patron identifier |
AA |
variable Länge |
Es wird die Ausweisnummer des Lesers des Exemplars übergeben. |
media type |
CK |
variable Länge |
Konfiguration über Parameter MedienGruppenKuerzel |
collection code |
CR |
variable Länge |
Langwert von MEKZ des zurückgegebenen Exemplars |
call number |
CS |
variable Länge |
Signatur des zurückgegebenen Exemplars (Zeilenumbrüche in der Signatur werden durch Leerzeichen ersetzt) |
destination location |
CT |
variable Länge |
Wenn Abholzweigstelle (Vormerkung.Zweigstelle) auffindbar, diese als CT zurückgeben, ansonsten Exemplar.Zweigstelle |
alert type |
CV |
variable Länge |
- 01 hold for this library -> Vormerkung.Zweigstelle == Arbeitsplatzzweigstelle aus winoeb.ini - 02 hold for other branch -> Vormerkung.Zweigstelle != Arbeitsplatzzweigstelle aus winoeb.ini, zusätzliche Prüfung, ob ExemplarStatus in (t, T) - 04 sent to other branch -> kein Eintrag in Vormerkung und Exemplarstatus in (t, T) |
hold patron id |
CY |
variable Länge |
Ausweisnummer |
hold patron name |
DA |
variable Länge |
Nachname, Vorname |
print line |
AG |
variable Länge |
Benutzer-/ Kontextspezifische Meldungen: -Angabe des Kurztitels des Exemplars, sofern angegeben. -Rückgabe überzogener Exemplare nicht erlaubt. -Exemplar überzogen. Gebühr fällig, Zahlung am Kassenautomaten. |
Beispielanfrage
Request: 09Y20141117 11323200000000 000000AP|AO|AB00622546|AC|AY1|AZF141<CR>
Response: 101YNN20141117 113259AOTestBibliothek|AB00622546|AQHST|AJBeer, Hans de: Kleiner Eisbär wovon träumst du?|AF|AGKleiner Eisbär wovon träumst du?|AYAZD42A<CR>
Checkout
Ausleihe eines Mediums
Request
11 <SC renewal policy><no block><transaction date><nb due date><institution id><patron identifier><item identifier><terminal password><patron password><item properties><fee acknowledged><cancel>
Feld |
ID |
Format |
Erforderlich |
Beschreibung |
---|---|---|---|---|
SC renewal policy |
|
1 Zeichen feste Länge: Y oder N |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
no block |
|
1 Zeichen feste Länge: Y oder N |
erforderlich |
Wenn der Wert des Feldes Y ist, werden keine Prüfungen durchgeführt. |
transaction date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
nb due date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
institution id |
AO |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
patron identi-fier |
AA |
variable Länge |
erforderlich |
Benutzernummer oder Ausweisnummer, Konfiguration über Parameter IsSVABenutzerNr , Ben2Ausweis |
item identifi-er |
AB |
variable Länge |
erforderlich |
Konfiguration über Parameter TrpIdentifier |
terminal password |
AC |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
patron password |
AD |
variable Länge |
|
|
item proper-ties |
CH |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
fee acknowl-edged |
BO |
1 Zeichen feste Länge: Y oder N |
optional |
Wenn Parameter BOswitch= Wert 1 (Default), so verhält sich die Schnitstelle für Checkout Messages (Kommando 11/12) wie zuvor. Die Ausleihe findet direkt statt. Wenn Parameter BOswitch= den Wert 0 hat, dann ist fee achnowledged aktiv. Der Parameter MMMPROTOCOLVERSION=2.00 muss für diese Funktion zwingend vorhanden sein. Wenn der Automat im Request 11 für das Feld BO den Wert N sendet, dann wird keine Ausleihe getätigt, sondern die Kosten für eine Ausleihe durch diesen Leser im Feld BV zurückgegeben. Wenn der Automat im Request 11 für das Feld BO den Wert Y sendet, dann wird die Ausleihe getätigt. |
cancel |
BI |
1 Zeichen feste Län-ge: Y oder N |
optional |
Eine cancel-Anforderung (Rückgängigmachen eines Checkouts) kann nur dann erfolgen, wenn der Checkout noch nicht verbucht wurde. Die Verbuchung erfolgt, wenn der Timer ‚ResetTimer‘ (Parameter [Ausleihe].ResetTimer) aktiv wird, oder Daten eines neuen Lesers über SIP/2 verarbeitet werden sollen. |
Response
12<ok><renewal ok><magnetic media><desensitize><transaction date><institution id><patron identifier><item identifier><title identifier><due date><fee type><security inhibit><currency type><fee amount><media type><item properties><transaction id><screen message><print line>
Feld |
ID |
Format |
Beschreibung |
---|---|---|---|
ok |
|
1 Zeichen feste Länge: Y oder N |
Ausleihe durchgeführt |
renewal ok |
|
1 Zeichen feste Länge: Y oder N |
Es wird immer N zurückgegeben |
magnetic media |
|
1 Zeichen feste Länge: Y oder N |
Konfiguration über Parameter Magnetische-Mediengruppen . Wenn die Mediengruppe des Exemplars im Wert des Parameters enthalten oder leer ist wird Y zurückgegeben. Ansonsten N |
Desensitize |
|
1 Zeichen feste Länge: Y oder N |
Wenn magnetic media = Y wird hier N übergeben. Wenn magnetic media = N, wird Y übergeben. |
transaction date |
|
18 Zeichen feste Länge |
Es wird das aktuelle Systemdatum und die –zeit übergeben |
institution id |
AO |
variable Länge |
Es wird der Wert des Parameters mmmInstitutionID zurückgegeben |
patron identifier |
AA |
variable Länge |
BenutzerNummer oder AusweisNummer. Konfiguration über Parameter IsSVABenutzerNr . |
item identifier |
AB |
variable Länge |
Es wird der Wert des AB-Feldes der Anfrage übergeben. |
title identifier |
AJ |
variable Länge |
Es wird der Kurztitel des Exemplars übergeben. |
due date |
AH |
variable Länge |
Es wird das Rückgabedatum des Mediums zurückgegeben. |
fee type |
BT |
2 Zeichen feste Länge: 01 .. 99 |
Es wird der fixe Wert 01 zurückgegeben. |
currency type |
BH |
3 Zeichen feste Länge |
Es wird der Wert des Parameters mmmCurr zurückgegeben |
fee amount |
BV |
variable Länge |
Konfiguration über Parameter CurrencySeperatorDot . Der Gebühren-Betrag wird über die Kondition BGEG mit der Benutzergruppe des Lesers und der Mediengruppe des Mediums berechnet. |
media type |
CK |
variable Länge |
Konfiguration über Parameter MedienGruppenKuerzel |
item properties |
CH |
variable Länge |
Ausleihhinweise |
screen message |
AF |
variable Länge |
Wenn Parameter AusleihHinweisAF= Wert J dann wird der Ausleihhinweis im Feld AF zusätzlich zum Feld CH ausgegeben. Im Fehlerfall wird im Feld AF weiterhin nur die Fehlermeldung ausgegeben z.B. "Bitte melden Sie sich an der Theke" |
print line |
AG |
variable Länge |
Benutzer-/ Kontextspezifische Meldungen:Falsches Passwort |
Beispielanfrage
Request: 11YN20141118 07264000000000 000000AO|AA00009904|AB00310911|AC|AY1|AZEF75<CR>
Response: 121NNY20141118 072733AOTestBibliothek|AA00009904|AB00310911|AJLindgren, Astrid: Pippi Langstrumpf geht an Bord|AH16.12.2014|AF|AG|AYAZDC79<CR
ItemInformation
Abfrage von Exemplardaten
Request
17 <transaction date><institution id><item identifier><terminal password>
Feld |
ID |
Format |
Erforderlich |
Beschreibung |
---|---|---|---|---|
transaction date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
institution id |
AO |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
item identifier |
AB |
variable Länge |
erforderlich |
Konfiguration über Parameter TrpIdentifier |
terminal password |
AC |
variable Länge |
optional |
Der Wert des Feldes wird nicht verarbeitet |
patron password |
AD |
variable Länge |
optional |
|
Response
18<circulation status><security marker><fee type><transaction date><hold queue length><due date><recall date><hold pickup date><item identifier><title identifier><owner><currency type><fee amount><media type><permanent location><current location><item properties><screen message><print line>
Feld |
ID |
Format |
Beschreibung |
---|---|---|---|
circulation status |
|
2 Zeichen feste Länge: 00 bis 99 |
Exemplar-Status |
security marker |
|
2 Zeichen feste Länge: 00 bis 99 |
Es wird der Wert 00 zurückgegeben |
fee type |
|
2 Zeichen feste Länge: 01 bis 99 |
Die Art der Gebühr, die mit dem Ausleihen dieses Mediums verbunden ist. Es wird der Wert 01 zurückgegeben. |
transaction date |
|
18 Zeichen feste Länge |
Es wird das aktuelle Systemdatum und die –zeit übergeben. |
hold queue length |
CF |
variable Länge |
|
due date |
AH |
variable Länge |
Frist (Rückgabedatum des Exemplars) |
item identifier |
AB |
variable Länge |
Es wird der Wert des AB-Feldes der Checkout-Anfrage übergeben. |
title identifier |
AJ |
variable Länge |
Es wird der Kurztitel des Exemplars übergeben |
owner |
BG |
variable Länge |
Es wird die Ausweisnummer oder die Benutzernummer des Lesers des Exemplars übergeben. Konfiguration über Parameter SendeAusweisNr . |
currency type |
BH |
3 Zeichen feste Länge |
EUR |
fee amount |
BV |
variable Länge |
Der Betrag, der mit diesem Medium verbunden ist. |
media type |
CK |
3 Zeichen feste Länge |
Konfiguration über Parameter MedienGruppenKuerzel |
permanent location |
AQ |
variable Länge |
Es wird die Zweigstelle des Exemplars übergeben. Falls beim Exemplar keine Zweigstelle angegeben ist, wird die Zweigstelle des Verbuchungssystems zurückgegeben (Wert des Parameters mmmZweigstelle ) |
Item properties |
CH |
variable Länge |
Ausleihhinweise |
screen message |
AF |
variable Länge |
Wenn Parameter AusleihHinweisAF= Wert J dann wird der Ausleihhinweis im Feld AF zusätzlich zum Feld CH ausgegeben. Im Fehlerfall wird im Feld AF weiterhin nur die Fehlermeldung ausgegeben z.B. "Bitte melden Sie sich an der Theke" |
print line |
AG |
variable Länge |
|
Beispielanfrage
Request: 1720141118 072317AO|AB00310911|AC|AY1|AZF5C9<CR>
Response: 1804000120141118 072329CF0|AH13.04.2013|AB00310911|AJLindgren, Astrid: Pippi Langstrumpf geht an Bord|BG00009904|BH|BV0,00|CK001|AQHST|CH16.03.2013|AF|AG|AYAZD2E5<CR>
PatronStatusRequest
Abfrage von Benutzerdaten (Einfach)
Request
23 <language><transaction date><institution id><patron identifier><terminal password><patron password>
Feld |
ID |
Format |
Erforderlich |
Beschreibung |
---|---|---|---|---|
language |
|
3 Zeichen feste Länge |
erforderlich |
wird beim Response 1 zu 1 zurückgeliefert |
transaction date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
institution id |
AO |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
patron identifier |
AA |
variable Länge |
erforderlich |
Benutzernummer oder Ausweisnummer, Konfiguration über Parameter IsSVABenutzerNr, Ben2Ausweis |
terminal password |
AC |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
patron password |
AD |
variable Länge |
erforderlich |
Benutzer-Passwort, Konfiguration über Parameter BenutzerPasswort |
Response
24 <patron status><language><transaction date><institution id><patron identifier><personal name><valid patron><valid patron password><currency type><fee amount><screen message><print line>
Feld |
ID |
Format |
Beschreibung |
---|---|---|---|
patron status |
|
14 Zeichen feste Länge |
Gesperrter Benutzer: YYYYYYYYYYYYYYAusweis abgelaufen: YYYYYYYYYYYYYYSonst: 14 BlanksKeine detaillierte Unterstützung gemäß SIP2.NISO.Z39.70 |
language |
|
3 Zeichen feste Länge |
Sprache der Anfrage |
transaction date |
|
18 Zeichen feste Länge |
Zeitpunkt der Bearbeitung der Anfrage |
institution id |
AO |
variable Länge |
Konfiguration über Parameter mmmInstitutionID |
patron identifier |
AA |
variable Länge |
Ausweisnummer bzw. Benutzernummer der Anfrage |
personal name |
AE |
variable Länge |
BIBLIOTHECA Benutzername (Anrede Name, Vorname) |
valid patron |
BL |
1 Zeichen feste Länge: Y oder N |
Y: gültig (existiert) N: ungültig (existiert nicht) |
valid patron password |
CQ |
1 Zeichen feste Länge: Y oder N |
Y: gültig N: bei falschem Passwort bzw. Benutzer existiert gar nicht |
currency type |
BH |
3 Zeichen feste Länge |
Konfiguration über Parameter mmmCurr |
fee amount |
BV |
variable Länge |
aktueller Gebührenstand des Benutzers, auf 2 Nachkommastellen gerundet. Konfiguration über Parameter CurrencySeperatorDotwird nur geliefert, wenn… |
screen message |
AF |
variable Länge |
Benutzer-/ Kontextspezifische Meldungen: -Ausleihe nicht erlaubt<LF> -Es liegen keine Einträge im Benutzerkonto vor! -Ihre Jahresgebühr ist abgelaufen, bitte zahlen Sie vor der Ausleihe Ihrer Medien die Gebühr an der Anmeldung -Falsches Passwort; bitte melden Sie sich an der Theke XXXXXX -> SperrvermerktXXX-> -Die Gültigkeit des Ausweises des Lesers ist am .... abgelaufen! -XXX-> Der Ausweis des Lesers ist" || sTmp2 || " abgelaufen (Ausweisgebühr). -XXX-> Bitte melden Sie sich an der Theke und halten Sie Ihren Ausweis bereit. -XXX-> Sperrvermerk: Maximale Mahnstufe erreicht! -XXX-> Die Gebührensperrgrenze von ... ist überschritten! |
print line |
AG |
variable Länge |
Benutzer-/ Kontextspezifische Meldungen: -Bitte wenden Sie sich bitte an das Personal der Stadtbuecherei. -Bitte melden Sie sich an der Theke. -Ihre Jahresgebühr ist abgelaufen, bitte zahlen Sie vor der Ausleihe Ihrer Medien die Gebühr an der Anmeldung. -Falsches Passwort; Bitte melden Sie sich an der Theke. -XXX Bitte wenden Sie sich bitte an das Personal der Stadtbuecherei. -XXX Bitte melden Sie sich an der Theke. -XXX Bitte wenden Sie sich bitte an das Personal der Stadtbuecherei. -> Wobei XXX eine weitere Begründung ist. -XXX-> Sperrvermerkt. -XXX-> Die Gültigkeit des Ausweises des Lesers ist am .... abgelaufen! -XXX-> Der Ausweis des Lesers ist" || sTmp2 || " abgelaufen (Ausweisgebühr). -XXX-> Bitte melden Sie sich an der Theke und halten Sie Ihren Ausweis bereit. -XXX-> Sperrvermerk: Maximale Mahnstufe erreicht! -XXX-> Die Gebührensperrgrenze von ... ist überschritten! |
Beispielanfrage
Request: 23ger20141117 112617AOTestBibliothek|AA00009904|AC|AD|AY1|AZF38A<CR>
Response: 24 ger20141117 112448AO|AA00009904|AEMüller, Klara|BLY|CQY|BH|BV-5,00|AFGuten Tag|AG|AYAZE123<CR>
PatronEnable
Benutzer entsperren
Request
25 <transaction date><institution id><patron identifier><terminal password><patron password>
Feld |
ID |
Format |
Erforderlich |
Beschreibung |
---|---|---|---|---|
transaction date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
institution id |
AO |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
patron identifier |
AA |
variable Länge |
erforderlich |
Benutzernummer oder Ausweisnummer, Konfiguration über Parameter IsSVABenutzerNr , Ben2Ausweis |
terminal password |
AC |
variable Länge |
optional |
Der Wert des Feldes wird nicht verarbeitet |
patron password |
AD |
variable Länge |
optional |
Benutzer-Passwort, Konfiguration über Parameter BenutzerPasswort |
Response
26 <patron status><language><transaction date><institution id><patron identifier><personal name><valid patron><valid patron password><screen message><print line>
Feld |
ID |
Format |
Beschreibung |
patron status |
|
14 Zeichen feste Länge |
Enthält 14 Leerzeichen, wenn Prüfung positiv, 14 Y, wenn ein Problem vorliegt (Sperre, Passwort falsch, Ausweis abgelaufen, Benutzergruppe nicht gesetzt ...) |
language |
|
3 Zeichen feste Länge |
|
transaction date |
|
18 Zeichen feste Länge |
Zeitpunkt der Bearbeitung der Anfrage (aktuelles Systemdatum und -zeit) |
institution id |
AO |
variable Länge |
Konfiguration über Parameter mmmInstitutionID |
patron identifier |
AA |
variable Länge |
Die im Request übergebene Benutzernummer |
personal name |
AE |
variable Länge |
Benutzername (Titel Nachname , Vorname) |
valid patron |
BL |
1 Zeichen: Y oder N |
Y=Benutzer vorhanden N=Benutzer nicht vorhanden |
valid patron password |
CQ |
1 Zeichen: Y oder N |
Y=Passwort korrekt N=Passwort falsch |
screen message |
AF |
variable Länge |
Benutzer-/ Kontextspezifische Meldungen: -Falsches Passwort; bitte melden Sie sich an der Theke -Guten Tag -Ihre Jahresgebühr ist abgelaufen, bitte zahlen Sie vor der Ausleihe Ihrer Medien die Gebühr an der Anmeldung -Es liegen keine Einträge im Benutzerkonto vor! -> keine Gebühren -Ausleihe nicht erlaubt -> Benutzer gesperrt |
print line |
AG |
variable Länge |
Benutzer-/ k ontextspezifische Meldungen: -Falsches Passwort; Bitte melden Sie sich an der Theke -Ihre Jahresgebühr ist abgelaufen, bitte zahlen Sie vor der Ausleihe Ihrer Medien die Gebühr an der Anmeldung -Bitte melden Sie sich an der Theke -> Keine Einträge in Benutzerkonto (Gebühren) -XXX Bitte wenden Sie sich bitte an das Personal der Stadtbuecherei. -> Wobei XXX eine weitere Begründung ist. -XXX-> Sperrvermerkt -XXX-> Die Gültigkeit des Ausweises des Lesers ist am .... abgelaufen! -XXX-> Der Ausweis des Lesers ist" || sTmp2 || " abgelaufen (Ausweisgebühr). -XXX-> Bitte melden Sie sich an der Theke und halten Sie Ihren Ausweis bereit. -XXX-> Sperrvermerk: Maximale Mahnstufe erreicht! |
Beispielanfrage
Request: 26 ger20141118 084252AO|AA00009904|AEMüller, Klara|AFGuten Tag|AG|AY1AZE6C2<CR>
Response: 2520141118 084252AOTestBibliothek|AA00009904|AC|AD|AY1|AZF4C2<CR>
Renew
Einzelverlängerung
Request
29 <third party allowed><no block><transaction date><nb due date><institution id><patron identifier><patron password><item identifier><title identifier><terminal password><item properties><fee acknowledged>
Feld |
ID |
Format |
Erforderlich |
Beschreibung |
---|---|---|---|---|
third party allowed |
|
1 Zeichen feste Länge: Y oder N |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
no block |
|
1 Zeichen feste Länge: Y oder N |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
transaction date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
nb due date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
institution id |
AO |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
patron identifier |
AA |
variable Länge |
erforderlich |
Benutzernummer oder Ausweisnummer, Konfiguration über Parameter IsSVABenutzerNr , Ben2Ausweis |
patron password |
AD |
variable Länge |
optional |
Benutzer-Passwort, Konfiguration über Parameter BenutzerPasswort |
item identifier |
AB |
variable Länge |
optional |
|
title identifier |
AJ |
variable Länge |
optional |
Der Wert des Feldes wird nicht verarbeitet |
terminal password |
AC |
variable Länge |
optional |
Der Wert des Feldes wird nicht verarbeitet |
item porperties |
CH |
variable Länge |
optional |
Der Wert des Feldes wird nicht verarbeitet |
fee acknowledged |
BO |
1 Zeichen feste Länge: Y oder N |
optional |
|
Response
30 <ok><renewal ok><magnetic media><desensitize><transaction date><institution id><patron identifier><item identifier><title identifier><due date><fee type><security inhibit><currency type><fee amount><media type><item properties><transaction id><screen message><print line>
Feld |
ID |
Format |
Beschreibung |
---|---|---|---|
ok |
|
1 Zeichen feste Länge: 0 oder 1 |
Verlängerung durchgeführt |
renewal ok |
|
1 Zeichen feste Länge: Y oder N |
Verlängerung zulässig |
magnetic media |
|
1 Zeichen feste Länge: Y, N oder U |
Magnetisches Medium (bei uns nur Y oder N). Wenn Mediengruppe des zu verlängernden Items in Parameter Magnetische-Mediengruppen , dann Y andernfalls N. |
desensitize |
|
1 Zeichen feste Länge: Y, N oder U |
Gegenteil von Magnetisches Medium (bei uns also nur N oder Y) |
transaction date |
|
18 Zeichen feste Länge |
Zeitpunkt der Bearbeitung der Anfrage (aktuelles Systemdatum und -zeit) |
institution id |
AO |
variable Länge |
Konfiguration über Parameter mmmInstitutionID |
patron identifier |
AA |
variable Länge |
Die in der Anfrage übergebene Ausweisnummer bzw. Benutzernummer |
item identifier |
AB |
variable Länge |
Buchungsnummer |
title identifier |
AJ |
variable Länge |
Der Kurztitel sowie der Verfasser des Exemplars |
due date |
AH |
variable Länge |
Frist |
fee type |
BT |
2 Zeichen feste Länge: 01 .. 99 |
Die Art der Gebühr bei der Verlängerung dieses Mediums. Es wird "01" übergeben. |
security inhibit |
CI |
1 Zeichen feste Länge: Y oder N |
Es wird "N" übergeben. |
currency type |
BH |
3 Zeichen feste Länge |
|
fee amount |
BV |
variable Länge |
Der Betrag der Gebühr für dieses Medium. |
media type |
CK |
3 Zeichen feste Länge |
Konfiguration über Parameter MedienGruppenKuerzel |
item properties |
CH |
variable Länge |
Es wird die Konstante 000 übergeben. |
screen message |
AF |
variable Länge |
Benutzer-/ Kontextspezifische Meldungen: -Verlängerung nicht möglich. -Das übermittelte Passwort war falsch! Das Exemplar wurde nicht verlängert. Falls der Parameter AusfMeldung ein M enthält, werden Sperrtexte an die Screenmessage angehängt. |
print line |
AG |
variable Länge |
Benutzer-/ Kontextspezifische Meldungen: -Falsches Passwort. Keine Verlängerung möglich. |
Beispielanfrage
Request..: 29YY20141230 10243220150104 093748AO|AA00009904|AB00622546|AZE6C2<CR>
Response: 301YNY20141118 084252AOTestBibliothek|AA00009904|AB00622546|AJDie verlorene Ehre der Katarina Blum, Böll, Heinrich|AH20150123|BV0,50|AFVerlängerung erfolgreich|AG|AZF4C2<CR>
EndPatronSession
Benutzersession beenden
Request
35 <transaction date><institution id><patron identifier><terminal password><patron password>
Feld |
ID |
Format |
Erforderlich |
Beschreibung |
---|---|---|---|---|
transaction date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
institution id |
AO |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
patron identifier |
AA |
variable Länge |
erforderlich |
|
terminal password |
AC |
variable Länge |
optional |
Der Wert des Feldes wird nicht verarbeitet |
patron password |
AD |
variable Länge |
optional |
Der Wert des Feldes wird nicht verarbeitet |
Response
36 <ok><end session><transaction date><institution id><patron identifier><screen message><print line>
Feld |
ID |
Format |
Beschreibung |
---|---|---|---|
end session |
|
1 Zeichen feste Länge: Y oder N |
Wir übergeben "Y". |
transaction date |
|
18 Zeichen feste Länge |
Zeitpunkt der Bearbeitung der Anfrage (aktuelles Systemdatum und -zeit) |
institution id |
AO |
variable Länge |
Konfiguration über Parameter mmmInstitutionID |
patron identifier |
AA |
variable Länge |
Es wird das Feld patron identifier der Anfrage zurückgegeben |
screen message |
AF |
variable Länge |
- |
print line |
AG |
variable Länge |
- |
Beispielanfrage
Request: 3520141118 113219AOTestInstitution|AA00009435|ACTerminalPass|ADPatronPass|AZE6C2<CR>
Response: 36Y20141118 114359AOTestBibliothek|AA00009435|AF|AG|AYAZF51A<CR>
FeePaid
Bezahlvorgang
Request
37 <transaction date><fee type><payment type><currency type><fee amount><institution id><patron identifier><terminal password><patron password><fee identifier><transaction id>
Feld |
ID |
Format |
Erforderlich |
Beschreibung |
---|---|---|---|---|
transaction date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
fee type |
|
2 Zeichen feste Länge: 01 .. 99 |
erforderlich |
|
payment type |
|
2 Zeichen feste Länge: 00 .. 99 |
erforderlich |
Wert 00 -> Die Zahlung wird als Kasse="T" - BAR markiert Wert 01 oder 02 -> Die Zahlung wird als Kasse="E" - ECash markiert |
currency type |
|
3 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
fee amount |
BV |
variable Länge |
erforderlich |
|
institution id |
AO |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
patron identifier |
AA |
variable Länge |
erforderlich |
Benutzernummer oder Ausweisnummer, Konfiguration über Parameter IsSVABenutzerNr , Ben2Ausweis |
terminal password |
AC |
variable Länge |
optional |
Der Wert des Feldes wird nicht verarbeitet |
patron password |
AD |
variable Länge |
optional |
Benutzer-Passwort, Konfiguration über BenutzerPasswort |
fee identifier |
CG |
variable Länge |
optional |
|
transaction id |
BK |
variable Länge |
optional |
wird beim Response 1 zu 1 im BK Feld zurückgeliefert |
Response
38 <payment accepted><transaction date><institution id><patron identifier><transaction id><screen message><print line>
Feld |
ID |
Format |
Beschreibung |
---|---|---|---|
payment accepted |
|
1 Zeichen feste Länge: Y oder N |
Y: Zahlung akzeptiert N: Zahlung nicht akzeptiert |
transaction date |
|
18 Zeichen feste Länge |
Zeitpunkt der Bearbeitung der Anfrage (aktuelles Systemdatum und -zeit) |
institution id |
AO |
variable Länge |
Konfiguration über Parameter mmmInstitutionID |
patron identifier |
AA |
variable Länge |
Ausweisnummer bzw. Benutzernummer der Anfrage |
transaction id |
BK |
variable Länge |
transaction id der Anfrage |
screen message |
AF |
variable Länge |
Benutzer-/ Kontextspezifische Meldungen: - Buchung erfolgreich! |
print line |
AG |
variable Länge |
Benutzer-/ Kontextspezifische Meldungen: -Passwörter stimmen nicht überein! -Betrag (Dezimaltrennzeichen) ungültig |
Beispielanfrage
Request: 3720141118 0819020100EURBV1,00|AO|AA00009904|AC|AD|AY1AZF1BE<CR>
Response: 38Y20141118 081922AOTestBibliothek|AA00009904|BK|AFBuchung erfolgreich!|AG|AY1AZEC47<CR>
PatronInformation
Abfrage von Benutzerdaten
Request
63 <language><transaction date><summary><institution id><patron identifier><terminalpassword><patron password><start item><end item>
Feld |
ID |
Format |
Erforderlich |
Beschreibung |
---|---|---|---|---|
language |
|
3 Zeichen feste Länge |
erforderlich |
Sprache der Anfrage, wird beim Response 1 zu 1 zurückgeliefert |
transaction date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
summary |
|
10 Zeichen feste Länge |
erforderlich |
Pos. 0: hold items 1: overdue items 2: charged items 3: fine items 4: recall items 5: unavailable holds 6: fee items |
institution id |
AO |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
patron identifier |
AA |
variable Länge |
erforderlich |
Ausweisnummer oder Benutzernummer, Konfiguration über Parameter IsSVABenutzerNr , Ben2Ausweis |
terminal password |
AC |
variable Länge |
optional |
Der Wert des Feldes wird nicht verarbeitet |
patron password |
AD |
variable Länge |
optional |
Benutzer-Passwort, Konfiguration über BenutzerPasswort |
start item |
BP |
variable Länge |
optional |
Es wird der SIP2 Standard beginnend mit 1 verwendet. |
end item |
BQ |
variable Länge |
optional |
Es wird der SIP2 Standard beginnend mit 1 verwendet. |
Response
64 <patron status><language><transaction date><hold items count><overdue items count><charged items count><fine items count><recall items count><unavailable holds count><institution id><patron identifier><personal name><hold items limit><overdue items limit><charged items limit><valid patron><valid patron password><currency type><fee amount><fee limit><items><home address><e-mail address><home phone number><screen message><print line>
Feld |
ID |
Format |
Beschreibung |
---|---|---|---|
patron status |
|
14 Zeichen feste Länge |
Ist ein Kriterium erfüllt, wird an der jeweiligen Stelle ein Y zurückgegeben. Ist ein Kriterium nicht erfüllt, wird an der jeweiligen Stelle ein Leerzeichen zurückgegeben. Die Kriterien für die jeweiligen Positionen in der Zeichenkette sind (1. Kriterium 0, 14. Kriterium 13): 0 charge privileges denied -> immer false (" ") 1 renewal privileges denied -> Sperre, Selbstbedienungssperre, BezahltBis oder Gültigbis < Heute, Gebührensperrgrenze überschritten 2 recall privileges denied -> immer false (" ") 3 hold privileges denied -> immer false (" ") 4 card reported lost -> immer false (" ") 5 too many items charged -> immer false (" ") 6 too many items overdue –> Der Wert für Konfig/Sys Mahnsperre ist im Leserkonto erreicht für ein oder mehrere Exemplare 7 too many renewals -> immer false (" ") 8 too many claims of items returned -> immer false (" ") 9 too many items lost -> immer false (" ") 10 excessive outstanding fines -> immer false (" ") 11 excessive outstanding fees -> Gebührensperrgrenze überschritten 12 recall overdue -> immer false (" ") 13 too many items billed -> immer false (" ") Falls Parameter BenutzerPasswort=J: Fehlerfall: "YYYY ". YYYYYYYYYYYYYY. Erfolg: 14 Blanks |
language |
|
3 Zeichen feste Länge |
Sprache der Anfrage |
transaction date |
|
18 Zeichen feste Länge |
Zeitpunkt der Bearbeitung der Anfrage (aktuelles Systemdatum und -zeit) |
hold items count |
|
4 Zeichen feste Länge |
Anzahl vorgemerkte Exemplare |
overdue items count |
|
4 Zeichen feste Länge |
Anzahl überfällige Exemplare |
charged items count |
|
4 Zeichen feste Länge |
Anzahl berechnete Exemplare |
fine items count |
|
4 Zeichen feste Länge |
Anzahl mit Säumnisgebühr belegte Exemplare |
recall items count |
|
4 Zeichen feste Länge |
Anzahl verlängerte Exemplare |
unavailable holds count |
|
4 Zeichen feste Länge |
Anzahl nicht verfügbare Vormerkungen |
institution id |
AO |
variable Länge |
Konfiguration über Parameter mmmInstitutionID |
patron identifier |
AA |
variable Länge |
Ausweisnummer bzw. Benutzernummer der Anfrage |
personal name |
AE |
variable Länge |
BIBLIOTHECA Benutzername |
valid patron |
BL |
1 Zeichen feste Länge: Y oder N |
Wenn Benutzer nicht gefunden werden kann, dann "N" |
valid patron password |
CQ |
1 Zeichen feste Länge: Y oder N |
Y = Passwort gültig N = Passwort ungültig |
currency type |
BH |
3 Zeichen feste Länge |
"EUR" |
fee amount |
BV |
variable Länge |
zu zahlender Betrag |
hold items |
AS |
variable Länge |
Vormerkungen. Der SQL-Befehl zur Ermittlung kann über PatronSelect1 angepasst werden. |
overdue items |
AT |
variable Länge |
Überfällige Exemplare. Der SQL-Befehl zur Ermittlung kann über PatronSelect2 angepasst werden. |
charged items |
AU |
variable Länge |
Berechnete Exemplare. Der SQL-Befehl zur Ermittlung kann über PatronSelect3 angepasst werden. |
fine items |
AV |
variable Länge |
Mit Säumnisgebühr belegte Exemplare. Der SQL-Befehl zur Ermittlung kann über PatronSelect4 angepasst werden. |
recall items |
BU |
variable Länge |
Verlängerte Exemplare. Der SQL-Befehl zur Ermittlung kann über PatronSelect5 angepasst werden. |
unavailable hold items |
CD |
variable Länge |
Nicht verfügbare Vormerkungen. Der SQL-Befehl zur Ermittlung kann über PatronSelect6 angepasst werden. |
fee items |
AV |
variable Länge |
|
overdue items limit |
CA |
4 Zeichen feste Länge |
Obergrenze Anzahl überfällige Exemplare. Hier wird immer 0000 zurückgegeben. |
charged items limit |
CB |
4 Zeichen feste Länge |
Obergrenze berechnet Exemplare. Hier wird immer 0000 zurückgegeben. |
hold items limit |
BZ |
4 Zeichen feste Länge |
Obergrenze Anzahl Vormerkungen. Hier wird immer 0000 zurückgegeben. |
birth date |
PB |
8 Zeichen feste Länge |
Geburtsdatum |
patron type |
ZY |
variable Länge |
Benutzergruppe |
e-mai address |
BE |
variable Länge |
E-Mail Adresse |
screen message |
AF |
variable Länge |
Benutzer-/ Kontextspezifische Meldungen: -Wenn das Passwort überprüft werden soll (Parameter BenutzerPasswort aktiviert und das Passwort ist fehlerhaft), kommt die Meldung "Benutzerpasswort wurde falsch eingegeben!". Wenn kein entsprechender Benutzer gefunden werden kann, kommt die Meldung "Keine Benutzerdaten vorhanden!". |
print line |
AG |
variable Länge |
Benutzer-/ Kontextspezifische Meldungen: -Wenn das Passwort überprüft werden soll (Parameter BenutzerPasswort aktiviert und das Passwort ist fehlerhaft), kommt die Meldung "Falsches Benutzerpasswort". Wenn kein entsprechender Benutzer gefunden werden kann, kommt die Meldung "Bitte melden Sie sich an der Theke". |
Beispielanfrage
Request: 63ger20141118 115647 AO|AA00009904|AC|AD|AY1|AZF23F<CR>
Response: 64 ger20141118 115647001700010015000000000000AOTestBibliothek|AA00009904|AEMüller, Klara| BLY|CQY|BHEUR|BV8,00|CA0000|CB0000|BZ0000|BEMueller.Klara@stadt.de|PB19870907|ZYERW|AF|AG|AY2AZC865<CR>
RenewAll
Alle Exemplare eines Benutzers verlängern
Request
65<transaction date><institution id><patron identifier><patron password><terminal password><fee acknowledged>
Feld |
ID |
Format |
Erforderlich |
Beschreibung |
---|---|---|---|---|
transaction date |
|
18 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
institution id |
AO |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
patron identifier |
AA |
variable Länge |
erforderlich |
Benutzernummer oder Ausweisnummer, Konfiguration über Parameter IsSVABenutzerNr , Ben2Ausweis |
patron password |
AD |
variable Länge |
optional |
Benutzer-Passwort, Konfiguration über Parameter BenutzerPasswort |
terminal password |
AC |
variable Länge |
optional |
Der Wert des Feldes wird nicht verarbeitet |
fee acknowledged |
BO |
1 Zeichen feste Länge: Y oder N |
optional |
Der Wert des Feldes wird nicht verarbeitet |
Response
66 <ok><renewed count><unrenewed count><transaction date><institution id><renewed items><unrenewed items><screen message><print line>
Feld |
ID |
Format |
Beschreibung |
---|---|---|---|
ok |
|
1 Zeichen feste Länge: 0 oder 1 |
Verlängerung durchgeführt |
renewed count |
|
4 Zeichen feste Länge |
Anzahl Verlängerungen |
unrenewed count |
|
4 Zeichen feste Länge |
Anzahl der nicht verlängerten Medien |
transaction date |
|
18 Zeichen feste Länge |
Zeitpunkt der Bearbeitung der Anfrage (aktuelles Systemdatum und -zeit) |
institution id |
AO |
variable Länge |
Es wird der Wert des Parameters mmmInstitutionID zurückgegeben |
renewed items |
BM |
variable Länge |
Je verlängertem Exemplar. Der Rückgabewert wird über den Parameter TrpIdentifier gesteuert. Wenn TrpIdentifier = 'B', werden Buchungsnummern der Exemplare zurückgegeben. Bei 'E' oder 'T' werden Exemplarnummern zurückgegeben. |
unrenewed items |
BN |
variable Länge |
Je nicht verlängertem Exemplar. Der Rückgabewert wird über den Parameter TrpIdentifier gesteuert. Wenn TrpIdentifier = 'B', werden Buchungsnummern der Exemplare zurückgegeben. Bei 'E' oder 'T' werden Exemplarnummern zurückgegeben. |
screen message |
AF |
variable Länge |
Benutzer-/ Kontextspezifische Meldungen: -Verlängerung nicht möglich -Das übermittelte Passwort war falsch! Die Exemplare wurden nicht verlängert. Falls der Parameter AusfMeldung ein M enthält, werden Sperrtexte aus BIBLIOTHECAplus an die Screenmessage angehängt. |
print line |
AG |
variable Länge |
Benutzer-/ Kontextspezifische Meldungen: -Falsches Passwort. Keine Verlängerung möglich. Wenn der Parameter RenewAllShowReturnDate den Wert J hat, werden alle verlängerten Exemplare, sowie deren Rückgabedatum zurückgegeben. |
Beispielanfrage
Request: 6520141118 095003AO|AA00009904|AD|AC|AY1|AZF4C2<CR>
Response: 6610016000120141118 095005AOTestBibliothek|BM00209307|BM00313470|BM00626985|BM00622546|BM00626685|BM00626622|BM00619488|BM00621802|BM00620331|BM00623256|BM00612732 |BM00312604|BM00612971|BM00313760|BM00628834|BM00310911|BN00616244|AF|AG|AYAZC97F<CR>
Login
Anmeldung des Selbstverbuchers an BIBLIOTHECAplus
Wird üblicherweise beim Start des Selbstverbuchers gesendet.
Request
93 <UID algorithm><PWD algorithm><Login user id><Login password><Location code>
Feld |
ID |
Format |
Erforderlich |
Beschreibung |
---|---|---|---|---|
UID algorithm |
|
1 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet sollte 0 für "Keine Verschlüsselung" sein |
PWD algorithm |
|
1 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet sollte 0 für "Keine Verschlüsselung" sein |
Login user id |
CN |
variable Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
Login password |
CO |
variable Länge |
erforderlich |
Konfiguration über Parameter mmmPWD |
Location code |
CP |
variable Länge |
optional |
Der Wert des Feldes wird nicht verarbeitet |
Response
94 <ok>
Feld |
ID |
Format |
Beschreibung |
---|---|---|---|
ok |
1 Zeichen feste Länge |
0: nicht erfolgreich |
Beispielanfrage
Request: 9300CN0000954COgeheim|AZE6C2<CR>
Response: 941AYAZFE2D<CR>
Request ACS Resend
Abweichend vom SIP/2 Standard senden wir immer die zuletzt gesendete Antwort. Das heißt, dass wir auch die Sequenz Nummer beim Resend übertragen
SCStatus
Selbstverbucher meldet Status an ACS. ACS antwortet mit eigenem Status.
Request
99 <status code><max print width><protocol version>
Feld |
ID |
Format |
Erforderlich |
Beschreibung |
---|---|---|---|---|
status code |
|
1 Zeichen feste Länge: 0, 1 oder 2 |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
max print width |
|
3 Zeichen feste Länge |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
protocol version |
|
4 Zeichen feste Länge: x.xx |
erforderlich |
Der Wert des Feldes wird nicht verarbeitet |
Response
98 <on-line status><checkin ok><checkout ok><ACS renewal policy><status update ok><off-line ok><timeout period><retries allowed><date / time sync><protocol version><institution id><library name><supported messages ><terminal location><screen message><print line>
Feld |
ID |
Format |
Beschreibung |
---|---|---|---|
on-line status |
|
1 Zeichen feste Länge: Y oder N |
Hier wird der Status zurückgegeben |
checkin ok |
|
1 Zeichen feste Länge: Y oder N |
Hier wird immer Y zurückgegeben |
checkout ok |
|
1 Zeichen feste Länge: Y oder N |
Hier wird immer Y zurückgegeben |
ACS renewal policy |
|
1 Zeichen feste Länge: Y oder N |
Hier wird immer Y zurückgegeben |
status update ok |
|
1 Zeichen feste Länge: Y oder N |
Hier wird immer Y zurückgegeben |
off-line ok |
|
1 Zeichen feste Länge |
Hier wird der Status zurückgegeben |
timeout period |
|
3 Zeichen feste Länge |
Es wird der Inhalt des Parameters mmmRetryTimeOut zurückgegeben |
retries allowed |
|
3 Zeichen feste Länge |
|
date / time sync |
|
18 Zeichen feste Länge |
Es wird das aktuelle Systemdatum und die -zeit zurückgegeben |
protocol version |
|
4 Zeichen feste Länge |
Es wird der Inhalt des Parameters mmmProtocolVersion zurückgegeben |
InstitutionID |
AO |
variable Länge |
Es wird der Wert des Parameters mmmInstitutionID zurückgegeben |
Library Name |
AM |
variable Länge |
Es wird der Wert des Parameters mmmLibraryName zurückgegeben |
Supported Messages |
BX |
variable Länge |
Es wird der Wert des Parameters mmmSupportedMessages zurückgegeben |
terminal location |
AN |
variable Länge |
Es wird der Wert des Parameters mmmZweigstelle zurückgegeben |
Screen Message |
AF |
variable Länge |
Es wird der Wert des Parameters mmm98ScreenMessage zurückgegeben |
Print Line |
AG |
variable Länge |
Es wird der Wert des Parameters mmm98PrintLine zurückgegeben |
Beispielanfrage
Request..: 9911002.00AZE6C2<CR>
Response: 98YYYYYY01000420141118 1132191.00AOTestBibliothek|AMOCLC|BXYYYYYYYYYYYYYNYY|ANHST|
Übersicht Parameter
Alle Parameter sind arbeitsplatzspezifische Einstellungen, die in der Datei winoeb.ini in der Sektion Sicherungs-System eingestellt werden müssen
TrpIdentifier
Dieser Parameter definiert, ob der übergebene Wert (z.B. im SIP/2-Feld item identifier) als Buchungsnummer, Exemplarnummer oder TransponderID zu interpretieren ist.
Wird herangezogen bei:
-
SIP2.Command.Checkin
-
SIP2.Command.Checkout
-
SIP2.Command.ItemInformation
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
TrpIdentifier |
S |
B |
B: der Wert enthält eine Buchungsnr E: der Wert enthält eine Exemplarnr |
Magnetische-Mediengruppen
Der Parameter enthält alle Mediengruppenkürzel die magnetisch sind.
Wird herangezogen bei:
-
SIP2.Command.Checkin
-
SIP2.Command.Checkout
-
SIP2.Command.Renew
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
Magnetische-Mediengruppen |
S |
Alle Mediengruppen, die magnetisch sind; durch * getrennt. |
IsSVABenutzerNr
Dieser Parameter definiert, ob bei SIP/2-Anfragen die Ausweisnummer oder die Benutzernummer übertragen wird.
Wird herangezogen bei:
-
SIP2.Command.PatronInformation
-
SIP2.Command.PatronStatusRequest
-
SIP2.Command.BlockPatron
-
SIP2.Command.Checkout
-
SIP2.Command.Renew
-
SIP2.Command.RenewAll
-
SIP2.Command.FeePaid
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
IsSVABenutzerNr |
B |
N |
N: Ausweisnummer |
Ben2Ausweis
Dieser Parameter definiert, ob bei der Ausweisnummer eine "#" als erstes Zeichen verwendet wird.
Wird herangezogen bei:
-
SIP2.Command.BlockPatron
-
SIP2.Command.Checkout
-
SIP2.Command.FeePaid
-
SIP2.Command.Renew
-
SIP2.Command.RenewAll
-
SIP2.Command.PatronInformation
-
SIP2.Command.PatronStatusRequest
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
Ben2Ausweis |
B |
N |
N: Keine Raute verwenden Y: Eine Raute als führendes Zeichen verwenden. |
mmmRetryTimeOut
Die ersten 3 Stellen sind die Timeoutzahl, letzten 3 Stellen die Anzahl der Retries für SIP/2
Wird herangezogen bei:
-
SIP2.Command.SCStatus
Sektion |
Name |
Typ |
Standardwert |
---|---|---|---|
Sicherungs-System |
mmmRetryTimeOut |
S |
010004 |
mmmProtocolVersion
Hier können Sie die Version des SIP/2 Übertragungsprotokolls einstellen
Wird herangezogen bei:
-
SIP2.Command.SCStatus
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
mmmProtocolVersion |
S |
1.00 |
1.00 für Funktionen des SIP Protokolls Version 1 2.00 für neuere Funktionen des SIP Protokolls Version 2 |
mmmInstitutionID
Dieser Parameter definiert die InstitutionID, welche bei SIP/2-Anfragen zurückgeliefert wird.
Wird herangezogen bei:
-
SIP2.Command.BlockPatron
-
SIP2.Command.Checkin
-
SIP2.Command.Checkout
-
SIP2.Command.FeePaid
-
SIP2.Command.PatronStatusRequest
-
SIP2.Command.PatronInformation
Sektion |
Name |
Typ |
Standardwert |
---|---|---|---|
Sicherungs-System |
mmmInstitutionID |
S |
mmmLibraryName
Wird herangezogen bei:
-
SIP2.Command.SCStatus
Sektion |
Name |
Typ |
Standardwert |
---|---|---|---|
Sicherungs-System |
mmmLibraryName |
S |
BOND |
mmmSupportedMessages
mmmSupportedMessages ist ein eParameter der Sektion SICHERUNGS-SYSTEM in der Datei winoeb.ini. Er wird für die Antwort auf das SIP2 Kommando SC Status (99) verwendet, um dem SC (SelfCheck System) mitzuteilen, welche SIP2-Kommandos von BIBLIOTHECAplus unterstützt werden.
mmmSupportedMessages ist im SIP2-Protokoll als ein String mit variabler Zeichenkette definiert, der die Zeichen 'Y' und 'N' enthalten kann. Mit diesem String teilt das ACS dem SC mit, welche Kommandos das ACS unterstützt. Je nach Position innerhalb des Strings steht der ein 'Y' dafür, dass das entsprechende Kommando unterstützt wird, ein 'N' besagt, dass das Kommando nicht unterstützt wird.
Da wir aktuell nur das Hold Kommando nicht unterstützen sollte mmmSupportedMessages auf den Wert 'YYYYYYYYYYYYYNYY' gesetzt werden.
Position |
Feldname |
Bedeutung |
SIP2 Kommando Anfrage des SC |
SIP2 Antwort BIBLIOTHECA |
---|---|---|---|---|
0 |
Patron Status Request |
Leserdaten erfragen |
23 |
24 |
1 |
Checkout |
Ausleihe |
11 |
12 |
2 |
Checkin |
Rückgabe |
09 |
10 |
3 |
Block Patron |
User (Leser) sperren |
01 |
24 (Wir liefern 98!!!) |
4 |
SC/ACS Status |
ACS meldet den aktuellen Status an SC |
99 |
98 |
5 |
Request SC/ACS Resend |
Aufforderung des SCs, die letzte Übertragung zu wiederholen |
97 |
(je nach Inhalt des letzten Puffers bzw. letztem Kommando) |
6 |
Login |
Anmelden eines Benutzers (Passwort überprüfen) |
93 |
94 |
7 |
Patron Information |
Benutzerdaten abfragen (Kontoabfrage). |
63 |
64 |
8 |
End Patron Session |
Benutzersession beenden |
35 |
36 |
9 |
Fee Paid |
Gebühren bezahlen |
37 |
38 |
10 |
Item Information |
Daten zu Exemplar ermitteln |
17 |
18 |
11 |
Item Status Update |
Exemplardaten ändern |
19 |
20 |
12 |
Patron Enable |
Benutzer entsperren |
25 |
26 |
13 |
Hold |
Vormerkungen |
15 |
26 |
14 |
Renew |
Einzelverlängerung |
29 |
30 |
15 |
Renew All |
Alle ausgeliehenen Exemplare eines Benutzers verlängern. |
65 |
66 |
mmmZweigstelle
Kürzel der Zweigstelle, in der sich der SIP/2 Server befindet
Wird herangezogen bei:
-
SIP2.Command.SCStatus
Sektion |
Name |
Typ |
Standardwert |
---|---|---|---|
Sicherungs-System |
mmmZweigstelle |
S |
mmm98ScreenMessage
Wird herangezogen bei:
-
SIP2.Command.SCStatus
Sektion |
Name |
Typ |
Standardwert |
---|---|---|---|
Sicherungs-System |
mmm98ScreenMessage |
S |
Selbstverbuchung |
mmm98PrintLine
Wird herangezogen bei:
-
SIP2.Command.SCStatus
Sektion |
Name |
Typ |
Standardwert |
---|---|---|---|
Sicherungs-System |
mmm98PrintLine |
S |
Selbstverbuchung |
mmmCurr
Dieser Parameter definiert die Währung, welches bei SIP/2-Anfragen zurückgeliefert wird.
Sollte dem ISO Standard 4217:1995 folgen. Wird bei den meisten unserer Kunden auf EUR konfiguriert sein.
Wird herangezogen bei:
-
SIP2.Command.PatronStatusRequest
-
SIP2.Command.Checkout
mmmPWD
Dieser Parameter definiert das Passwort, welches bei SIP/2-Anfragen zur Anmeldung am System gesendet werden kann.
Wird herangezogen bei:
-
SIP2.Command.Login
3MRejectCheckinOverdue
Dieser Parameter definiert, ob bei einem SIP/2-Checkin überzogene Exemplare zurückgegeben werden dürfen.
Wird herangezogen bei:
-
SIP2.Command.Checkin
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
3MRejectCheckinOverdue |
B |
N |
N: überzogene Exemplare dürfen bei einem SIP/2 Checkin nicht zurückgegeben werden |
MedienGruppenKuerzel
Dieser Parameter definiert, ob bei SIP/2-Anfragen die SIP/2 internen Mediengruppenkürzel oder die in BIBLIOTHECA definierten verwendet werden.
Wird herangezogen bei:
-
SIP2.Command.ItemInformation
-
SIP2.Command.Checkin
-
SIP2.Command.Renew
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
MedienGruppenKuerzel |
N: es werden die SIP2 konformen Mediengruppenkürzel (001, 002,…) gesendet. J: es werden die in BIBLIOTHECAplus definierten Kürzel (Bu, G, …) uncodiert gesendet. Betrifft das Feld CK (media type) bei Item Information Response (18) und Checkin Response (10) |
BOswitch
Über diese Funktionalität können Leser am Automaten vor Durchführung der Ausleihe über anfallende Gebühren informiert werden.
Die Ausleihe erfolgt erst nachdem die anfallenden Gebühren bestätigt wurden.
Dieser Parameter definiert, ob bei einem SIP/2-Checkout Request, wirklich verbucht wird (Wert des Parameters=1). Ansonsten wird nur eine Gebührenanfrage für die Ausleihe ermittelt.
Wird herangezogen bei:
-
SIP2.Command.Checkout
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
BOswitch |
N |
1 |
Für diese Funktion wird zwingend vorausgesetzt: MMMPROTOCOLVERSION=2.00 1: Exemplar wird direkt verbucht 0: Wenn der Automat im Request 11 für das Feld BO den Wert N sendet, dann wird keine Ausleihe getätigt, sondern die Kosten für eine Ausleihe durch diesen Leser im Feld BV zurückgegeben. Wenn der Automat im Request 11 für das Feld BO den Wert Y sendet, dann wird die Ausleihe getätigt. |
Hinweis: der frühere Parameter 3MBOswitch wird nicht mehr berücksichtigt.
CurrencySeperatorDot
Dieser Parameter definiert, ob Gebühren mit KOMMA- oder PUNKT-Trennern ausgegeben werden. Wird herangezogen bei:
-
SIP2.Command.PatronStatusRequest
-
SIP2.Command.Checkout
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
CurrencySeperatorDot |
B |
N |
N: es wird Komma als Separator übertragen |
SendeAusweisNr
Dieser Parameter definiert, ob bei SIP/2-Anfragen die Ausweisnummer oder die Benutzernummer übermittelt werden soll.
Wird herangezogen bei:
-
SIP2.Command.ItemInformation
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
SendeAusweisNr |
B |
J |
J: Ausweisnummer N: Benutzernummer |
BenutzerPasswort
Dieser Parameter definiert, ob bei SIP/2-Anfragen das Passwort überprüft werden soll.
Wird herangezogen bei:
-
SIP2.Command.Checkout
-
SIP2.Command.FeePaid
-
SIP2.Command.PatronInformation
-
SIP2.Command.PatronStatusRequest
-
SIP2.Command.Renew
-
SIP2.Command.RenewAll
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
BenutzerPasswort |
B |
N |
N: Passwort wird nicht überprüft |
AusleihHinweisAF
Über diesen Parameter kann die Ausgabe von Ausleihhinweisen
bei checkout Response (12) und Item Information Response (18) beeinflusst werden.
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
AusleihHinweisAF |
String |
N |
N: Ausleihhinweise werden im Feld CH übergeben. J: Ausleihhinweis werden im Feld AF zusätzlich zum Feld CH ausgegeben. Im Fehlerfall wird im Feld AF weiterhin nur die Fehlermeldung ausgegeben z.B. "Bitte melden Sie sich an der Theke" |
AusfMeldung
Dieser Parameter legt fest, ob bei SIP/2-Ausleihen Sperrtexte (Grund, warum ein Exemplar nicht ausgeliehen werden konnte) an die Screenmessage angehängt werden sollen.
Wird herangezogen bei:
-
SIP2.Command.Checkout
-
SIP2.Command.Renew
-
SIP2.Command.RenewAll
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
AusfMeldung |
String |
null |
M: Sperrtexte werden durch <LF> getrennt an die Screenmessage angehängt. |
PatronSelect1
Dieser Parameter definiert die Abfrage der Vormerkungen für den SIP/2 Befehl
PatronInformation.
Wird herangezogen bei:
-
SIP2.Command.PatronInformation
Sektion |
Name |
Typ |
Standardwert |
---|---|---|---|
Sicherungs-System |
PatronSelect1 |
S |
FROM exemplar |
PatronSelect2
Dieser Parameter definiert die Abfrage der überfälligen Exemplare für den SIP/2 Befehl
PatronInformation.
Wird herangezogen bei:
-
SIP2.Command.PatronInformation
Sektion |
Name |
Typ |
Standardwert |
---|---|---|---|
Sicherungs-System |
PatronSelect2 |
S |
FROM exemplar e WHERE e.exemplarstatus = 'E' and e.Mahndatum + X <= SYSDATE AND e.LeserNr = :sRealBenutzerNr |
Über die Variable sRealBenutzerNr wird der Patron der Anfrage für den Select verwendet.
PatronSelect3
Dieser Parameter definiert die Abfrage der berechneten Exemplare für den SIP/2 Befehl
PatronInformation.
Wird herangezogen bei:
-
SIP2.Command.PatronInformation
Sektion |
Name |
Typ |
Standardwert |
---|---|---|---|
Sicherungs-System |
PatronSelect3 |
S |
FROM exemplar e, benutzerkonten b WHERE e.exemplarstatus = 'E' and b.BenutzerNr = e.lesernr and b.MedienNr = e.ExemplarNr AND e.LeserNr = :sRealBenutzerNr |
Über die Variable sRealBenutzerNr wird der Patron der Anfrage für den Select verwendet.
PatronSelect4
Dieser Parameter definiert die Abfrage der mit Säumnisgebühr belegten Exemplare für den SIP/2 Befehl PatronInformation.
Wird herangezogen bei:
-
SIP2.Command.PatronInformation
Sektion |
Name |
Typ |
Standardwert |
---|---|---|---|
Sicherungs-System |
PatronSelect4 |
S |
FROM exemplar e WHERE e.exemplarstatus = 'E' AND e.LeserNr = :sRealBenutzerNr and exemplarnr not in (Select mediennr from benutzerkonten b where b.BenutzerNr = e.lesernr) |
Über die Variable sRealBenutzerNr wird der Patron der Anfrage für den Select verwendet.
PatronSelect5
Dieser Parameter definiert die Abfrage der verlängerten Exemplare für den SIP/2 Befehl
PatronInformation.
Wird herangezogen bei:
-
SIP2.Command.PatronInformation
Sektion |
Name |
Typ |
Standardwert |
---|---|---|---|
Sicherungs-System |
PatronSelect5 |
S |
FROM vormerkung v, exemplar e WHERE v.BenutzerNr = :sRealBenutzerNr and v.bereit is not null and v.exemplarnr = e.exemplarnr |
Über die Variable sRealBenutzerNr wird der Patron der Anfrage für den Select verwendet.
PatronSelect6
Dieser Parameter definiert die Abfrage der nicht verfügbare Vormerkungen für den SIP/2 Befehl PatronInformation.
Wird herangezogen bei:
-
SIP2.Command.PatronInformation
Sektion |
Name |
Typ |
Standardwert |
---|---|---|---|
Sicherungs-System |
PatronSelect6 |
S |
FROM vormerkung v, exemplar e WHERE v.BenutzerNr = :sRealBenutzerNr and v.bereit is null and v.exemplarnr = e.exemplarnr |
Über die Variable sRealBenutzerNr wird der Patron der Anfrage für den Select verwendet.
RenewAllShowReturnDate
Dieser Parameter definiert, ob bei SIP/2-Anfragen bei der Antwort auf RenewAll, im AG-Feld eine Liste der verlängerten Exemplare des Users mit deren Rückgabedatum zurückgegeben wird. Wird herangezogen bei:
-
SIP2.Command.ItemInformation
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs-System |
RenewAllShowReturnDate |
B |
N |
N: Es werden die ggf. Fehlermeldungen zurückgegeben |
SIPComEncoding
Dieser Parameter definiert das Encoding der SIP2 Kommunikation.
Sektion |
Name |
Typ |
Standardwert |
Beschreibung |
---|---|---|---|---|
Sicherungs- |
SIPComEncoding |
S |
0 |
65001: -> Unicode 1252: -> ANSI 28591: -> 8859-1 0: -> ANSI |