Typografidefinition: Typografi1: Skrifttype: 10 pkt, (intet) DKAL Snitflader REST Afhentningssystem

Transkript

1 Typografidefinition: Typografi1: Skrifttype: 10 pkt, (intet) DKAL Snitflader REST Afhentningssystem 1

2 Indholdsfortegnelse A3.1 INTRODUKTION 3 A3.1.1 HENVISNINGER 3 A3.1.2 LÆSEVEJLEDNING 4 A SÅDAN LÆSES EN REST GRAF 4 A SÅDAN LÆSES EN RESSOURCE OG EN TYPE 4 A SÅDAN LÆSES EN OPERATION 6 A3.2 OVERSIGT OVER FUNKTIONSOMRÅDET 7 A3.2.1 HENTE MEDDELELSER FRA INDBAKKE I SIKKER BOKS 7 A3.2.2 HENTE MEDDELELSER FRA POSTKASSE(R) 7 A3.2 RESSOURCER 9 A3.2.1 MEDDELELSEREFERENCESAMLING 10 A3.2.2 MEDDELELSE 10 A3.2.3 SIGNATURBEVIS 11 A3.2.4 POSTKASSEMETADATA 12 A3.2.5 VEDHAEFTNINGSAMLING 12 A3.2.6 VEDHAEFTNING 12 A3.2.7 MEDDELELSEFESDMETADATA 13 A3.3 OPERATIONER 15 A3.3.1 HENT LISTE AF DE ÆLDSTE MEDDELELSER FRA INDBAKKEN 15 A3.3.2 HENT MEDDELELSE FRA EGEN INDBAKKE 16 A3.3.3 SLET MEDDELELSE FRA INDBAKKEN 17 A3.3.4 ARKIVER MEDDELELSE FRA INDBAKKEN 17 A3.3.5 HENT LISTE AF UAFHENTEDE MEDDELELSER FRA TILKNYTTEDE POSTKASSER 18 A3.3.6 HENT SELVE MEDDELELSEN FRA EN TILKNYTTET POSTKASSE 19 A3.3.7 SLET MEDDELELSE FRA TILKNYTTET POSTKASSE 19 Bilag A3: REST Afhentningssystem 2... [1]... [2]... [3] Slettet: A... [4]... [5]... [6]... [7]... [8]... [9]... [10]... [11]... [12]... [13]... [14]... [15] Slettet: A... [16]... [17]... [18]... [19]... [20]... [21] Slettet: A.3 RESSOURCER... [22]... [23]... [24]... [25]... [26] Slettet: 3. MEDDELELSE... [27]... [28]... [29]... [30]... [31] Slettet: A3.3.1 MEDDELELSER... [32]... [33]... [34]... [35] Slettet: A3.3.3 POSTKASSEME... [36]... [37]... [38]... [39] Slettet: 3.4 VEDHÆFTNINGER... [40]... [41]... [42] Slettet:.5 VEDHÆFTNING... [43]... [44]... [45] Slettet: 3.6 FESDMETADATA... [46]... [47]... [48] Slettet: 3.7 AFSENDERMETAD... [49]... [50]... [51]... [52]... [53]... [54]... [55]... [56]... [57]... [58]

3 A3.1 Introduktion Dette dokument beskriver DKAL s REST snitflade for funktionsområdet vedrørende et afhentningssystem. Det anvendes af virksomheder til at hente meddelelser i deres sikre boks, og af myndigheder til at hente meddelelser sendt til dem via deres postkasser. Dokumentet henvender sig til udviklere og arkitekter, der skal integrere et afhentningssystem med DKAL. Denne introduktion indeholder en henvisning til andre relevante dokumenter, og en læsevejledning til snitfladebeskrivelsen. Efter introduktionen findes selve snitfladebeskrivelsen. A3.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 A1 REST Afsendersystem beskriver REST snitflade for et afsendersystem. Et afsendersystem anvendes af en myndighed til at sende afsendelser til slutbrugere. 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 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. Slettet: <#>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. : Venstre Bilag A3: REST Afhentningssystem 3

