Servicen udstilles af plannersystemer og anvendes af DFDG for at understøtte borgers selvbooking og ombooking på Jobnet.
Metoder
Table of Contents | ||
---|---|---|
|
Servicen udstilles af plannersystemer og anvendes af DFDG for at understøtte borgers selvbooking og ombooking på Jobnet. Note
Metoder
Table of Contents | ||
---|---|---|
|
Note |
---|
Bemærk at denne side er under udarbejdelse, en stor del af felterne er ikke omdøbte til at følge dansk navngivningsstandard. |
...
Element | Forekomst | Beskrivelse |
---|---|---|
MoedetilbudId | 0 - 1 | Hvis fejlmeldingen er knyttet til et specifikt mødetilbud angives ID |
MoedeId | 0 - 1 | Hvis fejlmeldingen er knyttet til et specifikt møde angives ID |
Fejlkode | 1 | Fejl på Jobnet... Fejl fanget i DFDGs validering på baggrund af GetBookingDetails... |
Fejltekst | 0 - 1 | Beskrivelse af fejlsituationen, herunder manuelt fra borger på Jobnet |
FejlOphav | 1 | Hvilket system fejlen er opstået i (Jobnet/DFDG) ¤?kodeliste? eksisterende systemtypeidentifier? |
FejlTidspunkt | 1 | Tidspunkt for fejlens registrering |
...
Output
(Emptyresponse)
Fejl
Ukendt borger, Ukendt MødetilbudId, ukendt MødeId, Ukendt fejlkode
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
- Jobcenterkode
JobCenterCodeType
Base: string
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
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
6})|0000000000 | 0 - 1 |
Klientkategori
- - Haendelsestidspunkt
dateTime
1
Angiver den dato og klokkeslet borger blev kategoriseret.
- PersongruppemarkeringSamling
PersonGroupProjectIdentifierCollectionType
0 - 1
Samling af persongruppemarkeringer for borgeren
- - Persongruppemarkeringsid
|
Element
Type
Detaljer
Forekomst
Beskrivelse
GetSelvbookingMoedetilbudResponse
GetSelfbookInterviewOptionsResponseType
1
- MoedetilbudSamling (InterviewOptionCollection)
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-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 | - MoedeSamling | - - MoedeStruktur | - FristSamling | InterviewDeadlineCollectionType | 0 - 1 | Samling af frister | - - FristStruktur | 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 afholdes |
Output
-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 klokkeslet borger blev kategoriseret. | |
- PersongruppemarkeringSamling | PersonGroupProjectIdentifierCollectionType | 0 - 1 | Samling af |
persongruppemarkeringer for borgeren |
- - |
InterviewOptionType
0 - *
Mødetilbud
(InterviewOptionIdentifier
- - - SamtaleType (InterviewTypeIdentifier)
PersongruppemarkeringId | 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 |
| Samling af borgerens aktuelle møder | |||
| Data for et enkelt møde | |||
| 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 |
Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbookingflowet.
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
En liste med tilgængelige samtaleformer for mødet
(tidl.
|
| 1 |
Angiver |
om mødet skal være personligt fremmøde, telefonisk |
, digitalt eller andet. | ||||
- FristSamling | InterviewDeadlineCollectionType | 0 - 1 | Samling af frister | |
- - |
FristStruktur |
InterviewDeadlineInfo) |
InterviewDeadlineInfoType | 0 - |
* | Information om |
frist for selvbooking |
- - - |
InterviewLocationDescriptionType
Base: string
Length: 1-200
0 - 1
SidsteAfholdelsesdato | date | 1 | Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato | |
- - - |
FriststatusType |
1 |
Status for frist. |
- - - |
MailDeliverySublocationIdentifierType
Base: string
Length: 1-34
0 - 1
Navn på bygning
- - - - - StreetName
StreetNameType
Base: string
Length: 1-40
1
Vejnavn
- - - - - StreetNameForAddressingName
StreetNameForAddressingNameType
Base: string
Length: 1-20
0 - 1
Forkortet vejnavn. Må ikke overstige 20 tegn
- - - - - StreetBuildingIdentifier
FristType | 1 | Angiver hvilken samtaletype der skal bookes |
Output
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.
Input
Element
Type
Detaljer
Forekomst
Beskrivelse
GetSelfbookTimeslotsRequest
GetSelfbookTimeslotsRequestType
1
- PersonCivilRegistrationIdentifier
Element | Type | Detaljer | Forekomst | Beskrivelse | ||||
---|---|---|---|---|---|---|---|---|
GetSelvbookingMoedetilbudResponse | GetSelfbookInterviewOptionsResponseType | 1 | ||||||
- MoedetilbudSamling (InterviewOptionCollection) | InterviewOptionCollectionType | 0 - 1 | Samling af mødetilbud | |||||
- - Moedetilbud | InterviewOptionType | 0 - * | Mødetilbud | |||||
- - - MoedetilbudId | guid | 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 | ||||
- - - - - FloorIdentifier | FloorIdentifierType | Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 | Etage | ||||
- - - - - SuiteIdentifier | SuiteIdentifierType | Length: 1-4 | 0 - 1 | Dørnummer9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12} | 1 | Identifikation af et online tilbud med GUID. ID skal anvendes ved efterfølgende forespørgsler i selvbookingflowet. | ||
- - - SamtaleType (InterviewTypeIdentifier) | 1 | Angiver hvilken samtaletype der skal afholdes | ||||||
- - - MoedeGruppeType | 1 | Angiver om det er et fælles eller individuelt møde. | ||||||
- - - SamtaleformSamling | 1 | En liste med tilgængelige samtaleformer for mødet | ||||||
- - - - | - DistrictSubdivisionIdentifierDistrictSubdivisionIdentifierType | Length: 1-34SamtaleformType | 1 - * | Angiver samtaleformen, dvs. om mødet skal være personligt fremmøde, telefonisk osv. | ||||
- - - MoedeLokationStruktur | InterviewLocationDetailType | 0 - 1Lokalområde | Information om hvor mødet skal afholdes | |||||
- - - - | - PostOfficeBoxIdentifierPostOfficeBoxIdentifierTypeLokationsuddybning (InterviewLocationDescription) | InterviewLocationDescriptionType | MinInclusiveLength: 1 | 0 - 1Postboks | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. | |||
- - - - | - PostCodeIdentifierPostCodeIdentifierType | Pattern: [0-9]{4} | 1 | PostnummerAdresseStruktur(AddressPostal) | AddressPostalType | 0 - 1 | Adresse | |
| - - DistrictNameDistrictNameType
| StreetNameType | Length: 1- | 2040 | 1 | BynavnVejnavn. | ||
| - - CountryIdentificationCodeCountryIdentificationCodeType
| StreetBuildingIdentifierType | _CountryIdentificationCodeType0 - 1 | Landeidentifikations kode baseret på de 4 forskellige formater. | - - - 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 |
|
| BaseType_CountryIdentificationCodeType
| FloorIdentifierType | Pattern: [ | a-z,A-Z]{2}1-9]|[ | a-z,A-Z]{3}|[0-9]{3}|[0-9]{4}1 | Dette er en støttetype til CountryIdentificationCodeType. Det regulære udtryk er et valg for de 4 forskellige regulære udtryk for de forskellige formater. ISO 3166 standard, alpha 2: [a-z,A-Z]{2}. Eksempel "DK" for Danmark. ISO 3166 standard, alpha 3: [a-z,A-Z]{3}. Eksempel "DKN" for Danmark. UN Statistics Divisions country codes1-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]{ | 3}. Eksempel "208" for Danmark AuthorityCode from the Central Office of Civil Registration: [0-9]{4}. Eksempel "5100" for Danmark4} | 1 | Postnummer | |||
| DistrictNameType | Length: 1-20 | 1 | Bynavn | ||||
| string |
| 0 - 1 | Landekode. | ||||
- - - | MeetingDurationMinutes MoedeVarighed | int | 1 | Mødets varighed i minutter | ||||
- - - | FirstTimeslot FoersteMoedetid | dateTime | 0 - 1 | Første mulige mødedato og tid. | ||||
- - - | LastTimeslot SidsteMoedetid | dateTime | 0 - 1 | Seneste mulige mødetidspunkt, som tilbuddet udstilles til. For individuelle møder kan datoen være "åben" og dermed ikke sat. For fællesmøder vil der altid være angivet en dato/tid. Denne kan være identisk med FirstTimeslot hvis der er tale om et fællesmøde, der kun foregår på en enkelt specifik dag | ||||
- - - | AllowChoiceOfSupervisor BorgerKanVaelgeSagsbehandler | boolean | 1 | Angiver hvorvidt borger kan se og vælge en specifik sagsbehandler. For fællesmøder altid false | ||||
- - - | MeetingTitle Moedetitel | MeetingTitleType | Length: 1-100 | 1 | Mødetitel. Vises på Jobnet | |||
- - - | MeetingDescription Moedebeskrivelse | MeetingDescriptionType | Length: 0-500 | 0 - 1 | Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet | |||
- - - | SupervisorCollection SagsbehandlerSamling | SupervisorCollectionType | 0 - 1 | Samling af relevante sagsbehandlere | ||||
- - - - | Supervisor Sagsbehandler | CaseWorkerStructureType | 0 - * | Sagsbehandler | ||||
- - - - - | CaseWorkerGivenName Fornavne | PersonGivenNameType | Length: 1-50 | 1 | Sagsbehandlerens fornavn. | |||
- - - - - CaseWorkerMiddleName | PersonMiddleNameType | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. | ||||
- - - - - CaseWorkerSurname | PersonSurnameNameType | Length: 1-40 | 1 | Sagsbehandlerens efternavn(e). | ||||
- - - - - | CaseWorkerIdentifierCaseWorkerIdentifierType Mellemnavn | PersonMiddleNameType | Length: 1-25540 | 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
0 - 1 | Sagsbehandlerens mellemnavn. |
- - - - - Efternavn | PersonSurnameNameType |
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
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 | GetSelfbookTimeslotsRequestType | 1 | ||
- 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 selvbooking flowet. |
- BookingOptionIntervalStartTime | dateTime | 1 | Starttidspunkt for tidsrummet der ønskes mødetider i | |
- BookingOptionIntervalEndTime | dateTime | 1 | Sluttidspunkt for tidsrummet der ønskes mødetider i | |
- SamtaleformType | 0 - 1 | Samtaleform hvis denne er valgt på dette punkt i flowet | ||
- CaseWorkerIdentifier | CaseWorkerIdentifierType | Length: 1-255 | 0 - 1 | Sagsbehandler-id hvis dette er valgt på dette punkt i flowet |
- InterviewDeadlineCollection | InterviewDeadlineCollectionType | 0 - 1 | Samling af frister | |
- - InterviewDeadlineInfo | InterviewDeadlineInfoType | 0 - * | Information om frist for selvbooking | |
- - - InterviewDateLimit | date | 1 | Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato | |
- - - InterviewDeadlineStatusTypeIdentifier | 1 | Status for frist. | ||
- - - InterviewTypeIdentifier | 1 | Angiver hvilken samtaletype der skal 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
Element | Type | Detaljer | Forekomst | Beskrivelse |
---|---|---|---|---|
GetImmediateBookingTimeslotsRequest | GetImmediateBookingTimeslotsRequestType | 1 | ||
| 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 |
| JobCenterCodeType | Pattern: [0-9]{5} | 1 | Jobcenterkode for det jobcenter borgeren hører til. 5-cifret numerisk format |
| 1 | Kontaktgruppe | ||
| PersonCategoryType | 0 - 1 | Klientkategori | |
| 0 - 1 | Klientkategori | ||
| dateTime | 1 | Angiver den dato og klokkeslet borger blev kategoriseret. | |
| PersonGroupProjectIdentifierCollectionType | 0 - 1 | Samling af persongruppemarkeringer for borgeren | |
| 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 timeslots | |
| date | 1 | Startdato på timeslottet | |
| date | 1 | Slutdato på timeslot | |
| 1 | Angiver hvilken samtaletype der skal afholdes |
...
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.
...