API-dokumentasjon | Notifikasjoner for arbeidsgivere

API-dokumentasjon

Interaktiv demo av API er tilgjengelig på ekstern.dev.nav.no. Hvis du kjører en spørring i den interaktive demoen, så sendes et ekte nettverkskall. Du kan derfor bruke developer-tools for å se hvordan JSON-et til forespørselen og svaret ser ut.

Autentisering

Tjenesten deres må autentisere seg med Azure AD, type server–server, som beskrevet i nais-dokumentasjonen.

Endepunkter for miljøer

miljø url
mock https://notifikasjon-fake-produsent-api.ekstern.dev.nav.no/api/graphql
dev fra gcp: https://ag-notifikasjon-produsent-api.intern.dev.nav.no/api/graphql fra fss: https://ag-notifikasjon-produsent-api.dev.intern.nav.no/api/graphql
prod https://ag-notifikasjon-produsent-api.intern.nav.no/api/graphql
service dicovery (gcp) http://notifikasjon-produsent-api.fager/api/graphql
Vi anbefaler bruk av service discovery som beskrevet i nais dokumentasjonen.

GraphQL over HTTP

Vi implementerer GraphQL over HTTP (kun POST, ikke GET) og JSON, basert på de offisielle anbefalingene: https://graphql.org/learn/serving-over-http/.

⚠️ GraphQL returnerer alltid en "well-formed" HTTP 200 OK. Dersom det er en eller flere valideringsfeil eller noe annet ugyldig vil det returneres informasjon om dette i errors feltet i response body fra server.

Vi anbefaler at dere angir correlationId i kall dere gjør mot APIet. Dette vil lette arbeidet med feilsøking og oppfølging. Vi plukker verdien ut fra en av følgende headere:

  • X-Request-ID
  • X-Correlation-ID
  • call-id
  • callId
  • call_id

Med dette angitt kan dere søke i kibana etter x_correlation_id.

Queries

hentNotifikasjon

Response

Returns a HentNotifikasjonResultat!

Arguments
Name Description
id - ID!

Example

