6.11 Library Automation Working Group

The Library Automation Working Group provides the library automation entities necessary to effectively exchange relevant data via the framework.

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.

LibraryPatronStatus
Figure 6.11.1-1: LibraryPatronStatus LibraryPatronStatus LibraryType SIF_RefId SIF_RefObject ElectronicIdList TransactionList Transaction ItemInfo Type Title Author ElectronicId CallNumber Price CheckoutInfo ReturnBy FineInfoList FineInfo Type Assessed Description Amount Reference HoldInfoList HoldInfo Type DatePlaced DateNeeded MadeAvailable Expires MessageList Message Priority Sent Text NumberOfCheckouts NumberOfOverdues NumberOfFines FineAmount NumberOfRefunds RefundAmount SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharDescriptionType
 LibraryPatronStatus 

This object reports the current library status for the requested student or staff member.

 
 
@LibraryTypeM

A library-defined language-independent value that refers to a specific patron type.

 
xs:string
@
key
SIF_RefIdM

The SIF wide unique identifier of a student or teacher.

 
IdRefType
@
key
SIF_RefObjectM

The type of patron mapped to a SIF supported object. Library automation products work with patrons who could be students or teachers.

 
values:
StudentPersonal
StaffPersonal
 ElectronicIdListM

List of electronic identifiers associated with the patron.

 
ElectronicIdList
 TransactionListO

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 Transaction elements will contain this element. However, certain types of fines assessed to the student like "talking in class", "running in library", etc. do not have a corresponding item so that Transaction instance would not contain an ItemInfo.

 
 
@TypeM

Type of item being referenced.

 
values:
Asset
LibraryMaterial
Media
Textbook
 TransactionList/Transaction/
     ItemInfo/Title
M

The title of the item being referenced by this Transaction.

 
xs:string
 TransactionList/Transaction/
     ItemInfo/Author
O

The author of the item being referenced by this Transaction.

 
xs:string
 TransactionList/Transaction/
     ItemInfo/ElectronicId
O

Electronic identifier associated with this Transaction.

This element will not appear if the Transaction contains a HoldInfo for an item where a specific instance of the item hasn't been assigned to fulfill the hold request (i.e. unfulfilled title hold request).

 
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.

 
 
@TypeM

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:
Damaged
Lost
Overdue
Refund
Other
 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.

 
 
@TypeM

