Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Siden opdateres automatisk til at afspejle koden.

Metoder

SaveDeltagelsesvalg (POST /v2/Indkaldelse/deltagelsesvalg)

Saves the participation choice for a given person.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseX
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
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
requestBodySaveDeltagelsesvalgRequestDto1DTO for gem deltagelsesvalg
-    deltagelsesvalgTypeDeltagelsesvalgTypeCodeList1
-    deltagerIMoedeboolean1TRUE ved deltagelse

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
90108Deltagelsesvalg må kun sættes for DagpengemodtagereDeltagelsesvalg må kun sættes for Dagpengemodtagere

GetDeltagelsesvalg (GET /v2/Indkaldelse/deltagelsesvalg)

Gets the participation choice for a given person.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseX
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetDeltagelsesvalgResponseDto1DTO for svar på forespørgsel om deltagelsesvalg
-    deltagelsesvalgDeltagelsesvalgDtoCollection1Samling af information om valg om deltagelse i fælles jobsamtale for dagpengemodtager (0-2 elementer)
-    -    DeltagelsesvalgDtoDeltagelsesvalgDto0 - *
-    -    -    deltagelsesvalgIdentifieruuid1Id på deltagelsesvalget
-    -    -    deltagelsesvalgTypeDeltagelsesvalgTypeCodeList1
-    -    -    deltagerIMoedeboolean1TRUE ved deltagelse
-    -    -    deltagelseOpdateringstidspunktdate-time1Tidspunkt for opdatering af deltagelsesvalget

Fejlkoder

FejlkodeFejltekstBeskrivelse
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død

GetSpecificDeltagelsesvalg (GET /v2/Indkaldelse/specifiktdeltagelsesvalg/{deltagelsesvalgId})

Gets a specific participation choice for a given person.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseX
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.read

Input

ElementTypeDetaljerForekomstBeskrivelse
deltagelsesvalgId [Path]uuid1
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetSpecifiktDeltagelsesvalgResponseDto1DTO for svar på forespørgsel om deltagelsesvalg
-    deltagelsesvalgDeltagelsesvalgMedErAktueltDtoCollection1Samling af information om valg om deltagelse i fælles jobsamtale for dagpengemodtager (0-2 elementer)
-    -    DeltagelsesvalgMedErAktueltDtoDeltagelsesvalgMedErAktueltDto0 - *
-    -    -    deltagelsesvalgIdentifieruuid1Id på deltagelsesvalget
-    -    -    deltagelsesvalgTypeDeltagelsesvalgTypeCodeList1
-    -    -    deltagerIMoedeboolean1TRUE ved deltagelse
-    -    -    deltagelseOpdateringstidspunktdate-time1Tidspunkt for opdatering af deltagelsesvalget
-    -    -    valgetErAktueltboolean1Indikerer om deltagelsesvalget som hentes per specifikt Id er den aktuelle status

Fejlkoder

FejlkodeFejltekstBeskrivelse
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død

GetDeltagelsesvalgshistorik (GET /v2/Indkaldelse/deltagelsesvalg/historik)

Gets the participation history for a given person.

Tilladte organisationer

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
JobCenterXXXX
KommuneXX
STARX

Scope

kontaktforloeb.samtale.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetDeltagelsesvalgshistorikResponseDto1DTO for svar på forespørgsel om historik for valg om deltagelse i møder.
-    deltagelsesvalgshistorikkerDeltagelsesvalgshistorikDtoCollection1Liste af historiske valg om deltagelse i møder.
-    -    DeltagelsesvalgshistorikDtoDeltagelsesvalgshistorikDto0 - *
-    -    -    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
-    -    -    deltagelsesvalgIdentifieruuid1Id på deltagelsesvalget
-    -    -    deltagelsesvalgTypeDeltagelsesvalgTypeCodeList1
-    -    -    deltagerIMoedeboolean1Angiver om man vil deltage. True hvis man deltager.
-    -    -    deltagelsesvalgMyndighedTypeOrganisationTypeCodeList1
-    -    -    deltagelsesvalgMyndighedKodestringMinLength: 11Id for organisationen

