案件の検索
GET /api/v1/cases
スコープ:cases:read 1 クレジット
検索ページと同じフィルターで検索と絞り込みを行います。財務フィルターと項目フィルターには、高度な検索を含むプランが必要です。
クエリパラメーター
| 名前 | 型 | 説明 |
|---|---|---|
sort 並べ替え | enum | null | 並べ替え relevance, declared_desc, declared_asc, name, estate_assets_desc, creditor_count_desc, distance, null |
page ページ番号 | integer | null | ページ番号 |
per_page 1ページあたりの結果数(最大100) | integer | null | 1ページあたりの結果数(最大100) |
q 検索テキスト | string | null | 検索テキスト |
q_scope | enum | null | all, name, kvk, curator, location, null |
status[] | enum[] | active, terminated, converted, transferred, annulled |
procedure[] | string[] | |
declared_from | string | null | |
declared_to | string | null | |
cir_publication_from | string | null | |
cir_publication_to | string | null | |
province[] | enum | Groningen, Fryslân, Drenthe, Overijssel, Flevoland, Gelderland, Utrecht, Noord-Holland, Zuid-Holland, Zeeland, Noord-Brabant, Limburg |
city | string | null | |
municipality | string | null | |
postcode | string | null | |
radius | integer | null | |
bbox | string | null | |
court[] | string[] | |
curator[] | string[] | |
law_firm[] | string[] | |
legal_form[] | string[] | |
sbi[] | string[] | |
industry | enum | null | landbouw-bosbouw-en-visserij, delfstoffenwinning, industrie, energievoorziening, water-en-afvalbeheer, bouw, groot-en-detailhandel, vervoer-en-opslag, horeca, informatie-en-communicatie, financiele-dienstverlening, onroerend-goed, specialistische-zakelijke-diensten, overige-zakelijke-diensten, openbaar-bestuur, onderwijs, gezondheids-en-welzijnszorg, cultuur-sport-en-recreatie, overige-dienstverlening, huishoudens, extraterritoriale-organisaties, null |
has_report | boolean | null | |
topic[] | string[] | |
estate_assets_min | number | null | |
estate_assets_max | number | null | |
concurrent_claims_min | number | null | |
concurrent_claims_max | number | null | |
creditor_count_min | number | null | |
creditor_count_max | number | null | |
employee_count_min | number | null | |
employee_count_max | number | null | |
conditions | string | null |
応答、HTTP 200
Public data
応答、HTTP 200
| 名前 | 型 | 説明 |
|---|---|---|
data 必須 | object[] | |
data[].id 必須 | string | |
data[].slug 必須 | string | |
data[].name 必須 | string | |
data[].status 必須 | string | |
data[].procedure 必須 | string | |
data[].insolvency_number 必須 | string | |
data[].declared_on 必須 | string | |
data[].last_cir_publication_on 必須 | string | null | |
data[].terminated_on 必須 | string | null | |
data[].legal_form 必須 | string | null | |
data[].sbi_code 必須 | string | null | |
data[].sbi_section 必須 | string | null | |
data[].last_report_on 必須 | string | null | |
data[].court 必須 | object | |
data[].court.name 必須 | string | null | |
data[].court.slug 必須 | string | null | |
data[].location 必須 | object | |
data[].location.city 必須 | string | null | |
data[].location.municipality 必須 | string | null | |
data[].location.province 必須 | string | null | |
data[].location.lat 必須 | number | null | |
data[].location.lng 必須 | number | null | |
data[].curator 必須 | object | null | |
data[].curator.name 必須 | string | |
data[].curator.slug 必須 | string | null | |
data[].figures 必須 | object | |
data[].figures.estate_assets 必須 | number | null | |
data[].figures.concurrent_claims 必須 | number | null | |
data[].figures.creditor_count 必須 | integer | null | |
data[].figures.employee_count 必須 | integer | null | |
data[].report_count 必須 | integer | |
data[].topics 必須 | object[] | |
data[].topics[].topic 必須 | string | |
data[].topics[].state 必須 | string | |
data[].links 必須 | object | |
data[].links.self 必須 | string | |
data[].links.web 必須 | string | |
meta 必須 | object | |
meta.total 必須 | integer | |
meta.page 必須 | integer | |
meta.per_page 必須 | integer | |
meta.last_page 必須 | integer |
応答、HTTP 422
Validation error
応答、HTTP 422
| 名前 | 型 | 説明 |
|---|---|---|
error 必須 | object | |
error.code 必須 Stable error code, for example not_found or validation_failed | string | Stable error code, for example not_found or validation_failed |
error.message 必須 Human-readable explanation | string | Human-readable explanation |
error.details Extra information, such as the fields that failed validation | object | Extra information, such as the fields that failed validation |
応答のフィールドは openapi.json に記載されています。各値が出典とともにどのように構成されているかは、次をご覧ください: データと出典文書