Servicen udstilles Servicen udstilles af plannersystemer og anvendes af DFDG for at understøtte borgers selvbooking og ombooking på Jobnet.
...
Table of Contents | ||||
---|---|---|---|---|
|
Hovedflow, booking
Booking ud fra mødetilbud, resources: Moedetilbud
...
CreateBooking - Opret en booking i det eksterne booking system - Post /v1/BorgerBooking/Booking/{MoedetilbudIdIndkaldelseId}/{body}
Alternativt flow ombooking
...
GetBookingdetaljer - Hent bookingdetaljer og reserver timeslot - Get /v1/BorgerBooking/Moedetilbud/{MoedetilbudId}/Detaljer/{body}
CreateMoedetidReservation - Reserver timeslot - Post /v1/BorgerBooking/Booking/{IndkaldelseId}/action/reserver
CreateBooking - Opret en booking i det eksterne booking system - Post /v1/BorgerBooking/Booking/{MoedetilbudIdIndkaldelseId}/{body}
Alternativt flow accept booking
...
Element | Type | Forekomst | Beskrivelse |
---|---|---|---|
CreateFejlmeldingRequest | |||
| GUID | 0 - 1 | Hvis fejlmeldingen er knyttet til et specifikt mødetilbud angives ID |
| GUID | 0 - 1 | Hvis fejlmeldingen er knyttet til et specifikt møde angives ID |
| Int | 1 | Fejl på Jobnet og fejl fanget i DFDGs validering på baggrund af GetBookingDetaljer data modtaget fra kald til BorgerBookingService med mere [] |
| String (500) | 0 - 1 | Beskrivelse af fejlsituationen, herunder manuelt fra borger på Jobnet |
| 1 | Hvilket system fejlen er opstået i (Jobnet/DFDG) | |
| dateTime | 1 | Tidspunkt for fejlens registrering |
Fejlkode kodelisten
BorgerBookingFejlTypeCodeList
Id
Navn
Beskrivelse
¤
Ulovligt system angivet som ophav
Kun Id 30 - DFDG og Id 32 - Jobnet er lovlige værdier for system som er ophav til fejl
¤
Ukendt borger (¤ genbrug eksisterende kode)
Den angivne borger kendes ikke af plannersystemet
¤
Ukendt MødetilbudId
Id | Navn | Beskrivelse | ¤
---|---|---|
1 |
Output
(Emptyresponse)
Fejl
Straksbooking ingen mødetider | Straksbookingramt borger kunne ikke finde nogen ledige mødetider | |
2 | Ingen mødetider (ej straksbooking) | Borger kunne ikke finde nogen ledige mødetider |
3 | Ingen mødetilbud | Borger fik ikke nogen mødetilbud |
4 | Andet problem oplevet på Jobnet | Detaljer om den specifikke fejl angives i Fejltekst |
5 | Mødetilbud er ikke forretningsmæssigt gyldigt | Detaljer om den specifikke fejl angives i Fejltekst |
6 | Mødetid er ikke forretningsmæssigt gyldig | Detaljer om den specifikke fejl angives i Fejltekst |
7 | Indkaldelse er ikke forretningsmæssigt gyldig | Detaljer om den specifikke fejl angives i Fejltekst |
Output
(Emptyresponse)
Fejl
Id | Navn | Beskrivelse | ||||
---|---|---|---|---|---|---|
¤ | Ukendt MødetilbudId | Det angivne id på et mødetilbud findes ikke i plannersystemet | ||||
¤ | Ukendt IndkaldelseId | Det angivne id på en indkaldelse findes ikke i plannersystemet | ¤ | Ukendt fejlkode | Det angivne fejlkodenummer kendes ikke i plannersystemet | ¤flere…?
GetSelvbookingMoedetilbud (GetSelfbookInterviewOptions)
Operationen anvendes af Jobnet, som via DFDG forespørger de mødetilbud, som udstilles til en specifik borger. Kaldet fra DFDG er stort set en ren viderestilling til og fra Jobnet.
HasExternalOperatorReferral og AbsenceCollection er taget ud af request, som tidligere udmeldt.
Bookings medsendes ved kald til plannersystem, da ikke alle plannersystemerne har en vedligeholdt bestand af borgers bookings.
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
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 | 0 - 1 |
|
Element | Type | Detaljer | Forekomst | Beskrivelse | ||
---|---|---|---|---|---|---|
GetSelvbookingMoedetilbudRequest | 1 | Identifikation af borger samt udvalgte borgerdata, der anvendes til at matche borgeren med søgeregler til de enkelt mødetilbud | ||||
- Jobcenterkode | JobCenterCodeType | Pattern: [0-9]{5} | 1 | Jobcenterkode for det jobcenter borgeren hører til. 5-cifret numerisk format | ||
- Kontaktgruppe | 1 | Kontaktgruppe | ||||
- PersonkategoriStruktur | PersonCategoryType | 0 - 1 | Klientkategoristruktur | |||
- - Personkategori | 0 - 1 | Klientkategori | ||||
- - Haendelsestidspunkt | dateTime | 1 | Angiver den dato og klokkeslæt borger blev kategoriseret. | |||
- | Persongruppemarkeringer Persongruppeprojekter | PersonGroupProjectIdentifierCollectionType | 0 - 1 | Samling af | persongruppemarkeringer for persongruppeprojekter borgeren er knyttet til | |
- - | PersongruppemarkeringId PersongruppeprojektId | guid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 0 - * | Id for en | persongruppemarkering persongruppeprojekt borger er knyttet til |
| 0 - 1 | Samling af borgerens aktuelle indkaldelser | ||||
| 0 - * | Informationsstruktur for en enkelt indkaldelse | ||||
| guid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 0 - 1 | Mulighed for at angive guid på indkaldelsen. | ||
| dateTime |
| 1 | Starttidspunkt for bookingen | ||
| dateTime |
| 0 - 1 | Sluttidspunktet for bookingen | ||
| int |
| 0 - 1 | Mødets varighed i minutter | ||
|
| 1 | Angiver hvilken type møde borgeren skal indkaldes til | |||
|
| 1 | Angiver om der er tale om et gruppemøde eller et individuelt møde. | |||
|
| 1 | Angiver om mødet skal være personligt fremmøde, telefonisk, digitalt eller andet. | |||
- Frister | InterviewDeadlineCollectionType | 0 - 1 | Samling af frister | |||
- - Frist | InterviewDeadlineInfoType | 0 - * | Information om frist for selvbooking | |||
- - - SidsteAfholdelsesdato | date |
| 1 | Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato. | ||
- - - FriststatusType | 1 | Status for frist. | ||||
- - - FristType | 1 | Angiver hvilken samtaletype der skal bookes |
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetSelvbookingMoedetilbudResponse | 1 | |||
- MoedetilbudSamling (InterviewOptionCollection) | InterviewOptionCollectionType | 0 - 11 | Samling af mødetilbud | |
- - Moedetilbud | InterviewOptionType | 0 - * | Mødetilbud | |
- - - MoedetilbudId | guid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 1 | Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbookingflowet. |
- - - SamtaleType (InterviewTypeIdentifier) | 1 | Angiver hvilken samtaletype der skal afholdes | ||
- - - MoedeGruppeType | 1 | Angiver om det er et fælles eller individuelt møde. | ||
- - - Samtaleformer | 1 | En liste med tilgængelige samtaleformer for mødet | ||
- - - - SamtaleformType | 1 - * | Angiver samtaleformen, dvs. om mødet skal være personligt fremmøde, telefonisk osv. | ||
- - - MoedeLokation | InterviewLocationDetailType | 0 - 1 | Information om hvor mødet skal afholdes | |
- - - - Lokationsuddybning (InterviewLocationDescription) | InterviewLocationDescriptionType | Length: 1-200 | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. |
- - - - Adresse | AddressPostalType | 0 - 1 | Adresse | |
| StreetNameType | Length: 1-40 | 1 | Vejnavn. |
| StreetBuildingIdentifierType | Pattern: ([1-9]|[1-9][0-9]|[1-9][0-9]{2})|([1-9][A-Z]|[1-9][0-9][A-Z]|[1-9][0-9]{2}[A-Z]) | 1 |
|
| FloorIdentifierType | Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 |
|
| SuiteIdentifierType | Length: 1-4 | 0 - 1 |
|
| PostCodeIdentifierType | Pattern: [0-9]{4} | 1 | Postnummer |
| DistrictNameType | Length: 1-20 | 1 | Bynavn |
| string |
| 0 - 1 | Landekode. |
- - - MoedeVarighed | int | 1 | Mødets varighed i minutter | |
- - - FoersteMoedetid | dateTime | 0 - 1 | Første mulige mødedato og tid. | |
- - - SidsteMoedetid | dateTime | 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 | MeetingTitleType | Length: 1-100 | 1 | Mødetitel. Vises på Jobnet |
- - - Moedebeskrivelse | MeetingDescriptionType | Length: 0-500 | 0 - 1 | Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet |
- - - Sagsbehandlere | SupervisorCollectionType | 0 - 1 | Samling af relevante sagsbehandlere | |
- - - - Sagsbehandler | CaseWorkerStructureType | 0 - * | Sagsbehandler | |
- - - - - Fornavne | PersonGivenNameType | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
- - - - - Mellemnavn | PersonMiddleNameType | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
- - - - - Efternavn | PersonSurnameNameType | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
- - - - - EksterntId | CaseWorkerIdentifierType | Length: 1-255 | 1 | Sagsbehandler-id |
...
Element | Type | Detaljer | Forekomst | Beskrivelse | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
GetSelvbookingMoedetiderRequest | 1 | |||||||||||||||
| dateTime | 1 | Starttidspunkt for tidsrummet der ønskes mødetider i | |||||||||||||
| dateTime | 1 |
| guid | Sluttidspunkt for tidsrummet der ønskes mødetider i | |||||||||||
| 0 - 1 | Samtaleform hvis denne er valgt på dette punkt i flowet | ||||||||||||||
| CaseWorkerIdentifierType | PatternLength: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 1 | Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbooking flowet. |
| dateTime | 1 | Starttidspunkt for tidsrummet der ønskes mødetider i |
| dateTime | 1 | Sluttidspunkt for tidsrummet der ønskes mødetider i |
| 0 - 1 | Samtaleform hvis denne er valgt på dette punkt i flowet | |
| CaseWorkerIdentifierType | Length: 1-255 | 0 - 1 | Sagsbehandler-id hvis dette er valgt på dette punkt i flowet | ||||||||||||
(InterviewDeadlineCollection) | InterviewDeadlineCollectionType |
| 0 - 1 | Samling af frister | ||||||||||||
(InterviewDeadlineInfo) | InterviewDeadlineInfoType |
| 0 - 1-255 | 0 - 1 | Sagsbehandler-id hvis dette er valgt på dette punkt i flowet | |||||||||||
(InterviewDeadlineCollection) | InterviewDeadlineCollectionType |
| 1 | Samling af frister | ||||||||||||
(InterviewDeadlineInfo) | InterviewDeadlineInfoType |
| 0 - * | Information om frist for selvbooking | ||||||||||||
(InterviewDateLimit) | date |
| 1 | Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato. | ||||||||||||
(InterviewDeadlineStatusTypeIdentifier) |
| 1 | Status for frist. | |||||||||||||
(InterviewTypeIdentifier) |
| 1 | Angiver hvilken samtaletype der skal bookes |
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetSelvbookingMoedetiderResponse | 1 | |||
| 0 - 1 | Samling af sagsbehandlere som kan bookes | ||
| 0 - * | |||
| int | 1 | ||
(Supervisor) | CaseWorkerStructureType |
| 1 | Sagsbehandler |
(CaseWorkerGivenName) | PersonGivenNameType | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
(CaseWorkerMiddleName) | PersonMiddleNameType | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
(CaseWorkerSurname) | PersonSurnameNameType | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
(CaseWorkerIdentifier) | CaseWorkerIdentifierType | Length: 1-255 | 1 | Sagsbehandler-id |
- Moedetider | BookingTimeslotCollectionType | 0 - 1 | Samling af mødetider der kan bookes | |
- - Moedetid | BookingTimeslotType | 0 - * | Mødetid med detaljer | |
- - - Starttidspunkt | dateTime | 1 | Starttidspunkt for møde | |
- - - Samtaleformer | 1 | En liste med tilgængelige samtaleformer for mødet | ||
- - - - SamtaleformType | 1 - * | Samtaleform, dvs. fysisk fremmøde/ telefonisk / videomøde | ||
- - - OmbookingMulig | boolean | 1 | Kan der ombookes for dette mødetilbud | |
- - - AflysningMulig | boolean | 1 | Kan der aflyses på dette mødetilbud | |
- - - MaksimaltMoededeltagerantal | int | 0 - 1 | Det højeste antal deltagere i mødet | |
- - - AntalLedigePladser | int | 0 - 1 | Ledige pladser for mødet | |
- - - BookbareSagsbehandlerIder | CaseWorkerIDType | 1 | Samling af Id’er på sagsbehandlere som kan bookes til denne mødetid | |
- - - - BookbarSagsbehandlerId | int | 1 - * | Sagsbehandler-id |
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetBookingdetaljerResponse | 1 | |||
- Bookingdetaljer | ExternalBookingDetailsType | 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 | |
- - IndkaldelseId | guid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 1 | Unikt id for bookingen (guid) |
- - GruppemoedeId | guid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 0 - 1 | Skal angives for fællesmøder |
- - GruppemoedeEjersystem |
| 0 - 1 | Hvis denne er sat, er det kun det angivne system der må ændre bookingen | |
- - Personnummer | PersonCivilRegistrationIdentifierType | 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 | Personnummer |
| boolean |
| 1 | Kan der ombookes for dette mødetilbud |
| dateTimedate |
| 0 - 1 | Obligatorisk hvis OmbookingMulig er sat til true |
| boolean |
| 1 | Kan borger aflyse dette møde |
| dateTimedate |
| 0 - 1 | Sluttidspunkt for borgers aflysningsmulighed |
| dateTime |
| 1 | Starttidspunkt for bookingen |
| dateTime |
| 0 - 1 | Sluttidspunktet for bookingen |
| 1 | Angiver hvilken samtaletype der skal afholdes | ||
| 1 | Angiver om det er et fælles eller individuelt møde. | ||
- - SamtaleformType | 1 | Angiver afholdelsesformen, dvs. om mødet skal være personligt fremmøde, telefonisk osv. | ||
| MeetingTitleType | Length: 1-100 | 1 | Mødetitel. Vises på Jobnet |
| MeetingDescriptionType | Length: 0-500 | 0 - 1 | Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet |
| CaseWorkerStructureType |
| 1 | Den mødeafholdende sagsbehandler |
| PersonGivenNameType | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
| PersonMiddleNameType | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
| PersonSurnameNameType | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
| CaseWorkerIdentifierType | Length: 1-255 | 1 | Sagsbehandler-id |
(InterviewLocationDetail) | InterviewLocationDetailType | 0 - 1 | Information om hvor mødet skal afholdes | |
(InterviewLocationDescription) | InterviewLocationDescriptionType | Length: 1-200 | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. |
(AddressPostal) | AddressPostalType | 0 - 1 | Adresse | |
| StreetNameType | Length: 1-40 | 1 | Vejnavn. |
| StreetBuildingIdentifierType | Pattern: ([1-9]|[1-9][0-9]|[1-9][0-9]{2})|([1-9][A-Z]|[1-9][0-9][A-Z]|[1-9][0-9]{2}[A-Z]) | 1 |
|
| FloorIdentifierType | Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 |
|
| SuiteIdentifierType | Length: 1-4 | 0 - 1 |
|
| PostCodeIdentifierType | Pattern: [0-9]{4} | 1 | Postnummer |
| DistrictNameType | Length: 1-20 | 1 | Bynavn |
| string |
| 0 - 1 | Landekode. |
| InterviewContactDetailType |
| 0 - 1 | Angiver detaljer om mødet når det ikke er med personligt fremmøde. |
| DigitalContactIdentifierType | Length: 0-2000 | 0 - 1 | Kontaktinformation hvis mødet er digitalt |
| TelephoneNumberIdentifierType | 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. |
| boolean |
| 0 - 1 | Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde. |
| boolean |
| 1 | Om navnet på afholdende sagsbehandler må vises for borger |
...
Metode til at reservere en mødetid til en borger
[Personnummer i header]
Put https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/action/reserver
[Empty body]
Response
[EmptyResponse]
...
GetBookingdetaljer (GetBookingDetails) - Ombooking flow
Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/{body}
Metoden bruges ifm. ombooking til at få alle bookingdetaljer fra det eksterne bookingsystem
...
CreateBooking (CreateBooking) - Booking flow
Post https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Moedetilbud/{MoedetilbudId}/{body}
Metoden bruges ved selvbooking til at oprette selve mødet i det eksterne bookingsystem.
[Personnummer i header]
Input
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
CreateBookingRequest
...
...
...
1
...
MoedetilbudId}/{body}
Metoden bruges ved selvbooking til at oprette selve mødet i det eksterne bookingsystem.
InterviewOptionID er blevet til MoedetilbudId og er flyttet op til at være en del af URL’en
[Personnummer i header]
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
CreateBookingRequest |
|
| 1 |
|
(InterviewOptionID) | guid Base: string | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 1 | Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbooking flowet. |
(BookingStartTime) | dateTime |
| 1 | Starttidspunkt for bookingen |
|
| 0 - 1 | Hvis denne er sat, er det kun det angivne system der må ændre bookingen | |
| InterviewContactTypeIdentifier |
| 0 - 1 |
|
(CaseWorkerIdentifier) | CaseWorkerIdentifierType | Length: 1-255 | 0 - 1 | Sagsbehandler-id |
(IsImmediateBooking) | boolean |
| 1 | Indikerer om der er tale om en straksbooking |
...
GetOmbookingMoedetider (GetRescheduleTimeslots)
Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/{body}
Metoden anvendes af Jobnet, der kalder det eksterne bookingsystem via DFDG. Formålet er at udstille mulige tider til ombookning af et eksisterende planlagt møde, der enten kan være selvbooket eller indkaldt.
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetOmbookingMoedetiderRequest | 1 | |||
| guid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 1 | Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbooking flowet. |
| dateTime |
| 1 | Starttidspunkt for tidsrummet der ønskes mødetider i |
| dateTime |
| 1 | Sluttidspunkt for tidsrummet der ønskes mødetider i |
| 0 - 1 | Samtaleform hvis denne er valgt på dette punkt i flowet | ||
| CaseWorkerIdentifierType | Length: 1-255 | 0 - 1 | Sagsbehandler-id hvis dette er valgt på dette punkt i flowet |
(InterviewDeadlineCollection) | InterviewDeadlineCollectionType |
| 0 - 1 | Samling af frister |
(InterviewDeadlineInfo) | InterviewDeadlineInfoType |
| 0 - * | Information om frist for selvbooking |
(InterviewDateLimit) | date |
| 1 | Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato. |
(InterviewDeadlineStatusTypeIdentifier) |
| 1 | Status for frist. | |
(InterviewTypeIdentifier) |
| 1 | Angiver hvilken samtaletype der skal bookes |
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetOmbookingMoedetiderResponse |
|
| 1 |
|
|
|
| 0 - 1 |
|
|
|
| 0 - * |
|
| int |
| 1 |
|
(Supervisor) | CaseWorkerStructureType |
| 0 - * | Sagsbehandler |
(CaseWorkerGivenName) | PersonGivenNameType | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
(CaseWorkerMiddleName) | PersonMiddleNameType | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
(CaseWorkerSurname) | PersonSurnameNameType | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
(CaseWorkerIdentifier) | CaseWorkerIdentifierType | Length: 1-255 | 1 | Sagsbehandler-id |
(BookingTimeslotCollection) | BookingTimeslotCollectionType |
| 0 - 1 | Samling af mødetider der kan bookes |
(BookingTimeslot) | BookingTimeslotType |
| 0 - * | Mødetid med detaljer |
(StartTime) | dateTime |
| 1 | Starttidspunkt for møde |
| 1 | En liste med tilgængelige samtaleformer for mødet | ||
| 1 - * | Samtaleform, dvs. fysisk fremmøde/ telefonisk / videomøde | ||
(RebookingPossible) | boolean |
| 1 | Kan der ombookes for dette mødetilbud |
(CancellationPossible) | boolean |
| 1 | Kan der aflyses på dette mødetilbud |
(TotalNoOfSeats) | int |
| 0 - 1 | Det højeste antal deltagere i mødet |
(AvailableNoOfSeats) | int |
| 0 - 1 | Ledige pladser for mødet |
(CaseWorkerIDCollection) | CaseWorkerIDType |
| 1 | Samling af Id’er på sagsbehandlere som kan bookes til denne mødetid |
(CaseWorkerID) | int |
| 1 - * | Sagsbehandler-id |
| 1 | Angiver hvilken samtaletype der skal afholdes |
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetOmbookingSagsbehandlereResponse | GetRescheduleSupervisorsResponseType | 1 | ||
| boolean | 1 | Angiver hvorvidt borger kan se og vælge en specifik sagsbehandler. For fællesmøder altid false | |
(SupervisorCollection) | SupervisorCollectionType |
| 0 - 1 | Samling af relevante sagsbehandlere |
(Supervisor) | CaseWorkerStructureType |
| 0 - * | Sagsbehandler |
(CaseWorkerGivenName) | PersonGivenNameType | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
(CaseWorkerMiddleName) | PersonMiddleNameType | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
(CaseWorkerSurname) | PersonSurnameNameType | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
(CaseWorkerIdentifier) | CaseWorkerIdentifierType | Length: 1-255 | 1 | Sagsbehandler-id |
...
Metoden bruges ved straksbooking til at hente et antal mødetidspunkter for alle mødetilbud af den specifikke samtaletype.
HasExternalOperatorReferral er taget ud, som tidligere udmeldt.
Input
[Personnummer i header]
Element | Type | Detaljer | Forekomst | Beskrivelse | ||
---|---|---|---|---|---|---|
GetStraksbookingMoedetiderRequest | 1 | |||||
(JobCenterCode) | JobCenterCodeType | Pattern: [0-9]{5} | 1 | Jobcenterkode for det jobcenter borgeren hører til. 5-cifret numerisk format | ||
(ContactGroupTypeIdentifier) |
| 1 | Kontaktgruppe | |||
(PersonCategory) | PersonCategoryType |
| 0 - 1 | Klientkategoristruktur | ||
(PersonCategoryTypeIdentifier) |
| 0 - 1 | Klientkategori | |||
(IncidentDate) | dateTime |
| 1 | Angiver den dato og klokkeslet borger blev kategoriseret. | ||
(PersonGroupProjectIdentifierCollection) | PersonGroupProjectIdentifierCollectionType |
| 0 - 1 | Samling af | persongruppemarkeringer for persongruppeprojekter borgeren er knyttet til | |
| PersongruppemarkeringId
(PersonGroupProjectIdentifier) | guid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 0 - * | Id for en | persongruppemarkering persongruppeprojekt borger er knyttet til |
| int | 1 | Antal mødetider | |||
| date | 1 | Startdato på timeslottet | |||
| date | 1 | Slutdato på timeslot | |||
| 1 | Angiver hvilken samtaletype der skal afholdes |
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetStraksbookingMoedetiderResponse | 1 | |||
|
|
| 0 - 1 |
|
|
|
| 0 - * |
|
| int |
| 1 |
|
(Supervisor) | CaseWorkerStructureType |
| 0 - * | Sagsbehandler |
(CaseWorkerGivenName) | PersonGivenNameType | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
(CaseWorkerMiddleName) | PersonMiddleNameType | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
(CaseWorkerSurname) | PersonSurnameNameType | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
(CaseWorkerIdentifier) | CaseWorkerIdentifierType | Length: 1-255 | 1 | Sagsbehandler-id |
(BookingTimeslotCollection) |
| 0 - 1 | Samling af mødetider der kan bookes | |
(BookingTimeslot) | BookingTimeslotType |
| 0 - * | Mødetid med detaljer |
(StartTime) | dateTime |
| 1 | Starttidspunkt for møde |
| 1 | En liste med tilgængelige samtaleformer for mødet | ||
| 1 - * | Samtaleform, dvs. fysisk fremmøde/ telefonisk / videomøde | ||
(RebookingPossible) | boolean |
| 1 | Kan der ombookes for dette mødetilbud |
(CancellationPossible) | boolean |
| 1 | Kan der aflyses på dette mødetilbud |
(TotalNoOfSeats) | int |
| 0 - 1 | Det højeste antal deltagere i mødet |
(AvailableNoOfSeats) | int |
| 0 - 1 | Ledige pladser for mødet |
(CaseWorkerIDCollection) | CaseWorkerIDType |
| 1 | Samling af Id’er på sagsbehandlere som kan bookes til denne mødetid |
(CaseWorkerID) | int |
| 1 - * | Sagsbehandler-id |
(InterviewOptionID) | guid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 1 | Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbookingflowet. |
(MeetingTitle) | MeetingTitleType | Length: 1-100 | 1 | Mødetitel. Vises på Jobnet |
(MeetingDescription) | MeetingDescriptionType | Length: 0-500 | 0 - 1 | Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet |
(MeetingDurationMinutes) | int |
| 1 | Mødets varighed i minutter |
(InterviewTypeIdentifier) |
| 1 | Angiver hvilken samtaletype der skal afholdes | |
(InterviewFormTypeIdentifier) |
| 1 | Angiver om det er et fælles eller individuelt møde. | |
(InterviewLocationDetail) | InterviewLocationDetailType |
| 0 - 1 | Information om hvor mødet skal afholdes |
(InterviewLocationDescription) | InterviewLocationDescriptionType | Length: 1-200 | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. |
(AddressPostal) | AddressPostalType |
| 0 - 1 | Adresse |
| StreetNameType | Length: 1-40 | 1 | Vejnavn. |
| StreetBuildingIdentifierType | Pattern: ([1-9]|[1-9][0-9]|[1-9][0-9]{2})|([1-9][A-Z]|[1-9][0-9][A-Z]|[1-9][0-9]{2}[A-Z]) | 1 |
|
| FloorIdentifierType | Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 |
|
| SuiteIdentifierType | Length: 1-4 | 0 - 1 |
|
| PostCodeIdentifierType | Pattern: [0-9]{4} | 1 | Postnummer |
| DistrictNameType | Length: 1-20 | 1 | Bynavn |
| string |
| 0 - 1 | Landekode. |
(AllowChoiceOfSupervisor) | boolean | 1 | Angiver hvorvidt borger kan se og vælge en specifik sagsbehandler. For fællesmøder altid false |
...
SaveIndkaldelsesaccept (AcceptBooking)
Put https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/Accept
Bruges når borgeren via Jobnet accepterer en indkaldelse. Kaldet medfører en markering i det eksterne bookingsystem, der tydeliggør, at borgeren har set indkaldelsen.
...
DeleteIndkaldelse (CancelBooking)
Delete https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}
Metoden bruges til at aflyse et møde i det eksterne bookingsystem.
...
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | Failed to validate message | The submitted message could not be validated |
4650 | It is not allowed to delete this registration because the startdate lies in the past | It is not allowed to delete this registration because the startdate lies in the past |
4768 | The submitted BookingIdentifier is unknown to the system | The submitted BookingIdentifier is unknown to the system |
4820 | Cancellation is not allowed | Cancellation is not allowed, or cancellation deadline is exceeded |
8107 | The BookingIdentifier does not correspond to the person civil registration identifier | The BookingIdentifier does not correspond to the person civil registration identifier |
9130 | The Booking can not be rescheduled or cancelled by the citizen because it is an immediate booking | The Booking can not be rescheduled or cancelled by the citizen because it is an immediate booking |
SaveBookingList (udfases)
Denne metode skal kaldes, når KSS kalder SaveBookingList i BookingService. På den måde vil det være muligt at overføre indkaldelisterne online til det eksterne bookingsystem.
...