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
Copy
Expand all Collapse all
{
  • "product":
    {
    }
}

工事/業務データを取得する

工事/業務データを取得する

path Parameters
product_id
required
integer

工事/業務データID

Responses

200

データの取得に成功した
実績内容確認担当者リストと受注担当者リストは個人情報が含まれるので返却されない

get /products/{product_id}
https://mycityconstruction-demo.com/api/v1/products/{product_id}

Response samples

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

工事/業務データを更新する

工事/業務データを更新する

path Parameters
product_id
required
integer

工事/業務データID

Request Body schema: application/json
kind
string

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

name
string

業務/工事名称

client_name
string

発注機関名

contractor_name
string

受注機関名

start_date
string

工期開始日

end_date
string

工期終了日

addresses
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
string

概要

client_corporate_number
string

発注者法人番号

client_persons
Array of objects (ClientPerson)

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

contractor_persons
Array of objects (ContractorPerson)

受注担当者リスト

amount
integer

金額(税込)

corins_tecris_number
string

コリンズテクリス番号

design_document_code
string

設計書コード

keyword