Przejdź do treści

API-documentatie

v1.0.0

Dossier

GET /api/v1/cases/{case}

scope: cases:read 1 credits

Eén dossier met status, rechtbank, curator, kerncijfers en de herkomst van elke waarde.

Padparameters

Padparameters
NaamTypeOmschrijving
case verplicht

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

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

Antwoord, HTTP 200

Public data

Antwoord, HTTP 200

Antwoord, HTTP 200
NaamTypeOmschrijving
data verplicht object
data.id verplicht string
data.slug verplicht string
data.name verplicht string
data.status verplicht string
data.procedure verplicht string
data.insolvency_number verplicht string
data.case_number verplicht string
data.declared_on verplicht string
data.terminated_on verplicht string | null
data.termination_reason verplicht string | null
data.kvk_number verplicht string | null
data.judge verplicht string | null
data.last_report_on verplicht string | null
data.last_update_at verplicht string | null
data.trade_names verplicht string[]
data.procedure_type verplicht object | null
data.procedure_type.id verplicht string
data.procedure_type.key verplicht string
data.procedure_type.family verplicht string
data.procedure_type.name verplicht string | null
data.procedure_type.short_name verplicht string | null
data.procedure_type.legal_basis verplicht object | null
data.procedure_type.legal_basis.name verplicht string
data.procedure_type.legal_basis.provision verplicht string | null
data.procedure_type.legal_basis.url verplicht string | null
data.procedure_type.features verplicht string[]
data.legal_form verplicht object | null
data.legal_form.value verplicht string
data.sbi verplicht object | null
data.sbi.code verplicht string
data.sbi.description verplicht string | null
data.sbi.version verplicht string | null
data.court verplicht object
data.court.name verplicht string
data.court.slug verplicht string
data.court.location verplicht string | null
data.curator verplicht object | null
data.curator.name verplicht string
data.curator.slug verplicht string
data.curator.law_firm verplicht string | null
data.curator.city verplicht string | null
data.curator.verified verplicht boolean
data.location verplicht object | null
data.location.street verplicht string | null
data.location.house_number verplicht string | null
data.location.addition verplicht string | null
data.location.postal_code verplicht string | null
data.location.city verplicht string | null
data.location.municipality verplicht string | null
data.location.province verplicht string | null
data.location.kind verplicht string | null
data.location.lat verplicht number | null
data.location.lng verplicht number | null
data.counts verplicht object
data.counts.reports verplicht integer
data.counts.documents verplicht integer
data.counts.assets verplicht integer
data.counts.investigations verplicht integer
data.counts.news verplicht integer
data.report_count verplicht integer
data.linked verplicht object
data.linked.continued_from verplicht object | null
data.linked.continued_from.slug verplicht string
data.linked.continued_from.case_number verplicht string | null
data.linked.continued_from.procedure verplicht string
data.linked.continued_from.court verplicht string | null
data.linked.continued_from.relation verplicht string | null
data.linked.continued_as verplicht object | null
data.linked.continued_as.slug verplicht string
data.linked.continued_as.case_number verplicht string | null
data.linked.continued_as.procedure verplicht string
data.linked.continued_as.court verplicht string | null
data.linked.continued_as.relation verplicht string | null
data.values verplicht object
data.values.*.field verplicht string
data.values.*.kind verplicht string
data.values.*.value verplicht number | null
data.values.*.state verplicht enum known, not_mentioned, not_known, not_reported
data.values.*.qualifier verplicht string | null
data.values.*.as_of verplicht string | null
data.values.*.report_number verplicht integer | null
data.values.*.report_date verplicht string | null
data.values.*.source verplicht object | null
data.values.*.source.document verplicht object | null
data.values.*.source.document.id verplicht string
data.values.*.source.document.title verplicht string | null
data.values.*.source.document.report_number verplicht integer | null
data.values.*.source.document.report_date verplicht string | null
data.values.*.source.document.published_on verplicht string | null
data.values.*.source.document.page_count verplicht integer | null
data.values.*.source.document.url verplicht string | null
data.values.*.source.document.sha256 verplicht string | null
data.values.*.source.page verplicht integer | null
data.values.*.source.section verplicht string | null
data.values.*.source.excerpt verplicht string | null
data.values.*.previous verplicht object | null
data.values.*.previous.value verplicht number | null
data.values.*.previous.state verplicht enum known, not_mentioned, not_known, not_reported
data.values.*.previous.report_number verplicht integer | null
data.values.*.previous.report_date verplicht string | null
data.values.*.delta verplicht number | null
data.values.*.curator verplicht object | null
data.values.*.curator.value verplicht number | null
data.values.*.curator.as_of verplicht string
data.topics verplicht object[]
data.topics[].topic verplicht string
data.topics[].state verplicht string
data.topics[].report_number verplicht integer | null
data.topics[].report_date verplicht string | null
data.topics[].source verplicht object | null
data.topics[].source.document verplicht object | null
data.topics[].source.document.id verplicht string
data.topics[].source.document.title verplicht string | null
data.topics[].source.document.report_number verplicht integer | null
data.topics[].source.document.report_date verplicht string | null
data.topics[].source.document.published_on verplicht string | null
data.topics[].source.document.page_count verplicht integer | null
data.topics[].source.document.url verplicht string | null
data.topics[].source.document.sha256 verplicht string | null
data.topics[].source.page verplicht integer | null
data.topics[].source.section verplicht string | null
data.topics[].source.excerpt verplicht string | null
data.reports verplicht object[]
data.reports[].id verplicht string
data.reports[].number verplicht integer | null
data.reports[].title verplicht string
data.reports[].is_final verplicht boolean
data.reports[].published_on verplicht string
data.reports[].period_start verplicht string | null
data.reports[].period_end verplicht string | null
data.reports[].page_count verplicht integer | null
data.reports[].document_url verplicht string | null
data.reports[].links verplicht object
data.reports[].links.self verplicht string
data.links verplicht object
data.links.self verplicht string
data.links.changes verplicht string
data.links.web verplicht string

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