Reminder class

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

Bases: Record

Class representing a reminder

static build_headers(data_format: Literal['json', 'xml'], zone: str, area: str, rights: Literal['R', 'RW'] = 'RW', env: Optional[Literal['P', 'S']] = '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: Optional[Union[Dict, Element, DataFrame]]

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

property entity_id

Get the entity id

Returns

string containing the entity id

get_reminder_id() → str

Get the reminder id

Returns

string

property reminder_type

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

property status

Get the status

Returns

string containing the status

update() → 'Reminder'

Update the reminder