Virksomhedsindsats.ForbudtOrdService (Version 1, 2024-3)
- WikiUploader
Siden opdateres automatisk til at afspejle koden.
Metoder
CreateForbudtOrd (POST /v1/ForbudtOrd)
Opretter et forbudt ord.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
virksomhedsindsats.forbudtord.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
requestBody | CreateForbudtOrdRequestDto |
| 1 |
|
- ord | string | Length: 1-100 | 1 | Forbudt ord, som fordrer yderligere behandling, hvis det optræder i en jobannonce. |
- id | uuid |
| 0 - 1 | Forburdt ord id. |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | CreateForbudtOrdResponseDto |
| 1 |
|
- id | uuid |
| 1 | Id for det forbudte ord. |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
121000 | Det forbudte ord blev ikke fundet. | Det forbudte ord blev ikke fundet. |
GetForbudteOrd (GET /v1/ForbudtOrd)
Henter samtlige forbudte ord.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
virksomhedsindsats.forbudtord.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetForbudteOrdResponseDto |
| 1 |
|
- forbudteOrd | ForbudtOrdDtoCollection |
| 1 | De forbudte ord objekter, som indeholder id og selve ordet. |
- - ForbudtOrdDto | ForbudtOrdDto |
| 0 - * |
|
- - - id | uuid |
| 1 | Id på det forbudte ord. |
- - - ord | string | Length: 1-100 | 1 | Forbudt ord, som fordrer yderligere behandling, hvis det optræder i en jobannonce. |
- - - oprettetTidspunkt | date-time |
| 1 | Tidspunkt for oprettelse. |
- - - opdateretTidspunkt | date-time |
| 1 | Tidspunkt for seneste opdatering. |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
121000 | Det forbudte ord blev ikke fundet. | Det forbudte ord blev ikke fundet. |
GetForbudtOrd (GET /v1/ForbudtOrd/{id})
Finder et forbudt ord.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
virksomhedsindsats.forbudtord.read
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
id [Path] | uuid |
| 1 |
|
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
response | GetForbudtOrdResponseDto |
| 1 |
|
- forbudtOrd | ForbudtOrdDto |
| 1 |
|
- - id | uuid |
| 1 | Id på det forbudte ord. |
- - ord | string | Length: 1-100 | 1 | Forbudt ord, som fordrer yderligere behandling, hvis det optræder i en jobannonce. |
- - oprettetTidspunkt | date-time |
| 1 | Tidspunkt for oprettelse. |
- - opdateretTidspunkt | date-time |
| 1 | Tidspunkt for seneste opdatering. |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
121000 | Det forbudte ord blev ikke fundet. | Det forbudte ord blev ikke fundet. |
UpdateForbudtOrd (PUT /v1/ForbudtOrd/{id})
Opdaterer et forbudt ord.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
virksomhedsindsats.forbudtord.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
id [Path] | uuid |
| 1 |
|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
requestBody | UpdateForbudtOrdRequestDto |
| 1 |
|
- ord | string | Length: 1-100 | 1 | Forbudt ord, som fordrer yderligere behandling, hvis det optræder i en jobannonce. |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
121000 | Det forbudte ord blev ikke fundet. | Det forbudte ord blev ikke fundet. |
DeleteForbudtOrd (DELETE /v1/ForbudtOrd/{id})
Sletter et forbudt ord.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
|---|---|---|---|---|---|---|---|---|
STAR | X |
|
|
|
|
|
|
|
Scope
virksomhedsindsats.forbudtord.write
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
id [Path] | uuid |
| 1 |
|
x-requestId [Header] | string |
| 1 | Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
121000 | Det forbudte ord blev ikke fundet. | Det forbudte ord blev ikke fundet. |