---
name: "WebService::ILS::RecordedBooks"
section: "3pm"
platform: "linux"
package: "libwebservice-ils-perl"
version: "0.18-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/WebService::ILS::RecordedBooks"
---

# WebService::ILS::RecordedBooks(3pm)

WebService::ILS module for RecordedBooks services

## 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\>