DKAL Snitflader REST Afsendersystem

DKAL Snitflader REST Afsendersystem 1

Indholdsfortegnelse A1.1 INTRODUKTION 3 A1.1.1 HENVISNINGER 3 A1.1.2 LÆSEVEJLEDNING 4 A1.1.2.1 SÅDAN LÆSES EN REST GRAF 4 A1.1.2.2 SÅDAN LÆSES EN RESSOURCE OG EN TYPE 4 A1.1.2.3 SÅDAN LÆSES EN OPERATION 6 A1.2 OVERSIGT OVER FUNKTIONSOMRÅDE 7 A1.2.1 AFGØR OM SLUTBRUGEREN ØNSKER EN AFSENDELSE 7 A1.2.2 AFSEND / OPDATER AFSENDELSE 7 A1.2.3 HENT EN TIDLIGERE AFSENDELSE 8 A1.2.4 TILBAGEKALD EN PLANLAGT AFSENDELSE 8 A1.3 RESSOURCER 9 A1.3.1 AFSENDELSESAMLING 10 A1.3.2 AFSENDELSE 11 A1.3.2.1 BEGRÆNSNINGER FOR SERVICEBESKEDER FEJL! BOGMÆRKE ER IKKE DEFINERET. A1.3.3 VEDHAEFTNINGSAMLING 14 A1.3.4 VEDHAEFTNING 14 A1.3.5 MEDDELELSEFESDMETADATA 15 A1.3.6 TILMELDINGSAMLINGREFERENCESAMLING 16 A1.3.7 TILMELDINGSAMLING 16 A1.4 OPERATIONER 17 A1.4.1 AFSEND OG OPDATER EN AFSENDELSE 17 A1.4.2 TILBAGEKALD EN AFSENDELSE 20 A1.4.3 HENT INFORMATIONER FOR EN SPECIFIK AFSENDELSE 21 A1.4.4 HENT INDHOLDET AF EN AFSENDELSE 21 A1.4.5 HENT INDHOLDET AF EN VEDHÆFTNING 23 A1.4.6 SØG EFTER TIDLIGERE AFSENDTE / PLANLAGTE AFSENDELSER 24 A1.4.7 FORESPØRG OM EN SLUTBRUGER ØNSKER EN SPECIFIK INDHOLDSTYPE 25 A1.4.8 HENT REFERENCE TIL BESTILT TILMELDINGSLISTE 27 A1.4.9 HENT EN BESTILT TILMELDINGSLISTE PER INDHOLDSTYPE 28 A1.4.10 SLET EN ÆNDRINGSLISTE 29 Bilag A1: REST Afsendersystem 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]... [30]... [31]... [32] Slettet: 3 VEDHÆFTNINGER... [33]... [34]... [35] Slettet: 4 VEDHÆFTNING... [36]... [37]... [38] Slettet: 5 FESDMETADATA... [39]... [40]... [41] Slettet: 6 AFSENDERMETADAT... [42]... [43]... [44]... [45] Slettet: 7 TILMELDINGSLISTE... [46]... [47]... [48]... [49] Slettet:.1 AFSEND OG... [50]... [51]... [52]... [53]... [54]... [55]... [56]... [57]... [58]... [59]

A1.1 Introduktion Dette dokument beskriver DKAL s REST snitflade for funktionsområdet afsendersystem. Dette funktionsområde anvendes når en myndighed ønsker at sende afsendelser til borgere, virksomheder og myndigheder som er tilmeldt DKAL. Dokumentet henvender sig til udviklere og arkitekter, der skal foretage systemintegration mellem DKAL og et afsendersystem. Denne introduktion indeholder udover en henvisning til andre relevante dokumenter, en læsevejledning til snitfladebeskrivelsen samt selve snitfladebeskrivelsen. A1.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, hvilket inkluderer en overordnet beskrivelse af REST snitfladen. 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 A5 HTTP returkoder og fejlkoder beskriver den generelle anvendelse af HTTP returkoder for REST snitfladen, samt de specifikke fejlkoder, som DKAL anvender. REST snitfladen består af yderligere tre funktionsområder, som er beskrevet i følgende dokumenter: Bilag A2 REST Register beskriver REST snitflade for et register. Et register anvendes af en myndighed til at hente og opdatere stamdata og tilmeldinger for slutbrugere. Bilag A3 REST Afhentningssystem beskriver REST snitflade for et afhentningssystem. Systemet anvendes 1) af virksomhed til at hente meddelelser fra deres sikre boks, og 2) af myndigheder til at hente meddelelser sendt til dem enten fra andre myndigheder, eller fra slutbrugere via de af myndigheden opsatte postkasser. Slettet: <#>Bilag A1 REST Afsendersystem beskriver REST snitflade for et afsendersystem. Et afsendersystem anvendes af en myndighed til at sende afsendelser til slutbrugere. Bilag A4 REST Portal beskriver REST snitflade for en portal. En portal anvendes af en myndighed til at 1) til- og afmelde slutbrugere til tilmeldingsgrupper, 2) hente en slutbrugers seneste meddelelser, og 3) efterspørge antallet af ulæste meddelelse. Bilag A1: REST Afsendersystem 3

