gbizinfo 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.openapi-generator/FILES +48 -0
- data/.openapi-generator/VERSION +1 -0
- data/.openapi-generator-ignore +30 -0
- data/.rspec +3 -0
- data/.rubocop.yml +13 -0
- data/CHANGELOG.md +3 -0
- data/CODE_OF_CONDUCT.md +84 -0
- data/Gemfile +12 -0
- data/Gemfile.lock +64 -0
- data/LICENSE.txt +21 -0
- data/README.md +121 -0
- data/Rakefile +12 -0
- data/bin/console +15 -0
- data/bin/setup +8 -0
- data/docs/ApiError.md +20 -0
- data/docs/CertificationInfo.md +30 -0
- data/docs/CommendationInfo.md +26 -0
- data/docs/CompatibilityOfChildcareAndWork.md +24 -0
- data/docs/Finance.md +24 -0
- data/docs/GBizINFORESTAPIApi.md +678 -0
- data/docs/GBizINFORESTAPIPeriodSpecifiedSearchApi.md +591 -0
- data/docs/HojinInfo.md +76 -0
- data/docs/HojinInfoResponse.md +24 -0
- data/docs/HojinInfoUpdateInfoResponse.md +30 -0
- data/docs/MajorShareholders.md +20 -0
- data/docs/ManagementIndex.md +66 -0
- data/docs/PatentInfo.md +26 -0
- data/docs/ProcurementInfo.md +26 -0
- data/docs/SubsidyInfo.md +32 -0
- data/docs/WomenActivityInfos.md +28 -0
- data/docs/WorkplaceBaseInfos.md +28 -0
- data/docs/WorkplaceInfoBean.md +22 -0
- data/gbizinfo.gemspec +37 -0
- data/git_push.sh +57 -0
- data/lib/gbizinfo/api/g_biz_inforestapi_api.rb +748 -0
- data/lib/gbizinfo/api/g_biz_inforestapi_period_specified_search_api.rb +670 -0
- data/lib/gbizinfo/api_client.rb +391 -0
- data/lib/gbizinfo/api_error.rb +58 -0
- data/lib/gbizinfo/configuration.rb +290 -0
- data/lib/gbizinfo/models/api_error.rb +225 -0
- data/lib/gbizinfo/models/certification_info.rb +275 -0
- data/lib/gbizinfo/models/commendation_info.rb +255 -0
- data/lib/gbizinfo/models/compatibility_of_childcare_and_work.rb +245 -0
- data/lib/gbizinfo/models/finance.rb +249 -0
- data/lib/gbizinfo/models/hojin_info.rb +515 -0
- data/lib/gbizinfo/models/hojin_info_response.rb +249 -0
- data/lib/gbizinfo/models/hojin_info_update_info_response.rb +279 -0
- data/lib/gbizinfo/models/major_shareholders.rb +225 -0
- data/lib/gbizinfo/models/management_index.rb +455 -0
- data/lib/gbizinfo/models/patent_info.rb +257 -0
- data/lib/gbizinfo/models/procurement_info.rb +257 -0
- data/lib/gbizinfo/models/subsidy_info.rb +287 -0
- data/lib/gbizinfo/models/women_activity_infos.rb +265 -0
- data/lib/gbizinfo/models/workplace_base_infos.rb +265 -0
- data/lib/gbizinfo/models/workplace_info_bean.rb +232 -0
- data/lib/gbizinfo/version.rb +15 -0
- data/lib/gbizinfo.rb +57 -0
- data/openapi/root.yaml +1377 -0
- data/sig/gbizinfo.rbs +4 -0
- metadata +105 -0
@@ -0,0 +1,678 @@
|
|
1
|
+
# Gbizinfo::GBizINFORESTAPIApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://info.gbiz.go.jp/hojin*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**get_certification_using_get**](GBizINFORESTAPIApi.md#get_certification_using_get) | **GET** /v1/hojin/{corporate_number}/certification | gBizINFOから届出・認定情報を取得します. |
|
8
|
+
| [**get_commendation_using_get**](GBizINFORESTAPIApi.md#get_commendation_using_get) | **GET** /v1/hojin/{corporate_number}/commendation | gBizINFOから表彰情報を取得します. |
|
9
|
+
| [**get_finance_using_get**](GBizINFORESTAPIApi.md#get_finance_using_get) | **GET** /v1/hojin/{corporate_number}/finance | gBizINFOから財務情報を取得します. |
|
10
|
+
| [**get_patent_using_get**](GBizINFORESTAPIApi.md#get_patent_using_get) | **GET** /v1/hojin/{corporate_number}/patent | gBizINFOから特許情報を取得します. |
|
11
|
+
| [**get_procurement_using_get**](GBizINFORESTAPIApi.md#get_procurement_using_get) | **GET** /v1/hojin/{corporate_number}/procurement | gBizINFOから調達情報を取得します. |
|
12
|
+
| [**get_subsidy_using_get**](GBizINFORESTAPIApi.md#get_subsidy_using_get) | **GET** /v1/hojin/{corporate_number}/subsidy | gBizINFOから補助金情報を取得します. |
|
13
|
+
| [**get_using_get**](GBizINFORESTAPIApi.md#get_using_get) | **GET** /v1/hojin/{corporate_number} | gBizINFOから法人基本情報を取得します. |
|
14
|
+
| [**get_workplace_information_using_get**](GBizINFORESTAPIApi.md#get_workplace_information_using_get) | **GET** /v1/hojin/{corporate_number}/workplace | gBizINFOから職場情報を取得します. |
|
15
|
+
| [**search_info_using_get**](GBizINFORESTAPIApi.md#search_info_using_get) | **GET** /v1/hojin | gBizINFOに登録された法人を検索します. |
|
16
|
+
|
17
|
+
|
18
|
+
## get_certification_using_get
|
19
|
+
|
20
|
+
> <HojinInfoResponse> get_certification_using_get(x_hojin_info_api_token, corporate_number)
|
21
|
+
|
22
|
+
gBizINFOから届出・認定情報を取得します.
|
23
|
+
|
24
|
+
指定された法人番号の情報を取得します。
|
25
|
+
|
26
|
+
### Examples
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'time'
|
30
|
+
require 'gbizinfo'
|
31
|
+
|
32
|
+
api_instance = Gbizinfo::GBizINFORESTAPIApi.new
|
33
|
+
x_hojin_info_api_token = 'x_hojin_info_api_token_example' # String | APIトークン
|
34
|
+
corporate_number = 'corporate_number_example' # String | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。
|
35
|
+
|
36
|
+
begin
|
37
|
+
# gBizINFOから届出・認定情報を取得します.
|
38
|
+
result = api_instance.get_certification_using_get(x_hojin_info_api_token, corporate_number)
|
39
|
+
p result
|
40
|
+
rescue Gbizinfo::ApiError => e
|
41
|
+
puts "Error when calling GBizINFORESTAPIApi->get_certification_using_get: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
#### Using the get_certification_using_get_with_http_info variant
|
46
|
+
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
48
|
+
|
49
|
+
> <Array(<HojinInfoResponse>, Integer, Hash)> get_certification_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
begin
|
53
|
+
# gBizINFOから届出・認定情報を取得します.
|
54
|
+
data, status_code, headers = api_instance.get_certification_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
55
|
+
p status_code # => 2xx
|
56
|
+
p headers # => { ... }
|
57
|
+
p data # => <HojinInfoResponse>
|
58
|
+
rescue Gbizinfo::ApiError => e
|
59
|
+
puts "Error when calling GBizINFORESTAPIApi->get_certification_using_get_with_http_info: #{e}"
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
### Parameters
|
64
|
+
|
65
|
+
| Name | Type | Description | Notes |
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
67
|
+
| **x_hojin_info_api_token** | **String** | APIトークン | |
|
68
|
+
| **corporate_number** | **String** | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。 | |
|
69
|
+
|
70
|
+
### Return type
|
71
|
+
|
72
|
+
[**HojinInfoResponse**](HojinInfoResponse.md)
|
73
|
+
|
74
|
+
### Authorization
|
75
|
+
|
76
|
+
No authorization required
|
77
|
+
|
78
|
+
### HTTP request headers
|
79
|
+
|
80
|
+
- **Content-Type**: Not defined
|
81
|
+
- **Accept**: application/json
|
82
|
+
|
83
|
+
|
84
|
+
## get_commendation_using_get
|
85
|
+
|
86
|
+
> <HojinInfoResponse> get_commendation_using_get(x_hojin_info_api_token, corporate_number)
|
87
|
+
|
88
|
+
gBizINFOから表彰情報を取得します.
|
89
|
+
|
90
|
+
指定された法人番号の情報を取得します。
|
91
|
+
|
92
|
+
### Examples
|
93
|
+
|
94
|
+
```ruby
|
95
|
+
require 'time'
|
96
|
+
require 'gbizinfo'
|
97
|
+
|
98
|
+
api_instance = Gbizinfo::GBizINFORESTAPIApi.new
|
99
|
+
x_hojin_info_api_token = 'x_hojin_info_api_token_example' # String | APIトークン
|
100
|
+
corporate_number = 'corporate_number_example' # String | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。
|
101
|
+
|
102
|
+
begin
|
103
|
+
# gBizINFOから表彰情報を取得します.
|
104
|
+
result = api_instance.get_commendation_using_get(x_hojin_info_api_token, corporate_number)
|
105
|
+
p result
|
106
|
+
rescue Gbizinfo::ApiError => e
|
107
|
+
puts "Error when calling GBizINFORESTAPIApi->get_commendation_using_get: #{e}"
|
108
|
+
end
|
109
|
+
```
|
110
|
+
|
111
|
+
#### Using the get_commendation_using_get_with_http_info variant
|
112
|
+
|
113
|
+
This returns an Array which contains the response data, status code and headers.
|
114
|
+
|
115
|
+
> <Array(<HojinInfoResponse>, Integer, Hash)> get_commendation_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
116
|
+
|
117
|
+
```ruby
|
118
|
+
begin
|
119
|
+
# gBizINFOから表彰情報を取得します.
|
120
|
+
data, status_code, headers = api_instance.get_commendation_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
121
|
+
p status_code # => 2xx
|
122
|
+
p headers # => { ... }
|
123
|
+
p data # => <HojinInfoResponse>
|
124
|
+
rescue Gbizinfo::ApiError => e
|
125
|
+
puts "Error when calling GBizINFORESTAPIApi->get_commendation_using_get_with_http_info: #{e}"
|
126
|
+
end
|
127
|
+
```
|
128
|
+
|
129
|
+
### Parameters
|
130
|
+
|
131
|
+
| Name | Type | Description | Notes |
|
132
|
+
| ---- | ---- | ----------- | ----- |
|
133
|
+
| **x_hojin_info_api_token** | **String** | APIトークン | |
|
134
|
+
| **corporate_number** | **String** | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。 | |
|
135
|
+
|
136
|
+
### Return type
|
137
|
+
|
138
|
+
[**HojinInfoResponse**](HojinInfoResponse.md)
|
139
|
+
|
140
|
+
### Authorization
|
141
|
+
|
142
|
+
No authorization required
|
143
|
+
|
144
|
+
### HTTP request headers
|
145
|
+
|
146
|
+
- **Content-Type**: Not defined
|
147
|
+
- **Accept**: application/json
|
148
|
+
|
149
|
+
|
150
|
+
## get_finance_using_get
|
151
|
+
|
152
|
+
> <HojinInfoResponse> get_finance_using_get(x_hojin_info_api_token, corporate_number)
|
153
|
+
|
154
|
+
gBizINFOから財務情報を取得します.
|
155
|
+
|
156
|
+
指定された法人番号の情報を取得します。
|
157
|
+
|
158
|
+
### Examples
|
159
|
+
|
160
|
+
```ruby
|
161
|
+
require 'time'
|
162
|
+
require 'gbizinfo'
|
163
|
+
|
164
|
+
api_instance = Gbizinfo::GBizINFORESTAPIApi.new
|
165
|
+
x_hojin_info_api_token = 'x_hojin_info_api_token_example' # String | APIトークン
|
166
|
+
corporate_number = 'corporate_number_example' # String | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。
|
167
|
+
|
168
|
+
begin
|
169
|
+
# gBizINFOから財務情報を取得します.
|
170
|
+
result = api_instance.get_finance_using_get(x_hojin_info_api_token, corporate_number)
|
171
|
+
p result
|
172
|
+
rescue Gbizinfo::ApiError => e
|
173
|
+
puts "Error when calling GBizINFORESTAPIApi->get_finance_using_get: #{e}"
|
174
|
+
end
|
175
|
+
```
|
176
|
+
|
177
|
+
#### Using the get_finance_using_get_with_http_info variant
|
178
|
+
|
179
|
+
This returns an Array which contains the response data, status code and headers.
|
180
|
+
|
181
|
+
> <Array(<HojinInfoResponse>, Integer, Hash)> get_finance_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
182
|
+
|
183
|
+
```ruby
|
184
|
+
begin
|
185
|
+
# gBizINFOから財務情報を取得します.
|
186
|
+
data, status_code, headers = api_instance.get_finance_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
187
|
+
p status_code # => 2xx
|
188
|
+
p headers # => { ... }
|
189
|
+
p data # => <HojinInfoResponse>
|
190
|
+
rescue Gbizinfo::ApiError => e
|
191
|
+
puts "Error when calling GBizINFORESTAPIApi->get_finance_using_get_with_http_info: #{e}"
|
192
|
+
end
|
193
|
+
```
|
194
|
+
|
195
|
+
### Parameters
|
196
|
+
|
197
|
+
| Name | Type | Description | Notes |
|
198
|
+
| ---- | ---- | ----------- | ----- |
|
199
|
+
| **x_hojin_info_api_token** | **String** | APIトークン | |
|
200
|
+
| **corporate_number** | **String** | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。 | |
|
201
|
+
|
202
|
+
### Return type
|
203
|
+
|
204
|
+
[**HojinInfoResponse**](HojinInfoResponse.md)
|
205
|
+
|
206
|
+
### Authorization
|
207
|
+
|
208
|
+
No authorization required
|
209
|
+
|
210
|
+
### HTTP request headers
|
211
|
+
|
212
|
+
- **Content-Type**: Not defined
|
213
|
+
- **Accept**: application/json
|
214
|
+
|
215
|
+
|
216
|
+
## get_patent_using_get
|
217
|
+
|
218
|
+
> <HojinInfoResponse> get_patent_using_get(x_hojin_info_api_token, corporate_number)
|
219
|
+
|
220
|
+
gBizINFOから特許情報を取得します.
|
221
|
+
|
222
|
+
指定された法人番号の情報を取得します。
|
223
|
+
|
224
|
+
### Examples
|
225
|
+
|
226
|
+
```ruby
|
227
|
+
require 'time'
|
228
|
+
require 'gbizinfo'
|
229
|
+
|
230
|
+
api_instance = Gbizinfo::GBizINFORESTAPIApi.new
|
231
|
+
x_hojin_info_api_token = 'x_hojin_info_api_token_example' # String | APIトークン
|
232
|
+
corporate_number = 'corporate_number_example' # String | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。
|
233
|
+
|
234
|
+
begin
|
235
|
+
# gBizINFOから特許情報を取得します.
|
236
|
+
result = api_instance.get_patent_using_get(x_hojin_info_api_token, corporate_number)
|
237
|
+
p result
|
238
|
+
rescue Gbizinfo::ApiError => e
|
239
|
+
puts "Error when calling GBizINFORESTAPIApi->get_patent_using_get: #{e}"
|
240
|
+
end
|
241
|
+
```
|
242
|
+
|
243
|
+
#### Using the get_patent_using_get_with_http_info variant
|
244
|
+
|
245
|
+
This returns an Array which contains the response data, status code and headers.
|
246
|
+
|
247
|
+
> <Array(<HojinInfoResponse>, Integer, Hash)> get_patent_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
248
|
+
|
249
|
+
```ruby
|
250
|
+
begin
|
251
|
+
# gBizINFOから特許情報を取得します.
|
252
|
+
data, status_code, headers = api_instance.get_patent_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
253
|
+
p status_code # => 2xx
|
254
|
+
p headers # => { ... }
|
255
|
+
p data # => <HojinInfoResponse>
|
256
|
+
rescue Gbizinfo::ApiError => e
|
257
|
+
puts "Error when calling GBizINFORESTAPIApi->get_patent_using_get_with_http_info: #{e}"
|
258
|
+
end
|
259
|
+
```
|
260
|
+
|
261
|
+
### Parameters
|
262
|
+
|
263
|
+
| Name | Type | Description | Notes |
|
264
|
+
| ---- | ---- | ----------- | ----- |
|
265
|
+
| **x_hojin_info_api_token** | **String** | APIトークン | |
|
266
|
+
| **corporate_number** | **String** | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。 | |
|
267
|
+
|
268
|
+
### Return type
|
269
|
+
|
270
|
+
[**HojinInfoResponse**](HojinInfoResponse.md)
|
271
|
+
|
272
|
+
### Authorization
|
273
|
+
|
274
|
+
No authorization required
|
275
|
+
|
276
|
+
### HTTP request headers
|
277
|
+
|
278
|
+
- **Content-Type**: Not defined
|
279
|
+
- **Accept**: application/json
|
280
|
+
|
281
|
+
|
282
|
+
## get_procurement_using_get
|
283
|
+
|
284
|
+
> <HojinInfoResponse> get_procurement_using_get(x_hojin_info_api_token, corporate_number)
|
285
|
+
|
286
|
+
gBizINFOから調達情報を取得します.
|
287
|
+
|
288
|
+
指定された法人番号の情報を取得します。
|
289
|
+
|
290
|
+
### Examples
|
291
|
+
|
292
|
+
```ruby
|
293
|
+
require 'time'
|
294
|
+
require 'gbizinfo'
|
295
|
+
|
296
|
+
api_instance = Gbizinfo::GBizINFORESTAPIApi.new
|
297
|
+
x_hojin_info_api_token = 'x_hojin_info_api_token_example' # String | APIトークン
|
298
|
+
corporate_number = 'corporate_number_example' # String | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。
|
299
|
+
|
300
|
+
begin
|
301
|
+
# gBizINFOから調達情報を取得します.
|
302
|
+
result = api_instance.get_procurement_using_get(x_hojin_info_api_token, corporate_number)
|
303
|
+
p result
|
304
|
+
rescue Gbizinfo::ApiError => e
|
305
|
+
puts "Error when calling GBizINFORESTAPIApi->get_procurement_using_get: #{e}"
|
306
|
+
end
|
307
|
+
```
|
308
|
+
|
309
|
+
#### Using the get_procurement_using_get_with_http_info variant
|
310
|
+
|
311
|
+
This returns an Array which contains the response data, status code and headers.
|
312
|
+
|
313
|
+
> <Array(<HojinInfoResponse>, Integer, Hash)> get_procurement_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
314
|
+
|
315
|
+
```ruby
|
316
|
+
begin
|
317
|
+
# gBizINFOから調達情報を取得します.
|
318
|
+
data, status_code, headers = api_instance.get_procurement_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
319
|
+
p status_code # => 2xx
|
320
|
+
p headers # => { ... }
|
321
|
+
p data # => <HojinInfoResponse>
|
322
|
+
rescue Gbizinfo::ApiError => e
|
323
|
+
puts "Error when calling GBizINFORESTAPIApi->get_procurement_using_get_with_http_info: #{e}"
|
324
|
+
end
|
325
|
+
```
|
326
|
+
|
327
|
+
### Parameters
|
328
|
+
|
329
|
+
| Name | Type | Description | Notes |
|
330
|
+
| ---- | ---- | ----------- | ----- |
|
331
|
+
| **x_hojin_info_api_token** | **String** | APIトークン | |
|
332
|
+
| **corporate_number** | **String** | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。 | |
|
333
|
+
|
334
|
+
### Return type
|
335
|
+
|
336
|
+
[**HojinInfoResponse**](HojinInfoResponse.md)
|
337
|
+
|
338
|
+
### Authorization
|
339
|
+
|
340
|
+
No authorization required
|
341
|
+
|
342
|
+
### HTTP request headers
|
343
|
+
|
344
|
+
- **Content-Type**: Not defined
|
345
|
+
- **Accept**: application/json
|
346
|
+
|
347
|
+
|
348
|
+
## get_subsidy_using_get
|
349
|
+
|
350
|
+
> <HojinInfoResponse> get_subsidy_using_get(x_hojin_info_api_token, corporate_number)
|
351
|
+
|
352
|
+
gBizINFOから補助金情報を取得します.
|
353
|
+
|
354
|
+
指定された法人番号の情報を取得します。
|
355
|
+
|
356
|
+
### Examples
|
357
|
+
|
358
|
+
```ruby
|
359
|
+
require 'time'
|
360
|
+
require 'gbizinfo'
|
361
|
+
|
362
|
+
api_instance = Gbizinfo::GBizINFORESTAPIApi.new
|
363
|
+
x_hojin_info_api_token = 'x_hojin_info_api_token_example' # String | APIトークン
|
364
|
+
corporate_number = 'corporate_number_example' # String | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。
|
365
|
+
|
366
|
+
begin
|
367
|
+
# gBizINFOから補助金情報を取得します.
|
368
|
+
result = api_instance.get_subsidy_using_get(x_hojin_info_api_token, corporate_number)
|
369
|
+
p result
|
370
|
+
rescue Gbizinfo::ApiError => e
|
371
|
+
puts "Error when calling GBizINFORESTAPIApi->get_subsidy_using_get: #{e}"
|
372
|
+
end
|
373
|
+
```
|
374
|
+
|
375
|
+
#### Using the get_subsidy_using_get_with_http_info variant
|
376
|
+
|
377
|
+
This returns an Array which contains the response data, status code and headers.
|
378
|
+
|
379
|
+
> <Array(<HojinInfoResponse>, Integer, Hash)> get_subsidy_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
380
|
+
|
381
|
+
```ruby
|
382
|
+
begin
|
383
|
+
# gBizINFOから補助金情報を取得します.
|
384
|
+
data, status_code, headers = api_instance.get_subsidy_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
385
|
+
p status_code # => 2xx
|
386
|
+
p headers # => { ... }
|
387
|
+
p data # => <HojinInfoResponse>
|
388
|
+
rescue Gbizinfo::ApiError => e
|
389
|
+
puts "Error when calling GBizINFORESTAPIApi->get_subsidy_using_get_with_http_info: #{e}"
|
390
|
+
end
|
391
|
+
```
|
392
|
+
|
393
|
+
### Parameters
|
394
|
+
|
395
|
+
| Name | Type | Description | Notes |
|
396
|
+
| ---- | ---- | ----------- | ----- |
|
397
|
+
| **x_hojin_info_api_token** | **String** | APIトークン | |
|
398
|
+
| **corporate_number** | **String** | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。 | |
|
399
|
+
|
400
|
+
### Return type
|
401
|
+
|
402
|
+
[**HojinInfoResponse**](HojinInfoResponse.md)
|
403
|
+
|
404
|
+
### Authorization
|
405
|
+
|
406
|
+
No authorization required
|
407
|
+
|
408
|
+
### HTTP request headers
|
409
|
+
|
410
|
+
- **Content-Type**: Not defined
|
411
|
+
- **Accept**: application/json
|
412
|
+
|
413
|
+
|
414
|
+
## get_using_get
|
415
|
+
|
416
|
+
> <HojinInfoResponse> get_using_get(x_hojin_info_api_token, corporate_number)
|
417
|
+
|
418
|
+
gBizINFOから法人基本情報を取得します.
|
419
|
+
|
420
|
+
指定された法人番号の情報を取得します。
|
421
|
+
|
422
|
+
### Examples
|
423
|
+
|
424
|
+
```ruby
|
425
|
+
require 'time'
|
426
|
+
require 'gbizinfo'
|
427
|
+
|
428
|
+
api_instance = Gbizinfo::GBizINFORESTAPIApi.new
|
429
|
+
x_hojin_info_api_token = 'x_hojin_info_api_token_example' # String | APIトークン
|
430
|
+
corporate_number = 'corporate_number_example' # String | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。
|
431
|
+
|
432
|
+
begin
|
433
|
+
# gBizINFOから法人基本情報を取得します.
|
434
|
+
result = api_instance.get_using_get(x_hojin_info_api_token, corporate_number)
|
435
|
+
p result
|
436
|
+
rescue Gbizinfo::ApiError => e
|
437
|
+
puts "Error when calling GBizINFORESTAPIApi->get_using_get: #{e}"
|
438
|
+
end
|
439
|
+
```
|
440
|
+
|
441
|
+
#### Using the get_using_get_with_http_info variant
|
442
|
+
|
443
|
+
This returns an Array which contains the response data, status code and headers.
|
444
|
+
|
445
|
+
> <Array(<HojinInfoResponse>, Integer, Hash)> get_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
446
|
+
|
447
|
+
```ruby
|
448
|
+
begin
|
449
|
+
# gBizINFOから法人基本情報を取得します.
|
450
|
+
data, status_code, headers = api_instance.get_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
451
|
+
p status_code # => 2xx
|
452
|
+
p headers # => { ... }
|
453
|
+
p data # => <HojinInfoResponse>
|
454
|
+
rescue Gbizinfo::ApiError => e
|
455
|
+
puts "Error when calling GBizINFORESTAPIApi->get_using_get_with_http_info: #{e}"
|
456
|
+
end
|
457
|
+
```
|
458
|
+
|
459
|
+
### Parameters
|
460
|
+
|
461
|
+
| Name | Type | Description | Notes |
|
462
|
+
| ---- | ---- | ----------- | ----- |
|
463
|
+
| **x_hojin_info_api_token** | **String** | APIトークン | |
|
464
|
+
| **corporate_number** | **String** | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。 | |
|
465
|
+
|
466
|
+
### Return type
|
467
|
+
|
468
|
+
[**HojinInfoResponse**](HojinInfoResponse.md)
|
469
|
+
|
470
|
+
### Authorization
|
471
|
+
|
472
|
+
No authorization required
|
473
|
+
|
474
|
+
### HTTP request headers
|
475
|
+
|
476
|
+
- **Content-Type**: Not defined
|
477
|
+
- **Accept**: application/json
|
478
|
+
|
479
|
+
|
480
|
+
## get_workplace_information_using_get
|
481
|
+
|
482
|
+
> <HojinInfoResponse> get_workplace_information_using_get(x_hojin_info_api_token, corporate_number)
|
483
|
+
|
484
|
+
gBizINFOから職場情報を取得します.
|
485
|
+
|
486
|
+
指定された法人番号の情報を取得します。
|
487
|
+
|
488
|
+
### Examples
|
489
|
+
|
490
|
+
```ruby
|
491
|
+
require 'time'
|
492
|
+
require 'gbizinfo'
|
493
|
+
|
494
|
+
api_instance = Gbizinfo::GBizINFORESTAPIApi.new
|
495
|
+
x_hojin_info_api_token = 'x_hojin_info_api_token_example' # String | APIトークン
|
496
|
+
corporate_number = 'corporate_number_example' # String | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。
|
497
|
+
|
498
|
+
begin
|
499
|
+
# gBizINFOから職場情報を取得します.
|
500
|
+
result = api_instance.get_workplace_information_using_get(x_hojin_info_api_token, corporate_number)
|
501
|
+
p result
|
502
|
+
rescue Gbizinfo::ApiError => e
|
503
|
+
puts "Error when calling GBizINFORESTAPIApi->get_workplace_information_using_get: #{e}"
|
504
|
+
end
|
505
|
+
```
|
506
|
+
|
507
|
+
#### Using the get_workplace_information_using_get_with_http_info variant
|
508
|
+
|
509
|
+
This returns an Array which contains the response data, status code and headers.
|
510
|
+
|
511
|
+
> <Array(<HojinInfoResponse>, Integer, Hash)> get_workplace_information_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
512
|
+
|
513
|
+
```ruby
|
514
|
+
begin
|
515
|
+
# gBizINFOから職場情報を取得します.
|
516
|
+
data, status_code, headers = api_instance.get_workplace_information_using_get_with_http_info(x_hojin_info_api_token, corporate_number)
|
517
|
+
p status_code # => 2xx
|
518
|
+
p headers # => { ... }
|
519
|
+
p data # => <HojinInfoResponse>
|
520
|
+
rescue Gbizinfo::ApiError => e
|
521
|
+
puts "Error when calling GBizINFORESTAPIApi->get_workplace_information_using_get_with_http_info: #{e}"
|
522
|
+
end
|
523
|
+
```
|
524
|
+
|
525
|
+
### Parameters
|
526
|
+
|
527
|
+
| Name | Type | Description | Notes |
|
528
|
+
| ---- | ---- | ----------- | ----- |
|
529
|
+
| **x_hojin_info_api_token** | **String** | APIトークン | |
|
530
|
+
| **corporate_number** | **String** | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。 | |
|
531
|
+
|
532
|
+
### Return type
|
533
|
+
|
534
|
+
[**HojinInfoResponse**](HojinInfoResponse.md)
|
535
|
+
|
536
|
+
### Authorization
|
537
|
+
|
538
|
+
No authorization required
|
539
|
+
|
540
|
+
### HTTP request headers
|
541
|
+
|
542
|
+
- **Content-Type**: Not defined
|
543
|
+
- **Accept**: application/json
|
544
|
+
|
545
|
+
|
546
|
+
## search_info_using_get
|
547
|
+
|
548
|
+
> <HojinInfoResponse> search_info_using_get(x_hojin_info_api_token, opts)
|
549
|
+
|
550
|
+
gBizINFOに登録された法人を検索します.
|
551
|
+
|
552
|
+
gBizINFOに登録された法人を検索します。
|
553
|
+
|
554
|
+
### Examples
|
555
|
+
|
556
|
+
```ruby
|
557
|
+
require 'time'
|
558
|
+
require 'gbizinfo'
|
559
|
+
|
560
|
+
api_instance = Gbizinfo::GBizINFORESTAPIApi.new
|
561
|
+
x_hojin_info_api_token = 'x_hojin_info_api_token_example' # String | APIトークン
|
562
|
+
opts = {
|
563
|
+
corporate_number: 'corporate_number_example', # String | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。
|
564
|
+
name: 'name_example', # String | 法人名:法人名を設定。 入力された法人名を部分一致で検索。
|
565
|
+
exist_flg: 'exist_flg_example', # String | 法人活動情報:以下のコードを設定。 true あり false なし
|
566
|
+
corporate_type: 'corporate_type_example', # String | 法人種別:以下のコードを設定。 101 国の機関 201 地方公共団体 301 株式会社 302 有限会社 303 合名会社 304 合資会社 305 合同会社 399 その他の設立登記法人 401 外国会社等 499 その他 複数の場合はカンマ区切りでコードを設定。
|
567
|
+
prefecture: 'prefecture_example', # String | 所在地(都道府県):JIS X 0401都道府県コードを設定。
|
568
|
+
city: 'city_example', # String | 所在地(市区町村):総務省地方公共団体コードの市区町村コードを設定。(prefecture設定必須)
|
569
|
+
capital_stock_from: 'capital_stock_from_example', # String | 資本金(以上):資本金の下限を設定。0以上の整数を設定。
|
570
|
+
capital_stock_to: 'capital_stock_to_example', # String | 資本金(以下):資本金の上限を設定。0以上の整数を設定。
|
571
|
+
employee_number_from: 'employee_number_from_example', # String | 従業員数(以上):従業員数の下限を設定。0以上の整数を設定。
|
572
|
+
employee_number_to: 'employee_number_to_example', # String | 従業員数(以下):従業員数の上限を設定。0以上の整数を設定。
|
573
|
+
founded_year: 'founded_year_example', # String | 創業年・設立年:正の整数を設定。 複数の場合はカンマ区切りで年を設定。
|
574
|
+
sales_area: 'sales_area_example', # String | 営業エリア:https://info.gbiz.go.jp/codelist/document/codelist.pdf 地域対応表のgBizINFOのマスターコードを設定。 複数の場合はカンマ区切りでコードを設定。
|
575
|
+
business_item: 'business_item_example', # String | 全省庁統一資格の営業品目:https://info.gbiz.go.jp/codelist/document/codelist.pdf 営業品目コードを設定。 複数の場合はカンマ区切りでコードを設定。
|
576
|
+
unified_qualification: 'unified_qualification_example', # String | 全省庁統一資格の資格等級(従来型):従来型の資格等級指定を行う場合に使用する。資格等級(物品の製造、物品の販売、役務の提供等、物品の買受け)のいずれかがA,B,C,Dであるものを指定。複数指定の場合は半角カンマ区切りで半角コードを設定。
|
577
|
+
unified_qualification_sub01: 'unified_qualification_sub01_example', # String | 全省庁統一資格の資格等級(物品の製造):物品の製造をA,B,C,Dで指定。複数指定の場合は半角カンマ区切りで半角コードを設定。
|
578
|
+
unified_qualification_sub02: 'unified_qualification_sub02_example', # String | 全省庁統一資格の資格等級(物品の販売):物品の販売をA,B,C,Dで指定。複数指定の場合は半角カンマ区切りで半角コードを設定。
|
579
|
+
unified_qualification_sub03: 'unified_qualification_sub03_example', # String | 全省庁統一資格の資格等級(役務の提供等):役務の提供等をA,B,C,Dで指定。複数指定の場合は半角カンマ区切りで半角コードを設定。
|
580
|
+
unified_qualification_sub04: 'unified_qualification_sub04_example', # String | 全省庁統一資格の資格等級(物品の買受け):物品の買受けをA,B,C,Dで指定。複数指定の場合は半角カンマ区切りで半角コードを設定。
|
581
|
+
net_sales_summary_of_business_results_from: 'net_sales_summary_of_business_results_from_example', # String | 売上高(以上):売上高の下限を設定。0以上の整数を設定。
|
582
|
+
net_sales_summary_of_business_results_to: 'net_sales_summary_of_business_results_to_example', # String | 売上高(以下):売上高の上限を設定。0以上の整数を設定。
|
583
|
+
net_income_loss_summary_of_business_results_from: 'net_income_loss_summary_of_business_results_from_example', # String | 当期純利益又は当期純損失(△)(以上):当期純利益又は当期純損失(△)の下限を設定。0以上の整数を設定。
|
584
|
+
net_income_loss_summary_of_business_results_to: 'net_income_loss_summary_of_business_results_to_example', # String | 当期純利益又は当期純損失(△)(以下):当期純利益又は当期純損失(△)の上限を設定。0以上の整数を設定。
|
585
|
+
total_assets_summary_of_business_results_from: 'total_assets_summary_of_business_results_from_example', # String | 総資産額(以上):総資産額の下限を設定。0以上の整数を設定。
|
586
|
+
total_assets_summary_of_business_results_to: 'total_assets_summary_of_business_results_to_example', # String | 総資産額(以下):総資産額の上限を設定。0以上の整数を設定。
|
587
|
+
name_major_shareholders: 'name_major_shareholders_example', # String | 大株主名:大株主名を設定。 入力された大株主名を部分一致で検索。
|
588
|
+
average_continuous_service_years: 'average_continuous_service_years_example', # String | 平均継続勤務年数:以下のコードを設定。 A:~5年 B:6年~10年 C:11年~20年 D:21年~
|
589
|
+
average_age: 'average_age_example', # String | 従業員の平均年齢:以下のコードを設定。 A:~30歳 B:31歳~45歳 C:46歳~60歳 D:61歳~
|
590
|
+
month_average_predetermined_overtime_hours: 'month_average_predetermined_overtime_hours_example', # String | 月平均所定外労働時間:以下のコードを設定。 A:20時間未満 B:40時間未満 C:40時間以上
|
591
|
+
female_workers_proportion: 'female_workers_proportion_example', # String | 労働者に占める女性労働者の割合:以下のコードを設定。 A:~20% B:21%~40% C:41%~60% D:61%~
|
592
|
+
year: 'year_example', # String | 年度:正の整数を設定。 複数の場合はカンマ区切りで年を設定。
|
593
|
+
ministry: 'ministry_example', # String | 担当府省: 担当府省コードの内部コードを指定。複数の場合はカンマ区切りでコードを設定。 内部コードは以下。 https://info.gbiz.go.jp/common/data/setcodelist.pdf
|
594
|
+
source: 'source_example', # String | 出典元:以下のコードを設定。 1 調達 2 表彰 3 届出認定 4 補助金 5 特許 6 財務 複数の場合はカンマ区切りでコードを設定。
|
595
|
+
page: 'page_example', # String | 検索結果のページ番号:正の整数を設定。 下限値1,上限値10。
|
596
|
+
limit: 'limit_example' # String | 検索結果の1ページあたりの件数:0以上の整数を設定。 下限値0,上限値5000。
|
597
|
+
}
|
598
|
+
|
599
|
+
begin
|
600
|
+
# gBizINFOに登録された法人を検索します.
|
601
|
+
result = api_instance.search_info_using_get(x_hojin_info_api_token, opts)
|
602
|
+
p result
|
603
|
+
rescue Gbizinfo::ApiError => e
|
604
|
+
puts "Error when calling GBizINFORESTAPIApi->search_info_using_get: #{e}"
|
605
|
+
end
|
606
|
+
```
|
607
|
+
|
608
|
+
#### Using the search_info_using_get_with_http_info variant
|
609
|
+
|
610
|
+
This returns an Array which contains the response data, status code and headers.
|
611
|
+
|
612
|
+
> <Array(<HojinInfoResponse>, Integer, Hash)> search_info_using_get_with_http_info(x_hojin_info_api_token, opts)
|
613
|
+
|
614
|
+
```ruby
|
615
|
+
begin
|
616
|
+
# gBizINFOに登録された法人を検索します.
|
617
|
+
data, status_code, headers = api_instance.search_info_using_get_with_http_info(x_hojin_info_api_token, opts)
|
618
|
+
p status_code # => 2xx
|
619
|
+
p headers # => { ... }
|
620
|
+
p data # => <HojinInfoResponse>
|
621
|
+
rescue Gbizinfo::ApiError => e
|
622
|
+
puts "Error when calling GBizINFORESTAPIApi->search_info_using_get_with_http_info: #{e}"
|
623
|
+
end
|
624
|
+
```
|
625
|
+
|
626
|
+
### Parameters
|
627
|
+
|
628
|
+
| Name | Type | Description | Notes |
|
629
|
+
| ---- | ---- | ----------- | ----- |
|
630
|
+
| **x_hojin_info_api_token** | **String** | APIトークン | |
|
631
|
+
| **corporate_number** | **String** | 法人番号:法人番号を設定。 入力された法人番号を完全一致で検索。 | [optional] |
|
632
|
+
| **name** | **String** | 法人名:法人名を設定。 入力された法人名を部分一致で検索。 | [optional] |
|
633
|
+
| **exist_flg** | **String** | 法人活動情報:以下のコードを設定。 true あり false なし | [optional] |
|
634
|
+
| **corporate_type** | **String** | 法人種別:以下のコードを設定。 101 国の機関 201 地方公共団体 301 株式会社 302 有限会社 303 合名会社 304 合資会社 305 合同会社 399 その他の設立登記法人 401 外国会社等 499 その他 複数の場合はカンマ区切りでコードを設定。 | [optional] |
|
635
|
+
| **prefecture** | **String** | 所在地(都道府県):JIS X 0401都道府県コードを設定。 | [optional] |
|
636
|
+
| **city** | **String** | 所在地(市区町村):総務省地方公共団体コードの市区町村コードを設定。(prefecture設定必須) | [optional] |
|
637
|
+
| **capital_stock_from** | **String** | 資本金(以上):資本金の下限を設定。0以上の整数を設定。 | [optional] |
|
638
|
+
| **capital_stock_to** | **String** | 資本金(以下):資本金の上限を設定。0以上の整数を設定。 | [optional] |
|
639
|
+
| **employee_number_from** | **String** | 従業員数(以上):従業員数の下限を設定。0以上の整数を設定。 | [optional] |
|
640
|
+
| **employee_number_to** | **String** | 従業員数(以下):従業員数の上限を設定。0以上の整数を設定。 | [optional] |
|
641
|
+
| **founded_year** | **String** | 創業年・設立年:正の整数を設定。 複数の場合はカンマ区切りで年を設定。 | [optional] |
|
642
|
+
| **sales_area** | **String** | 営業エリア:https://info.gbiz.go.jp/codelist/document/codelist.pdf 地域対応表のgBizINFOのマスターコードを設定。 複数の場合はカンマ区切りでコードを設定。 | [optional] |
|
643
|
+
| **business_item** | **String** | 全省庁統一資格の営業品目:https://info.gbiz.go.jp/codelist/document/codelist.pdf 営業品目コードを設定。 複数の場合はカンマ区切りでコードを設定。 | [optional] |
|
644
|
+
| **unified_qualification** | **String** | 全省庁統一資格の資格等級(従来型):従来型の資格等級指定を行う場合に使用する。資格等級(物品の製造、物品の販売、役務の提供等、物品の買受け)のいずれかがA,B,C,Dであるものを指定。複数指定の場合は半角カンマ区切りで半角コードを設定。 | [optional] |
|
645
|
+
| **unified_qualification_sub01** | **String** | 全省庁統一資格の資格等級(物品の製造):物品の製造をA,B,C,Dで指定。複数指定の場合は半角カンマ区切りで半角コードを設定。 | [optional] |
|
646
|
+
| **unified_qualification_sub02** | **String** | 全省庁統一資格の資格等級(物品の販売):物品の販売をA,B,C,Dで指定。複数指定の場合は半角カンマ区切りで半角コードを設定。 | [optional] |
|
647
|
+
| **unified_qualification_sub03** | **String** | 全省庁統一資格の資格等級(役務の提供等):役務の提供等をA,B,C,Dで指定。複数指定の場合は半角カンマ区切りで半角コードを設定。 | [optional] |
|
648
|
+
| **unified_qualification_sub04** | **String** | 全省庁統一資格の資格等級(物品の買受け):物品の買受けをA,B,C,Dで指定。複数指定の場合は半角カンマ区切りで半角コードを設定。 | [optional] |
|
649
|
+
| **net_sales_summary_of_business_results_from** | **String** | 売上高(以上):売上高の下限を設定。0以上の整数を設定。 | [optional] |
|
650
|
+
| **net_sales_summary_of_business_results_to** | **String** | 売上高(以下):売上高の上限を設定。0以上の整数を設定。 | [optional] |
|
651
|
+
| **net_income_loss_summary_of_business_results_from** | **String** | 当期純利益又は当期純損失(△)(以上):当期純利益又は当期純損失(△)の下限を設定。0以上の整数を設定。 | [optional] |
|
652
|
+
| **net_income_loss_summary_of_business_results_to** | **String** | 当期純利益又は当期純損失(△)(以下):当期純利益又は当期純損失(△)の上限を設定。0以上の整数を設定。 | [optional] |
|
653
|
+
| **total_assets_summary_of_business_results_from** | **String** | 総資産額(以上):総資産額の下限を設定。0以上の整数を設定。 | [optional] |
|
654
|
+
| **total_assets_summary_of_business_results_to** | **String** | 総資産額(以下):総資産額の上限を設定。0以上の整数を設定。 | [optional] |
|
655
|
+
| **name_major_shareholders** | **String** | 大株主名:大株主名を設定。 入力された大株主名を部分一致で検索。 | [optional] |
|
656
|
+
| **average_continuous_service_years** | **String** | 平均継続勤務年数:以下のコードを設定。 A:~5年 B:6年~10年 C:11年~20年 D:21年~ | [optional] |
|
657
|
+
| **average_age** | **String** | 従業員の平均年齢:以下のコードを設定。 A:~30歳 B:31歳~45歳 C:46歳~60歳 D:61歳~ | [optional] |
|
658
|
+
| **month_average_predetermined_overtime_hours** | **String** | 月平均所定外労働時間:以下のコードを設定。 A:20時間未満 B:40時間未満 C:40時間以上 | [optional] |
|
659
|
+
| **female_workers_proportion** | **String** | 労働者に占める女性労働者の割合:以下のコードを設定。 A:~20% B:21%~40% C:41%~60% D:61%~ | [optional] |
|
660
|
+
| **year** | **String** | 年度:正の整数を設定。 複数の場合はカンマ区切りで年を設定。 | [optional] |
|
661
|
+
| **ministry** | **String** | 担当府省: 担当府省コードの内部コードを指定。複数の場合はカンマ区切りでコードを設定。 内部コードは以下。 https://info.gbiz.go.jp/common/data/setcodelist.pdf | [optional] |
|
662
|
+
| **source** | **String** | 出典元:以下のコードを設定。 1 調達 2 表彰 3 届出認定 4 補助金 5 特許 6 財務 複数の場合はカンマ区切りでコードを設定。 | [optional] |
|
663
|
+
| **page** | **String** | 検索結果のページ番号:正の整数を設定。 下限値1,上限値10。 | [optional][default to '1'] |
|
664
|
+
| **limit** | **String** | 検索結果の1ページあたりの件数:0以上の整数を設定。 下限値0,上限値5000。 | [optional][default to '1000'] |
|
665
|
+
|
666
|
+
### Return type
|
667
|
+
|
668
|
+
[**HojinInfoResponse**](HojinInfoResponse.md)
|
669
|
+
|
670
|
+
### Authorization
|
671
|
+
|
672
|
+
No authorization required
|
673
|
+
|
674
|
+
### HTTP request headers
|
675
|
+
|
676
|
+
- **Content-Type**: Not defined
|
677
|
+
- **Accept**: application/json
|
678
|
+
|