Aktivitetskort as a service - AkaaS 0.0.1

Operations

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

Contact link: Team Dab

Operations

Pub aktivitetskort-v1.1

Topic for å bestille eller oppdatere aktiviteter i aktivitetsplan

Accepts one of the following messages:

#1 Aktivitetskort bestilling aktivitetskortBestilling

Bestilling for oppretting eller endring av et aktivitetskort

aktivitetskort.id må være det samme som kafka key

Payload
object
messageId
required
string
uuid

Unik id for denne meldingen brukes til deduplisering

source
required
string
length <= 200

Applikasjonen eller teamet som er avsender av meldingen.

Enum: "ARENA_TILTAK_AKTIVITET_ACL" "TEAM_TILTAK" "TEAM_KOMET" "REKRUTTERINGSBISTAND"
aktivitetskortType
required
string

Aktivitetskort typer som er tillatt å opprette via tjenesten. Denne enumereringen vil utvides etterhvert. MIDLERTIDIG_LONNSTILSKUDD - Midlertidig lønnstilskudd (Team Tiltak) VARIG_LONNSTILSKUDD - Varig lønnstilskudd (Team Tiltak) ARBEIDSTRENING - Arbeidstrening (Team Tiltak) MENTOR - Mentor (Team Tiltak) INDOPPFAG - Oppfølging (Team Komet) ARBFORB - Arbeidsforberedende trening - AFT (Team Komet) AVKLARAG - Avklaring (Team Komet) VASV - Varig tilrettelagt arbeid i skjermet virksomhet (Team Komet) ARBRRHDAG” - Arbeidsrettet rehabilitering - dag (Team Komet) DIGIOPPARB - Digitalt jobbsøkerkurs for arbeidsledige - jobbklubb (Team Komet) JOBBK - Jobbklubb (Team Komet) GRUPPEAMO Gruppe AMO - arbeidsmarkedsopplæring (Team Komet) GRUFAGYRKE - Gruppe Fag- og yrkesopplæring VGS og høyere yrkesfaglig utdanning (Team Komet) REKRUTTERINGSTREFF - Rekrutteringstreff mellom arbeidsgivere og potensielle arbeidstakere (Team Toi) ARENA_TILTAK - Resten av arbeidsmarkedstiltakene i arena (>100) ENKELAMO - Arbeidsmarkedsopplæring ENKFAGYRKE - Fag- og yrkesopplæring HOYEREUTD - Høyere utdanning

Enum: "MIDLERTIDIG_LONNSTILSKUDD" "VARIG_LONNSTILSKUDD" "ARBEIDSTRENING" "MENTOR" "INDOPPFAG" "ARBFORB" "AVKLARAG" "VASV" "ARBRRHDAG" "DIGIOPPARB" "JOBBK" "GRUPPEAMO" "GRUFAGYRKE" "REKRUTTERINGSTREFF" "ARENA_TILTAK" "ENKELAMO" "ENKFAGYRKE" "HOYEREUTD"
actionType
required
string

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

Enum: "UPSERT_AKTIVITETSKORT_V1" "KASSER_AKTIVITET"
aktivitetskort
required
object
id
required
string
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: "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.

Enum: "FORSLAG" "PLANLAGT" "GJENNOMFORES" "FULLFORT" "AVBRUTT"
startDato
string,null
date

Planlagt startdato for aktiviteten

Examples: "2022-03-01"
sluttDato
string,null
date

Planlagt sluttdato for aktiviteten

Examples: "2022-05-15"
beskrivelse
string,null

Beskrivende tekst for aktiviteten

endretAv
required
object

Sporingsfelt som identifiserer hvem som oppretter eller endrer aktiviteten

Examples: { "ident": "AAA123", "identType": "ARENAIDENT" }
ident
required
string

Id til bruker som oppretter eller endrer aktiviteten. 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

Examples: "Z999999"
identType
required
string
Enum: "ARENAIDENT" "NAVIDENT" "PERSONBRUKERIDENT" "TILTAKSARRAGOER" "ARBEIDSGIVER" "SYSTEM"

