Mergi la conținut

API-documentatie

v1.0.0

Verslag

GET /api/v1/reports/{report}

scope: reports:read 1 credits

Een openbaar verslag met metadata, verwerkingsstatus, gegevens en onderwerpen.

Padparameters

Padparameters
NaamTypeOmschrijving
report verplicht

Verslag-id (ULID)

stringVerslag-id (ULID)

Antwoord, HTTP 200

Public data

Antwoord, HTTP 200

Antwoord, HTTP 200
NaamTypeOmschrijving
data verplicht object
data.id verplicht string
data.number verplicht integer | null
data.title verplicht string
data.is_final verplicht boolean
data.published_on verplicht string
data.period_start verplicht string | null
data.period_end verplicht string | null
data.page_count verplicht integer | null
data.document_url verplicht string | null
data.links verplicht object
data.links.self verplicht string
data.case verplicht object
data.case.id verplicht string
data.case.name verplicht string
data.case.links verplicht object
data.case.links.self verplicht string
data.sha256 verplicht string | null
data.sections verplicht object[]
data.sections[].code verplicht string
data.sections[].heading verplicht string
data.sections[].page_from verplicht integer
data.sections[].page_to verplicht integer
data.values verplicht object[]
data.values[].field verplicht string
data.values[].kind verplicht enum count, hours, decimal, amount
data.values[].value verplicht number | null
data.values[].state verplicht string
data.values[].qualifier verplicht string | null
data.values[].as_of verplicht string
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.topics verplicht object[]
data.topics[].topic verplicht string
data.topics[].state verplicht string
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

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