API Docs
Deposit by user id and deposit id
Contents
This Web service retrieves the user deposit for a particular user id and deposit id.
Resource URL
GET /almaws/v1/users/{user_id}/deposits/{deposit_id}
API Description
URL Parameters
Parameter | Type | Description |
---|---|---|
user_id | xs:string | A unique identifier for the user |
deposit_id | xs:string | A unique identifier for the deposit |
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. |
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 deposit. |