Lese Altinn innboks og arkiv gjennom REST API

Etter innlogging i Altinn, kan Altinn sitt REST API brukes til å lese og hente ned meldinger fra innboks/arkiv til bruker eller entiteter som bruker kan representere.

Altinns dokumentasjon på kallene finnes her:

https://www.altinn.no/api/Help (action - messages)

 

APIet er også dokumentert her:

https://altinn.github.io/docs/api/rest/meldinger/

 

Eksempel:

Søknadssystemet ønsker å laste ned vannmerket PDF rett etter søknaden har blitt sendt inn.

  1. Bruker logger seg inn i Altinn

  2. REST API kall for reportee brukes for å finne ut hvem bruker kan representere

  3. Bruker velger hvem man vil representere (eksempelvis org nummer 911455307)

  4. En søknad er signert og sendt inn gjennom rest API:
    POST {who}/Messages?language={language}&complete={complete}&sign={sign}

  5. REST APIer returnerer id for signert skjema: b7565629 (b = AR):
    Location: https://tt02.altinn.no/api/911455307/messages/b7565626

  6. Detaljer om innsendelsen kan hentes ned med dette kallet:
    :https://tt02.altinn.no/api/911455307/Messages/b7565626?language=1044,
    print lenken brukes for å hente ned dokumentet.
    https://tt02.altinn.no/api/911455307/messages/b7565626/print

 

{ "MessageId": "b7565626", "OriginalId": "a10701555", "Subject": "Søknad om rammetillatelse, Nygate 33, Prosjektnavn", "Status": "Sendt og arkivert", "LastChangedDateTime": "2021-05-12T19:32:28.497", "CreatedDate": "2021-05-12T19:32:28.497", "LastChangedBy": "Direktoratet for byggkvalitet", "ServiceOwner": "Direktoratet for byggkvalitet", "Type": "FormTask", "ServiceCode": "4397", "ServiceEdition": 3, "ArchiveReference": "AR7565626", "_links": { "self": { "href": "https://tt02.altinn.no/api/911455307/messages/b7565626" }, "print": { "href": "https://tt02.altinn.no/api/911455307/messages/b7565626/print", "mime-type": "application/pdf" }, "portalview": { "href": "https://tt02.altinn.no/Pages/ServiceEngine/Receipt/Receipt.aspx?RAReporteeElementID=7565626&ESC=4397&ESEC=3" }, "metadata": { "href": "https://tt02.altinn.no/api/metadata/formtask/4397/3" }, "form": [ { "href": "https://tt02.altinn.no/api/911455307/messages/b7565626/forms/3603002", "name": "Søknad om rammetillatelse, Nygate 33, Prosjektnavn", "signinglocked": false, "signedbydefault": false } ] } }