Altinn formidling 2.0 - applikasjonstjenester og API-er
| Gå tilbake til standardvisning ved å klikke 'tilbake' (eller lukk dette vinduet om det er nytt) |
| Element | Beskrivelse |
|---|---|
Avsender |
Den som sender en elektronisk melding eller tilsvarende. |
Mottaker |
Den som mottar en elektronisk melding eller tilsvarende. |
Personbruker |
|
Altinn 2 Formidling |
|
Check if available Files |
Lettvekt metode for mottakere som ofte må sjekke om det er nye filer tilgjengelig. Sjekker kun i db, hopper over autorisasjons-steg. Returnerer True/false. |
Notify recepient |
Brukes av Politiet til å sende en melding via Altinn Corresponance) til mottaker med nedlastningslenke. |
Update receipt confirmation |
Mottaker: Oppdater tekst i mottakers kvittering, som er synlig også for avsender. Avsender: Kan (teoretisk) også brukes til å oppdatere kvitteringer for avsender, men kun avsender kan se sin oppdaterte kvittering. |
Get receipt confirmation |
Hent ut kvittering knyttet til filen basert på FileReference, per mottaker og totalt (alle motakere mottatt) |
Download File |
Strømmer ned fil for formidlingstjeneste basert på referanse. Autoriserer, strømmer ned fil, endrer IKKE status. |
Initiate message transfer |
Forbereder opprettelse av en formidlingstjeneste ved å sende inn nødvendig metadata, hvorpå fil kan strømmes opp .Returnerer en FileReference, en GUID som brukes videre som identifikator. Autoriserer og oppretter metadata i databasen, FileStatus=Initialized |
Upload file |
Strømmer opp fil for en gitt FileReference basert på opprettelse av formidlingstjeneste. Autoriserer, strømmer opp fil til sharet, oppdaterer manifest, utfører viruskontroll og setter status til "Uploaded" for både FileStatus og RecipientStatus. Returnerer Receipt. |
Get File Metadata |
Hent fil metadata. |
Get Available Files |
Henter en "avgivers" (Erik: du mener mottakers?) tilgjengelige formidlingstjenester med metadata og referanse for nedlasting. Inkluderer autorisasjon og henter ut liste med metadata for tilgjengelige filer. |
Confirm downloaded |
Bekrefter at mottaker har lastet ned filen, hvorpå filen kan saneres dersom den møter kriteriene. Endrer FileRecipientStatus til "Downloaded". |
Altinn Formidling SOAP API |
|
BrokerService/ConfirmDownloaded |
Bekrefter at mottaker har lastet ned filen, hvorpå filen kan saneres dersom den møter kriteriene. Endrer FileRecipientStatus til "Downloadaed". |
BrokerServiceStreamed/DownloadFileStreamed |
Strømmer ned fil for formidlingstjeneste basert på referanse. Autoriserer, strømmer ned fil, endrer IKKE status. |
BrokerService/CheckIfAvailableFiles |
Lettvekt metode for mottakere som ofte må sjekke om det er nye filer tilgjengelig. Sjekker kun i db, hopper over autorisasjons-steg. Returnerer True/false. |
BrokerService/GetAvailableFiles |
Henter en avgivers tilgjengelige formidlingstjenester med metadata og referanse for nedlasting.Inkluderer autorisasjon og henter ut liste med metadata for tilgjengelige filer. |
Receipt/UpdateReceipt |
Oppdater tekst i mottakers kvittering, som er synlig også for avsender. |
Receipt/GetReceiptV2 |
Hent ut kvittering knyttet til filen basert på FileReference. |
Altinn Formidling REST API |
|
GET https://www.altinn.no/api/my/brokerservice/files/{filereference} |
URL som kan benyttes av personbrukere som er logget inn I Altinn-portalen til å laste ned fil. - Brukes av Politiet, implementert i 15.2. |
Lettvekt metode for mottakere som ofte må sjekke om det er nye filer tilgjengelig.Tilsvarer SOAP CheckIfAvailableFiles. |
|
Henter en avgivers tilgjengelige filer med metadata og referanse for nedlasting. Tilsvarer SOAP GetAvailableFiles. |
|
GET https://www.altinn.no/api/{who}/brokerservice/inbox/{FileReference} |
GET for å hente metadata for en spesifikk fil til mottaker. |
GET https://www.altinn.no/api/{who}/brokerservice/inbox/{FileReference}/receipt |
GET for uthenting av fil receipt. Henter ut mottakers receipt. Vil kun vise receipt som tilhører mottaker.Tilsvarer SOAP GetReceiptV2, men avgrenset til formålet. |
POST https://www.altinn.no/api/{who}/brokerservice/inbox/{FileReference}/confirmdownloaded |
POST for å manuelt bekrefte at en fil er lastet ned og mottatt. Tilsvarer SOAP ConfirmDownloaded |
GET https://www.altinn.no/api/{who}/brokerservice/inbox/{FileReference}/download |
GET for å laste ned fil via binary stream. Tilsvarer SOAP DownloadFileStreamed. |
Altinn Formidling SOAP API |
|
Correspondence/InsertCorrespondenceV2 |
Brukes av Politiet til å sende en melding til mottaker med nedlastningslenke. |
BrokerService/InitiateBrokerService |
Forbereder opprettelse av en formidlingstjeneste ved å sende inn nødvendig metadata, hvorpå fil kan strømmes opp .Returnerer en FileReference, en GUID som brukes videre som identifikator. Autoriserer og oppretter metadata i databasen, FileStatus=Initialized |
BrokerServiceStreamed/UploadFileStreamed |
Strømmer opp fil for en gitt FileReference basert på opprettelse av formidlingstjeneste. Autoriserer, strømmer opp fil til sharet, oppdaterer manifest, utfører viruskontroll og setter status til "Uploaded" for både FileStatus og RecipientStatus. Returnerer Receipt. |
Receipt/GetReceiptV2 |
Hent ut kvittering knyttet til filen basert på FileReference. |
Receipt/UpdateReceipt |
Oppdater tekst i mottakers kvittering, som er synlig også for avsender. |
Altinn Formidling REST API |
|
Opprett BrokerService Fil med metadata og binary stream. Tilsvarer SOAP sin InitiateBrokerService og UploadFileStreamed. |
|
GET https://www.altinn.no/api/{who}/brokerservice/outbox/{FileReference} |
Hent fil metadata. |
GET https://www.altinn.no/api/{who}/brokerservice/outbox/{FileReference}/receipt |
Uthenting av fil kvittering / Receipt Tilsvarer SOAP GetReceiptV2, men avgrenset til formål. |
Get file URL |
URL som kan benyttes av personbrukere som er logget inn I Altinn-portalen til å laste ned fil. - Brukes av Politiet, implementert i 15.2. |