CiNii Books - Metadata and API - CiNii Books OpenSearch for Holdings

 

Query Specification

CiNii Books OpenSearch for Holdings query is as follows.
http://ci.nii.ac.jp/books/opensearch/holder?(parameter=value)&(parameter=value)&…&(parameter=value)

Each parameter that comprises the query is as follows. Parameters other than this table is disregarded.

No. Item Name Parameter Name Availability of Boolean expression Remarks
1 NCID ncid Impossible Exact match, Required
2 Library: ILL Membership ill Impossible A: Participant, N: Not Participant
3 Library: ILL Status ill_stat Impossible A: Available, N: Not available
4 Library: Copy Service Status ill_copys Impossible A: Available, C: Require at the other library, N: Not available
5 Library: Loan Service Status ill_loans Impossible A: Available, C: Require at the other library, N: Not available
6 Library: FAX Service Status ill_faxs Impossible A: Available, C: Available with conditions, N: Not available
7 Library: Membership of Japan and US ILL ill_oclc Impossible A: Participant, N: Not Participant
8 Library: Membership of Japan and Korea ILL ill_keris Impossible A: Participant, N: Not Participant
9 Library: Membership of ILL Offset ill_offset Impossible A: Participant, N: Not Participant
10 Library: Library ID fano Impossible Exact match
11 Journal Holding: Year year Impossible Range specification is disapprove. These parameters will be ignored if the record you searched is book.
12 Journal Holding: Volume vol Impossible Range specification is disapprove.
13 Journal Holding: Number issue Impossible Range specification is disapprove
14 Journal Holding: Continuing cont Impossible 0: Not continuing, 1: Continuing
15 Output format format Impossible atom:ATOM format (default), rss: RSS format
16 Application ID appid Impossible Required
  • In the fields which accept a Boolean expression, you can specify relation by AND, OR, NOT, operator (in capital letters) and parenthesis ("(", ")").
  • Between AND, OR, NOT and words, blank is required. When you put words without operator, a default relation (operator written with parenthesis in the table) is used.
 

Response Specification

You can choose the response format with query from RSS, Atom, JSON-LD and HTML.

 

RSS1.0 Response Format Specification

No. Tag name Required Content Remarks
First level Second level Third level Fourth level Fifth level Attribute
1 xml           Required Declare as XML document <?xml version="1.0" encoding="utf-8" ?>
2 rdf:RDF           Required Document route element Language code of the response will appear at xml:lang attribute. Other attributes are as follows.
  <rdf:RDF
xmlns xmlns="http://purl.org/rss/1.0/"
xmlns:rdf xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:rdfs xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#"
xxmlns:dc xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:opensearch xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
xml:lang xml:lang=”ja”>
3   channel       rdf:about Required Requested URI This is a search request URI. URL-encorded query is output with "variable identifier=value" format. Connects with "&amp;" ,and "appid" will be removed from parameter.
4     title       Required Title Concatenation with query to "CiNii Books Holder-" .
<title>CiNii Books Holder- ○○○○○</title>
5     description       Required Title Same as the above
6     link       Required Requested URI This is a search request URI. URL-encorded query is output with "variable identifier=value" format. Connects with "&amp;", and "appid" will be removed from parameter.
7     dc:date       Required Date when search was executed W3CDTF format
8     opensearch:totalResults       Required Total search results  
9     items       Required    
10       rdf:Seq     Required    
11         rdf:li rdf:resource Required URI of Library Details Page Indicates how many search results are included in the response. Repeated at most until the number of opensearch:itemsPerPage.
12   item       rdf:about Required Library information Repeated at most until the number of opensearch:itemsPerPage. The permalink is described in rdf:about.
<item rdf:about="http://ci.nii.ac.jp/library/FA123456">
13     title       Required Library name  
14     link       Required URI of Library Details Page Indicates the permalink in Library Details Page.
<link>http://ci.nii.ac.jp/library/FA123456</link>
15     rdfs:seeAlso     rdf:resource Required URI of Library RDF Indicates the URI of Library RDF (except parameter of appid)
<rdfs:seeAlso rdf:resource="http://ci.nii.ac.jp/library/FA123456.rdf" />
16     dc:date       Required Date of update Date when the search was executed.
 

Atom1.0 Response Format Specification

No. Tag name Required Content Remarks
First level Second level Third level Fourth level Attribute
1 xml         Required Declare as XML document <?xml version="1.0"encoding="UTF-8" ?>
2 feed         Required Document route element Language code of the response will appear at xml:lang attribute. Other attributes are as follows.
  <feed
xmlns xmlns="http://www.w3.org/2005/Atom"
xmlns:opensearch xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
xml:lang xml:lang=”ja”>
3   title       Required Feed title Concatenation with query to "CiNii Books Holder-
<title>CiNii Books Holder- ○○○○○</title>
4   link     rel Required Relation with reference at linked page Fixed: "self"
5         type Required MIME type of reference at linked page Fixed: "application/atom+xml"
6         href Required Requested URI This is a search request URI. URL-encorded query is output with "variable identifier=value" format. Connects with "&amp;" and "appid" will be removed from parameter.
7   id       Required Requested URI Same as the link element.
8   updated       Required Date when search was executed W3CDTF format
9   opensearch:totalResults       Required Total search results  
10   entry         Container that stores information on holding search results. Repeated at most until the number of opensearch:itemsPerPage.
11     title     Required Library name  
12     link   href Required URI of Library Details Page Indicates the permalink in Library details page.
<link href="http://ci.nii.ac.jp/library/FA123456"/>
13     link   rel Required Relation with reference at linked page Fixed: "alternate"
14         type Required MIME type of reference at linked page Fixed: "application/rdf+xml"
15         href Required URI of Library RDF Indicates the URI of Library RDF (except parameter of appid)
href="http://ci.nii.ac.jp/library/FA123456.rdf"
16     id     Required URI of Library Details Page Indicates the permalink in Library details page.
<id>http://ci.nii.ac.jp/library/FA123456</id>
17     updated     Required Date of update Date when search performed
 

JSON-LD Response Format Specification

No. Tag Name Type Required Contents Remarks
First level Second level Third level Fourth level Fifth level
1 @context         Object Required Document route element "@context": {
"dc": "http://purl.org/dc/elements/1.1/",
"rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
"opensearch": "http://a9.com/-/spec/opensearch/1.1/",
"rdfs": "http://www.w3.org/2000/01/rdf-schema#",
"@vocab": "http://purl.org/rss/1.0/"
},
2   @vocab         Required   http://purl.org/rss/1.0/
3   dc         Required   http://purl.org/dc/elements/1.1/
4   rdf         Required   http://www.w3.org/1999/02/22-rdf-syntax-ns#
5   opensearch         Required   http://a9.com/-/spec/opensearch/1.1/
6   rdfs         Required   http://www.w3.org/2000/01/rdf-schema#
7 @id           Required Requested URI This is a search request URI. URL-encorded query is output with "variable identifier=value" format. "appid" will be removed from parameter.
8 @graph         Array Required   Element count of array is 1
9   @id         Required Requested URI This is a search request URI. URL-encorded query is output with "variable identifier=value" format. "appid" will be removed from parameter.
10   @type         Required   Fixed: "channel"
11   title         Required Title Concatenation with query to "CiNii Books Holder-
Example:
"title":"CiNii Books Holder- ○○○○○",
12   description         Required Title Same as the above
13   link       Object Required    
14     @id       Required Requested URI >This is a search request URI. URL-encorded query is output with "variable identifier=value" format. "appid" will be removed from parameter.
15   dc:date         Required Date when search was executed W3CDTF format
16   opensearch:totalResults         Required Total search results  
17   items       Array      
18     @id       Required URI of Library Details Page Indicates the permalink in Library Details Page
"@id":"http://ci.nii.ac.jp/library/FA123456",
19     @type       Required   Fixed: "item"
20     title       Required Library name  
21     link     Object Required    
22       @id     Required URI of Library Details Page Indicates the permalink in Library Details Page
"link": {"@id":"http://ci.nii.ac.jp/library/FA123456"},
23     rdfs:seeAlso     Object Required    
24       @id     Required URI of Library JSON-LD Indicate the URI of Library JSON-LD (except parameter of appid)
"rdfs:seeAlso":{"@id":"http://ci.nii.ac.jp/author/XX12345678.json"},
25     dc:date       Required Date of update Date when search performed
 

Revision History

You can check revision history of CiNii Articles JSON-LD API for Articles later April, 2013.

March 13, 2015

JSON-LD response format has been partly changed. The details are as follows;

  • Type of "items" tag has changed from "Object" to "Array".
  • "rdf:Seq" and "rdf:li" tags have not been used.
  • CiNii Web APIs by JSON-LD has become official version.

October 11, 2013

  • JSON-LD Format (json) has added to output format for Query Specification.
  • JSON-LD (Beta version) has added to Response Format Specification.
  • It has been available to use asynchronous communication between cross domains.