3.12 Library Automation Working Group

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

3.12.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 3.12.1-1: LibraryPatronStatus LibraryPatronStatus RefId LibraryType SIF_RefId SIF_RefObject SIF_RefObjectCodeset ElectronicIdList TransactionList MessageList NumberOfCheckouts NumberOfOverdues NumberOfFines FineAmount NumberOfRefunds RefundAmount SIF_Metadata SIF_ExtendedElements
 Element/@AttributeCharCEDS Id/URLDescriptionType
 LibraryPatronStatus 

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

 
 
@RefIdM

A GUID that identifies an instance of this object. This RefId is a “transient” value; that is, it SHOULD be generated by the provider at the time the object is provided in a Response message. This value MUST NOT be used in a later Request for the object.

 
RefIdType
@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.

 
xs:token
@SIF_RefObjectCodesetO

A unique indicator (usually a URL) that points to the codeset used.

 
xs:token
 ElectronicIdListM

List of electronic identifiers associated with the patron.

 
ElectronicIdListType
 TransactionListO

List of transactions.

 
LibraryTransactionListType
 MessageListO

List of messages for/regarding the patron.

 
LibraryMessageListType
 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_MetadataType
 SIF_ExtendedElementsO
 SIF_ExtendedElementsType
Table 3.12.1-1: LibraryPatronStatus
{ "LibraryPatronStatus": { "RefId": "359D75101AD0A9D7A8C3DAD0A85103A2", "LibraryType": "S", "SIF_RefId": "52DBFBFC021311D68E8C00039303AE9C", "SIF_RefObject": "StudentPersonal", "ElectronicIdList": { "ElectronicId": [ { "Type": "Barcode", "value": "P 7676" }, { "Type": "Magstripe", "value": "200606300007676JJI" }, { "Type": "PIN", "value": "1234" }, { "Type": "RFID", "value": "0EF3098055921FEDC008FEEB" } ] }, "TransactionList": { "Transaction": [ { "ItemInfo": { "Type": "LibraryMaterial", "Title": "Redwall", "Author": "Brian Jacques", "ElectronicId": { "Type": "Barcode", "value": "T 311" }, "CallNumber": "YA JACQ", "Price": { "Currency": "USD", "value": 6.99 } }, "CheckoutInfo": { "ReturnBy": "2006-01-04T20:59:59-08:00" }, "FineInfoList": { "FineInfo": [ { "Type": "Overdue", "Assessed": "2006-01-06T10:19:00-08:00", "Description": "ESTIMATED FINE FOR OVERDUE ITEM", "Amount": { "Currency": "USD", "value": 0.5 } } ] } }, { "ItemInfo": { "Type": "LibraryMaterial", "Title": "Mossflower", "Author": "Brian Jacques", "ElectronicId": { "Type": "Barcode", "value": "T 1211" }, "CallNumber": "YA JACQ", "Price": { "Currency": "USD", "value": 7.49 } }, "HoldInfoList": { "HoldInfo": [ { "Type": "Ready", "DatePlaced": "2005-12-18", "DateNeeded": "2006-01-16", "MadeAvailable": "2006-01-05", "Expires": "2006-02-01" } ] } }, { "ItemInfo": { "Type": "LibraryMaterial", "Title": "The Bellmaker", "Author": "Brian Jacques" }, "HoldInfoList": { "HoldInfo": [ { "Type": "NotReady", "DatePlaced": "2005-12-18" } ] } }, { "ItemInfo": { "Type": "Textbook", "Title": "Passport to Algebra and Geometry", "Author": "Larson, Boswell, Kanold and Stiff", "ElectronicId": { "Type": "Barcode", "value": "98770000178215" }, "Price": { "Currency": "USD", "value": 57.18 } }, "CheckoutInfo": { "ReturnBy": "2006-06-15T21:59:59-07:00" } }, { "ItemInfo": { "Type": "LibraryMaterial", "Title": "Harry Potter and the Goblet of Fire", "Author": "JK Rowlings", "ElectronicId": { "Type": "Barcode", "value": "T 99321" } }, "FineInfoList": { "FineInfo": [ { "Type": "Refund", "Assessed": "2006-01-02T06:29:00-08:00", "Description": "Lost item returned", "Amount": { "Currency": "USD", "value": 28.9 } } ] } }, { "FineInfoList": { "FineInfo": [ { "Type": "Other", "Assessed": "2006-01-04T07:14:00-08:00", "Description": "Running in library", "Amount": { "Currency": "USD", "value": 1.0 }, "Reference": "42" } ] } } ] }, "MessageList": { "Message": [ { "Priority": "Normal", "Text": "This is a normal message." }, { "Priority": "Urgent", "Sent": "2006-01-12T11:01:00-08:00", "Text": "This is an URGENT message!" } ] }, "NumberOfCheckouts": 1, "NumberOfOverdues": 1, "NumberOfFines": 1, "FineAmount": { "Currency": "USD", "value": 1.0 }, "NumberOfRefunds": 1, "RefundAmount": { "Currency": "USD", "value": 28.9 } } }
<LibraryPatronStatus RefId="359D75101AD0A9D7A8C3DAD0A85103A2" 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 3.12.1-1: LibraryPatronStatus

Valid XHTML 1.0 Transitional