ALIS WebOPAC API

https://library.affrc.go.jp/API
Admin
Documentation for the ALIS WebOPAC API providing REST-based access to Japan's Union Catalog of...
Tokens:6,089
Snippets:43
Trust Score:9.4
Update:4 months ago
Show doc for...
Tokens:
Raw
### Example Book Permalink

Source: https://library.affrc.go.jp/API/opensearch.html

Shows a specific example of a book's permalink within the RSS response.

```text
http://library.affrc.go.jp/api/xx12345678
```

--------------------------------

### Search by Bibliographic ID Example

Source: https://library.affrc.go.jp/API

Example of how to search for a bibliographic record using its specific ID.

```http
http://library.affrc.go.jp/api/QQ20352964
```

--------------------------------

### Search by ISBN with MARCXML Output Example

Source: https://library.affrc.go.jp/API

Examples of searching by ISBN and requesting the output in MARCXML format. Both URL structures (suffix and extension) are shown.

```http
http://library.affrc.go.jp/api/9784585002789/marc
```

```http
http://library.affrc.go.jp/api/9784585002789.marc
```

--------------------------------

### Search API Examples

Source: https://library.affrc.go.jp/API

Examples of how to use the search API to query different databases and retrieve results in various formats.

```APIDOC
## Search API

### Description
Allows searching across different databases with specified keywords and output formats.

### Method
GET

### Endpoint
`/T///[keyword]`

### Parameters
#### Path Parameters
- **keyword** (string) - Required - The keyword to search for.

### Request Example
`http://library.affrc.go.jp/api/T///rice`

## Search API with Author

### Description
Searches the book database by author and returns a specified number of results in MARC format.

### Method
GET

### Endpoint
`/T//AU/[author]/[limit]/MARC`

### Parameters
#### Path Parameters
- **author** (string) - Required - The author's name to search for.
- **limit** (integer) - Required - The maximum number of results to return.

### Request Example
`http://library.affrc.go.jp/api/T//AU/18802648%e8%be%b2%e6%9e%97%e6%b0%b4%e7%94%a3%e7%9c%81/10/MARC`

## Search API with OpenSearch and Title

### Description
Searches the magazine database using OpenSearch compliance for a given title and returns a specified number of results in DCNDL format.

### Method
GET

### Endpoint
`/Z/OPENSEARCH/TL/[title]/[limit]/MARC`

### Parameters
#### Path Parameters
- **title** (string) - Required - The title to search for.
- **limit** (integer) - Required - The maximum number of results to return.

### Request Example
`http://library.affrc.go.jp/api/Z/OPENSEARCH/TL/environment/100/MARC`
```

--------------------------------

### Search by NACSIS Bibliographic ID Example

Source: https://library.affrc.go.jp/API

Example of how to search for a bibliographic record using its NACSIS bibliographic ID.

```http
http://library.affrc.go.jp/api/BA91833159
```

--------------------------------

### Search by ISBN with RSS 1.0 Output Example

Source: https://library.affrc.go.jp/API

Examples of searching by ISBN and requesting the output in RSS 1.0 format. Both URL structures (suffix and extension) are shown.

```http
http://library.affrc.go.jp/api/9784585002789/rss
```

```http
http://library.affrc.go.jp/api/9784585002789.rss
```

--------------------------------

### OAI-PMH Identify Response Example

Source: https://library.affrc.go.jp/API

An example of the response from an OAI-PMH Identify verb request. This provides details about the repository.

```xml
<OAI-PMH xmlns="http://www.openarchives.org/OAI/2.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/ http://www.openarchives.org/OAI/2.0/OAI-PMH.xsd">
<responseDate>2013-08-28T04:42:10Z</responseDate>
<request>http://app.cc.affrc.go.jp/oai/oai-pmh.do</request>
<Identify>
<repositoryName>
Union Catalog of the Agriculture, Forestry and Fisheries Research Insititutes.(ALIS WebOPAC:Books)
</repositoryName>
<baseURL>http://app.cc.affrc.go.jp/oai/oai-pmh.do</baseURL>
<protocolVersion>2.0</protocolVersion>
<adminEmail>ric@ml.affrc.go.jp</adminEmail>
<earliestDatestamp>1969-04-01</earliestDatestamp>
<deletedRecord>transient</deletedRecord>
<granularity>YYYY-MM-DD</granularity>
<compression>gzip</compression>
<description>
<oai-identifier xmlns="http://www.openarchives.org/OAI/2.0/oai-identifier"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.openarchives.org/OAI/2.0/oai-identifier 
 http://www.openarchives.org/OAI/2.0/oai-identifier.xsd">