A1.1.2 Læsevejledning Metoden der anvendes i dette dokument til beskrivelse af ressourcer og operationer er beskrevet i dette afsnit. A1.1.2.1 Sådan læses en REST graf REST operationerne illustreres ved hjælp af en URI-graf. Denne graf illustrerer hvilke HTTP operationer der er tilgængelig for det pågældende funktionsområde. Se nedenstående eksempel. GET PUT DEL /afsendersystem/{sysid} /afsendelser /tilmeldingsliste /{meddelelsesid} Øverst til højre ses en farvekode for hver HTTP operation: Grøn for GET, blå for PUT, og gul for DELETE (forkortet DEL). Grafen læses fra venstre mod højre og angiver et antal URI er. En URI kan indeholde en eller flere parametre, som er omkranset af { }. Den første del af grafen, /afsendersystem/{sysid}, indeholder således parameteren sysid, og kan f.eks. være /afsendersystem/1234. Den har ingen farvekoder angivet, hvilket viser at ingen operationer er tilgængelige. Eksempelet ovenfor viser følgende operationer: GET /afsendersystem/{sysid}/afsendelser GET /afsendersystem/{sysid}/afsendelser/{meddelelsesid} PUT /afsendersystem/{sysid}/afsendelser/{meddelelsesid} DELETE /afsendersystem/{sysid}/afsendelser/{meddelelsesid} GET /afsendersystem/{sysid}/tilmeldingsliste Det er ikke den fuld URI, der er angivet. De starter fra den fælles rod som alle URI erne i snitflade har, og deres fælles præfix, som angiver protokol, host og snitflade version, er udeladt. A1.1.2.2 Sådan læses en ressource og en type Ressourcer er dataobjekter, der anvendes som input eller output til operationerne i RESTgrafen. Typer er mindre datastrukturer, der indgår i en eller flere ressource. Ressourcer og typer 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 A1: REST Afsendersystem 4

Nedenstående illustration er et eksempel på en oversigt af ressourcer og typer. AfsendelseSamling Afsendelse Afs Af MeddelelseFESDmetadata VedhæftningSamling Slettet: FESDmetadata Ressourcer er vist med fuldt optrukken kant, og typer er vist med stiplet kant. En reference fra en ressource til en anden ressource er vist med en fuldt optrukken pil. Referencen følger pilens retning. En stiplet pil viser at en type eller ressource er inkluderet som en del af en anden type eller ressource. Inkluderingen følger pilens retning. Ovenstående illustration viser således at ressourcen AfsendelseSamling har en reference til ressourcen Afsendelse, og at typerne MeddelelseFESDmetadata og VedhæftningSamling er inkluderet i ressourcen Afsendelse. Hver ressource og type 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 ressourcen Afsendelse. Slettet: Afsendelser Slettet: FESDmetadata Slettet: Vedhæftninger RESSOURCE Afsendelse Formål Beskriver ressourcens/typens formål. XSD Navnet på det XSD skema som beskriver ressourcen. Angiver om det er en ressource eller en type. R Type Meddelelse Servicebesked C Indholdstype Angiver indholdstypen for afsendelsen. U Titel Titlen på afsendelsen. C Metadata Metadata for afsendelsen. Slettet: FESDmetadata 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 Bilag A1: REST Afsendersystem 5

