API Docs
Create deposit
Contents
This API performs creation of a deposit object. Currently supported: submitting deposit, submitting deposit as a draft.
Resource URL
POST /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. |
draft | xs:string | Optional. Default: false | Boolean flag for indicating whether submit as draft. |
Body Parameters
This method takes a Deposit 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 creating the deposit. |
| 402205 | Input parameter X (Y) is not numeric. |
| 401666 | X parameter is not valid. |