Ga naar inhoud

Berichten

Schuldhulpverleningsgegevens

De technische beschrijving van de API is in het volgende OAS3-bestand beschreven:

Bekijk specificatie

Vroegsignaleringsgegevens

De technische beschrijving van de API is in het volgende OAS3-bestand beschreven:

Bekijk specificatie

Hieronder worden de berichten die in het OAS-bestand technisch beschreven zijn, toegelicht.

Encoding

Conform de specificaties voor de bestandsuitwisseling voor schuldhulpverlening en vroegsignalering, is de encoding van de berichten UTF-8.

Vraagbericht (request)

Dit is het vraagbericht zoals dat door CBS via de "Outway" naar de "Inway" van de schuldhulpverlener gestuurd wordt. Dit is een POST request waarbij alleen gegevens opgevraagd worden. Er worden geen GET requests gebruikt, omdat hierbij de parameters in de URL zitten en mogelijk cache gegevens gebruikt worden, als de parameters niet wijzigen.

Parameters die meegestuurd kunnen worden (allemaal optioneel):

  • Startdatum (date, default leeg - schuldhulpverlener bepaalt dan startdatum)

  • Einddatum (date, default leeg - schuldhulpverlener bepaalt dan einddatum)

  • Aanleverende_organisatie (string, default alle – alleen relevant als over meer dan 1 organisatie (gemeente/ schuldhulpverlener) gegevens aangeleverd worden)

Het bericht wordt met JAdES ondertekend met de private sleutel van de verzender van het vraagbericht - in dit geval CBS. Zie het hoofdstuk Signing en Versleuteling voor de specificaties van de ondertekening.

Antwoordbericht (response)

Dit is het antwoordbericht van de gegevensbeheerder (systeem dat de bron beheert) met de gewenste gegevens in JSON formaat. De payload is gebaseerd op het uitwisselformaat zoals dat is beschreven voor schuldhulpgegevens en vroegsignaleringsgegevens.

Ook dit bericht wordt ondertekend met JAdES met gebruik van de eigen private sleutel. Versleutelen van de payload is niet nodig.

Mogelijke responses: