Versjonssammenligning

Nøkkel

  • Denne linjen ble lagt til.
  • Denne linjen ble fjernet.
  • Formateringen ble endret.

Vi har satt opp Ansako slik at status Status -og nedlastings Nedlastings-API fungerer på samme måte som de tilsvarende distribusjonstjenestene i Altinn.

Dokumentasjonen for disse APIene API-ene gjelder fortsatt:

FtB Arbeidsflyt Status API

InnsendingsAPI - Status https://dibk.atlassian.net/wiki/spaces/FB/pages/51480712

https://dibk.atlassian.net/wiki/spaces/FB/pages/2156691469

Ved bruk i Ansako erstattes Altinn-arkivreferansen med erklæringens ID for å hente status på innsendelsen. Vi bruker en ansvarsrett innsending som eksempelUnder ser du et eksempel på en innsending av en erklæring om ansvarsrett.

Eksempel statusApi

En ansvarsrett er sendt og har mottatt denne IDen ID-en fra Ansako: b9c14658-ccf4-4e1b-b02a-1f5d4b4f62e0

Response fra Ansako SkjemaInnsending API“SkjemaInnsending AP”I:

Kodeblokk
languagejson
    "formType": "ansvarsrett",
    "referanseId": "b9c14658-ccf4-4e1b-b02a-1f5d4b4f62e0",
    "dataFormatId": "ErklaeringAnsvarsrett",
    "dataFormatVersion": "1",
    "formMetadata": {
        "signeringsfrist": "2021-09-30T21:49:00.4Z"
    },
    xxxxxxx
}

...

Ved å bruke det opprinnelige status APIet API-et henter man en denne statusen:

/api/status/b9c14658-ccf4-4e1b-b02a-1f5d4b4f62e0

Kodeblokk
languagejson
{
    "Arkivreferanse": "B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0",
    "AltinnInnsending": "2021-10-01T10:35:11.447",
    "Saksaar": 0,
    "Sakssekvensnummer": 0,
    "StatusInnsending": "Ok",
    "Hendelser": [
        {
            "Beskrivelse": "Distribusjon av ansvarsrett mottatt",
            "Tidspunkt": "2021-10-01T10:35:22.487"
        },
        {
            "Beskrivelse": "ErklaeringAnsvarsrett opprettet og distribuert",
            "Tidspunkt": "2021-10-01T10:35:22.487"
        }
    ],
    "Distribusjoner": [
        {
            "Distribusjonstype": "Erklæring om ansvarsrett",
            "Status": "submittedPrefilled",
            "Sendt": "2021-10-01T10:35:11.447",
            "Filnedlastinger": [],
            "AnSaKoStatus": {
                "Status": "TilSignering",
                "Signeringsfrist": "2021-12-24T00:00:00"
            }
        }
    ]
}

"Distribusjoner"-bolken inneholder bare en én distribusjon siden Ansako oppretter en én og en én erklæring. Den vil ha et "Status"-felt som følger hovedstatusene som ble brukt i den tidligere versjonen. Det er også et "AnSaKoStatus" status objekt -statusobjekt som tilbyr mer granulert status informasjon statusinformasjon rundt statusene som blir brukt i Ansako.

Kommer: liste Liste over Ansako-statuser

Eksempel etter at signature signaturen er utført og filer kan lastes ned (ID B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0):

Kodeblokk
languagejson
{
    "Arkivreferanse": "B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0",
    "AltinnInnsending": "2021-10-01T10:35:11.447",
    "Saksaar": 0,
    "Sakssekvensnummer": 0,
    "StatusInnsending": "Ok",
    "Hendelser": [
        {
            "Beskrivelse": "Distribusjon av ansvarsrett mottatt",
            "Tidspunkt": "2021-10-01T10:35:22.487"
        },
        {
            "Beskrivelse": "ErklaeringAnsvarsrett opprettet og distribuert",
            "Tidspunkt": "2021-10-01T10:35:22.487"
        }
    ],
    "Distribusjoner": [
        {
            "Distribusjonstype": "Erklæring om ansvarsrett",
            "Status": "signed",
            "Sendt": "2021-10-01T10:35:11.447",
            "ReferanseIdSignert": "8c7e577b-d859-4399-8b2c-032833cc45ea",
            "Signert": "2021-10-01T12:39:06.263",
            "Filnedlastinger": [
                {
                    "Filbeskrivelse": "Erklæring om ansvarsrett",
                    "FilURL": "https://test-admbygg.dibk.no/api/download/8c7e577b-d859-4399-8b2c-032833cc45ea/ErklaeringAnsvarsrett-1_FormData.xml",
                    "Mimetype": "application/xml"
                },
                {
                    "Filbeskrivelse": "Erklæring om ansvarsrett",
                    "FilURL": "https://test-admbygg.dibk.no/api/download/8c7e577b-d859-4399-8b2c-032833cc45ea/testsigning-dac0089d-c601-4554-b55d-4b83129078eb.pdf",
                    "Mimetype": "application/pdf"
                }
            ],
            "AnSaKoStatus": {
                "Status": "Signert",
                "Signeringsfrist": "2021-12-24T00:00:00"
            }
        }
    ]
}

Eksempel innsending API

/api/v1/innsending/b9c14658-ccf4-4e1b-b02a-1f5d4b4f62e0

