NDL Search Application Programming Interface (API) Specifications (Ver. 1.24) 24 / 27
(4) Set "Set" is the definition for grouping items for selective harvest. "Set" is also used to acquire metadata related only to item group with a particular attribute. "Sets" include data provider (ID), data provider group (ID), NDC (please note you can specify it up to the three digit class number), Collection Code and Access Rights. Collection Code and Access Rights can be used " " " " .
For NDC,
prefix match shall be applied. For example, if a digit "7" is
specified, bibliographic data with the classification code "7xx" will be returned.
"D07"
"
"
"D07"
For example, if Aozora Bunko is specified for the data
provider, specify as "set=aozora".
for
the data whose NDC classification is "735", specify as "set=735". For the data of Aozora Bunko with NDC
classification "735", specify as "set=aozora:735" or "set=735:aozora."
,
"
"
"
".
"D07"
"
"
",
"
"
- Since 2013, NDL Search provides the Japanese national bibliography. The data provider NDL Online includes the Japanese national bibliography. If you want to scope the Japanese national bibliography, make a
NDL Search Application Programming Interface (API) Specifications (Ver. 1.24) 25 / 27 request with "set=iss-ndl-opac-national". Note that the Japanese national bibliography is equivalent to data with "set=iss-ndl-opac" and JPNO.
(5) Number of returned data records For ListIdentifiers, ListRecords, and ListSets, the number of returned data records at a time is 200. To acquire 201st and later records, make a request while specifying the resumptionToken notified when the first 200 records were acquired.
(6) Return format
The data return format is XML. For the schema (metadataPrefix), you can select either oai_dc, dcndl or
dcndl_simple.
To acquire the bibliographic data only, make a request with onlyBib=true specified.
(Available only when dcndl is specified for metadataPrefix)
For an example of returned data, see Appendix 3 (Examples of returned data for each interface) in this document.
(7) Identifier For OAI-PMH, a unique item identifier on the repository side can be received on the service provider side. By using this, you can update the data on the service provider at the time of differential harvest (the parameter described as the identifier in (3) Support requests and argument). This service uses this identifier as the metadata ID. (The ID, with the configuration shown below, uniquely given to all the metadata of this service.) oai:iss.ndl.go.jp :[repository number]-[item number]-[branch number]
(8) from, until If a date (YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ) is specified for "from the bibliographic data updated after the specified date is returned. If a date (YYYY-MM-DD or YYYY-MM-DDThh:mm:ssZ) is specified for "until" the bibliographic data updated earlier than the specified date is returned. The restriction on the period of "from" and "until see "(10) Access restriction of OAI-PMH
(9)Access restriction of OAI-PMH OAI-PMH applies following restriction to accesses in order to prevent the load on this service from being raised by accesses for large data acquisition. For ListRecords and Listidentifier, "from" is required. The following restriction is applied to the range (period) that can be specified by "from" or "until":
- Maximum period is one year.
NDL Search Application Programming Interface (API) Specifications (Ver. 1.24) 26 / 27
- In case of non-specified, maximum period (one year) is automatically assigned.
(11) Request sample Example 1: Identify request http://iss.ndl.go.jp/api/oaipmh?verb=Identify
Example 2: ListMetadataFormats request http://iss.ndl.go.jp/api/oaipmh?verb=ListMetadataFormats
Example 3: ListIdentifiers request http://iss.ndl.go.jp/api/oaipmh?verb=ListIdentifiers&metadataPrefix=oai_dc&from=2010-07-01
NDL Search Application Programming Interface (API) Specifications (Ver. 1.24) 27 / 27
Example 4: ListRecords request http://iss.ndl.go.jp/api/oaipmh?verb=ListRecords&metadataPrefix=oai_dc&set=aozora&from=2010-07- 01
http://iss.ndl.go.jp/api/oaipmh?verb=ListRecords&metadataPrefix=dcndl_simple&f rom=2011-02- 01&set=iss-ndl-opac-inprocess
Example 5: GetRecord request http://iss.ndl.go.jp/api/oaipmh?verb=GetRecord&metadataPrefix=oai_dc&identifier=oai:iss.ndl.go.jp:R00 0000014-I000044174-00
Example 6: ListSets request http://iss.ndl.go.jp/api/oaipmh?verb=ListSets