4 A3.1.2 Læsevejledning Metoden der anvendes i dette dokument til beskrivelse af ressourcer og operationer er beskrevet i dette afsnit. A 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. A 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. : Venstre Bilag A3: REST Afhentningssystem 4

5 Nedenstående illustration er et eksempel på en oversigt af ressourcer og typer. AfsendelseSamling Afsendelse Afs Af MeddelelseFESDmetadata VedhaeftningSamling 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 VedhaeftningSamling 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 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 : Venstre Bilag A3: REST Afhentningssystem 5

6 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. A 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} Eksempler på anvendelse et 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). : Punktopstilling : Venstre Bilag A3: REST Afhentningssystem 6

7 A3.2 Oversigt over funktionsområdet 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 Slettet: Først : Skrifttype: Kursiv : Skrifttype: Kursiv Slettet:. Efterfølgende Slettet: hver enkelt meddelelse. Til sidst slettes /afhentningssystem/{sysid} /meddelelser /{meddelelsesid} GET PUT DEL Slettet: /afhentningssys /boks/{cvr} /meddelelser /{meddelelsesid} /arkiv A3.2.1 Hente meddelelser fra indbakke i sikker boks GET /afhentningssystem/{sysid}/boks/{cvr}/meddelelser 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. Slettet: det GET /afhentningssystem/{sysid}/boks/{cvr}/meddelelser/{meddelelsesid} Operationen henter en meddelelse fra indbakken. Meddelelsen indeholder informationer om meddelelser, indholdet, samt evt. vedhæftninger og deres indhold. DELETE /afhentningssystem/{sysid}/boks/{cvr}/meddelelser/{meddelelsesid} Operationen sletter en meddelelse fra indbakken. PUT /afhentningssystem/{sysid}/boks/{cvr}/meddelelser/{meddelelsesid}/arkiv Operationen arkiverer meddelelse, således at den flyttes fra indbakken til angivne arkivmappe. A3.2.2 Hente meddelelser fra postkasse(r) GET /afhentningssystem/{sysid}/meddelelser 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. GET /afhentningssystem/{sysid}/meddelelser/{meddelelsesid} Operationen henter en meddelelse fra postkassen. Meddelelsen indeholder informationer om meddelelser, indholdet, samt evt. vedhæftninger og deres indhold. Slettet: Når den ældste : Skrifttype: Kursiv Slettet: i Slettet: slettet, bliver Slettet: næste Slettet: tilgængelig for afhentning. : Skrifttype: Kursiv : Venstre Bilag A3: REST Afhentningssystem 7

8 DELETE /afhentningssystem/{sysid}/ meddelelser/{meddelelsesid} 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: bevare et arkiv af Slettet: selv om Slettet: slettes Slettet: indbakken : Flere niveauer + Niveau: 1 + Nummereringstypografi: 1, 2, 3, + Begynd med: 1 + Justering: Venstre + Justeret: 0 cm + Tabulator efter: 0,76 cm + Indrykning: 0,76 cm : Venstre Bilag A3: REST Afhentningssystem 8

9 A3.2 Ressourcer Følgende ressourcer og typer 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. Typen 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. : Venstre Bilag A3: REST Afhentningssystem 9

10 A3.2.1 MeddelelseReferenceSamling MeddelelseReferenceSamling Ressourcen indeholder en liste af referencer til meddelelser. RESSOURCE Indeholder en liste af typen MeddelelseURLreference, der hver indeholder en reference til selve Meddelelsen. A3.2.2 Meddelelse Meddelelse RESSOURCE Ressourcen indeholder informationer om en meddelelse heriblandt dokumenter og servicebeskeder. R MeddelelseURLreference Reference til meddelelsen. R MeddelelseTypeNavn Meddelelse ServiceBesked. Angiver hvilken variant denne meddelelse er. Slettet: <#>Meddelelser Slettet: Meddelelser : Hold sammen med næste tabel Slettet: XSD... [63] Slettet: Meddelelse. Det eneste felt inkluderet i denne anvendelse af Meddelelse er : Dansk tabel : Dansk : Punktopstilling tabel Slettet: XSD tabel... [64] Slettet: MeddelelseURIrefer ence 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. tabel Slettet: MeddelelseIndholds data Slettet: indholde R FilformatNavn Angiver formatet af meddelelsens indhold. R IndholdsdataStoerrelseMaal Størrelsen på indholdet af meddelelsen i kilobytes. 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. Slettet: R tabel : Venstre... [65] Bilag A3: REST Afhentningssystem 10