<scheme>oai</scheme>
<repositoryIdentifier>affrc.go.jp</repositoryIdentifier>
<delimiter>:</delimiter>
<sampleIdentifier>oai:affrc.go.jp:ALIS-QQ00000000</sampleIdentifier>
</oai-identifier>
</description>
</Identify>
</OAI-PMH>
```

--------------------------------

### Search by ISSN with DC-NDL Output Example

Source: https://library.affrc.go.jp/API

Examples of searching by ISSN and requesting the output in DC-NDL format. Both URL structures (suffix and extension) are shown.

```http
http://library.affrc.go.jp/api/03854000/dcndl
```

```http
http://library.affrc.go.jp/api/03854000.dcndl
```

--------------------------------

### Search by ISSN with RDF Output Example

Source: https://library.affrc.go.jp/API

Examples of searching by ISSN and requesting the output in RDF format (CiNii Books compliant schema). Both URL structures (suffix and extension) are shown.

```http
http://library.affrc.go.jp/api/03854000/rdf
```

```http
http://library.affrc.go.jp/api/03854000.rdf
```

--------------------------------

### Search by Bibliographic ID with JSON Output Example

Source: https://library.affrc.go.jp/API

Examples of searching by bibliographic ID and requesting the output in JSON format. Both URL structures (suffix and extension) are shown.

```http
http://library.affrc.go.jp/api/QQ20352964/json
```

```http
http://library.affrc.go.jp/api/QQ20352964.json
```

--------------------------------

### Example Permalinks in RSS Response

Source: https://library.affrc.go.jp/API/opensearch.html

Illustrates how permalinks for books and magazines are represented in the RSS response, including the resource URL and the book/magazine information.

```xml
<rdf:li rdf:resource="http://library.affrc.go.jp/api/xx12345678"></rdf:li>
<rdf:li rdf:about="http://library.affrc.go.jp/api/xx12345678"></rdf:li>
```

--------------------------------

### OpenSearch Description Files

Source: https://library.affrc.go.jp/API

These are the URLs for the OpenSearch Description Files, which allow compatibility with OpenSearch for searching books and magazines. They are available in RSS, ATOM, and MARCXML formats.

```xml
https://library.affrc.go.jp/OpenSearch_RSS.xml
```

```xml
https://library.affrc.go.jp/OpenSearch_MARC.xml
```

--------------------------------

### Search Library Database for 'rice' (RSS 1.0)

Source: https://library.affrc.go.jp/API

Use this endpoint to search the library database for a keyword and receive results in RSS 1.0 format. Omit database, OPENSEARCH, and item search parameters if not needed, but keep the trailing '/'.

```http
http://library.affrc.go.jp/api/T///rice
```

--------------------------------

### OpenSearch Query Parameters

Source: https://library.affrc.go.jp/API/opensearch.html

The ALIS WebOPAC OpenSearch API accepts various query parameters to filter and retrieve library resource information. The base URL for queries is http://library.affrc.go.jp/api/opnsrhb.do.

```APIDOC
## GET /api/opnsrhb.do

### Description
This endpoint allows users to search for library resources using various query parameters.

### Method
GET

### Endpoint
http://library.affrc.go.jp/api/opnsrhb.do

### Parameters
#### Query Parameters
- **q** (string) - Optional - Specifies a "free word" search. Internally, it searches as 'keywd'. When used with 'keywd', both are used for an AND search.
- **format** (string) - Optional - Specifies the return format of OpenSearch. Possible values: atom, rss, marc, rdf, dcndl.
- **keywd** (string) - Optional - Specifies a "keyword" search. When used with 'q', both are used for an AND search.
- **title** (string) - Optional - Specifies a "title" search.
- **auth** (string) - Optional - Specifies an "author" search.
- **pub** (string) - Optional - Specifies a "publisher" search.
- **year** (string) - Optional - Specifies a "publication year" search.
- **isbnsn** (string) - Optional - Specifies an "ISBN/ISSN" search. The system determines ISBN or ISSN based on the number of digits.
- **bibid** (string) - Optional - Specifies a "bibliographic ID". If provided, other search conditions are ignored.
- **code_type** (string) - Optional - Specifies the "code type".
- **code** (string) - Optional - Specifies the "code".
- **cls** (string) - Optional - Specifies a "classification" search.
- **sortkey** (string) - Optional - Specifies the "sort" order.
- **listcnt** (string) - Optional - Specifies the "number of records to retrieve".
- **sh** (string) - Optional - Specifies a "subject" search.
- **cntry** (string) - Optional - Specifies the "country of publication code".
- **lang** (string) - Optional - Specifies the "language code".
- **ncid** (string) - Optional - Specifies the "NACSIS bibliographic ID".
- **startpos** (string) - Optional - Specifies the "starting position for record retrieval". Defaults to 1 if not set or set to zero or less.

