Siden opdateres automatisk til at afspejle koden.
Metoder
SaveDeltagelsesvalg (POST /v1/Indkaldelse/deltagelsesvalg)
Saves the participation choice for a given person.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | | | | | | |
JobCenter | | X | | | X | | | |
Kommune | | X | | | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.write
Element | Type | Detaljer | Forekomst | Beskrivelse |
x-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 | 1 | Beskrivelse af cpr |
x-requestId [Header] | string | | 1 | Unikt 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 |
requestBody | SaveDeltagelsesvalgRequestDto | | 1 | DTO for gem deltagelsesvalg |
- deltagelsesvalgType | DeltagelsesvalgTypeCodeList | | 1 | |
- deltagerIMoede | boolean | | 1 | TRUE ved deltagelse |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
90108 | Deltagelsesvalg må kun sættes for Dagpengemodtagere | Deltagelsesvalg må kun sættes for Dagpengemodtagere |
GetDeltagelsesvalg (GET /v1/Indkaldelse/deltagelsesvalg)
Gets the participation choice for a given person.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | | | | | | |
JobCenter | | X | | | X | | | |
Kommune | | X | | | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.read
Element | Type | Detaljer | Forekomst | Beskrivelse |
x-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 | 1 | Beskrivelse af cpr |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
response | GetDeltagelsesvalgResponseDto | | 1 | DTO for svar på forespørgsel om deltagelsesvalg |
- deltagelsesvalg | DeltagelsesvalgDtoCollection | | 1 | Samling af information om valg om deltagelse i fælles jobsamtale for dagpengemodtager (0-2 elementer) |
- - DeltagelsesvalgDto | DeltagelsesvalgDto | | 0 - * | |
- - - deltagelsesvalgType | DeltagelsesvalgTypeCodeList | | 1 | |
- - - deltagerIMoede | boolean | | 1 | TRUE ved deltagelse |
- - - deltagelseOpdateringstidspunkt | date-time | | 1 | Tidspunkt for opdatering af deltagelsesvalget |
- - - indkaldelseAccepteret | boolean | | 1 | Om gæstende sagsbehandler har accepteret indkaldelsen |
- - - indkaldelseAccepteretTidspunkt | date-time | | 0 - 1 | Tidspunktet for gæstende sagsbehandlers accept af indkaldelsen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
GetDeltagelsesvalgshistorik (GET /v1/Indkaldelse/deltagelsesvalg/historik)
Gets the participation history for a given person.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X | | | | |
JobCenter | | X | | X | X | X | | |
Kommune | | X | | X | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.read
Element | Type | Detaljer | Forekomst | Beskrivelse |
x-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 | 1 | Beskrivelse af cpr |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
response | GetDeltagelsesvalgshistorikResponseDto | | 1 | DTO for svar på forespørgsel om historik for valg om deltagelse i møder. |
- deltagelsesvalgshistorikker | DeltagelsesvalgshistorikDtoCollection | | 1 | Liste af historiske valg om deltagelse i møder. |
- - DeltagelsesvalgshistorikDto | DeltagelsesvalgshistorikDto | | 0 - * | |
- - - registreringsmetadata | RegistreringsmetadataDto | | 1 | DTO for registreringsmetadata. |
- - - - erSlettet | boolean | | 1 | Angiver om registreringen er en sletning |
- - - - erAktuel | boolean | | 1 | Det er en række som er aktuel (kan typisk også ses i PSS). |
- - - - registrerendeMyndighed | RegistrerendeMyndighedDto | | 0 - 1 | DTO for registrerende myndighed. |
- - - - - organisationType | OrganisationTypeCodeList | | 1 | |
- - - - - organisationskode | string | Length: 1-20 | 1 | Identifikation af organisation / myndighed |
- - - - - registrerendeBruger | RegistrerendeBrugerDto | | 0 - 1 | DTO for registrerende bruger. |
- - - - - - kaldendeBruger | KaldendeBrugerDto | | 1 | DTO for kaldende bruger. |
- - - - - - - brugerFuldtNavn | string | Length: 1-140 | 1 | Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her. |
- - - - - - - brugerType | RequestUserTypeCodeList | | 1 | |
- - - - - - - brugerId | string | Length: 1-255 | 1 | Unik 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. |
- - - - - - - brugerEmail | email | | 0 - 1 | Brugers e-mail. |
- - - - - - brugerOrganisation | BrugerOrganisationDto | | 1 | DTO for brugerorganisation. |
- - - - - - - organisationType | OrganisationTypeCodeList | | 1 | |
- - - - - - - organisattionskode | string | Pattern: [-][1]|[0-9]{1,8} MinLength: 1 | 1 | Organisationskode for den registrerende bruger. |
- - - - - - dfdgRegistreringstidspunkt | date-time | | 1 | Tidspunkt for registrering i DFDG |
- - - deltagelsesvalgType | DeltagelsesvalgTypeCodeList | | 1 | |
- - - deltagerIMoede | boolean | | 1 | Angiver om man vil deltage. True hvis man deltager. |
- - - deltagelsesvalgMyndighedType | OrganisationTypeCodeList | | 1 | |
- - - deltagelsesvalgMyndighedKode | string | MinLength: 1 | 1 | Id for organisationen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
1 | Person does not exist for given cpr number. | Person does not exist for given cpr number. |
CreateIndkaldelse (POST /v1/Indkaldelse)
Creates an indkaldelse for a specific person.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | | | | | | |
JobCenter | | X | | | X | | | |
Kommune | | X | | | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.write
Element | Type | Detaljer | Forekomst | Beskrivelse |
x-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 | 1 | Beskrivelse af cpr |
x-requestId [Header] | string | | 1 | Unikt 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 |
requestBody | CreateIndkaldelseRequestDto | | 1 | DTO for oprettelse af indkaldelse |
- aflysningsfrist | date | | 0 - 1 | Sluttidspunkt for borgers aflysningsmulighed. |
- moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
- moedeSluttidspunkt | date-time | | 0 - 1 | Sluttidspunktet for bookingen. |
- samtaleType | SamtaleTypeCodeList | | 1 | |
- moedeGruppeType | MoedeGruppeTypeCodeList | | 1 | |
- samtaleformType | SamtaleformTypeCodeList | | 1 | |
- gruppemoedeId | uuid | | 0 - 1 | Skal angives for fællesmøder. |
- ombookingMulig | boolean | | 1 | Kan der ombookes for dette mødetilbud. |
- ombookingFrist | date | | 0 - 1 | Obligatorisk hvis OmbookingMulig er sat til true. |
- aflysningMulig | boolean | | 1 | Kan borger aflyse dette møde. |
- moedetitel | string | Length: 1-100 | 1 | Mødetitel. Vises på Jobnet. |
- moedebeskrivelse | string | Length: 1-500 | 0 - 1 | Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet. |
- visSagsbehandlernavnForBorger | boolean | | 1 | Om navnet på afholdende sagsbehandler må vises for borger. |
- afholdendeSagsbehandler | SagsbehandlerDto | | 1 | Sagsbehandler |
- - fornavne | string | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
- - mellemnavn | string | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
- - efternavn | string | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
- - eksterntId | string | Length: 1-255 | 1 | Sagsbehandler-id |
- moedeLokation | MoedeLokationDto | | 0 - 1 | Information om hvor mødet skal afholdes |
- - lokationsuddybning | string | Length: 1-200 | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. |
- - adresse | AdresseDto | | 0 - 1 | Adresse |
- - - vejnavn | string | Length: 1-40 | 1 | Vejnavn. |
- - - husnummer | string | Pattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)$ MinLength: 1 | 1 | Husnummer |
- - - etage | string | Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 | Etagenummer |
- - - sideDoer | string | Length: 1-4 | 0 - 1 | Dør-angivelse, fx th. |
- - - postnummer | string | Pattern: [0-9]{4} MinLength: 1 | 1 | Postnummer |
- - - bynavn | string | Length: 1-20 | 1 | Bynavn |
- - - landekode | string | Pattern: ^[A-Za-z]{2}$ | 0 - 1 | Landekode |
- kontaktinformation | KontaktinformationDto | | 0 - 1 | Angiver detaljer om mødet når det ikke er med personligt fremmøde. |
- - digitaltMoedelink | string | Length: 0-2000 | 0 - 1 | Kontaktinformation hvis mødet er digitalt |
- - telefonnummer | 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 | boolean | | 0 - 1 | Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde. |
- selvbooket | boolean | | 0 - 1 | Har borger selvbooket denne aftale |
- moedevarighed | int32 | | 0 - 1 | Mødets varighed i minutter |
- myndighedsdeltagere | MyndighedsdeltagerDtoCollection | | 0 - 1 | Øvrige deltagere på mødet der ikke er borger eller ansvarlig sagsbehandler |
- - MyndighedsdeltagerDto | MyndighedsdeltagerDto | | 0 - * | |
- - - deltagerId | uuid | | 0 - 1 | Id som er unikt for indkaldelsen og deltageren og kan bruges til at opdatere denne separat |
- - - navn | string | Length: 1-256 | 0 - 1 | Fuldt navn på deltager |
- - - kontaktdetaljer | string | Length: 1-256 | 0 - 1 | Anden kontaktinformation |
- - - telefon | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Telefonnummer på deltager |
- - - email | email | | 0 - 1 | Emailadresse på deltager |
- - - eksterntId | string | Length: 1-256 | 0 - 1 | Eksternt id på deltager |
- - - deltagerrolle | DeltagerrolleTypeCodeList | | 1 | |
- - - myndighedsrepraesentantenDeltager | boolean | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- - - afbudsaarsag | MoedeafbudsaarsagTypeCodeList | | 0 - 1 | |
- - - afbudsuddybning | string | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- gruppemoedeEjersystem | ClientSystemTypeCodeList | | 0 - 1 | |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
response | uuid | | 1 | |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
4783 | MoedeStarttidspunkt kan ikke være tidligere end dags dato | MoedeStarttidspunkt kan ikke være tidligere end dags dato |
4784 | Det angivne IndkaldelseId findes allerede i systemet | Det angivne IndkaldelseId findes allerede i systemet |
4792 | MoedeSluttidspunkt kan ikke være tidligere end moedestarttidspunktet | MoedeSluttidspunkt kan ikke være tidligere end moedestarttidspunktet |
4856 | Borgeren er ikke medlem af en a-kasse | Borgeren er ikke medlem af en a-kasse |
4857 | Borgeren er medlem af en anden a-kasse | Borgeren er medlem af en anden a-kasse |
8058 | SamtaleTypen er ikke lovlig jf.borgers kontaktgruppe | SamtaleTypen er ikke lovlig jf.borgers kontaktgruppe |
8125 | OmbookingFrist kan ikke sættes når ombook ikke er muligt | OmbookingFrist kan ikke sættes når ombook ikke er muligt |
8126 | OmbookingFrist er påkrævet når ombook er muligt | OmbookingFrist er påkrævet når ombook er muligt |
8132 | OmbookingFrist må ikke være før dags dato | OmbookingFrist må ikke være før dags dato |
8134 | OmbookingFrist kan ikke være efter mødestart | OmbookingFrist kan ikke være efter mødestart |
8270 | OmbookingMulig må ikke være true for samtaletype Id 18 | OmbookingMulig må ikke være true for samtaletype Id 18 |
8127 | Aflysningsfrist kan ikke sættes når aflysning ikke er mulig | Aflysningsfrist kan ikke sættes når aflysning ikke er mulig |
8128 | Aflysningsfrist skal sættes når aflysning er mulig | Aflysningsfrist skal sættes når aflysning er mulig |
8133 | Aflysningsfrist må ikke være før dags dato | Aflysningsfrist må ikke være før dags dato |
8136 | Aflysningsfrist kan ikke være efter mødestart | Aflysningsfrist kan ikke være efter mødestart |
8129 | Der skal angives en adresse for møder med personligt fremmøde | Der skal angives en adresse for møder med personligt fremmøde |
8130 | Sluttidspunkt eller varighed er påkrævet for møder med den angivne samtaletype | Sluttidspunkt eller varighed er påkrævet for møder med den angivne samtaletype |
8131 | Telefonnummer er påkrævet når borger skal ringe op | Telefonnummer er påkrævet når borger skal ringe op |
8135 | Mødet må ikke strække sig over flere dage | Mødet må ikke strække sig over flere dage |
8209 | Den angivne samtaletype er ikke gyldig til et a-kasse møde | Den angivne samtaletype er ikke gyldig til et a-kasse møde |
8273 | Borger har allerede en kommende jobsamtale, og må ikke have flere fremtidige indkaldelser af denne type | Borger har allerede en kommende jobsamtale, og må ikke have flere fremtidige indkaldelser af denne type |
8288 | Indkaldelsen er senere end en eksisterende frist til selvbooking med samme samtaletype | Indkaldelsen er senere end en eksisterende frist til selvbooking med samme samtaletype |
9121 | Samtale med rehab team er ikke lovlig for denne kontaktgruppe | Samtale med rehab team er ikke lovlig for denne kontaktgruppe |
9220 | Borger har allerede en kommende opfølgningssamtale, og må ikke have flere fremtidige indkaldelser af denne type | Borger har allerede en kommende opfølgningssamtale, og må ikke have flere fremtidige indkaldelser af denne type |
9379 | Borgeren er i a-kasse-forsøg(har fravær 75) og må ikke bookes til møder i jobcentret | Borgeren er i a-kasse-forsøg(har fravær 75) og må ikke bookes til møder i jobcentret |
9390 | Borger skal straksbooke og kan kun selvbooke på Jobnet | Borger skal straksbooke og kan kun selvbooke på Jobnet |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
90105 | Det angivne DeltagerId findes allerede i systemet | Det angivne DeltagerId findes allerede i systemet |
90109 | Mødets starttidspunkt kan ikke være senere end dagen for lukning af kontaktgruppe | Mødets starttidspunkt kan ikke være senere end dagen for lukning af kontaktgruppe |
GetIndkaldelser (GET /v1/Indkaldelse)
Gets the indkaldelser for a specific person.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X | | | | |
JobCenter | | X | | X | X | X | | |
Kommune | | X | | X | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.read
Element | Type | Detaljer | Forekomst | Beskrivelse |
x-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 | 1 | Beskrivelse af cpr |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
response | GetIndkaldelseResponseDto | | 1 | DTO for response til at hente indkaldelser. |
- indkaldelser | IndkaldelseDtoCollection | | 1 | The available indkaldelser. |
- - IndkaldelseDto | IndkaldelseDto | | 0 - * | |
- - - aflysningsfrist | date | | 0 - 1 | Sluttidspunkt for borgers aflysningsmulighed. |
- - - moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
- - - moedeSluttidspunkt | date-time | | 0 - 1 | Sluttidspunktet for bookingen. |
- - - samtaleType | SamtaleTypeCodeList | | 1 | |
- - - moedeGruppeType | MoedeGruppeTypeCodeList | | 1 | |
- - - samtaleformType | SamtaleformTypeCodeList | | 1 | |
- - - personnummer | string | MinLength: 1 | 1 | Personnummer |
- - - gruppemoedeIdentifier | uuid | | 0 - 1 | Skal angives for gruppemøder |
- - - gruppemoedeEjersystem | ClientSystemTypeCodeList | | 0 - 1 | |
- - - indkaldelseId | uuid | | 0 - 1 | Mulighed for at angive guid på indkaldelsen. |
- - - indkaldelseOphav | IndkaldelseOphavDto | | 1 | Sagsbehandler |
- - - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} MinLength: 1 | 1 | Koden som identificerer organisationen. Det kan være et CVR nummer, en a-kasse kode eller en kommunekode. |
- - - - organisationType | OrganisationTypeCodeList | | 1 | |
- - - ombookingMulig | boolean | | 1 | Kan der ombookes for dette mødetilbud |
- - - ombookingFrist | date-time | | 0 - 1 | Obligatorisk hvis OmbookingMulig er sat til true |
- - - aflysningMulig | boolean | | 1 | Kan borger aflyse dette møde |
- - - selvbooket | boolean | | 1 | Har borger selvbooket denne aftale |
- - - moedetitel | string | Length: 1-100 | 1 | Mødetitel. Vises på Jobnet |
- - - moedebeskrivelse | string | Length: 0-500 | 0 - 1 | Beskrivelse til møde med dagsorden og uddybende information.
Vises på Jobnet |
- - - afholdendeSagsbehandler | SagsbehandlerDto | | 1 | Sagsbehandler |
- - - - fornavne | string | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
- - - - mellemnavn | string | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
- - - - efternavn | string | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
- - - - eksterntId | string | Length: 1-255 | 1 | Sagsbehandler-id |
- - - moedeLokation | MoedeLokationDto | | 0 - 1 | Information om hvor mødet skal afholdes |
- - - - lokationsuddybning | string | Length: 1-200 | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. |
- - - - adresse | AdresseDto | | 0 - 1 | Adresse |
- - - - - vejnavn | string | Length: 1-40 | 1 | Vejnavn. |
- - - - - husnummer | string | Pattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)$ MinLength: 1 | 1 | Husnummer |
- - - - - etage | string | Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 | Etagenummer |
- - - - - sideDoer | string | Length: 1-4 | 0 - 1 | Dør-angivelse, fx th. |
- - - - - postnummer | string | Pattern: [0-9]{4} MinLength: 1 | 1 | Postnummer |
- - - - - bynavn | string | Length: 1-20 | 1 | Bynavn |
- - - - - landekode | string | Pattern: ^[A-Za-z]{2}$ | 0 - 1 | Landekode |
- - - kontaktinformation | KontaktinformationDto | | 0 - 1 | Angiver detaljer om mødet når det ikke er med personligt fremmøde. |
- - - - digitaltMoedelink | string | Length: 0-2000 | 0 - 1 | Kontaktinformation hvis mødet er digitalt |
- - - - telefonnummer | 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 | boolean | | 0 - 1 | Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde. |
- - - visSagsbehandlernavnForBorger | boolean | | 1 | Om navnet på afholdende sagsbehandler må vises for borger |
- - - myndighedsdeltagere | MyndighedsdeltagerDtoCollection | | 1 | Øvrige deltagere på mødet der ikke er borger eller ansvarlig sagsbehandler |
- - - - MyndighedsdeltagerDto | MyndighedsdeltagerDto | | 0 - * | |
- - - - - deltagerId | uuid | | 0 - 1 | Id som er unikt for indkaldelsen og deltageren og kan bruges til at opdatere denne separat |
- - - - - navn | string | Length: 1-256 | 0 - 1 | Fuldt navn på deltager |
- - - - - kontaktdetaljer | string | Length: 1-256 | 0 - 1 | Anden kontaktinformation |
- - - - - telefon | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Telefonnummer på deltager |
- - - - - email | email | | 0 - 1 | Emailadresse på deltager |
- - - - - eksterntId | string | Length: 1-256 | 0 - 1 | Eksternt id på deltager |
- - - - - deltagerrolle | DeltagerrolleTypeCodeList | | 1 | |
- - - - - myndighedsrepraesentantenDeltager | boolean | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- - - - - afbudsaarsag | MoedeafbudsaarsagTypeCodeList | | 0 - 1 | |
- - - - - afbudsuddybning | string | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- - - dfdgRegistreringstidspunkt | date-time | | 0 - 1 | Tidspunktet for DFDGs seneste opdatering af indkaldelsen |
- - - indkaldelseAccepteret | boolean | | 0 - 1 | Angiver om borgeren har accepteret mødeindkaldelsen |
- - - indkaldelseAccepteretTidspunkt | date-time | | 0 - 1 | Angiver hvornår borgeren har accepteret mødeindkaldelsen |
- deltagelsesvalg | DeltagelsesvalgDtoCollection | | 1 | The selected deltagelsesvalg for the indkaldelser. |
- - DeltagelsesvalgDto | DeltagelsesvalgDto | | 0 - * | |
- - - deltagelsesvalgType | DeltagelsesvalgTypeCodeList | | 1 | |
- - - deltagerIMoede | boolean | | 1 | TRUE ved deltagelse |
- - - deltagelseOpdateringstidspunkt | date-time | | 1 | Tidspunkt for opdatering af deltagelsesvalget |
- - - indkaldelseAccepteret | boolean | | 1 | Om gæstende sagsbehandler har accepteret indkaldelsen |
- - - indkaldelseAccepteretTidspunkt | date-time | | 0 - 1 | Tidspunktet for gæstende sagsbehandlers accept af indkaldelsen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
4768 | Det angivne IndkaldelseId er ikke kendt i systemet | Det angivne IndkaldelseId er ikke kendt i systemet |
CreateIndkaldelse (POST /v1/Indkaldelse/{indkaldelseId})
Creates an indkaldelse for a specific person with the specific indkaldelse id.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | | | | | | |
JobCenter | | X | | | X | | | |
Kommune | | X | | | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.write
Element | Type | Detaljer | Forekomst | Beskrivelse |
indkaldelseId [Path] | uuid | | 1 | |
x-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 | 1 | Beskrivelse af cpr |
x-requestId [Header] | string | | 1 | Unikt 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 |
requestBody | CreateIndkaldelseRequestDto | | 1 | DTO for oprettelse af indkaldelse |
- aflysningsfrist | date | | 0 - 1 | Sluttidspunkt for borgers aflysningsmulighed. |
- moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
- moedeSluttidspunkt | date-time | | 0 - 1 | Sluttidspunktet for bookingen. |
- samtaleType | SamtaleTypeCodeList | | 1 | |
- moedeGruppeType | MoedeGruppeTypeCodeList | | 1 | |
- samtaleformType | SamtaleformTypeCodeList | | 1 | |
- gruppemoedeId | uuid | | 0 - 1 | Skal angives for fællesmøder. |
- ombookingMulig | boolean | | 1 | Kan der ombookes for dette mødetilbud. |
- ombookingFrist | date | | 0 - 1 | Obligatorisk hvis OmbookingMulig er sat til true. |
- aflysningMulig | boolean | | 1 | Kan borger aflyse dette møde. |
- moedetitel | string | Length: 1-100 | 1 | Mødetitel. Vises på Jobnet. |
- moedebeskrivelse | string | Length: 1-500 | 0 - 1 | Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet. |
- visSagsbehandlernavnForBorger | boolean | | 1 | Om navnet på afholdende sagsbehandler må vises for borger. |
- afholdendeSagsbehandler | SagsbehandlerDto | | 1 | Sagsbehandler |
- - fornavne | string | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
- - mellemnavn | string | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
- - efternavn | string | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
- - eksterntId | string | Length: 1-255 | 1 | Sagsbehandler-id |
- moedeLokation | MoedeLokationDto | | 0 - 1 | Information om hvor mødet skal afholdes |
- - lokationsuddybning | string | Length: 1-200 | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. |
- - adresse | AdresseDto | | 0 - 1 | Adresse |
- - - vejnavn | string | Length: 1-40 | 1 | Vejnavn. |
- - - husnummer | string | Pattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)$ MinLength: 1 | 1 | Husnummer |
- - - etage | string | Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 | Etagenummer |
- - - sideDoer | string | Length: 1-4 | 0 - 1 | Dør-angivelse, fx th. |
- - - postnummer | string | Pattern: [0-9]{4} MinLength: 1 | 1 | Postnummer |
- - - bynavn | string | Length: 1-20 | 1 | Bynavn |
- - - landekode | string | Pattern: ^[A-Za-z]{2}$ | 0 - 1 | Landekode |
- kontaktinformation | KontaktinformationDto | | 0 - 1 | Angiver detaljer om mødet når det ikke er med personligt fremmøde. |
- - digitaltMoedelink | string | Length: 0-2000 | 0 - 1 | Kontaktinformation hvis mødet er digitalt |
- - telefonnummer | 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 | boolean | | 0 - 1 | Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde. |
- selvbooket | boolean | | 0 - 1 | Har borger selvbooket denne aftale |
- moedevarighed | int32 | | 0 - 1 | Mødets varighed i minutter |
- myndighedsdeltagere | MyndighedsdeltagerDtoCollection | | 0 - 1 | Øvrige deltagere på mødet der ikke er borger eller ansvarlig sagsbehandler |
- - MyndighedsdeltagerDto | MyndighedsdeltagerDto | | 0 - * | |
- - - deltagerId | uuid | | 0 - 1 | Id som er unikt for indkaldelsen og deltageren og kan bruges til at opdatere denne separat |
- - - navn | string | Length: 1-256 | 0 - 1 | Fuldt navn på deltager |
- - - kontaktdetaljer | string | Length: 1-256 | 0 - 1 | Anden kontaktinformation |
- - - telefon | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Telefonnummer på deltager |
- - - email | email | | 0 - 1 | Emailadresse på deltager |
- - - eksterntId | string | Length: 1-256 | 0 - 1 | Eksternt id på deltager |
- - - deltagerrolle | DeltagerrolleTypeCodeList | | 1 | |
- - - myndighedsrepraesentantenDeltager | boolean | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- - - afbudsaarsag | MoedeafbudsaarsagTypeCodeList | | 0 - 1 | |
- - - afbudsuddybning | string | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- gruppemoedeEjersystem | ClientSystemTypeCodeList | | 0 - 1 | |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
response | uuid | | 1 | |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
4783 | MoedeStarttidspunkt kan ikke være tidligere end dags dato | MoedeStarttidspunkt kan ikke være tidligere end dags dato |
4784 | Det angivne IndkaldelseId findes allerede i systemet | Det angivne IndkaldelseId findes allerede i systemet |
4792 | MoedeSluttidspunkt kan ikke være tidligere end moedestarttidspunktet | MoedeSluttidspunkt kan ikke være tidligere end moedestarttidspunktet |
4856 | Borgeren er ikke medlem af en a-kasse | Borgeren er ikke medlem af en a-kasse |
4857 | Borgeren er medlem af en anden a-kasse | Borgeren er medlem af en anden a-kasse |
8058 | SamtaleTypen er ikke lovlig jf.borgers kontaktgruppe | SamtaleTypen er ikke lovlig jf.borgers kontaktgruppe |
8125 | OmbookingFrist kan ikke sættes når ombook ikke er muligt | OmbookingFrist kan ikke sættes når ombook ikke er muligt |
8126 | OmbookingFrist er påkrævet når ombook er muligt | OmbookingFrist er påkrævet når ombook er muligt |
8132 | OmbookingFrist må ikke være før dags dato | OmbookingFrist må ikke være før dags dato |
8134 | OmbookingFrist kan ikke være efter mødestart | OmbookingFrist kan ikke være efter mødestart |
8270 | OmbookingMulig må ikke være true for samtaletype Id 18 | OmbookingMulig må ikke være true for samtaletype Id 18 |
8127 | Aflysningsfrist kan ikke sættes når aflysning ikke er mulig | Aflysningsfrist kan ikke sættes når aflysning ikke er mulig |
8128 | Aflysningsfrist skal sættes når aflysning er mulig | Aflysningsfrist skal sættes når aflysning er mulig |
8133 | Aflysningsfrist må ikke være før dags dato | Aflysningsfrist må ikke være før dags dato |
8136 | Aflysningsfrist kan ikke være efter mødestart | Aflysningsfrist kan ikke være efter mødestart |
8129 | Der skal angives en adresse for møder med personligt fremmøde | Der skal angives en adresse for møder med personligt fremmøde |
8130 | Sluttidspunkt eller varighed er påkrævet for møder med den angivne samtaletype | Sluttidspunkt eller varighed er påkrævet for møder med den angivne samtaletype |
8131 | Telefonnummer er påkrævet når borger skal ringe op | Telefonnummer er påkrævet når borger skal ringe op |
8135 | Mødet må ikke strække sig over flere dage | Mødet må ikke strække sig over flere dage |
8209 | Den angivne samtaletype er ikke gyldig til et a-kasse møde | Den angivne samtaletype er ikke gyldig til et a-kasse møde |
8273 | Borger har allerede en kommende jobsamtale, og må ikke have flere fremtidige indkaldelser af denne type | Borger har allerede en kommende jobsamtale, og må ikke have flere fremtidige indkaldelser af denne type |
8288 | Indkaldelsen er senere end en eksisterende frist til selvbooking med samme samtaletype | Indkaldelsen er senere end en eksisterende frist til selvbooking med samme samtaletype |
9121 | Samtale med rehab team er ikke lovlig for denne kontaktgruppe | Samtale med rehab team er ikke lovlig for denne kontaktgruppe |
9220 | Borger har allerede en kommende opfølgningssamtale, og må ikke have flere fremtidige indkaldelser af denne type | Borger har allerede en kommende opfølgningssamtale, og må ikke have flere fremtidige indkaldelser af denne type |
9379 | Borgeren er i a-kasse-forsøg(har fravær 75) og må ikke bookes til møder i jobcentret | Borgeren er i a-kasse-forsøg(har fravær 75) og må ikke bookes til møder i jobcentret |
9390 | Borger skal straksbooke og kan kun selvbooke på Jobnet | Borger skal straksbooke og kan kun selvbooke på Jobnet |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
90105 | Det angivne DeltagerId findes allerede i systemet | Det angivne DeltagerId findes allerede i systemet |
90109 | Mødets starttidspunkt kan ikke være senere end dagen for lukning af kontaktgruppe | Mødets starttidspunkt kan ikke være senere end dagen for lukning af kontaktgruppe |
UpdateIndkaldelse (PUT /v1/Indkaldelse/{indkaldelseId})
Updates an indkaldelse for a specific person.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | | | | | | |
JobCenter | | X | | | X | | | |
Kommune | | X | | | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.write
Element | Type | Detaljer | Forekomst | Beskrivelse |
indkaldelseId [Path] | uuid | | 1 | |
x-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 | 1 | Beskrivelse af cpr |
x-requestId [Header] | string | | 1 | Unikt 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 |
requestBody | UpdateIndkaldelseRequestDto | | 1 | DTO for opdatering af indkaldelse. |
- aflysningsfrist | date | | 0 - 1 | Sluttidspunkt for borgers aflysningsmulighed. |
- moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
- moedeSluttidspunkt | date-time | | 0 - 1 | Sluttidspunktet for bookingen. |
- samtaleType | SamtaleTypeCodeList | | 1 | |
- moedeGruppeType | MoedeGruppeTypeCodeList | | 1 | |
- samtaleformType | SamtaleformTypeCodeList | | 1 | |
- gruppemoedeId | uuid | | 0 - 1 | Skal angives for fællesmøder. |
- ombookingMulig | boolean | | 1 | Kan der ombookes for dette mødetilbud. |
- ombookingFrist | date | | 0 - 1 | Obligatorisk hvis OmbookingMulig er sat til true. |
- aflysningMulig | boolean | | 1 | Kan borger aflyse dette møde. |
- moedetitel | string | Length: 1-100 | 1 | Mødetitel. Vises på Jobnet. |
- moedebeskrivelse | string | Length: 1-500 | 0 - 1 | Beskrivelse til møde med dagsorden og uddybende information. Vises på Jobnet. |
- visSagsbehandlernavnForBorger | boolean | | 1 | Om navnet på afholdende sagsbehandler må vises for borger. |
- afholdendeSagsbehandler | SagsbehandlerDto | | 1 | Sagsbehandler |
- - fornavne | string | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
- - mellemnavn | string | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
- - efternavn | string | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
- - eksterntId | string | Length: 1-255 | 1 | Sagsbehandler-id |
- moedeLokation | MoedeLokationDto | | 0 - 1 | Information om hvor mødet skal afholdes |
- - lokationsuddybning | string | Length: 1-200 | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. |
- - adresse | AdresseDto | | 0 - 1 | Adresse |
- - - vejnavn | string | Length: 1-40 | 1 | Vejnavn. |
- - - husnummer | string | Pattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)$ MinLength: 1 | 1 | Husnummer |
- - - etage | string | Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 | Etagenummer |
- - - sideDoer | string | Length: 1-4 | 0 - 1 | Dør-angivelse, fx th. |
- - - postnummer | string | Pattern: [0-9]{4} MinLength: 1 | 1 | Postnummer |
- - - bynavn | string | Length: 1-20 | 1 | Bynavn |
- - - landekode | string | Pattern: ^[A-Za-z]{2}$ | 0 - 1 | Landekode |
- kontaktinformation | KontaktinformationDto | | 0 - 1 | Angiver detaljer om mødet når det ikke er med personligt fremmøde. |
- - digitaltMoedelink | string | Length: 0-2000 | 0 - 1 | Kontaktinformation hvis mødet er digitalt |
- - telefonnummer | 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 | boolean | | 0 - 1 | Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde. |
- selvbooket | boolean | | 0 - 1 | Har borger selvbooket denne aftale |
- moedevarighed | int32 | | 0 - 1 | Mødets varighed i minutter |
- myndighedsdeltagere | MyndighedsdeltagerDtoCollection | | 0 - 1 | Øvrige deltagere på mødet der ikke er borger eller ansvarlig sagsbehandler |
- - MyndighedsdeltagerDto | MyndighedsdeltagerDto | | 0 - * | |
- - - deltagerId | uuid | | 0 - 1 | Id som er unikt for indkaldelsen og deltageren og kan bruges til at opdatere denne separat |
- - - navn | string | Length: 1-256 | 0 - 1 | Fuldt navn på deltager |
- - - kontaktdetaljer | string | Length: 1-256 | 0 - 1 | Anden kontaktinformation |
- - - telefon | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Telefonnummer på deltager |
- - - email | email | | 0 - 1 | Emailadresse på deltager |
- - - eksterntId | string | Length: 1-256 | 0 - 1 | Eksternt id på deltager |
- - - deltagerrolle | DeltagerrolleTypeCodeList | | 1 | |
- - - myndighedsrepraesentantenDeltager | boolean | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- - - afbudsaarsag | MoedeafbudsaarsagTypeCodeList | | 0 - 1 | |
- - - afbudsuddybning | string | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
4768 | Det angivne IndkaldelseId er ikke kendt i systemet | Det angivne IndkaldelseId er ikke kendt i systemet |
4783 | MoedeStarttidspunkt kan ikke være tidligere end dags dato | MoedeStarttidspunkt kan ikke være tidligere end dags dato |
4792 | MoedeSluttidspunkt kan ikke være tidligere end moedestarttidspunktet | MoedeSluttidspunkt kan ikke være tidligere end moedestarttidspunktet |
4856 | Borgeren er ikke medlem af en a-kasse | Borgeren er ikke medlem af en a-kasse |
4857 | Borgeren er medlem af en anden a-kasse | Borgeren er medlem af en anden a-kasse |
8125 | OmbookingFrist kan ikke sættes når ombook ikke er muligt | OmbookingFrist kan ikke sættes når ombook ikke er muligt |
8126 | OmbookingFrist er påkrævet når ombook er muligt | OmbookingFrist er påkrævet når ombook er muligt |
8132 | OmbookingFrist må ikke være før dags dato | OmbookingFrist må ikke være før dags dato |
8134 | OmbookingFrist kan ikke være efter mødestart | OmbookingFrist kan ikke være efter mødestart |
8270 | OmbookingMulig må ikke være true for samtaletype Id 18 | OmbookingMulig må ikke være true for samtaletype Id 18 |
8127 | Aflysningsfrist kan ikke sættes når aflysning ikke er mulig | Aflysningsfrist kan ikke sættes når aflysning ikke er mulig |
8128 | Aflysningsfrist skal sættes når aflysning er mulig | Aflysningsfrist skal sættes når aflysning er mulig |
8133 | Aflysningsfrist må ikke være før dags dato | Aflysningsfrist må ikke være før dags dato |
8136 | Aflysningsfrist kan ikke være efter mødestart | Aflysningsfrist kan ikke være efter mødestart |
8129 | Der skal angives en adresse for møder med personligt fremmøde | Der skal angives en adresse for møder med personligt fremmøde |
8130 | Sluttidspunkt eller varighed er påkrævet for møder med den angivne samtaletype | Sluttidspunkt eller varighed er påkrævet for møder med den angivne samtaletype |
8131 | Telefonnummer er påkrævet når borger skal ringe op | Telefonnummer er påkrævet når borger skal ringe op |
8135 | Mødet må ikke strække sig over flere dage | Mødet må ikke strække sig over flere dage |
8209 | Den angivne samtaletype er ikke gyldig til et a-kasse møde | Den angivne samtaletype er ikke gyldig til et a-kasse møde |
9121 | Samtale med rehab team er ikke lovlig for denne kontaktgruppe | Samtale med rehab team er ikke lovlig for denne kontaktgruppe |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
8210 | Det er kun opretter af en indkaldelse som kan opdatere og slette den | Det er kun opretter af en indkaldelse som kan opdatere og slette den |
90101 | Opdater eksisterende myndighedsdeltagere inden oprettelse af nye | Opdater eksisterende myndighedsdeltagere inden oprettelse af nye |
90103 | Det angivne DeltagerId hører til en anden indkaldelse end den angivne | Det angivne DeltagerId hører til en anden indkaldelse end den angivne |
90105 | Det angivne DeltagerId findes allerede i systemet | Det angivne DeltagerId findes allerede i systemet |
90109 | Mødets starttidspunkt kan ikke være senere end dagen for lukning af kontaktgruppe | Mødets starttidspunkt kan ikke være senere end dagen for lukning af kontaktgruppe |
DeleteIndkaldelse (DELETE /v1/Indkaldelse/{indkaldelseId})
Deletes an indkaldelse for a specific person.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | | | | | | |
JobCenter | | X | | | X | | | |
Kommune | | X | | | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.write
Element | Type | Detaljer | Forekomst | Beskrivelse |
indkaldelseId [Path] | uuid | | 1 | |
x-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 | 1 | Beskrivelse af cpr |
aflysningsaarsagType [Query] | AflysningsaarsagTypeCodeList | | 1 | |
berigtigelseskommentar [Query] | string | MaxLength: 1500 | 0 - 1 | |
x-requestId [Header] | string | | 1 | Unikt 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
Fejlkode | Fejltekst | Beskrivelse |
4768 | Det angivne IndkaldelseId er ikke kendt i systemet | Det angivne IndkaldelseId er ikke kendt i systemet |
8256 | Fristen skal være mindst en dag efter fristaktiveringsdatoen | Fristen skal være mindst en dag efter fristaktiveringsdatoen |
GetIndkaldelse (GET /v1/Indkaldelse/{indkaldelseId})
Gets a specific indkaldelse for a specific person.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X | | | | |
JobCenter | | X | | X | X | X | | |
Kommune | | X | | X | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.read
Element | Type | Detaljer | Forekomst | Beskrivelse |
indkaldelseId [Path] | uuid | | 1 | |
x-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 | 1 | Beskrivelse af cpr |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
response | GetIndkaldelseResponseDto | | 1 | DTO for response til at hente indkaldelser. |
- indkaldelser | IndkaldelseDtoCollection | | 1 | The available indkaldelser. |
- - IndkaldelseDto | IndkaldelseDto | | 0 - * | |
- - - aflysningsfrist | date | | 0 - 1 | Sluttidspunkt for borgers aflysningsmulighed. |
- - - moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
- - - moedeSluttidspunkt | date-time | | 0 - 1 | Sluttidspunktet for bookingen. |
- - - samtaleType | SamtaleTypeCodeList | | 1 | |
- - - moedeGruppeType | MoedeGruppeTypeCodeList | | 1 | |
- - - samtaleformType | SamtaleformTypeCodeList | | 1 | |
- - - personnummer | string | MinLength: 1 | 1 | Personnummer |
- - - gruppemoedeIdentifier | uuid | | 0 - 1 | Skal angives for gruppemøder |
- - - gruppemoedeEjersystem | ClientSystemTypeCodeList | | 0 - 1 | |
- - - indkaldelseId | uuid | | 0 - 1 | Mulighed for at angive guid på indkaldelsen. |
- - - indkaldelseOphav | IndkaldelseOphavDto | | 1 | Sagsbehandler |
- - - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} MinLength: 1 | 1 | Koden som identificerer organisationen. Det kan være et CVR nummer, en a-kasse kode eller en kommunekode. |
- - - - organisationType | OrganisationTypeCodeList | | 1 | |
- - - ombookingMulig | boolean | | 1 | Kan der ombookes for dette mødetilbud |
- - - ombookingFrist | date-time | | 0 - 1 | Obligatorisk hvis OmbookingMulig er sat til true |
- - - aflysningMulig | boolean | | 1 | Kan borger aflyse dette møde |
- - - selvbooket | boolean | | 1 | Har borger selvbooket denne aftale |
- - - moedetitel | string | Length: 1-100 | 1 | Mødetitel. Vises på Jobnet |
- - - moedebeskrivelse | string | Length: 0-500 | 0 - 1 | Beskrivelse til møde med dagsorden og uddybende information.
Vises på Jobnet |
- - - afholdendeSagsbehandler | SagsbehandlerDto | | 1 | Sagsbehandler |
- - - - fornavne | string | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
- - - - mellemnavn | string | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
- - - - efternavn | string | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
- - - - eksterntId | string | Length: 1-255 | 1 | Sagsbehandler-id |
- - - moedeLokation | MoedeLokationDto | | 0 - 1 | Information om hvor mødet skal afholdes |
- - - - lokationsuddybning | string | Length: 1-200 | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. |
- - - - adresse | AdresseDto | | 0 - 1 | Adresse |
- - - - - vejnavn | string | Length: 1-40 | 1 | Vejnavn. |
- - - - - husnummer | string | Pattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)$ MinLength: 1 | 1 | Husnummer |
- - - - - etage | string | Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 | Etagenummer |
- - - - - sideDoer | string | Length: 1-4 | 0 - 1 | Dør-angivelse, fx th. |
- - - - - postnummer | string | Pattern: [0-9]{4} MinLength: 1 | 1 | Postnummer |
- - - - - bynavn | string | Length: 1-20 | 1 | Bynavn |
- - - - - landekode | string | Pattern: ^[A-Za-z]{2}$ | 0 - 1 | Landekode |
- - - kontaktinformation | KontaktinformationDto | | 0 - 1 | Angiver detaljer om mødet når det ikke er med personligt fremmøde. |
- - - - digitaltMoedelink | string | Length: 0-2000 | 0 - 1 | Kontaktinformation hvis mødet er digitalt |
- - - - telefonnummer | 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 | boolean | | 0 - 1 | Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde. |
- - - visSagsbehandlernavnForBorger | boolean | | 1 | Om navnet på afholdende sagsbehandler må vises for borger |
- - - myndighedsdeltagere | MyndighedsdeltagerDtoCollection | | 1 | Øvrige deltagere på mødet der ikke er borger eller ansvarlig sagsbehandler |
- - - - MyndighedsdeltagerDto | MyndighedsdeltagerDto | | 0 - * | |
- - - - - deltagerId | uuid | | 0 - 1 | Id som er unikt for indkaldelsen og deltageren og kan bruges til at opdatere denne separat |
- - - - - navn | string | Length: 1-256 | 0 - 1 | Fuldt navn på deltager |
- - - - - kontaktdetaljer | string | Length: 1-256 | 0 - 1 | Anden kontaktinformation |
- - - - - telefon | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Telefonnummer på deltager |
- - - - - email | email | | 0 - 1 | Emailadresse på deltager |
- - - - - eksterntId | string | Length: 1-256 | 0 - 1 | Eksternt id på deltager |
- - - - - deltagerrolle | DeltagerrolleTypeCodeList | | 1 | |
- - - - - myndighedsrepraesentantenDeltager | boolean | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- - - - - afbudsaarsag | MoedeafbudsaarsagTypeCodeList | | 0 - 1 | |
- - - - - afbudsuddybning | string | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- - - dfdgRegistreringstidspunkt | date-time | | 0 - 1 | Tidspunktet for DFDGs seneste opdatering af indkaldelsen |
- - - indkaldelseAccepteret | boolean | | 0 - 1 | Angiver om borgeren har accepteret mødeindkaldelsen |
- - - indkaldelseAccepteretTidspunkt | date-time | | 0 - 1 | Angiver hvornår borgeren har accepteret mødeindkaldelsen |
- deltagelsesvalg | DeltagelsesvalgDtoCollection | | 1 | The selected deltagelsesvalg for the indkaldelser. |
- - DeltagelsesvalgDto | DeltagelsesvalgDto | | 0 - * | |
- - - deltagelsesvalgType | DeltagelsesvalgTypeCodeList | | 1 | |
- - - deltagerIMoede | boolean | | 1 | TRUE ved deltagelse |
- - - deltagelseOpdateringstidspunkt | date-time | | 1 | Tidspunkt for opdatering af deltagelsesvalget |
- - - indkaldelseAccepteret | boolean | | 1 | Om gæstende sagsbehandler har accepteret indkaldelsen |
- - - indkaldelseAccepteretTidspunkt | date-time | | 0 - 1 | Tidspunktet for gæstende sagsbehandlers accept af indkaldelsen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
4768 | Det angivne IndkaldelseId er ikke kendt i systemet | Det angivne IndkaldelseId er ikke kendt i systemet |
GetIndkaldelseshistorik (GET /v1/Indkaldelse/historik/{indkaldelseId})
Gets the history of a specific indkaldelse.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X | | | | |
JobCenter | | X | | X | X | X | | |
Kommune | | X | | X | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.read
Element | Type | Detaljer | Forekomst | Beskrivelse |
indkaldelseId [Path] | uuid | | 1 | |
x-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 | 1 | Beskrivelse af cpr |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
response | GetIndkaldelseshistorikResponseDto | | 1 | Gets the history of the call-ups for a given person. |
- indkaldelseshistorikker | IndkaldelseshistorikDtoCollection | | 1 | Liste af historik om indkaldelser. |
- - IndkaldelseshistorikDto | IndkaldelseshistorikDto | | 0 - * | |
- - - registreringsmetadata | RegistreringsmetadataDto | | 1 | DTO for registreringsmetadata. |
- - - - erSlettet | boolean | | 1 | Angiver om registreringen er en sletning |
- - - - erAktuel | boolean | | 1 | Det er en række som er aktuel (kan typisk også ses i PSS). |
- - - - registrerendeMyndighed | RegistrerendeMyndighedDto | | 0 - 1 | DTO for registrerende myndighed. |
- - - - - organisationType | OrganisationTypeCodeList | | 1 | |
- - - - - organisationskode | string | Length: 1-20 | 1 | Identifikation af organisation / myndighed |
- - - - - registrerendeBruger | RegistrerendeBrugerDto | | 0 - 1 | DTO for registrerende bruger. |
- - - - - - kaldendeBruger | KaldendeBrugerDto | | 1 | DTO for kaldende bruger. |
- - - - - - - brugerFuldtNavn | string | Length: 1-140 | 1 | Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her. |
- - - - - - - brugerType | RequestUserTypeCodeList | | 1 | |
- - - - - - - brugerId | string | Length: 1-255 | 1 | Unik 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. |
- - - - - - - brugerEmail | email | | 0 - 1 | Brugers e-mail. |
- - - - - - brugerOrganisation | BrugerOrganisationDto | | 1 | DTO for brugerorganisation. |
- - - - - - - organisationType | OrganisationTypeCodeList | | 1 | |
- - - - - - - organisattionskode | string | Pattern: [-][1]|[0-9]{1,8} MinLength: 1 | 1 | Organisationskode for den registrerende bruger. |
- - - - - - dfdgRegistreringstidspunkt | date-time | | 1 | Tidspunkt for registrering i DFDG |
- - - indkaldelse | IndkaldelseDto | | 1 | Data for en enkelt indkaldelse. |
- - - - aflysningsfrist | date | | 0 - 1 | Sluttidspunkt for borgers aflysningsmulighed. |
- - - - moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
- - - - moedeSluttidspunkt | date-time | | 0 - 1 | Sluttidspunktet for bookingen. |
- - - - samtaleType | SamtaleTypeCodeList | | 1 | |
- - - - moedeGruppeType | MoedeGruppeTypeCodeList | | 1 | |
- - - - samtaleformType | SamtaleformTypeCodeList | | 1 | |
- - - - personnummer | string | MinLength: 1 | 1 | Personnummer |
- - - - gruppemoedeIdentifier | uuid | | 0 - 1 | Skal angives for gruppemøder |
- - - - gruppemoedeEjersystem | ClientSystemTypeCodeList | | 0 - 1 | |
- - - - indkaldelseId | uuid | | 0 - 1 | Mulighed for at angive guid på indkaldelsen. |
- - - - indkaldelseOphav | IndkaldelseOphavDto | | 1 | Sagsbehandler |
- - - - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} MinLength: 1 | 1 | Koden som identificerer organisationen. Det kan være et CVR nummer, en a-kasse kode eller en kommunekode. |
- - - - - organisationType | OrganisationTypeCodeList | | 1 | |
- - - - ombookingMulig | boolean | | 1 | Kan der ombookes for dette mødetilbud |
- - - - ombookingFrist | date-time | | 0 - 1 | Obligatorisk hvis OmbookingMulig er sat til true |
- - - - aflysningMulig | boolean | | 1 | Kan borger aflyse dette møde |
- - - - selvbooket | boolean | | 1 | Har borger selvbooket denne aftale |
- - - - moedetitel | string | Length: 1-100 | 1 | Mødetitel. Vises på Jobnet |
- - - - moedebeskrivelse | string | Length: 0-500 | 0 - 1 | Beskrivelse til møde med dagsorden og uddybende information.
Vises på Jobnet |
- - - - afholdendeSagsbehandler | SagsbehandlerDto | | 1 | Sagsbehandler |
- - - - - fornavne | string | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
- - - - - mellemnavn | string | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
- - - - - efternavn | string | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
- - - - - eksterntId | string | Length: 1-255 | 1 | Sagsbehandler-id |
- - - - moedeLokation | MoedeLokationDto | | 0 - 1 | Information om hvor mødet skal afholdes |
- - - - - lokationsuddybning | string | Length: 1-200 | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. |
- - - - - adresse | AdresseDto | | 0 - 1 | Adresse |
- - - - - - vejnavn | string | Length: 1-40 | 1 | Vejnavn. |
- - - - - - husnummer | string | Pattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)$ MinLength: 1 | 1 | Husnummer |
- - - - - - etage | string | Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 | Etagenummer |
- - - - - - sideDoer | string | Length: 1-4 | 0 - 1 | Dør-angivelse, fx th. |
- - - - - - postnummer | string | Pattern: [0-9]{4} MinLength: 1 | 1 | Postnummer |
- - - - - - bynavn | string | Length: 1-20 | 1 | Bynavn |
- - - - - - landekode | string | Pattern: ^[A-Za-z]{2}$ | 0 - 1 | Landekode |
- - - - kontaktinformation | KontaktinformationDto | | 0 - 1 | Angiver detaljer om mødet når det ikke er med personligt fremmøde. |
- - - - - digitaltMoedelink | string | Length: 0-2000 | 0 - 1 | Kontaktinformation hvis mødet er digitalt |
- - - - - telefonnummer | 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 | boolean | | 0 - 1 | Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde. |
- - - - visSagsbehandlernavnForBorger | boolean | | 1 | Om navnet på afholdende sagsbehandler må vises for borger |
- - - - myndighedsdeltagere | MyndighedsdeltagerDtoCollection | | 1 | Øvrige deltagere på mødet der ikke er borger eller ansvarlig sagsbehandler |
- - - - - MyndighedsdeltagerDto | MyndighedsdeltagerDto | | 0 - * | |
- - - - - - deltagerId | uuid | | 0 - 1 | Id som er unikt for indkaldelsen og deltageren og kan bruges til at opdatere denne separat |
- - - - - - navn | string | Length: 1-256 | 0 - 1 | Fuldt navn på deltager |
- - - - - - kontaktdetaljer | string | Length: 1-256 | 0 - 1 | Anden kontaktinformation |
- - - - - - telefon | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Telefonnummer på deltager |
- - - - - - email | email | | 0 - 1 | Emailadresse på deltager |
- - - - - - eksterntId | string | Length: 1-256 | 0 - 1 | Eksternt id på deltager |
- - - - - - deltagerrolle | DeltagerrolleTypeCodeList | | 1 | |
- - - - - - myndighedsrepraesentantenDeltager | boolean | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- - - - - - afbudsaarsag | MoedeafbudsaarsagTypeCodeList | | 0 - 1 | |
- - - - - - afbudsuddybning | string | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- - - - dfdgRegistreringstidspunkt | date-time | | 0 - 1 | Tidspunktet for DFDGs seneste opdatering af indkaldelsen |
- - - - indkaldelseAccepteret | boolean | | 0 - 1 | Angiver om borgeren har accepteret mødeindkaldelsen |
- - - - indkaldelseAccepteretTidspunkt | date-time | | 0 - 1 | Angiver hvornår borgeren har accepteret mødeindkaldelsen |
- - - moedeaflysningsaarsagType | AflysningsaarsagTypeCodeList | | 0 - 1 | |
- - - berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
90102 | Det angivne IndkaldelseId findes ikke | Det angivne IndkaldelseId findes ikke |
1 | Person does not exist for given cpr number. | Person does not exist for given cpr number. |
GetIndkaldelseshistorik (GET /v1/Indkaldelse/historik)
Gets the history of indkaldelser for a specific person.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | Fra 120 dage inden medlemskab til 120 dage efter medlemskab | X | | | | |
JobCenter | | X | | X | X | X | | |
Kommune | | X | | X | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.read
Element | Type | Detaljer | Forekomst | Beskrivelse |
x-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 | 1 | Beskrivelse af cpr |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
response | GetIndkaldelseshistorikResponseDto | | 1 | Gets the history of the call-ups for a given person. |
- indkaldelseshistorikker | IndkaldelseshistorikDtoCollection | | 1 | Liste af historik om indkaldelser. |
- - IndkaldelseshistorikDto | IndkaldelseshistorikDto | | 0 - * | |
- - - registreringsmetadata | RegistreringsmetadataDto | | 1 | DTO for registreringsmetadata. |
- - - - erSlettet | boolean | | 1 | Angiver om registreringen er en sletning |
- - - - erAktuel | boolean | | 1 | Det er en række som er aktuel (kan typisk også ses i PSS). |
- - - - registrerendeMyndighed | RegistrerendeMyndighedDto | | 0 - 1 | DTO for registrerende myndighed. |
- - - - - organisationType | OrganisationTypeCodeList | | 1 | |
- - - - - organisationskode | string | Length: 1-20 | 1 | Identifikation af organisation / myndighed |
- - - - - registrerendeBruger | RegistrerendeBrugerDto | | 0 - 1 | DTO for registrerende bruger. |
- - - - - - kaldendeBruger | KaldendeBrugerDto | | 1 | DTO for kaldende bruger. |
- - - - - - - brugerFuldtNavn | string | Length: 1-140 | 1 | Sagsbehandlers fulde navn, ved systemkald angives systemets og jobbets navn her. |
- - - - - - - brugerType | RequestUserTypeCodeList | | 1 | |
- - - - - - - brugerId | string | Length: 1-255 | 1 | Unik 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. |
- - - - - - - brugerEmail | email | | 0 - 1 | Brugers e-mail. |
- - - - - - brugerOrganisation | BrugerOrganisationDto | | 1 | DTO for brugerorganisation. |
- - - - - - - organisationType | OrganisationTypeCodeList | | 1 | |
- - - - - - - organisattionskode | string | Pattern: [-][1]|[0-9]{1,8} MinLength: 1 | 1 | Organisationskode for den registrerende bruger. |
- - - - - - dfdgRegistreringstidspunkt | date-time | | 1 | Tidspunkt for registrering i DFDG |
- - - indkaldelse | IndkaldelseDto | | 1 | Data for en enkelt indkaldelse. |
- - - - aflysningsfrist | date | | 0 - 1 | Sluttidspunkt for borgers aflysningsmulighed. |
- - - - moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
- - - - moedeSluttidspunkt | date-time | | 0 - 1 | Sluttidspunktet for bookingen. |
- - - - samtaleType | SamtaleTypeCodeList | | 1 | |
- - - - moedeGruppeType | MoedeGruppeTypeCodeList | | 1 | |
- - - - samtaleformType | SamtaleformTypeCodeList | | 1 | |
- - - - personnummer | string | MinLength: 1 | 1 | Personnummer |
- - - - gruppemoedeIdentifier | uuid | | 0 - 1 | Skal angives for gruppemøder |
- - - - gruppemoedeEjersystem | ClientSystemTypeCodeList | | 0 - 1 | |
- - - - indkaldelseId | uuid | | 0 - 1 | Mulighed for at angive guid på indkaldelsen. |
- - - - indkaldelseOphav | IndkaldelseOphavDto | | 1 | Sagsbehandler |
- - - - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} MinLength: 1 | 1 | Koden som identificerer organisationen. Det kan være et CVR nummer, en a-kasse kode eller en kommunekode. |
- - - - - organisationType | OrganisationTypeCodeList | | 1 | |
- - - - ombookingMulig | boolean | | 1 | Kan der ombookes for dette mødetilbud |
- - - - ombookingFrist | date-time | | 0 - 1 | Obligatorisk hvis OmbookingMulig er sat til true |
- - - - aflysningMulig | boolean | | 1 | Kan borger aflyse dette møde |
- - - - selvbooket | boolean | | 1 | Har borger selvbooket denne aftale |
- - - - moedetitel | string | Length: 1-100 | 1 | Mødetitel. Vises på Jobnet |
- - - - moedebeskrivelse | string | Length: 0-500 | 0 - 1 | Beskrivelse til møde med dagsorden og uddybende information.
Vises på Jobnet |
- - - - afholdendeSagsbehandler | SagsbehandlerDto | | 1 | Sagsbehandler |
- - - - - fornavne | string | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
- - - - - mellemnavn | string | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
- - - - - efternavn | string | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
- - - - - eksterntId | string | Length: 1-255 | 1 | Sagsbehandler-id |
- - - - moedeLokation | MoedeLokationDto | | 0 - 1 | Information om hvor mødet skal afholdes |
- - - - - lokationsuddybning | string | Length: 1-200 | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. |
- - - - - adresse | AdresseDto | | 0 - 1 | Adresse |
- - - - - - vejnavn | string | Length: 1-40 | 1 | Vejnavn. |
- - - - - - husnummer | string | Pattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)$ MinLength: 1 | 1 | Husnummer |
- - - - - - etage | string | Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 | Etagenummer |
- - - - - - sideDoer | string | Length: 1-4 | 0 - 1 | Dør-angivelse, fx th. |
- - - - - - postnummer | string | Pattern: [0-9]{4} MinLength: 1 | 1 | Postnummer |
- - - - - - bynavn | string | Length: 1-20 | 1 | Bynavn |
- - - - - - landekode | string | Pattern: ^[A-Za-z]{2}$ | 0 - 1 | Landekode |
- - - - kontaktinformation | KontaktinformationDto | | 0 - 1 | Angiver detaljer om mødet når det ikke er med personligt fremmøde. |
- - - - - digitaltMoedelink | string | Length: 0-2000 | 0 - 1 | Kontaktinformation hvis mødet er digitalt |
- - - - - telefonnummer | 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 | boolean | | 0 - 1 | Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde. |
- - - - visSagsbehandlernavnForBorger | boolean | | 1 | Om navnet på afholdende sagsbehandler må vises for borger |
- - - - myndighedsdeltagere | MyndighedsdeltagerDtoCollection | | 1 | Øvrige deltagere på mødet der ikke er borger eller ansvarlig sagsbehandler |
- - - - - MyndighedsdeltagerDto | MyndighedsdeltagerDto | | 0 - * | |
- - - - - - deltagerId | uuid | | 0 - 1 | Id som er unikt for indkaldelsen og deltageren og kan bruges til at opdatere denne separat |
- - - - - - navn | string | Length: 1-256 | 0 - 1 | Fuldt navn på deltager |
- - - - - - kontaktdetaljer | string | Length: 1-256 | 0 - 1 | Anden kontaktinformation |
- - - - - - telefon | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Telefonnummer på deltager |
- - - - - - email | email | | 0 - 1 | Emailadresse på deltager |
- - - - - - eksterntId | string | Length: 1-256 | 0 - 1 | Eksternt id på deltager |
- - - - - - deltagerrolle | DeltagerrolleTypeCodeList | | 1 | |
- - - - - - myndighedsrepraesentantenDeltager | boolean | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- - - - - - afbudsaarsag | MoedeafbudsaarsagTypeCodeList | | 0 - 1 | |
- - - - - - afbudsuddybning | string | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- - - - dfdgRegistreringstidspunkt | date-time | | 0 - 1 | Tidspunktet for DFDGs seneste opdatering af indkaldelsen |
- - - - indkaldelseAccepteret | boolean | | 0 - 1 | Angiver om borgeren har accepteret mødeindkaldelsen |
- - - - indkaldelseAccepteretTidspunkt | date-time | | 0 - 1 | Angiver hvornår borgeren har accepteret mødeindkaldelsen |
- - - moedeaflysningsaarsagType | AflysningsaarsagTypeCodeList | | 0 - 1 | |
- - - berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Kommentar til berigtigelse af en registrering |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
90102 | Det angivne IndkaldelseId findes ikke | Det angivne IndkaldelseId findes ikke |
1 | Person does not exist for given cpr number. | Person does not exist for given cpr number. |
CreateMyndighedsdeltager (POST /v1/Indkaldelse/myndighedsdeltager/{myndighedsdeltagerid})
Creates a myndighedsdeltager for a specific indkaldelse.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | | | | | | |
JobCenter | | X | | | X | | | |
Kommune | | X | | | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.write
Element | Type | Detaljer | Forekomst | Beskrivelse |
x-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 | 1 | Beskrivelse af cpr |
myndighedsdeltagerid [Path] | uuid | | 1 | |
x-requestId [Header] | string | | 1 | Unikt 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 |
requestBody | CreateMyndighedsdeltagerRequestDto | | 1 | DTO for oprettelse af myndighedsdeltager. |
- indkaldelseId | uuid | | 1 | Id på den indkaldelse som myndighedsdeltageren skal deltage i |
- navn | string | Length: 1-256 | 0 - 1 | Fuldt navn på deltager |
- kontaktdetaljer | string | Length: 1-256 | 0 - 1 | Anden kontaktinformation |
- telefonnummer | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Telefonnummer på deltager |
- email | email | | 0 - 1 | Emailadresse på deltager |
- eksterntId | string | Length: 1-256 | 0 - 1 | Eksternt id på deltager |
- deltagerrolle | DeltagerrolleTypeCodeList | | 1 | |
- afbudsaarsag | MoedeafbudsaarsagTypeCodeList | | 0 - 1 | |
- afbudsuddybning | string | Length: 1-1000 | 0 - 1 | Uddybning af den gæstende myndigheds afbud |
- myndighedsrepraesentantenDeltager | boolean | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
response | uuid | | 1 | |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
90101 | Opdater eksisterende myndighedsdeltagere inden oprettelse af nye | Opdater eksisterende myndighedsdeltagere inden oprettelse af nye |
90102 | Det angivne IndkaldelseId findes ikke | Det angivne IndkaldelseId findes ikke |
90105 | Det angivne DeltagerId findes allerede i systemet | Det angivne DeltagerId findes allerede i systemet |
UpdateMyndighedsdeltager (PUT /v1/Indkaldelse/myndighedsdeltager/{myndighedsdeltagerid})
Updates a myndighedsdeltager for a specific indkaldelse.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | | | | | | |
JobCenter | | X | | | X | | | |
Kommune | | X | | | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.write
Element | Type | Detaljer | Forekomst | Beskrivelse |
x-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 | 1 | Beskrivelse af cpr |
myndighedsdeltagerid [Path] | uuid | | 1 | |
x-requestId [Header] | string | | 1 | Unikt 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 |
requestBody | UpdateMyndighedsdeltagerRequestDto | | 1 | DTO for opdatering af myndighedsdeltager. |
- indkaldelseId | uuid | | 1 | Id på den indkaldelse som myndighedsdeltageren skal deltage i |
- navn | string | Length: 1-256 | 0 - 1 | Fuldt navn på deltager |
- kontaktdetaljer | string | Length: 1-256 | 0 - 1 | Anden kontaktinformation |
- telefonnummer | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Telefonnummer på deltager |
- email | email | | 0 - 1 | Emailadresse på deltager |
- eksterntId | string | Length: 1-256 | 0 - 1 | Eksternt id på deltager |
- deltagerrolle | DeltagerrolleTypeCodeList | | 1 | |
- afbudsaarsag | MoedeafbudsaarsagTypeCodeList | | 0 - 1 | |
- afbudsuddybning | string | Length: 1-1000 | 0 - 1 | Uddybning af den gæstende myndigheds afbud |
- myndighedsrepraesentantenDeltager | boolean | | 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
Output
Intet output
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
90102 | Det angivne IndkaldelseId findes ikke | Det angivne IndkaldelseId findes ikke |
90103 | Det angivne DeltagerId hører til en anden indkaldelse end den angivne | Det angivne DeltagerId hører til en anden indkaldelse end den angivne |
90107 | Det angivne DeltagerId findes ikke | Det angivne DeltagerId findes ikke |
DeleteMyndighedsdeltager (DELETE /v1/Indkaldelse/myndighedsdeltager/{myndighedsdeltagerid}/indkaldelse/{indkaldelseid})
Deletes a myndighedsdeltager for a specific indkaldelse.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
A-kasse | | X | | | | | | |
JobCenter | | X | | | X | | | |
Kommune | | X | | | | | | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.write
Element | Type | Detaljer | Forekomst | Beskrivelse |
x-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 | 1 | Beskrivelse af cpr |
myndighedsdeltagerid [Path] | uuid | | 1 | |
indkaldelseid [Path] | uuid | | 1 | |
x-requestId [Header] | string | | 1 | Unikt 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
Fejlkode | Fejltekst | Beskrivelse |
4405 | Borgeren med det specificerede CPR nummer er død | Borgeren med det specificerede CPR nummer er død |
90102 | Det angivne IndkaldelseId findes ikke | Det angivne IndkaldelseId findes ikke |
90103 | Det angivne DeltagerId hører til en anden indkaldelse end den angivne | Det angivne DeltagerId hører til en anden indkaldelse end den angivne |
90107 | Det angivne DeltagerId findes ikke | Det angivne DeltagerId findes ikke |
GetSoegning (POST /v1/Indkaldelse/action/indkaldelseSoegning)
Gets a list of indkaldelser based on the search parameters.
Tilladte organisationer
| Alle borgere | Egne borgere | Tidligere egne borgere | Gæsteadgang | Anden Aktør - egne borgere | Anden Aktør - gæsteadgang | Anden Aktør - alle borgere | System - alle borgere |
---|
JobCenter | X | | | | | | X | |
STAR | X | | | | | | | |
Scope
kontaktforloeb.samtale.soegning.write
Element | Type | Detaljer | Forekomst | Beskrivelse |
x-requestId [Header] | string | | 1 | Unikt 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 |
requestBody | GetIndkaldelseSoegningRequestDto | | 1 | DTO for søgning af indkaldelser. |
- gruppemoedeIdentifier | uuid | | 0 - 1 | Det unikke identifikationsnummer for det møde, der søges efter. |
- tidligsteMoedestarttidspunkt | date-time | | 0 - 1 | Det tidligste tidspunkt, hvor mødet kan starte. |
- senesteMoedestarttidspunkt | date-time | | 0 - 1 | Det seneste tidspunkt, hvor mødet kan starte. |
- samtaleformType | SamtaleformTypeCodeList | | 0 - 1 | |
- samtaleType | SamtaleTypeCodeList | | 0 - 1 | |
- moedeGruppeType | MoedeGruppeTypeCodeList | | 0 - 1 | |
- afholdendeSagsbehandlerEksterntId | string | | 0 - 1 | Sagsbehandleren der afholder mødet |
- inkluderAflysteIndkaldelser | boolean | | 0 - 1 | Indikerer om aflyste indkaldelser skal inkluderes |
Output
Element | Type | Detaljer | Forekomst | Beskrivelse |
response | GetIndkaldelseSoegningResponseDto | | 1 | DTO for svar på indkaldelsessoegning. |
- indkaldelser | IndkaldelseSoegningDtoCollection | | 1 | Indkaldelser fundet. |
- - IndkaldelseSoegningDto | IndkaldelseSoegningDto | | 0 - * | |
- - - aflysningsfrist | date | | 0 - 1 | Sluttidspunkt for borgers aflysningsmulighed. |
- - - moedeStarttidspunkt | date-time | | 1 | Starttidspunkt for bookingen. |
- - - moedeSluttidspunkt | date-time | | 0 - 1 | Sluttidspunktet for bookingen. |
- - - samtaleType | SamtaleTypeCodeList | | 1 | |
- - - moedeGruppeType | MoedeGruppeTypeCodeList | | 1 | |
- - - samtaleformType | SamtaleformTypeCodeList | | 1 | |
- - - personnummer | string | MinLength: 1 | 1 | Personnummer |
- - - gruppemoedeIdentifier | uuid | | 0 - 1 | Skal angives for gruppemøder |
- - - gruppemoedeEjersystem | ClientSystemTypeCodeList | | 0 - 1 | |
- - - indkaldelseId | uuid | | 0 - 1 | Mulighed for at angive guid på indkaldelsen. |
- - - indkaldelseOphav | IndkaldelseOphavDto | | 1 | Sagsbehandler |
- - - - organisationskode | string | Pattern: [-][1]|[0-9]{1,8} MinLength: 1 | 1 | Koden som identificerer organisationen. Det kan være et CVR nummer, en a-kasse kode eller en kommunekode. |
- - - - organisationType | OrganisationTypeCodeList | | 1 | |
- - - ombookingMulig | boolean | | 1 | Kan der ombookes for dette mødetilbud |
- - - ombookingFrist | date-time | | 0 - 1 | Obligatorisk hvis OmbookingMulig er sat til true |
- - - aflysningMulig | boolean | | 1 | Kan borger aflyse dette møde |
- - - selvbooket | boolean | | 1 | Har borger selvbooket denne aftale |
- - - moedetitel | string | Length: 1-100 | 1 | Mødetitel. Vises på Jobnet |
- - - moedebeskrivelse | string | Length: 0-500 | 0 - 1 | Beskrivelse til møde med dagsorden og uddybende information.
Vises på Jobnet |
- - - afholdendeSagsbehandler | SagsbehandlerDto | | 1 | Sagsbehandler |
- - - - fornavne | string | Length: 1-50 | 1 | Sagsbehandlerens fornavn(e). |
- - - - mellemnavn | string | Length: 1-40 | 0 - 1 | Sagsbehandlerens mellemnavn. |
- - - - efternavn | string | Length: 1-40 | 1 | Sagsbehandlerens efternavn. |
- - - - eksterntId | string | Length: 1-255 | 1 | Sagsbehandler-id |
- - - moedeLokation | MoedeLokationDto | | 0 - 1 | Information om hvor mødet skal afholdes |
- - - - lokationsuddybning | string | Length: 1-200 | 0 - 1 | Beskrivelse af mødestedet i det omfang adressen ikke er tilstrækkelig. |
- - - - adresse | AdresseDto | | 0 - 1 | Adresse |
- - - - - vejnavn | string | Length: 1-40 | 1 | Vejnavn. |
- - - - - husnummer | string | Pattern: ^([1-9][0-9]{0,2}[a-zA-Z]?)$ MinLength: 1 | 1 | Husnummer |
- - - - - etage | string | Pattern: [1-9]|[1-9][0-9]|KL|ST|kl|st|k[2-9]|K[2-9] | 0 - 1 | Etagenummer |
- - - - - sideDoer | string | Length: 1-4 | 0 - 1 | Dør-angivelse, fx th. |
- - - - - postnummer | string | Pattern: [0-9]{4} MinLength: 1 | 1 | Postnummer |
- - - - - bynavn | string | Length: 1-20 | 1 | Bynavn |
- - - - - landekode | string | Pattern: ^[A-Za-z]{2}$ | 0 - 1 | Landekode |
- - - kontaktinformation | KontaktinformationDto | | 0 - 1 | Angiver detaljer om mødet når det ikke er med personligt fremmøde. |
- - - - digitaltMoedelink | string | Length: 0-2000 | 0 - 1 | Kontaktinformation hvis mødet er digitalt |
- - - - telefonnummer | 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 | boolean | | 0 - 1 | Angiver hvorvidt borgeren skal ringe i forbindelse med et telefonisk møde. |
- - - visSagsbehandlernavnForBorger | boolean | | 1 | Om navnet på afholdende sagsbehandler må vises for borger |
- - - myndighedsdeltagere | MyndighedsdeltagerDtoCollection | | 1 | Øvrige deltagere på mødet der ikke er borger eller ansvarlig sagsbehandler |
- - - - MyndighedsdeltagerDto | MyndighedsdeltagerDto | | 0 - * | |
- - - - - deltagerId | uuid | | 0 - 1 | Id som er unikt for indkaldelsen og deltageren og kan bruges til at opdatere denne separat |
- - - - - navn | string | Length: 1-256 | 0 - 1 | Fuldt navn på deltager |
- - - - - kontaktdetaljer | string | Length: 1-256 | 0 - 1 | Anden kontaktinformation |
- - - - - telefon | string | Pattern: (\+)?[0-9]{3,20} | 0 - 1 | Telefonnummer på deltager |
- - - - - email | email | | 0 - 1 | Emailadresse på deltager |
- - - - - eksterntId | string | Length: 1-256 | 0 - 1 | Eksternt id på deltager |
- - - - - deltagerrolle | DeltagerrolleTypeCodeList | | 1 | |
- - - - - myndighedsrepraesentantenDeltager | boolean | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- - - - - afbudsaarsag | MoedeafbudsaarsagTypeCodeList | | 0 - 1 | |
- - - - - afbudsuddybning | string | | 0 - 1 | Indikation på deltagelse.TRUE = Deltager, FALSE = Afbud |
- - - dfdgRegistreringstidspunkt | date-time | | 0 - 1 | Tidspunktet for DFDGs seneste opdatering af indkaldelsen |
- - - indkaldelseAccepteret | boolean | | 0 - 1 | Angiver om borgeren har accepteret mødeindkaldelsen |
- - - indkaldelseAccepteretTidspunkt | date-time | | 0 - 1 | Angiver hvornår borgeren har accepteret mødeindkaldelsen |
- - - aflysningsinformation | AflysningsinformationDto | | 0 - 1 | DTO for aflysningsinformation |
- - - - moedeaflysningaarsagType | AflysningsaarsagTypeCodeList | | 1 | |
- - - - berigtigelseskommentar | string | | 0 - 1 | Kommentar til berigtigelse af en registrering |
- - - - aflysningstidspunkt | date-time | | 1 | Tidspunktet for registreringen af aflysningen |
Fejlkoder
Fejlkode | Fejltekst | Beskrivelse |
4764 | Det er ikke muligt at søge uden søgeparametre | Det er ikke muligt at søge uden søgeparametre |
6010 | Søgningen resulterede i for mange resultater. Lav en snævrere søgning med skærpede søgeparametre | Søgningen resulterede i for mange resultater. Lav en snævrere søgning med skærpede søgeparametre |