Servicen udstilles af plannersystemer og anvendes af DFDG for at understøtte borgers selvbooking og ombooking på Jobnet.
Metoder
| Table of Contents | ||
|---|---|---|
|
CreateFejlmelding
Metode til tilbagemeldinger om fejl på Jobnet, booking-tilbud som ikke kan validere i DFDG med mere
Input
[ Personnummer i HEADER ]
...
Element
...
Type
...
Forekomst
...
Beskrivelse
...
MoedetilbudId
...
GUID
...
0 - 1
...
Hvis fejlmeldingen er knyttet til et specifikt mødetilbud angives ID
...
IndkaldelseId
...
GUID
...
0 - 1
...
Hvis fejlmeldingen er knyttet til et specifikt møde angives ID
...
Fejlkode
...
Int
...
1
Fejl på Jobnet...
Fejl fanget i DFDGs validering på baggrund af GetBookingDetails...
...
Fejltekst
...
String (500)
...
0 - 1
...
Beskrivelse af fejlsituationen, herunder manuelt fra borger på Jobnet
...
FejlOphav
...
...
1
...
Hvilket system fejlen er opstået i (Jobnet/DFDG)
...
FejlTidspunkt
...
dateTime
...
1
...
Tidspunkt for fejlens registrering
Fejlkode kodelisten
...
Id
...
Navn
...
Beskrivelse
...
¤
Output
(Emptyresponse)
Fejl
Ukendt borger, Ukendt MødetilbudId, ukendt MødeId, Ukendt fejlkode
...
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
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
(JobCenterCode)
...
JobCenterCodeType
Base: string
...
Pattern: [0-9]{5}
...
1
...
Jobcenterkode for det jobcenter borgeren hører til. 5-cifret numerisk format
...
- Kontaktgruppe
(ContactGroupTypeIdentifier)
...
ContactGroupTypeIdentifierType
...
1
...
Kontaktgruppe
...
- PersonkategoriStruktur
(PersonCategory)
...
PersonCategoryType
...
0 - 1
...
Klientkategoristruktur
...
- - Personkategori
(PersonCategoryTypeIdentifier)
...
PersonCategoryTypeIdentifierType
...
0 - 1
...
Klientkategori
...
- - Haendelsestidspunkt
(IncidentDate)
...
dateTime
...
1
...
Angiver den dato og klokkeslet borger blev kategoriseret.
...
- PersongruppemarkeringSamling
(PersonGroupProjectIdentifierCollection)
...
PersonGroupProjectIdentifierCollectionType
...
0 - 1
...
Samling af persongruppemarkeringer for borgeren
...
- - PersongruppemarkeringId
(PersonGroupProjectIdentifier)
...
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}
...
0 - *
...
Id for en persongruppemarkering borger er knyttet til
...
IndkaldelseSamling
...
Samling af borgerens aktuelle indkaldelser
...
- IndkaldelseStruktur
...
Data for en enkelt indkaldelse
...
- - IndkaldelseId
(BookingIdentifier)
...
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}
...
0 - 1
...
Mulighed for at angive guid på indkaldelsen.
...
- - MoedeStarttidspunkt
(BookingStartTime)
...
dateTime
...
...
1
...
Starttidspunkt for bookingen
...
- - MoedeSluttidspunkt
(BookingEndTime)
...
dateTime
...
...
0 - 1
...
Sluttidspunktet for bookingen
...
- - Moedevarighed
(BookingDuration)
...
int
...
...
0 - 1
...
Mødets varighed i minutter
...
- - SamtaleType
(InterviewTypeIdentifier)
...
...
...
1
...
Angiver hvilken type møde borgeren skal indkaldes til
...
- - MoedeGruppeType
(InterviewFormTypeIdentifier)
...
InterviewFormTypeIdentifierType
...
...
1
...
Angiver om der er tale om et gruppemøde eller et individuelt møde.
...
- - SamtaleformType
(InterviewContactTypeIdentifier)
...
InterviewContactTypeIdentifierType
...
...
1
...
Angiver om mødet skal være personligt fremmøde, telefonisk, digitalt eller andet.
...
- FristSamling
(InterviewDeadlineCollection)
...
InterviewDeadlineCollectionType
...
0 - 1
...
Samling af frister
...
- - FristStruktur
(InterviewDeadlineInfo)
...
InterviewDeadlineInfoType
...
0 - *
...
Information om frist for selvbooking
...
- - - SidsteAfholdelsesdato
(InterviewDateLimit)
...
date
...
1
...
Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato
...
- - - FriststatusType
(InterviewDeadlineStatusTypeIdentifier)
...
InterviewDeadlineStatusTypeIdentifierType
...
1
...
Status for frist.
...
- - - FristType
(InterviewTypeIdentifier)
...
...
1
...
Angiver hvilken samtaletype der skal bookes
Output
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
GetSelvbookingMoedetilbudResponse
...
1
...
- MoedetilbudSamling (InterviewOptionCollection)
...
InterviewOptionCollectionType
...
0 - 1
...
Samling af mødetilbud
...
- - Moedetilbud
(InterviewOption)
...
InterviewOptionType
...
0 - *
...
Mødetilbud
...
- - - MoedetilbudId
(InterviewOptionIdentifier)
...
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 selvbookingflowet.
...
- - - SamtaleType (InterviewTypeIdentifier)
...
...
1
...
Angiver hvilken samtaletype der skal afholdes
...
- - - MoedeGruppeType
(InterviewFormTypeIdentifier)
...
InterviewFormTypeIdentifierType
...
1
...
Angiver om det er et fælles eller individuelt møde.
...
- - - SamtaleformSamling
...
1
...
En liste med tilgængelige samtaleformer for mødet
...
- - - - SamtaleformType
...
InterviewContactTypeIdentifierType
...
1 - *
...
Angiver samtaleformen, dvs. om mødet skal være personligt fremmøde, telefonisk osv.
...
- - - MoedeLokationStruktur
(InterviewLocationDetail)
...
InterviewLocationDetailType
...
0 - 1
...
Information om hvor mødet skal afholdes
...
- - - - Lokationsuddybning (InterviewLocationDescription)
...
InterviewLocationDescriptionType
Base: string
...
Length: 1-200
...
0 - 1
...
Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig.
...
AddressPostalType
...
0 - 1
...
Adresse
...
- - - Vejnavn
(StreetName)
...
StreetNameType
Base: string
...
Length: 1-40
...
1
...
Vejnavn.
...
- - - Husnummer
(StreetBuildingIdentifier)
...
StreetBuildingIdentifierType
Base: string
...
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
...
- - - Etage
(FloorIdentifier)
...
FloorIdentifierType
Base: string
...
Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]
...
0 - 1
...
- - - SideDoer
(SuiteIdentifier)
...
SuiteIdentifierType
Base: string
...
Length: 1-4
...
0 - 1
...
- - - Postnummer
(PostCodeIdentifier)
...
PostCodeIdentifierType
Base: string
...
Pattern: [0-9]{4}
...
1
...
Postnummer
...
- - - Bynavn
(DistrictName)
...
DistrictNameType
Base: string
...
Length: 1-20
...
1
...
Bynavn
...
- - - Landekode
(CountryIdentificationCode)
...
string
...
...
0 - 1
...
Landekode.
...
- - - MoedeVarighed
(MeetingDurationMinutes)
...
int
...
1
...
Mødets varighed i minutter
...
- - - FoersteMoedetid
(FirstTimeslot)
...
dateTime
...
0 - 1
...
Første mulige mødedato og tid.
Kan være forekomst 0, hvor det stadig er relevant at have et InterviewOption element for at kunne vise møde-tilbudstypen til Jobnet
...
- - - SidsteMoedetid
(LastTimeslot)
...
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 FirstTimeslot hvis der er tale om et fællesmøde, der kun foregår på en enkelt specifik dag
...
- - - BorgerKanVaelgeSagsbehandler
(AllowChoiceOfSupervisor)
...
boolean
...
1
...
Angiver hvorvidt borger kan se og vælge en specifik sagsbehandler. For fællesmøder altid false
...
- - - Moedetitel
(MeetingTitle)
...
MeetingTitleType
Base: string
...
Length: 1-100
...
1
...
Mødetitel. Vises på Jobnet
...
- - - Moedebeskrivelse
(MeetingDescription)
...
MeetingDescriptionType
Base: string
...
Length: 0-500
...
0 - 1
...
Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet
...
- - - SagsbehandlerSamling
(SupervisorCollection)
...
SupervisorCollectionType
...
0 - 1
...
Samling af relevante sagsbehandlere
...
- - - - Sagsbehandler
(Supervisor)
...
CaseWorkerStructureType
...
0 - *
...
Sagsbehandler
...
- - - - - Fornavne
(CaseWorkerGivenName)
...
PersonGivenNameType
Base: string
...
Length: 1-50
...
1
...
Sagsbehandlerens fornavn(e).
...
- - - - - Mellemnavn
(CaseWorkerMiddleName)
...
PersonMiddleNameType
Base: string
...
Length: 1-40
...
0 - 1
...
Sagsbehandlerens mellemnavn.
...
- - - - - Efternavn
(CaseWorkerSurname)
...
PersonSurnameNameType
Base: string
...
Length: 1-40
...
1
...
Sagsbehandlerens efternavn.
...
- - - - - EksterntId
(CaseWorkerIdentifier)
...
CaseWorkerIdentifierType
Base: string
...
Length: 1-255
...
1
...
Sagsbehandler-id
Fejlkoder
...
Fejlkode
...
Fejltekst
...
Beskrivelse
...
¤1014
...
Failed to validate message
...
The submitted message could not be validated
...
¤8111
...
An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier
...
An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier
GetSelvbookingMoedetider (GetSelfbookTimeslots)
Metoden bruges ved selvbooking til at hente mulige mødetidspunkter for et specifikt mødetilbud. Metoden kaldes af Jobnet via DFDG til det eksterne bookingsystem.
[ Personnummer i HEADER ]
Input
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
GetSelvbookingMoedetiderRequest
...
1
...
Servicen udstilles af plannersystemer og anvendes af DFDG for at understøtte borgers selvbooking og ombooking på Jobnet.
Metoder
| Table of Contents | ||||
|---|---|---|---|---|
|
Hovedflow, booking
Booking ud fra mødetilbud, resources: Moedetilbud
GetSelvbookingMoedetilbud - Hent mødetilbud - Get /v1/BorgerBooking/Moedetilbud/{body}
GetSelvbookingMoedetider - Hent mødetider og sagsbehandler for et mødetilbud - Get /v1/BorgerBooking/Moedetilbud/{MoedetilbudId}/Moedetider/{body}
GetBookingdetaljer - Hent bookingdetaljer - 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/{IndkaldelseId}/{body}
Alternativt flow ombooking
Ombooking af en eksisterende booking, resources: Booking og Sagsbehandler
GetOmbookingMoedetider - Hent mødetider og sagsbehandlere ifm ombooking - Get /v1/BorgerBooking/Booking/{IndkaldelseId}/Moedetider/{body}
GetOmbookingSagsbehandlere - Hent mulige sagsbehandlere for et booket møde - Get /v1/BorgerBooking/Booking/{IndkaldelseId}/Sagsbehandlere
GetBookingdetaljer - Hent bookingdetaljer og reserver timeslot - Get /v1/BorgerBooking/Booking/{IndkaldelseId}/Detaljer/{body}
CreateMoedetidReservation - Reserver timeslot - Post /v1/BorgerBooking/Booking/{IndkaldelseId}/action/reserver
CreateOmbooking - Tilpas en booking i det eksterne booking system - Put /v1/BorgerBooking/Booking/{IndkaldelseId}/{body}
Alternativt flow straksbooking
Oprettelsen af en booking ud fra et mødetilbug, resource: Moedetilbud
GetStraksbookingMoedetider - Hent tider for en straksbooking - Get /v1/BorgerBooking/Straksbookingtilbud/{…}
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/{IndkaldelseId}/{body}
Alternativt flow accept booking
Acceptere en booking som borger, resource: booking
SaveIndkaldelsesaccept - Borgers accept af en indkaldelse - Put /v1/BorgerBooking/Booking/{IndkaldelseId}/Action/Accept
Alternativt flow slet booking
Sletter en allerede oprettet booking, resource: booking
DeleteIndkaldelse - Slet en indkaldelse i det eksterne booking system - Delete /v1/BorgerBooking/Booking/{IndkaldelseId}
Alternativt flow opret fejlmelding
Sender en fejlmeding tilbage til bookingsystemet inden der kastes en fejl til jobnet, resource: fejlmelding
CreateFejlmelding- Opret ny fejlmeding - Post /v1/BorgerBooking/Fejlmelding/{body}
CreateFejlmelding
Metode til tilbagemeldinger om fejl på Jobnet, booking-tilbud som ikke kan validere i DFDG med mere
Input
[ Personnummer i HEADER ]
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 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 |
|---|---|---|
1 | 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 |
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. | |
- Persongruppeprojekter | PersonGroupProjectIdentifierCollectionType | 1 | Samling af persongruppeprojekter borgeren er knyttet til | |
- - 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 persongruppeprojekt borger er knyttet til |
| 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 | 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 |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
GetSelvbookingMoedetilbudResponse | 1 | |||
- MoedetilbudSamling (InterviewOptionCollection) | InterviewOptionCollectionType | 1 | 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] |
1
Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbooking flowet.
StartMoedetidsinterval
(BookingOptionIntervalStartTime)
dateTime
1
Starttidspunkt for tidsrummet der ønskes mødetider i
SlutMoedetidsinterval
(BookingOptionIntervalEndTime)
dateTime
1
Sluttidspunkt for tidsrummet der ønskes mødetider i
SamtaleformType
0 - 1
Samtaleform hvis denne er valgt på dette punkt i flowet
EksterntId
(CaseWorkerIdentifier)
{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- |
Element
Type
Detaljer
Forekomst
Beskrivelse
GetSelvbookMoedetiderResponse
1
BookbarSagsbehandlerSamling
(SupervisorToBookCollection)
0 - 1
- BookbarSagsbehandler
(SupervisorToBook)
0 - *
- - Id
int
1
- - Sagsbehandler
(Supervisor)
CaseWorkerStructureType
0 - *
Sagsbehandler
- - - Fornavne
(CaseWorkerGivenName)
PersonGivenNameType
Base: string
Length: 1-50
1
Sagsbehandlerens fornavn(e).
- - - Mellemnavn
(CaseWorkerMiddleName)
200 | 0 - 1 |
Sagsbehandler-id hvis dette er valgt på dette punkt i flowet
FristSamling
(InterviewDeadlineCollection)
InterviewDeadlineCollectionType
0 - 1
Samling af frister
- FristStruktur
(InterviewDeadlineInfo)
InterviewDeadlineInfoType
0 - *
Information om frist for selvbooking
- - SidsteAfholdelsesdato
(InterviewDateLimit)
date
1
Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato
- - FriststatusType
(InterviewDeadlineStatusTypeIdentifier)
1
Status for frist.
- - FristType
(InterviewTypeIdentifier)
1
Angiver hvilken samtaletype der skal bookes
Output
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 |
Sagsbehandler-id
- MoedetidSamling
(BookingTimeslotCollection)
Bynavn | |||
| string |
| 0 - 1 |
Samling af mødetider der kan bookes
Landekode. |
- - - |
MoedeVarighed |
MeetingDurationMinutes) |
int |
0 - *
1 | Mødets varighed i minutter | |
- - - |
FoersteMoedetid |
FirstTimeslot) | dateTime | 0 - 1 |
Starttidspunkt for møde
- - - SamtaleformSamling
1
En liste med tilgængelige samtaleformer for mødet
- - - - SamtaleformType
1 - *
Første mulige mødedato og tid. |
- - - |
SidsteMoedetid |
LastTimeslot) |
dateTime |
1
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 |
AllowChoiceOfSupervisor) | boolean | 1 |
Angiver hvorvidt borger kan se og vælge en specifik sagsbehandler. For fællesmøder altid false |
- - - |
Moedetitel |
MeetingTitle) |
int
0 - 1
MeetingTitleType | Length: 1-100 | 1 | Mødetitel. Vises på Jobnet |
- - - |
Moedebeskrivelse |
MeetingDescription) |
int
MeetingDescriptionType | Length: 0- |
Ledige pladser for mødet
- - - BookbarSagsbehandlerIdSamling
(CaseWorkerIDCollection)
CaseWorkerIDType
1
500 | 0 - 1 | Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet |
- - - |
Sagsbehandlere |
int
1 - *
Sagsbehandler-id
Fejlkoder
...
Fejlkode
...
Fejltekst
...
Beskrivelse
...
1014
...
Failed to validate message
...
The submitted message could not be validated
...
4770
...
There are no available booking options
...
There are no available booking options
...
8107
...
The BookingIdentifier does not correspond to the person civil registration identifier
...
The BookingIdentifier does not correspond to the person civil registration identifier
...
8111
...
An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier
...
An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier
GetBookingdetaljer (GetBookingDetails)
Metoden bruges ifm. booking og ombooking til at få alle bookingdetaljer fra det eksterne bookingsystem, inden den egentlige booking foretages. Herved kan både det eksterne bookingsystem og DFDG validere, inden booking foretages.
[Personnummer i header]
Input
Element
Type
Detaljer
Forekomst
Beskrivelse
GetBookingDetaljerRequest
1
- IndkaldelseId
(BookingIdentifier)
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}
0 - 1
Unikt id (GUID) for bookingen som medsendes når der er tale om en ombookning
- MoedeStarttidspunkt
(BookingStartTime)
dateTime
1
Starttidspunkt for bookingen
- MoedetilbudId
(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}
0 - 1
Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbookingflowet.
- SamtaleformType
InterviewContactTypeIdentifier
0 - 1
SupervisorCollection) | SupervisorCollectionType | 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 |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
¤1014 | Failed to validate message | The submitted message could not be validated |
¤8111 | An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier | An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier |
GetSelvbookingMoedetider (GetSelfbookTimeslots)
Metoden bruges ved selvbooking til at hente mulige mødetidspunkter for et specifikt mødetilbud. Metoden kaldes af Jobnet via DFDG til det eksterne bookingsystem.
[ Personnummer i HEADER ]
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
GetSelvbookingMoedetiderRequest | 1 | |||
| 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 |
| 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 |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
GetSelvbookingMoedetiderResponse | 1 | |||
| 1 | Samling af sagsbehandlere som kan bookes | ||
| 0 - * | |||
| int | 1 | ||
|
( |
Supervisor) | CaseWorkerStructureType |
| 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
Sagsbehandler |
|
( |
CaseWorkerGivenName) |
PersonGivenNameType |
Length: |
1
Unikt id for bookingen (guid)
- - GruppemoedeId
(GroupBookingIdentifier)
1-50 | 1 | Sagsbehandlerens fornavn(e). | ||
(CaseWorkerMiddleName) | PersonMiddleNameType | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
(CaseWorkerSurname) | PersonSurnameNameType |
Length: |
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
(PersonCivilRegistrationIdentifier)
PersonCivilRegistrationIdentifierType
Base: 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
Personnummer
- OmbookingMulig
(ReBookingPossible)
boolean
1
Kan der ombookes for dette mødetilbud
- OmbookingFrist
(ReBookingDeadline)
dateTime
0 - 1
Obligatorisk hvis OmbookingMulig er sat til true
- AflysningMulig
(CancellationPossible)
boolean
1
Kan borger aflyse dette møde
- Aflysningsfrist
(CancellationDeadline)
dateTime
0 - 1
Sluttidspunkt for borgers aflysningsmulighed
- MoedeStarttidspunkt
(BookingStartTime)
dateTime
1
Starttidspunkt for bookingen
- MoedeSluttidspunkt
(BookingEndTime)
dateTime
0 - 1
Sluttidspunktet for bookingen
- SamtaleType
(InterviewTypeIdentifier)
1
Angiver hvilken samtaletype der skal afholdes
- MoedeGruppeType
(InterviewFormTypeIdentifier)
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.
- Moedetitel
(MeetingTitle)
MeetingTitleType
Base: string
Length: 1-100
1
Mødetitel. Vises på Jobnet
- Moedebeskrivelse
(MeetingDescription)
MeetingDescriptionType
Base: string
Length: 0-500
0 - 1
Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet
- AfholdendeSagsbehandler
(InterviewSupervisor)
CaseWorkerStructureType
1
Den mødeafholdende sagsbehandler
- - Fornavne
(CaseWorkerGivenName)
PersonGivenNameType
Base: string
Length: 1-50
1
Sagsbehandlerens fornavn(e).
- - Mellemnavn
(CaseWorkerMiddleName)
PersonMiddleNameType
Base: string
Length: 1-40
0 - 1
Sagsbehandlerens mellemnavn.
- - Efternavn
(CaseWorkerSurname)
PersonSurnameNameType
Base: string
Length: 1-40
1
Sagsbehandlerens efternavn.
- - EksterntId
(CaseWorkerIdentifier)
CaseWorkerIdentifierType
Base: string
Length: 1-255
1
Sagsbehandler-id
- - MoedeLokationStruktur
(InterviewLocationDetail)
InterviewLocationDetailType
0 - 1
Information om hvor mødet skal afholdes
- - - Lokationsuddybning
(InterviewLocationDescription)
InterviewLocationDescriptionType
Base: string
Length: 1-200
0 - 1
Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig.
- - - AdresseStruktur
AddressPostalType
0 - 1
Adresse
- - - Vejnavn
(StreetName)
StreetNameType
Base: string
Length: 1-40
1
Vejnavn.
- - - Husnummer
(StreetBuildingIdentifier)
StreetBuildingIdentifierType
Base: string
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
- - - Etage
(FloorIdentifier)
FloorIdentifierType
Base: string
Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]
0 - 1
- - - SideDoer
(SuiteIdentifier)
SuiteIdentifierType
Base: string
Length: 1-4
0 - 1
- - - Postnummer
(PostCodeIdentifier)
PostCodeIdentifierType
Base: string
Pattern: [0-9]{4}
1
Postnummer
- - - Bynavn
(DistrictName)
DistrictNameType
Base: string
Length: 1-20
1
Bynavn
- - - Landekode
(CountryIdentificationCode)
string
0 - 1
Landekode.
- - MoedeLokationStruktur
(InterviewLocationDetail)
InterviewLocationDetailType
0 - 1
Information om hvor mødet skal afholdes
- - - Lokationsuddybning
(InterviewLocationDescription)
1-40 | 1 | Sagsbehandlerens efternavn. | ||
(CaseWorkerIdentifier) | CaseWorkerIdentifierType | Length: 1-255 | 1 | Sagsbehandler-id |
- Moedetider | BookingTimeslotCollectionType | 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 |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1014 | Failed to validate message | The submitted message could not be validated |
4770 | There are no available booking options | There are no available booking options |
8107 | The BookingIdentifier does not correspond to the person civil registration identifier | The BookingIdentifier does not correspond to the person civil registration identifier |
8111 | An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier | An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier |
GetBookingdetaljer (GetBookingDetails) - Booking flow
Metoden bruges ifm. booking til at få alle bookingdetaljer fra det eksterne bookingsystem, inden den egentlige booking foretages. Herved kan både det eksterne bookingsystem og DFDG validere, inden booking foretages.
[Personnummer i header]
Input
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
GetBookingdetaljerRequest | 1 | |||
- MoedeStarttidspunkt | dateTime | 1 | Starttidspunkt for bookingen | |
- SamtaleformType | InterviewContactTypeIdentifier | 0 - 1 | ||
- SagsbehandlerEksterntId | CaseWorkerIdentifierType | Length: 1-255 | 0 - 1 | Sagsbehandler-id |
- ErStraksbooking | boolean | 1 | Indikerer om der er tale om en straksbooking |
Output
Element
Type
Detaljer
Forekomst
Beskrivelse
GetBookingDetaljerRequest
1
IndkaldelseId
(BookingIdentifier)
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 | ||||||
| date |
| 0 - 1 | Obligatorisk hvis OmbookingMulig er sat til true | ||||||
| boolean |
| 1 | Kan borger aflyse dette møde | ||||||
| date |
| 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-20050 | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. | AddressPostalType | 0 - 1 | Adresse |
| StreetNameType1 | Sagsbehandlerens fornavn(e). |
| PersonMiddleNameType | Length: 1-40 | 0 - 1 | VejnavnSagsbehandlerens mellemnavn. | ||||||
| StreetBuildingIdentifierTypePersonSurnameNameType | 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 | Husnummer|||||||
| 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 |
Fejlkoder
Ingen fejlkoder
CreateBooking (CreateBooking)
Metoden bruges ved selvbooking til at oprette selve mødet i det eksterne bookingsystem.
[Personnummer i header]
Input
GetOmbookingMoedetider (GetRescheduleTimeslots)
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.
...
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: [ |
0 - 1
Unikt id (GUID) for bookingen som medsendes når der er tale om en ombookning
MoedeStarttidspunkt
(BookingStartTime)
dateTime
1
Starttidspunkt for bookingen
MoedetilbudId
(InterviewOptionID)
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} |
GruppemoedeEjersystem
1 | Postnummer | |||
| DistrictNameType | Length: 1-20 | 1 | Bynavn |
| string |
| 0 - 1 |
Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbookingflowet.
SamtaleformType
InterviewContactTypeIdentifier
Landekode. | |||
| InterviewContactDetailType |
| 0 - 1 |
Hvis denne er sat, er det kun det angivne system der må ændre bookingen
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 |
Sagsbehandler-id
ErStraksbooking
Vil være udfyldt med vejlederens telefonnummer, alternativt hovednummer til jobcenter. Skal angives, hvis det er borger, der skal ringe. | ||
| boolean |
|
1
Indikerer om der er tale om en straksbooking
Output
[Empty Response]
Fejlkoder
...
Fejlkode
...
Fejltekst
...
Beskrivelse
...
1014
...
Failed to validate message
...
The submitted message could not be validated
...
4783
...
The BookingTime cannot be before todays date
...
The BookingTime cannot be before todays date
...
4819
...
The BookingStartTime is no longer available
...
The BookingStartTime is no longer available
...
8108
...
The specified InterviewOptionID is not active or is unknown to the system
...
The specified InterviewOptionID is not active or is unknown to the system
...
8109
...
The booking time is NOT within the allowed range of dates for this interview option
...
The booking time is NOT within the allowed range of dates for this interview option
...
8111
...
An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier
...
An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier
...
9003
...
The interview supervisor specified is not allowed for this interview option
...
The interview supervisor specified is not allowed for this interview option
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 |
Fejlkoder
Ingen fejlkoder
CreateMoedetidReservation (Ny metode)
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
[Samme input og output som GetBookingdetaljer]
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.
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 |
SlutMoedetidsinterval
(BookingOptionIntervalEndTime)
dateTime
1
Sluttidspunkt for tidsrummet der ønskes mødetider i
SamtaleformType
bookingen | ||||
|
| 0 - 1 | Hvis denne er sat, er det kun det angivne system der må ændre bookingen | |
| InterviewContactTypeIdentifier |
| 0 - 1 |
Samtaleform hvis denne er valgt på dette punkt i flowet
| ||||
(CaseWorkerIdentifier) | CaseWorkerIdentifierType | Length: 1-255 | 0 - 1 | Sagsbehandler-id |
( |
IsImmediateBooking) |
boolean |
|
0 - 1
Samling af frister
- FristStruktur
(InterviewDeadlineInfo)
InterviewDeadlineInfoType
0 - *
Information om frist for selvbooking
- - SidsteAfholdelsesdato
(InterviewDateLimit)
date
1
Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato
- - FriststatusType
(InterviewDeadlineStatusTypeIdentifier)
1
Status for frist.
- - FristType
(InterviewTypeIdentifier)
1
Angiver hvilken samtaletype der skal bookes
...
1 | Indikerer om der er tale om en straksbooking |
Output
[Empty Response]
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1014 | Failed to validate message | The submitted message could not be validated |
4783 | The BookingTime cannot be before todays date | The BookingTime cannot be before todays date |
4819 | The BookingStartTime is no longer available | The BookingStartTime is no longer available |
8108 | The specified InterviewOptionID is not active or is unknown to the system | The specified InterviewOptionID is not active or is unknown to the system |
8109 | The booking time is NOT within the allowed range of dates for this interview option | The booking time is NOT within the allowed range of dates for this interview option |
8111 | An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier | An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier |
9003 | The interview supervisor specified is not allowed for this interview option | The interview supervisor specified is not allowed for this interview option |
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.
Input
[Personnummer i header]
- - - Fornavne
(CaseWorkerGivenName)
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
GetSelvbookMoedetiderResponse
1
BookbarSagsbehandlerSamling
(SupervisorToBookCollection)
0 - 1
- BookbarSagsbehandler
(SupervisorToBook)
0 - *
- - Id
int
1
- - Sagsbehandler
(Supervisor)
CaseWorkerStructureType
0 - *
Sagsbehandler
GetOmbookingMoedetiderRequest | 1 | |||
| guid |
Length: 1-50
1
Sagsbehandlerens fornavn(e).
- - - Mellemnavn
(CaseWorkerMiddleName)
PersonMiddleNameType
Base: string
Length: 1-40
0 - 1
Sagsbehandlerens mellemnavn.
- - - Efternavn
(CaseWorkerSurname)
PersonSurnameNameType
Base: string
Length: 1-40
1
Sagsbehandlerens efternavn.
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 |
|
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. |
|
1 - *
Samtaleform, dvs. fysisk fremmøde/ telefonisk / videomøde
- - OmbookingMulig
(RebookingPossible)
(InterviewTypeIdentifier) |
| 1 | Angiver hvilken samtaletype der skal bookes |
Output
CreateOmbooking (RescheduleBooking)
Bruges til borgers ombooking af tidligere oprettede møder. Dette kan både være indkaldte og selvbookede møder.
Input
[Personnummer i header]
Element
Type
Detaljer
Forekomst
Beskrivelse
CreateOmbookingRequest
1
IndkaldelseId
(BookingIdentifier)
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}
0 - 1
Unikt id (GUID) for bookingen som medsendes når der er tale om en ombookning
MoedeStarttidspunkt
(BookingStartTime)
dateTime
1
Starttidspunkt for bookingen
- SamtaleformType
0 - 1
Borgers valgte samtaleform
Element | Type | Detaljer | Forekomst | Beskrivelse | |||||
|---|---|---|---|---|---|---|---|---|---|
GetOmbookingMoedetiderResponse |
|
| 1 |
| |||||
|
|
| 1 | Kan der ombookes for dette mødetilbud | |||||
| boolean |
| 1 | Kan der aflyses på dette mødetilbud0 - * |
| ||||
(TotalNoOfSeats) | int |
| 0 - 1 | Det højeste antal deltagere i mødet | |||||
(AvailableNoOfSeatsSupervisor) | intCaseWorkerStructureType |
| 0 - | 1Ledige pladser for mødet* | Sagsbehandler | ||||
(CaseWorkerIDCollectionCaseWorkerGivenName) | PersonGivenNameType | CaseWorkerIDType |
| 1 | Samling af Id’er på sagsbehandlere som kan bookes til denne mødetidBase: string | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). | |
(CaseWorkerIDCaseWorkerMiddleName) | intPersonMiddleNameType | Base: string | Length: 1- | *40 | Sagsbehandler-id |
| 1 | Angiver hvilken samtaletype der skal afholdes |
Fejlkoder
...
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)
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
...
IndkaldelseId
(BookingIdentifier)
...
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
...
Identifier for booking (guid)
Output
...
Element
...
Type
...
Detaljer
...
Forekomst
...
Beskrivelse
...
GetOmbookingSagsbehandlereResponse
...
GetRescheduleSupervisorsResponseType
...
1
...
BorgerKanVaelgeSagsbehandler
(AllowChoiceOfSupervisor)
...
boolean
...
1
...
Angiver hvorvidt borger kan se og vælge en specifik sagsbehandler. For fællesmøder altid false
...
- - SagsbehandlerSamling
(SupervisorCollection)
...
SupervisorCollectionType
...
...
0 - 1
...
Samling af relevante sagsbehandlere
...
- - - Sagsbehandler
(Supervisor)
...
CaseWorkerStructureType
...
...
0 - *
...
Sagsbehandler
...
- - - - Fornavne
(CaseWorkerGivenName)
...
PersonGivenNameType
Base: string
...
Length: 1-50
...
1
...
Sagsbehandlerens fornavn(e).
...
- - - - Mellemnavn
(CaseWorkerMiddleName)
...
PersonMiddleNameType
Base: string
...
Length: 1-40
...
0 - 1
...
Sagsbehandlerens mellemnavn.
...
- - - - Efternavn
(CaseWorkerSurname)
...
PersonSurnameNameType
Base: string
...
Length: 1-40
...
1
...
Sagsbehandlerens efternavn.
...
- - - - EksterntId
(CaseWorkerIdentifier)
...
CaseWorkerIdentifierType
Base: string
...
Length: 1-255
...
1
...
Sagsbehandler-id
Fejlkoder
...
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
...
4783
...
The BookingTime cannot be before todays date
...
The BookingTime cannot be before todays date
...
4770
...
There are no available booking options
...
There are no available booking options
...
8107
...
The BookingIdentifier does not correspond to the person civil registration identifier
...
The BookingIdentifier does not correspond to the person civil registration identifier
0 - 1 | Sagsbehandlerens mellemnavn. | |||
(CaseWorkerSurname) | PersonSurnameNameType | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
(CaseWorkerIdentifier) | CaseWorkerIdentifierType | Length: 1-255 | 1 | Sagsbehandler-id |
(BookingTimeslotCollection) | BookingTimeslotCollectionType |
| 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 |
Fejlkoder
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)
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]
[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 |
| 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 |
...
[EmptyResponse]
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1014 | Failed to validate message | The submitted message could not be validated |
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 |
4770 | There are no available booking options | There are no available booking options |
8107 | The BookingIdentifier does not correspond to the person civil registration identifier | The BookingIdentifier does not correspond |
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.
...
to the person civil registration identifier |
CreateOmbooking (RescheduleBooking)
Bruges til borgers ombooking af tidligere oprettede møder. Dette kan både være indkaldte og selvbookede møder.
Input
[Personnummer i header]
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|
CreateOmbookingRequest | 1 |
|
Element
Type
Detaljer
Forekomst
Beskrivelse
GetStraksbookingMoedetiderResponse
1
BookbarSagsbehandlerSamling
(SupervisorToBookCollection)
0 - 1
- BookbarSagsbehandler
(SupervisorToBook)
0 - *
- - Id
int
1
- - Sagsbehandler
(Supervisor)
CaseWorkerStructureType
0 - *
Sagsbehandler
- - - Fornavne
(CaseWorkerGivenName)
PersonGivenNameType
Base: string
Length: 1-50
1
Sagsbehandlerens fornavn(e).
- - - Mellemnavn
(CaseWorkerMiddleName)
PersonMiddleNameType
Base: string
Length: 1-40
0 - 1
Sagsbehandlerens mellemnavn.
- - - Efternavn
(CaseWorkerSurname)
PersonSurnameNameType
Base: string
Length: 1-40
1
Sagsbehandlerens efternavn.
- - - EksterntId
(CaseWorkerIdentifier)
CaseWorkerIdentifierType
Base: string
Length: 1-255
1
Sagsbehandler-id
MoedetidSamling
(BookingTimeslotCollection)
BookingTimeslotCollectionType
0 - 1
Samling af mødetider der kan bookes
- Moedetid
(BookingTimeslot)
BookingTimeslotType
0 - *
Mødetid med detaljer
- - Starttidspunkt
(StartTime)
dateTime
1
Starttidspunkt for møde
- - OmbookingMulig
(RebookingPossible)
boolean
1
Kan der ombookes for dette mødetilbud
- - AflysningMulig
(CancellationPossible)
boolean
1
Kan der aflyses på dette mødetilbud
- - TotalMoededeltagerAntal
(TotalNoOfSeats)
int
0 - 1
Det højeste antal deltagere i mødet
- - AntalLedigePladser
(AvailableNoOfSeats)
int
0 - 1
Ledige pladser for mødet
- - BookbarSagsbehandlerIdSamling
(CaseWorkerIDCollection)
CaseWorkerIDType
1
Samling af Id’er på sagsbehandlere som kan bookes til denne mødetid
- - - BookbarSagsbehandlerId
(CaseWorkerID)
int
1 - *
Sagsbehandler-id
- - MoedetilbudId
(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 selvbookingflowet.
- - Moedetitel
(MeetingTitle)
MeetingTitleType
Base: string
Length: 1-100
1
Mødetitel. Vises på Jobnet
- - Moedebeskrivelse
(MeetingDescription)
MeetingDescriptionType
Base: string
Length: 0-500
0 - 1
Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet
- - MoedeVarighed
(MeetingDurationMinutes)
int
1
Mødets varighed i minutter
- - SamtaleType
(InterviewTypeIdentifier)
1
Angiver hvilken samtaletype der skal afholdes
- - MoedeGruppeType
(InterviewFormTypeIdentifier)
1
Angiver om det er et fælles eller individuelt møde.
- - SamtaleformSamling
1
En liste med tilgængelige samtaleformer for mødet
- - - SamtaleformType
1 - *
Samtaleform, dvs. fysisk fremmøde/ telefonisk / videomøde
- - MoedeLokationStruktur
(InterviewLocationDetail)
InterviewLocationDetailType
0 - 1
Information om hvor mødet skal afholdes
- - - Lokationsuddybning
(InterviewLocationDescription)
InterviewLocationDescriptionType
Base: string
Length: 1-200
0 - 1
Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig.
- - - AdresseStruktur
AddressPostalType
0 - 1
Adresse
- - - Vejnavn
(StreetName)
|
JobCenterCodeType
Base: string
Pattern: [0-9]{5}
1
Jobcenterkode for det jobcenter borgeren hører til. 5-cifret numerisk format
Kontaktgruppe
(ContactGroupTypeIdentifier)
1
Kontaktgruppe
PersonkategoriStruktur
(PersonCategory)
PersonCategoryType
0 - 1
Klientkategoristruktur
- Personkategori
(PersonCategoryTypeIdentifier)
0 - 1
Klientkategori
- Haendelsestidspunkt
(IncidentDate)
dateTime
1
Angiver den dato og klokkeslet borger blev kategoriseret.
PersongruppemarkeringSamling
(PersonGroupProjectIdentifierCollection)
PersonGroupProjectIdentifierCollectionType
0 - 1
Samling af persongruppemarkeringer for borgeren
- PersongruppemarkeringId
(PersonGroupProjectIdentifier)
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}
0 - *
Id for en persongruppemarkering borger er knyttet til
Moedetidsantal
(TimeslotAmount)
int
1
Antal mødetider
MoedetiderStartdato
(TimeslotStartDate)
date
1
Startdato på timeslottet
MoedetiderSlutdato
(TimeslotEndDate)
date
1
Slutdato på timeslot
SamtaleType
(InterviewTypeIdentifier)
1
Angiver hvilken samtaletype der skal afholdes
Output
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 |
| 1 | Klientkategoristruktur |
(PersonCategoryTypeIdentifier) |
| 0 - 1 | Klientkategori | |
(IncidentDate) | dateTime |
| 1 | Angiver den dato og klokkeslet borger blev kategoriseret. |
(PersonGroupProjectIdentifierCollection) | PersonGroupProjectIdentifierCollectionType | 1 | Samling af persongruppeprojekter borgeren er knyttet til | |
(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 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 |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse | ||
|---|---|---|---|---|---|---|
GetStraksbookingMoedetiderResponse | 1 | |||||
|
|
| 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) |
| 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- | 40100 | 1 | VejnavnMødetitel. Vises på Jobnet | |
( StreetBuildingIdentifierMeetingDescription) | StreetBuildingIdentifierTypeMeetingDescriptionType | PatternLength: | ([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 | Husnummer0-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 | ||
( FloorIdentifierInterviewLocationDescription) | FloorIdentifierTypeInterviewLocationDescriptionType | PatternLength: | [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]1-200 | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. | |
(AddressPostal) | AddressPostalType |
| 0 - 1 | EtagenummerAdresse | ||
| SuiteIdentifierTypeStreetNameType | Length: 1-440 | 0 - 1 | Dør-angivelse, fx thVejnavn. | ||
| PostCodeIdentifierTypeStreetBuildingIdentifierType | Pattern:: ([1-9]|[1-9][0-9]|[1-9][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 afholdes2})|([1-9][A-Z]|[1-9][0-9][A-Z]|[1-9][0-9]{2}[A-Z]) | 1 |
|
| InterviewLocationDescriptionTypeFloorIdentifierType | Length: 1-200Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig.
| ||
| SuiteIdentifierType | AddressPostalType | Base: string | Length: 1-4 | 0 - 1 | Adresse
|
| StreetNameTypePostCodeIdentifierType | LengthPattern: 1-40 [0-9]{4} | 1 | Vejnavn.Postnummer | ||
| StreetBuildingIdentifierTypeDistrictNameType | PatternLength: ([ 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 | Husnummer20 | 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 |
Fejlkoder
Element
Type
Detaljer
Forekomst
Beskrivelse
SaveIndkaldelsesAcceptRequest
AcceptBookingRequestType
1
- IndkaldelseId
(BookingIdentifier)
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
Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
1014 | Failed to validate message | The submitted message could not be validated |
4770 | There are no available booking options | There are no available booking options |
8107 | The BookingIdentifier does not correspond to the person civil registration identifier | The BookingIdentifier does not correspond to the person civil registration identifier |
8111 | An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier | An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier |
SaveIndkaldelsesaccept (AcceptBooking)
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]
civil registration identifier | The BookingIdentifier does not correspond to the person civil registration identifier | |
8111 | An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier | An error occured when trying to look up the supplied PersonCivilRegistrationIdentifier |
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]
[Empty body]
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
EmptyResponse |
...
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 |
8107 | The BookingIdentifier does not correspond to the person civil registration identifier | The BookingIdentifier does not correspond to the person civil registration identifier |
DeleteIndkaldelse (CancelBooking)
identifier |
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 | - 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} | 1Identifier for booking (guid) | ||
- 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.
...