Fejlkoder

FejlkodeFejltekstBeskrivelse
1Person does not exist for given cpr number.Person does not exist for given cpr number.

CreateIndkaldelse (POST /v2/Indkaldelse)

Creates an indkaldelse for a specific person.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseX
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
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
requestBodyCreateIndkaldelseRequestDto1DTO for oprettelse af indkaldelse
-    aflysningsfristdate0 - 1Sluttidspunkt for borgers aflysningsmulighed.
-    moedeStarttidspunktdate-time1Starttidspunkt for bookingen.
-    moedeSluttidspunktdate-time0 - 1Sluttidspunktet for bookingen.
-    samtaleTypeSamtaleTypeCodeList1
-    moedeGruppeTypeMoedeGruppeTypeCodeList1
-    samtaleformTypeSamtaleformTypeCodeList1
-    gruppemoedeIduuid0 - 1Skal angives for fællesmøder.
-    ombookingMuligboolean1Kan der ombookes for dette mødetilbud.
-    ombookingFristdate0 - 1Obligatorisk hvis OmbookingMulig er sat til true.
-    aflysningMuligboolean1Kan borger aflyse dette møde.
-    moedetitelstringLength: 1-1001Mødetitel. Vises på Jobnet.
-    moedebeskrivelsestringLength: 1-5000 - 1Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet.
-    visSagsbehandlernavnForBorgerboolean1Om navnet på afholdende sagsbehandler må vises for borger.
-    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.
-    selvbooketboolean0 - 1Har borger selvbooket denne aftale
-    moedevarighedint320 - 1Mødets varighed i minutter
-    myndighedsdeltagereMyndighedsdeltagerDtoCollection0 - 1Ø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
-    gruppemoedeEjersystemClientSystemTypeCodeList0 - 1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
4783MoedeStarttidspunkt kan ikke være tidligere end dags datoMoedeStarttidspunkt kan ikke være tidligere end dags dato
4784Det angivne IndkaldelseId findes allerede i systemetDet angivne IndkaldelseId findes allerede i systemet
4792MoedeSluttidspunkt kan ikke være tidligere end moedestarttidspunktetMoedeSluttidspunkt kan ikke være tidligere end moedestarttidspunktet
4856Borgeren er ikke medlem af en a-kasseBorgeren er ikke medlem af en a-kasse
4857Borgeren er medlem af en anden a-kasseBorgeren er medlem af en anden a-kasse
8058SamtaleTypen er ikke lovlig jf.borgers kontaktgruppeSamtaleTypen er ikke lovlig jf.borgers kontaktgruppe
8125OmbookingFrist kan ikke sættes når ombook ikke er muligtOmbookingFrist kan ikke sættes når ombook ikke er muligt
8126OmbookingFrist er påkrævet når ombook er muligtOmbookingFrist er påkrævet når ombook er muligt
8132OmbookingFrist må ikke være før dags datoOmbookingFrist må ikke være før dags dato
8134OmbookingFrist kan ikke være efter mødestartOmbookingFrist kan ikke være efter mødestart
8270OmbookingMulig må ikke være true for samtaletype Id 18OmbookingMulig må ikke være true for samtaletype Id 18
8127Aflysningsfrist kan ikke sættes når aflysning ikke er muligAflysningsfrist kan ikke sættes når aflysning ikke er mulig
8128Aflysningsfrist skal sættes når aflysning er muligAflysningsfrist skal sættes når aflysning er mulig
8133Aflysningsfrist må ikke være før dags datoAflysningsfrist må ikke være før dags dato
8136Aflysningsfrist kan ikke være efter mødestartAflysningsfrist kan ikke være efter mødestart
8129Der skal angives en adresse for møder med personligt fremmødeDer skal angives en adresse for møder med personligt fremmøde
8130Sluttidspunkt eller varighed er påkrævet for møder med den angivne samtaletypeSluttidspunkt eller varighed er påkrævet for møder med den angivne samtaletype
8131Telefonnummer er påkrævet når borger skal ringe opTelefonnummer er påkrævet når borger skal ringe op
8135Mødet må ikke strække sig over flere dageMødet må ikke strække sig over flere dage
8209Den angivne samtaletype er ikke gyldig til et a-kasse mødeDen angivne samtaletype er ikke gyldig til et a-kasse møde
8273Borger har allerede en kommende jobsamtale, og må ikke have flere fremtidige indkaldelser af denne typeBorger har allerede en kommende jobsamtale, og må ikke have flere fremtidige indkaldelser af denne type
8288Indkaldelsen er senere end en eksisterende frist til selvbooking med samme samtaletypeIndkaldelsen er senere end en eksisterende frist til selvbooking med samme samtaletype
9121Samtale med rehab team er ikke lovlig for denne kontaktgruppeSamtale med rehab team er ikke lovlig for denne kontaktgruppe
9220Borger har allerede en kommende opfølgningssamtale, og må ikke have flere fremtidige indkaldelser af denne typeBorger har allerede en kommende opfølgningssamtale, og må ikke have flere fremtidige indkaldelser af denne type
9379Borgeren er i a-kasse-forsøg(har fravær 75) og må ikke bookes til møder i jobcentretBorgeren er i a-kasse-forsøg(har fravær 75) og må ikke bookes til møder i jobcentret
9390Borger skal straksbooke og kan kun selvbooke på JobnetBorger skal straksbooke og kan kun selvbooke på Jobnet
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
90105Det angivne DeltagerId findes allerede i systemetDet angivne DeltagerId findes allerede i systemet
90109Mødets starttidspunkt kan ikke være senere end dagen for lukning af kontaktgruppeMødets starttidspunkt kan ikke være senere end dagen for lukning af kontaktgruppe

