Naar de inhoud

API-documentatie

v1.0.0

Tijdlijn

GET/api/v1/cases/{case}/timeline

scope: cases:read1 credits

De openbare gebeurtenissen van een dossier, nieuwste eerst: publicaties, nieuwe verslagen, curatorwijzigingen, nieuws en veilingen, elk met de broncategorie. 30 per pagina, met per_page tot 100. Is de procedure omgezet of overgedragen, dan staan de gebeurtenissen van het eerdere dossier er ook in, met from_case.

Padparameters

Padparameters
NaamTypeOmschrijving
caseverplicht

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

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

Queryparameters

Queryparameters
NaamTypeOmschrijving
page

Paginanummer

integer | nullPaginanummer
per_page

Resultaten per pagina, maximaal 100

integer | nullResultaten per pagina, maximaal 100

Antwoord · HTTP 200

Public data

Antwoord · HTTP 200

Antwoord · HTTP 200
NaamTypeOmschrijving
dataverplichtobject[]
data[].idverplichtstring
data[].typeverplichtstring
data[].occurred_atverplichtstring | null
data[].from_caseverplichtobject | null
data[].from_case.idverplichtstring
data[].from_case.case_numberverplichtstring
data[].detailsverplichtobject
data[].details.report_idmixed
data[].details.report_numbermixed
data[].details.report_datemixed
data[].details.titlemixed
data[].details.descriptionmixed
data[].details.typemixed
data[].details.curatormixed
data[].details.rolemixed
data[].details.statusmixed
data[].details.frommixed
data[].details.tomixed
data[].details.reasonmixed
data[].details.providermixed
data[].details.publication_idmixed
data[].details.date_basismixed
data[].details.is_finalmixed
metaverplichtobject
meta.totalverplichtinteger
meta.pageverplichtinteger
meta.last_pageverplichtinteger

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

Antwoord · HTTP 422

Validation error

Antwoord · HTTP 422

Antwoord · HTTP 422
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