Kontaktforloeb.JobnetBookingService (Version 1, 2023-4)

STAR

moedetilbudId [Path]

uuid

1

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

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

CreateBookingRequestDto

1

DTO for oprettelse af booking.

-    moedeStarttidspunkt

date-time

1

The starting time of the meeting.

-    samtaleformType

SamtaleformTypeCodeList

0 - 1

-    sagsbehandlerEksterntId

string

Length: 1-255

0 - 1

Sagsbehandler-id.

response

uuid

1

90201

Systemfejl i kontakten med jobcentrets bookingsystem

Systemfejl i kontakten med jobcentrets bookingsystem

90204

Der er sket en systemfejl imellem Jobnet og DFDG

Der er sket en systemfejl imellem Jobnet og DFDG

90205

Mødetidspunktet er ikke længere tilgængeligt

Mødetidspunktet er ikke længere tilgængeligt

STAR

indkaldelseId [Path]

uuid

1

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

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

CreateOmbookingRequestDto

1

DTO for oprettelse af ombooking.

-    moedeStarttidspunkt

date-time

1

Starttidspunkt for bookingen.

-    samtaleformType

SamtaleformTypeCodeList

0 - 1

-    sagsbehandlerEksterntId

string

Length: 1-255

0 - 1

Sagsbehandler-id.

response

uuid

1

90201

Systemfejl i kontakten med jobcentrets bookingsystem

Systemfejl i kontakten med jobcentrets bookingsystem

90203

Der er ikke nogen ledige mødetider

Der er ikke nogen ledige mødetider

90204

Der er sket en systemfejl imellem Jobnet og DFDG

Der er sket en systemfejl imellem Jobnet og DFDG

STAR

indkaldelseId [Path]

uuid

1

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

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

DeleteBookingRequestDto

1

DTO for slet booking request.

-    aflysningsaarsagType

AflysningsaarsagTypeCodeList

1

90201

Systemfejl i kontakten med jobcentrets bookingsystem

Systemfejl i kontakten med jobcentrets bookingsystem

90204

Der er sket en systemfejl imellem Jobnet og DFDG

Der er sket en systemfejl imellem Jobnet og DFDG

STAR

indkaldelseId [Path]

uuid

1

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

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

GetOmbookingMoedetiderRequestDto

1

DTO for forespørgsel om at hente mødetider for ombooking af et online tilbud.

-    startMoedetidsinterval

date-time

1

Starttidspunkt for tidsrummet der ønskes mødetider i.

-    slutMoedetidsinterval

date-time

1

Sluttidspunkt for tidsrummet der ønskes mødetider i.

-    samtaleformType

SamtaleformTypeCodeList

0 - 1

-    eksterntId

string

Length: 1-255

0 - 1

Sagsbehandler-id hvis dette er valgt på dette punkt i flowet.

-    moedetilbudId

uuid

1

Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbooking flowet.

response

GetOmbookingMoedetiderResponseDto

1

DTO for at hente ombooking mødetider

-    bookbareSagsbehandlere

BookbarSagsbehandlerDtoCollection

1

De tilgængelige sagsbehandlere

-    -    BookbarSagsbehandlerDto

BookbarSagsbehandlerDto

0 - *

-    -    -    id

int32

1

Id of the bookbar sagsbehandler

-    -    -    sagsbehandler

SagsbehandlerDto

1

Sagsbehandler

-    -    -    -    fornavne

string

Length: 1-50

1

Sagsbehandlerens fornavn(e).

-    -    -    -    mellemnavn

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    -    efternavn

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    -    eksterntId

string

Length: 1-255

1

Sagsbehandler-id

-    moedetider

MoedetidDtoCollection

1

Mødetid med detaljer

-    -    MoedetidDto

MoedetidDto

0 - *

-    -    -    starttidspunkt

date-time

1

Starttidspunkt for møde

-    -    -    samtaleformer

SamtaleformTypeCodeListCollection

1

En liste med tilgængelige samtaleformer for mødet

-    -    -    -    SamtaleformTypeCodeList

SamtaleformTypeCodeList

1 - *

-    -    -    ombookingMulig

boolean

1

Kan der ombookes for dette mødetilbud

-    -    -    aflysningMulig

boolean

1

Kan der aflyses på dette mødetilbud

-    -    -    maksimaltMoededeltagerantal

int32

0 - 1

Det højeste antal deltagere i mødet

-    -    -    antalLedigePladser

int32

0 - 1

Ledige pladser for mødet

-    -    -    bookbareSagsbehandlerIder

int32Collection

1

Samling af Id’er på sagsbehandlere som kan bookes til denne mødetid

-    -    -    -    int32

int32

1 - *

-    samtaleType

