Zum Inhalt springen

API-documentatie

v1.0.0

Historie van een gegeven

GET /api/v1/cases/{case}/fields/{field}/history

scope: history:read 2 credits

Alle waarden van één gegeven door de verslagen heen, inclusief curatorbevestigingen en correcties.

Padparameters

Padparameters
NaamTypeOmschrijving
case verplicht

Dossier-id (ULID) of de slug van het dossier

stringDossier-id (ULID) of de slug van het dossier
field verplicht

Naam van het gegeven, bijvoorbeeld estate_assets

stringNaam van het gegeven, bijvoorbeeld estate_assets

Antwoord, HTTP 200

Public data

Antwoord, HTTP 200

Antwoord, HTTP 200
NaamTypeOmschrijving
data verplicht object[]
data[].id verplicht string
data[].value verplicht number | null
data[].state verplicht enum known, not_mentioned, not_known, not_reported
data[].qualifier verplicht string | null
data[].as_of verplicht string
data[].report_number verplicht integer | null
data[].report_date verplicht string | null
data[].current verplicht boolean
data[].sources verplicht object | null[]
data[].sources[].document verplicht object | null
data[].sources[].document.id verplicht string
data[].sources[].document.title verplicht string | null
data[].sources[].document.report_number verplicht integer | null
data[].sources[].document.report_date verplicht string | null
data[].sources[].document.published_on verplicht string | null
data[].sources[].document.page_count verplicht integer | null
data[].sources[].document.url verplicht string | null
data[].sources[].document.sha256 verplicht string | null
data[].sources[].page verplicht integer | null
data[].sources[].section verplicht string | null
data[].sources[].excerpt verplicht string | null
meta verplicht object
meta.field verplicht string
meta.kind verplicht string
meta.total verplicht integer

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