Webservice til upload af produktionstilladelser

Transkript

1 BILAG 1 Webservice til upload af produktionstilladelser Indhold og anvendelse Denne web-service gør det muligt for 3. parts programmer i kommuner og amter at Uploade og registrere kommunale produktionstilladelser og amtslige afgørelser med dertilhørende kommentarer og detaljer vedr. tilladelsen samt med tilknyttede filer. Web-servicens datagrundlag er de OIO-godkendte schemaer, som er publiceret på infostrukturbasen. De specifikke detaljer mht. hvordan 3-parts programmer forbinder til webservicen fremgår af WSDL filen. Brugervejledning Dataformater En semantisk beskrivelse af dataformater samt skemadefinitioner er tilgængelig fra Ved kald af webservicen modtages en SOAP kvittering. Såfremt denne kvittering ikke indeholder fejlmeddelelser, så er transaktionen gennemført korrekt. Adgange og sikkerhed For at kunne anvende disse webservices er det nødvendigt, at angive et brugernavn og kodeord. Brugeren skal være tilknyttet følgende to Oracle database roller: PRODTILLADELSESINDBERETTER WEBSERVICEROLLE Brugernavn og kodeord overføres via http headers. Der anvendes SSL (https) for at sikre, at data mellem klient og server krypteres. Dermed bliver brugernavn og kodeord beskyttet. Oprettelse af brugere sker ved henvendelse til: IBM s HelpDesk Telefon: e-post: [email protected] Servere Anvendelse af webservices (

2 Amtets afgørelser: Webservice: WSDL: Kommunale produktionstilladelser: Webservice: WSDL: Teknisk vejledning Standardisering Web-servicen anvender OIOXML schemaer som er NDR3 godkendte. Schemaerne kan findes på Infostrukturbasen under namespacet glrchr.dk. Der anvendes to hovedschemaer: countyruling.xsd og productionauthorization.xsd Sikkerhed Sikkerheden baseres på brugernavn og password samt SSL til krypteret data-transmssion. Det betyder, at klienten (dvs. 3. partsprogrammet) skal være i besiddelse af et brugernavn og password for at kunne anvende web-servicen. Brugerstyring For at kunne anvende web-servicen skal der være oprettet en web-service-bruger. Der skelnes mellem web-service brugere (3. partsprogrammer) og øvrige brugere (legaliseret medarbejder). Et 3. partsprogram kan således ikke anvende et medarbejder-login, men skal anvende et specifikt webservice login, hvilket sker på traditionel vis der henvises til dokumentationen for brugerstyring. Services Webservicen tilbyder flg. services: MetodeNavn Beskrivelse af elementer I/O Parameter addproductionauthorization Modtager en xml-instans med data om: - Udstedelsesperiode - Udstedelsesdato - Tilknyttede adresser - Evt. Tilladelsesdetaljer - Evt. Noter/kommentarer - Evt. Vedhæftede filer Input ProductionAuthorization AddCountyRuling Modtager en xml-instans med data om: Input CountyRuling

3 - Udstedelsesperiode - Udstedelsesdato - Tilknyttede adresser - Evt. Noter/kommentarer - Evt. Vedhæftede filer UDDI For at kunne tilgå en webservice er det nødvendigt med en WSDL-fil. Et UDDI er en slags telefonbog hvor det er muligt at finde en serviceudbyder samt evt. hente en WSDL-fil med detaljeret info om hvordan servicen skal tilgås. På OIO findes også et UDDI, i hvilket der bør placeres en WSDL-fil for dette system. Pt. er der dog en række uklarheder om anvendelsen og brugen af dette UDDI. Der arbejdes pt. på en afklaring vedr. dette. Schemaer: De enkelte OIOXML-schemaer med tilhørende metadatabeskrivelser for webservicen kan findes på Infostrukturbasen under namespacet glrchr.dk, på flg. adresser: Oversigt over elementer med typedefinitioner: Det flg. er en oversigt som beskriver hvilke data schemaerne opererer med. Collections/container elementer er ikke inkluderet i nedenstående oversigt kun de enkelte data-elementer og attributter. Ved attributter er elementets navn inkluderet i parentesen. Man kan indvende at oversigten ikke er nødvendig, fordi den ikke indeholder noget nyt ifht. schemafilerne. Dette er korrekt den er dog alligevel inkluderet i dette dokument fordi den overskueliggør dataindholdet af de 16 schemafiler som er nødvendige for denne service. Der opfordres i øvrigt til at studere schemaerne, metadata samt afleveringsdokumentationen som kan findes på Infostrukturbasen, under glrchr.dk namespacet. Element/attr. Navn datatype namespace Attribut (productionauthorization) String Eih IssuePeriodCode Element IssueDate Date Eih Element MunicipalityCode String [0-9] {4} Xkom Element StreetCode String [0-9] {4} Xkom Element StreetBuildingIdentifier String ([1-9] [1-9][0-9] [1-9][0-9]{2}) ([1-9][A- Z] [1-9][0-9][A- Z] [1-9][0-9]{2}[A-Z]) Xkom Element AnimalTypeCode Integer Gr Element AnimalTypeCountQuantity Integer gr Attribut (throughput)unitcode String Eih

4 Element InputQuantity Double Eih Element OutputQuantity Double Eih Element NoteText String Eih Attribut (productionauthorization- String Eih Attachent)CategoryCode Element AttachmentDescription- String Eih Text Attribut (attachmentbinarydata) mimetypecode String Eih

5 Hierarkisk opbygning: ProductionAuthorization:

6 CountyRuling: Logik og betingelser: Instanser af ProductionAuthorization (kommunal tilladelse) kan opdeles i to kategorier: Instanser udstedt FØR 1. august 2004 og instanser udstedt EFTER 1. august 2004 (datoen incl.). Instanser (tilladelser), der er udstedt FØR 1. august 2004 må IKKE indeholde tilladelsesdetaljer dvs. at elementet productionauthorizationdetailcollection skal være udeladt. Instanser udstedt EFTER 1. august 2004 KAN have tilladelsesdetaljer inkluderet, men behøver det ikke. CountyRuling (amtslig afgørelse) er næsten identisk med ProductionAuthorization, og inkluderer derfor også dette schema. Dog kan CountyRuling IKKE have tilladelsesdetaljer inkluderet. Ligeledes kan CountyRuling ikke have en værdi i attributten issueperiodcode. Drift og stabilitet Drift og stabilitet baseres på de øvrige betingelser for glrchr-oppetider.

7 Fejlhåndtering Opkobling og overførsel til Web servicen kan resultere i fejl af forskellige typer. I sådanne tilfælde vil der blive returneret en fejlbesked leveret i xml-format. Nedenfor findes en liste over typiske fejltyper: Fejltype Ikke autentificeret Ikke autoriseret Invalid dataformat Invalide data Systemfejl Beskrivelse Brugeren forsøger at tilgå webservicen uden gyldigt login. Brugeren er ikke autoriseret til at udføre den aktuelle handling. Xml-filen er ikke udformet efter de i schemaet definerede regler Dataindholdet i xml-filen er ikke validt. Fejl som er relateret til applikationen, driften, m.v. Eksempel på produktionstilladelse og afgørelse (XML-instanser) Produktionstilladelse efter 1. august 2004 <?xml version="1.0" encoding="utf-8"?> <ProductionAuthorization xmlns=" xmlns:gr=" xmlns:xkom=" xmlns:cpr=" xmlns:dkcc=" xmlns:xsi=" xsi:schemalocation=" EIH_ProductionAuthorization.xsd" issueperiodcode="afteraugustfirst2004"> <IssueDate> </IssueDate> <ProductionAuthorizationAddressCollection> <cpr:municipalitycode>0751</cpr:municipalitycode> <cpr:streetcode>0680</cpr:streetcode> <dkcc:streetbuildingidentifier>17b</dkcc:streetbuildingidentifier> <cpr:municipalitycode>0743</cpr:municipalitycode> <cpr:streetcode>0551</cpr:streetcode> <dkcc:streetbuildingidentifier>111a</dkcc:streetbuildingidentifier> </ProductionAuthorizationAddressCollection> <ProductionAuthorizationDetailCollection> <ProductionAuthorizationDetail> <gr:animaltypecode>1201</gr:animaltypecode> <gr:animaltypecountquantity>50</gr:animaltypecountquantity> <Throughput unitcode="years"> <InputQuantity>2</InputQuantity> <OutputQuantity>4</OutputQuantity> </Throughput> </ProductionAuthorizationDetail> <ProductionAuthorizationDetail> <gr:animaltypecode>1202</gr:animaltypecode> <gr:animaltypecountquantity>15</gr:animaltypecountquantity> <Throughput unitcode="kg"> <InputQuantity>3</InputQuantity> <OutputQuantity>7</OutputQuantity> </Throughput> </ProductionAuthorizationDetail> </ProductionAuthorizationDetailCollection>

8 <NoteText>Here additional information regarding the authorizations iis written...</notetext> <ProductionAuthorizationAttachmentCollection> <ProductionAuthorizationAttachment categorycode="authorization"> <ProductionAuthorizationAttachment categorycode="ruling"> </ProductionAuthorizationAttachmentCollection> </ProductionAuthorization> Produktionstilladelse før 1. august 2004 <?xml version="1.0" encoding="utf-8"?> <ProductionAuthorization xmlns=" xmlns:gr=" xmlns:xkom=" xmlns:cpr=" xmlns:dkcc=" xmlns:xsi=" xsi:schemalocation=" EIH_ProductionAuthorization.xsd" issueperiodcode="beforeaugustfirst2004"> <IssueDate> </IssueDate> <ProductionAuthorizationAddressCollection> <cpr:municipalitycode>0839</cpr:municipalitycode> <cpr:streetcode>2160</cpr:streetcode> <dkcc:streetbuildingidentifier>135a</dkcc:streetbuildingidentifier> <cpr:municipalitycode>0345</cpr:municipalitycode> <cpr:streetcode>3770</cpr:streetcode> <dkcc:streetbuildingidentifier>23</dkcc:streetbuildingidentifier> </ProductionAuthorizationAddressCollection> <ProductionAuthorizationDetailCollection> <ProductionAuthorizationDetail> <gr:animaltypecode>1201</gr:animaltypecode> <gr:animaltypecountquantity>180</gr:animaltypecountquantity> <Throughput unitcode="years"> <InputQuantity>130</InputQuantity> <OutputQuantity>170</OutputQuantity> </Throughput> </ProductionAuthorizationDetail> <ProductionAuthorizationDetail> <gr:animaltypecode>1202</gr:animaltypecode> <gr:animaltypecountquantity>20</gr:animaltypecountquantity> <Throughput unitcode="kg"> <InputQuantity>3</InputQuantity> <OutputQuantity>7</OutputQuantity> </Throughput> </ProductionAuthorizationDetail> </ProductionAuthorizationDetailCollection> <NoteText>Here it is possible to ad a description...</notetext> <ProductionAuthorizationAttachmentCollection> <ProductionAuthorizationAttachment categorycode="authorization"> <AttachmentDescriptionText>miljøgodkendelse nr 46</AttachmentDescriptionText> <ProductionAuthorizationAttachment categorycode="ruling"> </ProductionAuthorizationAttachmentCollection> </ProductionAuthorization>

9 Amtslig afgørelse <?xml version="1.0" encoding="utf-8"?> <!--Sample XML file generated by XMLSpy v2005 sp1 U ( <CountyRuling xmlns=" xmlns:gr=" xmlns:xkom=" xmlns:cpr=" xmlns:dkcc=" xmlns:xsi=" xsi:schemalocation=" <IssueDate> </IssueDate> <ProductionAuthorizationAddressCollection> <cpr:municipalitycode>0839</cpr:municipalitycode> <cpr:streetcode>2160</cpr:streetcode> <dkcc:streetbuildingidentifier>135a</dkcc:streetbuildingidentifier> <cpr:municipalitycode>0345</cpr:municipalitycode> <cpr:streetcode>3770</cpr:streetcode> <dkcc:streetbuildingidentifier>23</dkcc:streetbuildingidentifier> </ProductionAuthorizationAddressCollection> <NoteText>Her er der mulighed for at skrive en tilknyttende tekst...</notetext> <ProductionAuthorizationAttachmentCollection> <ProductionAuthorizationAttachment categorycode="authorization"> <ProductionAuthorizationAttachment categorycode="map"> </ProductionAuthorizationAttachmentCollection> </CountyRuling>