Gå til indhold

API-documentatie

v1.0.0

Veiling

GET /api/v1/auctions/{auction}

scope: auctions:read 1 credits

Eén veiling met gekoppelde dossiers en de reden van de koppeling.

Padparameters

Padparameters
NaamTypeOmschrijving
auction verplicht

Veiling-id (ULID)

stringVeiling-id (ULID)

Antwoord, HTTP 200

Antwoord, HTTP 200

Antwoord, HTTP 200
NaamTypeOmschrijving
data verplicht object
data.matches verplicht string[]
data.sources verplicht mixed[]

Antwoord, HTTP 404

Not found

Antwoord, HTTP 404

Antwoord, HTTP 404
NaamTypeOmschrijving
error verplicht object
error.code verplicht

Stable error code, for example not_found or validation_failed

stringStable error code, for example not_found or validation_failed
error.message verplicht

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

De velden van het antwoord staan in openapi.json. Hoe elke waarde met bron is opgebouwd, leest u bij Gegevens en brondocumenten