Location class
- class almapiwrapper.config.Location(zone: str, library_code: str, code: str | None = None, env: Literal['P', 'S'] | None = 'P', data: Dict | JsonData | str | None = None)
Bases:
RecordClass representing a location
- 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
- create() 'Location'
Create a new location
- Returns:
object
almapiwrapper.library.Location
- 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
create() -> None Delete a location
- Location.fulfillment_unit -> str
Get the fulfillment unit
- Returns:
string containing the fulfillment unit
- 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
- save() 'Location'
Save a Location record in the ‘records’ folder
When saved, a suffix is added to the file path with the version. Example: records/<IZ>_<library_code>/location_<IZ>_<library_code>_<location_code>_<version>.xml
- Returns:
object
almapiwrapper.library.Location
- update() Location
Update the location