Servicen udstilles af plannersystemer og anvendes af DFDG for at understøtte borgers selvbooking og ombooking på Jobnet.
...
GetSelvbookingMoedetilbud - Hent mødetilbud - Get https://kontaktforloebt12.startest.dk /v1/BorgerBooking/Moedetilbud/{body}
GetSelvbookingMoedetider - Hent mødetider og sagsbehandler for et mødetilbud - Get https: //kontaktforloebt12.startest.dk/v1/BorgerBooking/Moedetilbud/{MoedetilbudId}/Moedetider/{body}
GetBookingdetaljer - Hent bookingdetaljer - Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Moedetilbud/{MoedetilbudId}/Detaljer/{body}
CreateMoedetidReservation - Reserver timeslot - Post https: //kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/action/reserver
CreateBooking - Opret en booking i det eksterne booking system - Put https://kontaktforloebt12.startest.dk/Post /v1/BorgerBooking/Booking/{MoedetilbudId}/{body}
...
GetOmbookingMoedetider - Hent mødetider og sagsbehandlere ifm ombooking - Get https: //kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/Moedetider/{body}
GetOmbookingSagsbehandlere - Hent mulige sagsbehandlere for et booket møde - Get https://kontaktforloebt12.startest.dk /v1/BorgerBooking/Booking/{IndkaldelseId}/Sagsbehandlere
GetBookingdetaljer - Hent bookingdetaljer og reserver timeslot - Get https:/ /kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/Detaljer/{body}
CreateMoedetidReservation - Reserver timeslot - Post https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/action/reserver
CreateOmbooking - Tilpas en booking i det eksterne booking system - Put https://kontaktforloebt12.startest.dk- Put /v1/BorgerBooking/Booking/{IndkaldelseId}/{body}
...
GetStraksbookingMoedetider - Hent tider for en straksbooking - Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Straksbookingtilbud/{…}
GetBookingdetaljer - Hent bookingdetaljer og reserver timeslot - Get https:/ /kontaktforloebt12.startest.dk/v1/BorgerBooking/Moedetilbud/{MoedetilbudId}/{body}
CreateMoedetidReservation - Reserver timeslot - Post /v1/BorgerBooking/Booking/{IndkaldelseId}/action/reserver
CreateBooking - Opret en booking i det eksterne booking system - Post https:/ /kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{MoedetilbudId}/{body}
...
SaveIndkaldelsesaccept - Borgers accept af en indkaldelse - Put https: //kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/Action/Accept
...
DeleteIndkaldelse - Slet en indkaldelse i det eksterne booking system - Delete https: //kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}
...
Sender en fejlmeding tilbage til bookingsystemet inden der kastes en fejl til jobnet, resource: fejlmelding
CreateFejlmelding- Opret ny fejlmeding - Post https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Fejlmelding/{body}
CreateFejlmelding
Metode til tilbagemeldinger om fejl på Jobnet, booking-tilbud som ikke kan validere i DFDG med mere
...
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 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 |
...
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 | 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 |
|
...
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.
...
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.
...
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | Failed to validate message | The submitted message could not be validated |
4768 | The submitted BookingIdentifier is unknown to the system | The submitted BookingIdentifier is unknown to the system |
4770 | There are no available booking options | There are no available booking options |
4783 | The BookingTime cannot be before todays date | The BookingTime cannot be before todays date |
4812 | The booking does not allow selfbooking | The booking does not allow selfbooking |
GetOmbookingSagsbehandlere (GetRescheduleSupervisors)
...
does not allow selfbooking |
GetOmbookingSagsbehandlere (GetRescheduleSupervisors)
Metoden bruges ved ombookning til at hente en liste af mulige sagsbehandlere. Alle mulige sagsbehandlere, uanset om de har tid, bliver returneret.
Input
[Personnummer i header]
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
GetOmbookingSagsbehandlereRequest
...
1
[Empty body]
Output
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 |
...
CreateOmbooking (RescheduleBooking)
Put https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/{body}
Bruges til borgers ombooking af tidligere oprettede møder. Dette kan både være indkaldte og selvbookede møder.
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
CreateOmbookingRequest | 1 | |||
| dateTime |
| 1 | Starttidspunkt for bookingen |
- SamtaleformType | 0 - 1 | Borgers valgte samtaleform | ||
| CaseWorkerIdentifierType | Length: 1-255 | 0 - 1 | Sagsbehandler-id |
Output
[EmptyResponse]
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
---|---|---|
1014 | Failed to validate message | The submitted message could not be validated |
4767 | The booking has already been taken | The booking has already been taken |
4768 | The submitted BookingIdentifier is unknown to the system | The submitted BookingIdentifier is unknown to the system |
4783 | The BookingTime cannot be before todays date | The BookingTime cannot be before todays date |
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 |
GetStraksbookingMoedetider (GetImmediateBookingTimeslots)
...
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 borgeren |
(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 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 |
Output
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.
Input
[Personnummer i header]
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
SaveIndkaldelsesacceptRequest
...
AcceptBookingRequestType
...
[Empty body]
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
EmptyResponse |
...
DeleteIndkaldelse (CancelBooking)
Delete https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}
Metoden bruges til at aflyse et møde i det eksterne bookingsystem.
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
DeleteIndkaldelseRequest | CancelBookingRequestType | 1 | ||
- Aflysningsaarsag | 1 | Aflysningsårsag |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
EmptyResponse |
...
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.
...