CiNii Books - Metadata and API - CiNii Books OpenSearch for Books & Journals

Contents

 

Query Specification

CiNii Books OpenSearch query for Books & Journals is as follows.
https://ci.nii.ac.jp/books/opensearch/search?(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 Free Keyword q Possible(AND) Partial match
2 Title title Possible(AND) Partial match
3 Title exact match search flag title_exact Impossible Search by specifying true or false. True is needed for title exact match search.
4 Uniform title search flag include_utl Impossible Search by specifying true or false. True is needed for Uniform title exact match search.
5 Author name author Possible(AND) Partial match
6 Alias name of author search flag include_alias Impossible Search by specifying true or false. True is needed for Author name search included Alias name.
7 Publisher publisher Possible(AND) Partial match
8 Subject subject Possible(AND) Partial match
9 Note note Possible(AND) Partial match
10 Author ID authorid Possible(OR) Exact match search
11 Unification title ID utid Possible（OR） Exact match search
12 ISBN isbn 可（OR） Exact match search. Without hyphen. Both 10 digits and 13 digits can be searched.
13 ISSN issn Possible(OR) Exact match search. Without hyphen.
14 NCID ncid Possible(OR) Exact match search
15 Classification clas Possible(OR) Exact match search. It is possible to perform a prefix search by putting an asterisk (*) after the search terms.
16 General Material Designation gmd Possible(OR) Specify the Language code. Refer to the General Material Designation code tableHowever, to search materials without a code (Book and Journal) need to be specified one character of underscore.
17 Language lang Possible(OR) Specify the Language code. Refer tothe Language code table.
18 Library ID fano Possible(OR) Exact match
19 Organization ID kid Possible(OR) Exact match
20 Area area Possible(OR) Search with specifying the area of holding library. Specify the KENCODE of the list of libraries.
21 Publication year(from) year_from Impossible Western year including the specified year. Only either one is also possible. (Even in that case, book whose publication year is unknown can not be searched.)
22 Publication year(to) year_to Impossible Western year including the specified year.
23 Material type type Impossible 0: unspecified (default), 1: books, 2 journals
24 Output format format Impossible atom:ATOM format (default), rss: RSS format,json: JSON-LD format, html:HTML format
25 Sort Order sortorder Impossible 1: Sorts by relevance in descending order(default), 2: Sorts results with the oldest year at the top, 3: Sorts results with the newest year at the top, 4: Sorts by number of holding libraries with the lowest number at the top 5: Sorts by number of holding libraries with the highest number at the top
26 Search Page Number p Impossible The first page is 1.
27 Number of outcome per one page count Impossible Default is 20
28 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.

