ELEKTRONISK INDBERETNING POST 23/ VERSION 1.13

Transkript

1 ELEKTRONISK INDBERETNING POST 23/ VERSION 1.13

2 Indhold Indhold... 2 Introduktion... 3 dk.hob.ei.general.plugin... 4 Metoder... 4 GetPrivat GetPrivat Next... 7 DeletePrivat Ex... 7 dk.hob.ei.post.sendmail... 8 Metoder... 8 GetGroups... 8 SendMailToGroups... 9 dk.hob.ei.post.group Metoder GetGroupMailList() GetGroupMail DeleteGroupMailEx UnlockGroupMail PendingGroupMail RejectGroupMailEx SendGroupMailBack Appendix A Revisioner

3 Introduktion Dette modul muliggør afhentning og afsendelse af post. Modulets funktionalitet er yderligere delt på flere moduler, dk.hob.ei.post.sendmail, dk.hob.ei.post.group og dk.hob.ei.general.plugin. Brugeren skal have adgang til det rette modul for at benytte dets funktionalitet, undtagen general modulet, da alle brugere automatisk har adgang til dette. 3

4 dk.hob.ei.general.plugin Metoder GetPrivat C# : DataSet GetPrivat () Denne metode henter det private post som kalderen af methoden har liggende. Bemærk dog, at det nødvendigvis ikke er alt brugeres post som bliver returneret, men kun noget af det. Det er fordi der kan sættes en grænse op på back end en for meget den må returnere på én gang. Man kan så kalde GetPrivat Next() methoden for at hente næste pakke. Denne methode kan man så blive ved med at kalde indtil der ikke bliver returneret flere breve. Hvis man kun kalder GetPrivat () methoden, så bliver de breve man har hentet ned ikke slettet på back end en. Man skal derfor kalde DeletePrivat Ex() methoden bagefter for at slette dem. Der bliver returneret et DataSet med følgende opbygning: <?xml version= 1.0 standalone= yes?> <xs:schema id= NewDataSet xmlns= xmlns:xs= xmlns:msdata= urn:schemas-microsoft-com:xml-msdata > <xs:element name= NewDataSet msdata:isdataset= true > <xs:choice maxoccurs= unbounded > <xs:element name= PersonPostkasse > <xs:sequence> <xs:element name= uibrevid msdata:datatype="system.guid, mscorlib, <xs:element name= uibrugerid msdata:datatype="system.guid, mscorlib, <xs:element name= uibeskedtypeid msdata:datatype="system.guid, mscorlib, <xs:element name= txfra type= xs:string minoccurs="0" /> <xs:element name= txemne type= xs:string minoccurs="0" /> <xs:element name= txbesked type= xs:string minoccurs="0" /> <xs:element name= dtmodtaget type= xs:datetime minoccurs="0" /> </xs:sequence> <xs:element name= GruppePostkasse > <xs:sequence> <xs:element name= uibrevid msdata:datatype="system.guid, mscorlib, <xs:element name= txpluginnavn <xs:element name= txbrugernavn <xs:element name= txgruppenavn type= xs:string minoccurs="0" /> <xs:element name= uigruppeid msdata:datatype="system.guid, mscorlib, <xs:element name= itype type= xs:short minoccurs="0" /> <xs:element name= txemne type= xs:string minoccurs="0" /> <xs:element name= txbesked type= xs:string minoccurs="0" /> <xs:element name= txekstrabesked type= xs:string minoccurs="0" /> <xs:element name= dtmodtaget type= xs:datetime minoccurs="0" /> </xs:sequence> <xs:element name= Attachments > 4

