LibraryPatronStatuss
http://www.sifinfo.org/infrastructure/2.x
Documentation
This object reports the current library status for the requested student or staff member.
Tree
Table
Name | Mandatory | Characteristics | Type | Description | XPath |
---|---|---|---|---|---|
@RefId | * | M | RefIdType | 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. | /LibraryPatronStatuss/LibraryPatronStatus/@RefId |
@LibraryType | * | M | string | A library-defined language-independent value that refers to a specific patron type. | /LibraryPatronStatuss/LibraryPatronStatus/@LibraryType |
@SIF_RefId | * | M | IdRefType | The SIF wide unique identifier of a student or teacher. | /LibraryPatronStatuss/LibraryPatronStatus/@SIF_RefId |
@SIF_RefObject | * | M | string | The type of patron mapped to a SIF supported object. Library automation products work with patrons who could be students or teachers. | /LibraryPatronStatuss/LibraryPatronStatus/@SIF_RefObject |
@Type | * | M | string | Electronic Id type. | /LibraryPatronStatuss/LibraryPatronStatus/ElectronicIdList/ElectronicId/@Type |
ElectronicId | * | MR | ElectronicIdType | /LibraryPatronStatuss/LibraryPatronStatus/ElectronicIdList/ElectronicId | |
@Type | * | M | string | Type of item being referenced. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/ItemInfo/@Type |
Title | * | M | string | The title of the item being referenced by this Transaction. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/ItemInfo/Title |
Author | O | string | The author of the item being referenced by this Transaction. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/ItemInfo/Author | |
@Type | * | M | string | Electronic Id type. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/ItemInfo/ElectronicId/@Type |
ElectronicId | O | ElectronicIdType | Electronic identifier associated with this Transaction. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/ItemInfo/ElectronicId | |
CallNumber | O | string | The library call number, if any, assigned to this item. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/ItemInfo/CallNumber | |
@Currency | O | ISO4217CurrencyNamesAndCodeElementsType | Currency code. Where omitted, defaults to implementation-defined local currency, typically | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/ItemInfo/Price/@Currency | |
Price | O | MonetaryAmountType | The cost of this item. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/ItemInfo/Price | |
ReturnBy | * | M | dateTime | The date and time that this item is due to be returned. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/CheckoutInfo/ReturnBy |
@Type | * | M | string | 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. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/FineInfoList/FineInfo/@Type |
Assessed | * | M | dateTime | The date and time that this fine was assessed to the patron. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/FineInfoList/FineInfo/Assessed |
Description | O | string | More detailed information concerning the assessed fine or refund. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/FineInfoList/FineInfo/Description | |
@Currency | O | ISO4217CurrencyNamesAndCodeElementsType | Currency code. Where omitted, defaults to implementation-defined local currency, typically | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/FineInfoList/FineInfo/Amount/@Currency | |
Amount | * | M | MonetaryAmountType | The current balance of the fine expressed as a positive number. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/FineInfoList/FineInfo/Amount |
Reference | O | string | 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. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/FineInfoList/FineInfo/Reference | |
@Type | * | M | string | The type of hold being referenced. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/HoldInfoList/HoldInfo/@Type |
DatePlaced | * | M | date | The date that the patron placed the hold. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/HoldInfoList/HoldInfo/DatePlaced |
DateNeeded | O | date | The date that the patron needs this item by. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/HoldInfoList/HoldInfo/DateNeeded | |
MadeAvailable | O | date | The date that this item became available for the patron to pick up. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/HoldInfoList/HoldInfo/MadeAvailable | |
Expires | O | date | The date when this ready hold will expire freeing the item to be assigned to another patron. | /LibraryPatronStatuss/LibraryPatronStatus/TransactionList/Transaction/HoldInfoList/HoldInfo/Expires | |
@Priority | * | M | string | The level of urgency associated with this message. | /LibraryPatronStatuss/LibraryPatronStatus/MessageList/Message/@Priority |
Sent | O | dateTime | The date and time that this message was originally sent. | /LibraryPatronStatuss/LibraryPatronStatus/MessageList/Message/Sent | |
Text | * | M | string | The contents of the message. | /LibraryPatronStatuss/LibraryPatronStatus/MessageList/Message/Text |
NumberOfCheckouts | * | M | unsignedInt | The total number of items that this patron currently has checked out including overdue items. | /LibraryPatronStatuss/LibraryPatronStatus/NumberOfCheckouts |
NumberOfOverdues | * | M | unsignedInt | The total number of checkouts that are currently overdue. | /LibraryPatronStatuss/LibraryPatronStatus/NumberOfOverdues |
NumberOfFines | * | M | unsignedInt | The total number of fines currently assessed to this patron. | /LibraryPatronStatuss/LibraryPatronStatus/NumberOfFines |
@Currency | O | ISO4217CurrencyNamesAndCodeElementsType | Currency code. Where omitted, defaults to implementation-defined local currency, typically | /LibraryPatronStatuss/LibraryPatronStatus/FineAmount/@Currency | |
FineAmount | * | M | MonetaryAmountType | The total monetary amount of the fines that this patron currently owes the library expressed as a positive number. | /LibraryPatronStatuss/LibraryPatronStatus/FineAmount |
NumberOfRefunds | O | unsignedInt | The total number of refunds currently credited to this patron. | /LibraryPatronStatuss/LibraryPatronStatus/NumberOfRefunds | |
@Currency | O | ISO4217CurrencyNamesAndCodeElementsType | Currency code. Where omitted, defaults to implementation-defined local currency, typically | /LibraryPatronStatuss/LibraryPatronStatus/RefundAmount/@Currency | |
RefundAmount | O | MonetaryAmountType | The total monetary amount of the refunds that the library currently owes the patron expressed as a positive number. | /LibraryPatronStatuss/LibraryPatronStatus/RefundAmount | |
Type | * | M | normalizedString | This element is designed to contain the time period attached to an object.Very long periods (school year, quarter, etc.) and very small periods (second, millisecond, etc.) can be defined.This element provides a scoping description of the time metadata enclosed. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/TimeElements/TimeElement/Type |
Code | * | M | token | This element provides a place for the application to send structured data (code values, unique identifier, timestamps).This code value can, depending upon the use case agreement between agents, be used to qualify the data in the | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/TimeElements/TimeElement/Code |
Name | * | M | normalizedString | Contains a human-readable description of the value in | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/TimeElements/TimeElement/Name |
Value | * | M | normalizedString | Contains the human-readable value. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/TimeElements/TimeElement/Value |
StartDateTime | O | dateTime | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/TimeElements/TimeElement/StartDateTime | ||
EndDateTime | O | dateTime | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/TimeElements/TimeElement/EndDateTime | ||
Type | * | M | normalizedString | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/TimeElements/TimeElement/SpanGaps/SpanGap/Type | |
Code | * | M | token | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/TimeElements/TimeElement/SpanGaps/SpanGap/Code | |
Name | * | M | normalizedString | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/TimeElements/TimeElement/SpanGaps/SpanGap/Name | |
Value | * | M | normalizedString | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/TimeElements/TimeElement/SpanGaps/SpanGap/Value | |
StartDateTime | O | dateTime | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/TimeElements/TimeElement/SpanGaps/SpanGap/StartDateTime | ||
EndDateTime | O | dateTime | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/TimeElements/TimeElement/SpanGaps/SpanGap/EndDateTime | ||
IsCurrent | * | M | boolean | This element allows for the system to tag an object as being explicitly current.Although the baseline assumption in SIF is that objects are always current (default value is typically | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/TimeElements/TimeElement/IsCurrent |
DateTime | * | M | dateTime | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/Created/DateTime | |
Name | * | M | normalizedString | Human-readable name of the data's creator. If the object contains system-generated data,the name should identify the creating service or application. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/Created/Creators/Creator/Name |
ID | * | M | normalizedString | Unique identifier of the creator. An email address or URI could be used here. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/Created/Creators/Creator/ID |
By | * | M | normalizedString | Identifier of the system or person that modified the data. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/ModificationHistory/Modified/By |
DateTime | * | M | dateTime | The date/time the modification occurred. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/ModificationHistory/Modified/DateTime |
Description | O | string | Human readable description of the data modifications. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/ModificationHistory/Modified/Description | |
Type | * | M | normalizedString | This element is designed to contain the time period attached to an object.Very long periods (school year, quarter, etc.) and very small periods (second, millisecond, etc.) can be defined.This element provides a scoping description of the time metadata enclosed. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/TimeElements/TimeElement/Type |
Code | * | M | token | This element provides a place for the application to send structured data (code values, unique identifier, timestamps).This code value can, depending upon the use case agreement between agents, be used to qualify the data in the | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/TimeElements/TimeElement/Code |
Name | * | M | normalizedString | Contains a human-readable description of the value in | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/TimeElements/TimeElement/Name |
Value | * | M | normalizedString | Contains the human-readable value. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/TimeElements/TimeElement/Value |
StartDateTime | O | dateTime | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/TimeElements/TimeElement/StartDateTime | ||
EndDateTime | O | dateTime | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/TimeElements/TimeElement/EndDateTime | ||
Type | * | M | normalizedString | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/TimeElements/TimeElement/SpanGaps/SpanGap/Type | |
Code | * | M | token | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/TimeElements/TimeElement/SpanGaps/SpanGap/Code | |
Name | * | M | normalizedString | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/TimeElements/TimeElement/SpanGaps/SpanGap/Name | |
Value | * | M | normalizedString | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/TimeElements/TimeElement/SpanGaps/SpanGap/Value | |
StartDateTime | O | dateTime | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/TimeElements/TimeElement/SpanGaps/SpanGap/StartDateTime | ||
EndDateTime | O | dateTime | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/TimeElements/TimeElement/SpanGaps/SpanGap/EndDateTime | ||
IsCurrent | * | M | boolean | This element allows for the system to tag an object as being explicitly current.Although the baseline assumption in SIF is that objects are always current (default value is typically | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/LifeCycle/TimeElements/TimeElement/IsCurrent |
Cost | O | boolean | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/RightsElements/RightsElement/Cost | ||
UseType | * | M | string | A description of the fee structure for this resource.Some resources may be licensed differently depending upon their context.For example, a content provider might charge one fee structure for resources used in the classroom and a separate fee for thoseresources available to parents from home. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/RightsElements/RightsElement/FeesForUse/FeeForUse/UseType |
MeteringType | * | M | token | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/RightsElements/RightsElement/FeesForUse/FeeForUse/MeteringType | |
MeteringURL | O | anyURI | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/RightsElements/RightsElement/FeesForUse/FeeForUse/MeteringURL | ||
@Currency | O | ISO4217CurrencyNamesAndCodeElementsType | Currency code. Where omitted, defaults to implementation-defined local currency, typically | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/RightsElements/RightsElement/FeesForUse/FeeForUse/PerUseCharge/@Currency | |
PerUseCharge | O | MonetaryAmountType | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/RightsElements/RightsElement/FeesForUse/FeeForUse/PerUseCharge | ||
CopyrightStatement | O | string | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/RightsElements/RightsElement/CopyrightStatement | ||
TermsOfUse | O | string | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/RightsElements/RightsElement/TermsOfUse | ||
MediaType | * | MR | token | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/MediaTypes/MediaType | |
Code | * | M | string | Code representing the grade level. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/GradeLevels/GradeLevel/Code |
@Codeset | * | M | string | Describes the OtherCode element content as either a state/province code, a local code, other code, or text string. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/GradeLevels/GradeLevel/OtherCodeList/OtherCode/@Codeset |
OtherCode | * | MR | string | A state/province code, local code, other code or a text string that crosswalks to or serves as a translation of an associated Code element. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/GradeLevels/GradeLevel/OtherCodeList/OtherCode |
Code | * | M | string | The subject area code (i.e., the first two digits of the course classification code). | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/SubjectAreas/SubjectArea/Code |
@Codeset | * | M | string | Describes the OtherCode element content as either a state/province code, a local code, other code, or text string. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/SubjectAreas/SubjectArea/OtherCodeList/OtherCode/@Codeset |
OtherCode | * | MR | string | A state/province code, local code, other code or a text string that crosswalks to or serves as a translation of an associated Code element. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/SubjectAreas/SubjectArea/OtherCodeList/OtherCode |
Code | * | M | string | Code representing the grade level. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/InterestLevels/InterestLevel/Code |
@Codeset | * | M | string | Describes the OtherCode element content as either a state/province code, a local code, other code, or text string. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/InterestLevels/InterestLevel/OtherCodeList/OtherCode/@Codeset |
OtherCode | * | MR | string | A state/province code, local code, other code or a text string that crosswalks to or serves as a translation of an associated Code element. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/InterestLevels/InterestLevel/OtherCodeList/OtherCode |
LearningStandardItemRefId | * | MR | IdRefType | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/LearningStandardItems/LearningStandardItemRefId | |
BloomsTaxonomyLevel | OR | string | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/BloomsTaxonomyLevels/BloomsTaxonomyLevel | ||
MultipleIntelligence | OR | string | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/MultipleIntelligences/MultipleIntelligence | ||
InstructionalStrategy | OR | string | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/InstructionalStrategies/InstructionalStrategy | ||
Title | O | normalizedString | The title of the content. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/Title | |
Summary | O | string | A summary of the content. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/Summary | |
LearningObjective | * | MR | string | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/LearningObjectives/LearningObjective | |
ResourceType | * | MR | string | /LibraryPatronStatuss/LibraryPatronStatus/SIF_Metadata/EducationFilter/ResourceTypes/ResourceType | |
@Name | * | M | normalizedString | The name of the extended element. As it is possible that names for extended elements may collide from agent to agent, it is recommended that the names of extended elements be configurable in an agent, or that agents use URIs for the names of extended elements. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_ExtendedElements/SIF_ExtendedElement/@Name |
@SIF_Action | O | string | In a Change event, this flag can be used to indicate an element has been deleted from the parent list container. At a minimum the key for the list must also be present. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_ExtendedElements/SIF_ExtendedElement/@SIF_Action | |
SIF_ExtendedElement | OR | SIF_ExtendedElementType | A name/value pair, the name being contained in the Name attribute, the value being the element content. | /LibraryPatronStatuss/LibraryPatronStatus/SIF_ExtendedElements/SIF_ExtendedElement |
Download: .xlsx (with Formats)
Structure
Download: .xml