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 Servicen udstilles af plannersystemer og anvendes af DFDG for at understøtte borgers selvbooking og ombooking på Jobnet.

...

Table of Contents
maxLevel2

Forslag til endpoints/metoder/resourcer/flows:

Resourcer er: Fejlmelding, Moedetilbud, Booking, Sagsbehandler og Straksbookingtilbud.

...

GetBookingdetaljer - Hent bookingdetaljer og reserver timeslot - Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/MoedetilbudBooking/{MoedetilbudIdIndkaldelseId}/{body}

CreateBooking CreateOmbooking - Opret Tilpas en booking i det eksterne booking system - Post Put https://kontaktforloebt12.startest.dk/v1/BorgerBooking/MoedetilbudBooking/{MoedetilbudIdIndkaldelseId}/{body}

Alternativt flow straksbooking

...

GetStraksbookingMoedetider - Hent tider for en straksbooking - Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Straksbookingtilbud/{…}

GetBookingdetaljer - Hent bookingdetaljer og reserver timeslot - Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Moedetilbud/{MoedetilbudId}/{body}

...

Sender en fejlmeding tilbage til bookingsystemet inden der kastes en fejl til jobnet, resource: fejlmelding

CreateFejlmelding- Opret ny fejlmeding - Post https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Fejlmelding

CreateFejlmelding

Post https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Fejlmelding

Metode til tilbagemeldinger om fejl på Jobnet, booking-tilbud som ikke kan validere i DFDG med mere

...

Id

Navn

Beskrivelse

¤

Ulovligt system angivet som ophav

Kun Id 30 - DFDG og Id 32 - Jobnet er lovlige værdier for system som er ophav til fejl

¤

Ukendt borger (¤ genbrug eksisterende kode)

Den angivne borger kendes ikke af plannersystemet

¤

Ukendt MødetilbudId

Det angivne id på et mødetilbud findes ikke i plannersystemet

¤

Ukendt IndkaldelseId

Det angivne id på en indkaldelse findes ikke i plannersystemet

¤

Ukendt fejlkode

Det angivne fejlkodenummer kendes ikke i plannersystemet

¤flere…?

GetSelvbookingMoedetilbud (GetSelfbookInterviewOptions)

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

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

 

...

GetSelvbookingMoedetider (GetSelfbookTimeslots)GetSelfbookTimeslots)

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

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.

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetSelvbookingMoedetiderResponse

1

  • BookbareSagsbehandlere
    (SupervisorToBookCollection)

0 - 1

Samling af sagsbehandlere som kan bookes

  • -    BookbarSagsbehandler
    (SupervisorToBook)

0 - *

  • -    -    Id

int

1

  • -    -    Sagsbehandler

(Supervisor)

CaseWorkerStructureType

 

1

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

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

- - - Samtaleformer

1

En liste med tilgængelige samtaleformer for mødet

- - - - SamtaleformType

InterviewContactTypeIdentifierType

1 - *

Samtaleform, dvs. fysisk fremmøde/ telefonisk / videomøde

-    -    -    OmbookingMulig
(RebookingPossible)

boolean

1

Kan der ombookes for dette mødetilbud

-    -    -    AflysningMulig
(CancellationPossible)

boolean

1

Kan der aflyses på dette mødetilbud

-    -    -    MaksimaltMoededeltagerantal
(TotalNoOfSeats)

int

0 - 1

Det højeste antal deltagere i mødet

-    -    -    AntalLedigePladser
(AvailableNoOfSeats)

int

0 - 1

Ledige pladser for mødet

-    -    -    BookbareSagsbehandlerIder
(CaseWorkerIDCollection)

CaseWorkerIDType

1

Samling af Id’er på sagsbehandlere som kan bookes til denne mødetid

-    -    -    -    BookbarSagsbehandlerId
(CaseWorkerID)

int

1 - *

Sagsbehandler-id

Fejlkoder

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.

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

8107The 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 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

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

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

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
(BookingStartTime)

