API Docs
Get user fine/fee
Contents
This API returns a specific fine or fee for a user.
Resource URL
GET /almaws/v1/users/{user_id}/fees/{fee_id}
API Description
URL Parameters
Parameter | Type | Description |
---|---|---|
user_id | xs:string | A unique identifier for the user |
fee_id | xs:string | The fine/fee identifier |
Querystring Parameters
Parameter | Type | Required | Description |
---|---|---|---|
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. |
Body Parameters
None
Output
This method returns a Fee
object. See doc
Possible Error Codes
Code | Message |
---|---|
402119 | General error. |
401665 | Fine not found. |
401651 | Identifier not found. |
401666 | Parameter is not valid. |
60340 | The request is API Restricted by library. |
60258 | The API Restricted profile is not valid. |