跳到正文

API 文档

v1.0.0

拍卖

GET /api/v1/auctions

scope:auctions:read 1 个额度

来自破产案件的拍卖,附与案卷的关联及来源。

查询参数

查询参数
名称类型说明
q

搜索文本

string | null搜索文本
closing enum | null today, 7d, 30d, null
category[] enum[] construction_machinery, vehicles, tools, stock, office_it, hospitality, real_estate, other
provider[] string[]
linked boolean | null
sector enum | null A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, null
curator string | null
postcode string | null
radius enum | null 10, 25, 50, 100, null
province enum | null Groningen, Fryslân, Drenthe, Overijssel, Flevoland, Gelderland, Utrecht, Noord-Holland, Zuid-Holland, Zeeland, Noord-Brabant, Limburg, null
sort

排序

enum | null排序 closing, distance, newest, null
group enum | null case, null
page

页码

integer | null页码

响应,HTTP 200

响应,HTTP 200

响应,HTTP 200
名称类型说明
data 必填 mixed[]
meta 必填 object
meta.total 必填 integer
meta.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。每个值及其来源的构成方式请参阅 数据与来源文件