meddelelse). Derfor kan dette felt kun læses (R). Feltet Titel er også påkrævet ved oprettelse, men kan opdateres efterfølgende (U). Feltnavne som starter med små bogstaver er attributter. Store begyndelsesbogstaver angiver elementer. A1.1.2.3 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. /afsendersystem/{sysid}/afsendelser/{meddelelsesid} Formål Eksempler på anvendelse Formålet med operationen. Beskriver eksempler hvor operationen anvendes. GET Angiver om det er en læse (GET) eller skrive (PUT) operation. Input parametre Input søgeparametre Output content Fejlkoder Beskriver alle parametre i URI en. 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. PUT operationer kan kun opdatere felter i en ressource som er angivet som opdaterbare (se ressource forklaringen U). Bilag A1: REST Afsendersystem 6

A1.2 Oversigt over funktionsområde 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. /afsendelser /{meddelelsesid} /indhold GET PUT DEL /vedhæftninger/{id} /afsendersystem /afsendersystem/{sysid} /tilmeldingsliste /{tilmeldingslisteid} /{dellisteid} /tilmeldinger/{indholdtypeid} Slettet: A1.2.1 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: GET /afsendersystem/{sysid}/tilmeldingsliste Hent en reference til en bestilt tilmeldingsliste og referencer til de enkelte delliste, som tilmeldingslisten kan være delt i. GET /afsendersystem/{sysid}/tilmeldingsliste/{tilmeldingslisteid}/{dellisteid} Hent en del 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. DELETE /afsendersystem/{sysid}/tilmeldingsliste/{tilmeldingslisteid} 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. Slettet: id GET /afsendersystem/{sysid}/tilmeldinger/{indholdstypeid} Forespørg om en slutbruger er tilmeldt en specifik indholdstype. A1.2.2 Afsend / opdater afsendelse Følgende operationer anvendes til at afsende og opdatere en afsendelse: Bilag A1: REST Afsendersystem 7

PUT /afsendersystem/{sysid}/afsendelser/{meddelelsesid} 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 A1.2.3 Hent en tidligere afsendelse Nedenstående kald anvendes til at hente information om afsendelsen, indholdet samt eventuelle vedhæftninger: GET /afsendersystem/{sysid}/afsendelser/{meddelelsesid} Anvendes til at hente informationer om en specifik afsendelse. Afsendelsen indeholder ikke selve indholdet, men en reference til det. GET /afsendersystem/{sysid}/afsendelser/{meddelelsesid}/indhold Indholdet af en afsendelse kan være tekst, HTML eller en binær fil. Denne operation henter dette indhold. GET /afsendelsessystem/{sysid}/afsendelser/{meddelelsesid} /vedhaeftninger/{id} Indholdet af en vedhæftning kan være tekst, HTML eller en binær fil. Denne operation henter dette indhold. Slettet: vefhæftning GET /afsendersystem/{sysid}/afsendelser Søg efter tidligere afsendte og planlagte afsendelser. A1.2.4 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 DELETE /afsendersystem/{sysid}/afsendelser/{meddelelsesid} Slet en afsendelse. Bilag A1: REST Afsendersystem 8

A1.3 Ressourcer Følgende ressourcer og typer 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 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 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 indholdet af vedhæftningen. MeddelelseFESDmetadata - Indeholder FESD metadata, der anvendes til automatisering af behandlingen af meddelelsen. Typen er inkluderet i Afsendelse. Slettet: Vedhæftninger Slettet: Vedhæftning. Slettet: Vedhæftning 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. Bilag A1: REST Afsendersystem 9

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. Slettet: Tilmeldingsliste TilmeldingSamling - Indeholder en liste af tilmeldinger, der hver angiver en slutbruger og den indholdstype, som slutbrugeren er tilmeldt. A1.3.1 AfsendelseSamling AfsendelseSamling Formål RESSOURCE Ressourcen 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: <#>Afsendelser Slettet: Afsendelser Kommentar XSD Nedenstående felter er kun beskrevet kort, da det er de er defineret på samme måde som i ressourcen Afsendelse. Se ressourcen Afsendelse for en mere detaljeret beskrivelse af felterne. AfsendelseSamling, som anvender AfsendelseOversigt. : Skrifttype: Kursiv 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 AfsendelseURLreference Reference til ressourcen, der indeholder alle informationer om meddelelsen. R VedhaeftningSamlingKvantitet Antallet af vedhæftninger, som meddelelsen har. Slettet: MeddelelseAfsendel sedatotid Slettet: MeddelelseTidsfrist Slettet: MeddelelseReferenc e Slettet: VedhaeftningAntalM aal Bilag A1: REST Afsendersystem 10

