API Docs
Retrieve user's purchase requests.
Contents
This Web service retrieves a user's purchase requests.
Resource URL
GET /almaws/v1/users/{user_id}/purchase-requestsAPI 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 | Required | 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. |
limit | xs:int | Optional. Default: 10 | Limits the number of results. Optional. Valid values are 0-100. Default value: 10. |
offset | xs:int | Optional. Default: 0 | Offset of the results returned. Optional.Default value: 0, which means that the first results will be returned. |
status | xs:string | Optional. | For filtering based on the purchase request's status. Optional. Possible values: INREVIEW, APPROVED, REJECTED, DEFERRED. Default is no status. |
Body Parameters
None
Output
This method returns a Purchase Requests object. See doc
Possible Error Codes
| Code | Message |
|---|---|
| 401890 | User with identifier X of type Y was not found. |
| 401652 | General Error: An error has occurred while processing the request. |
| 60275 | Purchase request status is not valid. |