NB! Dokumentasjonen på dette nettstedet er for en løsning som skal avvikles innen juni 2026. Dokumentasjon for ny løsning finner du her.

Tjenesteeiers arkiv

Hente ut element fra tjenesteeiers arkiv

ArchiveCommon

Tjenesten ArchiveCommon inneholder operasjoner for uthenting av arkivdata fra tjenesteeiers arkiv.

Påfølgende kapittel beskriver tjenesteoperasjonen for denne arkivtjenesten.

GetServiceOwnerArchiveReporteeElementsV2

Denne operasjonen benyttes for å hente ut data for en gitt avgiver (privatperson eller foretak) fra en tjenesteeiers arkiv. Data kan være skjemasett arkivert i nåværende eller tidligere versjoner av Altinn, eller meldinger sendt fra tjenesteeier til avgiver. Merk at siden samhandlingstjenester og innsynstjenester ikke arkiveres til tjenesteeiers arkiv vil de ikke kunne hentes ut på denne måten. Kun elementer som innlogget bruker har tilgang til returneres, typisk ikke elementer for tjenester tilknyttet andre tjenesteeiere.

Det er for eksempel nødvendig å kunne ha direkte tilgang til disse dataene i tilfeller hvor tjenesteeier ønsker å veilede en avgiver i sanntid basert på avgivers arkiverte data.

Tjenesteeier får rutinemessig tilsendt alle arkiverte elementer for alle avgivere via batch-grensesnittet Innsendingstjenester.

Operasjonen er versjonert, gjeldende versjon er V2.

Tabellen under beskriver datakontrakten for operasjonen:

InputBeskrivelse
SearchServiceOwnerArchiveObjektet av typen ExternalSOASearchBE, som inneholder søkeparametre for uthenting av elementer fra tjenesteeiers arkiv.
languageIDSpråk id: 1033 Engelsk 1044 Bokmål 2068 Nynorsk. Språk angitt på arkivert element benyttes uavhengig av hva som settes.
ReturverdiBeskrivelse
ServiceOwnerArchiveReporteeElementListListe med objektet av typen ServiceOwnerArchiveReporteeElementBEV2, som inneholder elementer fra tjenesteeiers arkiv som tilfredsstiller angitte søkeparametre.

Tabellen under gir en nærmere beskrivelse av objektene som inngår i datakontrakten.

ExternalSOASearchBE

PropertyBeskrivelse
SSNOrOrgNumberFødselsnummer eller organisasjonsnummer
ReferenceIdUnik referanse id
SubjectHvilket emne søket gjelder
DateFromFra dato i arkivet
DateToTil dato i arkivet
CaseIDIdentifikator for samhandlingstjeneste elementet skal tilhøre
UserNameSøk basert på brukernavn

ServiceOwnerArchiveReporteeElementBEV2

PropertyBeskrivelse
SubjectEmne for elementet
IsSubjectMessageTitleAngir om tittel er satt av MessageTitle
LastChangedDateDato for siste endring
DatReporteeIdIntern id
SSNOrOrganizationNumberFødselsnummer eller organisasjonsnummer tilknyttet arkivert element
ReporteeNameNavn på avgiver som eier arkivert element
ReporteeElementIdIntern id
Altinn1ArchiveUnitIdIntern id fra AltinnI arkivet. Kan være tomt
Altinn1AMReferenceAM referansen fra AltinnI arkivet. Kan være tomt
Altinn1FormCodeSkjemanummer fra AltinnI arkivet. Kan være tomt
EndUserSystemIdId for sluttbrukersystem. Kan være tomt
SendCompleteHvorvidt forsendelsen er komplett eller ikke for elementet. Kan være tomt
ElementTypeElement type: Archive, Active, Correspondence, ArchiveCorrespondence, LookUp, Collaboration
IsAltinn1Flagg som indikerer om elementet eksisterer i AltinnI
IsCorrespondenceConfirmationRequiredHvorvidt meldingsbekreftelse er påkrevd eller ikke
ArchiveReferenceReferansen fra Altinn arkivet.
SystemTypeNameTypenavn på sluttbrukersystem. Kan være tomt
ExpiryDateAngir eventuelt når elementet er planlagt slettet

ServiceOwnerArchive

Tjenesten ServiceOwnerArchive inneholder operasjoner for uthenting av elementer fra tjenesteeiers arkiv (ikke tilgang til arkiverte elementer fra tidligere versjoner av Altinn).

Påfølgende kapitler beskriver operasjonen for denne tjenesten.

GetArchivedFormTaskV2

Denne operasjonen benyttes for å hente ut alle skjemaer og vedlegg som tilhører et gitt skjemasett. Operasjonen er versjonert, gjeldende versjon er V2.