A1.3.2 Afsendelse Formål Afsendelse RESSOURCE Ressourcen 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 referencer, således at indholdet efterfølgende kan hentes. R AfsendelseURLreference Reference til afsendelsen. 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. 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. Slettet: XSD... [63] Slettet: RessourceURIrefere nce Slettet: Slettet: : Tabulatorer: Ikke med 3,1 cm Slettet: : Tabulatorer: Ikke med 3,1 cm Slettet: Slettet: MeddelelseIndholds data Slettet: MeddelelseIndholds datareference Udfyldes ikke når meddelelsen er en servicebesked. Bilag A1: REST Afsendersystem 11

R MeddelelseIndholdURLreference 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. Udfyldes ikke når meddelelsen er en servicebesked. C 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. Slettet: MeddelelseIndholds data Reference Slettet: R : Tabulatorer: Ikke med 3,1 cm Slettet: Udfyldes ikke når meddelelsen er en servicebesked. R IndholdsdataStoerrelseMaal Størrelsen på indholdet af afsendelsen i kilobytes. 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. : Tabulatorer: Ikke med 3,1 cm Slettet: Slettet: MeddelelseAfsendel sedatotid : Tabulatorer: Ikke med 3,1 cm 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. Udfyldes ikke når meddelelsen er en servicebesked. Slettet: Typen Vedhæftninger, som indeholder Bilag A1: REST Afsendersystem 12

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 A1: REST Afsendersystem 13

C MeddelelseTidsfristDato 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 MeddelelsesTidsfristTekst 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: MeddelelseTidsfrist Slettet: MeddelelsesNote 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 e-mail). A1.3.3 VedhaeftningSamling VedhaeftningSamling Formål TYPE Typen 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 typen Vedhaeftning Slettet: <#>Vedhæftninger tabel Slettet: Vedhæftninger Slettet: XSD... [64] tabel Slettet: Vedhæftning A1.3.4 Vedhaeftning Formål Vedhaeftning TYPE Typen 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. 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 VedhaeftningIndholdURLreference inkluderet i stedet for. Slettet: <#>Vedhæftning tabel Slettet: Vedhæftning Slettet: XSD tabel... [65] : Tabulatorer: Ikke med 3,1 cm Slettet: VedhaeftningIndhol dsdata Slettet: VedhareftningIndho ldsdatareference C VedhaeftningIndholdURL reference Reference til indholdet af vedhæftningen. Ved læse repræsentationen er det hele URL en til indholdet. Slettet: VedhaeftningIndhol dsdata Reference Slettet: URI en Bilag A1: REST Afsendersystem 14

C 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. Slettet: R Slettet: BilagReference R IndholdStoerrelseMaal Størrelsen af filen i kilobytes. A1.3.5 MeddelelseFESDmetadata MeddelelseFESDmetadata Formål Kommentar Typen indeholder FESD-specifikke metadatafelter. TYPE 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 Klassifikation af sagen. Slettet: <#>FESDmetadata tabel 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. Slettet: SagsID Slettet: en sag. Slettet: SagsKilde Slettet: sagssystemet. Slettet: <#>AfsenderMetadat a Bilag A1: REST Afsendersystem 15

A1.3.6 TilmeldingSamlingReferenceSamling TilmeldingSamlingReferenceSamling Formål Listen indeholder følgende felt på overordnet niveau R TilmeldingSamlingURLreference Indeholder en liste af TilmeldingDelSamlingURLreference, der hver refererer til en del af tilmeldingslisten. A1.3.7 TilmeldingSamling TilmeldingSamling Formål Kommentar RESSOURCE Ressourcen 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. RESSOURCE Ressourcen 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... [66] : Skriftfarve: Brugerdefineret farve (RGB(88;87;91)) Slettet: <#> Sideskift <#>Tilmeldingsliste tabel Slettet: Tilmeldingsliste Slettet: XSD... [67] tabel Slettet: Listen indeholder følgende felte på overordnet ninveau... [68] 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 A1: REST Afsendersystem 16

A1.4 Operationer Følgende operationer er tilgængelige for enkeltforsendelse. A1.4.1 Afsend og opdater en afsendelse /afsendersystem/{sysid}/afsendelser/{meddelelsesid} Formål PUT 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 ressourcen 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 Ressourcen der skal oprettes/opdateres. Som angivet i ressourcen Afsendelse er det kun afsendelsestidspunktet og tilstanden, der kan opdateres. Bilag A1: REST Afsendersystem 17

