DKAL Snitflade Webservice

Transkript

1 DKAL Snitflade Webservice Typografidefinition: Overskrift 1: Skrifttype: Indrykning: Venstre: 0 cm, Hængende: 0,76 cm, Sideskift før Typografidefinition: Overskrift 2;H2;h2;2;headi;hea ding2;h21;h22;21;heading Two;DFL 12 fed og indrykket 3 cm;attribute Heading 2;(Alt+2);L2;dd heading 2;dh2;RFP Heading 2;sub-sect;sl2;Überschrift 2 Anhang;Überschrift 2 Anhang1;Überschrift 2 Anhang2;Titre2;R2;PLS 2: Skrifttype: Indrykning: Venstre: 1,9 cm, Hængende: 0,63 cm, Tabulatorer: 2,54 cm, Listetabulator + Ikke med 1,02 cm Typografidefinition: TOC Heading1: Skrifttype: Indrykning: Venstre: 0 cm, Hængende: 0,76 cm, Sideskift før 1

2 Indholdsfortegnelse INDHOLDSFORTEGNELSE 2 G.1 INTRODUKTION 4 G.1.1 HENVISNINGER 4 G.1.2 LÆSEVEJLEDNING 4 G SÅDAN LÆSES ET OBJEKT 4 G SÅDAN LÆSES EN OPERATION 6 G.2 AFSENDERSYSTEM 7 G AFGØR OM SLUTBRUGEREN ØNSKER EN AFSENDELSE 7 G AFSEND / OPDATER AFSENDELSE 7 G HENT EN TIDLIGERE AFSENDELSE 8 G TILBAGEKALD EN PLANLAGT AFSENDELSE 8 G.2.2 OBJEKTER 8 G AFSENDELSESAMLING 9 G AFSENDELSE 10 G VEDHAEFTNINGSAMLING 14 G VEDHAEFTNING 14 G MEDDELELSEFESDMETADATA 15 G TILMELDINGSAMLINGREFERENCESAMLING 16 G TILMELDINGSAMLING 16 G.2.3 OPERATIONER 17 G AFSEND OG OPDATER EN AFSENDELSE 17 G TILBAGEKALD EN AFSENDELSE 18 G HENT INFORMATIONER FOR EN SPECIFIK AFSENDELSE 18 G HENT INDHOLDET AF EN AFSENDELSE 19 G HENT INDHOLDET AF EN VEDHÆFTNING 20 G SØG EFTER TIDLIGERE AFSENDTE / PLANLAGTE AFSENDELSER 20 G FORESPØRG OM EN SLUTBRUGER ØNSKER EN SPECIFIK INDHOLDSTYPE 21 G HENT REFERENCE TIL BESTILT TILMELDINGSLISTE 23 G HENT EN BESTILT TILMELDINGSLISTE PER INDHOLDSTYPE 24 G SLET EN ÆNDRINGSLISTE 24 G.3 REGISTER 25 G KONFIGURATION AF ET REGISTER 25 G.3.2 OBJEKTER 26 G SLUTBRUGERSAMLINGREFERENCESAMLING 27 G SLUTBRUGERSAMLING 27 G SLUTBRUGER 27 G MYNDIGHEDSTILMELDING 28 G GRUPPETILMELDINGSAMLING 29 G GRUPPETILMELDING 29 G SLUTBRUGERSTAMDATA 30 G.3.3 OPERATIONER 31 Bilag G: Webservice 2... [1]... [2]... [3]... [4]... [5]... [6]... [7]... [8]... [9]... [10]... [11]... [12]... [13]... [14]... [15]... [16]... [17]... [18]... [19]... [20]... [21]... [22]... [23]... [24]... [25]... [26] Slettet: AFSENDELSER... [27]... [28]... [29] Slettet: VEDHÆFTNINGER... [30]... [31]... [32]... [33]... [34] Slettet: VEDHÆFTNING... [35]... [36] Slettet: FESDMETADATA... [37]... [38]... [39]... [40] Slettet: AFSENDERMETADATA... [41]... [42]... [43] Slettet: TILMELDINGSLISTE... [44]... [45]... [46]... [47]... [48]... [49]... [50]... [51]... [52]... [53]... [54]... [55]... [56]... [57]... [58]... [59]

3 G.3.4 HENT REFERENCE TIL SLUTBRUGERLISTE 31 G HENT SLUTBRUGER DELLISTE 32 G SLET ÆNDRINGSLISTE 33 G HENT EN SLUTBRUGERS STAMDATA OG TILMELDINGER 33 G OPRET BOKS / OPDATER STAMDATA 34 G TIL- / AFMELD EN SLUTBRUGER TIL EN MYNDIGHED / ALLE MYNDIGHEDER 35 G TILMELD EN SLUTBRUGER TIL EN TILMELDINGSGRUPPE 36 G SLET EN TILMELDING FOR EN SLUTBRUGER 37 G.4 AFHENTNINGSSYSTEM 38 G HENTE MEDDELELSER FRA INDBAKKE I SIKKER BOKS 38 G HENTE MEDDELELSER FRA POSTKASSE(R) 38 G.4.2 OBJEKTER 39 G MEDDELELSEREFERENCESAMLING 40 G MEDDELELSE 40 G SIGNATURBEVIS 41 G POSTKASSEMETADATA 42 G VEDHAEFTNINGSAMLING 42 G VEDHAEFTNING 43 G MEDDELELSEFESDMETADATA 44 G.4.3 OPERATIONER 44 G HENT LISTE AF DE ÆLDSTE MEDDELELSE FRA INDBAKKEN 44 G HENT MEDDELELSE I SLUTBRUGERENS INDBAKKE 46 G SLET MEDDELELSE FRA INDBAKKEN 46 G ARKIVER MEDDELELSE FRA INDBAKKEN 47 G HENT LISTE AF UAFHENTEDE MEDDELELSER FRA TILKNYTTEDE POSTKASSER 47 G HENT SELVE MEDDELELSEN FRA EN TILKNYTTET POSTKASSE 48 G SLET MEDDELELSE FRA TILKNYTTET POSTKASSE 49 G.5 PORTAL 50 G FÆLLESOFFENTLIGE PORTALER 50 G.5.2 OBJEKTER 50 G MEDDELELSEOVERSIGTSAMLING 51 G MEDDELELSEOVERSIGT 52 G SLUTBRUGERTILMELDINGER 53 G MYNDIGHEDSTILMELDING 53 G GRUPPETILMELDINGSAMLING 54 G GRUPPETILMELDING 54 G.5.3 OPERATIONER 55 G HENT EN SLUTBRUGERS TILMELDINGER 55 G TIL- / AFMELD EN SLUTBRUGER TIL EN MYNDIGHED / ALLE MYNDIGHEDER 56 G TILMELD EN SLUTBRUGER TIL EN TILMELDINGSGRUPPE 57 G SØG EFTER MEDDELELSER I EN SLUTBRUGERS BOKS 58 G HENT ANTAL ULÆSTE MEDDELELSER I EN SLUTBRUGERS BOKS 59 G.6 FEJLKODER 60 Bilag G: Webservice 3... [64] Slettet: 3.3 EN SLUTBRUGERS... [65]... [66]... [67]... [68] Slettet: 3. OPRET BOKS.../ [69]... [70]... [71]... [72]... [73]... [74] Slettet: G TIL- / AFMELD... [75]... [76]... [77] Slettet:.6 TILMELD SLUTBRU... [78]... [79]... [80]... [81]... [82] Slettet: G SLET EN... [83]... [84]... [85]... [86]... [87] Slettet: G.4 AFHENTNINGSSYST... [88]... [89]... [90]... [91]... [92] Slettet: G.4.1 OBJEKTER... [93]... [94]... [95]... [96] Slettet:.1.2 MEDDELELSE... [97]... [98]... [99]... [100] Slettet: G MEDDELELSER... [101]... [102]... [103]... [104] Slettet: 3 POSTKASSEMETADAT... [105]... [106]... [107]... [108] Slettet: 4 VEDHÆFTNINGER... [109]... [110]... [111]... [112] Slettet: 1.5 VEDHÆFTNING... [113]... [114]... [115]... [116]... [117]... [118]... [119]... [120]... [121]... [122]... [123]

4 Introduktion Dette dokument beskriver DKAL s Webservice snitflade. Snitfladen er delt i fire funktionsområder: afsendersystem, register, afhentningssystem og portal. Afsendersystem anvendes når en myndighed ønsker at sende afsendelser til borgere, virksomheder og myndigheder som er tilmeldt DKAL. Register anvendes af en myndighed til at hente og opdatere stamdata og administrerer til- og afmeldinger for slutbrugere. Afhentningssystem anvendes af virksomheder til at hente meddelelser i deres sikre boks, og af myndigheder til at hente meddelelser sendt til dem via deres postkasser. Portal anvendes af myndigheder til at tilmelde slutbrugere til tilmeldingsgrupper, hente slutbrugers seneste meddelelser samt hente antallet af ulæst meddelelse. Denne snitflade er et supplement til REST snitfladen. I forhold til DKAL anbefaler IT- og Telestyrelsen at REST snitfladen anvendes frem for webservice snitfladen. Dokumentet henvender sig til udviklere og arkitekter, der skal foretage systemintegration med DKAL. Denne introduktion indeholder udover en henvisning til andre relevante dokumenter, en læsevejledning til snitfladebeskrivelsen. G.1.1 Henvisninger Følgende dokumenter indeholder information, som er relevant for den snitflade, der er beskrevet i dette dokument: DKAL snitflader indeholder den overordnede beskrivelse af DKAL s system-til-system snitflader. Dokumentet indeholder også en begrebsliste, som beskriver alle DKAL relaterede begreber, der er anvendt i dette dokument. Disse begreber er i dette dokument skrevet med kursiv og det anbefales at læse dem forud for dette dokument. Bilag F Sikkerhed beskriver sikkerheden vedrørende DKAL s system-til-system snitflader. Bilag A1-A4 beskriver REST snitfladen, der tilbyder den samme funktionalitet som denne snitflade. Slettet: Sideskift G.1.2 Læsevejledning Metoden der anvendes i dette dokument til beskrivelse af objekter og operationer er beskrevet i dette afsnit. G Sådan læses et objekt Objekter er en samling af datafelter. Et eller flere objekter kan danne en Webservice-besked, der anvendes som input eller output til operationerne i Webservice-snitfladen. Objekter er dokumenteret via en oversigt, som viser deres relationer, og via hver sin tabel, som beskriver formål, det tilhørende XML skema, samt hvert enkelt felt. Bilag G: Webservice 4

5 Nedenstående illustration er et eksempel på en oversigt af objekter. AfsendelseSamling Afsendelse Afs Af MeddelelseFESDmetadata VedhaeftningSamling Slettet: FESDmetadata En reference fra et objekt til et andet objekt er vist med en fuldt optrukken pil. Referencen følger pilens retning. En stiplet pil viser at et objekt er inkluderet som en del af et andet objekt. Inkluderingen følger pilens retning. Ovenstående illustration viser således at AfsendelseSamling har en reference til Afsendelse, og at MeddelelseFESDmetadata og VedhaeftningSamling er inkluderet i Afsendelse. Hvert objekt er beskrevet i en tabel, som beskriver formål, det tilhørende XML skema, samt hvert enkelt felt. Tabellen kan også indeholde eksempler og kommentarer. For hvert felt er angivet hvordan det kan anvendes, feltets navn og en beskrivelse. Nedenfor er vist et forsimplet eksempel for objektet Afsendelse. Slettet: Afsendelser Slettet: FESDmetadata Slettet: Vedhæftninger Afsendelse Beskriver objektets formål. OBJEKT XSD Navnet på det XSD skema som beskriver objektet. R Type Meddelelse Servicebesked C Indholdstype Angiver indholdstypen for afsendelsen. U Titel Titlen på afsendelsen. C Metadata Metadata for afsendelsen. Slettet: FESDmetadata : Normal, Mellemrum Før: 6 pkt., Linjeafstand: enkelt Felt navnet Beskrivelse R: feltet kan kun læses. C: feltet er obligatorisk ved oprettelse, og kan efterfølgende kun læses. U: feltet er obligatorisk ved oprettelse, og kan efterfølgende opdateres. I eksemplet ovenfor er feltet Indholdstype påkrævet ved oprettelse idet der står (C) ud for feltet. Feltet Type er afledt af Indholdstype (en indholdstype er enten servicebesked eller en meddelelse). Derfor kan dette felt kun læses (R). Feltet Titel er også påkrævet ved oprettelse, men kan opdateres efterfølgende (U). Bilag G: Webservice 5

6 Feltnavne som starter med små bogstaver er attributter. Store begyndelsesbogstaver angiver elementer. G Sådan læses en operation Hver operation i snitfladen er beskrevet i en tabel, som beskriver formål, input parametre, output content og mulige fejlkoder, der kan returneres. Tabellen kan også indeholde eksempler på anvendelse og kommentarer. Alle operationer tilhører en service, så navnet er angivet som Service.Operation. Afsendersystem.HentAfsendelse et med operationen. Angiver Service.Oper ation Eksempler på anvendelse Input parametre Input søgeparametre Output content Fejlkoder Beskriver eksempler hvor operationen anvendes. Beskriver input parametre. Beskriver eventuelle søgeparametre. I denne sektion fremgår resultatet af kaldet deriblandt om resultatet er OIOXML / binært. Af denne sektion fremgår mulige fejlkoder, der kan returneres. Den første kode er den DKAL-specifikke fejlkode. Den relaterede HTTP returkode er angivet i parentes. Bilag G: Webservice 6

