6.11.1 LibraryPatronStatus
This object reports the current library status for the requested student or staff member.
The minimum data that the object will return will be the patron's ElectronicId,
the total number of materials that are checked out and overdue,
and the number and amount of any fines that have been assessed to the patron.
When a patron has materials that have been checked out, requested, or are overdue, the object will contain a Transaction element
describing the details of the transaction. Likewise, any fines that have an outstanding balance will also have a Transaction element for the fine.
When a checked out item is returned to the library, it will not appear in the object, even if the item was overdue. Fines that have an outstanding balance will be reported, but when the fine is paid, it will not appear in the object.
SIF_Events are not reported for this object.
Click here for non-normative background/supplementary documentation on this object.
| Element/@Attribute | Char | Description | Type | |
|---|---|---|---|---|
| LibraryPatronStatus | This object reports the current library status for the requested student or staff member. | |||
| @ | LibraryType | M | A library-defined language-independent value that refers to a specific patron type. | xs:string |
@ | SIF_RefId | M | The SIF wide unique identifier of a student or teacher. | IdRefType |
| @ | SIF_RefObject | M | The type of patron mapped to a SIF supported object. Library automation products work with patrons who could be students or teachers. | values:
|
| ElectronicIdList | M | List of electronic identifiers associated with the patron. | ElectronicIdList | |
| TransactionList | O | List of transactions. | List | |
| TransactionList/Transaction | OR | Contains information about library transactions for the referenced student. These include items that are checked out or have fines or holds placed on them. | ||
| TransactionList/Transaction/ ItemInfo | O |
If this transaction has an item associated with it, this element contains the information about the item. Most | ||
| @ | Type | M | Type of item being referenced. | values:
|
| TransactionList/Transaction/ ItemInfo/Title | M |
The title of the item being referenced by this | xs:string | |
| TransactionList/Transaction/ ItemInfo/Author | O |
The author of the item being referenced by this | xs:string | |
| TransactionList/Transaction/ ItemInfo/ElectronicId | O |
Electronic identifier associated with this
This element will not appear if the | ElectronicId | |
| TransactionList/Transaction/ ItemInfo/CallNumber | O | The library call number, if any, assigned to this item. | xs:string | |
| TransactionList/Transaction/ ItemInfo/Price | O | The cost of this item. | MonetaryAmountType | |
| TransactionList/Transaction/ CheckoutInfo | O | If the item is currently checked out to this person, this element contains the date and time that the item is due to be returned. | ||
| TransactionList/Transaction/ CheckoutInfo/ReturnBy | M | The date and time that this item is due to be returned. | xs:dateTime | |
| TransactionList/Transaction/ FineInfoList | O | List of fines assessed. | List | |
| TransactionList/Transaction/ FineInfoList/FineInfo | OR | If the item has a fine assessed to this person, this element will contain the information about the fine. | ||
| @ | Type | M | Type of fine assessed to this patron and item. A corresponding ItemInfo is required for all FineInfo types except "Other" and "Refund" where it is permissible to omit the ItemInfo element if there isn't an item associated with the fine. | values:
|
| TransactionList/Transaction/ FineInfoList/FineInfo/Assessed | M | The date and time that this fine was assessed to the patron. | xs:dateTime | |
| TransactionList/Transaction/ FineInfoList/FineInfo/Description | O | More detailed information concerning the assessed fine or refund. | xs:string | |
| TransactionList/Transaction/ FineInfoList/FineInfo/Amount | M | The current balance of the fine expressed as a positive number. | MonetaryAmountType | |
| TransactionList/Transaction/ FineInfoList/FineInfo/Reference | O | An application-specific reference identifier for the fine being assessed, paid, or refunded. It is intended to identify a specific fine transaction allowing consumers to include this information in Billing or Payment events sent to the library application. | xs:string | |
| TransactionList/Transaction/ HoldInfoList | O | List of holds placed. | List | |
| TransactionList/Transaction/ HoldInfoList/HoldInfo | OR | If the item has a hold placed on it by a patron, this element will contain the information about the hold. | ||
| @ | Type | M | The type of hold being referenced. | values:
|
| TransactionList/Transaction/ HoldInfoList/HoldInfo/DatePlaced | M | The date that the patron placed the hold. | xs:date | |
| TransactionList/Transaction/ HoldInfoList/HoldInfo/DateNeeded | O | The date that the patron needs this item by. | xs:date | |
| TransactionList/Transaction/ HoldInfoList/HoldInfo/MadeAvailable | O | The date that this item became available for the patron to pick up. | xs:date | |
| TransactionList/Transaction/ HoldInfoList/HoldInfo/Expires | O | The date when this ready hold will expire freeing the item to be assigned to another patron. | xs:date | |
| MessageList | O | List of messages for/regarding the patron. | List | |
| MessageList/Message | OR | |||
| @ | Priority | M | The level of urgency associated with this message. | values:
|
| MessageList/Message/Sent | O | The date and time that this message was originally sent. | xs:dateTime | |
| MessageList/Message/Text | M | The contents of the message. | xs:string | |
| NumberOfCheckouts | M | The total number of items that this patron currently has checked out including overdue items. | xs:unsignedInt | |
| NumberOfOverdues | M | The total number of checkouts that are currently overdue. | xs:unsignedInt | |
| NumberOfFines | M | The total number of fines currently assessed to this patron. | xs:unsignedInt | |
| FineAmount | M | The total monetary amount of the fines that this patron currently owes the library expressed as a positive number. | MonetaryAmountType | |
| NumberOfRefunds | O | The total number of refunds currently credited to this patron. | xs:unsignedInt | |
| RefundAmount | O | The total monetary amount of the refunds that the library currently owes the patron expressed as a positive number. | MonetaryAmountType | |
| SIF_Metadata | O | SIF_Metadata | ||
| SIF_ExtendedElements | O | SIF_ExtendedElements |