全国道路施設点検データベース（道路橋）
公開⽤ API 仕様書
カルテデータ編

令和 5 年 5⽉

改訂履歴
発行年月

改訂内容

令和 5 年 1 月

初版

令和 5 年 5 月(1)１.概要に仕様変更の方針を追記(2)４.(1)Key パラメータの注釈を追記(3)４.API 種類に(4)橋梁管理カルテを出力する API を追記(4)５.レスポンスのパラメータ一覧表の型を一部変更

１．概要
本仕様書は、全国道路施設点検データーベース（道路橋）の管理カルテデータを取得する公開⽤API の仕様を⽰すものです。
本仕様書に⽰す以外の基本事項は、別途、公開⽤ API 基本仕様書を参照下さい。
なお、全国道路施設点検データベース（道路橋）は当面のあいだ、機能の追加、変更を計画しています。
それに伴いAPIの仕様も変更する場合があります。
APIの仕様変更についての情報は、インフォメーションにて事前告知します。
ただし、データの破壊やセキュリティ上の障害への対応として緊急に仕様の変更が必要な場合には予告無しに変更する場合があることをご了承下さい。
管理カルテの公開⽤API で対象とするデータは、現時点(R5.4)では国⼟交通省の橋梁管理カルテ要領に従う結果となっています。
道路橋の管理カルテデータは、項⽬数が多く、データが多層構造になっているため、汎⽤性（管理カルテにある全項⽬の中から⽬的とするデータを必ず参照することができること）、サーバー負荷(タイムアウトエラー等の回避)等を考慮して以下の４つの公開⽤API を⽤意しています。
(１)年度別橋梁リスト取得 API ︓診断実施年度別に管理者区分などで検索した施設 ID リストを出⼒(２)様式別カルテ取得 API ︓診断実施年度、施設 ID を指定して管理カルテデータを出⼒(３)カルテ添付画像取得 API ︓診断実施年度、施設 ID、画像種別コード、通番を指定して橋梁管理カルテ様式 3 に含む図面、写真データを出⼒(４)橋梁管理カルテ出⼒ API ︓診断実施年度、施設 ID を指定して、橋梁管理カルテ一式を PDF 出⼒
使⽤例として、神奈川県の直轄管理の橋梁で 2020 年度の診断において橋梁概要および写真を取得する場合の流れを以下に⽰します。
①．年度別橋梁リスト取得 API で、2020 年度に診断を実施した神奈川県の橋梁の施設 ID リストを取得する。
②．様式別カルテ取得 API で、1 で取得した施設 ID の 2020 年度に診断した橋梁の様式 3-2 橋梁概要データを取得する。
③．カルテ添付画像取得 API で、2 で取得した画像種別コードと通番の写真を取得する。

２．接続先 URL
https://{API 設置サーバのドメイン}/xROAD/api/{バージョンコード}/{リソース名}s/
API 設置サーバのドメインバージョンコード

リソース名

road-structures-db-bridge.mlit.go.jp

v1bridge

３．認証機能API リクエストには、HTTP ヘッダに API キーを記述してください。
API キー記述ヘッダ
API-key: XXXXXXXXXXXXXX・・・・（コロンの後ろは半⾓スペースに続けて API キーを記述）

1

４．API 種類（１） 年度別橋梁リスト取得 API
機能︓橋梁管理カルテ登録年度を指定して対象施設の施設 ID を取得する。
※注︓施設 ID は、全国道路施設点検データベース(道路橋)に登録されている 77 条調査データに基づく値となります。一部で橋梁管理カルテ様式 3 に記載されている橋梁 ID とは異なる場合があります。
パス︓/xROAD/api/v1/bridges/karte/list/{年度}
メソッド︓ POST
項⽬名
年度

内容
診断実施年度を⻄暦 4 桁の数字を指定する

リクエストパラメータ
No.

種類

1

パラメータ

検索条件配列key(querys)

内容

省略時

検索項⽬を指し⽰すキー

⼊⼒必須

⼊れ⼦の項⽬はドットで繋いで表現する

2value

検索する値

⼊⼒必須

3

op

⽐ 較 ⽅ 法 。1:'＝ʼ等 し い 。2:'≠'等 し く な い 。

⼊⼒必須

3:'<'検索値より⼩さい。4:'>'検索値より⼤きい。5:'≦'検索値以下。6:'≧'検索値以上。7:
検索値を含む4offset検索結果の参照開始位置を指定