5 <xs:sequence> <xs:element name= uilinjeid msdata:datatype="system.guid, mscorlib, <xs:element name= uibrevid msdata:datatype="system.guid, mscorlib, <xs:element name= txnavn <xs:element name= txtype <xs:element name= txdata type= xs:string minoccurs="0" /> </xs:sequence> <xs:element name= MetaData > <xs:sequence> <xs:element name= istart type="xs:short" minoccurs="0" /> <xs:element name= iantal type="xs:short" minoccurs="0" /> <xs:element name= istorrelse type= xs:integer minoccurs="0" /> </xs:sequence> </xs:choice> </xs:schema> PersonPostkasse Denne tabel indeholder alle de personlige breve som brugeren har liggende. Disse breve er almindelige tekst breve. Hvis der ikke er nogen, vil denne tabel have 0 rækker. uibrevid En GUID der unikt identificerer dette brev. uibrugerid uibeskedtypeid txfra txemne txbesked dtmodtaget En GUID der identificerer brugeren som dette brev tilhører. Denne GUID bliver kun brugt rent internt på back end en. Den identificere typen af denne besked og i de fleste tilfælde vil det være en ny GUID for hvert brev. Den kan godt ignoreres på klient siden. Her står hvem dette brev er fra. Selve emnet på brevet. Selve brevet i XML format. Dette format er beskrevet i Backend dokumentet, appendix B. Hvornår back end en har modtaget denne mail. GruppePostkasse Denne tabel indeholder de personlige breve som brugeren har liggende, men i stedet for tekst breve, er disse skemaer. Hvis der ikke er nogen, vil den indeholde 0 rækker. uibrevid En GUID der unikt identificerer dette brev. txpluginnavn txbrugernavn txgruppenavn Det fulde plug in navn på den plug in som skal bruges for at læse skemaet ind med. Hvem som har indberettet dette skema i tidernes morgen. Navnet på den gruppe som dette skema skal tilknyttes til når det gemmes på disk. 5

6 uigruppeid itype Gruppe id et på den samme gruppe som står i txgruppenavn. Bestemmer hvilken type brugere gruppen indeholder. 0 brugere 1 lokal administratorgruppe. 2 administratorgruppe. 100 personlig gruppe. Har det samme navn som brugeres GUID (uibrugerid i Brugere tabellen). Kun den person er medlem af gruppen. For det meste vil det være 100 der står her. txemne txbesked txekstrabesked dtmodtaget Selve emnet på brevet. Skemaet i xml format (DataSet). Det er muligt at tilknytte en tekst besked til skemaet som så bliver vist sammen med skemaet når man åbner brevet. Hvis der er tilknyttet en tekst besked, står den i samme format som i PersonPostkasse tabellen. Hvis der ikke er tilknyttet en besked, er dette felt DBNull. Hvornår back end en har modtaget denne mail. Attachments Til et brev, kan der tilknyttes x antal attachments. Disse attachments står i denne tabel. Hvis der ikke er nogen attachments, vil denne tabel have 0 rækker. uilinjeid En GUID der unikt identificerer denne række. uibrevid txnavn txtype txdata En GUID på det brev som denne attachment tilhører. Er enten en reference til PersonPostkasse eller GruppePostkasse tabellen. Navnet på denne attachment. Man kan måske kalde det et slags filnavn. Filtypen af denne attachment. Kan f.eks. være txt, jpg, doc, mp3 osv. Det binære data men gemt i base64 format. MetaData Der står ikke noget vigtigt i denne tabel og kan ignoreres. Men hvis man vælger at bruge GetPrivat () sammen med GetPrivat Next() methoden og vil vise noget information til brugeren, så kan man bruge denne tabel til at hente denne information fra. Der vil være en række for hver gang det er nødvendigt at kalde back end en for at hente alt posten. Hvis der f.eks. er 3 rækker, betyder det at back end en skal kaldes 3 gange. Første gang har man allerede gjort ved at kalde GetPrivat () methoden. GetPrivat Next() skal så kaldes 2 gange for at få det hele og til sidst kalder man så DeletePrivat Ex() for at slette de sidste breve man har hentet. Bemærk dog, at når du kalder GetPrivat Next(), så vil denne tabel have én række mindre, da de forrige breve man har hentet er blevet slettet. 6

