Ben Abrahamse, Chair of the Standing Committee on Applications, has agreed to convene and coordinate this subgroup activity. The API review/testing group will be a collaboration between interested members of SCA and any of the ISNI pilot participants. A technical contact from ISNI will also participate as needed.
Members: Alison Thornton, Amber Billey, Christine Fernsebner Eslao, Isabel Quintana, Lucas Mak, Susan Radovsky, Vitus Tang
The group began its work in October 2017 and anticipates completing its work by the first week in February.
Activities and deliverables include:
- Review ISNI API documentation to learn functionality and gaps. For members there are two ISNI APIs :
- SRU Search API for members
- The AtomPub API: the AtomPub API allows members and RAG’s to submit ISNI requests using the ISNI Request schema.
- Test functionality according to varied use cases
- Determine ease of use and identify support or additional documentation that would be necessary for PCC members availing themselves of this self-service model
- Identify and prioritize development roadmap for ISNI for maximum benefit of API interaction with ISNI
- Document lessons learned, activities that require attention by others
- Review ISNI API documentation to learn functionality and gaps. For members there are two ISNI APIs :
API testing use cases:
HARVARD: HUP authors
MICHIGAN STATE: ETD authors
STANFORD: video game developers
COLUMBIA: department names
If you want to help test but don't have a project, contact other members of this group to see if you can help out
ISNI APH relevant documentation
Search
ISNI documention: http://www.isni.org/content/documents-related-database-enquiry
Suggested starting point: ISNI SRU Search API: Guidelines and Examples
The Search API is using the SRU standard, version 1.1 and is also available to the general public.
An interface for constructing complex queries is provided at: http://isni.oclc.org/sru/DB=1.2/
(If using a web browser to view results, view page source to see XML output. In most browsers, you can access this by right-clicking on the page you're viewing and choosing "view page source" from the right-click menu.)
Submission
ISNI documentation:
http://www.isni.org/content/documents-related-data-submission
http://www.isni.org/content/documents-related-data-submission-output
Suggested starting point: ISNI Atom Pub API guidelines.pdf
The AtomPub API submits single requests at a time, but could be programmed at a local level to automate submission of sequential requests as a way to make it a batch process.
Working documents
Meeting notes 2/23/18
-- Testing issues
AtomPub issues
Insufficient error messages: "Data not accepted" is not a useful response
"Requester identifier of resource" required–local identifier?
-- Links to documents coming out of the test
-- Is there are set of parameters that we can give the API that will provide results in the same sequence/order as the web page
-- How useful is the search API, given its obvious limitations? Should we just recommend avoiding its use?
-- "Set identifier" – do identified sets persists, can they be combined into more complex searches?
-- Question about creating request. Elements "creation class", what is it used for? Should this use a controlled vocabulary? What does attribute "src" refer to (ie source of data vs source of vocabulary) Word document on ISNI website with list of roles that can be used
-- Is there a comprehensive list of all available "MARC-esque" tags in Pica http://www.isni.org/content/documents-related-data-submission