Tabellen under beskriver datakontrakten for operasjonen:

InputBeskrivelse
reporteeElementIdUnik identifikator for skjemasettet som skal hentes. Identifikatoren er obligatorisk input til tjenesten
languageIDSpråk kode: 1033 Engelsk, 1044 Bokmål, 2068 Nynorsk
ReturverdiBeskrivelse
ArchivedFormTaskObjektet av typen ArchivedFormTaskBEV2 som skjemasettet som tilfredsstilte det gitte søkekriteriet.

Tabellen under gir en nærmere beskrivelse av objektene som inngår i datakontrakten.

ArchivedFormTaskBEV2

PropertyBeskrivelse
reporteeElementIdUnik identifikator for skjemasettet.
LastChangedTidspunkt for når det sist ble gjort endringer på skjemasettet
ReporteeIDIntern id.
ArchivedDateTimeTidspunkt for når skjemasettet ble arkivert
ServiceOwnerUnik identifikator for tjenesteeier for skjemasettet
InvoiceInformationEventuell betalingsinformasjon som er vedlagt skjemasettet
ArchivedFormListListe med ArchivedFormBE-objekter (nærmere beskrevet nedenfor), som inneholder alle skjemaene i skjemasettet
ExternalServiceCodeTjenestekode
ExternalServiceEditionCodeTjenesteutgavekode
ssnOrgNumberFødselsnummer eller organisasjonsnummer tilhørende skjemasettet
PasswordEncryptedSymmetricKeyPassordkryptert symmetrisk nøkkel for å dekryptere eventuell sensitive felter
SOEncryptedSymmetricdKeySamme symmetriske nøkkel som over, men kryptert med tjenesteeiers sertifikat. Tjenesteeier kan da bruke privat nøkkel til å dekryptere denne nøkkelen
ArchiveTaskListListe med arkiv-objekter av typen ArchiveTaskBEV2

ArchivedFormBE

PropertyBeskrivelse
FormIDIntern id
FormNameNavn på skjema
FormDataXMLInnhold i skjema. Må legges i en CDATA blokk
ParentReferenceReferanse til hovedskjema. Denne referansen er kun satt dersom gjeldende skjema er et underskjema
FormPresentationFieldValuePresentasjonsfelt for skjemaet, dersom dette finnes.
PaymentInformationE2BBetalingsinformasjon på E2B-format
PaymentInformationHTMLBetalingsinformasjon på XML-format
DataFormatIdId til skjema fra metadata kilde
DataFormatVersionBetalingsinformasjon vedlagt skjema
FormPaymentInfoSkjemabeskrivelse

ArchivedAttachmentBEV2

PropertyBeskrivelse
AttachmentIDIntern Id
AttachmentFunctionTypeAngir hvilken funksjonstype vedlegget utgjør: Invoice, Unspecified
AttachmentNameNavn på vedlegg
MimeTypeNameAngir MIME-typen for vedlegget: application_none, application_pdf, application_msword, application_vnd_ms_excel, application_vns_oasis_opendocument_text, application_vnd_oasis_opendocument_presentation, application_vnd_oasis_opendocument_spreadsheet, application_rtf, application_vnd_ms_powerpoint, application_postscript, application_zip, text_plain, text_html, text_xml, text_rtf, text_richtext, binary_octet_stream, not_Applicable
CreatedByUserIDIntern Altinn identifikator på bruker som har lagt til vedlegget
CreatedDateTimeDato for når vedlegget ble opprettet
IsAddedAfterFormFillinAngir om vedlegget ble lagt til i løpet av signeringen (etter utfylling)
IsEncryptedAngir om vedlegget er kryptert

ArchivedFormTaskSigningStepBEV2

PropertyBeskrivelse
SignatureIDIntern Id
SignedByUserIntern id bruker som har signert skjemasettet
SignedByUserSSNFødselsnummer til bruker som har signert / organisasjonsnummer til virksomhetsbruker som har signert
SignedByUserNameNavn på bruker som har signert skjemasettet.
CreatedDateTimeDato og tidspunkt for når skjemasettet ble signert
SignatureSignaturen, binært format
SignatureTextSigneringsteksten
RequiresGroupSigningAngir om signatur gjelder for alle elementer i skjemasettet
AuthenticationLevelIDIntern id for autentiseringsnivået for bruker når signering ble gjort
AuthenticationMethodAutentiseringsnivået for bruker når signering ble gjort
CertificateIssuedByNameNavnet sertifikatet er utstedt til
CertificateIssuedForNameNavnet signaturen er utstedt til
CertificateValidFromTidspunkt (dato og klokkeslett) for når sertifikatet er gyldig
CertificateValidToTidspunkt (dato og klokkeslett) for når sertifikatet blir ugyldig
SignedAttachmentListListe over signerte vedlegg.
SignedFromListListe over signerte skjemaer
IsSigningAllRequiredAngir om signering er utført for alle elementer i skjemasett: YES – signering på alle skjema, NO – valgfri signering på skjema, SET_PER_FORM – valg for signering satt på skjema nivå
ProcessStepIDDen unike identifikatoren for steget signaturen gjelder for