7 Afsendersystem Dette funktionsområde gør det muligt for et afsendersystem, at forespørge om en slutbruger er tilmeldt en indholdstype, at hente tilmeldingslister, og afsende meddelelser (heriblandt dokumenter og servicebeskeder) til tilmeldte slutbrugere. Meddelelser kan evt. have dokumenter og bilag vedhæftet. Tidligere fremsendte meddelelser kan fremfindes via søgning. Planlagte afsendelser som endnu ikke er afsendt, kan annulleres ligesom afsendelsestidspunktet kan ændres. En oversigt over samtlige kald hertil er vist nedenfor. Slettet: Sideskift G Afgør om slutbrugeren ønsker en afsendelse Forud for en afsendelse skal det afgøres hvorvidt brugeren ønsker at modtage afsendelsen. Dette gøres enten via en tilmeldingsliste eller en specifik forespørgsel: Afsendersystem.HentTilmeldingslisteReference Hent en reference til en bestilt tilmeldingsliste og referencer til de enkelte dellister, som tilmeldingslisten kan være delt i. Slettet: HentTilmeldingsli ste Hent Afsendersystem.HentTilmeldingslisteDelliste Hent en den af en bestilt tilmeldingsliste indeholdende en liste af slutbrugeres tilmeldinger på indholdstypeniveau. En slutbruger er ikke tilmeldt en indholdstype direkte, men er tilmeldt en tilmeldingsgruppe, der har en eller flere indholdstyper tilknyttet. Dermed er slutbrugeren indirekte tilmeldt disse indholdstyper. Tilmeldingslisten er begrænset til de indholdstyper, der tilhører det pågældende system, og de slutbrugere, som er tilmeldt disse indholdstyper. Tilmeldingslisten kan enten være en komplet liste eller en ændringsliste. Har man bestilt ændringslister, er det den ældste forberedte liste, der hentes via dette kald. AfsendersystemSletTilmeldingsliste Slet en ændringsliste. Dette skal gøres når listen er succesfuldt behandlet. Efter dette kald bliver den næste ændringsliste tilgængelig såfremt der er en. Afsendersystem.ErTilmeldt Forespørg om en slutbruger er tilmeldt en specifik indholdstype. G Afsend / opdater afsendelse Følgende operationer anvendes til at afsende og opdatere en afsendelse: Afsendersystem.OpretAfsendelse Afsendersystem.OpdaterAfsendelse Anvendes til at oprette en afsendelse og opdatere en planlagt afsendelse. En afsendelse bliver til en meddelelse når den er afsendt. Afsendelsen kan indeholde både XML og binære data, når den oprettes. Det binære data er indkodet i Base64 formatet. Afsendelsen indeholder afsendelsens informationer inklusiv metadata, selve indholdet, og evt. vedhæftninger. Når en afsendelse er oprettet er den eneste ændring der kan foretages annullering eller ændring af afsendelsestidspunkt. En afsendelse bliver først afsendt, når den har status planlagt og det angivne afsendelsestidspunkt er nået. Indtil da er den planlagt eller afventer. Parameteren meddelelsesid bestemmes af afsendersystemet. Det er afsendersystemets ansvar at sikre at de anvendte id er er unikke indenfor det pågældende afsendersystem. Slettet: afsendelsensinform ationer Slettet: Parametren Bilag G: Webservice 7

8 G Hent en tidligere afsendelse Nedenstående kald anvendes til at hente information om afsendelsen, indholdet samt eventuelle vedhæftninger: Afsendersystem.HentAfsendelse Anvendes til at hente informationer om en specifik afsendelse. Afsendelsen indeholder ikke selve indholdet, men en reference til det. Afsendersystem.HentAfsendelseIndhold Indholdet af en afsendelse kan være tekst, HTML eller en binær fil. Denne operation henter dette indhold. Afsendelsessystem.HentVedhæftningIndhold Indholdet af en vedhæftning kan være tekst, HTML eller en binær fil. Denne operation henter dette indhold. Slettet: vefhæftning Afsendersystem.FindAfsendelser Søg efter tidligere afsendte og planlagte afsendelser. G Tilbagekald en planlagt afsendelse Så længe en afsendelse endnu ikke er afsendt er det muligt at tilbagekalde den via nedenstående kald: Slettet: Sålænge Afsendersystem.AnnullerAfsendelser Slet en afsendelse. G.2.2 Objekter Følgende objekter anvendes i forbindelse med enkeltforsendelser. AfsendelseSamling TilmeldingSamlingReferenceSamling Afs AfsendelseOversigt TilmeldingSamling Afs Afsendelse Slettet: Afsendelser FESDmetadata MeddelelseFESDmetadata VedhaeftningSamling Vedhaeftning AfsenderMetadata AfsendelseSamling - Indeholder en liste af afsendelser med udvalgte informationer om hver afsendelse Bilag G: Webservice 8

9 samt en reference til afsendelserne. Disse informationer er repræsenteret i typen AfsendelseOversigt. Afsendelse - Indeholder information om en afsendelse, f.eks. modtager, titel, tilstand, afsendelsestidspunkt, og metadata. Ved oprettelse indeholder en afsendelse indholdet, og ved læsning indeholder den en reference til selve indholdet. Det samme gælder for eventuelle vedhæftninger. VedhaeftningSamling - Indeholder en liste af Vedhaeftning. Typen er inkluderet i Afsendelse. Vedhaeftning - Indeholder information om en vedhæftning, f.eks. titel, og format. Ved oprettelse indeholder en vedhæftning indholdet, og ved læsning indeholder den en reference til selve indholdet af vedhæftningen. MeddelelseFESDmetadata - Indeholder FESD metadata, der anvendes til automatisering af behandlingen af meddelelsen. Objektet er inkluderet i Afsendelse. Slettet: selve Slettet: evt. Slettet: Vedhæftninger Slettet: Vedhæftning Slettet: Vedhæftning Slettet: selve Slettet: FESDmetadata AfsenderMetadata - Indeholder metadata, som afsenderen ønsker at inkludere i afsendelsen. Disse metadata vil ikke blive læst eller redigeret af DKAL, men blot transporteret, som en del af afsendelsen. De vil være skjult for slutbrugeren, men være tilgængelig for afsenderen selv. Og de vil være inkluderet i svar på afsendelsen. AfsenderMetadata bliver håndteret som en vedhæftning til afsendelsen, som har det reserverede navn dkalafsendermetadata.xml. TilmeldingSamlingReferenceSamling - Indeholder en reference til en tilmeldingsliste. Dette kan enten være en komplet liste eller en ændringsliste. En tilmeldingsliste kan pga. størrelse være delt i et antal dellister; ressourcen inkluderer således en samling af referencer til hver delliste. TilmeldingSamling - Indeholder en liste af tilmeldinger, der hver angiver en slutbruger og den indholdstype, som slutbrugeren er tilmeldt. G AfsendelseSamling AfsendelseSamling OBJEKT Objektet indeholder en oversigtsliste med de vigtigste informationer om afsendelser, som er afsendt eller planlagt til afsendelse, samt en reference til de detaljerede informationer for hver afsendelse. Når afsendelsen modtages hos brugeren bliver den til en meddelelse. Slettet: Tilmeldingsliste Slettet: <#>Afsendelser Slettet: Afsendelser Kommentar XSD Nedenstående felter er kun beskrevet kort, da det er de er defineret på samme måde som i objektet Afsendelse. Se objektet Afsendelse for en mere detaljeret beskrivelse af felterne. AfsendelseSamling, som anvender AfsendelseOversigt. : Skrifttype: Kursiv Bilag G: Webservice 9

10 Hvert element i listen er en sekvens af nedenstående felter R AfsendelseModtager Angiver den slutbruger som skal modtage afsendelsen. R MeddelelseTypeNavn Meddelelse ServiceBesked. Angiver typen af afsendelse. Typen udledes fra indholdstypen. R MeddelelseIndholdstype Identifikator Indholdstypen som meddelelsen vedrører. R MeddelelseTitelTekst Titlen på meddelelsen. R AfsendelseDatoTid Angiver tidspunktet hvor beskeden skal afsendes / er afsendt. R AfsendelseTilstandNavn Afventer Planlagt Fremsendt R MeddelelseTidsfristDato En dato som angiver at der er en tidsfrist forbundet med meddelelsen. R AfsendelseIdReference Identifikation på objektet, der indeholder alle informationer om meddelelsen. R VedhaeftningSamlingKvantitet Antallet af vedhæftninger, som meddelelsen har. Slettet: MeddelelseAfsendel sedatotid Slettet: MeddelelseTidsfrist Slettet: MeddelelseIdRefere nce Slettet: VedhaeftningAntalM aal G Afsendelse Afsendelse OBJEKT Objektet beskriver i detaljer en afsendelse som er afsendt eller planlagt til afsendelse. Selve indholdet og indholdet af eventuelle vedhæftninger er inkluderet ved oprettelse af afsendelsen. Ved læsning af afsendelsen er indholdet ikke inkluderet, men i stedet fremgår en identifikation, således at indholdet efterfølgende kan hentes. R AfsendelseIdReference Identifikation af afsendelsen. Slettet: XSD... [127] Slettet: RessourceIdReferen ce C AfsendelseModtager Angiver den slutbruger som skal modtage afsendelsen. Slutbrugeren er identificeret ved enten CVR- eller CPR-nummer R MeddelelseTypeNavn Meddelelse ServiceBesked. Angiver typen af afsendelse. Typen udledes fra indholdstypen. Bilag G: Webservice 10

11 C MeddelelseIndholdstype Identifikator Angiver indholdstypen som afsendelsen vedrører. Slutbrugeren kan til- og afmelde sig tilmeldingsgrupper som indeholder en eller flere indholdstyper. Hvis slutbrugeren er tilmeldt en tilmeldingsgruppe som indeholder denne indholdstype vil slutbrugeren modtage afsendelsen. Feltet er påkrævet ved oprettelse. Værdien findes via administrationsportalen. C MeddelelseServiceBeskedTekst Såfremt det er en servicebesked der skal afsendes skal beskeden fremgå her. Beskeden kan maksimalt være på 160 karakterer. C MeddelelseTitelTekst Titlen på beskeden der afsendes. Titlen består af en variabel og en fast del. Ved oprettelse af afsendelsen angives den variable tekst. Ved hentning af afsendelsen vises den fulde titel. Udfyldes ikke når meddelelsen er en servicebesked. C MeddelelseIndholdData Indholdet af afsendelsen er indkodet i Base64 formatet. Feltet er kun relevant ved oprettelse af afsendelsen. Når afsendelsen hentes er MeddelelseIndholdsdataURLreference inkluderet i stedet. Udfyldes ikke når meddelelsen er en servicebesked. R MeddelelseIndholdIdReference Reference til indholdet, der skal sendes / er sendt. Ved læse repræsentationen er det hele URI en til indholdet. Feltet er ikke relevant for servicebeskeder. Slettet: MeddelelseIndholds data Slettet: Selve indholdet Slettet: MeddelelseIndholds datareference Slettet: for. Slettet: MeddelelseIndholds data Reference Slettet: Identifikation af selve Udfyldes ikke når meddelelsen er en servicebesked. R FilformatNavn Angiver formatet på meddelelsens indhold. Formatnavnet er endelsen af det filnavn, som blev opgivet da indholdet blev gemt F.eks. pdf, docx, txt, html. Udfyldes ikke når meddelelsen er en servicebesked. R IndholdsdataStoerrelseMaal Størrelsen på indholdet af afsendelsen i kilobytes. Bilag G: Webservice 11

12 C MeddelelseTraadIdentifikator Såfremt afsendelsen er en besvarelse af en henvendelse fra en slutbruger, skal svaret indeholde en reference der kæder svaret sammen med den oprindelige henvendelse. Denne reference kaldes for dialogtråden og id en fremgår af den oprindelige henvendelse. Udfyldes ikke når meddelelsen er en servicebesked. U AfsendelseDatoTid Angiver tidspunktet hvor afsendelsen skal afsendes / er afsendt. I en oprettelsessituation kan feltet være blankt, da afsendes omgående. Tidspunktet kan højest være 5 dage ud i fremtiden. Servicebeskeder afsendes på det angivne minuttal, mens meddelelser afsendes på den angivne dato. Slettet: MeddelelseAfsendel sedatotid U AfsendelseTilstandNavn Afventer Planlagt Fremsendt. Afventer: beskeden er sat / sættes på hold. Planlagt: afsendelse planlagt på det angivne tidspunkt Fremsendt: beskeden er fremsendt. Tilstanden kan ikke angives, det sker automatisk. Når tilstanden er fremsendt kan den ikke ændres eller tilbagekaldes. C VedhaeftningSamling Indeholder information om afsendelsens vedhæftninger, inklusiv selve indholdet eller reference til det. Slettet: Objektet Vedhæftninger, som indeholder Udfyldes ikke når meddelelsen er en servicebesked. Bilag G: Webservice 12

13 C MeddelelseSvarTypeNavn Standard Angivet IkkeMuligt. Angiver hvorvidt besvarelse er muligt samt hvordan svarpostkassen bestemmes. Bemærk at servicebeskeder aldrig kan besvares. Standard: svar er muligt såfremt en svarpostkasse er angivet på indholdstypen via administrationsportalen. Angivet: Svarpostkassen fremgår af feltet MeddelelseSvarPostkasseIdentifikator. IkkeMuligt: slutbrugeren kan ikke besvare afsendelsen. Udfyldes ikke når meddelelsen er en servicebesked. : Ingen punkttegn eller nummerering C C MeddelelseSvarPostkasse Identifikator MeddelelseSvarEmne Identifikator Skal angives når feltet MeddelelseSvarTypeNavn har værdien Angivet. Det skal være en postkasses identifikator, som findes via administrationsportalen. Feltet MeddelelseSvarEmneIdentifikator angiver det emne, der skal svares til. Udfyldes ikke når meddelelsen er en servicebesked. Angiver emnet på postkassen, der skal svares til. Emnet kan kun angives hvis MeddelelseSvarPostkasseIdentifikator er angivet. Udfyldes ikke når meddelelsen er en servicebesked. C MeddelelseFESDmetadata Feltet har kun relevans når afsendelsen har en svarpostkasse (se feltet MeddelelseSvarTypeNavn ) Indholdet af disse metadata vil blive returneret ved besvarelse af afsendelsen og tjener til at knytte svaret til den korrekte sag i et sagsbehandlingssystem. Udfyldes ikke når meddelelsen er en servicebesked. Bilag G: Webservice 13

14 C MeddelelseTidsfrist En dato som angiver at der er en tidsfrist forbundet med meddelelsen. Det er valgfrit at angive en tidsfrist. Udfyldes ikke når meddelelsen er en servicebesked. C MeddelelsesNote Et notat som afsender kan tilknytte til tidsfristen. Det er valgfrit at angive en tekst. Der kan kun angives en tekst, når MeddelelseTidsfristDato er angivet. Slettet: afsendelsen. Eksempelvis til at beskrive Udfyldes ikke når meddelelsen er en servicebesked. Kommentar Slutbrugerens besvarelse af en afsendelse vil altid ske i DKAL portalen (bemærk ikke via privat ). Begrænsninger for servicebeskeder Slettet: <#> Sideskift <#>Vedhæftninger Servicebeskeder, der er korte meddelelser fra myndighed til slutbruger, kan afsendes via REST, S/MIME og masseforsendelse snitfladerne. Da slutbruger skal kunne modtage servicebeskeder som SMS, sætter dette nogle begrænsninger på indholdet af servicebeskeder. Disse begrænsninger gælder for alle tre snitflader. Servicebeskeder kan maksimalt indeholde 160 karakterer. Disse karakterer er begrænset til standard SMS 7-bit karaktersæt, som defineret i GSM standarden for Alphabets and language-specific information 1. G VedhaeftningSamling VedhaeftningSamling OBJEKT Objektet indeholder en liste af informationer om de vedhæftninger der er tilknyttet en afsendelse. Det kan være dokumenter og/eller bilag. Indeholder en liste af objektet Vedhaeftning Slettet: Vedhæftninger Slettet: XSD... [128] Slettet: Vedhæftning G Vedhaeftning Slettet: <#>Vedhæftning Vedhaeftning OBJEKT Objektet indeholder information om en vedhæftning. Ved oprettelse indeholder vedhæftningen selve indholdet indkodet i Base64 format. Ved læsning indeholder den en reference til selve indholdet. tabel Slettet: Vedhæftning Slettet: XSD... [129] 1 Reference: Bilag G: Webservice 14