05limit

一度に参照する施設データの件数を指定

100 件

Key パラメータ
項⽬名

パラメータ

サンプル値

省略時

名称

bridge_name○○橋（例:市ノ瀬橋）

すべての施設

路線番号

route_code

4 桁数字（例:0007）

すべての路線

北海道開発局，東北，関地整

area_value

東，･･･，沖縄

すべての地整北海道開発局は××開発建設部,･･･北海道開
発局以外は
事務所

office_value○○河川国道,△△国道

すべての事務所

出張所

sub_office_value□□国道維持すべての出張所

2項⽬名

パラメータ

サンプル値
○○県△△市･･･

省略時

起点側所在地start_addr

起点側北緯latitude38.57519 すべての範囲

起点側東経

longitude

139.55745 すべての範囲

健全度コードsoundly_code

Ⅰ〜Ⅳ（例:Ⅱ）

全国すべての健全度

名称、地整、事務所、出張所、所在地については、リクエストパラメータの”op”を”7”に設定することで、一部の文字による部分検索が可能です。（ただし、起点側北緯、起点側東経には”7”は使⽤できません）
リクエストパラメータサンプル（body）
例１︓全国の健全度Ⅱの施設を抽出{"querys": [{"key": "soundly_code","value": "Ⅱ","op": 1}],"limit": 10,"offset": 0}

例２︓岐⾩県内の施設から健全度Ⅱの施設を抽出{"querys": [{"key": "soundly_code","value": "Ⅱ","op": 1},{"key": "start_addr","value": "岐⾩県","op": 7}],"limit": 10,"offset": 0 }3

レスポンスイメージ"result":["40.51432,141.29849","40.83548,141.12931","40.83547,141.12934","40.83546,141.12930","40.92944,140.98056","40.92518,140.96079","40.92508,140.96080","40.91850,140.93904","40.87253,140.85122","40.84444,140.83306"],

4

（２）様式別カルテ取得 API
機能︓橋梁管理カルテ登録年度と施設 ID を指定して、橋梁管理カルテ要領に従う橋梁管理カルテ様式 3 のデータを取得する。
パス︓/xROAD/api/v1/bridges/karte/report/{年度}/{施設 ID}/{様式}
メソッド︓ GET
項⽬名

内容

年度

診断実施年度を⻄暦 4 桁の数字を指定する

施設 ID

年度別橋梁リスト取得 API で取得した施設 ID を設定する

様式

診断実施年度に合わせた橋梁管理カルテ要領の橋梁管理カルテ様式 3 の様式番号を指定する
3-0︓基本情報
3-1︓様式 3-1 管理上の主要課題
3-2︓様式 3-2 橋梁概要
3-3︓様式 3-3 総合検査結果5
リクエストサンプル
例１︓施設 ID 40.*****,141.*****の 2020 年度の様式 3-1 のデータを取得
https://{API 設置サーバのドメイン}/xROAD/api/v1/bridges/karte/report/2020/40.*****,141.*****/3-1

5

