Vedlegg 5 Bilag Vedlegg 2. Bruk av EKWebService. Notat

Transkript

1 Vedlegg 5 Bilag Vedlegg 2 Bruk av EKWebService Notat Funksjoner... 2 GetTreeData... 2 GetSearchData... 2 GetNoteData... 2 GetDocumentData... 2 Utføre kall mot webservice... 3 Bruk av valgfrie parameter... 4 Tilgjengelige parameter... 4 XML returverdi... 6 FLD... 6 DOC, RES... 7 NOTE... 8 Status... 8 Eks.... 9

2 Funksjoner EK Webservice støtter 4 typer kall. GetTreeData Hente ut struktur og dokumenter i XML string. Parameter SID - Struktur ID MID - Mappe ID Options - Valgfrie parameter GetSearchData Utføre et søk og vise resultatet i XML string. Parameter SID - Struktur ID MID - Mappe ID Options - Valgfrie parameter SearchText - Tekst som skal søkes etter Standard oppførsel på søk er å vise dokumenter som en flat liste uten strukturelementer. Strukturelementer kan vises ved å koble dem inn via valgfrie parameter. GetNoteData Hente ut notater koblet til et dokument, resultat vises i XML string. Parameter DocumentID - Dokument notater skal hentes ut for Options - Valgfrie parameter Resultat er sortert etter viktighet. Notater med samme viktighet vil være sortert etter oppstartsdato med de nyeste øverst. GetDocumentData Hente ut metainformasjon om dokument, resultat vises i XML string. Parameter DocumentID - Dokument ID metainformasjon skal hentes ut for Options - Valgfrie parameter (Ingen parameter er støttet her enda) Side 2 av 9

3 Utføre kall mot webservice Eksempel på bruk av webservice: /EKWeb/Login/EKService.asmx/GetTreeData?SID=1&MID=25&Options=Level;2 /EKWeb/Login/EKService.asmx/GetSearchData?SID=1&MID=25&Options=&SearchText /EKWeb/Login/EKService.asmx/GetNoteData?DocumentID =1&Options=Entity;1 /EKWeb/Login/EKService.asmx/GetDocumentData?DocumentID =1&Options= Legg merke til at alle parametere er obligatoriske i kallet, selv om Options kan være tom må den inkluderes. Side 3 av 9

4 Bruk av valgfrie parameter Parameter legges inn som en separert liste der Id og verdi er separert med ; Eks: Id1;Verdi1 Id2;Verdi2 Level;2 Res;0 Attachments;0 Dersom parameter ikke er spesifisert vil default verdi bli benyttet. Tilgjengelige parameter Felles parameter Gjelder for GetSearchData og GetTreeData ID Gyldige Default Beskrivelse verdier verdi level [Integer] 0 Antall nivå som skal lastes i XML. 0 Betyr last alle nivåer. doc 0 eller 1 1 Skal styringsdokumenter returneres i XML. 1 : Ta med dokumenter 0 : Ikke ta med dokumenter res 0 eller 1 0 Skal resultatdokumenter returneres i XML. 1 : Ta med dokumenter 0 : Ikke ta med dokumenter orderby refnr / doktittel/ inuse Default verdi blir hentet fra WebSite. Kan være forskjellig på GetTreeData og GetSearchData. Styrer hvordan resultatet skal sorteres. RefNr Betyr sorter etter referansenr (dvs. struktur) DokTittel Betyr sorter etter dokument tittel. InUse Betyr sorter etter i bruk dato. Default satt for Endringssøk maxlevel [Integer] Antall mappenivå som skal vises før dokumenter rendres som flat liste. 0 Betyr vis alle nivåer. Default 0 for GetTreeData Default 1 for GetSearchData max [Integer] 0 Maks antall dokumenter som skal vises. Struktur vil kunne vises uten dokumenter dersom maks blir nådd. 0 betyr vis alle dokumenter funnet. Dersom dokumenter funnet overskrider maks som skal vises, vil status bli satt til Unwanted Side 4 av 9

5 showfirst 0 eller 1 Styrer om XML string skal inneholde mappen (SID/MID kombinasjon) som ble forespurt, eller om XML kun skal innholde undermapper/dokumenter til denne mappen. 1 Betyr vis mappen som ble forespurt 0 Betyr vis kun undermapper/dokumenter Default 1 for GetTreeData Default 0 for GetSearchData Søke parameter Gjelder bare for funksjon: GetSearchData ID Gyldige Default Beskrivelse verdier verdi searchtype Bestemmer hvilken type søk som skal kjøres. 0 Betyr kjør et søk i tittel, stikkord, merknad, dokumenttype og referansenr. 1 Betyr kjør et fritekst søk 2 Betyr endringsliste siste <searchtext> dager Treedata parameter Gjelder bare for funksjon: GetTreeData ID Gyldige verdier Default verdi Beskrivelse attachments 0 eller 1 1 Skal vedlegg til dokumenter tas med i XML 1 : Ta med vedlegg i XML 0 : Ikke ta med vedlegg i XML Notedata parameter Gjelder bare for funksjon: GetNoteData entity 0 eller 1 0 Gjelder kallet styringsdokument eller resultatdokument 0 : Styringsdokument 1 : Resultatdokument Side 5 av 9

