Aktivitetskort as a service - AkaaS 0.0.1 documentation

Aktivitetskort as a service - AkaaS 0.0.1

Data-drevet grensesnitt for å opprette og endre aktivitetskort i aktivitetsplanen.
Løsningen er beregnet på team som har data i sine systemer som skal representeres som en aktivitet i aktivitetsplan, for eksempel tiltaksgjennomføringer. Eksisterende aktiviteter kan oppdateres ved å sende en ny versjon av aktivitetskortet med samme funksjonelle id.
Tjenesten har støtte for en rekke dynamiske innholdskomponenter i aktivitetskortet, slik at produsentene på tjenesten har stor grad av kontroll på hvordan aktivitetskortet skal se ut.
Dynamiske komponenter inkluderer 'oppgave', 'handlinger', 'detaljer' og 'etiketter'. Disse er beskrevet i skjemaet.
Lenke til Mural

Operations

RECEIVE aktivitetskort-v1.1
Topic for å bestille eller oppdatere aktiviteter i aktivitetsplan

Operation IDpublish
object
key
string
format: uuid
aktiviteskorts id. Også kalt funksjonell id
Accepts one of the following messages:
- #0Aktivitetskort bestilling
  Bestilling for oppretting eller endring av et aktivitetskort
  application/json
  aktivitetskort.id må være det samme som kafka key
  
  object
  uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.aktivitetskort.schema.yml
  messageId
  required
  string
  format: uuid
  Unik id for denne meldingen brukes til deduplisering
  
  source
  required
  string
  <= 200 characters
  Applikasjonen eller teamet som er avsender av meldingen.
  
  Allowed values:
  "ARENA_TILTAK_AKTIVITET_ACL"
  "TEAM_TILTAK"
  "TEAM_KOMET"
  aktivitetskortType
  required
  string
  uid: aktivitetskortType
  Aktivitetskort typer som er tillatt å opprette via tjenesten. Denne enumereringen vil utvides etterhvert. MIDLERTIDIG_LONNSTILSKUDD - Midlertidig lønnstilskudd VARIG_LONNSTILSKUDD - Varig lønnstilskudd INDOPPFAG - Oppfølging ARBFORB - Arbeidsforberedende trening (AFT) AVKLARAG - Avklaring VASV - Varig tilrettelagt arbeid i skjermet virksomhet ARBRRHDAG” - Arbeidsrettet rehabilitering (dag) DIGIOPPARB - Digitalt jobbsøkerkurs for arbeidsledige (jobbklubb) JOBBK - Jobbklubb GRUPPEAMO Gruppe AMO (arbeidsmarkedsopplæring) GRUFAGYRKE - Gruppe Fag- og yrkesopplæring VGS og høyere yrkesfaglig utdanning ARENA_TILTAK - Resten av arbeidsmarkedstiltakene i arena (>100)
  
  Allowed values:
  "MIDLERTIDIG_LONNSTILSKUDD"
  "VARIG_LONNSTILSKUDD"
  "INDOPPFAG"
  "ARBFORB"
  "AVKLARAG"
  "VASV"
  "ARBRRHDAG"
  "DIGIOPPARB"
  "JOBBK"
  "GRUPPEAMO"
  "GRUFAGYRKE"
  "ARENA_TILTAK"
  actionType
  required
  string
  Actiontype forteller hvordan meldingen skal behandles. Forløpig har vi kun støtte for å opprette/oppdatere (UPSERT) og kassere aktivitetskort.
  
  Allowed values:
  "UPSERT_AKTIVITETSKORT_V1"
  "KASSER_AKTIVITET"
  required
  object
  id
  required
  string
  format: uuid
  Funksjonell ID for aktiviteten er en globalt unik UUID for aktiviteten. Ved vellykket opprettelse av aktiviteten, vil aktiviteten kunne gjenfinnnes ved hjelp av denne iden. Senere modifisering av samme aktivitet vil også bruke denne iden for å identifisere korrekt aktivitet.
  
  personIdent
  required
  string
  Norsk identitetsnummer (d-nr eller f-nr) for personen som eier aktivitetskortet
  
  Examples values:
  "10068831950"
  tittel
  required
  string
  Tittelen på aktivitetskortet
  
  aktivitetStatus
  required
  string
  Dette feltet forteller hvilken status aktiviteten har, og dermed hvilken kolonne aktivitetskortet skal ligge i i aktivitetsplanen. Merk at aktivitetskort som er fullført eller avbrutt ikke kan endres i etterkant, da dette er en endelig status.
  
  Allowed values:
  "FORSLAG"
  "PLANLAGT"
  "GJENNOMFORES"
  "FULLFORT"
  "AVBRUTT"
  startDato
  string | null
  format: date
  Planlagt startdato for aktiviteten
  
  Examples values:
  "2022-03-01"
  sluttDato
  string | null
  format: date
  Planlagt sluttdato for aktiviteten
  
  Examples values:
  "2022-05-15"
  beskrivelse
  string | null
  Beskrivende tekst for aktiviteten
  
  required
  object
  Sporingsfelt som identifiserer hvem som oppretter eller endrer aktiviteten
  
  Examples values:
  {"ident":"AAA123","identType":"ARENAIDENT"}
  ident
  required
  string
  Id til bruker som oppretter eller endrer aktiviteten
  
  Examples values:
  "Z999999"
  identType
  required
  string
  Tiltaksarrangør og arbeidsgiver er orgNr. Personbruker er norsk-ident (dnr eller fnr). Navident er ident til navansatt: feks Z999999. Arenaident: kun til intern bruk. System: Systembruker
  
  Allowed values:
  "ARENAIDENT"
  "NAVIDENT"
  "PERSONBRUKER"
  "TILTAKSARRAGOER"
  "ARBEIDSGIVER"
  "SYSTEM"
  Additional properties are NOT allowed.
  endretTidspunkt
  required
  string
  format: date-time
  Dato-tid for opprettelse eller endring i kildesystemet i ISO8601 format (ZonedDateTime). Vær oppmerksom på at dersom du ikke oppgir sone, vil tidspunktet bli tolket som vår lokale tidssone, altså Europe/Oslo
  
  Examples values:
  "2022-09-17T21:00:14+01:00"
  avtaltMedNav
  required
  boolean
  Hvorvidt aktiviteten skal bli markert som 'Avtalt med NAV'. Dette gjelder typisk aktiviteter med aktivitetsplikt.
  
  object | null
  object | null
  En oppgave vil bli rendret som et alert-panel med en lenke i aktivitetskortet. Dette signaliserer at det er en oppgave bruker eller veileder trenger å gjøre (f.eks. signere en avtale). Selve handlingen vil utføres i et annet system enn aktivitetsplan, og vil typisk resultere i en ny versjon av aktiviteten med oppdatert status sendes inn på denne tjenesten.
  
  tekst
  string
  subtekst
  string
  url
  string
  format: url
  Additional properties are NOT allowed.
  object | null
  En oppgave vil bli rendret som et alert-panel med en lenke i aktivitetskortet. Dette signaliserer at det er en oppgave bruker eller veileder trenger å gjøre (f.eks. signere en avtale). Selve handlingen vil utføres i et annet system enn aktivitetsplan, og vil typisk resultere i en ny versjon av aktiviteten med oppdatert status sendes inn på denne tjenesten.
  
  tekst
  string
  subtekst
  string
  url
  string
  format: url
  Additional properties are NOT allowed.
  Additional properties are NOT allowed.
  array<object> | null
  Handlinger vil rendres som lenkeseksjoner i aktivitetskortet. Dette kan brukes for å tilby tilleggsfunksjonalitet i kildesystemet, f.eks. Les avtalen, Evaluer deltakelsen på tiltaket, o.l.
  
  object
  tekst
  string
  subtekst
  string
  url
  string
  format: url
  lenkeType
  string
  Allowed values:
  "EKSTERN"
  "INTERN"
  "FELLES"
  Additional properties are NOT allowed.
  array<object>
  For å vise selvdefinerte informasjonsfelter på aktivitetskortet. Disse rendres som enkle label/tekst komponenter i samme rekkefølge som de ligger i meldingen.
  
  object
  label
  string
  verdi
  string
  Additional properties are NOT allowed.
  array<object>
  object
  Etiketter rendres som etiketter (Tags) på aktivitetskortet. Teksten som sendes inn vil vises som på etiketten med styling basert på sentimentet. Kode er valgfritt og blir foreløpig ikke brukt.
  
  tekst
  string
  <= 20 characters
  sentiment
  string
  Allowed values:
  "POSITIVE"
  "NEGATIVE"
  "NEUTRAL"
  kode
  string
  Additional properties are NOT allowed.
  Additional properties are NOT allowed.
  Additional properties are NOT allowed.
  object
  uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.headers.schema.yml
  Nav-Call-Id
  required
  string
  non-empty
  brukes for logging
  
  Additional properties are allowed.
  Examples
  { "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "source": "ARENA_TILTAK_AKTIVITET_ACL", "aktivitetskortType": "MIDLERTIDIG_LONNSTILSKUDD", "actionType": "UPSERT_AKTIVITETSKORT_V1", "aktivitetskort": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "personIdent": "10068831950", "tittel": "string", "aktivitetStatus": "FORSLAG", "startDato": "2022-03-01", "sluttDato": "2022-05-15", "beskrivelse": "string", "endretAv": { "ident": "AAA123", "identType": "ARENAIDENT" }, "endretTidspunkt": "2022-09-17T21:00:14+01:00", "avtaltMedNav": true, "oppgave": { "ekstern": { "tekst": "string", "subtekst": "string", "url": "string" }, "intern": { "tekst": "string", "subtekst": "string", "url": "string" } }, "handlinger": [ { "tekst": "string", "subtekst": "string", "url": "string", "lenkeType": "EKSTERN" } ], "detaljer": [ { "label": "string", "verdi": "string" } ], "etiketter": [ { "tekst": "string", "sentiment": "POSITIVE", "kode": "string" } ] } }
  
  This example has been generated automatically.
  { "Nav-Call-Id": "string" }
  
  This example has been generated automatically.
- #1Aktivitetskort kassering
  Melding som overskriver alle versoner og historikk for aktiviteten
  application/json
  aktivitetsid må være det samme som kafka key
  
  object
  uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.kasser.schema.yml
  source
  required
  string
  <= 200 characters
  Applikasjonen eller teamet som er avsender av meldingen.
  
  Allowed values:
  "ARENA_TILTAK_AKTIVITET_ACL"
  "TEAM_TILTAK"
  "TEAM_KOMET"
  sendt
  string
  format: date-time
  actionType
  required
  string
  Const:"KASSER_AKTIVITET"
  aktivitetsId
  required
  string
  format: uuid
  Funksjonell ID for aktiviteten er en globalt unik UUID for aktiviteten. Ved vellykket opprettelse av aktiviteten, vil aktiviteten kunne gjenfinnnes ved hjelp av denne iden. Senere modifisering av samme aktivitet vil også bruke denne iden for å identifisere korrekt aktivitet.
  
  personIdent
  required
  string
  Norsk identitetsnummer (d-nr eller f-nr) for personen som eier aktivitetskortet
  
  Examples values:
  "10068831950"
  navIdent
  required
  string
  Id til bruker som kasserer aktivitetskortet
  
  Examples values:
  "Z999999"
  begrunnelse
  string
  begrunnelse for kasseing som er synlig for bruker inne i aktivitetskortet
  
  messageId
  required
  string
  format: uuid
  Unik id for denne meldingen brukes til deduplisering
  
  Additional properties are NOT allowed.
  object
  uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.headers.schema.yml
  Nav-Call-Id
  required
  string
  non-empty
  brukes for logging
  
  Additional properties are allowed.
  Examples
  { "source": "ARENA_TILTAK_AKTIVITET_ACL", "sendt": "2019-08-24T14:15:22Z", "actionType": "KASSER_AKTIVITET", "aktivitetsId": "2496547e-d7bb-486b-b8ce-fa3a10bf1f8e", "personIdent": "10068831950", "navIdent": "Z999999", "begrunnelse": "string", "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85" }
  
  This example has been generated automatically.
  { "Nav-Call-Id": "string" }
  
  This example has been generated automatically.
SEND aktivitetskort-feil-v1
Dead-letter kø for aktivitetskort meldinger som ikke kan behandles.

Operation IDsubscribe
object
key
string
format: uuid
aktiviteskorts id. Også kalt funksjonell id
Accepts the following message:
Aktivitetskort feilmelding
Feilmelding for aktivitetskort som ikke kan behandles
application/json
object
uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.aktivitetskortfeilmelding.schema.yml
key
required
string
format: uuid
Funksjonell ID for aktiviteten er en globalt unik UUID for aktiviteten. Ved vellykket opprettelse av aktiviteten, vil aktiviteten kunne gjenfinnnes ved hjelp av denne iden. Senere modifisering av samme aktivitet vil også bruke denne iden for å identifisere korrekt aktivitet.

source
required
string
<= 200 characters
Applikasjonen eller teamet som er avsender av meldingen.

Allowed values:
"ARENA_TILTAK_AKTIVITET_ACL"
"TEAM_TILTAK"
"TEAM_KOMET"
timestamp
required
string
format: date-time
failingMessage
required
string
Hele payloaden til den feilende meldingen

errorMessage
required
string
Feilmelding

Examples values:
"DuplikatMeldingFeil Melding allerede handtert, ignorer"
"DeserialiseringsFeil Meldingspayload er ikke gyldig json"
"ManglerOppfolgingsperiodeFeil Finner ingen passende oppfølgingsperiode for aktivitetskortet."
errorType
required
string
Alle mulige funksjonelle-feil som kan oppstå under prosessering av aktivitetskort-meldinger og kasserings-meldinger

Allowed values:
"AKTIVITET_IKKE_FUNNET"
"DESERIALISERINGSFEIL"
"DUPLIKATMELDINGFEIL"
"KAFKA_KEY_ULIK_AKTIVITETSID"
"MANGLER_OPPFOLGINGSPERIODE"
"MESSAGEID_LIK_AKTIVITETSID"
"UGYLDIG_IDENT"
"ULOVLIG_ENDRING"
Additional properties are NOT allowed.
object
uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.headers.schema.yml
Nav-Call-Id
required
string
non-empty
brukes for logging

Additional properties are allowed.
Examples
{ "key": "4adfe27e-63d3-45b9-8238-62b6ed6fdb5e", "source": "ARENA_TILTAK_AKTIVITET_ACL", "timestamp": "2019-08-24T14:15:22Z", "failingMessage": "string", "errorMessage": "DuplikatMeldingFeil Melding allerede handtert, ignorer", "errorType": "AKTIVITET_IKKE_FUNNET" }

This example has been generated automatically.
{ "Nav-Call-Id": "string" }

This example has been generated automatically.
SEND aktivitetskort-kvittering-v1
Kvitteringskø for aktivitetskort meldinger.

Operation IDsubscribe
object
key
string
format: uuid
aktiviteskorts id. Også kalt funksjonell id
Accepts the following message:
Aktivitetskort kvittering
Kvitteringsmelding for aktivitetskortBestilling
application/json
object
uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.aktivitetskortkvittering.schema.yml
aktivitetId
required
string
format: uuid
Funksjonell ID for aktiviteten er en globalt unik UUID for aktiviteten. Ved vellykket opprettelse av aktiviteten, vil aktiviteten kunne gjenfinnnes ved hjelp av denne iden. Senere modifisering av samme aktivitet vil også bruke denne iden for å identifisere korrekt aktivitet.

meldingId
string
format: uuid
Samme meldingsid som aktivitetskort-bestillingen

behandlingstype
required
string
Actiontype forteller hvordan meldingen skal behandles. Forløpig har vi kun støtte for å opprette/oppdatere (UPSERT) og kassere aktivitetskort.

Allowed values:
"UPSERT_AKTIVITETSKORT_V1"
"KASSER_AKTIVITET"
suksess
required
boolean
Sier om behandling av meldingen var vellykket. Dersom 'false' vil behandlingsStatus og feilmelding gi ytterligere informasjon om feilen.

behandlingsStatus
required
string
Alle mulige funksjonelle-feil som kan oppstå under prosessering av aktivitetskort-meldinger og kasserings-meldinger

Allowed values:
"AKTIVITET_IKKE_FUNNET"
"DESERIALISERINGSFEIL"
"DUPLIKATMELDINGFEIL"
"KAFKA_KEY_ULIK_AKTIVITETSID"
"MANGLER_OPPFOLGINGSPERIODE"
"MESSAGEID_LIK_AKTIVITETSID"
"UGYLDIG_IDENT"
"ULOVLIG_ENDRING"
feilmelding
string
I tilfelle feil, inneholder exception.message.

behandlet
required
string
format: date-time
Dato-tid for behandling av meldingen

Examples values:
"2022-09-17T21:00:14"
Additional properties are allowed.
object
uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.headers.schema.yml
Nav-Call-Id
required
string
non-empty
brukes for logging

Additional properties are allowed.
Examples
{ "aktivitetId": "3f51fc70-3148-4d62-974b-0ec4829b04db", "meldingId": "419632a9-96a3-48f4-a46f-b808b670e760", "behandlingstype": "UPSERT_AKTIVITETSKORT_V1", "suksess": true, "behandlingsStatus": "AKTIVITET_IKKE_FUNNET", "feilmelding": "string", "behandlet": "2022-09-17T21:00:14" }

This example has been generated automatically.
{ "Nav-Call-Id": "string" }

This example has been generated automatically.

Messages

#1Aktivitetskort bestillingaktivitetskort
Bestilling for oppretting eller endring av et aktivitetskort
- application/json
Message IDaktivitetskort
aktivitetskort.id må være det samme som kafka key
object
uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.aktivitetskort.schema.yml
messageId
required
string
format: uuid
Unik id for denne meldingen brukes til deduplisering

source
required
string
<= 200 characters
Applikasjonen eller teamet som er avsender av meldingen.

Allowed values:
"ARENA_TILTAK_AKTIVITET_ACL"
"TEAM_TILTAK"
"TEAM_KOMET"
aktivitetskortType
required
string
uid: aktivitetskortType
Aktivitetskort typer som er tillatt å opprette via tjenesten. Denne enumereringen vil utvides etterhvert. MIDLERTIDIG_LONNSTILSKUDD - Midlertidig lønnstilskudd VARIG_LONNSTILSKUDD - Varig lønnstilskudd INDOPPFAG - Oppfølging ARBFORB - Arbeidsforberedende trening (AFT) AVKLARAG - Avklaring VASV - Varig tilrettelagt arbeid i skjermet virksomhet ARBRRHDAG” - Arbeidsrettet rehabilitering (dag) DIGIOPPARB - Digitalt jobbsøkerkurs for arbeidsledige (jobbklubb) JOBBK - Jobbklubb GRUPPEAMO Gruppe AMO (arbeidsmarkedsopplæring) GRUFAGYRKE - Gruppe Fag- og yrkesopplæring VGS og høyere yrkesfaglig utdanning ARENA_TILTAK - Resten av arbeidsmarkedstiltakene i arena (>100)

Allowed values:
"MIDLERTIDIG_LONNSTILSKUDD"
"VARIG_LONNSTILSKUDD"
"INDOPPFAG"
"ARBFORB"
"AVKLARAG"
"VASV"
"ARBRRHDAG"
"DIGIOPPARB"
"JOBBK"
"GRUPPEAMO"
"GRUFAGYRKE"
"ARENA_TILTAK"
actionType
required
string
Actiontype forteller hvordan meldingen skal behandles. Forløpig har vi kun støtte for å opprette/oppdatere (UPSERT) og kassere aktivitetskort.

Allowed values:
"UPSERT_AKTIVITETSKORT_V1"
"KASSER_AKTIVITET"
required
object
id
required
string
format: uuid
Funksjonell ID for aktiviteten er en globalt unik UUID for aktiviteten. Ved vellykket opprettelse av aktiviteten, vil aktiviteten kunne gjenfinnnes ved hjelp av denne iden. Senere modifisering av samme aktivitet vil også bruke denne iden for å identifisere korrekt aktivitet.

personIdent
required
string
Norsk identitetsnummer (d-nr eller f-nr) for personen som eier aktivitetskortet

Examples values:
"10068831950"
tittel
required
string
Tittelen på aktivitetskortet

aktivitetStatus
required
string
Dette feltet forteller hvilken status aktiviteten har, og dermed hvilken kolonne aktivitetskortet skal ligge i i aktivitetsplanen. Merk at aktivitetskort som er fullført eller avbrutt ikke kan endres i etterkant, da dette er en endelig status.

Allowed values:
"FORSLAG"
"PLANLAGT"
"GJENNOMFORES"
"FULLFORT"
"AVBRUTT"
startDato
string | null
format: date
Planlagt startdato for aktiviteten

Examples values:
"2022-03-01"
sluttDato
string | null
format: date
Planlagt sluttdato for aktiviteten

Examples values:
"2022-05-15"
beskrivelse
string | null
Beskrivende tekst for aktiviteten

required
object
Sporingsfelt som identifiserer hvem som oppretter eller endrer aktiviteten

Examples values:
{"ident":"AAA123","identType":"ARENAIDENT"}
ident
required
string
Id til bruker som oppretter eller endrer aktiviteten

Examples values:
"Z999999"
identType
required
string
Tiltaksarrangør og arbeidsgiver er orgNr. Personbruker er norsk-ident (dnr eller fnr). Navident er ident til navansatt: feks Z999999. Arenaident: kun til intern bruk. System: Systembruker

Allowed values:
"ARENAIDENT"
"NAVIDENT"
"PERSONBRUKER"
"TILTAKSARRAGOER"
"ARBEIDSGIVER"
"SYSTEM"
Additional properties are NOT allowed.
endretTidspunkt
required
string
format: date-time
Dato-tid for opprettelse eller endring i kildesystemet i ISO8601 format (ZonedDateTime). Vær oppmerksom på at dersom du ikke oppgir sone, vil tidspunktet bli tolket som vår lokale tidssone, altså Europe/Oslo

Examples values:
"2022-09-17T21:00:14+01:00"
avtaltMedNav
required
boolean
Hvorvidt aktiviteten skal bli markert som 'Avtalt med NAV'. Dette gjelder typisk aktiviteter med aktivitetsplikt.

object | null
object | null
En oppgave vil bli rendret som et alert-panel med en lenke i aktivitetskortet. Dette signaliserer at det er en oppgave bruker eller veileder trenger å gjøre (f.eks. signere en avtale). Selve handlingen vil utføres i et annet system enn aktivitetsplan, og vil typisk resultere i en ny versjon av aktiviteten med oppdatert status sendes inn på denne tjenesten.

tekst
string
subtekst
string
url
string
format: url
Additional properties are NOT allowed.
object | null
En oppgave vil bli rendret som et alert-panel med en lenke i aktivitetskortet. Dette signaliserer at det er en oppgave bruker eller veileder trenger å gjøre (f.eks. signere en avtale). Selve handlingen vil utføres i et annet system enn aktivitetsplan, og vil typisk resultere i en ny versjon av aktiviteten med oppdatert status sendes inn på denne tjenesten.

tekst
string
subtekst
string
url
string
format: url
Additional properties are NOT allowed.
Additional properties are NOT allowed.
array<object> | null
Handlinger vil rendres som lenkeseksjoner i aktivitetskortet. Dette kan brukes for å tilby tilleggsfunksjonalitet i kildesystemet, f.eks. Les avtalen, Evaluer deltakelsen på tiltaket, o.l.

object
tekst
string
subtekst
string
url
string
format: url
lenkeType
string
Allowed values:
"EKSTERN"
"INTERN"
"FELLES"
Additional properties are NOT allowed.
array<object>
For å vise selvdefinerte informasjonsfelter på aktivitetskortet. Disse rendres som enkle label/tekst komponenter i samme rekkefølge som de ligger i meldingen.

object
label
string
verdi
string
Additional properties are NOT allowed.
array<object>
object
Etiketter rendres som etiketter (Tags) på aktivitetskortet. Teksten som sendes inn vil vises som på etiketten med styling basert på sentimentet. Kode er valgfritt og blir foreløpig ikke brukt.

tekst
string
<= 20 characters
sentiment
string
Allowed values:
"POSITIVE"
"NEGATIVE"
"NEUTRAL"
kode
string
Additional properties are NOT allowed.
Additional properties are NOT allowed.
Additional properties are NOT allowed.
object
uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.headers.schema.yml
Nav-Call-Id
required
string
non-empty
brukes for logging

Additional properties are allowed.
#2Aktivitetskort kasseringkassering
Melding som overskriver alle versoner og historikk for aktiviteten
- application/json
Message IDkassering
aktivitetsid må være det samme som kafka key
object
uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.kasser.schema.yml
source
required
string
<= 200 characters
Applikasjonen eller teamet som er avsender av meldingen.

Allowed values:
"ARENA_TILTAK_AKTIVITET_ACL"
"TEAM_TILTAK"
"TEAM_KOMET"
sendt
string
format: date-time
actionType
required
string
Const:"KASSER_AKTIVITET"
aktivitetsId
required
string
format: uuid
Funksjonell ID for aktiviteten er en globalt unik UUID for aktiviteten. Ved vellykket opprettelse av aktiviteten, vil aktiviteten kunne gjenfinnnes ved hjelp av denne iden. Senere modifisering av samme aktivitet vil også bruke denne iden for å identifisere korrekt aktivitet.

personIdent
required
string
Norsk identitetsnummer (d-nr eller f-nr) for personen som eier aktivitetskortet

Examples values:
"10068831950"
navIdent
required
string
Id til bruker som kasserer aktivitetskortet

Examples values:
"Z999999"
begrunnelse
string
begrunnelse for kasseing som er synlig for bruker inne i aktivitetskortet

messageId
required
string
format: uuid
Unik id for denne meldingen brukes til deduplisering

Additional properties are NOT allowed.
object
uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.headers.schema.yml
Nav-Call-Id
required
string
non-empty
brukes for logging

Additional properties are allowed.
#3Aktivitetskort feilmeldingaktivitetskortfeilmelding
Feilmelding for aktivitetskort som ikke kan behandles
- application/json
Message IDaktivitetskortfeilmelding
object
uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.aktivitetskortfeilmelding.schema.yml
key
required
string
format: uuid
Funksjonell ID for aktiviteten er en globalt unik UUID for aktiviteten. Ved vellykket opprettelse av aktiviteten, vil aktiviteten kunne gjenfinnnes ved hjelp av denne iden. Senere modifisering av samme aktivitet vil også bruke denne iden for å identifisere korrekt aktivitet.

source
required
string
<= 200 characters
Applikasjonen eller teamet som er avsender av meldingen.

Allowed values:
"ARENA_TILTAK_AKTIVITET_ACL"
"TEAM_TILTAK"
"TEAM_KOMET"
timestamp
required
string
format: date-time
failingMessage
required
string
Hele payloaden til den feilende meldingen

errorMessage
required
string
Feilmelding

Examples values:
"DuplikatMeldingFeil Melding allerede handtert, ignorer"
"DeserialiseringsFeil Meldingspayload er ikke gyldig json"
"ManglerOppfolgingsperiodeFeil Finner ingen passende oppfølgingsperiode for aktivitetskortet."
errorType
required
string
Alle mulige funksjonelle-feil som kan oppstå under prosessering av aktivitetskort-meldinger og kasserings-meldinger

Allowed values:
"AKTIVITET_IKKE_FUNNET"
"DESERIALISERINGSFEIL"
"DUPLIKATMELDINGFEIL"
"KAFKA_KEY_ULIK_AKTIVITETSID"
"MANGLER_OPPFOLGINGSPERIODE"
"MESSAGEID_LIK_AKTIVITETSID"
"UGYLDIG_IDENT"
"ULOVLIG_ENDRING"
Additional properties are NOT allowed.
object
uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.headers.schema.yml
Nav-Call-Id
required
string
non-empty
brukes for logging

Additional properties are allowed.
#4Aktivitetskort kvitteringaktivitetskortkvittering
Kvitteringsmelding for aktivitetskortBestilling
- application/json
Message IDaktivitetskortkvittering
object
uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.aktivitetskortkvittering.schema.yml
aktivitetId
required
string
format: uuid
Funksjonell ID for aktiviteten er en globalt unik UUID for aktiviteten. Ved vellykket opprettelse av aktiviteten, vil aktiviteten kunne gjenfinnnes ved hjelp av denne iden. Senere modifisering av samme aktivitet vil også bruke denne iden for å identifisere korrekt aktivitet.

meldingId
string
format: uuid
Samme meldingsid som aktivitetskort-bestillingen

behandlingstype
required
string
Actiontype forteller hvordan meldingen skal behandles. Forløpig har vi kun støtte for å opprette/oppdatere (UPSERT) og kassere aktivitetskort.

Allowed values:
"UPSERT_AKTIVITETSKORT_V1"
"KASSER_AKTIVITET"
suksess
required
boolean
Sier om behandling av meldingen var vellykket. Dersom 'false' vil behandlingsStatus og feilmelding gi ytterligere informasjon om feilen.

behandlingsStatus
required
string
Alle mulige funksjonelle-feil som kan oppstå under prosessering av aktivitetskort-meldinger og kasserings-meldinger

Allowed values:
"AKTIVITET_IKKE_FUNNET"
"DESERIALISERINGSFEIL"
"DUPLIKATMELDINGFEIL"
"KAFKA_KEY_ULIK_AKTIVITETSID"
"MANGLER_OPPFOLGINGSPERIODE"
"MESSAGEID_LIK_AKTIVITETSID"
"UGYLDIG_IDENT"
"ULOVLIG_ENDRING"
feilmelding
string
I tilfelle feil, inneholder exception.message.

behandlet
required
string
format: date-time
Dato-tid for behandling av meldingen

Examples values:
"2022-09-17T21:00:14"
Additional properties are allowed.
object
uid: https://navikt.github.io/veilarbaktivitet/schemas/akaas/Aktivitetskort.V1.headers.schema.yml
Nav-Call-Id
required
string
non-empty
brukes for logging

Additional properties are allowed.

Aktivitetskort as a service - AkaaS 0.0.1

Operations

RECEIVE aktivitetskort-v1.1

Examples

This example has been generated automatically.

This example has been generated automatically.

Examples

This example has been generated automatically.

This example has been generated automatically.

SEND aktivitetskort-feil-v1

Examples

This example has been generated automatically.

This example has been generated automatically.

SEND aktivitetskort-kvittering-v1

Examples

This example has been generated automatically.

This example has been generated automatically.

Messages