CiNii Articles - Metadata and API - CiNii Articles OpenSearch for Authors

 

Query Specification

CiNii Articles OpenSearch for Authors query is as follows.
http://ci.nii.ac.jp/opensearch/author?(parameter=value)& (parameter=value)&…&(parameter=value)

Each parameter that comprises the query is as follows.

No. parameter content
1 q Specifies the author name or author name ID to be searched (required)
This parameter is necessary to encode the URL.
2 count Specifies the number of search results per page (optional)
The default is 20. When a value under 0 or exceeding 200 is specified, or when no value is specified, it will be considered as the default value. (The maximum number of search results that can be displayed on a single page is 200.)
3 lang Specifies the language the search results are displayed in (optional)
The default is ja. Specify Japanese (ja) or English (en). When a character string other than ja or en is specified, or when no character string is specified, it will be considered as the default value.
4 start Start number for the acquired search result list (optional)
The default is 0. When a value under 0 or exceeding the number of results is specified, it will be considered as the default value.
5 format Specifies the format of the response (optional)
The default is xhtml (regular search results page). rss/atom can be specified. The rss/atom format is described later.
6 sortorder Specifies the sorting condition. The default is 1.
author name: descending order 1 / ascending order 2
No. of articles:decending 3
7 appid Required
 

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#"
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 "&" ,and "appid" will be removed from parameter.
4     title       Required Title Concatenation with query to "CiNii Author OpenSearch-" .
Example:
<title>CiNii Author 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         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   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   Author 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/nrid/1234567890123">
15     title         Author name Indicates the permalink in Author Details Page. <item rdf:about="http://ci.nii.ac.jp/nrid/1234567890123">
16     link         URI of Author Details Page <link>http://ci.nii.ac.jp/nrid/1234567890123</link>
17     rdfs:seeAlso     rdf:resource   URL of the RDF Indicates the URI of Author RDF (except parameter of appid) <rdfs:seeAlso rdf:resource="http://ci.nii.ac.jp/nrid/1000080143551.rdf"/>
18     description         Affiliated institution  
19     dc:subject         Research fields  
20     dc:date         Publication Date The latest publication date of articles by the author
 

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: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 Author OpenSearch-".
<title>CiNii Author OpenSearch - Kokujyou+Taro</title>
4   link     href Required Query URI 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 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 author search results. Repeated at most until the number of opensearch:itemsPerPage.
14     title       Author name  
15     link   href   URI of Author Details Page Permalink of the author. <link>http://ci.nii.ac.jp/nrid/1234567890123</link>
16     link   rel   Relation with reference at linked page Fixed: "alternate"
17         type   MIME type of reference at linked page Fixed: "application/rdf+xml"
18         href   URI of Author RDF Indicates the URI of Author RDF (except parameter of appid)
href="http://ci.nii.ac.jp/nrid/1234567890123.rdf"
19     id       URI of Author Details Page Indicates the permalink in Author Details Page. <id>http://ci.nii.ac.jp/nrid/1234567890123</id>
20     content       Affiliated institution The displayed content is assumed to be that which is displayed when the user is not logged in.
21       type       Fixed: "text"
22     dc:subject       Research fields  
22     updated       Date of publication The latest publication date of articles by the author
 

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 Author OpenSearch"
Example:
"title":"CiNii Books Author - 国情+太郎",
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表記
16   opensearch:totalResults         Required Total search results  
17   opensearch:startIndex           Start number Indicates from which record number among the search results the data is being described.
18   opensearch:itemsPerPage           Results per page Indicates how many search results are included in the response.
19   items       Array      
20     @id         URI of Author Details Page Permalink to Authors in the response.
21     @type           Fixed: "item"
22     title         Author name  
23     link     Object      
24       @id       URI of the Author Details Page Indicates the permalink in Author Details Page
"link": {"@id":"http://ci.nii.ac.jp/nrid/1234567890123"},
25     rdfs:seeAlso     Object      
26       @id       URI of the Author JSON-LD Indicates the URI of Author JSON-LD (except parameter of appid)
"rdfs:seeAlso":{"@id":"http://ci.nii.ac.jp/nrid/1234567890123.json"},
27     description         Affiliated institution  
28     dc:subject         Research fields  
29     dc:date         Date of publication The latest publication date of articles by the author
 

Revision History

You can check revision history of CiNii Articles JSON-LD API for Authors 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.

Nobember 12, 2014

  • Query parameter "q" has been able to search Author ID (NRID).

October 29, 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.