SIVI Koppelingsprotocol

3.3.1. Stap-2A: aanroep doeFunctie vanuit 2e/3e Omgeving

De 2e Omgeving stuurt het resultaat door middel van de doeFunctieVraag naar de Koppelservice. In het AFD-bericht binnen de gimData-sectie worden zowel het document als de koppeldata opgenomen.

Verplichte attributen

Het uitgangspunt is dat het AFD-bericht binnen de gimData-sectie alle informatie bevat die ontvanger nodig heeft voor het afhandelen van het bericht. Dit kan handmatig of via een binnen de toepassing ingerichte workflow. Onderstaand het overzicht van de verplichte entiteiten en attributen in de gimData-sectie van een SKP-BASIS-bericht.

Verplichte attributen entiteit Algemeen (AL)

AFD XML-tag Omschrijving
AL_FUNCTIE Berichtfunctie, default is code 22 (Toevoegen aan dossier), tenzij het een statusmelding betreft vanuit een 3e Omgeving. Dan is code 23 (Melden Status) ook mogelijk.
AL_COREF Dit is altijd e-mailadres gebruiker 1e Omgeving. Hiermee kan bericht aan account en/of sessie gekoppeld worden. Als onbekend dan attribuut niet opnemen in het bericht.
AL_ADATMSG Datum aanmaken bericht door 2e Omgeving of 3e Omgeving.
AL_ATYDMSG Tijd aanmaken bericht door 2e Omgeving of 3e Omgeving.
AL_SKPSID SKP ServiceId. Elke aanbieder van een koppeling (de 2e Omgeving of 3e Omgeving) vult dit attribuut altijd met het eigen SKP ServiceId. Dit ServiceId identificeert de afzender en de service (toepassing) van waaruit is verzonden. ServiceId kan bijvoorbeeld gebruikt worden bij de aansturing van een workflow of naamgeving bij archivering. Doel is om zowel de afzender als de toepassing/service te identificeren.

Voordat een SKP-koppeling de eerste keer in gebruik wordt genomen, vraagt de aanbieder bij SIVI een SKP ServiceId aan. Een SKP ServiceId wordt uitgegeven voor de combinatie van aanbieder en service. Een aanbieder kan zo meerdere services laten registreren. Meer informatie over het aanvragen van een SKP ServiceID vindt u in de bijlage SKP Serviceregister

Verplichte attributen entiteit Bijlage (BY)

AFD XML-tag Omschrijving
BY_VOLGNUM Binnen één bericht kunnen meerdere documenten worden opgenomen. Op dat moment wordt de entiteit Bijlage (BY) herhaald voor elk document. Elke entiteit BY heeft dan zijn unieke oplopende volgnummer. BY_VOLGNUM=1, BY_VOLGNUM=2, etc.
BY_BYLSRT Soort bijlage: Codering die aangeeft om wat voor soort document het gaat. Zie AFD-codelijst ADNBYL.
SIVI wil categorie “overig” hier niet opnemen. Neem contact op met SIVI als uw soort bijlage niet in de codelijst staat.
BY_BYLOMS Vrije omschrijving voor duiding van de inhoud van het document. Een korte goede informatieve omschrijving helpt binnen de 1e Omgeving bij het inboeken van en zoeken naar documenten.
BY_FILNM Bestandsnaam bijlage
BY_EXT Bestandsnaam extensie
BY_DATA Complete inhoud van het bijlage bestand, opgenomen als BASE64 encoded string.
BY_ENDBSTM Eindbestemming: Codering die aangeeft voor wie het document in de bijlage bedoeld is (bij voorbeeld Tussenpersoon, Verzekeringnemer). Wanneer de betreffende eindbestemming niet voorkomt dan kan de code voor “Overige” worden gebruikt.
BY_REACTIE Indicatie om aan te geven dat verzender een reactie op het document in de bijlage verwacht van de ontvanger.

Identificerende gegevens