GetIndkaldelser (GET /v2/Indkaldelse)

Gets the indkaldelser for a specific person.

Tilladte organisationer

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
JobCenterXXXX
KommuneXX
STARX

Scope

kontaktforloeb.samtale.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetIndkaldelseResponseDto1DTO for response til at hente indkaldelser.
-    indkaldelserIndkaldelseDtoCollection1The available indkaldelser.
-    -    IndkaldelseDtoIndkaldelseDto0 - *
-    -    -    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
-    deltagelsesvalgDeltagelsesvalgDtoCollection1The selected deltagelsesvalg for the indkaldelser.
-    -    DeltagelsesvalgDtoDeltagelsesvalgDto0 - *
-    -    -    deltagelsesvalgIdentifieruuid1Id på deltagelsesvalget
-    -    -    deltagelsesvalgTypeDeltagelsesvalgTypeCodeList1
-    -    -    deltagerIMoedeboolean1TRUE ved deltagelse
-    -    -    deltagelseOpdateringstidspunktdate-time1Tidspunkt for opdatering af deltagelsesvalget

Fejlkoder

FejlkodeFejltekstBeskrivelse
4768Det angivne IndkaldelseId er ikke kendt i systemetDet angivne IndkaldelseId er ikke kendt i systemet

CreateIndkaldelse (POST /v2/Indkaldelse/{indkaldelseId})

Creates an indkaldelse for a specific person with the specific indkaldelse id.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseX
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.write

Input