7 istart Dette er det første brev start nummer, startende fra 0. iantal istorrelse Antallet af breve man får i ét kald. Den totale størrelse af alle brevene i dette kald. GetPrivat Next C# : DataSet GetPrivat Next(String[] privateletters, String[] groupletters) Denne methode skal kaldes, hvis man vil fortsætte med at hente ens bruger private post efter et kald til GetPrivat () methoden. Den returnere det samme DataSet som GetPrivat () gør, så se dokumentationen for denne. Argumenterne er de breve id er fra henholdsvis PersonPostkasse og GruppePostkasse tabellerne man fik fra det forrige kald. Disse breve vil så blive slettet, så man ikke henter dem ned igen. DeletePrivat Ex C# : void DeletePrivat Ex(String[] privateletters, String[] groupletters) Denne methode sletter de breve man angiver i argument listen. Det er brev id er fra henholdsvis PersonPostkasse og GruppePostkasse tabellerne. Man kan kun slette breve som tilhører kalderen af methoden. 7

8 dk.hob.ei.post.sendmail Metoder GetGroups C# : DataSet GetGroups() Denne method returnere en liste med alle de grupper som kalderen af methoden har lov til at sende en brev til. Det returnerede DataSet har følgende opbygning: <?xml version= 1.0 standalone= yes?> <xs:schema id= NewDataSet xmlns= xmlns:xs= xmlns:msdata= urn:schemas-microsoft-com:xml-msdata > <xs:element name= NewDataSet msdata:isdataset= true > <xs:choice maxoccurs= unbounded > <xs:element name= Grupper > <xs:sequence> <xs:element name= uigruppeid msdata:datatype="system.guid, mscorlib, <xs:element name= txnavn <xs:element name= txbeskrivelse <xs:element name= itype type= xs:short minoccurs="0" /> <xs:element name= txnogle type= xs:string minoccurs="0" /> <xs:element name= bgruppeadgang type= xs:boolean minoccurs="0" /> <xs:element name= dtoprettet type= xs:datetime minoccurs="0" /> <xs:element name= dtaendret type= xs:datetime minoccurs="0" /> </xs:sequence> </xs:choice> </xs:schema> Grupper En liste med alle grupperne. uigruppeid En GUID der unikt identificerer gruppen. txnavn txbeskrivelse itype Gruppens navn. En længere forklarende tekst om gruppens formål. Bestemmer hvilken type brugere gruppen indeholder. 0 Brugere. 1 Lokal administratorgruppe. 2 Administratorgruppe. 100 Personlig gruppe. Har det samme navn som brugeres GUID (uibrugerid i Brugere tabellen). Kun den person er medlem af gruppen. 200 Alle gruppen. Der eksistere kun én gruppe med dette nummer, og alle brugere i hele systemet er medlem af denne gruppe. 8

9 txnoegle bgruppeadgang dtoprettet dtaendret Er tom. 0 Gruppen er låst. 1 Gruppen er åben. Dato for oprettelse af gruppen. Dato for ændring af gruppen. SendMailToGroups C# : bool SendMailToGroups(String[] groups, String subject, String mailtext) Denne metode sender en besked til de givne gruppers medlemmers personlige postkasse. groups subject Grupperne hvortil der skal sendes post. Brevets emne i klar tekst. mailtext Selve brevet i XML format. Dette format er beskrevet i Backend dokumentet, appendix B. 9

