NAME
Catmandu::Store::CA - Retrieve items from a CollectiveAccess instance
SYNOPSIS
# From the command line
catmandu export CA to YAML --id 1234 --username demo --password demo --url http://demo.collectiveaccess.org --model ca_objects
# From a Catmandu Fix
lookup_in_store(
object_id,
CA,
url: http://demo.collectiveaccess.org,
username: demo,
password: demo,
model: ca_objects
)
# From Perl code
use Catmandu;
my $store = Catmandu->store('CA',
username => 'demo',
password => 'demo',
url => 'http://demo.collectiveaccess.org',
model => 'ca_objects'
)->bag;
my $item = $store->get('1234');DESCRIPTION
A Catmandu::Store::CA is Perl package that can query a CollectiveAccess instance.
CONFIGURATION
url
url of the CA instance (e.g. http://demo.collectiveaccess.org).
username
Name of a user that can be used to query the API. If you want to store items in the CA instance, it must have the necessary rights.
password
Password for the user.
model
The API can access several tables from the CA instance, called model in this module. The model is by default ca_objects, but the following are also supported:
ca_objectsca_object_lotsca_entitiesca_placesca_occurrencesca_collectionsca_storage_locationsca_loansca_movements
METHODS
new(%configuration)
Create a new Catmandu::Store::CA
get($id)
Retrieve a CA record given an identifier. This returns whatever the CA administrator designated as the "summary" of the record.
add($data)
Create a new CA record. See here to see what data you must provide to create a record.
update($id, $data)
Update a new CA record. See here to see what data you must provide to create a record.
delete($id)
Delete (soft delete) a record.
each()
Not supported
AUTHOR
Pieter De Praetere <pieter at packed.be>
COPYRIGHT
Copyright 2017- PACKED vzw
LICENSE
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.