...
| 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 | CreateBorgerbeskedRequestDto | 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 1 - * | ||
| - indholdstype | BeskedIndholdsTypeCodeList | 1 | ||
| - titel | string | MinLength: 0 | 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 | 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. |
| - 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. |
...