Versions Compared

Key

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

...

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseXFra 120 dage inden medlemskab til 120 dage efter medlemskabX
JobCenterXXXXX
KommuneXX
STARX

Scope

kontaktforloeb.samtale.read

...

ElementTypeDetaljerForekomstBeskrivelse
responseGetIndkaldelseshistorikResponseDto1Gets the history of the call-ups for a given personDTO for en given persons historiske indkaldelser.
-    indkaldelseshistorikkerIndkaldelseshistorikDtoCollection1Liste af historik om indkaldelser.
-    -    IndkaldelseshistorikDtoIndkaldelseshistorikDto0 - *
-    -    -    registreringsmetadataRegistreringsmetadataDto1DTO for registreringsmetadata.
-    -    -    -    erSlettetboolean1Angiver om registreringen er en sletning
-    -    -    -    erAktuelboolean1Det er en række som er aktuel (kan typisk også ses i PSS).
-    -    -    -    registrerendeMyndighedRegistrerendeMyndighedDto0 - 1DTO for registrerende myndighed.
-    -    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    -    organisationskodestringLength: 1-201Identifikation af organisation / myndighed
-    -    -    -    -    registrerendeBrugerRegistrerendeBrugerDto0 - 1DTO for registrerende bruger.
-    -    -    -    -    -    kaldendeBrugerKaldendeBrugerDto1DTO for kaldende bruger.
-    -    -    -    -    -    -    brugerFuldtNavnstringLength: 1-1401Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.
-    -    -    -    -    -    -    brugerTypeRequestUserTypeCodeList1
-    -    -    -    -    -    -    brugerIdstringLength: 1-2551Unik identifikation af brugeren, f.eks. en GUID, et medarbejder ID, system ID, bruger ID, certifikat ID, cpr-nummer, email (hvis den er unik) o.l.
-    -    -    -    -    -    -    brugerEmailemail0 - 1Brugers e-mail.
-    -    -    -    -    -    brugerOrganisationBrugerOrganisationDto1DTO for brugerorganisation.
-    -    -    -    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    -    -    -    organisattionskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Organisationskode for den registrerende bruger.
-    -    -    -    -    -    dfdgRegistreringstidspunktdate-time1Tidspunkt for registrering i DFDG
-    -    -    indkaldelseIndkaldelseDto1Data for en enkelt indkaldelse.
-    -    -    -    aflysningsfristdate0 - 1Sluttidspunkt for borgers aflysningsmulighed.
-    -    -    -    moedeStarttidspunktdate-time1Starttidspunkt for bookingen.
-    -    -    -    moedeSluttidspunktdate-time0 - 1Sluttidspunktet for bookingen.
-    -    -    -    samtaleTypeSamtaleTypeCodeList1
-    -    -    -    moedeGruppeTypeMoedeGruppeTypeCodeList1
-    -    -    -    samtaleformTypeSamtaleformTypeCodeList1
-    -    -    -    personnummerstringMinLength: 11Personnummer
-    -    -    -    gruppemoedeIdentifieruuid0 - 1Skal angives for gruppemøder
-    -    -    -    gruppemoedeEjersystemClientSystemTypeCodeList0 - 1
-    -    -    -    indkaldelseIduuid0 - 1Mulighed for at angive guid på indkaldelsen.
-    -    -    -    indkaldelseOphavIndkaldelseOphavDto1Sagsbehandler
-    -    -    -    -    organisationskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Koden som identificerer organisationen. Det kan være et CVR nummer, en a-kasse kode eller en kommunekode.
-    -    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    ombookingMuligboolean1Kan der ombookes for dette mødetilbud
-    -    -    -    ombookingFristdate-time0 - 1Obligatorisk hvis OmbookingMulig er sat til true
-    -    -    -    aflysningMuligboolean1Kan borger aflyse dette møde
-    -    -    -    selvbooketboolean1Har borger selvbooket denne aftale
-    -    -    -    moedetitelstringLength: 1-1001Mødetitel. Vises på Jobnet
-    -    -    -    moedebeskrivelsestringLength: 0-5000 - 1Beskrivelse til møde med dagsorden og uddybende information.
Vises på Jobnet
-    -    -    -    afholdendeSagsbehandlerSagsbehandlerDto1Sagsbehandler
-    -    -    -    -    fornavnestringLength: 1-501Sagsbehandlerens fornavn(e).
-    -    -    -    -    mellemnavnstringLength: 1-400 - 1Sagsbehandlerens mellemnavn.
-    -    -    -    -    efternavnstringLength: 1-401Sagsbehandlerens efternavn.
-    -    -    -    -    eksterntIdstringLength: 1-2551Sagsbehandler-id
-    -    -    -    moedeLokationMoedeLokationDto0 - 1Information om hvor mødet skal afholdes
-    -    -    -    -    lokationsuddybningstringLength: 1-2000 - 1Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig.
-    -    -    -    -    adresseAdresseDto0 - 1Adresse
-    -    -    -    -    -    vejnavnstringLength: 1-401Vejnavn.
-    -    -    -    -    -    husnummerstringPattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)$
MinLength: 1
1Husnummer
-    -    -    -    -    -    etagestringPattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]0 - 1Etagenummer
-    -    -    -    -    -    sideDoerstringLength: 1-40 - 1Dør-angivelse, fx th.
-    -    -    -    -    -    postnummerstringPattern: [0-9]{4}
MinLength: 1
1Postnummer
-    -    -    -    -    -    bynavnstringLength: 1-201Bynavn
-    -    -    -    -    -    landekodestringPattern: ^[A-Za-z]{2}$0 - 1Landekode
-    -    -    -    kontaktinformationKontaktinformationDto0 - 1Angiver detaljer om mødet når det ikke er med personligt fremmøde.
-    -    -    -    -    digitaltMoedelinkstringLength: 0-20000 - 1Kontaktinformation hvis mødet er digitalt
-    -    -    -    -    telefonnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Vil være udfyldt med vejlederens telefonnummer, alternativt hovednummer til jobcenter. Skal angives, hvis det er borger, der skal ringe.
-    -    -    -    -    borgerRingerOpboolean0 - 1Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde.
-    -    -    -    visSagsbehandlernavnForBorgerboolean1Om navnet på afholdende sagsbehandler må vises for borger
-    -    -    -    myndighedsdeltagereMyndighedsdeltagerDtoCollection1Øvrige deltagere på mødet der ikke er borger eller ansvarlig sagsbehandler
-    -    -    -    -    MyndighedsdeltagerDtoMyndighedsdeltagerDto0 - *
-    -    -    -    -    -    deltagerIduuid0 - 1Id som er unikt for indkaldelsen og deltageren og kan bruges til at opdatere denne separat
-    -    -    -    -    -    navnstringLength: 1-2560 - 1Fuldt navn på deltager
-    -    -    -    -    -    kontaktdetaljerstringLength: 1-2560 - 1Anden kontaktinformation
-    -    -    -    -    -    telefonstringPattern: (\+)?[0-9]{3,20}0 - 1Telefonnummer på deltager
-    -    -    -    -    -    emailemail0 - 1Emailadresse på deltager
-    -    -    -    -    -    eksterntIdstringLength: 1-2560 - 1Eksternt id på deltager
-    -    -    -    -    -    deltagerrolleDeltagerrolleTypeCodeList1
-    -    -    -    -    -    myndighedsrepraesentantenDeltagerboolean0 - 1Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud
-    -    -    -    -    -    afbudsaarsagMoedeafbudsaarsagTypeCodeList0 - 1
-    -    -    -    -    -    afbudsuddybningstring0 - 1Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud
-    -    -    -    dfdgRegistreringstidspunktdate-time0 - 1Tidspunktet for DFDGs seneste opdatering af indkaldelsen
-    -    -    -    indkaldelseAccepteretboolean0 - 1Angiver om borgeren har accepteret mødeindkaldelsen
-    -    -    -    indkaldelseAccepteretTidspunktdate-time0 - 1Angiver hvornår borgeren har accepteret mødeindkaldelsen
-    -    -    moedeaflysningsaarsagTypeAflysningsaarsagTypeCodeList0 - 1
-    -    -    berigtigelseskommentarstringLength: 0-15000 - 1Kommentar til berigtigelse af en registrering

