Skip to main content

Schema weather-river-flood v1.0.0

XMLをJSON化したデータのスキーマ情報を提供しています。

対象とするXML電文#

共通ヘッダ#

共通ヘッダはこちら

本文#

body フィールド内の定義となります。

"河川"と"指定河川"は区別して取り扱います。

階層フィールド出現条件説明
1.?notice情報によるString
お知らせを記載する
2.targetString
電文が対象とする指定河川と情報種別を記載する 2. target
3.mainTextsArray<Object>
主文について記載する 3. mainText
4.?supposition情報によるObject
浸水想定地区または氾濫発生情報について記載する 4. supposition
5.rainfallObject
雨量情報について記載する 5. rainfall
6.waterInfoObject
水位・流量及びレベルの観測と予測について記載する 6. waterInfo
7.floodedWatersArray<Object>
氾濫水について記載する 7. floodedWater
8.officesArray<Object>
共同発表した官署について記載する 8. office
9.referenceArray<Object>
水位観測所の受け持ち区間と基準の諸要素について記載する 9. reference

2. target#

この電文が対象とする指定河川を記載します。

階層フィールド出現条件説明
2._1.codeString<Integer>
指定河川コード
2._2.nameString
指定河川名
2._3._1.codeString<Integer>
指定河川洪水予報の種別コード
2._3._2.nameString
指定河川洪水予報の種別名
2._3._3.conditionString
洪水予報の種類

指定河川洪水予報の種別コードと洪水予報の種類の関係#

NameCodeCondition
氾濫注意情報解除10洪水注意報解除
氾濫注意情報20洪水注意報(発表)
氾濫注意情報21洪水注意報
氾濫注意情報(警戒情報解除)22洪水注意報(警報解除)
氾濫警戒情報30洪水警報(発表)
氾濫警戒情報31洪水警報
氾濫危険情報40洪水警報(発表)
氾濫危険情報41洪水警報
氾濫発生情報51洪水警報
氾濫発生情報(氾濫水の予報)53洪水警報

3. mainText#

主文について記載します。

階層フィールド出現条件説明
3._1.textString|Null
主文をテキスト形式で記述する、省略する際はNullとする
3._2.riversString<Object>
対象とする河川
3._2._1.codeString<Integer>
河川コード
3._2._2.nameString
河川名
3._3.stationsString<Object>
対象とする河川の水位・流量観測所、要素が0の場合がある
3._3._1.codeString<Integer>
観測所コード
3._3._2.nameString
観測所名
3._3._3.locationString
観測所の大まかな位置を記載する

4. supposition#

浸水想定地区又は氾濫発生情報について記載します。

階層フィールド出現条件説明
4._1.typeString
浸水想定又は氾濫発生についての情報種別を示す
取りうる値は、浸水想定地区浸水想定地区(氾濫発生情報)
4._2.descriptionString
浸水想定地区に対する説明を記載する
4._3.kindObject
浸水想定又は氾濫発生についての情報種別を示す
4._3._1.codeString<Integer>
浸水想定又は氾濫発生についての情報種別コード
取りうる値は、12
4._3._1.nameString
浸水想定又は氾濫発生についての情報種別名
取りうる値は、フィールド type と同じで、浸水想定地区浸水想定地区(氾濫発生情報)
4._4.districtsObject
対象となる観測所又は地域・地区を記載する
浸水想定地区の場合は観測点を、浸水想定地区(氾濫発生情報)の場合は地域・地区を記載する
4._4._1.?code観測点の場合に出現String<Integer>
観測所コード
4._4._2.nameString
観測所名又は地域・地区名
4._4._3.prefectureObject
観測所名又は地域・地区が所在する都道府県
4._4._3._1.codeString<Integer>
都道府県コード
4._4._3._2.nameString
都道府県名
4._4._4.cityObject
観測所名又は地域・地区が所在する市町村
4._4._4._1.codeString<Integer>
市町村コード
4._4._4._2.nameString
市町村名
4._4._5.districtString
対象となる地域・地区の名称

5. rainfall#

流域雨量情報について記載します。

