NAME

paia - Patrons Account Information API command line client

VERSION

version 0.11

SYNOPSIS

    paia login --base http://example.org/paia/ --username alice --password 12345
    paia patron
    paia items
    paia renew http://uri.example.org/item/123
    ...
    paia session --verbose
    paia logout

Run paia help or perldoc paia for more commands and options.

DESCRIPTION

The paia command line client can be used to access library patron account information, such as loans, reservations, and fees via the Patrons Account Information API (PAIA).

PAIA defines three commands for authentification (PAIA auth) and six commands to access a patron account (PAIA core). Each command can be called as first argument to the client. For instance

    paia items [options]

calls the "items" command of PAIA core. Access to PAIA core commands is granted by access tokens that can be required by the "login" command. By default the client automatically calls "login" if needed.

Basic options, such as base/core/auth URLs, username, and password can be stored in a config file, such as following. By default paia.json read used if found.

    {
      "base": "http://example.org/paia/",
      "username": "alice",
      "password": "12345"
    }

Access token, patron identifier and PAIA server URLs are stored in a session file (.paia_session by default) that can be checked with command "session".

COMMANDS

Call paia help <command> for help on a specific PAIA command. Note that PAIA servers do not need to support all PAIA commands.

PAIA auth

login

Get a access token and patron identifier from credentials (username and password). The patron identifier is used to uniquely identify a patron account. It may be identical with the username. On success access token, patron identifier and base URL are stored to a session file.

logout

Invalidate an access token. An existing session file is deleted.

change

Change login password (not implemented yet).

PAIA core

patron

Get general patron information.

items

List loans, reservations and other items related to a patron.

request

Request one or more items for reservation or delivery.

renew

Renew one or more documents held by a patron.

cancel

Cancel requests.

fees

List fees.

Client commands

session

Shows the current PAIA auth session status from session file.

help

Show help.

SEE ALSO

http://gbv.github.io/paia/

PAIA specification

App::PAIA

Perl module used to implement this client

AUTHOR

Jakob Voß

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Jakob Voß.

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