API Docs

__METHOD= GET . __PATH= /almaws/v1/users/{user_id} .

Get user details

This Web service returns a specific user's details.

Resource URL

GET /almaws/v1/users/{user_id}

API Description

URL Parameters

user_idxs:stringA unique identifier for the user

Querystring Parameters

user_id_typexs:stringOptional. Default: all_uniqueThe 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.
viewxs:stringOptional. Default: fullSpecial 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.
expandxs:stringOptional. Default: noneThis 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_codexs:stringOptional.The source institution Code. Optional. When used the user_id is used to locate a copied user (linked account) based on source_link_id.

Body Parameters



This method returns a User object. See doc

Possible Error Codes

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