dateTime

1

Starttidspunkt for bookingen

- SamtaleformType

InterviewContactTypeIdentifier

0 - 1

-    SagsbehandlerEksterntId
(CaseWorkerIdentifier)

CaseWorkerIdentifierType
Base: string

Length: 1-255

0 - 1

Sagsbehandler-id

-    ErStraksbooking
(IsImmediateBooking)

boolean

1

Indikerer om der er tale om en straksbooking

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetBookingdetaljerResponse

1

-    Bookingdetaljer
(BookingDetails)

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

Unikt id for bookingen (guid)

-    -    GruppemoedeId
(GroupBookingIdentifier)

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

Skal angives for fællesmøder

- - GruppemoedeEjersystem

ClientSystemTypeIdentifier

 

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)

InterviewTypeIdentifierType

1

Angiver hvilken samtaletype der skal afholdes

  • -    MoedeGruppeType
    (InterviewFormTypeIdentifier)

InterviewFormTypeIdentifierType

1

Angiver om det er et fælles eller individuelt møde.

-    -    SamtaleformType

InterviewContactTypeIdentifierType

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

  • -    -    MoedeLokation

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

  • -    -    -    Adresse

(AddressPostal)

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


Husnummer

  • -    -    -   - Etage
    (FloorIdentifier)

FloorIdentifierType
Base: string

Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]

0 - 1


Etagenummer

  • -    -    -   - SideDoer
    (SuiteIdentifier)

SuiteIdentifierType
Base: string

Length: 1-4

0 - 1


Dør-angivelse, fx th.

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

  • -    Kontaktinformation
    (InterviewContactDetail)

InterviewContactDetailType

 

0 - 1

Angiver detaljer om mødet når det ikke er med personligt fremmøde.

  • -    -    DigitaltMoedelink
    (DigitalContactIdentifier)

DigitalContactIdentifierType
Base: string

Length: 0-2000

0 - 1

Kontaktinformation hvis mødet er digitalt

  • -    -    Telefonnummer
    (PhoneNumber)

TelephoneNumberIdentifierType
Base: string

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.

  • -    -    BorgerRingerOp
    (ShouldCitizenCall)

boolean

 

0 - 1

Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde.

  • -    VisSagsbehandlernavnForBorger
    (ShowCaseWorker)

boolean

 

1

Om navnet på afholdende sagsbehandler må vises for borger

Fejlkoder

Ingen fejlkoder

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 anden GetBooingdetaljer

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.

...

Element

Type

Detaljer

Forekomst

Beskrivelse

CreateBookingRequest

 

 

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.

  • GruppemoedeEjersystem

ClientSystemTypeIdentifier

 

0 - 1

Hvis denne er sat, er det kun det angivne system der må ændre bookingen

  • SamtaleformType

InterviewContactTypeIdentifier

 

0 - 1

 

  • SagsbehandlerEksterntId

(CaseWorkerIdentifier)

CaseWorkerIdentifierType
Base: string

Length: 1-255

0 - 1

Sagsbehandler-id

  • ErStraksbooking

(IsImmediateBooking)

boolean

 

1

Indikerer om der er tale om en straksbooking

...

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

GetOmbookingMoedetiderResponse

 

 

1

 

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

  • Moedetider

(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

  • - - Samtaleformer

1

En liste med tilgængelige samtaleformer for mødet

  • - - - SamtaleformType

InterviewContactTypeIdentifierType

1 - *

Samtaleform, dvs. fysisk fremmøde/ telefonisk / videomø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

  • -    -    BookbareSagsbehandlerIder

(CaseWorkerIDCollection)

CaseWorkerIDType

 

1

Samling af Id’er på sagsbehandlere som kan bookes til denne mødetid

  • -    -    -    BookbarSagsbehandlerId

(CaseWorkerID)

int

 

1 - *

Sagsbehandler-id

  • SamtaleType
    (InterviewTypeIdentifier)

InterviewTypeIdentifierType

1

Angiver hvilken samtaletype der skal afholdes

Fejlkoder

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)

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]

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)

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

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

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

  • -    -    Sagsbehandlere

