MyJVN >> API >> getProductList >> 動作確認支援ツール

■ getProductList

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

■ リクエスト

  • http://jvndb.jvn.jp/myjvn?method=getProductList&パラメタ名=パラメタ値&...
    • リクエスト URL は、HTTP の GET および POST に対応しています。
  • パラメタ
    • メソッド名、パラメタ名は大文字小文字を区別しています。
    • 必須パラメタが未指定、または値なし ("method="など) の場合はエラーとなります。
    • 必須でないパラメタが未指定、または値なし ("lang="など) の場合はデフォルトを使用します。

パラメタ名 名称 パラメタ値 必須 デフォルト[1]
method メソッド名 getProductList (固定)
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
xsl XSLファイル適用/未適用 1:適用、0:未適用 (準備中) 0
  • 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.1"
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 
http://jvndb.jvn.jp/schema/results_3.1.xsd ">

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

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

  • エラーコードとエラーメッセージ

パラメタ 条件 エラーコード エラーメッセージ
method パラメタなし、パラメタ値なし、対象外のメソッド名 XX00000000 対象外のメソッド名です。メソッド名を確認の上、再試行してください。
startItem 半角数字以外 PR01020202 startItem は半角数値のみ指定可能です(1〜2147483647)。
整数以外(0、マイナス、小数など) PR01020203 startItem は正の整数値のみ指定可能です。
startItem > 応答エントリ数 PR01030004 startItem が検索結果件数を超えています。
maxCountItem 半角数字以外 PR02020206 maxCountItem は半角数値のみ指定可能です(1〜2147483647)。
整数以外(0、マイナス、小数など) PR02020207 maxCountItem は正の整数値のみ指定可能です。
maxCountItem > エントリ上限値 PR02030010 maxCountItem が API 検索上限値を超えています。
cpeName 先頭文字が "cpe:/*:" もしくは "cpe:*:" 以外 PR03030212 cpeName の先頭は "cpe:/*:" または "cpe:*:" のみ指定可能です。
cpe:/{part}:{vendor}:{product} の {vendor} か {product} が半角英数、半角記号以外 PR03020216 cpeName のベンダおよび製品部分は半角英数または半角記号のみ指定可能です(形式:cpe:/{part}:{vendor}:{product})。
vendorId 半角数字以外 PR04020218 vendorId は半角数値のみ指定可能です(1〜2147483647)。
整数以外(0、マイナス、小数など) PR04020219 vendorId は正の整数値のみ指定可能です。
productId 半角数字以外 PR05020221 productId は半角数値のみ指定可能です(1〜2147483647)。
整数以外(0、マイナス、小数など) PR05020222 productId は正の整数値のみ指定可能です。
cpeName
vendorId
productId
パラメタ "cpeName"、"vendorId"、"productId" の2つ以上指定あり PR06050223 パラメタ "cpeName"、"vendorId"、"productId" はいずれか1つのみ指定可能です。
lang "en"、"ja"以外 PR08030226 lang は "en" または "ja" のみ指定可能です。
サーバ側でエラーが発生した場合 RQ01999951 ※サーバ側でエラーが発生しました。しばらく時間を置いてから再試行してください。問題が解決しない場合は管理者にお問い合わせください。

TOP

[更新履歴]
2011年10月26日 改訂(XMLスキーマ).
2010年02月25日 初版.