レスポンスイメージ"result": [{"nendo": 2020,"k1": {
"traffic_research_year": "2015","traffic_quantity": "6706","big_car_mix": "23.5","main_damages": [{"diameter_no": "1","par_material_value": "横桁","material_value": "コンクリート","soundly_code": "Ⅱ","measure_judge": "C1","cause_decision_value": "","cause_estimate_value": "その他（製作・施工不良）","part_material_no": "01,03","damage_type_value": "うき","damage_list_no": "13","repair_expenses": 0,"damage_etc": "","measure_method_value": "","measure_list_no": "","measure_list_etc": "","particular_report": ""},・・・・・・・・・・・・・・

6

（３） カルテ添付画像取得 API
機能︓写真などの画像ファイルを取得する。
パス︓/xROAD/api/v1/bridges/karte/image/{年度}/{施設 ID}/{画像種別コード}/{通番}メソッド︓ GET
項⽬名

内容

年度

診断実施年度を⻄暦 4 桁の数字を指定する

施設 ID

年度別橋梁リスト取得 API で取得した施設 ID を設定する

画像種別コード

以下の画像種別コードを指定する
01︓位置図02︓橋梁写真（全景）03︓全体一般図

通番

様式別カルテ取得 API で取得した通番を指定する

リクエストサンプル
例１︓2020 年度の施設 ID 40.*****,141.*****の位置図の通番 1 を取得
https:// {API 設置サーバのドメイン}/xROAD/api/v1/bridges/karte/image/2020/40.*****,141.*****/01/1

レスポンスイメージ
レスポンスは画像ファイルとして送信されるため、Curl コマンドなどの利⽤している場合は--output などのオプションを追加してファイルへの保存を⾏うことで参照できる。

7

（４） 橋梁管理カルテ出力 API
機能︓診断実施年度、施設 ID を指定して、橋梁管理カルテを出⼒する。
※注︓施設 ID は、全国道路施設点検データベース(道路橋)に登録されている 77 条調査データに基づく値となります。一部で橋梁管理カルテに記載されている橋梁 ID とは異なる場合があります。
パス︓/xROAD/api/v1/bridges/karte/pdf/{年度}/{施設 ID}
メソッド︓ GET
項⽬名

内容

年度

⻄暦 4 桁の数字を指定する

施設 ID

施設 ID を指定する※「年度別橋梁リスト取得 API（カルテ）」にて取得したもの

リクエストサンプル
例１︓2020 年度の施設 ID 40.*****,141.*****の橋梁管理カルテを取得
https:// {API 設置サーバのドメイン}/xROAD/api/v1/bridges/karte/pdf/2020/40.*****,141.*****

レスポンスイメージ
レスポンスは PDF ファイルとして送信されるため、Curl コマンドなどを利⽤している場合は--output などのオプションを追加してファイルへの保存を⾏うことで参照できる。
※注︓様式 3-1、C 表 履歴一覧の備考（記載者）は出⼒しない。

ダウンロードファイル名（※画面側で生成しているファイル名と同様）
ファイル名︓「カルテ様式-3_」から始まるファイル名で出⼒します。
※注︓ご利⽤のツールが日本語に対応していない場合、日本語表記でファイル名を出⼒できないため
URL エンコードを⾏ってファイル名を出⼒します。
例) 「カルテ様式-3_」であれば、「%E3%82%AB%E3%83%AB%E3%83%86%E6%A7%98%E5%BC%8F-3_」を出⼒します。
この場合、URL デコードを実施していただくことで上記で⽰した形式のファイル名に変換が可能です。

8

５．様式別カルテ取得 API レスポンスのパラメータ⼀覧表（１）基本情報︓3-0
⼤項⽬

中項⽬

⼩項⽬型

nendovarchar(4)basicInfo

項⽬名称
点検年度
共通基礎項⽬north_latitude

float(8)北緯 1east_longitude

float(9)東経 1remote_north_latitude

float(8)北緯 2remote_east_longitude

float(9)東経 2bridge_idvarchar(18)

橋梁 ID

bridge_kanavarchar(120)

名称フリガナbridge_namevarchar(60)

名称route_code

varchar(60)路線名

bridge_novarchar(10)

橋梁番号

start_addr

varchar(60)終点側所在地

end_addr

varchar(60)終点側所在地complete_year

varchar(4)施設完成年度

local_spacevarchar(30)

距離自remote_spacevarchar(30)

距離至area_value

varchar(32)

地整名

office_value

varchar(36)

事務所名

sub_office_value

varchar(28)

出張所名update_date

varchar(14)

帳票更新年月日9

（２）様式 3-1 管理上の主要課題︓3-1

⼤項⽬

中項⽬

⼩項⽬

nendo型
varchar(4)

k1

項⽬名称
点検年度
様式３-１

traffic_research_year

varchar(4)

調査年度

traffic_quantity

varchar(6)交通量

big_car_mixvarchar(4)大型混入率

diameter_novarchar(7)径間番号

par_material_value

varchar(30)

部材種別

material_value

varchar(20)

材料名称

soundly_code

varchar(2)健全度

measure_judge

varchar(2)対策区分

cause_decision_value

varchar(30)

損傷原因（推定）cause_estimate_value

varchar(30)

損傷原因（確定）

part_material_novarchar(500)

部材番号

damage_type_value

varchar(30)

損傷種類

damage_list_novarchar(3)

履歴一覧番号

repair_expenses

float(11)

補修概算事業費

damage_etc

varchar(200)

損傷備考measure_method_value

varchar(50)

補修工法

measure_list_novarchar(3)

補修履歴一覧番号measure_list_etc

varchar(200)

補修備考

particular_reportvarchar(200)

特記事項

par_material_value_styleint(1)

部材種別_表示形式

material_value_styleint(1)

材料名称_表示形式

soundly_code_styleint(1)

健全度_表示形式

measure_judge_styleint(1)

対策区分_表示形式

cause_decision_value_styleint(1)

損傷原因（推定）_表示形式

cause_estimate_value_styleint(1)

損傷原因（確定）_表示形式

part_material_no_styleint(1)

部材番号_表示形式

damage_type_value_styleint(1)

損傷種類_表示形式

damage_list_no_styleint(1)

履歴一覧番号_表示形式

repair_expenses_styleint(1)

補修概算事業費_表示形式

main_damages

main_damage_lines

10⼤項⽬中項⽬⼩項⽬other_damage_lines

update_histories

項⽬名称

damage_etc_styleint(1)

損傷備考_表示形式

measure_method_value_styleint(1)

補修工法_表示形式

measure_list_no_styleint(1)

補修履歴一覧番号_表示形式

measure_list_etc_styleint(1)

補修備考_表示形式

particular_report_styleint(1)

特記事項_表示形式

float(11)

補修概算事業費合計

diameter_novarchar(7)径間番号

par_material_value

varchar(30)

部材種別

material_value

varchar(20)

材料名称

soundly_code

varchar(2)健全度

measure_judge

varchar(2)対策区分

damage_type_value

varchar(30)

損傷種類

damage_list_novarchar(3)

履歴一覧番号

damage_etc

varchar(200) 損傷備考

measure_list_novarchar(3)particular_reportvarchar(200) 特記事項

par_material_value_styleint(1)

部材種別_表示形式

material_value_styleint(1)

材料名称_表示形式

soundly_code_styleint(1)

健全度_表示形式

measure_judge_styleint(1)

対策区分_表示形式

damage_type_value_styleint(1)

損傷種類_表示形式

damage_list_no_styleint(1)

履歴一覧番号_表示形式

damage_etc_styleint(1)

損傷備考_表示形式

measure_list_no_styleint(1)

補修履歴一覧番号_表示形式

particular_report_styleint(1)

特記事項_表示形式

history_list_noint(3)

履歴一覧番号

operate_date

varchar(10)年月日tenken_type_value

varchar(58)

点検調査履歴_種別名称tenken_target_part_material

varchar(200) 点検調査履歴_対象部材

tenken_contents

text

repair_expenses_total
other_damages型

11

補修履歴一覧番号

点検調査履歴_内容

⼤項⽬

中項⽬

⼩項⽬型

項⽬名称

hoshu_type_value

varchar(50)

補修補強等履歴_種別名称

hoshu_target_part_material

varchar(200)

補修補強等履歴_対象部材

hoshu_contents

text

補修補強等履歴_内容

表⽰形式の対応は下記を参照ください。
0︓黒字/見え消し線なし
1︓黒字/見え消し線あり
2︓赤字/見え消し線なし
3︓赤字/見え消し線あり

12

（３）様式 3-2 橋梁概要︓3-2
⼤項⽬

中項⽬

⼩項⽬

nendo型
varchar(4)

k2

項⽬名称
点検年度
様式３-２

bridge_comp_namevarchar(8)諸元_橋梁区分

bridge_type_value

varchar(6)諸元_橋梁種別

distribute_type_value

varchar(22)

諸元_分割区分business_type_value

varchar(8)

諸元_事業区分

construct_status_value

varchar(100)

諸元_架橋状況cross_namevarchar(200)

諸元_交差物名称

salt_type_value

varchar(10)諸元_塩害地域区分

bridge_type

text

諸元_橋梁形式

bridge_length

float(9)諸元_橋長bridge_spacevarchar(9)諸元_橋面積all_diameter_num

varchar(3)

諸元_総径間数

plane_shape_value

varchar(14)諸元_平面形状plane_liner

varchar(6)諸元_平面線形vertical_grade

varchar(6)

諸元_縦断勾配order_value

varchar(6)諸元_等級

design_criteria_up_value

varchar(58)

諸元_設計基準上部構造

design_criteria_down_value

varchar(58)

諸元_設計基準下部構造

design_criteria_earth_value

varchar(58)

諸元_設計基準耐
震補強

design_load_value

varchar(18)

諸元_設計活荷重

design_seismic_intensity

varchar(4)

諸元_設計震度construct_up_structure

varchar(40)

諸元_施工会社上部構造

construct_down_structure

varchar(40)

諸元_施工会社下部構造

load_limit

varchar(4)

諸元_荷重制限

traffic_limit_value

varchar(14)諸元_通行制限detour_value

varchar(4)

諸元_迂回路有無

all_widthvarchar(6)幅員_全幅員available_widthvarchar(6)幅員_有効幅員

left_road_cover_widthvarchar(6)幅員_左地覆幅

13

⼤項⽬

中項⽬型

項⽬名称

left_road_cover_heightvarchar(6)幅員_左地覆高さ

left_road_side_widthvarchar(6)幅員_左歩道幅left_road_shoulder_widthvarchar(6)幅員_左路肩幅

left_road_widthvarchar(6)幅員_左車線幅

left_road_num

varchar(2)幅員_左車線数

center_spacevarchar(6)幅員_中央帯center_separate_spacevarchar(6)幅員_分離帯right_road_num

varchar(2)幅員_右車線数

right_road_widthvarchar(6)幅員_右車線幅

right_road_shoulder_widthvarchar(6)幅員_右路肩幅right_road_side_widthvarchar(6)幅員_右歩道幅right_road_cover_heightvarchar(6)幅員_右地覆高さ

right_road_cover_widthvarchar(6)幅員_右地覆幅

structure_noint(3)

上部_構造体番号material_div_value

varchar(18)上部_主桁材料区分

support_length

varchar(100)

上部_支間長main_beam_heightvarchar(6)上部_桁高main_beam_num

varchar(3)上部_桁本数

beam_namevarchar(305)

上部_上部構造形式

road_surface_loc_value

varchar(6)上部_路面位置flooring_material_value

varchar(14)上部_床版材料区分

flooring_thickness

varchar(4)上部_床版厚flooring_type_use_value

varchar(46)

上部_床版形式

waterproof_value

varchar(4)上部_防水工事有無

body_novarchar(6)下部_躯体番号bridge_leg_material_div_value

varchar(18)下部_下部構造材
料区分

bridge_leg_heightvarchar(7)下部_下部構造高bridge_leg_structure_type_value

varchar(26)下部_下部構造形式

foundation_material_div_value

varchar(18)下部_基礎材料区分

foundation_type_value

varchar(24)下部_基礎構造形式

stake_diamatervarchar(4)

下部_杭径

up_structures

low_structures

⼩項⽬

14

⼤項⽬

中項⽬

⼩項⽬型

項⽬名称

stake_num

varchar(3)

下部_杭本数support_type

varchar(80)

下部_支承形式

addition_div_value

varchar(12)添架物_添架物区分

addition_type_value

varchar(14)添架物_種別addition_size

varchar(10)

添架物_寸法private_use_num

varchar(3)

添架物_本数

addition_manager_namevarchar(60)

添架物_管理者

prm_low_paint1_value

varchar(34)

塗装_下塗り塗料 0

prm_low_paint2_value

varchar(34)

塗装_下塗り塗料 1

middle_paint1_value

varchar(28)塗装_中塗り塗料 0

middle_paint2_value

varchar(28)塗装_中塗り塗料 1

high_paint1_value

varchar(28)

塗装_上塗り塗料 0

high_paint2_value

varchar(28)

塗装_上塗り塗料 1

inspect_facility_value

varchar(14)塗装_ 点検施設

drain_facility_value

varchar(12)塗装_排水施設

block_sound_value

varchar(4)

塗装_遮音壁の有無

protection_fense_value

varchar(18)塗装_高欄種別

file_name01

varchar(40)位置図ファイル名

cont_no01

int(3)

位置図通番

image_date

varchar(14)

撮影年月日

file_name02

varchar(40)

写真ファイル名

cont_no02

int(3)

写真通番

file_name03

varchar(40)全体一般図ファイ
ル名

cont_no03

int(3)

全体一般図通番

file_namevarchar(40)全体一般図一覧_
ファイル名

cont_noint(3)全体一般図一覧_
通番

low_structures

addition_infos

general_figs

15

（４）様式 3-3 総合検査結果︓3-3
⼤項⽬

中項⽬

⼩項⽬型

nendo

varchar(4)

k3

項⽬名称
点検年度
様式３-３

update_histories

history_list_noint(3)

履歴一覧番号

operate_date

varchar(14)年月日

type_value

varchar(58)

種別・名称

total_inspection_result

text

総合検査結果soundly_code

varchar(2)健全度

type_max_measure_judge varchar(2)16

代表対策区分