Skip to content

Commit

Permalink
FIGO-794 oppdater valideringsregler og legg inn eksempel på feilobjekt (
Browse files Browse the repository at this point in the history 
#47)
  • Loading branch information
@jakobskatt
jakobskatt authored Apr 19, 2024
1 parent 0eb0a15 commit eb73926
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 8 deletions.
23 changes: 21 additions & 2 deletions docs/innkrevingsoppdrag/felles-valideringsregler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,27 @@ Valideringsreglene på denne siden er felles for alle oppdragsgivere.

## Synkrone valideringsregler

Ved feil i synkrone valideringer returneres et responsobjekt som
følger [RFC 7807-formatet](https://datatracker.ietf.org/doc/html/rfc7807). Et eksempel på en valideringsfeil for
"Ugyldig fastsettelsesdato" vises nedenfor:

```json
{
"type": "tag:skatteetaten.no,2024:innkreving:innkrevingsoppdrag:ugyldig-fastsettelsesdato",
"title": "Ugyldig fastsettelsesdato",
"status": 422,
"detail": "Ugyldig fastsettelsesdato=2024-04-20. Fastsettelsesdatoen kan ikke være i fremtiden",
"instance": "/api/innkreving/innkrevingsoppdrag/v1/innkrevingsoppdrag"
}
```

Tabellene nedenfor beskriver verdiene til de ulike delene av responsobjektet. Kolonnen **"Title i feilobjekt"** viser
verdien satt i `title`-feltet; i dette tilfellet `Ugyldig fastsettelsesdato`. **"Siste del av type-felt i feilobjekt"**
viser hva som settes etter det siste kolonet i `type`-feltet; i dette tilfellet `ugyldig-fastsettelsesdato`.
HTTP-statuskoden i `status`-feltet er oppført i kolonnen **"Http-status"**. Disse tre verdiene er konstante og kan
benyttes til å utvikle feilhåndteringslogikk. Feltet `detail` gir ytterligere detaljer om feilen og vil variere avhengig
av feilens årsak. Feltet `instance` viser hvilket endepunkt som er kalt.

### Valideringsregler for opprett innkrevingsoppdrag

| Title i feilobjekt | Siste del av type-felt i feilobjekt | Http-status | Merknad |
Expand All @@ -24,8 +45,6 @@ Valideringsreglene på denne siden er felles for alle oppdragsgivere.
| Ugyldig kravtype | ugyldig-kravtype | 422 | Kravtypen må tilhøre oppdragsgiveren |
| Rentebeloep er ikke over 0 | rentebeloep-er-ikke-over-0 | 422 | |
| Ugyldig renterilagtdato | ugyldig-renterilagtdato | 422 | Kan ikke være i fremtiden |
| Ytelser for avregning er ikke over 0 | ytelser-for-avregning-er-ikke-over-0 | 422 | |
| Ugyldig tilbakekrevingsperiode | ugyldig-tilbakekrevingsperiode | 422 | `fom` må være i fortiden. `tom` kan ikke være i fremtiden. `tom` må være etter `fom`. |
| Ugyldig tilleggsinformasjon | ugyldig-tilleggsinformasjon | 400 | Må være oppgitt om påkrevd for oppdragsgiver og være på rett format |

### Felles valideringsregler for alle de øvrige endepunktene
Expand Down
13 changes: 7 additions & 6 deletions docs/innkrevingsoppdrag/oppdragsgiverspesifikke-valideringsregler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@
| Kravtype gjelder kun for organisasjon | kravtype-gjelder-kun-for-organisasjon | 422 | TILBAKEKREVING\_<br/>LOENNSKOMPENSASJON | Det er kun kravtypen TILBAKEKREVING\_<br/>LOENNSKOMPENSASJON som *kun* kan rettes mot organisasjoner. |
| Foreldelsesfristens utgangspunkt eldre enn 2 aar og 11 maaneder | foreldelsesfristens-utgangspunkt-eldre-enn-2-aar-og-11-maaneder | 422 | TILBAKEKREVING\_<br/>FORSKUTTERTE\_<br/>DAGPENGER | |
| Tilleggsfrist etter foreldelsesloven eldre enn 11 maaneder | tilleggsfrist-etter-foreldelsesloven-eldre-enn-11-maaneder | 422 | TILBAKEKREVING\_<br/>FORSKUTTERTE\_<br/>DAGPENGER | |
| Ytelser for avregning er ikke over 0 | ytelser-for-avregning-er-ikke-over-0 | 422 | Alle kravtyper | |
| Ugyldig tilbakekrevingsperiode | ugyldig-tilbakekrevingsperiode | 422 | Alle kravtyper | `tom` kan ikke være i fremtiden. `fom` kan ikke være etter `tom`. |

### Asynkrone valideringsregler

Expand All @@ -24,18 +26,17 @@
| Organisasjonsnummer finnes ikke | <pre><code>{<br/> "error": "ORGANISASJONSNUMMER_FINNES_IKKE",<br/> "message": "Organisasjon med organisasjonsnummer=xxxxxxxxx finnes ikke. "<br/>}</code></pre> | Alle | Kan komme tilleggsinformasjon om at virksomheten er slettet, eller slettet som følge av dublett med nytt organisasjonsnummer om denne informasjonen er tilgjengelig. |
| Organisasjon er opphørt | <pre><code>{<br/> "error": "ORGANISASJON_ER_OPPHOERT",<br/> "message": "Organisasjon med organisasjonsnummer=xxxxxxxxx er opphørt. "<br/>}</code></pre> | Alle | |



## Brønnøysundregistrene

### Synkrone valideringsregler

#### Opprett innkrevingsoppdrag

| Title i feilobjekt | Siste del av type-felt i feilobjekt | Http-status |
|-----------------------------------------------------------------|-----------------------------------------------------------------|-------------|
| Kravtype gjelder kun for organisasjon | kravtype-gjelder-kun-for-organisasjon | 422 |

| Title i feilobjekt | Siste del av type-felt i feilobjekt | Http-status | Merknad |
|---------------------------------------|---------------------------------------|-------------|-------------------------------------------------------------------|
| Kravtype gjelder kun for organisasjon | kravtype-gjelder-kun-for-organisasjon | 422 | |
| Ugyldig tilbakekrevingsperiode | ugyldig-tilbakekrevingsperiode | 422 | `tom` kan ikke være i fremtiden. `fom` kan ikke være etter `tom`. |
| Ugyldig stoppdato for løpende mulkt | ugyldig-stoppdato-for-løpende-mulkt | 422 | `stoppdatoForLøpendeMulkt` kan ikke være i fremtiden. |

#### Endring av hovedstol

Expand Down

0 comments on commit eb73926

Please sign in to comment.