15 C VedhaeftningNavn Navnet på vedhæftningen. File extension angives i FilformatNavn. C VedhaeftningIndholdData Selve indholdet af vedhæftningen indkodet i Base64 formatet. Feltet er kun relevant ved oprettelse af vedhæftningen. Når afsendelsen hentes er VedhaeftningIndholdIdReference inkluderet i stedet for. C VedhaeftningIndholdIdentifikator Identifikation indholdet af vedhæftningen. R FilformatNavn Angiver formatet på vedhæftningens indhold. Formatnavnet er endelsen af det filnavn, som blev opgivet da filen blev gemt. F.eks. pdf, docx, html, txt. C BilagIdentifikator Hvis filen skal refereres i mange afsendelser, behøves den kun at blive oploadet en gang som et bilag. Efterfølgende kan den refereres via dette felt. Eksempelvis vil vejledninger oftest være et bilag. Bilagsnummeret som skal angives her findes via administrationsportalen ligesom bilaget oploades samme sted. tabel Slettet: VedhaeftningIndhol dsdata Slettet: VedhareftningIndho ldsdatareference Slettet: VedhaeftningIndhol dsdata Reference Slettet: BilagReference R IndholdStoerrelseMaal Størrelsen af filen i kilobytes. G MeddelelseFESDmetadata Slettet: <#> Sideskift <#>FESDmetadata MeddelelseFESDmetadata Kommentar Objektet indeholder FESD-specifikke metadatafelter. OBJEKT Felterne i denne type er en del af den kommende FESD standard, hvorfor deres format endnu ikke er defineret. C FESDdokumentIdentifikator Identificerer et dokument. C FESDaktoerIdentifikator Identificerer aktøren. C FESDsagIdentifikator Identificerer sagen. C FESDsagsklassifikation Identifikator Klassifikation af sagen. Slettet: FESDmetadata Slettet: XSD : Skrifttype: Kursiv Slettet: MeddelelseFESDme tadata Slettet: Kommentar tabel Slettet: Felterne i denne type er en del af den kommende FESD standard, hvorfor deres format endnu ikke er defineret. Slettet: ObjektID Slettet: en sag. Slettet: Objekttype Slettet: sagstypen. : Skriftfarve: Brugerdefineret farve (RGB(88;87;91)) Slettet: Identificerer sagssystemet. Slettet: ObjektIDkilde Bilag G: Webservice 15

16 G TilmeldingSamlingReferenceSamling Slettet: <#>AfsenderMetadat a TilmeldingSamlingReferenceSamling Listen indeholder følgende felt på overordnet niveau R TilmeldingSamlingIdentifikator Indeholder en liste af TilmeldingDelSamlingIdentifikator, der hver refererer til en del af tilmeldingslisten. G TilmeldingSamling TilmeldingSamling Kommentar OBJEKT Objektet indeholder en liste af referencer til tilmeldingslister, der for hver tilmelding angiver en slutbruger og den indholdstype, som slutbrugeren til tilmeldt. Identificerer listen. Relevant for ændringslister hvor en liste skal slettes førend der opnås adgang til den næste ændringsliste. OBJEKT Objektet indeholder en liste af tilmeldinger, der hver angiver en slutbruger og den indholdstype, som slutbrugeren er tilmeldt. Det kan enten være en komplet liste af tilmeldinger eller en liste af ændring af tilmeldinger. Visse indholdstyper er obligatoriske, hvilket betyder at slutbrugere ikke skal være tilmeldt indholdstypen for at kunne modtage dens indhold. Tilmeldingslisten indeholder ikke tilmeldinger for obligatoriske indholdstyper, da det ville være en liste med samtlige DKAL slutbrugere. Hvert element i listen er en sekvens af nedenstående felter R AfsendelseModtager Identificerer modtageren ved enten CVR- eller CPR-nummer. Slettet: AfsenderMetadata : Hold sammen med næste tabel Slettet: metadata Slettet: afsenderen ønsker at inkludere i en afsendelse. Slettet: AfsenderMetadata Slettet: XSD Slettet: Indeholder en liste af elementer, hvor hvert element er en sekvens af disse felter. : Tabulatorer: Ikke med 3,1 cm Slettet: AfsenderMetadataN oeglenavn Slettet: Nøglen Slettet: C : Skrifttype: Ikke Kursiv Slettet: C... [130] : Skriftfarve: Brugerdefineret farve (RGB(88;87;91)) Slettet: <#> Sideskift <#>Tilmeldingsliste : Hold sammen med næste tabel Slettet: Tilmeldingsliste Slettet: XSD... [131] tabel Slettet: Listen indeholder følgende felte på overordnet ninveau... [132] tabel R MeddelelseIndholdstype Identifikator Angiver indholdstypen. R TilmeldingHaendelseDatoTid Hvornår tilmeldingen / afmeldingen fandt sted. R TilmeldingTilmeldtIndikator Angiver om det er en tilmelding / afmelding. Er kun relevant for ændringslister. Ved komplette lister er det kun tilmeldte der fremgår. Bilag G: Webservice 16

17 Operationer Følgende operationer er tilgængelige for enkeltforsendelse. Slettet: Sideskift G Afsend og opdater en afsendelse Afsendersystem.OpretAfsendelse Afsendersystem.OpdaterAfsendelse Send en afsendelse. Afsendelsen afsendes som en samlet enhed, inklusiv information om afsendelsen, indhold og evt. vedhæftninger. tabel Opdater en afsendelse. Afsendelsen afsendes først på det tidspunkt som er angivet i afsendelsen. Så længe afsendelsen ikke er afsendt er det muligt at foretage ændringer i alle felter som er opdaterbare for Afsendelse. Kommentar Serviceaftager skal verificere at slutbrugeren er tilmeldt til at modtage den pågældende indholdstype, før afsendelsen afsendes. Dette kan gøres via tilmeldingslisten, eller ved at spørge online om en specifik slutbruger er tilmeldt en specifik indholdstype. Serviceaftager behøver ikke at verificere om slutbrugeren er tilmeldt såfremt slutbrugeren har initieret kontakten til myndigheden via DKAL. Herved har slutbrugeren accepteret, at myndigheden må besvarer via DKAL. I denne situation er det et krav, at der anvendes samme dialogtråd som blev oplyst ved slutbrugerens henvendelse. Input parametre sysid meddelelsesid Angiver id på afsendersystemet. Fremgår af administrationsportalen. Identifikator for afsendelsen. Afsendersystemet har ansvaret for generering af id en således at den er unik indenfor det pågældende afsendersystem. Input content (OIOXML) Afsendelse Objektet der skal oprettes/opdateres. Som angivet i objektet Afsendelse er det kun afsendelsestidspunktet og tilstanden, der kan opdateres. Bilag G: Webservice 17

18 Fejlkoder 101 Max graense for data overskredet {datamaengde} 121 Ingen adgang til system {sysid} 133 Ugyldig felt i indhold {feltnavn} 141 Ukendt meddelelsesidentifikation {meddelelsesid} 151 Afsendelsen er afsendt G Tilbagekald en afsendelse Afsendersystem.AnnullerAfsendelse Input parametre Tilbagekald en planlagt afsendelse inklusiv indhold og eventuelle vedhæftninger. sysid meddelelsesid Angiver id på afsendersystemet. Fremgår af administrationsportalen. Angiver id på afsendelsen. Det er den id der blev anvendt da afsendelsen blev oprettet. Se forklaring under G Fejlkoder 121 Ingen adgang til system {sysid} 132 Ugyldig soegeparameter {parameter} 141 Ukendt meddelelsesidentifikation {meddelelsesid} 151 Afsendelsen er afsendt G Hent informationer for en specifik afsendelse Afsendersystem.HentAfsendelse Hent informationer for en specifik afsendelse. tabel Eksempler på anvendelse Input parametre Et eksternt system kan via dette kald hente en specifik afsendelse som systemet tidligere har afsendt. Det kan afgøres om den returnerede afsendelser er afsendt. Bilag G: Webservice 18

19 sysid meddelelsesid Angiver id på afsendersystemet. Fremgår af administrationsportalen. Angiver id på afsendelsen. Det er den id der blev anvendt da afsendelsen blev oprettet. Se forklaring under G Output content (OIOXML) Afsendelse Den specifikke afsendelse returneres. Fejlkoder 121 Ingen adgang til system {sysid} 133 Ugyldig system identifikation {sysid} 134 Ugyldig meddelelsesidentifikation {meddelelsesid} 141 Ukendt meddelelsesidentifikation {meddelelsesid} G Hent indholdet af en afsendelse Afsendersystem.HentAfsendelseIndhold Hent indholdet af en afsendelse. Input parametre sysid mid Output content (BINÆRT) Indhold Fejlkoder Angiver id på afsendersystemet. Fremgår af administrationsportalen. Angiver id på afsendelsen. Det er den id der blev anvendt da afsendelsen blev oprettet. Se forklaring under G Selve indholdet af vedhæftningen. Slettet: Indhold 121 Ingen adgang til system {sysid} 141 Ukendt meddelelsesidentifikation {meddelelsesid} Bilag G: Webservice 19

20 Hent indholdet af en vedhæftning Slettet: Sideskift Afsendersystem.HentVedhæftningIndhold Hent indholdet af en vedhæftning. Input parametre sysid mid vid Output content (BINÆRT) Indhold Fejlkoder Angiver id på afsendersystemet. Fremgår af administrationsportalen. Angiver id på afsendelsen. Det er den id der blev anvendt da afsendelsen blev oprettet. Se forklaring under G Angiver id på vedhæftningen. Selve indholdet af vedhæftningen. Slettet: Indhold tabel 121 Ingen adgang til system {sysid} 141 Ukendt meddelelsesidentifikation {meddelelsesid} 142 Ukendt vedhaeftningsidentifikation {vedhaeftningsid} G Søg efter tidligere afsendte / planlagte afsendelser Afsendersystem.FindAfsendelser Operationen giver en afsender adgang til at fremfinde tidligere afsendte og planlagte afsendelser. Et afsendersystem kan kun søge i blandt egne afsendelser. Opera kan kun kaldes med et søgekriterium. Det er således ikke muligt at hente den komplette liste. tabel Eksempler på anvendelse Kommentar Input parametre Et eksternt system kan via dette kald finde tidligere afsendte og planlagte afsendelser for en bestemt borger, virksomhed eller myndighed. Det kan afgøres om en returneret afsendelse er afsendt. Et af søgeparametrene CPR eller CVR skal være udfyldt. Derudover skal et tidsinterval for søgningen angives. sysid Angiver afsendersystemet. Fremgår af administrationsportalen. Bilag G: Webservice 20

21 Input søgeparametre CPR CVR IndholdsType Søg efter specifik borger. Søg efter specifik virksomhed/myndighed. Angiv eventuelt den indholdstype som der søges efter. Det er kun muligt at angive en indholdstype som tilhører afsendersystemet. Er indholdstype ikke angivet omfatter søgningen alle indholdstyper som tilhører afsenderen. StartDato SlutDato Startdato for søgningen. Feltet er påkrævet. Slutdato for søgningen. Feltet er påkrævet. Output content (OIOXML) Afsendelse Samling Fejlkoder Liste med afsendelser der opfylder kriteriet. Slettet: Afsendelser 121 Ingen adgang til system {sysid} 132 Ugyldig soegeparameter {parameter} Forespørg om en slutbruger ønsker en specifik indholdstype Slettet: Sideskift Afsendersystem.ErTilmeldt Denne operation gør serviceaftager i stand til at afgøre hvorvidt en slutbruger vil modtage en afsendelse af en specifik indholdstype. Operationen skal kaldes forud for en afsendelse. Dette kan også afgøres via tilmeldingslisten (se G.2.3.8). Obligatoriske tilmeldinger Såfremt indholdstypen er obligatorisk, skal slutbrugeren ikke være tilmeldt indholdstypen for at kunne modtage afsendelsen. I denne situation er det nødvendigt via denne operation at undersøge: Ved afsendelse af servicebeskeder: Slutbrugeren er tilmeldt til at modtage servicebeskeder. Ved afsendelse af meddelelser: Slutbrugeren har accepteret DKAL samtykke. Bilag G: Webservice 21

22 Ikke relevant ved besvarelser Kommentar Serviceaftager behøver ikke at verificere om slutbrugeren er tilmeldt såfremt slutbrugeren har initieret kontakten til myndigheden via DKAL. Herved har slutbrugeren accepteret, at myndigheden må besvarer via DKAL. I denne situation er det et krav, at der anvendes samme dialogtråd som blev oplyst ved slutbrugerens henvendelse. Et af søgeparametrene CPR eller CVR skal være udfyldt. Input parametre sysid indholdstypeid Angiver id på afsendersystemet. Fremgår af administrationsportalen. Angiver den indholdstype der efterspørges. Feltet skal angives. Værdien findes via administrationsportalen. Input søgeparametre CVR Angiver slutbrugeren såfremt det er en virksomhed/myndighed. CPR Output content (OIOXML) XSD R Tilmelding TilmeldtIndikator SlutbrugerTilmeldingStatus Angiver slutbrugeren såfremt det er en borger. uden bindestreg. Angiver om slutbrugeren vil modtage en forsendelse med den angivne indholdstype. Er den forespurgte indholdstype obligatorisk vil det altid fremgå at slutbrugeren er tilmeldt uanset om vedkommende har en tilmelding. : Hold sammen med næste Slettet: AfsendersystemTil meldingsvar : Skrifttype: Kursiv Slettet: Indikator Slettet: Tilmeldt R SlutbrugerDKAL statuskode Angiver modtagerens DKAL status: 0: Slutbruger er ikke tilmeldt DKAL. 1: Kun tilmeldt servicebeskeder 2: Har accepteret DKAL vilkår. En slutbruger har kun en sikker boks, når DKAL vilkår er accepteret. Slettet: DKALstatusKode R SlutbrugerEboks StatusIndikator Angiver modtagerens e-boks status: Tilmeldt eller ej. Slettet: eboksstatus Indikator Vil kun være udfyldt hvis slutbrugeren er tilmeldt indholdstype. Bilag G: Webservice 22

23 Fejlkoder tabel 121 Ingen adgang til system {sysid} 132 Ugyldig soegeparameter {parameter} 143 Ukendt indholdstype {indholdstypeid} G Hent reference til bestilt tilmeldingsliste Slettet: en Slettet: per indholdstype Afsendersystem.HentTilmeldingslisteReference Ændringslister Kompletliste Kommentar Hent reference til en bestilt tilmeldingsliste indeholdende en liste af tilmeldinger. Pga. størrelse kan en tilmeldingsliste være delt i flere dele, så der bliver også hentet en liste en referencer til hver del af listen. Såfremt afsendersystemet ønsker ændringslister produceres en ændringsliste. Ændringerne hentes efter behov fra en kø. Den ældste ændringsliste returneres altid via dette kald. Når denne liste er modtaget og behandlet skal det bekræftes ved at slette den. Herefter skal denne operation kaldes igen. Denne proces fortsætter indtil der intet returneres via dette kald. Såfremt registeret ønsker komplette lister produceres en komplet liste. Er komplet liste bliver fjernet når en ny liste er blevet produceret. Er et register i gang med at hente de enkelte dele af en liste, når den bliver fjernet, skal registeret hente referencen til den nye komplette liste, og hente delene i denne liste. Tilmeldingerne, som er angivet i tilmeldingslisten, er gyldige i 5 dage. Slettet: HentTilmeldingsliste tabel Slettet: Tilmeldingslister produceres ikke online. De produceres med et interval der er aftalt i forbindelse med tilslutningen. De indeholder alle de slutbrugere der er tilmeldt indholdstyper der vedrører det pågældende afsendersystem. I forbindelse opsætningen af afsendersystemet skal det angives om der ønskes ændringslister eller komplette tilmeldingslister, hvilket ikke kan ændres efterfølgende. tabel Tilmeldingslisten vil ikke indeholde tilmeldinger for obligatoriske indholdstyper. Input parametre sysid Output content (OIOXML) Tilmelding Samling Reference Samling Fejlkoder Angiver id på afsendersystemet. Fremgår af administrationsportalen. Den bestilte tilmeldingsliste, enten en komplet liste eller en ændringsliste afhængig af opsætningen af systemet. tabel : Hold sammen med næste tabel : Skrifttype: Kursiv Slettet: Tilmeldingsliste 121 Ingen adgang til system {sysid} Bilag G: Webservice 23

