You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 11
Next »
Siden opdateres automatisk til at afspejle koden.
Metoder
CreateBooking (POST /v1/BorgerBooking/booking/{indkaldelseId})
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
kontaktforloeb.samtale.staronly.write
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
| jobcenterkode [Header] | string | Pattern: [0-9]{5} | 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 | CreateBookingRequestDto | | 1 | |
| - moedetilbudId | uuid | | 1 | Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbookingflowet. |
| - moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
| - gruppemoedeEjersystem | ClientSystemTypeCodeList | | 0 - 1 | |
| - samtaleformType | SamtaleformTypeCodeList | | 0 - 1 | |
| - sagsbehandlerEksterntId | string | Length: 1-255 | 0 - 1 | Sagsbehandler-id. |
| - erStraksbooking | boolean | | 1 | Indikerer om der er tale om en straksbooking. |
Output
Intet output
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 99000 | Beskeden kunne ikke valideres | Beskeden kunne ikke valideres |
| 99001 | Manglende rettigheder | Manglende rettigheder |
| 99003 | Mødetiden er optaget af anden borger | Mødetiden er optaget af anden borger |
| 99006 | Mødetidspunktet er i fortiden | Mødetidspunktet er i fortiden |
| 99010 | MoedetilbudsId'et er ikke aktivt eller findes ikke | MoedetilbudsId'et er ikke aktivt eller findes ikke |
| 99011 | Mødetidspunktet er ikke tilgængeligt for dette mødetilbud | Mødetidspunktet er ikke tilgængeligt for dette mødetilbud |
| 99012 | Personnummeret findes ikke i systemet | Personnummeret findes ikke i systemet |
| 99013 | Sagsbehandleren er ikke tilgængelig for dette mødetilbud | Sagsbehandleren er ikke tilgængelig for dette mødetilbud |
| 99015 | Intern fejl på serveren | Intern fejl på serveren |
| 99016 | Mødets starttidspunkt kan ikke være tidligere end dags dato | Mødets starttidspunkt kan ikke være tidligere end dags dato |
| 99017 | Mødets sluttidspunkt kan ikke være tidligere end mødets starttidspunkt | Mødets sluttidspunkt kan ikke være tidligere end mødets starttidspunkt |
CreateOmbooking (PUT /v1/BorgerBooking/booking/{indkaldelseId})
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
kontaktforloeb.samtale.staronly.write
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
| jobcenterkode [Header] | string | Pattern: [0-9]{5} | 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 | CreateOmbookingRequestDto | | 1 | |
| - moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
| - samtaleformType | SamtaleformTypeCodeList | | 0 - 1 | |
| - sagsbehandlerEksterntId | string | Length: 1-255 | 0 - 1 | Sagsbehandler-id. |
Output
Intet output
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 99000 | Beskeden kunne ikke valideres | Beskeden kunne ikke valideres |
| 99001 | Manglende rettigheder | Manglende rettigheder |
| 99003 | Mødetiden er optaget af anden borger | Mødetiden er optaget af anden borger |
| 99004 | IndkaldelseId'et findes ikke | IndkaldelseId'et findes ikke |
| 99006 | Mødetidspunktet er i fortiden | Mødetidspunktet er i fortiden |
| 99009 | IndkaldelseId'et er på en anden borger end den angivne | IndkaldelseId'et er på en anden borger end den angivne |
| 99014 | Bookingen kan hverken ombookes eller aflyses fordi det er en straksbooking | Bookingen kan hverken ombookes eller aflyses fordi det er en straksbooking |
| 99015 | Intern fejl på serveren | Intern fejl på serveren |
| 99016 | Mødets starttidspunkt kan ikke være tidligere end dags dato | Mødets starttidspunkt kan ikke være tidligere end dags dato |
| 99017 | Mødets sluttidspunkt kan ikke være tidligere end mødets starttidspunkt | Mødets sluttidspunkt kan ikke være tidligere end mødets starttidspunkt |
DeleteIndkaldelse (DELETE /v1/BorgerBooking/booking/{indkaldelseId})
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
kontaktforloeb.samtale.staronly.write
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
| jobcenterkode [Header] | string | Pattern: [0-9]{5} | 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 | DeleteIndkaldelseRequestDto | | 1 | |
| - aflysningsaarsag | AflysningsaarsagTypeCodeList | | 1 | |
Output
Intet output
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 99000 | Beskeden kunne ikke valideres | Beskeden kunne ikke valideres |
| 99001 | Manglende rettigheder | Manglende rettigheder |
| 99002 | Denne registrering kan ikke slettes, da startdatoen er i fortiden | Denne registrering kan ikke slettes, da startdatoen er i fortiden |
| 99004 | IndkaldelseId'et findes ikke | IndkaldelseId'et findes ikke |
| 99008 | Afbud er ikke tilladt på dette mødetilbud | Afbud er ikke tilladt på dette mødetilbud |
| 99009 | IndkaldelseId'et er på en anden borger end den angivne | IndkaldelseId'et er på en anden borger end den angivne |
| 99014 | Bookingen kan hverken ombookes eller aflyses fordi det er en straksbooking | Bookingen kan hverken ombookes eller aflyses fordi det er en straksbooking |
| 99015 | Intern fejl på serveren | Intern fejl på serveren |
GetOmbookingMoedetider (GET /v1/BorgerBooking/booking/{indkaldelseId}/moedetider)
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
kontaktforloeb.samtale.staronly.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
| jobcenterkode [Header] | string | Pattern: [0-9]{5} | 1 | |
| requestBody | GetOmbookingMoedetiderRequestDto | | 1 | |
| - 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. |
| - frister | FristDtoCollection | | 1 | Samling af frister. |
| - - FristDto | FristDto | | 0 - * | |
| - - - sidsteAfholdelsesdato | date | | 1 | Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato. |
| - - - friststatusType | FriststatusTypeCodeList | | 1 | |
| - - - fristType | SamtaleTypeCodeList | | 1 | |
| - moedetilbudId | uuid | | 1 | Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbooking flowet. |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | GetOmbookingMoedetiderResponseDto | | 1 | |
| - bookbareSagsbehandlere | BookbarSagsbehandlerDtoCollection | | 1 | |
| - - BookbarSagsbehandlerDto | BookbarSagsbehandlerDto | | 0 - * | |
| - - - id | int32 | | 1 | |
| - - - 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 | |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 99000 | Beskeden kunne ikke valideres | Beskeden kunne ikke valideres |
| 99001 | Manglende rettigheder | Manglende rettigheder |
| 99004 | IndkaldelseId'et findes ikke | IndkaldelseId'et findes ikke |
| 99005 | Der er ingen mødetilbud til rådighed | Der er ingen mødetilbud til rådighed |
| 99006 | Mødetidspunktet er i fortiden | Mødetidspunktet er i fortiden |
| 99007 | Det er ikke tilladt at selvbooke på dette mødetilbud | Det er ikke tilladt at selvbooke på dette mødetilbud |
| 99015 | Intern fejl på serveren | Intern fejl på serveren |
| 99016 | Mødets starttidspunkt kan ikke være tidligere end dags dato | Mødets starttidspunkt kan ikke være tidligere end dags dato |
| 99017 | Mødets sluttidspunkt kan ikke være tidligere end mødets starttidspunkt | Mødets sluttidspunkt kan ikke være tidligere end mødets starttidspunkt |
GetOmbookingSagsbehandlere (GET /v1/BorgerBooking/booking/{indkaldelseId}/sagsbehandlere)
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
kontaktforloeb.samtale.staronly.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
| jobcenterkode [Header] | string | Pattern: [0-9]{5} | 1 | |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | GetOmbookingSagsbehandlereResponseDto | | 1 | |
| - 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 |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 99000 | Beskeden kunne ikke valideres | Beskeden kunne ikke valideres |
| 99001 | Manglende rettigheder | Manglende rettigheder |
| 99004 | IndkaldelseId'et findes ikke | IndkaldelseId'et findes ikke |
| 99005 | Der er ingen mødetilbud til rådighed | Der er ingen mødetilbud til rådighed |
| 99006 | Mødetidspunktet er i fortiden | Mødetidspunktet er i fortiden |
| 99009 | IndkaldelseId'et er på en anden borger end den angivne | IndkaldelseId'et er på en anden borger end den angivne |
| 99015 | Intern fejl på serveren | Intern fejl på serveren |
| 99016 | Mødets starttidspunkt kan ikke være tidligere end dags dato | Mødets starttidspunkt kan ikke være tidligere end dags dato |
| 99017 | Mødets sluttidspunkt kan ikke være tidligere end mødets starttidspunkt | Mødets sluttidspunkt kan ikke være tidligere end mødets starttidspunkt |
GetBookingdetaljerForOmbooking (GET /v1/BorgerBooking/booking/{indkaldelseId}/detaljer)
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
kontaktforloeb.samtale.staronly.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
| jobcenterkode [Header] | string | Pattern: [0-9]{5} | 1 | |
| requestBody | GetBookingdetaljerForOmbookingRequestDto | | 1 | |
| - moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
| - samtaleformType | SamtaleformTypeCodeList | | 0 - 1 | |
| - sagsbehandlerEksterntId | string | Length: 1-255 | 0 - 1 | Sagsbehandler-id. |
| - erStraksbooking | boolean | | 1 | Indikerer om der er tale om en straksbooking. |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | GetBookingdetaljerResponseDto | | 1 | |
| - bookingdetaljer | BookingdetaljerDto | | 1 | Typen indeholder information tilknyttet en booking, det værende nyoprettet eller ombooket. Informationer anvendes af DFDG til dels at persistere informationen i DFDG og dels til at generere WSRM beskederne |
| - - moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
| - - moedeSluttidspunkt | date-time | | 0 - 1 | Sluttidspunktet for bookingen. |
| - - samtaleType | SamtaleTypeCodeList | | 1 | |
| - - moedeGruppeType | MoedeGruppeTypeCodeList | | 1 | |
| - - samtaleformType | SamtaleformTypeCodeList | | 1 | |
| - - indkaldelseId | uuid | | 1 | Unikt id for bookingen (guid) |
| - - gruppemoedeEjersystem | ClientSystemTypeCodeList | | 0 - 1 | |
| - - personnummer | 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
MinLength: 1 | 1 | Personnummer |
| - - gruppemoedeId | uuid | | 0 - 1 | Skal angives for fællesmøder. |
| - - ombookingMulig | boolean | | 1 | Kan der ombookes for dette mødetilbud. |
| - - ombookingFrist | date | | 0 - 1 | Obligatorisk hvis OmbookingMulig er sat til true. |
| - - aflysningMulig | boolean | | 1 | Kan borger aflyse dette møde. |
| - - aflysningsfrist | date | | 0 - 1 | Sluttidspunkt for borgers aflysningsmulighed. |
| - - 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. |
| - - visSagsbehandlernavnForBorger | boolean | | 1 | Om navnet på afholdende sagsbehandler må vises for borger. |
| - - afholdendeSagsbehandler | 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 |
| - - 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 |
| - - kontaktinformation | KontaktinformationDto | | 0 - 1 | Angiver detaljer om mødet når det ikke er med personligt fremmøde. |
| - - - digitaltMoedelink | string | Length: 0-2000 | 0 - 1 | Kontaktinformation hvis mødet er digitalt |
| - - - telefonnummer | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Vil være udfyldt med vejlederens telefonnummer, alternativt hovednummer til jobcenter. Skal angives, hvis det er borger, der skal ringe. |
| - - - borgerRingerOp | boolean | | 0 - 1 | Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde. |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 99000 | Beskeden kunne ikke valideres | Beskeden kunne ikke valideres |
| 90001 | | |
| 99004 | IndkaldelseId'et findes ikke | IndkaldelseId'et findes ikke |
| 99005 | Der er ingen mødetilbud til rådighed | Der er ingen mødetilbud til rådighed |
| 99006 | Mødetidspunktet er i fortiden | Mødetidspunktet er i fortiden |
| 99009 | IndkaldelseId'et er på en anden borger end den angivne | IndkaldelseId'et er på en anden borger end den angivne |
| 99015 | Intern fejl på serveren | Intern fejl på serveren |
CreateMoedetidReservation (POST /v1/BorgerBooking/booking/{indkaldelseId}/action/reserver)
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
kontaktforloeb.samtale.staronly.write
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
| jobcenterkode [Header] | string | Pattern: [0-9]{5} | 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 |
|---|
| 99000 | Beskeden kunne ikke valideres | Beskeden kunne ikke valideres |
| 99001 | Manglende rettigheder | Manglende rettigheder |
| 99004 | IndkaldelseId'et findes ikke | IndkaldelseId'et findes ikke |
| 90009 | | |
| 99015 | Intern fejl på serveren | Intern fejl på serveren |
SaveIndkaldelsesaccept (POST /v1/BorgerBooking/booking/{indkaldelseId}/action/accept)
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
kontaktforloeb.samtale.staronly.write
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
| jobcenterkode [Header] | string | Pattern: [0-9]{5} | 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 |
|---|
| 99000 | Beskeden kunne ikke valideres | Beskeden kunne ikke valideres |
| 99001 | Manglende rettigheder | Manglende rettigheder |
| 99004 | IndkaldelseId'et findes ikke | IndkaldelseId'et findes ikke |
| 99009 | IndkaldelseId'et er på en anden borger end den angivne | IndkaldelseId'et er på en anden borger end den angivne |
| 99015 | Intern fejl på serveren | Intern fejl på serveren |
CreateFejlmelding (POST /v1/BorgerBooking/fejlmelding)
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
kontaktforloeb.samtale.staronly.write
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
| jobcenterkode [Header] | string | Pattern: [0-9]{5} | 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 | CreateFejlmeldingRequestDto | | 1 | |
| - 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 | int32 | | 1 | Fejl på Jobnet og fejl fanget i DFDGs validering på baggrund af data modtaget fra kald til BorgerBookingService med mere. |
| - 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 |
Output
Intet output
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 99000 | Beskeden kunne ikke valideres | Beskeden kunne ikke valideres |
| 99001 | Manglende rettigheder | Manglende rettigheder |
| 99015 | Intern fejl på serveren | Intern fejl på serveren |
| 99019 | Det angivne id på en indkaldelse findes ikke i plannersystemet | Det angivne id på en indkaldelse findes ikke i plannersystemet |
| 99018 | Det angivne id på et mødetilbud findes ikke i plannersystemet | Det angivne id på et mødetilbud findes ikke i plannersystemet |
GetSelvbookingMoedetilbud (GET /v1/BorgerBooking/moedetilbud)
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
kontaktforloeb.samtale.staronly.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
| jobcenterkode [Header] | string | Pattern: [0-9]{5} | 1 | |
| requestBody | GetSelvbookingMoedetilbudRequestDto | | 1 | Identifikation af borger samt udvalgte borgerdata, der anvendes til at matche borgeren med søgeregler til de enkelt mødetilbud. |
| - jobcenterkode | string | Pattern: [0-9]{5}
MinLength: 1 | 1 | Jobcenterkode for det jobcenter borgeren hører til. 5-cifret numerisk format. |
| - kontaktgruppe | ContactGroupTypeCodeList | | 1 | |
| - personkategoriStruktur | PersonkategoriDto | | 0 - 1 | Klientkategoristruktur |
| - - personkategori | PersonCategoryTypeCodeList | | 0 - 1 | |
| - - haendelsestidspunkt | date-time | | 1 | Angiver den dato og klokkeslæt borger blev kategoriseret. |
| - persongruppeprojekter | PersongruppeprojektDtoCollection | | 1 | Samling af persongruppeprojekter borgeren er knyttet til. |
| - - PersongruppeprojektDto | PersongruppeprojektDto | | 0 - * | |
| - - - persongruppeprojektId | uuid | | 1 | Id for en persongruppeprojekt borger er knyttet til. |
| - indkaldelser | IndkaldelseDtoCollection | | 1 | Samling af borgerens aktuelle indkaldelser. |
| - - IndkaldelseDto | IndkaldelseDto | | 0 - * | |
| - - - moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
| - - - moedeSluttidspunkt | date-time | | 0 - 1 | Sluttidspunktet for bookingen. |
| - - - samtaleType | SamtaleTypeCodeList | | 1 | |
| - - - moedeGruppeType | MoedeGruppeTypeCodeList | | 1 | |
| - - - samtaleformType | SamtaleformTypeCodeList | | 1 | |
| - - - indkaldelseId | uuid | | 0 - 1 | Mulighed for at angive guid på indkaldelsen. |
| - - - moedevarighed | int32 | | 0 - 1 | Mødets varighed i minutter. |
| - frister | FristDtoCollection | | 1 | Samling af frister. |
| - - FristDto | FristDto | | 0 - * | |
| - - - sidsteAfholdelsesdato | date | | 1 | Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato. |
| - - - friststatusType | FriststatusTypeCodeList | | 1 | |
| - - - fristType | SamtaleTypeCodeList | | 1 | |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | GetSelvbookingMoedetilbudResponseDto | | 1 | |
| - 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 |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 99000 | Beskeden kunne ikke valideres | Beskeden kunne ikke valideres |
| 99001 | Manglende rettigheder | Manglende rettigheder |
| 99012 | Personnummeret findes ikke i systemet | Personnummeret findes ikke i systemet |
| 99015 | Intern fejl på serveren | Intern fejl på serveren |
GetSelvbookingMoedetider (GET /v1/BorgerBooking/moedetilbud/{moedetilbudId}/moedetider)
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
kontaktforloeb.samtale.staronly.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
| jobcenterkode [Header] | string | Pattern: [0-9]{5} | 1 | |
| requestBody | GetSelvbookingMoedetiderRequestDto | | 1 | |
| - 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. |
| - frister | FristDtoCollection | | 1 | Samling af frister. |
| - - FristDto | FristDto | | 0 - * | |
| - - - sidsteAfholdelsesdato | date | | 1 | Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato. |
| - - - friststatusType | FriststatusTypeCodeList | | 1 | |
| - - - fristType | SamtaleTypeCodeList | | 1 | |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | GetSelvbookingMoedetiderResponseDto | | 1 | |
| - bookbareSagsbehandlere | BookbarSagsbehandlerDtoCollection | | 1 | |
| - - BookbarSagsbehandlerDto | BookbarSagsbehandlerDto | | 0 - * | |
| - - - id | int32 | | 1 | |
| - - - 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 - * | |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 99000 | Beskeden kunne ikke valideres | Beskeden kunne ikke valideres |
| 99001 | Manglende rettigheder | Manglende rettigheder |
| 99005 | Der er ingen mødetilbud til rådighed | Der er ingen mødetilbud til rådighed |
| 99009 | IndkaldelseId'et er på en anden borger end den angivne | IndkaldelseId'et er på en anden borger end den angivne |
| 99012 | Personnummeret findes ikke i systemet | Personnummeret findes ikke i systemet |
| 99015 | Intern fejl på serveren | Intern fejl på serveren |
GetBookingdetaljer (GET /v1/BorgerBooking/moedetilbud/{moedetilbudId}/detaljer)
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
kontaktforloeb.samtale.staronly.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
| jobcenterkode [Header] | string | Pattern: [0-9]{5} | 1 | |
| requestBody | GetBookingdetaljerRequestDto | | 1 | |
| - moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
| - samtaleformType | SamtaleformTypeCodeList | | 0 - 1 | |
| - sagsbehandlerEksterntId | string | Length: 1-255 | 0 - 1 | Sagsbehandler-id. |
| - erStraksbooking | boolean | | 1 | Indikerer om der er tale om en straksbooking. |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | GetBookingdetaljerResponseDto | | 1 | |
| - bookingdetaljer | BookingdetaljerDto | | 1 | Typen indeholder information tilknyttet en booking, det værende nyoprettet eller ombooket. Informationer anvendes af DFDG til dels at persistere informationen i DFDG og dels til at generere WSRM beskederne |
| - - moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
| - - moedeSluttidspunkt | date-time | | 0 - 1 | Sluttidspunktet for bookingen. |
| - - samtaleType | SamtaleTypeCodeList | | 1 | |
| - - moedeGruppeType | MoedeGruppeTypeCodeList | | 1 | |
| - - samtaleformType | SamtaleformTypeCodeList | | 1 | |
| - - indkaldelseId | uuid | | 1 | Unikt id for bookingen (guid) |
| - - gruppemoedeEjersystem | ClientSystemTypeCodeList | | 0 - 1 | |
| - - personnummer | 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
MinLength: 1 | 1 | Personnummer |
| - - gruppemoedeId | uuid | | 0 - 1 | Skal angives for fællesmøder. |
| - - ombookingMulig | boolean | | 1 | Kan der ombookes for dette mødetilbud. |
| - - ombookingFrist | date | | 0 - 1 | Obligatorisk hvis OmbookingMulig er sat til true. |
| - - aflysningMulig | boolean | | 1 | Kan borger aflyse dette møde. |
| - - aflysningsfrist | date | | 0 - 1 | Sluttidspunkt for borgers aflysningsmulighed. |
| - - 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. |
| - - visSagsbehandlernavnForBorger | boolean | | 1 | Om navnet på afholdende sagsbehandler må vises for borger. |
| - - afholdendeSagsbehandler | 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 |
| - - 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 |
| - - kontaktinformation | KontaktinformationDto | | 0 - 1 | Angiver detaljer om mødet når det ikke er med personligt fremmøde. |
| - - - digitaltMoedelink | string | Length: 0-2000 | 0 - 1 | Kontaktinformation hvis mødet er digitalt |
| - - - telefonnummer | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Vil være udfyldt med vejlederens telefonnummer, alternativt hovednummer til jobcenter. Skal angives, hvis det er borger, der skal ringe. |
| - - - borgerRingerOp | boolean | | 0 - 1 | Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde. |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 99000 | Beskeden kunne ikke valideres | Beskeden kunne ikke valideres |
| 99001 | Manglende rettigheder | Manglende rettigheder |
| 99003 | Mødetiden er optaget af anden borger | Mødetiden er optaget af anden borger |
| 99010 | MoedetilbudsId'et er ikke aktivt eller findes ikke | MoedetilbudsId'et er ikke aktivt eller findes ikke |
| 99012 | Personnummeret findes ikke i systemet | Personnummeret findes ikke i systemet |
| 99015 | Intern fejl på serveren | Intern fejl på serveren |
GetStraksbookingMoedetider (GET /v1/BorgerBooking/straksbookingmoedetider)
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
kontaktforloeb.samtale.staronly.read
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| 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 |
| jobcenterkode [Header] | string | Pattern: [0-9]{5} | 1 | |
| requestBody | GetStraksbookingMoedetiderRequestDto | | 1 | |
| - jobcenterkode | string | Pattern: [0-9]{5}
MinLength: 1 | 1 | Jobcenterkode for det jobcenter borgeren hører til. 5-cifret numerisk format. |
| - kontaktgruppe | ContactGroupTypeCodeList | | 1 | |
| - personkategoriStruktur | PersonkategoriDto | | 0 - 1 | Klientkategoristruktur |
| - - personkategori | PersonCategoryTypeCodeList | | 0 - 1 | |
| - - haendelsestidspunkt | date-time | | 1 | Angiver den dato og klokkeslæt borger blev kategoriseret. |
| - persongruppeprojekter | PersongruppeprojektDtoCollection | | 1 | Samling af persongruppeprojekter borgeren er knyttet til. |
| - - PersongruppeprojektDto | PersongruppeprojektDto | | 0 - * | |
| - - - persongruppeprojektId | uuid | | 1 | Id for en persongruppeprojekt borger er knyttet til. |
| - moedetidsantal | int32 | | 1 | Antal mødetider. |
| - moedetiderStartdato | date-time | | 1 | Startdato på timeslottet. |
| - moedetiderSlutdato | date-time | | 1 | Slutdato på timeslot. |
| - samtaleType | SamtaleTypeCodeList | | 1 | |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
| response | GetStraksbookingMoedetiderResponseDto | | 1 | |
| - bookbareSagsbehandlere | BookbarSagsbehandlerDtoCollection | | 1 | |
| - - BookbarSagsbehandlerDto | BookbarSagsbehandlerDto | | 0 - * | |
| - - - id | int32 | | 1 | |
| - - - 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. |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|
| 99000 | Beskeden kunne ikke valideres | Beskeden kunne ikke valideres |
| 99005 | Der er ingen mødetilbud til rådighed | Der er ingen mødetilbud til rådighed |
| 99009 | IndkaldelseId'et er på en anden borger end den angivne | IndkaldelseId'et er på en anden borger end den angivne |
| 99012 | Personnummeret findes ikke i systemet | Personnummeret findes ikke i systemet |
| 99015 | Intern fejl på serveren | Intern fejl på serveren |