POST /api/v2/notificaties

Beschrijving

Aanvraag plaatsen tot creeren van notificaties op basis van een push van notificatiebundel. De gekozen formattering kan je aanduiden in 'Content-Type' in de request header (Content-Type='application/xml' of Content-Type='application/json').

Vraag Informatie

URI parameters

Geen.

Body parameters

notificatiebundel.

NotificatieBundel

Naam Omschrijving Type Bijkomende informatie
Id

Unieke identificatie van een notificatiebundel

String

Verplicht
AanbiederUri

De identificatie van (de beheerder van) de Applicatie die de NotificatieBundel aanbiedt (push).

String

Verplicht
Bestemmelingen

Bestemmelingen of agenten waarvoor notificatiebundel bestemd is

Lijst van Bestemmeling

Verplicht
Categorie

De (notificatie)categorie van de te creeren notificatie.

Categorie

Verplicht
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
Vervaldatum

Vervaldatum van de bundel.Onmiddellijk na 24:00 van deze datum (huidige datumtijd > vervaldatumtijd) mag de NotificatieBundel niet meer verwerkt worden en mogen geen Passieve Notificaties gebaseerd op de Bundel aangeboden worden aan Afnemers.

DateTime

Optioneel
Kanalen

Te notificeren kanalen

Lijst van NotificatieKanaal

Verplicht
ProductId

De IPDC of Dienstverleningscatalogus ID van de dienst of het product waarvoor de Notificatie gevraagd wordt.

String

Verplicht
MerkCode

Het merk van de publieke dienstverlening waarvoor genotifieerd wordt

String

Verplicht
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 voor de notificatiecategorie / -kanalen.
Wanneer sleutel/waarde-paren ontbreken die vereist zijn, dan kan de notificatie niet worden verwerkt.

Lijst van SleutelWaardePaar

Verplicht

Vraag formaat

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

{
  "Id": "sample string 1",
  "AanbiederUri": "sample string 2",
  "Bestemmelingen": [
    {
      "Identificatie": "sample string 1",
      "Type": "sample string 2"
    },
    {
      "Identificatie": "sample string 1",
      "Type": "sample string 2"
    },
  ],
  "Categorie": {
    "Code": "sample string 1",
    "Omschrijving": "sample string 2"
  },
  "TransactieId": "sample string 3",
  "VervalDatum": "2018-06-28T14:20:32.383Z",
  "Kanalen": [
    {
      "Type": "sample string 1",
      "Permissie": "sample string 2"
    },
    {
      "Type": "sample string 1",
      "Permissie": "sample string 2"
    }
  ],
  "ProductId": "sample string 4",
  "MerkCode": "sample string 5",
  "SleutelWaardeParen": [
    {
      "Sleutel": "sample string 1",
      "Waarde": "sample string 2"
    },
    {
      "Sleutel": "sample string 1",
      "Waarde": "sample string 2"
    }
  ]
}

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

<NotificatieBundel 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">
  <Id>sample string 1</NotificatieId>
  <Bestemmelingen>
    <Bestemmeling>
      <Identificatie>sample string 1</Identificatie>
      <Type>sample string 2</Type>
    </Bestemmeling>
    <Bestemmeling>
      <Identificatie>sample string 1</Identificatie>
      <Type>sample string 2</Type>
    </Bestemmeling>
  </Bestemmelingen>
  <Categorie>
    <Code>sample string 1</Code>
    <Omschrijving>sample string 2</Omschrijving>
  </Categorie>
  <TransactieId>sample string 3</TransactieId>
  <VervalDatum>2018-06-28T14:20:32.3835903Z</VervalDatum>
  <Kanalen>
    <NotificatieKanaal>
      <Type>sample string 1</Type>
      <Permissie>sample string 2</Permissie>
    </NotificatieKanaal>
    <NotificatieKanaal>
      <Type>sample string 1</Type>
      <Permissie>sample string 2</Permissie>
    </NotificatieKanaal>
  </Kanalen>
  <ProductId>sample string 4</ProductId>
  <MerkCode>sample string 5</MerkCode>
  <SleutelWaardeParen>
    <SleutelWaardePaar>
      <Sleutel>sample string 1</Sleutel>
      <Waarde>sample string 2</Waarde>
    </SleutelWaardePaar>
    <SleutelWaardePaar>
      <Sleutel>sample string 1</Sleutel>
      <Waarde>sample string 2</Waarde>
    </SleutelWaardePaar>
  </SleutelWaardeParen>
</NotificatieBundel>

Antwoord informatie

Model omschrijving

Indien succesvol wordt ApiSucess teruggestuurd.
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


ApiSuccess
Naam Omschrijving Type Bijkomende informatie
Status

String

Optioneel

Antwoord Formaat

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

{
  "Status": "sample string 1"
}

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

<ApiSuccess xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Status>sample string 1</Status>
</ApiSuccess>