Fejlkoder 101 Max graense for data overskredet {datamaengde} (500) 121 Ingen adgang til system {sysid} (401) 133 Ugyldig felt i indhold {feltnavn} (400) 141 Ukendt meddelelsesidentifikation {meddelelsesid} (404) 151 Afsendelsen er afsendt (403) Bilag A1: REST Afsendersystem 18

Pseudo kode eksempel 1 // Eksempel på besvarelse af en henvendelse // Afssendersystem skal finde unik meddelelsesid string meddelelseid = GetNextMeddelelsesId(); string uri = /afsendersystem/4/afsendelser/ + meddelelseid; // Opret HTML meddelelse til afsendelse String htmltekst = "<html><head></head><body> ; HtmlTekst += <div>kære Tina Hansen</div> ; HtmlTekst += <div>vi sender her vores årlige ; HtmlTekst += informationsskrivelse.</div> ; HtmlTekst += <div>med venlig hilsen</div> ; HtmlTekst += <div>fursø Kommune</div> ; HtmlTekst += </body></html> ; // Vedhæftning string vedhaeftning = LoadFile("Adgangskort.PDF"); // Opret afsendelse Afsendelse afsendelse = new Afsendelse() { AfsendelseModtager = CPR:0102030405, MeddelelseIndholdstypeIdentifikator = 43, MeddelelseTitelTekst = "Informationsskrivelse", MeddelelseIndholdData = Base64Encode(htmlTekst), MeddelelseTraadIdentifikator = 1001, AfsendelseDatoTid = DateTime.Tommorow(), MeddelelseSvarTypeNavn = "Standard", MeddelelseFESDmetadata = new MeddelelseFESDmetadata() { FESDsagIdentifikator = 550e8400-e29b-41d4-a716-446655440000, FESDsagsklassifikationIdentifikator = 0048e045-4d14-b92e-a716-223344556600 } VedhaeftningSamling = new VedhaeftningSamling[2] = { new Vedhaeftning() { VedhaeftningNavn = "Årsberetning", BilagReference = "1001" }, } } new Vedhaeftning() { VedhaeftningNavn = "Personligt adgangskort", VedhaeftningIndholdData = Base64Encode(vedhaeftning) } HTTP_PUT(uri, afsendelse); Slettet: nyafsendelse Slettet: MeddelelseIndhol dsdata Slettet: MeddelelseAfsend elsedatotid Slettet: SagsID = Sag10001, SagsKilde = InfoSystem Slettet: Vedhaeftninger Slettet: VedhaeftningIndh oldsdata Slettet: nyafsendelse Bilag A1: REST Afsendersystem 19

Pseudo kode eksempel 2 // Eksempel på opdatering af en planlagt afsendelse string uri = /afsendersystem/4/afsendelser/100 ; AfsendelseOpdatering afsendelse = HTTP_GET(uri); // Opdater afsendelse med ny afsendelsestidspunkt afsendelse.afsendelsedatotid = 2009-10-10T12:00:00 ; HTTP_PUT(uri, afsendelse); Slettet: Afsendelse Slettet: MeddelelseAfsend elsedatotid A1.4.2 Tilbagekald en afsendelse /afsendersystem/{sysid}/afsendelser/{meddelelsesid} Formål Input parametre DELETE 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 A1.4.1 Fejlkoder 121 Ingen adgang til system {sysid} (401) 132 Ugyldig soegeparameter {parameter} (400) 141 Ukendt meddelelsesidentifikation {meddelelsesid} (404) 151 Afsendelsen er afsendt (403) Pseudo kode eksempel string uri = /afsendersystem/4/afsendelse/100 ; HTTP_DELETE(uri); Bilag A1: REST Afsendersystem 20

