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

■ getXccdfList

XCCDF チェックリストデータリストを取得します。

■ リクエスト

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

パラメタ名 名称 パラメタ値 必須 デフォルト[1]
method メソッド名 getXccdfList (固定) ○ −
startItem エントリ開始位置 整数 (半角数字)
1〜応答エントリ数		 − 1
maxCountItem エントリ取得件数 整数 (半角数字)
1〜100 (getXccdfList エントリ上限値) 		− 100
lang 表示言語 (日本語／英語) ja:日本語、en:英語 − ja
xsl XSLファイル適用／未適用 1:適用、0:未適用 (準備中) − 0
  • 1)「デフォルト」は、該当パラメタに指定がない場合 (パラメタ自体もしくはパラメタ値が未指定の場合)に MyJVN API 側で自動的に設定する値です。

■ レスポンス

  • 概要
    • 処理成功時、Result ノードの中に XccdfList、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 ">

<XccdfList xml:lang="表示言語">
  <XccdfListItem id="XCCDF チェックリストデータ識別子" title="タイトル" description="説明"/>
  XccdfListItem ノードを繰り返します。
</XccdfList>

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

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

パラメタ 条件 エラーコード エラーメッセージ
method パラメタなし、パラメタ値なし、対象外のメソッド名 XX00000000 対象外のメソッド名です。メソッド名を確認の上、再試行してください。
startItem 半角数字以外 XL01022001 startItem は半角数値のみ指定可能です(1〜2147483647)。
整数以外(0、マイナス、小数など) XL01022002 startItem は正の整数値のみ指定可能です。
startItem ＞ 応答エントリ数 XL01032003 startItem が検索結果件数を超えています。
maxCountItem 半角数字以外 XL02022004 maxCountItem は半角数値のみ指定可能です(1〜2147483647)。
整数以外(0、マイナス、小数など) XL02022005 maxCountItem は正の整数値のみ指定可能です。
maxCountItem ＞ エントリ上限値 XL02032006 maxCountItem が API 検索上限値を超えています。
lang "en"、"ja"以外 XL03032007 lang は "en" または "ja" のみ指定可能です。
− サーバ側でエラーが発生した場合 RQ01999951 ※サーバ側でエラーが発生しました。しばらく時間を置いてから再試行してください。問題が解決しない場合は管理者にお問い合わせください。

TOP

[更新履歴]
2012年08月09日 初版．