新規中小企業の情報を取得します。
https://api.u10sme.go.jp/v1/corporations.{format}
名前 |
省略可否 |
説明 |
詳細・備考 |
{format} |
必須 |
レスポンスデータの形式を指定します。 |
"json" :レスポンスデータがJSON形式で返ります。 "xml" :レスポンスデータがXML形式で返ります。 |
limit |
省略可 |
取得する「企業情報」の最大件数を指定します。 |
1 以上 100 以下の整数を指定できます。 省略時は 20 となります。 |
offset |
省略可 |
取得する「企業情報」のオフセット (スキップ件数) を指定します。 |
0 以上 999 以下の整数を指定できます。 省略時は 0 となります。 例) limit=20&offset=0 →1件目から20件目が取得されます。 limit=20&offset=20 →21件目から40件目が取得されます。 ※「企業情報」の総件数を超えるオフセットを指定した場合、レスポンスに含まれる「企業情報」の配列は空の配列となります。 ※検索件数の制限を参照ください。 |
sortOrder |
省略可 |
取得する「企業情報」の並び順を指定します。 |
sortOrders リクエストのレスポンスに含まれる「並べ替え定義」の id を指定します。 省略時は"事業者名 昇順"の並び順となります。 |
keywords |
省略可 |
キーワードによる絞り込み条件を指定します。 |
半角または全角スペース区切りで複数の文字列を指定できます。(全体で最大50文字、最大3個、重複指定不可) ※ 条件文字列はURLエンコード(UTF-8)した値を指定する必要があります。URLエンコードしていない場合は正しい検索結果が得られません。 ※ キーワード検索は、事業者名および一部対象フィールドの値を部分一致で検索します。なお、対象フィールドおよび検索方法は予告なく変更される場合があります。 |
keywordMode |
省略可 |
keywords パラメータで指定した条件文字列の検索モードを指定します。 |
"and": AND検索 (既定値) "or": OR検索 |
prefectures |
省略可 |
『営業エリア』による絞り込み条件を指定します。 |
areas または prefectures リクエストのレスポンスに含まれる「都道府県」のコードを指定します。 複数の値を指定する場合は、AND条件の場合 "+"(正符号) 、OR条件の場合 ","(カンマ) で値を連結します。 ※ AND条件とOR条件は混在できません。 |
services |
省略可 |
『営業品目』による絞り込み条件を指定します。 |
serviceCategories リクエストのレスポンスに含まれる「営業品目」の id を指定します。 複数の値を指定する場合は、AND条件の場合 "+"(正符号) 、OR条件の場合 ","(カンマ) で id の値を連結します。 ※ AND条件とOR条件は混在できません。 |
tags |
省略可 |
『タグデータ』による絞り込み条件を指定します。 |
tags リクエストのレスポンスに含まれる「タグデータ」の id を指定します。 複数の値を指定する場合は、AND条件の場合 "+"(正符号) 、OR条件の場合 ","(カンマ) で id の値を連結します。 ※ AND条件とOR条件は混在できません。 |
foundationDate |
省略可 |
『設立年月日』による絞り込み条件を指定します。 |
次の形式で日付範囲を指定します。 開始日付[,終了日付] (※角括弧内は省略可) 日付は、YYYY-MM-DD 形式で指定します。 例) foundationDate=2007-04-01,2008-03-31 ※ 開始日付に創業10年未満とみなされない日付を設定するとエラーとなります。 |
lastUpdateTime |
省略可 |
『最終更新日時』による絞り込み条件を指定します。 |
次の形式で日時範囲を指定します。 開始日時[,終了日時] (※角括弧内は省略可) 日時は、YYYY-MM-DDTHH:MM:SS 形式で指定します。 例) lastUpdateTime=2007-04-01T00:00:00,2008-03-31T23:59:59 |
要素(フィールド) |
型 |
説明 |
詳細・備考 |
count |
number |
検索条件に該当する「企業情報」の総件数。 |
システムの制限により、総件数が 1000 件を超える場合は、この値は 1000 が返ります。 ※検索件数の制限を参照ください。 |
isOverLimitCount |
boolean |
count フィールドの値が制限数を超えているかどうかを示す値。 |
true: 制限数を超えている false: 制限数を超えていない ※検索件数の制限を参照ください。 |
corporations[] |
array |
検索条件に該当する「企業情報」の配列。 |
limit パラメータ、offset パラメータで指定した最大件数/オフセットが適用されます。 |
corporations[].id |
string |
「企業情報」の本システムにおけるID。 |
|
corporations[].corporateNumber |
string |
法人番号 |
未設定の場合があります。 |
corporations[].name |
string |
事業者名 |
|
corporations[].nameKana |
string |
事業者名フリガナ |
「株式会社」等を除く、本システムで事業者名順の並び替えに使用されるフリガナ。 |
corporations[].location |
object |
所在地 |
|
corporations[].location.postalCode |
string |
所在地 - 郵便番号 |
半角7桁、ハイフンなしの値。 |
corporations[].location.prefectureCode |
string |
所在地 - 都道府県コード (2桁) |
未設定の場合があります。 |
corporations[].location.cityCode |
string |
所在地 - 市町村コード (2桁) |
未設定の場合があります。 |
corporations[].location.address |
string |
所在地 - 住所 |
自由記述で登録されています。 |
corporations[].contact |
object |
連絡先 |
|
corporations[].contact.phoneNumber |
string |
連絡先 - 電話番号 |
未設定の場合があります。 |
corporations[].contact.faxNumber |
string |
連絡先 - FAX番号 |
未設定の場合があります。 |
corporations[].contact.email |
string |
連絡先 - Eメールアドレス |
|
corporations[].contact.departmentName |
string |
連絡先 - 部署名 |
未設定の場合があります。 |
corporations[].businessAreas[] |
array |
営業エリア |
areas のレスポンスと同一のフォーマットで、企業の営業エリアが出力されます。 |
corporations[].serviceCategories[] |
array |
営業品目(区分、種別、品目) |
serviceCategories のレスポンスと同一のフォーマットで、企業の営業品目が出力されます。 |
corporations[].tags[] |
array |
タグデータ |
tags のレスポンスと同一のフォーマットで、企業に関連する情報 (タグデータ) が出力されます。 |
corporations[].affiliatedGroup |
string |
所属団体 |
自由記述で登録されています。 |
corporations[].qualification |
string |
資格 |
自由記述で登録されています。 |
corporations[].businessResults |
string |
受注実績・主要取引先 |
自由記述で登録されています。 |
corporations[].profile |
string |
事業内容・商品PR |
自由記述で登録されています。 |
corporations[].url |
string |
URL |
未設定の場合があります。 |
corporations[].foundationDate |
string |
設立年月日 |
YYYY-MM-DD 形式で日付が設定されます。 例) 2007-01-01 |
corporations[].lastUpdateTime |
string |
「企業情報」の最終更新日時 |
YYYY-MM-DDTHH:MM:SS 形式で日時 (日本時間) が設定されます。時差を示す値は出力されません。 例) 2007-01-01T09:30:11 |
GET https://api.u10sme.go.jp/v1/corporations.json
{ "count": 880, "isOverLimitCount": false, "corporations": [ { "id": "1", "corporateNumber": "0000000000001", "name": "企業情報1", "nameKana": "キギョウジョウホウ1", "location": { "postalCode": "0000000", "address": "北海道函館市桔梗町1" }, "contact": { "phoneNumber": "00-0000-0000", "faxNumber": "11-1111-1111", "email": "1@test.jp", "departmentName": "部署名1" }, "businessAreas": [ { "id": "1", "name": "北海道地方", "prefectures": [ { "code": "01", "name": "北海道" }, ・・・ ] }, ・・・ ], "serviceCategories": [ { "id": "1", "name": "物品", "serviceKinds": [ { "id": "1", "name": "物品の製造", "services": [ { "id": "1", "name": "衣服・その他繊維製品類", "code": "101" }, ・・・ ] }, ・・・ ] }, ・・・ ], "tags": [ { "id": "1", "name": "障害者就労施設等からの物品等の調達(障害者優先調達推進法)の該当" }, ・・・ ], "affiliatedGroup": "△△△", "qualification": "△△△", "businessResults": "△△△", "profile": "△△△", "url": "http://test/1", "foundationDate": "2007-01-01", "lastUpdateTime": "2010-01-01T00:01:00" }, ・・・ ] }
GET https://api.u10sme.go.jp/v1/corporations.xml
<corporationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<count>880</count>
<isOverLimitCount>false</isOverLimitCount>
<corporations>
<corporation>
<id>1</id>
<corporateNumber>0000000000001</corporateNumber>
<name>企業情報1</name>
<nameKana>キギョウジョウホウ1</nameKana>
<location>
<postalCode>0000000</postalCode>
<address>北海道函館市桔梗町1</address>
</location>
<contact>
<phoneNumber>00-0000-0000</phoneNumber>
<faxNumber>11-1111-1111</faxNumber>
<email>1@test.jp</email>
<departmentName>部署名1</departmentName>
</contact>
<businessAreas>
<area>
<id>1</id>
<name>北海道地方</name>
<prefectures>
<prefecture>
<code>01</code>
<name>北海道</name>
</prefecture>
・・・
</prefectures>
</area>
・・・
</businessAreas>
<serviceCategories>
<serviceCategory>
<id>1</id>
<name>物品</name>
<serviceKinds>
<serviceKind>
<id>1</id>
<name>物品の製造</name>
<services>
<service>
<id>1</id>
<name>衣服・その他繊維製品類</name>
<code>101</code>
</service>
・・・
</services>
</serviceKind>
・・・
</serviceKinds>
</serviceCategory>
・・・
</serviceCategories>
<tags>
<tag>
<id>1</id>
<name>障害者就労施設等からの物品等の調達(障害者優先調達推進法)の該当</name>
</tag>
・・・
</tags>
<affiliatedGroup>△△△</affiliatedGroup>
<qualification>△△△</qualification>
<businessResults>△△△</businessResults>
<profile>△△△</profile>
<url>http://test/1</url>
<foundationDate>2007-01-01</foundationDate>
<lastUpdateTime>2010-01-01T00:01:00</lastUpdateTime>
</corporation>
・・・
</corporations>
</corporationsResponse>