Table of Contents
Query Specification
OpenSearch query in CiNii Research is in the following format.
https://cir.nii.ac.jp/opensearch/library?(parameter=value)& (parameter=value)&…&(parameter=value)
Query example: https://cir.nii.ac.jp/opensearch/all?q=abc&title=de&count=200&sortorder=0&format=rss
The search type and each parameter that comprises the query are as follows.
| No. | Item Name | Parameter | Availability of Boolean equation | Remarks |
|---|---|---|---|---|
| 1 | Library name | name | Possible(AND) | Partial match or exact match of Library ID. Required |
| 2 | Output format | format | Impossible |
atom:ATOM format (default) rss: RSS format json: JSON-LD format |
| 3 | Sort Order | sortorder | Impossible |
1:Sort by search score (default) 2:Sort by library ID in ascending order 3:Sort by library ID in descending order 4:Sort by prefecture code in ascending order 5:Sort by prefecture code in descending order 6:Sort by library name in alphabetical order 7:Sort by library name in reverse alphabetical order |
| 4 | Page Number | p | Impossible | The first page is 1. |
| 5 | Number of outcome per one page | count | Impossible | Default is 20 |
| 6 | 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 Specifications
You can select the response format from RSS, Atom, and JSON-LD in the query.
You can use cross-domain asynchronous communication by specifying "Access-Control-Allow-Origin:*" in the http header of the response.
RSS1.0 Response Format Specification
| No. | Tag Name | Requirement | Contents | Notes | |||||
|---|---|---|---|---|---|---|---|---|---|
| First level | Second level | Third level | Fourth level | Fifth level | Attribute | ||||
| 1 | xml | Required | Declares that it is an XML document | <?xml version="1.0" encoding="utf-8" ?> | |||||
| 2 | rdf:RDF | Required | Root element of the document | For xml:lang attribute describes the language to be returned. Describe the following character strings for attributes other than xml: lan | |||||
| 3 | <rdf:RDF | ||||||||
| 4 | xmlns | xmlns="http://purl.org/rss/1.0/" | |||||||
| 5 | xmlns:rdf | xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" | |||||||
| 6 | xmlns:rdfs | xmlns:rdfs=""http://www.w3.org/2000/01/rdf-schema#"" | |||||||
| 7 | xmlns:dc | xmlns:dc="http://purl.org/dc/elements/1.1/" | |||||||
| 8 | xmlns:opensearch | xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" | |||||||
| 9 | xmlns:cir | xmlns:cir="https://cir.nii.ac.jp/schema/1.0/" | |||||||
| 10 | xml:lang | xml:lang="ja"> | |||||||
| 11 | channel | rdf:about | Required | Requested URI | This is a search request URI. URL-encorded query is output with "variable identifier=value" format. Connects with "&" ,and "appid" will be removed from parameter. | ||||
| 12 | title | Required | Title | Concatenation with query to "CiNii Research Library -". Example: <title>CiNii Research Library - FA001062</title> |
|||||
| 13 | description | Required | Title | Same as the above | |||||
| 14 | link | Required | Requested URI | This is a search request URI. URL-encorded query is output with "variable identifier=value" format. Connects with "&", and "appid" will be removed from parameter. | |||||
| 15 | dc:date | Required | Date when search was executed | ||||||
| 16 | opensearch:totalResults | Required | Total search results | ||||||
| 17 | opensearch:startIndex | Required | Start number | Display which data in the search results is described from. | |||||
| 18 | opensearch:itemsPerPage | Required | Number of results | Display how many search results are included in the response. | |||||
| 19 | items | Required | |||||||
| 20 | rdf:Seq | Required | |||||||
| 21 | rdf:li | rdf:resource | Required | Detail page URI | List the permalinks to search results in the response. Repeat for up to the number of opensearch:itemsPerPage. | ||||
| 22 | item | rdf:about | Required | Detailed information (Detail page URI) | Repeat up to the number of opensearch:itemsPerPage. Describe the permalink in rdf:about. | ||||
| 23 | title | Required | Author name Title |
||||||
| 24 | link | Required | Detail page URI | Display permalink of the detail page<link>https://ci.nii.ac.jp/library/FA123456</link> | |||||
| 25 | rdfs:seeAlso | rdf:resource | Required | RDF URI | Display RDF URI (except for appid parameter) <rdfs:seeAlso rdf:resource="https://ci.nii.ac.jp/library/FA123456.rdf" /> |
||||
| 26 | dc:identifier | Required | identifier | ||||||
| 27 | rdf:datatype | Required | Type of identifier | "cir:FANO" | |||||
| 28 | (value) | Required | Value of identifier | Output library ID | |||||
| 29 | dc:date | Required | Date when search was executed |
Atom1.0 Response Format Specification
| No. | Tag Name | Requirement | Contents | Notes | |||||
|---|---|---|---|---|---|---|---|---|---|
| First level | Second level | Third level | Fourth level | Fifth level | Attribute | ||||
| 1 | xml | Required | Declares that it is an XML document | <?xml version="1.0" encoding="utf-8" ?> | |||||
| 2 | feed | Required | Root element of the document | For xml:lang attribute, describes the language to be returned. Describe the following character strings for attributes other than xml:lan. | |||||
| 3 | <feed | ||||||||
| 4 | xmlns | xmlns="http://www.w3.org/2005/Atom" | |||||||
| 5 | xmlns:rdf | xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" | |||||||
| 6 | xmlns:dc | xmlns:dc="http://purl.org/dc/elements/1.1/" | |||||||
| 7 | xmlns:opensearch | xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" | |||||||
| 8 | xmlns:cir | xmlns:cir="https://cir.nii.ac.jp/schema/1.0/" | |||||||
| 9 | xml:lang | xml:lang=”ja”> | |||||||
| 10 | title | Required | Feed title | "CiNii Research Library -" and search type linked with query. E.g. FA001062</title> |
|||||
| 11 | link | rel | Required | Relationship to the referenced document | Fixed value (self) | ||||
| 12 | type | Required | MIME type of the referenced document | Fixed value (application/atom+xm) | |||||
| 13 | href | Required | Requested URI | The URI of this search request. URL-encode the query and output it in the "variable name = value" format. Link it with "&". appid will be removed from the parameter. | |||||
| 14 | id | Required | Requested URI | Same as the link element | |||||
| 15 | updated | Required | Date and time the search was performed | W3CDTF notation | |||||
| 16 | opensearch:totalResults | Required | Total number of search results | ||||||
| 17 | opensearch:startIndex | Required | Start number | Display which data in the search results is described from. | |||||
| 18 | opensearch:itemsPerPage | Required | Number of results | Display how many search results are included in the response. | |||||
| 19 | entry | Required | Container to store the search results | Repeat up to the number of opensearch:itemsPerPage. | |||||
| 20 | title | Required | Library name | ||||||
| 21 | link | href | Required | Detail page URI | Display URI permalink. <link href="https://ci.nii.ac.jp/library/FA123456"/> |
||||
| 22 | link | rel | Required | Relationship to the referenced document | Fixed value(alternate) | ||||
| 23 | type | Required | MIME type of the referenced document | Fixed value (application/rdf+xml) | |||||
| 24 | href | Required | RDF URI | Display the URI for detailed RDF href="https://ci.nii.ac.jp/library/FA123456.rdf" |
|||||
| 25 | id | Required | Detail Page URI | Display the permalink of the detail page <id>https://ci.nii.ac.jp/library/FA123456</id> |
|||||
| 26 | dc:identifier | Required | Identifier | ||||||
| 27/td> | rdf:datatype | Required | Type of identifier | "cir:FANO" | |||||
| 28 | (value) | Required | Value of identifier | ||||||
| 29 | updated | Required | Date when search was executed |
JSON-LD Response Format Specification
| No. | Tag Name | Multiplicity | Type | Requirement | Contents | Notes | ||||
|---|---|---|---|---|---|---|---|---|---|---|
| First level | Second level | Third level | Fourth level | Fifth level | ||||||
| 1 | @context | Object | Required | Root element of the document | "@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/", "cir":"https://cir.nii.ac.jp/schema/1.0/" "rdfs": "http://www.w3.org/2000/01/rdf-schema#", "@vocab": "http://purl.org/rss/1.0/" }, |
|||||
| 2 | dc | Required | http://purl.org/dc/elements/1.1/ | |||||||
| 3 | rdf | Required | http://www.w3.org/1999/02/22-rdf-syntax-ns# | |||||||
| 4 | opensearch | Required | http://a9.com/-/spec/opensearch/1.1/ | |||||||
| 5 | cir | Required | https://cir.nii.ac.jp/schema/1.0/ | |||||||
| 6 | rdfs | Required | http://www.w3.org/2000/01/rdf-schema# | |||||||
| 7 | @vocab | Required | http://purl.org/rss/1.0/ | |||||||
| 8 | @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. | ||||||
| 9 | @graph | Array | Required | Element count of array is 1 | ||||||
| 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 | @type | Required | Fixed："channel" | |||||||
| 12 | title | Required | title | "CiNii Research Library -" and search type concatenated with query 例： "title":"CiNii Research Library - FA123456", |
||||||
| 13 | description | Required | title | Same content as title | ||||||
| 14 | link | object | Required | |||||||
| 15 | @id | Required | Requested URI | The URI of this search request. URL-encode the query and output it in the "variable name = value" format. appid will be removed from the parameter. | ||||||
| 16 | dc:date | Required | Date and time the search was performed | W3CDTF notation | ||||||
| 17 | opensearch:totalResults | Required | Total number of search results | |||||||
| 18 | opensearch:startIndex | Required | Start numbe | Display which data in the search results is described from. | ||||||
| 19 | opensearch:itemsPerPage | Required | Number of results | Display how many search results are included in the response. | ||||||
| 20 | items | array | ||||||||
| 21 | @id | Required | Detail page URI | Display the detail page permalink. "@id":"https://ci.nii.ac.jp/library/FA123456", |
||||||
| 22 | @type | Required | Fixed:"item" | |||||||
| 23 | title | Required | Library name | |||||||
| 24 | link | object | Required | |||||||
| 25 | @id | Required | Detail page URI | Display the permalink of the detail pageDisplay "link": {"@id":"https://ci.nii.ac.jp/library/FA123456"}, |
||||||
| 26 | rdfs:seeAlso | object | Required | |||||||
| 27 | @id | Required | JSON-LD URI | Display JSON-LD URI "rdfs:seeAlso":{"@id":"https://ci.nii.ac.jp/library/FA123456.json"}, |
||||||
| 28 | dc:identifier | Required | Identifier | |||||||
| 29 | @type | Required | Type of identifier | "cir:FANO" | ||||||
| 30 | @valu | Required | Value of identifier | Output library ID | ||||||
| 31 | dc:date | Required | Date when search was executed | W3CDTF format |