BRMO SOAP handleiding

#BRMO-SOAP

##SOAP Algemeen Via de brmo-soap webapplicatie kan een SOAP request worden beantwoord. Een SOAP request wordt over het algemeen door een Enterprise Service Bus (ESB) opgesteld, waarna ook het SOAP response door de ESB wordt ontvangen en eventueel na conversie wordt doorgestuurd naar een andere applicatie. Bij SOAP is dus vrijwel altijd sprake van een machine-naar-machine verbinding. Een SOAP service wordt gedefinieerd door een WSDL. Via een WSDL kan een SOAP-client uitvinden hoe een vraag gesteld moet worden en hoe het antwoord geinterpreteerd moet worden. Voor de BRMO kan de WSDL worden opgevraagd via de volgende weblink: http:///brmo-soap/GetBrkInfoImplService?wsdl.

##GetBrkInfoImplService De GetBrkInfoImplService levert BRK informatie (inclusief BAG adres en subjecten) op basis van een of meerdere zoektermen.

##SOAP request Het SOAP request bevat een aantal zoektermen welke allemaal optioneel zijn. Als meerdere termen worden ingevuld dan wordt gezocht op de combinatie van beide zoektermen, dus bv postcode plus huisnummer. Hiernaast kan aangegeven worden hoe compleet het antwoord moet zijn: wel of geen adressen, wel of geen subjecten en of gevoelige informatie geleverd moet worden (BSN nummer).

 <brk:getBrkInfo>
     <!--Optional:-->
     <request adressenToevoegen="?" gevoeligeInfoOphalen="?" 
             maxAantalResultaten="?" subjectsToevoegen="?">
        <!--Optional:-->
        <bufferLengte>?</bufferLengte>
        <!--Optional:-->
        <kadOnrndZk>
           <!--Optional:-->
           <appReVolgnummer>?</appReVolgnummer>
           <!--Optional:-->
           <gemeentecode>?</gemeentecode>
           <!--Optional:-->
           <identificatie>?</identificatie>
           <!--Optional:-->
           <perceelnummer>?</perceelnummer>
           <!--Optional:-->
           <sectie>?</sectie>
        </kadOnrndZk>
        <!--Optional:-->
        <perceelAdres>
           <!--Optional:-->
           <huisnummer>?</huisnummer>
           <!--Optional:-->
           <postcode>?</postcode>
           <!--Optional:-->
           <straatNaam>?</straatNaam>
           <!--Optional:-->
           <woonplaatsNaam>?</woonplaatsNaam>
        </perceelAdres>
        <!--Optional:-->
        <subjectNaam>?</subjectNaam>
        <!--Optional:-->
        <zoekgebied>?</zoekgebied>
     </request>
  </brk:getBrkInfo>

De meeste zoektermen spreken voor zich. In het veld Zoekgebied wordt WKT; dit is een tekstuele weergaven van een geografisch gebied. Voor een punt is het formaat: POINT(177753 576550). Er wordt uitgegaan van RD-coordinaten. Hiernaast kan een bufferlengte worden opgegeven. Hiermee wordt een cirkel met die straal om het punt berekend en alle BRK percelen binnen die cirkel worden opgezocht.

##SOAP response

De informatie in het SOAP response spreekt veelal voor zich. Indien een response gevoelige informatie bevat wordt dit in het bericht aangegeven. Een ESB kan bijvoorbeeld hierop controleren.

  <ns2:getBrkInfoResponse xmlns:ns2="http://brk.soap.brmo.b3p.nl/">
     <return bevatGevoeligeInfo="true" timestamp="2014-11-05T11:59:32.757+01:00">
        <kadOnrndZk>
           <aandSoortGrootte>1</aandSoortGrootte>
           <aardCultuurOnbebouwd>Erf - Tuin</aardCultuurOnbebouwd>
           <adressen>
              <BAGAdres>
                 <huisnummer>9</huisnummer>
                 <postcode>9999ZZ</postcode>
                 <straatNaam>xxxxxxxxxxxx</straatNaam>
                 <woonplaatsNaam>xxxxxxxx</woonplaatsNaam>
              </BAGAdres>
           </adressen>
           <bedrag>0.0</bedrag>
           <datumBeginGeldigheid>2014-09-01T00:00:00+02:00</datumBeginGeldigheid>
           <gemeentecode>AAA00</gemeentecode>
           <groottePerceel>1490</groottePerceel>
           <identificatie>9999999999999</identificatie>
           <koopjaar>0</koopjaar>
           <meerOnroerendgoed>false</meerOnroerendgoed>
           <perceelnummer>9999</perceelnummer>
           <rechten>
              <zakelijkRecht>
                 <aardVerkregenRecht>Eigendom (recht van)</aardVerkregenRecht>
                 <indicatieBetrokkenInSplitsing>false</indicatieBetrokkenInSplitsing>
                 <nietNatuurlijkPersoon>
                    <naam>Stichting A</naam>
                    <rechtsvorm>Stichting</rechtsvorm>
                    <statutaireZetel>AAAAA</statutaireZetel>
                 </nietNatuurlijkPersoon>
                 <noemer>1</noemer>
                 <teller>1</teller>
              </zakelijkRecht>
              <zakelijkRecht>
                 <aardVerkregenRecht>Opstalrecht Nutsvoorzieningen</aardVerkregenRecht>
                 <indicatieBetrokkenInSplitsing>false</indicatieBetrokkenInSplitsing>
                 <nietNatuurlijkPersoon>
                    <naam>BBBBBB</naam>
                    <rechtsvorm>Naamloze vennootschap</rechtsvorm>
                    <statutaireZetel>ZZZZZZZZZZZ</statutaireZetel>
                 </nietNatuurlijkPersoon>
                 <noemer>1</noemer>
                 <teller>1</teller>
              </zakelijkRecht>
           </rechten>
           <sectie>C</sectie>
           <type>perceel</type>
        </kadOnrndZk>
     </return>
  </ns2:getBrkInfoResponse>

##Authenticatie

De SOAP service gebruikt het zelfde authenticatiemechanisme als de brmo-service. De gebruikersnaam en wachtwoord gelden ook hiervoor. Standaard wordt de SOAP service met BASIC authentication en SSL toegepast. Encryptie en certificaten zijn ook mogelijk.