...

ElementTypeDetaljerForekomstBeskrivelse
responseGetIndkaldelseshistorikResponseDto1Gets the history of the call-ups for a given personDTO for en given persons historiske indkaldelser.
-    indkaldelseshistorikkerIndkaldelseshistorikDtoCollection1Liste af historik om indkaldelser.
-    -    IndkaldelseshistorikDtoIndkaldelseshistorikDto0 - *
-    -    -    registreringsmetadataRegistreringsmetadataDto1DTO for registreringsmetadata.
-    -    -    -    erSlettetboolean1Angiver om registreringen er en sletning
-    -    -    -    erAktuelboolean1Det er en række som er aktuel (kan typisk også ses i PSS).
-    -    -    -    registrerendeMyndighedRegistrerendeMyndighedDto0 - 1DTO for registrerende myndighed.
-    -    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    -    organisationskodestringLength: 1-201Identifikation af organisation / myndighed
-    -    -    -    -    registrerendeBrugerRegistrerendeBrugerDto0 - 1DTO for registrerende bruger.
-    -    -    -    -    -    kaldendeBrugerKaldendeBrugerDto1DTO for kaldende bruger.
-    -    -    -    -    -    -    brugerFuldtNavnstringLength: 1-1401Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her.
-    -    -    -    -    -    -    brugerTypeRequestUserTypeCodeList1
-    -    -    -    -    -    -    brugerIdstringLength: 1-2551Unik identifikation af brugeren, f.eks. en GUID, et medarbejder ID, system ID, bruger ID, certifikat ID, cpr-nummer, email (hvis den er unik) o.l.
-    -    -    -    -    -    -    brugerEmailemail0 - 1Brugers e-mail.
-    -    -    -    -    -    brugerOrganisationBrugerOrganisationDto1DTO for brugerorganisation.
-    -    -    -    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    -    -    -    organisattionskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Organisationskode for den registrerende bruger.
-    -    -    -    -    -    dfdgRegistreringstidspunktdate-time1Tidspunkt for registrering i DFDG
-    -    -    indkaldelseIndkaldelseDto1Data for en enkelt indkaldelse.
-    -    -    -    aflysningsfristdate0 - 1Sluttidspunkt for borgers aflysningsmulighed.
-    -    -    -    moedeStarttidspunktdate-time1Starttidspunkt for bookingen.
-    -    -    -    moedeSluttidspunktdate-time0 - 1Sluttidspunktet for bookingen.
-    -    -    -    samtaleTypeSamtaleTypeCodeList1
-    -    -    -    moedeGruppeTypeMoedeGruppeTypeCodeList1
-    -    -    -    samtaleformTypeSamtaleformTypeCodeList1
-    -    -    -    personnummerstringMinLength: 11Personnummer
-    -    -    -    gruppemoedeIdentifieruuid0 - 1Skal angives for gruppemøder
-    -    -    -    gruppemoedeEjersystemClientSystemTypeCodeList0 - 1
-    -    -    -    indkaldelseIduuid0 - 1Mulighed for at angive guid på indkaldelsen.
-    -    -    -    indkaldelseOphavIndkaldelseOphavDto1Sagsbehandler
-    -    -    -    -    organisationskodestringPattern: [-][1]|[0-9]{1,8}
MinLength: 1
1Koden som identificerer organisationen. Det kan være et CVR nummer, en a-kasse kode eller en kommunekode.
-    -    -    -    -    organisationTypeOrganisationTypeCodeList1
-    -    -    -    ombookingMuligboolean1Kan der ombookes for dette mødetilbud
-    -    -    -    ombookingFristdate-time0 - 1Obligatorisk hvis OmbookingMulig er sat til true
-    -    -    -    aflysningMuligboolean1Kan borger aflyse dette møde
-    -    -    -    selvbooketboolean1Har borger selvbooket denne aftale
-    -    -    -    moedetitelstringLength: 1-1001Mødetitel. Vises på Jobnet
-    -    -    -    moedebeskrivelsestringLength: 0-5000 - 1Beskrivelse til møde med dagsorden og uddybende information.
Vises på Jobnet
-    -    -    -    afholdendeSagsbehandlerSagsbehandlerDto1Sagsbehandler
-    -    -    -    -    fornavnestringLength: 1-501Sagsbehandlerens fornavn(e).
-    -    -    -    -    mellemnavnstringLength: 1-400 - 1Sagsbehandlerens mellemnavn.
-    -    -    -    -    efternavnstringLength: 1-401Sagsbehandlerens efternavn.
-    -    -    -    -    eksterntIdstringLength: 1-2551Sagsbehandler-id
-    -    -    -    moedeLokationMoedeLokationDto0 - 1Information om hvor mødet skal afholdes
-    -    -    -    -    lokationsuddybningstringLength: 1-2000 - 1Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig.
-    -    -    -    -    adresseAdresseDto0 - 1Adresse
-    -    -    -    -    -    vejnavnstringLength: 1-401Vejnavn.
-    -    -    -    -    -    husnummerstringPattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)$
MinLength: 1
1Husnummer
-    -    -    -    -    -    etagestringPattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9]0 - 1Etagenummer
-    -    -    -    -    -    sideDoerstringLength: 1-40 - 1Dør-angivelse, fx th.
-    -    -    -    -    -    postnummerstringPattern: [0-9]{4}
MinLength: 1
1Postnummer
-    -    -    -    -    -    bynavnstringLength: 1-201Bynavn
-    -    -    -    -    -    landekodestringPattern: ^[A-Za-z]{2}$0 - 1Landekode
-    -    -    -    kontaktinformationKontaktinformationDto0 - 1Angiver detaljer om mødet når det ikke er med personligt fremmøde.
-    -    -    -    -    digitaltMoedelinkstringLength: 0-20000 - 1Kontaktinformation hvis mødet er digitalt
-    -    -    -    -    telefonnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Vil være udfyldt med vejlederens telefonnummer, alternativt hovednummer til jobcenter. Skal angives, hvis det er borger, der skal ringe.
-    -    -    -    -    borgerRingerOpboolean0 - 1Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde.
-    -    -    -    visSagsbehandlernavnForBorgerboolean1Om navnet på afholdende sagsbehandler må vises for borger
-    -    -    -    myndighedsdeltagereMyndighedsdeltagerDtoCollection1Øvrige deltagere på mødet der ikke er borger eller ansvarlig sagsbehandler
-    -    -    -    -    MyndighedsdeltagerDtoMyndighedsdeltagerDto0 - *
-    -    -    -    -    -    deltagerIduuid0 - 1Id som er unikt for indkaldelsen og deltageren og kan bruges til at opdatere denne separat
-    -    -    -    -    -    navnstringLength: 1-2560 - 1Fuldt navn på deltager
-    -    -    -    -    -    kontaktdetaljerstringLength: 1-2560 - 1Anden kontaktinformation
-    -    -    -    -    -    telefonstringPattern: (\+)?[0-9]{3,20}0 - 1Telefonnummer på deltager
-    -    -    -    -    -    emailemail0 - 1Emailadresse på deltager
-    -    -    -    -    -    eksterntIdstringLength: 1-2560 - 1Eksternt id på deltager
-    -    -    -    -    -    deltagerrolleDeltagerrolleTypeCodeList1
-    -    -    -    -    -    myndighedsrepraesentantenDeltagerboolean0 - 1Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud
-    -    -    -    -    -    afbudsaarsagMoedeafbudsaarsagTypeCodeList0 - 1
-    -    -    -    -    -    afbudsuddybningstring0 - 1Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud
-    -    -    -    dfdgRegistreringstidspunktdate-time0 - 1Tidspunktet for DFDGs seneste opdatering af indkaldelsen
-    -    -    -    indkaldelseAccepteretboolean0 - 1Angiver om borgeren har accepteret mødeindkaldelsen
-    -    -    -    indkaldelseAccepteretTidspunktdate-time0 - 1Angiver hvornår borgeren har accepteret mødeindkaldelsen
-    -    -    moedeaflysningsaarsagTypeAflysningsaarsagTypeCodeList0 - 1
-    -    -    berigtigelseskommentarstringLength: 0-15000 - 1Kommentar til berigtigelse af en registrering

...

ElementTypeDetaljerForekomstBeskrivelse
x-requestId [Header]string1Unikt id for requestet (typisk guid). Hvis api'et modtager samme requestId mere end én gang returneres http status kode 412. Max længde for id'et er 46 chars
requestBodyGetIndkaldelseSoegningRequestDto1DTO for søgning af indkaldelser.
-    gruppemoedeIdentifieruuid0 - 1Det unikke identifikationsnummer for det møde, der søges efter.
-    tidligsteMoedestarttidspunktdate-time0 - 1Det tidligste tidspunkt, hvor mødet kan starte.
-    senesteMoedestarttidspunktdate-time0 - 1Det seneste tidspunkt, hvor mødet kan starte.
-    samtaleformTypeSamtaleformTypeCodeList0 - 1
-    samtaleTypeSamtaleTypeCodeList0 - 1
-    moedeGruppeTypeMoedeGruppeTypeCodeList0 - 1
-    afholdendeSagsbehandlerEksterntIdstring0 - 1Sagsbehandleren der afholder mødet
-    inkluderAflysteIndkaldelserboolean0 - 1Indikerer om aflyste indkaldelser skal inkluderes

...