My City Construction Web Api (v1)

My City ConstructionのWebAPIです。

Authentication

ApiKeyAuth

Security Scheme Type API Key
Header parameter name: X-Mcc-Api-Key

products

工事・業務データ関連API

工事/業務データを作成する

工事/業務データを作成する

Request Body schema: application/json

工事/業務データ

kind
required
string

種別 SURVEY_DESIGN:調査設計 GEOLOGICAL_SURVEY:地質調査 SURVEYING:測量 OTHER_WORK:その他業務 CONSTRUCTION:工事

name
required
string

業務/工事名称

client_name
required
string

発注機関名

contractor_name
required
string

受注機関名

start_date
required
string

工期開始日

end_date
required
string

工期終了日

addresses
required
Array of objects (Address)

住所リスト

point_locations
Array of objects (PointLocation)

場所情報(点)リスト
場所情報は点・線・面いずれか1つ以上のデータが必須

line_locations
Array of objects (LineLocation)

場所情報(線)リスト
場所情報は点・線・面いずれか1つ以上のデータが必須

area_locations
Array of objects (AreaLocation)

場所情報(面)リスト
場所情報は点・線・面いずれか1つ以上のデータが必須

overview
required
string

概要

client_corporate_number
required
string

発注者法人番号

client_persons
required
Array of objects (ClientPerson)

実績内容確認担当者リスト

contractor_persons
required
Array of objects (ContractorPerson)

受注担当者リスト

amount
integer

金額(税込)

corins_tecris_number
string

コリンズテクリス番号

design_document_code
string

設計書コード

keyword
string

キーワード

client_organization
object (ClientOrganization)

発注機関
電子納品に関する要領・基準 発注者コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

construction_industry
object (ConstructionIndustry)

工事業種
電子納品に関する要領・基準 工事業種コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

construction_field
object (ConstructionField)

工事分野コード
電子納品に関する要領・基準 工事分野コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

construction_kind_and_methods
Array of objects (ConstructionKindAndMethod)

工種・工法型式リスト

design_field
object (DesignField)

業務分野コード
電子納品に関する要領・基準 業務分野コードを参照
codeとname両方が指定された場合、codeが優先される
http://www.cals-ed.go.jp/h2803_code/

client_organization_code
string
Deprecated

発注者コード
コードは電子納品に関する要領・基準 発注者コードを参照
http://www.cals-ed.go.jp/h2803_code/

construction_industry_code
string
Deprecated

工事業種コード
コードは電子納品に関する要領・基準 工事業種コードを参照
http://www.cals-ed.go.jp/h2803_code/

construction_field_code
string
Deprecated

工事分野コード
コードは電子納品に関する要領・基準 工事分野コードを参照
http://www.cals-ed.go.jp/h2803_code/

construction_kind_and_method_codes
Array of objects (ConstructionKindAndMethodCode)
Deprecated

工種・工法型式コードリスト

design_field_code
string
Deprecated

業務分野コード
コードは電子納品に関する要領・基準 業務分野コードを参照
http://www.cals-ed.go.jp/h2803_code/

Responses

201

正常に登録が完了した
実績内容確認担当者リストと受注担当者リストは個人情報が含まれるので返却されない。

422

バリデーションエラー

post /products
https://mycityconstruction-demo.com/api/v1/products

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "kind": "CONSTRUCTION",
  • "name": "国道○号○○舗装修繕工事",
  • "client_name": "国土交通省○○地方整備局○○事務所",
  • "contractor_name": "○○建設株式会社△△組共同企業体(代表:○○建設株式会社)",
  • "start_date": "2017-11-01",
  • "end_date": "2019-03-26",
  • "addresses":
    [
    ],
  • "point_locations":
    [
    ],
  • "line_locations":
    [
    ],
  • "area_locations":
    [
    ],
  • "overview": "掘削工8500m3、土留め工2800m2、埋戻し工9500m3、路面覆工300m2",
  • "client_corporate_number": "00102004",
  • "client_persons":
    [
    ],
  • "contractor_persons":
    [
    ],
  • "amount": 10000000,
  • "corins_tecris_number": "12345678K",
  • "design_document_code": "207011110123",
  • "keyword": "サンプル キーワード",
  • "client_organization":
    {
    },
  • "construction_industry":
    {
    },
  • "construction_field":
    {
    },
  • "construction_kind_and_methods":
    [
    ],
  • "design_field":
    {
    },
  • "client_organization_code": "00101001",
  • "construction_industry_code": "01",
  • "construction_field_code": "02",
  • "construction_kind_and_method_codes":
    [
    ],
  • "design_field_code": "0111000"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "product":
    {
    }
}

