API Docs

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

Deposits by user id

This Web service retrieves the user deposits for a particular user id

Resource URL

GET /almaws/v1/users/{user_id}/deposits

API Description

URL Parameters

ParameterTypeDescription
user_idxs:stringA unique identifier for the user

Querystring Parameters

ParameterTypeRequiredDescription
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.
statusxs:stringOptional.filter deposits by status
limitxs:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.
order_byxs:stringOptional. Default: nameFew sort options are available: name, modification_date. One sort option may be used at a time. Default sorting is by name
directionxs:stringOptional. Default: ASCSorting direction: ASC/DESC. Default: ASC.

Body Parameters

None

Output

This method returns a User Deposit For User ID and Deposit ID object. See doc

Possible Error Codes

CodeMessage
402238Failed to get deposits.