6 XML returverdi Webservicen returnerer xml data i retur. Elementtypene som returneres er: FLD Folder DOC Styringsdokument RES Resultatdokument NOTE - Notat Status - Statusbeskrivelse Et FLD element kan inneholde alle tre typer elementer, nøstet i henhold til slik strukturen ser ut. Et DOC element kan inneholde vedlegg i form av andre DOC. Et tomt FLD element representerer en mappe som inneholder dokumenter og/eller undermapper som ikke er hentet ut i dette datasettet pga. begrensning i strukturdybe (evt. begrensning i antall elementer som hentes ut). Et Statusfelt blir inkludert i alle XML stringer som returneres. Status forteller om det har oppstått noen problemer med kallet. Egenskapsdata til xml-elementene angis som navngitte attributter. Aktuelle attributter: FLD SID - struktur-id MID - Mappe-id URef - Fullt refnr til mappen (A-II.3.1.2) Title - Mappens tittel Lvl - Mappens innrykks-nivå i strukturen (5) <FLD SID= 1 MID= 25 Uref= A-II Title= Mappenavn Lvl= 2 > Side 6 av 9

7 DOC, RES Id - Dokument-ID URef - Fullt refnr. til dokumentet Title - Dokumenttittel Frm - Forteller om dokumentet er klassifisert som et skjema Grad - Dokumentets gradering Class - Dok.klasse (Word, Excel, ) Fmt - Aktuelle filformater InUse - Dato dokumentet ble tatt i bruk på format dd.mm.yyyy. Dersom dokumentet ikke er tatt i bruk innholder denne en tom string. Merknad - Versjonsmerknad på dokumentet Note - Høyeste viktighetsfarge på notater. Er tom dersom dokumentet ikke har noen aktive notater. Kan ellers være Green, Yellow eller Red Følgende returneres kun for GetDocumentData kall: Ver - Versjonsnr til dokumentet App - Person som har godkjent dokument Owner - Dokumentansvarlig Type - Dokumenttype Search - Søkeord/Synonymer <DOC Id = 172 URef = A-II-01 Title = Mitt dokument Frm= 0 Grad= 0 Class= Word Fmt= doc;htm;pdf /> Side 7 av 9

8 NOTE NoteId - Id på notat Color - Viktighetsfarge på notat (Green, Yellow, Red) StartDate - Notat gyldig fra dato Text - Notattekst ReportedBy - Notat opprettet av Status StatusId - Statuskode som forteller om det har oppstått problemer. Gyldige verdier: OK Unwanted Error Ingen problemer har oppstått En uønsket hendelse har oppstått. Systemet vil forstatt returnere konsistente data men den vil være mangelfull. Dette skjer når det er definert et maks antall dokumenter som skal returneres og funnet dokumentmasse overstiger dette antallet. En feil har oppstått. Ingen data vil bli returnert. Description - Beskrivende tekst for status. <Status StatusId= OK Description= Ingen problemer oppstått /> <Status StatusId= Unwanted Description= Kall fant 750 dokumenter. Kun 500 dokumenter ble returnert grunnet maks antall dokumenter begrensning. /> <Status StatusId= Error Description= Mangler gyldig SID eller MID /> Side 8 av 9

9 Eks. <XML> <FLD sid= 1 mid= 3 uref= A-II title= Min mappe.> <DOC id= 172 uref= A-II title= Mitt første dokument /> <DOC id= 37 uref= A-II title= Dokument med vedlegg > <DOC id= 305 uref= V01 title= Skjema for datt /> </DOC> <FLD sid= 1 mid= 12 uref= A-II title= Undermappe 1 > <DOC.. /> : </FLD> <FLD sid= 1 mid= 188 uref= A-II title= Undermappe 2 > <DOC.. /> : </FLD> </FLD> <Status StatusId= OK Description= Ingen problemer oppstått /> </XML> <XML> <NOTE NoteId= 1 Color= Red StartDate= Text= Rødt notat ReportedBy= Ansatt /> <NOTE NoteId= 2 Color= Yellow StartDate= Text= Gult notat ReportedBy= Ansatt /> <NOTE NoteId= 3 Color= Green StartDate= Text= Grønt notat ReportedBy= Ansatt /> <Status StatusId= OK Description= Ingen problemer oppstått /> </XML> Side 9 av 9