Kodeblokk
languagejson
{
    "referanse": "B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0",
    "innsendingsType": "Distribusjon",
    "altinnInnsending": "2021-10-01T10:35:11.447",
    "status": "Ok",
    "antallVedlegg": 0,
    "_links": {
        "self": {
            "href": "/api/v1/innsending/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0"
        },
        "hendelser": {
            "href": "/api/v1/innsending/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0/hendelser"
        },
        "distribusjon": {
            "href": "/api/v1/innsending/distribusjoner/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0"
        }
    }
}

/api/v1/innsending/distribusjoner/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0

Kodeblokk
languagejson
{
    "antallDistribusjoner": 1,
    "antallDistribusjonerOk": 1,
    "antallDistribusjonerFeilet": 0,
    "_links": {
        "self": {
            "href": "/api/v1/innsending/distribusjoner/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0"
        },
        "distribusjoner": {
            "href": "/api/v1/innsending/distribusjoner/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0/distribusjonsdetaljer"
        }
    }
}

/api/v1/innsending/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0/hendelser

Kodeblokk
{
    "hendelser": [
        {
            "melding": "ErklaeringAnsvarsrett opprettet og distribuert",
            "tidspunkt": "2021-10-01T10:35:22.487"
        },
        {
            "melding": "Distribusjon av ansvarsrett mottatt",
            "tidspunkt": "2021-10-01T10:35:22.487"
        }
    ],
    "totalResults": 2,
    "totalPages": 1,
    "page": 1,
    "_links": {
        "self": {
            "href": "/api/v1/innsending/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0/hendelser?page=1"
        },
        "page": {
            "href": "/api/v1/innsending/{referanse}/hendelser{?page}",
            "templated": true
        }
    }
}

Etter signering

/api/v1/innsending/b9c14658-ccf4-4e1b-b02a-1f5d4b4f62e0

Kodeblokk
{
    "referanse": "B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0",
    "innsendingsType": "Distribusjon",
    "altinnInnsending": "2021-10-01T10:35:11.447",
    "status": "Ok",
    "antallVedlegg": 0,
    "_links": {
        "self": {
            "href": "/api/v1/innsending/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0"
        },
        "hendelser": {
            "href": "/api/v1/innsending/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0/hendelser"
        },
        "distribusjon": {
            "href": "/api/v1/innsending/distribusjoner/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0"
        }
    }
}

/api/v1/innsending/distribusjoner/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0

Kodeblokk
languagejson
{
    "antallDistribusjoner": 1,
    "antallDistribusjonerOk": 1,
    "antallDistribusjonerFeilet": 0,
    "_links": {
        "self": {
            "href": "/api/v1/innsending/distribusjoner/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0"
        },
        "distribusjoner": {
            "href": "/api/v1/innsending/distribusjoner/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0/distribusjonsdetaljer"
        }
    }
}

/api/v1/innsending/distribusjoner/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0/distribusjonsdetaljer

Kodeblokk
languagejson
{
    "totalResults": 1,
    "totalPages": 1,
    "page": 1,
    "_links": {
        "self": {
            "href": "/api/v1/innsending/distribusjoner/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0/distribusjonsdetaljer?page=1"
        },
        "page": {
            "href": "/api/v1/innsending/distribusjoner/{referanse}/distribusjonsdetaljer{?page}",
            "templated": true
        },
        "distribusjoner": [
            {
                "href": "/api/v1/innsending/distribusjoner/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0/distribusjonsdetaljer/cc9160df-e15b-4469-b42f-b40388c36ecf"
            }
        ]
    },
    "_embedded": {
        "distribusjoner": [
            {
                "distribusjonstype": "Erklæring om ansvarsrett",
                "status": "signed",
                "sendt": "2021-10-01T10:35:11.447",
                "referanseIdSignert": "8c7e577b-d859-4399-8b2c-032833cc45ea",
                "signert": "2021-10-01T12:39:06.263",
                "filnedlastinger": [
                    {
                        "vedleggstype": "MaskinlesbarXml",
                        "beskrivelse": "Erklæring om ansvarsrett",
                        "filUrl": "https://test-admbygg.dibk.no/api/download/8c7e577b-d859-4399-8b2c-032833cc45ea/ErklaeringAnsvarsrett-1_FormData.xml",
                        "mimeType": "application/xml"
                    },
                    {
                        "vedleggstype": "SkjemaPdf",
                        "beskrivelse": "Erklæring om ansvarsrett",
                        "filUrl": "https://test-admbygg.dibk.no/api/download/8c7e577b-d859-4399-8b2c-032833cc45ea/testsigning-dac0089d-c601-4554-b55d-4b83129078eb.pdf",
                        "mimeType": "application/pdf"
                    }
                ],
                "anSaKoStatus": {
                    "status": "Signert",
                    "signeringsfrist": "2021-12-24T00:00:00"
                },
                "_links": {
                    "self": {
                        "href": "/api/v1/innsending/distribusjoner/B9C14658-CCF4-4E1B-B02A-1F5D4B4F62E0/distribusjonsdetaljer/cc9160df-e15b-4469-b42f-b40388c36ecf"
                    },
                    "signertsvar": {
                        "href": "/api/v1/innsending/8c7e577b-d859-4399-8b2c-032833cc45ea"
                    }
                }
            }
        ]
    }
}

...