23 Patron status
- Request
- 23
- Response
- 24
- Set
- core
- Position in BX
- 0
This is the first question a device asks about a patron: Does this card exist, is the password right, and may it be used for transactions? Anyone who also needs the list of charged items uses patron information instead – it answers the same questions and more.
Request 23#
23<language><timestamp><AO...><AA...><AC...><AD...><XL...><XP...>
| Field | Length | Required | Content |
|---|---|---|---|
| language | 3 | yes | language of the patron, 000 unknown, 003 German |
| timestamp | 18 | yes | date and time on the device |
| Identifier | Required | Content |
|---|---|---|
AO |
yes | institution identifier |
AA |
yes | patron identifier |
AC |
yes | terminal password |
AD |
no | patron password |
XL |
no | type of patron identifier in AA: BAR, ACC or UID |
XP |
no | PIN of the patron |
The library system returns the language unchanged in its response.
Type of patron identifier#
A card can be named in three ways. XL tells the library system which one the
device has chosen – without it the system would have to guess, and a patron
identifier that happens to be valid as a barcode number would hit the wrong
patron.
| Value | Content of AA |
|---|---|
BAR |
barcode number as per the barcode specification |
ACC |
patron number as held by the library system |
UID |
serial number of the RFID transponder in the card |
If XL is missing, the setting configured in the library system applies.
Password or PIN#
Two fields are available, because two different things are checked: AD takes
the patron's password, the same one they use in the online catalogue. XP takes
a short PIN as entered on a numeric keypad.
If neither is given, the library system only checks whether it knows the card.
Response 24#
24<patron status><language><timestamp><AO...><AA...><AE...><BL...><CQ...>
<BH...><BV...><AF...><AG...>
| Field | Length | Required | Content |
|---|---|---|---|
| patron status | 14 | yes | block reasons, see below |
| language | 3 | yes | language from the request |
| timestamp | 18 | yes | date and time on the library system |
| Identifier | Required | Content |
|---|---|---|
AO |
yes | institution identifier |
AA |
yes | patron identifier |
AE |
yes | name of the patron |
BL |
yes | Y the card is known, N unknown |
CQ |
yes | Y password or PIN is correct, N incorrect |
BH |
no | currency, e.g. EUR; only together with BV |
BV |
no | outstanding fee amount; omitted if nothing is due |
AF |
no | message for the screen |
AG |
no | message for the receipt |
The patron status#
The fourteen positions each name a reason why the patron is restricted. Y means
the reason applies. A space means it does not. Fourteen spaces therefore mean
everything is in order.
| Pos. | Meaning | Pos. | Meaning |
|---|---|---|---|
| 0 | charge privileges denied | 7 | too many renewals |
| 1 | renewal privileges denied | 8 | too many claims of items returned |
| 2 | recall privileges denied | 9 | too many items lost |
| 3 | hold privileges denied | 10 | excessive outstanding fines |
| 4 | card reported lost | 11 | excessive outstanding fees |
| 5 | too many items charged | 12 | recall overdue |
| 6 | too many items overdue | 13 | too many items billed |
An expired card is reported the same way.
Example#
2300320260728 143012AOBVS|AA1140360000042|ACsecret|XLBAR|XP1987|AY2AZED69<CR>
24 00320260728 143012AOBVS|AA1140360000042|AESmith, Jane|BLY|CQY|AF|AG|AY2AZE97C<CR>
The card is known (BL), the PIN is correct (CQ), there is no block (fourteen
spaces) and no fees are due (no BV).