GET /api/v2/notificaties?agent={agent}

Beschrijving

Opvragen van een lijst van (passieve) notificatieberichten via rijksregisternummer of ondernemingsnummer.

Vraag Informatie

Naam

Header parameter Omschrijving
Accept-Language De taal waarin het antwoord vertaald moet worden.
Volgende talen worden ondersteund:
  • nl (standaard)
  • fr
  • de
  • en
Een omschrijving van het accept-Language header veld vind je hier
Accept Beschrijft hoe het resultaat moet worden geformatteerd.
Volgende formatteringen worden ondersteund:
  • JSON (MIME-type:application/json
  • JSON-LD (MIME-type: "application/ld+json")
  • XML (MIME-type:"application/xml")

URI parameters

Naam Omschrijving Type Bijkomende informatie
agent

het rijksregisternummer of ondernemingsnummer

 String

Verplicht

Body parameters

Geen.

Antwoord informatie

Model omschrijving

Indien succesvol wordt een NotificatieLijst doorgestuurd.

In andere gevallen krijg je één van onderstaande HTTP-statuscodes toegestuurd:
- 200 (OK): NotificatieLijst
- 400 (Bad Request): De request kan niet uitgevoerd worden omwille van syntaxfouten, bvb wanneer de body niet geparsed kan worden"
- 406 (Not Acceptable): Er kan geen antwoord worden voorzien in het gevraagde formaat volgens de Accept-header
- 500 (Internal Server Error): Er is een onvoorziene fout opgetreden op de server


Lijst van Notificatie

Naam Omschrijving Type Bijkomende informatie
NotificatieId

Unieke identificatie van een notificatie

String

Optioneel
Titel

Titel of kortbericht van een passieve notificatie in tekst-formaat.

String

Optioneel
Body

Lang bericht van een passieve notificatie in HTML-formaat.

String

Optioneel
TransactieId

Unieke en persistente identificatie van transactionele dienstverlening. Op basis van de TransactieID kan in de front end logica opgebouwd worden rond het al dan niet tonen van gegroepeerde notificaties en de problematiek oplossen van meerdere notificaties vanuit verschillende bronnen over hetzelfde dossier. Momenteel wordt binnen DOSIS een unieke sleutel gegenereerd door het samenvoegen van volgende velden: {bron}+{dossierID}

String

Optioneel
DatumNotificatie

Datum waarop notificatie werd aangemaakt.

DateTime

Optioneel
DocumentLinkUri

URI meer informatie >Apart veld met een link dat meestgestuurd wordt door externe bron in elk notificatiebericht. Vanuit DOSIS wordt de link meegegeven die in de DOSIS-record staat bij die status In principe is link optioneel, maar zal bijna altijd worden meegegeven

String

Optioneel
Bron

Bron of afzender van de notificatie

Bron

Optioneel
Bestemmeling

Bestemmeling of agenten waarvoor notificatie bestemd is

Bestemmeling

Optioneel
Kanalen

Te notificeren kanalen

Lijst van NotificatieKanaal

Optioneel
Statussen

Statussen van de notificatie

Lijst van Status

Optioneel
ProductIds

Lijst van IPDC-producten

Lijst van String

Optioneel
SleutelWaardeParen

Lijst met sleutel/waarde-paren gebruikt bij generatie van notificatieberichten. Bij creatie van een notificatie moeten alle sleutel/waarde-paren worden meegegeven die gebruikt worden in de gebruikte sjablonengroep. Wanneer sleutel/waarde-paren ontbreken die vereist zijn, dan kan de notificatie niet worden verwerkt.

Lijst van SleutelWaardePaar

Optioneel
Categorie

Het lijkt noodzakelijk om een typering van berichten te voorzien. Zodat een gebruiker snel zijn berichten kan screenen (in de frontend op te vangen) of doordat een gebruiker zijn voorkeur kan bepalen om enkel een bepaald type berichten te ontvangen.

Categorie

Optioneel
VervalDatum

Datum waarop notificatie vervalt

DateTime

Optioneel

Antwoord Formaat

Voorbeeld voor MIME-type application/json, text/json

[
  {
    "NotificatieId": "e30ba3ed-c8d4-49e9-96c7-ffe6b18b2538",
    "Titel": "Dit is een voorbeeld titel 1",
    "Body": "Dit is een voorbeeld body 1",
    "TransactieId": "VoorbeeldTransactieId1",
    "DatumNotificatie": "2018-06-22T20:39:12.271Z",
    "DocumentLinkUri": "http://agentschap.vlaanderen.be/loket/dossierid",
    "Bron": {
      "OrganisatieId": "1",
      "AfzenderNaam": "Afzender 1 naam",
      "AfzenderLink": "Afzender 1 link"
    },
    "Bestemmeling": {
      "Identificatie": "VoorbeeldBestemmelingIdentificatie1",
      "Type": "VoorbeeldBestemmelingType1"
    },
    "Kanalen": [
      {
        "Type": "Email",
        "Permissie": "Toegelaten"
      },
      {
        "Type": "Passief",
        "Permissie": "Toegelaten"
      }
    ],
    "Statussen": [
      {
        "Type": "Verstuurd",
        "WijzigingsDatum": "2018-06-27T20:39:12.271Z",
        "NotificatieKanaal": "Email"
      }
    ],
    "ProductIds": [
      "1"
    ],
    "SleutelWaardeParen": [
      {
        "Sleutel": "Sleutel1",
        "Waarde": "Waarde1"
      },
      {
        "Sleutel": "Sleutel2",
        "Waarde": "Waarde2"
      },
      {
        "Sleutel": "Sleutel3",
        "Waarde": "Waarde3"
      }
    ],
    "Categorie": {
      "Code": "VoorbeeldCodeCategorie1",
      "Omschrijving": "Voorbeeld omschrijving categorie 1"
    },
    "VervalDatum": "2018-07-02T20:39:12.271Z"
  },
  {
    "NotificatieId": "4566faf2-3b75-4ddb-8438-d6b7a03677fa",
    "Titel": "Dit is een voorbeeld titel 2",
    "Body": "Dit is een voorbeeld body 2",
    "TransactieId": "VoorbeeldTransactieId2",
    "DatumNotificatie": "2018-06-22T20:39:12.271Z",
    "DocumentLinkUri": "http://agentschap.vlaanderen.be/loket/dossierid2",
    "Bron": {
      "OrganisatieId": "2",
      "AfzenderNaam": "Afzender 2 naam",
      "AfzenderLink": "Afzender 2 link"
    },
    "Bestemmeling": {
      "Identificatie": "VoorbeeldBestemmelingIdentificatie2",
      "Type": "VoorbeeldBestemmelingType2"
    },
    "Kanalen": [
      {
        "Type": "Email",
        "Permissie": "Toegelaten"
      },
      {
        "Type": "Passief",
        "Permissie": "Toegelaten"
      }
    ],
    "Statussen": [
      {
        "Type": "Verstuurd",
        "WijzigingsDatum": "2018-06-27T20:39:12.271Z",
        "NotificatieKanaal": "Email"
      }
    ],
    "ProductIds": [
      "2"
    ],
    "SleutelWaardeParen": [
      {
        "Sleutel": "Sleutel1",
        "Waarde": "Waarde1"
      },
      {
        "Sleutel": "Sleutel2",
        "Waarde": "Waarde2"
      },
      {
        "Sleutel": "Sleutel3",
        "Waarde": "Waarde3"
      }
    ],
    "Categorie": {
      "Code": "VoorbeeldCodeCategorie2",
      "Omschrijving": "Voorbeeld omschrijving categorie 2"
    },
    "VervalDatum": "2018-07-02T20:39:12.271Z"
  }
]

Voorbeeld voor MIME-type application/xml, text/xml

<?xml version="1.0" encoding="utf-8"?>
<Notificaties xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.aiv.be/ws/notificatie/v1">
  <Notificatie>
    <NotificatieId>e30ba3ed-c8d4-49e9-96c7-ffe6b18b2538</NotificatieId>
    <Titel>Dit is een voorbeeld titel 1</Titel>
    <Body>Dit is een voorbeeld body 1</Body>
    <TransactieId>VoorbeeldTransactieId1</TransactieId>
    <DatumNotificatie>2018-06-22T20:39:12.2710573Z</DatumNotificatie>
    <DocumentLinkUri>linknaarloket</DocumentLinkUri>
    <Bron>
      <OrganisatieId>1</OrganisatieId>
      <AfzenderNaam>Afzender 1 naam</AfzenderNaam>
      <AfzenderLink>Afzender 1 link</AfzenderLink>
    </Bron>
    <Bestemmeling>
      <Identificatie>VoorbeeldBestemmelingIdentificatie1</Identificatie>
      <Type>VoorbeeldBestemmelingType1</Type>
    </Bestemmeling>
    <Kanalen>
      <NotificatieKanaal>
        <Type>Email</Type>
        <Permissie>Toegelaten</Permissie>
      </NotificatieKanaal>
      <NotificatieKanaal>
        <Type>Passief</Type>
        <Permissie>Toegelaten</Permissie>
      </NotificatieKanaal>
    </Kanalen>
    <Statussen>
      <Status>
        <Type>Verstuurd</Type>
        <WijzigingsDatum>2018-06-27T20:39:12.2710573Z</WijzigingsDatum>
        <NotificatieKanaal>Email</NotificatieKanaal>
      </Status>
    </Statussen>
    <ProductIds>
      <string>1</string>
    </ProductIds>
    <SleutelWaardeParen>
      <SleutelWaardePaar>
        <Sleutel>Sleutel1</Sleutel>
        <Waarde>Waarde1</Waarde>
      </SleutelWaardePaar>
      <SleutelWaardePaar>
        <Sleutel>Sleutel2</Sleutel>
        <Waarde>Waarde2</Waarde>
      </SleutelWaardePaar>
      <SleutelWaardePaar>
        <Sleutel>Sleutel3</Sleutel>
        <Waarde>Waarde3</Waarde>
      </SleutelWaardePaar>
    </SleutelWaardeParen>
    <Categorie>
      <Code>VoorbeeldCodeCategorie1</Code>
      <Omschrijving>Voorbeeld omschrijving categorie 1</Omschrijving>
    </Categorie>
    <VervalDatum>2018-07-02T20:39:12.2710573Z</VervalDatum>
  </Notificatie>
  <Notificatie>
    <NotificatieId>4566faf2-3b75-4ddb-8438-d6b7a03677fa</NotificatieId>
    <Titel>Dit is een voorbeeld titel 2</Titel>
    <Body>Dit is een voorbeeld body 2</Body>
    <TransactieId>VoorbeeldTransactieId2</TransactieId>
    <DatumNotificatie>2018-06-22T20:39:12.2710573Z</DatumNotificatie>
    <DocumentLinkUri>linknaarloket</DocumentLinkUri>
    <Bron>
      <OrganisatieId>2</OrganisatieId>
      <AfzenderNaam>Afzender 2 naam</AfzenderNaam>
      <AfzenderLink>Afzender 2 link</AfzenderLink>
    </Bron>
    <Bestemmeling>
      <Identificatie>VoorbeeldBestemmelingIdentificatie2</Identificatie>
      <Type>VoorbeeldBestemmelingType2</Type>
    </Bestemmeling>
    <Kanalen>
      <NotificatieKanaal>
        <Type>Email</Type>
        <Permissie>Toegelaten</Permissie>
      </NotificatieKanaal>
      <NotificatieKanaal>
        <Type>Passief</Type>
        <Permissie>Toegelaten</Permissie>
      </NotificatieKanaal>
    </Kanalen>
    <Statussen>
      <Status>
        <Type>Verstuurd</Type>
        <WijzigingsDatum>2018-06-27T20:39:12.2710573Z</WijzigingsDatum>
        <NotificatieKanaal>Email</NotificatieKanaal>
      </Status>
    </Statussen>
    <ProductIds>
      <string>2</string>
    </ProductIds>
    <SleutelWaardeParen>
      <SleutelWaardePaar>
        <Sleutel>Sleutel1</Sleutel>
        <Waarde>Waarde1</Waarde>
      </SleutelWaardePaar>
      <SleutelWaardePaar>
        <Sleutel>Sleutel2</Sleutel>
        <Waarde>Waarde2</Waarde>
      </SleutelWaardePaar>
      <SleutelWaardePaar>
        <Sleutel>Sleutel3</Sleutel>
        <Waarde>Waarde3</Waarde>
      </SleutelWaardePaar>
    </SleutelWaardeParen>
    <Categorie>
      <Code>VoorbeeldCodeCategorie2</Code>
      <Omschrijving>Voorbeeld omschrijving categorie 2</Omschrijving>
    </Categorie>
    <VervalDatum>2018-07-02T20:39:12.2710573Z</VervalDatum>
  </Notificatie>
</Notificaties>