ElementTypeDetaljerForekomstBeskrivelse
indkaldelseId [Path]uuid1
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
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
requestBodyCreateIndkaldelseRequestDto1DTO for oprettelse af indkaldelse
-    aflysningsfristdate0 - 1Sluttidspunkt for borgers aflysningsmulighed.
-    moedeStarttidspunktdate-time1Starttidspunkt for bookingen.
-    moedeSluttidspunktdate-time0 - 1Sluttidspunktet for bookingen.
-    samtaleTypeSamtaleTypeCodeList1
-    moedeGruppeTypeMoedeGruppeTypeCodeList1
-    samtaleformTypeSamtaleformTypeCodeList1
-    gruppemoedeIduuid0 - 1Skal angives for fællesmøder.
-    ombookingMuligboolean1Kan der ombookes for dette mødetilbud.
-    ombookingFristdate0 - 1Obligatorisk hvis OmbookingMulig er sat til true.
-    aflysningMuligboolean1Kan borger aflyse dette møde.
-    moedetitelstringLength: 1-1001Mødetitel. Vises på Jobnet.
-    moedebeskrivelsestringLength: 1-5000 - 1Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet.
-    visSagsbehandlernavnForBorgerboolean1Om navnet på afholdende sagsbehandler må vises for borger.
-    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.
-    selvbooketboolean0 - 1Har borger selvbooket denne aftale
-    moedevarighedint320 - 1Mødets varighed i minutter
-    myndighedsdeltagereMyndighedsdeltagerDtoCollection0 - 1Ø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
-    gruppemoedeEjersystemClientSystemTypeCodeList0 - 1

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
4783MoedeStarttidspunkt kan ikke være tidligere end dags datoMoedeStarttidspunkt kan ikke være tidligere end dags dato
4784Det angivne IndkaldelseId findes allerede i systemetDet angivne IndkaldelseId findes allerede i systemet
4792MoedeSluttidspunkt kan ikke være tidligere end moedestarttidspunktetMoedeSluttidspunkt kan ikke være tidligere end moedestarttidspunktet
4856Borgeren er ikke medlem af en a-kasseBorgeren er ikke medlem af en a-kasse
4857Borgeren er medlem af en anden a-kasseBorgeren er medlem af en anden a-kasse
8058SamtaleTypen er ikke lovlig jf.borgers kontaktgruppeSamtaleTypen er ikke lovlig jf.borgers kontaktgruppe
8125OmbookingFrist kan ikke sættes når ombook ikke er muligtOmbookingFrist kan ikke sættes når ombook ikke er muligt
8126OmbookingFrist er påkrævet når ombook er muligtOmbookingFrist er påkrævet når ombook er muligt
8132OmbookingFrist må ikke være før dags datoOmbookingFrist må ikke være før dags dato
8134OmbookingFrist kan ikke være efter mødestartOmbookingFrist kan ikke være efter mødestart
8270OmbookingMulig må ikke være true for samtaletype Id 18OmbookingMulig må ikke være true for samtaletype Id 18
8127Aflysningsfrist kan ikke sættes når aflysning ikke er muligAflysningsfrist kan ikke sættes når aflysning ikke er mulig
8128Aflysningsfrist skal sættes når aflysning er muligAflysningsfrist skal sættes når aflysning er mulig
8133Aflysningsfrist må ikke være før dags datoAflysningsfrist må ikke være før dags dato
8136Aflysningsfrist kan ikke være efter mødestartAflysningsfrist kan ikke være efter mødestart
8129Der skal angives en adresse for møder med personligt fremmødeDer skal angives en adresse for møder med personligt fremmøde
8130Sluttidspunkt eller varighed er påkrævet for møder med den angivne samtaletypeSluttidspunkt eller varighed er påkrævet for møder med den angivne samtaletype
8131Telefonnummer er påkrævet når borger skal ringe opTelefonnummer er påkrævet når borger skal ringe op
8135Mødet må ikke strække sig over flere dageMødet må ikke strække sig over flere dage
8209Den angivne samtaletype er ikke gyldig til et a-kasse mødeDen angivne samtaletype er ikke gyldig til et a-kasse møde
8273Borger har allerede en kommende jobsamtale, og må ikke have flere fremtidige indkaldelser af denne typeBorger har allerede en kommende jobsamtale, og må ikke have flere fremtidige indkaldelser af denne type
8288Indkaldelsen er senere end en eksisterende frist til selvbooking med samme samtaletypeIndkaldelsen er senere end en eksisterende frist til selvbooking med samme samtaletype
9121Samtale med rehab team er ikke lovlig for denne kontaktgruppeSamtale med rehab team er ikke lovlig for denne kontaktgruppe
9220Borger har allerede en kommende opfølgningssamtale, og må ikke have flere fremtidige indkaldelser af denne typeBorger har allerede en kommende opfølgningssamtale, og må ikke have flere fremtidige indkaldelser af denne type
9379Borgeren er i a-kasse-forsøg(har fravær 75) og må ikke bookes til møder i jobcentretBorgeren er i a-kasse-forsøg(har fravær 75) og må ikke bookes til møder i jobcentret
9390Borger skal straksbooke og kan kun selvbooke på JobnetBorger skal straksbooke og kan kun selvbooke på Jobnet
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
90105Det angivne DeltagerId findes allerede i systemetDet angivne DeltagerId findes allerede i systemet
90109Mødets starttidspunkt kan ikke være senere end dagen for lukning af kontaktgruppeMødets starttidspunkt kan ikke være senere end dagen for lukning af kontaktgruppe