The type of hold being referenced.

 
values:
Ready
(which means that a previously placed hold is ready for the patron to pick up at the library desk)
NotReady
(hold has been placed but hasn't been fulfilled yet)
 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
 MessageListO

List of messages for/regarding the patron.

 
List
 MessageList/MessageOR  
@PriorityM

The level of urgency associated with this message.

 
values:
Low
Normal
Urgent
 MessageList/Message/SentO

The date and time that this message was originally sent.

 
xs:dateTime
 MessageList/Message/TextM

The contents of the message.

 
xs:string
 NumberOfCheckoutsM

The total number of items that this patron currently has checked out including overdue items.

 
xs:unsignedInt
 NumberOfOverduesM

The total number of checkouts that are currently overdue.

 
xs:unsignedInt
 NumberOfFinesM

The total number of fines currently assessed to this patron.

 
xs:unsignedInt
 FineAmountM

The total monetary amount of the fines that this patron currently owes the library expressed as a positive number.

 
MonetaryAmountType
 NumberOfRefundsO

The total number of refunds currently credited to this patron.

 
xs:unsignedInt
 RefundAmountO

The total monetary amount of the refunds that the library currently owes the patron expressed as a positive number.

 
MonetaryAmountType
 SIF_MetadataO SIF_Metadata
 SIF_ExtendedElementsO SIF_ExtendedElements
Table 6.11.1-1: LibraryPatronStatus
<LibraryPatronStatus LibraryType="S" SIF_RefId="52DBFBFC021311D68E8C00039303AE9C" SIF_RefObject="StudentPersonal"> <ElectronicIdList> <ElectronicId Type="Barcode">P 7676</ElectronicId> <ElectronicId Type="Magstripe">200606300007676JJI</ElectronicId> <ElectronicId Type="PIN">1234</ElectronicId> <ElectronicId Type="RFID">0EF3098055921FEDC008FEEB</ElectronicId> </ElectronicIdList> <TransactionList> <Transaction> <ItemInfo Type="LibraryMaterial"> <Title>Redwall</Title> <Author>Brian Jacques</Author> <ElectronicId Type="Barcode">T 311</ElectronicId> <CallNumber>YA JACQ</CallNumber> <Price Currency="USD">6.99</Price> </ItemInfo> <CheckoutInfo> <ReturnBy>2006-01-04T23:59:59-05:00</ReturnBy> </CheckoutInfo> <FineInfoList> <FineInfo Type="Overdue"> <Assessed>2006-01-06T13:19:00-05:00</Assessed> <Description>ESTIMATED FINE FOR OVERDUE ITEM</Description> <Amount Currency="USD">0.50</Amount> </FineInfo> </FineInfoList> </Transaction> <Transaction> <ItemInfo Type="LibraryMaterial"> <Title>Mossflower</Title> <Author>Brian Jacques</Author> <ElectronicId Type="Barcode">T 1211</ElectronicId> <CallNumber>YA JACQ</CallNumber> <Price Currency="USD">7.49</Price> </ItemInfo> <HoldInfoList> <HoldInfo Type="Ready"> <DatePlaced>2005-12-18</DatePlaced> <DateNeeded>2006-01-16</DateNeeded> <MadeAvailable>2006-01-05</MadeAvailable> <Expires>2006-02-01</Expires> </HoldInfo> </HoldInfoList> </Transaction> <Transaction> <ItemInfo Type="LibraryMaterial"> <Title>The Bellmaker</Title> <Author>Brian Jacques</Author> </ItemInfo> <HoldInfoList> <HoldInfo Type="NotReady"> <DatePlaced>2005-12-18</DatePlaced> </HoldInfo> </HoldInfoList> </Transaction> <Transaction> <ItemInfo Type="Textbook"> <Title>Passport to Algebra and Geometry</Title> <Author>Larson, Boswell, Kanold and Stiff</Author> <ElectronicId Type="Barcode">98770000178215</ElectronicId> <Price Currency="USD">57.18</Price> </ItemInfo> <CheckoutInfo> <ReturnBy>2006-06-15T23:59:59-05:00</ReturnBy> </CheckoutInfo> </Transaction> <Transaction> <ItemInfo Type="LibraryMaterial"> <Title>Harry Potter and the Goblet of Fire</Title> <Author>JK Rowlings</Author> <ElectronicId Type="Barcode">T 99321</ElectronicId> </ItemInfo> <FineInfoList> <FineInfo Type="Refund"> <Assessed>2006-01-02T09:29:00-05:00</Assessed> <Description>Lost item returned</Description> <Amount Currency="USD">28.90</Amount> </FineInfo> </FineInfoList> </Transaction> <Transaction> <FineInfoList> <FineInfo Type="Other"> <Assessed>2006-01-04T10:14:00-05:00</Assessed> <Description>Running in library</Description> <Amount Currency="USD">1.00</Amount> <Reference>42</Reference> </FineInfo> </FineInfoList> </Transaction> </TransactionList> <MessageList> <Message Priority="Normal"> <Text>This is a normal message.</Text> </Message> <Message Priority="Urgent"> <Sent>2006-01-12T14:01:00-05:00</Sent> <Text>This is an URGENT message!</Text> </Message> </MessageList> <NumberOfCheckouts>1</NumberOfCheckouts> <NumberOfOverdues>1</NumberOfOverdues> <NumberOfFines>1</NumberOfFines> <FineAmount Currency="USD">1.00</FineAmount> <NumberOfRefunds>1</NumberOfRefunds> <RefundAmount Currency="USD">28.90</RefundAmount> </LibraryPatronStatus>
Example 6.11.1-1: LibraryPatronStatus

Valid XHTML 1.0 Transitional