24 G Hent en bestilt tilmeldingsliste per indholdstype Slettet: <#> Sideskift <#>Slet en ændringsliste Afsendersystem.HentTilmeldingslisteDelliste Hent en del af en tilmeldingsliste, der indeholder en liste af slutbrugers tilmelding til indholdstype. Slettet: SletTilmeldingsliste tabel Input parametre sysid tilmeldingslisteid dellisteid Angiver id på afsendersystemet. Fremgår af administrationsportalen. Identificerer tilmeldingslisten. Identificerer dellisten af tilmeldingslisten. Output content (OIOXML) Tilmelding Samling Den bestilte tilmeldingsliste, enten en komplet liste eller en ændringsliste afhængig af opsætningen af systemet. Fejlkoder 121 Ingen adgang til system {sysid} G Slet en ændringsliste Afsendersystem.SletTilmeldingsliste Slet den angivne tilmeldingsliste. Husk at hente og behandle listen forud. tabel Input Parametre sysid tilmeldingslisteid Fejlkoder Angiver id på afsendersystemet. Fremgår af administrationsportalen. Identificerer en specifik ændringsliste. Denne id er angivet i den specifikke ændringsliste, som ønskes slettet. Slettet: Slettet: id 121 Ingen adgang til system {sysid} 145 Ukendt identifikation {tilmeldingslisteid} Slettet: id} Bilag G: Webservice 24

25 G.3 Register Dette funktionsområde gør det muligt for et register / fagsystem at hente stamdata og tilmeldinger på tilmeldingsgruppe- og myndighedsniveau for slutbrugere. Et register kan opdatere stamdata og tilmeldinger, samt oprette nye slutbrugere. En oversigt over samtlige operationer er vist nedenfor. Register.HentSlutbrugerlisteReference Hent reference til slutbrugerliste og referencer til de enkelte dellister, som slutbrugerlisten kan være delt i. Slettet: HentSlutbrugerlis te : Skrifttype: Fed Register.HentSlutbrugerlisteDelliste Hent del af en slutbrugerliste. For hver slutbruger fremgår stamdata, tilmeldinger på tilmeldingsgruppeniveau, og tilmelding på myndighedsniveau. Bemærk at opsætningen af registret har stor indflydelse på den liste der returneres. Register.SletSlutbrugerliste Operationen anvendes til at bekræfte at en ændringsliste er færdigbehandlet. Hermed bliver den næste ændringsliste, såfremt der er en, tilgængelig. Register.HentSlutbruger Operationen henter oplysning om en slutbrugers stamdata og tilmeldinger. Stamdata inkluderer bl.a. slutbrugerens navn, mobilnummer, adresse, og status. Det fulde mobilnummer er kun vist såfremt denne ydelse er tilkøbt. adressen er kun delvist angivet. Tilmeldingerne angiver hvilke tilmeldingsgrupper, som slutbrugeren er tilmeldt. Det fremgår ligeledes om slutbrugeren har tilmeldt sig alt for den pågældende myndighed samt om vedkommende har tilmeldt sig alle myndigheder. Register.OpretSlutbruger Register.OpdaterSlutbruger Operationen opretter en ny boks og/eller foretager online opdatering af stamdata for en eksisterende slutbruger. Registret kan angive om slutbrugeren ønsker servicebeskeder eller både ønsker servicebeskeder samt meddelelser. Ved oprettelse af en ny slutbruger, som ønsker at modtage meddelelser, er det kun en foreløbig oprettelse, som slutbrugeren selv skal logge ind og bekræfte. Register.OpdaterMyndighedstilmelding Operationen opdaterer status for slutbrugerens tilmelding på myndighedsniveau. Herved kan en slutbruger til- og afmelde sig 1) den myndighed registret er tilknyttet eller 2) alle myndigheder. Herved bliver slutbrugeren samtidig automatisk tilmeldt nye tilmeldingsgrupper henholdsvis myndigheder når de oprettes. Slettet: sig1) Register.TilmeldSlutbruger Operationen gør det muligt at tilmelde en slutbruger til en tilmeldingsgruppe. Hvis tilmeldingen inkluderer modtagelse af meddelelser som ikke er servicebeskeder, er det kun en foreløbig tilmelding, som slutbrugeren selv skal logge ind og bekræfte. Hvis en tilmelding kun vedrører modtagelse af servicebeskeder, træder den omgående i kraft. Register.AfmeldSlutbruger - Slet en tilmelding for en slutbruger. G Konfiguration af et register Via administrationsportalen opsættes: Bilag G: Webservice 25

26 Registrets tilknytning til et afsendersystem eller hele myndigheden. Dette har betydning for hvilke slutbrugere der returneres i tilmeldingslister. Komplette lister eller ændringslister ønskes. Dette har betydning for de tilmeldingslister der produceres. Objekter Følgende objekter anvendes i forbindelse med registre. : Skrifttype: Verdana, 10 pkt, Ikke Fed, Skriftfarve: Brugerdefineret farve (RGB(88;87;91)), Dansk Slettet: Sideskift SlutbrugerSamlingReferenceSamling SlutbrugerSamling Slutbruger Stamdata G SlutbrugerStamdata GruppetilmeldingSamling Myndighedstilmelding Slettet: Slutbrugere Gruppetilmelding SlutbrugerSamlingReferenceSamling - Indeholder en reference til en slutbrugerliste. Dette kan enten være en komplet liste eller en ændringsliste. En slutbrugerliste kan pga. størrelse være delt i et antal dellister; ressourcen inkluderer således en samling af referencer til hver delliste. SlutbrugerSamling - Indeholder en liste af objektet Slutbruger som indeholder stamdata og tilmeldinger. Slutbruger - Beskriver en slutbrugers stamdata samt tilmeldinger. Tilmeldingerne fremgår både for den specifikke myndighed på myndighedsniveau og tilmeldingsgruppe-niveau, SlutbrugerStamdata - Indeholder stamdata for en slutbruger, hvilket bl.a. inkluderer CPR-/CVR-nummer, navn, mobilnummer, adresse, og DKAL status. Objektet indgår i Slutbruger. Slettet: Stamdata Myndighedstilmelding - Beskriver en slutbrugers tilmelding på myndighedsniveau til 1) en specifik myndighed, eller 2) alle myndigheder. Af tilmeldingen fremgår bl.a. hvorvidt adviseringer ønskes via SMS og/eller samt hvorvidt brugeren automatisk ønsker at tilmelde sig nye myndigheder / tilmeldingsgrupper. GruppetilmeldingSamling - Indeholder en liste af tilmeldinger på tilmeldingsgruppe-niveau. Slettet: Gruppetilmelding er Bilag G: Webservice 26

27 Gruppetilmelding - Beskriver en tilmelding på tilmeldingsgruppe-niveau. Af tilmeldingen fremgår bl.a. hvorvidt adviseringer ønskes via SMS og/eller . G SlutbrugerSamlingReferenceSamling Slettet: <#>Slutbrugere SlutbrugerSamlingReferenceSamling OBJEKT Ressourcen indeholder en liste af referencer til slutbrugerlister med stamdata og tilmeldinger for hver slutbruger. Tilmeldingerne er angivet på myndigheds- og tilmeldingsgruppeniveau. Listen indeholder følgende felt på overordnet niveau R SlutbrugerSamlingIdentifikator Identificerer listen. Relevant for ændringslister hvor en liste skal slettes førend der opnås adgang til den næste ændringsliste. Indeholder en liste af SlutbrugerDelSamlingIdentifikator, der hver refererer til en del af slutbrugerlisten. Slettet: Slutbrugere Sideskift : Hold sammen med næste Slettet: Objektet Slettet: slutbrugere Slettet: Det kan enten være en komplet liste af tilmeldinger eller en liste af ændring af tilmeldinger. Slettet: XSD... [133] Slettet: ninveau Slettet: RessourceIdReferen ce Slettet: objektet Slutbruger. G SlutbrugerSamling SlutbrugerSamling OBJEKT Objektet indeholder en liste af slutbrugere med stamdata og tilmeldinger for hver slutbruger. Tilmeldingerne er angivet på myndigheds- og tilmeldingsgruppeniveau. Det kan enten være en komplet liste af tilmeldinger eller en liste af ændring af tilmeldinger. Indeholder en liste af objektet Slutbruger. G Slutbruger Slutbruger OBJEKT Objektet indeholder information om en slutbrugers stamdata og tilmeldinger. Tilmeldingerne er opdelt i myndigheds-tilmelding og tilmeldingsgruppe-tilmelding. Specielt for ændringslist er Når dette objekt indgår i objektet Slutbrugere og der er tale om en ændringsliste, medtages kun de informationer, der er blevet ændret. Her vil typerne Stamdata, Myndighedstilmelding og Gruppetilmeldinger kun være angivet såfremt en ændring har fundet sted. Er en slutbrugers mobilnummer f.eks. blevet opdateret vil typen Stamdata være angivet. Slettet: XSD... [134] Bilag G: Webservice 27

28 Hvert element i listen er en sekvens af nedenstående C SlutbrugerIdentitet CPR / CVR nummer på slutbrugeren. R SlutbrugerStamdata Informationer om slutbrugeren, bl.a. navn, mobilnummer og adresse. R Myndighedstilmelding Tilmeldinger for en slutbruger på myndighedsniveau. R GruppetilmeldingSamling Liste af tilmeldinger for en slutbruger på tilmeldingsgruppeniveau. Slettet: Stamdata Slettet: Gruppetilmeldinger Er en slutbruger tilmeldt på myndighedsniveau, slår det igennem på tilmeldingsgruppeniveau, således at brugeren optræder som værende tilmeldt alle myndighedens grupper. G Myndighedstilmelding Myndighedstilmelding OBJEKT Objektet beskriver en slutbrugers tilmelding til 1) den myndighed som registret tilhører, eller 2) alle myndigheder. En bruger som tilmelder sig en myndighed vil optræde som være tilmeldt alle myndighedens tilmeldingsgrupper. En slutbruger som er tilmeldt alle myndigheder vil optræde som være tilmeldt alle myndigheder og deres tilmeldingsgrupper. Slettet: XSD... [135] R MyndighedIdentifikator Angiver CVR-nummeret på myndigheden, som denne tilmelding vedrører. U MyndighedTilmeldtIndikator ja nej. Er brugeren tilmeldt den pågældende myndighed. Slettet: TilmeldtMyndighedI ndikator U AlleMyndighederTilmeldt Indikator ja nej. Er brugeren tilmeldt alle myndigheder. Er denne ja, sættes MyndighedTilmeldtIndikator automatisk til ja. Det er uafklaret hvorvidt denne facilitet stilles til rådighed i den endelige udgave. Slettet: TilmeldtMyndighedA lleindikator Slettet: TilmeldtMyndighedI ndikator U AdviseringSMSindikator ja nej. Adviser brugeren via SMS når nye servicebeskeder / meddelelser ankommer til DKAL. Er feltet ikke angivet, anvendes slutbrugerens standardopsætning. Bilag G: Webservice 28

29 U Advisering Indikator ja nej. Adviser brugeren via når nye servicebeskeder / meddelelser ankommer til DKAL. Er feltet ikke angivet, anvendes slutbrugerens standardopsætning. G GruppetilmeldingSamling GruppetilmeldingSamling Objektet beskriver samling af tilmeldingsgrupper. Indeholder en liste af objektet Gruppetilmelding. OBJEKT Slettet: U... [136] G Gruppetilmelding OBJEKT Gruppetilmelding Objektet beskriver en slutbrugers tilmelding til en tilmeldingsgruppe. I nogle situationer ønskes en liste indeholdende både de tilmeldingsgrupper som brugeren er tilmeldt samt de tilmeldingsgrupper som brugeren kan tilmelde sig for en specifik myndighed. Dette objekt anvendes til at beskrive begge dele, idet feltet TilmeldingsgruppeTilmeldtIndikator angiver den aktuelle status for tilmeldingsgruppen. R GruppetilmeldingIdentifikator Identifikation af objektet. Slettet: XSD... [137] Slettet: RessourceIdReferen ce R TilmeldingsgruppeNavn Navnet på tilmeldingsgruppen. U AdviseringSMSindikator ja nej. Adviser brugeren via SMS når nye meddelelser (heriblandt servicebeskeder) ankommer til DKAL. Slettet: Default nej. Er feltet ikke angivet, anvendes slutbrugerens standardopsætning. U Advisering Indikator ja nej. Adviser brugeren via når nye meddelelser (heriblandt servicebeskeder) ankommer til DKAL. Slettet: Default ja. Er feltet ikke angivet, anvendes slutbrugerens standardopsætning. Bilag G: Webservice 29

30 R TilmeldingsgruppeTilmeldt Indikator Angiver om slutbrugeren er tilmeldt denne tilmeldingsgruppe. Anvendes når en liste af tilmeldinger også indeholder tilmeldingsgrupper, som brugeren har mulighed for at tilmelde sig. G SlutbrugerStamdata Slettet: <#>Stamdata SlutbrugerStamdata Objektet indeholder stamdata for en slutbruger. OBJEKT Slettet: Stamdata Slettet: XSD... [138] Hvert element i listen er en sekvens af nedenstående felter Slettet: R... [139] R SlutbrugerIdentitet CPR / CVR nummer på slutbrugeren. C SlutbrugerNavn Slutbrugerens navn som angivet ved oprettelsen. U MobilNummerVerificerbar Slutbrugerens mobiltelefonnummer. Hele nummeret vil ikke være læsbart, med mindre fuld visning er tilkøbt. Et eksempel på et sløret nummer er ****. Når nummeret opdateres, vil slutbrugeren automatisk blive bedt om at verificere dette. Det er angivet om nummeret er blevet verificeret eller ej. U EpostAdresseFoerste Angiver brugerens private adresse som der sendes adviseringer til i det omfang brugeren ønsker. Slettet: Slettet: AdresseFoerst e Når adressen opdateres, vil slutbrugerne automatisk blive bedt om at verificere den. Det er angivet om adresse er blevet verificeret eller ej. adressen er kun delvist angivet, f.eks. som anders@*****, og anvendes som et hint til slutbrugeren, der kan genkende sin adresse. Den fulde adresse er således aldrig tilgængelig for et register. U EpostAdresseAnden Som første adresse. Slettet: AdresseAnden Bilag G: Webservice 30