Additional properties are NOT allowed.

endretTidspunkt
required
string
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: "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.

oppgave
object,null
ekstern
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
url
intern
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
url
handlinger
array,null<object>

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.

detaljer
array<object>

For å vise selvdefinerte informasjonsfelter på aktivitetskortet. Disse rendres som enkle label/tekst komponenter i samme rekkefølge som de ligger i meldingen.

Items:

0
object
label
string
verdi
string

Additional properties are NOT allowed.

Additional items are allowed.

etiketter
array<object>

Items:

0
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
length <= 20
sentiment
string
Enum: "POSITIVE" "NEGATIVE" "NEUTRAL"
kode
string

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Additional properties are NOT allowed.

Headers
object
Nav-Call-Id
required
string
length >= 1

brukes for logging

Additional properties are allowed.

#2 Aktivitetskort kassering aktivitetskortkassering

Melding som overskriver alle versoner og historikk for aktiviteten

aktivitetsid må være det samme som kafka key

Payload
object
source
required
string
length <= 200

Applikasjonen eller teamet som er avsender av meldingen.

Enum: "ARENA_TILTAK_AKTIVITET_ACL" "TEAM_TILTAK" "TEAM_KOMET" "REKRUTTERINGSBISTAND"
sendt
string
date-time
actionType
required
Const: "KASSER_AKTIVITET"
aktivitetsId
required
string
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: "10068831950"
navIdent
required
string

Id til bruker som kasserer aktivitetskortet

Examples: "Z999999"
begrunnelse
string

begrunnelse for kasseing som er synlig for bruker inne i aktivitetskortet

messageId
required
string
uuid

Unik id for denne meldingen brukes til deduplisering

Additional properties are NOT allowed.

Headers
object
Nav-Call-Id
required
string
length >= 1

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": null,
    "endretAv": {
      "ident": "AAA123",
      "identType": "ARENAIDENT"
    },
    "endretTidspunkt": "2022-09-17T21:00:14+01:00",
    "avtaltMedNav": true,
    "oppgave": null,
    "handlinger": null,
    "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.
{
  "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.

Sub aktivitetskort-feil-v1

Dead-letter kø for aktivitetskort meldinger som ikke kan behandles.

Accepts the following message:

Aktivitetskort feilmelding aktivitetskortFeilMelding

Feilmelding for aktivitetskort som ikke kan behandles

Payload
object
key
required
string
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
length <= 200

Applikasjonen eller teamet som er avsender av meldingen.

Enum: "ARENA_TILTAK_AKTIVITET_ACL" "TEAM_TILTAK" "TEAM_KOMET" "REKRUTTERINGSBISTAND"
timestamp
required
string
date-time
failingMessage
required
string

Hele payloaden til den feilende meldingen

errorMessage
required
string

Feilmelding

Examples: "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

Enum: "AKTIVITET_IKKE_FUNNET" "DESERIALISERINGSFEIL" "DUPLIKATMELDINGFEIL" "KAFKA_KEY_ULIK_AKTIVITETSID" "MANGLER_OPPFOLGINGSPERIODE" "MESSAGEID_LIK_AKTIVITETSID" "UGYLDIG_IDENT" "ULOVLIG_ENDRING"

Additional properties are NOT allowed.

Headers
object
Nav-Call-Id
required
string
length >= 1

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.

Sub aktivitetskort-kvittering-v1

Kvitteringskø for aktivitetskort meldinger.

Accepts the following message:

Aktivitetskort kvittering aktivitetskortkvittering

Kvitteringsmelding for aktivitetskortBestilling

Payload
object
aktivitetId
required
string
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
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.

Enum: "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

Enum: "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
date-time

Dato-tid for behandling av meldingen

Examples: "2022-09-17T21:00:14"

Additional properties are allowed.

Headers
object
Nav-Call-Id
required
string
length >= 1

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.