UpdateIndkaldelse (PUT /v2/Indkaldelse/{indkaldelseId})

Updates an indkaldelse for a specific person.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseX
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.write

Input

ElementTypeDetaljerForekomstBeskrivelse
indkaldelseId [Path]uuid1
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
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
requestBodyUpdateIndkaldelseRequestDto1DTO for opdatering af indkaldelse.
-    aflysningsfristdate0 - 1Sluttidspunkt for borgers aflysningsmulighed.
-    moedeStarttidspunktdate-time1Starttidspunkt for bookingen.
-    moedeSluttidspunktdate-time0 - 1Sluttidspunktet for bookingen.
-    samtaleTypeSamtaleTypeCodeList1
-    moedeGruppeTypeMoedeGruppeTypeCodeList1
-    samtaleformTypeSamtaleformTypeCodeList1
-    gruppemoedeIduuid0 - 1Skal angives for fællesmøder.
-    ombookingMuligboolean1Kan der ombookes for dette mødetilbud.
-    ombookingFristdate0 - 1Obligatorisk hvis OmbookingMulig er sat til true.
-    aflysningMuligboolean1Kan borger aflyse dette møde.
-    moedetitelstringLength: 1-1001Mødetitel. Vises på Jobnet.
-    moedebeskrivelsestringLength: 1-5000 - 1Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet.
-    visSagsbehandlernavnForBorgerboolean1Om navnet på afholdende sagsbehandler må vises for borger.
-    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.
-    selvbooketboolean0 - 1Har borger selvbooket denne aftale
-    moedevarighedint320 - 1Mødets varighed i minutter
-    myndighedsdeltagereMyndighedsdeltagerDtoCollection0 - 1Ø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

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4768Det angivne IndkaldelseId er ikke kendt i systemetDet angivne IndkaldelseId er ikke kendt i systemet
4783MoedeStarttidspunkt kan ikke være tidligere end dags datoMoedeStarttidspunkt kan ikke være tidligere end dags dato
4792MoedeSluttidspunkt kan ikke være tidligere end moedestarttidspunktetMoedeSluttidspunkt kan ikke være tidligere end moedestarttidspunktet
4856Borgeren er ikke medlem af en a-kasseBorgeren er ikke medlem af en a-kasse
4857Borgeren er medlem af en anden a-kasseBorgeren er medlem af en anden a-kasse
8125OmbookingFrist kan ikke sættes når ombook ikke er muligtOmbookingFrist kan ikke sættes når ombook ikke er muligt
8126OmbookingFrist er påkrævet når ombook er muligtOmbookingFrist er påkrævet når ombook er muligt
8132OmbookingFrist må ikke være før dags datoOmbookingFrist må ikke være før dags dato
8134OmbookingFrist kan ikke være efter mødestartOmbookingFrist kan ikke være efter mødestart
8270OmbookingMulig må ikke være true for samtaletype Id 18OmbookingMulig må ikke være true for samtaletype Id 18
8127Aflysningsfrist kan ikke sættes når aflysning ikke er muligAflysningsfrist kan ikke sættes når aflysning ikke er mulig
8128Aflysningsfrist skal sættes når aflysning er muligAflysningsfrist skal sættes når aflysning er mulig
8133Aflysningsfrist må ikke være før dags datoAflysningsfrist må ikke være før dags dato
8136Aflysningsfrist kan ikke være efter mødestartAflysningsfrist kan ikke være efter mødestart
8129Der skal angives en adresse for møder med personligt fremmødeDer skal angives en adresse for møder med personligt fremmøde
8130Sluttidspunkt eller varighed er påkrævet for møder med den angivne samtaletypeSluttidspunkt eller varighed er påkrævet for møder med den angivne samtaletype
8131Telefonnummer er påkrævet når borger skal ringe opTelefonnummer er påkrævet når borger skal ringe op
8135Mødet må ikke strække sig over flere dageMødet må ikke strække sig over flere dage
8209Den angivne samtaletype er ikke gyldig til et a-kasse mødeDen angivne samtaletype er ikke gyldig til et a-kasse møde
9121Samtale med rehab team er ikke lovlig for denne kontaktgruppeSamtale med rehab team er ikke lovlig for denne kontaktgruppe
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
8210Det er kun opretter af en indkaldelse som kan opdatere og slette denDet er kun opretter af en indkaldelse som kan opdatere og slette den
90101Opdater eksisterende myndighedsdeltagere inden oprettelse af nyeOpdater eksisterende myndighedsdeltagere inden oprettelse af nye
90103Det angivne DeltagerId hører til en anden indkaldelse end den angivneDet angivne DeltagerId hører til en anden indkaldelse end den angivne
90105Det angivne DeltagerId findes allerede i systemetDet angivne DeltagerId findes allerede i systemet
90109Mødets starttidspunkt kan ikke være senere end dagen for lukning af kontaktgruppeMødets starttidspunkt kan ikke være senere end dagen for lukning af kontaktgruppe

