Servicen udstilles af plannersystemer og anvendes af DFDG for at understøtte borgers selvbooking og ombooking på Jobnet.
...
Table of Contents | ||
---|---|---|
|
Forslag til endpoints/metoder/resourcer:
Resourcer er: Fejlmelding, Moedetilbud, Booking, Sagsbehandler og Straksbookingtilbud.
CreateFejlmelding- Opret ny fejlmeding - Post https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Fejlmelding
GetSelvbookingMoedetilbud - Hent mødetilbud - Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Moedetilbud
GetSelvbookingMoedetider - Hent mødetider og sagsbehandler for et mødetilbud - Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Moedetilbud/{MoedetilbudId}/{…}
GetBookingdetaljer - Hent bookingdetaljer og reserver timeslot - Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{…}
CreateBooking - Opret en booking i det eksterne booking system - Post https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{…}
GetOmbookingMoedetider - Hent mødetider og sagsbehandlere ifm ombooking - Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Moedetilbud/{MoedetilbudId}/{…} - samme som GetSelvbookingMoedetider?
GetOmbookingSagsbehandlere - Hent mulige sagsbehandlere for et booket møde - Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Sagsbehandler/{IndkaldelseId}
CreateOmbooking - Lav en ombooking i det eksterne booking system - Put https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{…}
GetStraksbookingMoedetider - Hent tider for en straksbooking - Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Straksbookingtilbud/{…}
SaveIndkaldelsesaccept - Borgers accept af en indkaldelse - Put https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/Accept
DeleteIndkaldelse - Slet en indkaldelse i det eksterne booking system - Delete https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}
CreateFejlmelding
Metode til tilbagemeldinger om fejl på Jobnet, booking-tilbud som ikke kan validere i DFDG med mere
...
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 |
|
...
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetSelvbookingMoedetiderResponse | 1 | |||
| 0 - 1 | |||
| 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 |
- MoedetidSamling | BookingTimeslotCollectionType | 0 - 1 | Samling af mødetider der kan bookes | |
- - Moedetid MoedetidStruktur | BookingTimeslotType | 0 - * | Mødetid med detaljer | |
- - - Starttidspunkt | dateTime | 1 | Starttidspunkt for møde | |
- - - SamtaleformSamling | 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 | |
- - - BookbarSagsbehandlerIdSamling | 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 |
---|---|---|---|---|
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 |
...
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 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
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) | 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 | ||||||||
(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. |
| 1 | En liste med tilgængelige samtaleformer for mødet |
| 1 - * | Samtaleform, dvs. | fysisk fremmøde/ telefonisk / videomø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. | ||||||||
(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 |
| ||||||||
(AllowChoiceOfSupervisor) | boolean | 1 | Angiver hvorvidt borger kan se og vælge en specifik sagsbehandler. For fællesmøder altid false |
...
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.
...