Query
query hentNotifikasjon($id: ID!) {
  hentNotifikasjon(id: $id) {
    ... on HentetNotifikasjon {
      notifikasjon {
        ... on Beskjed {
          ...BeskjedFragment
        }
        ... on Oppgave {
          ...OppgaveFragment
        }
        ... on Kalenderavtale {
          ...KalenderavtaleFragment
        }
      }
    }
    ... on UkjentProdusent {
      feilmelding
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
  }
}
Variables
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Response
{"data": {"hentNotifikasjon": HentetNotifikasjon}}
Queries

hentSak

Response

Returns a HentSakResultat!

Arguments
Name Description
id - ID!

Example

Query
query hentSak($id: ID!) {
  hentSak(id: $id) {
    ... on HentetSak {
      sak {
        id
        grupperingsid
        virksomhetsnummer
        tittel
        lenke
        nesteSteg
        tilleggsinformasjon
        merkelapp
        sisteStatus
      }
    }
    ... on SakFinnesIkke {
      feilmelding
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Response
{"data": {"hentSak": HentetSak}}
Queries

hentSakMedGrupperingsid

Response

Returns a HentSakResultat!

Arguments
Name Description
grupperingsid - String!
merkelapp - String!

Example

Query
query hentSakMedGrupperingsid(
  $grupperingsid: String!,
  $merkelapp: String!
) {
  hentSakMedGrupperingsid(
    grupperingsid: $grupperingsid,
    merkelapp: $merkelapp
  ) {
    ... on HentetSak {
      sak {
        id
        grupperingsid
        virksomhetsnummer
        tittel
        lenke
        nesteSteg
        tilleggsinformasjon
        merkelapp
        sisteStatus
      }
    }
    ... on SakFinnesIkke {
      feilmelding
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{"grupperingsid": "0450c24f-89ca-4c78-a70c-c43af85df48c", "merkelapp": "Tiltak"}
Response
{"data": {"hentSakMedGrupperingsid": HentetSak}}
Queries

mineNotifikasjoner

Description

Vi bruker det Connections-patternet for paginering. Se Connection-standaren for mer informasjon.

Dere må gjenta paremetere når dere blar gjennom alle notifikasjonen.

Hvis verken merkelapp eller merkelapper er gitt, vil notifikasjoner med alle dine merkelapper være med.

Response

Returns a MineNotifikasjonerResultat!

Arguments
Name Description
first - Int antall notifikasjoner du ønsker å hente
after - String Cursor til notifikasjonen du henter fra. Cursor får du fra NotifikasjonEdge.
merkelapp - String Filtrer på merkelapp. Kan ikke brukes sammen med merkelapper.
merkelapper - [String!] Filtrer på merkelapper. Kan ikke brukes sammen med merkelapp.
grupperingsid - String

Example

Query
query mineNotifikasjoner(
  $first: Int,
  $after: String,
  $merkelapp: String,
  $merkelapper: [String!],
  $grupperingsid: String
) {
  mineNotifikasjoner(
    first: $first,
    after: $after,
    merkelapp: $merkelapp,
    merkelapper: $merkelapper,
    grupperingsid: $grupperingsid
  ) {
    ... on NotifikasjonConnection {
      edges {
        node {
          ... on Beskjed {
            ...BeskjedFragment
          }
          ... on Oppgave {
            ...OppgaveFragment
          }
          ... on Kalenderavtale {
            ...KalenderavtaleFragment
          }
        }
        cursor
      }
      pageInfo {
        hasNextPage
        endCursor
      }
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "first": 123,
  "after": "NzE0ODAzNzgtYzBiMi00ZjM1LWI3YzYtZGM3OTJmYTA5Nzdl",
  "merkelapp": "Oppfølging",
  "merkelapper": [],
  "grupperingsid": "7b1616ad-c56d-4817-a8d8-45fa3081bbf9"
}
Response
{"data": {"mineNotifikasjoner": NotifikasjonConnection}}
Queries

whoami

Description

Egnet for feilsøking. Forteller hvem du er autentisert som.

Response

Returns a String

Example

Query
query whoami {
  whoami
}
Response
{"data": {"whoami": "abc123"}}

Mutations

hardDeleteNotifikasjon

Description

Sletter en notifikasjon og tilhørende data helt fra databasen og kafka. Formålet er å støtte juridiske krav om sletting i henhold til personvern.

Eventuelle eksterne varsler (SMS, e-post) knyttet til notifikasjonen vil bli fortsatt bli sendt.

Advarsel: det er ikke mulig å angre på denne operasjonen. All data blir borte for godt.

Response

Returns a HardDeleteNotifikasjonResultat!

Arguments
Name Description
id - ID! ID-en som notifikasjolnen har. Den du fikk da du opprettet notifikasjonen.

Example

Query
mutation hardDeleteNotifikasjon($id: ID!) {
  hardDeleteNotifikasjon(id: $id) {
    ... on HardDeleteNotifikasjonVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Response
{
  "data": {
    "hardDeleteNotifikasjon": HardDeleteNotifikasjonVellykket
  }
}
Mutations

hardDeleteNotifikasjonByEksternId

Using the type ID for eksternId can lead to unexpected behaviour. Use hardDeleteNotifikasjonByEksternId_V2 instead.
Description

Se dokumentasjon for hardDeleteNotifikasjon(id).

Response

Returns a HardDeleteNotifikasjonResultat!

Arguments
Name Description
merkelapp - String! Merkelappen som dere ga oss da dere opprettet notifikasjonen.
eksternId - ID! ID-en som dere ga oss da dere opprettet notifikasjonen.

Example

Query
mutation hardDeleteNotifikasjonByEksternId(
  $merkelapp: String!,
  $eksternId: ID!
) {
  hardDeleteNotifikasjonByEksternId(
    merkelapp: $merkelapp,
    eksternId: $eksternId
  ) {
    ... on HardDeleteNotifikasjonVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "merkelapp": "Fritak arbeidsgiverperiode",
  "eksternId": "164fdd33-71df-4074-9da8-99fd9f6f42a1"
}
Response
{
  "data": {
    "hardDeleteNotifikasjonByEksternId": HardDeleteNotifikasjonVellykket
  }
}
Mutations

hardDeleteNotifikasjonByEksternId_V2

Description

Se dokumentasjon for hardDeleteNotifikasjon(id).

Response

Returns a HardDeleteNotifikasjonResultat!

Arguments
Name Description
merkelapp - String! Merkelappen som dere ga oss da dere opprettet notifikasjonen.
eksternId - String! ID-en som dere ga oss da dere opprettet notifikasjonen.

Example

Query
mutation hardDeleteNotifikasjonByEksternId_V2(
  $merkelapp: String!,
  $eksternId: String!
) {
  hardDeleteNotifikasjonByEksternId_V2(
    merkelapp: $merkelapp,
    eksternId: $eksternId
  ) {
    ... on HardDeleteNotifikasjonVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "merkelapp": "Inntektsmelding",
  "eksternId": "b788ed02-5847-4ca4-9874-0e8ece26d9f4"
}
Response
{
  "data": {
    "hardDeleteNotifikasjonByEksternId_V2": HardDeleteNotifikasjonVellykket
  }
}
Mutations

hardDeleteSak

Description

Sletter en sak og tilhørende data helt fra databasen og kafka. Formålet er å støtte juridiske krav om sletting i henhold til personvern.

Advarsel: det er ikke mulig å angre på denne operasjonen. All data blir borte for godt. Advarsel: notifikasjoner med samme merkelapp og grupperingsid blir slettet. Advarsel: Det vil ikke være mulig å lage en ny sak med samme merkelapp og grupperingsid.

Response

Returns a HardDeleteSakResultat!

Arguments
Name Description
id - ID!

Example

Query
mutation hardDeleteSak($id: ID!) {
  hardDeleteSak(id: $id) {
    ... on HardDeleteSakVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on SakFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Response
{"data": {"hardDeleteSak": HardDeleteSakVellykket}}
Mutations

hardDeleteSakByGrupperingsid

Description

Se dokumentasjon for hardDeleteSak(id).

Response

Returns a HardDeleteSakResultat!

Arguments
Name Description
merkelapp - String! Merkelappen som dere ga oss da dere opprettet saken.
grupperingsid - String! ID-en som dere ga oss da dere opprettet saken.

Example

Query
mutation hardDeleteSakByGrupperingsid(
  $merkelapp: String!,
  $grupperingsid: String!
) {
  hardDeleteSakByGrupperingsid(
    merkelapp: $merkelapp,
    grupperingsid: $grupperingsid
  ) {
    ... on HardDeleteSakVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on SakFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "merkelapp": "Innskrenking av arbeidstid",
  "grupperingsid": "40bcb585-9f7e-41c9-9ca0-d08bc4190010"
}
Response
{
  "data": {
    "hardDeleteSakByGrupperingsid": HardDeleteSakVellykket
  }
}
Mutations

nesteStegSak

Response

Returns a NesteStegSakResultat!

Arguments
Name Description
idempotencyKey - String
id - ID!
nesteSteg - String Dette feltet er frivillig. Her har dere mulighet til å vise virksomheten hva som er neste steg i saken. F.eks. "Saksbehandlignstiden er lang. Du kan forvente refusjon utbetalt i januar 2025." Dette vises i tidslinjen som en fremtidig handling i saken, over siste oppgave, beskjed eller kalenderavtale. Her kan dere oppgi verdien null for å fjerne neste steg.

Example

Query
mutation nesteStegSak(
  $idempotencyKey: String,
  $id: ID!,
  $nesteSteg: String
) {
  nesteStegSak(
    idempotencyKey: $idempotencyKey,
    id: $id,
    nesteSteg: $nesteSteg
  ) {
    ... on NesteStegSakVellykket {
      id
    }
    ... on SakFinnesIkke {
      feilmelding
    }
    ... on Konflikt {
      feilmelding
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "idempotencyKey": "xyz789",
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "nesteSteg": "xyz789"
}
Response
{"data": {"nesteStegSak": NesteStegSakVellykket}}
Mutations

nesteStegSakByGrupperingsid

Response

Returns a NesteStegSakResultat!

Arguments
Name Description
idempotencyKey - String
grupperingsid - String!
merkelapp - String!
nesteSteg - String Dette feltet er frivillig. Her har dere mulighet til å vise virksomheten hva som er neste steg i saken. F.eks. "Saksbehandlignstiden er lang. Du kan forvente refusjon utbetalt i januar 2025." Dette vises i tidslinjen som en fremtidig handling i saken, over siste oppgave, beskjed eller kalenderavtale. Her kan dere oppgi verdien null for å fjerne neste steg.

Example

Query
mutation nesteStegSakByGrupperingsid(
  $idempotencyKey: String,
  $grupperingsid: String!,
  $merkelapp: String!,
  $nesteSteg: String
) {
  nesteStegSakByGrupperingsid(
    idempotencyKey: $idempotencyKey,
    grupperingsid: $grupperingsid,
    merkelapp: $merkelapp,
    nesteSteg: $nesteSteg
  ) {
    ... on NesteStegSakVellykket {
      id
    }
    ... on SakFinnesIkke {
      feilmelding
    }
    ... on Konflikt {
      feilmelding
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "idempotencyKey": "xyz789",
  "grupperingsid": "a01361ee-0ef6-461d-ab72-cd725bff54b7",
  "merkelapp": "Inkluderingstilskudd",
  "nesteSteg": "abc123"
}
Response
{
  "data": {
    "nesteStegSakByGrupperingsid": NesteStegSakVellykket
  }
}
Mutations

nyBeskjed

Description

Opprett en ny beskjed.

Response

Returns a NyBeskjedResultat!

Arguments
Name Description
nyBeskjed - NyBeskjedInput!

Example

Query
mutation nyBeskjed($nyBeskjed: NyBeskjedInput!) {
  nyBeskjed(nyBeskjed: $nyBeskjed) {
    ... on NyBeskjedVellykket {
      id
      eksterneVarsler {
        id
      }
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UgyldigMottaker {
      feilmelding
    }
    ... on DuplikatEksternIdOgMerkelapp {
      feilmelding
      idTilEksisterende
    }
    ... on UkjentProdusent {
      feilmelding
    }
    ... on UkjentRolle {
      feilmelding
    }
  }
}
Variables
{"nyBeskjed": NyBeskjedInput}
Response
{"data": {"nyBeskjed": NyBeskjedVellykket}}
Mutations

nyKalenderavtale

Response

Returns a NyKalenderavtaleResultat!

Arguments
Name Description
virksomhetsnummer - String! Hvilken virksomhet som skal motta kalenderavtalen.
grupperingsid - String!

Grupperings-id-en knytter denne kalenderavtalen til en sak med samme grupperings-id og merkelapp. Det vises ikke til brukere. Saksnummer er en naturlig grupperings-id.

Når dere bruker grupperings-id, så er det mulig for oss å presentere en tidslinje med alle notifikasjonene og status-oppdateringer knyttet til en sak.
merkelapp - String!

Merkelapp for kalenderavtalen. Er typisk navnet på ytelse eller lignende. Den vises ikke til brukeren, men brukes i kombinasjon med grupperingsid for å koble kalenderavtalen til sak.

Hva du kan oppgi som merkelapp er bestemt av produsent-registeret.
eksternId - String!

Den eksterne id-en brukes for å unikt identifisere en notifikasjon. Den må være unik for merkelappen.

Hvis dere har en enkel, statisk bruk av notifikasjoner, så kan dere utlede eksternId fra f.eks. et saksnummer, og på den måten kunne referere til notifikasjoner dere har opprettet, uten at dere må lagre ID-ene vi genererer og returnerer til dere.
tekst - String! Teksten som vises til brukeren.
lenke - String! Lenken som brukeren føres til hvis de klikker på kalenderavtalen. Typisk en side i deres system som viser detaljer om avtalen.
mottakere - [MottakerInput!]! Her bestemmer dere hvem som skal få se kalenderavtalen.
startTidspunkt - ISO8601LocalDateTime! Når avtalen starter.
sluttTidspunkt - ISO8601LocalDateTime Når avtalen slutter.
lokasjon - LokasjonInput Her kan dere oppgi en fysisk adresse som brukeren kan møte opp på dersom dere har det. Denne vil vises til brukeren hvis den er angitt.
erDigitalt - Boolean Ved å sette dette flagget kan dere vise brukeren at det er mulig å møte digitalt. Det vil vises til brukeren hvis det er satt til true.
tilstand - KalenderavtaleTilstand Tilstanden til avtalen. Default er VENTER_SVAR_FRA_ARBEIDSGIVER. Denne vises til brukeren.
eksterneVarsler - [EksterntVarselInput!]! Default = []
paaminnelse - PaaminnelseInput Her kan du spesifisere en påminnelse for kalenderavtalen. Brukeren vil bli gjort oppmerksom via bjellen og evt ekstern varsling dersom du oppgir det.
hardDelete - FutureTemporalInput Oppgi dersom dere ønsker at hard delete skal skeduleres. Vi tolker relative datoer basert på når vi mottok kallet.

Example

Query
mutation nyKalenderavtale(
  $virksomhetsnummer: String!,
  $grupperingsid: String!,
  $merkelapp: String!,
  $eksternId: String!,
  $tekst: String!,
  $lenke: String!,
  $mottakere: [MottakerInput!]!,
  $startTidspunkt: ISO8601LocalDateTime!,
  $sluttTidspunkt: ISO8601LocalDateTime,
  $lokasjon: LokasjonInput,
  $erDigitalt: Boolean,
  $tilstand: KalenderavtaleTilstand,
  $eksterneVarsler: [EksterntVarselInput!]!,
  $paaminnelse: PaaminnelseInput,
  $hardDelete: FutureTemporalInput
) {
  nyKalenderavtale(
    virksomhetsnummer: $virksomhetsnummer,
    grupperingsid: $grupperingsid,
    merkelapp: $merkelapp,
    eksternId: $eksternId,
    tekst: $tekst,
    lenke: $lenke,
    mottakere: $mottakere,
    startTidspunkt: $startTidspunkt,
    sluttTidspunkt: $sluttTidspunkt,
    lokasjon: $lokasjon,
    erDigitalt: $erDigitalt,
    tilstand: $tilstand,
    eksterneVarsler: $eksterneVarsler,
    paaminnelse: $paaminnelse,
    hardDelete: $hardDelete
  ) {
    ... on NyKalenderavtaleVellykket {
      id
      eksterneVarsler {
        id
      }
      paaminnelse {
        eksterneVarsler {
          ...NyEksterntVarselResultatFragment
        }
      }
    }
    ... on UgyldigKalenderavtale {
      feilmelding
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UgyldigMottaker {
      feilmelding
    }
    ... on DuplikatEksternIdOgMerkelapp {
      feilmelding
      idTilEksisterende
    }
    ... on UkjentProdusent {
      feilmelding
    }
    ... on SakFinnesIkke {
      feilmelding
    }
  }
}
Variables
{
  "virksomhetsnummer": "148587333",
  "grupperingsid": "e31dc24f-0ae8-404a-8ac8-32110d0ab039",
  "merkelapp": "Lønnstilskudd",
  "eksternId": "80d082cf-073c-4597-8720-9c24fd63f6be",
  "tekst": "abc123",
  "lenke": "abc123",
  "mottakere": [MottakerInput],
  "startTidspunkt": ISO8601LocalDateTime,
  "sluttTidspunkt": ISO8601LocalDateTime,
  "lokasjon": LokasjonInput,
  "erDigitalt": true,
  "tilstand": "VENTER_SVAR_FRA_ARBEIDSGIVER",
  "eksterneVarsler": [""],
  "paaminnelse": PaaminnelseInput,
  "hardDelete": FutureTemporalInput
}
Response
{"data": {"nyKalenderavtale": NyKalenderavtaleVellykket}}
Mutations

nyOppgave

Description

Opprett en ny oppgave.

Response

Returns a NyOppgaveResultat!

Arguments
Name Description
nyOppgave - NyOppgaveInput!

Example

Query
mutation nyOppgave($nyOppgave: NyOppgaveInput!) {
  nyOppgave(nyOppgave: $nyOppgave) {
    ... on NyOppgaveVellykket {
      id
      eksterneVarsler {
        id
      }
      paaminnelse {
        eksterneVarsler {
          ...NyEksterntVarselResultatFragment
        }
      }
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UgyldigMottaker {
      feilmelding
    }
    ... on DuplikatEksternIdOgMerkelapp {
      feilmelding
      idTilEksisterende
    }
    ... on UkjentProdusent {
      feilmelding
    }
    ... on UkjentRolle {
      feilmelding
    }
    ... on UgyldigPaaminnelseTidspunkt {
      feilmelding
    }
  }
}
Variables
{"nyOppgave": NyOppgaveInput}
Response
{"data": {"nyOppgave": NyOppgaveVellykket}}
Mutations

nySak

Response

Returns a NySakResultat!

Arguments
Name Description
grupperingsid - String! Grupperings-id-en knytter en sak og notifikasjoner sammen. Den skal være unik for saker innenfor merkelappen. Et naturlig valg av grupperingsid er f.eks. et saksnummer.
merkelapp - String! Merkelapp som saken skal assossieres med.
virksomhetsnummer - String! Virksomhetsnummeret til virksomheten som saken omhandler.
mottakere - [MottakerInput!]!

Hvem som skal få se saken.

NB. At en bruker har tilgang til en sak påvirker ikke om de har tilgang til en notifikasjon. De tilgangsstyres hver for seg.
tittel - String! En tittel på saken, som vises til brukeren.
tilleggsinformasjon - String Dette feltet er frivillig. Tilleggssinformasjon som vises under tittelen på en sak. Feltet er begrenset til 140 tegn og kan ikke inneholde fødselsnummer.
lenke - String Her oppgir dere en lenke som brukeren kan klikke på for å komme rett til saken. Dersom lenken ikke oppgis vil saken lenke til en enkel visning av saken i Min side - Arbeidsgiver.
initiellStatus - SaksStatus!
nesteSteg - String Dette feltet er frivillig. Her har dere mulighet til å vise virksomheten hva som er neste steg i saken. F.eks. "Saksbehandlignstiden er lang. Du kan forvente refusjon utbetalt i januar 2025." Dette vises i tidslinjen som en fremtidig handling i saken, over siste oppgave, beskjed eller kalenderavtale.
tidspunkt - ISO8601DateTime Når endringen skjedde. Det kan godt være i fortiden. Dette feltet er frivillig. Hvis feltet ikke er oppgitt, bruker vi tidspunktet dere gjør kallet på.
overstyrStatustekstMed - String Dette feltet er frivillig. Det lar deg overstyre hvilken tekst vi viser til brukeren. Se SaksStatus for default tekster.
hardDelete - FutureTemporalInput Oppgi dersom dere ønsker at hard delete skal skeduleres. Vi tolker relative datoer basert på opprettetTidspunkt (eller når vi mottok kallet hvis dere ikke har oppgitt opprettetTidspunkt).

Example

Query
mutation nySak(
  $grupperingsid: String!,
  $merkelapp: String!,
  $virksomhetsnummer: String!,
  $mottakere: [MottakerInput!]!,
  $tittel: String!,
  $tilleggsinformasjon: String,
  $lenke: String,
  $initiellStatus: SaksStatus!,
  $nesteSteg: String,
  $tidspunkt: ISO8601DateTime,
  $overstyrStatustekstMed: String,
  $hardDelete: FutureTemporalInput
) {
  nySak(
    grupperingsid: $grupperingsid,
    merkelapp: $merkelapp,
    virksomhetsnummer: $virksomhetsnummer,
    mottakere: $mottakere,
    tittel: $tittel,
    tilleggsinformasjon: $tilleggsinformasjon,
    lenke: $lenke,
    initiellStatus: $initiellStatus,
    nesteSteg: $nesteSteg,
    tidspunkt: $tidspunkt,
    overstyrStatustekstMed: $overstyrStatustekstMed,
    hardDelete: $hardDelete
  ) {
    ... on NySakVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UgyldigMottaker {
      feilmelding
    }
    ... on DuplikatGrupperingsid {
      feilmelding
      idTilEksisterende
    }
    ... on DuplikatGrupperingsidEtterDelete {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
    ... on UkjentRolle {
      feilmelding
    }
  }
}
Variables
{
  "grupperingsid": "d2f17f1b-6da6-459f-95c0-0bb998bdd346",
  "merkelapp": "Tiltak",
  "virksomhetsnummer": "567565666",
  "mottakere": [MottakerInput],
  "tittel": "xyz789",
  "tilleggsinformasjon": "xyz789",
  "lenke": "xyz789",
  "initiellStatus": "MOTTATT",
  "nesteSteg": "abc123",
  "tidspunkt": ISO8601DateTime,
  "overstyrStatustekstMed": "abc123",
  "hardDelete": FutureTemporalInput
}
Response
{"data": {"nySak": NySakVellykket}}
Mutations

nyStatusSak

Response

Returns a NyStatusSakResultat!

Arguments
Name Description
idempotencyKey - String
id - ID!
nyStatus - SaksStatus!
tidspunkt - ISO8601DateTime Når endringen skjedde. Det kan godt være i fortiden. Dette feltet er frivillig. Hvis feltet ikke er oppgitt, bruker vi tidspunktet dere gjør kallet på.
overstyrStatustekstMed - String Dette feltet er frivillig. Det lar deg overstyre hvilken tekst vi viser til brukeren. Se SaksStatus for default tekster.
hardDelete - HardDeleteUpdateInput Se: HardDeleteUpdateInput typen
nyLenkeTilSak - String Her kan dere endre lenken til saken. F.eks hvis saken har gått fra å være en søknad til en kvittering, så kan det være dere har behov for å endre url som brukeren sendes til. Dette feltet er frivillig; er det ikke oppgitt (eller er null), så forblir lenken knyttet til saken uendret.

Example

Query
mutation nyStatusSak(
  $idempotencyKey: String,
  $id: ID!,
  $nyStatus: SaksStatus!,
  $tidspunkt: ISO8601DateTime,
  $overstyrStatustekstMed: String,
  $hardDelete: HardDeleteUpdateInput,
  $nyLenkeTilSak: String
) {
  nyStatusSak(
    idempotencyKey: $idempotencyKey,
    id: $id,
    nyStatus: $nyStatus,
    tidspunkt: $tidspunkt,
    overstyrStatustekstMed: $overstyrStatustekstMed,
    hardDelete: $hardDelete,
    nyLenkeTilSak: $nyLenkeTilSak
  ) {
    ... on NyStatusSakVellykket {
      id
      statuser {
        status
        tidspunkt
        overstyrStatusTekstMed
      }
    }
    ... on SakFinnesIkke {
      feilmelding
    }
    ... on Konflikt {
      feilmelding
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "idempotencyKey": "xyz789",
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "nyStatus": "MOTTATT",
  "tidspunkt": ISO8601DateTime,
  "overstyrStatustekstMed": "xyz789",
  "hardDelete": HardDeleteUpdateInput,
  "nyLenkeTilSak": "abc123"
}
Response
{"data": {"nyStatusSak": NyStatusSakVellykket}}
Mutations

nyStatusSakByGrupperingsid

Response

Returns a NyStatusSakResultat!

Arguments
Name Description
idempotencyKey - String
grupperingsid - String!
merkelapp - String!
nyStatus - SaksStatus!
tidspunkt - ISO8601DateTime Når endringen skjedde. Det kan godt være i fortiden. Dette feltet er frivillig. Hvis feltet ikke er oppgitt, bruker vi tidspunktet dere gjør kallet på.
overstyrStatustekstMed - String Dette feltet er frivillig. Det lar deg overstyre hvilken tekst vi viser til brukeren. Se SaksStatus for default tekster.
hardDelete - HardDeleteUpdateInput Se: HardDeleteUpdateInput typen
nyLenkeTilSak - String Her kan dere endre lenken til saken. F.eks hvis saken har gått fra å være en søknad til en kvittering, så kan det være dere har behov for å endre url som brukeren sendes til. Dette feltet er frivillig; er det ikke oppgitt (eller er null), så forblir lenken knyttet til saken uendret.

Example

Query
mutation nyStatusSakByGrupperingsid(
  $idempotencyKey: String,
  $grupperingsid: String!,
  $merkelapp: String!,
  $nyStatus: SaksStatus!,
  $tidspunkt: ISO8601DateTime,
  $overstyrStatustekstMed: String,
  $hardDelete: HardDeleteUpdateInput,
  $nyLenkeTilSak: String
) {
  nyStatusSakByGrupperingsid(
    idempotencyKey: $idempotencyKey,
    grupperingsid: $grupperingsid,
    merkelapp: $merkelapp,
    nyStatus: $nyStatus,
    tidspunkt: $tidspunkt,
    overstyrStatustekstMed: $overstyrStatustekstMed,
    hardDelete: $hardDelete,
    nyLenkeTilSak: $nyLenkeTilSak
  ) {
    ... on NyStatusSakVellykket {
      id
      statuser {
        status
        tidspunkt
        overstyrStatusTekstMed
      }
    }
    ... on SakFinnesIkke {
      feilmelding
    }
    ... on Konflikt {
      feilmelding
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "idempotencyKey": "xyz789",
  "grupperingsid": "515ccffb-c16d-4516-a2db-08bbd57f0d33",
  "merkelapp": "Lønnstilskudd",
  "nyStatus": "MOTTATT",
  "tidspunkt": ISO8601DateTime,
  "overstyrStatustekstMed": "xyz789",
  "hardDelete": HardDeleteUpdateInput,
  "nyLenkeTilSak": "xyz789"
}
Response
{
  "data": {
    "nyStatusSakByGrupperingsid": NyStatusSakVellykket
  }
}
Mutations

oppdaterKalenderavtale

Description

Oppdater tilstand på en kalenderavtale. Det er ingen regler tilknyttet endring av tilstand. Dere bestemmer her hvilken tilstand avtalen skal ha. Den nye tilstanden vises til brukeren. Dette kallet er ment for å oppdatere tilstand samt gi brukeren mer utfyllende informasjon når det blir kjent. Dette kallet vil anses som vellyket uavhengig av om dataen faktisk er endret. Dvs hvis dere sender inn samme tilstand som allerede er satt, så vil kallet anses som vellykket. Dette gjelder også hvis dere gjør kallet uten å oppgi noen nye verdier.

Response

Returns an OppdaterKalenderavtaleResultat!

Arguments
Name Description
id - ID! ID-en som kalenderavtalen har. Den du fikk da du opprettet kalenderavtalen med nyKalenderavtale.
nyTilstand - KalenderavtaleTilstand Ny tilstand for kalenderavtalen. Dersom ny tilstand settes til AVLYST vil vi stoppe eksterne varslinger som ikke allerede er sendt, og kansellere registrerte påminnelser.
nyTekst - String Teksten som vises til brukeren.
nyLenke - String Lenken som brukeren føres til hvis de klikker på kalenderavtalen. Typisk en side i deres system som viser detaljer om avtalen.
nyLokasjon - LokasjonInput Her kan dere oppgi en fysisk adresse som brukeren kan møte opp på dersom dere har det. Denne vil vises til brukeren hvis den er angitt.
nyErDigitalt - Boolean Ved å sette dette flagget kan dere vise brukeren at det er mulig å møte digitalt. Det vil vises til brukeren hvis det er satt til true.
hardDelete - HardDeleteUpdateInput Se: HardDeleteUpdateInput typen
idempotencyKey - String Dersom dere angir idempotenceKey så vil konsekvente kall med samme idempotenceKey gi samme resultat. Dette kan f.eks være nyttig hvis dere har retry mekanismer i deres system.
eksterneVarsler - [EksterntVarselInput!]! Her kan dere oppgi eksterne varsler som skal sendes i forbindelse med oppdateringen. Disse varslene vil erstatte tidligere bestilte varsler som ikke er sendt enda. Vi anbefaler dere å bruke denne i kombinasjon med idempotencyKey for å unngå å sende samme varsel flere ganger. Default = []
paaminnelse - PaaminnelseInput Her kan du spesifisere en påminnelse for kalenderavtalen. Brukeren vil bli gjort oppmerksom via bjellen og evt ekstern varsling dersom du oppgir det. Dersom dere senere oppdaterer kalenderavtalen og setter den til AVLYST, vil vi kansellere registrerte påminnelser. Vi anbefaler dere å bruke denne i kombinasjon med idempotencyKey.

Example

Query
mutation oppdaterKalenderavtale(
  $id: ID!,
  $nyTilstand: KalenderavtaleTilstand,
  $nyTekst: String,
  $nyLenke: String,
  $nyLokasjon: LokasjonInput,
  $nyErDigitalt: Boolean,
  $hardDelete: HardDeleteUpdateInput,
  $idempotencyKey: String,
  $eksterneVarsler: [EksterntVarselInput!]!,
  $paaminnelse: PaaminnelseInput
) {
  oppdaterKalenderavtale(
    id: $id,
    nyTilstand: $nyTilstand,
    nyTekst: $nyTekst,
    nyLenke: $nyLenke,
    nyLokasjon: $nyLokasjon,
    nyErDigitalt: $nyErDigitalt,
    hardDelete: $hardDelete,
    idempotencyKey: $idempotencyKey,
    eksterneVarsler: $eksterneVarsler,
    paaminnelse: $paaminnelse
  ) {
    ... on OppdaterKalenderavtaleVellykket {
      id
    }
    ... on UgyldigKalenderavtale {
      feilmelding
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on Konflikt {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "nyTilstand": "VENTER_SVAR_FRA_ARBEIDSGIVER",
  "nyTekst": "abc123",
  "nyLenke": "abc123",
  "nyLokasjon": LokasjonInput,
  "nyErDigitalt": true,
  "hardDelete": HardDeleteUpdateInput,
  "idempotencyKey": "abc123",
  "eksterneVarsler": [""],
  "paaminnelse": PaaminnelseInput
}
Response
{
  "data": {
    "oppdaterKalenderavtale": OppdaterKalenderavtaleVellykket
  }
}
Mutations

oppdaterKalenderavtaleByEksternId

Description

Oppdater tilstand på en kalenderavtale (identifisert ved ekstern id). Det er ingen regler tilknyttet endring av tilstand. Dere bestemmer her hvilken tilstand avtalen skal ha. Den nye tilstanden vises til brukeren. Dette kallet er ment for å oppdatere tilstand samt gi brukeren mer utfyllende informasjon når det blir kjent. Dette kallet vil anses som vellyket uavhengig av om dataen faktisk er endret. Dvs hvis dere sender inn samme tilstand som allerede er satt, så vil kallet anses som vellykket. Dette gjelder også hvis dere gjør kallet uten å oppgi noen nye verdier.

Response

Returns an OppdaterKalenderavtaleResultat!

Arguments
Name Description
merkelapp - String! Merkelapp som kalenderavtalen er registrert med.
eksternId - String! ID-en som dere ga oss da dere opprettet kalenderavtalen med nyKalenderavtale.
nyTilstand - KalenderavtaleTilstand Ny tilstand for kalenderavtalen. Dersom ny tilstand settes til AVLYST vil vi stoppe eksterne varslinger som ikke allerede er sendt, og kansellere registrerte påminnelser.
nyTekst - String Teksten som vises til brukeren.
nyLenke - String Lenken som brukeren føres til hvis de klikker på kalenderavtalen. Typisk en side i deres system som viser detaljer om avtalen.
nyLokasjon - LokasjonInput Her kan dere oppgi en fysisk adresse som brukeren kan møte opp på dersom dere har det. Denne vil vises til brukeren hvis den er angitt.
nyErDigitalt - Boolean Ved å sette dette flagget kan dere vise brukeren at det er mulig å møte digitalt. Det vil vises til brukeren hvis det er satt til true.
hardDelete - HardDeleteUpdateInput Se: HardDeleteUpdateInput typen
idempotencyKey - String Dersom dere angir idempotenceKey så vil konsekvente kall med samme idempotenceKey gi samme resultat. Dette kan f.eks være nyttig hvis dere har retry mekanismer i deres system.
eksterneVarsler - [EksterntVarselInput!]! Her kan dere oppgi eksterne varsler som skal sendes i forbindelse med oppdateringen. Disse varslene vil erstatte tidligere bestilte varsler som ikke er sendt enda. Vi anbefaler dere å bruke denn i kombinasjon med idempoencyKey for å unngå å sende samme varsel flere ganger. Default = []
paaminnelse - PaaminnelseInput Her kan du spesifisere en påminnelse for kalenderavtalen. Brukeren vil bli gjort oppmerksom via bjellen og evt ekstern varsling dersom du oppgir det. Dersom dere senere oppdaterer kalenderavtalen og setter den til AVLYST, vil vi kansellere registrerte påminnelser. Vi anbefaler dere å bruke denne i kombinasjon med idempotencyKey.

Example

Query
mutation oppdaterKalenderavtaleByEksternId(
  $merkelapp: String!,
  $eksternId: String!,
  $nyTilstand: KalenderavtaleTilstand,
  $nyTekst: String,
  $nyLenke: String,
  $nyLokasjon: LokasjonInput,
  $nyErDigitalt: Boolean,
  $hardDelete: HardDeleteUpdateInput,
  $idempotencyKey: String,
  $eksterneVarsler: [EksterntVarselInput!]!,
  $paaminnelse: PaaminnelseInput
) {
  oppdaterKalenderavtaleByEksternId(
    merkelapp: $merkelapp,
    eksternId: $eksternId,
    nyTilstand: $nyTilstand,
    nyTekst: $nyTekst,
    nyLenke: $nyLenke,
    nyLokasjon: $nyLokasjon,
    nyErDigitalt: $nyErDigitalt,
    hardDelete: $hardDelete,
    idempotencyKey: $idempotencyKey,
    eksterneVarsler: $eksterneVarsler,
    paaminnelse: $paaminnelse
  ) {
    ... on OppdaterKalenderavtaleVellykket {
      id
    }
    ... on UgyldigKalenderavtale {
      feilmelding
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on Konflikt {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "merkelapp": "Tiltak",
  "eksternId": "fa5aa2a4-4687-4d72-be09-dadbe553a3a2",
  "nyTilstand": "VENTER_SVAR_FRA_ARBEIDSGIVER",
  "nyTekst": "xyz789",
  "nyLenke": "xyz789",
  "nyLokasjon": LokasjonInput,
  "nyErDigitalt": true,
  "hardDelete": HardDeleteUpdateInput,
  "idempotencyKey": "xyz789",
  "eksterneVarsler": [""],
  "paaminnelse": PaaminnelseInput
}
Response
{
  "data": {
    "oppdaterKalenderavtaleByEksternId": OppdaterKalenderavtaleVellykket
  }
}
Mutations

oppgaveEndrePaaminnelse

Description

Endre påminnelsen for en oppgave. Dersom oppgaven har en eksisterende påminnelse, vil denne bli overskrevet. Eksterne varsler blir også overskrevet For fjerning av påminnelse, kan man send inn null

Response

Returns an OppgaveEndrePaaminnelseResultat!

Arguments
Name Description
id - ID! ID-en som oppgaven har. Den du fikk da du opprettet oppgaven med nyOppgave.
idempotencyKey - String Dersom dere angir idempotenceKey så vil konsekvente kall med samme idempotenceKey gi samme resultat. Dette kan f.eks være nyttig hvis dere har retry mekanismer i deres system.
paaminnelse - PaaminnelseInput Her kan du spesifisere en påminnelse for oppgaven. Dersom eksisterende påminnelse skal fjernes, spesifiser null Brukeren vil bli gjort oppmerksom via bjellen og evt ekstern varsling dersom du oppgir det.

Example

Query
mutation oppgaveEndrePaaminnelse(
  $id: ID!,
  $idempotencyKey: String,
  $paaminnelse: PaaminnelseInput
) {
  oppgaveEndrePaaminnelse(
    id: $id,
    idempotencyKey: $idempotencyKey,
    paaminnelse: $paaminnelse
  ) {
    ... on OppgaveEndrePaaminnelseVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UgyldigPaaminnelseTidspunkt {
      feilmelding
    }
    ... on OppgavenErAlleredeUtfoert {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "idempotencyKey": "abc123",
  "paaminnelse": PaaminnelseInput
}
Response
{
  "data": {
    "oppgaveEndrePaaminnelse": OppgaveEndrePaaminnelseVellykket
  }
}
Mutations

oppgaveEndrePaaminnelseByEksternId

Description

Endre påminnelsen for en oppgave (identifisert ved ekstern id) Dersom oppgaven har en eksisterende påminnelse, vil denne bli overskrevet. Eksterne varsler blir også overskrevet For fjerning av påminnelse, kan man send inn null

Response

Returns an OppgaveEndrePaaminnelseResultat!

Arguments
Name Description
merkelapp - String! Merkelapp som oppgaven er registrert med.
eksternId - String! ID-en som dere ga oss da dere opprettet oppgaven med nyOppgave.
idempotencyKey - String Dersom dere angir idempotenceKey så vil konsekvente kall med samme idempotenceKey gi samme resultat. Dette kan f.eks være nyttig hvis dere har retry mekanismer i deres system.
paaminnelse - PaaminnelseInput Her kan du spesifisere en påminnelse for oppgaven. Dersom eksisterende påminnelse skal fjernes, spesifiser null Brukeren vil bli gjort oppmerksom via bjellen og evt ekstern varsling dersom du oppgir det.

Example

Query
mutation oppgaveEndrePaaminnelseByEksternId(
  $merkelapp: String!,
  $eksternId: String!,
  $idempotencyKey: String,
  $paaminnelse: PaaminnelseInput
) {
  oppgaveEndrePaaminnelseByEksternId(
    merkelapp: $merkelapp,
    eksternId: $eksternId,
    idempotencyKey: $idempotencyKey,
    paaminnelse: $paaminnelse
  ) {
    ... on OppgaveEndrePaaminnelseVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UgyldigPaaminnelseTidspunkt {
      feilmelding
    }
    ... on OppgavenErAlleredeUtfoert {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "merkelapp": "Permittering",
  "eksternId": "07c51764-4484-429c-b72d-8ac6967928da",
  "idempotencyKey": "abc123",
  "paaminnelse": PaaminnelseInput
}
Response
{
  "data": {
    "oppgaveEndrePaaminnelseByEksternId": OppgaveEndrePaaminnelseVellykket
  }
}
Mutations

oppgaveUtfoert

Description

Marker en oppgave (identifisert ved id) som utført. Dersom oppgaven har påminnelse, vil denne og eventuelle eksterne varsler på påminnelsen bli kansellert.

Response

Returns an OppgaveUtfoertResultat!

Arguments
Name Description
id - ID! ID-en som oppgaven har. Den du fikk da du opprettet oppgaven med nyOppgave.
hardDelete - HardDeleteUpdateInput Se: HardDeleteUpdateInput typen
nyLenke - String

Ny lenke som oppgaven peker på: overskriver lenken som ble gitt ved opprettelse av oppgave. F.eks. for å peke på en kvitterings-side.

Optional: hvis ikke oppgitt/null, så beholdes forrige lenke. Default = null
utfoertTidspunkt - ISO8601DateTime

Tidspunkt for når oppgaven ble utført.

Optional: hvis ikke oppgitt/null, så blir den satt til now(). Default = null

Example

Query
mutation oppgaveUtfoert(
  $id: ID!,
  $hardDelete: HardDeleteUpdateInput,
  $nyLenke: String,
  $utfoertTidspunkt: ISO8601DateTime
) {
  oppgaveUtfoert(
    id: $id,
    hardDelete: $hardDelete,
    nyLenke: $nyLenke,
    utfoertTidspunkt: $utfoertTidspunkt
  ) {
    ... on OppgaveUtfoertVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "hardDelete": HardDeleteUpdateInput,
  "nyLenke": null,
  "utfoertTidspunkt": null
}
Response
{"data": {"oppgaveUtfoert": OppgaveUtfoertVellykket}}
Mutations

oppgaveUtfoertByEksternId

Using the type ID for eksternId can lead to unexpected behaviour. Use oppgaveUtfoertByEksternId_V2 instead.
Description

Marker en oppgave (identifisert ved ekstern id) som utført. Dersom oppgaven har påminnelse, vil denne og eventuelle eksterne varsler på påminnelsen bli kansellert.

Response

Returns an OppgaveUtfoertResultat!

Arguments
Name Description
merkelapp - String! Merkelapp som oppgaven er registrert med.
eksternId - ID! ID-en som dere ga oss da dere opprettet oppgaven med nyOppgave.
hardDelete - HardDeleteUpdateInput Se: HardDeleteUpdateInput typen

Example

Query
mutation oppgaveUtfoertByEksternId(
  $merkelapp: String!,
  $eksternId: ID!,
  $hardDelete: HardDeleteUpdateInput
) {
  oppgaveUtfoertByEksternId(
    merkelapp: $merkelapp,
    eksternId: $eksternId,
    hardDelete: $hardDelete
  ) {
    ... on OppgaveUtfoertVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "merkelapp": "Dialogmøte",
  "eksternId": "a4baf611-f364-47bd-be2c-bf62dfb47415",
  "hardDelete": HardDeleteUpdateInput
}
Response
{
  "data": {
    "oppgaveUtfoertByEksternId": OppgaveUtfoertVellykket
  }
}
Mutations

oppgaveUtfoertByEksternId_V2

Description

Marker en oppgave (identifisert ved ekstern id) som utført. Dersom oppgaven har påminnelse, vil denne og eventuelle eksterne varsler på påminnelsen bli kansellert.

Response

Returns an OppgaveUtfoertResultat!

Arguments
Name Description
merkelapp - String! Merkelapp som oppgaven er registrert med.
eksternId - String! ID-en som dere ga oss da dere opprettet oppgaven med nyOppgave.
hardDelete - HardDeleteUpdateInput Se: HardDeleteUpdateInput typen
nyLenke - String

Ny lenke som oppgaven peker på: overskriver lenken som ble gitt ved opprettelse av oppgave. F.eks. for å peke på en kvitterings-side.

Optional: hvis ikke oppgitt/null, så beholdes forrige lenke. Default = null
utfoertTidspunkt - ISO8601DateTime

Tidspunkt for når oppgaven ble utført.

Optional: hvis ikke oppgitt/null, så blir den satt til now(). Default = null

Example

Query
mutation oppgaveUtfoertByEksternId_V2(
  $merkelapp: String!,
  $eksternId: String!,
  $hardDelete: HardDeleteUpdateInput,
  $nyLenke: String,
  $utfoertTidspunkt: ISO8601DateTime
) {
  oppgaveUtfoertByEksternId_V2(
    merkelapp: $merkelapp,
    eksternId: $eksternId,
    hardDelete: $hardDelete,
    nyLenke: $nyLenke,
    utfoertTidspunkt: $utfoertTidspunkt
  ) {
    ... on OppgaveUtfoertVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "merkelapp": "Innskrenking av arbeidstid",
  "eksternId": "23fb452a-c0f1-4d9d-b54d-538e4d54ae5c",
  "hardDelete": HardDeleteUpdateInput,
  "nyLenke": null,
  "utfoertTidspunkt": null
}
Response
{
  "data": {
    "oppgaveUtfoertByEksternId_V2": OppgaveUtfoertVellykket
  }
}
Mutations

oppgaveUtgaatt

Description

Marker en oppgave (identifisert ved id) som utgått. Dersom oppgaven har påminnelse, vil denne og eventuelle eksterne varsler på påminnelsen bli kansellert.

Response

Returns an OppgaveUtgaattResultat!

Arguments
Name Description
id - ID! ID-en som oppgaven har. Den du fikk da du opprettet oppgaven med nyOppgave.
hardDelete - HardDeleteUpdateInput Se: HardDeleteUpdateInput typen
nyLenke - String

Ny lenke som oppgaven peker på: overskriver lenken som ble gitt ved opprettelse av oppgave. F.eks. for å peke på en kvitterings-side.

Optional: hvis ikke oppgitt/null, så beholdes forrige lenke. Default = null
utgaattTidspunkt - ISO8601DateTime

Tidspunkt for når oppgaven utgikk.

Optional: hvis ikke oppgitt/null, så blir den satt til now(). Default = null

Example

Query
mutation oppgaveUtgaatt(
  $id: ID!,
  $hardDelete: HardDeleteUpdateInput,
  $nyLenke: String,
  $utgaattTidspunkt: ISO8601DateTime
) {
  oppgaveUtgaatt(
    id: $id,
    hardDelete: $hardDelete,
    nyLenke: $nyLenke,
    utgaattTidspunkt: $utgaattTidspunkt
  ) {
    ... on OppgaveUtgaattVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on OppgavenErAlleredeUtfoert {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "hardDelete": HardDeleteUpdateInput,
  "nyLenke": null,
  "utgaattTidspunkt": null
}
Response
{"data": {"oppgaveUtgaatt": OppgaveUtgaattVellykket}}
Mutations

oppgaveUtgaattByEksternId

Description

Marker en oppgave (identifisert ved ekstern id) som utgått. Dersom oppgaven har påminnelse, vil denne og eventuelle eksterne varsler på påminnelsen bli kansellert.

Response

Returns an OppgaveUtgaattResultat!

Arguments
Name Description
merkelapp - String! Merkelapp som oppgaven er registrert med.
eksternId - String! ID-en som dere ga oss da dere opprettet oppgaven med nyOppgave.
hardDelete - HardDeleteUpdateInput Se: HardDeleteUpdateInput typen
nyLenke - String

Ny lenke som oppgaven peker på: overskriver lenken som ble gitt ved opprettelse av oppgave. F.eks. for å peke på en kvitterings-side.

Optional: hvis ikke oppgitt/null, så beholdes forrige lenke. Default = null
utgaattTidspunkt - ISO8601DateTime

Tidspunkt for når oppgaven utgikk.

Optional: hvis ikke oppgitt/null, så blir den satt til now(). Default = null

Example

Query
mutation oppgaveUtgaattByEksternId(
  $merkelapp: String!,
  $eksternId: String!,
  $hardDelete: HardDeleteUpdateInput,
  $nyLenke: String,
  $utgaattTidspunkt: ISO8601DateTime
) {
  oppgaveUtgaattByEksternId(
    merkelapp: $merkelapp,
    eksternId: $eksternId,
    hardDelete: $hardDelete,
    nyLenke: $nyLenke,
    utgaattTidspunkt: $utgaattTidspunkt
  ) {
    ... on OppgaveUtgaattVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on OppgavenErAlleredeUtfoert {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "merkelapp": "Permittering",
  "eksternId": "ed8cb3c8-c85b-4807-92fc-b67a45b05477",
  "hardDelete": HardDeleteUpdateInput,
  "nyLenke": null,
  "utgaattTidspunkt": null
}
Response
{
  "data": {
    "oppgaveUtgaattByEksternId": OppgaveUtgaattVellykket
  }
}
Mutations

oppgaveUtsettFrist

Description

Utsett frist på en oppgave. Dersom oppgaven allerede er utgått så gjenåpnes den og fristen utsettes. Dersom fristen ikke var utgått, og det tidligere var angitt en påminnelse så vil den påminnelsen bli slettet. Dersom dere ønsker at brukeren skal få en påminnelse når fristen nærmer seg må det angis i denne mutasjonen.

Response

Returns an OppgaveUtsettFristResultat!

Arguments
Name Description
id - ID! ID-en som oppgaven har. Den du fikk da du opprettet oppgaven med nyOppgave.
nyFrist - ISO8601Date!

Her angir du den nye fristen for når oppgaven skal utføres av bruker.

Fristen vises til bruker i grensesnittet. Oppgaven blir automatisk markert som UTGAAT når fristen er forbi. Dere kan kun oppgi frist med dato, og ikke klokkelsett. Fristen regnes som utløpt når dagen er omme (midnatt, norsk tidssone).
paaminnelse - PaaminnelseInput Her kan du spesifisere en påminnelse for oppgaven. Brukeren vil bli gjort oppmerksom via bjellen og evt ekstern varsling dersom du oppgir det.

Example

Query
mutation oppgaveUtsettFrist(
  $id: ID!,
  $nyFrist: ISO8601Date!,
  $paaminnelse: PaaminnelseInput
) {
  oppgaveUtsettFrist(
    id: $id,
    nyFrist: $nyFrist,
    paaminnelse: $paaminnelse
  ) {
    ... on OppgaveUtsettFristVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on Konflikt {
      feilmelding
    }
    ... on UgyldigPaaminnelseTidspunkt {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "nyFrist": ISO8601Date,
  "paaminnelse": PaaminnelseInput
}
Response
{
  "data": {
    "oppgaveUtsettFrist": OppgaveUtsettFristVellykket
  }
}
Mutations

oppgaveUtsettFristByEksternId

Description

Utsett frist på en oppgave (identifisert ved ekstern id). Dersom oppgaven allerede er utgått så gjenåpnes den og fristen utsettes. Dersom fristen ikke var utgått, og det tidligere var angitt en påminnelse så vil den påminnelsen bli slettet. Dersom dere ønsker at brukeren skal få en påminnelse når fristen nærmer seg må det angis i denne mutasjonen.

Response

Returns an OppgaveUtsettFristResultat!

Arguments
Name Description
merkelapp - String! Merkelapp som oppgaven er registrert med.
eksternId - String! ID-en som dere ga oss da dere opprettet oppgaven med nyOppgave.
nyFrist - ISO8601Date!

Her angir du den nye fristen for når oppgaven skal utføres av bruker.

Fristen vises til bruker i grensesnittet. Oppgaven blir automatisk markert som UTGAAT når fristen er forbi. Dere kan kun oppgi frist med dato, og ikke klokkelsett. Fristen regnes som utløpt når dagen er omme (midnatt, norsk tidssone).
paaminnelse - PaaminnelseInput Her kan du spesifisere en påminnelse for oppgaven. Brukeren vil bli gjort oppmerksom via bjellen og evt ekstern varsling dersom du oppgir det.

Example

Query
mutation oppgaveUtsettFristByEksternId(
  $merkelapp: String!,
  $eksternId: String!,
  $nyFrist: ISO8601Date!,
  $paaminnelse: PaaminnelseInput
) {
  oppgaveUtsettFristByEksternId(
    merkelapp: $merkelapp,
    eksternId: $eksternId,
    nyFrist: $nyFrist,
    paaminnelse: $paaminnelse
  ) {
    ... on OppgaveUtsettFristVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on Konflikt {
      feilmelding
    }
    ... on UgyldigPaaminnelseTidspunkt {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "merkelapp": "Inkluderingstilskudd",
  "eksternId": "c27d19aa-82b6-4598-ab9e-f0f7f708c9d1",
  "nyFrist": ISO8601Date,
  "paaminnelse": PaaminnelseInput
}
Response
{
  "data": {
    "oppgaveUtsettFristByEksternId": OppgaveUtsettFristVellykket
  }
}
Mutations

softDeleteNotifikasjon

Description

Markerer en notifikasjon som slettet (soft delete).

Notifikasjonen vil forsvinne helt for mottakeren: de vil ikke kunne se den på noen som helst måte — som om notifikasjonen aldri eksisterte.

For dere (produsenter), så kan dere fortsatt se notifikasjonen i listen over deres notifikasjoner.

Eventuelle eksterne varsler (SMS, e-post) knyttet til notifikasjonen vil bli fortsatt bli sendt.

Advarsel: det er ikke mulig å angre på denne operasjonen.

Response

Returns a SoftDeleteNotifikasjonResultat!

Arguments
Name Description
id - ID!

Example

Query
mutation softDeleteNotifikasjon($id: ID!) {
  softDeleteNotifikasjon(id: $id) {
    ... on SoftDeleteNotifikasjonVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Response
{
  "data": {
    "softDeleteNotifikasjon": SoftDeleteNotifikasjonVellykket
  }
}
Mutations

softDeleteNotifikasjonByEksternId

Using the type ID for eksternId can lead to unexpected behaviour. Use softDeleteNotifikasjonByEksternId_V2 instead.
Description

Se dokumentasjon for softDeleteNotifikasjon(id).

Response

Returns a SoftDeleteNotifikasjonResultat!

Arguments
Name Description
merkelapp - String! Merkelappen som dere ga oss da dere opprettet notifikasjonen.
eksternId - ID! ID-en som dere ga oss da dere opprettet notifikasjonen.

Example

Query
mutation softDeleteNotifikasjonByEksternId(
  $merkelapp: String!,
  $eksternId: ID!
) {
  softDeleteNotifikasjonByEksternId(
    merkelapp: $merkelapp,
    eksternId: $eksternId
  ) {
    ... on SoftDeleteNotifikasjonVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{"merkelapp": "Tiltak", "eksternId": "a1863bb7-ba16-4484-a7d7-dc3cfa3659c7"}
Response
{
  "data": {
    "softDeleteNotifikasjonByEksternId": SoftDeleteNotifikasjonVellykket
  }
}
Mutations

softDeleteNotifikasjonByEksternId_V2

Description

Se dokumentasjon for softDeleteNotifikasjon(id).

Response

Returns a SoftDeleteNotifikasjonResultat!

Arguments
Name Description
merkelapp - String! Merkelappen som dere ga oss da dere opprettet notifikasjonen.
eksternId - String! ID-en som dere ga oss da dere opprettet notifikasjonen.

Example

Query
mutation softDeleteNotifikasjonByEksternId_V2(
  $merkelapp: String!,
  $eksternId: String!
) {
  softDeleteNotifikasjonByEksternId_V2(
    merkelapp: $merkelapp,
    eksternId: $eksternId
  ) {
    ... on SoftDeleteNotifikasjonVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on NotifikasjonFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "merkelapp": "Lønnstilskudd",
  "eksternId": "9a38247a-2da7-4a54-90ea-24cc52b90f3e"
}
Response
{
  "data": {
    "softDeleteNotifikasjonByEksternId_V2": SoftDeleteNotifikasjonVellykket
  }
}
Mutations

softDeleteSak

Description

Markerer en sak som slettet (soft delete).

Sak vil forsvinne helt for mottakeren: de vil ikke kunne se den på noen som helst måte — som om saken aldri eksisterte.

Advarsel: det er ikke mulig å angre på denne operasjonen. Advarsel: ingen notifikasjoner blir slettet, selv om de har samme grupperingsid.

Response

Returns a SoftDeleteSakResultat!

Arguments
Name Description
id - ID! ID-en som notifikasjolnen har. Den du fikk da du opprettet notifikasjonen.

Example

Query
mutation softDeleteSak($id: ID!) {
  softDeleteSak(id: $id) {
    ... on SoftDeleteSakVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on SakFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Response
{"data": {"softDeleteSak": SoftDeleteSakVellykket}}
Mutations

softDeleteSakByGrupperingsid

Description

Se dokumentasjon for softDeleteSak(id).

Response

Returns a SoftDeleteSakResultat!

Arguments
Name Description
merkelapp - String! Merkelappen som dere ga oss da dere opprettet saken.
grupperingsid - String! ID-en som dere ga oss da dere opprettet saken.

Example

Query
mutation softDeleteSakByGrupperingsid(
  $merkelapp: String!,
  $grupperingsid: String!
) {
  softDeleteSakByGrupperingsid(
    merkelapp: $merkelapp,
    grupperingsid: $grupperingsid
  ) {
    ... on SoftDeleteSakVellykket {
      id
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on SakFinnesIkke {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{"merkelapp": "Tiltak", "grupperingsid": "17cb1ce8-50ae-4717-ae7e-d6a28deef95e"}
Response
{
  "data": {
    "softDeleteSakByGrupperingsid": SoftDeleteSakVellykket
  }
}
Mutations

tilleggsinformasjonSak

Response

Returns a TilleggsinformasjonSakResultat!

Arguments
Name Description
idempotencyKey - String
id - ID!
tilleggsinformasjon - String Dette feltet er frivillig. Her har dere mulighet til å vise virksomheten mer informasjon om saken. Feltet er begrenset til 140 tegn og kan ikke inneholde fødselsnummer.

Example

Query
mutation tilleggsinformasjonSak(
  $idempotencyKey: String,
  $id: ID!,
  $tilleggsinformasjon: String
) {
  tilleggsinformasjonSak(
    idempotencyKey: $idempotencyKey,
    id: $id,
    tilleggsinformasjon: $tilleggsinformasjon
  ) {
    ... on TilleggsinformasjonSakVellykket {
      id
    }
    ... on SakFinnesIkke {
      feilmelding
    }
    ... on Konflikt {
      feilmelding
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "idempotencyKey": "xyz789",
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "tilleggsinformasjon": "abc123"
}
Response
{
  "data": {
    "tilleggsinformasjonSak": TilleggsinformasjonSakVellykket
  }
}
Mutations

tilleggsinformasjonSakByGrupperingsid

Response

Returns a TilleggsinformasjonSakResultat!

Arguments
Name Description
idempotencyKey - String
grupperingsid - String!
merkelapp - String!
tilleggsinformasjon - String Dette feltet er frivillig. Her har dere mulighet til å vise virksomheten mer informasjon om saken. Feltet er begrenset til 140 tegn og kan ikke inneholde fødselsnummer.

Example

Query
mutation tilleggsinformasjonSakByGrupperingsid(
  $idempotencyKey: String,
  $grupperingsid: String!,
  $merkelapp: String!,
  $tilleggsinformasjon: String
) {
  tilleggsinformasjonSakByGrupperingsid(
    idempotencyKey: $idempotencyKey,
    grupperingsid: $grupperingsid,
    merkelapp: $merkelapp,
    tilleggsinformasjon: $tilleggsinformasjon
  ) {
    ... on TilleggsinformasjonSakVellykket {
      id
    }
    ... on SakFinnesIkke {
      feilmelding
    }
    ... on Konflikt {
      feilmelding
    }
    ... on UgyldigMerkelapp {
      feilmelding
    }
    ... on UkjentProdusent {
      feilmelding
    }
  }
}
Variables
{
  "idempotencyKey": "abc123",
  "grupperingsid": "97b84018-1fc3-40f7-a132-6e9d2f57d767",
  "merkelapp": "Arbeidstrening",
  "tilleggsinformasjon": "abc123"
}
Response
{
  "data": {
    "tilleggsinformasjonSakByGrupperingsid": TilleggsinformasjonSakVellykket
  }
}

Types

AltinnMottaker

Fields
Field Name Description
serviceCode - String!
serviceEdition - String!
virksomhetsnummer - String!
Example
{
  "serviceCode": "abc123",
  "serviceEdition": "abc123",
  "virksomhetsnummer": "xyz789"
}
Types

AltinnMottakerInput

Description

Spesifiser mottaker ved hjelp av tilganger i Altinn 2. Enhver som har den gitte tilgangen vil kunne se notifikasjone.

Tilgangssjekken utføres hver gang en bruker ser på notifikasjoner. Det betyr at hvis en bruker mister en Altinn 2-tilgang, så vil de hverken se historiske eller nye notifikasjone knyttet til den Altinn 2-tilgangen. Og motsatt, hvis en bruker får en Altinn 2-tilgang, vil de se tidligere notifikasjoner for den Altinn2-tilgangen.

Altinn 2 skal avvikles innen juni 2026, og denne mottakeren vil da også forsvinne. Vi anbefaler å migrere til Altinn 3, og ta i bruk AltinnRessursMottakerInput. Når dere migrerer til Altinn3 kan vi sørge for at brukere fortsatt får tilgang til gamle saker og notifikasjoner, så lenge vi blir informert om hvilke Altinn 3 ressurser som tilsvarer hvilke Altinn 2 tjenester. Ta gjerne kontakt med oss og gi beskjed.

Fields
Input Field Description
serviceCode - String!
serviceEdition - String!
Example
{
  "serviceCode": "xyz789",
  "serviceEdition": "xyz789"
}
Types

AltinnRessursMottaker

Fields
Field Name Description
virksomhetsnummer - String!
ressursId - String!
Example
{
  "virksomhetsnummer": "abc123",
  "ressursId": "abc123"
}
Types

AltinnRessursMottakerInput

Description

Spesifiser mottaker ved hjelp av tilganger i Altinn 3. Enhver som har den gitte tilgangen vil kunne se notifikasjone.

Tilgangssjekken utføres hver gang en bruker ser på notifikasjoner. Det betyr at hvis en bruker mister en Altinn 3-tilgang, så vil de hverken se historiske eller nye notifikasjone knyttet til den Altinn 3-tilgangen. Og motsatt, hvis en bruker får en Altinn 3-tilgang, vil de se tidligere notifikasjoner for den Altinn2-tilgangen.

Fields
Input Field Description
ressursId - String!
Example
{"ressursId": "xyz789"}
Types

AltinntjenesteMottakerInput

Fields
Input Field Description
serviceCode - String!
serviceEdition - String!
Example
{
  "serviceCode": "abc123",
  "serviceEdition": "xyz789"
}
Types

Beskjed

Fields
Field Name Description
mottaker - Mottaker!
mottakere - [Mottaker!]!
metadata - Metadata!
beskjed - BeskjedData!
eksterneVarsler - [EksterntVarsel!]!
Example
{
  "mottaker": AltinnMottaker,
  "mottakere": [AltinnMottaker],
  "metadata": Metadata,
  "beskjed": BeskjedData,
  "eksterneVarsler": [EksterntVarsel]
}
Types

BeskjedData

Fields
Field Name Description
merkelapp - String! Merkelapp for beskjeden. Er typisk navnet på ytelse eller lignende. Den vises til brukeren.
tekst - String! Teksten som vises til brukeren.
lenke - String! Lenken som brukeren føres til hvis de klikker på beskjeden.
Example
{
  "merkelapp": "abc123",
  "tekst": "abc123",
  "lenke": "xyz789"
}
Types

Boolean

Description

The Boolean scalar type represents true or false.

Example
true
Types

DuplikatEksternIdOgMerkelapp

Description

Denne feilen returneres dersom du prøver å opprette en notifikasjon med en eksternId og merkelapp som allerede finnes

Fields
Field Name Description
feilmelding - String!
idTilEksisterende - ID!
Example
{
  "feilmelding": "abc123",
  "idTilEksisterende": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

DuplikatGrupperingsid

Description

Denne feilen returneres hvis det allerede eksisterer en sak med denne grupperingsid-en under merkelappen.

Fields
Field Name Description
feilmelding - String!
idTilEksisterende - ID!
Example
{
  "feilmelding": "abc123",
  "idTilEksisterende": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

DuplikatGrupperingsidEtterDelete

Description

Denne feilen returneres hvis det tidligere eksisterte en sak med denne grupperingsid-en under merkelappen, som har blitt slettet.

Fields
Field Name Description
feilmelding - String!
Example
{"feilmelding": "abc123"}
Types

EksterntVarsel

Fields
Field Name Description
id - ID!
status - EksterntVarselStatus!
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "status": "NY"
}
Types

EksterntVarselAltinntjenesteInput

Description

Med denne typen vil varsel sendes til virksomheten vha tjenesten i Altinn. Dette vil bli sendt med EMAIL_PREFERRED, som betyr at det mest sannsynlig blir sendt som epost, men i enkelte tilfeller vil bli sendt sms.

De som har registrert sin kontaktadresse på underenheten (enten uten filter eller hvor filteret stemmer med tjenestekoden som oppgis) vil bli varslet. Den offisielle kontaktinformasjonen til overenheten vil bli varslet.

Malen som benyttes er TokenTextOnly og den ser slik ut:

                          type   | subject  | notificationText
                          SMS    |          | {tittel}{innhold}
                          EMAIL  | {tittel} | {innhold}
Fields
Input Field Description
mottaker - AltinntjenesteMottakerInput!
tittel - String! Subject/emne til e-posten, eller tekst i sms OBS: Det er ikke lov med personopplysninger i teksten.
innhold - String! Kroppen til e-posten. Dersom det sendes SMS blir dette feltet lagt til i kroppen på sms etter tittel OBS: Det er ikke lov med personopplysninger i teksten.
sendetidspunkt - SendetidspunktInput!
Example
{
  "mottaker": AltinntjenesteMottakerInput,
  "tittel": "abc123",
  "innhold": "xyz789",
  "sendetidspunkt": SendetidspunktInput
}
Types

EksterntVarselEpostInput

Fields
Input Field Description
mottaker - EpostMottakerInput!
epostTittel - String! Subject/emne til e-posten. OBS: Det er ikke lov med personopplysninger i teksten. E-post er ikke en sikker kanal.
epostHtmlBody - String! Kroppen til e-posten. Tolkes som HTML. OBS: Det er ikke lov med personopplysninger i teksten. E-post er ikke en sikker kanal.
sendetidspunkt - SendetidspunktInput!
Example
{
  "mottaker": EpostMottakerInput,
  "epostTittel": "xyz789",
  "epostHtmlBody": "xyz789",
  "sendetidspunkt": SendetidspunktInput
}
Types

EksterntVarselInput

Fields
Input Field Description
sms - EksterntVarselSmsInput
epost - EksterntVarselEpostInput
altinntjeneste - EksterntVarselAltinntjenesteInput
Example
{
  "sms": EksterntVarselSmsInput,
  "epost": EksterntVarselEpostInput,
  "altinntjeneste": EksterntVarselAltinntjenesteInput
}
Types

EksterntVarselSmsInput

Fields
Input Field Description
mottaker - SmsMottakerInput!
smsTekst - String! Teksten som sendes i SMS-en. OBS: Det er ikke lov med personopplysninger i teksten. SMS er ikke en sikker kanal.
sendetidspunkt - SendetidspunktInput!
Example
{
  "mottaker": SmsMottakerInput,
  "smsTekst": "abc123",
  "sendetidspunkt": SendetidspunktInput
}
Types

EksterntVarselStatus

Values
Enum Value Description

NY

SENDT

FEILET

KANSELLERT
Example
"NY"
Types

EpostKontaktInfoInput

Fields
Input Field Description
fnr - String deprecated. value is ignored.
epostadresse - String!
Example
{
  "fnr": "abc123",
  "epostadresse": "abc123"
}
Types

EpostMottakerInput

Fields
Input Field Description
kontaktinfo - EpostKontaktInfoInput
Example
{"kontaktinfo": EpostKontaktInfoInput}
Types

Error

Fields
Field Name Description
feilmelding - String!
Possible Types
Error Types

UgyldigMerkelapp

UgyldigMottaker

UkjentProdusent

OppgavenErAlleredeUtfoert

NotifikasjonFinnesIkke

SakFinnesIkke

DuplikatEksternIdOgMerkelapp

DuplikatGrupperingsid

DuplikatGrupperingsidEtterDelete

UkjentRolle

UgyldigPaaminnelseTidspunkt

Konflikt

UgyldigKalenderavtale
Example
{"feilmelding": "xyz789"}
Types

FutureTemporalInput

Description

Med denne kan dere spesifiserer et konkret tidspunkt.

Fields
Input Field Description
den - ISO8601LocalDateTime En konkret dato. I Europe/Oslo-tidssone.
om - ISO8601Duration Som duration-offset relativt til implisitt dato. Dere må se på dokumentasjonen til feltet hvor denne datatypen er brukt for å vite hva vi bruker som implisitt dato.
Example
{
  "den": ISO8601LocalDateTime,
  "om": "P3Y6M4DT12H30M5S"
}
Types

HardDeleteNotifikasjonResultat

Types
Union Types

HardDeleteNotifikasjonVellykket

UgyldigMerkelapp

NotifikasjonFinnesIkke

UkjentProdusent
Example
HardDeleteNotifikasjonVellykket
Types

HardDeleteNotifikasjonVellykket

Fields
Field Name Description
id - ID! ID-en til oppgaven du "hard-delete"-et.
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

HardDeleteSakResultat

Types
Union Types

HardDeleteSakVellykket

UgyldigMerkelapp

SakFinnesIkke

UkjentProdusent
Example
HardDeleteSakVellykket
Types

HardDeleteSakVellykket

Fields
Field Name Description
id - ID! ID-en til saken du "hard-delete"-et.
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

HardDeleteUpdateInput

Description

Dersom dere vet at saken/notifikasjonen senere skal slettes helt kan det angis her.

Fields
Input Field Description
nyTid - FutureTemporalInput! Oppgi dersom dere ønsker at hard delete skal skeduleres. Vi tolker relative datoer basert på tidspunkt angitt i kallet eller når vi mottok kallet, hvis dere ikke har oppgitt det eller det ikke er mulig å oppgi.
strategi - NyTidStrategi! hvis det finnes fremtidig sletting hvordan skal vi håndtere dette
Example
{"nyTid": FutureTemporalInput, "strategi": "FORLENG"}
Types

HentNotifikasjonResultat

Types
Union Types

HentetNotifikasjon

UkjentProdusent

UgyldigMerkelapp

NotifikasjonFinnesIkke
Example
HentetNotifikasjon
Types

HentSakResultat

Types
Union Types

HentetSak

SakFinnesIkke

UgyldigMerkelapp

UkjentProdusent
Example
HentetSak
Types

HentetNotifikasjon

Fields
Field Name Description
notifikasjon - Notifikasjon!
Example
{"notifikasjon": Beskjed}
Types

HentetSak

Fields
Field Name Description
sak - Sak!
Example
{"sak": Sak}
Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
"ffb116ee-f5a0-4af6-921f-7e22a167868a"
Types

ISO8601Date

Description

Dato etter ISO8601-standaren. F.eks. 2020-01-02, altså 2. mars 2020.

Example
ISO8601Date
Types

ISO8601DateTime

Description

DateTime med offset etter ISO8601-standaren. F.eks. '2011-12-03T10:15:30+01:00'.

Er representert som String.

Example
ISO8601DateTime
Types

ISO8601Duration

Description

Duration ISO8601-standaren. F.eks. 'P2DT3H4M'.

Er representert som String.

Example
"P3Y6M4DT12H30M5S"
Types

ISO8601LocalDateTime

Description

Dato og lokaltid etter ISO8601-standaren. F.eks. '2001-12-24T10:44:01'. Vi tolker tidspunktet som Oslo-tid ('Europe/Oslo').

Example
ISO8601LocalDateTime
Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
987
Types

Kalenderavtale

Fields
Field Name Description
mottakere - [Mottaker!]!
metadata - Metadata!
kalenderavtale - KalenderavtaleData!
eksterneVarsler - [EksterntVarsel!]!
Example
{
  "mottakere": [AltinnMottaker],
  "metadata": Metadata,
  "kalenderavtale": KalenderavtaleData,
  "eksterneVarsler": [EksterntVarsel]
}
Types

KalenderavtaleData

Fields
Field Name Description
merkelapp - String! Merkelapp for kalenderavtalen. Er typisk navnet på ytelse eller lignende.
tekst - String! Teksten som vises til brukeren.
lenke - String! Lenken som brukeren føres til hvis de klikker på kalenderavtalen.
startTidspunkt - ISO8601LocalDateTime! Når avtalen starter.
sluttTidspunkt - ISO8601LocalDateTime Når avtalen slutter.
lokasjon - Lokasjon Her kan dere oppgi en fysisk adresse som brukeren kan møte opp på dersom dere har det. Denne vil vises til brukeren hvis den er angitt.
digitalt - Boolean! Ved å sette dette flagget kan dere vise brukeren at det er mulig å møte digitalt. Det vil vises til brukeren hvis det er satt til true.
tilstand - KalenderavtaleTilstand Tilstanden til avtalen. Default er VENTER_SVAR_FRA_ARBEIDSGIVER. Denne vises til brukeren.
Example
{
  "merkelapp": "abc123",
  "tekst": "xyz789",
  "lenke": "abc123",
  "startTidspunkt": ISO8601LocalDateTime,
  "sluttTidspunkt": ISO8601LocalDateTime,
  "lokasjon": Lokasjon,
  "digitalt": false,
  "tilstand": "VENTER_SVAR_FRA_ARBEIDSGIVER"
}
Types

KalenderavtaleTilstand

Description

Tilstanden til en kalenderavtale. Disse tilstandene er laget basert på eksisterende behov. Har dere behov for flere tilstander, så ta kontakt med oss.

Values
Enum Value Description

VENTER_SVAR_FRA_ARBEIDSGIVER

 Avtalen venter på at brukeren skal svare. Dette er standardtilstanden.

ARBEIDSGIVER_VIL_AVLYSE

 Arbeidsgiver har svart at de ønsker å avlyse

ARBEIDSGIVER_VIL_ENDRE_TID_ELLER_STED

 Arbeidsgiver har svart at de ønsker å endre tid eller sted

ARBEIDSGIVER_HAR_GODTATT

 Arbeidsgiver har godtatt avtalen

AVLYST

 Avtalen er avlyst
Example
"VENTER_SVAR_FRA_ARBEIDSGIVER"
Types

Konflikt

Description

Oppgitt informasjon samsvarer ikke med tidligere informasjon som er oppgitt.

Fields
Field Name Description
feilmelding - String!
Example
{"feilmelding": "abc123"}
Types

Lokasjon

Fields
Field Name Description
adresse - String!
postnummer - String!
poststed - String!
Example
{
  "adresse": "xyz789",
  "postnummer": "xyz789",
  "poststed": "xyz789"
}
Types

LokasjonInput

Fields
Input Field Description
adresse - String!
postnummer - String!
poststed - String!
Example
{
  "adresse": "abc123",
  "postnummer": "xyz789",
  "poststed": "abc123"
}
Types

Metadata

Fields
Field Name Description
id - ID!
eksternId - String!
opprettetTidspunkt - ISO8601DateTime
grupperingsid - String
softDeleted - Boolean!
softDeletedAt - ISO8601DateTime
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "eksternId": "abc123",
  "opprettetTidspunkt": ISO8601DateTime,
  "grupperingsid": "abc123",
  "softDeleted": false,
  "softDeletedAt": ISO8601DateTime
}
Types

MetadataInput

Fields
Input Field Description
virksomhetsnummer - String! Hvilken virksomhet som skal motta notifikasjonen.
eksternId - String!

Den eksterne id-en brukes for å unikt identifisere en notifikasjon. Den må være unik for merkelappen.

Hvis dere har en enkel, statisk bruk av notifikasjoner, så kan dere utlede eksternId fra f.eks. et saksnummer, og på den måten kunne referere til notifikasjoner dere har opprettet, uten at dere må lagre ID-ene vi genererer og returnerer til dere.
opprettetTidspunkt - ISO8601DateTime Hvilken dato vi viser til brukeren. Dersom dere ikke oppgir noen dato, så bruker vi tidspuktet dere gjør kallet på.
grupperingsid - String

Grupperings-id-en gjør det mulig å knytte sammen forskjellige oppgaver, beskjed og saker. Det vises ikke til brukere. Saksnummer er en naturlig grupperings-id.

Når dere bruker grupperings-id, så er det mulig for oss å presentere en tidslinje med alle notifikasjonene og status-oppdateringer knyttet til en sak.
hardDelete - FutureTemporalInput Oppgi dersom dere ønsker at hard delete skal skeduleres. Vi tolker relative datoer basert på opprettetTidspunkt (eller når vi mottok kallet hvis dere ikke har oppgitt opprettetTidspunkt).
Example
{
  "virksomhetsnummer": "xyz789",
  "eksternId": "abc123",
  "opprettetTidspunkt": ISO8601DateTime,
  "grupperingsid": "xyz789",
  "hardDelete": FutureTemporalInput
}
Types

MineNotifikasjonerResultat

Types
Union Types

NotifikasjonConnection

UgyldigMerkelapp

UkjentProdusent
Example
NotifikasjonConnection
Types

Mottaker

Types
Union Types

AltinnMottaker

NaermesteLederMottaker

AltinnRessursMottaker
Example
AltinnMottaker
Types

MottakerInput

Description

Hvem som skal se notifikasjonen.

Du kan spesifisere mottaker av notifikasjoner på forskjellige måter. Du skal bruke nøyaktig ett av feltene.

Vi har implementert det på denne måten fordi GraphQL ikke støtter union-typer som input.

Fields
Input Field Description
altinn - AltinnMottakerInput
altinnRessurs - AltinnRessursMottakerInput
naermesteLeder - NaermesteLederMottakerInput
Example
{
  "altinn": AltinnMottakerInput,
  "altinnRessurs": AltinnRessursMottakerInput,
  "naermesteLeder": NaermesteLederMottakerInput
}
Types

NaermesteLederMottaker

Fields
Field Name Description
naermesteLederFnr - String!
ansattFnr - String!
virksomhetsnummer - String!
Example
{
  "naermesteLederFnr": "xyz789",
  "ansattFnr": "abc123",
  "virksomhetsnummer": "xyz789"
}
Types

NaermesteLederMottakerInput

Description

Spesifiser mottaker ved hjelp av fødselsnummer. Fødselsnummeret er det til nærmeste leder. Det er kun denne personen som potensielt kan se notifikasjonen. Det er videre en sjekk for å se om denne personen fortsatt er nærmeste leder for den ansatte notifikasjonen gjelder.

Tilgangssjekken utføres hver gang en bruker ønsker se notifikasjonen.

Fields
Input Field Description
naermesteLederFnr - String!
ansattFnr - String!
Example
{
  "naermesteLederFnr": "xyz789",
  "ansattFnr": "xyz789"
}
Types

NesteStegSakResultat

Types
Union Types

NesteStegSakVellykket

SakFinnesIkke

Konflikt

UgyldigMerkelapp

UkjentProdusent
Example
NesteStegSakVellykket
Types

NesteStegSakVellykket

Fields
Field Name Description
id - ID!
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

Notifikasjon

Types
Union Types

Beskjed

Oppgave

Kalenderavtale
Example
Beskjed
Types

NotifikasjonConnection

Fields
Field Name Description
edges - [NotifikasjonEdge!]!
pageInfo - PageInfo!
Example
{
  "edges": [NotifikasjonEdge],
  "pageInfo": PageInfo
}
Types

NotifikasjonEdge

Fields
Field Name Description
node - Notifikasjon!
cursor - String!
Example
{
  "node": Beskjed,
  "cursor": "MGViNDZmNDAtMjE2MC00OTE0LWFjN2YtNjdhMDRlNjVmMjM3"
}
Types

NotifikasjonFinnesIkke

Description

Denne feilen returneres dersom du prøver å referere til en notifikasjon som ikke eksisterer.

Utover at dere kan ha oppgitt feil informasjon, så kan det potensielt være på grunn av "eventual consistency" i systemet vårt.

Fields
Field Name Description
feilmelding - String!
Example
{"feilmelding": "xyz789"}
Types

NotifikasjonInput

Fields
Input Field Description
merkelapp - String!

Merkelapp for beskjeden. Er typisk navnet på ytelse eller lignende. Den vises til brukeren.

Hva du kan oppgi som merkelapp er bestemt av produsent-registeret.
tekst - String! Teksten som vises til brukeren. Feltet er begrenset til 300 tegn og kan ikke inneholde fødselsnummer.
lenke - String! Lenken som brukeren føres til hvis de klikker på beskjeden.
Example
{
  "merkelapp": "abc123",
  "tekst": "xyz789",
  "lenke": "xyz789"
}
Types

NyBeskjedInput

Fields
Input Field Description
mottaker - MottakerInput Se dokumentasjonen til mottakere-feltet.
mottakere - [MottakerInput!]!

Her bestemmer dere hvem som skal få se notifikasjonen.

Hvis dere oppgir en mottaker i mottaker-feltet, så tolker vi det som om det var et element i denne listen over mottakere.

Dere må gi oss minst 1 mottaker. Default = []
notifikasjon - NotifikasjonInput!
metadata - MetadataInput!
eksterneVarsler - [EksterntVarselInput!]!
Example
{
  "mottaker": MottakerInput,
  "mottakere": [MottakerInput],
  "notifikasjon": NotifikasjonInput,
  "metadata": MetadataInput,
  "eksterneVarsler": [EksterntVarselInput]
}
Types

NyBeskjedResultat

Types
Union Types

NyBeskjedVellykket

UgyldigMerkelapp

UgyldigMottaker

DuplikatEksternIdOgMerkelapp

UkjentProdusent

UkjentRolle
Example
NyBeskjedVellykket
Types

NyBeskjedVellykket

Fields
Field Name Description
id - ID!
eksterneVarsler - [NyEksterntVarselResultat!]!
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "eksterneVarsler": [NyEksterntVarselResultat]
}
Types

NyEksterntVarselResultat

Fields
Field Name Description
id - ID!
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

NyKalenderavtaleResultat

Types
Union Types

NyKalenderavtaleVellykket

UgyldigKalenderavtale

UgyldigMerkelapp

UgyldigMottaker

DuplikatEksternIdOgMerkelapp

UkjentProdusent

SakFinnesIkke
Example
NyKalenderavtaleVellykket
Types

NyKalenderavtaleVellykket

Fields
Field Name Description
id - ID!
eksterneVarsler - [NyEksterntVarselResultat!]!
paaminnelse - PaaminnelseResultat
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "eksterneVarsler": [NyEksterntVarselResultat],
  "paaminnelse": PaaminnelseResultat
}
Types

NyOppgaveInput

Fields
Input Field Description
mottaker - MottakerInput Se dokumentasjonen til mottakere-feltet.
mottakere - [MottakerInput!]!

Her bestemmer dere hvem som skal få se notifikasjonen.

Hvis dere oppgir en mottaker i mottaker-feltet, så tolker vi det som om det var et element i denne listen over mottakere.

Dere må gi oss minst 1 mottaker. Default = []
notifikasjon - NotifikasjonInput!
frist - ISO8601Date

Her kan du spesifisere frist for når oppgaven skal utføres av bruker. Ideen er at etter fristen, så har ikke bruker lov, eller dere sperret for, å gjøre oppgaven.

Fristen vises til bruker i grensesnittet. Oppgaven blir automatisk markert som UTGAAT når fristen er forbi. Dere kan kun oppgi frist med dato, og ikke klokkelsett. Fristen regnes som utløpt når dagen er omme (midnatt, norsk tidssone).

Hvis dere ikke sender med frist, så viser vi ingen frist for bruker, og oppgaven anses som NY frem til dere markerer oppgaven som UTFOERT eller UTGAATT.
metadata - MetadataInput!
eksterneVarsler - [EksterntVarselInput!]!
paaminnelse - PaaminnelseInput Her kan du spesifisere en påminnelse for en oppgave. Brukeren vil bli gjort oppmerksom via bjellen og evt ekstern varsling dersom du oppgir det.
Example
{
  "mottaker": MottakerInput,
  "mottakere": [MottakerInput],
  "notifikasjon": NotifikasjonInput,
  "frist": ISO8601Date,
  "metadata": MetadataInput,
  "eksterneVarsler": [EksterntVarselInput],
  "paaminnelse": PaaminnelseInput
}
Types

NyOppgaveResultat

Types
Union Types

NyOppgaveVellykket

UgyldigMerkelapp

UgyldigMottaker

DuplikatEksternIdOgMerkelapp

UkjentProdusent

UkjentRolle

UgyldigPaaminnelseTidspunkt
Example
NyOppgaveVellykket
Types

NyOppgaveVellykket

Fields
Field Name Description
id - ID!
eksterneVarsler - [NyEksterntVarselResultat!]!
paaminnelse - PaaminnelseResultat
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "eksterneVarsler": [NyEksterntVarselResultat],
  "paaminnelse": PaaminnelseResultat
}
Types

NySakResultat

Types
Union Types

NySakVellykket

UgyldigMerkelapp

UgyldigMottaker

DuplikatGrupperingsid

DuplikatGrupperingsidEtterDelete

UkjentProdusent

UkjentRolle
Example
NySakVellykket
Types

NySakVellykket

Fields
Field Name Description
id - ID!
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

NyStatusSakResultat

Types
Union Types

NyStatusSakVellykket

SakFinnesIkke

Konflikt

UgyldigMerkelapp

UkjentProdusent
Example
NyStatusSakVellykket
Types

NyStatusSakVellykket

Fields
Field Name Description
id - ID!
statuser - [StatusOppdatering!]! Nyeste statusoppdatering er først i listen.
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "statuser": [StatusOppdatering]
}
Types

NyTidStrategi

Values
Enum Value Description

FORLENG

 Vi bruker den tiden som er lengst i fremtiden.

OVERSKRIV

 Vi bruker den nye tiden uansett.
Example
"FORLENG"
Types

OppdaterKalenderavtaleResultat

Types
Union Types

OppdaterKalenderavtaleVellykket

UgyldigKalenderavtale

UgyldigMerkelapp

Konflikt

NotifikasjonFinnesIkke

UkjentProdusent
Example
OppdaterKalenderavtaleVellykket
Types

OppdaterKalenderavtaleVellykket

Fields
Field Name Description
id - ID! ID-en til kalenderavtalen du oppdaterte.
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

Oppgave

Fields
Field Name Description
mottaker - Mottaker!
mottakere - [Mottaker!]!
metadata - Metadata!
oppgave - OppgaveData!
eksterneVarsler - [EksterntVarsel!]!
Example
{
  "mottaker": AltinnMottaker,
  "mottakere": [AltinnMottaker],
  "metadata": Metadata,
  "oppgave": OppgaveData,
  "eksterneVarsler": [EksterntVarsel]
}
Types

OppgaveData

Fields
Field Name Description
tilstand - OppgaveTilstand
merkelapp - String! Merkelapp for beskjeden. Er typisk navnet på ytelse eller lignende. Den vises til brukeren.
tekst - String! Teksten som vises til brukeren.
lenke - String! Lenken som brukeren føres til hvis de klikker på beskjeden.
Example
{
  "tilstand": "NY",
  "merkelapp": "xyz789",
  "tekst": "abc123",
  "lenke": "abc123"
}
Types

OppgaveEndrePaaminnelseResultat

Types
Union Types

OppgaveEndrePaaminnelseVellykket

UgyldigMerkelapp

UgyldigPaaminnelseTidspunkt

OppgavenErAlleredeUtfoert

NotifikasjonFinnesIkke

UkjentProdusent
Example
OppgaveEndrePaaminnelseVellykket
Types

OppgaveEndrePaaminnelseVellykket

Fields
Field Name Description
id - ID! ID-en til oppgaven du oppdaterte.
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

OppgaveTilstand

Description

Tilstanden til en oppgave.

Values
Enum Value Description

NY

 En oppgave som kan utføres.

UTFOERT

 En oppgave som allerede er utført.

UTGAATT

 En oppgave hvor frist har utgått.
Example
"NY"
Types

OppgaveUtfoertResultat

Types
Union Types

OppgaveUtfoertVellykket

UgyldigMerkelapp

NotifikasjonFinnesIkke

UkjentProdusent
Example
OppgaveUtfoertVellykket
Types

OppgaveUtfoertVellykket

Fields
Field Name Description
id - ID! ID-en til oppgaven du oppdaterte.
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

OppgaveUtgaattResultat

Types
Union Types

OppgaveUtgaattVellykket

UgyldigMerkelapp

OppgavenErAlleredeUtfoert

NotifikasjonFinnesIkke

UkjentProdusent
Example
OppgaveUtgaattVellykket
Types

OppgaveUtgaattVellykket

Fields
Field Name Description
id - ID! ID-en til oppgaven du oppdaterte.
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

OppgaveUtsettFristResultat

Types
Union Types

OppgaveUtsettFristVellykket

UgyldigMerkelapp

Konflikt

UgyldigPaaminnelseTidspunkt

NotifikasjonFinnesIkke

UkjentProdusent
Example
OppgaveUtsettFristVellykket
Types

OppgaveUtsettFristVellykket

Fields
Field Name Description
id - ID! ID-en til oppgaven du oppdaterte.
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

OppgavenErAlleredeUtfoert

Description

Denne feilen returneres dersom du forsøker å gå fra utført til utgått.

Fields
Field Name Description
feilmelding - String!
Example
{"feilmelding": "abc123"}
Types

PaaminnelseEksterntVarselAltinntjenesteInput

Fields
Input Field Description
mottaker - AltinntjenesteMottakerInput!
tittel - String! Subject/emne til e-posten, eller tekst i sms OBS: Det er ikke lov med personopplysninger i teksten.
innhold - String! Kroppen til e-posten. Dersom det sendes SMS blir dette feltet lagt til i kroppen på sms etter tittel OBS: Det er ikke lov med personopplysninger i teksten.
sendevindu - Sendevindu! Vi sender eposten med utgangspunkt i påminnelsestidspunktet, men tar hensyn til sendingsvinduet. Hvis påminnelsestidspunktet er utenfor vinduet, sender vi det ved første mulighet.
Example
{
  "mottaker": AltinntjenesteMottakerInput,
  "tittel": "xyz789",
  "innhold": "abc123",
  "sendevindu": "NKS_AAPNINGSTID"
}
Types

PaaminnelseEksterntVarselEpostInput

Fields
Input Field Description
mottaker - EpostMottakerInput!
epostTittel - String! Subject/emne til e-posten. OBS: Det er ikke lov med personopplysninger i teksten. E-post er ikke en sikker kanal.
epostHtmlBody - String! Kroppen til e-posten. Tolkes som HTML. OBS: Det er ikke lov med personopplysninger i teksten. E-post er ikke en sikker kanal.
sendevindu - Sendevindu! Vi sender eposten med utgangspunkt i påminnelsestidspunktet, men tar hensyn til sendingsvinduet. Hvis påminnelsestidspunktet er utenfor vinduet, sender vi det ved første mulighet.
Example
{
  "mottaker": EpostMottakerInput,
  "epostTittel": "abc123",
  "epostHtmlBody": "abc123",
  "sendevindu": "NKS_AAPNINGSTID"
}
Types

PaaminnelseEksterntVarselInput

Fields
Input Field Description
sms - PaaminnelseEksterntVarselSmsInput
epost - PaaminnelseEksterntVarselEpostInput
altinntjeneste - PaaminnelseEksterntVarselAltinntjenesteInput
Example
{
  "sms": PaaminnelseEksterntVarselSmsInput,
  "epost": PaaminnelseEksterntVarselEpostInput,
  "altinntjeneste": PaaminnelseEksterntVarselAltinntjenesteInput
}
Types

PaaminnelseEksterntVarselSmsInput

Fields
Input Field Description
mottaker - SmsMottakerInput!
smsTekst - String! Teksten som sendes i SMS-en. OBS: Det er ikke lov med personopplysninger i teksten. SMS er ikke en sikker kanal.
sendevindu - Sendevindu! Vi sender SMS-en med utgangspunkt i påminnelsestidspunktet, men tar hensyn til sendingsvinduet. Hvis påminnelsestidspunktet er utenfor vinduet, sender vi det ved første mulighet.
Example
{
  "mottaker": SmsMottakerInput,
  "smsTekst": "xyz789",
  "sendevindu": "NKS_AAPNINGSTID"
}
Types

PaaminnelseInput

Fields
Input Field Description
tidspunkt - PaaminnelseTidspunktInput!

Tidspunktet for når påminnelsen skal aktiveres. Dersom det er angitt frist må påminnelsen være før dette.

Hvis du sender eksterneVarsler, så vil vi sjekke at vi har mulighet for å sende dem før fristen, ellers får du feil ved opprettelse av oppgaven/kalenderavtalen.
eksterneVarsler - [PaaminnelseEksterntVarselInput!]!
Example
{
  "tidspunkt": PaaminnelseTidspunktInput,
  "eksterneVarsler": [PaaminnelseEksterntVarselInput]
}
Types

PaaminnelseResultat

Fields
Field Name Description
eksterneVarsler - [NyEksterntVarselResultat!]!
Example
{"eksterneVarsler": [NyEksterntVarselResultat]}
Types

PaaminnelseTidspunktInput

Fields
Input Field Description
konkret - ISO8601LocalDateTime Konkret tidspunkt
etterOpprettelse - ISO8601Duration Relativ til når oppgaven/kalenderavtalen er angitt som opprettet. Altså X duration etter opprettelse.
foerFrist - ISO8601Duration Relativ til oppgavens frist, altså X duration før frist. Anses som ugyldig dersom det ikke er en oppgave med frist.
foerStartTidspunkt - ISO8601Duration Relativ til kalenderavtalens startTidspunkt, altså X duration før startTidspunkt. Anses som ugyldig dersom det ikke er en kalenderavtale.
Example
{
  "konkret": ISO8601LocalDateTime,
  "etterOpprettelse": "P3Y6M4DT12H30M5S",
  "foerFrist": "P3Y6M4DT12H30M5S",
  "foerStartTidspunkt": "P3Y6M4DT12H30M5S"
}
Types

PageInfo

Fields
Field Name Description
hasNextPage - Boolean!
endCursor - String!
Example
{"hasNextPage": true, "endCursor": "xyz789"}
Types

Sak

Fields
Field Name Description
id - ID!
grupperingsid - String!
virksomhetsnummer - String!
tittel - String!
lenke - String
nesteSteg - String
tilleggsinformasjon - String
merkelapp - String!
sisteStatus - SaksStatus
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a",
  "grupperingsid": "abc123",
  "virksomhetsnummer": "abc123",
  "tittel": "abc123",
  "lenke": "abc123",
  "nesteSteg": "abc123",
  "tilleggsinformasjon": "abc123",
  "merkelapp": "abc123",
  "sisteStatus": "MOTTATT"
}
Types

SakFinnesIkke

Fields
Field Name Description
feilmelding - String!
Example
{"feilmelding": "abc123"}
Types

SaksStatus

Description

Statusen påvirker bl.a. hvilket ikon som vises og brukes bl.a. for å kunne filtrere saksoversikten på min side arbeidsgiver.

Values
Enum Value Description

MOTTATT

Naturlig start-tilstand for en sak.

Default tekst som vises til bruker: "Mottatt"

UNDER_BEHANDLING

 Default tekst som vises til bruker: "Under behandling"

FERDIG

Slutt-tilstand for en sak. Når en sak er FERDIG, så vil vi nedprioritere visningen av den på min side arbeidsgivere.

Default tekst som vises til bruker: "Ferdig".
Example
"MOTTATT"
Types

SendetidspunktInput

Description

Med denne typen velger du når du ønsker at det eksterne varselet blir sendt. Du skal velge en (og kun en) av feltene, ellers blir forespørselen din avvist med en feil.

Fields
Input Field Description
tidspunkt - ISO8601LocalDateTime

Hvis du spesifiserer et tidspunkt på formen "YYYY-MM-DDThh:mm", så sender vi notifikasjonen på det tidspunktet. Oppgir du et tidspunkt i fortiden, så sender vi varselet øyeblikkelig.

Tidspunktet tolker vi som lokal, norsk tid (veggklokke-tid).
sendevindu - Sendevindu
Example
{
  "tidspunkt": ISO8601LocalDateTime,
  "sendevindu": "NKS_AAPNINGSTID"
}
Types

Sendevindu

Description

For SMS, så vil Altinns varslingsvindu også gjelde. Dette burde kun påvirke LOEPENDE.

Values
Enum Value Description

NKS_AAPNINGSTID

Vi sender varselet slik at mottaker skal ha mulighet for å kontakte NAVs kontaktsenter (NKS) når de mottar varselet. Varsler blir sendt litt før NKS åpner, og vi slutter å sende litt før NKS stenger.

Vi tar foreløpig ikke hensyn til røde dager eller produksjonshendelser som fører til at NKS er utilgjengelig.

DAGTID_IKKE_SOENDAG

Vi sender varselet på dagtid, mandag til lørdag. Altså sender vi ikke om kvelden og om natten, og ikke i det hele tatt på søndager.

Vi tar ikke hensyn til røde dager.

LOEPENDE

 Vi sender varslet så fort vi kan.
Example
"NKS_AAPNINGSTID"
Types

SmsKontaktInfoInput

Fields
Input Field Description
fnr - String deprecated. value is ignored.
tlf - String! Må være et gyldig norsk mobilnummer. Kan inneholde landkode på format +47 eller 0047. Nummeret må være gyldig iht norske mobilnummer-regler (40000000-49999999, 90000000-99999999) se https://nkom.no/telefoni-og-telefonnummer/telefonnummer-og-den-norske-nummerplan/alle-nummerserier-for-norske-telefonnumre
Example
{
  "fnr": "xyz789",
  "tlf": "abc123"
}
Types

SmsMottakerInput

Fields
Input Field Description
kontaktinfo - SmsKontaktInfoInput
Example
{"kontaktinfo": SmsKontaktInfoInput}
Types

SoftDeleteNotifikasjonResultat

Types
Union Types

SoftDeleteNotifikasjonVellykket

UgyldigMerkelapp

NotifikasjonFinnesIkke

UkjentProdusent
Example
SoftDeleteNotifikasjonVellykket
Types

SoftDeleteNotifikasjonVellykket

Fields
Field Name Description
id - ID! ID-en til oppgaven du "soft-delete"-et.
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

SoftDeleteSakResultat

Types
Union Types

SoftDeleteSakVellykket

UgyldigMerkelapp

SakFinnesIkke

UkjentProdusent
Example
SoftDeleteSakVellykket
Types

SoftDeleteSakVellykket

Fields
Field Name Description
id - ID! ID-en til saken du "soft-delete"-et.
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

StatusOppdatering

Fields
Field Name Description
status - SaksStatus!
tidspunkt - ISO8601DateTime!
overstyrStatusTekstMed - String
Example
{
  "status": "MOTTATT",
  "tidspunkt": ISO8601DateTime,
  "overstyrStatusTekstMed": "abc123"
}
Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example
"abc123"
Types

TilleggsinformasjonSakResultat

Types
Union Types

TilleggsinformasjonSakVellykket

SakFinnesIkke

Konflikt

UgyldigMerkelapp

UkjentProdusent
Example
TilleggsinformasjonSakVellykket
Types

TilleggsinformasjonSakVellykket

Fields
Field Name Description
id - ID!
Example
{
  "id": "ffb116ee-f5a0-4af6-921f-7e22a167868a"
}
Types

UgyldigKalenderavtale

Description

Kalenderavtalen er ugyldig. Det kan f.eks være at startTidspunkt er etter sluttTidspunkt. Detaljer kommer i feilmelding.

Fields
Field Name Description
feilmelding - String!
Example
{"feilmelding": "xyz789"}
Types

UgyldigMerkelapp

Description

Denne feilen returneres dersom en produsent forsøker å benytte en merkelapp som den ikke har tilgang til.

Fields
Field Name Description
feilmelding - String!
Example
{"feilmelding": "xyz789"}
Types

UgyldigMottaker

Description

Denne feilen returneres dersom en produsent forsøker å benytte en mottaker som den ikke har tilgang til.

Fields
Field Name Description
feilmelding - String!
Example
{"feilmelding": "abc123"}
Types

UgyldigPaaminnelseTidspunkt

Description

Tidpunkt for påminnelse er ugyldig iht grenseverdier. F.eks før opprettelse eller etter frist, eller i fortid.

Fields
Field Name Description
feilmelding - String!
Example
{"feilmelding": "xyz789"}
Types

UkjentProdusent

Description

Denne feilen returneres dersom vi ikke greier å finne dere i produsent-registeret vårt.

Fields
Field Name Description
feilmelding - String!
Example
{"feilmelding": "xyz789"}
Types

UkjentRolle

Fields
Field Name Description
feilmelding - String!
Example
{"feilmelding": "abc123"}