SamtaleTypeCodeList

1

90201

Systemfejl i kontakten med jobcentrets bookingsystem

Systemfejl i kontakten med jobcentrets bookingsystem

90203

Der er ikke nogen ledige mødetider

Der er ikke nogen ledige mødetider

90204

Der er sket en systemfejl imellem Jobnet og DFDG

Der er sket en systemfejl imellem Jobnet og DFDG

STAR

indkaldelseId [Path]

uuid

1

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

response

GetOmbookingSagsbehandlereResponseDto

1

DTO for ombooking sagsbehandler.

-    borgerKanVaelgeSagsbehandler

boolean

1

Angiver hvorvidt borger kan se og vælge en specifik sagsbehandler. For fællesmøder altid false.

-    sagsbehandlere

SagsbehandlerDtoCollection

1

Samling af relevante sagsbehandlere.

-    -    SagsbehandlerDto

SagsbehandlerDto

0 - *

-    -    -    fornavne

string

Length: 1-50

1

Sagsbehandlerens fornavn(e).

-    -    -    mellemnavn

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    efternavn

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    eksterntId

string

Length: 1-255

1

Sagsbehandler-id

90201

Systemfejl i kontakten med jobcentrets bookingsystem

Systemfejl i kontakten med jobcentrets bookingsystem

90203

Der er ikke nogen ledige mødetider

Der er ikke nogen ledige mødetider

90204

Der er sket en systemfejl imellem Jobnet og DFDG

Der er sket en systemfejl imellem Jobnet og DFDG

STAR

indkaldelseId [Path]

uuid

1

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

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

90201

Systemfejl i kontakten med jobcentrets bookingsystem

Systemfejl i kontakten med jobcentrets bookingsystem

90204

Der er sket en systemfejl imellem Jobnet og DFDG

Der er sket en systemfejl imellem Jobnet og DFDG

STAR

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

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

CreateFejlmeldingRequestDto

1

DTO for oprettelse af fejlmelding.

-    moedetilbudId

uuid

0 - 1

Hvis fejlmeldingen er knyttet til et specifikt mødetilbud angives ID.

-    indkaldelseId

uuid

0 - 1

Hvis fejlmeldingen er knyttet til et specifikt møde angives ID.

-    fejlkode

BorgerBookingFejlTypeCodeList

1

-    fejltekst

string

MaxLength: 500

0 - 1

Beskrivelse af fejlsituationen, herunder manuelt fra borger på Jobnet

-    fejlOphav

ClientSystemTypeCodeList

1

-    fejlTidspunkt

date-time

1

Tidspunkt for fejlens registrering

99000

Beskeden kunne ikke valideres

Beskeden kunne ikke valideres

99001

Manglende rettigheder

Manglende rettigheder

90206

Kun Id 30 - DFDG og Id 32 - Jobnet er lovlige værdier for system som er ophav til fejl

Kun Id 30 - DFDG og Id 32 - Jobnet er lovlige værdier for system som er ophav til fejl

90208

Det angivne id på en indkaldelse findes ikke i plannersystemet

Det angivne id på en indkaldelse findes ikke i plannersystemet

90207

Det angivne id på et mødetilbud findes ikke i plannersystemet

Det angivne id på et mødetilbud findes ikke i plannersystemet

STAR

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

response

GetSelvbookingMoedetilbudResponseDto

1

DTO for at hente mødetilbud

-    moedetilbudSamling

MoedetilbudDtoCollection

1

Samling af mødetilbud

-    -    MoedetilbudDto

MoedetilbudDto

0 - *

-    -    -    moedetilbudId

uuid

1

Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbookingflowet.

-    -    -    samtaleType

SamtaleTypeCodeList

1

-    -    -    moedeGruppeType

MoedeGruppeTypeCodeList

1

-    -    -    samtaleformer

SamtaleformTypeCodeListCollection

1

En liste med tilgængelige samtaleformer for mødet

-    -    -    -    SamtaleformTypeCodeList

SamtaleformTypeCodeList

1 - *

-    -    -    moedeLokation

MoedeLokationDto

0 - 1

Information om hvor mødet skal afholdes

-    -    -    -    lokationsuddybning

string

Length: 1-200

0 - 1

Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig.

-    -    -    -    adresse

AdresseDto

0 - 1

Adresse

-    -    -    -    -    vejnavn

string

Length: 1-40

1

Vejnavn.

-    -    -    -    -    husnummer

string

Pattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)$
MinLength: 1

1

Husnummer

-    -    -    -    -    etage

string

Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]

0 - 1

Etagenummer

-    -    -    -    -    sideDoer

string

Length: 1-4

0 - 1

Dør-angivelse, fx th.

-    -    -    -    -    postnummer

