Basiswettenbestand Gebruikersdocumentatie Web services. Versie 1.0 Datum 3 juni 2015

Transcriptie

1 Basiswettenbestand Gebruikersdocumentatie Web services Versie 1.0 Datum 3 juni 2015

2 Inhoudsopgave 1 INLEIDING DOCUMENTHISTORIE OPID2BWBIDSERVICE DOEL ENDPOINT WSDL METHODES GetBWBLinkItemsBasesOnOPID BWBIDSERVICE DOEL ENDPOINT WSDL METHODES searchbybwbid searchbytitle searchmodifiedsince... 8 Pagina 2 van 8

3 1 Inleiding Er zijn 2 web services beschikbaar waarmee regelingen gezocht kunnen worden in het basiswettenbestand. Dit document bevat de documentatie voor deze services. Het basiswettenbestand bevat de volgende services: OPId2BWBIdService - Hiermee kunnen regelingen gezocht worden op basis van een publicatie op officielebekendmakingen.nl. BWBIdService - Hiermee kunnen regelingen gezocht worden op basis van identifier, titel of laatste wijzigingsdatum. Het basiswettenbestand bevat ook nog een web service gebaseerd op SRU. Deze is beschreven in het document 'Basiswettenbestand - Gebruikersdocumentatie - SRU'. 1.1 Documenthistorie Versie Datum Beschrijving Initiële versie Pagina 3 van 8

4 2 OPId2BWBIdService 2.1 Doel Met deze service is het mogelijk om regelingen te zoeken die ontstaan of gewijzigd zijn op basis van een publicatie op officielebekendmakingen.nl. 2.2 Endpoint Deze service heeft het volgende endpoint: WSDL De volgende wsdl definieert deze service: Methodes Deze service bevat de volgende methodes: GetBWBLinkItemsBasesOnOPID (versie 1.1) GetBWBLinkItemsBasesOnOPID (versie 1.2) De twee methodes zijn gelijk. Het verschil is dat de eerst op SOAP versie 1.1. is gebaseerd en de tweede op versie GetBWBLinkItemsBasesOnOPID Met deze methodes is het mogelijk om regelingen te zoeken die ontstaan of gewijzigd zijn op basis van een publicatie op officielebekendmakingen.nl. Request Een voorbeeld van een request voor versie 1.1 is als volgt. <soapenv:envelope xmlns:soapenv=" xmlns:bwb=" <soapenv:header/> <soapenv:body> <bwb:getbwblinkitemsbasesonopid> <bwb:opid>stb </bwb:opid> </bwb:getbwblinkitemsbasesonopid> </soapenv:body> </soapenv:envelope> Voor versie 1.2 is het bericht hetzelfde op de namespace na. <soap:envelope xmlns:soap=" xmlns:bwb=" <soap:header/> <soap:body> <bwb:getbwblinkitemsbasesonopid> <bwb:opid>stb </bwb:opid> </bwb:getbwblinkitemsbasesonopid> </soap:body> </soap:envelope> De volgende velden moeten in het request gespecificeerd worden. opid Het identificatie nummer van de officiële publicatie. Dit moet voldoen aan een van de volgende reguliere expressies: (stb stcrt trb)-(\d{4})-(\d*).* (kst)-(\d*).* Er kan dus gezocht worden naar Staatsbladen, Staatscouranten, Tractatenbladen en kamerstukken. Pagina 4 van 8

5 Response Een voorbeeld van een response voor versie 1.1 is als volgt. <SOAP-ENV:Envelope xmlns:soap-env=" <SOAP-ENV:Body> <ns1:getbwblinkitemsbasesonopidresponse xmlns:ns1=" <ns1:getbwblinkitemsbasesonopidresult> <ns1:arrayofstring> <ns1:string> <ns1:string>wet strategische diensten</ns1:string> </ns1:arrayofstring> </ns1:getbwblinkitemsbasesonopidresult> </ns1:getbwblinkitemsbasesonopidresponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> Een voorbeeld voor versie 1.2 is als volgt. <env:envelope xmlns:env=" <env:body> <ns1:getbwblinkitemsbasesonopidresponse xmlns:ns1=" <ns1:getbwblinkitemsbasesonopidresult> <ns1:arrayofstring> <ns1:string> <ns1:string>wet strategische diensten</ns1:string> </ns1:arrayofstring> </ns1:getbwblinkitemsbasesonopidresult> </ns1:getbwblinkitemsbasesonopidresponse> </env:body> </env:envelope> De volgende velden worden in het response teruggegeven. url titel url van de regeling op wetten.nl Huidige citeertitel van de regeling Pagina 5 van 8