階層フィールド出現条件説明
4._1.dateTimeISO8601
予報・観測の基点時刻
4._2.textString
雨量の予報・観測文を記載
4._3.timeSeriesArray<Object>
雨量の時系列情報、時系列の定義の数だけ出現する
4._3._1.timeDefinesArray<Object>
全ての予想期間を示すとともに、対応する要素の個々の時刻定義を記載する
4._3._1._1.timeIdString<Integer>
時刻ID
4._3._1._2.dateTimeISO8601
予想する基準日時
4._3._1._3.durationString
基準日時からの予想時間の幅を、 ISO8601 の Time intervals 形式で表す
4._3._1._4.nameString
時刻定義の内容
4._3._2.itemsArray<Object>
予想の時系列等の内容と対象河川を記載する
4._3._2._1.nameString
対象河川名
4._3._2._2.forecastsArray<Object>
量的予想・観測情報を記載する
4._3._2._2._1.refIdString
対応する時刻ID
4._3._2._2._2.unitString
量的予想・観測情報の単位
4._3._2._2._3.valueString<Float>|Null
量的予想・観測情報の値

6. waterInfo#

水位・流量及びレベルの観測と予測について記載します。

階層フィールド出現条件説明
6._1.timeSeriesArray<Object>
水位・流量及びレベルの時系列情報、時系列の定義の数だけ出現する
6._1._1.timeDefinesArray<Object>
全ての予想期間を示すとともに、対応する要素の個々の時刻定義を記載する
6._1._1._1.timeIdString<Integer>
時刻ID
6._1._1._2.dateTimeISO8601
予想する基準日時
6._1._1._3.durationString
基準日時からの予想時間の幅を、 ISO8601 の Time intervals 形式で表す
6._1._1._4.nameString
時刻定義の内容
6._1._2.itemsArray<Object>
観測と予測の時系列等の内容と対象河川を記載する
6._1._2._1.codeString
水位・流量観測所コード
6._1._2._2.nameString
水位・流量観測所名
6._1._2._3.locationString
水位・流量観測所の大まかな位置
6._1._2._4.typeString
観測所の種類
取りうる値は、水位流量
6._1._2._5.forecastsArray<Object>
量的予想・観測情報を記載する
6._1._2._5._1.refIdString
対応する時刻ID
6._1._2._5._2.unitString
量的予想・観測情報の単位
6._1._2._5._3.valueString<Float>|Null
量的予想・観測情報の値
6._1._2._5._4.levelString<Integer>|Null
量的予想・観測情報のレベル、値は1234Nullとする
計画高水位・計画高水量時はレベル4となる
6._1._2._5._5.conditionString
流量実況変化傾向や実況・予測値の状況を記載

7. floodedWater#

氾濫水について記載します。

階層フィールド出現条件説明
7._1.codeString<Integer>
河川コード
7._2.nameString
河川名
7._3.dateTimeISO8601
予報の基点時刻
7._4.textString
氾濫水の予報に対する説明文を記載
7._5.assumptionsArray<Object>
浸水区域、氾濫水到達時刻、氾濫水最深時刻、想定最大浸水深について記載します
7._5._1.districtString
浸水区域
7._5._2.attainmentTimeObject
氾濫水到達時刻
7._5._2._1.valueISO8601Time
日時
7._5._2._2.dubiousString
日時のあいまいさを示すため、を固定値として記載する
7._5._3.attainmentTimeObject
氾濫水最深時刻
7._5._3._1.valueISO8601Time
日時
7._5._3._2.dubiousString
日時のあいまいさを示すため、を固定値として記載する
7._5._4.floodDepthObject
想定最大浸水深
7._5._4._1.fromString<Float>|Null
想定浸水深の下限
7._5._4._2.toString<Float>|Null
想定浸水深の上限

8. office#

共同発表した官署について記載します。

階層フィールド出現条件説明
8._1.typeString
官署種別
取りうる値は、水位関係気象関係
8._2.codeString<Integer>
官署コード
8._3.nameString
官署名
8._4.contactString
官署の連絡先
8._5.urlString
参考となるURL

9. reference#

水位・流量観測所の受け持ち区間と基準の諸要素について記載します。

階層フィールド出現条件説明
9._1.codeString<Integer>
観測所コード
9._2.nameString
観測所名
9._3.locationString
観測所の大まかな位置を記載する
9._4.districtString
浸水想定地域・地区
9._5.sectionArray<String>
水位・流量観測所の受け持ち区間を記載する
9._6.criteriaArray<Object>
水位・流量基準を記載する
9._6._1.typeString
基準の種類を記載する
9._6._2.unitString
基準の単位
9._6._3.valueString<Float>|Null
基準の値
9._6._4.conditionString
基準の値が有効かどうか示す
取りうる値は、有効無効

この電文で取り扱うコード類#

コードは、気象庁防災情報XMLフォーマット コード表 20200713_AreaRiver 及び 20200713_AreaFloodForecast 、20140423_RiverOffice 、20201224_WaterLevelStation に記載があります。

サンプル#