API Docs

Get user details

This Web service returns a specific user's details.

GET /almaws/v1/users/{user_id}

Parameter	Type	Description
`user_id`	xs:string	A unique identifier for the user

Parameter	Type	Required	Description
`user_id_type`	xs:string	Optional. Default: all_unique	The type of identifier that is being searched. Optional. If this is not provided, all unique identifier types are used. The values that can be used are any of the values in the User Identifier Type code table. The value may also be linking_id. To search for users which have linked accounts in other institutions according to the linking_id use user_id_type=linking_id.
`view`	xs:string	Optional. Default: full	Special view of User object. Optional. Possible values: full - full User object will be returned. brief - only user's core information, emails, identifiers and statistics are returned. By default, the full User object will be returned.
`expand`	xs:string	Optional. Default: none	This parameter allows for expanding on some user information. Three options are available: loans-Include the total number of loans; requests-Include the total number of requests; fees-Include the balance of fees. To have more than one option, use a comma separator.
`source_institution_code`	xs:string	Optional.	The source institution Code. Optional. When used the user_id is used to locate a copied user (linked account) based on source_link_id.

None

This method returns a User object. See doc

Code	Message
401890	User with identifier X of type Y was not found.
401861	User with identifier X was not found.
4019990	User with source identifier X of institution Y was not found.
4019998	User with linking ID not found.
60101	General Error: An error has occurred while processing the request.