Field overview

For looking things up while reading a log. The dotted notation shows the nesting: customer.masked is the field masked within the object customer.

Frame#

Field	Kind	Meaning
`auth.token`	text	agreed secret when operating over the network
`client.lang`	text	language of the controlling program
`client.name`	text	name of the controlling program
`client.version`	text	its version
`cmd`	text	command
`error.code`	number	error code
`error.name`	text	short name of the error
`error.text`	text	diagnostic message, not intended for display
`id`	number/text	identifier of the request, returned unchanged
`ok`	yes/no	whether the request was carried out
`result`	object	result of the request
`v`	number	version of the protocol

Session#

Field	Kind	Meaning
`counters.borrowed`	number	charged in this session
`counters.holds`	number	reservations in total
`counters.holds_ready`	number	of those, ready for collection
`counters.loans`	number	items on loan in total
`counters.renewed`	number	renewed in this session
`counters.returned`	number	returned in this session
`customer.balance`	amount	account balance; negative means debt
`customer.currency`	text	its currency
`customer.has_debt`	yes/no	there are outstanding charges
`customer.lang`	text	this person's preferred language
`customer.masked`	text	shortened form of address, e.g. initials
`customer.number`	text	patron number
`customer.valid_until`	date	expiry of membership
`dates.due_next`	date	this person's next due date
`dates.next_open`	date	the library's next opening day
`event.from`, `event.to`	point in time	period of an event
`event.note`	text	addition to the event
`event.title`	text	name of the event
`farewell.note`	text	extra line beneath the greeting
`items[].amount`	amount	size of a charge
`items[].author`	text	statement of responsibility
`items[].barcode`	text	identifier of the item
`items[].cover`	text	path or address of the cover image
`items[].due`	date	due date
`items[].kind`	text	`loan`, `return`, `renew`, `hold` or `fee`
`items[].reason`	text	occasion of a charge
`items[].state`	text	with `hold`: `waiting` or `ready`
`items[].title`	text	title of the item
`lang`	text	language the display should use
`notes[].date`	date	date belonging to the notice, if it carries one
`notes[].key`	text	notice key, see below
`notes[].severity`	text	`info`, `warn` or `error`
`notes[].text`	text	ready-made wording instead of a key

Library data#

Field	Kind	Meaning
`closures[].from`, `closures[].to`	date	period of a closure
`closures[].reason`	text	occasion of the closure
`events[].from`, `events[].to`	point in time	period of an event
`events[].note`	text	addition to the event
`events[].title`	text	name of the event
`extras[].date`	date	additional opening day
`extras[].from`, `extras[].to`	time of day	its opening hours
`extras[].reason`	text	occasion of the extra opening
`hours[].day`	number	weekday, `1` Monday to `7` Sunday
`hours[].from`, `hours[].to`	time of day	opening hours on that day
`name`	text	name of the library
`next_open`	date	next opening day as calculated by the display

Display and device#

Field	Kind	Meaning
`caps`	list	areas present on the display
`cover`	text	cover image with `media.show`
`delay`	number	period in seconds before it is carried out
`index`	number	number of a screen
`key`, `value`	text/any	key and value of a setting
`limits.items`	number	maximum number of entries in `items`
`limits.line`	number	largest line length that can be processed, in bytes
`monitor.h`, `monitor.w`	number	resolution of the screen
`ms`	number	duration in milliseconds (`monitor.mark` only)
`note`	text	extra line with `media.show`
`proto`	list	supported protocol versions
`seconds`	number	dwell time in seconds
`session`	yes/no	whether a session is open
`severity`	text	`info`, `warn` or `error`
`slides[].image`	text	path or address of an image
`slides[].seconds`	number	different dwell time for this image
`state`	text	`idle`, `active`, `farewell` or `saver`
`sticky`	yes/no	notice stays until it is removed
`title`, `text`	text	heading and explanation of a notice
`uptime_s`	number	uptime of the display in seconds

Notice keys#

Values for notes[].key. The display forms a sentence from them in the language of the session.

Key	In substance	Extra field
`card_expired`	The card has expired.	`date`
`card_expires`	The card expires shortly.	`date`
`has_debt`	There are outstanding charges.
`holds_ready`	Reserved items are ready for collection.	`count`
`limit_reached`	The maximum number of items has been reached.
`online_delay`	The details online follow with a delay.
`overdue`	Items are overdue.	`count`
`receipt_sent`	The receipt has been sent.	`to` (shortened)

The list is open. An unknown key is ignored; anyone needing one of their own uses x-<manufacturer>.<name> and supplies text with it.

This page was translated automatically from the German original. If anything reads oddly or looks wrong, please let us know — the German edition prevails.