11 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. A3.2.3 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. 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 CertifikatEmneSerienummer Identifikator Certifikatets SubjectSerialNumber, der identificerer ejeren. Slettet: <#>PostkasseMetada ta tabel Slettet: PostkasseMetadata Slettet: Typen 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 Slettet: C Slettet: PostkasseMetadata VaerdiTekst Slettet: Værdien : Skriftfarve: Brugerdefineret farve (RGB(88;87;91)) : Venstre Bilag A3: REST Afhentningssystem 11

12 R MeddelelseAfsenderCVRnummer Identifikator 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. A3.2.4 PostkasseMetadata PostkasseMetadata TYPE Typen indeholder metadata fra en postkasse for en meddelelse. 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 A3.2.5 VedhaeftningSamling VedhaeftningSamling TYPE Typen indeholder en liste informationer om vedhæftede dokumenter eller bilag. Indeholder en liste af typen Vedhaeftning Slettet: <#>Vedhæftninger Slettet: Vedhæftninger tabel Slettet: XSD... [66] tabel Slettet: Vedhæftning A3.2.6 Vedhaeftning Vedhaeftning TYPE Typen indeholder information om en vedhæftning, inklusiv reference til selve indholdet et dokument eller bilag. Slettet: <#>Vedhæftning tabel Slettet: Vedhæftning Ægthed ved videresendel se 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. Slettet: Modtaget Slettet: XSD tabel Slettet: C : Venstre... [67]... [68] Bilag A3: REST Afhentningssystem 12

13 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: VedhaeftningIndhol dsdata tabel Slettet: C 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. tabel 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 A3.2.7 MeddelelseFESDmetadata MeddelelseFESDmetadata Kommentar Såfremt feltet VedhaeftningOprindeligAfsenderNavn er udfyldt fremgår CVR-nummeret på myndigheden der oprindeligt afsendte vedhæftningen. 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: ObjektID Slettet: en sag. Slettet: Objekttype Slettet: sagstypen. : Skriftfarve: Brugerdefineret farve (RGB(88;87;91)) Slettet: Identificerer sagssystemet. Slettet: ObjektIDkilde : Venstre Bilag A3: REST Afhentningssystem 13

14 Slettet: <#>AfsenderMetadat a AfsenderMetadata... [69] : Punktopstilling : Venstre Bilag A3: REST Afhentningssystem 14

15 A3.3 Operationer Følgende operationer er tilgængelige for et afhentningssystem. A3.3.1 Hent liste af de ældste meddelelser fra indbakken /afhentningssystem/{sysid}/boks/{cvr}/meddelelser Input parametre GET 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. Slettet: meddelelse : Punktopstilling Slettet: Returnerer en liste Slettet: de ældste meddelelse Slettet: ligger i indbakken. Slettet: i indbakken Slettet: Meddelelserne der hentes inkluderer servicebeskeder. Slettet: Kommentarer... [70] sysid Angiver id for virksomhedens / myndighedens system cvr Virksomhedens / myndighedens CVRnummer. Input søgeparametre Antal Integer Det antal seneste meddelelser, der ønskes returneret. Hvis ikke angivet, returneres de 20 ældste. Maximum er 100. Slettet: fem Output content (OIOXML) MeddelelseURL referencesamling Fejlkoder Liste af referencer til meddelelser. Slettet: Meddelelser 121 Ingen adgang til system {sysid} (401) 132 Ugyldig soegeparameter {parameter} (400) 146 Ukendt slutbruger (404) : Venstre Bilag A3: REST Afhentningssystem 15

