Virksomhedsindsats.ForbudtOrdService (Version 1 [UDV], 2024-1)

Owned by Rolf Marcher Arndt
Last updated: Dec 15, 2023
2 min read

Siden opdateres automatisk til at afspejle koden.

Metoder

CreateForbudtOrd (POST /v1/ForbudtOrd)

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

 

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

X-ActiveOrganisation [Header]

ActiveOrganisationDto

 

1

Impersoneret myndighed

-    organisationType

OrganisationTypeCodeList

 

1

 

-    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

X-RequestUserMetadata [Header]

RequestUserMetadataDto

 

1

Kaldende myndighed

-    requestUserStructure

RequestUserStructureDto

 

1

 

-    -    userFullName

string

Length: 1-140

1

 

-    -    requestUserType

RequestUserTypeCodeList

 

1

 

-    -    userIdentifier

string

Length: 1-255

1

 

-    -    userEmail

email

 

0 - 1

 

-    requestOrganisationStructure

RequestOrganisationStructureDto

 

1

 

-    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

-    registrationDateTime

date-time

 

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

CreateForbudtOrdRequestDto

 

1

 

-    ord

string

MinLength: 1

1

Det forbudte ord, som skal fordre yderligere behandling, hvis det optræder i en jobannonce.

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1014

The submitted message is not valid

The submitted message is not valid

GetForbudteOrd (GET /v1/ForbudtOrd)

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

 

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

X-ActiveOrganisation [Header]

ActiveOrganisationDto

 

1

Impersoneret myndighed

-    organisationType

OrganisationTypeCodeList

 

1

 

-    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

X-RequestUserMetadata [Header]

RequestUserMetadataDto

 

1

Kaldende myndighed

-    requestUserStructure

RequestUserStructureDto

 

1

 

-    -    userFullName

string

Length: 1-140

1

 

-    -    requestUserType

RequestUserTypeCodeList

 

1

 

-    -    userIdentifier

string

Length: 1-255

1

 

-    -    userEmail

email

 

0 - 1

 

-    requestOrganisationStructure

RequestOrganisationStructureDto

 

1

 

-    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

-    registrationDateTime

date-time

 

1

 

Output

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

response

GetForbudteOrdResponseDto

 

1

 

-    ord

ForbudtOrdDtoCollection

 

1

De forbudte ord objekter, som indeholder id og selve ordet.

-    -    ForbudtOrdDto

ForbudtOrdDto

 

0 - *

 

-    -    -    id

int32

 

1

Id på det forbudte ord

-    -    -    ord

string

MinLength: 1

1

Det forbudte ord, som fordrer yderligere behandling, hvis det optræder i en jobannonce.

Fejlkoder

Ingen fejlkoder

UpdateForbudtOrd (PUT /v1/ForbudtOrd/{id})

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

 

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

id [Path]

int32

 

1

 

X-ActiveOrganisation [Header]

ActiveOrganisationDto

 

1

Impersoneret myndighed

-    organisationType

OrganisationTypeCodeList

 

1

 

-    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

X-RequestUserMetadata [Header]

RequestUserMetadataDto

 

1

Kaldende myndighed

-    requestUserStructure

RequestUserStructureDto

 

1

 

-    -    userFullName

string

Length: 1-140

1

 

-    -    requestUserType

RequestUserTypeCodeList

 

1

 

-    -    userIdentifier

string

Length: 1-255

1

 

-    -    userEmail

email

 

0 - 1

 

-    requestOrganisationStructure

RequestOrganisationStructureDto

 

1

 

-    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

-    registrationDateTime

date-time

 

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

MinLength: 1

1

Det forbudte ord, som fordrer yderligere behandling, hvis det optræder i en jobannonce.

Output

Intet output

Fejlkoder

Fejlkode

Fejltekst

Beskrivelse

Fejlkode

Fejltekst

Beskrivelse

1014

The submitted message is not valid

The submitted message is not valid

XxXxXxXx

Det forbudte ord kunne ikke findes

Det forbudte ord kunne ikke findes

DeleteForbudtOrd (DELETE /v1/ForbudtOrd/{id})

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

 

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

Ikke defineret

Input

Element

Type

Detaljer

Forekomst

Beskrivelse

Element

Type

Detaljer

Forekomst

Beskrivelse

id [Path]

int32

 

1

 

X-ActiveOrganisation [Header]

ActiveOrganisationDto

 

1

Impersoneret myndighed

-    organisationType

OrganisationTypeCodeList

 

1

 

-    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

X-RequestUserMetadata [Header]

RequestUserMetadataDto

 

1

Kaldende myndighed

-    requestUserStructure

RequestUserStructureDto

 

1

 

-    -    userFullName

string

Length: 1-140

1

 

-    -    requestUserType

RequestUserTypeCodeList

 

1

 

-    -    userIdentifier

string

Length: 1-255

1

 

-    -    userEmail

email

 

0 - 1

 

-    requestOrganisationStructure

RequestOrganisationStructureDto

 

1

 

-    -    organisationType

OrganisationTypeCodeList

 

1

 

-    -    organisationCode

string

Pattern: \d{1,8}
MinLength: 1

1

 

-    registrationDateTime

date-time

 

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

Fejlkode

Fejltekst

Beskrivelse

1014

The submitted message is not valid

The submitted message is not valid

XxXxXxXx

Det forbudte ord kunne ikke findes

Det forbudte ord kunne ikke findes

Tilgængelighed: https://starwiki.atlassian.net/was