API Docs

External Sys Export User Blocks

Overview

The 'Export User Blocks' job exports users that owe the library money or contain certain blocks.
This is in order to enable blocking these users from certain activities until they clear their outstanding obligations to the library.

Data Dictionary

Click here to download external_sys_export_user_blocks.xsd

userExportedBlocksList

Description: List of users and their balance and blocks.

FieldTypeDescription
userExportedBlockuserExportedBlockBlocks and balance for a specific user.

 

userExportedBlock

Description: Blocks and balance for a specific user.

FieldTypeDescription
useruserUser details.
userBalancestringThe user's active balance.
userBlockListuserBlockListList of user's blocks.

 

user

Description:

FieldTypeDescription
userGroupstringThe group within the institution to which the
user belongs. Possible codes are listed in 'User Groups' code
table.

The valid values for this parameter are controlled by the code-table: UserGroups. These are the currently defined values for your institution:
CodeDescription
userIdstringThe user's ID, of the id type that is defined on the integration profile. This ID is the match point between Alma and the SIS.

 

userBlockList

Description: List of user's blocks.

FieldTypeDescription
userBlockuserBlockSpecific user's block.

 

userBlock

Description: Specific user block.

FieldTypeDescription
blockIdstringThe block's internal ID.
blockTypestringPossible values are listed in the 'User Block
Types' code table. Note that the description is exported, not the code.

The valid values for this parameter are controlled by the code-table: UserBlockTypes. These are the currently defined values for your institution:
CodeDescription
blockDescriptionstringThe block's description. Mandatory. Possible
values are listed in the 'User Block Description' code table. Note that the description is exported, not the code.

The valid values for this parameter are controlled by the code-table: UserBlockDescription. These are the currently defined values for your institution:
CodeDescription
blockCreationDateformattedDateTypeThe creation data of the block.

 

formattedDateType
formattedDateTypeis a xs:string with xs:restriction - see XSD for details.

Samples

XML
JSON
__