10 dk.hob.ei.post.group Denne plug in giver rettighed til at sende/modtage gruppe mails som ikke er sendt til ens egen private gruppe. Metoder GetGroupMailList() C# : DataSet GetGroupMailList() Denne method henter en liste over alle de breve som ligger og venter på at blive behandlet. Man vil kun få en liste over de breve som ligger i de grupper kalderen selv er medlem af og indeholder skemaer som kalderen har adgang til. Det returnerede DataSet har følgende opbygning: <?xml version= 1.0 standalone= yes?> <xs:schema id= NewDataSet xmlns= xmlns:xs= xmlns:msdata= urn:schemas-microsoft-com:xml-msdata > <xs:element name= NewDataSet msdata:isdataset= true > <xs:choice maxoccurs= unbounded > <xs:element name= GruppePostkasse > <xs:sequence> <xs:element name= uibrevid msdata:datatype="system.guid, mscorlib, <xs:element name= txpluginnavn <xs:element name= txbrugernavn <xs:element name= txgruppenavn type= xs:string minoccurs="0" /> <xs:element name= txemne type= xs:string minoccurs="0" /> <xs:element name= dtmodtaget type= xs:datetime minoccurs="0" /> <xs:element name= istatus type= xs:int minoccurs="0" /> <xs:element name= txcprnr type= xs:string minoccurs="0" /> <xs:element name= dthaendelsesdato type= xs:datetime minoccurs="0" /> <xs:element name= uiskemaid msdata:datatype="system.guid, mscorlib, <xs:element name= txafventersataf type= xs:string minoccurs="0" /> </xs:sequence> </xs:choice> </xs:schema> GruppePostkasse En liste med alle brevene. uibrevid En GUID der unikt identificerer dette brev. txpluginnavn txbrugernavn txgruppenavn txemne Det fulde plug in navn på den plug in som skal bruges for at læse skemaet ind med. Hvem som har indberettet dette skema. Navnet på den gruppe som dette skema er sendt til. En beskrivelse af hvorfor det er blevet sendt til denne gruppe. 10

11 dtmodtaget istatus Hvornår back end en har modtaget denne mail. Indeholder en status for dette skema. Kan have følgende værdier: 0 Ingen status. 1 Er sat til afventer. txcprnr dthaendelsesdato uiskemaid txafventersataf Skemaets CPR nummer eller en tom streng hvis det ikke er defineret. Skemaets hændelsesdato eller DBNull hvis det ikke er defineret. Skemaets unikke ID. Hvis brevet er sat til afventer (istatus=1), så står der navnet på den person som har sat denne status i dette felt. Hvis ikke, så står der DBNull her. GetGroupMail C# : DataSet GetGroupMail(String letterid) Med denne metode henter du et enkelt gruppe brev ned. Efter du har hentet det, vil det blive markeret som afhentet og kan ikke hentes af andre. Det DataSet som der bliver returneret, minder meget om det som GetPrivat () returnere, bortset fra, at det kun er GruppePostkasse og Attachments tabellerne som står der i. Felterne i disse tabeller er de samme, så se GetPrivat () for information om disse. DeleteGroupMailEx C# : void DeleteGroupMailEx(String[] letterids) Denne metode sletter de breve som der er givet som argument. De vil blive fysisk slettet fra tabellerne, så det er ikke muligt at få dem tilbage igen. Man kan dog kun slette de breve, som kalderen selv har adgang til. UnlockGroupMail C# : bool UnlockGroupMail(String letterid) Denne metode låser en specifik besked op. Herefter kan den hentes og behandles af en anden bruger. letterid En GUID der unikt identificerer beskeden. PendingGroupMail C# : bool PendingGroupMail(String letterid) 11

12 Denne metode låser en specifik besked op og sætter det til afventer. letterid En GUID der unikt identificerer beskeden. RejectGroupMailEx C# : bool RejectGroupMailEx(String letterid, String reason) Denne metode afviser beskeden som returneres til den oprindelige indberetter. letterid reason En GUID der unikt identificerer beskeden. En beskrivelse af hvorfor dette skema skal returneres. SendGroupMailBack C# : bool SendGroupMailBack(String letterid, String reason) Denne metode afviser beskeden som returneres til nogle udvalgte personer i Sundhedsstyrelsen. letterid reason En GUID der unikt identificerer beskeden. En beskrivelse af hvorfor dette skema skal returneres. 12

13 Appendix A Revisioner 1.0 Første udgave 1.1 Rettet en masse og tilføjet metoder som manglet at blive beskrevet Tilføjet txcprnr og dthaendelsesdato til GetGroupList() metoden Tilføjet RejectGroupMailEx() og SendGroupMailBack() metoderne Tilføjet txafventersataf og uiskemaid i resultsættet til GetGroupMailList(). 13

14 14