string

Pattern: [0-9]{4}
MinLength: 1

1

Postnummer

-    -    -    -    -    bynavn

string

Length: 1-20

1

Bynavn

-    -    -    -    -    landekode

string

Pattern: ^[A-Za-z]{2}$

0 - 1

Landekode

-    -    -    moedeVarighed

int32

1

Mødets varighed i minutter

-    -    -    foersteMoedetid

date-time

0 - 1

Første mulige mødedato og tid. Kan være forekomst 0, hvor det stadig er relevant at have et mødetilbuds-element for at kunne vise møde-tilbudstypen til Jobnet.

-    -    -    sidsteMoedetid

date-time

0 - 1

Seneste mulige mødetidspunkt, som tilbuddet udstilles til. For individuelle møder kan datoen være "åben" og dermed ikke sat. For fællesmøder vil der altid være angivet en dato/tid. Denne kan være identisk med FoersteMoedetid hvis der er tale om et fællesmøde, der kun foregår på en enkelt specifik dag.

-    -    -    borgerKanVaelgeSagsbehandler

boolean

1

Angiver hvorvidt borger kan se og vælge en specifik sagsbehandler. For fællesmøder altid false.

-    -    -    moedetitel

string

Length: 1-100

1

Mødetitel. Vises på Jobnet.

-    -    -    moedebeskrivelse

string

Length: 1-500

0 - 1

Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet.

-    -    -    sagsbehandlere

SagsbehandlerDtoCollection

1

Samling af relevante sagsbehandlere

-    -    -    -    SagsbehandlerDto

SagsbehandlerDto

0 - *

-    -    -    -    -    fornavne

string

Length: 1-50

1

Sagsbehandlerens fornavn(e).

-    -    -    -    -    mellemnavn

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    -    -    efternavn

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    -    -    eksterntId

string

Length: 1-255

1

Sagsbehandler-id

90201

Systemfejl i kontakten med jobcentrets bookingsystem

Systemfejl i kontakten med jobcentrets bookingsystem

90204

Der er sket en systemfejl imellem Jobnet og DFDG

Der er sket en systemfejl imellem Jobnet og DFDG

STAR

moedetilbudId [Path]

uuid

1

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

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

GetSelvbookingMoedetiderRequestDto

1

DTO for request om at hente selvbooking mødetider.

-    startMoedetidsinterval

date-time

1

Starttidspunkt for tidsrummet der ønskes mødetider i.

-    slutMoedetidsinterval

date-time

1

Sluttidspunkt for tidsrummet der ønskes mødetider i.

-    samtaleformType

SamtaleformTypeCodeList

0 - 1

-    eksterntId

string

Length: 1-255

0 - 1

Sagsbehandler-id hvis dette er valgt på dette punkt i flowet.

response

GetSelvbookingMoedetiderResponseDto

1

DTO for at hente selvbooking mødetider

-    bookbareSagsbehandlere

BookbarSagsbehandlerDtoCollection

1

De bookbare sagsbehandlere

-    -    BookbarSagsbehandlerDto

BookbarSagsbehandlerDto

0 - *

-    -    -    id

int32

1

Id of the bookbar sagsbehandler

-    -    -    sagsbehandler

SagsbehandlerDto

1

Sagsbehandler

-    -    -    -    fornavne

string

Length: 1-50

1

Sagsbehandlerens fornavn(e).

-    -    -    -    mellemnavn

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    -    efternavn

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    -    eksterntId

string

Length: 1-255

1

Sagsbehandler-id

-    moedetider

MoedetidDtoCollection

1

Mødetid med detaljer

-    -    MoedetidDto

MoedetidDto

0 - *

-    -    -    starttidspunkt

date-time

1

Starttidspunkt for møde

-    -    -    samtaleformer

SamtaleformTypeCodeListCollection

1

En liste med tilgængelige samtaleformer for mødet

-    -    -    -    SamtaleformTypeCodeList

SamtaleformTypeCodeList

1 - *

-    -    -    ombookingMulig

boolean

1

Kan der ombookes for dette mødetilbud

-    -    -    aflysningMulig

boolean

1

Kan der aflyses på dette mødetilbud

-    -    -    maksimaltMoededeltagerantal

int32

0 - 1

Det højeste antal deltagere i mødet

-    -    -    antalLedigePladser

int32

0 - 1

Ledige pladser for mødet

-    -    -    bookbareSagsbehandlerIder

int32Collection

1

Samling af Id’er på sagsbehandlere som kan bookes til denne mødetid

-    -    -    -    int32

int32

1 - *

90201

Systemfejl i kontakten med jobcentrets bookingsystem

Systemfejl i kontakten med jobcentrets bookingsystem

90203

