# info.description
De berichten-service bestaat uit een beschrijving van afspraken, standaarden en referentiecomponenten aangevuld met interactiepatronen, ontwerpbesluiten en aanbevelingen. Het Berichten-patroon biedt een gestandaardiseerde, flexibele oplossing voor de communicatie tussen inwoners, ondernemers en gemeenten via digitale kanalen. Met dit patroon kunnen berichten eenvoudig geregistreerd worden en door verschillende applicaties worden opgehaald, weergegeven en verwerkt. In tegenstelling tot traditionele berichtgevingen (zoals e-mail), zijn berichten centraal geregistreerd en kunnen ze eenvoudig getoond en gerelateerd worden naast zaken, taken of producten binnen het gemeentelijke landschap. 

**URN Pattern**

Open VTB uses URNs (Uniform Resource Names) to link to other resources, below is a description of the pattern that should be used.

**Syntax:**

`urn:<NID>:<NSS>[#<f-component>]`

**Parts:**

- `urn:` (required): fixed prefix for all URNs, every URN must start with this prefix.
- `NID` (required): Namespace Identifier: alphanumeric characters, e.g. `nld`.
- `NSS` (required): Namespace Specific String identifying the object, e.g. `brp:bsn:111222333`.
- `f-component` (optional): Optional component preceded by `#`, e.g. `#section1`.

**Examples:**

`urn:namespace:component:resource:uuid`, `urn:example:foo#bar`

For more information, see the official specification: https://datatracker.ietf.org/doc/html/rfc8141

# paths./berichten.get.parameters[].description
Een pagina binnen de gepagineerde set resultaten.

# paths./berichten.get.parameters[].description
Het aantal resultaten terug te geven per pagina. (default: 100, maximum: 500).

# paths./berichten.get.parameters[].description
Berichten met publicatiedatum op of na dit tijdstip (ISO-8601).

# paths./berichten.get.parameters[].description
Berichten met publicatiedatum op of voor dit tijdstip (ISO-8601).

# paths./berichten.get.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./berichten.post.responses.201.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./berichten/{uuid}.get.parameters[].schema.description
Unieke identificatiecode (UUID4) voor het Bericht.

# paths./berichten/{uuid}.get.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# paths./berichten/{uuid}.patch.description
Werk het veld 'geopendOp' van een bericht bij.

# paths./berichten/{uuid}.patch.summary
Werk het veld 'geopendOp' van een bericht bij.

# paths./berichten/{uuid}.patch.parameters[].schema.description
Unieke identificatiecode (UUID4) voor het Bericht.

# paths./berichten/{uuid}.patch.responses.200.headers.API-version.description
Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.

# components.schemas.Bericht.properties.url.description
De unieke URL van het Bericht binnen deze API.

# components.schemas.Bericht.properties.urn.description
De Uniform Resource Name van het Bericht.

# components.schemas.Bericht.properties.uuid.description
Unieke identificatiecode (UUID4) voor het Bericht.

# components.schemas.Bericht.properties.berichtTekst.description
Tekst van het bericht. URLs worden altijd weergegeven als klikbare URLs op alle portalen. Voor portalen van lokale overheden is de basic syntax van Markdown toegestaan, voor de Mijn Overheid berichtenbox enkel newlines (\r\n).

# components.schemas.Bericht.properties.publicatiedatum.description
Datum/tijd waarop bericht zichtbaar moet worden voor de ontvanger. Dit geldt voor zowel de Mijn Overheid berichtenbox als het portaal van de lokale overheid. De standaardwaarde is de huidige datum/tijd.

# components.schemas.Bericht.properties.geopendOp.description
Het bericht is door de geadresseerde geopend op dit tijdstip in het portaal van de lokale overheid. Deze waarde is onafhankelijk Mijn Overheid.

# components.schemas.Bericht.properties.berichtType.description
Een code voor het technisch identificeren van een bericht soort & origine. Wordt ook gebruikt in de Mijn Overheid berichtenbox.

# components.schemas.Bericht.properties.handelingsPerspectief.description
De door de toegewezen persoon of bedrijf uit te voeren handeling. Bijvoorbeeld: `lezen`, `naleveren`, `invullen`.

# components.schemas.Bericht.properties.einddatumHandelingsTermijn.description
Datum/tijd waarop handeling afgerond moet zijn.

# components.schemas.Bericht.properties.mijnOverheidBerichtenbox.description
Geeft aan of dit bericht geschikt is voor publicatie in de MijnOverheid Berichtenbox. Als dit op ``False`` staat, is het bericht niet bedoeld voor publicatie in de Berichtenbox.

# components.schemas.Bericht.properties.bijlagen.description
Lijst van bijlagen bij het bericht. Let op; In het geval dat dit bericht naar de Mijn Overheid Berichtenbox moet, moet rekening gehouden worden met de requirements van Logius in haar technische aansluithandleiding.

# components.schemas.Bijlage.properties.omschrijving.description
Een door de inwoner of bedrijf goed leesbare omschrijving van de bijlage die wordt weergegeven als bestandsnaam in een berichtenbox of portaal.

# components.schemas.Bijlage.properties.isBerichtTypeBijlage.description
Geeft aan of dit document een standaardbijlage is die vooraf geüpload is in het Berichtenbox Leveranciersportaal. Standaard `false`. Indien `true` moet deze bijlage door het outputmanagementcomponent genegeerd worden - als de Berichtenbox het doelkanaal is.

# components.schemas.PatchedBerichtGeopendOp.properties.geopendOp.description
Het bericht is door de geadresseerde geopend op dit tijdstip in het portaal van de lokale overheid. Deze waarde is onafhankelijk Mijn Overheid.

# components.securitySchemes.tokenAuth.description
Token-based authentication with required prefix "Token"