...
| 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 | CreateBorgerBeskedRequestCreateBorgerbeskedRequestDto | 1 | createBorgerBeskedRequest dto. | |
| - afsender | AfsenderDto | 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen. | |
| - - brugertype | BrugerTypeCodeList | 1 | ||
| - - brugerIdentifier | string | 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CV nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID. | |
| - - navn | string | 1 | Sagsbehandlers eller borgerens fulde navn. | |
| - - virksomhed | VirksomhedDto | 0 - 1 | Angiver virksomhedsinformation. | |
| - - - pNummer | string | Length: 1-10 | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid være tilknyttet et CVR-nummer.. |
| - - - cvrEnhedsid | string | Length: 1-8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
| - - - virksomhedKontaktIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Identifikation af kontaktperson hos virksomhed (arbejdsgiver). |
| - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - organisationskode | string | 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse. | |
| - Personer | PersonerDto | 1 | CPR numre på den/de borgere beskeden omhandler. Der dannes en separat meddelelse for hvert cpr-nummer der er angivet i listen. | |
| - - personnummer | stringCollection | 1 | CPR nummer. | |
| - - - string | string | 0 - * | ||
| - indholdstype | BeskedIndholdsTypeCodeList | 1 | ||
| - titel | string | LengthMinLength: 0-200 | 0 - 1 | Kodelisteværdi der fortæller hvilken kontekst meddelelsen skal oprettes under. Dette styrer eksempelvis hvor meddelelserne vises på jobnet. Max 200 karakterer. |
| - tekst | string | LengthMinLength: 1-2000 | 1 | Indeholder den tekst dialogen skal indeholde. SMS max 160 karakterer, Mail max 2000 karakterer, Notifikation max 500 karakterer, Myndighed-til-myndighed max 2000 karakterer. |
| - besvarelsestype | BesvarelsesTypeCodeList | 1 | ||
| - afsendelseskanal | AfsendelsesKanalTypeCodeList | 1 | ||
| - modtagendeMyndighed | ModtagendeMyndighedDto | 0 - 1 | ||
| - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - organisationskode | string | 1 | Organisationskode. | |
| - visIBeskedbakke | boolean | 1 | Markering af hvorvidt besked skal vises i beskedbakken eller ej:Sandt: Besked vises; Falsk: Besked vises ikke. | |
| - beskedSynligFratidspunkt | date-time | 0 - 1 | Eventuel fremtidig visningsdato.Hvis udfyldt vises besked først når dato nås. | |
| - beskedSynligTiltidspunkt | date-time | 0 - 1 | Eventuel dato for afslutning af visning Hvis udfyld vises besked ikke mere når dato nås. Kan kun angives for kanal lig Notifikation. | |
| - senesteSvartidspunkt | date-time | 0 - 1 | Eventuel dato for Svar senest. | |
| - vigtighedsniveau | VigtighedsniveauTypeCodeList | 1 | ||
| - vedhaeftetDokumenter | VedhaeftetDokumenterDtoCollection | 1 | Kollektion af vedhæftede dokumenter. | |
| - - VedhaeftetDokumenterDto | VedhaeftetDokumenterDto | 0 - * | ||
| - - - documentIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 0 - 1 | Entydig nøgle. |
| - - - dokumenttitel | string | Length: 1-260 | 1 | Titel på dokumentet. |
| - - - dokumentfiltype | DokumentTypeCodeList | 1 | ||
| - - - dokumentskema | DokumentSkemaTypeCodeList | 0 - 1 | ||
| - - - dokumentdata | base64Binary | 0 - 1 | Selve dokumentet. | |
| - arkivbesked | boolean | 1 | Om beskede er en arkiv besked. | |
| - beskedTag | string | 0 - 1 | Multibeskeder, samme besked til mange borgere. |
...
| Element | Type | Detaljer | Forekomst | Beskrivelse | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| response | CreateborgerbeskedResponceDtoCreateBorgerbeskedResponseDto | 1 | CreateborgerbeskedResponceDto dto.CreateBorgerbeskedResponseDto | |||||||||||
| - borgerbeskeder borgerbeskedIdentifiers | BorgerbeskederDtouuidCollection | 0 - 1 | Indeholder GUID (borgerbeskedIdentifier) for den nyoprettede meddelelse. Hvis der er flere CPR-numre i oprettelsen returneres en servicesReceipt for hver nyoprettede meddelelse. | |||||||||||
| - - Borgerbesked | BorgerbeskedDto | 1 | Servicekvittering. | - - - borgerbeskedIdentifier | stringCollection | 1 | Unik identifikation af transaktion eller registrering. | - - - - string | string | uuid | uuid | 0 - * |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 8143 | Den angivne tekst er over maksimun længde for kanalen | Den angivne tekst er over maksimun længde for kanalen |
| 8149 | En modtager skal være angivet når kanal er 'MyndighedTilMyndighed' | En modtager skal være angivet når kanal er 'MyndighedTilMyndighed' |
| 8150 | Myndigheden skal være jobcenter eller a-kasse | Myndigheden skal være jobcenter eller a-kasse |
| 8154 | Titel er ikke tilladt når kanal er SMS | Titel er ikke tilladt når kanal er SMS |
| 8157 | Når kanalen ikke er 'MyndighedTilMyndighed' skal modtager være Null | Når kanalen ikke er 'MyndighedTilMyndighed' skal modtager være Null |
| 8311 | Et default jobcenter eller a-kasse eksisterer ikke for personen | Et default jobcenter eller a-kasse eksisterer ikke for personen |
| 8313 | Titel er ikke tilladt for denne kanaltype | Titel er ikke tilladt for denne kanaltype |
| 9014 | Den angivende kanal er ikke tilladt for afsender | Den angivende kanal er ikke tilladt for afsender |
| 9015 | Den angivende ResponseType er ikke tillladt for beskedtype, afsender og kanal | Den angivende ResponseType er ikke tillladt for beskedtype, afsender og kanal |
| 9016 | Den angivende arkivbesked er ikke tillladt for beskedtype, afsender og kanal | Den angivende arkivbesked er ikke tillladt for beskedtype, afsender og kanal |
| 9017 | Den angivne visIBeskedbakke er ikke tilladt for denne beskedtype og afsendelseskanal | Den angivne visIBeskedbakke er ikke tilladt for denne beskedtype og afsendelseskanal |
| 9019 | Html er ikke tilladt | Html er ikke tilladt |
| 9104 | Organisationtype skal være angivet når bruger er sagsbehandler | Organisationtype skal være angivet når bruger er sagsbehandler |
| 9310 | Modtagende organisationskode kan ikke være et subjobcenter | Modtagende organisationskode kan ikke være et subjobcenter |
...
GetBorgerbesked (GET /v1/Borgerbesked)
Metoden bruges til at hente alle beskeder for en borger.
...
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | getCitizenMessageResponseDtoGetBorgerbeskedResponseDto | 1 | Response Get Borgerbeskeder. | |
| - Borgerbesked borgerbeskeder | GetBorgerbeskedDtoCollection | 1 | BorgerbeskedBorgerbeskeder. | |
| - - GetBorgerbeskedDto | GetBorgerbeskedDto | 0 - * | ||
| - - - borgerbeskedIdentifier | uuid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Unik ID for meddelelsen |
| - - - indholdstype | BeskedIndholdsTypeCodeList | 1 | ||
| - - - afsender | AfsenderDto | 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen. | |
| - - - - brugertype | BrugerTypeCodeList | 1 | ||
| - - - - brugerIdentifier | string | 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CV nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID. | |
| - - - - navn | string | 1 | Sagsbehandlers eller borgerens fulde navn. | |
| - - - - virksomhed | VirksomhedDto | 0 - 1 | Angiver virksomhedsinformation. | |
| - - - - - pNummer | string | Length: 1-10 | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid være tilknyttet et CVR-nummer.. |
| - - - - - cvrEnhedsid | string | Length: 1-8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
| - - - - - virksomhedKontaktIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Identifikation af kontaktperson hos virksomhed (arbejdsgiver). |
| - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - - organisationskode | string | 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse. | |
| - - - title | string | 0 - 1 | Titlen på dialogen | |
| - - - tekst | string | 1 | Tekst dialogen skal indeholde | |
| - - - modtagendeMyndighed | ModtagendeMyndighedDto | 0 - 1 | ||
| - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - - organisationskode | string | 1 | Organisationskode. | |
| - - - afsendelseskanal | AfsendelsesKanalTypeCodeList | 1 | ||
| - - - besvarelsestype | BesvarelsesTypeCodeList | 1 | ||
| - - - borgerbeskedsvar | beskedstatusmarkeringerCollectionBeskedsvarDtoCollection | 0 - 1 | Indeholder en liste over alle de retursvar der er oprettet til denne dialog | |
| - - - - beskedstatusmarkeringer BeskedsvarDto | beskedstatusmarkeringerBeskedsvarDto | 0 - * | ||
| - - - - - borgerbeskedsvarIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Entydig nøgle. |
| - - - - - afsender | AfsenderDto | 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen. | |
| - - - - - - brugertype | BrugerTypeCodeList | 1 | ||
| - - - - - - brugerIdentifier | string | 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CV nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID. | |
| - - - - - - navn | string | 1 | Sagsbehandlers eller borgerens fulde navn. | |
| - - - - - - virksomhed | VirksomhedDto | 0 - 1 | Angiver virksomhedsinformation. | |
| - - - - - - - pNummer | string | Length: 1-10 | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid være tilknyttet et CVR-nummer.. |
| - - - - - - - cvrEnhedsid | string | Length: 1-8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
| - - - - - - - virksomhedKontaktIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Identifikation af kontaktperson hos virksomhed (arbejdsgiver). |
| - - - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - - - - organisationskode | string | 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse. | |
| - - - - - tekst | string | LengthMinLength: 1-2000 | 1 | Tekst retursvar indeholder. Max 2000 karakterer. |
| - - - - - oprettelsestidspunkt | date-time | 1 | Dato og tid for hvornår svar er blevet oprettet | |
| - - - - - beskedstatus | BorgerBeskedStatusCodeList | 1 | ||
| - - - - - vedhaeftetDokumenter | vedhaeftetDokumentDtoCollectionVedhaeftetDokumentDtoCollection | 0 - 1 | Kollektion af vedhæftede dokumenter | |
| - - - - - - vedhaeftetDokumentDto VedhaeftetDokumentDto | vedhaeftetDokumentDtoVedhaeftetDokumentDto | 0 - * | ||
| - - - - - - - documentIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 0 - 1 | Entydig nøgle. |
| - - - - - - - dokumenttitel | string | Length: 1-260 | 1 | Titel på dokumentet. |
| - - - - - - - dokumentfiltype | DokumentTypeCodeList | 1 | ||
| - - - - - - - dokumentskema | DokumentSkemaTypeCodeList | 0 - 1 | ||
| - - - - - beskedstatusmarkering | beskedstatusmarkeringCollectionBeskedstatusmarkeringDtoCollection | 0 - 1 | Kollektion af markeringer for visning og læsning | |
| - - - - - - beskedstatusmarkering BeskedstatusmarkeringDto | beskedstatusmarkeringBeskedstatusmarkeringDto | 0 - * | ||
| - - - - - - - statusmarkering | BeskedMarkeringsstatusCodeList | 1 | ||
| - - - - - - - haendelsestidspunkt | date-time | 1 | Dato for hvornår handlingen blev udført. | |
| - - - - - berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Berigtigelseskommentar |
| - - - beskedstatus | BorgerBeskedStatusCodeList | 1 | ||
| - - - oprettelsestidspunkt | date-time | 1 | Dato og tid for hvornår dialogen er blevet oprettet | |
| - - - visIBeskedbakke | boolean | 1 | Markering af hvorvidt besked skal vises i beskedbakken eller ej:Sandt: Besked vises; Falsk: Besked vises ikke | |
| - - - beskedSynligFratidspunkt | date-time | 0 - 1 | Eventuel fremtidig visningsdato. Hvis udfyldt vises besked først når dato nås | |
| - - - beskedSynligTiltidspunkt | date-time | 0 - 1 | Eventuel dato for afslutning af visning Hvis udfyld vises besked ikke mere når dato nås. Kan kun angives for kanal lig Notifikation | |
| - - - senesteSvartidspunkt | date-time | 0 - 1 | Eventuel dato for Svar senest | |
| - - - vigtighedsniveau | VigtighedsniveauTypeCodeList | 1 | ||
| - - - vedhaeftetDokumenter | vedhaeftetDokumentDtoCollectionVedhaeftetDokumentDtoCollection | 0 - 1 | Kollektion af vedhæftede dokumenter | |
| - - - - vedhaeftetDokumentDto VedhaeftetDokumentDto | vedhaeftetDokumentDtoVedhaeftetDokumentDto | 0 - * | ||
| - - - - - documentIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 0 - 1 | Entydig nøgle. |
| - - - - - dokumenttitel | string | Length: 1-260 | 1 | Titel på dokumentet. |
| - - - - - dokumentfiltype | DokumentTypeCodeList | 1 | ||
| - - - - - dokumentskema | DokumentSkemaTypeCodeList | 0 - 1 | ||
| - - - beskedstatusmarkeringer | beskedstatusmarkeringCollectionBeskedstatusmarkeringDtoCollection | 0 - 1 | Kollektion af markeringer for visning og læsning | |
| - - - - beskedstatusmarkering BeskedstatusmarkeringDto | beskedstatusmarkeringBeskedstatusmarkeringDto | 0 - * | ||
| - - - - - statusmarkering | BeskedMarkeringsstatusCodeList | 1 | ||
| - - - - - haendelsestidspunkt | date-time | 1 | Dato for hvornår handlingen blev udført. | |
| - - - beskedTag | beskedTagCollectionBeskedTagDtoCollection | 0 - 1 | Multibeskeder, samme besked til mange borgere | |
| - - - - BeskedTagDto | BeskedTagDto | 0 - * | ||
| - - - - beskedTagbeskedTag - oprettetAf | AfsenderDto | 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen. | |
| - - - - - - brugertype | BrugerTypeCodeList | 1 | ||
| - - - - - - brugerIdentifier | string | 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CV nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID. | |
| - - - - - - navn | string | 1 | Sagsbehandlers eller borgerens fulde navn. | |
| - - - - - - virksomhed | VirksomhedDto | 0 - 1 | Angiver virksomhedsinformation. | |
| - - - - - - - pNummer | string | Length: 1-10 | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid være tilknyttet et CVR-nummer.. |
| - - - - - - - cvrEnhedsid | string | Length: 1-8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
| - - - - - - - virksomhedKontaktIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Identifikation af kontaktperson hos virksomhed (arbejdsgiver). |
| - - - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - - - - organisationskode | string | 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse. | |
| - - - - - beskedTag | string | 1 | Multibeskeder, samme besked til mange borgere. | |
| - - - - - haendelsestidspunkt | date-time | 1 | Dato for hvornår handlingen blev udført. | |
| - - - berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Berigtigelseskommentar |
Fejlkoder
Ingen fejlkoder
GetBorgerbeskedByIdentifier (GET /v1/Borgerbesked/{borgerbeskedIdentifier})
Metoden bruges til at hente en specifik besked relateret til en borger. Beskeden indeholder hovedbeskeden og evt. tilhørende svar til denne hovedbesked.
Scope
borgerkommunikation.borgerbesked.read
Input
| 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 |
| borgerbeskedIdentifier [Path] | uuid | 1 |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | GetBorgerbeskedMedIdentifierResponseDto | 1 | Response Get Borgerbeskeder. | |
| - borgerbesked | GetBorgerbeskedDto | 1 | Borgerbesked. | |
| - - borgerbeskedIdentifier | uuid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Unik ID for meddelelsen |
| - - indholdstype | BeskedIndholdsTypeCodeList | 1 | ||
| - - afsender | AfsenderDto | 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen. | |
| - - - brugertype | BrugerTypeCodeList | 1 | ||
| - - - brugerIdentifier | string | 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CV nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID. | |
| - - - navn | string | 1 | Sagsbehandlers eller borgerens fulde navn. | |
| - - - virksomhed | VirksomhedDto | 0 - 1 | Angiver virksomhedsinformation. | |
| - - - - pNummer | string | Length: 1-10 | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid være tilknyttet et CVR-nummer.. |
| - - - - cvrEnhedsid | string | Length: 1-8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
| - - - - virksomhedKontaktIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Identifikation af kontaktperson hos virksomhed (arbejdsgiver). |
| - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - organisationskode | string | 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse. | |
| - - title | string | 0 - 1 | Titlen på dialogen | |
| - - tekst | string | 1 | Tekst dialogen skal indeholde | |
| - - modtagendeMyndighed | ModtagendeMyndighedDto | 0 - 1 | ||
| - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - organisationskode | string | 1 | Organisationskode. | |
| - - afsendelseskanal | AfsendelsesKanalTypeCodeList | 1 | ||
| - - besvarelsestype | BesvarelsesTypeCodeList | 1 | ||
| - - borgerbeskedsvar | BeskedsvarDtoCollection | 0 - 1 | Indeholder en liste over alle de retursvar der er oprettet til denne dialog | |
| - - - BeskedsvarDto | BeskedsvarDto | 0 - * | ||
| - - - - borgerbeskedsvarIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Entydig nøgle. |
| - - - - afsender | AfsenderDto | 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen. | |
| - - - - - brugertype | BrugerTypeCodeList | 1 | ||
| - - - - - brugerIdentifier | string | 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CV nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID. | |
| - - - - - navn | string | 1 | Sagsbehandlers eller borgerens fulde navn. | |
| - - - - - virksomhed | VirksomhedDto | 0 - 1 | Angiver virksomhedsinformation. | |
| - - - - - - pNummer | string | Length: 1-10 | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid være tilknyttet et CVR-nummer.. |
| - - - - - - cvrEnhedsid | string | Length: 1-8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
| - - - - - - virksomhedKontaktIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Identifikation af kontaktperson hos virksomhed (arbejdsgiver). |
| - - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - - - organisationskode | string | 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse. | |
| - - - - tekst | string | MinLength: 1 | 1 | Tekst retursvar indeholder. Max 2000 karakterer. |
| - - - - oprettelsestidspunkt | date-time | 1 | Dato og tid for hvornår svar er blevet oprettet | |
| - - - - beskedstatus | BorgerBeskedStatusCodeList | 1 | ||
| - - - - vedhaeftetDokumenter | VedhaeftetDokumentDtoCollection | 0 - 1 | Kollektion af vedhæftede dokumenter | |
| - - - - - VedhaeftetDokumentDto | VedhaeftetDokumentDto | 0 - * | ||
| - - - - - - documentIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 0 - 1 | Entydig nøgle. |
| - - - - - - dokumenttitel | string | Length: 1-260 | 1 | Titel på dokumentet. |
| - - - - - - dokumentfiltype | DokumentTypeCodeList | 1 | ||
| - - - - - - dokumentskema | DokumentSkemaTypeCodeList | 0 - 1 | ||
| - - - - beskedstatusmarkering | BeskedstatusmarkeringDtoCollection | 0 - 1 | Kollektion af markeringer for visning og læsning | |
| - - - - - BeskedstatusmarkeringDto | BeskedstatusmarkeringDto | 0 - * | ||
| - - - - - - statusmarkering | BeskedMarkeringsstatusCodeList | 1 | ||
| - - - - - - haendelsestidspunkt | date-time | 1 | Dato for hvornår handlingen blev udført. | |
| - - - - berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Berigtigelseskommentar |
| - - beskedstatus | BorgerBeskedStatusCodeList | 1 | ||
| - - oprettelsestidspunkt | date-time | 1 | Dato og tid for hvornår dialogen er blevet oprettet | |
| - - visIBeskedbakke | boolean | 1 | Markering af hvorvidt besked skal vises i beskedbakken eller ej:Sandt: Besked vises; Falsk: Besked vises ikke | |
| - - beskedSynligFratidspunkt | date-time | 0 - 1 | Eventuel fremtidig visningsdato. Hvis udfyldt vises besked først når dato nås | |
| - - beskedSynligTiltidspunkt | date-time | 0 - 1 | Eventuel dato for afslutning af visning Hvis udfyld vises besked ikke mere når dato nås. Kan kun angives for kanal lig Notifikation | |
| - - senesteSvartidspunkt | date-time | 0 - 1 | Eventuel dato for Svar senest | |
| - - vigtighedsniveau | VigtighedsniveauTypeCodeList | 1 | ||
| - - vedhaeftetDokumenter | VedhaeftetDokumentDtoCollection | 0 - 1 | Kollektion af vedhæftede dokumenter | |
| - - - VedhaeftetDokumentDto | VedhaeftetDokumentDto | 0 - * | ||
| - - - - documentIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 0 - 1 | Entydig nøgle. |
| - - - - dokumenttitel | string | Length: 1-260 | 1 | Titel på dokumentet. |
| - - - - dokumentfiltype | DokumentTypeCodeList | 1 | ||
| - - - - dokumentskema | DokumentSkemaTypeCodeList | 0 - 1 | ||
| - - beskedstatusmarkeringer | BeskedstatusmarkeringDtoCollection | 0 - 1 | Kollektion af markeringer for visning og læsning | |
| - - - BeskedstatusmarkeringDto | BeskedstatusmarkeringDto | 0 - * | ||
| - - - - statusmarkering | BeskedMarkeringsstatusCodeList | 1 | ||
| - - - - haendelsestidspunkt | date-time | 1 | Dato for hvornår handlingen blev udført. | |
| - - beskedTag | BeskedTagDtoCollection | 0 - 1 | Multibeskeder, samme besked til mange borgere | |
| - - - BeskedTagDto | BeskedTagDto | 0 - * | ||
| - - - - oprettetAf | AfsenderDto | 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen. | |
| - - - - - brugertype | BrugerTypeCodeList | 1 | ||
| - - - - - brugerIdentifier | string | 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CV nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID. | |
| - - - - - navn | string | 1 | Sagsbehandlers eller borgerens fulde navn. | |
| - - - - - virksomhed | VirksomhedDto | 0 - 1 | Angiver virksomhedsinformation. | |
| - - - - - - pNummer | string | Length: 1-10 | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid være tilknyttet et CVR-nummer.. |
| - - - - - - cvrEnhedsid | string | Length: 1-8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
| - - - - - - virksomhedKontaktIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Identifikation af kontaktperson hos virksomhed (arbejdsgiver). |
| - - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - - - organisationskode | string | 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse. | |
| - - - - beskedTag | string | 1 | Multibeskeder, samme besked til mange borgere. | |
| - - - - haendelsestidspunkt | date-time | 1 | Dato for hvornår handlingen blev udført. | |
| - - berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Berigtigelseskommentar |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 8144 | Den ønskede besked kunne ikke findes | Den ønskede besked kunne ikke findes |
UpdateBorgerbeskedStatus (PUT /v1/Borgerbesked/{borgerbeskedIdentifier}/action/setstatus)
Metoden bruges til at angive om en besked er afsluttet eller fejlagtigt oprettet. Denne servicemetode kan kun anvendes hvis afsendelseskanal er Id 4 "Myndighed til Myndighed"
Scope
borgerkommunikation.borgerbesked.write
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| borgerbeskedIdentifier [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 | UpdateBorgerbeskedStatusRequestDto | 1 | UpdateBorgerbeskedStatusRequestDto. | |
| - beskedstatus | BorgerBeskedStatusCodeList | 1 | ||
| - berigtigelseskommentar | string | 0 - 1 | Kommentar til fejloprettet. |
Output
Intet output
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 8144 | Den ønskede besked kunne ikke findes | Den ønskede besked kunne ikke findes |
| 60021 | Det angivne cpr nummer er ikke identisk med cpr nummer på borgerbeskeden | Det angivne cpr nummer er ikke identisk med cpr nummer på borgerbeskeden |
| 8211 | Der er ikke muligt at opdatere dette svar, da en anden har oprettet det | Der er ikke muligt at opdatere dette svar, da en anden har oprettet det |
| 8196 | Det er kun muligt at ændre status hvis beskeden er myndighed til myndighed eller jobnet beskedbakke | Det er kun muligt at ændre status hvis beskeden er myndighed til myndighed eller jobnet beskedbakke |
| 8160 | Beskeden kan kun statusskiftes, hvis den har status 'Aktiv', eller hvis den har status 'LukketDialog' og ændringen er til status 'Fejloprettet'. Status kan aldrig skiftes til 'Aktiv' | Beskeden kan kun statusskiftes, hvis den har status 'Aktiv', eller hvis den har status 'LukketDialog' og ændringen er til status 'Fejloprettet'. Status kan aldrig skiftes til 'Aktiv' |
| 8300 | Berigtigelseskommentar der påkrævet med status Fejloprettet | Berigtigelseskommentar der påkrævet med status Fejloprettet |
UpdateBorgerbeskedsvarStatus (PUT /v1/Borgerbesked/{borgerbeskedIdentifier}/Svar/{borgerbeskedsvarIdentifier}/action/setstatus)
Denne metode anvendes til at markere at et svar er blevet fejlagtigt oprettet.
Scope
borgerkommunikation.borgerbesked.write
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| borgerbeskedIdentifier [Path] | uuid | 1 | ||
| borgerbeskedsvarIdentifier [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 | UpdateBorgerbeskedsvarStatusRequestDto | 1 | UpdateBorgerbeskedsvarStatusRequestDto | |
| - beskedstatus | BorgerBeskedStatusCodeList | 1 | ||
| - berigtigelseskommentar | string | 0 - 1 | Kommentar til fejloprettet. |
Output
Intet output
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 8144 | Den ønskede besked kunne ikke findes | Den ønskede besked kunne ikke findes |
| 60021 | Det angivne cpr nummer er ikke identisk med cpr nummer på borgerbeskeden | Det angivne cpr nummer er ikke identisk med cpr nummer på borgerbeskeden |
| 8160 | Beskeden kan kun statusskiftes, hvis den har status 'Aktiv', eller hvis den har status 'LukketDialog' og ændringen er til status 'Fejloprettet'. Status kan aldrig skiftes til 'Aktiv' | Beskeden kan kun statusskiftes, hvis den har status 'Aktiv', eller hvis den har status 'LukketDialog' og ændringen er til status 'Fejloprettet'. Status kan aldrig skiftes til 'Aktiv' |
| 8162 | Den angivne statusændring er ikke tillladt | Den angivne statusændring er ikke tillladt |
| 8164 | Svar kunne ikke findes | Svar kunne ikke findes |
| 8163 | Status på svar skal være 'Aktiv' for at status kan ændres | Status på svar skal være 'Aktiv' for at status kan ændres |
| 8211 | Der er ikke muligt at opdatere dette svar, da en anden har oprettet det | Der er ikke muligt at opdatere dette svar, da en anden har oprettet det |
| 8300 | Berigtigelseskommentar der påkrævet med status Fejloprettet | Berigtigelseskommentar der påkrævet med status Fejloprettet |
UpdateBorgerbeskedMarkering (PUT /v1/Borgerbesked/{borgerbeskedIdentifier}/action/setmarkering)
Metoden bruges til at angive at borgeren, i regi af Jobnet, har fået vist eller har læst beskeden. Metoden anvendes også til at angive at borgeren, i regi af Jobnet, har læst et svar.
Scope
borgerkommunikation.borgerbesked.write
Input
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| borgerbeskedIdentifier [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 | UpdateBorgerbeskedMarkeringRequestDto | 1 | UpdateBorgerbeskedMarkeringRequestDto | |
| - statusmarkering | BeskedMarkeringsstatusCodeList | 1 |
Output
Intet output
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 8144 | Den ønskede besked kunne ikke findes | Den ønskede besked kunne ikke findes |
| 60021 | Det angivne cpr nummer er ikke identisk med cpr nummer på borgerbeskeden | Det angivne cpr nummer er ikke identisk med cpr nummer på borgerbeskeden |
| 8149 | En modtager skal være angivet når kanal er 'MyndighedTilMyndighed' | En modtager skal være angivet når kanal er 'MyndighedTilMyndighed' |
| 9007 | En arkiveret besked kan ikke blive markeret | En arkiveret besked kan ikke blive markeret |
CreateBorgerbeskedsvar (POST /v1/Borgerbesked/{borgerbeskedIdentifier}/Svar)
Metoden bruges som svar på en eksisterende meddelelse – dermed kan skabes beskedtråd.
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 | ||||||
| JobCenter | X | X | ||||||
| STAR | X |
Scope
borgerkommunikation.borgerbesked.write
Input
| 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 |
| borgerbeskedIdentifier [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 | CreateBorgerbeskedsvarRequestDto | 1 | createBorgerBeskedRequest dto. | |
| - afsender | AfsenderDto | 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen. | |
| - - brugertype | BrugerTypeCodeList | 1 | ||
| - - brugerIdentifier | string | 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CV nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID. | |
| - - navn | string | 1 | Sagsbehandlers eller borgerens fulde navn. | |
| - - virksomhed | VirksomhedDto | 0 - 1 | Angiver virksomhedsinformation. | |
| - - - pNummer | string | Length: 1-10 | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid være tilknyttet et CVR-nummer.. |
| - - - cvrEnhedsid | string | Length: 1-8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
| - - - virksomhedKontaktIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Identifikation af kontaktperson hos virksomhed (arbejdsgiver). |
| - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - organisationskode | string | 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse. | |
| - tekst | string | MinLength: 1 | 1 | Indeholder den tekst dialogen skal indeholde. SMS max 160 karakterer, Mail max 2000 karakterer, Notifikation max 500 karakterer, Myndighed-til-myndighed max 2000 karakterer. |
| - vedhaeftetDokumenter | VedhaeftetDokumenterDtoCollection | 1 | Kollektion af vedhæftede dokumenter. | |
| - - VedhaeftetDokumenterDto | VedhaeftetDokumenterDto | 0 - * | ||
| - - - documentIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 0 - 1 | Entydig nøgle. |
| - - - dokumenttitel | string | Length: 1-260 | 1 | Titel på dokumentet. |
| - - - dokumentfiltype | DokumentTypeCodeList | 1 | ||
| - - - dokumentskema | DokumentSkemaTypeCodeList | 0 - 1 | ||
| - - - dokumentdata | base64Binary | 0 - 1 | Selve dokumentet. |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | CreateBorgerbeskedsvarResponseDto | 1 | CreateBorgerbeskedsvarResponseDto. | |
| - borgerbeskedsvarIdentifier | uuid | 1 | Indeholder GUID (borgerbeskedsvarIdentifier) for det nyoprettede svar. |
Fejlkoder
| Fejlkode | Fejltekst | Beskrivelse |
|---|---|---|
| 8143 | Den angivne tekst er over maksimun længde for kanalen | Den angivne tekst er over maksimun længde for kanalen |
| 8144 | Den ønskede besked kunne ikke findes | Den ønskede besked kunne ikke findes |
| 8145 | Beskeden har en svartype der ikke er er tillladt for besvarelser | Beskeden har en svartype der ikke er er tillladt for besvarelser |
| 8147 | Beskeden har en status der ikke tilllader nye besvarelser | Beskeden har en status der ikke tilllader nye besvarelser |
| 8156 | Svaret skal være oprettet enten af modtagende eller sendende organisation | Svaret skal være oprettet enten af modtagende eller sendende organisation |
| 8158 | Borger kan ikke svare på besked med given beskedtype | Borger kan ikke svare på besked med given beskedtype |
| 8159 | Sagsbehandler kan ikke svare på besked med given beskedtype | Sagsbehandler kan ikke svare på besked med given beskedtype |
| 9104 | Organisationtype skal være angivet når bruger er sagsbehandler | Organisationtype skal være angivet når bruger er sagsbehandler |
| 9105 | Minimum CVR nummer skal være angivet når bruger er virksomhed | Minimum CVR nummer skal være angivet når bruger er virksomhed |
| 9114 | Beskeden har en svartype der ikke er tilladt for virksomheder | Beskeden har en svartype der ikke er tilladt for virksomheder |
| 9115 | Det er kun opretter og modtager der må svare på beskeder | Det er kun opretter og modtager der må svare på beskeder |
| 9116 | Seneste tidspunkt for besvarelse er overskredet | Seneste tidspunkt for besvarelse er overskredet |
| 60021 | Det angivne cpr nummer er ikke identisk med cpr nummer på borgerbeskeden | Det angivne cpr nummer er ikke identisk med cpr nummer på borgerbeskeden |
GetBorgerbeskedVirksomhed (GET /v1/Borgerbesked/Virksomhed)
Metoden bruges til at hente alle de beskeder der er oprettet til en arbejdsgiver. Af performancemæssige hensyn giver servicemetoden mulighed for kun at returnere hovedbeskeden uden de underliggende svar.
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 | |
|---|---|---|---|---|---|---|---|---|
| STAR | X |
Scope
borgerkommunikation.borgerbesked.virksomhed.read
Input
| 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 |
| cvrEnhedsid [Query] | string | Length: 8-8 | 1 | |
| pNummer [Query] | string | Length: 10-10 | 0 - 1 | |
| virksomhedKontaktIdentifier [Query] | uuid | 1 | ||
| indholdstype [Query] | BeskedIndholdsTypeCodeList | 0 - 1 | ||
| svarSkalMedtages [Query] | boolean | 1 | ||
| ulaeste [Query] | boolean | 1 |
Output
| Element | Type | Detaljer | Forekomst | Beskrivelse |
|---|---|---|---|---|
| response | GetBorgerbeskedVirksomhedResponseDto | 1 | Response Get Borgerbeskeder. | |
| - borgerbeskeder | GetBorgerbeskedDtoCollection | 1 | Borgerbeskeder. | |
| - - GetBorgerbeskedDto | GetBorgerbeskedDto | 0 - * | ||
| - - - borgerbeskedIdentifier | uuid | Pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Unik ID for meddelelsen |
| - - - indholdstype | BeskedIndholdsTypeCodeList | 1 | ||
| - - - afsender | AfsenderDto | 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen. | |
| - - - - brugertype | BrugerTypeCodeList | 1 | ||
| - - - - brugerIdentifier | string | 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CV nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID. | |
| - - - - navn | string | 1 | Sagsbehandlers eller borgerens fulde navn. | |
| - - - - virksomhed | VirksomhedDto | 0 - 1 | Angiver virksomhedsinformation. | |
| - - - - - pNummer | string | Length: 1-10 | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid være tilknyttet et CVR-nummer.. |
| - - - - - cvrEnhedsid | string | Length: 1-8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
| - - - - - virksomhedKontaktIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Identifikation af kontaktperson hos virksomhed (arbejdsgiver). |
| - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - - organisationskode | string | 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse. | |
| - - - title | string | 0 - 1 | Titlen på dialogen | |
| - - - tekst | string | 1 | Tekst dialogen skal indeholde | |
| - - - modtagendeMyndighed | ModtagendeMyndighedDto | 0 - 1 | ||
| - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - - organisationskode | string | 1 | Organisationskode. | |
| - - - afsendelseskanal | AfsendelsesKanalTypeCodeList | 1 | ||
| - - - besvarelsestype | BesvarelsesTypeCodeList | 1 | ||
| - - - borgerbeskedsvar | BeskedsvarDtoCollection | 0 - 1 | Indeholder en liste over alle de retursvar der er oprettet til denne dialog | |
| - - - - BeskedsvarDto | BeskedsvarDto | 0 - * | ||
| - - - - - borgerbeskedsvarIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Entydig nøgle. |
| - - - - - afsender | AfsenderDto | 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen. | |
| - - - - - - brugertype | BrugerTypeCodeList | 1 | ||
| - - - - - - brugerIdentifier | string | 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CV nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID. | |
| - - - - - - navn | string | 1 | Sagsbehandlers eller borgerens fulde navn. | |
| - - - - - - virksomhed | VirksomhedDto | 0 - 1 | Angiver virksomhedsinformation. | |
| - - - - - - - pNummer | string | Length: 1-10 | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid være tilknyttet et CVR-nummer.. |
| - - - - - - - cvrEnhedsid | string | Length: 1-8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
| - - - - - - - virksomhedKontaktIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Identifikation af kontaktperson hos virksomhed (arbejdsgiver). |
| - - - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - - - - organisationskode | string | 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse. | |
| - - - - - tekst | string | MinLength: 1 | 1 | Tekst retursvar indeholder. Max 2000 karakterer. |
| - - - - - oprettelsestidspunkt | date-time | 1 | Dato og tid for hvornår svar er blevet oprettet | |
| - - - - - beskedstatus | BorgerBeskedStatusCodeList | 1 | ||
| - - - - - vedhaeftetDokumenter | VedhaeftetDokumentDtoCollection | 0 - 1 | Kollektion af vedhæftede dokumenter | |
| - - - - - - VedhaeftetDokumentDto | VedhaeftetDokumentDto | 0 - * | ||
| - - - - - - - documentIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 0 - 1 | Entydig nøgle. |
| - - - - - - - dokumenttitel | string | Length: 1-260 | 1 | Titel på dokumentet. |
| - - - - - - - dokumentfiltype | DokumentTypeCodeList | 1 | ||
| - - - - - - - dokumentskema | DokumentSkemaTypeCodeList | 0 - 1 | ||
| - - - - - beskedstatusmarkering | BeskedstatusmarkeringDtoCollection | 0 - 1 | Kollektion af markeringer for visning og læsning | |
| - - - - - - BeskedstatusmarkeringDto | BeskedstatusmarkeringDto | 0 - * | ||
| - - - - - - - statusmarkering | BeskedMarkeringsstatusCodeList | 1 | ||
| - - - - - - - haendelsestidspunkt | date-time | 1 | Dato for hvornår handlingen blev udført. | |
| - - - - - berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Berigtigelseskommentar |
| - - - beskedstatus | BorgerBeskedStatusCodeList | 1 | ||
| - - - oprettelsestidspunkt | date-time | 1 | Dato og tid for hvornår dialogen er blevet oprettet | |
| - - - visIBeskedbakke | boolean | 1 | Markering af hvorvidt besked skal vises i beskedbakken eller ej:Sandt: Besked vises; Falsk: Besked vises ikke | |
| - - - beskedSynligFratidspunkt | date-time | 0 - 1 | Eventuel fremtidig visningsdato. Hvis udfyldt vises besked først når dato nås | |
| - - - beskedSynligTiltidspunkt | date-time | 0 - 1 | Eventuel dato for afslutning af visning Hvis udfyld vises besked ikke mere når dato nås. Kan kun angives for kanal lig Notifikation | |
| - - - senesteSvartidspunkt | date-time | 0 - 1 | Eventuel dato for Svar senest | |
| - - - vigtighedsniveau | VigtighedsniveauTypeCodeList | 1 | ||
| - - - vedhaeftetDokumenter | VedhaeftetDokumentDtoCollection | 0 - 1 | Kollektion af vedhæftede dokumenter | |
| - - - - VedhaeftetDokumentDto | VedhaeftetDokumentDto | 0 - * | ||
| - - - - - documentIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 0 - 1 | Entydig nøgle. |
| - - - - - dokumenttitel | string | Length: 1-260 | 1 | Titel på dokumentet. |
| - - - - - dokumentfiltype | DokumentTypeCodeList | 1 | ||
| - - - - - dokumentskema | DokumentSkemaTypeCodeList | 0 - 1 | ||
| - - - beskedstatusmarkeringer | BeskedstatusmarkeringDtoCollection | 0 - 1 | Kollektion af markeringer for visning og læsning | |
| - - - - BeskedstatusmarkeringDto | BeskedstatusmarkeringDto | 0 - * | ||
| - - - - - statusmarkering | BeskedMarkeringsstatusCodeList | 1 | ||
| - - - - - haendelsestidspunkt | date-time | 1 | Dato for hvornår handlingen blev udført. | |
| - - - beskedTag | BeskedTagDtoCollection | 0 - 1 | Multibeskeder, samme besked til mange borgere | |
| - - - - BeskedTagDto | BeskedTagDto | 0 - * | ||
| - - - - - oprettetAf | AfsenderDto | 1 | Indeholder informationer om den person som er ophavsmand til meddelelsen. | |
| - - - - - - brugertype | BrugerTypeCodeList | 1 | ||
| - - - - - - brugerIdentifier | string | 1 | Unik identifikator for pågældende User. Hvis Usertyper er en borger skal identifikator være borgers CV nummer. Hvis Usertyper er en sagsbehandler skal identifikator være sagsbehandlerens RID. | |
| - - - - - - navn | string | 1 | Sagsbehandlers eller borgerens fulde navn. | |
| - - - - - - virksomhed | VirksomhedDto | 0 - 1 | Angiver virksomhedsinformation. | |
| - - - - - - - pNummer | string | Length: 1-10 | 0 - 1 | En P-enhed får tildelt et entydigt identifikationsnummer, et P-nummer, som er et 10-cifret nummer. Et P-nummer vil altid være tilknyttet et CVR-nummer.. |
| - - - - - - - cvrEnhedsid | string | Length: 1-8 | 1 | CVR-nummeret er et 8-cifret nummer, der er unikt for den enkelte virksomhed. |
| - - - - - - - virksomhedKontaktIdentifier | uuid | Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ | 1 | Identifikation af kontaktperson hos virksomhed (arbejdsgiver). |
| - - - - - - organisationType | OrganisationTypeCodeList | 1 | ||
| - - - - - - organisationskode | string | 0 - 1 | Kun relevant hvis brugertype er lig sagsbehandler. Angivelse af organisationstypen - Jobcenter eller A-kasse. | |
| - - - - - beskedTag | string | 1 | Multibeskeder, samme besked til mange borgere. | |
| - - - - - haendelsestidspunkt | date-time | 1 | Dato for hvornår handlingen blev udført. | |
| - - - berigtigelseskommentar | string | Length: 0-1500 | 0 - 1 | Berigtigelseskommentar |
Fejlkoder
Ingen fejlkoder