API Docs

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

Action on a request

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

ParameterTypeDescription
user_idxs:stringA unique identifier for the user
deposit_idxs:stringA unique identifier for the deposit

Querystring Parameters

ParameterTypeRequiredDescription
opxs:stringOptional.The operation to be performed on the deposit. Mandatory. Currently submit and withdraw are supported.
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.

Body Parameters

This method takes a Request object. See doc

Output

This method returns a Deposit object. See doc

Possible Error Codes

CodeMessage
401652General Error - An error has occurred while updating the deposit.
401666X parameter is not valid.