### Response
#### Success Response (200)
Responses are typically in RSS format, detailing search results. Key elements include:
- **title**: The title of the search result.
- **link**: The permalink to the bibliographic detail page.
- **dc:creator**: The author(s) of the resource.
- **dc:publisher**: The publisher of the resource.
- **prism:publicationDate**: The publication year.
- **opensearch:totalResults**: The total number of search results.
- **opensearch:startIndex**: The starting index of the current results set.
- **opensearch:itemsPerPage**: The number of items per page in the response.

#### Response Example (RSS)
```xml
<rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
         xmlns:dc="http://purl.org/dc/elements/1.1/"
         xmlns:prism="http://prismstandard.org/namespaces/basic/2.0/"
         xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
         xml:lang="ja">
  <item rdf:about="[permalink]">
    <title>[Title]</title>
    <link>[Permalink to bibliographic detail page]</link>
    <dc:creator>[Author Name]</dc:creator>
    <dc:publisher>[Publisher]</dc:publisher>
    <prism:publicationDate>[Publication Year]</prism:publicationDate>
  </item>
  <opensearch:totalResults>[Total Results]</opensearch:totalResults>
  <opensearch:startIndex>[Start Index]</opensearch:startIndex>
  <opensearch:itemsPerPage>[Items Per Page]</opensearch:itemsPerPage>
</rdf:RDF>
```
```

--------------------------------

### OpenSearch Query URL Structure

Source: https://library.affrc.go.jp/API/opensearch.html

This is the base structure for constructing an OpenSearch query. Append parameters as key-value pairs, separated by '&'.

```text
http://library.affrc.go.jp/api/opnsrhb.do?(パラメータ=値)&(パラメータ=値)&…(パラメータ=値)
```

--------------------------------

### API URL Structure for Keyword Search

Source: https://library.affrc.go.jp/API

This is the general structure for API requests when searching by keywords, title, or author. It includes parameters for database, search item, search term, number of results, and output format.

```http
>http://library.affrc.go.jp/api/検索対象データベース/OPENSEARCHの利用/検索対象項目/検索語/出力件数/出力フォーマット
```

--------------------------------

### Search by Code (ISBN, ISSN, Bibliographic ID, NACSIS ID, Authority ID)

Source: https://library.affrc.go.jp/API

Allows searching for library resources using specific codes such as ISBN, ISSN, Bibliographic ID, NACSIS ID, or Authority ID. Supports various output formats.

```APIDOC
## Search by Code

### Description
Allows searching for library resources using specific codes such as ISBN, ISSN, Bibliographic ID, NACSIS ID, or Authority ID. Supports various output formats.

### Method
GET

### Endpoint
`/api/{ISSN|ISBN|書誌ID|NCID|典拠ID}/{marc|json|rss|atom|rmarc|rdf|dcndl|junii2}`

`/api/{ISSN|ISBN|書誌ID|NCID|典拠ID}.{marc|json|rss|atom|rmarc|rdf|dcndl|junii2}`

### Parameters
#### Path Parameters
- **ISSN** (string) - Required - International Standard Serial Number.
- **ISBN** (string) - Required - International Standard Book Number.
- **書誌ID** (string) - Required - Bibliographic ID.
- **NCID** (string) - Required - NACSIS Bibliographic ID.
- **典拠ID** (string) - Required - Authority ID.
- **marc** (string) - Optional - Output format: MARCXML.
- **json** (string) - Optional - Output format: JSON.
- **rss** (string) - Optional - Output format: RSS 1.0.
- **atom** (string) - Optional - Output format: ATOM.
- **rmarc** (string) - Optional - Output format: MARCXML with RSS 1.0.
- **rdf** (string) - Optional - Output format: RDF (CiNii Books compliant schema).
- **dcndl** (string) - Optional - Output format: DC-NDL.
- **junii2** (string) - Optional - Output format: JuNii2 (Ver 1.0).

### Request Example
```
http://library.affrc.go.jp/api/QQ20352964
http://library.affrc.go.jp/api/BA91833159
http://library.affrc.go.jp/api/9784585002789/rss
http://library.affrc.go.jp/api/9784585002789.rss
http://library.affrc.go.jp/api/9784585002789/marc
http://library.affrc.go.jp/api/9784585002789.marc
http://library.affrc.go.jp/api/03854000/dcndl
http://library.affrc.go.jp/api/03854000.dcndl
http://library.affrc.go.jp/api/03854000/rdf
http://library.affrc.go.jp/api/03854000.rdf
http://library.affrc.go.jp/api/QQ20352964/json
http://library.affrc.go.jp/api/QQ20352964.json
```
```

--------------------------------

### Search Library Database by Author (MARC)

Source: https://library.affrc.go.jp/API

Search the library database by author name and retrieve a specified number of results in MARC format. Ensure the author ID is properly URL-encoded.

```http
http://library.affrc.go.jp/api/T//AU/18802648%e8%be%b2%e6%9e%97%e6%b0%b4%e7%94%a3%e7%9c%81/10/MARC
```

--------------------------------

### Keyword Search

Source: https://library.affrc.go.jp/API

Enables searching for library resources by keywords, titles, or authors. Supports various output formats and filtering options.

```APIDOC
## Keyword Search

### Description
Enables searching for library resources by keywords, titles, or authors. Supports various output formats and filtering options.

### Method
GET

### Endpoint
`http://library.affrc.go.jp/api/{検索対象データベース}/{OPENSEARCHの利用}/{検索対象項目}/{検索語}/{出力件数}/{出力フォーマット}`

### Parameters
#### Path Parameters
- **BASEURL** (string) - `http://library.affrc.go.jp/api/`
- **検索対象データベース** (string) - `T` (books) or `Z` (magazines). If omitted, searches both.
- **OPENSEARCHの利用** (string) - `OPENSEARCH`. Optional. If omitted, searches WebOPAC and outputs in HTML. Includes elements like start position and number of items.
- **検索対象項目** (string) - `keyword` (search by keyword), `TL` (search by title), `AU` (search by author). If omitted, searches across keyword, title, publisher, and subject.
- **検索語** (string) - Required. The search term. Multi-byte characters must be URL-encoded in UTF-8.
- **出力件数** (integer) - Optional. Number of items to output. Can be 10, 20, 50, 100. Defaults to 10.
- **出力フォーマット** (string) - Optional. If omitted, outputs in HTML. Supported formats: `RSS` (RSS 1.0), `ATOM`, `MARC` (MARCXML with detailed bibliographic information and holdings), `RDF` (CiNii Books compliant schema with detailed bibliographic information and holdings), `RMARC` (MARCXML with detailed bibliographic information and RSS 1.0), `DCNDL` (detailed bibliographic information in DC-NDL format), `JuNii2` (detailed bibliographic information in JuNii2 version 1), `JSON` (detailed bibliographic information and holdings in JSON, CiNii Books compliant schema).

### Request Example
```
http://library.affrc.go.jp/api/T/OPENSEARCH/keyword/rice/10/RSS
http://library.affrc.go.jp/api/Z/keyword/agriculture/20/MARC
http://library.affrc.go.jp/api/keyword/genetics/50/JSON
```
```

--------------------------------

### Search Magazine Database with OpenSearch (DCNDL)

Source: https://library.affrc.go.jp/API

Search the magazine database using OpenSearch compliance for a title and retrieve a specified number of results in DCNDL format.

```http
http://library.affrc.go.jp/api/Z/OPENSEARCH/TL/environment/100/MARC
```

--------------------------------

### API URL Structure for Code Search

Source: https://library.affrc.go.jp/API

This is the general structure for API requests when searching by ISSN, ISBN, or bibliographic ID. The output format can be specified as a suffix or an extension.

```http
http://library.affrc.go.jp/api/{ISSN|ISBN|書誌ID|NCID|典拠ID}/{marc|json|rss|atom|rmarc|rdf|dcndl|junii2}
```

```http
http://library.affrc.go.jp/api/{ISSN|ISBN|書誌ID|NCID|典拠ID}.{marc|json|rss|atom|rmarc|rdf|dcndl|junii2}
```

--------------------------------

### OAI-PMH Base URL

Source: https://library.affrc.go.jp/API

This is the base URL for OAI-PMH requests. Note that this feature is under adjustment and may experience timeouts.

```http
http://app.cc.affrc.go.jp/oai/oai-pmh.do
```

--------------------------------

### OAI-PMH Harvest API

Source: https://library.affrc.go.jp/API

Information on harvesting bibliographic data using the OAI-PMH protocol.

```APIDOC
## OAI-PMH Harvest API

### Description
Provides access to bibliographic data via the OAI-PMH protocol. Supports various metadata prefixes for harvesting.

### Base URL
`http://app.cc.affrc.go.jp/oai/oai-pmh.do`

### Supported Metadata Prefixes
- oai_dc
- junii2
- marc21
- dcndl
- rdf

### Example Request (Identify Verb)
`http://app.cc.affrc.go.jp/oai/oai-pmh.do?verb=Identify`

### Note
This service is currently under adjustment, and issues such as timeouts during output have been confirmed.
```
Tokens:
Raw