A1.4.3 Hent informationer for en specifik afsendelse /afsendersystem/{sysid}/afsendelser/{meddelelsesid} Formål Hent informationer for en specifik afsendelse. GET Eksempler på anvendelse Input parametre sysid meddelelsesid 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. 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 A1.4.1 Output content (OIOXML) Afsendelse Fejlkoder Den specifikke afsendelse returneres. : Skrifttype: Kursiv 121 Ingen adgang til system {sysid} (401) 133 Ugyldig system identifikation {sysid} (400) 134 Ugyldig meddelelsesidentifikation {meddelelsesid} (400) 141 Ukendt meddelelsesidentifikation {meddelelsesid} (404) Pseudo kode eksempel Se eksemplet for A1.4.4 A1.4.4 Hent indholdet af en afsendelse /afsendersystem/{sysid}/afsendelser/{mid}/indhold Formål Hent indholdet af en afsendelse. Input parametre GET Slettet: // Søg efter afsendelser AfsendelseSamling afsendelser = HTTP_GET(uri); Afsendelse afsendelsereference = afsendelser[0]; string uri = afsendelsereference.res sourceurireference; Afsendelse afsendelse = HTTP_GET(uri);... [69] tabel sysid Angiver id på afsendersystemet. Fremgår af administrationsportalen. Bilag A1: REST Afsendersystem 21

mid Output content (BINÆRT) Indhold Fejlkoder Angiver id på afsendelsen. Det er den id der blev anvendt da afsendelsen blev oprettet. Se forklaring under A1.4.1 Selve indholdet af vedhæftningen. Slettet: Indhold 121 Ingen adgang til system {sysid} (401) 141 Ukendt meddelelsesidentifikation {meddelelsesid} (404) Pseudo kode eksempel // Hent en eksisterende afsendelse Afsendelse afsendelse = HTTP_GET(uri); FileStream f = HTTP_GET(uri, afsendelse.meddelelseindholdreference); string contentformat = afsendelse.filformatnavn; bool ishtml = (contentformat == html ); Slettet: MeddelelseIndhol dsdatareference Bilag A1: REST Afsendersystem 22

A1.4.5 Hent indholdet af en vedhæftning /afsendersystem/{sysid}/afsendelser/{mid}/vedhaeftning/{vid} Formål Hent indholdet af en vedhæftning. GET 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 A1.4.1 Angiver id på vedhæftningen. Selve indholdet af vedhæftningen. Slettet: Indhold 121 Ingen adgang til system {sysid} (401) 141 Ukendt meddelelsesidentifikation {meddelelsesid} (404) 142 Ukendt vedhaeftningsidentifikation {vedhaeftningsid} (404) Pseudo kode eksempel // Udgangspunkt: en eksisterende afsendelse Afsendelse afsendelse = HTTP_GET(uri); Vedhaeftning vh = afsendelse.vedhaeftningsamling[0]; FileStream f = HTTP_GET(uri, vh.vedhaeftningindholdreference); string filename = vh.vedhaeftningnavn +. + vh.filformatnavn; SaveFile(f, filename); Slettet: VedhaeftningIndh oldsdatareference Bilag A1: REST Afsendersystem 23

A1.4.6 Søg efter tidligere afsendte / planlagte afsendelser /afsendersystem/{sysid}/afsendelser Formål GET Operationen giver en afsender adgang til at fremfinde tidligere afsendte og planlagte afsendelser. Et afsendersystem kan kun søge i blandt egne afsendelser. Operationen kan kun kaldes med et søgekriterium. Det er således ikke muligt at hente den komplette liste. tabel Slettet: Opera 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. 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 Liste med afsendelser der opfylder kriteriet. Slettet: Afsendelser Eksempel /afsendersystem/12345678/afsendelser?startdato=20090801& slutdato=20090831&cpr=0102030405. Returnerer alle afsendelser til den angivne borger som er afsendt i august 2009. Bilag A1: REST Afsendersystem 24

Fejlkoder 121 Ingen adgang til system {sysid} (401) 132 Ugyldig soegeparameter {parameter} (400) Pseudo kode eksempel string searchparams = "CPR=1234567890"; searchparams += "&StartDato=20090101"; searchparams += "&SlutDato=20091231"; string uri = "/afsendersystem/1234/afsendelser?" + searchparams; // Udfør søgning AfsendelseSamling afsendelser = HTTP_GET(uri); A1.4.7 Forespørg om en slutbruger ønsker en specifik indholdstype /afsendersystem/{sysid}/tilmeldinger/{indholdstypeid} Formål GET 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 A1.4.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. 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 Angiver id på afsendersystemet. Fremgår af administrationsportalen. Bilag A1: REST Afsendersystem 25