ArchiveTaskBEV2

PropertyBeskrivelse
EndUserSystemIDSluttbrukersystem identifikator
LastChangedAngir dato for sist endring
NumberOfSignaturesAddedAntall signaturer som er lagt til
ProcessStepID_FKIntern ID for prosessteg
SentCompleteAngir om element ble sent som komplett fra sluttbrukersystem
TaskIDIdentifikator for elementet, samme som ReporteeElementID
UserDefinedNumberOfSignaturesRequiredAntall signaturer krevd for et evt brukerstyrt signeringssteg
WorkflowReferenceIntern ID forarbeidsflyt

GetArchiveShipmentStatusV2

Denne operasjonen benyttes for å hente ut status på oversending fra Altinn til Tjenesteeier for et arkivert skjema. Man kan hente ut status ved å bruke enten ArchiveReference eller ServiceReference. Disse kan ikke brukes samtidig. Operasjonen er versjonert, gjeldende versjon er V2. Tabellen under beskriver datakontrakten for operasjonen:

InputBeskrivelse
ArchiveReference (string)Tar inn en ArkivReferanse for et arkivert element. Når dette elementet er brukt skal ikke ServiceReference brukes.
ServiceReference (objekt)Inneholder en liste med ArchiveShipmentStatusExternalV2 objekter. Hvert objekt representerer et elementen som ble funnet av tjenesten, og har en egen liste over statuser registrert på elementet.
ServiceReference
ServiceCodeUnik identifikator. Dette er en mandatory parameter når man bruker ServiceReference til å hente ut status data.
ServiceEditionCodeUnik identifikator. Dette er en mandatory parameter når man bruker ServiceReference til å hente ut status data. Unik identifikator. Dette er en mandatory parameter når man bruker ServiceReference til å hente ut status data.
DateFromDefinerer dato og tidspunkt tjenesten skal hente ut status data fra.
DateToDefinerer dato og tidspunkt tjenesten skal hente ut status data til
ArchiveShipmentStatusExternalBEV2List
LimitReachedNår dette flagget er satt ble det funnet flere arkiverte elementer enn det som det er returnert statuser for
ArchiveShipmentStatusListListe over de returnerte arkiv elementene som en liste av ArchiveShipmentStatusExternalV2-entiteter
ArchiveShipmentStatusExternalV2
ArchiveReferenceUnik arkiv referanse
TimeOfArchivingTidspunkt for arkivering
ServiceCodeTjenestekode
ServiceEditionCodeTjeneste utgave kode
ShipmentStatusLogListe over arkiv elementets status endringer som en liste av ShipmentStatusLogEntry-entiteter.
ShipmentStatusLogEntry
ShipmentDescriptionEn beskrivelse av Shipment relatert til statusen, som inneholder navnet på ShipmentDefinition og TransportSekvensNummeret for shipmentet til tjenesteeier. Disse blir adskilt med et pipe-tegn
ShipmentStatusEn beskrivelse av Shipment relatert til statusen, som inneholder navnet på ShipmentDefinition og TransportSekvensNummeret for shipmentet til tjenesteeier. Disse blir adskilt med et pipe-tegn ShipmentStatus ShipmentStatus for arkiv elementet. Kan være: NotSet - Elementet er ikke gjort klar til oversendelse. NotSent – Elementet er ikke sendt til tjenesteeier. Sent – Element er sent til tjenesteeier. Error – Overførsel til tjenesteeier feilet. Correlated – Correspondence er opprettet som er knyttet til denne ArkivReferansen
ShipmentStatusDateTimeDato og klokkeslett for når statusen ble satt på arkiv elementet

GetAttachmentDataStreamed

Denne operasjonen benyttes for å hente ut data for ett gitt vedlegg in den tilfelle vedlegg er større en 30MB. GetArchivedFormTaskV2 må kalles for å få detailene om den binær filen returnerte av denne metoden.

Tabellen under beskriver datakontrakten for operasjonen.

InputBeskrivelse
AttachmentIDUnik identifikator for et vedlegg
ReturverdiBeskrivelse
AttachmentStream som inneholder et binært vedlegg