跳到正文

API 文档

v1.0.0

搜索案卷

GET /api/v1/cases

scope: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

每页结果数,最多 100

integer | null每页结果数,最多 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

响应,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

响应,HTTP 422
名称类型说明
error 必填 object
error.code 必填

Stable error code, for example not_found or validation_failed

stringStable error code, for example not_found or validation_failed
error.message 必填

Human-readable explanation

stringHuman-readable explanation
error.details

Extra information, such as the fields that failed validation

objectExtra information, such as the fields that failed validation

响应字段见 openapi.json。每个值及其来源的构成方式请参阅 数据与来源文件