About

caiasoft - SDK for Connecting to the CaiaSoft API

Caiasoft SDK is the Python library for writing code that interfaces with CaiaSoft Storage Management System.

Usage

• About
• Usage
• Installation
  • Note
• Getting an API Key
• Notes
• API Status
  • GET
  • POST w/file payloads
  • POST w/ JSON payloads
• Contributing & Bug Reporting

Installation

Use pip: (not setup yet)

pip install caiasoft-sdk-python

Note

Alternatively the latest version could be directly installed via GitHub:

pip install git+https://github.com/kstatelibraries/caiasoft-sdk-python.git@main

Getting an API Key

To use these libraries, you must first obtain an API token and password, which can be done from within the Caiasoft Interface.

Notes

The full API documentation can be found at https://portal.caiasoft.com/apiguide.php.

API Status

GET

Method	Caiasoft API Endpoint	Status	Function Name
GET	/accessioned_active	Implemented / No Tests	accession_items_active
GET	/accessionedlist	Implemented / No Tests	accessioned_items
GET	/accessioninfo	Implemented / No Tests	accession_info
GET	/accessioninfo_active	Implemented / No Tests	accession_info_active
GET	/bibmissing	Implemented / No Tests	missing_bibfield
GET	/bibmissing_bydate	Implemented / No Tests	missing_bibfield_bydate
GET	/circstoplist	Implemented / No Tests	circ_stop_list
GET	/circstopout	Implemented / No Tests	circ_stop_out
GET	/deaccessionedlist	Implemented / No Tests	deaccessioned_items
GET	/deaccessioninfo	Implemented / No Tests	deaccession_info
GET	/item	Implemented / No Tests	item_info
GET	/itemloc	Implemented / No Tests	item_loc
GET	/itemstatus	Implemented / No Tests	item_status
GET	/refiledlist	Implemented / No Tests	refiled_list
GET	/retrievalinfo	Implemented / No Tests	retrieval_info
GET	/retrievedlist	Implemented / No Tests	retrieved_list

POST w/file payloads

Method	Caiasoft API Endpoint	Status	Function Name
POST	/attributefile	Missing
POST	/incomingfile	Missing
POST	/requestfile	Missing

POST w/ JSON payloads

Method	Caiasoft API Endpoint	Status	Function Name
POST	/circrequests	Implemented / No Tests	circulation_request
POST	/incomingitems	Implemented / No Tests	incoming_items
POST	/itemupdates	Implemented / No Tests	item_updates
POST	/itemsbybarcode	Implemented / No Tests	items_by_barcode
POST	/itemloclist	Implemented / No Tests	item_location_by_barcode
POST	/itemstatuslist	Implemented / No Tests	item_status_by_barcodes
POST	/union_author	Implemented / No Tests	union_author
POST	/union_callnumber	Implemented / No Tests	union_callnumber
POST	/union_isbn	Implemented / No Tests	union_isbn
POST	/union_issn	Implemented / No Tests	union_issn
POST	/union_lccn	Implemented / No Tests	union_lccn
POST	/union_oclc	Implemented / No Tests	union_oclc
POST	/union_title	Implemented / No Tests	union_title

Contributing & Bug Reporting

If you find a bug, please submit it through the GitHub issues page.

Pull requests are welcome!