DeleteIndkaldelse (DELETE /v2/Indkaldelse/{indkaldelseId})

Deletes an indkaldelse for a specific person.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseX
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.write

Input

ElementTypeDetaljerForekomstBeskrivelse
indkaldelseId [Path]uuid1
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
aflysningsaarsagType [Query]AflysningsaarsagTypeCodeList1
berigtigelseskommentar [Query]stringMaxLength: 15000 - 1
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

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4768Det angivne IndkaldelseId er ikke kendt i systemetDet angivne IndkaldelseId er ikke kendt i systemet
8256Fristen skal være mindst en dag efter fristaktiveringsdatoenFristen skal være mindst en dag efter fristaktiveringsdatoen

GetIndkaldelse (GET /v2/Indkaldelse/{indkaldelseId})

Gets a specific indkaldelse for a specific person.

Tilladte organisationer

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
JobCenterXXXX
KommuneXX
STARX

Scope

kontaktforloeb.samtale.read

Input

ElementTypeDetaljerForekomstBeskrivelse
indkaldelseId [Path]uuid1
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetIndkaldelseResponseDto1DTO for response til at hente indkaldelser.
-    indkaldelserIndkaldelseDtoCollection1The available indkaldelser.
-    -    IndkaldelseDtoIndkaldelseDto0 - *
-    -    -    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
-    deltagelsesvalgDeltagelsesvalgDtoCollection1The selected deltagelsesvalg for the indkaldelser.
-    -    DeltagelsesvalgDtoDeltagelsesvalgDto0 - *
-    -    -    deltagelsesvalgIdentifieruuid1Id på deltagelsesvalget
-    -    -    deltagelsesvalgTypeDeltagelsesvalgTypeCodeList1
-    -    -    deltagerIMoedeboolean1TRUE ved deltagelse
-    -    -    deltagelseOpdateringstidspunktdate-time1Tidspunkt for opdatering af deltagelsesvalget