31 U SlutbrugerDKALstatusKode Angiver modtagerens DKAL status: 0: Ikke tilmeldt 1: Kun tilmeldt som servicebeskedmodtager. 2: Har accepteret DKAL vilkår. En slutbruger har kun en sikker boks, når DKAL vilkår er accepteret. Ved oprettelse af en slutbruger anvendes dette felt til at angive om hvilken type oprettelse slutbrugeren ønsker. Ønsker slutbrugeren at kunne modtage meddelelser udover servicebeskeder, vil dette kun være en foreløbig oprettelse. Slutbrugeren skal efterfølgende selv logge ind og bekræfte. R SlutbrugerEboksStatusKode Angiver modtagerens e-boks status: 0: Ikke tilmeldt. 1: Tilmeldt. R SlutbrugerRegistreringDatoTid Angiver tidspunktet for oprettelse af slutbrugeren. Operationer Følgende operationer er tilgængelige for registre. G.3.4 Register.HentSlutbrugerlisteDelliste Ændringslister Kompletliste Konfiguration Input parametre Hent reference til slutbrugerliste Hent reference til en bestilt slutbrugerliste indeholdende en liste af slutbrugere. Pga. størrelse kan en slutbrugerliste være delt i flere dele, så der bliver også hentet en liste en referencer til hver del af listen. Såfremt registret ønsker ændringslister produceres en ændringsliste. Ændringerne hentes efter behov fra en kø med et aftalt interval. Den ældste ændringsliste returneres altid via dette kald. Når denne liste er modtaget og behandlet skal det bekræftes ved at slette den. Herefter skal denne operation kaldes igen. Denne proces fortsætter indtil der alle tilgængelige ændringslister er behandlet. Såfremt registeret ønsker komplette lister produceres en komplet liste. Er komplet liste bliver fjernet når en ny liste er blevet produceret. Er et register i gang med at hente de enkelte dele af en liste, når den bliver fjernet, skal registeret hente referencen til den nye komplette liste, og hente delene i denne liste. Se afsnit (se G.3.1.1) Slettet: DKALstatus Slettet: eboksstatus Slettet: eller ej Slettet: Sideskift : Overskrift 2;H2;h 2;2;headi;heading2;h21;h22;2 1;Heading Two;DFL 12 fed og indrykket 3 cm;attribute Heading 2;(Alt+2);L2;dd heading 2;dh2;RFP Heading 2;sub-sect;sl2;Überschrift 2 Anhang;Überschrift 2 Anhang1;Überschrift 2 Anhang2;Titre2;R2;PLS 2 Slettet: HentSlutbrugerliste Slettet: For Slettet: slutbruger er angivet stamdata, tilmeldinger på tilmeldingsgruppeniveau, og tilmelding på myndighedsniveau Slettet: Registrets tilknytning Slettet: Et register er enten tilknyttet et afsendersystem eller hele myndigheden hvilket har indflydelse på hvilke slutbrugere der medtages i den returnerede liste. Såfremt registret er tilknyttet et afsendersystem er det kun slutbrugere som er tilmeldt tilmeldingsgrupper for dette afsendersystem der medtages i resultatet. Slettet: Ændringslister Slettet: Såfremt registret ønsker ændringslister produceres en ændringsliste. Ændringerne hentes efter behov fra en kø med et aftalt interval. Den ældste ændringsliste returneres altid via dette kald. Når denne liste er modtaget og behandlet skal det bekræftes ved at slette den. Herefter skal denne operation kaldes igen. Denne proces fortsætter indtil der intet returneres via dette kald. Bilag G: Webservice 31

32 sysid Identificerer registret. Fremgår af administrationsportalen. Output content (OIOXML) Slutbruger Samling Reference Samling Reference til en slutbrugerliste og den dellister. Fejlkoder 121 Ingen adgang til system {sysid} G Hent slutbruger delliste Register.HentSlutbrugerlisteDelliste Input parametre Hent en del af en bestilt slutbrugerliste indeholdende en liste af slutbrugere. For hver slutbruger er angivet stamdata, tilmeldinger på tilmeldingsgruppeniveau, og tilmelding på myndighedsniveau. : Hold sammen med næste sysid slutbrugerlisteid dellisteid Identificerer registret. Fremgår af administrationsportalen. Identificerer slutbrugerlisten. Identificerer delliste, der er en del af en slutbrugerliste. Output content (OIOXML) Slutbruger Samling Fejlkoder En liste med slutbrugere. Slettet: Slutbrugerliste 121 Ingen adgang til system {sysid} Bilag G: Webservice 32

33 G Slet ændringsliste Register.SletSlutbrugerliste Såfremt et register anvender ændringslister, skal en ændringsliste slettes førend den næste kan hentes. tabel Slutbrugerlisten slettes således som en helhed, og det er ikke hver enkelt delliste, der slettes. Input Parametre sysid slutbrugerlisteid Fejlkoder Identificerer registret. Fremgår af administrationsportalen. Identificerer en specifik ændringsliste. Denne id er angivet i den specifikke ændringsliste, som ønskes slettet. Slettet: id 121 Ingen adgang til system {sysid} 145 Ukendt identifikation {id} G Hent en slutbrugers stamdata og tilmeldinger Register.HentSlutbruger Returnerer en slutbrugers stamdata og tilmeldinger. Stamdata inkludere bl.a. slutbrugerens navn, mobilnummer, adresse, og status. Tilmeldingerne inkluderer: de tilmeldingsgrupper, som slutbrugeren er tilmeldt for det aktuelle register, samt oplysning om slutbrugeren har tilmeldt sig 1) alt for den myndighed registret er tilknyttet eller 2) har tilmeldt sig alt for alle myndigheder. Kommentar En af søgeparametrene CPR eller CVR skal være udfyldt. Input parametre sysid cpr Identificerer registret. Fremgår af administrationsportalen. Angiver slutbrugeren, når det er en borger. Bilag G: Webservice 33

34 cvr Angiver slutbrugeren, når det er en virksomhed/myndighed. Input søgeparametre IkkeTilmeldte Indikator Hvis angivet inkluderes også de tilmeldingsgrupper, som slutbrugeren ikke er tilmeldt for myndigheden som registret er tilknyttet. For hver tilmeldingsgruppe vil det fremgå om slutbrugeren er tilmeldt eller ej. Output content (OIOXML) Slutbruger Information om slutbrugeren. Fejlkoder 121 Ingen adgang til system {sysid} 132 Ugyldig soegeparameter {parameter} 146 Ukendt slutbruger G Opret boks / opdater stamdata Register.OpretSlutbruger Register.OpdaterSlutbruger Opret boks for den angivne slutbruger, eller opdater en eksisterende slutbrugers stamdata. tabel Input parametre Når en slutbruger oprettes skal det angives via slutbrugerens stamdata, om vedkommende ønsker at modtage servicebeskeder, eller om det også ønskes at modtage andre meddelelser. En servicebeskedmodtager kan oprettes omgående, hvorimod de resterende meddelelser (personfølsomme) kræver at brugeren efterfølgende logger ind og acceptere vilkårene førend vedkommende kan modtage afsendelser. sysid cpr cvr Identificerer registret. Fremgår af administrationsportalen. Angiver slutbrugeren, når det er en borger. Angiver slutbrugeren, når det er en virksomhed/myndighed. Bilag G: Webservice 34

35 Slutbruger Stamdata Fejlkoder Slutbrugerens stamdata. : Skrifttype: Kursiv 101 Max graense for data overskredet {datamaengde} 121 Ingen adgang til system {sysid} 133 Ugyldig felt i indhold {feltnavn} 146 Ukendt slutbruger G Til / afmeld en slutbruger til en myndighed / alle myndigheder Register.OpdaterMyndighedstilmelding Til- og afmeld slutbrugeren på myndighedsniveau. Via dette kald kan en slutbruger til- og afmeldes : Hold sammen med næste tabel 1) Den myndighed som registret er tilknyttet. En tilmelding her angiver at slutbrugeren er tilmeldt alle tilmeldingsgrupper for denne myndighed samt automatisk tilmeldes nye tilmeldingsgrupper når disse oprettes. Eller 2) Alle myndigheder. En tilmelding til alle myndigheder betyder at slutbrugeren er tilmeldt alle myndigheder samt automatisk tilmeldes nye myndigheder når disse oprettes. Myndigheden som tilmeldingen vedrører Den specifikke myndighed der kan til- og afmeldes er den som registeret er tilknyttet. Det vil sige den myndighed, der har oprettet registeret i administrationsportalen. Input parametre sysid cpr cvr Identificerer registret. Fremgår af administrationsportalen. Angiver slutbrugeren, når det er en borger. Angiver slutbrugeren, når det er en virksomhed/myndighed. Input Content (OIOXML) Myndigheds tilmelding Indeholder den nye tilmelding / opdatering af en eksisterende. Bilag G: Webservice 35

36 Fejlkoder 101 Max graense for data overskredet {datamaengde} 121 Ingen adgang til system {sysid} 133 Ugyldig felt i indhold {feltnavn} 146 Ukendt slutbruger G Tilmeld en slutbruger til en tilmeldingsgruppe Register.TilmeldSlutbruger Opret en ny tilmelding af en slutbruger til en tilmeldingsgruppe, eller opdater en eksisterende tilmelding. Afhængig af registrets tilknytning til et afsendersystem / hele myndigheden afgrænses hvilke tilmeldingsgrupper der kan tilmeldes. Konfiguration Se afsnit (se G.3.1.1) Input parametre sysid cpr cvr tid Identificerer registret. Fremgår af administrationsportalen. Angiver slutbrugeren, når det er en borger. Angiver slutbrugeren, når det er en virksomhed/myndighed. Identifikation af tilmeldingsgruppen. Kan findes via administrationsportalen, eller via en forespørgsel på en slutbrugers tilmeldinger hvor IkkeTilmeldte tilmeldingsgrupper medtages. Input content (OIOXML) Gruppetilmelding Indeholder den nye tilmelding, eller opdatering af en eksisterende. Bilag G: Webservice 36

37 Fejlkoder 101 Max graense for data overskredet {datamaengde} 121 Ingen adgang til system {sysid} 133 Ugyldig felt i indhold {feltnavn} 144 Ukendt tilmeldingsgruppe {tilmeldingsgruppeid} 146 Ukendt slutbruger G Slet en tilmelding for en slutbruger Register.AfmeldSlutbruger Afmeld en slutbruger fra en specifik tilmeldingsgruppe. Input parametre sysid cpr cvr tid Identificerer registret. Fremgår af administrationsportalen. Angiver slutbrugeren, når det er en borger. Angiver slutbrugeren, når det er en virksomhed/myndighed. Identificerer tilmeldingsgruppen Fejlkoder 121 Ingen adgang til system {sysid} 143 Ukendt indholdstype {indholdstypeid} 144 Ukendt tilmeldingsgruppe {tilmeldingsgruppeid} 146 Ukendt slutbruger Bilag G: Webservice 37

38 G.4 Afhentningssystem Dette funktionsområde giver: 1. En myndighed/virksomhed adgang til via et eksternt system løbende at hente og slette meddelelser fra virksomheds/myndigheds sikre boks. 2. En myndighed adgang til via et eksternt system løbende at hente og slette meddelelser der er ankommet via en eller flere postkasser som er opsat til at blive tømt via dette afhentningssystem. For begge operationer gælder: først hentes en liste af meddelelser, derefter hentes de en ad gangen og slettes. Afhængig af hvordan systemet er konfigureret via administrationsportalen vil meddelelsen eventuelt blive arkiveret. Slettet: adgang til : Skrifttype: Kursiv Slettet: Først : Skrifttype: Kursiv Slettet: som efterfølgende kan hentes og Slettet: slettes G Hente meddelelser fra indbakke i sikker boks Afhentningssystem.HentMeddelelsesliste Operationen søger efter de ældste meddelelser i slutbrugerens indbakke. Som søgekriterium kan angives antallet af meddelelser der ønskes returneret. Resultatet er en liste af meddelelser, der blot indeholder en reference til meddelelsen. Referencerne kan efterfølgende anvendes til at hente meddelelserne. Afhentningssystem.HentMeddelelse Operationen henter en meddelelse fra indbakken. Meddelelsen indeholder informationer om meddelelser, indholdet, samt evt. vedhæftninger og deres indhold. Afhentningssystem.SletMeddelelse Operationen sletter en meddelelse fra indbakken. Afhentningssystem.ArkiverMeddelelse Operationen arkiverer meddelelse, således at den flyttes fra indbakken til angivne arkivmappe. Slettet: det Slettet: selve Slettet: selve Slettet: selve Slettet: Når den ældste : Skrifttype: Kursiv Slettet: i G Hente meddelelser fra postkasse(r) Afhentningssystem.HentPostkasseMeddelelsesliste Operationen søger efter de ældste meddelelser som endnu ikke er hentet i den eller de postkasser som er tilknyttet dette afhentningssystem. Som søgekriterium kan angives antallet af meddelelser der ønskes returneret. Resultatet er en liste af meddelelser, der blot indeholder en reference til meddelelsen. Referencerne kan efterfølgende anvendes til at hente meddelelserne. Afhentningssystem.HentPostkasseMeddelelse Operationen henter en meddelelse fra postkassen. Meddelelsen indeholder informationer om meddelelser, indholdet, samt evt. vedhæftninger og deres indhold. Afhentningssystem.SletPostkasseMeddelelse Operationen sletter en meddelelse fra postkassen. Under opsætningen af systemet i administrationsportalen, kan det angives hvorvidt der skal gemmes en kopi af meddelelsen. Det er således muligt at arkivere meddelelser, i forbindelse med at de hentes fra postkassen. Slettet: slettet, bliver Slettet: næste : Skrifttype: Kursiv Slettet: tilgængelig for afhentning. Slettet: bevare et arkiv af Slettet: selv om Slettet: slettes Slettet: indbakken Bilag G: Webservice 38

39 G.4.2 Objekter Følgende objekter anvendes i forbindelse med et afhentningssystem. MeddelelseReferenceSamling Meddelelse FESDmetadata MeddelelseFESDmetadata VedhaeftningSamling PostkasseMetadata Signaturbevis Slettet: Meddelelser Vedhaeftning AfsenderMetadata MeddelelseReferenceSamling Indeholder en samling af referencer til meddelelser. Slettet: liste Meddelelse Indeholder information om en meddelelse, heriblandt afsender, titel, modtagelsestidspunkt, selve det binære indhold samt evt. vedhæftninger og deres indhold. Signaturbevis Indeholder information om det certifikat der blev anvendt af slutbrugeren ved afsendelsen. Er kun relevant for myndigheder, der modtager meddelelser fra slutbrugere. Slettet: Vedhæftninger VedhaeftningSamling Beskriver en liste af vedhæftninger Vedhaeftning Beskriver en vedhæftning, heriblandt titel, format, samt en reference til det binære indholdet. MeddelelseFESDmetadata Indeholder FESD metadata, der anvendes af myndigheden til at automatisere routningen af meddelelsen. Objektet er inkluderet i Meddelelse. Slettet: Vedhæftning Slettet: FESDmetadata PostkasseMetadata Indeholder de metadata som slutbrugeren eventuelt har udfyldt i forbindelse med henvendelsen. Disse metadata er defineret på postkassen via administrationsportalen. AfsenderMetadata Indeholder metadata, som afsenderen ønsker at inkludere. Disse metadata vil kun være tilgængelig når meddelelsen er et svar på en afsendelse fra myndigheden, hvor disse metadata var tilføjet til afsendelsen. AfsenderMetadata bliver håndteret som en vedhæftning til meddelelsen, som har det reserverede navn dkalafsendermetadata.xml. Bilag G: Webservice 39

