Scroll to navigation

WebService::ILS::RecordedBooks(3pm) User Contributed Perl Documentation WebService::ILS::RecordedBooks(3pm)

NAME

WebService::ILS::RecordedBooks - WebService::ILS module for RecordedBooks services

SYNOPSIS

    use WebService::ILS::RecordedBooks::Partner;
    or
    use WebService::ILS::RecordedBooks::Patron;

DESCRIPTION

WebService::ILS::RecordedBooks::Partner - services that use partner credentials, for any patron

WebService::ILS::RecordedBooks::PartnerPatron - same as above, except it operates on a single patron account

WebService::ILS::RecordedBooks::Patron - services that use individual patron credentials, in addition to partner credentials

WebService::ILS::RecordedBooks::PartnerPatron is preferred over WebService::ILS::RecordedBooks::Patron because the later requires patron credentials - username and password. However, if you do not know patron's email or RecordedBooks id (barcode) you are stuck with Patron interface.

See WebService::ILS

CONSTRUCTOR

new (%params_hash or $params_hashref)

Additional constructor params:

"ssl" => if set to true use https
"domain" => RecordedBooks domain for title url

"client_id" is either RecordedBooks id (barcode) or email

"domain" if set is either "whatever.rbdigital.com" or "whatever", in which case rbdigital.com is appended.

DISCOVERY METHODS

facets ()

Returns a hashref of facet => [values]

search ($params_hashref)

Additional input params:

"facets" => a hashref of facet values

named_query_search ($query, $media)

  See C<native_named_query_search()> below for $query, $media

facet_search ($facets)

  See C<native_facet_search()> below for $facets

CIRCULATION METHOD SPECIFICS

Differences to general WebService::ILS interface

holds ()

place_hold ($isbn)

remove_hold ($isbn)

checkouts ()

checkout ($isbn, $days)

renew ($isbn)

return ($isbn)

NATIVE METHODS

native_search ($params_hashref)

See <https://developer.overdrive.com/apis/search>

native_named_query_search ($query, $media)

  $query can be one of 'bestsellers', 'most-popular', 'newly-added'
  $media can be 'eaudio' or 'ebook'

native_facet_search ($facets)

  $facets can be either:
  * a hashref of facet => [values],
  * an arrayref of values
  * a single value

native_item ($isbn)

native_item_summary ($isbn)

Returns subset of item fields, with addition of summary field

native_holds ()

See <http://developer.rbdigital.com/endpoints/title-holds>

native_checkouts ()

LICENSE

Copyright (C) Catalyst IT NZ Ltd Copyright (C) Bywater Solutions

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR

Srdjan JankoviX <srdjan@catalyst.net.nz>

2020-03-21 perl v5.30.0