Voor het koppelen van de bijlage aan een persoon, contract en/of dossier dienen identificerende gegevens aanwezig te zijn. Het is binnen SKP-BASIS verplicht om minimaal één identificerend gegeven op te nemen. Identificerende attributen (inclusief bijbehorende entiteiten) worden conform de geldende AFD-berichtstructuren (Contractberichtstructuur, Schadeberichtstructuur, etc.).

Voorgestelde koppelgegevens / identificerende gegevens

AFD XML-tag Omschrijving
LC_NUMMER Contractnummer (Lease)
RC_NUMMER Contractnummer (Raamcontract)
PK_NUMMER Contractnummer (Pakket)
PP_NUMMER Contractnummer (Polis/Onderdeel)
OB_KENTEKE Kenteken
VP_ANAAM Achternaam
VP_VOORL Voorletters
VP_VOORV Voorvoegsels
VP_GEBDAT Geboortedatum
VP_PCODE Postcode
VP_HUISNR Huisnummer
VP_TOEVOEG Huisnummertoevoeging
VP_EMAIL E-mailadres
OG_ANAAM Bedrijfsnaam
OG_PCODE Postcode
OG_HUISNR Huisnummer
OG_TOEVOEG Huisnummertoevoeging
OG_EMAIL E-mail adres
OG_NRHNDRG Nummer handelsregister
SD_SCHNRVM Schadenummer maatschappij
SD_SCHNRTP Schadenummer tussenpersoon
SD_SCHNRVG Schadenummer volmachtgever
SD_SCHNRPA Schadenummer pechhulp/alarmcentrale
SD_SCHNRLM Schadenummer leasemaatschappij

Voorbeeldbericht

<doeFunctie xmlns="urn:sivi:standards:skp:ws">
	<doeFunctieVraag xmlns="urn:sivi:standards:skp:schemas">
  		<procesInfo>
      <procesId>1234567890|a.gebruiker@tussenpersoon.nl</procesId>
      <functie>
        <productId>0</productId>
        <contextId>200</contextId>
        <functieId>2060</functieId>
      </functie>
    </procesInfo>
    <inhoud>
      <gimData><![CDATA[
	<Contractdocument>
	 <AL>
	  <AL_FUNCTIE>22</AL_FUNCTIE>
	  <AL_COREF>a.gebruiker@tussenpersoon.nl</AL_COREF>
	  <AL_ADATMSG>20180101</AL_ADATMSG>
	  <AL_ATYDMSG>1010</AL_ATYDMSG>
	  <AL_SKPSID>99999999</AL_SKPSID>
	  <BY>
	   <BY_VOLGNUM>1</BY_VOLGNUM>
	   <BY_BYLSRT>11</BY_BYLSRT>
	   <BY_BYLOMS>Offerte Janssen Volvo V70 77-ABC-7</BY_BYLOMS>
	   <BY_FILNM>Janssen77ABC7</BY_FILNM>
	   <BY_EXT>PDF</BY_EXT>
	   <BY_DATA>FSO:Hwo12S2jASHDasaKASJIgtaQtyiHzbs 
	    ...
	   </BY_DATA>
	   <BY_ENDBSTM>VP</BY_ENDBSTM>
	   <BY_REACTIE>N</BY_REACTIE>
	  </BY>
	 </AL>
	 <PP>
	  <VP>
	   <VP_ANAAM>Janssen</VP_ANAAM>
	   <VP_PCODE>3584BB</VP_PCODE>
	   <VP_HUISNR>101</VP_HUISNR>
	  </VP>
	  <OB>
	   <OB_KENTEKE>77-ABC-7</OB_KENTEKE>
	  </OB>
	 </PP>
	</Contractdocument>]]>
      </gimData>
    </inhoud>
  </doeFunctieVraag>
</doeFunctie>

Reactie

Was dit nuttig?

Ja Nee
U heeft aangegeven dat u dit onderwerp niet nuttig vond ...
Zou u hieronder willen uitleggen waarom niet? Bij voorbaat dank!
Dank voor uw reactie.

Geef uw reactie op dit onderwerp.

Verstuur Reactie