API Docs
Deposits by user id
Contents
This Web service retrieves the user deposits for a particular user id
Resource URL
GET /almaws/v1/users/{user_id}/depositsAPI Description
URL Parameters
| Parameter | Type | Description |
|---|---|---|
user_id | xs:string | A unique identifier for the user |
Querystring Parameters
| 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. |
status | xs:string | Optional. | filter deposits by status |
limit | xs:int | Optional. Default: 10 | Limits the number of results. Optional. Valid values are 0-100. Default value: 10. |
offset | xs:int | Optional. Default: 0 | Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned. |
order_by | xs:string | Optional. Default: name | Few sort options are available: name, modification_date. One sort option may be used at a time. Default sorting is by name |
direction | xs:string | Optional. Default: ASC | Sorting 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
| Code | Message |
|---|---|
| 402238 | Failed to get deposits. |