Vejledning til Retsinformation web services test stubs

Transkript

1 Civilstyrelsen Vejledning til Retsinformation Version:

2 Indholdsfortegnelse 1. Introduktion Installation Web Service beskrivelse og testdata Side 2 af 5

3 1. Introduktion Denne vejledning beskriver, hvordan Retsinformation web service stub pakke installeres og anvendes hos serviceaftagere. Web service stubs er testet mod følgende anbefalede serverkonfiguration: Microsoft Windows Server 2003 R2 (standard edition) SP1 Microsoft Internet Information Server (IIS) 6.0 Microsoft.NET Framework version 2.0 (x86) redistributable Bemærk, Retsinformation web service stubs er udviklet i Microsoft.NET framework 2.0 og kræver derfor en Microsoft baseret platform. Det er desværre ikke muligt at tilbyde kodebase til alternative platforme i øjeblikket. 2. Installation Pakken (webservicestub_ zip) kan hentes fra: Følg nedenstående trin for opsætning af web service stubs: På filsystemet oprettes rodfolder til web service stubs filerne. I IIS en oprettes et nyt web-site, som mapper til web service stubs rodfolderen. Sørg for at web-sitet tillader anonym adgang eller alternativt, at web service klienten sender valide credentials med til web service. Sørg ligeledes for, at web-sitet er konfigureret til at anvende ASP.NET version 2.0. Kopiér nu indholdet af testpakken til web service stubs rodfolderen. I folderen App_Data findes lexdania eksempel data, som anvendes af GetDocument metoden (se nedenfor). Folderen skal ligge i roden af web-sitet. Når web services er installeret som beskrevet ovenfor, kan serviceaftager konfigurere sin egen test applikation op mod disse. Hvis serviceaftager ønsker at autogenerere web service client proxies, fx med wsdl.exe toolet fra Microsoft, skal man anvende wsdl dokumenter genereret af web service stubs selv. 3. Web Service beskrivelse og testdata Retsinformation web service stubs indeholder to services: LegalDocument.asmx og LegalDocuments.asmx. LegalDocuments.asmx eksponerer metoden GetChangedDocumentList og Side 3 af 5 Forfatters initialer: StDa, RLh

4 LegalDocument.asmx eksponerer metoden GetDocument. For en forretningsmæssig beskrivelse af disse metoder henvises til Vejledning til Retsinformation web services. Web services i denne pakke returnerer prækonfigureret testdata, som gør serviceaftager i stand til at konfigurere egne applikationer til at anvende og fortolke data fra Retsinformation web services. Nedenfor beskrives, hvilke test ind- og uddata web services er konfigureret med. Web Service Metode Parameter LegalDocuments.asmx GetChangedDocumentList DocumentChangeDate, string, obligatorisk Input format: DDMMYYYY Testdata Input Dagsdato (fx ) To dage tilbage (fx ) Tre dage tilbage Fire dage tilbage Fem dage tilbage Mere end 10 dage tilbage Forkert formateret dato (fx eller ) Output Response indeholder ingen fundne dokumenter. Elementet documents er tomt. Response indeholder 1 fundet dokument. Response indeholder 2 fundne dokumenter. Response indeholder 3 fundne dokumenter. Response indeholder 4 fundne dokumenter. Response indeholder fejlkode i elementet error og intet documents element. Response indeholder fejlkode i elementet error og intet documents element. Web Service Metode Parameter LegalDocument.asmx GetDocument InternalDocumentID, integer, obligatorisk Testdata Input Output Side 4 af 5

5 1-20 Response indeholder fundet dokument, som matcher dokument id. Elementet document matcher følgende lexdania skemaer: Internal Document Id Dokument type Lexdania skema (.xsd) 1 AND H ANDH.Retsinfo.LexDania_2.1 2 AND I ANDI.Retsinfo.LexDania_2.1 3 AND Æ ANDC.Retsinfo.LexDania_2.1 4 ANG I ANGI.Retsinfo.LexDania_2.1 5 BEK H BEKH.Retsinfo.LexDania_2.1 6 BEK I BEKI.Retsinfo.LexDania_2.1 7 BEK Æ BEKC.Retsinfo.LexDania_2.1 8 BKI BKIT1.Retsinfo.LexDania_2.1 9 CIR1H CIRH.Retsinfo.LexDania_ CIR1Æ CIRC.Retsinfo.LexDania_ CIR H CIRH.Retsinfo.LexDania_ CIS CIS.Retsinfo.LexDania_ DSK H DSKH.Retsinfo.LexDania_ FIN FIN.Retsinfo.LexDania_ LBK H LBKH.Retsinfo.LexDania_ LOV H LOVH.Retsinfo.LexDania_ LOV Æ LOVC.Retsinfo.LexDania_ SKR SKR.Retsinfo.LexDania_ VEJ VEJ.Retsinfo.LexDania_ ÅBR ABR.Retsinfo.LexDania_ Response indeholder fundet dokument, som matcher dokument id 100. Elementet document matcher legacy lexdania skema LEGACY.Retsinfo.LexDania_2.1. Alle andre dokument id er Returnerer et tomt resultat, dvs. intet dokument fundet med pågældende id Side 5 af 5