indholdstypeid Angiver den indholdstype der efterspørges. Feltet skal angives. Værdien findes via administrationsportalen. Input søgeparametre CVR CPR Angiver slutbrugeren såfremt det er en virksomhed/myndighed. Angiver slutbrugeren såfremt det er en borger. uden bindestreg. Output content (OIOXML) XSD R Tilmelding TilmeldtIndikator SlutbrugerTilmeldingStatus Angiver om slutbrugeren vil modtage en forsendelse med den angivne indholdstype. Slettet: AfsendersystemTil meldingsvar Slettet: Indikator Slettet: Tilmeldt Er den forespurgte indholdstype obligatorisk vil det altid fremgå at slutbrugeren er tilmeldt uanset om vedkommende har en tilmelding. 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. Eksempel /afsendersystem/4/tilmeldinger/25?cvr=12345678. Et specifikt afsendersystem forespørger forud for en afsendelse om en virksomhed ønsker at modtage den angivne indholdstype. Fejlkoder 121 Ingen adgang til system {sysid} (401) 132 Ugyldig soegeparameter {parameter} (400) 143 Ukendt indholdstype {indholdstypeid} (404) Bilag A1: REST Afsendersystem 26

Pseudo kode eksempel string param = "?cpr=1234567890"; string uri = "/afsendersystem/1234/tilmeldinger/4/" + param; // Afgør om afsendelse er muligt TilmeldingStatus tilmeldingstatus = HTTP_GET(uri); bool kanfremsende = tilmeldingstatus.tilmeldingtilmeldtindikator; A1.4.8 Hent reference til bestilt tilmeldingsliste /afsendersystem/{sysid}/tilmeldingsliste Formål Ændringslister Kompletliste Kommentar GET 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: AfsendersystemTi lmeldingsvar tilmeldingsvar Slettet: tilmeldingsvar.t ilmeldt; Slettet: en Slettet: per indholdstype : Norsk (bokmål) 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 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. : Hold sammen med næste : Skrifttype: Kursiv Slettet: Tilmeldingsliste Bilag A1: REST Afsendersystem 27

Fejlkoder 121 Ingen adgang til system {sysid} (401) A1.4.9 Hent en bestilt tilmeldingsliste per indholdstype /afsendersystem/{sysid}/tilmeldingsliste/ {tilmeldingslisteid}/{dellisteid} Formål Input parametre GET Hent en del af en tilmeldingsliste, der indeholder en liste af slutbrugers tilmelding til indholdstype. 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} (401) Bilag A1: REST Afsendersystem 28

Pseudo kode eksempel string uri = "/afsendersystem/1234/tilmeldingsliste"; // Hent reference til tilmeldingsliste TilmeldingReferenceSamling tilmeldingerref = HTTP_GET(uri); // Fortsæt indtil alle tilgængelige ændringslister er tilrådighed while (tilmeldingerref!= null) { TilmeldingSamlingReferenceSamling dellisterref = tilmeldingerref.tilmeldingsamlingreferencesamling; foreach (TilmeldingSamlingReference dellisteref in dellisterref) { TilmeldingSamling deliste = HTTP_GET(dellisteRef); tabel Slettet: AfsendersystemTi lmeldingsamling tilmeldinger Slettet: Slettet: tilmeldinger Slettet: Tilmeldingsliste Element } foreach (Tilmelding tilmelding in dellist) { string slutbruger = tilmelding.afsendelsemodtager; string itype = tilmelding.meddelelseindholdstypeidentifikator; //processer hver tilmelding } Slettet: tilmeldinger) { Slettet: } } HTTP_DELETE(tilmeldingerRef); tilmeldinger = HTTP_GET(uri); Slettet: tilmeldinger.res sourceurireference A1.4.10 Slet en ændringsliste /afsendersystem/{sysid}/tilmeldingsliste/{tilmeldingslisteid} Formål DELETE Slet den angivne tilmeldingsliste. Husk at hente og behandle listen forud. tabel Slettet: id} 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} (401) 145 Ukendt identifikation {tilmeldingslisteid} (404) Slettet: id Bilag A1: REST Afsendersystem 29

Pseudo kode eksempel Se eksempelet for A1.4.10. Bilag A1: REST Afsendersystem 30

Side 2: [1] Forfatter 11-12-2009 17:15:00 Side 2: [2] Erstat Side 2: [2] Erstat Side 2: [3] Forfatter 11-12-2009 17:15:00 Side 2: [4] Erstat Side 2: [4] Erstat Side 2: [5] Forfatter 11-12-2009 17:15:00 Side 2: [6] Erstat Side 2: [6] Erstat Side 2: [7] Forfatter 11-12-2009 17:15:00 Side 2: [8] Erstat Side 2: [8] Erstat Side 2: [9] Forfatter 11-12-2009 17:15:00

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

