---
name: "HTTP::OAI::ListRecords"
section: "3pm"
platform: "linux"
package: "libhttp-oai-perl"
version: "4.13-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/HTTP::OAI::ListRecords"
---

# HTTP::OAI::ListRecords(3pm)

Provide access to an OAI ListRecords response

## NAME

HTTP::OAI::ListRecords - Provide access to an OAI ListRecords response

## SYNOPSIS

```
        my $r = $h->ListRecords(
                metadataPrefix=>'oai_dc',
        );
        while( my $rec = $r->next ) {
                print "Identifier => ", $rec->identifier, "\n";
        }
        die $r->message if $r->is_error;
        # Using callback method
        sub callback {
                my $rec = shift;
                print "Identifier => ", $rec->identifier, "\n";
        };
        my $r = $h->ListRecords(
                metadataPrefix=>'oai_dc',
                onRecord=>\&callback
        );
        die $r->message if $r->is_error;
```

## METHODS

- $lr = new HTTP::OAI::ListRecords

  This constructor method returns a new HTTP::OAI::ListRecords object.

- $rec = $lr-\>next

  Returns either an HTTP::OAI::Record object, or undef, if no more record are available. Use `$rec`-\>is\_error to test whether there was an error getting the next record.

- @recl = $lr-\>record(\[$rec\])

  Returns the record list and optionally adds a new record or resumptionToken, `$rec`. Returns an array ref of HTTP::OAI::Records, including an optional resumptionToken string.

- $token = $lr-\>resumptionToken(\[$token\])

  Returns and optionally sets the HTTP::OAI::ResumptionToken.

- $dom = $lr-\>toDOM

  Returns a XML::DOM object representing the ListRecords response.