API Docs

__METHOD= GET . __PATH= /almaws/v1/users/{user_id}/purchase-requests .

Retrieve user's purchase requests.

This Web service retrieves a user's purchase requests.

Resource URL

GET /almaws/v1/users/{user_id}/purchase-requests

API Description

URL Parameters

user_idxs:stringA unique identifier for the user

Querystring Parameters

user_id_typexs:stringRequiredThe 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.
limitxs:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional.Default value: 0, which means that the first results will be returned.
statusxs:stringOptional.For filtering based on the purchase request's status. Optional. Possible values: INREVIEW, APPROVED, REJECTED, DEFERRED. Default is no status.

Body Parameters



This method returns a Purchase Requests object. See doc

Possible Error Codes

401890User with identifier X of type Y was not found.
401652General Error: An error has occurred while processing the request.
60275Purchase request status is not valid.