Der er ikke nogen ledige mødetider

Der er ikke nogen ledige mødetider

90204

Der er sket en systemfejl imellem Jobnet og DFDG

Der er sket en systemfejl imellem Jobnet og DFDG

STAR

x-civilregistrationIdentifier [Header]

string

Pattern: ((((0[1-9]|1[0-9]|2[0-9]|3[0-1])(01|03|05|07|08|10|12))|((0[1-9]|1[0-9]|2[0-9]|30)(04|06|09|11))|((0[1-9]|1[0-9]|2[0-9])(02)))[0-9]{6})|0000000000

1

Beskrivelse af cpr

response

GetStraksbookingMoedetiderResponseDto

1

DTO for svar på hentning af straksbooking mødetider.

-    bookbareSagsbehandlere

BookbarSagsbehandlerDtoCollection

1

Samling af bookbare sagsbehandlere.

-    -    BookbarSagsbehandlerDto

BookbarSagsbehandlerDto

0 - *

-    -    -    id

int32

1

Id of the bookbar sagsbehandler

-    -    -    sagsbehandler

SagsbehandlerDto

1

Sagsbehandler

-    -    -    -    fornavne

string

Length: 1-50

1

Sagsbehandlerens fornavn(e).

-    -    -    -    mellemnavn

string

Length: 1-40

0 - 1

Sagsbehandlerens mellemnavn.

-    -    -    -    efternavn

string

Length: 1-40

1

Sagsbehandlerens efternavn.

-    -    -    -    eksterntId

string

Length: 1-255

1

Sagsbehandler-id

-    moedetider

StraksbookingMoedetidDtoCollection

1

Samling af mødetider der kan bookes.

-    -    StraksbookingMoedetidDto

StraksbookingMoedetidDto

0 - *

-    -    -    starttidspunkt

date-time

1

Starttidspunkt for møde

-    -    -    samtaleformer

SamtaleformTypeCodeListCollection

1

En liste med tilgængelige samtaleformer for mødet

-    -    -    -    SamtaleformTypeCodeList

SamtaleformTypeCodeList

1 - *

-    -    -    ombookingMulig

boolean

1

Kan der ombookes for dette mødetilbud

-    -    -    aflysningMulig

boolean

1

Kan der aflyses på dette mødetilbud

-    -    -    maksimaltMoededeltagerantal

int32

0 - 1

Det højeste antal deltagere i mødet

-    -    -    antalLedigePladser

int32

0 - 1

Ledige pladser for mødet

-    -    -    bookbareSagsbehandlerIder

int32Collection

1

Samling af Id’er på sagsbehandlere som kan bookes til denne mødetid

-    -    -    -    int32

int32

1 - *

-    -    -    moedetilbudId

uuid

1

Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbookingflowet.

-    -    -    moedetitel

string

Length: 1-100

1

Mødetitel. Vises på Jobnet.

-    -    -    moedebeskrivelse

string

Length: 0-500

0 - 1

Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet.

-    -    -    moedeVarighed

int32

1

Mødets varighed i minutter.

-    -    -    samtaleType

SamtaleTypeCodeList

1

-    -    -    moedeGruppeType

MoedeGruppeTypeCodeList

1

-    -    -    moedeLokation

MoedeLokationDto

0 - 1

Information om hvor mødet skal afholdes

-    -    -    -    lokationsuddybning

string

Length: 1-200

0 - 1

Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig.

-    -    -    -    adresse

AdresseDto

0 - 1

Adresse

-    -    -    -    -    vejnavn

string

Length: 1-40

1

Vejnavn.

-    -    -    -    -    husnummer

string

Pattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)$
MinLength: 1

1

Husnummer

-    -    -    -    -    etage

string

Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]

0 - 1

Etagenummer

-    -    -    -    -    sideDoer

string

Length: 1-4

0 - 1

Dør-angivelse, fx th.

-    -    -    -    -    postnummer

string

Pattern: [0-9]{4}
MinLength: 1

1

Postnummer

-    -    -    -    -    bynavn

string

Length: 1-20

1

Bynavn

-    -    -    -    -    landekode

string

Pattern: ^[A-Za-z]{2}$

0 - 1

Landekode

-    -    -    borgerKanVaelgeSagsbehandler

boolean

1

Angiver hvorvidt borger kan se og vælge en specifik sagsbehandler. For fællesmøder altid false.

90200

Der er ikke kontakt med jobcentrets bookingsystem

Der er ikke kontakt med jobcentrets bookingsystem

90203

Der er ikke nogen ledige mødetider

Der er ikke nogen ledige mødetider

90204

Der er sket en systemfejl imellem Jobnet og DFDG

Der er sket en systemfejl imellem Jobnet og DFDG