ALIS WebOPAC OpenSearch クエリパラメータとレスポンス仕様

 ALIS WebOPAC OpenSearch クエリパラメータとレスポンス仕様
クエリパラメータ
  • OpenSearchクエリは以下の形式です。
    http://library.affrc.go.jp/api/opnsrhb.do?(パラメータ=値)&(パラメータ=値)&…(パラメータ=値)
  • クエリを構成するパラメータは以下の通りです。
     No.  パラメータ  内容
     1  q  「フリーワード」を指定するパラメータ。内部的には、keywdとして検索を実施する。Keywdと合わせて検索を行った場合、qとkeywdを、keywdのAND検索として利用。
     2  format  OpenSearchの返却フォーマットの指定を行う。atom, rss, marc, rdf, dcndlを指定可能。
     3  keywd  「キーワード」を指定するパラメータ。qと合わせて検索を行った場合、qとkeywdを、keywdのAND検索として利用。
     4  title  「タイトル」を指定するパラメータ。
     5  auth  「著者」を指定するパラメータ。
     6  pub  「出版者」を指定するパラメータ。
     7  year  「出版年」を指定するパラメータ。
     8  isbnsn  「ISBN/ISSN」を指定するパラメータ。桁数で、ISBN、ISSNの判断を行う。
     9  bibid  「書誌ID」を指定するパラメータ。bibidが指定されている場合、他の検索条件は無視される。
     10  code_type  「コード種別」を指定するパラメータ。
     11  code  「コード」を指定するパラメータ。
     12  cls  「分類」を指定するパラメータ。
     14  sortkey  「ソート」を指定するパラメータ。
     15  listcnt  「レコード取得件数」を指定するパラメータ。
     16  sh  「件名」を指定するパラメータ。
     17  cntry  「出版国コード」を指定するパラメータ。
     18  lang  「言語コード」を指定するパラメータ。
     19  ncid  「NACSIS書誌ID」を指定するパラメータ。
     27  startpos  「レコード取得開始位置」を指定するパラメータ。未設定もしくはゼロ以下の場合は1。
RSSレスポンス仕様
 No.  第1階層  第3階層  第4階層  第5階層  属性  必須  内容  備考
 1  xml           必須  XML文書であることを宣言  
 2  rdf:RDF          必須  文書のルート要素  xml:lang属性には返却する言語を記述する。xml:lang以外の属性は以下の文字列を記述する。
                 
           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:prism      xmlns:prism="http://prismstandard.org/namespaces/basic/2.0/"
           xmlns:opensearch      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
           xml:lang      xml:lang=”ja”
 3          rdf:about    リクエストされたURI  クエリをURLエンコードし、「変数名=値」形式で出力。「&」で連結する。
 4    title          タイトル  「webOPAC Books OpenSearch -」にクエリを連結したもの。
                 
 5    description          タイトル  titleと同じ内容
 6    link          リクエストされたURI  
 7    dc:date          検索が行われた日時  W3CDTF表記
 8    opensearch:totalResults          検索結果総数  
 9    opensearch:startIndex          開始番号  検索結果のうち、何件目のデータから記述しているかを表示する
 10    opensearch:itemsPerPage          件数  レスポンスに何件の検索結果が含まれているかを表示する
 11    items            
 12      rdf:Seq          
 13        rdf:li  rdf:resource    パーマリンク  レスポンスに含まれる図書・雑誌へのパーマリンクを列挙
 14          rdf:about    図書・雑誌情報  rdf:aboutにはパーマリンクを記述。
                 
 15    title          タイトル  
 16    link          パーマリンク  書誌詳細ページのURL
                 http://library.affrc.go.jp/api/xx12345678
 17    rdfs:seeAlso      rdf:resource    rdfへのurl  
 18    dc:creator          著者名  複数ある場合は列挙する
 19    dc:publisher          出版者  
 20    prism:publicationDate          出版年  
 21    dc:date          出版年  prism:publicationDateと同じ内容


ATOMレスポンス仕様

 No.  第1階層  第3階層  第4階層    属性  必須  内容  備考
 1  xml           必須  XML文書であることを宣言  
 2  feed          必須  文書のルート要素  xml:lang属性には返却する言語を記述する。xml:lang以外の属性は以下の文字列を記述する。
                 
           xmlns      xmlns="http://www.w3.org/2005/Atom"
           xmlns:dc      xmlns:dc="http://purl.org/dc/elements/1.1/"
           xmlns:prism      xmlns:prism="http://prismstandard.org/namespaces/basic/2.0/"
           xmlns:opensearch      xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/"
           xml:lang      xml:lang="ja"
 3              フィードのタイトル  「webOPAC Books OpenSearch - 」 に検索語を連結したもの。
                 
 4          href      同等内容の検索をHTMLで行う場合のURL
 5          ref      固定値(self)
 6          type      固定値(application/atom+xml)
 7          href    クエリのURI  
 8              クエリのURI  link要素と同じ
 9              検索が行われた日時  W3CDTF表記
 10              検索結果総数  
 11              開始番号  検索結果のうち、何件目のデータから記述しているかを表示する
 12              件数  レスポンスに何件の検索結果が含まれているかを表示する
 13              検索結果の図書・雑誌情報を格納するコンテナ  
 14    title          タイトル  
 15    link      href    書誌URI  パーマリンクを表示
                 
 16    link      ref      固定値(alternate)
 17          type      固定値(application/rdf+xml)
 18          href    RDFのURI  RDFのURIを表示
                 href="http://library.affrc.go.jp/api/XX12345678.rdf"
 19    id          書誌URI  パーマリンクを表示
                 http://library.affrc.go.jp/api/XX12345678
 20    author            複数ある場合は列挙する
 21      name        著者名  
 22    dc:publisher          出版者  
 23    prism:publicationDate          出版年月日  
 24    updated          出版年月日  prism:publicationDateと同じ内容