API Docs
Action on a deposit
Contents
This API performs an update of a deposit. Currently supported: withdraw and submit of a returned/draft deposit.
Resource URL
POST /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 |
|---|---|---|---|
op | xs:string | Optional. | The operation to be performed on the deposit. Mandatory. Currently submit and withdraw are supported. |
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
This method takes a Request object. See doc
Output
This method returns a Deposit object. See doc
Possible Error Codes
| Code | Message |
|---|---|
| 401652 | General Error - An error has occurred while updating the deposit. |
| 401666 | X parameter is not valid. |