Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Servicen udstilles af plannersystemer og anvendes af DFDG for at understøtte borgers selvbooking og ombooking på Jobnet.

...

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

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 klokkeslæt borger blev kategoriseret.

-    Persongruppemarkeringer
(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

  • Indkaldelser

0 - 1

Samling af borgerens aktuelle indkaldelser

  • - Indkaldelse

0 - *

Informationsstruktur 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)

InterviewTypeIdentifierType

 

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.

-    Frister
(InterviewDeadlineCollection)

InterviewDeadlineCollectionType

0 - 1

Samling af frister

-    -    Frist
(InterviewDeadlineInfo)

InterviewDeadlineInfoType

0 - *

Information om frist for selvbooking

-    -    -    SidsteAfholdelsesdato
(InterviewDateLimit)

DateTime

date 

1

Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato. Datoen er afgørende, der ses bort fra timer og minutter.

-    -    -    FriststatusType
(InterviewDeadlineStatusTypeIdentifier)

InterviewDeadlineStatusTypeIdentifierType

1

Status for frist.

-    -    -    FristType
(InterviewTypeIdentifier)

InterviewTypeIdentifierType

1

Angiver hvilken samtaletype der skal bookes

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetSelvbookingMoedetiderRequest

1

  • 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

InterviewContactTypeIdentifierType

0 - 1

Samtaleform hvis denne er valgt på dette punkt i flowet

  • EksterntId
    (CaseWorkerIdentifier)

CaseWorkerIdentifierType
Base: string

Length: 1-255

0 - 1

Sagsbehandler-id hvis dette er valgt på dette punkt i flowet

  • Frister

(InterviewDeadlineCollection)

InterviewDeadlineCollectionType

 

0 - 1

Samling af frister

  • -    Frist

(InterviewDeadlineInfo)

InterviewDeadlineInfoType

 

0 - *

Information om frist for selvbooking

  • -    -    SidsteAfholdelsesdato

(InterviewDateLimit)

dateDateTime

 

1

Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato. Datoen er afgørende, der ses bort fra timer og minutter.

  • -    -    FriststatusType

(InterviewDeadlineStatusTypeIdentifier)

InterviewDeadlineStatusTypeIdentifierType

 

1

Status for frist.

  • -    -    FristType

(InterviewTypeIdentifier)

InterviewTypeIdentifierType

 

1

Angiver hvilken samtaletype der skal bookes

...

Metode til at reservere en mødetid til en borger

[Personnummer i header]

Put https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/action/reserver

[Empty body]

Response

[EmptyResponse]

...

GetBookingdetaljer (GetBookingDetails) - Ombooking flow

Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/{body}

Metoden bruges ifm. ombooking til at få alle bookingdetaljer fra det eksterne bookingsystem

...

CreateBooking (CreateBooking) - Booking flow

Post https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Moedetilbud/{MoedetilbudId}/{body}

Metoden bruges ved selvbooking til at oprette selve mødet i det eksterne bookingsystem.

...

GetOmbookingMoedetider (GetRescheduleTimeslots)

Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/{body}

Metoden anvendes af Jobnet, der kalder det eksterne bookingsystem via DFDG. Formålet er at udstille mulige tider til ombookning af et eksisterende planlagt møde, der enten kan være selvbooket eller indkaldt.

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetOmbookingMoedetiderRequest

1

  • 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 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

InterviewContactTypeIdentifierType

0 - 1

Samtaleform hvis denne er valgt på dette punkt i flowet

  • EksterntId
    (CaseWorkerIdentifier)

CaseWorkerIdentifierType
Base: string

Length: 1-255

0 - 1

Sagsbehandler-id hvis dette er valgt på dette punkt i flowet

  • Frister

(InterviewDeadlineCollection)

InterviewDeadlineCollectionType

 

0 - 1

Samling af frister

  • -    Frist

(InterviewDeadlineInfo)

InterviewDeadlineInfoType

 

0 - *

Information om frist for selvbooking

  • -    -    SidsteAfholdelsesdato

(InterviewDateLimit)

dateDateTime

 

1

Sidste afholdelsesdato. Fristindfriende samtale må ikke lægges senere end denne dato. Datoen er afgørende, der ses bort fra timer og minutter.

  • -    -    FriststatusType

(InterviewDeadlineStatusTypeIdentifier)

InterviewDeadlineStatusTypeIdentifierType

 

1

Status for frist.

  • -    -    FristType

(InterviewTypeIdentifier)

InterviewTypeIdentifierType

 

1

Angiver hvilken samtaletype der skal bookes

...

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]

...

SaveIndkaldelsesaccept (AcceptBooking)

Put https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}/Accept

Bruges når borgeren via Jobnet accepterer en indkaldelse. Kaldet medfører en markering i det eksterne bookingsystem, der tydeliggør, at borgeren har set indkaldelsen.

...

DeleteIndkaldelse (CancelBooking)

Delete https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Booking/{IndkaldelseId}

Metoden bruges til at aflyse et møde i det eksterne bookingsystem.

...

Fejlkode

Fejltekst

Beskrivelse

1014

Failed to validate message

The submitted message could not be validated

4650

It is not allowed to delete this registration because the startdate lies in the past

It is not allowed to delete this registration because the startdate lies in the past

4768

The submitted BookingIdentifier is unknown to the system

The submitted BookingIdentifier is unknown to the system

4820

Cancellation is not allowed

Cancellation is not allowed, or cancellation deadline is exceeded

8107

The BookingIdentifier does not correspond to the person civil registration identifier

The BookingIdentifier does not correspond to the person civil registration identifier

9130

The Booking can not be rescheduled or cancelled by the citizen because it is an immediate booking

The Booking can not be rescheduled or cancelled by the citizen because it is an immediate booking

SaveBookingList (udfases)

Denne metode skal kaldes, når KSS kalder SaveBookingList i BookingService. På den måde vil det være muligt at overføre indkaldelisterne online til det eksterne bookingsystem.

...