Side 2: [18] Erstat Side 2: [19] Forfatter 11-12-2009 17:15:00 Side 2: [20] Erstat Side 2: [20] Erstat Side 2: [21] Forfatter 11-12-2009 17:15:00 Side 2: [22] Erstat Side 2: [22] Erstat Side 2: [23] Forfatter 11-12-2009 17:15:00 Side 2: [24] Erstat Side 2: [24] Erstat Side 2: [25] Forfatter 11-12-2009 17:15:00 Side 2: [26] Erstat

Side 2: [27] Erstat Side 2: [28] Forfatter 11-12-2009 17:15:00 Side 2: [29] Erstat Side 2: [29] Erstat Side 2: [30] Forfatter 11-12-2009 17:15:00 Side 2: [31] Forfatter 11-12-2009 17:15:00 Indholdsfortegnelse 3, Tabulatorer: 1,77 cm, Venstre + Ikke med 1,48 cm Side 2: [32] Erstat Side 2: [33] Erstat Side 2: [34] Forfatter 11-12-2009 17:15:00 Side 2: [35] Erstat Side 2: [36] Erstat Side 2: [37] Forfatter 11-12-2009 17:15:00 Side 2: [38] Erstat

Side 2: [39] Erstat Side 2: [40] Forfatter 11-12-2009 17:15:00 Side 2: [41] Erstat Side 2: [42] Slettet Forfatter 11-12-2009 17:15:00 6 AFSENDERMETADATA Side 2: [43] Erstat Side 2: [44] Forfatter 11-12-2009 17:15:00 Side 2: [45] Erstat Side 2: [46] Erstat Side 2: [47] Forfatter 11-12-2009 17:15:00 Side 2: [48] Forfatter 11-12-2009 17:15:00 Indholdsfortegnelse 1, Tabulatorer: 1,19 cm, Venstre + Ikke med 1,48 cm Side 2: [49] Erstat Side 2: [50] Slettet Forfatter 11-12-2009 17:15:00.1 AFSEND OG OPDATER EN AFSENDELSE Side 2: [51] Forfatter 11-12-2009 17:15:00

Ingen understregning, Ikke Store bogstaver Side 2: [52] Erstat Side 2: [53] Forfatter 11-12-2009 17:15:00 Side 2: [54] Forfatter 11-12-2009 17:15:00 Indholdsfortegnelse 2, Tabulatorer: 1,48 cm, Venstre + Ikke med 1,19 cm Side 2: [55] Erstat Side 2: [56] Erstat Side 2: [57] Forfatter 11-12-2009 17:15:00 Ikke Kapitæler Side 2: [58] Forfatter 11-12-2009 17:15:00 Side 2: [59] Erstat Side 2: [60] Erstat Side 2: [61] Forfatter 11-12-2009 17:15:00 Side 1: [62] Forfatter 11-12-2009 17:15:00 Venstre Side 11: [63] Slettet Forfatter 11-12-2009 17:15:00 XSD Afsendelse

Side 14: [64] Slettet Forfatter 11-12-2009 17:15:00 XSD VedhaeftningSamling Side 14: [65] Slettet Forfatter 11-12-2009 17:15:00 XSD Vedhaeftning Side 16: [66] Slettet Forfatter 11-12-2009 17:15:00 C AfsenderMetadataVaerdiTekst Værdien Side 16: [67] Slettet Forfatter 11-12-2009 17:15:00 XSD AfsendersystemTilmeldingSamling Side 16: [68] Slettet Forfatter 11-12-2009 17:15:00 Listen indeholder følgende felte på overordnet ninveau R RessourceURIreference Identificerer tilmeldingslisten. Relevant for ændringslister hvor en liste skal slettes førend der opnås adgang til den næste ændringsliste. Side 21: [69] Slettet Forfatter 11-12-2009 17:15:00 // Søg efter afsendelser AfsendelseSamling afsendelser = HTTP_GET(uri); Afsendelse afsendelsereference = afsendelser[0]; string uri = afsendelsereference.ressourceurireference; Afsendelse afsendelse = HTTP_GET(uri); Sideskift