16 Pseudo kode eksempel string uri = "/afhentningssystem/1234/boks/ /meddelelser"; // Afgræns antal i resultatet uri +=?antal=7 ; MeddelelseURLreferenceSamling meddelelser = HTTP_GET(uri); foreach (MeddelelseURLreference referenceurl in meddelelser) { Meddelelse m = HTTP_GET(referenceURL); HTTP_DELETE(referenceURL); } Slettet: Meddelelser Slettet: Meddelelse meddelelse Slettet: string referenceuri = meddelelse.meddelelseur Ireference; Hent meddelelse fra egen indbakke /afhentningssystem/{sysid}/boks/{cvr}/meddelelser/{mid} Hent en meddelelse fra egen indbakke. Input parametre GET Slettet: referenceuri Slettet: referenceuri Slettet: Sideskift : Punktopstilling Slettet: i slutbrugerens tabel Slettet: i slutbrugerens 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. : Skrifttype: Kursiv 121 Ingen adgang til system {sysid} (401) 141 Ukendt meddelelsesidentifikation {meddelelsesid} (404) 146 Ukendt slutbruger (404) Pseudo kode eksempel Se eksemplet for A : Venstre Bilag A3: REST Afhentningssystem 16

17 A3.3.3 Slet meddelelse fra indbakken /afhentningssystem/{sysid}/boks/{cvr}/meddelelse/{mid} Input Parametre Slet den angivne meddelelse. sysid Angiver id for virksomhedens / myndighedens system DELETE : Punktopstilling tabel cvr mid Virksomhedens / myndighedens CVRnummer. Angiver meddelelsen, der skal slettes. Fejlkoder 121 Ingen adgang til system {sysid} (401) 141 Ukendt meddelelsesidentifikation {meddelelsesid} (404) 146 Ukendt slutbruger (404) Pseudo kode eksempel Se eksemplet for A A3.3.4 Arkiver meddelelse fra indbakken /afhentningssystem/{sysid}/boks/{cvr}/meddelelse/{mid} Input Parametre PUT 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. : Venstre Bilag A3: REST Afhentningssystem 17

18 Fejlkoder 121 Ingen adgang til system {sysid} (401) 141 Ukendt meddelelsesidentifikation {mid} (404) 146 Ukendt slutbruger (404) 152 Ingen arkiveringsmappe angivet for indholdstype (403) A3.3.5 Hent liste af uafhentede meddelelser fra tilknyttede postkasser /afhentningssystem/{sysid}/meddelelser Input parametre GET 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. 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) : Venstre Bilag A3: REST Afhentningssystem 18

19 Pseudo kode eksempel string uri = "/afhentningssystem/1235/meddelelser"; // Afgræns antal i resultatet uri +=?antal=7 ; MeddelelseURLreferenceSamling meddelelser = HTTP_GET(uri); foreach (MeddelelseURLreference referenceurl in meddelelser) { Meddelelse m = HTTP_GET(referenceURL); HTTP_DELETE(referenceURL); } A3.3.6 Hent selve meddelelsen fra en tilknyttet postkasse /afhentningssystem/{sysid}/meddelelser/{mid} Hent en meddelelse fra en tilknyttet postkasse. GET 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) Pseudo kode eksempel Se eksemplet for A A3.3.7 Slet meddelelse fra tilknyttet postkasse /afhentningssystem/{sysid}/meddelelse/{mid} DELETE : Venstre Bilag A3: REST Afhentningssystem 19

20 Slet den angivne meddelelse. Input Parametre 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) Pseudo kode eksempel Se eksemplet for A : Venstre Bilag A3: REST Afhentningssystem 20

21 Side 2: [1] Forfatter :19:00 Tabulatorer: 1,19 cm, Venstre + Ikke med 0,99 cm Side 2: [2] Forfatter :19:00 Side 2: [3] Erstat Side 2: [4] Erstat Side 2: [5] Forfatter :19:00 Side 2: [6] Erstat Side 2: [6] Erstat Side 2: [7] Forfatter :19:00 Side 2: [8] Erstat Side 2: [8] Erstat Side 2: [9] Forfatter :19:00 Side 2: [10] Erstat Side 2: [10] Erstat

