API Docs

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

Create deposit

This API performs creation of a deposit object. Currently supported: submittig deposit, submitting deposit as a draft.

Resource URL

POST /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.
draftxs:stringOptional. Default: falseBoolean 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

CodeMessage
401652General Error - An error has occurred while creating the deposit.
402205Input parameter X (Y) is not numeric.
401666X parameter is not valid.