Naar de inhoud

API-documentatie

v1.0.0

Historie van een gegeven

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

scope: history:read2 credits

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

Padparameters

Padparameters
NaamTypeOmschrijving
caseverplicht

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

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

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
dataverplichtobject[]
data[].idverplichtstring
data[].valueverplichtnumber | null
data[].stateverplichtenum known · not_mentioned · not_known · not_reported
data[].qualifierverplichtstring | null
data[].as_ofverplichtstring
data[].report_numberverplichtinteger | null
data[].report_dateverplichtstring | null
data[].currentverplichtboolean
data[].sourcesverplichtobject | null[]
data[].sources[].documentverplichtobject | null
data[].sources[].document.idverplichtstring
data[].sources[].document.titleverplichtstring | null
data[].sources[].document.report_numberverplichtinteger | null
data[].sources[].document.report_dateverplichtstring | null
data[].sources[].document.published_onverplichtstring | null
data[].sources[].document.page_countverplichtinteger | null
data[].sources[].document.urlverplichtstring | null
data[].sources[].document.sha256verplichtstring | null
data[].sources[].pageverplichtinteger | null
data[].sources[].sectionverplichtstring | null
data[].sources[].excerptverplichtstring | null
metaverplichtobject
meta.fieldverplichtstring
meta.kindverplichtstring
meta.totalverplichtinteger

Antwoord · HTTP 404

Not found

Antwoord · HTTP 404

Antwoord · HTTP 404
NaamTypeOmschrijving
errorverplichtobject
error.codeverplicht

Stable error code, for example not_found or validation_failed

stringStable error code, for example not_found or validation_failed
error.messageverplicht

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