(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

...

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

CreateOmbooking (RescheduleBooking)RescheduleBooking)

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

Bruges til borgers ombooking af tidligere oprettede møder. Dette kan både være indkaldte og selvbookede møder.

...

Unikt id (GUID) for bookingen som medsendes når der er tale om en ombookning

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

1

  • MoedeStarttidspunkt
    (BookingStartTime)

dateTime

 

1

Starttidspunkt for bookingen

- SamtaleformType

InterviewContactTypeIdentifierType

0 - 1

Borgers valgte samtaleform

  • SagsbehandlerEksterntId
    (CaseWorkerIdentifier)

CaseWorkerIdentifierType
Base: string

Length: 1-255

0 - 1

Sagsbehandler-id

...

GetStraksbookingMoedetider (GetImmediateBookingTimeslots)

Get https://kontaktforloebt12.startest.dk/v1/BorgerBooking/Straksbookingtilbud/{…}

Metoden bruges ved straksbooking til at hente et antal mødetidspunkter for alle mødetilbud af den specifikke samtaletype.

HasExternalOperatorReferral er taget ud, som tidligere udmeldt.

Input

[Personnummer i header]

...

Element

Type

Detaljer

Forekomst

Beskrivelse

GetStraksbookingMoedetiderResponse

1

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

  • StraksbookingMoedetider

(BookingTimeslotCollection)

 

0 - 1

Samling af mødetider der kan bookes

  • -    StraksbookingMoedetid

(BookingTimeslot)

BookingTimeslotType

 

0 - *

Mødetid med detaljer

  • -    -    Starttidspunkt

(StartTime)

dateTime

 

1

Starttidspunkt for møde

  • - - Samtaleformer

1

En liste med tilgængelige samtaleformer for mødet

  • - - - SamtaleformType

InterviewContactTypeIdentifierType

1 - *

Samtaleform, dvs. fysisk fremmøde/ telefonisk / videomøde

  • -    -    OmbookingMulig

(RebookingPossible)

boolean

 

1

Kan der ombookes for dette mødetilbud

  • -    -    AflysningMulig

(CancellationPossible)

boolean

 

1

Kan der aflyses på dette mødetilbud

  • -    -    MaksimaltMoededeltagerAntal

(TotalNoOfSeats)

int

 

0 - 1

Det højeste antal deltagere i mødet

  • -    -    AntalLedigePladser

(AvailableNoOfSeats)

int

 

0 - 1

Ledige pladser for mødet

  • -    -    BookbareSagsbehandlerIder

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

InterviewTypeIdentifierType

 

1

Angiver hvilken samtaletype der skal afholdes

  • -    -    MoedeGruppeType

(InterviewFormTypeIdentifier)

InterviewFormTypeIdentifierType

 

1

Angiver om det er et fælles eller individuelt møde.

  • -    -    MoedeLokation

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

  • -    -    -    Adresse

(AddressPostal)

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


Husnummer

  • -    -    -   -  Etage
    (FloorIdentifier)

FloorIdentifierType
Base: string

Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]

0 - 1


Etagenummer

  • -    -    -   -  SideDoer
    (SuiteIdentifier)

SuiteIdentifierType
Base: string

Length: 1-4

0 - 1


Dør-angivelse, fx th.

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

  • -    -    BorgerKanVaelgeSagsbehandler

(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

Identifier for booking (guid)

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]

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]

Element

Type

Detaljer

Forekomst

Beskrivelse

SaveIndkaldelsesacceptRequest

AcceptBookingRequestType

1

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

...

registration 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
(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}

1Identifier for booking (guid)

-    Aflysningsaarsag
(CancellationCauseTypeIdentifier)

CancellationCauseTypeIdentifierType

1

Aflysningsårsag

...

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.

...