· Web view政府統計の総合窓口(e-Stat) API仕様 【バージョン1.0】...
Transcript of · Web view政府統計の総合窓口(e-Stat) API仕様 【バージョン1.0】...
政 府 統 計 の 総 合 窓 口
( e-Stat )
API仕 様
【 バ ー ジ ョ ン 1.0】
平 成 30 年 5 月
独 立 行 政 法 人 統 計 セ ン タ ー
はじめに本書は、政府統計の総合窓口(e-Stat)の API 機能に係る仕様について説明したものです。
目 次
1. API 機能の種類.......................................................................................................................12. API の利用方法.......................................................................................................................12.1. 統計表情報取得.................................................................................................................12.2. メタ情報取得....................................................................................................................12.3. 統計データ取得.................................................................................................................12.4. データセット登録.............................................................................................................22.5. データセット参照.............................................................................................................2
3. API パラメータ.......................................................................................................................23.1. 全 API 共通.......................................................................................................................23.2. 統計表情報取得.................................................................................................................23.3. メタ情報取得....................................................................................................................33.4. 統計データ取得.................................................................................................................43.5. データセット登録.............................................................................................................63.6. データセット参照.............................................................................................................7
4. API の出力データ....................................................................................................................84.1. 全 API 共通.......................................................................................................................84.2. 統計表情報取得..............................................................................................................124.3. メタ情報取得.................................................................................................................154.4. 統計データ取得.............................................................................................................174.5. データセット登録..........................................................................................................244.6. データセット参照..........................................................................................................26
1. API 機能の種類取り扱うデータの種類や操作内容により、以下の5つの機能を提供します。
統計表情報取得
政府統計の総合窓口(e-Stat)で提供している統計表の情報を取得します。リクエストパラメータの指定により条件を絞った情報の取得も可能です。
メタ情報取得
指定した統計表 ID に対応するメタ情報(表章事項、分類事項、地域事項等)を取得します。
統計データ取得
指定した統計表 ID 又はデータセット ID に対応する統計データ(数値データ)を取得します。
データセット登録
統計データを取得する際の取得条件を登録します。統計データの取得における絞り込み条件を「データセット」として指定することで、取得条件を省略することができます。
データセット参照
登録されているデータセットの絞り込み条件等を参照します。データセット ID が指定されていない場合は、利用者が使用できるデータセットの一覧が参照可能です。
2. API の利用方法指定された URL に対してリクエストを送信することで、各 API を利用することができます。https に
よるリクエストも可能となっております。
各 API を利用するには、アプリケーション ID を必ず指定する必要があります。利用登録を行い、アプ リケーション ID を取得して下さい。
2.1. 統計表情報取得
リ ク エ ス トURL
http(s)://api.e-stat.go.jp/rest/<バージョン>/app/getStatsList?<パラメータ群>
HTTP メ ソ ッド GET
2.2. メタ情報取得
リ ク エ ス トURL
http(s)://api.e-stat.go.jp/rest/< バージョン>/app/getMetaInfo?< パラメータ群>
HTTP メ ソ ッド GET
2.3. 統計データ取得
リ ク エ ス トURL
http(s)://api.e-stat.go.jp/rest/<バージョン>/app/getStatsData?<パラメータ群>
HTTP メ ソ ッド GET
2.4. データセット登録
リ ク エ ス トURL http(s)://api.e-stat.go.jp/rest/<バージョン>/app/postDataset
HTTP メ ソ ッド POST
Content-Type application/x-www-form-urlencoded
※ データセット登録の場合は POST で送信して下さい。また、HTTP ヘッダに上記の通り'Content-Type'の指定が必要です。
2.5. データセット参照
リ ク エ ス トURL
http(s)://api.e-stat.go.jp/rest/<バージョン>/app/refDataset?<パラメータ群>
HTTP メ ソ ッド GET
3. API パラメータ各 API は、リクエスト送信時にパラメータの指定が必要です。
各パラメータは「パラメータ名=値」のように名称と値を'='で結合し、複数のパラメータを指定する場合は「パラメータ名=値&パラメータ名=値&…」のようにそれぞれのパラメータ指定を'&'で結合して下さい。また、パラメータ値は必ず URL エンコードしてから結合して下さい。
リクエスト方式が GET の場合は「2.API の利用方法」の各リクエスト URL の<パラメータ群>の位置に、POST の場合はリクエストのボディ部に、それぞれ 結合した文字列を指定して下さい。
3.1. 全 API 共通
パ ラ メ ー タ
名
意味 必須 設定内容・設定可能値
appId アプリケーション ID ○ 取得したアプリケーション ID を指定して下さい。
lang 言語 - 取得するデータの言語を 以下のいずれかを指定して下さ
い。
・J:日本語 (省略値)
・E:英語
3.2. 統計表情報取得
パラメータ名 意味 必須 設定内容・設定可能値
surveyYears 調査年月 - 以下のいずれかの形式で指定して下さい。
・yyyy:単年検索
・yyyymm:単月検索
・yyyymm-yyyymm:範囲検索
openYears 公開年月 - 調査年月と同様です。
statsField 統計分野 - 以下のいずれかの形式で指定して下さい。
・数値 2 桁:統計大分類で検索
・数値 4 桁:統計小分類で検索
statsCode 政府統計コード - 以下のいずれかの形式で指定して下さい。
・数値 5 桁:作成機関で検索
・数値 8 桁:政府統計コードで検索
searchWord 検索キーワード - 任意の文字列
表題やメタ情報等に含まれている文字列を検索します。
AND 又は OR を指定して複数ワードでの検索が可能で
す。 (東京 AND 人口、東京 OR 大阪 等)
searchKind 検索データ種別 - 検索するデータの種別を指定して下さい。
・1:統計情報(省略値)
・2:小地域・地域メッシュ
・3:社会・人口統計体系(都道府県・市区町村のすが
た)
statsNameList
統計調査名指定 - 統計表情報でなく、統計調査名の一覧を取得する場合に指
定して下さい。
・Y:統計調査名一覧
統計調査名一覧を出力します。
statsNameList パラメータを省略した場合、又は Y 以外
の値を設定した場合は統計表情報を出力します。
3.3. メタ情報取得
パ ラ メ ー タ
名
意味 必須 設定内容・設定可能値
statsDataId 統計表 ID ○ 「統計表情報取得」で得られる統計表 ID です。
3.4. 統計データ取得
パラメータ名 意味 必
須
設定内容・設定可能値
dataSetId データセット ID 1,2※ △ 「データセット登録」で登録したデータセット ID です。
statsDataId 統計表 ID 1※ △ 「統計表情報取得」で得られる統計表 ID です。
lvTab
絞り込み条件
※2
1,2
表章事項
階層レベル - 以下のいずれかの形式で指定して下さい。 (X は「メ
タ情報取得」で得られる各メタ情報の階層レベル)
・X:指定階層レベルのみで絞り込み
・X-X:指定階層レベルの範囲で絞り込み
・-X:階層レベル 1 から指定階層レベルの範囲で絞
り込み
・X-:指定階層レベルから階層レベル 9 の範囲で絞
り込み
cdTab 単一コード
3※
- 特定の項目コードでの絞り込み
「メタ情報取得」で得られる各メタ情報の項目コード
を指定して下さい。
コードはカンマ区切りで 100 個まで指定可能です。
cdTabFrom コード From
3※
- 項目コードの範囲で絞り込み
絞り込む範囲の開始位置の項目コードを指定して下さ
い。
cdTabTo コード To
3※
- 項目コードの範囲で絞り込み
絞り込む範囲の終了位置の項目コードを指定して下さ
い。
lvTime 時間軸事項
階層レベル - 表章事項の階層レベルと同様です。
cdTime 単一コード - 表章事項の単一コードと同様です。
cdTimeFrom コード From - 表章事項のコード From と同様です。
cdTimeTo コード To - 表章事項のコード To と同様です。
lvArea地域事項
階層レベル - 表章事項の階層レベルと同様です。
cdArea 単一コード - 表章事項の単一コードと同様です。
cdAreaFrom コード From - 表章事項のコード From と同様です。
cdAreaTo コード To - 表章事項のコード To と同様です。
lvCat01分類事項01
階層レベル - 表章事項の階層レベルと同様です。
cdCat01 単一コード - 表章事項の単一コードと同様です。
cdCat01From
コード From - 表章事項のコード From と同様です。
cdCat01To コード To - 表章事項のコード To と同様です。
・・・ 分類事項 02 ~ 15 - 分類事項 01 と同様です。
startPosition データ取得開始位置 - データの取得開始位置(1 から始まる行番号)を指定
して下さい。省略時は先頭から取得します。
統計データを複数回に分けて取得する場合等、継続
データを取得する開始位置を指定するために指定し
ます。
前回受信したデータの<NEXT_KEY>タグの値を指
定します。
limit データ取得件数 - データの取得行数を指定して下さい。省略時は 10万件です。
データ件数が指定した limit 値より少ない場合、全件
を取得します。データ件数が指定した limit 値より多
い場合(継続データが存在する)は、受信したデータ
の<NEXT_KEY>タグに継続データの開始行が設定
されます。
metaGetFlg メタ情報有無 - 統計データと一緒にメタ情報を取得するか否かを以
下のいずれかから指定して下さい。
・Y:取得する (省略値)
・N:取得しない
cntGetFlg 件数取得フラグ - 指 定 し た 場 合 、 件 数 の み 取 得 で き ま
す。metaGetFlg=Y の場合は、メタ情報も同時に返
却されます。
・Y:件数のみ取得する。統計データは取得しない。
・N:件数及び統計データを取得する。(省略値)
callback コールバック関数 △ JSONP 形式のデータ呼出の場合は必須パラメータで
す。
コールバックされる関数名を指定して下さい。
1※ データセット ID 又は 統計表 ID のいずれか一方を必ず指定して下さい。どちらも指定しない場合や両方指
定した場合はエラーとなります。
2※ データセット ID を指定した場合、そのデータセットに登録されている絞り込み条件を元にデータを取得し
ます。データセット ID と絞り込み条件を指定した場合は、データセットに登録されている条件から更に絞
り込むことができます。
3※ 以下の特別なキーワードを指定可能です。
min:最小値
max:最大値
min及びmax はそれぞれ該当事項に属する項目コード値の最小値及び最大値を表します。
単一コードで min 又は max を使用する場合には、カンマ区切りによる複数の項目コード指定はできません。
3.5. データセット登録
パラメータ名 意味 必
須
設定内容・設定可能値
dataSetId データセット ID 1※ △ 30 文字以内の任意の文字列で半角英数字と'-'、'_'、'.'、'@'のみ使用可です。
省略時は「政府統計コード(8 桁)-年月日時分秒(14 桁)-枝番(1 桁)」の形式で自動付与されます。
(「-枝番(1 桁)」の部分はない場合あり)
statsDataId 統計表 ID 1※ △ 「統計表情報取得」で得られる統計表 ID です
lvTab 絞り込み条件
※1,2
1,2表章事項
階層レベル - 以下のいずれかの形式で指定して下さい。 (X は「メタ情
報取得」で得られる各メタ情報の階層レベル)
・X:指定階層レベルのみで絞り込み
・X-X:指定階層レベルの範囲で絞り込み
・-X:階層レベル 1 から指定階層レベルの範囲で絞り込
み
・X-:指定階層レベルから階層レベル 9 の範囲で絞り込
み
cdTab 単一コード
3※
- 特定の項目コードでの絞り込み
「メタ情報取得」で得られる各メタ情報の項目コードを指
定して下さい。
コードはカンマ区切りで 100 個まで指定可能です。
cdTabFrom コ ー ド
From
3※
- 項目コードの範囲で絞り込み
絞り込む範囲の開始位置の項目コードを指定して下さい。
cdTabTo コード To
3※
- 項目コードの範囲で絞り込み
絞り込む範囲の終了位置の項目コードを指定して下さい。
lvTime時間軸事項
階層レベル - 表章事項の階層レベルと同様です。
cdTime 単一コード - 表章事項の単一コードと同様です。
cdTimeFrom
コ ー ド
From- 表章事項のコード From と同様です。
cdTimeTo コード To - 表章事項のコード To と同様です。
lvArea地域事項
階層レベル - 表章事項の階層レベルと同様です。
cdArea 単一コード - 表章事項の単一コードと同様です。
cdAreaFrom
コ ー ド
From- 表章事項のコード From と同様です。
cdAreaTo コード To - 表章事項のコード To と同様です。
lvCat01分類事項01
階層レベル - 表章事項の階層レベルと同様です。
cdCat01 単一コード - 表章事項の単一コードと同様です。
cdCat01From
コ ー ド
From- 表章事項のコード From と同様です。
cdCat01To コード To - 表章事項のコード To と同様です。
・・・ 分 類 事 項 02 ~ - 分類事項 01 と同様です。
15
penSpecified
公開可否 - 登録したデータセットを公開するか否かを指定して下さ
い。
0:公開不可 (他の利用者は参照・利用不可) (省略値)
1:公開可 (他の利用者も参照・利用可)
processMode
処理モード ※1 - 以下のいずれかを指定して下さい。
E:登録・更新(新規データセットの登録又は既存データ
セットの更新) (省略値)
D:削除(既存データセットの削除)
dataSetName
データセット名 - データセットの名称、内容、説明等を指定して下さい。
全角で 256 文字まで指定可能です。
1※ 登録の場合は、処理モードを'E'とした上で統計表 ID と 1 つ以上の絞り込み条件の指定が必須となります。
更新の場合は、処理モードを'E'とした上で統計表 ID とデータセット ID及び 1 つ以上の絞り込み条件の指
定が必須となります。
削除の場合は、処理モードを'D'とした上でデータセット ID が必須となります。
2※ 同一事項に対して階層レベルと項目コードの絞り込み条件を併用した場合は AND 条件となります。単一
コードとコード範囲(From-To)を併用した場合も AND 条件になります。コード範囲(From-To)の指定は
From のみ、To のみの指定も可能です。From のみの場合は指定コード以降すべて、To のみの場合は指定
コード以前すべてが対象となります。
3※ 以下の特別なキーワードを指定可能です。
min:最小値
max:最大値
min及びmax はそれぞれ該当事項に属する項目コード値の最小値及び最大値を表します。
単一コードで min 又は max を使用する場合には、カンマ区切りによる複数の項目コード指定はできません。
3.6. データセット参照
パ ラ メ ー タ
名
意味 必
須
設定内容・設定可能値
dataSetId データセット ID - 「データセット登録」で登録したデータセット ID です。
省略時は 利用可能なデータセットの一覧を取得します。
4. API の出力データ各 API は、XML 形式のデータを返却します (JSON 形式及び JSONP 形式のデータフォーマットを指
定した場合を除く) 。
ルートタグ名やスキーマ名、API毎の出力部のタグ名は API により異なりますが、基本的には以下のように3つのブロックで構成されます。
<?xml version="1.0" encoding="utf-8" standalone="yes"?><GET_STATS_LIST
xsi:noNamespaceSchemaLocation="http://api.e-stat.go.jp/rest/< バ ー ジ ョ ン >/schema/GetStatsList.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><RESULT>
・・・ API の処理結果情報</RESULT><PARAMETER>
・・・ API が受信したパラメータ情報</PARAMETER><DATALIST_INF>
・・・ API毎の出力部<DATALIST_INF>
</GET_STATS_LIST>
4.1. 全 API 共通
4.1.1. RESULT タグすべての API 共通で、以下の要素を出力します。
タグ名 内容
RESULT API の処理結果情報を出力します。
STATUS API の処理結果をコードで表します。
0 ~ 1 の場合は正常終了、100 以上の場合はエラーです。
ERROR_MSG STATUS の値に対応するエラーメッセージです。
DATE この XML データが出力された日時です。
4.1.2. 処理結果コード
RESULT 要素の結果コード(STATUS)とメッセージ(ERROR_MSG)及びHTTP ステータスの一覧を以下に示します。
結果コー
ド
HTTP
ステー
タス
メッセージ 意味統計表情報取得
メタ情報取得
統計デー
タ取得
デー
タセッ
ト登録
デー
タセッ
ト参照
0200
正常に終了しました。 正常終了。○ ○ ○ ○ ○
1200
正常に終了しましたが、該当
データはありませんでした。
正常終了(結果0件:該当デー
タ無し)。○ ○
100
403
認証に失敗しました。ユーザー
ID、パスワードを確認して下さ
い。
認証エラー(アプリケーション
ID に誤りがある)の場合に出力
されます。
○ ○ ○ ○ ○
101
400
{0}を指定して下さい。 必須パラメータが指定されてい
ない場合に出力されます。
{0}にはパラメータ名が出力さ
れます。
○ ○ ○
102
400
{0}の値が正しくありません。 パラメータに指定されている値
が無効値(有効範囲外等)の場
合に出力されます。
{0}にはパラメータ名が出力さ
れます。
○ ○ ○ ○
103
400
{0}の値が長すぎます。{1}バ
イト以内で指定して下さい。
パラメータに指定されている値
の長さが制限値を超えている場
合に出力されます。
{0}にはパラメータ名が出力さ
れます。{1}には制限値が出力
されます。
○
104
400
{0}に使用できる文字は{1}で
す。
パラメータに指定されている値
に許可されていない文字が含ま
れている場合に出力されます。
{0}にはパラメータ名が出力さ
れます。{1}には使用可能な文
字が出力されます。
○
105
400
{0}の値が多すぎます。100 個
以内で指定して下さい。
絞り込み条件で単一コードの指
定制限数を超えて指定した場合
に出力されます。
{0}にはパラメータ名が出力さ
れます。
○ ○
結果コー
ド
HTTP
ステー
タス
メッセージ 意味統計表情報取得
メタ情報取得
統計データ取得
データセッ
ト登録
データセッ
ト参照
200
500
データベース(統計データ)に
アクセス中にエラーが発生しま
した。時間をおいてからやり直
してみて下さい。改善しない場
合は管理者に問い合わせて下さ
い。
データベースアクセス時に発生
する内部エラーです。
○ ○ ○ ○ ○
201
500
データベース(データセット)
にアクセス中にエラーが発生し
ました。時間をおいてからやり
直してみて下さい。改善しない
場合は管理者に問い合わせて下
さい。
データベースアクセス時に発生
する内部エラーです。
○ ○ ○
202
500
データベース(利用者マスタ)
にアクセス中にエラーが発生し
ました。時間をおいてからやり
直してみて下さい。改善しない
場合は管理者に問い合わせて下
さい。
データベースアクセス時に発生
する内部エラーです。
○ ○ ○ ○ ○
203
500
データベース(補完データ)に
アクセス中にエラーが発生しま
した。時間をおいてからやり直
してみて下さい。改善しない場
合は管理者に問い合わせて下さ
い。
データベースアクセス時に発生
する内部エラーです。
○ ○ ○ ○
299
500
予期しないエラーが発生しまし
た。管理者に問い合わせて下さ
い。
処理中に発生する内部エラーで
す。 ○ ○ ○ ○ ○
300
400
{0}=[{1}]のデータは存在し
ません。 ID を確認し て 下 さ
い。
パラメータに指定されている値
のデータが存在しない場合(存
在し な い デ ー タ の 統 計 表 ID等)に出力されます。
{0}にはパラメータ名が出力さ
れます。{1}にはパラメータの
指定値が出力されます。
○ ○ ○ ○
301
200
このデータを更新・削除する権
限がありません。
データセット変更時に、他のア
プ リ ケ ー シ ョ ン ID の デ ー タ
セットを指定した場合に出力さ
れます。
○
302
200
絞り込み条件を適用した結果、
抽出件数が 0 件となるため登録
出来ません。絞り込み条件を見
直して下さい。
データセット登録・更新時に、
絞り込み結果が0件となる場合
に出力されます。 ○
結果コー
ド
HTTP
ステー
タス
メッセージ 意味統計表情報取得
メタ情報取得
統計データ取得
データセッ
ト登録
データセッ
ト参照
303
500
データセット ID の自動付与に
失敗しました。時間をおいてか
らやり直すか、任意のデータ
セット ID を指定して下さい。
データセット登録時に、データ
セット ID の自動生成に失敗し
た場合に出力されます。○
304
200
抽出件数が{0}件を超えるた
め、JSON 形式では取得できま
せん。絞り込み条件を見直す
か、XML 形式で取得してくだ
さい。
JSON及び JSONP 形式の統計
データ取得時に、結果が規定の
件数を超える場合に出力されま
す。
{0}には制限数が出力されま
す。
○
4.2. 統計表情報取得
ルートタグは<GET_STATS_LIST>です。
4.2.1. PARAMETER タグリクエスト時に指定されたパラメータを出力します。パラメータ名を間違えた場合や別の API の
パラメータを指定した場合は出力されません。
タグ名 内容
PARAMETER リクエスト時に指定されたパラメータを出力します。
LANG 言語
SURVEY_YEARS 調査年月
OPEN_YEARS 公開年月
STATS_FIELD 統計分野
STATS_CODE 政府統計コード
SEARCH_WORD 検索キーワード
SEARCH_KIND 検索データ種別
STATS_NAME_LIST 統計調査名一覧指定
4.2.2. DATALIST_INF タグ統計表情報を出力します。エラーがあった場合はこのタグ自体出力されません。
タグ名 内容
DATALIST_INF 統計表情報を出力します。
NUMBER 出力される統計表の件数です。
LIST_INF 統計表の情報を NUMBER の件数分出力します。属性として統計表 ID(id)を保持します。統計調査名一覧指定の場合、id には政府統計コードを保持しま
す。
STAT_NAME 統計表の政府統計名です。属性として政府統計コード(code)を保持します。
GOV_ORG 統計表の作成機関名です。属性として作成機関コード(code)を保持します。
STATISTICS_NAME
統計表の提供統計名及び提供分類名です。
TITLE 統計表の表題です。属性として表番号(no)を保持します。
CYCLE 統計表の提供周期です。
SURVEY_DATE 統計の調査年月です。
OPEN_DATE 統計表の公開日です。
SMALL_AREA 小地域属性のフラグです。
4.2.3. 出力サンプル<?xml version="1.0" encoding="UTF-8" standalone="yes"?><GET_STATS_LIST xsi:noNamespaceSchemaLocation=http://api.e-stat.go.jp/rest/< バ ー ジ ョ ン >/schema/
GetStatsList.xsd xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <RESULT> <STATUS>0</STATUS> <ERROR_MSG>正常に終了しました。</ERROR_MSG> <DATE>2014-10-17T11:42:44.104+09:00</DATE> </RESULT> <PARAMETER> <LANG>J</LANG> <SURVEY_YEARS>201001-201212</SURVEY_YEARS> <STATS_FIELD>03</STATS_FIELD> <STATS_CODE>00200</STATS_CODE> <SEARCH_WORD>就業構造基本調査</SEARCH_WORD> <SEARCH_KIND>1</SEARCH_KIND> </PARAMETER> <DATALIST_INF> <NUMBER>543</NUMBER> <LIST_INF id="0003084821"> <STAT_NAME code="00200532">就業構造基本調査</STAT_NAME> <GOV_ORG code="00200">総務省</GOV_ORG> <STATISTICS_NAME>平成 24 年就業構造基本調査 全国編</STATISTICS_NAME> <TITLE no="00100">男女,就業状態・仕事の主従,就業希望意識・就業希望の有無,求職活動の有無,世帯主との続き柄,一般・単身世帯,配偶関係,年齢別 15歳以上人口</TITLE> <CYCLE>-</CYCLE> <SURVEY_DATE>201210</SURVEY_DATE> <OPEN_DATE>2013-07-12</OPEN_DATE> <SMALL_AREA>0</SMALL_AREA> </LIST_INF> <LIST_INF id="0003084783"> <STAT_NAME code="00200532">就業構造基本調査</STAT_NAME> <GOV_ORG code="00200">総務省</GOV_ORG> <STATISTICS_NAME>平成 24 年就業構造基本調査 全国編</STATISTICS_NAME> <TITLE no="00201">男女,就業状態・仕事の主従,就業希望意識・就業希望の有無,求職活動の有無,
年齢,教育別 15歳以上人口</TITLE> <CYCLE>-</CYCLE> <SURVEY_DATE>201210</SURVEY_DATE> <OPEN_DATE>2013-07-12</OPEN_DATE> <SMALL_AREA>0</SMALL_AREA> </LIST_INF> ・・・ </DATALIST_INF></GET_STATS_LIST>
パラメータに統計調査名一覧指定を指定した場合、以下のように出力されます。
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><GET_STATS_LIST xsi:noNamespaceSchemaLocation=http://api.e-stat.go.jp/rest/ < バ ー ジ ョ ン > /schema/
GetStatsList.xsd xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <RESULT> <STATUS>0</STATUS> <ERROR_MSG>正常に終了しました。</ERROR_MSG> <DATE>2014-10-17T13:47:41.156+09:00</DATE> </RESULT> <PARAMETER> <LANG>J</LANG> <SURVEY_YEARS>201001-201212</SURVEY_YEARS> <STATS_FIELD>03</STATS_FIELD> <SEARCH_KIND>1</SEARCH_KIND> <STATS_NAME_LIST>Y</STATS_NAME_LIST> </PARAMETER> <DATALIST_INF> <NUMBER>3</NUMBER>
<LIST_INF id="00200531"> <STAT_NAME code="00200531">労働力調査</STAT_NAME> <GOV_ORG code="00200">総務省</GOV_ORG> </LIST_INF> <LIST_INF id="00200532"> <STAT_NAME code="00200532">就業構造基本調査</STAT_NAME> <GOV_ORG code="00200">総務省</GOV_ORG> </LIST_INF> <LIST_INF id="00450091"> <STAT_NAME code="00450091">賃金構造基本統計調査</STAT_NAME> <GOV_ORG code="00450">厚生労働省</GOV_ORG> </LIST_INF> </DATALIST_INF></GET_STATS_LIST>
4.3. メタ情報取得
ルートタグは<GET_META_INFO>です。
4.3.1. PARAMETER タグリクエスト時に指定されたパラメータを出力します。パラメータ名を間違えた場合や別の API の
パラメータを指定した場合は出力されません。
タグ名 内容
PARAMETER リクエスト時に指定されたパラメータを出力します。
LANG 言語
STATS_DATA_ID 統計表 ID
4.3.2. METADATA_INF タグメタ情報を出力します。エラーがあった場合はこのタグ自体出力されません。
タグ名 内容
METADATA_INF メタ情報を出力します。
TABLE_INF 指定した統計表の情報を出力します。属性として統計表 ID(id)を保持しま
す。
STAT_NAME 統計表の政府統計名です。属性として政府統計コード(code)を保持します。
GOV_ORG 統計表の作成機関名です。属性として作成機関コード(code)を保持します。
STATISTICS_NAME
統計表の提供統計名及び提供分類名です。
TITLE 表統計表の題です。属性として表番号(no)を保持します。
SURVEY_DATE 統計の調査年月です。
CLASS_INF 統計データのメタ情報を出力します。
CLASS_OBJ メタ情報の数分だけ出力します。属性としてメタ情報の ID(id)、名称
(name)及び解説(description)を保持します。解説はデータがある場合のみ
出力されます。
CLASS メタ情報を構成する要素の数分だけ出力します。属性としてメタ情報要素の
コード(code)、名称(name)、階層レベル(level)、単位(unit)及び追加情報
(addInf)を保持します。単位及び追加情報はデータがある場合のみ出力され
ます。
4.3.3. 出力サンプル<?xml version="1.0" encoding="UTF-8" standalone="yes"?><GET_META_INFO xsi:noNamespaceSchemaLocation=http://api.e-stat.go.jp/rest/ < バ ー ジ ョ ン > /schema/
GetMetaInfo.xsd xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <RESULT> <STATUS>0</STATUS> <ERROR_MSG>正常に終了しました。</ERROR_MSG> <DATE>2014-10-17T14:10:40.550+09:00</DATE> </RESULT> <PARAMETER> <LANG>J</LANG> <STATS_DATA_ID>0003090287</STATS_DATA_ID> </PARAMETER> <METADATA_INF> <TABLE_INF id="0003090287"> <STAT_NAME code="00200532">就業構造基本調査</STAT_NAME> <GOV_ORG code="00200">総務省</GOV_ORG> <STATISTICS_NAME>平成 24 年就業構造基本調査 地域別主要結果編(全国,都道府県,県庁所在都市,人口 30万以上の市,県内経済圏) 世帯単位で見た統計表</STATISTICS_NAME> <TITLE no="410101">世帯の家族類型,夫と妻の就業状態・有業の親の有無別世帯数-全国,都道府県</TITLE> <SURVEY_DATE>201210</SURVEY_DATE> </TABLE_INF> <CLASS_INF> <CLASS_OBJ id="tab" name="表章項目"> <CLASS code="006" name="世帯数" level="" unit="世帯"/> </CLASS_OBJ> <CLASS_OBJ id="cat01" name="世帯家族類型,夫妻の就業状態・有業の親有無-2012"> <CLASS code="000" name="総数" level="1"/> <CLASS code="001" name="夫婦のみの世帯" level="2"/> <CLASS code="002" name="夫婦ともに有業" level="3"/> ・・・ </CLASS_OBJ> <CLASS_OBJ id="area" name="地域 2012"> <CLASS code="00000" name="全国" level="1"/> <CLASS code="01000" name="北海道" level="2"/> <CLASS code="02000" name="青森県" level="2"/> </CLASS_OBJ> <CLASS_OBJ id="time" name="時間軸(年次)"> <CLASS code="2012000000" name="2012 年" level="1"/> ・・・ </CLASS_OBJ> </CLASS_INF> </METADATA_INF></GET_META_INFO>
4.4. 統計データ取得
ルートタグは<GET_STATS_DATA>です。
4.4.1. PARAMETER タグリクエスト時に指定されたパラメータを出力します。パラメータ名を間違えた場合や別の API の
パラメータを指定した場合は出力されません。
タグ名 内容
PARAMETER リクエスト時に指定されたパラメータを出力します。
LANG 言語
DATASET_ID データセット ID
STATS_DATA_ID 統計表 ID
NARROWING_COND
「
」の絞り込み条件と同様です。
「
」の絞り込み条件を参照して下さい。
DATA_FORMAT データフォーマット
「X」:XML 形式
「J」:JSON 形式又は JSONP 形式
START_POSITION データ出力開始位置
LIMIT 取得データ件数
METAGET_FLG メタ情報出力有無
CNT_GET_FLG 件数取得フラグ
CALLBACK JSONP コールバック関数(JSONP の場合のみ)
4.4.2. STATISTICAL_DATA タグ統計データの情報を出力します。エラーがあった場合はこのタグ自体出力されません。
タグ名 内容
STATISTICAL_DATA 統計データの情報を出力します。
TABLE_INF 指定した統計表又は指定したデータセットが指し示す統計データの情報を出
力します。属性として統計表 ID(id)を保持します。
STAT_NAME 統計表の政府統計名です。属性として政府統計コード(code)を保持します。
GOV_ORG 統計表の作成機関名です。属性として作成機関コード(code)を保持します。
STATISTICS_NAME
統計表の提供統計名及び提供分類名です。
TITLE 統計表の表題です。属性として表番号(no)を保持します。
SURVEY_DATE 統計の調査年月です。
TOTAL_NUMBER 指定した絞り込み条件又はデータセットの条件又はその両方の条件で出力される統計データの総件数です。
FROM_NUMBER <TOTAL_NUMBER>の件数のうち<DATA_INF>に出力されるデータの開
始位置です。
TO_NUMBER <TOTAL_NUMBER>の件数のうち<DATA_INF>に出力されるデータの終
了位置です。
NEXT_KEY 要求した統計データが一度に取得できなかった際、継続データの要求に使用するためのコードです。全データを返却できた場合、このタグは出力されません。継続データを要求する場合、リクエストパラメータのデータ取得開始位置 (startPosition) にこのタグの値を指定します。
CLASS_INF 統計データのメタ情報を出力します。リクエストパラメータのメタ情報有無(metaGetFlg)に"N"(取得しない)を指定した場合、このタグは出力されません。
CLASS_OBJ メタ情報の数分だけ出力します。属性としてメタ情報の ID(id)、名称(name)及び解説(description)を保持します。解説はデータがある場合のみ出力されます。
CLASS メタ情報を構成する要素の数分だけ出力します。属性としてメタ情報要素のコード(code)、名称(name)、階層レベル(level)、単位(unit)及び追加情報(addInf)を保持します。単位及び追加情報はデータがある場合のみ出力されます。指定した絞り込み条件又はデータセットの条件又はその両方の条件によって抽出されるメタ情報のみ出力されます。
DATA_INF 統計データの数値情報を出力します。指定した絞り込み条件又はデータセットの条件又はその両方の条件によって抽出されるデータ件数が 0 の場合、このタグは出力されません。
また、件数取得フラグ(cntGetFlg)に"Y"(件数のみ取得する)を指定した場合も出力されません。
NOTE 特殊文字の凡例です。特殊文字の数分だけ出力されます。属性として特殊文字(char)を保持します。
VALUE 統計数値(セル)の情報です。データ件数分だけ出力されます。属性として表章事項コード(tab)、分類事項コード(cat01 ~ cat15)、地域事項コード(area)、時間軸事項コード(time)、単位(unit)を保持します。全ての属性はデータがある場合のみ出力されます。
4.4.3. 出力サンプル<?xml version="1.0" encoding="UTF-8" standalone="yes"?><GET_STATS_DATA xsi:noNamespaceSchemaLocation=http://api.e-stat.go.jp/rest/ < バ ー ジ ョ ン >/schema/
GetStatsData.xsd xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <RESULT> <STATUS>0</STATUS> <ERROR_MSG>正常に終了しました。</ERROR_MSG> <DATE>2014-10-17T14:38:48.066+09:00</DATE> </RESULT> <PARAMETER> <LANG>J</LANG> <STATS_DATA_ID>0003090287</STATS_DATA_ID> <DATA_FORMAT>X</DATA_FORMAT> <START_POSITION>1</START_POSITION> <METAGET_FLG>Y</METAGET_FLG> <CNT_GET_FLG>N</CNT_GET_FLG> </PARAMETER> <STATISTICAL_DATA> <TABLE_INF id="0003090287"> <STAT_NAME code="00200532">就業構造基本調査</STAT_NAME> <GOV_ORG code="00200">総務省</GOV_ORG> <STATISTICS_NAME>平成 24 年就業構造基本調査 地域別主要結果編(全国,都道府県,県庁所在都市,人口 30万以上の市,県内経済圏) 世帯単位で見た統計表</STATISTICS_NAME> <TITLE no="410101">世帯の家族類型,夫と妻の就業状態・有業の親の有無別世帯数-全国,都道府県</TITLE> <SURVEY_DATE>201210</SURVEY_DATE> <TOTAL_NUMBER>1392</TOTAL_NUMBER> <FROM_NUMBER>1</FROM_NUMBER> <TO_NUMBER>1392</TO_NUMBER> </TABLE_INF> <CLASS_INF> <CLASS_OBJ id="tab" name="表章項目"> <CLASS code="006" name="世帯数" level="" unit="世帯"/> </CLASS_OBJ> <CLASS_OBJ id="cat01" name="世帯家族類型,夫妻の就業状態・有業の親有無-2012"> <CLASS code="000" name="総数" level="1"/> <CLASS code="001" name="夫婦のみの世帯" level="2"/> <CLASS code="002" name="夫婦ともに有業" level="3"/> ・・・ </CLASS_OBJ> <CLASS_OBJ id="area" name="地域 2012"> <CLASS code="00000" name="全国" level="1"/> <CLASS code="01000" name="北海道" level="2"/> <CLASS code="02000" name="青森県" level="2"/> ・・・ </CLASS_OBJ> <CLASS_OBJ id="time" name="時間軸(年次)"> <CLASS code="2012000000" name="2012 年" level="1"/> </CLASS_OBJ> </CLASS_INF>
【表章事項】
【分類事項 01】
【地域事項】
【時間軸事項】
<DATA_INF> <NOTE char="*">平均値及び割合の算出に当たって除数が表章単位に満たないもの</NOTE> <NOTE char="-">該当数値のないもの,又は平均値及び割合の算出に当たって除数が0のも
の</NOTE> <NOTE char="...">平均値及び割合の算出に当たって除数が表章単位に満たないもの,または増減率及び構成比の算出に当たって除数が1万人未満の場合</NOTE> <NOTE char="X">数字が秘匿されているもの</NOTE> <VALUE tab="006" cat01="000" area="00000" time="2012000000" unit=" 世帯">28547900</VALUE>
<VALUE tab="006" cat01="000" area="01000" time="2012000000" unit=" 世帯">1289100</VALUE>
<VALUE tab="006" cat01="000" area="02000" time="2012000000" unit=" 世帯">278500</VALUE>
<VALUE tab="006" cat01="000" area="03000" time="2012000000" unit=" 世帯">263800</VALUE>
・・・ </DATA_INF> </STATISTICAL_DATA></GET_STATS_DATA>
cntGetFlg=Y、metaGetFlg=N を指定した場合(件数のみ取得し、メタ情報を取得しない)の出力は以下になります。
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><GET_STATS_DATA xsi:noNamespaceSchemaLocation="http://api.e-stat.go.jp/rest/< バ ー ジ ョ ン >/schema/GetStatsData.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <RESULT> <STATUS>0</STATUS> <ERROR_MSG>正常に終了しました。</ERROR_MSG> <DATE>2014-10-20T14:13:10.916+09:00</DATE> </RESULT> <PARAMETER> <LANG>J</LANG> <STATS_DATA_ID>0003090287</STATS_DATA_ID> <DATA_FORMAT>X</DATA_FORMAT> <START_POSITION>1</START_POSITION> <METAGET_FLG>N</METAGET_FLG> <CNT_GET_FLG>Y</CNT_GET_FLG> </PARAMETER> <STATISTICAL_DATA> <TABLE_INF> <TOTAL_NUMBER>1392</TOTAL_NUMBER> </TABLE_INF> </STATISTICAL_DATA></GET_STATS_DATA>
【表章事項】
【分類事項 01】
【地域事項】 【時間軸事項】
4.4.4. JSON 形式での出力
以下の URL を指定することで、JSON 形式のデータを取得することができます。
パラメータは XML 形式の場合と同様です。
リ ク エ ス トURL
http(s)://api.e-stat.go.jp/rest/<バージョン>/app/json/getStatsData?<パラメータ群>
HTTP メ ソ ッド GET
JSON 形式のデータは XML 形式のデータを元に次の変換表に従い変換され、さらに全体が中括弧 { } で囲まれます。
XML 形式 JSON 形式
基本的な変換 <親要素名> <子要素名1>文字型値</子要素名1> <子要素名2>数値</子要素名2></親要素名>
"親要素名":{"子要素名1":"文字型値","子要素名2":数値
}
属性がある場合 <要素名 属性名="属性値">要素値
</要素名>
"要素名":{"@属性名":"属性値","$":"要素値"
}同名タグがある場合
<要素名>要素値1</要素名><要素名>要素値2</要素名>・・・
"要素名":[{"$":"要素値1"},
{"$":"要素値2"}, ・・・]
4.4.5. 出力サンプル (JSON){ "GET_STATS_DATA": { "RESULT": { "STATUS": 0, "ERROR_MSG": "正常に終了しました。", "DATE": "2014-10-20T17:18:56.488+09:00" }, "PARAMETER": { "LANG": "J", "STATS_DATA_ID": "0003014477", "DATA_FORMAT": "J", "START_POSITION": 1, "METAGET_FLG": "Y", "CNT_GET_FLG": "N" }, "STATISTICAL_DATA": { "TABLE_INF": { "@id": "0003014477", "STAT_NAME": {"@code": "00550020","$": "商業統計調査"}, "GOV_ORG": {"@code": "00550","$": "経済産業省"}, "STATISTICS_NAME": "商業統計調査 統計表一覧 平成 19 年商業統計 速報", "TITLE": {"@no": "1-03","$": "データ(平成 20 年 4 月 3 日公表) 都道府県別、東京特別区・政令指定都市別、産業分類小分類別の事業所数、従業者数、年間商品販売額、商品手持額及び売場面積" }, "SURVEY_DATE": "200701-200712", "TOTAL_NUMBER": 17688, "FROM_NUMBER": 1, "TO_NUMBER": 17688 }, "CLASS_INF": { "CLASS_OBJ": [ { "@id": "cat01", "@name": "速報・集計項目", "CLASS": [ {"@code": "020000000","@name": "事業所数","@level": "1"}, {"@code": "030020000","@name": "従業者数 (人)", "@level": "2"}, ・・・ ] }, ・・・ { "@id": "area", "@name": "都道府県及び東京特別区・政令指定都市", "CLASS": [ {"@code": "00000","@name": "全国","@level": "1"}, {"@code": "01000","@name": "北海道","@level": "2"}, ・・・ ] } ] },
<RESULT> <STATUS>0</STATUS> <ERROR_MSG>正常に 終 了 し ま し た 。
</ERROR_MSG><DATE>2014-10-20T17:19:43.104+09:00</DATE></RESULT>上記 XML から 基本的な変換方式に従って変換
<STAT_NAME code="00550020"> 商 業 統 計 調査</STAT_NAME>
<CLASS code="00000" name="全国" level="1"/><CLASS code="01000" name="北海道" level="2"/>・・・
"DATA_INF": { "NOTE": [ { "@char": "-", "$": "皆無または定義上該当数字がないもの" }, { "@char": "X", "$": "数値が秘匿されているもの" } ], "VALUE": [ {"@cat01": "020000000","@cat02": "0","@area": "00000","$": "1470995"}, {"@cat01":"020000000","@cat02":"0","@area":"01000","$":"58217"}, {"@cat01":"020000000","@cat02":"0","@area":"02000","$":"18672"}, ・・・ ] } } }}
4.4.6. JSONP 形式での出力
以下の URL を指定することで、JSONP 形式のデータを取得することができます。
パラメータは XML 形式の場合と同様です。
リ ク エ ス トURL
http(s)://api.e-stat.go.jp/rest/< バ ー ジ ョ ン >/app/jsonp/getStatsData?<パラメータ群>
HTTP メ ソ ッド GET
JSONP 形式でデータを取得する場合、コールバックパラメータ(callback)は必須となります。
コールバック関数に渡される JSON 形式のデータは『4.4.4 JSON 形式での出力』に準じます。
4.5. データセット登録
ルートタグは<POST_DATASET>です。
4.5.1. PARAMETER タグリクエスト時に指定されたパラメータを出力します。パラメータ名を間違えた場合や別の API の
パラメータを指定した場合は出力されません。
タグ名 内容
PARAMETER リクエスト時に指定されたパラメータを出力します。
LANG 言語
DATASET_ID データセット ID
DATASET_NAME データセット名
STATS_DATA_ID 統計表 ID
NARROWING_COND
絞り込み条件
LEVEL_TAB_COND
表章事項のレベル指定
CODE_TAB_SELECT
表章事項の単一コード指定
CODE_TAB_FROM
表章事項のコードの範囲(開始)指定
CODE_TAB_TO 表章事項のコードの範囲(終了)指定
LEVEL_TIME_COND
時間軸事項のレベル指定
CODE_TIME_SELECT
時間軸事項の単一コード指定
CODE_TIME_FROM
時間軸事項のコードの範囲(開始)指定
CODE_TIME_TO 時間軸事項のコードの範囲(終了)指定
LEVEL_AREA_COND
地域事項のレベル指定
CODE_AREA_SELECT
地域事項の単一コード指定
CODE_AREA_FROM
地域事項のコードの範囲(開始)指定
CODE_AREA_TO 地域事項のコードの範囲(終了)指定
LEVEL_CAT01_COND
分類事項 01 のレベル指定
CODE_CAT01_SELECT
分類事項 01 の単一コード指定
CODE_CAT01_FROM
分類事項 01 のコードの範囲(開始)指定
CODE_CAT01_TO 分類事項 01 のコードの範囲(終了)指定
・・・ ※ 分類事項は 01 から 15 まで
OPEN_SPECIFIED 公開可否
PROCESS_MODE 処理モード
4.5.2. REGIST_INF タグ登録又は削除したデータセットの情報を出力します。エラーがあった場合はこのタグ自体出力さ
れません。
タグ名 内容
REGIST_INF 登録又は削除したデータセットの情報を出力します。属性として処理モード
(mode) を保持します。(処理モードは "add"、"update"、"delete" のい
ずれか)
DATASET_ID データセットのデータセット ID です。
STATS_DATA_ID データセットが指定する統計表 ID です。
PUBLIC_STATE データセットの公開可否状態です。
CELLS_NUM データセットの条件で出力される統計データの件数です。
4.5.3. 出力サンプル<?xml version="1.0" encoding="utf-8" standalone="yes"?><POST_DATASET xsi:noNamespaceSchemaLocation=http://api.e-stat.go.jp/rest/ < バ ー ジ ョ ン > /schema/
PostDataSet.xsd xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <RESULT> <STATUS>0</STATUS> <ERROR_MSG>正常に終了しました。</ERROR_MSG> <DATE>2014-10-20T15:18:46.115+09:00</DATE> </RESULT> <PARAMETER> <LANG>J</LANG> <STATS_DATA_ID>0003010900</STATS_DATA_ID> <DATASET_NAME>住宅・土地統計調査 データセット1</DATASET_NAME> <NARROWING_COND> <CODE_CAT01_FROM>01</CODE_CAT01_FROM> <CODE_CAT01_TO>02</CODE_CAT01_TO> <CODE_CAT02_SELECT>03</CODE_CAT02_SELECT> <LEVEL_AREA_COND>1</LEVEL_AREA_COND> </NARROWING_COND> <OPEN_SPECIFIED>1</OPEN_SPECIFIED> <PROCESS_MODE>E</PROCESS_MODE> </PARAMETER> <REGIST_INF mode="add"> <DATASET_ID>00200522-20141020151846</DATASET_ID> <STATS_DATA_ID>0003010900</STATS_DATA_ID> <PUBLIC_STATE>yes</PUBLIC_STATE> <CELLS_NUM>2</CELLS_NUM> </REGIST_INF></POST_DATASET>
4.6. データセット参照
ルートタグは、参照するデータがデータセット一覧の場合は<GET_DATASET_LIST>、データセット情報の場合は<REF_DATASET>です。
4.6.1. PARAMETER タグリクエスト時に指定されたパラメータを出力します。パラメータ名を間違えた場合や別の API の
パラメータを指定した場合は出力されません。
タグ名 内容
PARAMETER リクエスト時に指定されたパラメータを出力します。
LANG 言語
DATASET_ID データセット ID(データセット ID を指定した場合のみ)
4.6.2. DATASET_LIST_INF タグ利用者が参照・使用できるデータセットの一覧を出力します。エラーがあった場合、又はデータ
セット情報の場合はこのタグ自体出力されません。
タグ名 内容
DATASET_LIST_INF データセット一覧を出力します。
NUMBER 一覧に出力されるデータセットの件数です。
LIST_INF データセットの情報を NUMBER の件数分出力します。属性としてデータ
セット ID(id) を保持します。
DATASET_NAME データセット名です。
STATS_DATA_ID データセットが指定する統計表 ID です。
STAT_NAME データセットが指定する統計表の政府統計名です。属性として政府統計コー
ド(code)を保持します。
GOV_ORG データセットが指定する統計表の作成機関名です。属性として作成機関コー
ド(code)を保持します。
STATISTICS_NAME
データセットが指定する統計表の提供統計名及び提供分類名です。
TITLE データセットが指定する統計表の表題です。属性として表番号(no)を保持し
ます。
PUBLIC_STATE データセットの公開可否状態です。
CELLS_NUM データセットの条件で出力される統計データの件数です。
4.6.3. 出力サンプル<?xml version="1.0" encoding="UTF-8" standalone="yes"?><GET_DATASET_LIST xsi:noNamespaceSchemaLocation=http://api.e-stat.go.jp/rest/ < バ ー ジ ョ ン > /schema/
GetDataSetList.xsd xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <RESULT> <STATUS>0</STATUS> <ERROR_MSG>正常に終了しました。</ERROR_MSG> <DATE>2014-10-20T16:08:21.935+09:00</DATE> </RESULT> <PARAMETER> <LANG>J</LANG> </PARAMETER> <DATASET_LIST_INF> <NUMBER>11</NUMBER> <LIST_INF id="00200522-20141020151846"> <DATASET_NAME>住宅・土地統計調査 データセット1</DATASET_NAME> <STATS_DATA_ID>0003010900</STATS_DATA_ID> <STAT_NAME code="00200522">住宅・土地統計調査</STAT_NAME> <GOV_ORG code="00200">総務省</GOV_ORG> <STATISTICS_NAME>平成 20 年住宅・土地統計調査 全国編</STATISTICS_NAME> <TITLE no="001-2">居住世帯の有無(9 区分)別住宅数及び建物の種類(4 区分)別住宅以外で人が居住
する建物数―全国,人口集中地区</TITLE> <PUBLIC_STATE>YES</PUBLIC_STATE> <CELLS_NUM>2</CELLS_NUM> </LIST_INF> <LIST_INF id="CTCdemo-kokusei1"> <STATS_DATA_ID>0003038586</STATS_DATA_ID> <STAT_NAME code="00200521">国勢調査</STAT_NAME> <GOV_ORG code="00200">総務省</GOV_ORG> <STATISTICS_NAME>平成 22 年国勢調査 人口等基本集計(男女・年齢・配偶関係,世帯の構成,住居の状態など)</STATISTICS_NAME> <TITLE no="00100">人口,人口増減,面積及び人口密度 全国,市部・郡部,都道府県,市部・郡
部,支庁,郡計,市区町村・旧市町村,全域・人口集中地区</TITLE> <PUBLIC_STATE>YES</PUBLIC_STATE> <CELLS_NUM>14382</CELLS_NUM> </LIST_INF> ・・・ </DATASET_LIST_INF></GET_DATASET_LIST>
4.6.4. DATASET_INF タグデータセットの情報を出力します。エラーがあった場合、又はデータセット一覧の場合はこのタグ自体出力されません。
タグ名 内容
DATASET_INF データセットの情報を出力します。属性としてデータセット ID(id)を保持し
ます。
DATASET_NAME データセット名です。
STATS_DATA_ID 対象のデータセットで指定されている統計表 ID です。
NARROWING_COND
対象のデータセットで指定されている絞り込み条件です。
LEVEL_TAB_COND
表章事項のレベル指定
CODE_TAB_SELECT
表章事項の単一コード指定
CODE_TAB_FROM
表章事項のコードの範囲(開始)指定
CODE_TAB_TO 表章事項のコードの範囲(終了)指定
LEVEL_TIME_COND
時間軸事項のレベル指定
CODE_TIME_SELECT
時間軸事項の単一コード指定
CODE_TIME_FROM
時間軸事項のコードの範囲(開始)指定
CODE_TIME_TO 時間軸事項のコードの範囲(終了)指定
LEVEL_AREA_COND
地域事項のレベル指定
CODE_AREA_SELECT
地域事項の単一コード指定
CODE_AREA_FROM
地域事項のコードの範囲(開始)指定
CODE_AREA_TO 地域事項のコードの範囲(終了)指定
LEVEL_CAT01_COND
分類事項 01 のレベル指定
CODE_CAT01_SELECT
分類事項 01 の単一コード指定
CODE_CAT01_FROM
分類事項 01 のコードの範囲(開始)指定
CODE_CAT01_TO 分類事項 01 のコードの範囲(終了)指定
・・・ ※ 分類事項は 01 から 15 まで
STAT_NAME 統計表の政府統計名です。属性として政府統計コード(code)を保持します。
STATISTICS_NAME 統計表の提供統計名及び提供分類名です。
TITLE 統計表の表題です。属性として表番号(no)を保持します。
PUBLIC_STATE データセットの公開可否状態です。
CELLS_NUM データセットの条件で出力される統計表の件数です。
4.6.5. 出力サンプル<?xml version="1.0" encoding="UTF-8" standalone="yes"?><REF_DATASET xsi:noNamespaceSchemaLocation=http://api.e-stat.go.jp/rest/ < バ ー ジ ョ ン > /schema/
RefDataSet.xsd xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <RESULT> <STATUS>0</STATUS> <ERROR_MSG>正常に終了しました。</ERROR_MSG> <DATE>2014-10-20T16:31:06.520+09:00</DATE> </RESULT> <PARAMETER> <LANG>J</LANG> <DATASET_ID>JYUCHO_DATASET03</DATASET_ID> </PARAMETER> <DATASET_INF id="JYUCHO_DATASET03"> <DATASET_NAME>住宅・土地統計調査データセット3</DATASET_NAME> <STATS_DATA_ID>0003010900</STATS_DATA_ID> <NARROWING_COND> <CODE_CAT01_SELECT>01</CODE_CAT01_SELECT> </NARROWING_COND> <STAT_NAME code="00200522">住宅・土地統計調査</STAT_NAME> <STATISTICS_NAME>平成 20 年住宅・土地統計調査 全国編</STATISTICS_NAME> <TITLE no="001-2">居住世帯の有無(9 区分)別住宅数及び建物の種類(4 区分)別住宅以外で人が居住す
る建物数―全国,人口集中地区</TITLE> <PUBLIC_STATE>NO</PUBLIC_STATE> <CELLS_NUM>50</CELLS_NUM> </DATASET_INF></REF_DATASET>