22 Side 2: [11] Forfatter :19:00 Side 2: [12] Erstat Side 2: [12] Erstat Side 2: [13] Forfatter :19:00 Side 2: [14] Forfatter :19:00 Tabulatorer: 1,19 cm, Venstre + Ikke med 0,99 cm Side 2: [15] Erstat Side 2: [16] Erstat Side 2: [17] Forfatter :19:00 Side 2: [18] Erstat Side 2: [18] Erstat Side 2: [19] Forfatter :19:00 Side 2: [20] Forfatter :19:00 Indholdsfortegnelse 2, Tabulatorer: 1,48 cm, Venstre + Ikke med 0,99 cm Side 2: [21] Erstat

23 Side 2: [22] Erstat Side 2: [23] Forfatter :19:00 Ikke Kapitæler Side 2: [24] Forfatter :19:00 Side 2: [25] Forfatter :19:00 Indholdsfortegnelse 1, Tabulatorer: 1,19 cm, Venstre + Ikke med 1,48 cm Side 2: [26] Erstat Side 2: [27] Slettet Forfatter :19:00 3. Side 2: [27] Slettet Forfatter :19:00 MEDDELELSE Side 2: [28] Erstat Side 2: [29] Forfatter :19:00 Ingen understregning, Ikke Store bogstaver Side 2: [30] Forfatter :19:00 Side 2: [31] Erstat

24 Side 2: [32] Slettet Forfatter :19:00 A3.3.1 MEDDELELSER Side 2: [33] Erstat Side 2: [34] Forfatter :19:00 Side 2: [35] Erstat Side 2: [36] Slettet Forfatter :19:00 A3.3.3 POSTKASSEMETADATA Side 2: [37] Erstat Side 2: [38] Forfatter :19:00 Side 2: [39] Erstat Side 2: [40] Erstat Side 2: [41] Forfatter :19:00 Side 2: [42] Erstat Side 2: [43] Erstat Side 2: [44] Forfatter :19:00 Side 2: [45] Erstat

25 Side 2: [46] Erstat Side 2: [47] Forfatter :19:00 Side 2: [48] Erstat Side 2: [49] Slettet Forfatter :19: AFSENDERMETADATA Side 2: [50] Erstat Side 2: [51] Forfatter :19:00 Side 2: [52] Forfatter :19:00 Indholdsfortegnelse 2, Tabulatorer: 1,48 cm, Venstre + Ikke med 0,99 cm Side 2: [53] Erstat Side 2: [54] Erstat Side 2: [55] Forfatter :19:00 Ikke Kapitæler Side 2: [56] Forfatter :19:00 Side 2: [57] Forfatter :19:00 Indholdsfortegnelse 1, Tabulatorer: 1,19 cm, Venstre + Ikke med 1,48 cm Side 2: [58] Forfatter :19:00

26 Side 2: [59] Erstat Side 2: [60] Slettet Forfatter :19:00 A3.4.1 HENT LISTE AF DE ÆLDSTE MEDDELELSE FRA INDBAKKEN Side 2: [61] Erstat Side 1: [62] Forfatter :19:00 Venstre Side 10: [63] Slettet Forfatter :19:00 XSD MeddelelseSamling Side 10: [64] Slettet Forfatter :19:00 XSD Meddelelse R Side 10: [65] Slettet Forfatter :19:00 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 12: [66] Slettet Forfatter :19:00 XSD VedhaeftningSamling Side 12: [67] Slettet Forfatter :19:00 XSD Vedhaeftning C R VedhaeftningNavn Navnet på dokumentet. File extension fremgår af FilformatNavn. Side 12: [68] Slettet Forfatter :19:00 C FilformatNavn Angiver formatet af vedhaeftningens indhold C R VedhaeftningIndholdsdataVedha eftningindholddata Selve indholdet af vedhæftningen indkodet i Base64 formatet.

27 Side 14: [69] Slettet Forfatter :19:00 AfsenderMetadata AfsenderMetadata RESSOURCE Ressourcen 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 Side 15: [70] Slettet Forfatter :19:00 Kommentarer For at få adgang til de næste meddelelser skal denne slettes.