Help - Metadata and API - OpenSearch - CiNii Books OpenSearch for Books & Journals
Query Specification
CiNii Books OpenSearch for Books & Journals query is as follows.
http://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 | Author name | author | Possible(AND) | Partial match | |
| 4 | Publisher | publisher | Possible(AND) | Partial match | |
| 5 | Subject | subject | Possible(AND) | Partial match | |
| 6 | Note | note | Possible(AND) | Partial match | |
| 7 | Author ID | authorid | Possible(OR) | Exact match | |
| 8 | ISBN | isbn | Possible(OR) | Exact match. Without hyphen. Both 10 digits and 13 digits can be searched. | |
| 9 | ISSN | issn | Possible(OR) | Exact match. Without hyphen. | |
| 10 | NCID | ncid | Possible(OR) | Exact match | |
| 11 | Classification | clas | Possible(OR) | Exact match. It is possible to perform a prefix search by putting an asterisk (*) after the search terms. | |
| 12 | General Material Designation | gmd | Possible(OR) | Refer to the General Material Designation code table. However, to search materials without a code (Book and Journal) need to be specified one character of underscore. | |
| 13 | Language | lang | Possible(OR) | Specify the Language code. Refer to the Language code table. | |
| 14 | Library ID | fano | Possible(OR) | Exact match | |
| 15 | Organization ID | kid | Possible(OR) | Exact match | |
| 16 | Area | area | Possible(OR) | Search with specifying the area of holding library. Specify the KENCODE of the list of libraries. | |
| 17 | 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.) |
| 18 | Publication year(to) | year_to | Impossible | Western year including the specified year. | |
| 19 | Material type | type | Impossible | 0: unspecified (default), 1: books, 2 journals | |
| 20 | Output format | format | Impossible | atom:ATOM format (default), rss: RSS format, html:HTML format | |
| 21 | 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 | |
| 22 | Page Number | p | Impossible | The first page is 1. | |
| 23 | Number of outcome per one page | count | Impossible | Default is 20 | |
| 24 | Application ID | appid | Impossible | Required | |
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 specify the format of a response from RSS, Atom and HTML by query.
- 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:prism xmlns:prism="http://prismstandard.org/namespaces/basic/2.0/" xmlns:opensearch xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" xml:lang xml:lang="ja"> 3 channel rdf:about Requested URI Encoded query as "parameter=value" and connect by "&". 4 title Title Query will come after "CiNii Books OpenSearch-". <title>CiNii Books OpenSearch - search engine order</title> 5 description Title The same as title 6 link Requested URI 7 dc:date Date when search was executed W3CDTF format 8 opensearch:totalResults Total search results 9 opensearch:startIndex Start number Indicates from which record number among the search results the data is being described. 10 opensearch:itemsPerPage Results per page Indicates how many search results are included in the response. 11 items 12 rdf:Seq 13 rdf:li rdf:resource Permalink Lists the permalink to the bibliography included in the response. 14 item rdf:about Book & journal information Describe the permalink with rdf:about. <item rdf:about="http://ci.nii.ac.jp/ncid/XX12345678"> 15 title Title 16 link Permalink URL of Book & Journal Details Page
<link>http://ci.nii.ac.jp/ncid/XX12345678</link>17 rdfs:seeAlso rdf:resource URL of the RDF <rdfs:seeAlso rdf:resource="http://ci.nii.ac.jp/naid/XX12345678.rdf" /> 18 dc:creator Author name Repeated if there are multiple items. 19 dc:publisher Publisher 20 prism:publicationDate Publication year W3CDTF format 21 dc:date Publication year The same as prism:publicationDate
- 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/" xml:lang xml:lang="ja"> 3 title Feed title Query will come after "CiNii Books OpenSearch -" <title>CiNii Books OpenSearch - interaction+大向</title> 4 link href URL in the case of searching equivalent contents with HTML 5 link ref Fixed value(self) 6 type Fixed value(application/atom+xml) 7 href Query URI 8 id Query URI Same as the link element. 9 updated Date when search was executed W3CDTF format 10 opensearch:totalResults Total search results 11 opensearch:startIndex Start number Indicates from which record number among the search results the data is being described. 12 opensearch:itemsPerPage Results per page Indicates how many search results are included in the response. 13 entry Container that stores information on book & journal search results. 14 title Title 15 link href Bibliography URI Permalink of the bibliography.
<link href="http://ci.nii.ac.jp/ncid/XX12345678"/>16 link ref Fixed value(alternate) 17 type Fixed value(application/atom+xml) 18 href RDF’s URI Displays RDF’s URI.
href="http://ci.nii.ac.jp/ncid/XX12345678.rdf"19 id Bibliography URI Permalink of the bibliography.
<id>http://ci.nii.ac.jp/ncid/XX12345678</id>20 author Repeated if there are multiple items. 21 name Author name 22 dc:publisher Publisher 23 prism:publicationDate Date of publication W3CDTF format 24 updated Date of publication The same as prism:publicationDate