Ready to Learn?Ex Libris products all provide open APIs

Overview

Data Dictionary

Click here to download external_sys_user.xsd
userRecords
Description: List of external users to import from SIS
FieldTypeDescription
userRecorduserRecord
userRecord
Description: Specific external user to import.
FieldTypeDescription
matchIdstring Currently not in use.
userDetailsuserDetails General user details
owneredEntityowneredEntityInformation about the creator/modifier and the change date. If not supplied, creator/modifier will be set to EX_LIBRIS.
Creation/modification date will be set to the current date.
userNoteListuserNoteList List of user's external notes.
userBlockListuserBlockListList of user's external blocks. Not relevant for contact users.
userFineFeesListuserFineFeesList Currently not in use.
userIdentifiersuserIdentifiersListList of user's external identifiers. Not relevant for contact users. If the match ID type is not the primary identifier,
userIdentifiers must be supplied including the match ID type.
userAddressListuserAddressListList of user's external contact informations.
userRoleListuserRoleList Currently not in use.
userStatisticalCategoriesListuserStatListList of user's external statistics.
userDetails
Description: General user details
FieldTypeDescription
statususerStatusStatus of user account. Possible values are: Active, Inactive, Deleted
recordTyperecordTypeCurrently not in use. The type of user record (e.g. Public, Contact, Staff) is determined by the record type defined
on
the External Interface profile.
userTypeuserTypeCurrently not in use. The system will always put "External".
expiryDateformattedDateTypeThe estimated date when the user is expected to leave the institution.
defaultLanguagestringThe user's preferred language. Possible codes are listed in 'User Preferred Language' code table.
userNamestringThe primary identifier of the user. This value is mandatory if the primary id is the match id. If it is not the match id,
it should always be supplied for existing users. For new users, if not supplied, the system will generate a default.
firstNamestring The user's first name.
lastNamestring The user's last name.
middleNamestring The user's middle name.
jobTitlestringThe types of jobs the user performs in the library, such as Cataloger, Circulation Desk Operator, and so forth.
Possible
values are listed in 'Job Titles' code table.
jobDescriptionstringGeneral description of the user's job.
userGroupstringThe group within the institution to which the user belongs. Possible codes are listed in 'User Groups' code table.
Rules
for user group usage is define in 'UserRecordTypeUserGroup' mapping table.
externalIdstringCurrently not in use. The external interface code is determined by the code defined on the External Interface
profile.
webSiteUrlstringThe web site address related to the user.
birthDateformattedDateType The user's birth date.
purgeDateformattedDateTypeThe date on which the user is purged from the system.
gendergenderThe user's gender. Possible values are Male, Female, None.
passwordstring Currently not in use.
pinNumberstringA four-digit number which serves as a password for the user to log on to the selfcheck machine (SIP2).
campusCodestringThe code of the campus related to the user. Possible codes are listed in the "Campus List" of the general
configuration
menu.
resourceSharingLibraryCodestringThe code of resource sharing library related to the user. Possible codes are libraries that are marked as
resource sharing
library.
toCheckstring Currently not in use.
userNoteList
Description:
FieldTypeDescription
userNoteuserNote Specific user note.
userNote
Description: Specific user note.
FieldTypeDescription
segmentActionstring Currently not in use.
matchIdstring Currently not in use.
owneredEntityowneredEntityInformation about the creator/modifier and the change date of the note. If not supplied, creator/modifier will be set to
EX_LIBRIS. Creation/modification date will be set to the current date.
notestring The text of the note.
userViewablebooleanIndication whether the user is enabled to view the note.
typenoteType Tne note's type. Possible values are: Address, Barcode, Circulation, Library, Other.
userFineFeesList
Description: Currently not in use.
FieldTypeDescription
userFineFeeuserFineFee
userFineFee
Description: Currently not in use.
FieldTypeDescription
matchIdstring
owneredEntityowneredEntity
fineFeeTypefineFeeType
fineFeeStatusfineFeeStatus
fineFeeStatusReasonfineFeeStatusReason
fineFeeCommentstring
compositeSumcompositeSum
fineFeeTransactionListfineFeeTransactionList
fineFeeTransactionList
Description: Currently not in use.
FieldTypeDescription
fineFeeTransactionfineFeeTransaction
fineFeeTransaction
Description: Currently not in use.
FieldTypeDescription
matchIdstring
owneredEntityowneredEntity
transactionTypefineFeeTransactionType
transactionTypeReasontransactionTypeReason
transactionDateformattedDateType
compositeSumcompositeSum
transactionRelatedNumberstring
transactionCommentstring
compositeSum
Description:
FieldTypeDescription
sumdigitString
vatdigitString
currencystring
userBlockList
Description:
FieldTypeDescription
userBlockuserBlockSpecific user's external block.
userBlock
Description: Specific user block.
FieldTypeDescription
matchIdstring Currently not in use.
segmentActionstring Currently not in use.
owneredEntityowneredEntityInformation about the creator/modifier and the change date of the block. If not supplied, creator/modifier will be set to
EX_LIBRIS. Creation/modification date will be set to the current date.
statusblockStatusThe block's status. Possible values: Active, Inactive
notestring The block's related note.
blockDefinitionIdstringThe block type. Possible codes are listed in 'User Block Description' code table.
userIdentifiersList
Description: List of user's External identifiers. In case of synchronization , this list will replace the existing external
identifiers.
Internal identifiers will be kept.
FieldTypeDescription
userIdentifieruserIdentifier Specific user's external identifier.
userIdentifier
Description: Specific user's external identifier.
FieldTypeDescription
matchIdstring Currently not in use.
owneredEntityowneredEntityInformation about the creator/modifier and the change date of the identifier. If not supplied, creator/modifier will be
set to EX_LIBRIS. Creation/modification date will be set to the current date.
typestringThe identifier type. Possible codes are listed in 'User Identifier Type' code table. Mandatory.
toCheckstring Currently not in use.
statusidStatusThe identifier's status. Possible values are: Active, Inactive.
notestring The identifier's related note.
valuestring The identifier value. Note that the values are case sensitive.
userRoleList
Description: Currently not in use.
FieldTypeDescription
userRoleuserRole
userRole
Description: Currently not in use.
FieldTypeDescription
matchIdstring
owneredEntityowneredEntity
statusroleStatus
expiryDateformattedDateType
scopestring
roleTypedigitString
detailsstring
notestring
userAddressList
Description: List of External user's contact informations. In case of synchronization, this list will replace the existing external
contacts. Internal contacts will be kept.
FieldTypeDescription
userAddressuserAddressList of user's external addresses.
userPhoneuserPhoneList of user's external phone numbers.
userEmailuserEmailList of user's external email addresses.
userAddress
Description: List of user's external addresses. In case of synchronization, this list will replace the existing external addresses.
Internal addresses will be kept.
FieldTypeDescription
matchIdstring Currently not in use.
owneredEntityowneredEntityInformation about the creator/modifier and the change date. If not supplied, creator/modifier will be set to EX_LIBRIS.
Creation/modification date will be set to the current date.
segmentActionstring Currently not in use.
line1string Line 1 of the address.
line2string Line 2 of the address.
line3string Line 3 of the address.
line4string Line 4 of the address.
line5string Line 5 of the address.
citystring The address' relevant city.
stateProvincestring The address' relevant state.
postalCodestringThe address' relevant postal code.
countrystringThe address' relevant country. Possible codes are listed in 'Country Codes' code table.
notestring The address' related note.
startDateformattedDateTypeThe date from which the address is deemed to be active.
endDateformattedDateTypeThe date after which the address is no longer active.
typestypes
types
Description:
FieldTypeDescription
userAddressTypesuserAddressTypes
userPhone
Description: List of user's external phone numbers. In case of synchronization, this list will replace the existing external phone
numbers. Internal phone numbers will be kept.
FieldTypeDescription
matchIdstring Currently not in use.
owneredEntityowneredEntityInformation about the creator/modifier and the change date. If not supplied, creator/modifier will be set to EX_LIBRIS.
Creation/modification date will be set to the current date.
segmentActionstring Currently not in use.
phonestring The phone number.
typestypes
types
Description:
FieldTypeDescription
userPhoneTypesuserPhoneTypes
userEmail
Description: List of user's external email addresses. In case of synchronization, this list will replace the existing external email
addresses. Internal email addresses will be kept.
FieldTypeDescription
matchIdstring Currently not in use.
owneredEntityowneredEntityInformation about the creator/modifier and the change date. If not supplied, creator/modifier will be set to EX_LIBRIS.
Creation/modification date will be set to the current date.
segmentActionstring Currently not in use.
emailstring The email address.
descriptionstringThe email address' related description.
typestypes
types
Description:
FieldTypeDescription
userEmailTypesuserEmailTypes
owneredEntity
Description:
FieldTypeDescription
creationDateformattedDateTypeCreation date of the user information or related segment.
modificationDateformattedDateTypeModification date of the user information or related segment.
createdBystringCreator of the user information or related segment.
modifiedBystringModifier of the user information or related segment.
userStatList
Description:
FieldTypeDescription
userCategoryuserCategory Specific user statistic.
userCategory
Description: Specific user statistic.
FieldTypeDescription
owneredEntityowneredEntityInformation about the creator/modifier and the change date. If not supplied, creator/modifier will be set to EX_LIBRIS.
Creation/modification date will be set to the current date.
notestring The statistic's related note.
statisticalCategorystringThe statistical category. Possible codes are listed in 'User Statistical Categories' code table.
digitString
digitString is a xs:string with xs:restriction - see XSD for details.
userStatus
userStatus is a xs:string with xs:restriction - see XSD for details.
roleStatus
roleStatus is a xs:string with xs:restriction - see XSD for details.
fineFeeType
fineFeeType is a xs:string with xs:restriction - see XSD for details.
fineFeeStatus
fineFeeStatus is a xs:string with xs:restriction - see XSD for details.
fineFeeStatusReason
fineFeeStatusReason is a xs:string with xs:restriction - see XSD for details.
fineFeeTransactionType
fineFeeTransactionType is a xs:string with xs:restriction - see XSD for details.
noteType
noteType is a xs:string with xs:restriction - see XSD for details.
blockStatus
blockStatus is a xs:string with xs:restriction - see XSD for details.
idStatus
idStatus is a xs:string with xs:restriction - see XSD for details.
transactionTypeReason
transactionTypeReason is a xs:string with xs:restriction - see XSD for details.
emailStatus
emailStatus is a xs:string with xs:restriction - see XSD for details.
recordType
recordType is a xs:string with xs:restriction - see XSD for details.
userType
userType is a xs:string with xs:restriction - see XSD for details.
gender
gender is a xs:string with xs:restriction - see XSD for details.
formattedDateType
formattedDateType is a xs:string with xs:restriction - see XSD for details.

Samples

XML

JSON

__