{
  "openapi" : "3.0.1",
  "info" : {
    "title" : "KS SvarUt: SvarInn API",
    "description" : "SvarInn API",
    "contact" : {
      "name" : "Fiks-brukerstøtte",
      "url" : "https://developers.fiks.ks.no",
      "email" : "fiks@ksdigital.no"
    },
    "version" : "v1"
  },
  "servers" : [ {
    "url" : "https://test.svarut.ks.no/tjenester",
    "description" : "SvarUt TEST"
  }, {
    "url" : "https://svarut.ks.no/tjenester",
    "description" : "SvarUt"
  } ],
  "tags" : [ {
    "name" : "SvarInn",
    "description" : "API for henting av og oppdatering av status for forsendelser sendt til SvarInn"
  } ],
  "paths" : {
    "/svarinn/forsendelse/{forsendelseId}" : {
      "get" : {
        "tags" : [ "SvarInn" ],
        "summary" : "Henter ZIP med alle filene tilhørende forsendelsen med gitt id. Husk at filene kan være store. MIME type er definert i Content-Type headeren, og filnavn i Content-Disposition. Filen er kryptert med den offentlige nøkkelen til mottakersystemet og må dekrypteres etter nedlasting.",
        "operationId" : "hentForsendelsefil",
        "parameters" : [ {
          "name" : "forsendelseId",
          "in" : "path",
          "required" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "200" : {
            "description" : "Kryptert ZIP med forsendelsens filer",
            "content" : {
              "*/*" : {
                "schema" : {
                  "type" : "string",
                  "format" : "byte"
                }
              }
            }
          }
        }
      }
    },
    "/svarinn/mottaker/hentNyeForsendelser" : {
      "get" : {
        "tags" : [ "SvarInn" ],
        "summary" : "Henter metadata for opptil 200 nye forsendelser på mottakersystemet man er autentisert med. Dersom det ikke finnes noen nye forsendelser returneres tom liste.",
        "operationId" : "hentNyeForsendelser",
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "application/json; charset=utf-8" : {
                "schema" : {
                  "type" : "array",
                  "items" : {
                    "$ref" : "#/components/schemas/Forsendelse"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/svarinn/kvitterMottak/forsendelse/{forsendelseId}" : {
      "post" : {
        "tags" : [ "SvarInn" ],
        "summary" : "Markerer forsendelsen som mottatt, slik at status endres til Lest. Forsendelsen vil ikke lenger returneres ved henting av nye forsendelser, og vil ikke videresendes via andre kanaler.",
        "operationId" : "settForsendelseMottatt",
        "parameters" : [ {
          "name" : "forsendelseId",
          "in" : "path",
          "required" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "*/*" : { }
            }
          }
        }
      }
    },
    "/kvitterMottakmanuelt/forsendelse/{forsendelseId}" : {
      "post" : {
        "tags" : [ "SvarInn" ],
        "summary" : "Markerer forsendelsen som mottatt manuelt. Krever personinnlogging via ID-porten.",
        "operationId" : "settForsendelseMottattManuelt",
        "parameters" : [ {
          "name" : "forsendelseId",
          "in" : "path",
          "required" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "*/*" : { }
            }
          }
        }
      }
    },
    "/svarinn/mottakFeilet/forsendelse/{forsendelseId}" : {
      "post" : {
        "tags" : [ "SvarInn" ],
        "summary" : "Hvis mottak av forsendelse feilet, kan dette meldes tilbake til SvarUt. Dette vil da fremkomme i loggen til avsender. Dersom en feil blir market som permanent, vil den bli sendt videre til Altinn, eller eventuelt som brevpost, gitt at forsendelsen ikke er markert som kun digital. ",
        "operationId" : "settImportFeilet",
        "parameters" : [ {
          "name" : "forsendelseId",
          "in" : "path",
          "required" : true,
          "schema" : {
            "type" : "string"
          }
        } ],
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/ImportFeil"
              }
            }
          }
        },
        "responses" : {
          "default" : {
            "description" : "default response",
            "content" : {
              "*/*" : { }
            }
          }
        }
      }
    }
  },
  "components" : {
    "schemas" : {
      "Avsender" : {
        "type" : "object",
        "properties" : {
          "adresselinje1" : {
            "type" : "string",
            "description" : "Første adresselinje",
            "example" : "Digitaliseringsetaten"
          },
          "adresselinje2" : {
            "type" : "string",
            "description" : "Andre adresselinje",
            "example" : "Utviklingsavdelingen"
          },
          "adresselinje3" : {
            "type" : "string",
            "description" : "Tredje adresselinje",
            "example" : "Postboks 123"
          },
          "navn" : {
            "type" : "string",
            "description" : "Navn",
            "example" : "Storevik kommune"
          },
          "poststed" : {
            "type" : "string",
            "description" : "Poststed",
            "example" : "Storevik"
          },
          "postnr" : {
            "type" : "string",
            "description" : "Postnummer",
            "example" : "0000"
          }
        },
        "description" : "Informasjon om forsendelsens avsender"
      },
      "Entry" : {
        "type" : "object",
        "properties" : {
          "key" : {
            "type" : "string",
            "description" : "Nøkkel som beskriver metadataene",
            "example" : "versjon"
          },
          "value" : {
            "type" : "string",
            "description" : "Metadata-verdi",
            "example" : "4"
          }
        },
        "description" : "Ekstra metadata for filen definert av avsender"
      },
      "FilMetadata" : {
        "required" : [ "filnavn", "mimetype", "sha256hash", "size" ],
        "type" : "object",
        "properties" : {
          "filnavn" : {
            "minLength" : 1,
            "type" : "string",
            "description" : "Filnavn med eventuell extension",
            "example" : "brev.pdf"
          },
          "mimetype" : {
            "minLength" : 1,
            "type" : "string",
            "description" : "MIME type",
            "example" : "application/pdf"
          },
          "sha256hash" : {
            "minLength" : 1,
            "type" : "string",
            "description" : "SHA-256 hash av filens innhold",
            "example" : "82275bb0c47c7e5fe81e3f58242d44e3ca2f5ea438cea0013d9bfdeec736c910"
          },
          "dokumentType" : {
            "type" : "string",
            "description" : "Fritekst for å beskrive dokumentets type, f.eks. Noark dokumenttype",
            "example" : "B"
          },
          "size" : {
            "type" : "integer",
            "description" : "Filens størrelse, eller 0 om den ikke er satt",
            "format" : "int64",
            "example" : 15324
          },
          "ekstraMetadata" : {
            "type" : "array",
            "description" : "Ekstra metadata for filen definert av avsender",
            "items" : {
              "$ref" : "#/components/schemas/Entry"
            }
          }
        },
        "description" : "Metadata for filene i forsendelsen"
      },
      "Forsendelse" : {
        "required" : [ "downloadUrl", "filmetadata", "id", "mottaker", "niva", "status", "tittel" ],
        "type" : "object",
        "properties" : {
          "avsender" : {
            "$ref" : "#/components/schemas/Avsender"
          },
          "mottaker" : {
            "$ref" : "#/components/schemas/Mottaker"
          },
          "id" : {
            "type" : "string",
            "description" : "Forsendelsens unike id. UUID.",
            "example" : "f11f5cba-68ad-422f-ad2c-922cd6060f46"
          },
          "tittel" : {
            "minLength" : 1,
            "type" : "string",
            "description" : "Tittel på forsendelsen",
            "example" : "Søknad om skjenkebevilling"
          },
          "date" : {
            "type" : "integer",
            "description" : "Tidspunkt når forsendelsen ble mottatt av SvarUt. Millisekunder etter epoch.",
            "format" : "int64",
            "example" : 1694782865669
          },
          "metadataFraAvleverendeSystem" : {
            "$ref" : "#/components/schemas/NoarkMetadataFraAvleverendeSakssystem"
          },
          "metadataForImport" : {
            "$ref" : "#/components/schemas/NoarkMetadataForImport"
          },
          "status" : {
            "type" : "string",
            "description" : "Forsendelsens nåværende status",
            "example" : "Klar for mottak"
          },
          "niva" : {
            "type" : "string",
            "description" : "Sikkerhetsnivå for forsendelsen. 3 eller 4.",
            "example" : "4"
          },
          "filmetadata" : {
            "type" : "array",
            "description" : "Metadata for filene i forsendelsen",
            "items" : {
              "$ref" : "#/components/schemas/FilMetadata"
            }
          },
          "svarSendesTil" : {
            "$ref" : "#/components/schemas/SvarSendesTil"
          },
          "svarPaForsendelse" : {
            "type" : "string",
            "description" : "Id for forsendelse som denne forsendelsen er et svar på. UUID.",
            "example" : "aff355c4-7b57-4eb9-81e0-e4950e7a3776"
          },
          "forsendelseType" : {
            "type" : "string",
            "description" : "Type satt på forsendelsen",
            "example" : "Innkommende dokument"
          },
          "eksternRef" : {
            "type" : "string",
            "description" : "Ekstern referanse satt på forsendelsen",
            "example" : "AB123"
          },
          "korrelasjonsid" : {
            "type" : "string",
            "description" : "Identifikator som kan benyttes til å knytte flere forsendelser sammen",
            "example" : "264146aa-1307-42ed-be91-0996c116698e"
          },
          "lenker" : {
            "type" : "array",
            "description" : "Lenker som er lagt ved forsendelsen",
            "items" : {
              "$ref" : "#/components/schemas/Lenke"
            }
          },
          "downloadUrl" : {
            "type" : "string",
            "description" : "Lenke for å laste ned forsendelsens filer",
            "example" : "https://svarut.ks.no/tjenester/svarinn/forsendelse/b2cb3edf-7200-4478-a2ad-78dda61651c0"
          },
          "avgivendeSystem" : {
            "type" : "string",
            "description" : "Navn på systemet som sendte forsendelsen",
            "example" : "EDIALOG"
          },
          "avgivendeSystemAktor" : {
            "type" : "string",
            "description" : "Aktør som startet utsending av forsendelsen i avgivende system."
          },
          "taushetsbelagtPost" : {
            "type" : "boolean",
            "description" : "Er forsendelsen markert som taushetsbelagt?",
            "example" : true
          }
        }
      },
      "Lenke" : {
        "required" : [ "urlLenke", "urlTekst" ],
        "type" : "object",
        "properties" : {
          "ledetekst" : {
            "type" : "string",
            "description" : "Tekst som kommer før lenken",
            "example" : "Trykk på lenken for mer informasjon"
          },
          "urlLenke" : {
            "minLength" : 1,
            "type" : "string",
            "description" : "URL som lenken peker til",
            "example" : "https://svarut.ks.no/"
          },
          "urlTekst" : {
            "minLength" : 1,
            "type" : "string",
            "description" : "Teksten som kan trykkes på i lenken",
            "example" : "SvarUt"
          }
        },
        "description" : "Lenker tilknyttet forsendelsen"
      },
      "Mottaker" : {
        "required" : [ "navn" ],
        "type" : "object",
        "properties" : {
          "adresse1" : {
            "type" : "string",
            "description" : "Første adresselinje",
            "example" : "Storevik kommune"
          },
          "adresse2" : {
            "type" : "string",
            "description" : "Andre adresselinje",
            "example" : "Helseetaten"
          },
          "adresse3" : {
            "type" : "string",
            "description" : "Tredje adresselinje",
            "example" : "Postboks 55"
          },
          "postnr" : {
            "type" : "string",
            "description" : "Postnummer",
            "example" : "0000"
          },
          "poststed" : {
            "type" : "string",
            "description" : "Poststed",
            "example" : "Storevik"
          },
          "navn" : {
            "minLength" : 1,
            "type" : "string",
            "description" : "Navn",
            "example" : "Ola Nordmann"
          },
          "land" : {
            "type" : "string",
            "description" : "Land",
            "example" : "Norge"
          },
          "orgnr" : {
            "type" : "string",
            "description" : "Organisasjonsnummer",
            "example" : "123456789"
          }
        },
        "description" : "Mottaker av forsendelsen"
      },
      "NoarkMetadataForImport" : {
        "type" : "object",
        "properties" : {
          "sakssekvensnummer" : {
            "type" : "integer",
            "description" : "Viser rekkefølgen når saksmappen ble opprettet innenfor året",
            "format" : "int64",
            "example" : 648677
          },
          "saksaar" : {
            "type" : "integer",
            "description" : "Viser året saksmappen ble opprettet",
            "format" : "int32",
            "example" : 2005
          },
          "journalposttype" : {
            "type" : "string",
            "description" : "Navn på type journalpost",
            "example" : "I"
          },
          "journalstatus" : {
            "type" : "string",
            "description" : "Status til journalposten, dvs. om dokumentet er registrert, under behandling eller endelig arkivert",
            "example" : "J"
          },
          "dokumentetsDato" : {
            "type" : "integer",
            "description" : "Dato som er påført selve dokumentet. Millisekunder etter epoch.",
            "format" : "int64",
            "example" : 1104879600000
          },
          "tittel" : {
            "type" : "string",
            "description" : "Tittel eller navn på arkivenheten",
            "example" : "Gjennomføringsplan"
          }
        },
        "description" : "Noark 5-metadata som stemmer med mottakende system. Kan brukes til å legge dokumentet på rett sak."
      },
      "NoarkMetadataFraAvleverendeSakssystem" : {
        "type" : "object",
        "properties" : {
          "sakssekvensnummer" : {
            "type" : "integer",
            "description" : "Viser rekkefølgen når saksmappen ble opprettet innenfor året",
            "format" : "int64",
            "example" : 1234
          },
          "saksaar" : {
            "type" : "integer",
            "description" : "Viser året saksmappen ble opprettet",
            "format" : "int32",
            "example" : 2020
          },
          "journalaar" : {
            "type" : "integer",
            "description" : "Viser året journalposten ble opprettet",
            "format" : "int64",
            "example" : 2023
          },
          "journalsekvensnummer" : {
            "type" : "integer",
            "description" : "Viser rekkefølgen når journalposten ble opprettet under året",
            "format" : "int64",
            "example" : 23456
          },
          "journalpostnummer" : {
            "type" : "integer",
            "description" : "Viser rekkefølgen journalpostene ble opprettet innenfor saksmappen",
            "format" : "int64",
            "example" : 15
          },
          "journalposttype" : {
            "type" : "string",
            "description" : "Navn på type journalpost",
            "example" : "U"
          },
          "journalstatus" : {
            "type" : "string",
            "description" : "Status til journalposten, dvs. om dokumentet er registrert, under behandling eller endelig arkivert",
            "example" : "A"
          },
          "journaldato" : {
            "type" : "integer",
            "description" : "Datoen journalposten er opprettet/arkivert. Millisekunder etter epoch.",
            "format" : "int64",
            "example" : 1694781172651
          },
          "dokumentetsDato" : {
            "type" : "integer",
            "description" : "Dato som er påført selve dokumentet. Millisekunder etter epoch.",
            "format" : "int64",
            "example" : 1694642400000
          },
          "tittel" : {
            "type" : "string",
            "description" : "Tittel eller navn på arkivenheten",
            "example" : "Søknad om støtte"
          },
          "saksBehandler" : {
            "type" : "string",
            "description" : "Navn på person som er saksbehandler",
            "example" : "Kari Nordmann"
          },
          "ekstraMetadata" : {
            "type" : "array",
            "description" : "Ekstra metadata for forsendelsen definert av avsender",
            "items" : {
              "$ref" : "#/components/schemas/Entry"
            }
          }
        },
        "description" : "Noark 5-metadata fra avleverende system"
      },
      "SvarSendesTil" : {
        "required" : [ "navn" ],
        "type" : "object",
        "properties" : {
          "adresse1" : {
            "type" : "string",
            "description" : "Første adresselinje",
            "example" : "Digitaliseringsetaten"
          },
          "adresse2" : {
            "type" : "string",
            "description" : "Andre adresselinje",
            "example" : "Utviklingsavdelingen"
          },
          "adresse3" : {
            "type" : "string",
            "description" : "Tredje adresselinje",
            "example" : "Postboks 123"
          },
          "postnr" : {
            "type" : "string",
            "description" : "Postnummer",
            "example" : "0000"
          },
          "poststed" : {
            "type" : "string",
            "description" : "Poststed",
            "example" : "Storevik"
          },
          "navn" : {
            "minLength" : 1,
            "type" : "string",
            "description" : "Navn",
            "example" : "Storevik kommune"
          },
          "land" : {
            "type" : "string",
            "description" : "Land",
            "example" : "Norge"
          },
          "orgnr" : {
            "type" : "string",
            "description" : "Organisasjonsnummer, vil ikke være satt samtidig som fnr",
            "example" : "123456789"
          },
          "fnr" : {
            "type" : "string",
            "description" : "Fødselsnummer, vil ikke være satt samtidig som orgnr",
            "example" : "12345678910"
          }
        },
        "description" : "Adresse som svar på forsendelsen kan sendes til"
      },
      "ImportFeil" : {
        "required" : [ "feilmelding", "permanent" ],
        "type" : "object",
        "properties" : {
          "feilmelding" : {
            "minLength" : 1,
            "type" : "string",
            "description" : "En menneskelig lesbar feilmelding"
          },
          "permanent" : {
            "type" : "boolean",
            "description" : "En feil kan være permanent eller midlertidig. Dersom forsendelsen markeres som feilet permanent blir den sendt videre via en annen kanal. Ved en midlertidig feil vil feilmeldingen dukke opp i hendelsesloggen for forsendelsen, men den vil fortsatt ligge klar til nedlasting i SvarInn."
          }
        },
        "description" : "Request body for å markere at mottak av forsendelse feilet"
      }
    }
  }
}