Contents
Query Specification
CiNii Research OpenSearch for Holdings query is as follows.
https://cir.nii.ac.jp/opensearch/holder?(parameter=value)&(parameter=value)&…&(parameter=value)
| 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. These parameters will be ignored if the record you searched is book. |
| 13 | Journal Holding: Number | issue | Impossible | Range specification is disapprove. These parameters will be ignored if the record you searched is book. |
| 14 | Journal Holding: Continuing | cont | Impossible | 0: Not continuing, 1: Continuing These parameters will be ignored if the record you searched is book. |
| 15 | Output format | format | Impossible | atom:ATOM format (default) rss: RSS format json: JSON-LD format |
| 16 | Application ID | appid | Impossible | Required |
Response Specification
You can choose the response format with query from RSS, Atom and JSON-LD.
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. | |||||
| 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:abou | 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 Books Holder-". For example： <title>CiNii Research Holder - ○○○○○</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 | W3CDTF format | |||||
| 16 | opensearch:totalResults | Required | Total search results | ||||||
| 17 | items | Required | |||||||
| 18 | rdf:Seq | Required | |||||||
| 19 | 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. | ||||
| 20 | item | rdf:about | Required | Library information | The permalink is described in rdf:about. <item rdf:about="https://ci.nii.ac.jp/library/FA123456"> |
||||
| 21 | title | Required | Libirary name | ||||||
| 22 | link | Required | URI of Library Details Page | Indicates the permalink in Library Details Page. <link>https://ci.nii.ac.jp/library/FA123456</link> | |||||
| 23 | rdfs:seeAlso | rdf:resource | Required | URI of Library Details Page | Indicates the URI of Library RDF <rdfs:seeAlso rdf:resource="https://ci.nii.ac.jp/library/FA123456.rdf" /> |
||||
| 24 | dc:identifier | Required | Identifier | ||||||
| 25 | rdf:datatype | Required | Type of identifier | "cir:FANO" | |||||
| 26 | (Value) | Required | Value of identifier | Output library ID | |||||
| 27 | dc:date | Required | 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. | |||||
| 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 | Concatenation with query to "CiNii Research Holder - ". For example： <title>CiNii Research Holder - ○○○○○</title> |
|||||
| 11 | link | rel | Required | Relation with reference at linked page | Fixed: "self" | ||||
| 12 | type | Required | MIME type of reference at linked page | Fixed: "application/atom+xml" | |||||
| 13 | href | 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. | |||||
| 14 | id | Required | Requested URI | Same as the link element. | |||||
| 15 | updated | Required | Date when search was executed | W3CDTF format | |||||
| 16 | opensearch:totalResults | Required | Total search results | ||||||
| 17 | entry | Container that stores information on holding search results. | |||||||
| 18 | title | Required | Library name | ||||||
| 19 | link | href | Required | URI of Library Details Page | Indicates the permalink in Library details page. <link href="https://ci.nii.ac.jp/library/FA123456"/> |
||||
| 20 | link | rel | Required | Relation with reference at linked page | Fixed: "alternate" | ||||
| 21 | type | Required | MIME type of reference at linked page | Fixed: "application/rdf+xml" | |||||
| 22 | href | Required | URI of Library RDF | Indicates the URI of Library RDF href="https://ci.nii.ac.jp/library/FA123456.rdf" |
|||||
| 23 | id | Required | URI of Library Details Page | Indicates the permalink in Library details page. <id>https://ci.nii.ac.jp/library/FA123456</id> |
|||||
| 24 | dc:identifier | Required | Identifier | ||||||
| 25 | rdf:datatype | Required | Type of identifier | "cir:FANO" | |||||
| 26 | (Value) | Required | Value of identifier | Output library ID | |||||
| 27 | updated | Required | 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/", "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 | Concatenation with query to "CiNii Research Holder - ". For example： "title":"CiNii Research Holder - ○○○○○", |
|||||
| 13 | description | Required | Title | Same as the above | |||||
| 14 | link | Object | Required | ||||||
| 15 | @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. | |||||
| 16 | dc:date | Required | Date when search was executed | W3CDTF format | |||||
| 17 | opensearch:totalResults | Required | Total search results | ||||||
| 18 | items | Array | |||||||
| 19 | @id | Required | URI of Library Details Page | Indicates the permalink in Library Details Page "@id":"https://ci.nii.ac.jp/library/FA123456", |
|||||
| 20 | @type | Required | Fixed: "item" | ||||||
| 21 | title | Required | Library name | ||||||
| 22 | link | Object | Required | ||||||
| 23 | @id | Required | URI of Library Details Page | Indicates the permalink in Library Details Page "link": {"@id":"https://ci.nii.ac.jp/library/FA123456"}, |
|||||
| 24 | rdfs:seeAlso | Object | Required | ||||||
| 25 | @id | Required | URI of Library JSON-LD | Indicate the URI of Library JSON-LD "rdfs:seeAlso":{"@id":"https://ci.nii.ac.jp/library/FA123456.json"}, |
|||||
| 26 | dc:identifier | Required | Identifier | ||||||
| 27 | @type | Required | Type of identifier | "cir:FANO" | |||||
| 28 | @value | Required | Value of identifier | Output library ID | |||||
| 29 | dc:date | Required | Date when search was executed | W3CDTF format |