40 G MeddelelseReferenceSamling Slettet: <#>Meddelelser MeddelelseReferenceSamling Objektet indeholder en liste af referencer til meddelelser. OBJEKT Slettet: Meddelelser Slettet: XSD... [140] Indeholder en liste af objektet MeddelelseURLreference, der hver indeholder en reference til selve Meddelelsen. Slettet: Meddelelse. Det eneste felt inkluderet i denne anvendelse af Meddelelse er G Meddelelse Meddelelse Objektet indeholder informationer om en meddelelse heriblandt dokumenter og servicebeskeder. R MeddelelseIdentifikator Identifikation af meddelelsen. OBJEKT R MeddelelseTypeNavn Meddelelse ServiceBesked. Angiver hvilken variant denne meddelelse er. R AfsenderNavn Afsenderens navn. Er kun angivet når afsenderen er en myndighed. R Signaturbevis Informationer om det certifikat der blev anvendt af afsenderen. Er kun angivet når afsenderen er en slutbruger og modtageren er en myndighed. R MeddelelseServicebeskedTekst Såfremt meddelelsen er en servicebesked fremgår selve beskeden her. R MeddelelseTitelTekst Titlen på beskeden / Navnet på dokumentet når brugeren har oploadet en fil. En beskrivelse af indholdstypen foranstilles automatisk. R MeddelelseIndholdData Selve det binære indhold af meddelelsen indkodet i Base64 formatet. Slettet: XSD : Skrifttype: Kursiv Slettet: Meddelelse tabel Slettet: MeddelelseIdRefere nce Slettet: Identifikation af meddelelsen. Slettet: MeddelelseTypeNav n : Tabulatorer: 3,1 cm, Venstre Slettet: Meddelelse ServiceBesked. Angiver hvilken variant denne meddelelse er. Slettet: AfsenderNavn Slettet: Afsenderens navn. Slettet: MeddelelseIndholds data Slettet: indholde R FilformatNavn Angiver formatet af meddelelsens indhold. R IndholdsdataStoerrelseMaal Størrelsen på indholdet af meddelelsen i kilobytes. Slettet: R... [141] Bilag G: Webservice 40

41 R MeddelelseTraadIdentifikator Såfremt meddelelsen er en del af en dialog, så angives her en pågældende dialog. Er kun inkluderet for Afhentningssystemer tilhørende myndigheder. R MeddelelseModtagetDatoTid Modtagelsestidspunktet. R VedhaeftningSamling Liste af vedhæftninger. R MeddelelseLaestIndikator Har brugeren læst meddelelsen. R PostkasseMetadata Angiver anvendte postkasse og emne, og indeholder en liste af metadata fra emnet. Er kun inkluderet for Afhentningssystemer tilhørende myndigheder. R MeddelelseFESDmetadata Feltet har kun relevans når afsendelsen har en svarpostkasse. Indholdet bliver returneret ved besvarelse af en afsendelse og tjener til at knytte svaret til den korrekte sag i et sagsbehandlingssystem. Slettet: beskeden. Slettet: PostkasseMetadata Samling Slettet: En Slettet: værdier af Slettet: en postkasse Slettet: FESDmetadata Er kun inkluderet for Afhentningssystemer tilhørende myndigheder. R MeddelelseTidsfristDato En dato som angiver at der er en tidsfrist forbundet med meddelelsen. R MeddelelseTidsfristTekst Et notat som afsender kan tilknytte til afsendelsen. Eksempelvis til at beskrive tidsfristen. G Signaturbevis Kommentar Signaturbevis TYPE En slutbruger kan sende meddelelser til myndigheder via myndighedernes postkasser. Slutbrugeren skal være logget i DKAL for at kunne sende til en postkasse. Denne type indeholder information om det certifikat slutbrugeren anvendte til login i DKAL ved anvendelsen. Signaturbevis bliver kun anvendt for meddelelser der er sendt fra en slutbruger til en myndighed. Indeholder en liste af elementer, hvor hvert element er en sekvens af disse felter. R CertifikatUdstederIdentifikator Certifikatets udsteder angivet med Issuer. Slettet: <#>PostkasseMetada ta Slettet: OBJEKT tabel Slettet: PostkasseMetadata Slettet: Objektet indeholder metadata fra en postkasse for en meddelelse. Slettet: XSD : Skrifttype: Kursiv Slettet: PostkasseMetadata : Skrifttype: Ikke Kursiv Slettet: sequens Slettet: C Slettet: PostkasseMetadata NoegleNavn Slettet: Nøglen Bilag G: Webservice 41

42 R CertifikatOrganisationNavn Såfremt det er en virksomhed / myndighed der er afsendte meddelelsen (som slutbruger) vil navnet på organisation fremgå her som det er beskrevet i certifikatet. R R CertifikatEmneSerienummer Identifikator MeddelelseAfsenderCVRnummer Identifikator Certifikatets SubjectSerialNumber, der identificerer ejeren. Såfremt det er en virksomhed / myndighed der er afsendte meddelelsen (som slutbruger) vil CVR nummeret på denne organisation fremgå her som det er beskrevet i certifikatet. Slettet: C Slettet: PostkasseMetadata VaerdiTekst Slettet: Værdien : Tabulatorer: Ikke med 3,1 cm : Skriftfarve: Brugerdefineret farve (RGB(88;87;91)) G PostkasseMetadata Slettet: <#>Vedhæftninger OBJEKT PostkasseMetadata Objektet indeholder metadata fra en postkasse for en meddelelse. tabel Slettet: Vedhæftninger Indeholder en liste af elementer, som består af nedenstående to felter og en liste af metadata nøgle/værdi-sæt. R PostkasseIdentifikator Angiver postkassen. R PostkasseEmneIdentifikator Angiver emnet. Metadata, som en liste af nøgle/værdi-sæt. R MetadataNoegleNavn Nøglen R MetadataVaerdiTekst Værdien G VedhaeftningSamling VedhaeftningSamling OBJEKT Objektet indeholder en liste informationer om vedhæftede dokumenter eller bilag. Indeholder en liste af objektet Vedhaeftning Slettet: XSD... [142] Slettet: Vedhæftning Bilag G: Webservice 42

43 G Vedhaeftning Slettet: <#>Vedhæftning Vedhaeftning Ægthed ved videresendel se OBJEKT Objektet indeholder information om en vedhæftning, inklusiv reference til selve indholdet et dokument eller bilag. Felterne VedhaeftningOprindelig er vil kun være udfyldt for en myndighed og angiver hvor vedhæftningen oprindeligt stammer fra. R VedhaeftningNavn Navnet på dokumentet. File extension fremgår af FilformatNavn. R VedhaeftningIndholdData Selve indholdet af vedhæftningen indkodet i Base64 formatet. R FilformatNavn Angiver formatet på vedhæftningens indhold. Formatnavnet er endelsen af det filnavn, som man ville give indholdet skulle det gemmes som en fil. F.eks. pdf, docx. Slettet: Vedhæftning Slettet: Modtaget Slettet: XSD Slettet: C Slettet: VedhaeftningIndhol dsdata Slettet: C... [143]... [144] R IndholdStoerrelseMaal Størrelsen af filen i kilobytes. R MIMEcontentIdentifikator Vedhæftninger i en S/MIME afsendelse bliver tildelt en MIME Content-ID, således at der i teksten i afsendelsen kan refereres til vedhæftninger, f.eks. ved indlejring af billeder i teksten. For at kunne genskabe denne afsendelser med indlejrede vedhæftninger, bliver Content-ID bevaret. R VedhaeftningOprindelig AfsenderNavn Angiver myndigheden som oprindeligt afsendte meddelelsen. Når dette felt er angivet kan der haves tillid til ægtheden af vedhæftningen. Slettet: ModtagetFraNavn R VedhaeftningOprindelig ModtagetDatoTid Såfremt feltet VedhaeftningOprindeligAfsenderNavn er udfyldt fremgår tidspunkt er for hvornår slutbrugeren oprindeligt modtog vedhæftningen. Slettet: ModtagetTidspunkt DatoTid Slettet: ModtagetFraNavn R VedhaeftningOprindelig AfsenderCVRnummer Identifikator Såfremt feltet VedhaeftningOprindeligAfsenderNavn er udfyldt fremgår CVR-nummeret på myndigheden der oprindeligt afsendte vedhæftningen. Bilag G: Webservice 43

44 G MeddelelseFESDmetadata Slettet: <#>FESDmetadata MeddelelseFESDmetadata Kommentar Objektet indeholder FESD-specifikke metadatafelter. OBJEKT Felterne i denne type er en del af den kommende FESD standard. C FESDdokumentIdentifikator Identificerer et dokument. C FESDaktoerIdentifikator Identificerer aktøren. C FESDsagIdentifikator Identificerer sagen. C FESDsagsklassifikation Identifikator Operationer Klassifikation af sagen. Følgende operationer er tilgængelige for et afhentningssystem. G Hent liste af de ældste meddelelse fra indbakken Afhentningssystem.HentMeddelelsesliste Input parametre Anvendes af virksomheder og myndigheder til at hente meddelelser fra deres indbakke. Meddelelserne der hentes inkluderer servicebeskeder. Såfremt der ikke er nogen meddelelser klar til afhentning returneres en tom liste. Som et søgekriterium kan antallet af returnerede meddelelser angives. Meddelelserne indeholder blot en reference til selve meddelelsen. sysid Angiver id for virksomhedens / myndighedens system cvr Virksomhedens / myndighedens CVRnummer. Slettet: FESDmetadata Slettet: XSD : Skrifttype: Kursiv Slettet: MeddelelseFESDme tadata Slettet: Kommentar Slettet: Felterne i denne type er en del af den kommende FESD standard, hvorfor deres format endnu ikke er defineret. tabel Slettet: ObjektID Slettet: en sag. Slettet: Objekttype Slettet: sagstypen. : Skriftfarve: Brugerdefineret farve (RGB(88;87;91)) Slettet: Identificerer sagssystemet. Slettet: ObjektIDkilde Slettet: <#>AfsenderMetadat a AfsenderMetadata... [145] tabel Slettet: Returnerer en liste Slettet: de ældste meddelelse Slettet: ligger i indbakken. Slettet: i indbakken Slettet: der hentes inkluderer servicebeskeder. Meddelelserne Slettet: Kommentarer... [146] tabel Input søgeparametre Antal Integer Det antal seneste meddelelser, der ønskes returneret. Hvis ikke angivet, returneres de 20 ældste. Maksimum er 100. Slettet: fem Slettet: Maximum Output content (OIOXML) Bilag G: Webservice 44

45 MeddelelseURL referencesamling Fejlkoder Liste af referencer til meddelelser. Slettet: Meddelelser 121 Ingen adgang til system {sysid} 132 Ugyldig soegeparameter {parameter} 146 Ukendt slutbruger Bilag G: Webservice 45

46 G Hent meddelelse i slutbrugerens indbakke Afhentningssystem.HentMeddelelse Hent en meddelelse i slutbrugerens indbakke. Input parametre sysid cvr mid Output content (OIOXML) Meddelelse Fejlkoder Identificerer systemet. Fremgår af administrationsportalen. Angiver virksomheden/myndigheden som ønsker at hente en meddelelse fra deres indbakke. Angiver meddelelsen. Den angivne meddelelse. Denne vil aldrig indeholde metadata. Slettet: slutbrugeren, der er Slettet: virksomhed/myndig hed. 121 Ingen adgang til system {sysid} 141 Ukendt meddelelsesidentifikation {meddelelsesid} 146 Ukendt slutbruger G Slet meddelelse fra indbakken Afhentningssystem.SletMeddelelse Input Parametre Slet den angivne meddelelse. sysid Angiver id for virksomhedens / myndighedens system cvr mid Virksomhedens / myndighedens CVRnummer. Angiver meddelelsen, der skal slettes. Bilag G: Webservice 46

47 Fejlkoder 121 Ingen adgang til system {sysid} 141 Ukendt meddelelsesidentifikation {meddelelsesid} 146 Ukendt slutbruger G Arkiver meddelelse fra indbakken Afhentningssystem.ArkiverMeddelelse Input Parametre Den angivne meddelelse flyttes fra indbakken til arkiveringsmappen for den pågældende tilmeldingsgruppe. Er der ikke angivet en arkiveringsmappe, fejler operationen. sysid Angiver id for virksomhedens / myndighedens system cvr mid Virksomhedens / myndighedens CVRnummer. Angiver meddelelsen, der skal arkiveres. Fejlkoder 121 Ingen adgang til system {sysid} 141 Ukendt meddelelsesidentifikation {mid} 146 Ukendt slutbruger 152 Ingen arkiveringsmappe angivet for indholdstype G Hent liste af uafhentede meddelelser fra tilknyttede postkasser Afhentningssystem.HentPostkasseMeddelelsesliste Anvendes af myndigheder til at hente meddelelser fra de postkasser der er tilknyttet dette afhentningssystem. Såfremt der ikke er nogen meddelelser klar til afhentning returneres en tom liste. Som et søgekriterium kan antallet af returnerede meddelelser angives. Meddelelserne indeholder blot en reference til selve meddelelsen. Bilag G: Webservice 47

48 Input parametre sysid Angiver id for virksomhedens / myndighedens system Input søgeparametre Antal Integer Det antal seneste meddelelser, der ønskes returneret. Hvis ikke angivet, returneres de 20 ældste. Maximum er 100. Output content (OIOXML) MeddelelseURL referencesamling Liste af referencer til meddelelser. Fejlkoder 121 Ingen adgang til system {sysid} (401) 132 Ugyldig soegeparameter {parameter} (400) 146 Ukendt slutbruger (404) G Hent selve meddelelsen fra en tilknyttet postkasse Afhentningssystem.HentPostkasseMeddelelse Hent en meddelelse fra en tilknyttet postkasse. Input parametre sysid mid Identificerer systemet. Fremgår af administrationsportalen. Angiver meddelelsen. Output content (OIOXML) Meddelelse Den angivne meddelelse. Denne indeholder FESD metadata, postkasse metadata og evt. afsendermetadata. Fejlkoder 121 Ingen adgang til system {sysid} (401) 141 Ukendt meddelelsesidentifikation {meddelelsesid} (404) 146 Ukendt slutbruger (404) Bilag G: Webservice 48

