Jakob Voß > App-PAIA-0.27 > paia

Download:
App-PAIA-0.27.tar.gz

Annotate this POD

Website

View/Report Bugs
Source  

NAME ^

paia - Patrons Account Information API command line client

VERSION ^

version 0.27

SYNOPSIS ^

    paia login --base http://example.org/paia/ -u alice -p 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). 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. Access token, patron identifier and PAIA server URLs are stored in a session file (paia-session.json by default) that can be checked with command "session".

Basic options, such as base/core/auth URLs, username, and password can be stored in a config file (paia.json by default), such as following:

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

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 (<http://gbv.github.io/paia/paia.html#login>)

Get a access token and patron identifier from credentials (username and password). On success access token, patron identifier and base URL are stored to a session file.

logout (<http://gbv.github.io/paia/paia.html#logout>)

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

change (<http://gbv.github.io/paia/paia.html#change>)

Change login password.

PAIA core

patron (<http://gbv.github.io/paia/paia.html#patron>)

Get general patron information.

items (<http://gbv.github.io/paia/paia.html#items>)

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

request (<http://gbv.github.io/paia/paia.html#request>)

Request one or more items for reservation or delivery.

renew (<http://gbv.github.io/paia/paia.html#renew>)

Renew one or more documents held by a patron.

cancel (<http://gbv.github.io/paia/paia.html#cancel>)

Cancel requests.

fees (<http://gbv.github.io/paia/paia.html#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) 2014 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.

syntax highlighting: