MyJVN >> API >> getProductList (ver. HND)

getProductList (ver. HND)

フィルタリング条件に当てはまる製品名リストを取得します。


リクエスト

  • https://jvndb.jvn.jp/myjvn?method=getProductList&feed=hnd&パラメタ名=パラメタ値&...
    • リクエスト URL は、HTTPS の GET および POST に対応しています。
  • パラメタ
    • メソッド名、パラメタ名は大文字小文字を区別しています。
    • 必須パラメタが未指定、または値なし ("method="など) の場合はエラーとなります。
    • 必須でないパラメタが未指定、または値なし ("lang="など) の場合はデフォルトを使用します。
パラメタ名 名称 パラメタ値 必須 デフォルト[1]
method メソッド名 getProductList (固定) ○ −
feed フィードフォーマット名 フィードフォーマット(=APIバージョン)を示す名称
hnd を指定		 ○ −
startItem エントリ開始位置 整数 (半角数字)
1〜応答エントリ数		 − 1
maxCountItem エントリ取得件数 整数 (半角数字)
1〜10,000 (getProductList エントリ上限値) 		− 10,000
cpeName CPE 製品名
(cpe:/{part}:{vendor}:{product}) 		cpe:/{part}:{vendor}:{product}
{part}フィールド ... "h" | "o" | "a" | "*"
{vendor}:{product}フィールド ... CPE 製品名
  • ワイルドカード "*" 指定可
  • アスキー文字
  • 大文字／小文字区別なし
  • 複数指定時は "+" で連結
  • URL エンコードされたエスケープシーケンス
    cpe:/a:apache:xerces-c%2B%2B
    cpeName=cpe:/a:apache:xerces-c%252B%252B
  • いずれか1つのみ指定可 [ cpeName | vendorId | productId ]
 − −
vendorId ベンダID 整数 (半角数字)
  • 複数指定時は "+" で連結
  • いずれか1つのみ指定可 [ cpeName | vendorId | productId ]
 − −
productId 製品ID 整数 (半角数字)
  • 複数指定時は "+" で連結
  • いずれか1つのみ指定可 [ cpeName | vendorId | productId ]
 − −
keyword キーワード URL エンコードされたキーワード
  • 製品名の部分一致によるフィルタリング
  • ワイルドカード "*" 指定不可 ("*"を指定した場合、"*"を含む項目をフィルタリング)
  • 大文字／小文字区別なし
  • charset=UTF-8
 − −
lang 表示言語 (日本語／英語) ja:日本語、en:英語 − ja
  • 1)「デフォルト」は、該当パラメタに指定がない場合 (パラメタ自体もしくはパラメタ値が未指定の場合)に MyJVN API 側で自動的に設定する値です。


レスポンス

  • 概要
    • 処理成功時、Result ノードの中に VendorInfo、MyJVN 共通 Status ノードを含む XML を応答します。ただし、フィルタリング結果が0件の場合、Result ノードの中に MyJVN 共通 Status ノードのみを含む XML を応答します。
    • エラー発生時、MyJVN 共通 Status ノードにエラーコードとエラーメッセージを格納します。
  • XMLスキーマ
<?xml version="1.0" encoding="UTF-8" ?>
<Result version="3.3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://jvndb.jvn.jp/myjvn/Results"
xmlns:mjres="http://jvndb.jvn.jp/myjvn/Results"
xmlns:status="http://jvndb.jvn.jp/myjvn/Status"
xsi:schemaLocation="http://jvndb.jvn.jp/myjvn/Results　
https://jvndb.jvn.jp/schema/results_3.3.xsd ">

<VendorInfo xml:lang="表示言語">
  <Vendor vname="ベンダ名" cpe="CPE ベンダ名" vid="ベンダ ID">
    <Product pname="製品名" cpe="CPE 製品名" pid="製品 ID"/>
    フィルタリングに当てはまる製品の件数分 Product ノードを繰り返します。
  </Vendor>
  ベンダの件数分 Vendor ノードを繰り返します。
</VendorInfo>

<status:Status
version="3.3"
method="getProductList"
feed="hnd"
lang="表示言語"
retCd="リターンコード (0:成功時、1:エラー時) "
retMax="エントリ取得件数"
errCd="エラーコード (処理成功時は空文字列) "
errMsg="エラーメッセージ (処理成功時は空文字列) "
totalRes="応答エントリ総数"
totalResRet="応答エントリ数"
firstRes="応答エントリ開始位置"
各リクエストパラメタ>
</status:Status>
</Result>


更新履歴


2018/02/21: 初版．