Feldübersicht

Zum Nachschlagen beim Lesen eines Mitschnitts. Die Schreibweise mit Punkt gibt die Schachtelung wieder: customer.masked ist das Feld masked innerhalb des Objekts customer.

Rahmen#

Feld	Art	Bedeutung
`auth.token`	Text	vereinbartes Geheimnis bei Betrieb über das Netz
`client.lang`	Text	Sprache des Steuerprogramms
`client.name`	Text	Name des Steuerprogramms
`client.version`	Text	dessen Fassung
`cmd`	Text	Kommando
`error.code`	Zahl	Fehlerkennung
`error.name`	Text	Kurzname des Fehlers
`error.text`	Text	Diagnosemeldung, nicht zur Anzeige bestimmt
`id`	Zahl/Text	Kennung des Auftrags, kommt unverändert zurück
`ok`	Ja/Nein	ob der Auftrag ausgeführt wurde
`result`	Objekt	Ergebnis des Auftrags
`v`	Zahl	Fassung des Protokolls

Sitzung#

Feld	Art	Bedeutung
`counters.borrowed`	Zahl	in dieser Sitzung ausgeliehen
`counters.holds`	Zahl	Vorbestellungen insgesamt
`counters.holds_ready`	Zahl	davon abholbereit
`counters.loans`	Zahl	ausgeliehene Medien insgesamt
`counters.renewed`	Zahl	in dieser Sitzung verlängert
`counters.returned`	Zahl	in dieser Sitzung zurückgegeben
`customer.balance`	Betrag	Kontostand; negativ bedeutet Schulden
`customer.currency`	Text	Währung dazu
`customer.has_debt`	Ja/Nein	es bestehen offene Forderungen
`customer.lang`	Text	Sprachwunsch dieser Person
`customer.masked`	Text	verkürzte Anrede, etwa Initialen
`customer.number`	Text	Lesernummer
`customer.valid_until`	Datum	Ablauf der Mitgliedschaft
`dates.due_next`	Datum	nächster Rückgabetermin dieser Person
`dates.next_open`	Datum	nächster Öffnungstag der Bücherei
`event.from`, `event.to`	Zeitpunkt	Zeitraum einer Veranstaltung
`event.note`	Text	Zusatz zur Veranstaltung
`event.title`	Text	Bezeichnung der Veranstaltung
`farewell.note`	Text	Zusatzzeile unter dem Gruß
`items[].amount`	Betrag	Höhe einer Gebühr
`items[].author`	Text	Verfasserangabe
`items[].barcode`	Text	Kennung des Mediums
`items[].cover`	Text	Pfad oder Adresse des Titelbildes
`items[].due`	Datum	Rückgabetermin
`items[].kind`	Text	`loan`, `return`, `renew`, `hold` oder `fee`
`items[].reason`	Text	Anlass einer Gebühr
`items[].state`	Text	bei `hold`: `waiting` oder `ready`
`items[].title`	Text	Titel des Mediums
`lang`	Text	Sprache, in der die Anzeige formulieren soll
`notes[].date`	Datum	Datum zum Hinweis, sofern er eines trägt
`notes[].key`	Text	Hinweisschlüssel, siehe unten
`notes[].severity`	Text	`info`, `warn` oder `error`
`notes[].text`	Text	fertiger Wortlaut statt eines Schlüssels

Büchereidaten#

Feld	Art	Bedeutung
`closures[].from`, `closures[].to`	Datum	Zeitraum einer Schließung
`closures[].reason`	Text	Anlass der Schließung
`events[].from`, `events[].to`	Zeitpunkt	Zeitraum einer Veranstaltung
`events[].note`	Text	Zusatz zur Veranstaltung
`events[].title`	Text	Bezeichnung der Veranstaltung
`extras[].date`	Datum	zusätzlicher Öffnungstag
`extras[].from`, `extras[].to`	Uhrzeit	dessen Öffnungszeit
`extras[].reason`	Text	Anlass der Zusatzöffnung
`hours[].day`	Zahl	Wochentag, `1` Montag bis `7` Sonntag
`hours[].from`, `hours[].to`	Uhrzeit	Öffnungszeit an diesem Tag
`name`	Text	Name der Bücherei
`next_open`	Datum	von der Anzeige errechneter nächster Öffnungstag

Anzeige und Gerät#

Feld	Art	Bedeutung
`caps`	Liste	vorhandene Bereiche der Anzeige
`cover`	Text	Titelbild bei `media.show`
`delay`	Zahl	Frist in Sekunden bis zur Ausführung
`index`	Zahl	Nummer eines Bildschirms
`key`, `value`	Text/beliebig	Schlüssel und Wert einer Einstellung
`limits.items`	Zahl	Höchstzahl der Einträge in `items`
`limits.line`	Zahl	größte verarbeitbare Zeilenlänge in Byte
`monitor.h`, `monitor.w`	Zahl	Auflösung des Bildschirms
`ms`	Zahl	Dauer in Millisekunden (nur `monitor.mark`)
`note`	Text	Zusatzzeile bei `media.show`
`proto`	Liste	unterstützte Protokollfassungen
`seconds`	Zahl	Standzeit in Sekunden
`session`	Ja/Nein	ob eine Sitzung offen ist
`severity`	Text	`info`, `warn` oder `error`
`slides[].image`	Text	Pfad oder Adresse eines Bildes
`slides[].seconds`	Zahl	abweichende Standzeit dieses Bildes
`state`	Text	`idle`, `active`, `farewell` oder `saver`
`sticky`	Ja/Nein	Hinweis bleibt stehen, bis er entfernt wird
`title`, `text`	Text	Überschrift und Erläuterung eines Hinweises
`uptime_s`	Zahl	Laufzeit der Anzeige in Sekunden

Hinweisschlüssel#

Werte für notes[].key. Die Anzeige formuliert daraus einen Satz in der Sprache der Sitzung.

Schlüssel	Sinngemäß	Zusatzfeld
`card_expired`	Der Ausweis ist abgelaufen.	`date`
`card_expires`	Der Ausweis läuft demnächst ab.	`date`
`has_debt`	Es sind Gebühren offen.
`holds_ready`	Vorbestellte Medien liegen bereit.	`count`
`limit_reached`	Die Höchstzahl entleihbarer Medien ist erreicht.
`online_delay`	Die Angaben im Netz folgen zeitversetzt.
`overdue`	Es sind Medien überfällig.	`count`
`receipt_sent`	Die Quittung wurde versandt.	`to` (gekürzt)

Die Liste ist offen. Ein unbekannter Schlüssel wird übergangen; wer einen eigenen braucht, verwendet x-<hersteller>.<name> und liefert text mit.