Reminder class

class almapiwrapper.config.Reminder(reminder_id: str | None = None, zone: str | None = None, env: Literal['P', 'S'] | None = 'P', data: Dict | JsonData | None = None, create_reminder: bool | None = False)

Bases: Record

Class representing a reminder

static api_call(method: Literal['get', 'put', 'post', 'delete'], *args, **kwargs) → Response | None

Static method to handle http errors. Quit the program after 3 failed tries

Parameters:

method – ‘get’, ‘put’, ‘post’ or ‘delete’ according to the api method call

static build_headers(data_format: Literal['json', 'xml'], zone: str, area: str, rights: Literal['R', 'RW'] = 'RW', env: Literal['P', 'S'] | None = 'P') → Dict

Build the headers for the API calls.

Parameters:

  • data_format – “json” or “xml”

  • zone – optional, if indicated allow to make the query in an other IZ

  • area – area of the record, bibs, users for example

  • rights – “R” for read only or “RW” for write and read rights

  • env – environment of the api call: ‘P’ for production, ‘S’ for sandbox

Returns:

dict with the headers

property data: Dict | Element | DataFrame | None

Property that get xml data with API call. If not available, make an api call

Returns:

xml data, dictionary or pandas dataframe

delete() → None

Delete the reminder

Returns:

None

Reminder.entity_id -> str

Get the entity id

Returns:

string containing the entity id

get_reminder_id() → str

Get the reminder id

Returns:

string

static parse_data(data: JsonData | XmlData | Dict | str) → JsonData | XmlData | None

Parse the data and return a parsed data object or None if an error occurs

Parameters:

data – data to be parsed

Returns:

parsed data object or None if an error occurs

Reminder.reminder_type -> str

Get the reminder type

Returns:

string containing the reminder type

save() → 'Reminder'

Save a Reminder record in the ‘records’ folder

When saved, a suffix is added to the file path with the version. Example: records/<entity_type>_<entity_id>/reminder_<IZ>_<reminder_id>_<version>.xml

Returns:

object almapiwrapper.reminder.Reminder

Reminder.status -> str

Get the status

Returns:

string containing the status

update() → 'Reminder'

Update the reminder