API Docs
Retrieve user requests
Contents
This Web service returns list of requests for a specific user.
Resource URL
GET /almaws/v1/users/{user_id}/requests
API Description
URL Parameters
Parameter | Type | Description |
---|---|---|
user_id | xs:string | A unique identifier for the user |
Querystring Parameters
Parameter | Type | Required | Description |
---|---|---|---|
request_type | xs:string | Optional. | Filter results by request type. Optional. Possible values: HOLD, DIGITIZATION, BOOKING. If not supplied, all request types will be returned. |
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. |
limit | xs:int | Optional. Default: 10 | Limits the number of results. Optional. Valid values are 0-100. Default value: 10. |
offset | xs:string | 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. Default: active | Active or History request status. Default is active. The 'history' option is only available if the 'should_anonymize_requests' customer parameter is set to 'false' at the time the request was completed. |
Body Parameters
None
Output
This method returns a User 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. |
60258 | The API Restricted profile is not valid. |