49 G Slet meddelelse fra tilknyttet postkasse Afhentningssystem.SletPostkasseMeddelelse Input Parametre Slet den angivne meddelelse. sysid Angiver id for virksomhedens / myndighedens system mid Angiver meddelelsen, der skal slettes. Fejlkoder 121 Ingen adgang til system {sysid} (401) 141 Ukendt meddelelsesidentifikation {meddelelsesid} (404) 146 Ukendt slutbruger (404) Bilag G: Webservice 49

50 G.5 Portal Dette funktionsområde tilbyder en række specifikke funktioner, som er beregnet til integration i en portal. Der kan hentes en liste med de seneste meddelelser, som en slutbruger har i sin sikre boks, samt hvor mange ulæste meddelelser slutbrugeren har. Det er også muligt at se en slutbrugers tilmeldinger, opdatere dem, og tilmelde slutbrugeren til nye tilmeldingsgrupper. Det er ikke muligt at oprette en ny slutbruger via denne snitflade. For at tilbyde en slutbruger at blive oprettet via en portal, skal slutbrugeren præsenteres for et link til en DKAL iframe, hvor oprettelsen foretages. En oversigt over samtlige kald hertil er vist nedenfor. Portal.HentTilmeldinger Operationen henter oplysning om en slutbrugers tilmeldinger. Tilmeldingerne angiver hvilke tilmeldingsgrupper, som slutbrugeren er tilmeldt. Det fremgår ligeledes om slutbrugeren har tilmeldt sig alt for den pågældende myndighed samt om vedkommende har tilmeldt sig alle myndigheder. Portal.OpdaterMyndighedstilmelding Operationen opdaterer status for slutbrugerens tilmelding på myndighedsniveau. Herved kan en slutbruger til- og afmelde sig 1) den myndighed portalen er tilknyttet eller 2) alle myndigheder. Herved bliver slutbrugeren samtidig automatisk tilmeldt nye tilmeldingsgrupper henholdsvis myndigheder når de oprettes. Portal.TilmeldSlutbruger Operationen gør det muligt at tilmelde en slutbruger til en tilmeldingsgruppe. Hvis tilmeldingen inkluderer modtagelse af meddelelser som ikke er servicebeskeder, er det kun en foreløbig tilmelding, som slutbrugeren selv skal logge ind og bekræfte. Hvis en tilmelding kun vedrører modtagelse af servicebeskeder, træder den omgående i kraft. Portal.FindMeddelelser Operationen søger efter meddelelser i en slutbrugers indbakke. Et eksempel på et søgekriterium er: Find brugerens ulæste meddelelser af for en specifik indholdstype. Det kan samtidig angives hvor mange meddelelser resultatet maksimalt skal indeholde. For hver meddelelse returneres der nogle få informationer, som f.eks. titel, samt et link til meddelelsen i en portal, der anvender DKAL iframe integration. Portal.HentAntalUlaesteMeddelelser Operationen henter antallet af ulæste meddelelser i en slutbrugers indbakke. G Fællesoffentlige portaler Normalt er en portal tilknyttet til den myndighed som har oprettet portalen via deres administrationsportal. Dette er ikke dækkende for fællesoffentlige portaler, som f.eks. borger.dk, som ikke er tilknyttet en bestemt myndighed, men som agerer på vegne af mange myndigheder. Det er muligt ved tilslutningen af en portal, at angive om det er en fællesoffentlig portal. Det har den konsekvens, at en fællesoffentlig portal ved anvendelse af funktionalitet der forudsætter en specifik myndighed i stedet skal oplyse den aktuelle myndighed. Objekter Følgende objekter anvendes i forbindelse med portalintegration. Slettet: Sideskift Bilag G: Webservice 50

51 MeddelelseOversigtSamling SlutbrugerTilmeldinger Meddelelser MeddelelseOversigt GruppetilmeldingSamling Myndighedstilmelding Meddelelse MeddelelseOversigtSamling En samling af typen MeddelelseOversigt. Gruppetilmelding Slettet: <#>Meddelelser En liste af objektet Meddelelse. Meddelelse MeddelelseOversigt Beskriver en meddelelse, heriblandt modtager, titel, tilstand, og afsendelsestidspunkt, samt et link til meddelelsen i en portal, der anvender DKAL iframe integration. SlutbrugerTilmeldinger Beskriver en slutbrugers tilmeldinger for en specifik myndighed på myndighedsniveau og tilmeldingsgruppe-niveau, Slettet: Slutbruger Myndighedstilmelding Beskriver en slutbrugers tilmelding på myndighedsniveau til 1) en specifik myndighed, eller 2) alle myndigheder. Af tilmeldingen fremgår bl.a. hvorvidt adviseringer ønskes via SMS og/eller . GruppetilmeldingSamling Indeholder en liste af tilmeldinger på tilmeldingsgruppe-niveau. Slettet: Gruppetilmelding er Gruppetilmelding Beskriver en tilmelding på tilmeldingsgruppe-niveau. Af tilmeldingen fremgår bl.a. hvorvidt adviseringer ønskes via SMS og/eller . G MeddelelseOversigtSamling Slettet: <#>Meddelelser MeddelelseOversigtSamling OBJEKT Objektet indeholder en liste af meddelelser, der hver indeholder en oversigt over pågældende meddelelse. Indeholder en liste af typen MeddelelseOversigt. Slettet: Meddelelser Slettet:. Slettet: XSD Slettet: objektet Meddelelse.... [147] Bilag G: Webservice 51

52 G MeddelelseOversigt Slettet: <#>Meddelelse MeddelelseOversigt Link til iframe integration OBJEKT Objektet indeholder informationer om en meddelelse heriblandt dokumenter og servicebeskeder. Og et link til meddelelsen i en portal, der anvender DKAL iframe integration. Feltet MeddelelseURLreference indeholder et link til meddelelsen enten i borger.dk eller virk.dk afhængig af hvilken brugertype der er tale om. Feltet MeddelelseReference indeholder en identifikation af meddelelsen, som kan anvendes i reference til meddelelsen i egen portal. R MeddelelseURLreference Link til meddelelsen i enten borger.dk eller virk.dk portalerne. tabel Slettet: Meddelelse : Hold sammen med næste Slettet: I-Frame Slettet: MeddelelseIdentifik ator Slettet: XSD tabel... [148] R MeddelelseIdentifikator Identifikation af meddelelsen, der anvendes i reference til meddelelsen i egen portal, der anvender DKAL iframe integration. R MeddelelseTypeNavn Meddelelse ServiceBesked. Angiver hvorvidt meddelelsen er en servicebesked. R AfsenderNavn Afsenderens navn. R MeddelelseServicebeskedTekst Såfremt meddelelsen er en servicebesked fremgår selve beskeden her. R MeddelelseTitelTekst Titlen på beskeden / Navnet på dokumentet når brugeren har oploadet en fil. En beskrivelse af indholdstypen foranstilles automatisk. R FilformatNavn Angiver formatet af meddelelsens indhold. R MeddelelseModtagetDatoTid Modtagelsestidspunktet. R VedhaeftningSamlingKvantitet Antallet af vedhæftninger, som meddelelsen indeholder. R MeddelelseLaestIndikator Angiver om brugeren har læst beskeden. R MeddelelseTidsfrist En dato som angiver at der er en tidsfrist forbundet med meddelelsen. Slettet: VedhaeftningAntalM aal Slettet: C Bilag G: Webservice 52

53 G SlutbrugerTilmeldinger SlutbrugerTilmeldinger OBJEKT Objektet indeholder information om en slutbrugers tilmeldinger. Tilmeldingerne er opdelt i myndigheds-tilmelding og tilmeldingsgruppetilmelding. tabel Slettet: Slutbruger Slettet: <#>Slutbruger Forskel mellem portal & register Dette objekt anvendes både for registre og portaler med den forskel at objektet for portaler ikke indeholder stamdata for slutbrugeren. Dette skyldes at disse oplysninger ikke stilles til rådighed for portaler. Hvert element i listen er en sekvens af nedenstående Slettet: XSD tabel... [149] R Myndighedstilmelding Tilmeldinger for en slutbruger på myndighedsniveau. R GruppetilmeldingSamling Liste af tilmeldinger for en slutbruger på tilmeldingsgruppeniveau. Slettet: Gruppetilmeldinger Er en slutbruger tilmeldt på myndighedsniveau, slår det igennem på tilmeldingsgruppeniveau, således at brugeren optræder som værende tilmeldt alle myndighedens grupper. G Myndighedstilmelding Myndighedstilmelding OBJEKT Objektet beskriver en slutbrugers tilmelding til 1) den myndighed som portalen er tilknyttet, eller 2) alle myndigheder. En bruger som tilmelder sig en myndighed vil automatisk blive tilmeldt alle myndighedens tilmeldingsgrupper. En slutbruger som er tilmeldt alle myndigheder vil automatisk være tilmeldt alle myndigheders tilmeldingsgrupper. R MyndighedIdentifikator Angiver CVR-nummeret på myndigheden, som denne tilmelding vedrører. U TilmeldtMyndighedIndikator ja nej. Er brugeren tilmeldt den pågældende myndighed. Slettet: XSD... [150] Bilag G: Webservice 53

54 U AlleMyndighederTilmeldt Indikator ja nej. Er brugeren tilmeldt alle myndigheder. Er denne ja, sættes MyndighedTilmeldtIndikator automatisk til ja. Det er uafklaret hvorvidt denne facilitet stilles til rådighed i den endelige udgave. U AdviseringSMSindikator ja nej. Adviser brugeren via SMS når nye servicebeskeder / meddelelser ankommer til DKAL. Default nej. Slettet: TilmeldtMyndighedA lleindikator Slettet: TilmeldtMyndighedI ndikator Slettet: U... [151] U Advisering Indikator ja nej. Adviser brugeren via når nye servicebeskeder / meddelelser ankommer til DKAL. Default ja G GruppetilmeldingSamling GruppetilmeldingSamling Objektet beskriver samling af tilmeldingsgrupper. OBJEKT Indeholder en liste af objektet Gruppetilmelding. Slettet: XSD... [152] G Gruppetilmelding OBJEKT Gruppetilmelding Objektet beskriver en slutbrugers tilmelding til en tilmeldingsgruppe. I nogle situationer ønskes en liste indeholdende både de tilmeldingsgrupper som brugeren er tilmeldt samt de tilmeldingsgrupper som slutbrugeren kan tilmelde sig for en specifik myndighed. Dette objekt anvendes til at beskrive begge dele, idet feltet TilmeldingsgruppeTilmeldtIndikator angiver den aktuelle status for tilmeldingsgruppen. R GruppetilmeldingIdentifikator Identifikation af objektet. R TilmeldingsgruppeNavn Navnet på tilmeldingsgruppen. Slettet: RessourceIdReferen ce Slettet: XSD... [153] U AdviseringSMSindikator ja nej. Adviser brugeren via SMS når nye servicebeskeder / meddelelser ankommer til DKAL. Default nej. U Advisering Indikator ja nej. Adviser brugeren via når nye servicebeskeder / meddelelser ankommer til DKAL. Default ja Bilag G: Webservice 54

55 R TilmeldingsgruppeTilmeldt Indikator Angiver om brugeren er tilmeldt denne gruppe. Anvendes når en liste af tilmeldinger også indeholder grupper, som brugeren har mulighed for at tilmelde sig. Operationer Følgende operationer er tilgængelige for portalintegration. Slettet: Sideskift G Hent en slutbrugers tilmeldinger Portal.HentTilmeldinger Returnerer en slutbrugers tilmeldinger. de tilmeldingsgrupper, som slutbrugeren er tilmeldt for den myndighed portalen er tilknyttet, samt oplysning om slutbrugeren har tilmeldt sig 1) alt for den myndighed eller 2) har tilmeldt sig alt for alle myndigheder. Forskel mellem portal & register Input parametre sysid cpr cvr En tilsvarende funktionalitet er tilgængelig for register. Forskellen er at denne operation ikke inkluderer slutbrugerens stamdata. Identificerer registret. Fremgår af administrationsportalen. Angiver slutbrugeren, når det er en borger. Angiver slutbrugeren, når det er en virksomhed/myndighed. Slettet: Kommentar... [154] Input søgeparametre IkkeTilmeldte Indikator Hvis angivet inkluderes også de af myndighedens tilmeldingsgrupper, som slutbrugeren ikke er tilmeldt. For hver gruppe angives om slutbrugeren er tilmeldt eller ej. Myndighed CVR Angiver den pågældende myndighed. Anvendes kun af fællesoffentlige portaler. Output content (OIOXML) Slutbruger Slutbruger Information om slutbrugeren. : Skrifttype: Kursiv Bilag G: Webservice 55

56 Fejlkoder 121 Ingen adgang til system {sysid} 132 Ugyldig soegeparameter {parameter} 146 Ukendt slutbruger G Til / afmeld en slutbruger til en myndighed / alle myndigheder Portal.OpdaterMyndighedstilmelding Til- og afmeld slutbrugeren på myndighedsniveau. Via dette kald kan en slutbruger til- og afmeldes 3) den myndighed som registret er tilknyttet, eller 4) alle myndigheder. Myndigheden som tilmeldingen vedrører Specielt for fællesoffentlig e portaler Den specifikke myndighed der kan til- og afmeldes er den som portalen er tilknyttet. Det vil sige den myndighed i vis administrationsportal denne portal er konfigureret. Såfremt dette er en fællesoffentlig portal skal myndigheden angives explicit. Se feltet Myndighed nedenfor. Input parametre sysid cpr cvr Identificerer portalen. Fremgår af administrationsportalen. Angiver slutbrugeren, når det er en borger. Angiver slutbrugeren, når det er en virksomhed/myndighed. Input søgeparametre Myndighed CVR Skal kun angives af fælles offentlige portaler. Angiver den myndighed som tilmeldingen vedrører. Input Content (OIOXML) Myndigheds tilmelding Indeholder den nye tilmelding / opdatering af en eksisterende. : Skrifttype: Kursiv Bilag G: Webservice 56

57 Fejlkoder 101 Max graense for data overskredet {datamaengde} 121 Ingen adgang til system {sysid} 132 Ugyldig soegeparameter {parameter} 133 Ugyldig felt i indhold {feltnavn} 146 Ukendt slutbruger G Tilmeld en slutbruger til en tilmeldingsgruppe Portal.TilmeldSlutbruger Input parametre Opret en ny tilmelding af en slutbruger til en tilmeldingsgruppe, eller opdater en eksisterende tilmelding. sysid cpr cvr tid Input content (OIOXML) Gruppetilmelding Fejlkoder Identificerer portalen. Fremgår af administrationsportalen. Angiver slutbrugeren, når det er en borger. Angiver slutbrugeren, når det er en virksomhed/myndighed. Identifikation af tilmeldingsgruppen. Kan findes via administrationsportalen, eller via en forespørgsel på en slutbrugers tilmeldinger hvor IkkeTilmeldte tilmeldingsgrupper medtages. Indeholder den nye tilmelding, eller opdatering af en eksisterende. : Skrifttype: Kursiv 101 Max graense for data overskredet {datamaengde} 121 Ingen adgang til system {sysid} 133 Ugyldig felt i indhold {feltnavn} 144 Ukendt tilmeldingsgruppe {tilmeldingsgruppeid} 146 Ukendt slutbruger Bilag G: Webservice 57