Fejlkoder

FejlkodeFejltekstBeskrivelse
4768Det angivne IndkaldelseId er ikke kendt i systemetDet angivne IndkaldelseId er ikke kendt i systemet

GetIndkaldelseshistorik (GET /v2/Indkaldelse/historik/{indkaldelseId})

Gets the history of a specific indkaldelse.

Tilladte organisationer

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
JobCenterXXXX
KommuneXX
STARX

Scope

kontaktforloeb.samtale.read

Input

ElementTypeDetaljerForekomstBeskrivelse
indkaldelseId [Path]uuid1
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetIndkaldelseshistorikResponseDto1Gets the history of the call-ups for a given person.
-    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

Fejlkoder

FejlkodeFejltekstBeskrivelse
90102Det angivne IndkaldelseId findes ikkeDet angivne IndkaldelseId findes ikke
1Person does not exist for given cpr number.Person does not exist for given cpr number.

GetIndkaldelseshistorik (GET /v2/Indkaldelse/historik)

Gets the history of indkaldelser for a specific person.

Tilladte organisationer

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
JobCenterXXXX
KommuneXX
STARX

Scope

kontaktforloeb.samtale.read

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetIndkaldelseshistorikResponseDto1Gets the history of the call-ups for a given person.
-    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

Fejlkoder

FejlkodeFejltekstBeskrivelse
90102Det angivne IndkaldelseId findes ikkeDet angivne IndkaldelseId findes ikke
1Person does not exist for given cpr number.Person does not exist for given cpr number.

CreateMyndighedsdeltager (POST /v2/Indkaldelse/myndighedsdeltager/{myndighedsdeltagerid})

Creates a myndighedsdeltager for a specific indkaldelse.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseX
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
myndighedsdeltagerid [Path]uuid1
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
requestBodyCreateMyndighedsdeltagerRequestDto1DTO for oprettelse af myndighedsdeltager.
-    indkaldelseIduuid1Id på den indkaldelse som myndighedsdeltageren skal deltage i
-    navnstringLength: 1-2560 - 1Fuldt navn på deltager
-    kontaktdetaljerstringLength: 1-2560 - 1Anden kontaktinformation
-    telefonnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Telefonnummer på deltager
-    emailemail0 - 1Emailadresse på deltager
-    eksterntIdstringLength: 1-2560 - 1Eksternt id på deltager
-    deltagerrolleDeltagerrolleTypeCodeList1
-    afbudsaarsagMoedeafbudsaarsagTypeCodeList0 - 1
-    afbudsuddybningstringLength: 1-10000 - 1Uddybning af den gæstende myndigheds afbud
-    myndighedsrepraesentantenDeltagerboolean0 - 1Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud

Output

ElementTypeDetaljerForekomstBeskrivelse
responseuuid1

Fejlkoder

FejlkodeFejltekstBeskrivelse
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
90101Opdater eksisterende myndighedsdeltagere inden oprettelse af nyeOpdater eksisterende myndighedsdeltagere inden oprettelse af nye
90102Det angivne IndkaldelseId findes ikkeDet angivne IndkaldelseId findes ikke
90105Det angivne DeltagerId findes allerede i systemetDet angivne DeltagerId findes allerede i systemet

UpdateMyndighedsdeltager (PUT /v2/Indkaldelse/myndighedsdeltager/{myndighedsdeltagerid})

