API Docs

__METHOD= GET . __PATH= /almaws/v1/conf/reminders .

Retrieve a list of Reminders

This Web service returns a list of Reminders.

Resource URL

GET /almaws/v1/conf/reminders

API Description

URL Parameters

None

Querystring Parameters

ParameterTypeRequiredDescription
typexs:stringOptional.Type for filtering. Optional. Valid values are from the ReminderTypes code table
statusxs:stringOptional.Status for filtering. Optional. Valid values are from the ReminderStatuses code table
fromxs:stringOptional.From this Date (YYYY-MM-DD). Optional. Defaults to today.
toxs:stringOptional.To this Date (YYYY-MM-DD). Optional. Defaults to the From Date.
order_byxs:stringOptional. Default: typeOrder by parameter. Optional. Valid values are type, status, reminder_date.
directionxs:stringOptional. Default: ascDirection parameter. Optional. Valid values are asc, desc.
entity_idxs:stringOptional.Entity ID parameter. Optional. Valid value is an entity id.
entity_typexs:stringOptional. Default: BIB_MMSEntity Type parameter. Optional. Valid value is BIB_MMS.
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.

Body Parameters

None

Output

This method returns a Reminders object. See doc

Possible Error Codes

CodeMessage
40166410Parameter value invalid.