58 G Søg efter meddelelser i en slutbrugers boks Portal.FindMeddelelser Input parametre Søg efter meddelelser i en slutbrugers indbakke på baggrund af søgekriterium. : Hold sammen med næste sysid cpr cvr Identificerer systemet. Fremgår af administrationsportalen. Angiver slutbrugeren, når det er en borger. Angiver slutbrugeren, når det er en virksomhed/myndighed. Input søgeparametre Antal Integer Det antal seneste meddelelser, der ønskes returneret. Hvis ikke angivet, returneres de seneste fem. Maksimum er 100. Slettet: senste Slettet: Maximum KunUlaeste Indikator ja nej. Returner kun ulæste meddelelser. Default er nej. Indholdstype Identifikator Returner kun meddelelser fra denne indholdstype. Kan ikke angives sammen med tilmeldingsgruppe og myndighed. Tilmeldings gruppe Identifikator Returner kun meddelelser fra denne tilmeldingsgruppe. Kan ikke angives sammen med indholdstype og myndighed. Slettet: Tilmeldingsgruppe Myndighed CVR Returner kun meddelelser fra denne myndighed. Kan ikke angives sammen med indholdstype og tilmeldingsgruppe. Output content (OIOXML) Meddelelse OversigtSamling Fejlkoder Oversigt med meddelelser der opfylder kriteriet. Slettet: Meddelelser 121 Ingen adgang til system {sysid} 132 Ugyldig soegeparameter {parameter} 146 Ukendt slutbruger Bilag G: Webservice 58

59 G Hent antal ulæste meddelelser i en slutbrugers boks Portal.HentAntalUlaesteMeddelelser Hent antallet af ulæste meddelelser i en slutbrugers indbakke. Input parametre sysid cpr cvr Identificerer systemet. Fremgår af administrationsportalen. Angiver slutbrugeren, når det er en borger. Angiver slutbrugeren, når det er en virksomhed/myndighed. Output content Integer Antallet af ulæste meddelelser Fejlkoder 121 Ingen adgang til system {sysid} 146 Ukendt slutbruger Bilag G: Webservice 59

60 G.6 Fejlkoder Dette afsnit lister de applikationsspecifikke fejlkoder, som DKAL returnerer. Hver fejlkode har en fejltekst. Kode Beskrivelse Generel tabel Serverfejl 100 Serverfejl 101 Max graense for data overskredet {datamaengde} Ugyldig operation 111 Ukendt URL 112 Ugyldig XML tabel 113 {metode} er ikke tilladt Ingen adgang 120 Ingen adgang 121 Ingen adgang til system {sysid} 131 Ugyldig input parameter 132 Ugyldig soegeparameter {parameter} 133 Ugyldig felt i indhold {feltnavn} 140 Ukendt input parameter 141 Ukendt meddelelsesidentifikation {meddelelsesid} 142 Ukendt vedhaeftningsidentifikation {vedhaeftningsid} 143 Ukendt indholdstype {indholdstypeid} 144 Ukendt tilmeldingsgruppe {tilmeldingsgruppeid} Fejl i input Funktionel fejl tabel Slettet: [155] tabel Slettet: Logisk : Centreret : Skrifttype: Fed Slettet: Slettet: [156] tabel 145 Ukendt identifikation {id} 146 Ukendt slutbruger Logiske fejl Slettet: 111 Slettet: Ukendt operation Slettet: : Centreret : Skrifttype: Fed Bilag G: Webservice 60

61 Kode Beskrivelse Generel 150 Logisk fejl 151 Afsendelsen er afsendt 152 Ingen arkiveringsmappe angivet for indholdstype En række af disse fejlkoder er generelle for alle operationer. Disse vil derfor ikke være angivet som en mulig fejlkode for den enkelte operation. tabel Slettet: 113 Slettet: {metode} er ikke tilladt Slettet: 100 Slettet: Serverfejl Slettet: Slettet: 101 Slettet: Max graense for data overskredet {datamaengde} : Centreret Bilag G: Webservice 61

62 Side 2: [1] Forfatter :31:00 Side 2: [2] Erstat Side 2: [2] Erstat Side 2: [3] Forfatter :31:00 Side 2: [4] Erstat Side 2: [4] Erstat Side 2: [5] Forfatter :31:00 Side 2: [6] Erstat Side 2: [6] Erstat Side 2: [7] Forfatter :31:00 Side 2: [8] Erstat Side 2: [8] Erstat Side 2: [9] Forfatter :31:00

63 Side 2: [10] Erstat Side 2: [10] Erstat Side 2: [11] Forfatter :31:00 Side 2: [12] Erstat Side 2: [12] Erstat Side 2: [13] Forfatter :31:00 Side 2: [14] Erstat Side 2: [14] Erstat Side 2: [15] Forfatter :31:00 Side 2: [16] Erstat Side 2: [16] Erstat Side 2: [17] Forfatter :31:00 Side 2: [18] Erstat

64 Side 2: [18] Erstat Side 2: [19] Forfatter :31:00 Side 2: [20] Erstat Side 2: [20] Erstat Side 2: [21] Forfatter :31:00 Side 2: [22] Erstat Side 2: [22] Erstat Side 2: [23] Forfatter :31:00 Side 2: [24] Erstat Side 2: [24] Erstat Side 2: [25] Forfatter :31:00 Side 2: [26] Erstat

65 Side 2: [27] Erstat Side 2: [28] Forfatter :31:00 Side 2: [29] Erstat Side 2: [29] Erstat Side 2: [30] Forfatter :31:00 Side 2: [31] Erstat Side 2: [32] Erstat Side 2: [33] Forfatter :31:00 Side 2: [34] Erstat Side 2: [35] Erstat Side 2: [36] Erstat Side 2: [37] Forfatter :31:00 Side 2: [38] Erstat

66 Side 2: [39] Forfatter :31:00 Side 2: [40] Erstat Side 2: [41] Erstat Side 2: [42] Forfatter :31:00 Side 2: [43] Erstat Side 2: [44] Erstat Side 2: [45] Forfatter :31:00 Side 2: [46] Erstat Side 2: [46] Erstat Side 2: [47] Forfatter :31:00 Side 2: [48] Erstat Side 2: [48] Erstat Side 2: [49] Forfatter :31:00

67 Side 2: [50] Erstat Side 2: [50] Erstat Side 2: [51] Forfatter :31:00 Side 2: [52] Erstat Side 2: [52] Erstat Side 2: [53] Forfatter :31:00 Side 2: [54] Erstat Side 2: [54] Erstat Side 2: [55] Forfatter :31:00 Side 2: [56] Erstat Side 2: [56] Erstat Side 2: [57] Forfatter :31:00

68 Side 2: [58] Erstat Side 2: [58] Erstat Side 2: [59] Forfatter :31:00 Side 2: [60] Erstat Side 2: [60] Erstat Side 2: [61] Forfatter :31:00 Side 2: [62] Erstat Side 1: [63] Forfatter :31:00 Venstre Side 3: [64] Forfatter :31:00 Side 3: [65] Slettet Forfatter :31: Side 3: [65] Slettet Forfatter :31:00 EN SLUTBRUGERS STAMDATA OG TILMELDINGER Side 2: [66] Erstat Side 2: [67] Erstat Side 3: [68] Forfatter :31:00 Skrifttype: Ikke Fed

69 Side 3: [69] Slettet Forfatter :31:00 3. Side 3: [69] Slettet Forfatter :31:00 OPRET BOKS / OPDATER STAMDATA Side 3: [70] Forfatter :31:00 Side 2: [71] Erstat Side 2: [72] Erstat Side 3: [73] Forfatter :31:00 Side 2: [74] Erstat Side 3: [75] Slettet Forfatter :31:00 G TIL- / AFMELD EN SLUTBRUGER TIL EN MYNDIGHED / ALLE MYNDIGHEDER Side 2: [76] Erstat Side 2: [77] Erstat Side 3: [78] Slettet Forfatter :31:00.6 TILMELD Side 3: [78] Slettet Forfatter :31:00 SLUTBRUGER TIL EN TILMELDINGSGRUPPE Side 3: [79] Forfatter :31:00 Side 2: [80] Erstat Side 3: [81] Forfatter :31:00

70 Side 2: [82] Erstat Side 3: [83] Slettet Forfatter :31:00 G SLET EN TILMELDING FOR EN SLUTBRUGER Side 2: [84] Erstat Side 3: [85] Forfatter :31:00 Side 3: [86] Forfatter :31:00 Indholdsfortegnelse 3, Tabulatorer: 1,58 cm, Venstre + Ikke med 1,02 cm Side 2: [87] Erstat Side 3: [88] Slettet Forfatter :31:00 G.4 AFHENTNINGSSYSTEM Side 2: [89] Erstat Side 3: [90] Forfatter :31:00 Ikke Kapitæler Side 3: [91] Forfatter :31:00 Side 2: [92] Erstat Side 2: [93] Erstat Side 3: [94] Forfatter :31:00 Side 3: [95] Forfatter :31:00

71 Indholdsfortegnelse 1, Tabulatorer: 1,02 cm, Venstre + Ikke med 1,58 cm Side 2: [96] Erstat Side 2: [97] Erstat Side 3: [98] Forfatter :31:00 Skrifttype: Ikke Fed, Ingen understregning, Ikke Store bogstaver Side 3: [99] Forfatter :31:00 Side 2: [100] Erstat Side 3: [101] Slettet Forfatter :31:00 G MEDDELELSER Side 2: [102] Erstat Side 3: [103] Forfatter :31:00 Side 2: [104] Erstat Side 3: [105] Slettet Forfatter :31:00 3 POSTKASSEMETADATA Side 2: [106] Erstat Side 3: [107] Forfatter :31:00 Side 2: [108] Erstat

72 Side 2: [109] Erstat Side 3: [110] Forfatter :31:00 Side 3: [111] Forfatter :31:00 Indholdsfortegnelse 2, Tabulatorer: 1,31 cm, Venstre + Ikke med 1,58 cm Side 2: [112] Erstat Side 2: [113] Erstat Side 3: [114] Forfatter :31:00 Skrifttype: Ikke Fed Side 3: [115] Forfatter :31:00 Side 2: [116] Erstat Side 2: [117] Erstat Side 3: [118] Forfatter :31:00 Side 2: [119] Erstat Side 3: [120] Slettet Forfatter :31: AFSENDERMETADATA Side 2: [121] Erstat

73 Side 3: [122] Forfatter :31:00 Side 3: [123] Forfatter :31:00 Indholdsfortegnelse 3, Tabulatorer: 1,58 cm, Venstre + Ikke med 1,31 cm Side 2: [124] Erstat Side 2: [125] Erstat Side 1: [126] Forfatter :31:00 Venstre Side 10: [127] Slettet Forfatter :31:00 XSD Afsendelse Side 14: [128] Slettet Forfatter :31:00 XSD VedhaeftningSamling Side 14: [129] Slettet Forfatter :31:00 XSD Vedhaeftning Side 16: [130] Slettet Forfatter :31:00 C AfsenderMetadataVaerdiTekst Værdien Side 16: [131] Slettet Forfatter :31:00 XSD AfsendersystemTilmeldingSamling Side 16: [132] Slettet Forfatter :31:00 Listen indeholder følgende felte på overordnet ninveau R RessourceIdReference Identificerer tilmeldingslisten. Relevant for ændringslister hvor en liste skal slettes førend der opnås adgang til den næste ændringsliste. Side 27: [133] Slettet Forfatter :31:00

74 XSD SlutbrugerSamling Side 27: [134] Slettet Forfatter :31:00 XSD Slutbruger Side 28: [135] Slettet Forfatter :31:00 XSD TilmeldingMyndighed Side 29: [136] Slettet Forfatter :31:00 U AdviseringSMSindikator ja nej. Adviser brugeren via SMS når nye servicebeskeder / meddelelser ankommer til DKAL. Default nej. U Advisering Indikator ja nej. Adviser brugeren via når nye servicebeskeder / meddelelser ankommer til DKAL. Default ja Gruppetilmeldinger Gruppetilmeldinger Objektet beskriver samlig af tilmeldingsgrupper. OBJEKT XSD TilmeldingTilmeldingsgruppeSamling Side 29: [137] Slettet Forfatter :31:00 XSD TilmeldingTilmeldingsgruppe Side 30: [138] Slettet Forfatter :31:00 XSD SlutbrugerStamdata Side 30: [139] Slettet Forfatter :31:00 R RessourceIdReference Identifikation af objektet. Side 40: [140] Slettet Forfatter :31:00 XSD MeddelelseSamling Side 40: [141] Slettet Forfatter :31:00

75 R MeddelelseSvarPostkasseIdentifi kator Hvis en postkasse er angivet her, kan meddelelsen besvares via DKAL portalen (bemærk ikke via privat ). Såfremt postkassen har metadata skal disse felter fremgå i forbindelse med besvarelsen. Side 42: [142] Slettet Forfatter :31:00 XSD VedhaeftningSamling Side 43: [143] Slettet Forfatter :31:00 XSD Vedhaeftning C R VedhaeftningNavn Navnet på dokumentet. File extension fremgår af FilformatNavn. Side 43: [144] Slettet Forfatter :31:00 C FilformatNavn Angiver formatet af vedhaeftningens indhold C R VedhaeftningIndholdsdataVedha eftningindholddata Selve indholdet af vedhæftningen indkodet i Base64 formatet. Side 44: [145] Slettet Forfatter :31:00 AfsenderMetadata AfsenderMetadata OBJEKT Objektet indeholder metadata som afsenderen ønsker at inkludere i en meddelelse. XSD AfsenderMetadata Indeholder en liste af elementer, hvor hvert element er en sekvens af disse felter. C AfsenderMetadataNoegleNavn Nøglen C AfsenderMetadataVaerdiTekst Værdien Sideskift Side 44: [146] Slettet Forfatter :31:00 Kommentarer For at få adgang til de næste meddelelser skal denne slettes.

76 Side 51: [147] Slettet Forfatter :31:00 XSD MeddelelseSamling Side 52: [148] Slettet Forfatter :31:00 XSD Meddelelse Side 53: [149] Slettet Forfatter :31:00 XSD Slutbruger Side 53: [150] Slettet Forfatter :31:00 XSD TilmeldingMyndighed Side 54: [151] Slettet Forfatter :31:00 U AdviseringSMSindikator ja nej. Adviser brugeren via SMS når nye servicebeskeder / meddelelser ankommer til DKAL. Default nej. U Advisering Indikator ja nej. Adviser brugeren via når nye servicebeskeder / meddelelser ankommer til DKAL. Default ja Gruppetilmeldinger Gruppetilmeldinger OBJEKT Side 54: [152] Slettet Forfatter :31:00 XSD TilmeldingTilmeldingsgruppeSamling Side 54: [153] Slettet Forfatter :31:00 XSD TilmeldingTilmeldingsgruppe Side 55: [154] Slettet Forfatter :31:00 Kommentar En af søgeparametrene CPR eller CVR skal være udfyldt. Side 60: [155] Slettet Forfatter :31: Ingen adgang 121 Ingen adgang til system {sysid}

77 150 LogiskFunktionel fejl Side 60: [156] Slettet Forfatter :31: Afsendelsen er afsendt