Updates a myndighedsdeltager for a specific indkaldelse.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseX
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
myndighedsdeltagerid [Path]uuid1
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
requestBodyUpdateMyndighedsdeltagerRequestDto1DTO for opdatering af myndighedsdeltager.
-    indkaldelseIduuid1Id på den indkaldelse som myndighedsdeltageren skal deltage i
-    navnstringLength: 1-2560 - 1Fuldt navn på deltager
-    kontaktdetaljerstringLength: 1-2560 - 1Anden kontaktinformation
-    telefonnummerstringPattern: (\+)?[0-9]{3,20}0 - 1Telefonnummer på deltager
-    emailemail0 - 1Emailadresse på deltager
-    eksterntIdstringLength: 1-2560 - 1Eksternt id på deltager
-    deltagerrolleDeltagerrolleTypeCodeList1
-    afbudsaarsagMoedeafbudsaarsagTypeCodeList0 - 1
-    afbudsuddybningstringLength: 1-10000 - 1Uddybning af den gæstende myndigheds afbud
-    myndighedsrepraesentantenDeltagerboolean1Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
90102Det angivne IndkaldelseId findes ikkeDet angivne IndkaldelseId findes ikke
90103Det angivne DeltagerId hører til en anden indkaldelse end den angivneDet angivne DeltagerId hører til en anden indkaldelse end den angivne
90107Det angivne DeltagerId findes ikkeDet angivne DeltagerId findes ikke

DeleteMyndighedsdeltager (DELETE /v2/Indkaldelse/myndighedsdeltager/{myndighedsdeltagerid}/indkaldelse/{indkaldelseid})

Deletes a myndighedsdeltager for a specific indkaldelse.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
A-kasseX
JobCenterXX
KommuneX
STARX

Scope

kontaktforloeb.samtale.write

Input

ElementTypeDetaljerForekomstBeskrivelse
x-civilregistrationIdentifier [Header]stringPattern: ((((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})|00000000001Beskrivelse af cpr
myndighedsdeltagerid [Path]uuid1
indkaldelseid [Path]uuid1
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

Output

Intet output

Fejlkoder

FejlkodeFejltekstBeskrivelse
4405Borgeren med det specificerede CPR nummer er dødBorgeren med det specificerede CPR nummer er død
90102Det angivne IndkaldelseId findes ikkeDet angivne IndkaldelseId findes ikke
90103Det angivne DeltagerId hører til en anden indkaldelse end den angivneDet angivne DeltagerId hører til en anden indkaldelse end den angivne
90107Det angivne DeltagerId findes ikkeDet angivne DeltagerId findes ikke

GetSoegning (POST /v2/Indkaldelse/action/indkaldelseSoegning)

Gets a list of indkaldelser based on the search parameters.

Tilladte organisationer

Alle borgereEgne borgereTidligere egne borgereGæsteadgangAnden Aktør - egne borgereAnden Aktør - gæsteadgangAnden Aktør - alle borgereSystem - alle borgere
JobCenterXX
STARX

Scope

kontaktforloeb.samtale.soegning.write

Input

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

Output

ElementTypeDetaljerForekomstBeskrivelse
responseGetIndkaldelseSoegningResponseDto1DTO for svar på indkaldelsessoegning.
-    indkaldelserIndkaldelseSoegningDtoCollection1Indkaldelser fundet.
-    -    IndkaldelseSoegningDtoIndkaldelseSoegningDto0 - *
-    -    -    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
-    -    -    aflysningsinformationAflysningsinformationDto0 - 1DTO for aflysningsinformation
-    -    -    -    moedeaflysningaarsagTypeAflysningsaarsagTypeCodeList1
-    -    -    -    berigtigelseskommentarstring0 - 1Kommentar til berigtigelse af en registrering
-    -    -    -    aflysningstidspunktdate-time1Tidspunktet for registreringen af aflysningen

Fejlkoder

FejlkodeFejltekstBeskrivelse
4764Det er ikke muligt at søge uden søgeparametreDet er ikke muligt at søge uden søgeparametre
6010Søgningen resulterede i for mange resultater. Lav en snævrere søgning med skærpede søgeparametreSøgningen resulterede i for mange resultater. Lav en snævrere søgning med skærpede søgeparametre
  • No labels