developer.overheid.nl

Ontwikkelaarsportaal van de Nederlandse overheid

Ga naar hoofdinhoud
Concept pagina
Deze pagina is een concept. Deze zal alleen zichtbaar zijn in de ontwikkelomgeving en uitgesloten worden van de productie build.

ContextResultaat

Samengesteld object met klantgerelateerde gegevens. Bevat per resource-type een lijst van samenvattingen (info-objecten). Voor resource-typen waarvoor een detail-endpoint bestaat (bijv. GET /taken/{uuid} voor afhandeling) kan aanvullende informatie worden opgevraagd. Bevat alleen de resource-typen die via include zijn opgevraagd én door de provider worden ondersteund. Afwezige sleutels betekenen dat het type niet is opgevraagd of niet ondersteund wordt.

taken object[]

Taken die voldoen aan de opgegeven filtercriteria. Aanwezig als taken in include staat (of include afwezig is).

Bevat TaakInfo-objecten: alle velden die nodig zijn voor een takenlijst of taakkaart. Type-specifieke uitvoeringsvelden worden niet meegeleverd; die zijn beschikbaar via GET /taken/{uuid}.

  • Array [
    • uuiduuidrequired
    Example: 550e8400-e29b-41d4-a716-446655440000
    titel objectrequired

    Taaknaam in één of meer talen (BCP 47 taalcodes als sleutels). Nederlands (nl) is verplicht; andere talen zijn optioneel. Portalen tonen de taal die overeenkomt met de voorkeur van de gebruiker, of vallen terug op nl.

    nlstringrequired

    Nederlandse taaknaam (verplicht).

    property name*string
    toelichting object

    Optionele korte toelichting op de taak, in één of meer talen (BCP 47 taalcodes als sleutels). Alleen aanwezig als de titel niet voldoende zelfbeschrijvend is. Als toelichting aanwezig is, moet ten minste de Nederlandse variant (nl) gevuld zijn.

    nlstringrequired

    Nederlandse toelichting (verplicht als toelichting aanwezig is).

    property name*string
    statusstringrequired

    Extensible enum.

    Enum ValueDescription
    openTaak staat open en kan door de gebruiker worden uitgevoerd.
    afgerondTaak is succesvol afgerond.
    geannuleerdTaak is geannuleerd en niet meer uitvoerbaar.
    Examples:
    Example: open
    deadlinedate-time

    Laatste moment waarop de taak nog op tijd is (RFC 3339 / ISO 8601, inclusief tijdzone-offset). Dit is een inclusieve bovengrens: zolang nu <= deadline is de taak op tijd; vanaf het eerstvolgende moment is hij te laat.

    De referentietijdzone is Europe/Amsterdam (Nederlandse lokale tijd: +01:00 in de winter, +02:00 in de zomer).

    Codering — als een exact tijdstip bekend is: gebruik dat tijdstip rechtstreeks. Voorbeeld: deadline "uiterlijk 12 december 12:00" → 2026-12-12T12:00:00+01:00.

    Codering — als alleen een kalenderdag bekend is: gebruik conventioneel het einde van die dag in lokale tijd: 23:59:59. Voorbeeld: deadline "uiterlijk 12 december" → 2026-12-12T23:59:59+01:00. Zo blijft de getoonde datum gelijk aan wat de gebruiker leest, en is de hele dag nog geldig. Deze conventie wordt in de praktijk breed toegepast (denk aan belastingdiensten, vergunningstermijnen, formulierdeadlines) en sluit daarmee aan bij wat gebruikers gewend zijn.

    Example: 2026-12-12T23:59:59+01:00
    context object

    De context waaraan de taak is gekoppeld (bijv. een zaak of product), aangeduid met een URN en optioneel een canonicalUrl.

    canonicalUrl is afwezig als de dienstverlener geen eigen portaal heeft (bijv. bedrijfsonderdelen die geen eigen portaal hebben).

    Portalen die de URN kunnen omzetten naar een interne URL doen dat; canonicalUrl is dan irrelevant. Anders geldt: gebruik canonicalUrl als die aanwezig is. Het type context is af te leiden uit de URN-structuur.

    flowchart TD
        A{URN → Interne URL?} -->|Ja| B[Gebruik interne URL]
        A -->|Nee| C{Heeft canonicalUrl?}
        C -->|Ja| D[Gebruik canonicalUrl]
        C -->|Nee| E[Nader te bepalen]
    urnstringrequired

    Portaal-agnostische identifier van de context, in URN-formaat.

    Possible values: Value must match regular expression ^urn:

    Example: urn:nl:gemeenten:zaak:2026-00042
    canonicalUrluri

    Optionele URL naar de context in de omgeving van de dienstverlener. Afwezig als de dienstverlener geen eigen portaal heeft. Als aanwezig, bruikbaar als directe link voor portalen die de URN niet zelf omzetten. Portalen met eigen contextondersteuning kunnen deze URL negeren en een interne URL opbouwen via de URN.

    Example: https://portaal.gemeente.nl/zaken/2026-00042
    uitvoering object

    Uitvoeringsinformatie voor een taak: hoe de actieknop gelabeld wordt en waar de gebruiker naartoe gaat.

    fallbackUrl is altijd aanwezig als universele fallback.

    flowchart TD
        A{Type ondersteund?} -->|Nee| B[Label: \'Uitvoeren\']
        A -->|Ja| C[Type-specifiek label]
        B --> D[Redirect via fallbackUrl + returnUrl]
        C --> E{Type-specifieke velden aanwezig?}
        E -->|Nee| D
        E -->|Ja| F[Lokale uitvoering via type-specifieke velden]
    typestring
    fallbackUrlurirequired

    Fallback-URL voor de uitvoering van de taak. Altijd aanwezig. Gebruikt als het portaal type niet ondersteunt of de type-specifieke velden niet lokaal kan verwerken.

    In redirect-scenario's voegt het portaal een returnUrl toe vóór de redirect, zodat de externe partij de gebruiker na afloop terug kan sturen naar SCR-TAKEN-IN-CONTEXT. De precieze parameternaam is afhankelijk van de ontvangende partij.

    Examples:
    Example: https://portaal.gemeente.nl/taken/550e8400/uitvoeren?returnUrl=https%3A%2F%2Fmijnoverheid.nl%2Ftaken%2Fcontext%2Fzaak-2026-00042
  • ]
    • ContextResultaat
    {
      "taken": [
        {
          "uuid": "550e8400-e29b-41d4-a716-446655440000",
          "titel": {
            "nl": "Kentekenbewijs uploaden",
            "en": "Upload vehicle registration document"
          },
          "toelichting": {
            "nl": "Upload een kopie van uw kentekenbewijs voor uw parkeervergunningsaanvraag.",
            "en": "Upload a copy of your vehicle registration document for your parking permit application."
          },
          "status": "open",
          "deadline": "2026-12-12T23:59:59+01:00",
          "context": {
            "urn": "urn:nl:gemeenten:zaak:2026-00042",
            "canonicalUrl": "https://portaal.gemeente.nl/zaken/2026-00042"
          },
          "uitvoering": {
            "type": "string",
            "fallbackUrl": "https://portaal.gemeente.nl/taken/550e8400/uitvoeren?returnUrl=https%3A%2F%2Fmijnoverheid.nl%2Ftaken%2Fcontext%2Fzaak-2026-00042"
          }
        }
      ]
    }