公開されている工事・業務データ一覧を検索する

公開されている工事・業務データ一覧を検索する

query Parameters
q
string

文字列検索

文字列で検索を行う。文字列は一部を除き部分一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
完全一致検索が行われるのは以下のデータ
  • 発注機関名法人番号
  • 受注機関名法人番号
  • 設計書コード
  • コリンズ・テクリス番号
files
string

成果物の絞り込み検索

成果物の有無で絞り込み検索を行う
以下の文字列を指定して絞り込みができる
指定された文字列以外の場合、この絞り込み検索は無視される。
  • PUBLISHED(成果物を公開している工事データ)
  • UNPUBLISHED(成果物を公開していない工事データ)
kind
string

「種別(kind)」の絞り込み検索

「種別(kind)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。 種別絞り込み検索で利用できる文字列は以下の通り。
  • SURVEY_DESIGN(調査設計)
  • GEOLOGICAL_SURVEY(地質調査)
  • SURVEYING(測量)
  • OTHER_WORK(その他業務)
  • CONSTRUCTION(工事)
corins_tecris_number
string

「コリンズ・テクリス番号(corins_tecris_number)」の絞り込み検索

「コリンズ・テクリス番号(corins_tecris_number)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
design_document_code
string

「設計書コード(design_document_code)」の絞り込み検索

「設計書コード(design_document_code)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
client_corporate_number
string

「発注機関名法人番号(client_corporate_number)」の絞り込み検索

「発注機関名法人番号(client_corporate_number)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
contractor_corporate_number
string

「受注機関名法人番号(contractor_corporate_number)」の絞り込み検索

「発注機関名法人番号(contractor_corporate_number)」で絞り込み検索を行う。文字列は完全一致検索される。
パラメータを半角/全角スペースで区切るとOR検索が行われる。
from
string

工期範囲検索(始まり)

工期開始日、工期終了日について期間で検索できる。
form以降に含まれる工事が検索される。toと組み合わせることで、ある期間の工事を検索することができる。
to
string

工期範囲検索(終わり)

工期開始日、工期終了日について期間で検索できる。
to以前に含まれる工事が検索される。fromと組み合わせることで、ある期間の工事を検索することができる。
fields
string

表示フィールドの設定

取得するフィールドを限定する事ができる。
パラメータを半角/全角スペースで区切ることにより、取得するフィールド名を複数指定することができる。
ただし、「id」フィールドは設定に関わらず必ず取得される。
不要なフィールドがある場合はfieldsパラメータを設定することにより、取得するデータ量を削減することができる。
page
integer

ページ設定

工事データ一覧は一度のリクエストにつき決められた件数(デフォルトでは20件)のみしか取得できない。
pageを設定することによりページングされた一覧を取得することができる。
次のpage,前のpageが存在するかどうかは
工事データ一覧レスポンス中のpagination.hasPrev, pagenation.hasNext
最大のページ数は工事データ一覧レスポンス中のpagination.maxPageCountを参照。
limit
integer

最大取得件数設定

1度のリクエストでの最大取得件数を設定する。
デフォルトでは20件。
limitを設定することにより、最小1件、最大100件のデータを1度のリクエストで取得できる。
sort
string

一覧ソート設定

一覧ソートを設定する。デフォルトではid順になっている。directionを指定しない場合、昇順でソートされる。
指定できるフィールド名は以下の通り。
  • id
  • 工事名(name)
  • 種別(kind)
  • 工期開始日(start_date)
  • 工期終了日(end_date)
  • 発注者名(client_name)
  • 受注者名(contractor_name)
  • 発注機関名法人番号(client_corporate_number)
  • 受注機関名法人番号(contractor_corporate_number)
  • 金額(amount)
direction
string

昇順/降順設定

ソートの昇順/降順を設定する。
昇順(asc)または降順(desc)を指定する。

Responses

200

工事・業務データ一覧を取得できた

get /products/search
https://mycityconstruction-demo.com/api/v1/products/search

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "contents":
    [