MAGDA Document service
Inleiding
Ook wel Magda Documentendienst of Magda Document Service genoemd. Dit laat directe communicatie met de burger toe via eBox en/of aangetekende zending.
Technische info MAGDA-documentendienst.
Protocol
Idem als bij alle Magda connectoren.
Applicatie eigenschappen
Specifieke applicatie eigenschappen, los van de eigenschappen die de toegang regelen.
Eigenschap | Beschrijving |
|---|---|
Info volgt. | - |
Info volgt. | - |
Services en functies
Deze connector is volledig in te stellen via Skryv Studio service taak templates.
hasAnEbox
Controleer of de opgegeven persoon (personen) of onderneming (ondernemingen) over een actieve eBox beschikken. Zie ook de service taak templates ‘Controleer of eBox actief is voor burger’ en ‘Controleer of eBox actief is voor onderneming’.
Workflow expression
${magda.hasAnEbox(String type, List<String> identifiers)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
type | String | ‘kbo’ | Twee opties: ‘kbo’ ofwel ‘ssin’ |
identifiers | List<String> | ['85010212345', ‘95010212345’, ‘75010212345’] | Lijst met ofwel rijksregisternummers (indien type ‘ssin’ is) ofwel ondernemingsnummers (indien type ‘kbo’ is) |
Output
Je krijgt een map met voor elke identifier (persoon of onderneming) een aanduiding of er al dat niet een actieve eBox is.
getMessageStatus
Check voor een verstuurd bericht of de ontvanger deze gelezen heeft of niet. Zie service task templates ‘Haal verzendstatus op voor eBox’ en ‘Haal verzendstatus op voor papier’.
Workflow expressie
${magda.getMessageStatus(String eboxMessageId, String type, List<String> identifiers)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
eboxMessageId | String | - | Verwijst naar de id van het bericht zoals die gekend is in eBox. Dit is info die je haalt uit de response van publishEboxMessage |
type | String | ‘kbo’ | Twee opties: ‘kbo’ ofwel ‘ssin’ |
identifiers | List<String> | ['85010212345', ‘95010212345’, ‘75010212345’] | Lijst met ofwel rijksregisternummers (indien type ‘ssin’ is) ofwel ondernemingsnummers (indien type ‘kbo’ is) |
Output
Je krijgt een map met voor elke identifier de aanduiding of het bericht al dan niet gelezen is.
publishEboxMessage
Publiceer een bericht in de eBox van de persoon of onderneming. Zie ook de service taak template ‘Verstuur documenten'.
Workflow expressie
${magda.publishEboxMessage(EboxMessageParamsWrapper eboxMessageParamsWrapper)}
Input
Inputparameters | Data type | Voorbeeld | Uitleg |
|---|---|---|---|
eboxMessageParamsWrapper | Wrapper | - | Bevat alle info nodig om een bericht te publiceren in de eBox. In te stellen via Studio. |
Output
Je krijgt een string met de Id van het bericht zoals die in eBox gekend is.