"Access-Control-Allow-Origin" is required on http header for response, and it is available to use asynchronous communication between cross domains.

 

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#"
xmlns:dc xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:prism xmlns:prism="http://prismstandard.org/namespaces/basic/2.0/"
xmlns:dcterms xmlns:dcterms="http://purl.org/dc/terms/"
xmlns:cinii xmlns:cinii="http://ci.nii.ac.jp/ns/1.0/"
xmlns:cinii xmlns:cinii="http://ci.nii.ac.jp/ns/1.0/"
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 OpenSearch-" .
Example:
<title>CiNii Books OpenSearch - インタラクション+大向</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     opensearch:startIndex       Required Start number Indicates from which record number among the search results the data is being described.
10     opensearch:itemsPerPage       Required Results per page Indicates how many search results are included in the response.
11     items       Required    
12       rdf:Seq     Required    
13         rdf:li rdf:resource Required URI of Bibliography Details Page Indicates how many search results are included in the response. Repeated at most until the number of opensearch:itemsPerPage.
14   item       rdf:about Required Book and journal information Repeated at most until the number of opensearch:itemsPerPage. The permalink is described in rdf:about.
Example:
<item rdf:about="http://ci.nii.ac.jp/ncid/XX12345678">
15     title       Required Title  
16     link       Required URI of Bibliography Details Page Indicates the permalink in Bibliography Details Page.
<link>http://ci.nii.ac.jp/ncid/XX12345678</link>
17     rdfs:seeAlso     rdf:resource Required URI of Bibliography RDF Indicates the URI of Bibliography RDF (except parameter of appid)
<rdfs:seeAlso rdf:resource="http://ci.nii.ac.jp/ncid/XX12345678.rdf" />
18     dc:creator       Required Author name Repeated if there are multiple items.
19     dc:publisher         Publisher  
20     prism:publicationDate         Date of publication W3CDTF format
21     dc:date         Date of publication The same as prism:publicationDate
22     dcterms:isPartOf         Description of Parent Bibliography Repeated if there are multiple Parent bibliographies(series name).
Example:
<dcterms:isPartOf rdf:resource="http://ci.nii.ac.jp/ncid/BN06190301" dc:title="丸善ライブラリー"/>
23           rdf:resource Required URI of Parent bibliography URI of Parent bibliography(series name) at bibliography details page
24           dc:title Required Title of Parent bibliography Including numbers of series
25     dcterms:hasPart         Description of ISBN and ISSN Repeated by the number of ISBN and ISSN.
Example:
<dcterms:hasPart rdf:resource="urn:isbn:9784621053812"/>
<dcterms:hasPart rdf:resource="urn:issn:09133801"/>
26           rdf:resource Required ISBN, ISSN URN Format
27     cinii:ownerCount       Required Number of holding libraries Number of holding libraries of the Books and the journal.
Example:
<cinii:ownerCount>63</cinii:ownerCount>
 

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:dc xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:prism xmlns:prism="http://prismstandard.org/namespaces/basic/2.0/"
xmlns:opensearch xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
xmlns:dcterms xmlns:dcterms="http://purl.org/dc/terms/"
xmlns:cinii xmlns:cinii="http://ci.nii.ac.jp/ns/1.0/"
xml:lang xml:lang=”ja”>
3   title       Required Feed title Concatenation with query to "CiNii Books OpenSearch-".
<title>CiNii Books OpenSearch - インタラクション+大向</title>
4   link     href Required Query URL URL of Equivalent search with HTML. URL-encorded query is output with "variable identifier=value" format. Connects with "&amp;" and "appid" will be removed from parameter.
5   link     rel Required Relation with reference at linked page Fixed: "self"
6         type Required MIME type of reference at linked page Fixed: "application/atom+xml"
7         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.
8   id       Required Requested URI Same as the link element.
9   updated       Required Date when search was executed W3CDTF format
10   opensearch:totalResults       Required Total search results  
11   opensearch:startIndex       Required Start number Indicates from which record number among the search results the data is being described.
12   opensearch:itemsPerPage       Required Results per page Indicates how many search results are included in the response.
13   entry         Container that stores information on books and journals search results. Repeated at most until the number of opensearch:itemsPerPage.
14     title     Required Title  
15     link   href Required URI of Bibliography Details Page Indicates the permalink in Bibliography Details Page.
<link href="http://ci.nii.ac.jp/ncid/XX12345678"/>
16     link   rel Required Relation with reference at linked page Fixed: "alternate"
17         type   MIME type of reference at linked page Fixed: "application/rdf+xml"
18         href Required URI of Bibliography RDF Indicates the URI of Bibliography RDF (except parameter of appid)
href="http://ci.nii.ac.jp/ncid/XX12345678.rdf"
19     id     Required URI of Bibliography Details Page Indicates the permalink in Bibliography Details Page.
<id>http://ci.nii.ac.jp/ncid/XX12345678</id>
20     author     Required Description of Author Repeated if there are multiple items.
21       name   Required Author name  
22     dc:publisher       Publisher  
23     prism:publicationDate       Date of publication W3CDTF format
24     updated       Date of publication The same as prism:publicationDate
25     dcterms:isPartOf       Description of Parent Bibliography Repeated if there are multiple Parent bibliographies(series name).
Example:
<dcterms:isPartOf dc:title="丸善ライブラリー">http://ci.nii.ac.jp/ncid/BN06190301</dcterms:isPartOf>
26         dc:title Required Title of Parent bibliography Including numbers of series
27           Required URI of Writings in parent bibliography URI of Parent bibliography(series name) at bibliography details page
28     dcterms:hasPart       ISBN, ISSN URN format. Repeated by the number of ISBNand ISSN.
例：
<dcterms:hasPart>urn:isbn:9784621053812</dcterms:hasPart>
<dcterms:hasPart >urn:issn:09133801</dcterms:hasPart>
29     cinii:ownerCount     Required Number of Holding libraries Number of holding libraries of the Books and the journal.
Example:
<cinii:ownerCount>63</cinii:ownerCount>
 

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#",
"dcterms": "http://purl.org/dc/terms/",
"prism": "http://prismstandard.org/namespaces/basic/2.0/",
"cinii": "http://ci.nii.ac.jp/ns/1.0/",
"@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   dcterms         Required   http://purl.org/dc/terms/
5   rdf         Required   http://www.w3.org/1999/02/22-rdf-syntax-ns#
6   opensearch         Required   http://a9.com/-/spec/opensearch/1.1/
7   rdfs         Required   http://www.w3.org/2000/01/rdf-schema#
8   prism         Required   http://prismstandard.org/namespaces/basic/2.0/
9   cinii         Required   http://ci.nii.ac.jp/ns/1.0/
10 @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.
11 @graph         Array Required   Element count of array is 1
12   @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.
13   @type         Required   Fixed: "channel"
14   title         Required Title Concatenation with query to "CiNii Books OpenSearch"
Example:
"title":"CiNii Books OpenSearch - 検索エンジン 順位",<
15   description         Required Title Same as the above
16   link       Object Required    
17     @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.
18   dc:date         Required Date when search was executed W3CDTF format
19   opensearch:totalResults         Required Total search results  
20   opensearch:startIndex         Required Start number Indicates from which record number among the search results the data is being described.
21   opensearch:itemsPerPage         Required Results per page Indicates how many search results are included in the response.
22   items       Array      
23     @id       Required URI of the Bibliography Details Page Permalink to articles in the response.
24     @type       Required   Fixed: "item"
25     title       Required Title  
26     link     Object Required    
27       @id     Required URI of Bibliography Details Page Indicates the permalink in Bibliography Details Page.
"link": {@id:"http://ci.nii.ac.jp/ncid/XX12345678"},
28     rdfs:seeAlso     Object Required    
29       @id     Required URI of Bibliography JSON-LD Indicates the URI of Bibliography JSON-LD (except parameter of appid)
"rdfs:seeAlso":{@id:"http://ci.nii.ac.jp/ncid/XX12345678.json"},
30     dc:creator         Author name  
31     dc:publisher         Publisher  
32     prism:publicationDate         Date of publication W3CDTF format
33     dc:date         Date of publication The same as prism:publicationDate
34     dcterms:isPartOf     Array   Description of Parent bibliography Repeated if there are multiple Parent bibliographies(series name).
Example:
"dcterms:isPartOf":[{"@id":"http://ci.nii.ac.jp/ncid/BN06190301","dc:title":"丸善ライブラリー"}],
35       @id     Required URI of Parent bibliography URI of Parent bibliography (series name) at bibliography details page
36       dc:title     Required Title of Parent bibliography Including the number of series
37     dcterms:hasPart     Array   Description of ISBN and ISSN Repeated by the number of ISBN and ISSN.
Example:
"dcterms:hasPart":[{"@id":"urn:isbn:4591095142"},{"@id":"urn:isbn:9784591095607"},{"@id":"urn:isbn:9784591097526"}],
38       @id     Required ISBN, ISSN URN format
39     cinii:ownerCount       Required Number of Holding libraries Number of Holding libraries of the book and the journal
Example:
"cinii:ownerCount":"179"
 

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.

July 12, 2013

  • The following items have been added to Response Format Specification.
    • Number of Holding libraries (cinii:ownerCount)

May 10, 2013

  • The following items have been added to Query Specification.
    • Title exact match search flag(title_exact)
    • Uniform title search flag (include_utl)
    • Alias name of author search flag (include_alias)
    • Unification title ID (utid)

April 19,2013

  • The following items have been added to Response Format Specification.
    • Parent bibliography (series name) (dcterms:isPartOf)
    • ISBN, ISSN (dcterms:hasPart)