API Docs
Retrieve a list of Reminders
Contents
This Web service returns a list of Reminders.
Resource URL
GET /almaws/v1/conf/reminders
API Description
URL Parameters
None
Querystring Parameters
Parameter | Type | Required | Description |
---|---|---|---|
type | xs:string | Optional. | Type for filtering. Optional. Valid values are from the ReminderTypes code table |
status | xs:string | Optional. | Status for filtering. Optional. Valid values are from the ReminderStatuses code table |
from | xs:string | Optional. | From this Date (YYYY-MM-DD). Optional. Defaults to today. |
to | xs:string | Optional. | To this Date (YYYY-MM-DD). Optional. Defaults to the From Date. |
order_by | xs:string | Optional. Default: type | Order by parameter. Optional. Valid values are type, status, reminder_date. |
direction | xs:string | Optional. Default: asc | Direction parameter. Optional. Valid values are asc, desc. |
entity_id | xs:string | Optional. | Entity ID parameter. Optional. Valid value is an entity id. |
entity_type | xs:string | Optional. Default: BIB_MMS | Entity Type parameter. Optional. Valid value is BIB_MMS. |
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. |
Body Parameters
None
Output
This method returns a Reminders
object. See doc
Possible Error Codes
Code | Message |
---|---|
40166410 | Parameter value invalid. |