6 3 BWBIdService 3.1 Doel Met deze service is het mogelijk om regelingen te zoeken op basis van de identifier, de titel of de laatste wijzigingsdatum. 3.2 Endpoint Deze service heeft het volgende endpoint: WSDL De volgende wsdl definieert deze service: Methodes Deze service bevat de volgende methodes: searchbybwbid searchbytitle searchmodifiedsince searchbybwbid Met deze methode is het mogelijk om regelingen te zoeken op basis van de identifier. Request Een voorbeeld van een request is als volgt. <soapenv:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soapenv=" xmlns:bwb=" <soapenv:header/> <soapenv:body> <bwb:searchbybwbid soapenv:encodingstyle=" <bwbid xsi:type="xsd:string">bwbr </bwbid> </bwb:searchbybwbid> </soapenv:body> </soapenv:envelope> De volgende velden moeten in het request gespecificeerd worden. bwbid Identificatie van een regeling Response Een voorbeeld van een response is als volgt. <SOAP-ENV:Envelope SOAP-ENV:encodingStyle=" xmlns:xsi=" xmlns:soap- ENC=" xmlns:soap- ENV=" xmlns:xsd=" <SOAP-ENV:Body> <namesp1:searchbybwbidresponse xmlns:namesp1=" <return xsi:type="bwbns:bwbidserviceresultaat" xmlns:bwbns=" <GegenereerdOp xsi:type="xsd:date"> </gegenereerdop> <RegelingInfoLijst xsi:type="soap-enc:array" SOAP-ENC:arrayType="bwbns:RegelingInfo[1]"> <RegelingInfo xsi:type="bwbns:regelinginfo"> <BWBId xsi:type="xsd:string">bwbr </bwbid> <DatumLaatsteWijziging xsi:type="xsd:date"> </datumlaatstewijziging> <VervalDatum xsi:type="xsd:date" xsi:nil="true"/> <OfficieleTitel xsi:type="xsd:string">grondwet voor het Koninkrijk der Nederlanden van 24 augustus 1815</OfficieleTitel> Pagina 6 van 8

7 <CiteertitelLijst xsi:type="soap-enc:array" SOAP-ENC:arrayType="bwbns:Citeertitel[1]"> <Citeertitel xsi:type="bwbns:citeertitel"> <titel xsi:type="xsd:string">grondwet</titel> <status xsi:type="xsd:string">officieel</status> <InwerkingtredingsDatum xsi:type="xsd:date"> </inwerkingtredingsdatum> </Citeertitel> </CiteertitelLijst> <NietOfficieleTitelLijst xsi:type="soap-enc:array" SOAP-ENC:arrayType="xsd:string[0]"/> <AfkortingLijst xsi:type="soap-enc:array" SOAP-ENC:arrayType="xsd:string[2]"> <Afkorting xsi:type="xsd:string">gw</afkorting> <Afkorting xsi:type="xsd:string">gw</afkorting> </AfkortingLijst> <RegelingSoort xsi:type="xsd:string">wet</regelingsoort> </RegelingInfo> </RegelingInfoLijst> </return> </namesp1:searchbybwbidresponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> De volgende velden worden in het response teruggegeven. GegenereerdOp BWBId DatumLaatsteWijziging VervalDatum OfficieleTitel Citeertitel - titel Citeertitel - status Citeertitel - Inwerkingtredingsdatum NietOfficieleTitel Afkorting Regelingsoort Datum-tijd waarop het respons is gegenereerd Identificatie van de regeling De datum waarop voor het laatst een publicatie op de repository is gedaan voor de regeling De intrekkingsdatum van de regeling De intitule van de regeling Citeertitel. De citeertitel van een regeling kan wijzigen. De service geeft altijd alleen de huidige titel terug. Status van de citeertitel inwerkingtredingsdatum van de citeertitel. Niet-officiële titel van de regeling Afkorting van de regeling Soort van de regeling searchbytitle Met deze methode is het mogelijk om regelingen te zoeken op basis van de citeertitel. Request Een voorbeeld van een request is als volgt. <soapenv:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soapenv=" xmlns:bwb=" <soapenv:header/> <soapenv:body> <bwb:searchbytitle soapenv:encodingstyle=" <titel xsi:type="xsd:string">grondwet</titel> <datumgeldig xsi:type="xsd:date"> </datumgeldig> <volledigetitel xsi:type="xsd:boolean">grondwet</volledigetitel>- </bwb:searchbytitle> </soapenv:body> </soapenv:envelope> De volgende velden moeten in het request gespecificeerd worden. Pagina 7 van 8

8 titel datumgeldig volledigetitel Citeertitel van de regeling geldigheidsdatum Boolean om aan te geven of het de volledige titel betreft Response Zie searchbybwbid searchmodifiedsince Met deze methode is het mogelijk om regelingen te zoeken op basis van de laatste wijzigingsdatum. Request Een voorbeeld van een request is als volgt. <soapenv:envelope xmlns:xsi=" xmlns:xsd=" xmlns:soapenv=" xmlns:bwb=" <soapenv:header/> <soapenv:body> <bwb:searchmodifiedsince soapenv:encodingstyle=" <datumgewijzigd xsi:type="xsd:datetime"> </datumgewijzigd> </bwb:searchmodifiedsince> </soapenv:body> </soapenv:envelope> De volgende velden moeten in het request gespecificeerd worden. datumgewijzigd Datum laatste wijziging van de regeling Response Zie searchbybwbid Pagina 8 van 8